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.

Sign up for GitHub

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

Jump to bottom

Add message from Bad Request errors to HassioAPIError #113144

Merged
merged 6 commits into from
Mar 13, 2024
Merged

Add message from Bad Request errors to HassioAPIError #113144

merged 6 commits into from
Mar 13, 2024

Conversation

agners
Copy link
Member

@agners agners commented Mar 12, 2024 •
edited
Loading

Breaking change

Proposed change

With #111162 send_command() started to pass Bad Requests directly as Exception. Before that, errors got returned as dictionary, and ultimately converted into HassioAPIError in websocket_supervisor_api and api_data. Raising HassioAPIError without adding the message lead to the frontend to show "Unknown error, see supervisor logs" in cases where the API actually returned a sensible message.

It is generally a good idea to convert errors into exception as early as possible, so this PR still makes Bad Request raising an exception. However, with this change we add the message to the HassioAPIError exception object to restore previous behavior for websocket calls.

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

To help with the load of incoming pull requests:

@agners agners added the bugfix label Mar 12, 2024
@home-assistant
Copy link

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

Code owner commands

Code owners of hassio 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 hassio 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.

@agners agners requested a review from mdegat01 March 12, 2024 11:27
@agners agners added this to the 2024.3.1 milestone Mar 12, 2024
@agners
Copy link
Member Author

agners commented Mar 12, 2024

It seems that the tests we have expects a json to be returned even when the error is Bad Request:

core/tests/components/hassio/test_websocket_api.py

Line 174 in 42574fe

json={"result": "error", "message": "example error"},

I guess this is to simulate the previous HTTP behavior? 🤔

@agners
Copy link
Member Author

agners commented Mar 12, 2024

Hm, on closer look test_websocket_supervisor_api_error actually relied on a specific behavior of the websocket_supervisor_api implementation: It formatted an error even when the HTTP return status was OK (200).

This is actually not really what the Supervisor typically does, API errors always lead to a HTTP return status Bad Requuest (400):

So I think the tests needs fixing here and use HTTP status 400 instead.

If APIForbidden is returned on Supervisor side, this will lead to HTTP status 403. But this was also before this PR handled differently (converted to a HassioAPIError exception in send_command).

mdegat01
mdegat01 previously requested changes Mar 12, 2024
View reviewed changes
homeassistant/components/hassio/handler.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft March 12, 2024 14:47
@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.

@agners agners marked this pull request as ready for review March 12, 2024 15:28
@home-assistant home-assistant bot requested a review from mdegat01 March 12, 2024 15:28
agners and others added 5 commits March 12, 2024 23:49
@agners
Add message from Bad Request errors to HassioAPIError
50a11ca 
With #111162 send_command() started to pass Bad Requests directly
as Exception. Before that, errors got returned as dictionary,
and ultimately converted into HassioAPIError in `websocket_supervisor_api`
and and `api_data`. Raising HassioAPIError without adding the message
lead to the frontend to show "Unknown error, see supervisor logs" in cases
where the API actually returned a sensible message.

It is generally a good idea to convert errors into exception as early
as possible, so this PR still makes Bad Request raising an exception.
However, with this change we add the message to the HassioAPIError
exception object to restore previous behavior for websocket calls.
@agners
Use status code 400 to simulate Supervisor error
500784c
@agners @mdegat01
Update homeassistant/components/hassio/handler.py
bbe532f 
Co-authored-by: Mike Degatano <michael.degatano@gmail.com>
@agners
Simplify code
91dec1e
@agners
Explicitly test error code
40c0d96
@agners agners force-pushed the hassio-fix-passing-msg-on-bad-request branch from f248662 to 91dec1e Compare March 12, 2024 22:51
frenck
frenck approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @agners 👍

../Frenck

@frenck frenck dismissed mdegat01’s stale review March 13, 2024 10:29

Comment addressed

@frenck frenck merged commit 99eaa07 into dev Mar 13, 2024
35 checks passed
@frenck frenck deleted the hassio-fix-passing-msg-on-bad-request branch March 13, 2024 10:29
frenck pushed a commit that referenced this pull request Mar 13, 2024
@agners @mdegat01 @frenck
Add message from Bad Request errors to HassioAPIError (#113144)
095d0d0 
Co-authored-by: Mike Degatano <michael.degatano@gmail.com>
@frenck frenck mentioned this pull request Mar 13, 2024
Merged
xeniter pushed a commit to xeniter/core that referenced this pull request Mar 13, 2024
@agners @mdegat01 @xeniter
Add message from Bad Request errors to HassioAPIError (home-assistant…
2064028 
…#113144)

Co-authored-by: Mike Degatano <michael.degatano@gmail.com>
@github-actions github-actions bot locked and limited conversation to collaborators Mar 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

@mdegat01 mdegat01 Awaiting requested review from mdegat01

Assignees
No one assigned
Labels
bugfix by-code-owner cherry-picked cla-signed core integration: hassio Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
2024.3.1
Development

Successfully merging this pull request may close these issues.
3 participants
@agners @frenck @mdegat01