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 an index for devices and config entries to the entity registry #107516

Merged
merged 4 commits into from Jan 13, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jan 8, 2024

Proposed change

As more entities have been added, the run time cost of looking up entities by device and config entries has increased. For reference, the entity registry storage is now 4-5MB on most of my production systems. The number of entities in the registry continues to grow as more integrations are updated so the problem will continue to get worse over time.

More integrations have migrations of unique ids which tend to stay in the code base for a very long time. They are frequent callers of er.async_entries_for_device and er.async_entries_for_config_entry. Both of these functions have to do a linear search over the entire registry to find matching entries since there is no index for device_id or config_entry id

Side node: Ideally we would change these functions to return a set in another set so removing the the index is cheap, but a lot of the tests are expecting explicit order because its been a list even though its not needed

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

@bdraco bdraco marked this pull request as ready for review January 10, 2024 01:25
@bdraco bdraco requested a review from a team as a code owner January 10, 2024 01:25
@balloob balloob merged commit d791084 into dev Jan 13, 2024
53 checks passed
@balloob balloob deleted the entity_index branch January 13, 2024 19:49
@bdraco
Copy link
Member Author

bdraco commented Jan 13, 2024

thanks

@github-actions github-actions bot locked and limited conversation to collaborators Jan 14, 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

2 participants