@webex/plugin-meetings 3.6.0-next.3 → 3.6.0-next.4

package/dist/types/constants.d.ts

@@ -406,6 +406,11 @@ export declare const ERROR_DICTIONARY: {
         MESSAGE: string;
         CODE: number;
     };
+    WebinarRegistrationError: {
+        NAME: string;
+        MESSAGE: string;
+        CODE: number;
+    };
 };
 export declare const FLOOR_ACTION: {
     GRANTED: string;
@@ -1058,6 +1063,7 @@ export declare const MEETING_INFO_FAILURE_REASON: {
     WRONG_PASSWORD: string;
     WRONG_CAPTCHA: string;
     POLICY: string;
+    WEBINAR_REGISTRATION: string;
     OTHER: string;
 };
 export declare const BNR_STATUS: {

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ import CaptchaError from './common/errors/captcha-error';
 import IntentToJoinError from './common/errors/intent-to-join';
 import PasswordError from './common/errors/password-error';
 import PermissionError from './common/errors/permission';
+import WebinarRegistrationError from './common/errors/webinar-registration-error';
 import { ReclaimHostEmptyWrongKeyError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError } from './common/errors/reclaim-host-role-errors';
 import Meeting from './meeting';
 import MeetingInfoUtil from './meeting-info/utilv2';
@@ -14,6 +15,6 @@ export * as REACTIONS from './reactions/reactions';
 export * as sdkAnnotationTypes from './annotation/annotation.types';
 export * as MeetingInfoV2 from './meeting-info/meeting-info-v2';
 export { type Reaction } from './reactions/reactions.type';
-export { CaptchaError, IntentToJoinError, JoinMeetingError, PasswordError, PermissionError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError, ReclaimHostEmptyWrongKeyError, Meeting, MeetingInfoUtil, };
+export { CaptchaError, IntentToJoinError, JoinMeetingError, PasswordError, PermissionError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError, ReclaimHostEmptyWrongKeyError, Meeting, MeetingInfoUtil, WebinarRegistrationError, };
 export { RemoteMedia } from './multistream/remoteMedia';
 export { default as TriggerProxy } from './common/events/trigger-proxy';

package/dist/types/meeting-info/meeting-info-v2.d.ts

@@ -64,6 +64,23 @@ export declare class MeetingInfoV2CaptchaError extends Error {
      */
     constructor(wbxAppApiErrorCode?: number, captchaInfo?: object, message?: string);
 }
+/**
+ * Error preventing join because of a webinar registration error
+ */
+export declare class MeetingInfoV2WebinarRegistrationError 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);
+}
 /**
  * @class MeetingInfo
  */
@@ -89,6 +106,12 @@ export default class MeetingInfoV2 {
      * @returns {void}
      */
     handlePolicyError: (err: any) => void;
+    /**
+     * Raises a handleWebinarRegistrationError for webinar registration error codes
+     * @param {any} err the error from the request
+     * @returns {void}
+     */
+    handleWebinarRegistrationError: (err: any) => void;
     /**
      * Creates adhoc space meetings for a space by fetching the conversation infomation
      * @param {String} conversationUrl conversationUrl to start adhoc meeting on

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

@@ -67,5 +67,6 @@ declare const BEHAVIORAL_METRICS: {
     ROAP_HTTP_RESPONSE_MISSING: string;
     TURN_DISCOVERY_REQUIRES_OK: string;
     REACHABILITY_COMPLETED: string;
+    WEBINAR_REGISTRATION_ERROR: string;
 };
 export { BEHAVIORAL_METRICS as default };

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.6.0-next.3"
+  version: "3.6.0-next.4"
 });
 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.6.0-next.3",
+    "@webex/plugin-meetings": "3.6.0-next.4",
     "@webex/plugin-rooms": "3.5.0-next.23",
     "@webex/test-helper-chai": "3.5.0-next.21",
     "@webex/test-helper-mocha": "3.5.0-next.21",
@@ -70,7 +70,7 @@
     "@webex/internal-plugin-metrics": "3.5.0-next.21",
     "@webex/internal-plugin-support": "3.5.0-next.23",
     "@webex/internal-plugin-user": "3.5.0-next.21",
-    "@webex/internal-plugin-voicea": "3.6.0-next.3",
+    "@webex/internal-plugin-voicea": "3.6.0-next.4",
     "@webex/media-helpers": "3.5.0-next.22",
     "@webex/plugin-people": "3.5.0-next.21",
     "@webex/plugin-rooms": "3.5.0-next.23",
@@ -91,5 +91,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.6.0-next.3"
+  "version": "3.6.0-next.4"
 }

package/src/common/errors/webinar-registration-error.ts

@@ -0,0 +1,27 @@
+import {ERROR_DICTIONARY} from '../../constants';
+
+/**
+ * Error occurred while the webinar required registration
+ */
+export default class WebinarRegistrationError extends Error {
+  code: number;
+  error: any;
+  sdkMessage: string;
+
+  /**
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = ERROR_DICTIONARY.WebinarRegistrationError.MESSAGE,
+    error: any = null
+  ) {
+    super(message);
+    this.name = ERROR_DICTIONARY.WebinarRegistrationError.NAME;
+    this.sdkMessage = ERROR_DICTIONARY.WebinarRegistrationError.MESSAGE;
+    this.error = error;
+    this.stack = error ? error.stack : new Error().stack;
+    this.code = ERROR_DICTIONARY.WebinarRegistrationError.CODE;
+  }
+}

package/src/constants.ts

@@ -524,6 +524,11 @@ export const ERROR_DICTIONARY = {
       'Reconnection was not started, because there is one already in progress or reconnections are disabled in config.',
     CODE: 15,
   },
+  WebinarRegistrationError: {
+    NAME: 'WebinarRegistrationError',
+    MESSAGE: 'An error occurred while the webinar required registration.',
+    CODE: 16,
+  },
 };
 
 export const FLOOR_ACTION = {
@@ -1269,6 +1274,7 @@ export const MEETING_INFO_FAILURE_REASON = {
   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
   POLICY: 'POLICY', // meeting info request violates some meeting policy
+  WEBINAR_REGISTRATION: 'WEBINAR_REGISTRATION', // webinar need registration
   OTHER: 'OTHER', // any other error (network, etc)
 };
 

package/src/index.ts

@@ -8,6 +8,7 @@ import CaptchaError from './common/errors/captcha-error';
 import IntentToJoinError from './common/errors/intent-to-join';
 import PasswordError from './common/errors/password-error';
 import PermissionError from './common/errors/permission';
+import WebinarRegistrationError from './common/errors/webinar-registration-error';
 import {
   ReclaimHostEmptyWrongKeyError,
   ReclaimHostIsHostAlreadyError,
@@ -68,6 +69,7 @@ export {
   ReclaimHostEmptyWrongKeyError,
   Meeting,
   MeetingInfoUtil,
+  WebinarRegistrationError,
 };
 
 export {RemoteMedia} from './multistream/remoteMedia';

package/src/meeting/index.ts

@@ -128,6 +128,7 @@ import {
   MeetingInfoV2PasswordError,
   MeetingInfoV2CaptchaError,
   MeetingInfoV2PolicyError,
+  MeetingInfoV2WebinarRegistrationError,
 } from '../meeting-info/meeting-info-v2';
 import {CSI, ReceiveSlotManager} from '../multistream/receiveSlotManager';
 import SendSlotManager from '../multistream/sendSlotManager';
@@ -156,6 +157,7 @@ import ControlsOptionsManager from '../controls-options-manager';
 import PermissionError from '../common/errors/permission';
 import {LocusMediaRequest} from './locusMediaRequest';
 import {ConnectionStateHandler, ConnectionStateEvent} from './connectionStateHandler';
+import WebinarRegistrationError from '../common/errors/webinar-registration-error';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -1759,8 +1761,16 @@ export default class Meeting extends StatelessWebexPlugin {
         if (err.meetingInfo) {
           this.meetingInfo = err.meetingInfo;
         }
-
         throw new PermissionError();
+      } else if (err instanceof MeetingInfoV2WebinarRegistrationError) {
+        this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_REGISTRATION;
+        this.meetingInfoFailureCode = err.wbxAppApiCode;
+
+        if (err.meetingInfo) {
+          this.meetingInfo = err.meetingInfo;
+        }
+
+        throw new WebinarRegistrationError();
       } else if (err instanceof MeetingInfoV2PasswordError) {
         LoggerProxy.logger.info(
           // @ts-ignore

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

@@ -18,6 +18,7 @@ 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];
 /**
  * Error to indicate that wbxappapi requires a password
  */
@@ -124,6 +125,31 @@ export class MeetingInfoV2CaptchaError extends Error {
   }
 }
 
+/**
+ * Error preventing join because of a webinar registration error
+ */
+export class MeetingInfoV2WebinarRegistrationError 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 = 'MeetingInfoV2WebinarRegistrationError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.meetingInfo = meetingInfo;
+  }
+}
+
 /**
  * @class MeetingInfo
  */
@@ -177,6 +203,29 @@ export default class MeetingInfoV2 {
     }
   };
 
+  /**
+   * Raises a handleWebinarRegistrationError for webinar registration error codes
+   * @param {any} err the error from the request
+   * @returns {void}
+   */
+  handleWebinarRegistrationError = (err) => {
+    if (!err.body) {
+      return;
+    }
+
+    if (WEBINAR_REGISTRATION_ERROR_CODES.includes(err.body?.code)) {
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.WEBINAR_REGISTRATION_ERROR, {
+        code: err.body?.code,
+      });
+
+      throw new MeetingInfoV2WebinarRegistrationError(
+        err.body?.code,
+        err.body?.data?.meetingInfo,
+        err.body?.message
+      );
+    }
+  };
+
   /**
    * Creates adhoc space meetings for a space by fetching the conversation infomation
    * @param {String} conversationUrl conversationUrl to start adhoc meeting on
@@ -237,6 +286,7 @@ export default class MeetingInfoV2 {
       })
       .catch((err) => {
         this.handlePolicyError(err);
+        this.handleWebinarRegistrationError(err);
 
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
           reason: err.message,
@@ -391,6 +441,7 @@ export default class MeetingInfoV2 {
 
         if (err?.statusCode === 403) {
           this.handlePolicyError(err);
+          this.handleWebinarRegistrationError(err);
 
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
             reason: err.message,

package/src/meetings/index.ts

@@ -56,6 +56,7 @@ import MeetingCollection from './collection';
 import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
+import WebinarRegistrationError from '../common/errors/webinar-registration-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 
@@ -1397,7 +1398,8 @@ export default class Meetings extends WebexPlugin {
       if (
         !(err instanceof CaptchaError) &&
         !(err instanceof PasswordError) &&
-        !(err instanceof PermissionError)
+        !(err instanceof PermissionError) &&
+        !(err instanceof WebinarRegistrationError)
       ) {
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`

package/src/metrics/constants.ts

@@ -70,6 +70,7 @@ const BEHAVIORAL_METRICS = {
   ROAP_HTTP_RESPONSE_MISSING: 'js_sdk_roap_http_response_missing',
   TURN_DISCOVERY_REQUIRES_OK: 'js_sdk_turn_discovery_requires_ok',
   REACHABILITY_COMPLETED: 'js_sdk_reachability_completed',
+  WEBINAR_REGISTRATION_ERROR: 'js_sdk_webinar_registration_error',
 };
 
 export {BEHAVIORAL_METRICS as default};

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

@@ -90,13 +90,15 @@ import WebExMeetingsErrors from '../../../../src/common/errors/webex-meetings-er
 import ParameterError from '../../../../src/common/errors/parameter';
 import PasswordError from '../../../../src/common/errors/password-error';
 import CaptchaError from '../../../../src/common/errors/captcha-error';
-import PermissionError from '../../../../src/common/errors/permission';
+import PermissionError   from '../../../../src/common/errors/permission';
+import WebinarRegistrationError   from '../../../../src/common/errors/webinar-registration-error';
 import IntentToJoinError from '../../../../src/common/errors/intent-to-join';
 import testUtils from '../../../utils/testUtils';
 import {
   MeetingInfoV2CaptchaError,
   MeetingInfoV2PasswordError,
   MeetingInfoV2PolicyError,
+  MeetingInfoV2WebinarRegistrationError,
 } from '../../../../src/meeting-info/meeting-info-v2';
 import {
   DTLS_HANDSHAKE_FAILED_CLIENT_CODE,
@@ -6254,6 +6256,22 @@ describe('plugin-meetings', () => {
 
           assert.equal(meeting.fetchMeetingInfoTimeoutId, undefined);
         });
+
+        it('handles meetingInfoProvider webinar need registration error', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
+          meeting.attrs.meetingInfoProvider = {
+            fetchMeetingInfo: sinon
+              .stub()
+              .throws(new MeetingInfoV2WebinarRegistrationError(403021, FAKE_MEETING_INFO, 'a message')),
+          };
+
+          await assert.isRejected(meeting.fetchMeetingInfo({sendCAevents: true}), WebinarRegistrationError);
+
+          assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
+          assert.equal(meeting.meetingInfoFailureCode, 403021);
+          assert.equal(meeting.meetingInfoFailureReason, MEETING_INFO_FAILURE_REASON.WEBINAR_REGISTRATION);
+        });
       });
 
       describe('#refreshPermissionToken', () => {

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

@@ -18,6 +18,7 @@ import MeetingInfo, {
   MeetingInfoV2CaptchaError,
   MeetingInfoV2AdhocMeetingError,
   MeetingInfoV2PolicyError,
+  MeetingInfoV2WebinarRegistrationError,
 } from '@webex/plugin-meetings/src/meeting-info/meeting-info-v2';
 import MeetingInfoUtil from '@webex/plugin-meetings/src/meeting-info/utilv2';
 import Metrics from '@webex/plugin-meetings/src/metrics';
@@ -888,6 +889,42 @@ describe('plugin-meetings', () => {
           });
         }
       );
+
+      forEach(
+        [
+          {errorCode: 403021},
+          {errorCode: 403022},
+          {errorCode: 403024},
+        ],
+        ({errorCode}) => {
+          it(`should throw a MeetingInfoV2WebinarRegistrationError for error code ${errorCode}`, async () => {
+            const message = 'a message';
+            const meetingInfoData = {meetingInfo: {registrationUrl: 'registrationUrl'}};
+
+            webex.request = sinon.stub().rejects({
+              statusCode: 403,
+              body: {message, code: errorCode, data: {meetingInfo: meetingInfoData}},
+            });
+            try {
+              await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+              assert.fail('createAdhocSpaceMeeting should have thrown, but has not done that');
+            } catch (err) {
+              assert.instanceOf(err, MeetingInfoV2WebinarRegistrationError);
+              assert.deepEqual(err.message, `${message}, code=${errorCode}`);
+              assert.equal(err.wbxAppApiCode, errorCode);
+              assert.deepEqual(err.meetingInfo, meetingInfoData);
+
+              assert(Metrics.sendBehavioralMetric.calledOnce);
+              assert.calledWith(
+                Metrics.sendBehavioralMetric,
+                BEHAVIORAL_METRICS.WEBINAR_REGISTRATION_ERROR,
+                {code: errorCode}
+              );
+
+            }
+          });
+        }
+      );
     });
   });
 });