Introduce observe entity for display

Author: TimoPtr

app/src/full/kotlin/io/homeassistant/companion/android/settings/wear/views/SettingsWearFavoritesView.kt

@@ -125,7 +125,7 @@ fun LoadWearFavoritesSettings(
                 val favoriteEntityID = favoriteEntities[index].replace("[", "").replace("]", "")
                 settingsWearViewModel.entities[favoriteEntityID]?.let { entity ->
                     // Metadata-free item, this screen has no websocket access (see the picker above)
-                    val displayEntity = remember(entity) { EntityDisplayItem.from(entity) }
+                    val displayEntity = remember(entity) { EntityDisplayItem(entity) }
                     ReorderableItem(
                         state = reorderState,
                         key = favoriteEntities[index],

app/src/main/kotlin/io/homeassistant/companion/android/settings/qs/ManageTilesViewModel.kt

@@ -171,7 +171,7 @@ internal class ManageTilesViewModel @Inject constructor(
     private fun loadEntities(serverId: Int) {
         loadEntitiesJob?.cancel()
         loadEntitiesJob = viewModelScope.launch {
-            getEntitiesForDisplay(serverId) { it.isUsableInTile() }.collect { state ->
+            getEntitiesForDisplay.snapshot(serverId) { it.isUsableInTile() }.collect { state ->
                 _state.update { it.copy(entityDisplayState = state) }
             }
         }

app/src/main/kotlin/io/homeassistant/companion/android/settings/shortcuts/legacy/ManageShortcutsViewModel.kt

@@ -96,7 +96,7 @@ internal class ManageShortcutsViewModel @Inject constructor(
             this@ManageShortcutsViewModel.servers = servers
             servers.forEach { server ->
                 launch {
-                    getEntitiesForDisplay(serverId = server.id).collect { state ->
+                    getEntitiesForDisplay.snapshot(serverId = server.id).collect { state ->
                         displayEntities[server.id] = state
                     }
                 }

app/src/main/kotlin/io/homeassistant/companion/android/settings/vehicle/ManageAndroidAutoViewModel.kt

@@ -56,7 +56,7 @@ class ManageAndroidAutoViewModel @Inject constructor(
             servers.map { server ->
                 val serverId = server.id
                 async {
-                    getEntitiesForDisplay(serverId) { isVehicleDomain(it) }.collect { state ->
+                    getEntitiesForDisplay.snapshot(serverId) { isVehicleDomain(it) }.collect { state ->
                         displayEntitiesByServer[serverId] = state
                     }
                 }

app/src/main/kotlin/io/homeassistant/companion/android/util/compose/entity/EntityPicker.kt

@@ -219,7 +219,7 @@ fun rememberEntityDisplayState(entities: List<Entity>): EntityDisplayState {
     // Conversion runs on a background dispatcher to avoid ANRs on large entity lists
     LaunchedEffect(entities) {
         displayState = withContext(Dispatchers.Default) {
-            EntityDisplayState.Loaded(entities.map(EntityDisplayItem::from))
+            EntityDisplayState.Loaded(entities.map(::EntityDisplayItem))
         }
     }
     return displayState

app/src/main/kotlin/io/homeassistant/companion/android/widgets/todo/TodoWidgetConfigureViewModel.kt

@@ -66,7 +66,7 @@ class TodoWidgetConfigureViewModel @AssistedInject constructor(
         .distinctUntilChanged()
         .flatMapLatest { serverId ->
             if (serverManager.isRegistered()) {
-                getEntitiesForDisplay(serverId = serverId) { it.domain == TODO_DOMAIN }
+                getEntitiesForDisplay.snapshot(serverId = serverId) { it.domain == TODO_DOMAIN }
             } else {
                 Timber.w("No server registered")
                 flowOf(EntityDisplayState.Loaded(emptyList()))

app/src/test/kotlin/io/homeassistant/companion/android/settings/qs/ManageTilesViewModelTest.kt

@@ -71,8 +71,8 @@ class ManageTilesViewModelTest {
         coEvery { tileDao.get(any()) } returns null
         coEvery { tileDao.getAll() } returns emptyList()
         coEvery { tileDao.add(any()) } returns 1L
+        every { getEntitiesForDisplay.snapshot(any(), any<(Entity) -> Boolean>()) } returns flowOf(EntityDisplayState.Loading)
         every { tileDao.getAllFlow() } returns flowOf(emptyList())
-        every { getEntitiesForDisplay(any(), any<(Entity) -> Boolean>()) } returns flowOf(EntityDisplayState.Loading)
     }
 
     private fun fakeServer(id: Int) = Server(
@@ -464,7 +464,7 @@ class ManageTilesViewModelTest {
         // Regression test: the filter passed to the use case must exclude entities a tile
         // cannot act on, otherwise the picker offers entities that do nothing when clicked.
         val filter = slot<(Entity) -> Boolean>()
-        every { getEntitiesForDisplay(any(), capture(filter)) } returns flowOf(EntityDisplayState.Loading)
+        every { getEntitiesForDisplay.snapshot(any(), capture(filter)) } returns flowOf(EntityDisplayState.Loading)
 
         createViewModel()
         advanceUntilIdle()
@@ -481,7 +481,7 @@ class ManageTilesViewModelTest {
         val tileId = tileSlots[0].id.value
         coEvery { tileDao.get(tileId) } returns
             fakeTile(tileId = tileId, label = "Living Room", entityId = "switch.lamp", serverId = 2)
-        every { getEntitiesForDisplay(2, any<(Entity) -> Boolean>()) } returns flow {
+        every { getEntitiesForDisplay.snapshot(2, any<(Entity) -> Boolean>()) } returns flow {
             emit(EntityDisplayState.Loading)
             delay(10_000.milliseconds)
             emit(EntityDisplayState.Loaded(emptyList()))
@@ -502,12 +502,12 @@ class ManageTilesViewModelTest {
         // that is expected to win. Without cancelling the stale in-flight collection, the slow flow
         // would emit last and clobber the fresh one.
         val icon = CommunityMaterial.getIconByMdiName("mdi:account")!!
-        every { getEntitiesForDisplay(1, any<(Entity) -> Boolean>()) } returns flow {
+        every { getEntitiesForDisplay.snapshot(1, any<(Entity) -> Boolean>()) } returns flow {
             emit(EntityDisplayState.Loading)
             delay(100.milliseconds)
             emit(EntityDisplayState.Loaded(listOf(EntityDisplayItem(entityId = "light.stale", name = "Stale", icon = icon))))
         }
-        every { getEntitiesForDisplay(2, any<(Entity) -> Boolean>()) } returns flow {
+        every { getEntitiesForDisplay.snapshot(2, any<(Entity) -> Boolean>()) } returns flow {
             emit(EntityDisplayState.Loading)
             delay(10.milliseconds)
             emit(EntityDisplayState.Loaded(listOf(EntityDisplayItem(entityId = "light.fresh", name = "Fresh", icon = icon))))

common/src/main/kotlin/io/homeassistant/companion/android/common/data/integration/display/EntityDisplayItem.kt

@@ -4,8 +4,13 @@ import androidx.compose.runtime.Immutable
 import androidx.compose.ui.unit.LayoutDirection
 import com.mikepenz.iconics.typeface.IIcon
 import io.homeassistant.companion.android.common.data.integration.Entity
+import io.homeassistant.companion.android.common.data.integration.FriendlyState
 import io.homeassistant.companion.android.common.data.integration.friendlyName
+import io.homeassistant.companion.android.common.data.integration.friendlyState
 import io.homeassistant.companion.android.common.data.integration.getIcon
+import io.homeassistant.companion.android.common.data.integration.isActive
+import io.homeassistant.companion.android.common.data.integration.isExecuting
+import io.homeassistant.companion.android.common.data.integration.supportsAlarmControlPanelArmAway
 
 private const val CATEGORY_CONFIG = "config"
 private const val CATEGORY_DIAGNOSTIC = "diagnostic"
@@ -25,12 +30,40 @@ enum class EntityCategory {
     }
 }
 
-/** Fully resolved display information for an entity. */
+/** Geographic position of an entity, resolved from its state attributes. */
+@Immutable
+data class EntityCoordinates(val latitude: Double, val longitude: Double)
+
+/** Display information specific to `alarm_control_panel` entities. */
+@Immutable
+data class AlarmDisplay(
+    /** Whether the alarm panel can be armed without entering a code. */
+    val hasNoCode: Boolean,
+)
+
+/**
+ * Everything needed to display an entity, fully resolved from the entity state and the
+ * registries: the single source of truth for entity displays, so anything a display needs
+ * should be resolved into this class at creation (see the [EntityDisplayItem] constructor
+ * that takes a [Entity]).
+ *
+ * The item is a snapshot at resolution time.
+ */
 @Immutable
 data class EntityDisplayItem(
     val entityId: String,
     val name: String,
     val icon: IIcon,
+    val state: FriendlyState = FriendlyState.Literal(""),
+    val rawState: String = "",
+    /** Whether the entity is currently executing an action. */
+    val isExecuting: Boolean = false,
+    /** Whether the entity is in an active state, for state-colored rendering. */
+    val isActive: Boolean = false,
+    /** Geographic position of the entity, null when it has none. */
+    val coordinates: EntityCoordinates? = null,
+    /** Alarm panel display information, only set for `alarm_control_panel` entities. */
+    val alarm: AlarmDisplay? = null,
     val areaName: String? = null,
     val floorName: String? = null,
     val deviceName: String? = null,
@@ -39,6 +72,41 @@ data class EntityDisplayItem(
     val displayPrecision: Int? = null,
     val labels: List<String> = emptyList(),
 ) {
+    /**
+     * Resolves the entity-derived fields from an [Entity], applying the [customIcon]
+     * and [displayPrecision] when the caller has them, so [icon] and [state] are resolved
+     * exactly once.
+     */
+    constructor(
+        entity: Entity,
+        name: String = entity.friendlyName,
+        customIcon: IIcon? = null,
+        areaName: String? = null,
+        floorName: String? = null,
+        deviceName: String? = null,
+        isHidden: Boolean = false,
+        entityCategory: EntityCategory? = null,
+        displayPrecision: Int? = null,
+        labels: List<String> = emptyList(),
+    ) : this(
+        entityId = entity.entityId,
+        name = name,
+        icon = customIcon ?: entity.getIcon(),
+        state = entity.friendlyState(displayPrecision = displayPrecision),
+        rawState = entity.state,
+        isExecuting = entity.isExecuting(),
+        isActive = entity.isActive(),
+        coordinates = entity.coordinates(),
+        alarm = entity.alarmDisplay(),
+        areaName = areaName,
+        floorName = floorName,
+        deviceName = deviceName,
+        isHidden = isHidden,
+        entityCategory = entityCategory,
+        displayPrecision = displayPrecision,
+        labels = labels,
+    )
+
     val domain: String get() = entityId.substringBefore('.')
 
     /**
@@ -50,15 +118,17 @@ data class EntityDisplayItem(
         ?.joinToString(if (layoutDirection == LayoutDirection.Ltr) " ▸ " else " ◂ ")
 
     companion object {
-        /**
-         * Builds an item from an [Entity] alone, without any registry metadata (no
-         * area/floor/device names). Meant for callers that cannot reach the websocket API,
-         * such as the Wear favorites settings screen, and for previews.
-         */
-        fun from(entity: Entity): EntityDisplayItem = EntityDisplayItem(
-            entityId = entity.entityId,
-            name = entity.friendlyName,
-            icon = entity.getIcon(),
-        )
+        private fun Entity.alarmDisplay(): AlarmDisplay? {
+            if (domain != "alarm_control_panel") return null
+            return AlarmDisplay(
+                hasNoCode = attributes["code_format"] == null && supportsAlarmControlPanelArmAway(),
+            )
+        }
+
+        private fun Entity.coordinates(): EntityCoordinates? {
+            val latitude = (attributes["latitude"] as? Number)?.toDouble()
+            val longitude = (attributes["longitude"] as? Number)?.toDouble()
+            return if (latitude != null && longitude != null) EntityCoordinates(latitude, longitude) else null
+        }
     }
 }