Fix stalls in config flow of APCUPSD #108931
Merged
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
home-assistant
bot
added
bugfix
cla-signed
integration: apcupsd
small-pr
bdraco
reviewed
Jan 27, 2024
| @@ -52,9 +52,8 @@ async def async_step_user( | |||
|
|
|||
| # Test the connection to the host and get the current status for serial number. | |||
| coordinator = APCUPSdCoordinator(self.hass, host, port) | |||
There was a problem hiding this comment.
Usually we don't create coordinators in config flows.
In a future PR it would be nice to replace this with await aioapcaccess.request_status(host, port) and trap the exceptions instead
There was a problem hiding this comment.
Sounds good, will do!
bdraco
reviewed
Jan 27, 2024
| await coordinator.async_request_refresh() | ||
| await self.hass.async_block_till_done() |
There was a problem hiding this comment.
This will wait for everything, not just the integration so it will likely never finish once startup has completed.
There was a problem hiding this comment.
Huh, that makes sense now! Thanks for the explanations!
Updated the PR description!
bdraco
approved these changes
Jan 27, 2024
yuxincs
changed the title
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
This PR fixes the stalls in config flow of APCUPSD integration, where we were mistakenly calling
hass.async_block_till_done()after requesting initial coordinator refresh.hass.async_block_till_done()waits for everything in HASS, not just the the integration itself (and it is usually only used in test code). Therefore, this call will probably never return once HASS startup finishes. We were unable to reproduce this since we were testing on new installations, but users with existing installations have reported such an issue when they were adding an apcupsd integration (see #108221).Credit goes to @dom42 who was able to reproduce this locally and found the culprit.
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..coveragerc.To help with the load of incoming pull requests: