Open Assist external message in FrontendScreen (#6477)

TimoPtr · web-flow · commit ba3169b33be7 · 2026-03-02T15:09:20.000+01:00
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModel.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModel.kt
@@ -254,6 +254,16 @@ internal class FrontendViewModel @VisibleForTesting constructor(
                 _navigationEvents.tryEmit(FrontendNavigationEvent.NavigateToSettings)
             }
 
+            is FrontendHandlerEvent.ShowAssist -> {
+                _navigationEvents.tryEmit(
+                    FrontendNavigationEvent.NavigateToAssist(
+                        serverId = _viewState.value.serverId,
+                        pipelineId = result.pipelineId,
+                        startListening = result.startListening,
+                    ),
+                )
+            }
+
             is FrontendHandlerEvent.AuthError -> {
                 onError(result.error)
             }
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessage.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessage.kt
@@ -106,3 +106,22 @@ data class OpenSettingsMessage(override val id: Int? = null) : IncomingExternalB
 @Serializable
 @SerialName("theme-update")
 data class ThemeUpdateMessage(override val id: Int? = null) : IncomingExternalBusMessage
+
+/**
+ * Message requesting the app to open the voice assistant (Assist).
+ *
+ * Sent when the user triggers the voice assistant from the frontend UI.
+ * No response is expected for this message.
+ */
+@Serializable
+@SerialName("assist/show")
+data class OpenAssistMessage(
+    override val id: Int? = null,
+    val payload: OpenAssistPayload = OpenAssistPayload(),
+) : IncomingExternalBusMessage
+
+@Serializable
+data class OpenAssistPayload(
+    @SerialName("pipeline_id") val pipelineId: String? = null,
+    @SerialName("start_listening") val startListening: Boolean = true,
+)
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendHandlerEvent.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendHandlerEvent.kt
@@ -30,6 +30,11 @@ sealed interface FrontendHandlerEvent {
      */
     data object OpenSettings : FrontendHandlerEvent
 
+    /**
+     * User triggered the voice assistant from the frontend.
+     */
+    data class ShowAssist(val pipelineId: String?, val startListening: Boolean) : FrontendHandlerEvent
+
     /**
      * Frontend theme changed (colors, dark mode, etc.).
      */
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandler.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandler.kt
@@ -12,6 +12,7 @@ import io.homeassistant.companion.android.frontend.externalbus.WebViewScript
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConfigGetMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConnectionStatusMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.IncomingExternalBusMessage
+import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ThemeUpdateMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.UnknownIncomingMessage
@@ -163,6 +164,14 @@ class FrontendMessageHandler @Inject constructor(
                 FrontendHandlerEvent.OpenSettings
             }
 
+            is OpenAssistMessage -> {
+                Timber.d("Open assist request received with id: ${message.id}")
+                FrontendHandlerEvent.ShowAssist(
+                    pipelineId = message.payload.pipelineId,
+                    startListening = message.payload.startListening,
+                )
+            }
+
             is ThemeUpdateMessage -> {
                 Timber.d("Theme update received")
                 FrontendHandlerEvent.ThemeUpdated
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigation.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigation.kt
@@ -12,6 +12,7 @@ import androidx.navigation.activity
 import androidx.navigation.compose.composable
 import androidx.navigation.toRoute
 import io.homeassistant.companion.android.WIPFeature
+import io.homeassistant.companion.android.assist.AssistActivity
 import io.homeassistant.companion.android.common.data.servers.ServerManager.Companion.SERVER_ID_ACTIVE
 import io.homeassistant.companion.android.frontend.FrontendScreen
 import io.homeassistant.companion.android.frontend.FrontendViewModel
@@ -72,6 +73,16 @@ internal fun NavGraphBuilder.frontendScreen(
             FrontendNavigationHandler(
                 navigationEvents = viewModel.navigationEvents,
                 onNavigateToSettings = onNavigateToSettings,
+                onNavigateToAssist = { serverId, pipelineId, startListening ->
+                    navController.context.startActivity(
+                        AssistActivity.newInstance(
+                            context = navController.context,
+                            serverId = serverId,
+                            pipelineId = pipelineId,
+                            startListening = startListening,
+                        ),
+                    )
+                },
             )
 
             FrontendScreen(
@@ -107,13 +118,18 @@ internal fun NavGraphBuilder.frontendScreen(
 internal fun FrontendNavigationHandler(
     navigationEvents: SharedFlow<FrontendNavigationEvent>,
     onNavigateToSettings: () -> Unit,
+    onNavigateToAssist: (serverId: Int, pipelineId: String?, startListening: Boolean) -> Unit,
 ) {
     LaunchedEffect(Unit) {
         navigationEvents.collect { event ->
             when (event) {
                 is FrontendNavigationEvent.NavigateToSettings -> {
                     onNavigateToSettings()
                 }
+
+                is FrontendNavigationEvent.NavigateToAssist -> {
+                    onNavigateToAssist(event.serverId, event.pipelineId, event.startListening)
+                }
             }
         }
     }
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationEvent.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationEvent.kt
@@ -13,4 +13,11 @@ package io.homeassistant.companion.android.frontend.navigation
 sealed interface FrontendNavigationEvent {
     /** Navigate to the app settings screen */
     data object NavigateToSettings : FrontendNavigationEvent
+
+    /** Navigate to the voice assistant (Assist) screen */
+    data class NavigateToAssist(
+        val serverId: Int,
+        val pipelineId: String?,
+        val startListening: Boolean,
+    ) : FrontendNavigationEvent
 }
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModelTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModelTest.kt
@@ -372,6 +372,34 @@ class FrontendViewModelTest {
             assertEquals(authError, (state as FrontendViewState.Error).error)
         }
 
+        @Test
+        fun `Given show assist message result when collected then NavigateToAssist event is emitted`() = runTest {
+            val messageFlow = MutableSharedFlow<FrontendHandlerEvent>()
+            every { externalBusHandler.messageResults() } returns messageFlow
+            every { urlManager.serverUrlFlow(any(), any()) } returns flowOf(
+                UrlLoadResult.Success(url = testUrlWithAuth, serverId = serverId),
+            )
+
+            val viewModel = createViewModel()
+
+            // Collect navigation events
+            val navigationEvents = mutableListOf<FrontendNavigationEvent>()
+            val job = backgroundScope.launch { viewModel.navigationEvents.collect { navigationEvents.add(it) } }
+
+            advanceTimeBy(CONNECTION_TIMEOUT - 1.seconds)
+
+            // Emit show assist message
+            messageFlow.emit(FrontendHandlerEvent.ShowAssist(pipelineId = "abc", startListening = false))
+            advanceUntilIdle()
+
+            val event = navigationEvents.filterIsInstance<FrontendNavigationEvent.NavigateToAssist>().firstOrNull()
+            assertTrue(event != null, "Expected NavigateToAssist event")
+            assertEquals(serverId, event!!.serverId)
+            assertEquals("abc", event.pipelineId)
+            assertEquals(false, event.startListening)
+            job.cancel()
+        }
+
         @Test
         fun `Given open settings message result when collected then navigation event is emitted`() = runTest {
             val messageFlow = MutableSharedFlow<FrontendHandlerEvent>()
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessageTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessageTest.kt
@@ -1,9 +1,10 @@
 package io.homeassistant.companion.android.frontend.externalbus.incoming
 
 import io.homeassistant.companion.android.frontend.externalbus.frontendExternalBusJson
-import org.junit.jupiter.api.Assertions
 import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertInstanceOf
+import org.junit.jupiter.api.Assertions.assertNull
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Test
 
@@ -17,7 +18,7 @@ class IncomingExternalBusMessageTest {
 
         assertInstanceOf(ConnectionStatusMessage::class.java, message)
         val statusMessage = message as ConnectionStatusMessage
-        Assertions.assertEquals(1, statusMessage.id)
+        assertEquals(1, statusMessage.id)
         assertEquals("connected", statusMessage.payload.event)
         assertTrue(statusMessage.payload.isConnected)
     }
@@ -29,7 +30,7 @@ class IncomingExternalBusMessageTest {
         val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
 
         assertInstanceOf(ConfigGetMessage::class.java, message)
-        Assertions.assertEquals(42, (message as ConfigGetMessage).id)
+        assertEquals(42, (message as ConfigGetMessage).id)
     }
 
     @Test
@@ -39,7 +40,7 @@ class IncomingExternalBusMessageTest {
         val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
 
         assertInstanceOf(ThemeUpdateMessage::class.java, message)
-        Assertions.assertEquals(5, (message as ThemeUpdateMessage).id)
+        assertEquals(5, (message as ThemeUpdateMessage).id)
     }
 
     @Test
@@ -49,7 +50,33 @@ class IncomingExternalBusMessageTest {
         val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
 
         assertInstanceOf(OpenSettingsMessage::class.java, message)
-        Assertions.assertEquals(5, (message as OpenSettingsMessage).id)
+        assertEquals(5, (message as OpenSettingsMessage).id)
+    }
+
+    @Test
+    fun `Given assist-show JSON then parses to OpenAssistMessage with payload`() {
+        val json = """{"type":"assist/show","id":7,"payload":{"pipeline_id":"abc","start_listening":false}}"""
+
+        val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
+
+        assertInstanceOf(OpenAssistMessage::class.java, message)
+        val assistMessage = message as OpenAssistMessage
+        assertEquals(7, assistMessage.id)
+        assertEquals("abc", assistMessage.payload.pipelineId)
+        assertFalse(assistMessage.payload.startListening)
+    }
+
+    @Test
+    fun `Given assist-show JSON without payload then parses to OpenAssistMessage with defaults`() {
+        val json = """{"type":"assist/show","id":8}"""
+
+        val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
+
+        assertInstanceOf(OpenAssistMessage::class.java, message)
+        val assistMessage = message as OpenAssistMessage
+        assertEquals(8, assistMessage.id)
+        assertNull(assistMessage.payload.pipelineId)
+        assertTrue(assistMessage.payload.startListening)
     }
 
     @Test
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandlerTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandlerTest.kt
@@ -11,6 +11,8 @@ import io.homeassistant.companion.android.frontend.externalbus.WebViewScript
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConfigGetMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConnectionStatusMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConnectionStatusPayload
+import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistMessage
+import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistPayload
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ThemeUpdateMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.UnknownIncomingMessage
@@ -199,6 +201,24 @@ class FrontendMessageHandlerTest {
         assertEquals(0, configResult["hasBarCodeScanner"]?.jsonPrimitive?.int)
     }
 
+    @Test
+    fun `Given open assist message when messageResults then emits ShowAssist with payload`() = runTest {
+        val message = OpenAssistMessage(
+            id = 7,
+            payload = OpenAssistPayload(pipelineId = "abc", startListening = false),
+        )
+        every { externalBusRepository.incomingMessages() } returns flowOf(message)
+
+        handler.messageResults().test {
+            val result = awaitItem()
+            assertTrue(result is FrontendHandlerEvent.ShowAssist)
+            val showAssist = result as FrontendHandlerEvent.ShowAssist
+            assertEquals("abc", showAssist.pipelineId)
+            assertEquals(false, showAssist.startListening)
+            expectNoEvents()
+        }
+    }
+
     @Test
     fun `Given open settings message when messageResults then emits OpenSettings`() = runTest {
         val message = OpenSettingsMessage(id = 1)
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationTest.kt
@@ -38,6 +38,7 @@ class FrontendNavigationTest {
             FrontendNavigationHandler(
                 navigationEvents = navigationEvents,
                 onNavigateToSettings = { settingsNavigated = true },
+                onNavigateToAssist = { _, _, _ -> },
             )
         }
 
@@ -47,4 +48,38 @@ class FrontendNavigationTest {
 
         assertEquals(true, settingsNavigated)
     }
+
+    @Test
+    fun `Given NavigateToAssist event then onNavigateToAssist is called with correct params`() = runTest {
+        var capturedServerId: Int? = null
+        var capturedPipelineId: String? = null
+        var capturedStartListening: Boolean? = null
+        val navigationEvents = MutableSharedFlow<FrontendNavigationEvent>()
+
+        composeTestRule.setContent {
+            FrontendNavigationHandler(
+                navigationEvents = navigationEvents,
+                onNavigateToSettings = { },
+                onNavigateToAssist = { serverId, pipelineId, startListening ->
+                    capturedServerId = serverId
+                    capturedPipelineId = pipelineId
+                    capturedStartListening = startListening
+                },
+            )
+        }
+
+        composeTestRule.waitForIdle()
+        navigationEvents.emit(
+            FrontendNavigationEvent.NavigateToAssist(
+                serverId = 1,
+                pipelineId = "abc",
+                startListening = false,
+            ),
+        )
+        composeTestRule.waitForIdle()
+
+        assertEquals(1, capturedServerId)
+        assertEquals("abc", capturedPipelineId)
+        assertEquals(false, capturedStartListening)
+    }
 }
