core icon indicating copy to clipboard operation
core copied to clipboard

Use unique_id_mismatch in aseko_pool_live reauth

Open epenet opened this issue 1 year ago • 6 comments

Proposed change

The tests imply that the unique_id of the config entry may change during the reauth process. This ensures that it is rejected...

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)
  • [x] Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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:

epenet avatar Oct 14 '24 08:10 epenet

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

Code owner commands

Code owners of aseko_pool_live 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 aseko_pool_live 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.

home-assistant[bot] avatar Oct 14 '24 08:10 home-assistant[bot]

The unique_id can change when the users enters the account details of a different account in the reauth flow. Should we update the id or reject the reath because the user is entering the credentials for another account?

milanmeu avatar Oct 14 '24 08:10 milanmeu

The unique_id can change when the users enters the account details of a different account in the reauth flow. Should we update the id or reject the reath because the user is entering the credentials for another account?

That's your call - you know it better.

  • If the new account has access to the same devices => the unique_id should be updated
  • If the new account is unrelated => it should be rejected using the new helper unique_id_mismatch

epenet avatar Oct 14 '24 08:10 epenet

I don't think we should use reauth for changing credentials, We should rather have the user setup the integration again. But since every device has its own unique_id, it does not break automations

joostlek avatar Oct 14 '24 09:10 joostlek

I don't think we should use reauth for changing credentials, We should rather have the user setup the integration again. But since every device has its own unique_id, it does not break automations

I've updated the code and the PR description to apply this. If the underlying "user_id" linked to the credentials is different, then it will now fail with unique_id_mismatch

epenet avatar Oct 14 '24 11:10 epenet

@milanmeu are you happy with the latest changes?

epenet avatar Oct 15 '24 11:10 epenet