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

Fix zwave_js set_config_parameter WS api regression #109042

Merged
merged 1 commit into from
Jan 29, 2024

Conversation

kpine
Copy link
Contributor

@kpine kpine commented Jan 29, 2024

Proposed change

This PR fixes a breaking API regression of the Z-Wave JS set_config_parameter WS API, that was introduced in 2023.11.0 (here). Specifically this upstream PR, which was marked as a breaking change, changed the return type of async_set_config_parameter, but no follow up change was made in the integration.

Prior to the change, the frontend was receiving an object with a string field named "status" (here), with valid values "accepted" or "queued". After the upstream change, an object is being returned instead of the string. This results in the configuration page showing a grey circle and no text, instead of useful icons and text.

The fix is to just pass the string status result as was originally done.

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:

Reported in the community forum:

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

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.

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!

@kpine kpine marked this pull request as ready for review January 29, 2024 14:41
@kpine kpine requested a review from a team as a code owner January 29, 2024 14:41
@MartinHjelmare MartinHjelmare merged commit be8af7b into home-assistant:dev Jan 29, 2024
23 checks passed
chemelli74 pushed a commit to chemelli74/core that referenced this pull request Jan 29, 2024
Moustachauve pushed a commit to Moustachauve/HA-core that referenced this pull request Jan 30, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jan 30, 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