@webex/plugin-meetings 3.0.0-beta.9 → 3.0.0-beta.90

package/src/locus-info/index.ts

@@ -1,4 +1,4 @@
-import {isEqual} from 'lodash';
+import {isArray, isEqual, mergeWith, cloneDeep} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -19,14 +19,14 @@ import {
 } from '../constants';
 import Metrics from '../metrics';
 import {eventType} from '../metrics/config';
-import InfoUtils from '../locus-info/infoUtils';
-import FullState from '../locus-info/fullState';
-import SelfUtils from '../locus-info/selfUtils';
-import HostUtils from '../locus-info/hostUtils';
-import ControlsUtils from '../locus-info/controlsUtils';
-import EmbeddedAppsUtils from '../locus-info/embeddedAppsUtils';
-import MediaSharesUtils from '../locus-info/mediaSharesUtils';
-import LocusDeltaParser from '../locus-info/parser';
+import InfoUtils from './infoUtils';
+import FullState from './fullState';
+import SelfUtils from './selfUtils';
+import HostUtils from './hostUtils';
+import ControlsUtils from './controlsUtils';
+import EmbeddedAppsUtils from './embeddedAppsUtils';
+import MediaSharesUtils from './mediaSharesUtils';
+import LocusDeltaParser from './parser';
 
 /**
  * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
@@ -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 = {
@@ -171,6 +180,7 @@ 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);
@@ -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
@@ -206,8 +218,9 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   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) {
@@ -225,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);
     }
   }
 
@@ -256,6 +269,7 @@ 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(
@@ -265,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);
@@ -280,6 +295,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
+  // eslint-disable-next-line @typescript-eslint/no-shadow
   handleOneOnOneEvent(eventType: string) {
     if (
       this.parsedLocus.fullState.type === _CALL_ ||
@@ -324,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();
   }
 
@@ -334,7 +351,14 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateLocusInfo(locus: any) {
+  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);
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateCreated(locus.created);
@@ -352,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
   }
@@ -373,7 +398,7 @@ export default class LocusInfo extends EventsScope {
           self &&
           participant.identity !== self.identity &&
           (participants.length <= 2 || (participant.type === _USER_ && !participant.removed))
-      // @ts-ignore
+        // @ts-ignore
       ) || this.partner
     );
   }
@@ -420,8 +445,7 @@ export default class LocusInfo extends EventsScope {
             shouldLeave: false,
           }
         );
-      }
-      else if (
+      } else if (
         partner.state === MEETING_STATE.STATES.LEFT &&
         this.parsedLocus.self &&
         (this.parsedLocus.self.state === MEETING_STATE.STATES.DECLINED ||
@@ -444,8 +468,7 @@ export default class LocusInfo extends EventsScope {
               this.parsedLocus.self.joinedWith && this.parsedLocus.self.joinedWith.state !== _LEFT_,
           }
         );
-      }
-      else if (
+      } else if (
         this.parsedLocus.self &&
         this.parsedLocus.self.state === MEETING_STATE.STATES.LEFT &&
         (partner.state === MEETING_STATE.STATES.LEFT ||
@@ -469,8 +492,7 @@ export default class LocusInfo extends EventsScope {
           }
         );
       }
-    }
-    else if (this.parsedLocus.fullState.type === _MEETING_) {
+    } else if (this.parsedLocus.fullState.type === _MEETING_) {
       if (
         this.fullState &&
         (this.fullState.state === LOCUS.STATE.INACTIVE ||
@@ -495,8 +517,7 @@ export default class LocusInfo extends EventsScope {
             shouldLeave: false,
           }
         );
-      }
-      else if (this.fullState && this.fullState.removed) {
+      } else if (this.fullState && this.fullState.removed) {
         // user has been dropped from a meeting
         Metrics.postEvent({
           event: eventType.REMOTE_ENDED,
@@ -530,8 +551,7 @@ export default class LocusInfo extends EventsScope {
           }
         );
       }
-    }
-    else {
+    } else {
       LoggerProxy.logger.warn('Locus-info:index#isMeetingActive --> Meeting Type is unknown.');
     }
   }
@@ -574,8 +594,7 @@ export default class LocusInfo extends EventsScope {
           canAssignHost: true,
         }
       );
-    }
-    else {
+    } else {
       this.emitScoped(
         {
           file: 'locus-info',
@@ -639,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',
@@ -658,6 +677,7 @@ 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,
       }
     );
   }
@@ -677,6 +697,8 @@ export default class LocusInfo extends EventsScope {
           hasMeetingContainerChanged,
           hasTranscribeChanged,
           hasEntryExitToneChanged,
+          hasBreakoutChanged,
+          hasVideoEnabledChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -687,13 +709,11 @@ export default class LocusInfo extends EventsScope {
         if (hasRecordingPausedChanged) {
           if (current.record.paused) {
             state = RECORDING_STATE.PAUSED;
-          }
-          else {
+          } else {
             // state will be `IDLE` if the recording is not active, even when there is a `pause` status change.
             state = current.record.recording ? RECORDING_STATE.RESUMED : RECORDING_STATE.IDLE;
           }
-        }
-        else if (hasRecordingChanged) {
+        } else if (hasRecordingChanged) {
           state = current.record.recording ? RECORDING_STATE.RECORDING : RECORDING_STATE.IDLE;
         }
 
@@ -742,9 +762,26 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasBreakoutChanged) {
+        const {breakout} = current;
+
+        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',
@@ -752,11 +789,29 @@ export default class LocusInfo extends EventsScope {
           },
           LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
           {
-            entryExitTone
+            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;
@@ -773,8 +828,7 @@ export default class LocusInfo extends EventsScope {
     if (conversationUrl && !isEqual(this.conversationUrl, conversationUrl)) {
       this.conversationUrl = conversationUrl;
       this.updateMeeting({conversationUrl});
-    }
-    else if (
+    } else if (
       info &&
       info.conversationUrl &&
       !isEqual(this.conversationUrl, info.conversationUrl)
@@ -795,6 +849,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}
@@ -865,8 +940,7 @@ export default class LocusInfo extends EventsScope {
         );
       }
       this.host = host;
-    }
-    else {
+    } else {
       this.compareAndUpdateFlags.compareSelfAndHost = false;
     }
   }
@@ -878,8 +952,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);
 
@@ -918,6 +995,7 @@ export default class LocusInfo extends EventsScope {
       // Parses the info and adds necessary values
       this.updateMeeting(parsedInfo.current);
     }
+    this.roles = roles;
   }
 
   /**
@@ -958,6 +1036,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',
@@ -969,8 +1049,6 @@ export default class LocusInfo extends EventsScope {
           previous: parsedMediaShares.previous,
         }
       );
-      this.parsedLocus.mediaShares = parsedMediaShares.current;
-      this.mediaShares = mediaShares;
     }
   }
 
@@ -1033,8 +1111,7 @@ export default class LocusInfo extends EventsScope {
 
       if (parsedSelves.updates.moderatorChanged) {
         this.compareAndUpdateFlags.compareHostAndSelf = true;
-      }
-      else {
+      } else {
         this.compareAndUpdateFlags.compareHostAndSelf = false;
       }
 
@@ -1049,6 +1126,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(
           {
@@ -1070,6 +1158,31 @@ export default class LocusInfo extends EventsScope {
           self
         );
       }
+      // When the user upgrades to moderator or cohost
+      if (parsedSelves.updates.isUpgradeToModeratorOrCohost) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MODERATOR_OR_COHOST_UPGRADE,
+          self
+        );
+      }
+      //
+      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(
           {
@@ -1204,8 +1317,7 @@ export default class LocusInfo extends EventsScope {
       this.parsedLocus.self = parsedSelves.current;
       // @ts-ignore
       this.self = self;
-    }
-    else {
+    } else {
       this.compareAndUpdateFlags.compareHostAndSelf = false;
     }
   }
@@ -1285,4 +1397,106 @@ 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) {
+      // eslint-disable-next-line consistent-return
+      mergeWith(this.mainSessionLocusCache, locusClone, (objValue, srcValue, key) => {
+        if (isArray(objValue)) {
+          if (key === 'participants') {
+            return this.mergeParticipants(objValue, srcValue);
+          }
+
+          return srcValue; // just replace the old ones
+        }
+      });
+    } else {
+      this.mainSessionLocusCache = locusClone;
+    }
+  }
+
+  /**
+   * clear main session cache
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  clearMainSessionLocusCache() {
+    this.mainSessionLocusCache = null;
+  }
 }

package/src/locus-info/infoUtils.ts

@@ -29,13 +29,22 @@ InfoUtils.parse = (info, roles, isJoined = true) => {
     parsed.meetingNumber = info.meetingId;
   }
 
+  if (info.datachannelUrl) {
+    parsed.datachannelUrl = info.datachannelUrl;
+  }
+
   return parsed;
 };
 
 InfoUtils.parseDisplayHintSection = (info, displayHintKey) => {
   const displayHints = {};
 
-  if (info && info.displayHints && info.displayHints[displayHintKey] && info.displayHints[displayHintKey].length > 0) {
+  if (
+    info &&
+    info.displayHints &&
+    info.displayHints[displayHintKey] &&
+    info.displayHints[displayHintKey].length > 0
+  ) {
     info.displayHints[displayHintKey].forEach((key) => {
       displayHints[key] = true;
     });
@@ -75,10 +84,13 @@ InfoUtils.getInfos = (oldInfo, newInfo, roles, isJoined) => {
     current.isLocked = InfoUtils.isLocked(current.policy);
     current.isUnlocked = InfoUtils.isUnlocked(current.policy);
 
-    if (previous && previous.isUnlocked && current.isLocked || !previous && current.isLocked) {
+    if ((previous && previous.isUnlocked && current.isLocked) || (!previous && current.isLocked)) {
       updates.isLocked = current.isLocked;
     }
-    if (previous && previous.isLocked && current.isUnlocked || !previous && current.isUnlocked) {
+    if (
+      (previous && previous.isLocked && current.isUnlocked) ||
+      (!previous && current.isUnlocked)
+    ) {
       updates.isUnlocked = current.isUnlocked;
     }
   }
@@ -86,7 +98,7 @@ InfoUtils.getInfos = (oldInfo, newInfo, roles, isJoined) => {
   return {
     previous,
     current,
-    updates
+    updates,
   };
 };
 

package/src/locus-info/mediaSharesUtils.ts

@@ -12,13 +12,13 @@ MediaSharesUtils.parse = (mediaShares: object) => {
     return {
       content: {
         beneficiaryId: MediaSharesUtils.getContentBeneficiaryId(mediaShares),
-        disposition: MediaSharesUtils.getContentDisposition(mediaShares)
+        disposition: MediaSharesUtils.getContentDisposition(mediaShares),
       },
       whiteboard: {
         beneficiaryId: MediaSharesUtils.getWhiteboardBeneficiaryId(mediaShares),
         disposition: MediaSharesUtils.getWhiteboardDisposition(mediaShares),
-        resourceUrl: MediaSharesUtils.getWhiteboardResourceUrl(mediaShares)
-      }
+        resourceUrl: MediaSharesUtils.getWhiteboardResourceUrl(mediaShares),
+      },
     };
   }
 
@@ -38,7 +38,7 @@ MediaSharesUtils.getMediaShares = (oldShare: object, newShare: object) => {
 
   return {
     previous,
-    current
+    current,
   };
 };