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

Add new helper for matching reauth/reconfigure config flows #127565

Draft
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Oct 4, 2024

Breaking change

Proposed change

As we seek to prevent reauth/reconfigure flows from creating new entries, whilst at the same time preventing reauth/reconfigurations from updating other entries, I think it makes sense to add this helper.

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Oct 4, 2024

Hey there @frenck, @joostlek, mind taking a look at this pull request as it has been labeled with an integration (spotify) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of spotify can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign spotify Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Comment on lines +2447 to +2451
self.source == SOURCE_REAUTH
and self._get_reauth_entry().unique_id != self.unique_id
) or (
self.source == SOURCE_RECONFIGURE
and self._get_reconfigure_entry().unique_id != self.unique_id
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if we should assume the unique ID is being used for detecting these cases.

@frenck
Copy link
Member

frenck commented Oct 5, 2024

I think it makes sense to add this helper.

Can you elaborate on that? There is nothing in the PR description that explain the foundation behind it.

@epenet
Copy link
Contributor Author

epenet commented Oct 5, 2024

I think it makes sense to add this helper.

Can you elaborate on that? There is nothing in the PR description that explain the foundation behind it.

It's a pattern I've bumped into a few times. Axis and abode for example use this pattern.
It was used by integrations when reconfigure wasn't available.
I'll look for more examples on Monday

@epenet epenet marked this pull request as draft October 5, 2024 14:20
@epenet
Copy link
Contributor Author

epenet commented Oct 5, 2024

I think it makes sense to add this helper.

Can you elaborate on that? There is nothing in the PR description that explain the foundation behind it.

It's a pattern I've bumped into a few times. Axis and abode for example use this pattern. It was used by integrations when reconfigure wasn't available. I'll look for more examples on Monday

It's also partially linked to #127527

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants