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

Handle Alert exception on notification failure #93632

Merged
merged 1 commit into from Aug 4, 2023

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented May 27, 2023

Proposed change

Currently when Alert integration attemps to send a notification, it will throw an unhandled exception if any of its notifiers do not exist. This can happen in two situations:

  1. On home assistant boot, the alert may attempt to fire before all notifiers have been created.
  2. If user specifies one or more notifiers that do not exist in the configuration.

When this happens the alert gets into a bad state, where its internal self._firing flag is set, but it throws an exception before it can call async_write_ha_state. Because of a notification failure, even though the watched condition may be true, the alert does not update its state to on. It will forever remain in idle state if any notifications cannot be delivered.

This change adds a simple try/catch around each attempt to send notification. This ensures that even if one notification fails, the Alert state is always accurate, and all other notifiers that could receive the notification continue to do so.

If the failure was due to trying to send a notification on boot before a notifier was setup, that notifier will then continue receiving subsequent notifications at the original repeat interval.

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

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:

@home-assistant
Copy link

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

Code owner commands

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

Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @karwosts.

Can you please rebase your PR and fix the merge conflicts. Thanks :)

@home-assistant home-assistant bot marked this pull request as draft August 3, 2023 16:44
@home-assistant
Copy link

home-assistant bot commented Aug 3, 2023

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.

@karwosts karwosts marked this pull request as ready for review August 3, 2023 17:44
@home-assistant home-assistant bot requested a review from edenhaus August 3, 2023 17:44
@karwosts
Copy link
Contributor Author

karwosts commented Aug 3, 2023

Change has been rebased/merged.

Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @karwosts 👍

@edenhaus edenhaus merged commit 41eca41 into home-assistant:dev Aug 4, 2023
21 checks passed
@edenhaus edenhaus added this to the 2023.8.2 milestone Aug 4, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Aug 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants