@webex/plugin-meetings 3.9.0-next.14 → 3.9.0-next.16

package/package.json

@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.9.0-next.14"
+  "version": "3.9.0-next.16"
 }

package/src/locus-info/index.ts

@@ -31,6 +31,51 @@ import LocusDeltaParser from './parser';
 import Metrics from '../metrics';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 
+export type LocusDTO = {
+  controls?: any;
+  fullState?: {
+    active: boolean;
+    count: number;
+    lastActive: string;
+    locked: boolean;
+    sessionId: string;
+    seessionIds: string[];
+    startTime: number;
+    state: string;
+    type: string;
+  };
+  host?: {
+    id: string;
+    incomingCallProtocols: any[];
+    isExternal: boolean;
+    name: string;
+    orgId: string;
+  };
+  info?: any;
+  links?: any;
+  mediaShares?: any[];
+  meetings?: any[];
+  participants: any[];
+  replaces?: any[];
+  self?: any;
+  sequence?: {
+    dirtyParticipants: number;
+    entries: number[];
+    rangeEnd: number;
+    rangeStart: number;
+    sequenceHash: number;
+    sessionToken: string;
+    since: string;
+    totalParticipants: number;
+  };
+  syncUrl?: string;
+  url?: string;
+};
+
+export type LocusApiResponseBody = {
+  locus: LocusDTO; // this LocusDTO here might not be the full one (for example it won't have all the participants, but it should have self)
+};
+
 /**
  * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
  * @export
@@ -294,7 +339,7 @@ export default class LocusInfo extends EventsScope {
     this.updateLocusCache(locus);
     // above section only updates the locusInfo object
     // The below section makes sure it updates the locusInfo as well as updates the meeting object
-    this.updateParticipants(locus.participants);
+    this.updateParticipants(locus.participants, []);
     // For 1:1 space meeting the conversation Url does not exist in locus.conversation
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateControls(locus.controls, locus.self);
@@ -323,6 +368,16 @@ export default class LocusInfo extends EventsScope {
     this.emitChange = true;
   }
 
+  /**
+   * Handles HTTP response from Locus API call.
+   * @param {Meeting} meeting meeting object
+   * @param {LocusApiResponseBody} responseBody body of the http response from Locus API call
+   * @returns {void}
+   */
+  handleLocusAPIResponse(meeting, responseBody: LocusApiResponseBody): void {
+    this.handleLocusDelta(responseBody.locus, meeting);
+  }
+
   /**
    * @param {Meeting} meeting
    * @param {Object} data
@@ -335,6 +390,8 @@ export default class LocusInfo extends EventsScope {
     const locus = this.getTheLocusToUpdate(data.locus);
     LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
 
+    locus.jsSdkMeta = {removedParticipantIds: []};
+
     switch (eventType) {
       case LOCUSEVENT.PARTICIPANT_JOIN:
       case LOCUSEVENT.PARTICIPANT_LEFT:
@@ -400,7 +457,11 @@ export default class LocusInfo extends EventsScope {
     this.participants = locus.participants;
     const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants, isReplaceMembers);
+    this.updateParticipants(
+      locus.participants,
+      locus.jsSdkMeta?.removedParticipantIds,
+      isReplaceMembers
+    );
     this.isMeetingActive();
     this.handleOneOnOneEvent(eventType);
     this.updateEmbeddedApps(locus.embeddedApps);
@@ -462,7 +523,11 @@ export default class LocusInfo extends EventsScope {
     const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.mergeParticipants(this.participants, locus.participants);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants, isReplaceMembers);
+    this.updateParticipants(
+      locus.participants,
+      locus.jsSdkMeta?.removedParticipantIds,
+      isReplaceMembers
+    );
     this.isMeetingActive();
   }
 
@@ -753,11 +818,12 @@ export default class LocusInfo extends EventsScope {
   /**
    * update meeting's members
    * @param {Object} participants new participants object
+   * @param {Array} removedParticipantIds list of removed participants
    * @param {Boolean} isReplace is replace the whole members
    * @returns {Array} updatedParticipants
    * @memberof LocusInfo
    */
-  updateParticipants(participants: object, isReplace?: boolean) {
+  updateParticipants(participants: object, removedParticipantIds?: string[], isReplace?: boolean) {
     this.emitScoped(
       {
         file: 'locus-info',
@@ -766,6 +832,7 @@ export default class LocusInfo extends EventsScope {
       EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
       {
         participants,
+        removedParticipantIds,
         recordingId: this.parsedLocus.controls && this.parsedLocus.controls.record?.modifiedBy,
         selfIdentity: this.parsedLocus.self && this.parsedLocus.self.selfIdentity,
         selfId: this.parsedLocus.self && this.parsedLocus.self.selfId,

package/src/meeting/muteState.ts

@@ -291,18 +291,14 @@ export class MuteState {
     );
 
     return MeetingUtil.remoteUpdateAudioVideo(meeting, audioMuted, videoMuted)
-      .then((locus) => {
+      .then((response) => {
         LoggerProxy.logger.info(
           `Meeting:muteState#sendLocalMuteRequestToServer --> ${this.type}: local mute (audio=${audioMuted}, video=${videoMuted}) applied to server`
         );
 
         this.state.server.localMute = this.type === AUDIO ? audioMuted : videoMuted;
 
-        if (locus) {
-          meeting.locusInfo.handleLocusDelta(locus, meeting);
-        }
-
-        return locus;
+        return MeetingUtil.updateLocusFromApiResponse(meeting, response);
       })
       .catch((remoteUpdateError) => {
         LoggerProxy.logger.warn(

package/src/meeting/util.ts

@@ -59,18 +59,16 @@ const MeetingUtil = {
       );
     }
 
-    return meeting.locusMediaRequest
-      .send({
-        type: 'LocalMute',
-        selfUrl: meeting.selfUrl,
-        mediaId: meeting.mediaId,
-        sequence: meeting.locusInfo.sequence,
-        muteOptions: {
-          audioMuted,
-          videoMuted,
-        },
-      })
-      .then((response) => response?.body?.locus);
+    return meeting.locusMediaRequest.send({
+      type: 'LocalMute',
+      selfUrl: meeting.selfUrl,
+      mediaId: meeting.mediaId,
+      sequence: meeting.locusInfo.sequence,
+      muteOptions: {
+        audioMuted,
+        videoMuted,
+      },
+    });
   },
 
   hasOwner: (info) => info && info.owner,
@@ -695,22 +693,20 @@ const MeetingUtil = {
   },
 
   /**
-   * Updates the locus info for the meeting with the delta locus
-   * returned from requests that include the sequence information
+   * Updates the locus info for the meeting with the locus
+   * information returned from API requests made to Locus
    * Returns the original response object
    * @param {Object} meeting The meeting object
    * @param {Object} response The response of the http request
    * @returns {Object}
    */
-  updateLocusWithDelta: (meeting, response) => {
+  updateLocusFromApiResponse: (meeting, response) => {
     if (!meeting) {
       return response;
     }
 
-    const locus = response?.body?.locus;
-
-    if (locus) {
-      meeting.locusInfo.handleLocusDelta(locus, meeting);
+    if (response?.body?.locus) {
+      meeting.locusInfo.handleLocusAPIResponse(meeting, response.body);
     }
 
     return response;
@@ -757,7 +753,7 @@ const MeetingUtil = {
 
       return meeting
         .request(options)
-        .then((response) => MeetingUtil.updateLocusWithDelta(meeting, response));
+        .then((response) => MeetingUtil.updateLocusFromApiResponse(meeting, response));
     };
 
     return locusDeltaRequest;

package/src/member/types.ts

@@ -109,4 +109,5 @@ export interface Participant {
   status: ParticipantMediaStatus;
   type: string;
   url: ParticipantUrl;
+  isRemoved: boolean; // JS-SDK internal field to indicate in updates when the participant is removed
 }

package/src/members/collection.ts

@@ -39,6 +39,17 @@ export default class MembersCollection {
     return this.members;
   }
 
+  /**
+   * Removes a member from the collection
+   * @param {String} id
+   * @returns {void}
+   */
+  remove(id: string) {
+    if (this.members[id]) {
+      delete this.members[id];
+    }
+  }
+
   /**
    * @returns {void}
    * reset members

package/src/members/index.ts

@@ -74,7 +74,11 @@ import {Invitee} from '../meeting/type';
  * @memberof Members
  */
 
-type UpdatedMembers = {added: Array<Member>; updated: Array<Member>};
+type UpdatedMembers = {
+  added: Array<Member>;
+  updated: Array<Member>;
+  removedIds?: Array<string>; // removed member ids
+};
 /**
  * @class Members
  */
@@ -384,12 +388,18 @@ export default class Members extends StatelessWebexPlugin {
    * when new participant updates come in, both delta and full participants, update them in members collection
    * delta object in the event will have {updated, added} and full will be the full membersCollection
    * @param {Object} payload
-   * @param {Object} payload.participants
+   * @param {Object} payload.participants new/updated participants
+   * @param {Boolean} payload.isReplace whether to replace the whole members collection
+   * @param {Object} payload.removedParticipantIds ids of the removed participants
    * @returns {undefined}
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
+  locusParticipantsUpdate(payload: {
+    participants: object;
+    isReplace?: boolean;
+    removedParticipantIds?: Array<string>;
+  }) {
     if (payload) {
       if (payload.isReplace) {
         this.clearMembers();
@@ -547,10 +557,22 @@ export default class Members extends StatelessWebexPlugin {
   private handleMembersUpdate(membersUpdate: UpdatedMembers) {
     this.constructMembers(membersUpdate.updated, true);
     this.constructMembers(membersUpdate.added, false);
+    this.removeMembers(membersUpdate.removedIds);
 
     return this.membersCollection.getAll();
   }
 
+  /**
+   * removes members from the collection
+   * @param {Array<string>} removedMembers removed members ids
+   * @returns {void}
+   */
+  private removeMembers(removedMembers: Array<string>) {
+    removedMembers.forEach((memberId) => {
+      this.membersCollection.remove(memberId);
+    });
+  }
+
   /**
    * set members to the member collection from each updated/added lists as passed in
    * @param {Array} list
@@ -600,6 +622,10 @@ export default class Members extends StatelessWebexPlugin {
     }
     const memberUpdate = this.update(payload.participants);
 
+    // this code depends on memberIds being the same as participantIds
+    // if MemberUtil.extractId() ever changes, this will need to be updated
+    memberUpdate.removedIds = payload.removedParticipantIds || [];
+
     return memberUpdate;
   }
 

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

@@ -772,7 +772,7 @@ describe('plugin-meetings', () => {
           },
         };
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants({});
+        locusInfo.updateParticipants({}, []);
 
         // if this assertion fails, double-check the attributes used in
         // the updateParticipants function in locus-info/index.js
@@ -790,6 +790,7 @@ describe('plugin-meetings', () => {
             selfId: '2',
             hostId: '3',
             isReplace: undefined,
+            removedParticipantIds: [],
           }
         );
         // note: in a real use case, recordingId, selfId, and hostId would all be the same
@@ -814,7 +815,7 @@ describe('plugin-meetings', () => {
         };
 
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants({}, true);
+        locusInfo.updateParticipants({}, [], true);
 
         assert.calledWith(
           locusInfo.emitScoped,
@@ -830,6 +831,7 @@ describe('plugin-meetings', () => {
             selfId: '2',
             hostId: '3',
             isReplace: true,
+            removedParticipantIds: [],
           }
         );
       });
@@ -847,7 +849,7 @@ describe('plugin-meetings', () => {
         ];
 
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants(failureParticipant);
+        locusInfo.updateParticipants(failureParticipant, []);
         assert.calledWith(
           locusInfo.emitScoped,
           {
@@ -2038,6 +2040,18 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#handleLocusAPIResponse', () => {
+      it('calls handleLocusDelta', () => {
+        const fakeLocus = {eventType: LOCUSEVENT.DIFFERENCE};
+
+        sinon.stub(locusInfo, 'handleLocusDelta');
+
+        locusInfo.handleLocusAPIResponse(mockMeeting, {locus: fakeLocus});
+
+        assert.calledWith(locusInfo.handleLocusDelta, fakeLocus, mockMeeting);
+      });
+    });
+
     describe('#LocusDeltaEvents', () => {
       const fakeMeeting = 'fakeMeeting';
       let sandbox = null;
@@ -2050,7 +2064,7 @@ describe('plugin-meetings', () => {
 
         fakeLocus = {
           meeting: true,
-          participants: true,
+          participants: [],
           url: 'newLocusUrl',
           syncUrl: 'newSyncUrl',
         };
@@ -2525,7 +2539,7 @@ describe('plugin-meetings', () => {
       });
 
       it('onDeltaLocus handle delta data', () => {
-        fakeLocus.participants = {};
+        fakeLocus.participants = [];
         const fakeBreakout = {
           sessionId: 'sessionId',
           groupId: 'groupId',
@@ -2542,11 +2556,11 @@ describe('plugin-meetings', () => {
         };
         locusInfo.updateParticipants = sinon.stub();
         locusInfo.onDeltaLocus(fakeLocus);
-        assert.calledWith(locusInfo.updateParticipants, {}, false);
+        assert.calledWith(locusInfo.updateParticipants, [], undefined, false);
 
         fakeLocus.controls.breakout.sessionId = 'sessionId2';
         locusInfo.onDeltaLocus(fakeLocus);
-        assert.calledWith(locusInfo.updateParticipants, {}, true);
+        assert.calledWith(locusInfo.updateParticipants, [], undefined, true);
       });
 
       it('onDeltaLocus merges delta participants with existing participants', () => {
@@ -2563,7 +2577,7 @@ describe('plugin-meetings', () => {
           existingParticipants,
           FAKE_DELTA_PARTICIPANTS
         );
-        assert.calledWith(locusInfo.updateParticipants, FAKE_DELTA_PARTICIPANTS, false);
+        assert.calledWith(locusInfo.updateParticipants, FAKE_DELTA_PARTICIPANTS, undefined, false);
       });
 
       [true, false].forEach((isDelta) =>
@@ -3074,6 +3088,7 @@ describe('plugin-meetings', () => {
               id: 'test person id',
             },
           },
+          participants: [],
         });
 
         updateLocusInfoStub.resetHistory();

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

@@ -12,7 +12,7 @@ describe('plugin-meetings', () => {
   let video;
   let originalRemoteUpdateAudioVideo;
 
-  const fakeLocus = {info: 'this is a fake locus'};
+  const fakeLocusResponse = {body: {locus: {info: 'this is a fake locus'}}};
 
   const createFakeLocalStream = (id, userMuted, systemMuted) => {
     return {
@@ -38,9 +38,6 @@ describe('plugin-meetings', () => {
       unmuteAllowed: true,
       remoteVideoMuted: false,
       unmuteVideoAllowed: true,
-      locusInfo: {
-        handleLocusDelta: sinon.stub(),
-      },
       members: {
         selfId: 'fake self id',
         muteMember: sinon.stub().resolves(),
@@ -49,7 +46,8 @@ describe('plugin-meetings', () => {
 
     originalRemoteUpdateAudioVideo = MeetingUtil.remoteUpdateAudioVideo;
 
-    MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves(fakeLocus);
+    MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves(fakeLocusResponse);
+    MeetingUtil.updateLocusFromApiResponse = sinon.stub();
 
     audio = createMuteState(AUDIO, meeting, true);
     video = createMuteState(VIDEO, meeting, true);
@@ -141,6 +139,7 @@ describe('plugin-meetings', () => {
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
       assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, false, undefined);
+      assert.calledWith(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
 
       assert.isFalse(audio.isMuted());
     });
@@ -173,6 +172,7 @@ describe('plugin-meetings', () => {
 
       // system was muted so local unmute was not sent to server
       assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+      assert.notCalled(MeetingUtil.updateLocusFromApiResponse);
 
       assert.isTrue(audio.isMuted());
     });
@@ -207,6 +207,7 @@ describe('plugin-meetings', () => {
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
       assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, false);
+      assert.calledWith(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
 
       assert.isFalse(video.isMuted());
     });
@@ -219,7 +220,9 @@ describe('plugin-meetings', () => {
 
       assert.isTrue(video.isMuted());
 
+      await testUtils.flushPromises();
       MeetingUtil.remoteUpdateAudioVideo.resetHistory();
+      MeetingUtil.updateLocusFromApiResponse.resetHistory();
 
       // now simulate server requiring us to locally unmute
       // assuming setServerMuted succeeds at updating userMuted
@@ -239,6 +242,7 @@ describe('plugin-meetings', () => {
 
       // system was muted so local unmute was not sent to server
       assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+      assert.notCalled(MeetingUtil.updateLocusFromApiResponse);
 
       assert.isTrue(video.isMuted());
     });
@@ -443,6 +447,7 @@ describe('plugin-meetings', () => {
 
         assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
         assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, true, undefined);
+        assert.calledWith(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
 
         // now allow the first request to complete
         serverResponseResolve();
@@ -559,6 +564,7 @@ describe('plugin-meetings', () => {
         await testUtils.flushPromises();
 
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
+        MeetingUtil.updateLocusFromApiResponse.resetHistory();
       };
 
       const setupSpies = (mediaType) => {
@@ -605,13 +611,15 @@ describe('plugin-meetings', () => {
         {mediaType: VIDEO, title: 'video'},
       ];
 
+      const fakeLocusResponse = {body: {locus: {info: 'fake locus'}}};
+
       tests.forEach(({mediaType, title}) =>
         describe(title, () => {
           let originalRemoteUpdateAudioVideo;
 
           beforeEach(() => {
             originalRemoteUpdateAudioVideo = MeetingUtil.remoteUpdateAudioVideo;
-            MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves({info: 'fake locus'});
+            MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves(fakeLocusResponse);
           });
 
           afterEach(() => {
@@ -660,6 +668,7 @@ describe('plugin-meetings', () => {
               assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
               assert.notCalled(setServerMutedSpy);
               assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+              assert.notCalled(MeetingUtil.updateLocusFromApiResponse);
               assert.isTrue(muteState.state.client.localMute);
             });
 
@@ -672,6 +681,7 @@ describe('plugin-meetings', () => {
               assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
               assert.notCalled(setServerMutedSpy);
               assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+              assert.notCalled(MeetingUtil.updateLocusFromApiResponse);
               assert.isTrue(muteState.state.client.localMute);
             });
 
@@ -681,9 +691,12 @@ describe('plugin-meetings', () => {
 
               muteState.init(meeting);
 
+              await testUtils.flushPromises();
+
               assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
               assert.notCalled(setServerMutedSpy);
               assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
+              assert.calledOnceWithExactly(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
               assert.isFalse(muteState.state.client.localMute);
             });
 
@@ -707,6 +720,7 @@ describe('plugin-meetings', () => {
               simulateUserMute(mediaType, true);
               muteState.handleLocalStreamMuteStateChange(meeting);
               assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+              assert.notCalled(MeetingUtil.updateLocusFromApiResponse);
 
               assert.isFalse(muteState.state.client.localMute);
             });
@@ -716,8 +730,11 @@ describe('plugin-meetings', () => {
 
               simulateUserMute(mediaType, false);
               muteState.handleLocalStreamMuteStateChange(meeting);
+              await testUtils.flushPromises();
+
               assert.equal(muteState.state.client.localMute, false);
               assert.called(MeetingUtil.remoteUpdateAudioVideo);
+              assert.calledOnceWithExactly(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
             });
 
             it('tests localMute - user mute from false to true', async () => {
@@ -725,8 +742,11 @@ describe('plugin-meetings', () => {
 
               simulateUserMute(mediaType, true);
               muteState.handleLocalStreamMuteStateChange(meeting);
+              await testUtils.flushPromises();
+
               assert.equal(muteState.state.client.localMute, true);
               assert.called(MeetingUtil.remoteUpdateAudioVideo);
+              assert.calledOnceWithExactly(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
             });
 
             it('tests localMute - system mute from true to false', async () => {
@@ -734,8 +754,11 @@ describe('plugin-meetings', () => {
 
               simulateSystemMute(mediaType, false);
               muteState.handleLocalStreamMuteStateChange(meeting);
+              await testUtils.flushPromises();
+
               assert.equal(muteState.state.client.localMute, false);
               assert.called(MeetingUtil.remoteUpdateAudioVideo);
+              assert.calledOnceWithExactly(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
             });
 
             it('tests localMute - system mute from false to true', async () => {
@@ -743,8 +766,11 @@ describe('plugin-meetings', () => {
 
               simulateSystemMute(mediaType, true);
               muteState.handleLocalStreamMuteStateChange(meeting);
+              await testUtils.flushPromises();
+
               assert.equal(muteState.state.client.localMute, true);
               assert.called(MeetingUtil.remoteUpdateAudioVideo);
+              assert.calledOnceWithExactly(MeetingUtil.updateLocusFromApiResponse, meeting, fakeLocusResponse);
             });
           });