Skip to content

Conversation

@k-wasniowski
Copy link
Contributor

@k-wasniowski k-wasniowski commented May 19, 2025

COMPLETES #SPARK-627888

This pull request addresses

Adds a feature toggle which will help rolling out of the Audio Main DTX from the web client

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

Tested with JS-SDK

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

I certified that

  • I have read and followed contributing guidelines
  • I discussed changes with code owners prior to submitting this pull request
  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

@k-wasniowski k-wasniowski requested review from a team as code owners May 19, 2025 07:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 19, 2025

📝 Walkthrough

Walkthrough

The changes update the @webex/internal-media-core dependency from version 2.14.7 to 2.15.0 in the package.json files for the @webex/media-helpers, @webex/plugin-meetings, and @webex/calling packages. In the @webex/plugin-meetings package, an optional disableAudioMainDtx boolean property is added to the Media.createMediaConnection function, and a new private method _toggleDisableAudioMainDtx is introduced in the Meetings class to manage this flag in the configuration. The disableAudioMainDtx option is also integrated into the Meeting class's media connection creation. Corresponding unit tests for _toggleDisableAudioMainDtx and for the handling of disableAudioMainDtx in media connection creation are added. Minor formatting changes are made in some test cases. No other changes to exported or public entity declarations are present except for the new function parameter and private method.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
(node:28174) [DEP0169] DeprecationWarning: url.parse() behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for url.parse() vulnerabilities.
(Use node --trace-deprecation ... to show where the warning was created)
warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > [email protected]: Glob versions prior to v9 are no longer supported
warning [email protected]: Glob versions prior to v9 are no longer supported
warning intern > [email protected]: Glob versions prior to v9 are no longer supported
warning intern > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jasmine > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-config > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > [email protected]: Glob versions prior to v9 are no longer supported
warning mocha > [email protected]: Glob versions prior to v9 are no longer supported
warning mocha > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning [email protected]: 16.1.1
warning sinon > @sinonjs/samsam > [email protected]: This package is deprecated. Use the optional chaining (?.) operator instead.
warning wd > [email protected]: You or someone you depend on is using Q, the JavaScript Promise library that gave JavaScript developers strong feelings about promises. They can almost certainly migrate to the native JavaScript promise now. Thank you literally everyone for joining me in this bet against the odds. Be excellent to each other.

(For a CapTP with native promises, see @endo/eventual-send and @endo/captp)
warning wd > archiver > [email protected]: Glob versions prior to v9 are no longer supported
warning wd > [email protected]: request has been deprecated, see request/request#3142
warning wd > archiver > archiver-utils > [email protected]: Glob versions prior to v9 are no longer supported
warning wd > request > [email protected]: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.
warning wd > request > [email protected]: this library is no longer supported
warning @babel/cli > [email protected]: Glob versions prior to v9 are no longer supported
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-export-namespace-from instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning @babel/[email protected]: 🚨 This package has been deprecated in favor of separate inclusion of a polyfill and regenerator-runtime (when needed). See the @babel/polyfill docs (https://babeljs.io/docs/en/babel-polyfill) for more information.
warning @babel/polyfill > [email protected]: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
warning @babel/runtime-corejs2 > [email protected]: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
warning babel-plugin-lodash > [email protected]: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > [email protected]: Glob versions prior to v9 are no longer supported
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > [email protected]: 16.1.1
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-export-namespace-from instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning workspace-aggregator-5bd70a12-862e-45be-9716-db5149645541 > @babel/[email protected]: 🚨 This package has been deprecated in favor of separate inclusion of a polyfill and regenerator-runtime (when needed). See the @babel/polyfill docs (https://babeljs.io/docs/en/babel-polyfill) for more information.
[2/4] Fetching packages...
error [email protected]: The engine "node" is incompatible with this module. Expected version "^14 || ^16 || ^17 || ^18 || ^19". Got "24.0.2"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 4501064 and 43bc9bc.

📒 Files selected for processing (1)
  • packages/@webex/plugin-meetings/src/meeting/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/@webex/plugin-meetings/src/meeting/index.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Initialize Project
  • GitHub Check: AWS Amplify Console Web Preview
  • GitHub Check: GitGuardian Security Checks
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@k-wasniowski k-wasniowski added the validated If the pull request is validated for automation. label May 19, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (1)

403-414: Tests for new Audio Main DTX toggle feature

New test suite added for the _toggleDisableAudioMainDtx method, which verifies that the method exists and properly updates the configuration when called with true.

Consider adding a test case for toggling the feature off (passing false to the method) to ensure bidirectional functionality works as expected.

 describe('success', () => {
   it('should update meetings to disable audio main dtx', () => {
     webex.meetings._toggleDisableAudioMainDtx(true);
     assert.equal(webex.meetings.config.experimental.disableAudioMainDtx, true);
   });
+  
+  it('should update meetings to enable audio main dtx', () => {
+    webex.meetings._toggleDisableAudioMainDtx(false);
+    assert.equal(webex.meetings.config.experimental.disableAudioMainDtx, false);
+  });
 });
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 727e691 and 50ccabf.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (6)
  • packages/@webex/media-helpers/package.json (1 hunks)
  • packages/@webex/plugin-meetings/package.json (1 hunks)
  • packages/@webex/plugin-meetings/src/media/index.ts (3 hunks)
  • packages/@webex/plugin-meetings/src/meetings/index.ts (1 hunks)
  • packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (3 hunks)
  • packages/calling/package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Initialize Project
  • GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (9)
packages/calling/package.json (1)

40-40: Dependency bump aligned with related packages
The update of @webex/internal-media-core to version 2.15.0 matches the bumps in @webex/plugin-meetings and @webex/media-helpers, ensuring consistent use of the new Audio Main DTX feature support across the SDK.

packages/@webex/media-helpers/package.json (1)

25-25: Dependency version update

This updates the @webex/internal-media-core package from 2.14.7 to 2.15.0 to support the Audio Main DTX toggle feature.

packages/@webex/plugin-meetings/package.json (1)

66-66: Dependency version update

This updates the @webex/internal-media-core package from 2.14.7 to 2.15.0 to support the Audio Main DTX toggle feature.

packages/@webex/plugin-meetings/test/unit/spec/meetings/index.js (2)

674-674: Minor formatting improvement

Added trailing comma for better consistency in object declarations.


690-690: Minor formatting improvement

Added trailing comma for better consistency in object declarations.

packages/@webex/plugin-meetings/src/meetings/index.ts (1)

810-828: Implementation looks clean and follows existing patterns

The new _toggleDisableAudioMainDtx method follows the established pattern of other toggle methods in this class, with proper type checking and conditional state update. The method is well-documented, clearly indicating it should be called before webex.meetings.register().

packages/@webex/plugin-meetings/src/media/index.ts (3)

145-145: Parameter addition is well-placed

The new optional disableAudioMainDtx boolean parameter is properly added to the options interface.


157-158: Clean parameter destructuring

The new parameter is correctly destructured from the options object.


175-176: Properly applied configuration parameter

The disableAudioMainDtx flag is correctly passed into the configuration for MultistreamRoapMediaConnection, which aligns with the PR objectives for controlling Audio Main DTX functionality.

@aws-amplify-us-east-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-4278.d3m3l2kee0btzx.amplifyapp.com

Copy link
Contributor

@edvujic edvujic 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, but could you check why unit tests are failing?

➤ YN0000: [@webex/plugin-meetings]:      AssertError: expected MultistreamRoapMediaConnection to be called with arguments 
➤ YN0000: [@webex/plugin-meetings]: { iceServers: [], disableAudioMainDtx: undefined } { iceServers: [] } 
➤ YN0000: [@webex/plugin-meetings]: '"meeting id"'
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]

@k-wasniowski
Copy link
Contributor Author

Looks good, but could you check why unit tests are failing?

➤ YN0000: [@webex/plugin-meetings]:      AssertError: expected MultistreamRoapMediaConnection to be called with arguments 
➤ YN0000: [@webex/plugin-meetings]: { iceServers: [], disableAudioMainDtx: undefined } { iceServers: [] } 
➤ YN0000: [@webex/plugin-meetings]: '"meeting id"'
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]
➤ YN0000: [@webex/plugin-meetings]: [Function (anonymous)]

Yeah, looking into it

@k-wasniowski k-wasniowski reopened this May 19, 2025
@k-wasniowski k-wasniowski requested a review from edvujic May 19, 2025 08:45
}

/**
* API to toggle usage of audio main DTX, needs to be called before webex.meetings.register()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the comment says "needs to be called before webex.meetings.register()" - I don't think that's true, it can be called later as long as it's done before joinWithMedia() or addMedia()

@k-wasniowski k-wasniowski merged commit f2533e4 into webex:next May 19, 2025
13 of 23 checks passed
@k-wasniowski k-wasniowski deleted the feat-toggle-for-disable-audio-main-dtx branch May 19, 2025 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated If the pull request is validated for automation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants