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 myuplink reauth flow #110587

Merged
merged 16 commits into from Feb 17, 2024
Merged

Add myuplink reauth flow #110587

merged 16 commits into from Feb 17, 2024

Conversation

astrandb
Copy link
Contributor

@astrandb astrandb commented Feb 14, 2024

Breaking change

Proposed change

Add reauth flow
Before we release the switch platform and other future platforms that send commands to the API we need to add a "WRITESYSTEM" scope to OAuth2 .
There is now a check for this scope in async_setup_entry(). If the scope is missing a reauthentication flow is initiated. The user will have to authenticate the account at myUplink and after a few clicks it is finished and the integration starts again.

TODO

The reauth flow should also be triggered by normal HTTP authentication errors but that is a topic for a follow-up PR.

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

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

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@astrandb astrandb changed the title Reauth Add myuplink reauth flowReauth Feb 14, 2024
@astrandb astrandb changed the title Add myuplink reauth flowReauth Add myuplink reauth flow Feb 14, 2024
tests/components/myuplink/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/myuplink/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/myuplink/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/conftest.py Outdated Show resolved Hide resolved
tests/components/myuplink/test_config_flow.py Outdated Show resolved Hide resolved
tests/components/myuplink/test_config_flow.py Outdated Show resolved Hide resolved
@astrandb
Copy link
Contributor Author

Well, it is cleaned up and tests work except that the scope is not updated because the abort-and-reload is not executed.
For one reason or anotherself.config_entry_reauth is None in this last part of the flow when running test_config_flow.

Real HA works fine.

---------- coverage: platform linux, python 3.11.4-final-0 -----------
Name                                               Stmts   Miss  Cover   Missing
--------------------------------------------------------------------------------
homeassistant/components/myuplink/config_flow.py      27      1    96%   53
homeassistant/components/myuplink/const.py             5      0   100%
homeassistant/components/myuplink/diagnostics.py      20      0   100%
homeassistant/components/myuplink/update.py           24      0   100%
--------------------------------------------------------------------------------
TOTAL                                                 76      1    99%

@astrandb
Copy link
Contributor Author

I think we are getting close!
Some cleanups also.

@astrandb astrandb marked this pull request as ready for review February 16, 2024 13:14
@MartinHjelmare MartinHjelmare marked this pull request as draft February 16, 2024 13:44
@astrandb astrandb marked this pull request as ready for review February 16, 2024 15:08
@astrandb astrandb closed this Feb 16, 2024
@astrandb astrandb reopened this Feb 16, 2024
@astrandb
Copy link
Contributor Author

CI is failing on file test_ini.py. It was removed as per your request in this latest commit.

ERROR tests/components/myuplink/test_init.py - Failed: In test_expired_token_refresh_failure: function uses no argument 'expires_at'
ERROR tests/components/myuplink/test_init.py - Failed: In test_expired_token_refresh_failure: function uses no argument 'expires_at'
Error: Process completed with exit code 1.

@MartinHjelmare MartinHjelmare marked this pull request as draft February 16, 2024 21:36
@astrandb astrandb marked this pull request as ready for review February 17, 2024 08:44
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare merged commit f5dad1d into home-assistant:dev Feb 17, 2024
23 checks passed
@astrandb
Copy link
Contributor Author

Thanks again for your thorough and constructive review.

@github-actions github-actions bot locked and limited conversation to collaborators Feb 18, 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.

None yet

2 participants