Round-trip active command through draft messages (#6389)

andremion · web-flow · commit d1300c525442 · 2026-04-28T16:25:53.000+01:00
* Add command and args fields to DraftMessage.

Mirrors the iOS SDK's wire format so an active slash command can be round-tripped through draft messages cross-SDK.

* Round-trip command/args for drafts on the wire.

DraftMessage.toDto() previously hardcoded command = null; now passes the model's command and args through. DownstreamDraftDto.toDomain() reads the same two fields from the wire payload. UpstreamMessageDto and DownstreamDraftMessageDto gain args; command is reused on UpstreamMessageDto and added to DownstreamDraftMessageDto.

* Persist command and args in offline draft cache.

* Round-trip active command in draft save/restore.
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DomainMapping.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DomainMapping.kt
@@ -269,6 +269,8 @@ internal class DomainMapping(
             mentionedUsersIds = message.mentioned_users?.map { it.id } ?: emptyList(),
             silent = message.silent,
             text = message.text,
+            command = message.command,
+            args = message.args,
             extraData = message.extraData ?: emptyMap(),
         )
 
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DtoMapping.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DtoMapping.kt
@@ -125,6 +125,7 @@ internal class DtoMapping(
                     attachments = attachments.map { it.toDto() },
                     cid = cid,
                     command = command,
+                    args = null,
                     html = html,
                     id = id,
                     type = type,
@@ -156,7 +157,8 @@ internal class DtoMapping(
     internal fun DraftMessage.toDto(): UpstreamMessageDto = UpstreamMessageDto(
         attachments = attachments.map { it.toDto() },
         cid = cid,
-        command = null,
+        command = command,
+        args = args,
         id = id,
         html = "",
         mentioned_users = mentionedUsersIds,
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/MessageDtos.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/MessageDtos.kt
@@ -33,6 +33,7 @@ internal data class UpstreamMessageDto(
     val attachments: List<AttachmentDto>,
     val cid: String,
     val command: String?,
+    val args: String?,
     val html: String,
     val id: String,
     val type: String,
@@ -119,6 +120,8 @@ internal data class DownstreamDraftDto(
 internal data class DownstreamDraftMessageDto(
     val id: String,
     val text: String,
+    val command: String? = null,
+    val args: String? = null,
     val attachments: List<AttachmentDto>? = null,
     val mentioned_users: List<DownstreamUserDto>? = null,
     val silent: Boolean = false,
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/database/internal/ChatDatabase.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/database/internal/ChatDatabase.kt
@@ -88,7 +88,7 @@ import io.getstream.chat.android.client.internal.offline.repository.domain.user.
         ThreadOrderEntity::class,
         DraftMessageEntity::class,
     ],
-    version = 102,
+    version = 103,
     exportSchema = false,
 )
 @TypeConverters(
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/domain/message/internal/DraftMessageEntity.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/domain/message/internal/DraftMessageEntity.kt
@@ -32,6 +32,8 @@ internal data class DraftMessageEntity(
     val silent: Boolean,
     val showInChannel: Boolean,
     val replyMessageId: String? = null,
+    val command: String? = null,
+    val args: String? = null,
     val extraData: Map<String, Any> = mapOf(),
 )
 
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/domain/message/internal/MessageMapper.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/internal/offline/repository/domain/message/internal/MessageMapper.kt
@@ -237,6 +237,8 @@ internal fun DraftMessage.toEntity(): DraftMessageEntity = DraftMessageEntity(
     showInChannel = showInChannel,
     replyMessageId = replyMessage?.id,
     text = text,
+    command = command,
+    args = args,
     extraData = extraData,
 )
 
@@ -251,6 +253,8 @@ internal suspend fun DraftMessageEntity.toModel(
     showInChannel = showInChannel,
     replyMessage = replyMessageId?.let { getMessage(it) },
     text = text,
+    command = command,
+    args = args,
     extraData = extraData,
 )
 
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/Mother.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/Mother.kt
@@ -261,13 +261,17 @@ internal object Mother {
     fun randomDownstreamDraftMessageDto(
         id: String = randomString(),
         text: String = randomString(),
+        command: String? = null,
+        args: String? = null,
         attachments: List<AttachmentDto>? = emptyList(),
         mentionedUsers: List<DownstreamUserDto>? = emptyList(),
         silent: Boolean = randomBoolean(),
         showInChannel: Boolean = randomBoolean(),
     ): DownstreamDraftMessageDto = DownstreamDraftMessageDto(
         id = id,
         text = text,
+        command = command,
+        args = args,
         attachments = attachments,
         mentioned_users = mentionedUsers,
         silent = silent,
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/mapping/DomainMappingTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/mapping/DomainMappingTest.kt
@@ -166,7 +166,12 @@ internal class DomainMappingTest {
 
     @Test
     fun `DownstreamDraftDto is correctly mapped to DraftMessage`() {
-        val draftMessageResponse = randomDownstreamDraftDto()
+        val draftMessageResponse = randomDownstreamDraftDto(
+            message = randomDownstreamDraftMessageDto(
+                command = "giphy",
+                args = "cat",
+            ),
+        )
         val sut = Fixture()
             .get()
         val expectedMappedDraftMessage = with(sut) {
@@ -183,6 +188,8 @@ internal class DomainMappingTest {
                 extraData = draftMessageResponse.message.extraData ?: emptyMap(),
                 silent = draftMessageResponse.message.silent,
                 showInChannel = draftMessageResponse.message.show_in_channel,
+                command = draftMessageResponse.message.command,
+                args = draftMessageResponse.message.args,
             )
         }
 
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/mapping/DtoMappingTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/mapping/DtoMappingTest.kt
@@ -141,7 +141,8 @@ internal class DtoMappingTest {
         val expected = UpstreamMessageDto(
             attachments = message.attachments.map { with(mapping) { it.toDto() } },
             cid = message.cid,
-            command = null,
+            command = message.command,
+            args = message.args,
             html = "",
             id = message.id,
             type = "regular",
@@ -176,6 +177,7 @@ internal class DtoMappingTest {
             attachments = message.attachments.map { with(mapping) { it.toDto() } },
             cid = message.cid,
             command = message.command,
+            args = null,
             html = message.html,
             id = message.id,
             type = message.type,
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/parser2/testdata/MessageDtoTestData.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/parser2/testdata/MessageDtoTestData.kt
@@ -415,6 +415,7 @@ internal object MessageDtoTestData {
         html = "html",
         parent_id = null,
         command = null,
+        args = null,
         silent = false,
         shadowed = false,
         extraData = mapOf(
@@ -471,6 +472,7 @@ internal object MessageDtoTestData {
         html = "",
         parent_id = null,
         command = null,
+        args = null,
         silent = false,
         shadowed = false,
         extraData = emptyMap(),
diff --git a/stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/components/channels/MessagePreviewContent.kt b/stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/components/channels/MessagePreviewContent.kt
@@ -96,7 +96,8 @@ internal fun DraftPreviewContent(
     modifier: Modifier = Modifier,
 ) {
     val draftLabel = stringResource(R.string.stream_compose_channel_list_draft)
-    val fullPreview = "$draftLabel ${draftMessage.text}"
+    val draftBody = draftMessage.previewBody()
+    val fullPreview = "$draftLabel $draftBody"
     Row(
         modifier = modifier
             .testTag("Stream_MessagePreview")
@@ -110,11 +111,22 @@ internal fun DraftPreviewContent(
             maxLines = 1,
         )
         Text(
-            text = draftMessage.text,
+            text = draftBody,
             maxLines = 1,
             overflow = TextOverflow.Ellipsis,
             style = ChatTheme.typography.captionDefault,
             color = ChatTheme.colors.textSecondary,
         )
     }
 }
+
+/**
+ * Renders the body of the draft preview. Active commands are surfaced with their `/name` prefix
+ * so the channel list reflects what the user actually composed (matches legacy mode, where the
+ * prefix was carried inside `text`).
+ */
+private fun DraftMessage.previewBody(): String {
+    val name = command ?: return text
+    val typed = args ?: text
+    return if (typed.isEmpty()) "/$name" else "/$name $typed"
+}
diff --git a/stream-chat-android-core/api/stream-chat-android-core.api b/stream-chat-android-core/api/stream-chat-android-core.api
@@ -848,10 +848,12 @@ public final class io/getstream/chat/android/models/DistinctFilterObject : io/ge
 
 public final class io/getstream/chat/android/models/DraftMessage : io/getstream/chat/android/models/CustomObject, io/getstream/chat/android/models/querysort/ComparableFieldProvider {
 	public fun <init> ()V
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;)V
-	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;Ljava/lang/String;Ljava/lang/String;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ljava/lang/String;
 	public final fun component10 ()Lio/getstream/chat/android/models/Message;
+	public final fun component11 ()Ljava/lang/String;
+	public final fun component12 ()Ljava/lang/String;
 	public final fun component2 ()Ljava/lang/String;
 	public final fun component3 ()Ljava/lang/String;
 	public final fun component4 ()Ljava/lang/String;
@@ -860,11 +862,13 @@ public final class io/getstream/chat/android/models/DraftMessage : io/getstream/
 	public final fun component7 ()Ljava/util/Map;
 	public final fun component8 ()Z
 	public final fun component9 ()Z
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;)Lio/getstream/chat/android/models/DraftMessage;
-	public static synthetic fun copy$default (Lio/getstream/chat/android/models/DraftMessage;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;ILjava/lang/Object;)Lio/getstream/chat/android/models/DraftMessage;
+	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/chat/android/models/DraftMessage;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/models/DraftMessage;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/util/List;Ljava/util/Map;ZZLio/getstream/chat/android/models/Message;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/chat/android/models/DraftMessage;
 	public fun equals (Ljava/lang/Object;)Z
+	public final fun getArgs ()Ljava/lang/String;
 	public final fun getAttachments ()Ljava/util/List;
 	public final fun getCid ()Ljava/lang/String;
+	public final fun getCommand ()Ljava/lang/String;
 	public fun getComparableField (Ljava/lang/String;)Ljava/lang/Comparable;
 	public fun getExtraData ()Ljava/util/Map;
 	public fun getExtraValue (Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object;
@@ -885,8 +889,10 @@ public final class io/getstream/chat/android/models/DraftMessage$Builder {
 	public fun <init> ()V
 	public fun <init> (Lio/getstream/chat/android/models/DraftMessage;)V
 	public final fun build ()Lio/getstream/chat/android/models/DraftMessage;
+	public final fun withArgs (Ljava/lang/String;)Lio/getstream/chat/android/models/DraftMessage$Builder;
 	public final fun withAttachments (Ljava/util/List;)Lio/getstream/chat/android/models/DraftMessage$Builder;
 	public final fun withCid (Ljava/lang/String;)Lio/getstream/chat/android/models/DraftMessage$Builder;
+	public final fun withCommand (Ljava/lang/String;)Lio/getstream/chat/android/models/DraftMessage$Builder;
 	public final fun withExtraData (Ljava/util/Map;)Lio/getstream/chat/android/models/DraftMessage$Builder;
 	public final fun withId (Ljava/lang/String;)Lio/getstream/chat/android/models/DraftMessage$Builder;
 	public final fun withMentionedUsersIds (Ljava/util/List;)Lio/getstream/chat/android/models/DraftMessage$Builder;
diff --git a/stream-chat-android-core/src/main/java/io/getstream/chat/android/models/DraftMessage.kt b/stream-chat-android-core/src/main/java/io/getstream/chat/android/models/DraftMessage.kt
@@ -75,6 +75,18 @@ public data class DraftMessage(
      */
     val replyMessage: Message? = null,
 
+    /**
+     * The name of the slash command active on this draft (e.g. `"giphy"`), or `null` when the
+     * draft is plain text.
+     */
+    val command: String? = null,
+
+    /**
+     * The arguments typed for the active slash command (the text that follows the `/name `
+     * prefix), or `null` when [command] is `null`.
+     */
+    val args: String? = null,
+
 ) : CustomObject, ComparableFieldProvider {
 
     @Suppress("ComplexMethod")
@@ -116,6 +128,8 @@ public data class DraftMessage(
         append(", silent=").append(silent)
         append(", showInChannel=").append(showInChannel)
         if (replyMessage != null) append(", replyMessage=").append(replyMessage)
+        if (command != null) append(", command=\"").append(command).append("\"")
+        if (args != null) append(", args=\"").append(args).append("\"")
         if (extraData.isNotEmpty()) append(", extraData=").append(extraData)
         append(")")
     }.toString()
@@ -136,6 +150,8 @@ public data class DraftMessage(
         private var silent: Boolean = false
         private var showInChannel: Boolean = false
         private var replyMessage: Message? = null
+        private var command: String? = null
+        private var args: String? = null
 
         public constructor(message: DraftMessage) : this() {
             id = message.id
@@ -148,6 +164,8 @@ public data class DraftMessage(
             silent = message.silent
             showInChannel = message.showInChannel
             replyMessage = message.replyMessage
+            command = message.command
+            args = message.args
         }
 
         public fun withId(id: String): Builder = apply { this.id = id }
@@ -162,6 +180,8 @@ public data class DraftMessage(
         public fun withSilent(silent: Boolean): Builder = apply { this.silent = silent }
         public fun withShowInChannel(showInChannel: Boolean): Builder = apply { this.showInChannel = showInChannel }
         public fun withReplyMessage(replyMessage: Message?): Builder = apply { this.replyMessage = replyMessage }
+        public fun withCommand(command: String?): Builder = apply { this.command = command }
+        public fun withArgs(args: String?): Builder = apply { this.args = args }
 
         public fun build(): DraftMessage {
             return DraftMessage(
@@ -175,6 +195,8 @@ public data class DraftMessage(
                 silent = silent,
                 showInChannel = showInChannel,
                 replyMessage = replyMessage,
+                command = command,
+                args = args,
             )
         }
     }
diff --git a/stream-chat-android-core/src/testFixtures/kotlin/io/getstream/chat/android/Mother.kt b/stream-chat-android-core/src/testFixtures/kotlin/io/getstream/chat/android/Mother.kt
@@ -278,6 +278,8 @@ public fun randomDraftMessage(
     silent: Boolean = randomBoolean(),
     showInChannel: Boolean = randomBoolean(),
     replyMessage: Message? = randomMessage(),
+    command: String? = null,
+    args: String? = null,
 ): DraftMessage = DraftMessage(
     id = id,
     cid = cid,
@@ -290,6 +292,8 @@ public fun randomDraftMessage(
     silent = silent,
     showInChannel = showInChannel,
     replyMessage = replyMessage,
+    command = command,
+    args = args,
 )
 
 public fun randomQueryDraftsResult(
diff --git a/stream-chat-android-ui-common/src/main/kotlin/io/getstream/chat/android/ui/common/feature/messages/composer/MessageComposerController.kt b/stream-chat-android-ui-common/src/main/kotlin/io/getstream/chat/android/ui/common/feature/messages/composer/MessageComposerController.kt
@@ -529,38 +529,68 @@ public class MessageComposerController(
     private suspend fun saveDraftMessage(messageMode: MessageMode) {
         if (!config.draftMessageEnabled) return
         currentDraftId = null
-        when (val messageText = _messageInput.value.text) {
-            "" -> clearDraftMessage(messageMode)
-            else -> {
-                getDraftMessageOrEmpty(messageMode).let {
-                    chatClient.createDraftMessage(
-                        channelType = channelType,
-                        channelId = channelId,
-                        message = it.copy(
-                            text = messageText,
-                            showInChannel = _state.value.alsoSendToChannel,
-                            replyMessage = (_messageActions.value.firstOrNull { it is Reply } as? Reply)?.message,
-                        ),
-                    ).await()
-                }
-            }
+        val inputText = _messageInput.value.text
+        // In legacy mode the slash + name + args is encoded inside `text`, so command/args fields
+        // would duplicate what's already there and confuse cross-SDK readers.
+        val activeCommand = _state.value.activeCommand.takeIf { config.activeCommandEnabled }
+        if (inputText.isEmpty() && activeCommand == null) {
+            clearDraftMessage(messageMode)
+            return
+        }
+        getDraftMessageOrEmpty(messageMode).let {
+            chatClient.createDraftMessage(
+                channelType = channelType,
+                channelId = channelId,
+                message = it.copy(
+                    text = inputText,
+                    command = activeCommand?.name,
+                    args = if (activeCommand != null) inputText else null,
+                    showInChannel = _state.value.alsoSendToChannel,
+                    replyMessage = (_messageActions.value.firstOrNull { it is Reply } as? Reply)?.message,
+                ),
+            ).await()
         }
     }
 
     private fun fetchDraftMessage(messageMode: MessageMode) {
         if (!config.draftMessageEnabled) return
+        // Drop any active command + stash carried over from the previous mode so leftover state
+        // doesn't block the new mode's reply-action restore or leak into a later cancel-restore.
+        _state.update { it.copy(activeCommand = null) }
+        discardCommandStash()
         getDraftMessageOrEmpty(messageMode).let { draftMessage ->
             currentDraftId = draftMessage.id
-            setMessageInputInternal(draftMessage.text, MessageInput.Source.DraftMessage)
-            setAlsoSendToChannel(draftMessage.showInChannel)
+            // Restore the reply action first so command-availability checks see the right action.
             draftMessage.replyMessage
                 ?.let { performMessageAction(Reply(it)) }
                 ?: run {
                     _messageActions.value = _messageActions.value.filterNot { it is Reply }.toSet()
                 }
+            val command = restoreDraftCommandIfAvailable(draftMessage.command)
+            val inputText = if (command != null) draftMessage.args ?: draftMessage.text else draftMessage.text
+            setMessageInputInternal(inputText, MessageInput.Source.DraftMessage)
+            setAlsoSendToChannel(draftMessage.showInChannel)
         }
     }
 
+    /**
+     * Activates the command from a fetched draft when [Config.activeCommandEnabled] is `true`,
+     * the command is known to the channel, and it is available for the current composer action.
+     * Updates state directly rather than via [selectCommand] — draft restore must not emit
+     * [MessageComposerViewEvent.CommandUnavailable] or trigger the pre-command stash.
+     *
+     * @param commandName The command name from the draft, or `null` for plain-text drafts.
+     * @return The restored [Command], or `null` when no command was applied.
+     */
+    private fun restoreDraftCommandIfAvailable(commandName: String?): Command? {
+        if (!config.activeCommandEnabled) return null
+        val name = commandName ?: return null
+        val command = commands.firstOrNull { it.name == name } ?: return null
+        if (!command.isAvailableFor(activeAction)) return null
+        _state.update { it.copy(activeCommand = command) }
+        return command
+    }
+
     /**
      * Called when the message mode changes and the internal state needs to be updated.
      *
diff --git a/stream-chat-android-ui-common/src/test/kotlin/io/getstream/chat/android/ui/common/feature/messages/composer/MessageComposerControllerTest.kt b/stream-chat-android-ui-common/src/test/kotlin/io/getstream/chat/android/ui/common/feature/messages/composer/MessageComposerControllerTest.kt

Original file line number	Diff line number	Diff line change
`@@ -269,6 +269,8 @@ internal class DomainMapping(`
`269`	`269`	`mentionedUsersIds = message.mentioned_users?.map { it.id } ?: emptyList(),`
`270`	`270`	`silent = message.silent,`
`271`	`271`	`text = message.text,`
	`272`	`+ command = message.command,`
	`273`	`+ args = message.args,`
`272`	`274`	`extraData = message.extraData ?: emptyMap(),`
`273`	`275`	`)`
`274`	`276`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ import io.getstream.chat.android.client.internal.offline.repository.domain.user.`
`88`	`88`	`ThreadOrderEntity::class,`
`89`	`89`	`DraftMessageEntity::class,`
`90`	`90`	`],`
`91`		`- version = 102,`
	`91`	`+ version = 103,`
`92`	`92`	`exportSchema = false,`
`93`	`93`	`)`
`94`	`94`	`@TypeConverters(`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@ internal data class DraftMessageEntity(`
`32`	`32`	`val silent: Boolean,`
`33`	`33`	`val showInChannel: Boolean,`
`34`	`34`	`val replyMessageId: String? = null,`
	`35`	`+ val command: String? = null,`
	`36`	`+ val args: String? = null,`
`35`	`37`	`val extraData: Map<String, Any> = mapOf(),`
`36`	`38`	`)`
`37`	`39`