@webex/plugin-meetings 3.8.0-next.30 → 3.8.0-next.32

package/src/roap/turnDiscovery.ts

@@ -4,11 +4,11 @@ import {Defer} from '@webex/common';
 import Metrics from '../metrics';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import LoggerProxy from '../common/logs/logger-proxy';
-import {ROAP, Enum} from '../constants';
+import {ROAP} from '../constants';
 
 import RoapRequest from './request';
 import Meeting from '../meeting';
-import MeetingUtil from '../meeting/util';
+import {TurnDiscoverySkipReason, TurnServerInfo, TurnDiscoveryResult} from './types';
 
 const TURN_DISCOVERY_TIMEOUT = 10; // in seconds
 
@@ -18,28 +18,6 @@ const TURN_DISCOVERY_TIMEOUT = 10; // in seconds
 // and do the SDP offer with seq=1
 const TURN_DISCOVERY_SEQ = 0;
 
-const TurnDiscoverySkipReason = {
-  missingHttpResponse: 'missing http response', // when we asked for the TURN discovery response to be in the http response, but it wasn't there
-  reachability: 'reachability', // when udp reachability to public clusters is ok, so we don't need TURN (this doens't apply when joinWithMedia() is used)
-  alreadyInProgress: 'already in progress', // when we try to start TURN discovery while it's already in progress
-} as const;
-
-export type TurnDiscoverySkipReason =
-  | Enum<typeof TurnDiscoverySkipReason> // this is a kind of FYI, because in practice typescript will infer the type of TurnDiscoverySkipReason as a string
-  | string // used in case of errors, contains the error message
-  | undefined; // used when TURN discovery is not skipped
-
-export type TurnServerInfo = {
-  url: string;
-  username: string;
-  password: string;
-};
-
-export type TurnDiscoveryResult = {
-  turnServerInfo?: TurnServerInfo;
-  turnDiscoverySkippedReason: TurnDiscoverySkipReason;
-};
-
 /**
  * Handles the process of finding out TURN server information from Linus.
  * This is achieved by sending a TURN_DISCOVERY_REQUEST.
@@ -61,7 +39,7 @@ export default class TurnDiscovery {
   constructor(roapRequest: RoapRequest) {
     this.roapRequest = roapRequest;
     this.turnInfo = {
-      url: '',
+      urls: [],
       username: '',
       password: '',
     };
@@ -134,21 +112,27 @@ export default class TurnDiscovery {
     }
 
     const expectedHeaders = [
-      {headerName: 'x-cisco-turn-url', field: 'url'},
-      {headerName: 'x-cisco-turn-username', field: 'username'},
-      {headerName: 'x-cisco-turn-password', field: 'password'},
+      {headerName: 'x-cisco-turn-url', field: 'urls', multipleAllowed: true},
+      {headerName: 'x-cisco-turn-username', field: 'username', multipleAllowed: false},
+      {headerName: 'x-cisco-turn-password', field: 'password', multipleAllowed: false},
     ];
 
-    let foundHeaders = 0;
+    const foundHeaders = {};
 
     headers?.forEach((receivedHeader) => {
       // check if it matches any of our expected headers
       expectedHeaders.forEach((expectedHeader) => {
         if (receivedHeader.startsWith(`${expectedHeader.headerName}=`)) {
-          this.turnInfo[expectedHeader.field] = receivedHeader.substring(
-            expectedHeader.headerName.length + 1
-          );
-          foundHeaders += 1;
+          foundHeaders[expectedHeader.headerName] = true;
+
+          const headerValue = receivedHeader.substring(expectedHeader.headerName.length + 1);
+
+          if (expectedHeader.multipleAllowed) {
+            this.turnInfo[expectedHeader.field].push(headerValue);
+          } else {
+            // just store the last one we find
+            this.turnInfo[expectedHeader.field] = headerValue;
+          }
         }
       });
     });
@@ -156,7 +140,7 @@ export default class TurnDiscovery {
     clearTimeout(this.responseTimer);
     this.responseTimer = undefined;
 
-    if (foundHeaders !== expectedHeaders.length) {
+    if (expectedHeaders.some((header) => !foundHeaders[header.headerName])) {
       LoggerProxy.logger.warn(
         `Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received ${from}: ${JSON.stringify(
           headers
@@ -169,9 +153,11 @@ export default class TurnDiscovery {
       );
     } else {
       LoggerProxy.logger.info(
-        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response ${from}, url=${this.turnInfo.url}`
+        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response ${from}, urls=${this.turnInfo.urls}`
       );
 
+      this.turnInfo.urls = this.turnInfo.urls.filter((url) => url !== ''); // remove empty urls, we might get them if we land on video-mesh nodes (VMN)
+
       this.defer.resolve({isOkRequired: !headers?.includes('noOkInTransaction')});
     }
   }

package/src/roap/types.ts

@@ -0,0 +1,23 @@
+import {Enum} from '../constants';
+
+export const TurnDiscoverySkipReason = {
+  missingHttpResponse: 'missing http response', // when we asked for the TURN discovery response to be in the http response, but it wasn't there
+  reachability: 'reachability', // when udp reachability to public clusters is ok, so we don't need TURN (this doens't apply when joinWithMedia() is used)
+  alreadyInProgress: 'already in progress', // when we try to start TURN discovery while it's already in progress
+} as const;
+
+export type TurnDiscoverySkipReason =
+  | Enum<typeof TurnDiscoverySkipReason> // this is a kind of FYI, because in practice typescript will infer the type of TurnDiscoverySkipReason as a string
+  | string // used in case of errors, contains the error message
+  | undefined; // used when TURN discovery is not skipped
+
+export type TurnServerInfo = {
+  urls: string[];
+  username: string;
+  password: string;
+};
+
+export type TurnDiscoveryResult = {
+  turnServerInfo?: TurnServerInfo;
+  turnDiscoverySkippedReason: TurnDiscoverySkipReason;
+};

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

@@ -79,7 +79,7 @@ describe('createMediaConnection', () => {
       enableRtx: ENABLE_RTX,
       enableExtmap: ENABLE_EXTMAP,
       turnServerInfo: {
-        url: 'turns:turn-server-url:443?transport=tcp',
+        urls: ['turns:turn-server-url-1:443?transport=tcp', 'turns:turn-server-url-2:443?transport=tcp'],
         username: 'turn username',
         password: 'turn password',
       },
@@ -91,12 +91,7 @@ describe('createMediaConnection', () => {
       {
         iceServers: [
           {
-            urls: 'turn:turn-server-url:5004?transport=tcp',
-            username: 'turn username',
-            credential: 'turn password',
-          },
-          {
-            urls: 'turns:turn-server-url:443?transport=tcp',
+            urls: ['turns:turn-server-url-1:443?transport=tcp', 'turns:turn-server-url-2:443?transport=tcp'],
             username: 'turn username',
             credential: 'turn password',
           },
@@ -159,7 +154,7 @@ describe('createMediaConnection', () => {
       },
       rtcMetrics,
       turnServerInfo: {
-        url: 'turns:turn-server-url:443?transport=tcp',
+        urls: ['turns:turn-server-url-1:443?transport=tcp', 'turns:turn-server-url-2:443?transport=tcp'],
         username: 'turn username',
         password: 'turn password',
       },
@@ -171,12 +166,7 @@ describe('createMediaConnection', () => {
       {
         iceServers: [
           {
-            urls: 'turn:turn-server-url:5004?transport=tcp',
-            username: 'turn username',
-            credential: 'turn password',
-          },
-          {
-            urls: 'turns:turn-server-url:443?transport=tcp',
+            urls: ['turns:turn-server-url-1:443?transport=tcp', 'turns:turn-server-url-2:443?transport=tcp'],
             username: 'turn username',
             credential: 'turn password',
           },
@@ -212,7 +202,7 @@ describe('createMediaConnection', () => {
     {testCase: 'turnServerInfo is undefined', turnServerInfo: undefined},
     {
       testCase: 'turnServerInfo.url is empty string',
-      turnServerInfo: {url: '', username: 'turn username', password: 'turn password'},
+      turnServerInfo: {urls: [], username: 'turn username', password: 'turn password'},
     },
   ].forEach(({testCase, turnServerInfo}) => {
     it(`passes empty ICE servers array to MultistreamRoapMediaConnection if ${testCase} (multistream enabled)`, () => {
@@ -276,7 +266,7 @@ describe('createMediaConnection', () => {
     {testCase: 'turnServerInfo is undefined', turnServerInfo: undefined},
     {
       testCase: 'turnServerInfo.url is empty string',
-      turnServerInfo: {url: '', username: 'turn username', password: 'turn password'},
+      turnServerInfo: {urls: [], username: 'turn username', password: 'turn password'},
     },
   ].forEach(({testCase, turnServerInfo}) => {
     it(`passes empty ICE servers array to RoapMediaConnection if ${testCase} (multistream disabled)`, () => {

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

@@ -2664,7 +2664,7 @@ describe('plugin-meetings', () => {
 
           meeting.roap.doTurnDiscovery = sinon.stub().resolves({
             turnServerInfo: {
-              url: FAKE_TURN_URL,
+              urls: [FAKE_TURN_URL],
               username: FAKE_TURN_USER,
               password: FAKE_TURN_PASSWORD,
             },
@@ -2686,7 +2686,7 @@ describe('plugin-meetings', () => {
             meeting.id,
             sinon.match({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -2744,7 +2744,7 @@ describe('plugin-meetings', () => {
             .onSecondCall()
             .returns({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -2956,7 +2956,7 @@ describe('plugin-meetings', () => {
             .onSecondCall()
             .returns({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -3133,7 +3133,7 @@ describe('plugin-meetings', () => {
             .onSecondCall()
             .returns({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -3185,7 +3185,7 @@ describe('plugin-meetings', () => {
             .onSecondCall()
             .returns({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -3637,7 +3637,7 @@ describe('plugin-meetings', () => {
 
             meeting.roap.doTurnDiscovery = sinon.stub().resolves({
               turnServerInfo: {
-                url: FAKE_TURN_URL,
+                urls: [FAKE_TURN_URL],
                 username: FAKE_TURN_USER,
                 password: FAKE_TURN_PASSWORD,
               },
@@ -3663,7 +3663,7 @@ describe('plugin-meetings', () => {
               meeting.id,
               sinon.match({
                 turnServerInfo: {
-                  url: FAKE_TURN_URL,
+                  urls: [FAKE_TURN_URL],
                   username: FAKE_TURN_USER,
                   password: FAKE_TURN_PASSWORD,
                 },
@@ -3887,6 +3887,22 @@ describe('plugin-meetings', () => {
               assert.isRejected((Promise.reject()));
             }
           });
+
+          it('updates remote mute state when brb is enabled', async () => {
+            meeting.audio = { handleServerRemoteMuteUpdate: sinon.stub() };
+
+            await meeting.beRightBack(true);
+
+            sinon.assert.calledOnceWithExactly(meeting.audio.handleServerRemoteMuteUpdate, meeting, true);
+          });
+
+          it('does not update remote mute state when brb is disabled', async () => {
+            meeting.audio = { handleServerRemoteMuteUpdate: sinon.stub() };
+
+            await meeting.beRightBack(false);
+
+            assert.notCalled(meeting.audio.handleServerRemoteMuteUpdate);
+          });
         });
       });
 
@@ -3940,7 +3956,7 @@ describe('plugin-meetings', () => {
               .resolves({id: 'fake clientMediaPreferences'});
             meeting.roap.doTurnDiscovery = sinon.stub().resolves({
               turnServerInfo: {
-                url: 'turns:turn-server-url:443?transport=tcp',
+                urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
                 username: 'turn user',
                 password: 'turn password',
               },
@@ -3958,12 +3974,7 @@ describe('plugin-meetings', () => {
             expectedMediaConnectionConfig = {
               iceServers: [
                 {
-                  urls: 'turn:turn-server-url:5004?transport=tcp',
-                  username: 'turn user',
-                  credential: 'turn password',
-                },
-                {
-                  urls: 'turns:turn-server-url:443?transport=tcp',
+                  urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
                   username: 'turn user',
                   credential: 'turn password',
                 },
@@ -5231,7 +5242,7 @@ describe('plugin-meetings', () => {
                 // and check that when we fallback to transcoded we still do another TURN discovery
                 await runCheck(
                   {
-                    url: 'turns:turn-server-url:443?transport=tcp',
+                    urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
                     username: 'turn user',
                     password: 'turn password',
                   },
@@ -5245,7 +5256,7 @@ describe('plugin-meetings', () => {
                 // but doing it just for completeness
                 await runCheck(
                   {
-                    url: 'turns:turn-server-url:443?transport=tcp',
+                    urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
                     username: 'turn user',
                     password: 'turn password',
                   },
@@ -7527,19 +7538,19 @@ describe('plugin-meetings', () => {
         });
       });
 
-      describe('#setIsoLocalClientMeetingJoinTime', () => {      
+      describe('#setIsoLocalClientMeetingJoinTime', () => {
         it('should fallback to system clock ISO string when given an undefined value', () => {
           const currentSystemTime = new Date().toISOString();
           meeting.isoLocalClientMeetingJoinTime = undefined;
           assert.equal(meeting.isoLocalClientMeetingJoinTime, currentSystemTime);
         });
-      
+
         it('should fallback to system clock ISO string when given an invalid value', () => {
           const currentSystemTime = new Date().toISOString();
           meeting.isoLocalClientMeetingJoinTime = 'invalid-date';
           assert.equal(meeting.isoLocalClientMeetingJoinTime, currentSystemTime);
         });
-      
+
         it('should set the isoLocalClientMeetingJoinTime correctly for a valid date string', () => {
           const validDateString = 'Tue, 01 Apr 2025 13:00:36 GMT';
           const expectedISOString = new Date(validDateString).toISOString();
@@ -8699,7 +8710,7 @@ describe('plugin-meetings', () => {
             meeting.deferSDPAnswer = {
               reject: sinon.stub(),
             };
-            
+
             const clearTimeoutSpy = sinon.spy(clock, 'clearTimeout');
 
             const fakeError = new Errors.SdpAnswerHandlingError(fakeErrorMessage, {

package/test/unit/spec/meeting/muteState.js

@@ -2,7 +2,6 @@ import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 import {createMuteState, MuteState} from '@webex/plugin-meetings/src/meeting/muteState';
-import PermissionError from '@webex/plugin-meetings/src/common/errors/permission';
 import {AUDIO, VIDEO} from '@webex/plugin-meetings/src/constants';
 
 import testUtils from '../../../utils/testUtils';
@@ -39,7 +38,6 @@ describe('plugin-meetings', () => {
       unmuteAllowed: true,
       remoteVideoMuted: false,
       unmuteVideoAllowed: true,
-
       locusInfo: {
         handleLocusDelta: sinon.stub(),
       },

package/test/unit/spec/reconnection-manager/index.js

@@ -60,7 +60,7 @@ describe('plugin-meetings', () => {
         roap: {
           doTurnDiscovery: sinon.stub().resolves({
             turnServerInfo: {
-              url: 'fake_turn_url',
+              urls: ['fake_turn_url1', 'fake_turn_url2'],
               username: 'fake_turn_username',
               password: 'fake_turn_password',
             },
@@ -137,7 +137,7 @@ describe('plugin-meetings', () => {
       assert.calledOnce(fakeMediaConnection.reconnect);
       assert.calledWith(fakeMediaConnection.reconnect, [
         {
-          urls: 'fake_turn_url',
+          urls: ['fake_turn_url1', 'fake_turn_url2'],
           username: 'fake_turn_username',
           credential: 'fake_turn_password',
         },
@@ -152,12 +152,12 @@ describe('plugin-meetings', () => {
     });
 
     // this can happen when we land on a video mesh node
-    it('does not use TURN server if TURN url is an empty string', async () => {
+    it('does not use TURN server if TURN urls is an empty array', async () => {
       const rm = new ReconnectionManager(fakeMeeting);
 
       fakeMeeting.roap.doTurnDiscovery.resolves({
         turnServerInfo: {
-          url: '',
+          urls: [],
           username: 'whatever',
           password: 'whatever',
         },