Skip to content

Restore entity ID and user customizations of deleted entities #145278

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

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented May 20, 2025

Proposed change

Keep and restore entity ID and user customizations of aliases, area_id, categories, device_class, disabled_by, hidden_by, icon, labels, name and options when restoring deleted entities

If the area_id no longer exists, it will not be restored
Any category or label which no longer exists will not be restored

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:
  • Link to developer documentation pull request:
  • Link to frontend 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:

@emontnemery emontnemery requested a review from a team as a code owner May 20, 2025 07:01
@emontnemery emontnemery marked this pull request as draft May 20, 2025 07:01
@emontnemery emontnemery marked this pull request as ready for review May 20, 2025 07:26
@emontnemery
Copy link
Contributor Author

Tests are failing because integrations expect entity ID to not be stable when an entity is removed and then added back with a changed name.

Comment on lines +947 to +951
disabled_by = (
deleted_entity.disabled_by
if deleted_entity.disabled_by == RegistryEntryDisabler.USER
else disabled_by
)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we should always restore disabled_by and hidden_by flags, also if the integration has changed?
That would match the behavior for live entities (we never change the disabled or hidden flags for an entity which has already been seen).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant