zwave-js / zwave-js-ui / 19273238312

20%

push

github

fix: changedZwaveKeys incorrectly includes UI defaults as changes (#4454)

The recent feature to update driver options without restart (PR #4413)
fails because `changedZwaveKeys` includes properties that weren't
actually modified by the user—specifically, default values added by the
UI that don't exist in stored settings.

## Root Cause

```typescript
// Before: Only checks keys in NEW settings
changedZwaveKeys = Object.keys(settings.zwave || {}).filter(
  (key) => !utils.deepEqual(actualSettings.zwave?.[key], settings.zwave?.[key])
)
```

When the UI sends settings, it includes all properties with defaults.
Keys present in new settings but absent in stored settings are detected
as "changed", even if the user only modified logging settings. If these
keys aren't in `editableZWaveSettings`, the system incorrectly requires
a restart.

## Changes

```typescript
// After: Check keys from both old AND new settings
const allKeys = new Set([
  ...Object.keys(actualSettings.zwave || {}),
  ...Object.keys(settings.zwave || {}),
])
changedZwaveKeys = Array.from(allKeys).filter(
  (key) => !utils.deepEqual(actualSettings.zwave?.[key], settings.zwave?.[key])
)
```

This ensures only keys with actual value differences are detected as
changed, not keys added as UI defaults.

Added debug logging to surface which keys changed and why restart is
required when troubleshooting similar issues.

> [!WARNING]
>
> <details>
> <summary>Firewall rules blocked me from connecting to one or more
addresses (expand for details)</summary>
>
> #### I tried to connect to the following addresses, but was blocked by
firewall rules:
>
> - `224.0.0.251`
> - `firmware.zwave-js.io`
>   - Triggering command: `node server/bin/www.js` (dns block)
>
> If you need me to access, download, or install something from one of
these locations, you can either:
>
> - Configure [Actions setup
steps](https://gh.io/copilot/actions-setup-steps) to set up my
environment, which run before the firewall is enabl... (continued)

333 of 441 branches covered (75.51%)

Branch coverage included in aggregate %.

0 of 37 new or added lines in 1 file covered. (0.0%)

4048 of 21310 relevant lines covered (19.0%)

1.18 hits per line