@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/test/unit/spec/locus-info/embeddedAppsUtils.js

@@ -8,14 +8,16 @@ describe('plugin-meetings', () => {
     const slidoApp = {
       url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
       sequence: 138849877016800000,
-      appId: 'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
+      appId:
+        'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
       instanceInfo: {
-        appInstanceUrl: 'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
+        appInstanceUrl:
+          'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
         externalAppInstanceUrl: '',
-        title: 'Active session'
+        title: 'Active session',
       },
       state: 'STARTED',
-      lastModified: '2022-10-13T21:01:41.680Z'
+      lastModified: '2022-10-13T21:01:41.680Z',
     };
     const otherApp = {
       url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
@@ -24,10 +26,10 @@ describe('plugin-meetings', () => {
       instanceInfo: {
         appInstanceUrl: 'https://webex.someotherapp.com/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
         externalAppInstanceUrl: '',
-        title: 'Active session'
+        title: 'Active session',
       },
       state: 'STARTED',
-      lastModified: '2022-10-13T21:01:31.680Z'
+      lastModified: '2022-10-13T21:01:31.680Z',
     };
 
     describe('parseApp', () => {

package/test/unit/spec/locus-info/index.js

@@ -18,7 +18,8 @@ import {
   DISPLAY_HINTS,
 } from '../../../../src/constants';
 
-import {self, selfWithInactivity} from './selfConstant';
+import { self, selfWithInactivity } from "./selfConstant";
+import uuid from "uuid";
 
 describe('plugin-meetings', () => {
   describe('LocusInfo index', () => {
@@ -82,6 +83,7 @@ describe('plugin-meetings', () => {
             meetingContainerUrl: 'http://new-url.com',
           },
           entryExitTone: {enabled: true, mode: 'foo'},
+          video: {enabled: true},
         };
       });
 
@@ -277,6 +279,28 @@ describe('plugin-meetings', () => {
         );
       });
 
+      it('should update the breakout state', () => {
+        locusInfo.emitScoped = sinon.stub();
+        let tmpStub = sinon.stub(SelfUtils, 'getReplacedBreakoutMoveId').returns('breakoutMoveId');
+        newControls.breakout = { 'breakout': {} };
+        let selfInfo = {};
+
+        locusInfo.updateControls(newControls, selfInfo);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_BREAKOUT_UPDATED,
+          {
+            breakout: newControls.breakout,
+          }
+        );
+        tmpStub.restore();
+      });
+
       it('should update the transcript state', () => {
         locusInfo.emitScoped = sinon.stub();
         locusInfo.controls = {
@@ -398,6 +422,39 @@ describe('plugin-meetings', () => {
           assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED);
         });
       });
+
+      it('should update videoEnabled when changed', () => {
+        locusInfo.controls = {};
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+          {unmuteAllowed: true}
+        );
+
+        assert.equal(mockMeeting.unmuteVideoAllowed, true);
+      });
+
+      it('should not update videoEnabled when unchanged', () => {
+        locusInfo.controls = {videoEnabled: true};
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        locusInfo.emitScoped.getCalls().forEach((x) => {
+          // check that no calls in emitScoped are for SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED
+          assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED);
+        });
+
+        assert.equal(mockMeeting.unmuteVideoAllowed, undefined);
+      });
     });
 
     describe('#updateParticipants()', () => {
@@ -451,6 +508,7 @@ describe('plugin-meetings', () => {
             selfIdentity: '123',
             selfId: '2',
             hostId: '3',
+            isReplace: undefined,
           }
         );
         // note: in a real use case, recordingId, selfId, and hostId would all be the same
@@ -458,6 +516,43 @@ describe('plugin-meetings', () => {
         // are being correctly grabbed from locusInfo.parsedLocus within updateParticipants
       });
 
+      it('should call with breakout control info', () => {
+        locusInfo.parsedLocus = {
+          controls: {
+            record: {
+              modifiedBy: '1',
+            },
+          },
+          self: {
+            selfIdentity: '123',
+            selfId: '2',
+          },
+          host: {
+            hostId: '3',
+          },
+        };
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateParticipants({}, true);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateParticipants',
+          },
+          EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
+          {
+            participants: {},
+            recordingId: '1',
+            selfIdentity: '123',
+            selfId: '2',
+            hostId: '3',
+            isReplace: true,
+          }
+        );
+      });
+
       it('should update the deltaParticipants object', () => {
         const prev = locusInfo.deltaParticipants;
 
@@ -664,6 +759,143 @@ describe('plugin-meetings', () => {
         );
       });
 
+      describe('SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED', () => {
+        it('should emit event when video muted on entry', () => {
+          // usually "previous self" is just undefined when we get first self from locus
+          locusInfo.self = undefined;
+          const selfWithMutedByOthers = cloneDeep(self);
+
+          // remoteVideoMuted
+          selfWithMutedByOthers.controls.video.muted = true;
+
+          locusInfo.webex.internal.device.url = self.deviceUrl;
+          locusInfo.emitScoped = sinon.stub();
+          locusInfo.updateSelf(selfWithMutedByOthers, []);
+
+          assert.calledWith(
+            locusInfo.emitScoped,
+            {
+              file: 'locus-info',
+              function: 'updateSelf',
+            },
+            LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+            {muted: true}
+          );
+
+          // but sometimes "previous self" is defined, but without controls.audio.muted, so we test this here:
+          locusInfo.self = cloneDeep(self);
+          locusInfo.self.controls.video = {};
+
+          locusInfo.updateSelf(selfWithMutedByOthers, []);
+          assert.calledWith(
+            locusInfo.emitScoped,
+            {
+              file: 'locus-info',
+              function: 'updateSelf',
+            },
+            LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+            {muted: true}
+          );
+        });
+
+        it('should not emit event when not muted on entry', () => {
+          locusInfo.self = undefined;
+          const selfWithMutedByOthersFalse = cloneDeep(self);
+
+          selfWithMutedByOthersFalse.controls.video.muted = false;
+
+          locusInfo.webex.internal.device.url = self.deviceUrl;
+          locusInfo.emitScoped = sinon.stub();
+          locusInfo.updateSelf(selfWithMutedByOthersFalse, []);
+
+          // we might get some calls to emitScoped, but we need to check that none of them are for SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED
+          locusInfo.emitScoped.getCalls().forEach((x) => {
+            assert.notEqual(x.args[1], LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED);
+          });
+        });
+
+        it('should emit event when remoteVideoMuted changed', () => {
+          locusInfo.self = self;
+          const selfWithMutedByOthers = cloneDeep(self);
+
+          selfWithMutedByOthers.controls.video.muted = true;
+
+          locusInfo.webex.internal.device.url = self.deviceUrl;
+          locusInfo.emitScoped = sinon.stub();
+          locusInfo.updateSelf(selfWithMutedByOthers, []);
+
+          assert.calledWith(
+            locusInfo.emitScoped,
+            {
+              file: 'locus-info',
+              function: 'updateSelf',
+            },
+            LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+            {muted: true}
+          );
+        });
+      });
+
+      it('should trigger SELF_MEETING_BREAKOUTS_CHANGED when breakouts changed', () => {
+        locusInfo.self = self;
+        const selfWithBreakoutsChanged = cloneDeep(self);
+
+        selfWithBreakoutsChanged.controls.breakout.sessions.active[0].name = 'new name';
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateSelf(selfWithBreakoutsChanged, []);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MEETING_BREAKOUTS_CHANGED,
+          {
+            breakoutSessions: {
+              active: [
+                {
+                  name: 'new name',
+                  groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                  sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                  sessionType: 'BREAKOUT',
+                },
+              ],
+              allowed: [
+                {
+                  name: 'Breakout session 2',
+                  groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                  sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                  sessionType: 'BREAKOUT',
+                },
+              ],
+            },
+          }
+        );
+      });
+
+      it('should trigger upgradeToModeratorOrCohost for breakouts', () => {
+
+        locusInfo.self = self;
+        const upgradeToModeratorOrCohost = cloneDeep(self);
+        upgradeToModeratorOrCohost.roles = ['ATTENDEE','COHOST'];
+
+        locusInfo.webex.internal.device.url = self.deviceUrl;
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateSelf(upgradeToModeratorOrCohost, []);
+
+        assert.neverCalledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MODERATOR_OR_COHOST_UPGRADE,
+          self
+        );
+      });
+
       it('should trigger SELF_REMOTE_MUTE_STATUS_UPDATED if muted and disallowUnmute changed', () => {
         locusInfo.self = self;
         const selfWithMutedByOthersAndDissalowUnmute = cloneDeep(self);
@@ -962,18 +1194,36 @@ describe('plugin-meetings', () => {
             function: 'updateMeetingInfo',
           },
           LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
-          {info: locusInfo.parsedLocus.info, self},
+         {info: locusInfo.parsedLocus.info, self},
         ];
 
         if (expected) {
           assert.calledWith(...expectedArgs);
+        } else {
+          assert.neverCalledWith(...expectedArgs);
         }
-        else {
+        locusInfo.emitScoped.resetHistory();
+      };
+
+      const checkMeetingInfoUpdatedCalledForRoles = (expected) => {
+        const expectedArgs = [
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateMeetingInfo',
+          },
+          LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
+        ];
+
+        if (expected) {
+          assert.calledWith(...expectedArgs);
+        } else {
           assert.neverCalledWith(...expectedArgs);
         }
         locusInfo.emitScoped.resetHistory();
       };
 
+
       it('emits MEETING_INFO_UPDATED if the info changes', () => {
         const initialInfo = cloneDeep(meetingInfo);
 
@@ -999,6 +1249,16 @@ describe('plugin-meetings', () => {
 
         // since the info is the same it should not call trigger the event
         checkMeetingInfoUpdatedCalled(false);
+
+        // update it with the same info, but roles changed
+        const updateSelf = cloneDeep(self);
+        updateSelf?.controls?.role?.roles.push({
+          type: 'COHOST',
+          hasRole: true,
+        });
+        locusInfo.updateMeetingInfo(newInfo, updateSelf);
+        // since the info is the same but roles changed, it should call trigger the event
+        checkMeetingInfoUpdatedCalledForRoles(true);
       });
 
       it('gets roles from self if available', () => {
@@ -1148,6 +1408,55 @@ describe('plugin-meetings', () => {
         assert.isFunction(locusParser.onDeltaAction);
       });
 
+      it('#updateLocusInfo ignores breakout LEFT message', () => {
+        const newLocus = {
+          self: {
+            reason: 'MOVED',
+            state: 'LEFT',
+          },
+        };
+
+        locusInfo.updateControls = sinon.stub();
+        locusInfo.updateConversationUrl = sinon.stub();
+        locusInfo.updateCreated = sinon.stub();
+        locusInfo.updateFullState = sinon.stub();
+        locusInfo.updateHostInfo = sinon.stub();
+        locusInfo.updateMeetingInfo = sinon.stub();
+        locusInfo.updateMediaShares = sinon.stub();
+        locusInfo.updateParticipantsUrl = sinon.stub();
+        locusInfo.updateReplace = sinon.stub();
+        locusInfo.updateSelf = sinon.stub();
+        locusInfo.updateLocusUrl = sinon.stub();
+        locusInfo.updateAclUrl = sinon.stub();
+        locusInfo.updateBasequence = sinon.stub();
+        locusInfo.updateSequence = sinon.stub();
+        locusInfo.updateMemberShip = sinon.stub();
+        locusInfo.updateIdentifiers = sinon.stub();
+        locusInfo.updateEmbeddedApps = sinon.stub();
+        locusInfo.compareAndUpdate = sinon.stub();
+
+        locusInfo.updateLocusInfo(newLocus);
+
+        assert.notCalled(locusInfo.updateControls);
+        assert.notCalled(locusInfo.updateConversationUrl);
+        assert.notCalled(locusInfo.updateCreated);
+        assert.notCalled(locusInfo.updateFullState);
+        assert.notCalled(locusInfo.updateHostInfo);
+        assert.notCalled(locusInfo.updateMeetingInfo);
+        assert.notCalled(locusInfo.updateMediaShares);
+        assert.notCalled(locusInfo.updateParticipantsUrl);
+        assert.notCalled(locusInfo.updateReplace);
+        assert.notCalled(locusInfo.updateSelf);
+        assert.notCalled(locusInfo.updateLocusUrl);
+        assert.notCalled(locusInfo.updateAclUrl);
+        assert.notCalled(locusInfo.updateBasequence);
+        assert.notCalled(locusInfo.updateSequence);
+        assert.notCalled(locusInfo.updateMemberShip);
+        assert.notCalled(locusInfo.updateIdentifiers);
+        assert.notCalled(locusInfo.updateEmbeddedApps);
+        assert.notCalled(locusInfo.compareAndUpdate);
+      });
+
       it('onFullLocus() updates the working-copy of locus parser', () => {
         const eventType = 'fakeEvent';
 
@@ -1227,6 +1536,187 @@ describe('plugin-meetings', () => {
           assert.calledOnce(locusInfo.locusParser.resume);
         });
       });
+
+      it('onDeltaLocus handle delta data', () => {
+        fakeLocus.participants = {};
+        const fakeBreakout = {
+          sessionId: 'sessionId',
+          groupId: 'groupId',
+        };
+
+        fakeLocus.controls = {
+          breakout: fakeBreakout
+        };
+        locusInfo.controls = {
+          breakout: {
+            sessionId: 'sessionId',
+            groupId: 'groupId',
+          }
+        }
+        locusInfo.updateParticipants = sinon.stub();
+        locusInfo.onDeltaLocus(fakeLocus);
+        assert.calledWith(locusInfo.updateParticipants, {}, false);
+
+        fakeLocus.controls.breakout.sessionId = 'sessionId2';
+        locusInfo.onDeltaLocus(fakeLocus);
+        assert.calledWith(locusInfo.updateParticipants, {}, true);
+      });
+    });
+
+    describe('#updateLocusCache', () => {
+      it('cache it if income locus is main session locus', () => {
+        const locus = {url: 'url'};
+        locusInfo.mainSessionLocusCache = null;
+        locusInfo.updateLocusCache(locus);
+
+        assert.deepEqual(locusInfo.mainSessionLocusCache, locus);
+      });
+
+      it('not cache it if income locus is breakout session locus', () => {
+        const locus = {url: 'url', controls: {breakout: {sessionType: 'BREAKOUT'}}};
+        locusInfo.mainSessionLocusCache = null;
+        locusInfo.updateLocusCache(locus);
+
+        assert.isNull(locusInfo.mainSessionLocusCache);
+      });
+    });
+
+    describe('#getTheLocusToUpdate', () => {
+      it('return the cache locus if return to main session', () => {
+        locusInfo.mainSessionLocusCache = {url: 'url'};
+        locusInfo.controls = {
+          breakout: {
+            sessionType: 'BREAKOUT'
+          }
+        }
+        const newLocus = {
+          controls: {
+            breakout: {
+              sessionType: 'MAIN',
+            },
+          },
+        };
+
+        assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), {url: 'url'});
+      });
+
+      it('return the new locus if return to main session but no cache', () => {
+        locusInfo.mainSessionLocusCache = null;
+        locusInfo.controls = {
+          breakout: {
+            sessionType: 'BREAKOUT'
+          }
+        }
+        const newLocus = {
+          controls: {
+            breakout: {
+              sessionType: 'MAIN',
+            },
+          },
+        };
+
+        assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), newLocus);
+      });
+
+      it('return the new locus if not return to main session', () => {
+        locusInfo.mainSessionLocusCache = {url: 'url'};
+        locusInfo.controls = {
+          breakout: {
+            sessionType: 'MAIN'
+          }
+        }
+        const newLocus = {
+          controls: {
+            breakout: {
+              sessionType: 'BREAKOUT',
+            },
+          },
+        };
+
+        assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), newLocus);
+      });
+    });
+
+    describe('#mergeParticipants', () => {
+      let participants;
+      let sourceParticipants;
+      beforeEach(() => {
+        participants = [{id: '111', status: 'JOINED'}, {id: '222'}];
+        sourceParticipants = [{id: '111', status: 'LEFT'}, {id: '333'}];
+      });
+
+      it('merge the participants, replace it by id if exist in old array', () => {
+        const result = locusInfo.mergeParticipants(participants, sourceParticipants);
+        assert.deepEqual(result, [{id: '111', status: 'LEFT'}, {id: '222'}, {id: '333'}]);
+      });
+
+      it('return new participants if previous participants is empty', () => {
+        const result = locusInfo.mergeParticipants([], sourceParticipants);
+        assert.deepEqual(result, sourceParticipants);
+      });
+
+      it('return new participants if previous participants is null/undefined', () => {
+        let result = locusInfo.mergeParticipants(null, sourceParticipants);
+        assert.deepEqual(result, sourceParticipants);
+
+        result = locusInfo.mergeParticipants(undefined, sourceParticipants);
+        assert.deepEqual(result, sourceParticipants);
+      });
+
+      it('return previous participants if new participants is empty', () => {
+        const result = locusInfo.mergeParticipants(participants, []);
+        assert.deepEqual(result, participants);
+      });
+
+      it('return previous participants if new participants is null/undefined', () => {
+        let result = locusInfo.mergeParticipants(participants, null);
+        assert.deepEqual(result, participants);
+
+        result = locusInfo.mergeParticipants(participants, undefined);
+        assert.deepEqual(result, participants);
+      });
+    });
+
+    describe('#updateMainSessionLocusCache', () => {
+      let cachedLocus;
+      let newLocus;
+      beforeEach(() => {
+        cachedLocus = {controls: {}, participants: [], info: {webExMeetingId: 'testId1', topic: 'test'}};
+        newLocus = {self: {}, participants: [{id: '111'}], info: {testId: 'testId2', webExMeetingName: 'hello'}};
+      });
+      it('shallow merge new locus into cache', () => {
+        locusInfo.mainSessionLocusCache = cachedLocus;
+        locusInfo.updateMainSessionLocusCache(newLocus);
+
+        assert.deepEqual(locusInfo.mainSessionLocusCache, {
+          controls: {},
+          participants: [{id: '111'}],
+          info: {testId: 'testId2', webExMeetingName: 'hello'},
+          self: {},
+        });
+      });
+
+      it('cache new locus if no cache before', () => {
+        locusInfo.mainSessionLocusCache = null;
+        locusInfo.updateMainSessionLocusCache(newLocus);
+
+        assert.deepEqual(locusInfo.mainSessionLocusCache, newLocus);
+      });
+
+      it('do nothing if new locus is null', () => {
+        locusInfo.mainSessionLocusCache = cachedLocus;
+        locusInfo.updateMainSessionLocusCache(null);
+
+        assert.deepEqual(locusInfo.mainSessionLocusCache, cachedLocus);
+      });
+    });
+
+    describe('#clearMainSessionLocusCache', () => {
+      it('clear main session locus cache', () => {
+        locusInfo.mainSessionLocusCache = {controls: {}};
+        locusInfo.clearMainSessionLocusCache();
+        assert.isNull(locusInfo.mainSessionLocusCache);
+      })
     });
 
     describe('#handleOneonOneEvent', () => {