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

Adjust SamsungTV abstraction layer #67216

Merged
merged 23 commits into from
Feb 25, 2022

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Feb 25, 2022

Proposed change

Adjust the SamsungTV to ensure that:

  • all public methods are abstract (this result is a slight code duplication right now, but it will make it easier to adjust for Legacy versus WebSocket in the future)
  • ensure that async_add_executor_job is only called in the public methods (at the top level of the abstraction layer) to avoid not needed context switches inside the abstraction implementations
  • adjust exception handling to ensure we do not catch samsungtvws exceptions in legacy implementation and samsungctl in websocket implementation

As follow-up to #67042, and preliminary work for #67127

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)
  • 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
  • The code has been formatted using Black (black --fast 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

Hey there @escoand, @chemelli74, mind taking a look at this pull request as it has been labeled with an integration (samsungtv) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

cc @bdraco / @MartinHjelmare

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

I think it makes sense to add this to the next beta, as it is tightly bound to #67042

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

Note: the coverage decrease was expected - I plan to reach 100% coverage in a follow-up PR

@MartinHjelmare
Copy link
Member

Does it fix any user facing problems?

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

Does it fix any user facing problems?

Not exactly, but #67127 will (as soon as the library is released), and it will need this.

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

Maybe you prefer to keep this one on hold, and include it in the next milestone at the same time as #67127?

@MartinHjelmare
Copy link
Member

I don't think we should switch library in a patch release even if it fixes problems.

@epenet epenet marked this pull request as draft February 25, 2022 14:15
@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

Draft => I will attempt to improve coverage

@epenet epenet marked this pull request as ready for review February 25, 2022 15:03
@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

96.19% of diff hit (target 96.32%)
Not quite 100% yet but getting there...

@epenet epenet marked this pull request as draft February 25, 2022 15:09
@epenet epenet marked this pull request as ready for review February 25, 2022 15:20
@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

100% coverage on bridge.py 🥇

@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

100% coverage on media_player.py 🥇

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.

Looks good!

@MartinHjelmare MartinHjelmare merged commit 715d7f7 into home-assistant:dev Feb 25, 2022
@epenet epenet deleted the samsung-abstract branch February 25, 2022 16:32
@epenet
Copy link
Contributor Author

epenet commented Feb 25, 2022

Thanks @MartinHjelmare 👍

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

4 participants