@webex/plugin-meetings 3.0.0-beta.66 → 3.0.0-beta.67

package/src/meetings/collection.ts

@@ -40,4 +40,24 @@ export default class MeetingCollection extends Collection {
 
     return null;
   }
+
+  /**
+   * get a specific meeting searching for key
+   * @param {String} breakoutUrl
+   * @returns {Meeting} if found, else returns null
+   * @public
+   * @memberof MeetingCollection
+   */
+  public getActiveBreakoutLocus(breakoutUrl: string) {
+    if (breakoutUrl) {
+      // @ts-ignore
+      return find(
+        // @ts-ignore
+        this.meetings,
+        (meeting) => meeting.breakouts?.url === breakoutUrl && meeting.breakouts?.isActiveBreakout
+      );
+    }
+
+    return null;
+  }
 }

package/src/meetings/index.ts

@@ -40,6 +40,10 @@ import {
   MEETING_REMOVED_REASON,
   _CONVERSATION_URL_,
   CONVERSATION_URL,
+  MEETINGNUMBER,
+  BREAKOUTS,
+  _JOINED_,
+  _MOVED_,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import MeetingInfo from '../meeting-info';
@@ -227,6 +231,103 @@ export default class Meetings extends WebexPlugin {
     this.onReady();
   }
 
+  /**
+   * check whether you need to handle this main session's locus data or not
+   * @param {Object} meeting current meeting data
+   * @param {Object} newLocus new locus data
+   * @returns {boolean}
+   * @private
+   * @memberof Meetings
+   */
+  private isNeedHandleMainLocus(meeting: any, newLocus: any) {
+    const breakoutUrl = newLocus.controls?.breakout?.url;
+    const breakoutLocus = this.meetingCollection.getActiveBreakoutLocus(breakoutUrl);
+
+    const isSelfJoined = newLocus?.self?.state === _JOINED_;
+    const isSelfMoved = newLocus?.self?.state === _LEFT_ && newLocus?.self?.reason === _MOVED_;
+    const deviceFromNewLocus = MeetingsUtil.getThisDevice(newLocus);
+    const isNewLocusJoinThisDevice = MeetingsUtil.joinedOnThisDevice(meeting, newLocus);
+    const isBreakoutLocusJoinThisDevice =
+      breakoutLocus?.joinedWith?.correlationId &&
+      breakoutLocus.joinedWith.correlationId === meeting?.correlationId;
+
+    if (isSelfJoined && isNewLocusJoinThisDevice) {
+      LoggerProxy.logger.log(
+        'Meetings:index#isNeedHandleMainLocus --> self this device shown as JOINED in the main session'
+      );
+      if (breakoutLocus?.joinedWith && deviceFromNewLocus) {
+        const breakoutReplaceAt =
+          breakoutLocus.joinedWith.replaces?.length > 0
+            ? breakoutLocus.joinedWith.replaces[0].replaceAt
+            : '';
+        const newLocusReplaceAt =
+          deviceFromNewLocus.replaces?.length > 0 ? deviceFromNewLocus.replaces[0].replaceAt : '';
+        if (breakoutReplaceAt && newLocusReplaceAt && breakoutReplaceAt > newLocusReplaceAt) {
+          LoggerProxy.logger.log(
+            `Meetings:index#isNeedHandleMainLocus --> this is expired main joined status locus_dto replacedAt ${newLocusReplaceAt} bo replacedAt ${breakoutReplaceAt}`
+          );
+
+          return false;
+        }
+      }
+
+      return true;
+    }
+    if (isBreakoutLocusJoinThisDevice) {
+      LoggerProxy.logger.log(
+        `Meetings:index#isNeedHandleMainLocus --> there is active breakout session and joined on this device, and don't need to handle main session: ${breakoutUrl}`
+      );
+
+      return false;
+    }
+    if (isSelfMoved && newLocus?.self?.removed) {
+      LoggerProxy.logger.log(
+        'Meetings:index#isNeedHandleMainLocus --> self moved main locus with self removed status, not need to handle'
+      );
+
+      return false;
+    }
+    LoggerProxy.logger.log(
+      'Meetings:index#isNeedHandleMainLocus --> this is a normal main session locusDTO update case'
+    );
+
+    return true;
+  }
+
+  /**
+   * check whether you need to handle this locus data or not
+   * @param {Object} meeting old locus data
+   * @param {Object} newLocus new locus data
+   * @returns {boolean}
+   * @private
+   * @memberof Meetings
+   */
+  private isNeedHandleLocusDTO(meeting: any, newLocus: any) {
+    if (newLocus) {
+      const isNewLocusAsBreakout =
+        newLocus.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+      const isSelfMoved = newLocus?.self?.state === _LEFT_ && newLocus?.self?.reason === _MOVED_;
+      if (!meeting) {
+        if (isNewLocusAsBreakout) {
+          LoggerProxy.logger.log(
+            `Meetings:index#isNeedHandleLocusDTO --> the first breakout session locusDTO active status: ${newLocus.fullState?.active}`
+          );
+
+          return newLocus.self?.state === _JOINED_;
+        }
+
+        return this.isNeedHandleMainLocus(meeting, newLocus);
+      }
+      if (!isNewLocusAsBreakout) {
+        return this.isNeedHandleMainLocus(meeting, newLocus);
+      }
+
+      return !isSelfMoved;
+    }
+
+    return true;
+  }
+
   /**
    * handle locus events and takes meeting actions with them as they come in
    * @param {Object} data a locus event
@@ -240,7 +341,6 @@ export default class Meetings extends WebexPlugin {
    */
   private handleLocusEvent(data: {locusUrl: string; locus: any}, useRandomDelayForInfo = false) {
     let meeting = null;
-
     // getting meeting by correlationId. This will happen for the new event
     // Either the locus
     // TODO : Add check for the callBack Address
@@ -260,7 +360,8 @@ export default class Meetings extends WebexPlugin {
       ) ||
       (data.locus.info?.isUnifiedSpaceMeeting
         ? undefined
-        : this.meetingCollection.getByKey(CONVERSATION_URL, data.locus.conversationUrl));
+        : this.meetingCollection.getByKey(CONVERSATION_URL, data.locus.conversationUrl)) ||
+      this.meetingCollection.getByKey(MEETINGNUMBER, data.locus?.info?.webExMeetingId);
 
     // Special case when locus has got replaced, This only happend once if a replace locus exists
     // https://sqbu-github.cisco.com/WebExSquared/locus/wiki/Locus-changing-mid-call
@@ -273,6 +374,13 @@ export default class Meetings extends WebexPlugin {
       );
     }
 
+    if (!this.isNeedHandleLocusDTO(meeting, data.locus)) {
+      LoggerProxy.logger.log(
+        `Meetings:index#handleLocusEvent --> doesn't need to process locus event`
+      );
+
+      return;
+    }
     if (!meeting) {
       // TODO: create meeting when we get a meeting object
       // const checkForEnded = (locus) => {

package/src/meetings/util.ts

@@ -8,6 +8,9 @@ import {
   CORRELATION_ID,
   EVENT_TRIGGERS,
   ROAP,
+  _LEFT_,
+  _MOVED_,
+  _JOINED_,
 } from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import Trigger from '../common/events/trigger-proxy';
@@ -220,4 +223,39 @@ MeetingsUtil.checkH264Support = async function checkH264Support(options: {
   }, delay);
 };
 
+/**
+ * get device from locus data
+ * @param {Object} newLocus new locus data
+ * @returns {Object}
+ */
+MeetingsUtil.getThisDevice = (newLocus: any) => {
+  if (newLocus?.self?.devices?.length > 0) {
+    const [thisDevice] = newLocus.self.devices;
+
+    return thisDevice;
+  }
+
+  return null;
+};
+
+/**
+ * get self device joined status from locus data
+ * @param {Object} meeting current meeting data
+ * @param {Object} newLocus new locus data
+ * @returns {Object}
+ */
+MeetingsUtil.joinedOnThisDevice = (meeting: any, newLocus: any) => {
+  const thisDevice = MeetingsUtil.getThisDevice(newLocus);
+  if (thisDevice) {
+    if (!thisDevice.correlationId || meeting?.correlationId === thisDevice.correlationId) {
+      return (
+        thisDevice.state === _JOINED_ ||
+        (thisDevice.state === _LEFT_ && thisDevice.reason === _MOVED_)
+      );
+    }
+  }
+
+  return false;
+};
+
 export default MeetingsUtil;

package/src/members/collection.ts

@@ -37,4 +37,12 @@ export default class MembersCollection {
   getAll() {
     return this.members;
   }
+
+  /**
+   * @returns {void}
+   * reset members
+   */
+  reset() {
+    this.members = {};
+  }
 }

package/src/members/index.ts

@@ -283,6 +283,25 @@ export default class Members extends StatelessWebexPlugin {
     );
   }
 
+  /**
+   * clear member collection
+   * @returns {void}
+   * @private
+   * @memberof Members
+   */
+  clearMembers() {
+    this.membersCollection.reset();
+    Trigger.trigger(
+      this,
+      {
+        file: 'members',
+        function: 'clearMembers',
+      },
+      EVENT_TRIGGERS.MEMBERS_CLEAR,
+      {}
+    );
+  }
+
   /**
    * 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
@@ -292,8 +311,11 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object}) {
+  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
     if (payload) {
+      if (payload.isReplace) {
+        this.clearMembers();
+      }
       const delta = this.handleLocusInfoUpdatedParticipants(payload);
       const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
 
@@ -309,6 +331,7 @@ export default class Members extends StatelessWebexPlugin {
         {
           delta,
           full,
+          isReplace: !!payload.isReplace,
         }
       );
     }

package/test/unit/spec/breakouts/breakout.ts

@@ -20,6 +20,7 @@ describe('plugin-meetings', () => {
       breakout = new Breakout({}, {parent: breakouts});
       breakout.groupId = 'groupId';
       breakout.sessionId = 'sessionId';
+      breakout.sessionType = 'BREAKOUT';
       breakout.url = 'url';
       webex.request = sinon.stub().returns(Promise.resolve('REQUEST_RETURN_VALUE'));
     });
@@ -140,7 +141,7 @@ describe('plugin-meetings', () => {
 
         assert.calledOnceWithExactly(breakout.members.locusParticipantsUpdate, locusData);
         assert.equal(result, undefined);
-      });
-    });
+      })
+    })
   });
 });

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

@@ -292,6 +292,16 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#isActiveBreakout', () => {
+      it('return is current is breakout with active status', () => {
+        assert.equal(breakouts.isActiveBreakout, false);
+        breakouts.set('sessionType', BREAKOUTS.SESSION_TYPES.BREAKOUT);
+        assert.equal(breakouts.isActiveBreakout, false);
+        breakouts.set('status', BREAKOUTS.STATUS.OPEN);
+        assert.equal(breakouts.isActiveBreakout, true);
+      });
+    });
+
     describe('#queryRosters', () => {
       it('makes the expected query', async () => {
         webex.request.returns(

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

@@ -1,5 +1,6 @@
 import {assert} from '@webex/test-helper-chai';
 import ControlsUtils from '@webex/plugin-meetings/src/locus-info/controlsUtils';
+import controlsUtils from "@webex/plugin-meetings/src/locus-info/controlsUtils";
 
 const defaultControls = {
   entryExitTone: {
@@ -156,5 +157,25 @@ describe('plugin-meetings', () => {
         });
       });
     });
+
+    describe('isNeedReplaceMembers', () => {
+      it('if no breakout control, return false', () => {
+        const oldControls = {};
+        const newControls = {};
+        assert.equal(controlsUtils.isNeedReplaceMembers(oldControls, newControls), false);
+      });
+
+      it('if current session moved, return true', () => {
+        const oldControls = {breakout: {sessionId: 'sessionId1', groupId: 'groupId1'}};
+        const newControls = {breakout: {sessionId: 'sessionId2', groupId: 'groupId2'}};
+        assert.equal(controlsUtils.isNeedReplaceMembers(oldControls, newControls), true);
+      });
+
+      it('if in same session, return false', () => {
+        const oldControls = {breakout: {sessionId: 'sessionId1', groupId: 'groupId'}};
+        const newControls = {breakout: {sessionId: 'sessionId1', groupId: 'groupId'}};
+        assert.equal(controlsUtils.isNeedReplaceMembers(oldControls, newControls), false);
+      });
+    })
   });
 });

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

@@ -504,6 +504,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
@@ -511,6 +512,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;
 
@@ -1444,6 +1482,31 @@ 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);
+
+        fakeBreakout.sessionId = 'sessionId2';
+        locusInfo.onDeltaLocus(fakeLocus);
+        assert.calledWith(locusInfo.updateParticipants, {}, false);
+      });
     });
 
     describe('#handleOneonOneEvent', () => {

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

@@ -48,5 +48,19 @@ describe('plugin-meetings', () => {
         assert.deepEqual(meetingCollection.getByKey('value', 'test'), {value: 'test', id: uuid1});
       });
     });
+
+    describe('#getActiveBreakoutLocus', () => {
+      beforeEach(() => {
+        meetingCollection.meetings.test = {breakouts: {url: 'url', isActiveBreakout: true}, id: uuid1};
+      });
+      it('return null if empty breakoutUrl', () => {
+        assert.deepEqual(meetingCollection.getActiveBreakoutLocus(), null);
+      });
+
+      it('should get the meeting which joined breakout by breakoutUrl', () => {
+        assert.deepEqual(meetingCollection.getActiveBreakoutLocus('url'), {
+          breakouts: {url: 'url', isActiveBreakout: true}, id: uuid1});
+      });
+    });
   });
 });