@webex/plugin-meetings 3.0.0-beta.94 → 3.0.0-beta.96

package/src/breakouts/index.ts

@@ -105,12 +105,17 @@ const Breakouts = WebexPlugin.extend({
       leading: true,
       trailing: false,
     });
-    this.listenTo(this.breakouts, 'add', () => {
+    this.listenTo(this.breakouts, 'add', (breakout) => {
       this.debouncedQueryRosters();
+      this.triggerReturnToMainEvent(breakout);
+    });
+    this.listenTo(this.breakouts, 'change:requestedLastModifiedTime', (breakout) => {
+      this.triggerReturnToMainEvent(breakout);
     });
     this.listenToCurrentSessionTypeChange();
     this.listenToBroadcastMessages();
     this.listenToBreakoutRosters();
+    this.listenToBreakoutHelp();
     // @ts-ignore
     this.breakoutRequest = new BreakoutRequest({webex: this.webex});
   },
@@ -234,6 +239,19 @@ const Breakouts = WebexPlugin.extend({
     });
   },
 
+  /**
+   * Sets up a listener for ask help notify from mecury
+   * @returns {void}
+   */
+  listenToBreakoutHelp() {
+    this.listenTo(this.webex.internal.mercury, 'event:breakout.help', (event) => {
+      const {
+        data: {participant, sessionId},
+      } = event;
+      this.trigger(BREAKOUTS.EVENTS.ASK_FOR_HELP, {participant, sessionId});
+    });
+  },
+
   /**
    * Updates the information about the current breakout
    * @param {Object} params
@@ -301,6 +319,10 @@ const Breakouts = WebexPlugin.extend({
           }
 
           breakouts[sessionId][state] = true;
+
+          if (state === BREAKOUTS.SESSION_STATES.REQUESTED) {
+            breakouts[sessionId].requestedLastModifiedTime = breakout.modifiedAt;
+          }
         });
       });
     }
@@ -311,10 +333,6 @@ const Breakouts = WebexPlugin.extend({
     });
 
     this.breakouts.set(Object.values(breakouts));
-
-    if (this.allowBackToMain && this.getMainSession().requested) {
-      this.trigger(BREAKOUTS.EVENTS.ASK_RETURN_TO_MAIN);
-    }
   },
   /**
    * get main session
@@ -786,6 +804,16 @@ const Breakouts = WebexPlugin.extend({
       body,
     });
   },
+  /**
+   * trigger ASK_RETURN_TO_MAIN event when main session requested
+   * @param {Object} breakout
+   * @returns {void}
+   */
+  triggerReturnToMainEvent(breakout) {
+    if (breakout.isMain && breakout.requested) {
+      this.trigger(BREAKOUTS.EVENTS.ASK_RETURN_TO_MAIN);
+    }
+  },
 });
 
 export default Breakouts;

package/src/constants.ts

@@ -315,6 +315,7 @@ export const EVENT_TRIGGERS = {
   MEETING_BREAKOUTS_MESSAGE: 'meeting:breakouts:message',
   MEETING_BREAKOUTS_ASK_RETURN_TO_MAIN: 'meeting:breakouts:askReturnToMain',
   MEETING_BREAKOUTS_LEAVE: 'meeting:breakouts:leave',
+  MEETING_BREAKOUTS_ASK_FOR_HELP: 'meeting:breakouts:askForHelp',
   MEMBERS_UPDATE: 'members:update',
   MEMBERS_CLEAR: 'members:clear',
   MEMBERS_CONTENT_UPDATE: 'members:content:update',
@@ -368,6 +369,7 @@ export const MEETING_REMOVED_REASON = {
   FULLSTATE_REMOVED: 'FULLSTATE_REMOVED', // meeting got dropped ? not sure
   MEETING_INACTIVE_TERMINATING: 'MEETING_INACTIVE_TERMINATING', // Meeting got ended or everyone left the meeting
   CLIENT_LEAVE_REQUEST: 'CLIENT_LEAVE_REQUEST', // You triggered leave meeting
+  CLIENT_LEAVE_REQUEST_TAB_CLOSED: 'CLIENT_LEAVE_REQUEST_TAB_CLOSED', // You triggered leave meeting, such as closing the browser tab directly
   USER_ENDED_SHARE_STREAMS: 'USER_ENDED_SHARE_STREAMS', // user triggered stop share
   NO_MEETINGS_TO_SYNC: 'NO_MEETINGS_TO_SYNC', // After the syncMeeting no meeting exists
   MEETING_CONNECTION_FAILED: 'MEETING_CONNECTION_FAILED', // meeting failed to connect due to ice failures or firewall issue
@@ -549,6 +551,7 @@ export const BREAKOUTS = {
     MEMBERS_UPDATE: 'MEMBERS_UPDATE',
     ASK_RETURN_TO_MAIN: 'ASK_RETURN_TO_MAIN',
     LEAVE_BREAKOUT: 'LEAVE_BREAKOUT',
+    ASK_FOR_HELP: 'ASK_FOR_HELP',
   },
   SESSION_TYPES: {
     MAIN: 'MAIN',

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

@@ -140,8 +140,8 @@ export default class ControlsOptionsManager {
    * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs
    * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.
    */
-  protected update(...controls: Array<ControlConfig>) {
-    const payload = controls.reduce((output, control) => {
+  public update(...controls: Array<ControlConfig>) {
+    const payloads = controls.map((control) => {
       if (!Object.keys(Control).includes(control.scope)) {
         throw new Error(
           `updating meeting control scope "${control.scope}" is not a supported scope`
@@ -155,17 +155,20 @@ export default class ControlsOptionsManager {
       }
 
       return {
-        ...output,
         [control.scope]: control.properties,
       };
-    }, {});
-
-    // @ts-ignore
-    return this.request.request({
-      uri: `${this.locusUrl}/${CONTROLS}`,
-      body: payload,
-      method: HTTP_VERBS.PATCH,
     });
+
+    return payloads.reduce((previous, payload) => {
+      return previous.then(() =>
+        // @ts-ignore
+        this.request.request({
+          uri: `${this.locusUrl}/${CONTROLS}`,
+          body: payload,
+          method: HTTP_VERBS.PATCH,
+        })
+      );
+    }, Promise.resolve());
   }
 
   /**

package/src/meeting/in-meeting-actions.ts

@@ -40,7 +40,6 @@ interface IInMeetingActions {
   isRealTimeTranslationEnabled?: boolean;
   canSelectSpokenLanguages?: boolean;
   waitingForOthersToJoin?: boolean;
-  canEnableReactions?: boolean;
   canSendReactions?: boolean;
   canManageBreakout?: boolean;
   canAdmitLobbyToBreakout?: boolean;
@@ -48,6 +47,19 @@ interface IInMeetingActions {
   canUserAskForHelp?: boolean;
   canUserRenameSelfAndObserved?: boolean;
   canUserRenameOthers?: boolean;
+  canMuteAll?: boolean;
+  canUnmuteAll?: boolean;
+  canEnableHardMute?: boolean;
+  canDisableHardMute?: boolean;
+  canEnableMuteOnEntry?: boolean;
+  canDisableMuteOnEntry?: boolean;
+  canEnableReactions?: boolean;
+  canDisableReactions?: boolean;
+  canEnableReactionDisplayNames?: boolean;
+  canDisableReactionDisplayNames?: boolean;
+  canUpdateShareControl?: boolean;
+  canEnableViewTheParticipantsList?: boolean;
+  canDisableViewTheParticipantsList?: boolean;
 }
 
 /**
@@ -118,8 +130,6 @@ export default class InMeetingActions implements IInMeetingActions {
 
   waitingForOthersToJoin = null;
 
-  canEnableReactions = null;
-
   canSendReactions = null;
 
   canManageBreakout = null;
@@ -134,6 +144,32 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canUserRenameOthers = null;
 
+  canMuteAll = null;
+
+  canUnmuteAll = null;
+
+  canEnableHardMute = null;
+
+  canDisableHardMute = null;
+
+  canEnableMuteOnEntry = null;
+
+  canDisableMuteOnEntry = null;
+
+  canEnableReactions = null;
+
+  canDisableReactions = null;
+
+  canEnableReactionDisplayNames = null;
+
+  canDisableReactionDisplayNames = null;
+
+  canUpdateShareControl = null;
+
+  canEnableViewTheParticipantsList = null;
+
+  canDisableViewTheParticipantsList = null;
+
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -170,7 +206,6 @@ export default class InMeetingActions implements IInMeetingActions {
     isRealTimeTranslationEnabled: this.isRealTimeTranslationEnabled,
     canSelectSpokenLanguages: this.canSelectSpokenLanguages,
     waitingForOthersToJoin: this.waitingForOthersToJoin,
-    canEnableReactions: this.canEnableReactions,
     canSendReactions: this.canSendReactions,
     canManageBreakout: this.canManageBreakout,
     canAdmitLobbyToBreakout: this.canAdmitLobbyToBreakout,
@@ -178,6 +213,19 @@ export default class InMeetingActions implements IInMeetingActions {
     canUserAskForHelp: this.canUserAskForHelp,
     canUserRenameSelfAndObserved: this.canUserRenameSelfAndObserved,
     canUserRenameOthers: this.canUserRenameOthers,
+    canMuteAll: this.canMuteAll,
+    canUnmuteAll: this.canUnmuteAll,
+    canEnableHardMute: this.canEnableHardMute,
+    canDisableHardMute: this.canDisableHardMute,
+    canEnableMuteOnEntry: this.canEnableMuteOnEntry,
+    canDisableMuteOnEntry: this.canDisableMuteOnEntry,
+    canEnableReactions: this.canEnableReactions,
+    canDisableReactions: this.canDisableReactions,
+    canEnableReactionDisplayNames: this.canEnableReactionDisplayNames,
+    canDisableReactionDisplayNames: this.canDisableReactionDisplayNames,
+    canUpdateShareControl: this.canUpdateShareControl,
+    canEnableViewTheParticipantsList: this.canEnableViewTheParticipantsList,
+    canDisableViewTheParticipantsList: this.canDisableViewTheParticipantsList,
   });
 
   /**

package/src/meeting/index.ts

@@ -2,6 +2,7 @@ import uuid from 'uuid';
 import {cloneDeep, isEqual, pick, isString, defer} from 'lodash';
 // @ts-ignore - Fix this
 import {StatelessWebexPlugin} from '@webex/webex-core';
+import {base64} from '@webex/common';
 import {
   ConnectionState,
   Errors,
@@ -62,6 +63,7 @@ import {
   _JOIN_,
   AUDIO,
   CONTENT,
+  DISPLAY_HINTS,
   ENDED,
   EVENT_TRIGGERS,
   EVENT_TYPES,
@@ -90,6 +92,7 @@ import {
   VIDEO_RESOLUTIONS,
   VIDEO,
   HTTP_VERBS,
+  SELF_ROLES,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import ParameterError from '../common/errors/parameter';
@@ -508,12 +511,12 @@ export default class Meeting extends StatelessWebexPlugin {
   statsAnalyzer: StatsAnalyzer;
   transcription: Transcription;
   updateMediaConnections: (mediaConnections: any[]) => void;
-  endCallInitiateJoinReq: any;
+  endCallInitJoinReq: any;
   endJoinReqResp: any;
   endLocalSDPGenRemoteSDPRecvDelay: any;
   joinedWith: any;
   locusId: any;
-  startCallInitiateJoinReq: any;
+  startCallInitJoinReq: any;
   startJoinReqResp: any;
   startLocalSDPGenRemoteSDPRecvDelay: any;
   wirelessShare: any;
@@ -528,8 +531,8 @@ export default class Meeting extends StatelessWebexPlugin {
   state: any;
   localAudioTrackMuteStateHandler: (event: TrackMuteEvent) => void;
   localVideoTrackMuteStateHandler: (event: TrackMuteEvent) => void;
-  webexMeetingId: string;
-
+  roles: any[];
+  environment: string;
   namespace = MEETINGS;
 
   /**
@@ -1481,6 +1484,18 @@ export default class Meeting extends StatelessWebexPlugin {
         EVENT_TRIGGERS.MEETING_BREAKOUTS_LEAVE
       );
     });
+
+    this.breakouts.on(BREAKOUTS.EVENTS.ASK_FOR_HELP, (helpEvent) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'setUpBreakoutsListener',
+        },
+        EVENT_TRIGGERS.MEETING_BREAKOUTS_ASK_FOR_HELP,
+        helpEvent
+      );
+    });
   }
 
   /**
@@ -1696,12 +1711,12 @@ export default class Meeting extends StatelessWebexPlugin {
         };
       }
 
-      const callInitiateJoinReq = this.getCallInitiateJoinReq();
+      const callInitJoinReq = this.getCallInitJoinReq();
 
-      if (callInitiateJoinReq) {
+      if (callInitJoinReq) {
         options.joinTimes = {
           ...options.joinTimes,
-          callInitiateJoinReq,
+          callInitJoinReq,
         };
       }
 
@@ -1714,15 +1729,31 @@ export default class Meeting extends StatelessWebexPlugin {
         };
       }
 
-      const getTotalJmt = this.getTotalJmt();
+      const totalJmt = this.getTotalJmt();
 
-      if (getTotalJmt) {
+      if (totalJmt) {
         options.joinTimes = {
           ...options.joinTimes,
-          getTotalJmt,
+          totalJmt,
         };
       }
 
+      const curUserType = this.getCurUserType();
+
+      if (curUserType) {
+        options.userType = curUserType;
+      }
+
+      const curLoginType = this.getCurLoginType();
+
+      if (curLoginType) {
+        options.loginType = curLoginType;
+      }
+
+      if (this.environment) {
+        options.environment = this.environment;
+      }
+
       if (options.type === MQA_STATS.CA_TYPE) {
         payload = Metrics.initMediaPayload(options.event, identifiers, options);
       } else {
@@ -2430,10 +2461,6 @@ export default class Meeting extends StatelessWebexPlugin {
             payload.info.userDisplayHints
           ),
           waitingForOthersToJoin: MeetingUtil.waitingForOthersToJoin(payload.info.userDisplayHints),
-          canEnableReactions: MeetingUtil.canEnableReactions(
-            this.inMeetingActions.canEnableReactions,
-            payload.info.userDisplayHints
-          ),
           canSendReactions: MeetingUtil.canSendReactions(
             this.inMeetingActions.canSendReactions,
             payload.info.userDisplayHints
@@ -2450,6 +2477,58 @@ export default class Meeting extends StatelessWebexPlugin {
             payload.info.userDisplayHints
           ),
           canUserRenameOthers: MeetingUtil.canUserRenameOthers(payload.info.userDisplayHints),
+          canMuteAll: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.MUTE_ALL],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canUnmuteAll: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.UNMUTE_ALL],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canEnableHardMute: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_HARD_MUTE],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canDisableHardMute: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_HARD_MUTE],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canEnableMuteOnEntry: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canDisableMuteOnEntry: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canEnableReactions: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_REACTIONS],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canDisableReactions: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_REACTIONS],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canEnableReactionDisplayNames: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_SHOW_DISPLAY_NAME],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canDisableReactionDisplayNames: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_SHOW_DISPLAY_NAME],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canUpdateShareControl: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.SHARE_CONTROL],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canEnableViewTheParticipantsList: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_VIEW_THE_PARTICIPANT_LIST],
+            displayHints: payload.info.userDisplayHints,
+          }),
+          canDisableViewTheParticipantsList: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_VIEW_THE_PARTICIPANT_LIST],
+            displayHints: payload.info.userDisplayHints,
+          }),
         });
 
         this.recordingController.setDisplayHints(payload.info.userDisplayHints);
@@ -3047,6 +3126,8 @@ export default class Meeting extends StatelessWebexPlugin {
         webexMeetingInfo?.hostId ||
         this.owner;
       this.permissionToken = webexMeetingInfo?.permissionToken;
+      // Need to populate environment when sending CA event
+      this.environment = locusMeetingObject?.info.channel || webexMeetingInfo?.channel;
     }
   }
 
@@ -6086,13 +6167,12 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public leave(options: {resourceId?: string; reason?: any} = {} as any) {
+    const leaveReason = options.reason || MEETING_REMOVED_REASON.CLIENT_LEAVE_REQUEST;
     Metrics.postEvent({
       event: eventType.LEAVE,
       meeting: this,
-      data: {trigger: trigger.USER_INTERACTION, canProceed: false},
+      data: {trigger: trigger.USER_INTERACTION, canProceed: false, reason: leaveReason},
     });
-    const leaveReason = options.reason || MEETING_REMOVED_REASON.CLIENT_LEAVE_REQUEST;
-
     LoggerProxy.logger.log('Meeting:index#leave --> Leaving a meeting');
 
     return MeetingUtil.leaveMeeting(this, options)
@@ -7020,7 +7100,7 @@ export default class Meeting extends StatelessWebexPlugin {
     const end = this.endLocalSDPGenRemoteSDPRecvDelay;
 
     if (start && end) {
-      const calculatedDelay = end - start;
+      const calculatedDelay = Math.round(end - start);
 
       return calculatedDelay > METRICS_JOIN_TIMES_MAX_DURATION ? undefined : calculatedDelay;
     }
@@ -7032,26 +7112,26 @@ export default class Meeting extends StatelessWebexPlugin {
    *
    * @returns {undefined}
    */
-  setStartCallInitiateJoinReq() {
-    this.startCallInitiateJoinReq = performance.now();
-    this.endCallInitiateJoinReq = undefined;
+  setStartCallInitJoinReq() {
+    this.startCallInitJoinReq = performance.now();
+    this.endCallInitJoinReq = undefined;
   }
 
   /**
    *
    * @returns {undefined}
    */
-  setEndCallInitiateJoinReq() {
-    this.endCallInitiateJoinReq = performance.now();
+  setEndCallInitJoinReq() {
+    this.endCallInitJoinReq = performance.now();
   }
 
   /**
    *
    * @returns {string} duration between call initiate and sending join request to locus
    */
-  getCallInitiateJoinReq() {
-    const start = this.startCallInitiateJoinReq;
-    const end = this.endCallInitiateJoinReq;
+  getCallInitJoinReq() {
+    const start = this.startCallInitJoinReq;
+    const end = this.endCallInitJoinReq;
 
     if (start && end) {
       const calculatedDelay = end - start;
@@ -7088,7 +7168,7 @@ export default class Meeting extends StatelessWebexPlugin {
     const end = this.endJoinReqResp;
 
     if (start && end) {
-      const calculatedDelay = end - start;
+      const calculatedDelay = Math.round(end - start);
 
       return calculatedDelay > METRICS_JOIN_TIMES_MAX_DURATION ? undefined : calculatedDelay;
     }
@@ -7101,10 +7181,45 @@ export default class Meeting extends StatelessWebexPlugin {
    * @returns {string} duration between call initiate and successful locus join (even if it is in lobby)
    */
   getTotalJmt() {
-    const start = this.startCallInitiateJoinReq;
+    const start = this.startCallInitJoinReq;
     const end = this.endJoinReqResp;
 
-    return start && end ? end - start : undefined;
+    return start && end ? Math.round(end - start) : undefined;
+  }
+
+  /**
+   *
+   * @returns {string} one of 'attendee','host','cohost', returns the user type of the current user
+   */
+  getCurUserType() {
+    const {roles} = this;
+    if (roles) {
+      if (roles.includes(SELF_ROLES.MODERATOR)) {
+        return 'host';
+      }
+      if (roles.includes(SELF_ROLES.COHOST)) {
+        return 'cohost';
+      }
+      if (roles.includes(SELF_ROLES.ATTENDEE)) {
+        return 'attendee';
+      }
+    }
+
+    return null;
+  }
+
+  /**
+   *
+   * @returns {string} one of 'login-ci','unverified-guest', returns the login type of the current user
+   */
+  getCurLoginType() {
+    // @ts-ignore
+    if (this.webex.canAuthorize) {
+      // @ts-ignore
+      return this.webex.credentials.isUnverifiedGuest ? 'unverified-guest' : 'login-ci';
+    }
+
+    return null;
   }
 
   /**

package/src/meeting/util.ts

@@ -497,17 +497,6 @@ MeetingUtil.canSelectSpokenLanguages = (displayHints) =>
 MeetingUtil.waitingForOthersToJoin = (displayHints) =>
   displayHints.includes(DISPLAY_HINTS.WAITING_FOR_OTHERS);
 
-MeetingUtil.canEnableReactions = (originalValue, displayHints) => {
-  if (displayHints.includes(DISPLAY_HINTS.ENABLE_REACTIONS)) {
-    return true;
-  }
-  if (displayHints.includes(DISPLAY_HINTS.DISABLE_REACTIONS)) {
-    return false;
-  }
-
-  return originalValue;
-};
-
 MeetingUtil.canSendReactions = (originalValue, displayHints) => {
   if (displayHints.includes(DISPLAY_HINTS.REACTIONS_ACTIVE)) {
     return true;

package/src/metrics/index.ts

@@ -31,10 +31,10 @@ const anonymizeIPAddress = (localIp) => anonymize(localIp, 28, 96);
 const triggerTimers = ({event, meeting, data}) => {
   switch (event) {
     case eventType.CALL_INITIATED:
-      meeting.setStartCallInitiateJoinReq();
+      meeting.setStartCallInitJoinReq();
       break;
     case eventType.LOCUS_JOIN_REQUEST:
-      meeting.setEndCallInitiateJoinReq();
+      meeting.setEndCallInitJoinReq();
       meeting.setStartJoinReqResp();
       break;
     case eventType.LOCUS_JOIN_RESPONSE:
@@ -189,6 +189,9 @@ class Metrics {
         name: 'endpoint',
         networkType: 'unknown',
         userAgent: this.userAgentToString(),
+        userType: options.userType,
+        loginType: options.loginType,
+        channel: options.channel,
         clientInfo: {
           clientType: options.clientType,
           clientVersion: `${CLIENT_NAME}/${this.webex.version}`,