Persist Entity and Device registry (#4157)

<!-- Thank you for submitting a Pull Request and helping to improve Home
Assistant. Please complete the following sections to help the processing
and review of your changes. Please do not delete anything from this
template. -->

## Summary
<!-- Provide a brief summary of the changes you have made and most
importantly what they aim to achieve -->

## Screenshots
<!-- If this is a user-facing change not in the frontend, please include
screenshots in light and dark mode. -->

## Link to pull request in Documentation repository
<!-- Pull requests that add, change or remove functionality must have a
corresponding pull request in the Companion App Documentation repository
(https://github.com/home-assistant/companion.home-assistant). Please add
the number of this pull request after the "#" -->
Documentation: home-assistant/companion.home-assistant#

## Any other notes
<!-- If there is any other information of note, like if this Pull
Request is part of a bigger change, please include it here. -->

Author: bgoncal

HomeAssistant.xcodeproj/project.pbxproj

@@ -55,16 +55,22 @@ final class MagicItemAddViewModel: ObservableObject {
     }
 
     func subtitleForEntity(entity: HAAppEntity, serverId: String) -> String {
-        // Fetch area from database based on entity
-        do {
-            let areas = try AppArea.fetchAreas(containingEntity: entity.entityId, serverId: serverId)
-            if let area = areas.first {
-                return area.name
+        var subtitle = ""
+        if let areaName = entity.area?.name, !areaName.isEmpty {
+            subtitle = areaName
+        }
+        if let deviceName = entity.device?.name,
+           !deviceName.isEmpty,
+           deviceName.range(of: entity.name, options: [.caseInsensitive, .diacriticInsensitive]) == nil {
+            if !subtitle.isEmpty {
+                subtitle += " • "
             }
-        } catch {
-            Current.Log.error("Failed to fetch area for entity from database: \(error.localizedDescription)")
+            subtitle += deviceName
+        }
+        if subtitle.isEmpty {
+            subtitle = entity.entityId
         }
-        return entity.entityId
+        return subtitle
     }
 
     @MainActor

Sources/App/Settings/MagicItem/Add/MagicItemAddViewModel.swift

@@ -15,7 +15,7 @@ final class EntityPickerViewModel: ObservableObject {
 
     func fetchEntities() {
         do {
-            var newEntities = try HAAppEntity.config() ?? []
+            var newEntities = try HAAppEntity.config()
             if let domainFilter {
                 newEntities = newEntities.filter({ entity in
                     entity.domain == domainFilter.rawValue

Sources/App/Settings/MagicItem/EntityPickerViewModel.swift

@@ -0,0 +1,105 @@
+import Foundation
+import GRDB
+
+public extension HAAppEntity {
+    var area: AppArea? {
+        do {
+            let areas = try AppArea.fetchAreas(for: serverId)
+
+            return areas.first { area in
+                area.entities.contains(entityId)
+            }
+        } catch {
+            Current.Log.error("Failed to fetch areas for entity \(entityId): \(error)")
+            return nil
+        }
+    }
+
+    var device: AppDeviceRegistry? {
+        do {
+            let entityRegistry = try Current.database().read { db in
+                try AppEntityRegistry
+                    .filter(Column(DatabaseTables.EntityRegistry.serverId.rawValue) == serverId)
+                    .filter(Column(DatabaseTables.EntityRegistry.entityId.rawValue) == entityId)
+                    .fetchOne(db)
+            }
+            let deviceId = entityRegistry?.deviceId
+            let device = try Current.database().read { db in
+                try AppDeviceRegistry
+                    .filter(Column(DatabaseTables.DeviceRegistry.serverId.rawValue) == serverId)
+                    .filter(Column(DatabaseTables.DeviceRegistry.deviceId.rawValue) == deviceId)
+                    .fetchOne(db)
+            }
+            return device
+        } catch {
+            Current.Log.error("Failed to fetch device for entity \(entityId): \(error)")
+            return nil
+        }
+    }
+}
+
+public extension [HAAppEntity] {
+    /// Creates a mapping from entity IDs to their associated areas for a given server.
+    /// - Parameter serverId: The server identifier to filter areas by.
+    /// - Returns: A dictionary mapping entity IDs to their corresponding `AppArea` objects.
+    func areasMap(for serverId: String) -> [String: AppArea] {
+        do {
+            let areas = try AppArea.fetchAreas(for: serverId)
+
+            var entityToAreaMap: [String: AppArea] = [:]
+
+            // Iterate through areas and map each entity to its area
+            for area in areas {
+                for entityId in area.entities {
+                    entityToAreaMap[entityId] = area
+                }
+            }
+
+            return entityToAreaMap
+        } catch {
+            Current.Log.error("Failed to fetch areas for mapping: \(error)")
+            return [:]
+        }
+    }
+
+    /// Creates a mapping from entity IDs to their associated devices for a given server.
+    /// - Parameter serverId: The server identifier to filter entities and devices by.
+    /// - Returns: A dictionary mapping entity IDs to their corresponding `AppDeviceRegistry` objects.
+    func devicesMap(for serverId: String) -> [String: AppDeviceRegistry] {
+        do {
+            // Fetch all entity registries for the server
+            let entityRegistries = try Current.database().read { db in
+                try AppEntityRegistry
+                    .filter(Column(DatabaseTables.EntityRegistry.serverId.rawValue) == serverId)
+                    .fetchAll(db)
+            }
+
+            // Fetch all devices for the server
+            let devices = try Current.database().read { db in
+                try AppDeviceRegistry
+                    .filter(Column(DatabaseTables.DeviceRegistry.serverId.rawValue) == serverId)
+                    .fetchAll(db)
+            }
+
+            // Create device lookup by deviceId
+            let devicesByDeviceId = Dictionary(uniqueKeysWithValues: devices.map { ($0.deviceId, $0) })
+
+            // Map entity IDs to devices
+            var entityToDeviceMap: [String: AppDeviceRegistry] = [:]
+
+            for entityRegistry in entityRegistries {
+                guard let entityId = entityRegistry.entityId,
+                      let deviceId = entityRegistry.deviceId,
+                      let device = devicesByDeviceId[deviceId] else {
+                    continue
+                }
+                entityToDeviceMap[entityId] = device
+            }
+
+            return entityToDeviceMap
+        } catch {
+            Current.Log.error("Failed to fetch devices for mapping: \(error)")
+            return [:]
+        }
+    }
+}

Sources/Extensions/EntityProvider+Details.swift

@@ -14,22 +14,50 @@ struct IntentCoverEntity: AppEntity {
     var id: String
     var entityId: String
     var serverId: String
+    var areaName: String?
+    var deviceName: String?
     var displayString: String
     var iconName: String
     var displayRepresentation: DisplayRepresentation {
-        DisplayRepresentation(title: "\(displayString)")
+        DisplayRepresentation(
+            title: "\(displayString)",
+            subtitle: .init(stringLiteral: subtitle)
+        )
+    }
+
+    private var subtitle: String {
+        var subtitle = ""
+        if let areaName {
+            subtitle += areaName
+        }
+
+        if let deviceName,
+           deviceName.trimmingCharacters(in: .whitespacesAndNewlines).lowercased() != displayString.lowercased()
+           .trimmingCharacters(in: .whitespacesAndNewlines) {
+            if subtitle.isEmpty {
+                subtitle += deviceName
+            } else {
+                subtitle += " → \(deviceName)"
+            }
+        }
+
+        return subtitle
     }
 
     init(
         id: String,
         entityId: String,
         serverId: String,
+        areaName: String? = nil,
+        deviceName: String? = nil,
         displayString: String,
         iconName: String
     ) {
         self.id = id
         self.entityId = entityId
         self.serverId = serverId
+        self.areaName = areaName
+        self.deviceName = deviceName
         self.displayString = displayString
         self.iconName = iconName
     }
@@ -42,12 +70,12 @@ struct IntentCoverAppEntityQuery: EntityQuery, EntityStringQuery {
     }
 
     func entities(matching string: String) async throws -> IntentItemCollection<IntentCoverEntity> {
-        let CoveresPerServer = await getCoverEntities()
+        let CoveresPerServer = await getCoverEntities(matching: string)
 
         return .init(sections: CoveresPerServer.map { (key: Server, value: [IntentCoverEntity]) in
             .init(
                 .init(stringLiteral: key.info.name),
-                items: value.filter({ $0.displayString.lowercased().contains(string.lowercased()) })
+                items: value
             )
         })
     }
@@ -65,11 +93,15 @@ struct IntentCoverAppEntityQuery: EntityQuery, EntityStringQuery {
         let entities = ControlEntityProvider(domains: [.cover]).getEntities(matching: string)
 
         for (server, values) in entities {
+            let deviceMap = values.devicesMap(for: server.identifier.rawValue)
+            let areasMap = values.areasMap(for: server.identifier.rawValue)
             coverEntities.append((server, values.map({ entity in
                 IntentCoverEntity(
                     id: entity.id,
                     entityId: entity.entityId,
                     serverId: entity.serverId,
+                    areaName: areasMap[entity.entityId]?.name,
+                    deviceName: deviceMap[entity.entityId]?.name,
                     displayString: entity.name,
                     iconName: entity.icon ?? SFSymbol.blindsVerticalOpen.rawValue
                 )

Sources/Extensions/Widgets/Controls/Cover/IntentCoverEntity.swift

@@ -14,22 +14,50 @@ struct IntentFanEntity: AppEntity {
     var id: String
     var entityId: String
     var serverId: String
+    var areaName: String?
+    var deviceName: String?
     var displayString: String
     var iconName: String
     var displayRepresentation: DisplayRepresentation {
-        DisplayRepresentation(title: "\(displayString)")
+        DisplayRepresentation(
+            title: "\(displayString)",
+            subtitle: .init(stringLiteral: subtitle)
+        )
+    }
+
+    private var subtitle: String {
+        var subtitle = ""
+        if let areaName {
+            subtitle += areaName
+        }
+
+        if let deviceName,
+           deviceName.trimmingCharacters(in: .whitespacesAndNewlines).lowercased() != displayString.lowercased()
+           .trimmingCharacters(in: .whitespacesAndNewlines) {
+            if subtitle.isEmpty {
+                subtitle += deviceName
+            } else {
+                subtitle += " → \(deviceName)"
+            }
+        }
+
+        return subtitle
     }
 
     init(
         id: String,
         entityId: String,
         serverId: String,
+        areaName: String? = nil,
+        deviceName: String? = nil,
         displayString: String,
         iconName: String
     ) {
         self.id = id
         self.entityId = entityId
         self.serverId = serverId
+        self.areaName = areaName
+        self.deviceName = deviceName
         self.displayString = displayString
         self.iconName = iconName
     }
@@ -42,12 +70,12 @@ struct IntentFanAppEntityQuery: EntityQuery, EntityStringQuery {
     }
 
     func entities(matching string: String) async throws -> IntentItemCollection<IntentFanEntity> {
-        let fansPerServer = await getFanEntities()
+        let fansPerServer = await getFanEntities(matching: string)
 
         return .init(sections: fansPerServer.map { (key: Server, value: [IntentFanEntity]) in
             .init(
                 .init(stringLiteral: key.info.name),
-                items: value.filter({ $0.displayString.lowercased().contains(string.lowercased()) })
+                items: value
             )
         })
     }
@@ -65,11 +93,15 @@ struct IntentFanAppEntityQuery: EntityQuery, EntityStringQuery {
         let entities = ControlEntityProvider(domains: [.fan]).getEntities(matching: string)
 
         for (server, values) in entities {
+            let deviceMap = values.devicesMap(for: server.identifier.rawValue)
+            let areasMap = values.areasMap(for: server.identifier.rawValue)
             fanEntities.append((server, values.map({ entity in
                 IntentFanEntity(
                     id: entity.id,
                     entityId: entity.entityId,
                     serverId: entity.serverId,
+                    areaName: areasMap[entity.entityId]?.name,
+                    deviceName: deviceMap[entity.entityId]?.name,
                     displayString: entity.name,
                     iconName: entity.icon ?? SFSymbol.fan.rawValue
                 )

Sources/Extensions/Widgets/Controls/Fan/IntentFanEntity.swift

@@ -14,22 +14,50 @@ struct IntentLightEntity: AppEntity {
     var id: String
     var entityId: String
     var serverId: String
+    var areaName: String?
+    var deviceName: String?
     var displayString: String
     var iconName: String
     var displayRepresentation: DisplayRepresentation {
-        DisplayRepresentation(title: "\(displayString)")
+        DisplayRepresentation(
+            title: "\(displayString)",
+            subtitle: .init(stringLiteral: subtitle)
+        )
+    }
+
+    private var subtitle: String {
+        var subtitle = ""
+        if let areaName {
+            subtitle += areaName
+        }
+
+        if let deviceName,
+           deviceName.trimmingCharacters(in: .whitespacesAndNewlines).lowercased() != displayString.lowercased()
+           .trimmingCharacters(in: .whitespacesAndNewlines) {
+            if subtitle.isEmpty {
+                subtitle += deviceName
+            } else {
+                subtitle += " → \(deviceName)"
+            }
+        }
+
+        return subtitle
     }
 
     init(
         id: String,
         entityId: String,
         serverId: String,
+        areaName: String? = nil,
+        deviceName: String? = nil,
         displayString: String,
         iconName: String
     ) {
         self.id = id
         self.entityId = entityId
         self.serverId = serverId
+        self.areaName = areaName
+        self.deviceName = deviceName
         self.displayString = displayString
         self.iconName = iconName
     }
@@ -42,12 +70,12 @@ struct IntentLightAppEntityQuery: EntityQuery, EntityStringQuery {
     }
 
     func entities(matching string: String) async throws -> IntentItemCollection<IntentLightEntity> {
-        let lightsPerServer = getLightEntities()
+        let lightsPerServer = getLightEntities(matching: string)
 
         return .init(sections: lightsPerServer.map { (key: Server, value: [IntentLightEntity]) in
             .init(
                 .init(stringLiteral: key.info.name),
-                items: value.filter({ $0.displayString.lowercased().contains(string.lowercased()) })
+                items: value
             )
         })
     }
@@ -65,11 +93,15 @@ struct IntentLightAppEntityQuery: EntityQuery, EntityStringQuery {
         let entities = ControlEntityProvider(domains: [.light]).getEntities(matching: string)
 
         for (server, values) in entities {
+            let deviceMap = values.devicesMap(for: server.identifier.rawValue)
+            let areasMap = values.areasMap(for: server.identifier.rawValue)
             lightEntities.append((server, values.map({ entity in
                 IntentLightEntity(
                     id: entity.id,
                     entityId: entity.entityId,
                     serverId: entity.serverId,
+                    areaName: areasMap[entity.entityId]?.name,
+                    deviceName: deviceMap[entity.entityId]?.name,
                     displayString: entity.name,
                     iconName: entity.icon ?? SFSymbol.lightbulbFill.rawValue
                 )