@webex/internal-plugin-metrics 3.8.0-web-workers-keepalive.1 → 3.8.1-next.1

package/dist/types/new-metrics.d.ts

@@ -3,7 +3,7 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -22,6 +22,10 @@ declare class Metrics extends WebexPlugin {
      * Whether or not to delay the submission of client events.
      */
     delaySubmitClientEvents: boolean;
+    /**
+     * Overrides for delayed client events. E.g. if you want to override the correlationId for all delayed client events, you can set this to { correlationId: 'newCorrelationId' }
+     */
+    delayedClientEventsOverrides: Partial<DelayedClientEvent['options']>;
     /**
      * Constructor
      * @param args
@@ -178,8 +182,11 @@ declare class Metrics extends WebexPlugin {
      * Sets the value of delaySubmitClientEvents. If set to true, client events will be delayed until submitDelayedClientEvents is called. If
      * set to false, delayed client events will be submitted.
      *
-     * @param {boolean} shouldDelay - A boolean value indicating whether to delay the submission of client events.
+     * @param {object} options - {shouldDelay: A boolean value indicating whether to delay the submission of client events, overrides: An object containing overrides for the client events}
      */
-    setDelaySubmitClientEvents(shouldDelay: boolean): Promise<any[]> | Promise<void>;
+    setDelaySubmitClientEvents({ shouldDelay, overrides, }: {
+        shouldDelay: boolean;
+        overrides?: Partial<DelayedClientEvent['options']>;
+    }): Promise<any[]> | Promise<void>;
 }
 export default Metrics;

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.8.0-web-workers-keepalive.1",
-    "@webex/test-helper-mocha": "3.8.0-web-workers-keepalive.1",
-    "@webex/test-helper-mock-webex": "3.8.0-web-workers-keepalive.1",
-    "@webex/test-helper-test-users": "3.8.0-web-workers-keepalive.1",
+    "@webex/test-helper-chai": "3.8.1-next.1",
+    "@webex/test-helper-mocha": "3.8.1-next.1",
+    "@webex/test-helper-mock-webex": "3.8.1-next.1",
+    "@webex/test-helper-test-users": "3.8.1-next.1",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0-web-workers-keepalive.1",
-    "@webex/common-timers": "3.8.0-web-workers-keepalive.1",
-    "@webex/event-dictionary-ts": "^1.0.1688",
-    "@webex/internal-plugin-metrics": "3.8.0-web-workers-keepalive.1",
-    "@webex/test-helper-chai": "3.8.0-web-workers-keepalive.1",
-    "@webex/test-helper-mock-webex": "3.8.0-web-workers-keepalive.1",
-    "@webex/webex-core": "3.8.0-web-workers-keepalive.1",
+    "@webex/common": "3.8.1-next.1",
+    "@webex/common-timers": "3.8.1-next.1",
+    "@webex/event-dictionary-ts": "^1.0.1753",
+    "@webex/internal-plugin-metrics": "3.8.1-next.1",
+    "@webex/test-helper-chai": "3.8.1-next.1",
+    "@webex/test-helper-mock-webex": "3.8.1-next.1",
+    "@webex/webex-core": "3.8.1-next.1",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.8.0-web-workers-keepalive.1"
+  "version": "3.8.1-next.1"
 }

package/src/call-diagnostic/call-diagnostic-metrics.ts

@@ -97,6 +97,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private hasLoggedBrowserSerial: boolean;
   private device: any;
   private delayedClientEvents: DelayedClientEvent[] = [];
+  private eventErrorCache: WeakMap<any, any> = new WeakMap();
+  private isMercuryConnected = false;
 
   // the default validator before piping an event to the batcher
   // this function can be overridden by the user
@@ -149,6 +151,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return undefined;
   }
 
+  /**
+   * Sets mercury connected status for event data object in CA events
+   * @public
+   * @param status - boolean value indicating mercury connection status
+   * @return {void}
+   */
+  public setMercuryConnectedStatus(status: boolean): void {
+    this.isMercuryConnected = status;
+  }
+
   /**
    * Returns meeting's subServiceType
    * @param meeting
@@ -555,16 +567,31 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return undefined;
   }
 
+  /**
+   * Clear the error cache
+   */
+  clearErrorCache() {
+    this.eventErrorCache = new WeakMap();
+  }
+
   /**
    * Generate error payload for Client Event
    * @param rawError
    */
   generateClientEventErrorPayload(rawError: any) {
+    const cachedError = this.eventErrorCache.get(rawError);
+
+    if (cachedError) {
+      return [cachedError, true];
+    }
+
     const rawErrorMessage = rawError.message;
     const httpStatusCode = rawError.statusCode;
+    let payload;
+
     if (rawError.name) {
       if (isBrowserMediaErrorName(rawError.name)) {
-        return this.getErrorPayloadForClientErrorCode({
+        payload = this.getErrorPayloadForClientErrorCode({
           serviceErrorCode: undefined,
           clientErrorCode: BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[rawError.name],
           serviceErrorName: rawError.name,
@@ -574,11 +601,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       }
     }
 
-    if (isSdpOfferCreationError(rawError)) {
+    if (isSdpOfferCreationError(rawError) && !payload) {
       // error code is 30005, but that's not specific enough. we also need to check error.cause.type
       const causeType = rawError.cause?.type;
 
-      return this.getErrorPayloadForClientErrorCode({
+      payload = this.getErrorPayloadForClientErrorCode({
         serviceErrorCode: undefined,
         clientErrorCode:
           SDP_OFFER_CREATION_ERROR_MAP[causeType] || SDP_OFFER_CREATION_ERROR_MAP.GENERAL,
@@ -596,8 +623,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
     if (serviceErrorCode) {
       const clientErrorCode = SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP[serviceErrorCode];
-      if (clientErrorCode) {
-        return this.getErrorPayloadForClientErrorCode({
+      if (clientErrorCode && !payload) {
+        payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode,
           serviceErrorCode,
           rawErrorMessage,
@@ -606,8 +633,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       }
 
       // by default, if it is locus error, return new locus err
-      if (isLocusServiceErrorCode(serviceErrorCode)) {
-        return this.getErrorPayloadForClientErrorCode({
+      if (isLocusServiceErrorCode(serviceErrorCode) && !payload) {
+        payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode: NEW_LOCUS_ERROR_CLIENT_CODE,
           serviceErrorCode,
           rawErrorMessage,
@@ -616,8 +643,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       }
     }
 
-    if (isMeetingInfoServiceError(rawError)) {
-      return this.getErrorPayloadForClientErrorCode({
+    if (isMeetingInfoServiceError(rawError) && !payload) {
+      payload = this.getErrorPayloadForClientErrorCode({
         clientErrorCode: MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
         serviceErrorCode,
         rawErrorMessage,
@@ -625,8 +652,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       });
     }
 
-    if (isNetworkError(rawError)) {
-      return this.getErrorPayloadForClientErrorCode({
+    if (isNetworkError(rawError) && !payload) {
+      payload = this.getErrorPayloadForClientErrorCode({
         clientErrorCode: NETWORK_ERROR,
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
@@ -635,8 +662,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       });
     }
 
-    if (isUnauthorizedError(rawError)) {
-      return this.getErrorPayloadForClientErrorCode({
+    if (isUnauthorizedError(rawError) && !payload) {
+      payload = this.getErrorPayloadForClientErrorCode({
         clientErrorCode: AUTHENTICATION_FAILED_CODE,
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
@@ -645,15 +672,22 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       });
     }
 
-    // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
-    return this.getErrorPayloadForClientErrorCode({
-      clientErrorCode: UNKNOWN_ERROR,
-      serviceErrorCode: serviceErrorCode || UNKNOWN_ERROR,
-      serviceErrorName: rawError?.name,
-      payloadOverrides: rawError.payloadOverrides,
-      rawErrorMessage,
-      httpStatusCode,
-    });
+    if (!payload) {
+      // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
+      payload = this.getErrorPayloadForClientErrorCode({
+        clientErrorCode: UNKNOWN_ERROR,
+        serviceErrorCode: serviceErrorCode || UNKNOWN_ERROR,
+        serviceErrorName: rawError?.name,
+        payloadOverrides: rawError.payloadOverrides,
+        rawErrorMessage,
+        httpStatusCode,
+      });
+    }
+
+    // cache the payload for future use
+    this.eventErrorCache.set(rawError, payload);
+
+    return [payload, false];
   }
 
   /**
@@ -716,6 +750,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       errors,
       eventData: {
         webClientDomain: window.location.hostname,
+        isMercuryConnected: this.isMercuryConnected,
       },
       userType: meeting.getCurUserType(),
       loginType:
@@ -784,6 +819,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       identifiers,
       eventData: {
         webClientDomain: window.location.hostname,
+        isMercuryConnected: this.isMercuryConnected,
       },
       loginType: this.getCurLoginType(),
       // @ts-ignore
@@ -834,14 +870,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const errors: ClientEventPayloadError = [];
 
     if (rawError) {
-      const generatedError = this.generateClientEventErrorPayload(rawError);
+      const [generatedError, cached] = this.generateClientEventErrorPayload(rawError);
       if (generatedError) {
         errors.push(generatedError);
       }
       this.logger.log(
         CALL_DIAGNOSTIC_LOG_IDENTIFIER,
         'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
-        `generatedError: ${JSON.stringify(generatedError)}`
+        `generatedError (cached: ${cached}): ${JSON.stringify(generatedError)}`
       );
     }
 
@@ -919,7 +955,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   /**
    * Submit Delayed Client Event CA events. Clears delayedClientEvents array after submission.
    */
-  public submitDelayedClientEvents() {
+  public submitDelayedClientEvents(overrides?: Partial<DelayedClientEvent['options']>) {
     this.logger.log(
       CALL_DIAGNOSTIC_LOG_IDENTIFIER,
       'CallDiagnosticMetrics: @submitDelayedClientEvents. Submitting delayed client events.'
@@ -930,7 +966,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     }
 
     const promises = this.delayedClientEvents.map((delayedSubmitClientEventParams) => {
-      return this.submitClientEvent(delayedSubmitClientEventParams);
+      const {name, payload, options} = delayedSubmitClientEventParams;
+      const optionsWithOverrides: DelayedClientEvent['options'] = {...options, ...overrides};
+
+      return this.submitClientEvent({name, payload, options: optionsWithOverrides});
     });
 
     this.delayedClientEvents = [];

package/src/call-diagnostic/config.ts

@@ -133,6 +133,7 @@ export const ERROR_DESCRIPTIONS = {
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
   WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
+  USER_NOT_ALLOWED_JOIN_WEBINAR: 'UserNotAllowedJoinWebinar',
 };
 
 export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
@@ -151,6 +152,10 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   403004: 4005,
   // Wrong password. Meeting is not allow to access since password error
   403028: 4005,
+  // meeting is not allow to access since require panelist password
+  403025: 4005,
+  // wrong password. Meeting is not allow to access since panelist password error
+  403125: 4005,
   // Wrong or expired permission. Meeting is not allow to access since permissionToken error or expire
   403032: 4005,
   // Meeting is required login for current user
@@ -202,6 +207,24 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   423013: 4005,
   // Too many requests access
   429005: 4100,
+  // Webinar: Meeting registration is required
+  403021: 4104,
+  // Webinar: Meeting registration is still pending
+  403022: 4104,
+  // Webinar: Meeting registration have been rejected
+  403024: 4104,
+  // Webinar: Registration ID verified failure
+  403137: 4104,
+  // Webinar: Registration ID input too many time,please input captcha code
+  423007: 4104,
+  // Webinar: Need to join meeting via webcast
+  403026: 4104,
+  // Webinar: Meeting join required registration ID
+  403037: 4104,
+  // Not reach JBH, can't join meeting
+  403003: 4101,
+  // Attendee email is required
+  403030: 4101,
 
   // ---- Locus ------
   // FREE_USER_MAX_PARTICIPANTS_EXCEEDED
@@ -666,6 +689,11 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  4104: {
+    errorDescription: ERROR_DESCRIPTIONS.USER_NOT_ALLOWED_JOIN_WEBINAR,
+    category: 'expected',
+    fatal: true,
+  },
   2729: {
     errorDescription: ERROR_DESCRIPTIONS.NO_MEDIA_FOUND,
     category: 'expected',

package/src/new-metrics.ts

@@ -22,6 +22,7 @@ import {
   InternalEvent,
   SubmitClientEventOptions,
   Table,
+  DelayedClientEvent,
 } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 import {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';
@@ -50,6 +51,11 @@ class Metrics extends WebexPlugin {
    */
   delaySubmitClientEvents = false;
 
+  /**
+   * Overrides for delayed client events. E.g. if you want to override the correlationId for all delayed client events, you can set this to { correlationId: 'newCorrelationId' }
+   */
+  delayedClientEventsOverrides: Partial<DelayedClientEvent['options']> = {};
+
   /**
    * Constructor
    * @param args
@@ -74,6 +80,10 @@ class Metrics extends WebexPlugin {
       // @ts-ignore
       this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
       this.isReady = true;
+      this.setDelaySubmitClientEvents({
+        shouldDelay: this.delaySubmitClientEvents,
+        overrides: this.delayedClientEventsOverrides,
+      });
     });
   }
 
@@ -404,13 +414,20 @@ class Metrics extends WebexPlugin {
    * Sets the value of delaySubmitClientEvents. If set to true, client events will be delayed until submitDelayedClientEvents is called. If
    * set to false, delayed client events will be submitted.
    *
-   * @param {boolean} shouldDelay - A boolean value indicating whether to delay the submission of client events.
+   * @param {object} options - {shouldDelay: A boolean value indicating whether to delay the submission of client events, overrides: An object containing overrides for the client events}
    */
-  public setDelaySubmitClientEvents(shouldDelay: boolean) {
+  public setDelaySubmitClientEvents({
+    shouldDelay,
+    overrides,
+  }: {
+    shouldDelay: boolean;
+    overrides?: Partial<DelayedClientEvent['options']>;
+  }) {
     this.delaySubmitClientEvents = shouldDelay;
+    this.delayedClientEventsOverrides = overrides || {};
 
-    if (!shouldDelay) {
-      return this.callDiagnosticMetrics.submitDelayedClientEvents();
+    if (this.isReady && !shouldDelay) {
+      return this.callDiagnosticMetrics.submitDelayedClientEvents(overrides);
     }
 
     return Promise.resolve();