Skip to content

Clean up device registry if entity registry updates#35106

Merged
balloob merged 2 commits intodevfrom
dev-reg-cleanup
May 5, 2020
Merged

Clean up device registry if entity registry updates#35106
balloob merged 2 commits intodevfrom
dev-reg-cleanup

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented May 3, 2020

Breaking change

Proposed change

After startup or when entity registry entries are removed or their device ID is updated, schedule a cleanup of the device registry.

Devices will be removed if:

  • no entities reference them
  • no config entries reference them

That last one is actually a bug, because config entry removal is supposed to do this but somehow it can happen that devices end up referring to a non-existing config entry. I have been unable to track it down but it ends up breaking random things like device automations.

Note: The logic in this PR to remove devices without config entries was modified by #35977

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

Example entry for configuration.yaml:

# Example configuration.yaml

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

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

@Adminiuga
Copy link
Copy Markdown
Contributor

Would this cause issues for integrations with deferred entity loading? E.g. zha could take a while to quert all devices, so it doesn't delay ha start, but continue loading in the background. I.e. zha entities might not be available on ha startup

@balloob balloob force-pushed the dev-reg-cleanup branch from d45e91a to 9dab7a0 Compare May 4, 2020 21:50
@balloob
Copy link
Copy Markdown
Member Author

balloob commented May 4, 2020

@Adminiuga cleanup is based on the entity registry. The ZHA entries are available there even if ZHA is not booted.

This really is the use case if people are manually removing entities via the frontend etc.

@balloob balloob merged commit 4ae31bc into dev May 5, 2020
@balloob balloob deleted the dev-reg-cleanup branch May 5, 2020 17:53
bdraco pushed a commit that referenced this pull request May 11, 2020
* ISY994 Add Services

ISY994 Add support for climate platform

* Remove device registry cleanup

Remove device registry cleanup from service in favor of #35106

* ISY994 Update Services Definitions

Rename entry to config_entry_id

* Grammar corrections

Fix Typo

* Add await and lower logging per review.

* Rename to entries and remove unused device_id refs

* Fix tuple typo

* Fix Typo in strings

* Fix typo in strings
rhadamantys pushed a commit to rhadamantys/home-assistant that referenced this pull request May 11, 2020
* ISY994 Add Services

ISY994 Add support for climate platform

* Remove device registry cleanup

Remove device registry cleanup from service in favor of home-assistant#35106

* ISY994 Update Services Definitions

Rename entry to config_entry_id

* Grammar corrections

Fix Typo

* Add await and lower logging per review.

* Rename to entries and remove unused device_id refs

* Fix tuple typo

* Fix Typo in strings

* Fix typo in strings
@lock lock Bot locked and limited conversation to collaborators May 21, 2020
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