From 8bc123fc0e2491065b3500f23f16ca483986f042 Mon Sep 17 00:00:00 2001
From: Josep Boix Requesens <jspboix@gmail.com>
Date: Mon, 4 Nov 2024 13:23:50 +0100
Subject: [PATCH] fix: adjust data deserializer to return correct type

- Changed the DataDeserializer to return Any? instead of JsonNode to fix type mismatch errors
  in 'data'field deserialization.
- Changed the user agent field from `agent` to `user_agent` to match specificiations.
---
 .../monitoring/event/model/EventRequest.kt    | 10 ++---
 .../event/model/EventRequestTest.kt           | 40 ++++++++-----------
 2 files changed, 21 insertions(+), 29 deletions(-)

diff --git a/src/main/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequest.kt b/src/main/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequest.kt
index 647ce28..0516ef7 100644
--- a/src/main/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequest.kt
+++ b/src/main/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequest.kt
@@ -54,7 +54,7 @@ data class EventRequest(
  *
  * If the `browser.agent` field is not present, the deserializer returns the node unmodified.
  */
-private class DataDeserializer : JsonDeserializer<JsonNode?>() {
+private class DataDeserializer : JsonDeserializer<Any?>() {
   companion object {
     private val userAgentAnalyzer =
       UserAgentAnalyzer
@@ -67,14 +67,14 @@ private class DataDeserializer : JsonDeserializer<JsonNode?>() {
   override fun deserialize(
     parser: JsonParser,
     ctxt: DeserializationContext,
-  ): JsonNode {
+  ): Any? {
     val node: JsonNode = parser.codec.readTree(parser)
     val browserNode = (node as? ObjectNode)?.get("browser")
     val userAgent =
       (browserNode as? ObjectNode)
-        ?.get("agent")
+        ?.get("user_agent")
         ?.asText()
-        ?.let(userAgentAnalyzer::parse) ?: return node
+        ?.let(userAgentAnalyzer::parse) ?: return parser.codec.treeToValue(node, Any::class.java)
 
     node.set<ObjectNode>(
       "browser",
@@ -100,7 +100,7 @@ private class DataDeserializer : JsonDeserializer<JsonNode?>() {
       },
     )
 
-    return node
+    return parser.codec.treeToValue(node, Any::class.java)
   }
 }
 
diff --git a/src/test/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequestTest.kt b/src/test/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequestTest.kt
index b143fa5..4e0c013 100644
--- a/src/test/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequestTest.kt
+++ b/src/test/kotlin/ch/srgssr/pillarbox/monitoring/event/model/EventRequestTest.kt
@@ -1,11 +1,9 @@
 package ch.srgssr.pillarbox.monitoring.event.model
 
 import com.fasterxml.jackson.databind.ObjectMapper
-import com.fasterxml.jackson.databind.node.ObjectNode
 import com.fasterxml.jackson.module.kotlin.readValue
 import io.kotest.core.spec.style.ShouldSpec
 import io.kotest.matchers.shouldBe
-import io.kotest.matchers.shouldNotBe
 import org.springframework.boot.test.context.SpringBootTest
 
 @SpringBootTest
@@ -23,7 +21,7 @@ class EventRequestTest(
           "version": 1,
           "data": {
             "browser": {
-              "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36"
+              "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36"
             }
           }
         }
@@ -33,22 +31,18 @@ class EventRequestTest(
       val eventRequest = objectMapper.readValue<EventRequest>(jsonInput)
 
       // Then: The user agent data should have been resolved
-      val dataNode = eventRequest.data as? ObjectNode
-      dataNode shouldNotBe null
+      val dataNode = eventRequest.data as Map<*, *>
 
-      val browserNode = dataNode?.get("browser") as? ObjectNode
-      browserNode shouldNotBe null
-      browserNode?.get("name")?.asText() shouldBe "Chrome"
-      browserNode?.get("version")?.asText() shouldBe "129"
+      val browserNode = dataNode["browser"] as Map<*, *>
+      browserNode["name"] shouldBe "Chrome"
+      browserNode["version"] shouldBe "129"
 
-      val deviceNode = dataNode?.get("device") as? ObjectNode
-      deviceNode shouldNotBe null
-      deviceNode?.get("name")?.asText() shouldBe "Apple Macintosh"
+      val deviceNode = dataNode["device"] as Map<*, *>
+      deviceNode["name"] shouldBe "Apple Macintosh"
 
-      val osNode = dataNode?.get("os") as? ObjectNode
-      osNode shouldNotBe null
-      osNode?.get("name")?.asText() shouldBe "Mac OS"
-      osNode?.get("version")?.asText() shouldBe ">=10.15.7"
+      val osNode = dataNode["os"] as Map<*, *>
+      osNode["name"] shouldBe "Mac OS"
+      osNode["version"] shouldBe ">=10.15.7"
     }
 
     should("retain existing data when deserializing an event without user agent") {
@@ -73,15 +67,13 @@ class EventRequestTest(
       val eventRequest = objectMapper.readValue<EventRequest>(jsonInput)
 
       // Then: The data for browser, os and device should not have been modified
-      val dataNode = eventRequest.data as? ObjectNode
-      dataNode shouldNotBe null
+      val dataNode = eventRequest.data as Map<*, *>
 
-      val browserNode = dataNode?.get("browser") as? ObjectNode
-      browserNode shouldNotBe null
-      browserNode?.get("name")?.asText() shouldBe "Firefox"
-      browserNode?.get("version")?.asText() shouldBe "2.0"
+      val browserNode = dataNode["browser"] as Map<*, *>
+      browserNode["name"] shouldBe "Firefox"
+      browserNode["version"] shouldBe "2.0"
 
-      dataNode?.get("device") shouldBe null
-      dataNode?.get("os") shouldBe null
+      dataNode["device"] shouldBe null
+      dataNode["os"] shouldBe null
     }
   })