@webex/plugin-meetings 3.8.0-next.66 → 3.8.0-next.67

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.66"
+  version: "3.8.0-next.67"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.8.0-next.66",
+    "@webex/plugin-meetings": "3.8.0-next.67",
     "@webex/plugin-rooms": "3.8.0-next.23",
     "@webex/test-helper-chai": "3.8.0-next.19",
     "@webex/test-helper-mocha": "3.8.0-next.19",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.0-next.19",
     "@webex/internal-plugin-support": "3.8.0-next.23",
     "@webex/internal-plugin-user": "3.8.0-next.19",
-    "@webex/internal-plugin-voicea": "3.8.0-next.66",
+    "@webex/internal-plugin-voicea": "3.8.0-next.67",
     "@webex/media-helpers": "3.8.0-next.23",
     "@webex/plugin-people": "3.8.0-next.21",
     "@webex/plugin-rooms": "3.8.0-next.23",
@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.66"
+  "version": "3.8.0-next.67"
 }

package/src/config.ts

@@ -98,5 +98,6 @@ export default {
     enableReachabilityChecks: true,
     reachabilityGetClusterTimeout: 5000,
     logUploadIntervalMultiplicationFactor: 0, // if set to 0 or undefined, logs won't be uploaded periodically, if you want periodic logs, recommended value is 1
+    stopIceGatheringAfterFirstRelayCandidate: false,
   },
 };

package/src/media/index.ts

@@ -16,6 +16,7 @@ import {
   LocalMicrophoneStream,
 } from '@webex/media-helpers';
 import {RtcMetrics} from '@webex/internal-plugin-metrics';
+import {BrowserInfo} from '@webex/web-capabilities';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {MEDIA_TRACK_CONSTRAINT} from '../constants';
 import Config from '../config';
@@ -143,6 +144,7 @@ Media.createMediaConnection = (
     bundlePolicy?: BundlePolicy;
     iceCandidatesTimeout?: number;
     disableAudioMainDtx?: boolean;
+    stopIceGatheringAfterFirstRelayCandidate?: boolean;
   }
 ) => {
   const {
@@ -155,6 +157,7 @@ Media.createMediaConnection = (
     bundlePolicy,
     iceCandidatesTimeout,
     disableAudioMainDtx,
+    stopIceGatheringAfterFirstRelayCandidate,
   } = options;
 
   const iceServers = [];
@@ -182,6 +185,12 @@ Media.createMediaConnection = (
       config.disableAudioMainDtx = disableAudioMainDtx;
     }
 
+    if (BrowserInfo.isFirefox()) {
+      config.doFullIce = true;
+
+      config.stopIceGatheringAfterFirstRelayCandidate = stopIceGatheringAfterFirstRelayCandidate;
+    }
+
     return new MultistreamRoapMediaConnection(
       config,
       meetingId,

package/src/meeting/index.ts

@@ -7022,6 +7022,9 @@ export default class Meeting extends StatelessWebexPlugin {
         iceCandidatesTimeout: this.config.iceCandidatesGatheringTimeout,
         // @ts-ignore - config coming from registerPlugin
         disableAudioMainDtx: this.config.experimental.disableAudioMainDtx,
+        stopIceGatheringAfterFirstRelayCandidate:
+          // @ts-ignore - config coming from registerPlugin
+          this.config.stopIceGatheringAfterFirstRelayCandidate,
       }
     );
 

package/src/meetings/index.ts

@@ -827,6 +827,27 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle stopping ICE Candidates Gathering after first relay candidate,
+   * needs to be called before webex.meetings.joinWithMedia()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleStopIceGatheringAfterFirstRelayCandidate(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.stopIceGatheringAfterFirstRelayCandidate !== newValue) {
+      // @ts-ignore
+      this.config.stopIceGatheringAfterFirstRelayCandidate = newValue;
+    }
+  }
+
   /**
    * Executes a registration step and updates the registration status.
    * @param {Function} step - The registration step to execute.

package/test/unit/spec/media/index.ts

@@ -4,6 +4,7 @@ import Media from '@webex/plugin-meetings/src/media/index';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import StaticConfig from '@webex/plugin-meetings/src/common/config';
+import { BrowserInfo } from '@webex/web-capabilities';
 
 describe('createMediaConnection', () => {
   let clock;
@@ -197,7 +198,68 @@ describe('createMediaConnection', () => {
 
     sendMetricsInQueueCallback();
     assert.calledOnce(rtcMetrics.sendMetricsInQueue);
+  });
+
+  it('multistream non-firefox does not care about stopIceGatheringAfterFirstRelayCandidate', () => {
+    const multistreamRoapMediaConnectionConstructorStub = sinon
+      .stub(InternalMediaCoreModule, 'MultistreamRoapMediaConnection')
+      .returns(fakeRoapMediaConnection);
+
+    Media.createMediaConnection(true, 'some debug id', 'meeting id', {
+      stopIceGatheringAfterFirstRelayCandidate: true,
+    });
+    assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
+    assert.calledWith(
+      multistreamRoapMediaConnectionConstructorStub,
+      {
+        iceServers: []
+      },
+      'meeting id'
+    );
+  });
+
+  it('multistream firefox stops gathering after first relay if stopIceGatheringAfterFirstRelayCandidate is true', () => {
+    const multistreamRoapMediaConnectionConstructorStub = sinon
+      .stub(InternalMediaCoreModule, 'MultistreamRoapMediaConnection')
+      .returns(fakeRoapMediaConnection);
+
+    sinon.stub(BrowserInfo, 'isFirefox').returns(true);
+
+    Media.createMediaConnection(true, 'some debug id', 'meeting id', {
+      stopIceGatheringAfterFirstRelayCandidate: true,
+    });
+    assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
+    assert.calledWith(
+      multistreamRoapMediaConnectionConstructorStub,
+      {
+        iceServers: [],
+        doFullIce: true,
+        stopIceGatheringAfterFirstRelayCandidate: true,
+      },
+      'meeting id'
+    );
+  });
+
+  it('multistream firefox continues gathering if stopIceGatheringAfterFirstRelayCandidate is false', () => {
+    const multistreamRoapMediaConnectionConstructorStub = sinon
+      .stub(InternalMediaCoreModule, 'MultistreamRoapMediaConnection')
+      .returns(fakeRoapMediaConnection);
+
+    sinon.stub(BrowserInfo, 'isFirefox').returns(true);
 
+    Media.createMediaConnection(true, 'some debug id', 'meeting id', {
+      stopIceGatheringAfterFirstRelayCandidate: false,
+    });
+    assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
+    assert.calledWith(
+      multistreamRoapMediaConnectionConstructorStub,
+      {
+        iceServers: [],
+        doFullIce: true,
+        stopIceGatheringAfterFirstRelayCandidate: false,
+      },
+      'meeting id'
+    );
   });
 
   [

package/test/unit/spec/meetings/index.js

@@ -413,6 +413,19 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#_toggleStopIceGatheringAfterFirstRelayCandidate', () => {
+      it('should have _toggleStopIceGatheringAfterFirstRelayCandidate', () => {
+        assert.equal(typeof webex.meetings._toggleStopIceGatheringAfterFirstRelayCandidate, 'function');
+      });
+
+      describe('success', () => {
+        it('should update meetings to stop ICE candidates gathering after first relay candidate', () => {
+          webex.meetings._toggleStopIceGatheringAfterFirstRelayCandidate(true);
+          assert.equal(webex.meetings.config.stopIceGatheringAfterFirstRelayCandidate, true);
+        });
+      });
+    });
+
     describe('Public API Contracts', () => {
       describe('#register', () => {
         it('emits an event and resolves when register succeeds', async () => {