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

Remove legacy webrtc provider APIs #128790

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

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Oct 19, 2024

Breaking change

Breaking change for developers: This removes the legacy WebRTC provider API async_register_rtsp_to_web_rtc_provider in favor of the new WebRTC provider APIs introduced while adding go2rtc

Integrations now use the package homeassistant.components.camera.webrtc and implement CameraWebRTCProvider and register with async_register_webrtc_provider.

Proposed change

Remove legacy webrtc provider APIs and update rtsp_to_webrtc to use the new APIs.

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

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (camera) you are listed as a code owner for? Thanks!

Code owner commands

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

@edenhaus
Copy link
Contributor

Drafting this PR as I will discuss it with the core team to discuss if we can really remove the API without any deprecation period.
In my opinion, also, this PR should be merged after #127981. Otherwise, #127981 will get even bigger as we need to add support for async webRTC and especially async candidates in the mentioned PR.

@edenhaus edenhaus marked this pull request as draft October 19, 2024 19:27
@allenporter
Copy link
Contributor Author

allenporter commented Oct 19, 2024

Drafting this PR as I will discuss it with the core team to discuss if we can really remove the API without any deprecation period. In my opinion, also, this PR should be merged after #127981. Otherwise, #127981 will get even bigger as we need to add support for async webRTC and especially async candidates in the mentioned PR.

My take is that it gets smaller by removing the shim layer support. There is already too much complexity in camera for special cases and I think it's work minimizing. Open to input of course, but that's my recommendation.

@allenporter
Copy link
Contributor Author

Drafting this PR as I will discuss it with the core team to discuss if we can really remove the API without any deprecation period. In my opinion, also, this PR should be merged after #127981. Otherwise, #127981 will get even bigger as we need to add support for async webRTC and especially async candidates in the mentioned PR.

My take is that it gets smaller by removing the shim layer support. There is already too much complexity in camera for special cases and I think it's work minimizing. Open to input of course, but that's my recommendation.

Either way, whatever it takes to move fast here -- My impression is we're blocked until tuesday when frontend gets sorted.

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.

2 participants