@webex/plugin-meetings 3.0.0-beta.15 → 3.0.0-beta.151

package/src/locus-info/controlsUtils.ts

@@ -1,4 +1,5 @@
 import {isEqual} from 'lodash';
+import {BREAKOUTS} from '../constants';
 
 const ControlsUtils: any = {};
 
@@ -48,6 +49,41 @@ ControlsUtils.parse = (controls: any) => {
       : null;
   }
 
+  if (controls && controls.video) {
+    parsedControls.videoEnabled = controls.video.enabled;
+  }
+
+  if (controls?.muteOnEntry) {
+    parsedControls.muteOnEntry = {enabled: controls.muteOnEntry.enabled};
+  }
+
+  if (controls?.shareControl) {
+    parsedControls.shareControl = {control: controls.shareControl.control};
+  }
+
+  if (controls?.disallowUnmute) {
+    parsedControls.disallowUnmute = {enabled: controls.disallowUnmute.enabled};
+  }
+
+  if (controls?.reactions) {
+    parsedControls.reactions = {
+      enabled: controls.reactions.enabled,
+      showDisplayNameWithReactions: controls.reactions.showDisplayNameWithReactions,
+    };
+  }
+
+  if (controls?.viewTheParticipantList) {
+    parsedControls.viewTheParticipantList = {enabled: controls.viewTheParticipantList.enabled};
+  }
+
+  if (controls?.raiseHand) {
+    parsedControls.raiseHand = {enabled: controls.raiseHand.enabled};
+  }
+
+  if (controls?.video) {
+    parsedControls.video = {enabled: controls.video.enabled};
+  }
+
   return parsedControls;
 };
 
@@ -65,6 +101,26 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
     previous,
     current,
     updates: {
+      hasMuteOnEntryChanged: current?.muteOnEntry?.enabled !== previous?.muteOnEntry?.enabled,
+
+      hasShareControlChanged: current?.shareControl?.control !== previous?.shareControl?.control,
+
+      hasDisallowUnmuteChanged:
+        current?.disallowUnmute?.enabled !== previous?.disallowUnmute?.enabled,
+
+      hasReactionsChanged: current?.reactions?.enabled !== previous?.reactions?.enabled,
+
+      hasReactionDisplayNamesChanged:
+        current?.reactions?.showDisplayNameWithReactions !==
+        previous?.reactions?.showDisplayNameWithReactions,
+
+      hasViewTheParticipantListChanged:
+        current?.viewTheParticipantList?.enabled !== previous?.viewTheParticipantList?.enabled,
+
+      hasRaiseHandChanged: current?.raiseHand?.enabled !== previous?.raiseHand?.enabled,
+
+      hasVideoChanged: current?.video?.enabled !== previous?.video?.enabled,
+
       hasRecordingPausedChanged:
         current?.record &&
         !isEqual(previous?.record?.paused, current.record.paused) &&
@@ -92,6 +148,12 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
         !isEqual(previous?.entryExitTone, current?.entryExitTone) &&
         (previous?.entryExitTone || current?.entryExitTone)
       ),
+
+      hasBreakoutChanged: !isEqual(previous?.breakout, current?.breakout),
+
+      hasVideoEnabledChanged:
+        newControls.video?.enabled !== undefined &&
+        !isEqual(previous?.videoEnabled, current?.videoEnabled),
     },
   };
 };
@@ -109,4 +171,50 @@ ControlsUtils.getId = (controls: any) => {
   return null;
 };
 
+/**
+ * check whether to replace the meeting's members or not.
+ * For case joined breakout session, need replace meeting's members
+ * @param {LocusControls} oldControls
+ * @param {LocusControls} controls
+ * @returns {Boolean}
+ */
+ControlsUtils.isNeedReplaceMembers = (oldControls: any, controls: any) => {
+  // no breakout case
+  if (!oldControls?.breakout || !controls?.breakout) {
+    return false;
+  }
+
+  return (
+    oldControls.breakout.groupId !== controls.breakout.groupId ||
+    oldControls.breakout.sessionId !== controls.breakout.sessionId
+  );
+};
+
+/**
+ * determine the switch status between breakout session and main session.
+ * @param {LocusControls} oldControls
+ * @param {LocusControls} controls
+ * @returns {Object}
+ */
+ControlsUtils.getSessionSwitchStatus = (oldControls: any, controls: any) => {
+  const status = {isReturnToMain: false, isJoinToBreakout: false};
+  // no breakout case
+  if (!oldControls?.breakout || !controls?.breakout) {
+    return status;
+  }
+
+  status.isReturnToMain =
+    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+  status.isJoinToBreakout =
+    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+
+  return status;
+};
+
+ControlsUtils.isMainSessionDTO = (locus: any) => {
+  return locus?.controls?.breakout?.sessionType !== BREAKOUTS.SESSION_TYPES.BREAKOUT;
+};
+
 export default ControlsUtils;

package/src/locus-info/index.ts

@@ -1,4 +1,4 @@
-import {isEqual} from 'lodash';
+import {isEqual, assignWith, cloneDeep} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -59,10 +59,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 {boolean} updateMeeting true if the meeting should be updated
+   * @param {object} webex
+   * @param {string} meetingId
+   * @returns {undefined}
+   */
   constructor(updateMeeting, webex, meetingId) {
     super();
     this.parsedLocus = {
@@ -98,7 +107,7 @@ export default class LocusInfo extends EventsScope {
         meeting.meetingRequest
           .getFullLocus({
             desync: true,
-            locusUrl: meeting.locusUrl,
+            locusUrl: locus.url ? locus.url : meeting.locusUrl,
           })
           .then((res) => {
             meeting.locusInfo.onFullLocus(res.body);
@@ -171,12 +180,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);
@@ -185,6 +195,7 @@ export default class LocusInfo extends EventsScope {
     this.updateSelf(locus.self, locus.participants);
     this.updateHostInfo(locus.host);
     this.updateMediaShares(locus.mediaShares);
+    this.updateServices(locus.links?.services);
   }
 
   /**
@@ -193,6 +204,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
@@ -208,7 +220,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) {
@@ -226,16 +238,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);
     }
   }
 
@@ -267,8 +279,9 @@ export default class LocusInfo extends EventsScope {
     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);
@@ -327,8 +340,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();
   }
 
@@ -337,8 +351,15 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateLocusInfo(locus: any) {
-    this.updateControls(locus.controls);
+  updateLocusInfo(locus) {
+    if (locus.self?.reason === 'MOVED' && locus.self?.state === 'LEFT') {
+      // When moved to a breakout session locus sends a message for the previous locus
+      // indicating that we have been moved. It isn't helpful to continue parsing this
+      // as it gets interpreted as if we have left the call
+      return;
+    }
+
+    this.updateControls(locus.controls, locus.self);
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateCreated(locus.created);
     this.updateFullState(locus.fullState);
@@ -355,6 +376,7 @@ export default class LocusInfo extends EventsScope {
     this.updateMemberShip(locus.membership);
     this.updateIdentifiers(locus.identities);
     this.updateEmbeddedApps(locus.embeddedApps);
+    this.updateServices(locus.links?.services);
     this.compareAndUpdate();
     // update which required to compare different objects from locus
   }
@@ -636,13 +658,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',
@@ -655,16 +677,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 {
@@ -674,10 +698,76 @@ export default class LocusInfo extends EventsScope {
           hasMeetingContainerChanged,
           hasTranscribeChanged,
           hasEntryExitToneChanged,
+          hasBreakoutChanged,
+          hasVideoEnabledChanged,
+          hasMuteOnEntryChanged,
+          hasShareControlChanged,
+          hasDisallowUnmuteChanged,
+          hasReactionsChanged,
+          hasReactionDisplayNamesChanged,
+          hasViewTheParticipantListChanged,
+          hasRaiseHandChanged,
+          hasVideoChanged,
         },
         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;
 
@@ -737,9 +827,29 @@ 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',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_BREAKOUT_UPDATED,
+          {
+            breakout,
+          }
+        );
+      }
+
       if (hasEntryExitToneChanged) {
         const {entryExitTone} = current;
 
+        this.updateMeeting({entryExitTone});
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -750,8 +860,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;
@@ -789,6 +917,27 @@ export default class LocusInfo extends EventsScope {
     }
   }
 
+  /**
+   * @param {Object} services
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  updateServices(services: Record<'breakout' | 'record', {url: string}>) {
+    if (services && !isEqual(this.services, services)) {
+      this.services = services;
+      this.emitScoped(
+        {
+          file: 'locus-info',
+          function: 'updateServices',
+        },
+        LOCUSINFO.EVENTS.LINKS_SERVICES,
+        {
+          services,
+        }
+      );
+    }
+  }
+
   /**
    * @param {Object} fullState
    * @returns {undefined}
@@ -871,8 +1020,11 @@ 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);
 
@@ -911,6 +1063,7 @@ export default class LocusInfo extends EventsScope {
       // Parses the info and adds necessary values
       this.updateMeeting(parsedInfo.current);
     }
+    this.roles = roles;
   }
 
   /**
@@ -951,6 +1104,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',
@@ -962,8 +1117,6 @@ export default class LocusInfo extends EventsScope {
           previous: parsedMediaShares.previous,
         }
       );
-      this.parsedLocus.mediaShares = parsedMediaShares.current;
-      this.mediaShares = mediaShares;
     }
   }
 
@@ -1041,6 +1194,17 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (parsedSelves.updates.breakoutsChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MEETING_BREAKOUTS_CHANGED,
+          {breakoutSessions: parsedSelves.current.breakoutSessions}
+        );
+      }
+
       if (parsedSelves.updates.isMediaInactiveOrReleased) {
         this.emitScoped(
           {
@@ -1062,6 +1226,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(
           {
@@ -1276,4 +1465,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;
+  }
 }