Make sure that widgets don't crash the app when server is removed (#6295)

TimoPtr · web-flow · commit cfcdcbf4d0b0 · 2026-01-22T08:43:58.000Z
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/widgets/camera/CameraWidget.kt b/app/src/main/kotlin/io/homeassistant/companion/android/widgets/camera/CameraWidget.kt
@@ -35,6 +35,7 @@ import io.homeassistant.companion.android.widgets.BaseWidgetProvider.Companion.w
 import io.homeassistant.companion.android.widgets.EXTRA_WIDGET_ENTITY
 import io.homeassistant.companion.android.widgets.common.RemoteViewsTarget
 import javax.inject.Inject
+import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
@@ -127,21 +128,28 @@ class CameraWidget : AppWidgetProvider() {
         var widgetCameraError = false
         var url: String? = null
         if (widget != null) {
-            try {
-                val entityPictureUrl = retrieveCameraImageUrl(widget.serverId, widget.entityId)
-
-                val urlState = serverManager.connectionStateProvider(
-                    widget.serverId,
-                ).urlFlow().first()
-                if (urlState is UrlState.HasUrl) {
-                    val baseUrl = urlState.url?.toString()?.removeSuffix("/") ?: ""
-                    url = "$baseUrl$entityPictureUrl"
-                } else {
-                    throw IllegalStateException("No URL available to retrieve picture")
-                }
-            } catch (e: Exception) {
-                Timber.e(e, "Failed to fetch entity or entity does not exist")
+            if (serverManager.getServer(widget.serverId) == null) {
+                Timber.w("Widget is attached to a server that has been removed")
                 widgetCameraError = true
+            } else {
+                try {
+                    val entityPictureUrl = retrieveCameraImageUrl(widget.serverId, widget.entityId)
+
+                    val urlState = serverManager.connectionStateProvider(
+                        widget.serverId,
+                    ).urlFlow().first()
+                    if (urlState is UrlState.HasUrl) {
+                        val baseUrl = urlState.url?.toString()?.removeSuffix("/") ?: ""
+                        url = "$baseUrl$entityPictureUrl"
+                    } else {
+                        throw IllegalStateException("No URL available to retrieve picture")
+                    }
+                } catch (e: CancellationException) {
+                    throw e
+                } catch (e: Exception) {
+                    Timber.e(e, "Failed to fetch entity or entity does not exist")
+                    widgetCameraError = true
+                }
             }
         }
 
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/widgets/entity/EntityWidget.kt b/app/src/main/kotlin/io/homeassistant/companion/android/widgets/entity/EntityWidget.kt
@@ -161,6 +161,8 @@ class EntityWidget : BaseWidgetProvider<StaticWidgetEntity, StaticWidgetDao>() {
             } else {
                 entityId?.let { serverManager.integrationRepository(serverId).getEntity(it) }
             }
+        } catch (e: CancellationException) {
+            throw e
         } catch (e: Exception) {
             Timber.e(e, "Unable to fetch entity")
             entityCaughtException = true
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/widgets/mediaplayer/MediaPlayerControlsWidget.kt b/app/src/main/kotlin/io/homeassistant/companion/android/widgets/mediaplayer/MediaPlayerControlsWidget.kt
@@ -244,9 +244,16 @@ class MediaPlayerControlsWidget : BaseWidgetProvider<MediaPlayerControlsWidgetEn
                 )
 
                 val entityPictureUrl = entity?.attributes?.get("entity_picture")?.toString()
-                val baseUrl = serverManager.connectionStateProvider(
-                    widget.serverId,
-                ).urlFlow().firstUrlOrNull()?.toString()?.removeSuffix("/") ?: ""
+                val baseUrl = try {
+                    serverManager.connectionStateProvider(
+                        widget.serverId,
+                    )
+                } catch (e: CancellationException) {
+                    throw e
+                } catch (e: IllegalStateException) {
+                    Timber.e(e, "The server does not exist anymore, could have been removed")
+                    null
+                }?.urlFlow()?.firstUrlOrNull()?.toString()?.removeSuffix("/") ?: ""
                 val url = if (entityPictureUrl?.startsWith("http") ==
                     true
                 ) {
@@ -427,8 +434,10 @@ class MediaPlayerControlsWidget : BaseWidgetProvider<MediaPlayerControlsWidgetEn
                 }
                 return entities[0]
             }
+        } catch (e: CancellationException) {
+            throw e
         } catch (e: Exception) {
-            Timber.d("Failed to fetch entity or entity does not exist")
+            Timber.d(e, "Failed to fetch entity or entity does not exist")
             if (lastIntent == UPDATE_MEDIA_IMAGE) {
                 Toast.makeText(context, commonR.string.widget_entity_fetch_error, Toast.LENGTH_LONG).show()
             }
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetActions.kt b/app/src/main/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetActions.kt
@@ -118,6 +118,11 @@ class ToggleTodoAction : ActionCallback {
             return
         }
 
+        if (serverManager.getServer(widgetEntity.serverId) == null) {
+            Timber.w("Aborting the server has been removed, widget needs to be configured again")
+            return
+        }
+
         val result = serverManager.webSocketRepository(widgetEntity.serverId).updateTodo(
             entityId = widgetEntity.entityId,
             todoItem = todoItem.uid,
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetStateUpdater.kt b/app/src/main/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetStateUpdater.kt
@@ -49,6 +49,11 @@ internal class TodoWidgetStateUpdater @Inject constructor(
     }
 
     private suspend fun getAndSubscribeEntityUpdates(serverId: Int, listEntityId: String): Flow<Entity?>? {
+        if (serverManager.getServer(serverId) == null) {
+            Timber.w("Server has been removed and the widget needs to be reconfigured")
+            return null
+        }
+
         // Since we might be re-subscribing we might not have get the entity update when subscribing so we query it first
         val currentEntity = serverManager.integrationRepository(serverId).getEntity(listEntityId)
 
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetStateUpdaterTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetStateUpdaterTest.kt
@@ -64,6 +64,7 @@ Initial state emission
             awaitClose()
         }
         coEvery { dao.get(widgetId) } returns todoWidgetEntity
+        coEvery { serverManager.getServer(any<Int>()) } returns mockk()
         coJustAwait { integrationRepository.getEntity(entityId) }
 
         updater.stateFlow(42).test {
@@ -73,6 +74,27 @@ Initial state emission
         }
     }
 
+    @Test
+    fun `Given widgetId in DAO with a removed server when subscribing to stateFlow then emits DAO Entry current state out of sync`() = runTest {
+        val widgetId = 42
+        val entityId = "test"
+        val todoWidgetEntity = TodoWidgetEntity(widgetId, 1, entityId)
+
+        coEvery { dao.getFlow(widgetId) } returns channelFlow {
+            send(todoWidgetEntity)
+            awaitClose()
+        }
+        coEvery { dao.get(widgetId) } returns todoWidgetEntity
+        coEvery { serverManager.getServer(any<Int>()) } returns null
+        coJustAwait { integrationRepository.getEntity(entityId) }
+
+        updater.stateFlow(42).test {
+            assertEquals(TodoStateWithData.from(todoWidgetEntity), awaitItem())
+            assertEquals(TodoStateWithData.from(todoWidgetEntity), awaitItem())
+            expectNoEvents()
+        }
+    }
+
     @Test
     fun `Given widgetID when subscribing to stateFlow with error then it catches and complete the flow`() = runTest {
         val widgetId = 42
@@ -106,6 +128,7 @@ Watch for update
             awaitClose()
         }
         coJustRun { dao.updateWidgetLastUpdate(any(), any()) }
+        coEvery { serverManager.getServer(any<Int>()) } returns mockk()
 
         coEvery { integrationRepository.getEntity(entityId) } returns serverEntity
         coEvery { integrationRepository.getEntityUpdates(any()) } returns channelFlow {
@@ -156,6 +179,7 @@ Watch for update
             awaitClose()
         }
         coJustRun { dao.updateWidgetLastUpdate(any(), any()) }
+        coEvery { serverManager.getServer(any<Int>()) } returns mockk()
 
         coEvery { integrationRepository.getEntity(entityId) } returns serverEntity
         coEvery { integrationRepository.getEntityUpdates(any()) } returns channelFlow {
@@ -212,6 +236,7 @@ Watch for update
             awaitClose()
         }
         coJustRun { dao.updateWidgetLastUpdate(any(), any()) }
+        coEvery { serverManager.getServer(any<Int>()) } returns mockk()
 
         coEvery { integrationRepository.getEntity(entityId) } returns serverEntity
         coEvery { integrationRepository.getEntityUpdates(any()) } returns null
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetToggleActionsTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetToggleActionsTest.kt
@@ -98,6 +98,7 @@ class TodoWidgetToggleActionsTest {
         coEvery {
             entryPoints.webSocketRepository.updateTodo(any(), any(), any(), any())
         } returns true
+        coEvery { entryPoints.serverManager.getServer(42) } returns mockk()
 
         coEvery { entryPoints.dao().get(widgetId) } returns todoItem
 
@@ -116,6 +117,32 @@ class TodoWidgetToggleActionsTest {
         }
     }
 
+    @Test
+    fun `Given a widgetID and todo item state with uid but server removed when present in DAO and invoking onAction then do nothing`() = runTest {
+        val action = spyk<ToggleTodoAction>()
+        val glanceManager = mockk<GlanceAppWidgetManager>()
+        val widgetId = 1
+        val todoItem = TodoWidgetEntity(1, 42, "HA")
+        val parameters = actionParametersOf(TOGGLE_KEY to TodoItemState("42", "", false))
+
+        every { action.getEntryPoints(any()) } returns entryPoints
+        every { action.getGlanceManager(any()) } returns glanceManager
+        every { glanceManager.getAppWidgetId(any()) } returns widgetId
+        coEvery { entryPoints.serverManager.getServer(42) } returns null
+
+        coEvery { entryPoints.dao().get(widgetId) } returns todoItem
+
+        action.onAction(mockk(), FakeGlanceId(widgetId), parameters)
+
+        coVerify(exactly = 1) {
+            entryPoints.dao().get(widgetId)
+            entryPoints.serverManager().getServer(42)
+        }
+        coVerify(exactly = 0) {
+            entryPoints.serverManager().webSocketRepository(any())
+        }
+    }
+
     @Test
     fun `Given boolean value when invoking toggleStatus then mapping is valid from the API point of view`() {
         val action = ToggleTodoAction()
diff --git a/common/src/main/kotlin/io/homeassistant/companion/android/common/data/servers/ServerManager.kt b/common/src/main/kotlin/io/homeassistant/companion/android/common/data/servers/ServerManager.kt
@@ -81,7 +81,7 @@ interface ServerManager {
      *
      * @param serverId the server ID, or [SERVER_ID_ACTIVE] for the currently active server
      * @return [AuthenticationRepository] for the server
-     * @throws IllegalArgumentException if there is no server with the provided ID
+     * @throws IllegalStateException if there is no server with the provided ID
      */
     suspend fun authenticationRepository(serverId: Int = SERVER_ID_ACTIVE): AuthenticationRepository
 
@@ -90,7 +90,7 @@ interface ServerManager {
      *
      * @param serverId the server ID, or [SERVER_ID_ACTIVE] for the currently active server
      * @return [IntegrationRepository] for the server
-     * @throws IllegalArgumentException if there is no server with the provided ID
+     * @throws IllegalStateException if there is no server with the provided ID
      */
     suspend fun integrationRepository(serverId: Int = SERVER_ID_ACTIVE): IntegrationRepository
 
@@ -99,7 +99,7 @@ interface ServerManager {
      *
      * @param serverId the server ID, or [SERVER_ID_ACTIVE] for the currently active server
      * @return [WebSocketRepository] for the server
-     * @throws IllegalArgumentException if there is no server with the provided ID
+     * @throws IllegalStateException if there is no server with the provided ID
      */
     suspend fun webSocketRepository(serverId: Int = SERVER_ID_ACTIVE): WebSocketRepository
 
@@ -108,7 +108,7 @@ interface ServerManager {
      *
      * @param serverId the server ID, or [SERVER_ID_ACTIVE] for the currently active server
      * @return [ServerConnectionStateProvider] for the server
-     * @throws IllegalArgumentException if there is no server with the provided ID
+     * @throws IllegalStateException if there is no server with the provided ID
      */
     suspend fun connectionStateProvider(serverId: Int = SERVER_ID_ACTIVE): ServerConnectionStateProvider
 }

Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,8 @@ class EntityWidget : BaseWidgetProvider<StaticWidgetEntity, StaticWidgetDao>() {`
`161`	`161`	`} else {`
`162`	`162`	`entityId?.let { serverManager.integrationRepository(serverId).getEntity(it) }`
`163`	`163`	`}`
	`164`	`+ } catch (e: CancellationException) {`
	`165`	`+ throw e`
`164`	`166`	`} catch (e: Exception) {`
`165`	`167`	`Timber.e(e, "Unable to fetch entity")`
`166`	`168`	`entityCaughtException = true`