Add state check to config entry setup to ensure it cannot be setup twice #117193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The config entry manager had a check to make sure the state was in the NOT_LOADED state, but since the entry can retry setup we should check in the entry async_setup to verify that the entry is not already loaded or in the progress of setting up before allowing setup to proceed
thecode
approved these changes
May 10, 2024
|
all good after many restarts |
|
thanks |
|
I assume this can be added to the next milestone? |
| ): | ||
| raise OperationNotAllowed( | ||
| f"The config entry {self.title} ({self.domain}) with entry_id" | ||
| f" {self.entry_id} cannot be setup because is already loaded in the" |
There was a problem hiding this comment.
nit:
Suggested change
| f" {self.entry_id} cannot be setup because is already loaded in the" | |
| f" {self.entry_id} cannot be set up because is already loaded in the" |
Taking another look, maybe also:
Suggested change
| f" {self.entry_id} cannot be setup because is already loaded in the" | |
| f" {self.entry_id} cannot be set up because it is already loaded in the" |
There was a problem hiding this comment.
I'll do a followup as I copied the message from the other location
There was a problem hiding this comment.
I'm adding a lock check to async_setup and async_unload to ensure we never run them without the lock in #117214. I fixed the text there
|
I'm a little nervous about back porting it since it changes the failure mode a bit but it's probably ok |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
The config entry manager has a check to make sure the config entry state was in the
NOT_LOADEDstate, but since the entry can retry setup and does no go through the manager, we should check in the entryasync_setupto verify that the entry is not already loaded or in the progress of setting up before allowing setup to proceedType of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.To help with the load of incoming pull requests: