@webex/plugin-meetings 3.7.0-wxcc.1 → 3.8.0

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

@@ -114,6 +114,7 @@ import {ERROR_DESCRIPTIONS} from '@webex/internal-plugin-metrics/src/call-diagno
 import MeetingCollection from '@webex/plugin-meetings/src/meetings/collection';
 
 import {EVENT_TRIGGERS as VOICEAEVENTS} from '@webex/internal-plugin-voicea';
+import { createBrbState } from '@webex/plugin-meetings/src/meeting/brbState';
 import JoinForbiddenError               from '../../../../src/common/errors/join-forbidden-error';
 
 describe('plugin-meetings', () => {
@@ -246,6 +247,7 @@ describe('plugin-meetings', () => {
       isAnyPublicClusterReachable: sinon.stub().resolves(true),
       getReachabilityResults: sinon.stub().resolves(undefined),
       getReachabilityMetrics: sinon.stub().resolves({}),
+      stopReachability: sinon.stub(),
     };
     webex.internal.llm.on = sinon.stub();
     webex.internal.newMetrics.callDiagnosticLatencies = new CallDiagnosticLatencies(
@@ -2095,6 +2097,7 @@ describe('plugin-meetings', () => {
               someReachabilityMetric1: 'some value1',
               someReachabilityMetric2: 'some value2',
             }),
+            stopReachability: sinon.stub(),
           };
 
           const forceRtcMetricsSend = sinon.stub().resolves();
@@ -2514,6 +2517,7 @@ describe('plugin-meetings', () => {
           assert.calledOnce(meeting.setMercuryListener);
           assert.calledOnce(fakeMediaConnection.initiateOffer);
           assert.equal(meeting.allowMediaInLobby, allowMediaInLobby);
+          assert.calledOnce(webex.meetings.reachability.stopReachability);
         };
 
         it('should attach the media and return promise', async () => {
@@ -2709,6 +2713,7 @@ describe('plugin-meetings', () => {
           webex.meetings.reachability = {
             isWebexMediaBackendUnreachable: sinon.stub().resolves(false),
             getReachabilityMetrics: sinon.stub().resolves(),
+            stopReachability: sinon.stub(),
           };
           const MOCK_CLIENT_ERROR_CODE = 2004;
           const generateClientErrorCodeForIceFailureStub = sinon
@@ -2917,6 +2922,7 @@ describe('plugin-meetings', () => {
               .onCall(2)
               .resolves(false),
             getReachabilityMetrics: sinon.stub().resolves({}),
+            stopReachability: sinon.stub(),
           };
           const getErrorPayloadForClientErrorCodeStub =
             (webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode =
@@ -3211,6 +3217,7 @@ describe('plugin-meetings', () => {
               someReachabilityMetric1: 'some value1',
               someReachabilityMetric2: 'some value2',
             }),
+            stopReachability: sinon.stub(),
           };
           meeting.iceCandidatesCount = 3;
           meeting.iceCandidateErrors.set('701_error', 3);
@@ -3715,6 +3722,7 @@ describe('plugin-meetings', () => {
 
               webex.meetings.reachability = {
                 isWebexMediaBackendUnreachable: sinon.stub().resolves(unreachable || false),
+                stopReachability: sinon.stub(),
               };
 
               const generateClientErrorCodeForIceFailureStub = sinon
@@ -3812,7 +3820,6 @@ describe('plugin-meetings', () => {
         };
 
         beforeEach(() => {
-          meeting.meetingRequest.setBrb = sinon.stub().resolves({body: 'test'});
           meeting.mediaProperties.webrtcMediaConnection = {createSendSlot: sinon.stub()};
           meeting.sendSlotManager.createSlot(
             fakeMultistreamRoapMediaConnection,
@@ -3822,6 +3829,8 @@ describe('plugin-meetings', () => {
           meeting.locusUrl = 'locus url';
           meeting.deviceUrl = 'device url';
           meeting.selfId = 'self id';
+          meeting.brbState = createBrbState(meeting, false);
+          meeting.brbState.enable = sinon.stub().resolves();
         });
 
         afterEach(() => {
@@ -3843,7 +3852,7 @@ describe('plugin-meetings', () => {
 
             await brbResult;
             assert.exists(brbResult.then);
-            assert.calledOnce(meeting.meetingRequest.setBrb);
+            assert.calledOnce(meeting.brbState.enable);
           })
 
           it('should disable #beRightBack and return a promise', async () => {
@@ -3851,12 +3860,12 @@ describe('plugin-meetings', () => {
 
             await brbResult;
             assert.exists(brbResult.then);
-            assert.calledOnce(meeting.meetingRequest.setBrb);
+            assert.calledOnce(meeting.brbState.enable);
           })
 
           it('should throw an error and reject the promise if setBrb fails', async () => {
             const error = new Error('setBrb failed');
-            meeting.meetingRequest.setBrb.rejects(error);
+            meeting.brbState.enable.rejects(error);
 
             try {
               await meeting.beRightBack(true);
@@ -3867,27 +3876,6 @@ describe('plugin-meetings', () => {
             }
           })
         });
-
-        describe('when in a transcoded meeting', () => {
-
-          beforeEach(() => {
-            meeting.isMultistream = false;
-          });
-
-          it('should ignore enabling #beRightBack', async () => {
-            meeting.beRightBack(true);
-
-            assert.isRejected((Promise.reject()));
-            assert.notCalled(meeting.meetingRequest.setBrb);
-          })
-
-          it('should ignore disabling #beRightBack', async () => {
-            meeting.beRightBack(false);
-
-            assert.isRejected((Promise.reject()));
-            assert.notCalled(meeting.meetingRequest.setBrb);
-          })
-        });
       });
 
       /* This set of tests are like semi-integration tests, they use real MuteState, Media, LocusMediaRequest and Roap classes.
@@ -6804,7 +6792,7 @@ describe('plugin-meetings', () => {
           assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
           assert.equal(
             meeting.meetingInfoFailureReason,
-            MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATIONID
+            MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATION_ID
           );
         });
       });
@@ -6864,7 +6852,8 @@ describe('plugin-meetings', () => {
             'fake-installed-org-id',
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -6909,7 +6898,8 @@ describe('plugin-meetings', () => {
             'fake-installed-org-id',
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -6963,7 +6953,8 @@ describe('plugin-meetings', () => {
               extraParam1: 'value1',
               permissionToken: FAKE_PERMISSION_TOKEN,
             },
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -9230,6 +9221,7 @@ describe('plugin-meetings', () => {
 
         it('listens to the brb state changed event', () => {
           const assertBrb = (enabled) => {
+            meeting.brbState = createBrbState(meeting, false);
             meeting.locusInfo.emit(
               { function: 'test', file: 'test' },
               LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
@@ -13260,7 +13252,7 @@ describe('plugin-meetings', () => {
 
   describe('#roapMessageReceived', () => {
     it('calls roapMessageReceived on the webrtc media connection', () => {
-      const fakeMessage = {messageType: 'fake', sdp: 'fake sdp'};
+      const fakeMessage = {messageType: 'ANSWER', sdp: 'fake sdp'};
 
       const getMediaServer = sinon.stub(MeetingsUtil, 'getMediaServer').returns('homer');
 
@@ -13298,5 +13290,75 @@ describe('plugin-meetings', () => {
 
       assert.notCalled(meeting.mediaProperties.webrtcMediaConnection.roapMessageReceived);
     });
+
+    it('does not call getMediaServer for a roap message other than ANSWER', async () => {
+      const fakeMessage = {messageType: 'ERROR', sdp: 'fake sdp'};
+
+      meeting.isMultistream = true;
+      meeting.mediaProperties.webrtcMediaConnection = {
+        roapMessageReceived: sinon.stub(),
+      };
+      meeting.mediaProperties.webrtcMediaConnection.mediaServer = 'linus';
+
+      const getMediaServerStub = sinon.stub(MeetingsUtil, 'getMediaServer').returns('something');
+
+      meeting.roapMessageReceived(fakeMessage);
+
+      assert.calledOnceWithExactly(
+        meeting.mediaProperties.webrtcMediaConnection.roapMessageReceived,
+        fakeMessage
+      );
+      assert.notCalled(getMediaServerStub);
+      assert.equal(meeting.mediaProperties.webrtcMediaConnection.mediaServer, 'linus'); // check that it hasn't been overwritten
+    });
+  });
+
+  describe('#verifyRegistrationId', () => {
+    it('calls fetchMeetingInfo() with the passed registrationId and captcha code', async () => {
+      // simulate successful case
+      meeting.fetchMeetingInfo = sinon.stub().resolves();
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert(Metrics.sendBehavioralMetric.calledOnce);
+      assert.calledWith(
+        Metrics.sendBehavioralMetric,
+        BEHAVIORAL_METRICS.VERIFY_REGISTRATION_ID_SUCCESS
+      );
+      assert.equal(result.isRegistrationIdValid, true);
+      assert.equal(result.requiredCaptcha, null);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.NONE);
+      assert.calledWith(meeting.fetchMeetingInfo, {
+        registrationId: 'registrationId',
+        captchaCode: 'captcha id',
+        sendCAevents: false,
+      });
+    });
+    it('handles registrationIdError returned by fetchMeetingInfo', async () => {
+      meeting.fetchMeetingInfo = sinon.stub().callsFake(() => {
+        meeting.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATIONID;
+
+        return Promise.reject(new JoinWebinarError());
+      });
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert.equal(result.isRegistrationIdValid, false);
+      assert.equal(result.requiredCaptcha, null);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATION_ID);
+    });
+    it('handles CaptchaError returned by fetchMeetingInfo', async () => {
+      const FAKE_CAPTCHA = {captchaId: 'some catcha id...'};
+
+      meeting.fetchMeetingInfo = sinon.stub().callsFake(() => {
+        meeting.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA;
+        meeting.requiredCaptcha = FAKE_CAPTCHA;
+
+        return Promise.reject(new CaptchaError());
+      });
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert.equal(result.isRegistrationIdValid, false);
+      assert.deepEqual(result.requiredCaptcha, FAKE_CAPTCHA);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA);
+    });
   });
 });

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

@@ -113,30 +113,6 @@ describe('plugin-meetings', () => {
       assert.isTrue(audio.isRemotelyMuted());
     });
 
-    it('does not locally unmute on a server unmute', async () => {
-      const setServerMutedSpy = meeting.mediaProperties.audioStream.setServerMuted;
-
-      // simulate remote mute
-      audio.handleServerRemoteMuteUpdate(meeting, true, true);
-
-      assert.isTrue(audio.isRemotelyMuted());
-      assert.isTrue(audio.isLocallyMuted());
-
-      // mutes local
-      assert.calledOnceWithExactly(setServerMutedSpy, true, 'remotelyMuted');
-
-      setServerMutedSpy.resetHistory();
-
-      // simulate remote unmute
-      audio.handleServerRemoteMuteUpdate(meeting, false, true);
-
-      assert.isFalse(audio.isRemotelyMuted());
-      assert.isTrue(audio.isLocallyMuted());
-
-      // does not unmute local
-      assert.notCalled(setServerMutedSpy);
-    });
-
     it('does local audio unmute if localAudioUnmuteRequired is received', async () => {
       // first we need to have the local stream user muted
       meeting.mediaProperties.audioStream.userMuted = true;

package/test/unit/spec/meeting-info/utilv2.js

@@ -192,6 +192,15 @@ describe('plugin-meetings', () => {
         assert.equal(res.meetingUUID, 'xsddsdsdsdssdsdsdsdsd');
       });
 
+      it('for registrationId', () => {
+        const res = MeetingInfoUtil.getRequestBody({
+          type: DESTINATION_TYPE.MEETING_UUID,
+          registrationId: 'registrationId',
+        });
+
+        assert.equal(res.registrationId, 'registrationId');
+      });
+
       it('for DESTINATION_TYPE.LOCUS_ID', () => {
         const res = MeetingInfoUtil.getRequestBody({
           type: DESTINATION_TYPE.LOCUS_ID,

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

@@ -1050,6 +1050,7 @@ describe('gatherReachability', () => {
 
         // the metrics related to ipver and trigger are not tested in these tests and are all the same, so setting them up here
         const expectedMetricsFull = {
+          aborted: false,
           ...expectedMetrics,
           ipver_firstIpV4: -1,
           ipver_firstIpV6: -1,
@@ -1238,6 +1239,7 @@ describe('gatherReachability', () => {
 
     // finally, check the metrics - they should contain values from ipNetworkDetector
     assert.calledWith(Metrics.sendBehavioralMetric, 'js_sdk_reachability_completed', {
+      aborted: false,
       vmn_udp_min: -1,
       vmn_udp_max: -1,
       vmn_udp_average: -1,
@@ -1622,14 +1624,14 @@ describe('gatherReachability', () => {
     const reachability = new Reachability(webex);
 
     let getClustersCallCount = 0;
-    
+
     reachability.reachabilityRequest.getClusters = sinon.stub().callsFake(() => {
       getClustersCallCount++;
 
       if (getClustersCallCount == 1) {
         throw new Error('fake error');
       }
-      
+
       return getClustersResult;
     });
 
@@ -1637,7 +1639,7 @@ describe('gatherReachability', () => {
 
     await simulateTimeout();
     await promise;
-    
+
     assert.equal(getClustersCallCount, 2);
 
     assert.calledOnce(clusterReachabilityCtorStub);
@@ -1647,7 +1649,7 @@ describe('gatherReachability', () => {
     const reachability = new Reachability(webex);
 
     let getClustersCallCount = 0;
-    
+
     reachability.reachabilityRequest.getClusters = sinon.stub().callsFake(() => {
       getClustersCallCount++;
 
@@ -1657,9 +1659,9 @@ describe('gatherReachability', () => {
     const promise = reachability.gatherReachability('test');
 
     await simulateTimeout();
-    
+
     await promise;
-    
+
     assert.equal(getClustersCallCount, 2);
 
     assert.neverCalledWith(clusterReachabilityCtorStub);
@@ -1927,7 +1929,86 @@ describe('gatherReachability', () => {
     });
   });
 
-  
+  describe('stopReachability', () => {
+    let reachability;
+    let receivedEvents;
+    let sendMetricSpy;
+
+    beforeEach(() => {
+      reachability = new Reachability(webex);
+
+      receivedEvents = {};
+
+      sendMetricSpy = sinon.stub(reachability, 'sendMetric').resolves();
+    });
+
+    const setListener = (event) => {
+      reachability.on(event, () => {
+        receivedEvents[event] = receivedEvents[event] + 1 || 1;
+      });
+    };
+    it('works as expected', async () => {
+      setListener('reachability:stopped');
+      setListener('reachability:done');
+      setListener('reachability:firstResultAvailable');
+
+      const mockGetClustersResult = {
+        clusters: {
+          clusterA: {
+            udp: ['udp-urlA'],
+            tcp: ['tcp-urlA'],
+            xtls: ['xtls-urlA'],
+            isVideoMesh: false,
+          },
+          clusterB: {
+            udp: ['udp-urlB'],
+            tcp: ['tcp-urlB'],
+            xtls: ['xtls-urlB'],
+            isVideoMesh: false,
+          },
+        },
+        joinCookie: {id: 'id'},
+      };
+
+      reachability.reachabilityRequest.getClusters = sinon.stub().returns(mockGetClustersResult);
+
+      const gatherReachabilityFallbackSpy = sinon.spy(reachability, 'gatherReachabilityFallback');
+
+      const resultPromise = reachability.gatherReachability('test');
+
+      await testUtils.flushPromises();
+
+      reachability.stopReachability();
+
+      await resultPromise;
+
+      // simulate a lot of time passing to check that all timers were stopped and nothing else happens
+      clock.tick(99000);
+
+      assert.calledOnceWithExactly(mockClusterReachabilityInstances['clusterA'].abort);
+      assert.calledOnceWithExactly(mockClusterReachabilityInstances['clusterB'].abort);
+
+      assert.calledOnceWithExactly(sendMetricSpy, true);
+
+      assert.equal(receivedEvents['reachability:stopped'], 1);
+      assert.equal(receivedEvents['reachability:done'], undefined);
+      assert.equal(receivedEvents['reachability:firstResultAvailable'], undefined);
+
+      assert.notCalled(gatherReachabilityFallbackSpy);
+    });
+
+    it('does nothing if called without reachability being started', async () => {
+      const reachability = new Reachability(webex);
+
+      reachability.stopReachability();
+
+      assert.notCalled(sendMetricSpy);
+
+      assert.equal(receivedEvents['reachability:stopped'], undefined);
+      assert.equal(receivedEvents['reachability:done'], undefined);
+      assert.equal(receivedEvents['reachability:firstResultAvailable'], undefined);
+    });
+  });
 });
 
 describe('getReachabilityResults', () => {
@@ -2489,19 +2570,18 @@ describe('getStatistics', () => {
 describe('sendMetric', () => {
   let webex;
   let reachability;
+  let getStatisticsStub;
 
   beforeEach(() => {
     webex = new MockWebex();
     reachability = new TestReachability(webex);
 
     sinon.stub(Metrics, 'sendBehavioralMetric');
-  });
 
-  it('works as expected', async () => {
     // setup stub for getStatistics to return values that show what parameters it was called with,
     // this way we can verify that the correct results of calls to getStatistics are placed
     // in correct data fields when sendBehavioralMetric() is called
-    const getStatisticsStub = sinon
+    getStatisticsStub = sinon
       .stub(reachability, 'getStatistics')
       .callsFake((results, protocol, isVideoMesh) => {
         return {result: 'fake', protocol, isVideoMesh};
@@ -2522,7 +2602,13 @@ describe('sendMetric', () => {
         isVideoMesh: false,
       },
     });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
 
+  it('works as expected', async () => {
     await reachability.sendMetric();
 
     // each call to getStatistics should be made with all the results from all fake clusterReachability:
@@ -2546,6 +2632,30 @@ describe('sendMetric', () => {
     assert.alwaysCalledWith(getStatisticsStub, expectedResults, sinon.match.any, sinon.match.any);
 
     assert.calledWith(Metrics.sendBehavioralMetric, 'js_sdk_reachability_completed', {
+      aborted: false,
+      vmn_udp_result: 'fake',
+      vmn_udp_protocol: 'udp',
+      vmn_udp_isVideoMesh: true,
+
+      public_udp_result: 'fake',
+      public_udp_protocol: 'udp',
+      public_udp_isVideoMesh: false,
+
+      public_tcp_result: 'fake',
+      public_tcp_protocol: 'tcp',
+      public_tcp_isVideoMesh: false,
+
+      public_xtls_result: 'fake',
+      public_xtls_protocol: 'xtls',
+      public_xtls_isVideoMesh: false,
+    });
+  });
+
+  it('sends metric with "aborted:true" if called with aborted=true arg', async () => {
+    await reachability.sendMetric(true);
+
+    assert.calledWith(Metrics.sendBehavioralMetric, 'js_sdk_reachability_completed', {
+      aborted: true,
       vmn_udp_result: 'fake',
       vmn_udp_protocol: 'udp',
       vmn_udp_isVideoMesh: true,