Log all topics contained in a registration request with an invalid topic type (#1834)

* log invalid topic id and type

* add logging to non-legacy

* better loging

* use MDC

* log all topics

* update

Author: aracho1

common/src/main/scala/models/Registration.scala

@@ -16,17 +16,21 @@ object Registration {
     val base = Json.format[Registration]
     Format(
       Reads { json =>
+        def topicSummary(v: JsValue): String = {
+          val t = (v \ "type").asOpt[String].getOrElse("unknown")
+          val n = (v \ "name").asOpt[String].getOrElse("unknown")
+          s"$t (id=$n)"
+        }
+        val all = (json \ "topics").asOpt[JsArray].toSeq.flatMap(_.value.map(topicSummary))
         val invalid = (json \ "topics").asOpt[JsArray].toSeq.flatMap { arr =>
           arr.value.flatMap { v =>
-            if (v.validate[Topic].isError) {
-              val topicType = (v \ "type").asOpt[String].getOrElse("unknown")
-              val topicName = (v \ "name").asOpt[String].getOrElse("unknown")
-              Some(s"Topic Type=$topicType (Topic Id=$topicName)")
-            } else None
+            if (v.validate[Topic].isError) Some(topicSummary(v)) else None
           }
         }
-        if (invalid.nonEmpty)
-          MDC.put("invalidTopics", invalid.mkString(". "))
+        if (invalid.nonEmpty) {
+          MDC.put("invalidTopics", invalid.mkString(", "))
+          if (all.nonEmpty) MDC.put("allTopics", all.mkString(", "))
+        }
         base.reads(json)
       },
       base

registration/app/registration/CustomErrorHandler.scala

@@ -14,12 +14,17 @@ class CustomErrorHandler(env: Environment, config: Configuration, sourceMapper:
   private val logger: Logger = LoggerFactory.getLogger(this.getClass)
   override def onBadRequest(request: RequestHeader, message: String): Future[Result] = {
     val debugInfo = request.headers.get("User-Agent")
-    Option(MDC.get("invalidTopics")) match {
-      case Some(invalidTopics) =>
-        logger.warn(s"Bad request: request contains invalid topic type(s). $invalidTopics. User agent = $debugInfo")
-        MDC.remove("invalidTopics")
-      case None =>
-        logger.error(s"Bad request due to $message. User agent = $debugInfo")
+    try {
+      Option(MDC.get("invalidTopics")) match {
+        case Some(invalidTopics) =>
+          val allTopics = Option(MDC.get("allTopics")).getOrElse("")
+          logger.warn(s"Bad request: invalid topic type(s): [$invalidTopics]. All topics: [$allTopics]. User agent: ${debugInfo.getOrElse("unknown")}")
+        case None =>
+          logger.error(s"Bad request due to $message. User agent: ${debugInfo.getOrElse("unknown")}")
+      }
+    } finally {
+      MDC.remove("invalidTopics")
+      MDC.remove("allTopics")
     }
     Future.successful(BadRequest("Bad request"))
   }