[ECO-5196] Updated Message.kt

1. Marked message headers as non-nullable to enforce library level defaults 2. Removed redudunt copy method, refactored update method signature 3. Removed filesuppress for notImplemented methods across files
ably · Feb 25, 2025 · 99a0fa2 · 99a0fa2
1 parent fbac777
commit 99a0fa2
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 37 deletions.
diff --git a/chat-android/src/main/java/com/ably/chat/ChatApi.kt b/chat-android/src/main/java/com/ably/chat/ChatApi.kt
@@ -44,7 +44,7 @@ internal class ChatApi(
                     text = messageJsonObject.requireString(MessageProperty.Text),
                     createdAt = messageJsonObject.requireLong(MessageProperty.CreatedAt),
                     metadata = messageJsonObject.getAsJsonObject(MessageProperty.Metadata),
-                    headers = messageJsonObject.get(MessageProperty.Headers)?.toMap(),
+                    headers = messageJsonObject.get(MessageProperty.Headers)?.toMap() ?: mapOf(),
                     action = action,
                     version = messageJsonObject.requireString(MessageProperty.Version),
                     timestamp = messageJsonObject.requireLong(MessageProperty.Timestamp),
@@ -75,7 +75,7 @@ internal class ChatApi(
                 text = params.text,
                 createdAt = createdAt,
                 metadata = params.metadata ?: MessageMetadata(),
-                headers = params.headers,
+                headers = params.headers ?: mapOf(),
                 action = MessageAction.MESSAGE_CREATE,
                 version = serial,
                 timestamp = createdAt,
@@ -105,7 +105,7 @@ internal class ChatApi(
                 text = params.message.text,
                 createdAt = message.createdAt,
                 metadata = params.message.metadata ?: MessageMetadata(),
-                headers = params.message.headers,
+                headers = params.message.headers ?: mapOf(),
                 action = MessageAction.MESSAGE_UPDATE,
                 version = version,
                 timestamp = timestamp,

diff --git a/chat-android/src/main/java/com/ably/chat/ChatClient.kt b/chat-android/src/main/java/com/ably/chat/ChatClient.kt
@@ -1,5 +1,3 @@
-@file:Suppress("NotImplementedDeclaration")
-
 package com.ably.chat
 
 import io.ably.lib.realtime.AblyRealtime

diff --git a/chat-android/src/main/java/com/ably/chat/Message.kt b/chat-android/src/main/java/com/ably/chat/Message.kt
@@ -71,7 +71,7 @@ data class Message(
      * Do not use the headers for authoritative information. There is no server-side
      * validation. When reading the headers treat them like user input.
      */
-    val headers: MessageHeaders?,
+    val headers: MessageHeaders,
 
     /**
      * The latest action of the message. This can be used to determine if the message was created, updated, or deleted.
@@ -97,21 +97,6 @@ data class Message(
     val operation: Message.Operation? = null,
 )
 
-fun com.ably.chat.Message.copy(text: String, metadata: MessageMetadata? = null, headers: MessageHeaders? = null): com.ably.chat.Message =
-    Message(
-        serial = this.serial,
-        clientId = this.clientId,
-        roomId = this.roomId,
-        text = text,
-        createdAt = this.createdAt,
-        metadata = metadata ?: this.metadata,
-        headers = headers ?: this.headers,
-        action = this.action,
-        version = this.version,
-        timestamp = this.timestamp,
-        operation = this.operation,
-    )
-
 internal fun buildMessageOperation(jsonObject: JsonObject?): Message.Operation? {
     if (jsonObject == null) {
         return null

diff --git a/chat-android/src/main/java/com/ably/chat/Messages.kt b/chat-android/src/main/java/com/ably/chat/Messages.kt
@@ -1,5 +1,3 @@
-@file:Suppress("StringLiteralDuplication")
-
 package com.ably.chat
 
 import com.ably.chat.OrderBy.NewestFirst
@@ -78,12 +76,12 @@ interface Messages : EmitsDiscontinuities {
      * The original message is not modified.
      * Spec: CHA-M8
      *
-     * @param messageCopy The updated copy of the message created using the `message.copy` method.
+     * @param updatedMessage The updated copy of the message created using the `message.copy` method.
      * @param operationDescription Optional description for the update action.
      * @param operationMetadata Optional metadata for the update action.
      * @returns updated message.
      */
-    suspend fun update(messageCopy: Message, operationDescription: String? = null, operationMetadata: OperationMetadata? = null): Message
+    suspend fun update(updatedMessage: Message, operationDescription: String? = null, operationMetadata: OperationMetadata? = null): Message
 
     /**
      * Delete a message in the chat room.
@@ -364,7 +362,7 @@ internal class DefaultMessages(
                 serial = pubSubMessage.serial,
                 text = data.text,
                 metadata = data.metadata,
-                headers = pubSubMessage.extras.asJsonObject().get("headers")?.toMap(),
+                headers = pubSubMessage.extras.asJsonObject().get("headers")?.toMap() ?: mapOf(),
                 action = pubSubMessage.action,
                 version = pubSubMessage.version,
                 timestamp = pubSubMessage.timestamp,
@@ -407,13 +405,13 @@ internal class DefaultMessages(
         )
 
     override suspend fun update(
-        messageCopy: Message,
+        updatedMessage: Message,
         operationDescription: String?,
         operationMetadata: OperationMetadata?,
     ): Message = chatApi.updateMessage(
-        messageCopy,
+        updatedMessage,
         UpdateMessageParams(
-            message = SendMessageParams(messageCopy.text, messageCopy.metadata, messageCopy.headers),
+            message = SendMessageParams(updatedMessage.text, updatedMessage.metadata, updatedMessage.headers),
             description = operationDescription,
             metadata = operationMetadata,
         ),

diff --git a/chat-android/src/main/java/com/ably/chat/Occupancy.kt b/chat-android/src/main/java/com/ably/chat/Occupancy.kt
@@ -1,4 +1,4 @@
-@file:Suppress("StringLiteralDuplication", "NotImplementedDeclaration")
+@file:Suppress("StringLiteralDuplication")
 
 package com.ably.chat
 

diff --git a/chat-android/src/main/java/com/ably/chat/Presence.kt b/chat-android/src/main/java/com/ably/chat/Presence.kt
@@ -1,4 +1,4 @@
-@file:Suppress("StringLiteralDuplication", "NotImplementedDeclaration")
+@file:Suppress("StringLiteralDuplication")
 
 package com.ably.chat
 

diff --git a/chat-android/src/main/java/com/ably/chat/RoomReactions.kt b/chat-android/src/main/java/com/ably/chat/RoomReactions.kt
@@ -1,4 +1,4 @@
-@file:Suppress("StringLiteralDuplication", "NotImplementedDeclaration")
+@file:Suppress("StringLiteralDuplication")
 
 package com.ably.chat
 

diff --git a/chat-android/src/main/java/com/ably/chat/Typing.kt b/chat-android/src/main/java/com/ably/chat/Typing.kt
@@ -1,4 +1,4 @@
-@file:Suppress("StringLiteralDuplication", "NotImplementedDeclaration")
+@file:Suppress("StringLiteralDuplication")
 
 package com.ably.chat
 

diff --git a/chat-android/src/test/java/com/ably/chat/ChatApiTest.kt b/chat-android/src/test/java/com/ably/chat/ChatApiTest.kt
@@ -51,7 +51,7 @@ class ChatApiTest {
                     text = "hello",
                     createdAt = 1_000_000L,
                     metadata = MessageMetadata(),
-                    headers = null,
+                    headers = mapOf(),
                     action = MessageAction.MESSAGE_CREATE,
                     version = "timeserial",
                     timestamp = 1_000_000L,
@@ -106,7 +106,7 @@ class ChatApiTest {
                 clientId = "clientId",
                 text = "hello",
                 createdAt = 1_000_000L,
-                headers = null,
+                headers = mapOf(),
                 metadata = MessageMetadata(),
                 action = MessageAction.MESSAGE_CREATE,
                 version = "timeserial",

diff --git a/chat-android/src/test/java/com/ably/chat/integration/MessagesIntegrationTest.kt b/chat-android/src/test/java/com/ably/chat/integration/MessagesIntegrationTest.kt
@@ -6,7 +6,6 @@ import com.ably.chat.MessageMetadata
 import com.ably.chat.RoomOptions
 import com.ably.chat.RoomStatus
 import com.ably.chat.assertWaiter
-import com.ably.chat.copy
 import io.ably.lib.types.MessageAction
 import java.util.UUID
 import kotlinx.coroutines.CompletableDeferred
@@ -168,7 +167,7 @@ class MessagesIntegrationTest {
         val opDescription = "Updating message"
         val opMetadata = mapOf("operation" to "update")
 
-        val messageCopy = sentMessage.copy(updatedText, updatedMetadata, headers)
+        val messageCopy = sentMessage.copy(text = updatedText, metadata = updatedMetadata, headers = headers)
         val updatedMessage = room.messages.update(
             messageCopy,
             opDescription,