feat(settings): intelligent restart with hot-reload for editable Z-Wave options #4413

Copilot · 2025-10-08T13:55:24Z

Summary

Added a clarifying comment explaining how ZwaveClient configuration properties map to the corresponding driver.updateOptions() parameters. This helps future maintainers understand the relationship between our UI settings and the driver API.

Changes Made

Backend (`api/app.ts`)

Added Documentation Comment:

Clarified that the listed properties are ZwaveClient configuration settings
Explained the mapping to driver.updateOptions() parameters:
- scales → preferences.scales
- Log properties (logEnabled, logLevel, etc.) → logConfig object
- disableOptimisticValueUpdate → direct mapping
Helps developers understand why these specific properties can be updated without restart

Benefits

✅ Better code documentation
✅ Clearer understanding of the settings-to-driver mapping
✅ Easier maintenance for future developers
✅ Explains the commented inline annotations

Testing

✅ All existing tests pass (52 tests)
✅ Linting successful
✅ Build successful

Original prompt

This section details on the original issue you should resolve

<issue_title>Save button without restarting</issue_title>
<issue_description>Hi,

Each time the configuration is changed, the application restarts. Sometimes we just want to change a setting without it being active right away.

Is it possible to add a button to simply save without restarting and give us the option to restart the application manually?
</issue_description>

<agent_instructions>In Settings.vue, when users press on save, show a confirmation dialog with a checkbox (checked by default) that ask user if he also want to restart zwave-js driver, if unchecked the request should only update settings json without restarting client</agent_instructions>

Comments on the Issue (you are @copilot in this section)
@robertsLando I'm not sure I want this, most changes require a restart and I think this could lead to unexpected behaviours.
@AlCalzone opinion?</comment_new>

Fixes #4410

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

coveralls · 2025-10-08T14:01:25Z

Pull Request Test Coverage Report for Build 18876306141

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

15 of 242 (6.2%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.1%) to 20.178%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/apis/ConfigApis.js	0	4	0.0%
api/lib/ZwaveClient.ts	0	5	0.0%
api/lib/utils.ts	15	46	32.61%
api/app.ts	0	187	0.0%

Totals
Change from base Build 18715718057:	-0.1%
Covered Lines:	4048
Relevant Lines:	21271

💛 - Coveralls

Co-authored-by: robertsLando <[email protected]>

api/app.ts

Co-authored-by: robertsLando <[email protected]>

robertsLando

Check for other ConfigApis.updateConfig calls codewise and ensure them are compatible with new format

robertsLando · 2025-10-08T15:02:29Z

@copilot fix

Co-authored-by: robertsLando <[email protected]>

Copilot · 2025-10-08T15:07:52Z

@copilot fix

Fixed in commit c5e9d3a. Found one incompatible call in src/App.vue:1004 where restart() was calling updateConfig(false). Changed it to updateConfig(null) to properly pass null data and use the default restart=true parameter. All three usages are now compatible with the new { restart, data } format.

AlCalzone · 2025-10-09T08:36:09Z

src/views/Settings.vue

 			if (result.valid) {
 				try {
+					// Show confirmation dialog with restart option
+					const restartOptions = await this.app.confirm(


We definitely know which settings can be changed without restarting (EditableZWaveOptions). Shouldn't we compare against that list somewhere?

@copilot Refactor the PR in this way:

The user calls ConfigApis.updateConfig, no prompt is show at this point to ask for restart.

Backend checks what changed, if something on gateway settings changed set shouldRestart to true, if something on zwave settings changes check if it matches properties of EditableZWaveOptions, if so instead of restarting everything only update driver settings using driver.updateOptions API, if something on zniffer set shouldRestart to true

The API call should then return also shouldRestart that is true/false, when this is true then ask the user if he want to restart the gw or not with the dialog that you created in actual implementation

If user checks the restart box restart the gw using the dedicated API

Refactored in commit e7f4a91. The implementation now:

No upfront prompt - User calls updateConfig, settings are saved immediately

Intelligent restart detection:

Gateway/MQTT changes → shouldRestart = true

Zniffer changes → shouldRestart = true

Z-Wave editable options (matching EditableZWaveOptions) → uses driver.updateOptions(), no restart

Other Z-Wave changes → shouldRestart = true

Response includes shouldRestart flag indicating if restart is needed

Conditional dialog - Only shows restart prompt if shouldRestart === true

Dedicated restart endpoint - /api/restart called when user confirms

The editable Z-Wave options that can be updated without restart: attempts, disableOptimisticValueUpdate, emitValueUpdateAfterSetValue, inclusionUserCallbacks, joinNetworkUserCallbacks, interview, logConfig, preferences, vendor, userAgent.

…port Co-authored-by: robertsLando <[email protected]>

robertsLando

@copilot Well done. Fix what highlighted in my review and it should be good to go

robertsLando · 2025-10-10T09:43:59Z

api/app.ts

+					const zwaveKeys = Object.keys(settings.zwave || {})
+					const onlyEditableChanged = zwaveKeys.every((key) =>
+						editableZWaveProps.includes(key),
+					)


mind that here you always get ALL settings so you should check which settings changed and which not

Fixed in commit a3b4c7d. The code now:

Identifies which Z-Wave properties actually changed by comparing against actualSettings.zwave

Only evaluates the changed properties against the EditableZWaveOptions list

When calling driver.updateOptions(), only passes properties that actually changed

Improved logging to show which specific options were updated

This ensures unchanged properties don't trigger unnecessary restarts or get passed to the driver update API.

Co-authored-by: robertsLando <[email protected]>

robertsLando

@copilot fix review

robertsLando · 2025-10-16T09:24:48Z

api/lib/ZwaveClient.ts

+					nodeFilter: this.cfg.nodeFilter,
+				}),
 				filename: ZWAVEJS_LOG_FILE,
 				forceConsole: isDocker() ? !this.cfg.logToFile : false,


forceConsole depends from logToFile so that should be included as well in buildLogConfig and also filename

Fixed in commit a7b9c4d. Added optional filename and forceConsole parameters to buildLogConfig(). Both are now included in the returned logConfig object when provided. Updated ZwaveClient to pass these values when calling the function.

robertsLando · 2025-10-16T09:25:53Z

api/lib/utils.ts

+export function buildLogConfig(config: {
+	logEnabled?: boolean
+	logLevel?: string
+	logToFile?: boolean
+	maxFiles?: number
+	nodeFilter?: string[]
+}) {


make config type of zwaveconfig so you don't have to specify all those props but we can just pass the entire config

Fixed in commit a7b9c4d. Changed buildLogConfig() to accept the full config object (using DeepPartial for type safety) instead of individual properties. Both app.ts and ZwaveClient.ts now pass the entire config object, making the code cleaner and more maintainable.

robertsLando · 2025-10-16T09:26:45Z

@copilot fix review

…lename/forceConsole Co-authored-by: robertsLando <[email protected]>

Copilot · 2025-10-16T09:38:23Z

@copilot fix review

All checks pass successfully:

✅ Linting: No errors
✅ Tests: All 52 tests passing
✅ Build: Successful

All previous review comments have been addressed. If there are specific issues or new review comments that need attention, please let me know what needs to be fixed.

…ettings

…references and buildLogConfig functions

…r improved configuration handling

…pe safety

…n app.ts

api/app.ts

AlCalzone · 2025-10-20T09:54:00Z

src/views/Settings.vue

+						const restartConfirm = await this.app.confirm(
+							'Restart Required',
+							'Do you want to restart the Z-Wave JS driver to apply the changes?',
+							'info',
+							{
+								width: 500,
+								inputs: [
+									{
+										type: 'checkbox',
+										key: 'restart',
+										label: 'Restart Z-Wave JS driver',
+										default: true,
+										hint: 'Changes require a restart to take effect. Uncheck to restart manually later.',
+									},
+								],
+							},
+						)


Would a modal dialog with 3 buttons be simpler here?
[CANCEL] [SAVE] [SAVE and RESTART]

hummm not sure, that would require a single click and could be easier to click the wrong button?

I don't feel strongly either way, but this is already a confirmation dialog for pressing the save button, so it's not super easy to open accidentally.

I would keep it like this for now 🙏🏼

Co-authored-by: robertsLando <[email protected]>

Initial plan

0ad5f9a

Copilot AI assigned Copilot and robertsLando Oct 8, 2025

Copilot started work on behalf of robertsLando October 8, 2025 13:55 View session

feat(settings): add option to save without restarting Z-Wave JS driver

8d0ec2c

Co-authored-by: robertsLando <[email protected]>

Copilot AI changed the title ~~[WIP] Add save button to update settings without restart~~ feat(settings): add option to save without restarting Z-Wave JS driver Oct 8, 2025

Copilot AI requested a review from robertsLando October 8, 2025 14:27

Copilot finished work on behalf of robertsLando October 8, 2025 14:27

robertsLando requested changes Oct 8, 2025

View reviewed changes

api/app.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of robertsLando October 8, 2025 14:52 View session

robertsLando mentioned this pull request Oct 8, 2025

Save button without restarting #4410

Closed

refactor: change API body structure to { restart, data }

3c2d115

Co-authored-by: robertsLando <[email protected]>

Copilot AI requested a review from robertsLando October 8, 2025 14:58

Copilot finished work on behalf of robertsLando October 8, 2025 14:58

robertsLando requested changes Oct 8, 2025

View reviewed changes

Copilot started work on behalf of robertsLando October 8, 2025 15:02 View session

fix: update App.vue restart method to use new API format

cb1493c

Co-authored-by: robertsLando <[email protected]>

Copilot AI requested a review from robertsLando October 8, 2025 15:08

Copilot finished work on behalf of robertsLando October 8, 2025 15:08

AlCalzone reviewed Oct 9, 2025

View reviewed changes

Copilot started work on behalf of robertsLando October 10, 2025 09:23 View session

refactor: intelligent restart detection with EditableZWaveOptions sup…

2a8ef24

…port Co-authored-by: robertsLando <[email protected]>

Copilot AI changed the title ~~feat(settings): add option to save without restarting Z-Wave JS driver~~ feat(settings): intelligent restart with hot-reload for editable Z-Wave options Oct 10, 2025

Copilot finished work on behalf of robertsLando October 10, 2025 09:40

robertsLando requested changes Oct 10, 2025

View reviewed changes

Copilot started work on behalf of robertsLando October 10, 2025 09:46 View session

fix: only check changed Z-Wave properties for restart detection

79da031

Co-authored-by: robertsLando <[email protected]>

Copilot started work on behalf of robertsLando October 15, 2025 15:56 View session

refactor: move scale and logConfig converters to utils for reuse

bd8198e

Co-authored-by: robertsLando <[email protected]>

Copilot finished work on behalf of robertsLando October 15, 2025 16:08

robertsLando requested changes Oct 16, 2025

View reviewed changes

Merge branch 'master' into copilot/add-save-settings-without-restart

1c0756e

Copilot started work on behalf of robertsLando October 16, 2025 09:27 View session

refactor: improve buildLogConfig to accept full config and include fi…

172b92f

…lename/forceConsole Co-authored-by: robertsLando <[email protected]>

Copilot AI requested a review from robertsLando October 16, 2025 09:34

Copilot finished work on behalf of robertsLando October 16, 2025 09:34

Copilot started work on behalf of robertsLando October 16, 2025 09:35 View session

Copilot finished work on behalf of robertsLando October 16, 2025 09:40

robertsLando added 7 commits October 16, 2025 11:58

refactor: update logConfig to use default filename and forceConsole s…

d9e4bec

…ettings

refactor: remove unused parameter documentation from convertScalesToP…

96f25d9

…references and buildLogConfig functions

refactor: replace convertScalesToPreferences with buildPreferences fo…

583f4e4

…r improved configuration handling

refactor: update buildLogConfig to accept ZwaveConfig for improved ty…

1d2248a

…pe safety

refactor: enhance type safety by updating scales to use ZwaveConfig i…

a13e63b

…n app.ts

refactor: simplify restart confirmation check in Settings.vue

7bfccd1

refactor: simplify gw.zwave.driver checks using optional chaining

9bf5a6d

robertsLando requested a review from AlCalzone October 16, 2025 10:14

AlCalzone reviewed Oct 20, 2025

View reviewed changes

Copilot started work on behalf of robertsLando October 20, 2025 10:24 View session

docs: add clarifying comment for editable Z-Wave settings mapping

cb82eca

Co-authored-by: robertsLando <[email protected]>

Copilot finished work on behalf of robertsLando October 20, 2025 10:30

Merge branch 'master' into copilot/add-save-settings-without-restart

9260023

robertsLando approved these changes Oct 28, 2025

View reviewed changes

Merge branch 'master' into copilot/add-save-settings-without-restart

4ad130e

robertsLando merged commit d574d8b into master Oct 28, 2025
7 of 11 checks passed

robertsLando deleted the copilot/add-save-settings-without-restart branch October 28, 2025 13:25

Uh oh!

Uh oh!

feat(settings): intelligent restart with hot-reload for editable Z-Wave options #4413

feat(settings): intelligent restart with hot-reload for editable Z-Wave options #4413

Conversation

Copilot AI commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes Made

Backend (api/app.ts)

Benefits

Testing

Comments on the Issue (you are @copilot in this section)

Uh oh!

coveralls commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 18876306141

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

Uh oh!

robertsLando left a comment

Choose a reason for hiding this comment

Uh oh!

robertsLando commented Oct 8, 2025

Uh oh!

Copilot AI commented Oct 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

robertsLando left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

robertsLando left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

robertsLando commented Oct 16, 2025

Uh oh!

Copilot AI commented Oct 16, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Oct 8, 2025 •

edited

Loading

Backend (`api/app.ts`)

coveralls commented Oct 8, 2025 •

edited

Loading