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

Bad Request from supervisor should be error #111162

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Bad Request from supervisor should be error #111162

merged 1 commit into from
Feb 27, 2024

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Feb 22, 2024

Proposed change

If an API call is made to Supervisor and it cannot process it due to invalid input or a handled issue that occurred with the particular resource it responds with a 400 (Bad Request) type response. This is an error, the API call was not processed successfully. Core should treat it like an error and raise an exception like it would or any other non-200 type response.

Currently this causes a number of problems. For example, repairs created by supervisor always disappear when the user applies the repair even if it wasn't actually applied successfully. Or when a service call results in an API call to supervisor with invalid input but appears to have been processed successfully:
image

I'm not entirely sure why Bad Request was originally given a pass on raising an exception so I don't know exactly what issues this change could cause. Hopefully if someone does they can comment and we can work on those. Logically though it doesn't really make sense to me, a 400 response is clearly an error and should not be treated like a success.

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:

@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 merged commit 68200de into dev Feb 27, 2024
53 checks passed
@agners agners deleted the bad-request-is-error branch February 27, 2024 20:49
@github-actions github-actions bot locked and limited conversation to collaborators Feb 28, 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