@webex/plugin-meetings 3.7.0 → 3.8.0-next.10

package/src/meeting/locusMediaRequest.ts

@@ -1,9 +1,11 @@
 /* eslint-disable valid-jsdoc */
 import {defer} from 'lodash';
-import {Defer} from '@webex/common';
+import {Defer, transferEvents} from '@webex/common';
+import {EventEmitter} from 'events';
 import {WebexPlugin} from '@webex/webex-core';
-import {MEDIA, HTTP_VERBS, ROAP, IP_VERSION} from '../constants';
+import {MEDIA, HTTP_VERBS, ROAP} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
+import {ClientMediaPreferences} from '../reachability/reachability.types';
 
 export type MediaRequestType = 'RoapMessage' | 'LocalMute';
 export type RequestResult = any;
@@ -14,9 +16,8 @@ export type RoapRequest = {
   mediaId: string;
   roapMessage: any;
   reachability: any;
+  clientMediaPreferences: ClientMediaPreferences;
   sequence?: any;
-  joinCookie: any; // any, because this is opaque to the client, we pass whatever object we got from one backend component (Orpheus) to the other (Locus)
-  ipVersion?: IP_VERSION;
 };
 
 export type LocalMuteRequest = {
@@ -202,10 +203,6 @@ export class LocusMediaRequest extends WebexPlugin {
     const body: any = {
       device: this.config.device,
       correlationId: this.config.correlationId,
-      clientMediaPreferences: {
-        preferTranscoding: this.config.preferTranscoding,
-        ipver: request.type === 'RoapMessage' ? request.ipVersion : undefined,
-      },
     };
 
     const localMedias: any = {
@@ -223,7 +220,7 @@ export class LocusMediaRequest extends WebexPlugin {
       case 'RoapMessage':
         localMedias.roapMessage = request.roapMessage;
         localMedias.reachability = request.reachability;
-        body.clientMediaPreferences.joinCookie = request.joinCookie;
+        body.clientMediaPreferences = request.clientMediaPreferences;
 
         // @ts-ignore
         this.webex.internal.newMetrics.submitClientEvent({
@@ -254,12 +251,19 @@ export class LocusMediaRequest extends WebexPlugin {
       this.confluenceState = 'creation in progress';
     }
 
-    // @ts-ignore
-    return this.request({
+    const upload = new EventEmitter();
+    const download = new EventEmitter();
+
+    const options = {
       method: HTTP_VERBS.PUT,
       uri,
       body,
-    })
+      upload,
+      download,
+    };
+
+    // @ts-ignore
+    const promise = this.request(options)
       .then((result) => {
         if (isRequestAffectingConfluenceState(request)) {
           this.confluenceState = 'created';
@@ -298,6 +302,21 @@ export class LocusMediaRequest extends WebexPlugin {
 
         throw e;
       });
+
+    if (request.type === 'RoapMessage') {
+      const setupProgressListener = (direction: string, eventEmitter: EventEmitter) => {
+        eventEmitter.on('progress', (progressEvent: ProgressEvent) => {
+          LoggerProxy.logger.info(
+            `${request.type}: ${direction} Progress, Timestamp: ${progressEvent.timeStamp}, Progress: ${progressEvent.loaded}/${progressEvent.total}`
+          );
+        });
+      };
+
+      setupProgressListener('Upload', options.upload);
+      setupProgressListener('Download', options.download);
+    }
+
+    return promise;
   }
 
   /**
@@ -346,4 +365,11 @@ export class LocusMediaRequest extends WebexPlugin {
   public isConfluenceCreated() {
     return this.confluenceState === 'created';
   }
+
+  /**
+   * This method needs to be called when we downgrade from multistream to transcoded connection.
+   */
+  public downgradeFromMultistreamToTranscoded() {
+    this.config.preferTranscoding = true;
+  }
 }

package/src/meeting/muteState.ts

@@ -379,12 +379,7 @@ export class MuteState {
     }
     if (muted !== undefined) {
       this.state.server.remoteMute = muted;
-
-      // We never want to unmute the local stream from a server remote mute update.
-      // Moderated unmute is handled by a different function.
-      if (muted) {
-        this.muteLocalStream(meeting, muted, 'remotelyMuted');
-      }
+      this.muteLocalStream(meeting, muted, 'remotelyMuted');
     }
   }
 

package/src/meeting/request.ts

@@ -26,11 +26,11 @@ import {
   SEND_DTMF_ENDPOINT,
   _SLIDES_,
   ANNOTATION,
-  IP_VERSION,
 } 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';
 
 /**
  * @class MeetingRequest
@@ -128,8 +128,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     locale?: string;
     deviceCapabilities?: Array<string>;
     liveAnnotationSupported: boolean;
-    ipVersion?: IP_VERSION;
     alias?: string;
+    clientMediaPreferences: ClientMediaPreferences;
   }) {
     const {
       asResourceOccupant,
@@ -147,12 +147,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       moveToResource,
       roapMessage,
       reachability,
-      preferTranscoding,
       breakoutsSupported,
       locale,
       deviceCapabilities = [],
       liveAnnotationSupported,
-      ipVersion,
+      clientMediaPreferences,
       alias,
     } = options;
 
@@ -160,8 +159,6 @@ export default class MeetingRequest extends StatelessWebexPlugin {
 
     let url = '';
 
-    const joinCookie = await this.getJoinCookie();
-
     const body: any = {
       asResourceOccupant,
       device: {
@@ -176,11 +173,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       allowMultiDevice: true,
       ensureConversation: ensureConversation || false,
       supportsNativeLobby: 1,
-      clientMediaPreferences: {
-        preferTranscoding: preferTranscoding ?? true,
-        joinCookie,
-        ipver: ipVersion,
-      },
+      clientMediaPreferences,
     };
 
     if (alias) {
@@ -916,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

@@ -115,7 +115,7 @@ const MeetingUtil = {
     return IP_VERSION.unknown;
   },
 
-  joinMeeting: (meeting, options) => {
+  joinMeeting: async (meeting, options) => {
     if (!meeting) {
       return Promise.reject(new ParameterError('You need a meeting object.'));
     }
@@ -127,6 +127,31 @@ const MeetingUtil = {
       options: {meetingId: meeting.id},
     });
 
+    let reachability;
+    let clientMediaPreferences = {
+      // bare minimum fallback value that should allow us to join
+      ipver: IP_VERSION.unknown,
+      joinCookie: undefined,
+      preferTranscoding: !meeting.isMultistream,
+    };
+
+    try {
+      clientMediaPreferences = await webex.meetings.reachability.getClientMediaPreferences(
+        meeting.isMultistream,
+        MeetingUtil.getIpVersion(webex)
+      );
+      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:',
+        e
+      );
+    }
+
     // eslint-disable-next-line no-warning-comments
     // TODO: check if the meeting is in JOINING state
     // if Joining state termintate the request as user might click multiple times
@@ -138,20 +163,19 @@ const MeetingUtil = {
         locusUrl: meeting.locusUrl,
         locusClusterUrl: meeting.meetingInfo?.locusClusterUrl,
         correlationId: meeting.correlationId,
-        reachability: options.reachability,
+        reachability,
         roapMessage: options.roapMessage,
         permissionToken: meeting.permissionToken,
         resourceId: options.resourceId || null,
         moderator: options.moderator,
         pin: options.pin,
         moveToResource: options.moveToResource,
-        preferTranscoding: !meeting.isMultistream,
         asResourceOccupant: options.asResourceOccupant,
         breakoutsSupported: options.breakoutsSupported,
         locale: options.locale,
         deviceCapabilities: options.deviceCapabilities,
         liveAnnotationSupported: options.liveAnnotationSupported,
-        ipVersion: MeetingUtil.getIpVersion(meeting.getWebexObject()),
+        clientMediaPreferences,
       })
       .then((res) => {
         const parsed = MeetingUtil.parseLocusJoin(res);
@@ -177,6 +201,7 @@ const MeetingUtil = {
 
   cleanUp: (meeting) => {
     meeting.getWebexObject().internal.device.meetingEnded();
+    meeting.stopPeriodicLogUpload();
 
     meeting.breakouts.cleanUp();
     meeting.simultaneousInterpretation.cleanUp();
@@ -420,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],
@@ -475,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

@@ -17,8 +17,23 @@ const CAPTCHA_ERROR_DEFAULT_MESSAGE =
 const ADHOC_MEETING_DEFAULT_ERROR =
   'Failed starting the adhoc meeting, Please contact support team ';
 const CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES = [423005, 423006];
+const CAPTCHA_ERROR_REQUIRES_REGISTRATION_ID_CODES = [423007];
+
 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
  */
@@ -100,6 +115,7 @@ export class MeetingInfoV2PolicyError extends Error {
 export class MeetingInfoV2CaptchaError extends Error {
   captchaInfo: any;
   isPasswordRequired: any;
+  isRegistrationIdRequired: any;
   sdkMessage: any;
   wbxAppApiCode: any;
   body: any;
@@ -121,14 +137,41 @@ export class MeetingInfoV2CaptchaError extends Error {
     this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
     this.isPasswordRequired = CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES.includes(wbxAppApiErrorCode);
+    this.isRegistrationIdRequired =
+      CAPTCHA_ERROR_REQUIRES_REGISTRATION_ID_CODES.includes(wbxAppApiErrorCode);
     this.captchaInfo = captchaInfo;
   }
 }
 
 /**
- * Error preventing join because of a webinar registration error
+ * Error preventing join because of a webinar have some error
+ */
+export class MeetingInfoV2JoinWebinarError 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 = '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 MeetingInfoV2WebinarRegistrationError extends Error {
+export class MeetingInfoV2JoinForbiddenError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
@@ -142,7 +185,7 @@ export class MeetingInfoV2WebinarRegistrationError extends Error {
    */
   constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
-    this.name = 'MeetingInfoV2WebinarRegistrationError';
+    this.name = 'MeetingInfoV2JoinForbiddenError';
     this.sdkMessage = message;
     this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
@@ -204,21 +247,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 +352,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,
@@ -308,6 +375,7 @@ export default class MeetingInfoV2 {
    * @param {String} locusId
    * @param {Object} extraParams
    * @param {Object} options
+   * @param {String} registrationId
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -323,7 +391,8 @@ export default class MeetingInfoV2 {
     installedOrgID = null,
     locusId = null,
     extraParams: object = {},
-    options: {meetingId?: string; sendCAevents?: boolean} = {}
+    options: {meetingId?: string; sendCAevents?: boolean} = {},
+    registrationId: string = null
   ) {
     const {meetingId, sendCAevents} = options;
 
@@ -348,6 +417,7 @@ export default class MeetingInfoV2 {
       installedOrgID,
       locusId,
       extraParams,
+      registrationId,
     });
 
     // If the body only contains the default properties, we don't have enough to
@@ -441,7 +511,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;
@@ -226,8 +228,16 @@ export default class MeetingInfoUtil {
    * @returns {Object} returns an object with {resource, method}
    */
   static getRequestBody(options: {type: DESTINATION_TYPE; destination: object} | any) {
-    const {type, destination, password, captchaInfo, installedOrgID, locusId, extraParams} =
-      options;
+    const {
+      type,
+      destination,
+      password,
+      captchaInfo,
+      installedOrgID,
+      locusId,
+      extraParams,
+      registrationId,
+    } = options;
     const body: any = {
       ...DEFAULT_MEETING_INFO_REQUEST_BODY,
       ...extraParams,
@@ -269,6 +279,10 @@ export default class MeetingInfoUtil {
       body.password = password;
     }
 
+    if (registrationId) {
+      body.registrationId = registrationId;
+    }
+
     if (captchaInfo) {
       body.captchaID = captchaInfo.id;
       body.captchaVerifyCode = captchaInfo.code;