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

package/src/locus-info/index.ts

@@ -294,7 +294,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);
@@ -335,6 +335,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 +402,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 +468,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 +763,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 +777,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/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,
           {
@@ -2050,7 +2052,7 @@ describe('plugin-meetings', () => {
 
         fakeLocus = {
           meeting: true,
-          participants: true,
+          participants: [],
           url: 'newLocusUrl',
           syncUrl: 'newSyncUrl',
         };
@@ -2525,7 +2527,7 @@ describe('plugin-meetings', () => {
       });
 
       it('onDeltaLocus handle delta data', () => {
-        fakeLocus.participants = {};
+        fakeLocus.participants = [];
         const fakeBreakout = {
           sessionId: 'sessionId',
           groupId: 'groupId',
@@ -2542,11 +2544,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 +2565,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 +3076,7 @@ describe('plugin-meetings', () => {
               id: 'test person id',
             },
           },
+          participants: [],
         });
 
         updateLocusInfoStub.resetHistory();

package/test/unit/spec/members/collection.js

@@ -0,0 +1,120 @@
+const { default: MembersCollection } = require("../../../../src/members/collection");
+const { default: Member } = require("../../../../src/member");
+const { assert } = require('@webex/test-helper-chai');
+
+
+describe('plugin-meetings', () => {
+  describe('MembersCollection', () => {
+    let collection;
+    let member1;
+    let member2;
+    const participant1 = { controls: {}, status: {} };
+    const participant2 = { controls: {}, status: {} };
+
+    beforeEach(() => {
+      collection = new MembersCollection();
+      member1 = new Member(participant1);
+      member2 = new Member(participant2);
+    });
+
+    it('starts with no members', () => {
+      assert.equal(Object.keys(collection.getAll()).length, 0);
+    });
+
+    it('can add members', () => {      
+      collection.set('member1', member1);
+      assert.equal(Object.keys(collection.getAll()).length, 1);
+      assert.equal(collection.get('member1'), member1);
+
+      collection.set('member2', member2);
+      assert.equal(Object.keys(collection.getAll()).length, 2);
+      assert.equal(collection.get('member2'), member2);
+    });
+
+    it('can remove members', () => {
+      // Add some members first
+      collection.set('member1', member1);
+      collection.set('member2', member2);
+      assert.equal(Object.keys(collection.getAll()).length, 2);
+
+      // Remove one member
+      collection.remove('member1');
+      assert.equal(Object.keys(collection.getAll()).length, 1);
+      assert.equal(collection.get('member1'), undefined);
+      assert.equal(collection.get('member2'), member2);
+
+      // Remove another member
+      collection.remove('member2');
+      assert.equal(Object.keys(collection.getAll()).length, 0);
+      assert.equal(collection.get('member2'), undefined);
+
+      // Removing non-existent member should not cause errors
+      collection.remove('nonExistent');
+      assert.equal(Object.keys(collection.getAll()).length, 0);
+    });
+
+    describe('reset', () => {
+      it('removes all members', () => {
+        // Add some members first
+        collection.set('member1', member1);
+        collection.set('member2', member2);
+        assert.equal(Object.keys(collection.getAll()).length, 2);
+
+        // Reset should clear all members
+        collection.reset();
+        assert.equal(Object.keys(collection.getAll()).length, 0);
+        assert.equal(collection.get('member1'), undefined);
+        assert.equal(collection.get('member2'), undefined);
+      });
+    });
+
+    describe('setAll', () => {
+      it('replaces all members with new collection', () => {
+        // Add initial member
+        collection.set('member1', member1);
+        assert.equal(Object.keys(collection.getAll()).length, 1);
+
+        // Set all with new collection
+        const newMembers = {
+          'member2': member2,
+          'member3': new Member(participant1)
+        };
+        collection.setAll(newMembers);
+
+        assert.equal(Object.keys(collection.getAll()).length, 2);
+        assert.equal(collection.get('member1'), undefined);
+        assert.equal(collection.get('member2'), member2);
+        assert.exists(collection.get('member3'));
+      });
+    });
+
+    describe('get', () => {
+      it('returns undefined for non-existent members', () => {
+        assert.equal(collection.get('nonExistent'), undefined);
+      });
+
+      it('returns correct member for existing id', () => {
+        collection.set('member1', member1);
+        assert.equal(collection.get('member1'), member1);
+      });
+    });
+
+    describe('getAll', () => {
+      it('returns empty object when no members', () => {
+        const allMembers = collection.getAll();
+        assert.isObject(allMembers);
+        assert.equal(Object.keys(allMembers).length, 0);
+      });
+
+      it('returns all members', () => {
+        collection.set('member1', member1);
+        collection.set('member2', member2);
+        
+        const allMembers = collection.getAll();
+        assert.equal(Object.keys(allMembers).length, 2);
+        assert.equal(allMembers.member1, member1);
+        assert.equal(allMembers.member2, member2);
+      });
+    });
+  });
+});

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

@@ -320,9 +320,18 @@ describe('plugin-meetings', () => {
           EVENT_TRIGGERS.MEMBERS_CLEAR,
           {}
         );
+        sinon.restore();
       });
     });
     describe('#locusParticipantsUpdate', () => {
+      beforeEach(() => {
+        sinon.stub(Trigger, 'trigger');
+      });
+
+      afterEach(() => {
+        sinon.restore();
+      });
+
       it('should send member update event with session info', () => {
         const members = createMembers({url: url1});
         const fakePayload = {
@@ -343,13 +352,45 @@ describe('plugin-meetings', () => {
           },
           EVENT_TRIGGERS.MEMBERS_UPDATE,
           {
-            delta: {added: [], updated: []},
+            delta: {added: [], updated: [], removedIds: []},
             full: {},
             isReplace: true,
           }
         );
       });
 
+      it('should handle participants being removed', () => {
+        const members = createMembers({url: url1});
+
+        // setup the collection with a fake member
+        members.membersCollection.setAll(fakeMembersCollection);
+        assert.equal(Object.keys(members.membersCollection.getAll()).length, 1);
+
+        // remove the member
+        members.locusParticipantsUpdate({
+          participants: [],
+          removedParticipantIds: ['test1'],
+        });
+
+        assert.equal(Object.keys(members.membersCollection.getAll()).length, 0);
+
+        // check that the event was emitted
+        assert.calledWith(
+          Trigger.trigger,
+          members,
+          {
+            file: 'members',
+            function: 'locusParticipantsUpdate',
+          },
+          EVENT_TRIGGERS.MEMBERS_UPDATE,
+          {
+            delta: {added: [], updated: [], removedIds: ['test1']},
+            full: {},
+            isReplace: false,
+          }
+        );
+      });
+
       describe('handles members with paired devices correctly', () => {
         const runCheck = (propsForUpdate, expectedPropsOnPairedMember) => {
           const members = createMembers({url: url1});