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.

Sign up for GitHub

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

Jump to bottom

Add config subentry support to entity registry #128155

Merged
merged 5 commits into from
Jan 27, 2025
Merged

Add config subentry support to entity registry #128155

merged 5 commits into from
Jan 27, 2025

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Oct 11, 2024 •
edited
Loading

Proposed change

Add config subentry support to entity registry

This is intended as a follow-up to #117355

Needs #128157

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.

To help with the load of incoming pull requests:

@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!

Code owner commands

Code owners of config can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign config Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@emontnemery emontnemery mentioned this pull request Oct 11, 2024
Merged
19 tasks
@emontnemery emontnemery force-pushed the entity_registry_subentry_support branch from 4842a7c to 8d6853d Compare December 2, 2024 08:06
@emontnemery
Copy link
Contributor Author

emontnemery commented Dec 12, 2024 •
edited
Loading

Frontend is approved: home-assistant/frontend#23160

@emontnemery emontnemery force-pushed the entity_registry_subentry_support branch from 8d6853d to 23fc272 Compare December 12, 2024 19:17
@emontnemery emontnemery mentioned this pull request Dec 13, 2024
Closed
19 tasks
@emontnemery emontnemery force-pushed the entity_registry_subentry_support branch from 23fc272 to 242226b Compare December 14, 2024 10:37
@bramkragten bramkragten mentioned this pull request Dec 16, 2024
Open
9 tasks
@emontnemery emontnemery force-pushed the entity_registry_subentry_support branch from 242226b to 7292531 Compare December 18, 2024 09:13
@emontnemery emontnemery force-pushed the entity_registry_subentry_support branch from 7292531 to 048e642 Compare January 23, 2025 19:13
@emontnemery emontnemery changed the base branch from dev to config_subentries_feature_2 January 23, 2025 19:13
@emontnemery emontnemery marked this pull request as ready for review January 23, 2025 19:13
MartinHjelmare
MartinHjelmare approved these changes Jan 27, 2025
View reviewed changes
homeassistant/helpers/entity_registry.py Outdated Show resolved Hide resolved
tests/helpers/test_entity_registry.py
@@ -1431,7 +1562,7 @@ async def test_remove_config_entry_from_device_removes_entities_2(
config_entry_2.entry_id,
}

# Create one entity for each config entry
# Create an entity without config entry
Copy link
Member

Choose a reason for hiding this comment

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

Side note: It's weird to have an entity entry connected to a device entry but not connected to the config entry of the device entry. Should that even be allowed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it's indeed weird, and I think we should add validation to prevent it in a follow-up

tests/helpers/test_entity_registry.py Outdated Show resolved Hide resolved
tests/helpers/test_entity_registry.py
"light",
"hue",
"5678",
device_id=device_entry.id,
Copy link
Member

Choose a reason for hiding this comment

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

When does an integration connect its entities to another integration's device without having a config entry of its own?

I was thinking maybe the template integration but that only links to devices when set up from a config entry.

The entity platform helper code doesn't support connecting a device via device_info if the added entity doesn't have a config entry.

The only place in our codebase I found that created an entity entry directly via async_get_or_create without a config entry was the TagEntity which doesn't connect to a device entry.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's probably no valid case, I just added tests to assert behavior for various cases

@emontnemery emontnemery merged commit 313e82f into config_subentries_feature_2 Jan 27, 2025
46 checks passed
@emontnemery emontnemery deleted the entity_registry_subentry_support branch January 27, 2025 20:15
@github-actions github-actions bot locked and limited conversation to collaborators Jan 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@MartinHjelmare MartinHjelmare MartinHjelmare approved these changes

@gjohansson-ST gjohansson-ST Awaiting requested review from gjohansson-ST gjohansson-ST is a code owner

@frenck frenck Awaiting requested review from frenck frenck is a code owner

@joostlek joostlek Awaiting requested review from joostlek joostlek is a code owner

@dgomes dgomes Awaiting requested review from dgomes dgomes is a code owner

@Kane610 Kane610 Awaiting requested review from Kane610 Kane610 is a code owner

@Danielhiversen Danielhiversen Awaiting requested review from Danielhiversen Danielhiversen is a code owner

@bieniu bieniu Awaiting requested review from bieniu bieniu is a code owner

@rytilahti rytilahti Awaiting requested review from rytilahti rytilahti is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

@zweckj zweckj Awaiting requested review from zweckj zweckj is a code owner

@jjlawren jjlawren Awaiting requested review from jjlawren jjlawren is a code owner

@Ernst79 Ernst79 Awaiting requested review from Ernst79 Ernst79 is a code owner

@epenet epenet Awaiting requested review from epenet epenet is a code owner

@andrey-git andrey-git Awaiting requested review from andrey-git andrey-git is a code owner

@chemelli74 chemelli74 Awaiting requested review from chemelli74 chemelli74 is a code owner

@jpbede jpbede Awaiting requested review from jpbede jpbede is a code owner

@bachya bachya Awaiting requested review from bachya bachya is a code owner

@pvizeli pvizeli Awaiting requested review from pvizeli pvizeli is a code owner

@pree pree Awaiting requested review from pree pree is a code owner

@mib1185 mib1185 Awaiting requested review from mib1185 mib1185 is a code owner

@cgtobi cgtobi Awaiting requested review from cgtobi cgtobi is a code owner

@fabaff fabaff Awaiting requested review from fabaff fabaff is a code owner

@ctalkington ctalkington Awaiting requested review from ctalkington ctalkington is a code owner

@jbouwh jbouwh Awaiting requested review from jbouwh jbouwh is a code owner

@Jc2k Jc2k Awaiting requested review from Jc2k Jc2k is a code owner

@cgarwood cgarwood Awaiting requested review from cgarwood cgarwood is a code owner

@edenhaus edenhaus Awaiting requested review from edenhaus edenhaus is a code owner

@balloob balloob Awaiting requested review from balloob balloob is a code owner

@thecode thecode Awaiting requested review from thecode thecode is a code owner

@farmio farmio Awaiting requested review from farmio farmio is a code owner

Assignees
No one assigned
Labels
by-code-owner cla-signed core Hacktoberfest has-tests integration: config new-feature Quality Scale: internal
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@emontnemery @MartinHjelmare