Skip to content

Fix zwave_js websocket api KeyError on unloaded entry#50154

Merged
MartinHjelmare merged 15 commits intodevfrom
fix-zwave_js-api-entry-access
May 6, 2021
Merged

Fix zwave_js websocket api KeyError on unloaded entry#50154
MartinHjelmare merged 15 commits intodevfrom
fix-zwave_js-api-entry-access

Conversation

@MartinHjelmare
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare commented May 6, 2021

Breaking change

Proposed change

  • Handle websocket api calls when the config entry is unloaded, eg when the server restarts.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

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
  • 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:

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/z-wave, mind taking a look at this pull request as its been labeled with an integration (zwave_js) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

@MartinHjelmare MartinHjelmare added this to the 2021.5.1 milestone May 6, 2021
@MartinHjelmare MartinHjelmare merged commit 38d7652 into dev May 6, 2021
@MartinHjelmare MartinHjelmare deleted the fix-zwave_js-api-entry-access branch May 6, 2021 14:43
ERR_ID_REUSE = "id_reuse"
ERR_INVALID_FORMAT = "invalid_format"
ERR_NOT_FOUND = "not_found"
ERR_NOT_LOADED = "not_loaded"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

No need to make this generic since it's only used inside the zwave_js integration. This list is not exclusive, you can make any error code.

Copy link
Copy Markdown
Member Author

@MartinHjelmare MartinHjelmare May 6, 2021

Choose a reason for hiding this comment

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

Ok. So far it seemed no custom codes were used, but I'll move it.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Moved it: #50188

@github-actions github-actions bot locked and limited conversation to collaborators May 8, 2021
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.

Z-wave JS can't connect to zwave-server on another Rasberry after restart.

4 participants