Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resume adding Z-Wave device if the page is refreshed #129081

Merged
merged 3 commits into from
Oct 25, 2024

Conversation

MindFreeze
Copy link
Contributor

@MindFreeze MindFreeze commented Oct 24, 2024

Proposed change

If device inclusion is already in progress when the "zwave_js/add_node" is received, we subscribe to the controller events but if the "node added" has passed, we will not be subscribed to the node events. So the client will not know when the device inclusion ended.
This PR checks if inclusion is in progress and if there is already a node that hasn't finished the process. It then subscribes to the node events and sends "node added" event to the frontend so proper progress can be displayed.
The use case for this is refreshing the Configure page or reopening it after a crash, for example.

A frontend PR will follow to better utilize these changes but is not required for this to work. FE PR home-assistant/frontend#22519

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 #
  • 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 Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

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

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@MindFreeze MindFreeze marked this pull request as ready for review October 24, 2024 12:53
@MindFreeze MindFreeze requested a review from a team as a code owner October 24, 2024 12:53
@MartinHjelmare MartinHjelmare changed the title ZwaveJS: Resume adding a device if the page is refreshed Resume adding Z-Wave device if the page is refreshed Oct 24, 2024
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add tests for the changed code.

homeassistant/components/zwave_js/api.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

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.

@home-assistant home-assistant bot marked this pull request as draft October 24, 2024 21:26
@MindFreeze MindFreeze marked this pull request as ready for review October 25, 2024 06:45
@MartinHjelmare MartinHjelmare marked this pull request as draft October 25, 2024 07:29
@MindFreeze MindFreeze marked this pull request as ready for review October 25, 2024 08:50
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MartinHjelmare MartinHjelmare merged commit 47bf0eb into home-assistant:dev Oct 25, 2024
32 checks passed
zxdavb pushed a commit to zxdavb/hass that referenced this pull request Oct 25, 2024
…129081)

* ZwaveJS: Resume adding a device if the page is refreshed

* add test

* address PR comments
noahhusby pushed a commit to noahhusby/ha-core that referenced this pull request Oct 25, 2024
…129081)

* ZwaveJS: Resume adding a device if the page is refreshed

* add test

* address PR comments
@github-actions github-actions bot locked and limited conversation to collaborators Oct 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants