@webex/plugin-meetings 3.7.0-next.6 → 3.7.0-next.60

package/src/meeting/request.ts

@@ -27,7 +27,7 @@ import {
   _SLIDES_,
   ANNOTATION,
 } from '../constants';
-import {SendReactionOptions, ToggleReactionsOptions} from './request.type';
+import {SendReactionOptions, BrbOptions, ToggleReactionsOptions} from './request.type';
 import MeetingUtil from './util';
 import {AnnotationInfo} from '../annotation/annotation.types';
 import {ClientMediaPreferences} from '../reachability/reachability.types';
@@ -909,4 +909,29 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       uri: locusUrl,
     });
   }
+
+  /**
+   * Sends a request to set be right back status.
+   *
+   * @param {Object} options - The options for brb request.
+   * @param {boolean} options.enabled - Whether brb status is enabled.
+   * @param {string} options.locusUrl - The URL of the locus.
+   * @param {string} options.deviceUrl - The URL of the device.
+   * @param {string} options.selfId - The ID of the participant.
+   * @returns {Promise}
+   */
+  setBrb({enabled, locusUrl, deviceUrl, selfId}: BrbOptions) {
+    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${CONTROLS}`;
+
+    return this.locusDeltaRequest({
+      method: HTTP_VERBS.PATCH,
+      uri,
+      body: {
+        brb: {
+          enabled,
+          deviceUrl,
+        },
+      },
+    });
+  }
 }

package/src/meeting/request.type.ts

@@ -11,3 +11,10 @@ export type ToggleReactionsOptions = {
   locusUrl: string;
   requestingParticipantId: string;
 };
+
+export type BrbOptions = {
+  enabled: boolean;
+  locusUrl: string;
+  deviceUrl: string;
+  selfId: string;
+};

package/src/meeting/util.ts

@@ -140,7 +140,11 @@ const MeetingUtil = {
         meeting.isMultistream,
         MeetingUtil.getIpVersion(webex)
       );
-      reachability = await webex.meetings.reachability.getReachabilityReportToAttachToRoap();
+      if (options.roapMessage) {
+        // we only need to attach reachability if we are sending a roap message
+        // sending reachability on its own will cause Locus to reject our join request
+        reachability = await webex.meetings.reachability.getReachabilityReportToAttachToRoap();
+      }
     } catch (e) {
       LoggerProxy.logger.error(
         'Meeting:util#joinMeeting --> Error getting reachability or clientMediaPreferences:',
@@ -441,6 +445,9 @@ const MeetingUtil = {
     displayHints.includes(DISPLAY_HINTS.LEAVE_END_MEETING),
 
   canManageBreakout: (displayHints) => displayHints.includes(DISPLAY_HINTS.BREAKOUT_MANAGEMENT),
+
+  canStartBreakout: (displayHints) => !displayHints.includes(DISPLAY_HINTS.DISABLE_BREAKOUT_START),
+
   canBroadcastMessageToBreakout: (displayHints, policies = {}) =>
     displayHints.includes(DISPLAY_HINTS.BROADCAST_MESSAGE_TO_BREAKOUT) &&
     !!policies[SELF_POLICY.SUPPORT_BROADCAST_MESSAGE],
@@ -496,15 +503,6 @@ const MeetingUtil = {
     }
   },
 
-  handleDeviceLogging: (devices = []) => {
-    const LOG_HEADER = 'MeetingUtil#handleDeviceLogging -->';
-
-    devices.forEach((device) => {
-      LoggerProxy.logger.log(LOG_HEADER, `deviceId = ${device.deviceId}`);
-      LoggerProxy.logger.log(LOG_HEADER, 'settings', JSON.stringify(device));
-    });
-  },
-
   endMeetingForAll: (meeting) => {
     if (meeting.meetingState === FULL_STATE.INACTIVE) {
       return Promise.reject(new MeetingNotActiveError());

package/src/meeting-info/meeting-info-v2.ts

@@ -18,7 +18,20 @@ const ADHOC_MEETING_DEFAULT_ERROR =
   'Failed starting the adhoc meeting, Please contact support team ';
 const CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES = [423005, 423006];
 const POLICY_ERROR_CODES = [403049, 403104, 403103, 403048, 403102, 403101];
-const WEBINAR_REGISTRATION_ERROR_CODES = [403021, 403022, 403024];
+const JOIN_FORBIDDEN_CODES = [403003];
+/**
+ * 403021 - Meeting registration is required
+ * 403022 - Meeting registration is still pending
+ * 403024 - Meeting registration have been rejected
+ * 403137 - Registration ID verified failure
+ * 423007 - Registration ID input too many time,please input captcha code
+ * 403026 - Need to join meeting via webcast
+ * 403037 - Meeting join required registration ID
+ * 403137 - Registration ID verified failure
+ *
+ */
+const JOIN_WEBINAR_ERROR_CODES = [403021, 403022, 403024, 403137, 423007, 403026, 403037, 403137];
+
 /**
  * Error to indicate that wbxappapi requires a password
  */
@@ -126,9 +139,9 @@ export class MeetingInfoV2CaptchaError extends Error {
 }
 
 /**
- * Error preventing join because of a webinar registration error
+ * Error preventing join because of a webinar have some error
  */
-export class MeetingInfoV2WebinarRegistrationError extends Error {
+export class MeetingInfoV2JoinWebinarError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
@@ -142,7 +155,32 @@ export class MeetingInfoV2WebinarRegistrationError extends Error {
    */
   constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
-    this.name = 'MeetingInfoV2WebinarRegistrationError';
+    this.name = 'MeetingInfoV2JoinWebinarError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.meetingInfo = meetingInfo;
+  }
+}
+
+/**
+ * Error preventing join because of a forbidden error
+ */
+export class MeetingInfoV2JoinForbiddenError extends Error {
+  meetingInfo: any;
+  sdkMessage: any;
+  wbxAppApiCode: any;
+  body: any;
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [meetingInfo]
+   * @param {String} [message]
+   */
+  constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2JoinForbiddenError';
     this.sdkMessage = message;
     this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
@@ -204,21 +242,44 @@ export default class MeetingInfoV2 {
   };
 
   /**
-   * Raises a handleWebinarRegistrationError for webinar registration error codes
+   * Raises a handleJoinWebinarError for join webinar error codes
+   * @param {any} err the error from the request
+   * @returns {void}
+   */
+  handleJoinWebinarError = (err) => {
+    if (!err.body) {
+      return;
+    }
+
+    if (JOIN_WEBINAR_ERROR_CODES.includes(err.body?.code)) {
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.JOIN_WEBINAR_ERROR, {
+        code: err.body?.code,
+      });
+
+      throw new MeetingInfoV2JoinWebinarError(
+        err.body?.code,
+        err.body?.data?.meetingInfo,
+        err.body?.message
+      );
+    }
+  };
+
+  /**
+   * Raises a handleForbiddenError for join meeting forbidden error
    * @param {any} err the error from the request
    * @returns {void}
    */
-  handleWebinarRegistrationError = (err) => {
+  handleForbiddenError = (err) => {
     if (!err.body) {
       return;
     }
 
-    if (WEBINAR_REGISTRATION_ERROR_CODES.includes(err.body?.code)) {
-      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.WEBINAR_REGISTRATION_ERROR, {
+    if (JOIN_FORBIDDEN_CODES.includes(err.body?.code)) {
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.JOIN_FORBIDDEN_ERROR, {
         code: err.body?.code,
       });
 
-      throw new MeetingInfoV2WebinarRegistrationError(
+      throw new MeetingInfoV2JoinForbiddenError(
         err.body?.code,
         err.body?.data?.meetingInfo,
         err.body?.message
@@ -286,7 +347,8 @@ export default class MeetingInfoV2 {
       })
       .catch((err) => {
         this.handlePolicyError(err);
-        this.handleWebinarRegistrationError(err);
+        this.handleJoinWebinarError(err);
+        this.handleForbiddenError(err);
 
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
           reason: err.message,
@@ -441,7 +503,8 @@ export default class MeetingInfoV2 {
 
         if (err?.statusCode === 403) {
           this.handlePolicyError(err);
-          this.handleWebinarRegistrationError(err);
+          this.handleJoinWebinarError(err);
+          this.handleForbiddenError(err);
 
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
             reason: err.message,

package/src/meeting-info/utilv2.ts

@@ -19,6 +19,7 @@ import {
   UUID_REG,
   VALID_EMAIL_ADDRESS,
   DEFAULT_MEETING_INFO_REQUEST_BODY,
+  JOIN_LINK_MTID,
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 import LoggerProxy from '../common/logs/logger-proxy';
@@ -70,7 +71,8 @@ export default class MeetingInfoUtil {
           parsedUrl.pathname.includes(`/${MEET_M}`) ||
           parsedUrl.pathname.includes(`/${MEET_CISCO}`) ||
           parsedUrl.pathname.includes(`/${MEET_CO}`) ||
-          parsedUrl.pathname.includes(`/${JOIN}`));
+          parsedUrl.pathname.includes(`/${JOIN}`) ||
+          (parsedUrl.search && parsedUrl.search.includes(JOIN_LINK_MTID)));
     }
 
     return hostNameBool && pathNameBool;

package/src/meetings/index.ts

@@ -1,5 +1,5 @@
 /* eslint no-shadow: ["error", { "allow": ["eventType"] }] */
-import {cloneDeep} from 'lodash';
+import {cloneDeep, clone} from 'lodash';
 import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 import '@webex/internal-plugin-metrics';
@@ -42,6 +42,7 @@ import {
   _ON_HOLD_LOBBY_,
   _WAIT_,
   DESTINATION_TYPE,
+  INITIAL_REGISTRATION_STATUS,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import MeetingInfo from '../meeting-info';
@@ -53,12 +54,18 @@ import Request from './request';
 import PasswordError from '../common/errors/password-error';
 import CaptchaError from '../common/errors/captcha-error';
 import MeetingCollection from './collection';
-import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
+import {
+  MEETING_KEY,
+  INoiseReductionEffect,
+  IVirtualBackgroundEffect,
+  MeetingRegistrationStatus,
+} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
-import WebinarRegistrationError from '../common/errors/webinar-registration-error';
+import JoinWebinarError from '../common/errors/join-webinar-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
+import JoinForbiddenError from '../common/errors/join-forbidden-error';
 
 let mediaLogger;
 
@@ -155,6 +162,9 @@ export type BasicMeetingInformation = {
   };
   meetingInfo: any;
   sessionCorrelationId: string;
+  roles: string[];
+  getCurUserType: () => string | null;
+  callStateForMetrics: CallStateForMetrics;
 };
 
 /**
@@ -176,6 +186,7 @@ export default class Meetings extends WebexPlugin {
   mediaHelpers: any;
   breakoutLocusForHandleLater: any;
   namespace = MEETINGS;
+  registrationStatus: MeetingRegistrationStatus;
 
   /**
    * Initializes the Meetings Plugin
@@ -689,6 +700,20 @@ export default class Meetings extends WebexPlugin {
     });
   }
 
+  /**
+   * API to change log upload interval. Setting the factor to 0 will disable periodic log uploads.
+   *
+   * @param {number} factor new factor value
+   * @returns {void}
+   */
+  private _setLogUploadIntervalMultiplicationFactor(factor: number) {
+    if (typeof factor !== 'number') {
+      return;
+    }
+    // @ts-ignore
+    this.config.logUploadIntervalMultiplicationFactor = factor;
+  }
+
   /**
    * API to toggle unified meetings
    * @param {Boolean} changeState
@@ -782,6 +807,18 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * Executes a registration step and updates the registration status.
+   * @param {Function} step - The registration step to execute.
+   * @param {string} stepName - The name of the registration step.
+   * @returns {Promise} A promise that resolves when the step is completed.
+   */
+  executeRegistrationStep(step: () => Promise<any>, stepName: string) {
+    return step().then(() => {
+      this.registrationStatus[stepName] = true;
+    });
+  }
+
   /**
    * Explicitly sets up the meetings plugin by registering
    * the device, connecting to mercury, and listening for locus events.
@@ -792,6 +829,8 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   public register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any> {
+    this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
+
     // @ts-ignore
     if (!this.webex.canAuthorize) {
       LoggerProxy.logger.error(
@@ -810,24 +849,39 @@ export default class Meetings extends WebexPlugin {
     }
 
     return Promise.all([
-      this.fetchUserPreferredWebexSite(),
-      this.getGeoHint(),
-      this.startReachability('registration').catch((error) => {
-        LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
-      }),
-      // @ts-ignore
-      this.webex.internal.device
-        .register(deviceRegistrationOptions)
-        // @ts-ignore
-        .then(() =>
-          LoggerProxy.logger.info(
+      this.executeRegistrationStep(() => this.fetchUserPreferredWebexSite(), 'fetchWebexSite'),
+      this.executeRegistrationStep(() => this.getGeoHint(), 'getGeoHint'),
+      this.executeRegistrationStep(
+        () =>
+          this.startReachability('registration').catch((error) => {
+            LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
+          }),
+        'startReachability'
+      ),
+      this.executeRegistrationStep(
+        () =>
+          // @ts-ignore
+          this.webex.internal.device
+            .register(deviceRegistrationOptions)
             // @ts-ignore
-            `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
-          )
+            .then(() => {
+              LoggerProxy.logger.info(
+                // @ts-ignore
+                `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
+              );
+            }),
+        'deviceRegister'
+      ).then(() =>
+        this.executeRegistrationStep(
+          // @ts-ignore
+          () => this.webex.internal.mercury.connect(),
+          'mercuryConnect'
         )
-        // @ts-ignore
-        .then(() => this.webex.internal.mercury.connect()),
-      MeetingsUtil.checkH264Support.call(this),
+      ),
+      this.executeRegistrationStep(
+        () => Promise.resolve(MeetingsUtil.checkH264Support.call(this)),
+        'checkH264Support'
+      ),
     ])
       .then(() => {
         this.listenForEvents();
@@ -891,6 +945,7 @@ export default class Meetings extends WebexPlugin {
             EVENT_TRIGGERS.MEETINGS_UNREGISTERED
           );
           this.registered = false;
+          this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
         })
     );
   }
@@ -1143,6 +1198,9 @@ export default class Meetings extends WebexPlugin {
           sessionId: meeting.locusInfo?.fullState?.sessionId,
         },
       },
+      roles: meeting.roles,
+      callStateForMetrics: meeting.callStateForMetrics,
+      getCurUserType: meeting.getCurUserType,
     });
     this.meetingCollection.delete(meeting.id);
     Trigger.trigger(
@@ -1406,7 +1464,8 @@ export default class Meetings extends WebexPlugin {
         !(err instanceof CaptchaError) &&
         !(err instanceof PasswordError) &&
         !(err instanceof PermissionError) &&
-        !(err instanceof WebinarRegistrationError)
+        !(err instanceof JoinWebinarError) &&
+        !(err instanceof JoinForbiddenError)
       ) {
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`

package/src/meetings/meetings.types.ts

@@ -21,3 +21,13 @@ export const MEETING_KEY = {
 } as const;
 
 export type MEETING_KEY = Enum<typeof MEETING_KEY>;
+
+// finer grained status for registration steps
+export type MeetingRegistrationStatus = {
+  fetchWebexSite: boolean;
+  getGeoHint: boolean;
+  startReachability: boolean;
+  deviceRegister: boolean;
+  mercuryConnect: boolean;
+  checkH264Support: boolean;
+};

package/src/meetings/util.ts

@@ -90,7 +90,8 @@ MeetingsUtil.getMediaServer = (sdp) => {
       .find((line) => line.startsWith('o='))
       .split(' ')
       .shift()
-      .replace('o=', '');
+      .replace('o=', '')
+      .toLowerCase();
   } catch {
     mediaServer = undefined;
   }

package/src/member/index.ts

@@ -28,6 +28,7 @@ export default class Member {
   isRecording: any;
   isRemovable: any;
   isSelf: any;
+  isBrb: boolean;
   isUser: any;
   isVideoMuted: any;
   roles: IExternalRoles;
@@ -227,6 +228,13 @@ export default class Member {
      * @memberof Member
      */
     this.isRemovable = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isBrb = false;
     /**
      * @instance
      * @type {String}
@@ -295,6 +303,7 @@ export default class Member {
       this.supportsInterpretation = MemberUtil.isInterpretationSupported(participant);
       this.supportLiveAnnotation = MemberUtil.isLiveAnnotationSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
+      this.isBrb = MemberUtil.isBrb(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);
       this.isModerator = MemberUtil.isModerator(participant);

package/src/member/types.ts

@@ -23,6 +23,14 @@ export type ParticipantWithRoles = {
   };
 };
 
+export type ParticipantWithBrb = {
+  controls: {
+    brb?: {
+      enabled: boolean;
+    };
+  };
+};
+
 // values are inherited from locus so don't update these
 export enum MediaStatus {
   RECVONLY = 'RECVONLY', // participant only receiving and not sending