Navigation Menu

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decouple initial refreshes in setup for Environment Canada #64946

Merged
merged 2 commits into from Jan 26, 2022
Merged

Decouple initial refreshes in setup for Environment Canada #64946

merged 2 commits into from Jan 26, 2022

Conversation

gwww
Copy link
Contributor

@gwww gwww commented Jan 26, 2022

Proposed change

When the integration is being setup and if one of the coordinators is down (most often see radar not available) then the entire integration is unavailable, instead of just the one coordinator (of the three) that is down.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

There are two "parts" to this PR. The first bit is decoupling the DataUpdateCoordinator initial refreshes. The second bit is to fix all the places in the entities that break because the initial refresh of the data failed. Most of those are pretty straight forward. The only one I want to highlight is that the unique_id for sensor is initialized from a different data source -- the unique_ids have not changed.

Big thank you to @thecode who helped me understand the options for how this is fixed.

We considered two approaches for this change. The approach that can be seen in the first commit in this PR was discarded as entities would show with unknown values when their corresponding DataUpdateCoordinator fails. The approach taken in the final PR show entities as Unavailable when their corresponding DataUpdateCoordinator fails.

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 @michaeldavie, mind taking a look at this pull request as it has been labeled with an integration (environment_canada) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@balloob balloob merged commit cf7148c into home-assistant:dev Jan 26, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Jan 27, 2022
@gwww gwww deleted the ec-fix-setup branch April 3, 2022 15:28
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.

None yet

3 participants