Log invalid registration topic types (#1830)

* log invalid topic id and type

* add logging to non-legacy

* better loging

* use MDC

Author: aracho1

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

@@ -1,6 +1,7 @@
 package models
 
-import play.api.libs.json.{Format, Json}
+import org.slf4j.MDC
+import play.api.libs.json._
 
 case class Registration(
   deviceToken: DeviceToken,
@@ -11,5 +12,24 @@ case class Registration(
 )
 
 object Registration {
-  implicit val registrationJF: Format[Registration] = Json.format[Registration]
-}
+  implicit val registrationJF: Format[Registration] = {
+    val base = Json.format[Registration]
+    Format(
+      Reads { json =>
+        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 (invalid.nonEmpty)
+          MDC.put("invalidTopics", invalid.mkString(". "))
+        base.reads(json)
+      },
+      base
+    )
+  }
+}

registration/app/registration/CustomErrorHandler.scala

@@ -1,6 +1,6 @@
 package registration
 
-import org.slf4j.{Logger, LoggerFactory}
+import org.slf4j.{Logger, LoggerFactory, MDC}
 import play.api._
 import play.api.http.DefaultHttpErrorHandler
 import play.api.mvc.Results._
@@ -14,7 +14,13 @@ 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")
-    logger.error(s"Bad request due to $message. User agent = $debugInfo")
+    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")
+    }
     Future.successful(BadRequest("Bad request"))
   }
 }

registration/app/registration/services/LegacyRegistrationConverter.scala

@@ -5,9 +5,12 @@ import registration.models.LegacyTopic
 import models._
 import registration.models.LegacyRegistration
 import cats.syntax.all._
+import org.slf4j.LoggerFactory
 
 class LegacyRegistrationConverter extends RegistrationConverter[LegacyRegistration] {
 
+  private val logger = LoggerFactory.getLogger(this.getClass)
+
   def toRegistration(legacyRegistration: LegacyRegistration): Either[NotificationsError, Registration] = {
 
     def deviceTokenFromRegistration(platform: Platform): Either[NotificationsError, DeviceToken] = {
@@ -57,7 +60,10 @@ class LegacyRegistrationConverter extends RegistrationConverter[LegacyRegistrati
     val topics = for {
       topics <- request.preferences.topics.toList
       topic <- topics
-      topicType <- TopicType.fromString(topic.`type`)
+      topicType <- TopicType.fromString(topic.`type`) orElse {
+        logger.warn(s"Invalid topic type=${topic.`type`} topic id=${topic.name}")
+        None
+      }
     } yield Topic(topicType, topic.name) // todo: check this
 
     val matchTopics = for {