Abort if a flow is removed during a step #142138
Merged
Conversation
This file contains hidden or 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
emontnemery
commented
Apr 3, 2025
emontnemery
commented
Apr 7, 2025
emontnemery
commented
Apr 7, 2025
emontnemery
force-pushed
the
data_entry_flow_end_on_abort
branch
from
a3bd027 to
f52d0fb
Compare
emontnemery
commented
Apr 9, 2025
Comment on lines
+1506
to
+1511
| @callback | ||
| def async_flow_removed( | ||
| self, | ||
| flow: data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult], | ||
| result: ConfigFlowResult, | ||
| ) -> ConfigFlowResult: | ||
| """Finish a config flow and add an entry. | ||
|
|
||
| This method is called when a flow step returns FlowResultType.ABORT or | ||
| FlowResultType.CREATE_ENTRY. | ||
| """ | ||
| ) -> None: | ||
| """Handle a removed config flow.""" |
There was a problem hiding this comment.
The point of this method is to unconditionally remove reauth issues when a reauth flow is removed. We could optionally also include updating of the discovery keys, but I don't think that's needed.
bdraco
approved these changes
Apr 9, 2025
|
Latest design looks a lot cleaner. 👍 |
|
This needs tests of the new method and changed behavior before merge Edit: Tests have been added, I think this can be merged now. |
19 tasks
This was referenced Apr 9, 2025
bdraco
approved these changes
Apr 9, 2025
|
Thanks @emontnemery |
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
Abort early if a flow is removed during a step, instead of going ahead creating an entry
To still give flow managers the opportunity to clean up, a new method
FlowManager.async_flow_removedis added, which is meant to be implemented by classed derived fromFlowManager.In this PR, an
async_flow_removedmethod is added toConfigEntriesFlowManager, the method cleans up reauth issues which ensures reauth issues are always cleaned up when a reauth flow is aborted, not only if the reauth flow returns abort.Type 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.To help with the load of incoming pull requests: