@webex/plugin-meetings 3.0.0-beta.21 → 3.0.0-beta.211

package/src/locus-info/index.ts

@@ -1,4 +1,4 @@
-import {isEqual} from 'lodash';
+import {isEqual, assignWith, cloneDeep, isEmpty} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -17,8 +17,6 @@ import {
   CALL_REMOVED_REASON,
   RECORDING_STATE,
 } from '../constants';
-import Metrics from '../metrics';
-import {eventType} from '../metrics/config';
 import InfoUtils from './infoUtils';
 import FullState from './fullState';
 import SelfUtils from './selfUtils';
@@ -59,11 +57,19 @@ export default class LocusInfo extends EventsScope {
   fullState: any;
   host: any;
   info: any;
+  roles: any;
   mediaShares: any;
   replace: any;
   url: any;
   services: any;
-
+  mainSessionLocusCache: any;
+  /**
+   * Constructor
+   * @param {function} updateMeeting callback to update the meeting object from an object
+   * @param {object} webex
+   * @param {string} meetingId
+   * @returns {undefined}
+   */
   constructor(updateMeeting, webex, meetingId) {
     super();
     this.parsedLocus = {
@@ -77,6 +83,53 @@ export default class LocusInfo extends EventsScope {
     this.locusParser = new LocusDeltaParser();
   }
 
+  /**
+   * Does a Locus sync. It tries to get the latest delta DTO or if it can't, it falls back to getting the full Locus DTO.
+   *
+   * @param {Meeting} meeting
+   * @returns {undefined}
+   */
+  private doLocusSync(meeting: any) {
+    let isDelta;
+    let url;
+
+    if (this.locusParser.workingCopy.syncUrl) {
+      url = this.locusParser.workingCopy.syncUrl;
+      isDelta = true;
+    } else {
+      url = meeting.locusUrl;
+      isDelta = false;
+    }
+
+    LoggerProxy.logger.info(
+      `Locus-info:index#doLocusSync --> doing Locus sync (getting ${
+        isDelta ? 'delta' : 'full'
+      } DTO)`
+    );
+
+    // return value ignored on purpose
+    meeting.meetingRequest
+      .getLocusDTO({url})
+      .then((res) => {
+        if (isDelta) {
+          if (!isEmpty(res.body)) {
+            meeting.locusInfo.handleLocusDelta(res.body, meeting);
+          } else {
+            LoggerProxy.logger.info(
+              'Locus-info:index#doLocusSync --> received empty body from syncUrl, so we already have latest Locus DTO'
+            );
+          }
+        } else {
+          meeting.locusInfo.onFullLocus(res.body);
+        }
+      })
+      .finally(() => {
+        // Notify parser to resume processing delta events.
+        // Any deltas in the queue that have now been superseded by this sync will simply be ignored
+        this.locusParser.resume();
+      });
+  }
+
   /**
    * Apply locus delta data to meeting
    * @param {string} action Locus delta action
@@ -85,28 +138,18 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    */
   applyLocusDeltaData(action: string, locus: any, meeting: any) {
-    const {DESYNC, USE_CURRENT, USE_INCOMING} = LocusDeltaParser.loci;
+    const {DESYNC, USE_CURRENT, USE_INCOMING, WAIT} = LocusDeltaParser.loci;
 
     switch (action) {
       case USE_INCOMING:
         meeting.locusInfo.onDeltaLocus(locus);
         break;
       case USE_CURRENT:
-        meeting.locusDesync = false;
-        meeting.needToGetFullLocus = false;
+      case WAIT:
+        // do nothing
         break;
       case DESYNC:
-        meeting.meetingRequest
-          .getFullLocus({
-            desync: true,
-            locusUrl: meeting.locusUrl,
-          })
-          .then((res) => {
-            meeting.locusInfo.onFullLocus(res.body);
-            // Notify parser to resume processing delta events
-            // now that we have full locus from DESYNC.
-            this.locusParser.resume();
-          });
+        this.doLocusSync(meeting);
         break;
       default:
         LoggerProxy.logger.info(
@@ -172,12 +215,13 @@ export default class LocusInfo extends EventsScope {
      */
     this.deltaParticipants = [];
 
+    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);
     // For 1:1 space meeting the conversation Url does not exist in locus.conversation
     this.updateConversationUrl(locus.conversationUrl, locus.info);
-    this.updateControls(locus.controls);
+    this.updateControls(locus.controls, locus.self);
     this.updateLocusUrl(locus.url);
     this.updateFullState(locus.fullState);
     this.updateMeetingInfo(locus.info);
@@ -195,6 +239,7 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   initialSetup(locus: object) {
+    this.updateLocusCache(locus);
     this.onFullLocus(locus);
 
     // Change it to true after it receives it first locus object
@@ -210,7 +255,7 @@ export default class LocusInfo extends EventsScope {
   parse(meeting: any, data: any) {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     const {eventType} = data;
-
+    const locus = this.getTheLocusToUpdate(data.locus);
     LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
 
     switch (eventType) {
@@ -228,16 +273,16 @@ export default class LocusInfo extends EventsScope {
       case LOCUSEVENT.PARTICIPANT_DECLINED:
       case LOCUSEVENT.FLOOR_GRANTED:
       case LOCUSEVENT.FLOOR_RELEASED:
-        this.onFullLocus(data.locus, eventType);
+        this.onFullLocus(locus, eventType);
         break;
       case LOCUSEVENT.DIFFERENCE:
-        this.handleLocusDelta(data.locus, meeting);
+        this.handleLocusDelta(locus, meeting);
         break;
 
       default:
         // Why will there be a event with no eventType ????
         // we may not need this, we can get full locus
-        this.handleLocusDelta(data.locus, meeting);
+        this.handleLocusDelta(locus, meeting);
     }
   }
 
@@ -259,18 +304,27 @@ export default class LocusInfo extends EventsScope {
    * @returns {object} null
    * @memberof LocusInfo
    */
-  // eslint-disable-next-line @typescript-eslint/no-shadow
   onFullLocus(locus: any, eventType?: string) {
     if (!locus) {
       LoggerProxy.logger.error(
         'Locus-info:index#onFullLocus --> object passed as argument was invalid, continuing.'
       );
     }
+
+    if (!this.locusParser.isNewFullLocus(locus)) {
+      LoggerProxy.logger.info(
+        `Locus-info:index#onFullLocus --> ignoring old full locus DTO, eventType=${eventType}`
+      );
+
+      return;
+    }
+
     this.updateParticipantDeltas(locus.participants);
     this.scheduledMeeting = locus.meeting || null;
     this.participants = locus.participants;
+    const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants);
+    this.updateParticipants(locus.participants, isReplaceMembers);
     this.isMeetingActive();
     this.handleOneOnOneEvent(eventType);
     this.updateEmbeddedApps(locus.embeddedApps);
@@ -329,8 +383,9 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   onDeltaLocus(locus: any) {
+    const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants);
+    this.updateParticipants(locus.participants, isReplaceMembers);
     this.isMeetingActive();
   }
 
@@ -347,7 +402,7 @@ export default class LocusInfo extends EventsScope {
       return;
     }
 
-    this.updateControls(locus.controls);
+    this.updateControls(locus.controls, locus.self);
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateCreated(locus.created);
     this.updateFullState(locus.fullState);
@@ -418,10 +473,15 @@ export default class LocusInfo extends EventsScope {
         LoggerProxy.logger.warn(
           'Locus-info:index#isMeetingActive --> Call Ended, locus state is inactive.'
         );
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -440,9 +500,12 @@ export default class LocusInfo extends EventsScope {
           this.parsedLocus.self.state === MEETING_STATE.STATES.NOTIFIED ||
           this.parsedLocus.self.state === MEETING_STATE.STATES.JOINED)
       ) {
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {
@@ -464,10 +527,14 @@ export default class LocusInfo extends EventsScope {
           partner.state === MEETING_STATE.STATES.NOTIFIED ||
           partner.state === MEETING_STATE.STATES.IDLE) // Happens when user just joins and adds no Media
       ) {
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -490,9 +557,13 @@ export default class LocusInfo extends EventsScope {
         LoggerProxy.logger.warn(
           'Locus-info:index#isMeetingActive --> Meeting is ending due to inactive or terminating'
         );
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {
@@ -507,9 +578,13 @@ export default class LocusInfo extends EventsScope {
         );
       } else if (this.fullState && this.fullState.removed) {
         // user has been dropped from a meeting
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {
@@ -646,13 +721,13 @@ export default class LocusInfo extends EventsScope {
   }
 
   /**
-   *
+   * update meeting's members
    * @param {Object} participants new participants object
-   * @param {boolen} deltaParticpantFlag  delta event
+   * @param {Boolean} isReplace is replace the whole members
    * @returns {Array} updatedParticipants
    * @memberof LocusInfo
    */
-  updateParticipants(participants: object) {
+  updateParticipants(participants: object, isReplace?: boolean) {
     this.emitScoped(
       {
         file: 'locus-info',
@@ -665,16 +740,18 @@ export default class LocusInfo extends EventsScope {
         selfIdentity: this.parsedLocus.self && this.parsedLocus.self.selfIdentity,
         selfId: this.parsedLocus.self && this.parsedLocus.self.selfId,
         hostId: this.parsedLocus.host && this.parsedLocus.host.hostId,
+        isReplace,
       }
     );
   }
 
   /**
    * @param {Object} controls
+   * @param {Object} self
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateControls(controls: object) {
+  updateControls(controls: object, self: object) {
     if (controls && !isEqual(this.controls, controls)) {
       this.parsedLocus.controls = ControlsUtils.parse(controls);
       const {
@@ -685,10 +762,76 @@ export default class LocusInfo extends EventsScope {
           hasTranscribeChanged,
           hasEntryExitToneChanged,
           hasBreakoutChanged,
+          hasVideoEnabledChanged,
+          hasMuteOnEntryChanged,
+          hasShareControlChanged,
+          hasDisallowUnmuteChanged,
+          hasReactionsChanged,
+          hasReactionDisplayNamesChanged,
+          hasViewTheParticipantListChanged,
+          hasRaiseHandChanged,
+          hasVideoChanged,
+          hasInterpretationChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
 
+      if (hasMuteOnEntryChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_MUTE_ON_ENTRY_CHANGED,
+          {state: current.muteOnEntry}
+        );
+      }
+
+      if (hasShareControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_SHARE_CONTROL_CHANGED,
+          {state: current.shareControl}
+        );
+      }
+
+      if (hasDisallowUnmuteChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_DISALLOW_UNMUTE_CHANGED,
+          {state: current.disallowUnmute}
+        );
+      }
+
+      if (hasReactionsChanged || hasReactionDisplayNamesChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_REACTIONS_CHANGED,
+          {state: current.reactions}
+        );
+      }
+
+      if (hasViewTheParticipantListChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_VIEW_THE_PARTICIPANTS_LIST_CHANGED,
+          {state: current.viewTheParticipantList}
+        );
+      }
+
+      if (hasRaiseHandChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_RAISE_HAND_CHANGED,
+          {state: current.raiseHand}
+        );
+      }
+
+      if (hasVideoChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_VIDEO_CHANGED,
+          {state: current.video}
+        );
+      }
+
       if (hasRecordingChanged || hasRecordingPausedChanged) {
         let state = null;
 
@@ -750,7 +893,10 @@ export default class LocusInfo extends EventsScope {
 
       if (hasBreakoutChanged) {
         const {breakout} = current;
-
+        breakout.breakoutMoveId = SelfUtils.getReplacedBreakoutMoveId(
+          self,
+          this.webex.internal.device.url
+        );
         this.emitScoped(
           {
             file: 'locus-info',
@@ -763,9 +909,25 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasInterpretationChanged) {
+        const {interpretation} = current;
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_INTERPRETATION_UPDATED,
+          {
+            interpretation,
+          }
+        );
+      }
+
       if (hasEntryExitToneChanged) {
         const {entryExitTone} = current;
 
+        this.updateMeeting({entryExitTone});
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -776,8 +938,26 @@ export default class LocusInfo extends EventsScope {
             entryExitTone,
           }
         );
+      }
 
-        this.updateMeeting({entryExitTone});
+      // videoEnabled is handled differently than other controls,
+      // to fit with audio mute status logic
+      if (hasVideoEnabledChanged) {
+        const {videoEnabled} = current;
+
+        this.updateMeeting({unmuteVideoAllowed: videoEnabled});
+
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+          {
+            // muted: not part of locus.controls
+            unmuteAllowed: videoEnabled,
+          }
+        );
       }
 
       this.controls = controls;
@@ -918,20 +1098,14 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   updateMeetingInfo(info: object, self?: object) {
-    if (info && !isEqual(this.info, info)) {
-      const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
+    const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
+    if (
+      (info && !isEqual(this.info, info)) ||
+      (roles.length && !isEqual(this.roles, roles) && info)
+    ) {
       const isJoined = SelfUtils.isJoined(self || this.parsedLocus.self);
       const parsedInfo = InfoUtils.getInfos(this.parsedLocus.info, info, roles, isJoined);
 
-      this.emitScoped(
-        {
-          file: 'locus-info',
-          function: 'updateMeetingInfo',
-        },
-        LOCUSINFO.EVENTS.MEETING_INFO_UPDATED,
-        {info: parsedInfo.current, self}
-      );
-
       if (parsedInfo.updates.isLocked) {
         this.emitScoped(
           {
@@ -957,7 +1131,16 @@ export default class LocusInfo extends EventsScope {
       this.parsedLocus.info = parsedInfo.current;
       // Parses the info and adds necessary values
       this.updateMeeting(parsedInfo.current);
+
+      this.emitScoped(
+        {
+          file: 'locus-info',
+          function: 'updateMeetingInfo',
+        },
+        LOCUSINFO.EVENTS.MEETING_INFO_UPDATED
+      );
     }
+    this.roles = roles;
   }
 
   /**
@@ -998,6 +1181,8 @@ export default class LocusInfo extends EventsScope {
       const parsedMediaShares = MediaSharesUtils.getMediaShares(this.mediaShares, mediaShares);
 
       this.updateMeeting(parsedMediaShares.current);
+      this.parsedLocus.mediaShares = parsedMediaShares.current;
+      this.mediaShares = mediaShares;
       this.emitScoped(
         {
           file: 'locus-info',
@@ -1009,8 +1194,6 @@ export default class LocusInfo extends EventsScope {
           previous: parsedMediaShares.previous,
         }
       );
-      this.parsedLocus.mediaShares = parsedMediaShares.current;
-      this.mediaShares = mediaShares;
     }
   }
 
@@ -1099,6 +1282,20 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (parsedSelves.updates.interpretationChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MEETING_INTERPRETATION_CHANGED,
+          {
+            interpretation: parsedSelves.current.interpretation,
+            selfParticipantId: parsedSelves.current.selfId,
+          }
+        );
+      }
+
       if (parsedSelves.updates.isMediaInactiveOrReleased) {
         this.emitScoped(
           {
@@ -1120,6 +1317,31 @@ export default class LocusInfo extends EventsScope {
           self
         );
       }
+
+      if (parsedSelves.updates.isRolesChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_ROLES_CHANGED,
+          {oldRoles: parsedSelves.previous?.roles, newRoles: parsedSelves.current?.roles}
+        );
+      }
+
+      if (parsedSelves.updates.isVideoMutedByOthersChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+          {
+            muted: parsedSelves.current.remoteVideoMuted,
+            // unmuteAllowed: not part of .self
+          }
+        );
+      }
       if (parsedSelves.updates.localAudioUnmuteRequiredByServer) {
         this.emitScoped(
           {
@@ -1334,4 +1556,104 @@ export default class LocusInfo extends EventsScope {
       this.identities = identities;
     }
   }
+
+  /**
+   * check the locus is main session's one or not, if is main session's, update main session cache
+   * @param {Object} locus
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  updateLocusCache(locus: any) {
+    const isMainSessionDTO = ControlsUtils.isMainSessionDTO(locus);
+    if (isMainSessionDTO) {
+      this.updateMainSessionLocusCache(locus);
+    }
+  }
+
+  /**
+   * if return from breakout to main session, need to use cached main session DTO since locus won't send the full locus (participants)
+   * if join breakout from main session, need to query main locus url (if response with 403 means no privilege, need to clear the cache)
+   * @param {Object} newLocus
+   * @returns {Object}
+   * @memberof LocusInfo
+   */
+  getTheLocusToUpdate(newLocus: any) {
+    const switchStatus = ControlsUtils.getSessionSwitchStatus(this.controls, newLocus?.controls);
+    if (switchStatus.isReturnToMain && this.mainSessionLocusCache) {
+      return cloneDeep(this.mainSessionLocusCache);
+    }
+    if (switchStatus.isJoinToBreakout) {
+      this.emitScoped(
+        {
+          file: 'locus-info',
+          function: 'updateControls',
+        },
+        LOCUSINFO.EVENTS.CONTROLS_JOIN_BREAKOUT_FROM_MAIN,
+        {
+          mainLocusUrl: this.url,
+        }
+      );
+    }
+
+    return newLocus;
+  }
+
+  /**
+   * merge participants by participant id
+   * @param {Array} participants
+   * @param {Array} sourceParticipants
+   * @returns {Array} merged participants
+   * @memberof LocusInfo
+   */
+  // eslint-disable-next-line class-methods-use-this
+  mergeParticipants(participants, sourceParticipants) {
+    if (!sourceParticipants || !sourceParticipants.length) return participants;
+    if (!participants || !participants.length) {
+      return sourceParticipants;
+    }
+    sourceParticipants.forEach((participant) => {
+      const existIndex = participants.findIndex((p) => p.id === participant.id);
+      if (existIndex > -1) {
+        participants.splice(existIndex, 1, participant);
+      } else {
+        participants.push(participant);
+      }
+    });
+
+    return participants;
+  }
+
+  /**
+   * need cache main sessions' participants since locus will not send the full list when cohost/host leave breakout
+   * @param {Object} mainLocus
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  updateMainSessionLocusCache(mainLocus: any) {
+    if (!mainLocus) {
+      return;
+    }
+    const locusClone = cloneDeep(mainLocus);
+    if (this.mainSessionLocusCache) {
+      // shallow merge and do special merge for participants
+      assignWith(this.mainSessionLocusCache, locusClone, (objValue, srcValue, key) => {
+        if (key === 'participants') {
+          return this.mergeParticipants(objValue, srcValue);
+        }
+
+        return srcValue || objValue;
+      });
+    } else {
+      this.mainSessionLocusCache = locusClone;
+    }
+  }
+
+  /**
+   * clear main session cache
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  clearMainSessionLocusCache() {
+    this.mainSessionLocusCache = null;
+  }
 }