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

Allow async_integration_yaml_config to raise if config fails on reload #101037

Closed
wants to merge 15 commits into from
Closed

Allow async_integration_yaml_config to raise if config fails on reload #101037

wants to merge 15 commits into from

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Sep 28, 2023 •
edited
Loading

Proposed change

Allow async_integration_yaml_config to throw if config fails on reload. This way integrations no longer need to raise an exception if the config failed causing additional errors in the logs.

Before the change with raising in the MQTT integration logging and extra line:
afbeelding

After the change with more details in the UI:
afbeelding

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

@jbouwh jbouwh requested review from emontnemery and a team as code owners September 28, 2023 07:39
@home-assistant
Copy link

Hey there @emontnemery, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt 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 mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.

emontnemery
emontnemery requested changes Sep 28, 2023
View reviewed changes
homeassistant/config.py Show resolved Hide resolved
homeassistant/config.py Outdated Show resolved Hide resolved
homeassistant/helpers/reload.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft September 28, 2023 08:13
@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.

@jbouwh jbouwh marked this pull request as ready for review September 29, 2023 11:02
jbouwh
jbouwh commented Sep 29, 2023
View reviewed changes
homeassistant/config.py
Comment on lines +970 to 973
except LOAD_EXCEPTIONS as ex:
_raise_on_fail(ex, f"Platform error: {domain}")
_LOGGER.exception("Platform error: %s", domain)
continue
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This code part did not have tests for the current code

emontnemery
emontnemery reviewed Sep 29, 2023
View reviewed changes
homeassistant/helpers/reload.py Outdated Show resolved Hide resolved
homeassistant/config.py Outdated Show resolved Hide resolved
homeassistant/config.py Outdated Show resolved Hide resolved
@jbouwh jbouwh requested a review from emontnemery September 29, 2023 12:50
emontnemery
emontnemery approved these changes Sep 29, 2023
View reviewed changes
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

This is very nice, thanks @jbouwh 👍

@emontnemery emontnemery added the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Sep 29, 2023
@emontnemery
Copy link
Contributor

I'd like a second opinion on this in case the solution is not good for some reason.

@jbouwh jbouwh marked this pull request as draft October 2, 2023 09:51
@emontnemery
Copy link
Contributor

One concern is that while this gives a better explanation to the user in frontend about what went wrong, it also spams the log with an unneeded stack trace. A suggestion discussed on Discord is to add a parameter to HomeAssistantError which communicates that a stack trace is not needed for that exception.

@emontnemery emontnemery mentioned this pull request Oct 2, 2023
Draft
20 tasks
@emontnemery emontnemery self-requested a review October 2, 2023 18:05
emontnemery
emontnemery reviewed Oct 2, 2023
View reviewed changes
homeassistant/exceptions.py Outdated Show resolved Hide resolved
homeassistant/exceptions.py Outdated Show resolved Hide resolved
@jbouwh jbouwh marked this pull request as ready for review October 3, 2023 16:33
@home-assistant home-assistant bot requested a review from emontnemery October 3, 2023 16:33
@jbouwh
Copy link
Contributor Author

jbouwh commented Oct 5, 2023

Related: #101357

@jbouwh jbouwh force-pushed the component-config-exception branch from c7db8f1 to 9b0abdb Compare October 10, 2023 06:34
@jbouwh jbouwh marked this pull request as draft October 10, 2023 08:04
@jbouwh
Copy link
Contributor Author

jbouwh commented Oct 10, 2023

The concerns about logging are addressed with: #101762

@jbouwh jbouwh force-pushed the component-config-exception branch from 787ee40 to 986c6f3 Compare October 20, 2023 09:53
@jbouwh jbouwh removed the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Oct 20, 2023
@jbouwh jbouwh mentioned this pull request Oct 20, 2023
Merged
20 tasks
@jbouwh
Copy link
Contributor Author

jbouwh commented Oct 20, 2023

Super seeded by #102410

@jbouwh jbouwh closed this Oct 20, 2023
@jbouwh jbouwh deleted the component-config-exception branch October 20, 2023 18:25
@github-actions github-actions bot locked and limited conversation to collaborators Oct 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco will be requested when the pull request is marked ready for review bdraco is a code owner

Assignees

@emontnemery emontnemery

Labels
by-code-owner cla-signed code-quality core integration: mqtt Quality Scale: gold
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jbouwh @emontnemery