Order automation devices in pickers based on automation usage #27477
+200
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| import { createContext } from "@lit/context"; | ||
| import type { HomeAssistant } from "../types"; | ||
| import type { AutomationConfig } from "./automation"; | ||
| import { ensureArray } from "../common/array/ensure-array"; | ||
|
|
||
| export type AutomationSection = "triggers" | "conditions" | "actions"; | ||
|
|
||
| export type EntityId = string; | ||
| export type DeviceId = string; | ||
| export type AreaId = string; | ||
| export type Domain = string; | ||
|
|
||
| export interface AutomationLocalContext { | ||
| meta: { | ||
| automationId?: string; | ||
| signature: string; | ||
| }; | ||
|
|
||
| used: { | ||
| entities: EntityId[]; | ||
| devices: DeviceId[]; | ||
| areas: AreaId[]; | ||
| domains: Domain[]; | ||
| }; | ||
|
|
||
| maps: { | ||
| entityArea: Record<EntityId, AreaId | null>; | ||
| entityDevice: Record<EntityId, DeviceId | null>; | ||
| deviceArea: Record<DeviceId, AreaId | null>; | ||
| deviceDomains: Record<DeviceId, Domain[]>; | ||
| }; | ||
|
|
||
| weights?: { | ||
| used: number; | ||
| sameDomain: number; | ||
| sameArea: number; | ||
| }; | ||
|
|
||
| hints?: { | ||
| lastEditedPath?: string[] | number[]; | ||
| labels?: string[]; | ||
| services?: string[]; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Context key for the automation editor locality context. | ||
| */ | ||
| export const automationEditorContext = createContext< | ||
| AutomationLocalContext | undefined | ||
| >("automationEditorContext"); | ||
|
|
||
| const addIds = (ids: unknown, set: Set<string>) => { | ||
| if (ids === undefined || ids === null) return; | ||
| const list = ensureArray(ids) as unknown[]; | ||
| for (const item of list) { | ||
| if (typeof item === "string" && item) { | ||
| set.add(item); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const getContextSignature = (devices: Set<string>): string => | ||
| Array.from(devices.values()) | ||
| .map((d) => d.slice(0, 6)) | ||
| .sort() | ||
| .join(); | ||
|
|
||
| export const buildAutomationLocalContext = ( | ||
| config: AutomationConfig | undefined, | ||
| _hass: HomeAssistant, | ||
| automationId?: string, | ||
| previous?: AutomationLocalContext | ||
| ): AutomationLocalContext | undefined => { | ||
| if (!config) return undefined; | ||
|
|
||
| const devicesSet = new Set<string>(); | ||
|
|
||
| const scan = (val: any) => { | ||
| if (val === null || val === undefined) return; | ||
| if (Array.isArray(val)) { | ||
| for (const item of val) scan(item); | ||
| return; | ||
| } | ||
| if (typeof val !== "object") return; | ||
|
|
||
| if ("device_id" in val) { | ||
| addIds((val as any).device_id, devicesSet); | ||
| } | ||
| if ("target" in val && val.target && typeof val.target === "object") { | ||
| if ("device_id" in (val.target as any)) { | ||
| addIds((val.target as any).device_id, devicesSet); | ||
| } | ||
| } | ||
|
|
||
| for (const key of Object.keys(val)) { | ||
| const child = (val as any)[key]; | ||
| if (child && typeof child === "object") { | ||
| scan(child); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| scan(config.triggers); | ||
| scan(config.conditions); | ||
| scan(config.actions); | ||
|
|
||
| // Avoid re-rendering if nothing changed | ||
| const signature = getContextSignature(devicesSet); | ||
| if (previous && previous.meta.signature === signature) { | ||
| return previous; | ||
| } | ||
|
|
||
| return { | ||
| meta: { | ||
| automationId, | ||
| signature, | ||
| }, | ||
| used: { | ||
| entities: [], | ||
| devices: Array.from(devicesSet), | ||
| areas: [], | ||
| domains: [], | ||
| }, | ||
| maps: { | ||
| entityArea: {}, | ||
| entityDevice: {}, | ||
| deviceArea: Object.fromEntries( | ||
| Object.entries(_hass.devices || {}).map(([id, dev]) => [ | ||
| id, | ||
| dev.area_id || null, | ||
| ]) | ||
| ), | ||
| deviceDomains: {}, | ||
| }, | ||
| }; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bramkragten This is hacky but I didn't want to increase the scope of the PR nor know how you would approach an alternative. In my mind this would be replaced by a proper grouping like “Suggested” and “All devices” or something similar.