fixes #1978 [WhatsApp]: fix message deserialization errors (#1979)

Author: Fabilin

bot/connector-whatsapp-cloud/src/main/kotlin/WhatsAppConnectorCloudConnector.kt

@@ -94,7 +94,7 @@ class WhatsAppConnectorCloudConnector internal constructor(
                     val verifyTokenMeta = queryParams.get("hub.verify_token")
                     val challenge = queryParams.get("hub.challenge")
                     if (modeHub == WEBHOOK_SUBSCRIBE_MODE && verifyToken == verifyTokenMeta) {
-                        logger.info("WEBHOOK_VERIFIED")
+                        logger.info { "WhatsApp Cloud API webhook verified for $connectorId" }
                         context.response().setStatusCode(200).end(challenge)
                     } else {
                         context.response().end("Invalid verify token")
@@ -113,7 +113,6 @@ class WhatsAppConnectorCloudConnector internal constructor(
                 val requestTimerData = BotRepository.requestTimer.start("whatsapp_cloud_webhook")
                 try {
                     val body = context.body().asString()
-                    logger.info { body }
                     val requestBody = mapper.readValue<WebHookEventReceiveMessage>(body)
 
                     handleWebHook(requestBody, controller)
@@ -136,12 +135,10 @@ class WhatsAppConnectorCloudConnector internal constructor(
                 val requestTimerData = BotRepository.requestTimer.start("whatsapp_cloud_create_template")
                 try {
                     val body = context.body().asString()
-                    logger.info { body }
+                    logger.debug { "creating template: $body" }
                     val requestBody = mapper.readValue<WhatsappTemplate>(body)
 
                     whatsAppCloudApiService.createOrUpdateTemplate(requestBody)
-
-                    logger.info { "ok" }
                 } catch (e: Throwable) {
                     logger.logError(e, requestTimerData)
                 } finally {
@@ -213,6 +210,7 @@ class WhatsAppConnectorCloudConnector internal constructor(
                 change.value.messages.filter {
                     restrictedPhoneNumbers?.contains(it.from) ?: true
                 }.forEach { message: WhatsAppCloudMessage ->
+                    logger.debug { "received message $message" }
                     executor.executeBlocking {
                         val event = WebhookActionConverter.toEvent(message, connectorId, whatsAppCloudApiService)
                         if (event != null) {

bot/connector-whatsapp-cloud/src/main/kotlin/model/webhook/message/WhatsAppCloudAudioMessage.kt

@@ -29,4 +29,4 @@ data class WhatsAppCloudAudioMessage(
     override val context: ContextContent? = null,
     override val referral: Referral? = null,
     override val errors: List<ErrorItem>? = emptyList(),
-) : WhatsAppCloudMessage(WhatsAppCloudMessageType.text)
+) : WhatsAppCloudMessage(WhatsAppCloudMessageType.audio)

bot/connector-whatsapp-cloud/src/main/kotlin/model/webhook/message/WhatsAppCloudDocumentMessage.kt

@@ -22,7 +22,7 @@ import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.content.ErrorI
 import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.content.Referral
 
 data class WhatsAppCloudDocumentMessage(
-    val text: DocumentContent,
+    val text: DocumentContent?,
     override val id: String,
     override val from: String,
     override val timestamp: String,

bot/connector-whatsapp-cloud/src/main/kotlin/model/webhook/message/WhatsAppCloudMessage.kt

@@ -26,6 +26,8 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo
     use = JsonTypeInfo.Id.NAME,
     include = JsonTypeInfo.As.EXISTING_PROPERTY,
     property = "type",
+    visible = true,
+    defaultImpl = WhatsAppCloudUnknownMessage::class,
 )
 @JsonSubTypes(
     JsonSubTypes.Type(value = WhatsAppCloudTextMessage::class, name = "text"),

bot/connector-whatsapp-cloud/src/main/kotlin/model/webhook/message/WhatsAppCloudUnknownMessage.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2017/2025 SNCF Connect & Tech
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ai.tock.bot.connector.whatsapp.cloud.model.webhook.message
+
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.content.ContextContent
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.content.ErrorItem
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.content.Referral
+import com.fasterxml.jackson.annotation.JsonAnyGetter
+import com.fasterxml.jackson.annotation.JsonAnySetter
+import com.fasterxml.jackson.annotation.JsonProperty
+
+/**
+ * Unsupported or unknown message
+ */
+data class WhatsAppCloudUnknownMessage(
+    override val id: String,
+    override val from: String,
+    override val timestamp: String,
+    override val context: ContextContent? = null,
+    override val referral: Referral? = null,
+    override val errors: List<ErrorItem>? = emptyList(),
+    @JsonProperty("type")
+    val rawType: String = WhatsAppCloudMessageType.unknown.name,
+    @JsonAnySetter
+    @JsonAnyGetter
+    val additionalProperties: MutableMap<String, Any> = mutableMapOf(),
+) : WhatsAppCloudMessage(WhatsAppCloudMessageType.unknown)

bot/connector-whatsapp-cloud/src/test/kotlin/model/webhook/WhatsAppCloudMessagesDeserializationTest.kt

@@ -16,4 +16,56 @@
 
 package model.webhook
 
-class WhatsAppCloudMessagesDeserializationTest
+import ai.tock.bot.connector.whatsapp.cloud.model.common.TextContent
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.WhatsAppCloudMessage
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.WhatsAppCloudTextMessage
+import ai.tock.bot.connector.whatsapp.cloud.model.webhook.message.WhatsAppCloudUnknownMessage
+import ai.tock.shared.jackson.mapper
+import com.fasterxml.jackson.module.kotlin.readValue
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertNotNull
+import java.time.Instant
+
+class WhatsAppCloudMessagesDeserializationTest {
+    @Test
+    fun testMessageWebhookDeserialization() {
+        val m =
+            WhatsAppCloudTextMessage(
+                text = TextContent("Hello, World!"),
+                id = "aaa",
+                from = "bbb",
+                timestamp = Instant.now().toString(),
+            )
+        val s = mapper.writeValueAsString(m)
+        assertEquals(m, mapper.readValue<WhatsAppCloudMessage>(s))
+    }
+
+    @Test
+    fun testUnknownMessageDeserialization() {
+        val m =
+            WhatsAppCloudUnknownMessage(
+                id = "aaa",
+                from = "bbb",
+                timestamp = "2025-12-30T10:50:52.355219Z",
+                rawType = "unsupported",
+                additionalProperties =
+                    mutableMapOf(
+                        "thing" to "Hello, World!",
+                    ),
+            )
+        val s =
+            """
+            {
+              "thing" : "Hello, World!",
+              "id" : "aaa",
+              "from" : "bbb",
+              "timestamp" : "2025-12-30T10:50:52.355219Z",
+              "errors" : [ ],
+              "type" : "unsupported"
+            }
+            """.trimIndent()
+        assertNotNull(mapper.writeValueAsString(m))
+        assertEquals(m, mapper.readValue<WhatsAppCloudMessage>(s))
+    }
+}