@webex/plugin-meetings 3.7.0-next.63 → 3.7.0-next.64

package/dist/types/metrics/constants.d.ts

@@ -70,6 +70,8 @@ declare const BEHAVIORAL_METRICS: {
     JOIN_WEBINAR_ERROR: string;
     GUEST_ENTERED_LOBBY: string;
     GUEST_EXITED_LOBBY: string;
+    VERIFY_REGISTRATION_ID_SUCCESS: string;
+    VERIFY_REGISTRATION_ID_ERROR: string;
     JOIN_FORBIDDEN_ERROR: string;
 };
 export { BEHAVIORAL_METRICS as default };

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.7.0-next.63"
+  version: "3.7.0-next.64"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.7.0-next.63",
+    "@webex/plugin-meetings": "3.7.0-next.64",
     "@webex/plugin-rooms": "3.7.0-next.25",
     "@webex/test-helper-chai": "3.7.0-next.18",
     "@webex/test-helper-mocha": "3.7.0-next.18",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.7.0-next.18",
     "@webex/internal-plugin-support": "3.7.0-next.26",
     "@webex/internal-plugin-user": "3.7.0-next.18",
-    "@webex/internal-plugin-voicea": "3.7.0-next.63",
+    "@webex/internal-plugin-voicea": "3.7.0-next.64",
     "@webex/media-helpers": "3.7.0-next.24",
     "@webex/plugin-people": "3.7.0-next.23",
     "@webex/plugin-rooms": "3.7.0-next.25",
@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.7.0-next.63"
+  "version": "3.7.0-next.64"
 }

package/src/constants.ts

@@ -202,7 +202,7 @@ export const RETRY_TIMEOUT = 3000;
 export const ICE_AND_DTLS_CONNECTION_TIMEOUT = 20000;
 export const ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT = 35000;
 export const WEBINAR_ERROR_WEBCAST = [403026];
-export const WEBINAR_ERROR_REGISTRATIONID = [403037, 403137];
+export const WEBINAR_ERROR_REGISTRATION_ID = [403037, 403137];
 export const JOIN_BEFORE_HOST = 403003;
 
 // ******************** REGEX **********************
@@ -1331,14 +1331,22 @@ export const PASSWORD_STATUS = {
   VERIFIED: 'VERIFIED', // client has already provided the password and it has been verified, client can proceed to call join()
 };
 
+export const REGISTRATION_ID_STATUS = {
+  NOT_REQUIRED: 'NOT_REQUIRED', // registrationId is not required to join the meeting
+  REQUIRED: 'REQUIRED', // client needs to provide the registrationId by calling verifyRegistrationId() before calling join()
+  UNKNOWN: 'UNKNOWN', // we are waiting for information from the backend if registrationId is required or not
+  VERIFIED: 'VERIFIED', // client has already provided the registrationId and it has been verified, client can proceed to call join()
+};
+
 export const MEETING_INFO_FAILURE_REASON = {
   NONE: 'NONE', // meeting info was retrieved succesfully
   WRONG_PASSWORD: 'WRONG_PASSWORD', // meeting requires password and no password or wrong one was provided
   WRONG_CAPTCHA: 'WRONG_CAPTCHA', // wbxappapi requires a captcha code or a wrong captcha code was provided
+  WRONG_REGISTRATION_ID: 'WRONG_REGISTRATION_ID', // meeting requires registrationId and no registrationId or wrong one was provided
   POLICY: 'POLICY', // meeting info request violates some meeting policy
   WEBINAR_REGISTRATION: 'WEBINAR_REGISTRATION', // webinar need registration
   NEED_JOIN_WITH_WEBCAST: 'NEED_JOIN_WITH_WEBCAST', // webinar need using webcast join
-  WEBINAR_NEED_REGISTRATIONID: 'WEBINAR_NEED_REGISTRATIONID', // webinar need registrationID
+  WEBINAR_NEED_REGISTRATION_ID: 'WEBINAR_NEED_REGISTRATION_ID', // webinar need registrationID
   NOT_REACH_JBH: 'NOT_REACH_JBH', // Meeting is not allow to access since not reach JBH (join before host) time
   JOIN_FORBIDDEN: 'JOIN_FORBIDDEN', // meeting is not allow join
   OTHER: 'OTHER', // any other error (network, etc)

package/src/meeting/index.ts

@@ -122,8 +122,9 @@ import {
   ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT,
   NAMED_MEDIA_GROUP_TYPE_AUDIO,
   WEBINAR_ERROR_WEBCAST,
-  WEBINAR_ERROR_REGISTRATIONID,
+  WEBINAR_ERROR_REGISTRATION_ID,
   JOIN_BEFORE_HOST,
+  REGISTRATION_ID_STATUS,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import ParameterError from '../common/errors/parameter';
@@ -256,6 +257,7 @@ export enum ScreenShareFloorStatus {
 
 type FetchMeetingInfoParams = {
   password?: string;
+  registrationId?: string;
   captchaCode?: string;
   extraParams?: Record<string, any>;
   sendCAevents?: boolean;
@@ -650,6 +652,7 @@ export default class Meeting extends StatelessWebexPlugin {
   turnServerUsed: boolean;
   areVoiceaEventsSetup = false;
   isMoveToInProgress = false;
+  registrationIdStatus: string;
   brbState: BrbState;
 
   voiceaListenerCallbacks: object = {
@@ -1347,6 +1350,16 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.passwordStatus = PASSWORD_STATUS.UNKNOWN;
 
+    /**
+     * registrationId status. If it's REGISTRATIONID_STATUS.REQUIRED then verifyRegistrationId() needs to be called
+     * with the correct registrationId before calling join()
+     * @instance
+     * @type {REGISTRATION_ID_STATUS}
+     * @public
+     * @memberof Meeting
+     */
+    this.registrationIdStatus = REGISTRATION_ID_STATUS.UNKNOWN;
+
     /**
      * Information about required captcha. If null, then no captcha is required. status. If it's PASSWORD_STATUS.REQUIRED then verifyPassword() needs to be called
      * with the correct password before calling join()
@@ -1659,6 +1672,15 @@ export default class Meeting extends StatelessWebexPlugin {
       this.passwordStatus = PASSWORD_STATUS.NOT_REQUIRED;
     }
 
+    if (
+      this.registrationIdStatus === REGISTRATION_ID_STATUS.REQUIRED ||
+      this.registrationIdStatus === REGISTRATION_ID_STATUS.VERIFIED
+    ) {
+      this.registrationIdStatus = REGISTRATION_ID_STATUS.VERIFIED;
+    } else {
+      this.registrationIdStatus = REGISTRATION_ID_STATUS.NOT_REQUIRED;
+    }
+
     Trigger.trigger(
       this,
       {
@@ -1702,7 +1724,12 @@ export default class Meeting extends StatelessWebexPlugin {
    * @private
    */
   private prepForFetchMeetingInfo(
-    {password = null, captchaCode = null, extraParams = {}}: FetchMeetingInfoParams,
+    {
+      password = null,
+      registrationId = null,
+      captchaCode = null,
+      extraParams = {},
+    }: FetchMeetingInfoParams,
     caller: string
   ): Promise<void> {
     // when fetch meeting info is called directly by the client, we want to clear out the random timer for sdk to do it
@@ -1742,6 +1769,7 @@ export default class Meeting extends StatelessWebexPlugin {
     captchaCode = null,
     extraParams = {},
     sendCAevents = false,
+    registrationId = null,
   }): Promise<void> {
     try {
       const captchaInfo = captchaCode
@@ -1757,7 +1785,8 @@ export default class Meeting extends StatelessWebexPlugin {
         this.config.installedOrgID,
         this.locusId,
         extraParams,
-        {meetingId: this.id, sendCAevents}
+        {meetingId: this.id, sendCAevents},
+        registrationId
       );
 
       this.parseMeetingInfo(info?.body, this.destination, info?.errors);
@@ -1779,14 +1808,15 @@ export default class Meeting extends StatelessWebexPlugin {
         this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_REGISTRATION;
         if (WEBINAR_ERROR_WEBCAST.includes(err.wbxAppApiCode)) {
           this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.NEED_JOIN_WITH_WEBCAST;
-        } else if (WEBINAR_ERROR_REGISTRATIONID.includes(err.wbxAppApiCode)) {
-          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATIONID;
+        } else if (WEBINAR_ERROR_REGISTRATION_ID.includes(err.wbxAppApiCode)) {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATION_ID;
         }
         this.meetingInfoFailureCode = err.wbxAppApiCode;
 
         if (err.meetingInfo) {
           this.meetingInfo = err.meetingInfo;
         }
+        this.requiredCaptcha = null;
 
         throw new JoinWebinarError();
       } else if (err instanceof MeetingInfoV2JoinForbiddenError) {
@@ -1831,9 +1861,13 @@ export default class Meeting extends StatelessWebexPlugin {
           `Meeting:index#fetchMeetingInfo --> Info Unable to fetch meeting info for ${this.destination} - captcha required (code=${err?.body?.code}).`
         );
 
-        this.meetingInfoFailureReason = this.requiredCaptcha
-          ? MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA
-          : MEETING_INFO_FAILURE_REASON.WRONG_PASSWORD;
+        if (this.requiredCaptcha) {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA;
+        } else if (err.isRegistrationIdRequired) {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATION_ID;
+        } else {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_PASSWORD;
+        }
 
         this.meetingInfoFailureCode = err.wbxAppApiCode;
 
@@ -1841,6 +1875,10 @@ export default class Meeting extends StatelessWebexPlugin {
           this.passwordStatus = PASSWORD_STATUS.REQUIRED;
         }
 
+        if (err.isRegistrationIdRequired) {
+          this.registrationIdStatus = REGISTRATION_ID_STATUS.REQUIRED;
+        }
+
         this.requiredCaptcha = err.captchaInfo;
         throw new CaptchaError();
       } else {
@@ -1981,6 +2019,48 @@ export default class Meeting extends StatelessWebexPlugin {
       });
   }
 
+  /**
+   * Checks if the supplied registrationId is correct. It returns a promise with information whether the
+   * registrationId and captcha code were correct or not.
+   * @param {String | undefined} registrationId - can be undefined if only captcha was required
+   * @param {String | undefined} captchaCode - can be undefined if captcha was not required by the server
+   * @param {Boolean} sendCAevents - whether Call Analyzer events should be sent when fetching meeting information
+   * @public
+   * @memberof Meeting
+   * @returns {Promise<{isRegistrationIdValid: boolean, requiredCaptcha: boolean, failureReason: MEETING_INFO_FAILURE_REASON}>}
+   */
+  public verifyRegistrationId(registrationId: string, captchaCode: string, sendCAevents = false) {
+    return this.fetchMeetingInfo({
+      registrationId,
+      captchaCode,
+      sendCAevents,
+    })
+      .then(() => {
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_REGISTRATION_ID_SUCCESS);
+
+        return {
+          isRegistrationIdValid: true,
+          requiredCaptcha: null,
+          failureReason: MEETING_INFO_FAILURE_REASON.NONE,
+        };
+      })
+      .catch((error) => {
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_REGISTRATION_ID_ERROR);
+
+        if (error instanceof JoinWebinarError || error instanceof CaptchaError) {
+          return {
+            isRegistrationIdValid: this.registrationIdStatus === REGISTRATION_ID_STATUS.VERIFIED,
+            requiredCaptcha: this.requiredCaptcha,
+            failureReason:
+              error instanceof JoinWebinarError
+                ? MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATION_ID
+                : this.meetingInfoFailureReason,
+          };
+        }
+        throw error;
+      });
+  }
+
   /**
    * Refreshes the captcha. As a result the meeting will have new captcha id, image and audio.
    * If the refresh operation fails, meeting remains with the old captcha properties.

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

@@ -17,6 +17,8 @@ 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 JOIN_FORBIDDEN_CODES = [403003];
 /**
@@ -113,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;
@@ -134,6 +137,8 @@ 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;
   }
 }
@@ -370,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
@@ -385,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;
 
@@ -410,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

package/src/meeting-info/utilv2.ts

@@ -228,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,
@@ -271,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;

package/src/metrics/constants.ts

@@ -73,6 +73,8 @@ const BEHAVIORAL_METRICS = {
   JOIN_WEBINAR_ERROR: 'js_sdk_join_webinar_error',
   GUEST_ENTERED_LOBBY: 'js_sdk_guest_entered_lobby',
   GUEST_EXITED_LOBBY: 'js_sdk_guest_exited_lobby',
+  VERIFY_REGISTRATION_ID_SUCCESS: 'js_sdk_verify_registrationId_success',
+  VERIFY_REGISTRATION_ID_ERROR: 'js_sdk_verify_registrationId_error',
   JOIN_FORBIDDEN_ERROR: 'js_sdk_join_forbidden_error',
 };
 

package/test/unit/spec/meeting/index.js

@@ -6792,7 +6792,7 @@ describe('plugin-meetings', () => {
           assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
           assert.equal(
             meeting.meetingInfoFailureReason,
-            MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATIONID
+            MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATION_ID
           );
         });
       });
@@ -6852,7 +6852,8 @@ describe('plugin-meetings', () => {
             'fake-installed-org-id',
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -6897,7 +6898,8 @@ describe('plugin-meetings', () => {
             'fake-installed-org-id',
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -6951,7 +6953,8 @@ describe('plugin-meetings', () => {
               extraParam1: 'value1',
               permissionToken: FAKE_PERMISSION_TOKEN,
             },
-            {meetingId: meeting.id, sendCAevents: true}
+            {meetingId: meeting.id, sendCAevents: true},
+            null
           );
           assert.deepEqual(meeting.meetingInfo, {
             ...FAKE_MEETING_INFO,
@@ -13309,4 +13312,53 @@ describe('plugin-meetings', () => {
       assert.equal(meeting.mediaProperties.webrtcMediaConnection.mediaServer, 'linus'); // check that it hasn't been overwritten
     });
   });
+
+  describe('#verifyRegistrationId', () => {
+    it('calls fetchMeetingInfo() with the passed registrationId and captcha code', async () => {
+      // simulate successful case
+      meeting.fetchMeetingInfo = sinon.stub().resolves();
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert(Metrics.sendBehavioralMetric.calledOnce);
+      assert.calledWith(
+        Metrics.sendBehavioralMetric,
+        BEHAVIORAL_METRICS.VERIFY_REGISTRATION_ID_SUCCESS
+      );
+      assert.equal(result.isRegistrationIdValid, true);
+      assert.equal(result.requiredCaptcha, null);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.NONE);
+      assert.calledWith(meeting.fetchMeetingInfo, {
+        registrationId: 'registrationId',
+        captchaCode: 'captcha id',
+        sendCAevents: false,
+      });
+    });
+    it('handles registrationIdError returned by fetchMeetingInfo', async () => {
+      meeting.fetchMeetingInfo = sinon.stub().callsFake(() => {
+        meeting.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATIONID;
+
+        return Promise.reject(new JoinWebinarError());
+      });
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert.equal(result.isRegistrationIdValid, false);
+      assert.equal(result.requiredCaptcha, null);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.WRONG_REGISTRATION_ID);
+    });
+    it('handles CaptchaError returned by fetchMeetingInfo', async () => {
+      const FAKE_CAPTCHA = {captchaId: 'some catcha id...'};
+
+      meeting.fetchMeetingInfo = sinon.stub().callsFake(() => {
+        meeting.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA;
+        meeting.requiredCaptcha = FAKE_CAPTCHA;
+
+        return Promise.reject(new CaptchaError());
+      });
+      const result = await meeting.verifyRegistrationId('registrationId', 'captcha id');
+
+      assert.equal(result.isRegistrationIdValid, false);
+      assert.deepEqual(result.requiredCaptcha, FAKE_CAPTCHA);
+      assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.WRONG_CAPTCHA);
+    });
+  });
 });

package/test/unit/spec/meeting-info/utilv2.js

@@ -192,6 +192,15 @@ describe('plugin-meetings', () => {
         assert.equal(res.meetingUUID, 'xsddsdsdsdssdsdsdsdsd');
       });
 
+      it('for registrationId', () => {
+        const res = MeetingInfoUtil.getRequestBody({
+          type: DESTINATION_TYPE.MEETING_UUID,
+          registrationId: 'registrationId',
+        });
+
+        assert.equal(res.registrationId, 'registrationId');
+      });
+
       it('for DESTINATION_TYPE.LOCUS_ID', () => {
         const res = MeetingInfoUtil.getRequestBody({
           type: DESTINATION_TYPE.LOCUS_ID,