core icon indicating copy to clipboard operation
core copied to clipboard

Refactor Tado to use OAuth in the DeviceTracker

Open erwindouna opened this issue 1 year ago • 8 comments

Breaking change

Proposed change

As hinted out in Issue 102402, by a developer of Tado, the DeviceTracker is still using the old way of authenticating with Tado. This PR fixes this by utilizing PyTado's methods, which have OAuth. This is in line with the desire of Tado and a foundational improvement, whereas direct protocol specific code has been removed and replaced by PyTado.

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)
  • [x] 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 #102402
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • [x] The code change is tested and works locally.
  • [x] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] The code has been formatted using Black (black --fast homeassistant tests)
  • [x] 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:

erwindouna avatar Oct 23 '23 20:10 erwindouna

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

Code owner commands

Code owners of tado 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 tado Removes the current integration label and assignees on the pull request, add the integration domain after the command.

home-assistant[bot] avatar Oct 23 '23 20:10 home-assistant[bot]

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

Learn more about our pull request process.

home-assistant[bot] avatar Oct 23 '23 21:10 home-assistant[bot]

@MartinHjelmare The dispatcher logic has been added and parts refactored to support this. I got a perfectly working setup that updates my device state. Please let me know if you have any feedback.

erwindouna avatar Nov 14 '23 20:11 erwindouna

The config flow and repair issues need to have written tests.

MartinHjelmare avatar Nov 16 '23 10:11 MartinHjelmare

The config flow and repair issues need to have written tests.

Will do so, once the import step is stable enough to write tests. 👍

erwindouna avatar Nov 16 '23 11:11 erwindouna

I think you can start writing tests for the config flow now.

MartinHjelmare avatar Dec 14 '23 12:12 MartinHjelmare

Just solve the merge conflict and we can merge, I think.

MartinHjelmare avatar Dec 26 '23 20:12 MartinHjelmare

Please add a paragraph in the PR description about what is deprecated now.

MartinHjelmare avatar Dec 26 '23 20:12 MartinHjelmare

We should update the docs about the device tracker too.

https://www.home-assistant.io/integrations/tado/#presence-detection

Please link a docs PR here.

MartinHjelmare avatar Dec 27 '23 12:12 MartinHjelmare

We should update the docs about the device tracker too.

https://www.home-assistant.io/integrations/tado/#presence-detection

Please link a docs PR here.

PR made and submitted.

erwindouna avatar Dec 27 '23 12:12 erwindouna

That return value now gives trouble in the CI. Shall I fix it?

erwindouna avatar Dec 27 '23 13:12 erwindouna