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

Always reload after a successful reauth flow #116026

Merged
merged 10 commits into from
Apr 24, 2024

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Apr 23, 2024

Proposed change

This PR will update the helper async_update_reload_and_abort is to always reload after a successful reauth flow by default.

When the entry needs attention, this can e.g. be due to a temporary disabled account. In cased where the entry is not updated, because the credentials did not change, we still want to reload the entry as this helper promises after a successful re-auth flow. Otherwise the entry might stay in its faulty state.

For backwards compatibility, it is still possible to fall back to the old behavior by passing reload_even_if_entry_is_unchanged=False.

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:

@jbouwh jbouwh requested a review from a team as a code owner April 23, 2024 09:43
@home-assistant home-assistant bot added bugfix cla-signed core small-pr PRs with less than 30 lines. labels Apr 23, 2024
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Please add tests which pass with the changes in this PR and fail without them.

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft April 23, 2024 09:48
@jbouwh jbouwh marked this pull request as ready for review April 23, 2024 18:25
@bdraco bdraco changed the title Always reload after a succesful reauth-flow Always reload after a successful reauth flow Apr 23, 2024
homeassistant/config_entries.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft April 24, 2024 08:23
@jbouwh jbouwh marked this pull request as ready for review April 24, 2024 11:18
@home-assistant home-assistant bot requested a review from frenck April 24, 2024 11:18
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.

Nice 👍

../Frenck

@jbouwh jbouwh dismissed emontnemery’s stale review April 24, 2024 12:07

Tests added as requested

@jbouwh
Copy link
Contributor Author

jbouwh commented Apr 24, 2024

Thnx!

@jbouwh jbouwh merged commit 70b358b into dev Apr 24, 2024
38 checks passed
@jbouwh jbouwh deleted the always-reload-after-succesfull-reauth-flow branch April 24, 2024 13:13
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bugfix cla-signed core small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants