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 coordinator to ring integration #107088

Merged
merged 9 commits into from Jan 31, 2024

Conversation

sdb9696
Copy link
Contributor

@sdb9696 sdb9696 commented Jan 4, 2024

Proposed change

Replace bespoke DataUpdater classes with DataUpdateCoordinator derived classes from helpers.update_coordinator.

This will prevent errors spamming the logs in error conditions and should get the integration quality to silver (and then gold once test coverage is improved elsewhere.)

It's also a dependency for a subsequent PR to address issue #88705.

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

The change consolidates 3 of the DataUpdater classes into 1 DataUpdateCoordinator class. This will prevent 3 seperate log messages if the api is unavailable and also makes the code simpler.

The NotificationUpdateCoordinator will be replaced with a Push listener in a subsequent change.

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:

Copy link

@D661 D661 left a comment

Choose a reason for hiding this comment

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

LGTM

homeassistant/components/ring/__init__.py Show resolved Hide resolved
homeassistant/components/ring/coordinator.py Show resolved Hide resolved
homeassistant/components/ring/coordinator.py Outdated Show resolved Hide resolved
homeassistant/components/ring/coordinator.py Outdated Show resolved Hide resolved
homeassistant/components/ring/entity.py Outdated Show resolved Hide resolved
homeassistant/components/ring/entity.py Outdated Show resolved Hide resolved
homeassistant/components/ring/light.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 19, 2024 13:38
@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.

@sdb9696 sdb9696 marked this pull request as ready for review January 19, 2024 18:13
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 19, 2024

Now updated as per all suggestions/comments

@edenhaus edenhaus marked this pull request as draft January 24, 2024 10:27
@edenhaus
Copy link
Contributor

Please mark it ready to review after #107088 (comment) is addressed

@sdb9696 sdb9696 marked this pull request as ready for review January 24, 2024 13:58
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 24, 2024

Now ready for review again. Service re-instated and deprecation added to #108781.

@sdb9696 sdb9696 marked this pull request as draft January 24, 2024 14:07
@sdb9696 sdb9696 marked this pull request as ready for review January 24, 2024 14:23
homeassistant/components/ring/light.py Outdated Show resolved Hide resolved
homeassistant/components/ring/binary_sensor.py Outdated Show resolved Hide resolved
homeassistant/components/ring/switch.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 24, 2024 14:54
@sdb9696 sdb9696 marked this pull request as ready for review January 24, 2024 15:58
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 24, 2024

Latest comments addressed. CI failed due to coverage upload which should be transient.

@home-assistant home-assistant bot marked this pull request as draft January 25, 2024 07:50
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 25, 2024

Review comment addressed.

@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 29, 2024

Hi @edenhaus, hopefully all comments addressed here? Was hoping to get this into beta if possible.

@edenhaus
Copy link
Contributor

Was hoping to get this into beta if possible.

@sdb9696 Please answer my question above otherwise the PR looks fine :)

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 @sdb9696 👍

Can be merged if CI is passing

@edenhaus edenhaus merged commit f725258 into home-assistant:dev Jan 31, 2024
23 checks passed
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 31, 2024

Thanks for all your help @edenhaus!

@sdb9696 sdb9696 deleted the add_ring_coordinator branch January 31, 2024 09:39
@sdb9696
Copy link
Contributor Author

sdb9696 commented Jan 31, 2024

N.B. The PR to prepare the ring update service for deprecation is now updated and ready for review #108781.

@sdb9696 sdb9696 mentioned this pull request Jan 31, 2024
20 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 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.

None yet

3 participants