refactor(hass): extract discovery domain by AlCalzone · Pull Request #4729 · zwave-js/zwave-js-ui

AlCalzone · 2026-07-11T12:42:49Z

Extracts the Home Assistant discovery domain from Gateway.

Separates entity generation, custom-device loading, persistence, and watcher ownership.
Keeps discovery payloads, identifiers, templates, command mappings, and synchronous projection compatible.
Review focus: cache/watcher lifecycle, stale publication fencing, and exact MQTT discovery output.

Part of #4722. Stacked on #4728.

coveralls · 2026-07-11T12:45:21Z

Coverage Report for CI Build 29567758133

Warning

No base build found for commit b9dd3b4 on alcalzone-backend-refactor-socket-handlers.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 43.056%

Details

Patch coverage: 95 uncovered changes across 7 files (786 of 881 lines covered, 89.22%).

Uncovered Changes

File	Changed	Covered	%
api/hass/DiscoveryGenerator.ts	592	544	91.89%
api/lib/Gateway.ts	136	109	80.15%
api/lib/ZwaveClient.ts	12	1	8.33%
api/app.ts	16	12	75.0%
api/hass/CustomDeviceRegistry.ts	78	75	96.15%
api/runtime/AppRuntime.ts	4	3	75.0%
api/socket/hassApi.ts	4	3	75.0%
Total (12 files)	881	786	89.22%

Coverage Regressions

Requires a base build to compare against. How to fix this →

Coverage Stats


Relevant Lines:	6992
Covered Lines:	3196
Line Coverage:	45.71%
Relevant Branches:	4479
Covered Branches:	1743
Branch Coverage:	38.91%
Branches in Coverage %:	Yes
Coverage Strength:	30.34 hits per line

💛 - Coveralls

Move legacy HASS DTOs and editor persistence behind typed domain ports, and replace Gateway's process-global custom catalog with disposable per-instance registries while preserving legacy loader seams. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Preserve the legacy two-watcher import lifecycle through a shared source while each Gateway owns an isolated subscribed catalog view. Dispose views and event listeners across restart and failed teardown, and tolerate legacy malformed catalogs without poisoning hash retries. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Emit the current node projection after concurrent persistence and keep cover STOP writes bound to the cached MQTT mapping even if the live value disappears. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Keep legacy undefined metadata coercion in entity names and replace vacuous rediscovery and RAW availability checks with exact, non-empty payload assertions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Load discovery and Gateway modules only after the temporary STORE_DIR is active, verify the repository store byte-for-byte, and restore watchers, modules, and environment state during teardown. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Accept the emitter's optional value-change flag while preserving the legacy false default, keeping restart-safe listener bindings strict-neutral. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Assert isolated config, secrets, logs, and concrete watcher paths at import time without racing unrelated parallel logger tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Remove redundant changed comments and keep repository-store isolation checks stable when logger tests write concurrently. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Ignore only logger-owned repository artifacts across concurrent isolation snapshots. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Clone per-device array containers at fork boundaries so dynamic climate discovery cannot mutate sibling Gateway catalogs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Evict the resolved CommonJS module before watcher reloads so same-path customDevices.js edits propagate to active registry forks. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

AlCalzone mentioned this pull request Jul 11, 2026

refactor(hass): add lifecycle-managed integrations #4730

Draft

AlCalzone marked this pull request as draft July 11, 2026 21:11

robertsLando mentioned this pull request Jul 14, 2026

Landing Plan: backend-refactor & dashboard-neo integration branches (review order, merge train & issue closure) #4745

Open

27 tasks

AlCalzone force-pushed the alcalzone-backend-refactor-socket-handlers branch from fc3970a to 428aa02 Compare July 16, 2026 05:51

AlCalzone force-pushed the alcalzone-backend-refactor-hass-domain branch from d0a95f8 to 48c2e1b Compare July 16, 2026 06:51

AlCalzone force-pushed the alcalzone-backend-refactor-socket-handlers branch from 428aa02 to 122277f Compare July 16, 2026 12:14

AlCalzone force-pushed the alcalzone-backend-refactor-hass-domain branch from 48c2e1b to d8adedf Compare July 16, 2026 13:01

AlCalzone force-pushed the alcalzone-backend-refactor-socket-handlers branch from 122277f to ac5c083 Compare July 16, 2026 18:56

AlCalzone force-pushed the alcalzone-backend-refactor-hass-domain branch from d8adedf to 7d7c6af Compare July 16, 2026 19:23

AlCalzone force-pushed the alcalzone-backend-refactor-socket-handlers branch from ac5c083 to b9dd3b4 Compare July 17, 2026 08:11

AlCalzone and others added 19 commits July 17, 2026 10:16

refactor(hass): extract discovery generator

c7edca0

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): enforce extracted domain coverage

3f577c8

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): preserve live device state writes

e932302

Emit the current node projection after concurrent persistence and keep cover STOP writes bound to the cached MQTT mapping even if the live value disappears. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): restore discovery compatibility details

1035f9f

Keep legacy undefined metadata coercion in entity names and replace vacuous rediscovery and RAW availability checks with exact, non-empty payload assertions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): retain typed listener compatibility

bdb05c0

Accept the emitter's optional value-change flag while preserving the legacy false default, keeping restart-safe listener bindings strict-neutral. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): harden isolation verification

53c476f

Assert isolated config, secrets, logs, and concrete watcher paths at import time without racing unrelated parallel logger tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): harden cross-stack audit

25bb6e8

Remove redundant changed comments and keep repository-store isolation checks stable when logger tests write concurrently. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): stabilize facade isolation checks

c8240b8

Ignore only logger-owned repository artifacts across concurrent isolation snapshots. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): isolate registry projection arrays

7e6f27c

Clone per-device array containers at fork boundaries so dynamic climate discovery cannot mutate sibling Gateway catalogs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

docs(hass): restore semantic contracts

f89368c

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

refactor(hass): inject gateway registry ownership

2889e5f

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): return typed persistence results

5637fdd

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): verify discovery through public behavior

0a37e36

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

refactor(hass): tighten gateway behavior boundaries

ed82fa8

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): reject malformed storage records

12b15af

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

refactor(hass): hide discovery helpers

87f2e34

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

AlCalzone and others added 15 commits July 17, 2026 10:17

test(hass): remove private helper coverage

f797ed1

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): preserve custom script caching

3039cce

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

refactor(hass): privatize value id handling

b1f6d26

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): expose typed store results

84246f2

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): fail rejected store requests

e2a7588

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

refactor(hass): reuse shared domain helpers

25709d9

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): use canonical discovery behavior

8bd0f1b

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): describe observable lifecycle behavior

ee2157d

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(runtime): stop application maintenance timers

d50938f

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): preserve canonical source imports

7e9064c

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(runtime): retain application close contract

63075b2

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

test(hass): restore shared ownership harnesses

7271019

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): preserve MQTT callback typing

ed7aec2

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): skip auxiliary values without metadata

b1c96bf

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix(hass): reload edited custom scripts

1ca0240

Evict the resolved CommonJS module before watcher reloads so same-path customDevices.js edits propagate to active registry forks. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

AlCalzone force-pushed the alcalzone-backend-refactor-hass-domain branch from 7d7c6af to 1ca0240 Compare July 17, 2026 08:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(hass): extract discovery domain#4729

refactor(hass): extract discovery domain#4729
AlCalzone wants to merge 34 commits into
alcalzone-backend-refactor-socket-handlersfrom
alcalzone-backend-refactor-hass-domain

AlCalzone commented Jul 11, 2026 •

edited

Loading

Uh oh!

coveralls commented Jul 11, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

AlCalzone commented Jul 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jul 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report for CI Build 29567758133

Coverage: 43.056%

Details

Uncovered Changes

Coverage Regressions

Coverage Stats

💛 - Coveralls

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AlCalzone commented Jul 11, 2026 •

edited

Loading

coveralls commented Jul 11, 2026 •

edited

Loading