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.

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

Fix race in config entry setup #117756

Merged
merged 4 commits into from
May 20, 2024
Merged

Fix race in config entry setup #117756

merged 4 commits into from
May 20, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 20, 2024

Proposed change

If the config entry was reloaded while we are waiting for the lock to do the setup retry we should bail out since the config entry is already loaded. This was much more likely to happen if the event loop was blocked during startup.

It may have been possible for it to also happen the other way around where the event loop is blocked for a bit and the reload happens before the config entries are setup. This change will fix it for both paths since we check the state after getting the lock.

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

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

If the config entry was reloaded while we are waiting for the lock
to do the setup retry we should bail out since the config entry
is already loaded
@bdraco bdraco added this to the 2024.5.5 milestone May 20, 2024
@home-assistant home-assistant bot added bugfix cla-signed core small-pr PRs with less than 30 lines. labels May 20, 2024
@bdraco bdraco changed the title Fix race in config entry setup retry Fix race in config entry setup May 20, 2024
@bdraco bdraco marked this pull request as ready for review May 20, 2024 05:05
@bdraco bdraco requested a review from a team as a code owner May 20, 2024 05:05
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @bdraco 👍

../Frenck

@frenck frenck merged commit 13ba8e6 into dev May 20, 2024
38 checks passed
@frenck frenck deleted the race_setup_again_fix branch May 20, 2024 07:47
@bdraco
Copy link
Member Author

bdraco commented May 20, 2024

thanks

bajansen pushed a commit to bajansen/homeassistant that referenced this pull request May 20, 2024
@github-actions github-actions bot locked and limited conversation to collaborators May 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants