Webrtc use RTCIceCandidateInit messages with backend #22667

sdb9696 · 2024-11-05T10:06:39Z

Proposed change

Pass the RTCIceCandidateInit message between the frontend and backend to allow setting the sdpMid and sdpMLineIndex values.

core PR

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

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

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

coderabbitai · 2024-11-05T10:06:48Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

bramkragten · 2024-11-05T12:21:08Z

Can you link the associated core PR?

sdb9696 · 2024-11-05T14:56:47Z

Can you link the associated core PR?

That's done

src/components/ha-web-rtc-player.ts

Co-authored-by: Bram Kragten <[email protected]>

sdb9696 · 2024-11-06T13:22:13Z

Hi @bramkragten, since you approved this I have updated the messaging to pass the RTCIceCandidate message between the front end the core rather than just adding sdp_m_line_index. This makes the solution more in line with the standard which could accept sdpMid as well.

bramkragten · 2024-11-07T08:37:48Z

@sdb9696 I like that, but the types that are used dont match, the type in frontend has a lot more than the model in the backend.

Create a separate type in the frontend that matches the type of the backend.

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate

https://github.com/home-assistant-libs/python-webrtc-models/pull/2/files#diff-2cb5148764f0e6bbc48bc92652db6485ce1dd68cfa48e37dd19ab9716c4c600eR58-R64

sdb9696 · 2024-11-07T13:04:35Z

@sdb9696 I like that, but the types that are used dont match, the type in frontend has a lot more than the model in the backend.

Create a separate type in the frontend that matches the type of the backend.

developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate

home-assistant-libs/python-webrtc-models#2 (files)

Hi @bramkragten, using the same type seems to be consistent with how the RTCConfiguration is being used, i.e. the webrtc-models implementation is not defining all the fields in the spec but the message from the backend is being used to construct the RTCConfiguration directly. At the moment the web socket just ignores the extra fields in the message it gets back from the frontend. Do you think that's an issue? Another approach could be to implement all the ice candidate spec in webrtc-models but it seems unnecessary as all the other fields are derived from the candidate string so we'll never need them.

bramkragten · 2024-11-07T13:54:54Z

The difference there is that for RTCConfiguration every property is optional, so it is valid.

interface RTCConfiguration {
    bundlePolicy?: RTCBundlePolicy;
    certificates?: RTCCertificate[];
    iceCandidatePoolSize?: number;
    iceServers?: RTCIceServer[];
    iceTransportPolicy?: RTCIceTransportPolicy;
    rtcpMuxPolicy?: RTCRtcpMuxPolicy;
}

For RTCIceCandidate there is no optional property, they can be null, but not omitted. Also there should be a toJSON function.

interface RTCIceCandidate {
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/address) */
    readonly address: string | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/candidate) */
    readonly candidate: string;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/component) */
    readonly component: RTCIceComponent | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/foundation) */
    readonly foundation: string | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/port) */
    readonly port: number | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/priority) */
    readonly priority: number | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/protocol) */
    readonly protocol: RTCIceProtocol | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/relatedAddress) */
    readonly relatedAddress: string | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/relatedPort) */
    readonly relatedPort: number | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/sdpMLineIndex) */
    readonly sdpMLineIndex: number | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/sdpMid) */
    readonly sdpMid: string | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/tcpType) */
    readonly tcpType: RTCIceTcpCandidateType | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/type) */
    readonly type: RTCIceCandidateType | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/usernameFragment) */
    readonly usernameFragment: string | null;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/toJSON) */
    toJSON(): RTCIceCandidateInit;
}

sdb9696 · 2024-11-07T14:04:15Z

Ah, good point. So I think I'll need to extend the RTCIceCandidate interface. Will check with @edenhaus.

sdb9696 · 2024-11-07T18:02:19Z

Ok have now more fully implemented RTCIceCandidate in the webrtc-models PR.

to_json will return the RTCIceCandidateInit as per the spec.

sdb9696 · 2024-11-13T16:13:19Z

This is now updated to use the RTCIceCandidateInit for messaging and supports just the candidate being received to avoid breaking change.

Add sdp m line index to ICE Candidates

3d05b80

home-assistant bot added the cla-signed label Nov 5, 2024

sdb9696 mentioned this pull request Nov 5, 2024

Webrtc use RTCIceCandidateInit messages with frontend home-assistant/core#129879

Open

19 tasks

Merge remote-tracking branch 'upstream/dev' into feat/webrtc_mlineindex

1e6e80c

bramkragten reviewed Nov 5, 2024

View reviewed changes

src/components/ha-web-rtc-player.ts Outdated Show resolved Hide resolved

Remove ? from candidate

9b69d2e

Co-authored-by: Bram Kragten <[email protected]>

silamon added the wait for backend label Nov 5, 2024

bramkragten previously approved these changes Nov 6, 2024

View reviewed changes

Send full candidate in message

bb727bd

sdb9696 dismissed bramkragten’s stale review via bb727bd November 6, 2024 13:13

Revert launch.json change

2692edc

sdb9696 added 2 commits November 13, 2024 16:10

Use RTCIceCandidate for messaging

76f6ea1

Merge remote-tracking branch 'upstream/dev' into feat/webrtc_mlineindex

2468763

sdb9696 changed the title ~~Add sdp m line index to ICE Candidates~~ Webrtc use RTCIceCandidateInit messages with backend Nov 19, 2024

Merge branch 'dev' into feat/webrtc_mlineindex

abca4c8

sdb9696 marked this pull request as ready for review November 19, 2024 10:08

bramkragten approved these changes Nov 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Webrtc use RTCIceCandidateInit messages with backend #22667

Webrtc use RTCIceCandidateInit messages with backend #22667

sdb9696 commented Nov 5, 2024 •

edited

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

bramkragten commented Nov 5, 2024

sdb9696 commented Nov 5, 2024

sdb9696 commented Nov 6, 2024

bramkragten commented Nov 7, 2024 •

edited

Loading

sdb9696 commented Nov 7, 2024

bramkragten commented Nov 7, 2024

sdb9696 commented Nov 7, 2024

sdb9696 commented Nov 7, 2024

sdb9696 commented Nov 13, 2024

Webrtc use RTCIceCandidateInit messages with backend #22667

Are you sure you want to change the base?

Webrtc use RTCIceCandidateInit messages with backend #22667

Conversation

sdb9696 commented Nov 5, 2024 • edited Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

coderabbitai bot commented Nov 5, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

bramkragten commented Nov 5, 2024

sdb9696 commented Nov 5, 2024

sdb9696 commented Nov 6, 2024

bramkragten commented Nov 7, 2024 • edited Loading

sdb9696 commented Nov 7, 2024

bramkragten commented Nov 7, 2024

sdb9696 commented Nov 7, 2024

sdb9696 commented Nov 7, 2024

sdb9696 commented Nov 13, 2024

sdb9696 commented Nov 5, 2024 •

edited

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

bramkragten commented Nov 7, 2024 •

edited

Loading