@webex/plugin-meetings 3.8.0-next.8 → 3.8.0-next.81

package/src/controls-options-manager/util.ts

@@ -7,6 +7,8 @@ import {
   ReactionsProperties,
   ViewTheParticipantListProperties,
   VideoProperties,
+  type RemoteDesktopControlProperties,
+  type AnnotationProperties,
 } from './types';
 
 /**
@@ -256,6 +258,52 @@ class Utils {
     return Utils.hasHints({requiredHints, displayHints});
   }
 
+  /**
+   * Validate if a annotation-scoped control is allowed to be sent to the service.
+   *
+   * @param {ControlConfig<AnnotationProperties>} control - Annotation control config to validate
+   * @param {Array<string>} displayHints - All available hints
+   * @returns {boolean} - True if all of the actions are allowed.
+   */
+  public static canUpdateAnnotation(
+    control: ControlConfig<AnnotationProperties>,
+    displayHints: Array<string>
+  ): boolean {
+    const requiredHints = [];
+
+    if (control.properties.enabled === true) {
+      requiredHints.push(DISPLAY_HINTS.ENABLE_ANNOTATION_MEETING_OPTION);
+    }
+    if (control.properties.enabled === false) {
+      requiredHints.push(DISPLAY_HINTS.DISABLE_ANNOTATION_MEETING_OPTION);
+    }
+
+    return Utils.hasHints({requiredHints, displayHints});
+  }
+
+  /**
+   * Validate if a rdc-scoped control is allowed to be sent to the service.
+   *
+   * @param {ControlConfig<RemoteDesktopControlProperties>} control - Remote Desktop Control config to validate
+   * @param {Array<string>} displayHints - All available hints
+   * @returns {boolean} - True if all of the actions are allowed.
+   */
+  public static canUpdateRemoteDesktopControl(
+    control: ControlConfig<RemoteDesktopControlProperties>,
+    displayHints: Array<string>
+  ): boolean {
+    const requiredHints = [];
+
+    if (control.properties.enabled === true) {
+      requiredHints.push(DISPLAY_HINTS.ENABLE_RDC_MEETING_OPTION);
+    }
+    if (control.properties.enabled === false) {
+      requiredHints.push(DISPLAY_HINTS.DISABLE_RDC_MEETING_OPTION);
+    }
+
+    return Utils.hasHints({requiredHints, displayHints});
+  }
+
   /**
    * Validate that a control can be sent to the service based on the provided
    * display hints.
@@ -301,6 +349,20 @@ class Utils {
         );
         break;
 
+      case Control.annotation:
+        determinant = Utils.canUpdateAnnotation(
+          control as ControlConfig<AnnotationProperties>,
+          displayHints
+        );
+        break;
+
+      case Control.rdc:
+        determinant = Utils.canUpdateRemoteDesktopControl(
+          control as ControlConfig<RemoteDesktopControlProperties>,
+          displayHints
+        );
+        break;
+
       default:
         determinant = false;
     }

package/src/locus-info/controlsUtils.ts

@@ -1,5 +1,5 @@
 import {isEqual} from 'lodash';
-import {BREAKOUTS} from '../constants';
+import {BREAKOUTS, MEETING_STATE} from '../constants';
 
 const ControlsUtils: any = {};
 
@@ -111,6 +111,18 @@ ControlsUtils.parse = (controls: any) => {
     };
   }
 
+  if (controls?.annotationControl) {
+    parsedControls.annotationControl = {
+      enabled: controls.annotationControl.enabled,
+    };
+  }
+
+  if (controls?.rdcControl) {
+    parsedControls.rdcControl = {
+      enabled: controls.rdcControl.enabled,
+    };
+  }
+
   return parsedControls;
 };
 
@@ -206,11 +218,17 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
         ),
 
       hasPracticeSessionEnabledChanged: !isEqual(
-        previous?.practiceSession?.enabled,
-        current?.practiceSession?.enabled
+        !!previous?.practiceSession?.enabled,
+        !!current?.practiceSession?.enabled
       ),
 
       hasStageViewChanged: !isEqual(previous?.videoLayout, current?.videoLayout),
+
+      hasAnnotationControlChanged:
+        current?.annotationControl?.enabled !== previous?.annotationControl?.enabled,
+
+      hasRemoteDesktopControlChanged:
+        current?.rdcControl?.enabled !== previous?.rdcControl?.enabled,
     },
   };
 };
@@ -242,30 +260,42 @@ ControlsUtils.isNeedReplaceMembers = (oldControls: any, controls: any) => {
   }
 
   return (
-    oldControls.breakout.groupId !== controls.breakout.groupId ||
-    oldControls.breakout.sessionId !== controls.breakout.sessionId
+    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
+ * @param {LocusInfo} oldLocus
+ * @param {LocusInfo} newLocus
  * @returns {Object}
  */
-ControlsUtils.getSessionSwitchStatus = (oldControls: any, controls: any) => {
+ControlsUtils.getSessionSwitchStatus = (oldLocus: any, newLocus: any) => {
   const status = {isReturnToMain: false, isJoinToBreakout: false};
   // no breakout case
-  if (!oldControls?.breakout || !controls?.breakout) {
+  if (!oldLocus.controls?.breakout || !newLocus.controls?.breakout) {
     return status;
   }
 
-  status.isReturnToMain =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+  // It is used to fix the timing issue triggered when the creator leaves session to ensure that the member list is complete
+  const needUseCache = !!(
+    oldLocus.self?.isCreator &&
+    newLocus.participants?.length === 1 &&
+    newLocus.participants?.[0].isCreator &&
+    newLocus.participants?.[0].state === MEETING_STATE.STATES.JOINED &&
+    newLocus.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls?.breakout?.groups?.length
+  );
+
+  const isReturnToMain =
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+
+  status.isReturnToMain = needUseCache || isReturnToMain;
   status.isJoinToBreakout =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
 
   return status;
 };

package/src/locus-info/index.ts

@@ -1,4 +1,4 @@
-import {isEqual, assignWith, cloneDeep, isEmpty} from 'lodash';
+import {isEqual, assignWith, cloneDeep, isEmpty, forEach} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -17,7 +17,9 @@ import {
   MEETING_REMOVED_REASON,
   CALL_REMOVED_REASON,
   RECORDING_STATE,
+  BREAKOUTS,
 } from '../constants';
+
 import InfoUtils from './infoUtils';
 import FullState from './fullState';
 import SelfUtils from './selfUtils';
@@ -67,6 +69,7 @@ export default class LocusInfo extends EventsScope {
   services: any;
   resources: any;
   mainSessionLocusCache: any;
+  self: any;
   /**
    * Constructor
    * @param {function} updateMeeting callback to update the meeting object from an object
@@ -261,7 +264,7 @@ export default class LocusInfo extends EventsScope {
     this.updateMeetingInfo(locus.info);
     this.updateEmbeddedApps(locus.embeddedApps);
     // self and participants generate sipUrl for 1:1 meeting
-    this.updateSelf(locus.self, locus.participants);
+    this.updateSelf(locus.self);
     this.updateHostInfo(locus.host);
     this.updateMediaShares(locus.mediaShares);
     this.updateServices(locus.links?.services);
@@ -419,6 +422,7 @@ export default class LocusInfo extends EventsScope {
    */
   onDeltaLocus(locus: any) {
     const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
+    this.mergeParticipants(this.participants, locus.participants);
     this.updateLocusInfo(locus);
     this.updateParticipants(locus.participants, isReplaceMembers);
     this.isMeetingActive();
@@ -446,7 +450,7 @@ export default class LocusInfo extends EventsScope {
     this.updateMediaShares(locus.mediaShares);
     this.updateParticipantsUrl(locus.participantsUrl);
     this.updateReplace(locus.replace);
-    this.updateSelf(locus.self, locus.participants);
+    this.updateSelf(locus.self);
     this.updateLocusUrl(locus.url);
     this.updateAclUrl(locus.aclUrl);
     this.updateBasequence(locus.baseSequence);
@@ -780,6 +784,23 @@ export default class LocusInfo extends EventsScope {
         isReplace,
       }
     );
+
+    if (participants && Array.isArray(participants) && participants.length > 0) {
+      for (const participant of participants) {
+        if (participant && participant?.reason === 'FAILURE') {
+          this.emitScoped(
+            {
+              file: 'locus-info',
+              function: 'updateParticipants',
+            },
+            LOCUSINFO.EVENTS.PARTICIPANT_REASON_CHANGED,
+            {
+              displayName: participant?.person?.primaryDisplayString,
+            }
+          );
+        }
+      }
+    }
   }
 
   /**
@@ -814,6 +835,8 @@ export default class LocusInfo extends EventsScope {
           hasMeetingFullChanged,
           hasPracticeSessionEnabledChanged,
           hasStageViewChanged,
+          hasAnnotationControlChanged,
+          hasRemoteDesktopControlChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -1049,6 +1072,22 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasAnnotationControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED,
+          {state: current.annotationControl}
+        );
+      }
+
+      if (hasRemoteDesktopControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED,
+          {state: current.rdcControl}
+        );
+      }
+
       this.controls = controls;
     }
   }
@@ -1336,17 +1375,20 @@ export default class LocusInfo extends EventsScope {
 
   /**
    * handles when the locus.self is updated
-   * @param {Object} self the locus.mediaShares property
-   * @param {Array} participants the locus.participants property
+   * @param {Object} self the new locus.self
    * @returns {undefined}
    * @memberof LocusInfo
    * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
    */
-  updateSelf(self: any, participants: Array<any>) {
-    // @ts-ignore - check where this.self come from
-    if (self && !isEqual(this.self, self)) {
+  updateSelf(self: any) {
+    if (self) {
       // @ts-ignore
-      const parsedSelves = SelfUtils.getSelves(this.self, self, this.webex.internal.device.url);
+      const parsedSelves = SelfUtils.getSelves(
+        this.parsedLocus.self,
+        self,
+        this.webex.internal.device.url,
+        this.participants // using this.participants instead of locus.participants here, because with delta DTOs locus.participants will only contain a small subset of participants
+      );
 
       this.updateMeeting(parsedSelves.current);
       this.parsedLocus.self = parsedSelves.current;
@@ -1360,7 +1402,7 @@ export default class LocusInfo extends EventsScope {
       // TODO: check if we need to save the sipUri here as well
       // this.emit(LOCUSINFO.EVENTS.MEETING_UPDATE, SelfUtils.getSipUrl(this.getLocusPartner(participants, self), this.parsedLocus.fullState.type, this.parsedLocus.info.sipUri));
       const result = SelfUtils.getSipUrl(
-        this.getLocusPartner(participants, self),
+        this.getLocusPartner(this.participants, self),
         this.parsedLocus.fullState.type,
         this.parsedLocus.info.sipUri
       );
@@ -1506,7 +1548,7 @@ export default class LocusInfo extends EventsScope {
           {}
         );
       }
-      if (parsedSelves.updates.isUserUnadmitted) {
+      if (parsedSelves.updates.hasUserEnteredLobby) {
         this.emitScoped(
           {
             file: 'locus-info',
@@ -1516,7 +1558,7 @@ export default class LocusInfo extends EventsScope {
           self
         );
       }
-      if (parsedSelves.updates.isUserAdmitted) {
+      if (parsedSelves.updates.hasUserBeenAdmitted) {
         this.emitScoped(
           {
             file: 'locus-info',
@@ -1706,7 +1748,8 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   getTheLocusToUpdate(newLocus: any) {
-    const switchStatus = ControlsUtils.getSessionSwitchStatus(this.controls, newLocus?.controls);
+    const switchStatus = ControlsUtils.getSessionSwitchStatus(this, newLocus);
+
     if (switchStatus.isReturnToMain && this.mainSessionLocusCache) {
       return cloneDeep(this.mainSessionLocusCache);
     }