@webex/plugin-meetings 3.1.0 → 3.3.0

package/test/unit/spec/meeting/locusMediaRequest.ts

@@ -106,6 +106,12 @@ describe('LocusMediaRequest.send()', () => {
       },
     });
 
+    mockWebex.internal = {
+      newMetrics: {
+        submitClientEvent: sinon.stub()
+      },
+    };
+
     locusMediaRequest = new LocusMediaRequest({
       device: {
         url: 'deviceUrl',
@@ -113,6 +119,7 @@ describe('LocusMediaRequest.send()', () => {
         regionCode: 'regionCode',
       },
       correlationId: 'correlationId',
+      meetingId: 'meetingId',
       preferTranscoding: true,
     }, {
       parent: mockWebex,
@@ -134,6 +141,27 @@ describe('LocusMediaRequest.send()', () => {
     await sendRoapMessage('OFFER');
 
     webexRequestStub.resetHistory();
+    mockWebex.internal.newMetrics.submitClientEvent.resetHistory();
+  }
+
+  const checkMetrics = (expectedMetrics: boolean = true) => {
+    if (expectedMetrics) {
+      assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.request',
+        options: {
+          meetingId: 'meetingId',
+        },
+      });
+
+      assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.response',
+        options: {
+          meetingId: 'meetingId',
+        },
+      });
+    } else {
+      assert.notCalled(mockWebex.internal.newMetrics.submitClientEvent);
+    }
   }
 
   it('sends a roap message', async () => {
@@ -146,6 +174,21 @@ describe('LocusMediaRequest.send()', () => {
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: true}),
     });
+
+    checkMetrics();
+  });
+
+  it('sends correct metric event when roap message fails', async () => {
+    webexRequestStub.rejects({code: 300, message: 'fake error'});
+    await assert.isRejected(sendRoapMessage('OFFER'));
+
+    assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
+      name: 'client.locus.media.response',
+      options: {
+        meetingId: 'meetingId',
+        rawError: {code: 300, message: 'fake error'},
+      },
+    });
   });
 
   it('sends a local mute request', async () => {
@@ -160,6 +203,8 @@ describe('LocusMediaRequest.send()', () => {
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: false}),
     });
+
+    checkMetrics(false);
   });
 
   it('sends a local mute request with sequence', async () => {
@@ -207,6 +252,7 @@ describe('LocusMediaRequest.send()', () => {
       body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: true}),
     });
 
+    checkMetrics(false);
   });
 
   it('sends a local mute request with the last audio/video mute values', async () => {
@@ -225,6 +271,7 @@ describe('LocusMediaRequest.send()', () => {
       body: createExpectedLocalMuteBody({audioMuted: true, videoMuted: false}),
     });
 
+    checkMetrics(false);
   });
 
   it('sends only roap when roap and local mute are requested', async () => {
@@ -242,6 +289,8 @@ describe('LocusMediaRequest.send()', () => {
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: false}),
     });
+
+    checkMetrics();
   });
 
   describe('queueing', () => {

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

@@ -370,16 +370,6 @@ describe('plugin-meetings', () => {
           sequence: {},
           type: 'LocalMute',
         });
-
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.locus.media.request',
-          options: {meetingId: meeting.id},
-        });
-
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.locus.media.response',
-          options: {meetingId: meeting.id},
-        });
       });
     });
 
@@ -765,6 +755,9 @@ describe('plugin-meetings', () => {
       {functionName: 'canStartTranscribing', displayHint: 'TRANSCRIPTION_CONTROL_START'},
       {functionName: 'canStopTranscribing', displayHint: 'TRANSCRIPTION_CONTROL_STOP'},
       {functionName: 'isClosedCaptionActive', displayHint: 'CAPTION_STATUS_ACTIVE'},
+      {functionName: 'canStartManualCaption', displayHint: 'MANUAL_CAPTION_START'},
+      {functionName: 'canStopManualCaption', displayHint: 'MANUAL_CAPTION_STOP'},
+      {functionName: 'isManualCaptionActive', displayHint: 'MANUAL_CAPTION_STATUS_ACTIVE'},
       {functionName: 'isWebexAssistantActive', displayHint: 'WEBEX_ASSISTANT_STATUS_ACTIVE'},
       {functionName: 'canViewCaptionPanel', displayHint: 'ENABLE_CAPTION_PANEL'},
       {functionName: 'isRealTimeTranslationEnabled', displayHint: 'DISPLAY_REAL_TIME_TRANSLATION'},

package/test/unit/spec/meeting/voicea-meeting.ts

@@ -101,14 +101,7 @@ describe('plugin-meetings', () => {
                     ],
                     transcript_language_code: "en"
                 }
-            ],
-            transcript: {
-                text: "Don't bother me talking I'm just going to get the transcript data that is interim and I needed if I keep talking, I get the interim data",
-                csis: [
-                    1234867712
-                ],
-                transcript_language_code: "en"
-            }
+            ]
         };
     });
 
@@ -160,7 +153,6 @@ describe('plugin-meetings', () => {
             it('should process new final captions correctly', () => {
                 let transcriptData = fakeMeeting.transcription;
                 let transcriptId = fakeVoiceaPayload.transcriptId;
-                delete fakeVoiceaPayload.transcripts;
 
                 // Assuming that processNewCaptions is a pure function that doesn't mutate the input but returns a new state
                 processNewCaptions({
@@ -169,7 +161,7 @@ describe('plugin-meetings', () => {
                 });
 
                 // Check if speaker details are cached if needed
-                const csisKey = fakeVoiceaPayload.transcript.csis[0];
+                const csisKey = fakeVoiceaPayload.transcripts[0].csis[0];
                 const speaker = transcriptData.speakerProxy[csisKey];
                 expect(speaker).to.exist;
 
@@ -178,6 +170,7 @@ describe('plugin-meetings', () => {
 
                 //check if the interim caption is removed
                 const oldInterimCaption = transcriptData.captions.find(caption => caption.id === `${transcriptId}_${speaker.speakerId}`);
+                console.log(oldInterimCaption);
                 expect(oldInterimCaption).to.not.exist;
 
                 // Check the final caption data
@@ -186,8 +179,8 @@ describe('plugin-meetings', () => {
                 expect(newCaption).to.include({
                   id: transcriptId,
                   isFinal: fakeVoiceaPayload.isFinal,
-                  text: fakeVoiceaPayload.transcript.text,
-                  currentSpokenLanguage: fakeVoiceaPayload.transcript.transcript_language_code,
+                  text: fakeVoiceaPayload.transcripts[0].text,
+                  currentSpokenLanguage: fakeVoiceaPayload.transcripts[0].transcript_language_code,
                 });
 
                 // Check the speaker data in the new caption
@@ -197,7 +190,6 @@ describe('plugin-meetings', () => {
             it('should process new interim captions correctly', () => {
                 let transcriptData = fakeMeeting.transcription;
                 let transcriptId = fakeVoiceaPayload.transcriptId;
-                delete fakeVoiceaPayload.transcript;
 
                 transcriptData.captions.splice(transcriptData.length - 1, 1);
                 fakeVoiceaPayload.isFinal = false;
@@ -232,7 +224,6 @@ describe('plugin-meetings', () => {
             it('should process interim captions with an existing one correctly', () => {
                 let transcriptData = fakeMeeting.transcription;
                 let transcriptId = fakeVoiceaPayload.transcriptId;
-                delete fakeVoiceaPayload.transcript;
                 fakeVoiceaPayload.isFinal = false;
 
                 processNewCaptions({

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

@@ -513,13 +513,8 @@ describe('plugin-meetings', () => {
             });
             describe('#getAllMeetings', () => {
               it('calls MeetingCollection to get all meetings with supplied options', () => {
-                webex.meetings.getAllMeetings({
-                  test: test1,
-                });
+                webex.meetings.getAllMeetings();
                 assert.calledOnce(webex.meetings.meetingCollection.getAll);
-                assert.calledWith(webex.meetings.meetingCollection.getAll, {
-                  test: test1,
-                });
               });
             });
           });
@@ -1011,6 +1006,7 @@ describe('plugin-meetings', () => {
                   callBackInfo: {
                     callbackAddress: uri1,
                   },
+                  devices: [],
                 },
                 info: {
                   webExMeetingId,
@@ -1038,6 +1034,7 @@ describe('plugin-meetings', () => {
                 callBackInfo: {
                   callbackAddress: uri1,
                 },
+                devices: [],
               },
               info: {
                 webExMeetingId,
@@ -1052,6 +1049,7 @@ describe('plugin-meetings', () => {
                   callBackInfo: {
                     callbackAddress: uri1,
                   },
+                  devices: [],
                 },
                 info: {
                   webExMeetingId,
@@ -1074,6 +1072,7 @@ describe('plugin-meetings', () => {
                 callBackInfo: {
                   callbackAddress: uri1,
                 },
+                devices: [],
               },
               info: {
                 webExMeetingId,
@@ -1091,6 +1090,7 @@ describe('plugin-meetings', () => {
                   callBackInfo: {
                     callbackAddress: uri1,
                   },
+                  devices: [],
                 },
                 info: {
                   webExMeetingId,
@@ -1121,6 +1121,7 @@ describe('plugin-meetings', () => {
                   callBackInfo: {
                     callbackAddress: uri1,
                   },
+                  devices: [],
                 },
                 info: {
                   webExMeetingId,
@@ -1143,6 +1144,7 @@ describe('plugin-meetings', () => {
                 callBackInfo: {
                   callbackAddress: uri1,
                 },
+                devices: [],
               },
               info: {
                 webExMeetingId,
@@ -1157,6 +1159,7 @@ describe('plugin-meetings', () => {
                 callbackInfo: {
                   callbackAddress: uri1,
                 },
+                devices: [],
               },
               info: {
                 isUnifiedSpaceMeeting,
@@ -2299,6 +2302,7 @@ describe('plugin-meetings', () => {
           sessionType: 'BREAKOUT',
         };
         newLocus.self.state = 'JOINED';
+        newLocus.self.devices = [];
         newLocus.fullState = {
           active: true,
         };
@@ -2315,7 +2319,7 @@ describe('plugin-meetings', () => {
           sessionType: 'MAIN',
         };
         newLocus.self.state = 'JOINED';
-
+        newLocus.self.devices = [];
         LoggerProxy.logger.log = sinon.stub();
         const result = webex.meetings.isNeedHandleLocusDTO(meeting, newLocus);
         assert.equal(result, true);
@@ -2330,11 +2334,26 @@ describe('plugin-meetings', () => {
         };
         newLocus.self.state = 'LEFT';
         newLocus.self.reason = 'MOVED';
-
+        newLocus.self.devices = [];
         LoggerProxy.logger.log = sinon.stub();
         const result = webex.meetings.isNeedHandleLocusDTO(meeting, newLocus);
         assert.equal(result, false);
       });
+      it('moved to lobby, return true', () => {
+        newLocus.controls.breakout = {
+          sessionType: 'MAIN',
+        };
+        newLocus.self.state = 'JOINED';
+        newLocus.self.devices = [{
+          intent: {
+            reason: 'ON_HOLD_LOBBY',
+            type: 'WAIT',
+          }
+        }];
+        LoggerProxy.logger.log = sinon.stub();
+        const result = webex.meetings.isNeedHandleLocusDTO(meeting, newLocus);
+        assert.equal(result, true);
+      });
     });
 
     describe('#getCorrespondingMeetingByLocus', () => {

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

@@ -2,11 +2,14 @@ import 'jsdom-global/register';
 import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import sinon from 'sinon';
+import {Defer} from '@webex/common';
 import ReconnectionManager from '@webex/plugin-meetings/src/reconnection-manager';
+import ReconnectionNotStartedError from '@webex/plugin-meetings/src/common/errors/reconnection-not-started';
+import TriggerProxy from '@webex/plugin-meetings/src/common/events/trigger-proxy';
+import Metrics from '@webex/plugin-meetings/src/metrics';
 import { RECONNECTION } from '../../../../src/constants';
 import LoggerProxy from '../../../../src/common/logs/logger-proxy';
 import LoggerConfig from '../../../../src/common/logs/logger-config';
-
 const {assert} = chai;
 
 chai.use(chaiAsPromised);
@@ -14,18 +17,15 @@ sinon.assert.expose(chai.assert, {prefix: ''});
 
 describe('plugin-meetings', () => {
   describe('ReconnectionManager.reconnect', () => {
-    const sandbox = sinon.createSandbox();
     let fakeMediaConnection;
     let fakeMeeting;
     let loggerSpy;
 
-    before(() => {
+    beforeEach(() => {
       LoggerConfig.set({ enable: false });
       LoggerProxy.set();
-      loggerSpy = sandbox.spy(LoggerProxy.logger, 'info');
-    });
+      loggerSpy = sinon.spy(LoggerProxy.logger, 'info');
 
-    beforeEach(() => {
       fakeMediaConnection = {
         initiateOffer: sinon.stub().resolves({}),
         reconnect: sinon.stub().resolves({}),
@@ -33,6 +33,7 @@ describe('plugin-meetings', () => {
       fakeMeeting = {
         closePeerConnections: sinon.stub().resolves({}),
         createMediaConnection: sinon.stub().returns(fakeMediaConnection),
+        correlationId: 'correlationId',
         config: {
           reconnection: {
             enabled: true,
@@ -47,6 +48,7 @@ describe('plugin-meetings', () => {
             },
           },
         },
+        locusUrl: 'test/id',
         mediaProperties: {
           unsetPeerConnection: sinon.stub(),
           webrtcMediaConnection: fakeMediaConnection,
@@ -83,11 +85,16 @@ describe('plugin-meetings', () => {
             }
           }
         },
+        trigger: sinon.stub(),
       };
+
+      sinon.stub(TriggerProxy, 'trigger').returns(true);
+      sinon.stub(Metrics, 'sendBehavioralMetric');
     });
 
     afterEach(() => {
-      sandbox.reset();
+      sinon.reset();
+      sinon.restore();
     });
 
     it('calls syncMeetings', async () => {
@@ -223,6 +230,99 @@ describe('plugin-meetings', () => {
         });
       }
     });
+
+    it('sends the right metrics and events when succeeds', async () => {
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      await rm.reconnect();
+
+      assert.calledWith(
+        TriggerProxy.trigger,
+        fakeMeeting,
+        {file: 'reconnection-manager/index', function: 'reconnect'},
+        'meeting:reconnectionSuccess'
+      );
+      assert.calledWithMatch(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.media.recovered',
+        payload: {
+          recoveredBy: 'new',
+        },
+        options: {
+          meetingId: fakeMeeting.id,
+        },
+      });
+      assert.equal(rm.status, RECONNECTION.STATE.DEFAULT_STATUS);
+    });
+
+    it('sends the right metrics and events when fails', async () => {
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      sinon.stub(rm, 'executeReconnection').rejects(new Error('fake error'));
+
+      await assert.isRejected(rm.reconnect());
+
+      assert.calledWith(
+        TriggerProxy.trigger,
+        fakeMeeting,
+        {file: 'reconnection-manager/index', function: 'reconnect'},
+        'meeting:reconnectionFailure'
+      );
+      assert.calledWithMatch(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.call.aborted',
+        payload: {
+          errors: [
+            {
+              category: 'expected',
+              errorCode: 2008,
+              fatal: true,
+              name: 'media-engine',
+              shownToUser: false,
+            },
+          ],
+        },
+        options: {
+          meetingId: fakeMeeting.id,
+        },
+      });
+      assert.calledWith(Metrics.sendBehavioralMetric, 'js_sdk_meeting_reconnect_failures', {
+        correlation_id: fakeMeeting.correlationId,
+        locus_id: 'id',
+        reason: 'fake error',
+        stack: sinon.match.any,
+      });
+      assert.equal(rm.status, RECONNECTION.STATE.DEFAULT_STATUS);
+    });
+
+    it('throws ReconnectionNotStartedError if reconnection is already in progress', async () => {
+      const rm = new ReconnectionManager(fakeMeeting);
+      const defer = new Defer();
+
+      sinon.stub(rm, 'executeReconnection').returns(defer.promise);
+
+      rm.reconnect();
+
+      try {
+        await rm.reconnect();
+
+        fail("rm.reconnect() should have thrown, but it hasn't");
+      } catch (e) {
+        assert.instanceOf(e, ReconnectionNotStartedError);
+      }
+    });
+
+    it('throws ReconnectionNotStartedError if reconnection is disabled in config', async () => {
+      fakeMeeting.config.reconnection.enabled = false;
+
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      try {
+        await rm.reconnect();
+
+        fail("rm.reconnect() should have thrown, but it hasn't");
+      } catch (e) {
+        assert.instanceOf(e, ReconnectionNotStartedError);
+      }
+    });
   });
 
   /**
@@ -316,29 +416,41 @@ describe('plugin-meetings', () => {
 
     describe('waitForIceReconnect()', () => {
       describe('when ice is marked as not disconnected', () => {
+        let clock;
+
         beforeEach(() => {
+          clock = sinon.useFakeTimers();
           reconnectionManager.iceState.disconnected = false;
         });
 
+        afterEach(() => {
+          clock.restore();
+        });
+
         it('should set the disconnected state to true', () => {
-          reconnectionManager.waitForIceReconnect();
+          const promise = reconnectionManager.waitForIceReconnect();
 
           assert.isTrue(reconnectionManager.iceState.disconnected);
+
+          // we let the timer expire
+          clock.tick(reconnectionManager.iceState.timeoutDuration);
+          assert.isRejected(promise);
         });
 
-        it('should return a promise that rejects after a duration', (done) => {
-          reconnectionManager.iceState.timeoutDuration = 100;
+        it('should return a promise that rejects after a duration', async () => {
+          const promise = reconnectionManager.waitForIceReconnect();
 
-          assert.isRejected(reconnectionManager.waitForIceReconnect());
-          done();
+          // we let the timer expire
+          clock.tick(reconnectionManager.iceState.timeoutDuration);
+          assert.isRejected(promise);
         });
 
-        it('should resolve return a resolved promise when triggered', () => {
+        it('should resolve when ICE is reconnected', async () => {
           const promise = reconnectionManager.waitForIceReconnect();
 
-          reconnectionManager.iceState.resolve();
+          reconnectionManager.iceReconnected();
 
-          assert.isFulfilled(promise);
+          await promise;
         });
       });
 
@@ -359,30 +471,6 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('setStatus()', () => {
-      beforeEach(() => {
-        reconnectionManager.status = RECONNECTION.STATE.DEFAULT_STATUS;
-      });
-
-      it('should correctly change status to in progress', () => {
-        reconnectionManager.setStatus(RECONNECTION.STATE.IN_PROGRESS);
-
-        assert.equal(reconnectionManager.status, RECONNECTION.STATE.IN_PROGRESS);
-      });
-
-      it('should correctly change status to complete', () => {
-        reconnectionManager.setStatus(RECONNECTION.STATE.COMPLETE);
-
-        assert.equal(reconnectionManager.status, RECONNECTION.STATE.COMPLETE);
-      });
-
-      it('should correctly change status to failure', () => {
-        reconnectionManager.setStatus(RECONNECTION.STATE.FAILURE);
-
-        assert.equal(reconnectionManager.status, RECONNECTION.STATE.FAILURE);
-      });
-    });
-
     describe('cleanUp()', () => {
       it('should call reset and keep reference to meeting object', () => {
         const resetSpy = sinon.spy(reconnectionManager, 'reset');

package/test/unit/spec/roap/request.ts

@@ -133,20 +133,6 @@ describe('plugin-meetings/roap', () => {
         locusMediaRequest,
       });
 
-      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-        name: 'client.locus.media.request',
-        options: {
-          meetingId: 'meeting-id',
-        },
-      });
-
-      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-        name: 'client.locus.media.response',
-        options: {
-          meetingId: 'meeting-id',
-        },
-      });
-
       const requestParams = locusMediaRequest.send.getCall(0).args[0];
       assert.deepEqual(requestParams, {
         type: 'RoapMessage',
@@ -175,29 +161,6 @@ describe('plugin-meetings/roap', () => {
         },
       });
     });
-
-    it('sends correct client event when fails', async () => {
-      const locusMediaRequest = {send: sinon.stub().rejects({code: 300, message: 'error'})};
-      try {
-        await roapRequest.sendRoap({
-          locusSelfUrl: locusUrl,
-          mediaId: 'mediaId',
-          roapMessage: {
-            seq: 'seq',
-          },
-          meetingId: 'meeting-id',
-          locusMediaRequest,
-        });
-      } catch (err) {
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.locus.media.response',
-          options: {
-            meetingId: 'meeting-id',
-            rawError: {code: 300, message: 'error'},
-          },
-        });
-      }
-    });
   });
 
   it('calls attachReachabilityData when sendRoap', async () => {