zwave-js / zwave-js-ui / 39441114164

17%

push

github

fix(driver): don't let external presets wipe sibling driver options (#4830)

## The bug

Driver presets from the external settings file were applied with
`Object.assign(zwaveOptions, preset)`. `Object.assign` is shallow, so a
preset replaced the whole top-level object it touched instead of merging
into it.

Two presets carry a `features` object:

```js
NO_CONTROLLER_RECOVERY: { features: { unresponsiveControllerRecovery: false } },
NO_WATCHDOG:            { features: { watchdog: false } },
```

`ZwaveClient` builds `features` from the settings, including
`features.softReset` from `enableSoftReset`. Applying either preset
dropped `softReset`, and the driver fell back to its default (enabled).
In the Home Assistant add-on that means: with `disable_watchdog` or
`disable_controller_recovery` on, `soft_reset: Disabled` was ignored.
`SAFE_MODE` had the same effect on `timeouts`.

## The fix

`Driver`'s constructor already takes presets as extra arguments and deep
merges them (`constructor(port, ...optionsAndPresets)`). Presets are now
resolved by `getExternalDriverPresets()` and passed to it:

```ts
this._driver = new Driver(this.cfg.port, zwaveOptions, ...getExternalDriverPresets())
```

A preset now overrides only the values it defines. One test passes the
resolved `NO_WATCHDOG` preset to `Driver` and checks that
`features.softReset: false` survives. It covers the preset resolution
and the merge, not the `ZwaveClient` call site.

## Merge with the next zwave-js bump

Passing the shared `driverPresets` objects as-is depends on
zwave-js/zwave-js#9306. Without it, `mergeDeep` stores a preset's nested
objects by reference and writes driver defaults into them. #9306 is
merged but not yet released (it landed after v15.31.1), so this should
go in together with the zwave-js update that includes it.

## Not in this PR

This doesn't fix the case reported in #4829. That reporter has no preset
enabled. Their add-on options were reset to defaults by a Home Assistant
c... (continued)

633 of 4566 branches covered (13.86%)

Branch coverage included in aggregate %.

5 of 7 new or added lines in 2 files covered. (71.43%)

1103 of 7044 relevant lines covered (15.66%)

2.31 hits per line