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 blog post for config_entry unique_id collision warning #2467

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add blog post for config_entry unique_id collision warning #2467

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b93b030
Add blog post for config_entry unique_id collision warning
epenet Nov 21, 2024
1feb5e9
Update and rename 2024-11-22-config-flow-unique-id to 2024-11-22-conf…
epenet Nov 21, 2024
9fbb0d7
Update 2024-11-22-config-flow-unique-id.md
epenet Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions blog/2024-11-22-config-flow-unique-id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
author: epenet
authorURL: https://github.com/epenet
title: "New checks for config flow unique ID"
---

### Summary of changes

When a config flow creates an entry with a colliding unique ID, the old entry is currently automatically removed and replaced with the new config entry.
This can lead to unexpected behavior, and will now log a warning.

The integration should carefully consider whether this was intentional or accidental:
- if it was accidental, the integration should probably be updated to use `self._abort_if_unique_id_configured`
- it it was intentional, the integration should probably be migrated to use a reconfigure flow and use `self.async_update_reload_and_abort`
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo and format technical terms

There's a typo in the conditional statement, and technical terms should use code formatting.

-The integration should carefully consider whether this was intentional or accidental:
-- if it was accidental, the integration should probably be updated to use `self._abort_if_unique_id_configured`
-- it it was intentional, the integration should probably be migrated to use a reconfigure flow and use `self.async_update_reload_and_abort`
+Integrations must evaluate if the collision is intentional:
+- If accidental: Update the integration to use `self._abort_if_unique_id_configured`
+- If intentional: Migrate to use a `reconfigure` flow with `self.async_update_reload_and_abort`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The integration should carefully consider whether this was intentional or accidental:
- if it was accidental, the integration should probably be updated to use `self._abort_if_unique_id_configured`
- it it was intentional, the integration should probably be migrated to use a reconfigure flow and use `self.async_update_reload_and_abort`
Integrations must evaluate if the collision is intentional:
- If accidental: Update the integration to use `self._abort_if_unique_id_configured`
- If intentional: Migrate to use a `reconfigure` flow with `self.async_update_reload_and_abort`
🧰 Tools
🪛 LanguageTool

[grammar] ~14-~14: It seems you either mean “if it”, “it” or there is a comma missing.
Context: ...self._abort_if_unique_id_configured - it it was intentional, the integration should...

(IT_IT)


More details can be found in the [config flow](/docs/config_entries_config_flow_handler#unique-id-requirements) documentation.