Fix WebRTC for Firefox by ignoring empty ice candidates #21908

jonnynch · 2024-09-06T07:52:47Z

Proposed change

Not adding empty candidate into offer sdp to avoid smartdevicemanagement google api returns 500 internal server error

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 #
Error handling WebRTC offer: Nest API error: Error from API: 500: INTERNAL: Internal error encountered.: Internal Server Error core#103924
It has to combine with Workaround for Nest SDP answer bugs to pass firefox validation allenporter/python-google-nest-sdm#1115 release
in order to have nest cam working in Firefox
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

Summary by CodeRabbit

Bug Fixes
- Improved handling of ICE candidates during WebRTC connections to enhance connection stability.
- Ensured that the connection setup only proceeds once valid candidates are fully gathered, preventing premature resolutions.

home-assistant

Hi @jonnynch

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2024-09-06T07:52:51Z

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

Learn more about our pull request process.

Stale

coderabbitai · 2024-09-06T08:20:35Z

Walkthrough

The changes involve an update to the ICE candidate handling logic within the HaWebRtcPlayer class. The condition for resolving the promise has been refined to ensure that a valid ICE candidate is present before proceeding. This adjustment enhances the robustness of the candidate gathering process during WebRTC connection setup.

Changes

Files	Change Summary
src/components/ha-web-rtc-player.ts	Modified the logic for resolving ICE candidate promises to ensure valid candidate presence.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2a41406 and dfd843d.

Files selected for processing (1)

src/components/ha-web-rtc-player.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

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

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 or @coderabbitai title 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.

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-09-06T08:23:52Z

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

@@ -109,7 +109,7 @@ class HaWebRtcPlayer extends LitElement {
    let candidates = ""; // Build an Offer SDP string with ice candidates
    const iceResolver = new Promise<void>((resolve) => {
      peerConnection.addEventListener("icecandidate", async (event) => {
-        if (!event.candidate) {
+        if (!(event.candidate && event.candidate.candidate)) {


Refine ICE candidate handling and consider using optional chaining.

The modification at line 112 enhances the robustness of the ICE candidate handling by ensuring that the promise resolves only when there are no valid candidates available. This is a crucial fix for the issue with Firefox and empty ICE candidates.

Additionally, consider using optional chaining to simplify the condition and improve code safety:

- if (!(event.candidate && event.candidate.candidate)) { + if (!event.candidate?.candidate) {

This change will make the code more readable and prevent potential null reference errors.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if (!(event.candidate && event.candidate.candidate)) {

if (!event.candidate?.candidate) {

Tools

Biome

[error] 112-112: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

@coderabbitai updated as per comment

@jonnynch Thank you for updating the code as per the suggestion! The use of optional chaining will indeed make the code more readable and safer. Everything looks great! 😊

If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!

allenporter

Thank you so much for fixing this long standing issue with the Firefox webrtc. Many nest + firefox users will very much appreciate this.

Can you change the PR description to something like "Fix WebRTC for Firefox by ignoring empty ice candidates"? Something with propper capitalization.

allenporter · 2024-09-06T14:18:50Z

Tagging for review for a future patch release candidate.

handle firefox empty string ice candidate

a6b22d1

home-assistant bot added the cla-needed label Sep 6, 2024

home-assistant bot previously requested changes Sep 6, 2024

View reviewed changes

home-assistant bot marked this pull request as draft September 6, 2024 07:52

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Sep 6, 2024

jonnynch marked this pull request as ready for review September 6, 2024 08:19

Merge branch 'dev' into dev

2a41406

coderabbitai bot reviewed Sep 6, 2024

View reviewed changes

jonnynch added 2 commits September 6, 2024 22:14

use optional chaining as per comment

dfd843d

Merge branch 'dev' into dev

fb96054

allenporter approved these changes Sep 6, 2024

View reviewed changes

allenporter added this to the 2024.9 milestone Sep 6, 2024

jonnynch changed the title ~~handle firefox empty string ice candidate~~ Fix WebRTC for Firefox by ignoring empty ice candidates Sep 6, 2024

silamon approved these changes Sep 8, 2024

View reviewed changes

silamon merged commit de292a8 into home-assistant:dev Sep 8, 2024
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix WebRTC for Firefox by ignoring empty ice candidates #21908

Fix WebRTC for Firefox by ignoring empty ice candidates #21908

jonnynch commented Sep 6, 2024 •

edited by coderabbitai bot

Loading

home-assistant bot left a comment

home-assistant bot commented Sep 6, 2024

coderabbitai bot commented Sep 6, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Sep 6, 2024 •

edited

Loading

jonnynch Sep 6, 2024

coderabbitai bot Sep 6, 2024

allenporter left a comment

allenporter commented Sep 6, 2024

	if (!(event.candidate && event.candidate.candidate)) {
	if (!event.candidate?.candidate) {

Fix WebRTC for Firefox by ignoring empty ice candidates #21908

Fix WebRTC for Firefox by ignoring empty ice candidates #21908

Conversation

jonnynch commented Sep 6, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Sep 6, 2024

coderabbitai bot commented Sep 6, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Sep 6, 2024 • edited Loading

Choose a reason for hiding this comment

jonnynch Sep 6, 2024

Choose a reason for hiding this comment

coderabbitai bot Sep 6, 2024

Choose a reason for hiding this comment

allenporter left a comment

Choose a reason for hiding this comment

allenporter commented Sep 6, 2024

jonnynch commented Sep 6, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

coderabbitai bot Sep 6, 2024 •

edited

Loading