refactor: use custom homeAssistantBehavior for better state management

packages/backend/.env.sample → .env.sample

@@ -1,5 +1,4 @@
-NODE_ENV=development
 HAMH_HOME_ASSISTANT_URL="http://192.168.178.111:8123/"
 HAMH_HOME_ASSISTANT_ACCESS_TOKEN=""
 HAMH_STORAGE_LOCATION=$PWD/.local-storage
-HAMH_LOG_LEVEL=info
+HAMH_LOG_LEVEL=debug

apps/docker/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "type": "module",
   "scripts": {
+    "cleanup": "rimraf package.tgz",
     "build": "./build.sh",
     "retrieve-package": "node retrieve-package.js",
     "nx-release-publish": "./build.sh --latest --push --all-platforms"

apps/home-assistant-matter-hub/package.json

@@ -41,16 +41,17 @@
   "license": "Apache-2.0",
   "repository": "github:t0bst4r/home-assistant-matter-hub",
   "scripts": {
+    "cleanup": "rimraf dist pack",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "build": "node build.js",
     "test": "vitest run",
-    "start": "dotenvx run -- ./dist/backend/cli.js start --log-level=info",
+    "start": "dotenvx run -f ../../.env -- ./dist/backend/cli.js start",
     "pack": "mkdir -p pack && npm pack --pack-destination pack --json | jq -r .[0].filename > pack/package-name.txt"
   },
   "dependencies": {
-    "@project-chip/matter.js": "~0.10.6",
-    "@project-chip/matter-node.js": "~0.10.6",
+    "@project-chip/matter.js": "~0.11.2",
+    "@project-chip/matter-node.js": "~0.11.2",
     "ajv": "^8.17.1",
     "chalk": "^5.3.0",
     "color": "^4.2.3",

package.json

@@ -4,6 +4,7 @@
   "private": true,
   "type": "module",
   "scripts": {
+    "cleanup": "nx run-many -t cleanup --parallel 100 && nx reset && git clean -fx",
     "lint": "nx run-many -t lint && prettier . --check",
     "lint:fix": "nx run-many -t lint:fix && prettier . --write",
     "test": "nx run-many -t test",

packages/backend/.env.development

@@ -0,0 +1 @@
+ NODE_ENV=development

packages/backend/package.json

@@ -5,15 +5,16 @@
   "type": "module",
   "destination": "./dist",
   "scripts": {
+    "cleanup": "rimraf dist",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "build": "tsc && node bundle.js",
-    "serve": "tsx watch --env-file=.env --clear-screen=false src/cli.ts start"
+    "serve": "tsx watch --env-file=../../.env --env-file=.env.development --clear-screen=false src/cli.ts start"
   },
   "dependencies": {
     "@home-assistant-matter-hub/common": "*",
-    "@project-chip/matter.js": "~0.10.6",
-    "@project-chip/matter-node.js": "~0.10.6",
+    "@project-chip/matter.js": "~0.11.2",
+    "@project-chip/matter-node.js": "~0.11.2",
     "ajv": "^8.17.1",
     "chalk": "^5.3.0",
     "express": "^4.21.1",

packages/backend/src/home-assistant/api/get-registry.ts

@@ -1,26 +1,10 @@
-import {
-  HomeAssistantEntityRegistry,
-  HomeAssistantEntityRegistryWithInitialState,
-  HomeAssistantEntityState,
-} from "@home-assistant-matter-hub/common";
-import { Connection, getStates } from "home-assistant-js-websocket";
-import _, { Dictionary } from "lodash";
+import { HomeAssistantEntityRegistry } from "@home-assistant-matter-hub/common";
+import { Connection } from "home-assistant-js-websocket";
 
 export async function getRegistry(
   connection: Connection,
-): Promise<Dictionary<HomeAssistantEntityRegistryWithInitialState>> {
-  const registry = _.keyBy(
-    await connection.sendMessagePromise<HomeAssistantEntityRegistry[]>({
-      type: "config/entity_registry/list",
-    }),
-    (r) => r.entity_id,
-  );
-  const states: Dictionary<HomeAssistantEntityState> = _.keyBy(
-    await getStates(connection),
-    (e) => e.entity_id,
-  );
-  return _.mapValues(registry, (r) => ({
-    ...r,
-    initialState: states[r.entity_id],
-  }));
+): Promise<HomeAssistantEntityRegistry[]> {
+  return connection.sendMessagePromise<HomeAssistantEntityRegistry[]>({
+    type: "config/entity_registry/list",
+  });
 }

packages/backend/src/home-assistant/home-assistant-client.ts

@@ -3,10 +3,11 @@ import {
   Connection,
   createConnection,
   createLongLivedTokenAuth,
+  getStates,
   UnsubscribeFunc,
 } from "home-assistant-js-websocket";
 import {
-  HomeAssistantEntityRegistryWithInitialState,
+  HomeAssistantEntityRegistry,
   HomeAssistantEntityState,
   HomeAssistantFilter,
 } from "@home-assistant-matter-hub/common";
@@ -15,11 +16,12 @@ import { ServiceBase } from "../utils/service.js";
 import _, { Dictionary } from "lodash";
 import { Subject } from "rxjs";
 import crypto from "node:crypto";
-import { subscribeEntities } from "./subscribe-entities.js";
+import { subscribeEntities } from "./api/subscribe-entities.js";
 import { matchEntityFilter } from "./match-entity-filter.js";
 import { getRegistry } from "./api/get-registry.js";
 import { HomeAssistantActions } from "./home-assistant-actions.js";
 import { HassServiceTarget } from "home-assistant-js-websocket/dist/types.js";
+import { isValidEntity } from "./is-valid-entity.js";
 
 export interface HomeAssistantClientProps {
   readonly url: string;
@@ -38,7 +40,9 @@ export class HomeAssistantClient
     Dictionary<HomeAssistantEntityState>
   >();
   private connection?: Connection;
-  private _registry?: Dictionary<HomeAssistantEntityRegistryWithInitialState>;
+
+  private _initialStates?: Dictionary<HomeAssistantEntityState>;
+  private _registry?: Dictionary<HomeAssistantEntityRegistry>;
 
   private subscriptions: Record<string, HomeAssistantFilter> = {};
   private unsubscribeState?: UnsubscribeFunc;
@@ -55,37 +59,14 @@ export class HomeAssistantClient
     this.connection = await createConnection({
       auth: createLongLivedTokenAuth(this.url, this.accessToken),
     });
-    const registry = await getRegistry(this.connection);
-    this._registry = _.fromPairs(
-      _.toPairs(registry)
-        .filter(([, item]) => {
-          const isHidden = item.hidden_by != undefined;
-          const isDisabled = item.disabled_by != undefined;
-          if (isHidden) {
-            this.log.debug(
-              "%s is hidden by %s",
-              item.entity_id,
-              item.hidden_by,
-            );
-          }
-          if (isDisabled) {
-            this.log.debug(
-              "%s is disabled by %s",
-              item.entity_id,
-              item.disabled_by,
-            );
-          }
-          return !isHidden && !isDisabled;
-        })
-        .filter(([, item]) => {
-          const hasState = !!item.initialState;
-          if (!hasState) {
-            this.log.warn("%s does not have an initial-state", item.entity_id);
-          }
-          return hasState;
-        }),
+    this._initialStates = _.keyBy(
+      await getStates(this.connection),
+      (e) => e.entity_id,
+    );
+    this._registry = _.keyBy(
+      await getRegistry(this.connection),
+      (r) => r.entity_id,
     );
-
     this.subscriptions = {};
   }
 
@@ -98,18 +79,28 @@ export class HomeAssistantClient
     this.connection = undefined;
 
     this._registry = undefined;
+    this._initialStates = undefined;
   }
 
   registry(
     filter: HomeAssistantFilter,
-  ): HomeAssistantEntityRegistryWithInitialState[] {
+  ): Dictionary<HomeAssistantEntityRegistry> {
     if (!this._registry) {
       throw new Error("Home Assistant Client is not yet initialized");
     }
-    return _.filter(this._registry, (r) => matchEntityFilter(r, filter));
+    return _.pickBy(
+      this._registry,
+      (r) => isValidEntity(r) && matchEntityFilter(r, filter),
+    );
+  }
+
+  initialStates(entityIds: string[]): Dictionary<HomeAssistantEntityState> {
+    return _.pickBy(this._initialStates, (e) =>
+      entityIds.includes(e.entity_id),
+    );
   }
 
-  states(
+  subscribeStates(
     filter: HomeAssistantFilter,
     cb: (entities: Dictionary<HomeAssistantEntityState>) => Promise<void>,
   ): () => void {

packages/backend/src/home-assistant/is-valid-entity.ts

@@ -0,0 +1,10 @@
+import { HomeAssistantEntityRegistry } from "@home-assistant-matter-hub/common";
+
+export function isValidEntity(registry: HomeAssistantEntityRegistry): boolean {
+  if (registry.disabled_by != null) {
+    return false;
+  } else if (registry.hidden_by != null) {
+    return false;
+  }
+  return true;
+}