Don't remove zwave_js devices automatically

[raman325]

Breaking change

Home Assistant Devices that represent Z-Wave JS nodes will persist even after the node has been removed. If the node has been removed, you can manually delete the device entry, but note that you will be unable to do so if the node is still known to the controller

Proposed change

Due to issues reported in #80398 where the unique identifiers we use for devices randomly change, the integration was removing devices and recreating them, causing users to lose their entity customizations. To address this, when a node is being (re)registered in the device registry, if there is an existing device that has this node ID but has a different hardware based identifier, we will keep the old device and add a new one with the new hardware based identifier. This will allow a node to reassociate with the first device if the hardware signature changed because of an error and is later corrected. Additionally, users can remove the old device manually if it shouldn't be there.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes ZwaveJS Renames Devices on HA Restart #80398
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zwave_js can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign zwave_js Removes the current integration label and assignees on the pull request, add the integration domain after the command.

[MartinHjelmare]

I don't think this is the solution. We're able to know when devices have been removed and the mentioned problem is not affecting most users. I think we should find the cause and fix that, not workaround it by degrading to manual remove of devices.

[MartinHjelmare]

Reading the PR code, we're still removing the devices that are not known to the controller. It's just the replacement removal of devices with changed metadata that has been removed. The PR description needs to be clarified. I'm more positive about this change.

[raman325]

yes the scope of this PR changed mid flight. Still trying to figure out what to do long term which is why this is still in draft. With that being said, I've updated the PR description to be less confusing

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[raman325]

still valid

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

review comments addressed

[MartinHjelmare]

Thanks!