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

Validate unique_id in entity registry #114648

Merged
merged 5 commits into from
Apr 4, 2024
Merged

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Apr 2, 2024

Proposed change

Validate unique_id in entity registry to avoid crashing core if the unique_id is not hashable

Note: This does not fix a new regression, but we keep getting reports about integrations breaking core startup because of invalid entity ids

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

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:

@emontnemery emontnemery added this to the 2024.4.0 milestone Apr 2, 2024
@emontnemery emontnemery requested a review from a team as a code owner April 2, 2024 15:30
_validate_item(
self.hass, domain, entity["platform"], entity["unique_id"]
)
except (TypeError, ValueError):
Copy link
Member

Choose a reason for hiding this comment

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

Could we add a test for this part?

@emontnemery emontnemery force-pushed the entity_registry_validate_unique_id branch from 84e1c2b to 72dba26 Compare April 3, 2024 07:18
@frenck frenck removed this from the 2024.4.0 milestone Apr 3, 2024
@bdraco
Copy link
Member

bdraco commented Apr 4, 2024

Testing this now on production

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

Performance impact is negligible/within margin of error with latest code 👍

Nice work

Screenshot 2024-04-04 at 9 16 20 AM

@bdraco bdraco merged commit 7c95ecf into dev Apr 4, 2024
34 checks passed
@bdraco bdraco deleted the entity_registry_validate_unique_id branch April 4, 2024 19:51
),
entity["entity_id"],
entity["platform"],
str(err),
Copy link
Member

Choose a reason for hiding this comment

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

Exceptions have a string magic method so we don't need to copy them to a string.

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

7 participants