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

Add support for subscribing to config entry changes #77803

Merged
merged 5 commits into from
Sep 5, 2022

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Sep 4, 2022

Frontend: home-assistant/frontend#13585

Proposed change

Add support for subscribing to config entry changes.

The dispatcher is used to get events to the api since config entry state changes
are frequent and we do not want to broadcast them to the event bus.

I didn't use a collection here since config entries are rather noisy with retries
and state changes and I wanted to send everything in a single api so
there wasn't a race between fetching the initial payload and getting callbacks.

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

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

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

@bdraco
Copy link
Member Author

bdraco commented Sep 4, 2022

Will write tests after first round of feedback

@MartinHjelmare
Copy link
Member

What will we use it for?

@bdraco
Copy link
Member Author

bdraco commented Sep 4, 2022

Add support for subscribing to config entry changes home-assistant/frontend#13585

home-assistant/frontend#13446 (comment)

Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@bdraco bdraco marked this pull request as ready for review September 5, 2022 03:57
@bdraco bdraco requested a review from a team as a code owner September 5, 2022 03:57
@bdraco bdraco merged commit 016a59a into home-assistant:dev Sep 5, 2022
@bdraco bdraco deleted the config_entry_changes branch September 5, 2022 03:57
@github-actions github-actions bot locked and limited conversation to collaborators Sep 6, 2022
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.

4 participants