@webex/internal-plugin-metrics 3.0.0-beta.217 → 3.0.0-beta.219

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

@@ -14,6 +14,8 @@ import {
   prepareDiagnosticMetricItem,
   userAgentToString,
   extractVersionMetadata,
+  isMeetingInfoServiceError,
+  isBrowserMediaErrorName,
 } from './call-diagnostic-metrics.util';
 import {CLIENT_NAME} from '../config';
 import {
@@ -30,14 +32,17 @@ import {
   ClientEventError,
   ClientEventPayload,
   ClientInfo,
+  ClientEventPayloadError,
 } from '../metrics.types';
 import CallDiagnosticEventsBatcher from './call-diagnostic-metrics-batcher';
 import {
   CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD,
   CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND,
-  MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
   NEW_LOCUS_ERROR_CLIENT_CODE,
   SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP,
+  UNKNOWN_ERROR,
+  BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP,
+  MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
 } from './config';
 
 const {getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
@@ -346,9 +351,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   public getErrorPayloadForClientErrorCode({
     clientErrorCode,
     serviceErrorCode,
+    serviceErrorName,
   }: {
     clientErrorCode: number;
     serviceErrorCode: any;
+    serviceErrorName?: any;
   }): ClientEventError {
     let error: ClientEventError;
 
@@ -359,6 +366,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         error = merge(
           {fatal: true, shownToUser: false, name: 'other', category: 'other'}, // default values
           {errorCode: clientErrorCode},
+          serviceErrorName ? {errorData: {errorName: serviceErrorName}} : {},
           {serviceErrorCode},
           partialParsedError
         );
@@ -375,30 +383,49 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * @param rawError
    */
   generateClientEventErrorPayload(rawError: any) {
+    if (rawError.name) {
+      if (isBrowserMediaErrorName(rawError.name)) {
+        return this.getErrorPayloadForClientErrorCode({
+          serviceErrorCode: undefined,
+          clientErrorCode: BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[rawError.name],
+          serviceErrorName: rawError.name,
+        });
+      }
+    }
+
     const serviceErrorCode =
-      rawError?.error?.body?.errorCode || rawError?.body?.errorCode || rawError?.body?.code;
+      rawError?.error?.body?.errorCode ||
+      rawError?.body?.errorCode ||
+      rawError?.body?.code ||
+      rawError?.body?.reason?.reasonCode;
+
     if (serviceErrorCode) {
       const clientErrorCode = SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP[serviceErrorCode];
       if (clientErrorCode) {
         return this.getErrorPayloadForClientErrorCode({clientErrorCode, serviceErrorCode});
       }
 
-      // by default, if it is locus error, return nre locus err
+      // by default, if it is locus error, return new locus err
       if (isLocusServiceErrorCode(serviceErrorCode)) {
         return this.getErrorPayloadForClientErrorCode({
           clientErrorCode: NEW_LOCUS_ERROR_CLIENT_CODE,
           serviceErrorCode,
         });
       }
+    }
 
-      // otherwise return meeting info
+    if (isMeetingInfoServiceError(rawError)) {
       return this.getErrorPayloadForClientErrorCode({
         clientErrorCode: MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
         serviceErrorCode,
       });
     }
 
-    return undefined;
+    // otherwise return unkown error
+    return this.getErrorPayloadForClientErrorCode({
+      clientErrorCode: UNKNOWN_ERROR,
+      serviceErrorCode: UNKNOWN_ERROR,
+    });
   }
 
   /**
@@ -411,11 +438,13 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private createClientEventObjectInMeeting({
     name,
     options,
+    errors,
   }: {
     name: ClientEvent['name'];
     options?: SubmitClientEventOptions;
+    errors?: ClientEventPayloadError;
   }) {
-    const {meetingId, mediaConnections, rawError} = options;
+    const {meetingId, mediaConnections} = options;
 
     // @ts-ignore
     const meeting = this.webex.meetings.meetingCollection.get(meetingId);
@@ -442,16 +471,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       mediaConnections: meeting?.mediaConnections || mediaConnections,
     });
 
-    // check if we need to generate errors
-    const errors: ClientEvent['payload']['errors'] = [];
-
-    if (rawError) {
-      const generatedError = this.generateClientEventErrorPayload(rawError);
-      if (generatedError) {
-        errors.push(generatedError);
-      }
-    }
-
     // create client event object
     const clientEventObject: ClientEvent['payload'] = {
       name,
@@ -481,9 +500,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private createClientEventObjectPreMeeting({
     name,
     options,
+    errors,
   }: {
     name: ClientEvent['name'];
     options?: SubmitClientEventOptions;
+    errors?: ClientEventPayloadError;
   }) {
     const {correlationId} = options;
 
@@ -495,6 +516,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     // create client event object
     const clientEventObject: ClientEvent['payload'] = {
       name,
+      errors,
       canProceed: true,
       identifiers,
       eventData: {
@@ -524,15 +546,25 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     payload?: ClientEventPayload;
     options?: SubmitClientEventOptions;
   }) {
-    const {meetingId, correlationId} = options;
+    const {meetingId, correlationId, rawError} = options;
     let clientEventObject: ClientEvent['payload'];
 
+    // check if we need to generate errors
+    const errors: ClientEventPayloadError = [];
+
+    if (rawError) {
+      const generatedError = this.generateClientEventErrorPayload(rawError);
+      if (generatedError) {
+        errors.push(generatedError);
+      }
+    }
+
     // events that will most likely happen in join phase
     if (meetingId) {
-      clientEventObject = this.createClientEventObjectInMeeting({name, options});
+      clientEventObject = this.createClientEventObjectInMeeting({name, options, errors});
     } else if (correlationId) {
       // any pre join events or events that are outside the meeting.
-      clientEventObject = this.createClientEventObjectPreMeeting({name, options});
+      clientEventObject = this.createClientEventObjectPreMeeting({name, options, errors});
     } else {
       throw new Error('Not implemented');
     }

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

@@ -11,6 +11,7 @@ import {
   MediaQualityEventVideoSetupDelayPayload,
   MetricEventNames,
 } from '../metrics.types';
+import {BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP, WBX_APP_API_URL} from './config';
 
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
@@ -96,7 +97,7 @@ export const clearEmptyKeysRecursively = (obj: any) => {
  * If it is 7 digits and starts with a 2, it is locus.
  *
  * @param errorCode
- * @returns
+ * @returns {boolean}
  */
 export const isLocusServiceErrorCode = (errorCode: string | number) => {
   const code = `${errorCode}`;
@@ -108,6 +109,36 @@ export const isLocusServiceErrorCode = (errorCode: string | number) => {
   return false;
 };
 
+/**
+ * MeetingInfo errors sometimes has body.data.meetingInfo object
+ * MeetingInfo errors come with a wbxappapi url
+ *
+ * @param {Object} rawError
+ * @returns {boolean}
+ */
+export const isMeetingInfoServiceError = (rawError: any) => {
+  if (rawError.body?.data?.meetingInfo || rawError.body?.url?.includes(WBX_APP_API_URL)) {
+    return true;
+  }
+
+  return false;
+};
+
+/**
+ * MDN Media Devices getUserMedia() method returns a name if it errs
+ * Documentation can be found here: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
+ *
+ * @param errorCode
+ * @returns
+ */
+export const isBrowserMediaErrorName = (errorName: any) => {
+  if (BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[errorName]) {
+    return true;
+  }
+
+  return false;
+};
+
 /**
  * @param webClientDomain
  * @returns

package/src/call-diagnostic/config.ts

@@ -6,7 +6,32 @@ import {ClientEventError} from '../metrics.types';
 
 export const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
 export const MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE = 4100;
+export const UNKNOWN_ERROR = 9999; // Unexpected error that is not a meetingInfo error, locus error or browser media error.
 export const ICE_FAILURE_CLIENT_CODE = 2004;
+export const WBX_APP_API_URL = 'wbxappapi'; // MeetingInfo WebexAppApi response object normally contains a body.url that includes the string 'wbxappapi'
+
+// Found in https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
+const BROWSER_MEDIA_ERROR_NAMES = {
+  PERMISSION_DENIED_ERROR: 'PermissionDeniedError',
+  NOT_ALLOWED_ERROR: 'NotAllowedError',
+  NOT_READABLE_ERROR: 'NotReadableError',
+  ABORT_ERROR: 'AbortError',
+  NOT_FOUND_ERROR: 'NotFoundError',
+  OVERCONSTRAINED_ERROR: 'OverconstrainedError',
+  SECURITY_ERROR: 'SecurityError',
+  TYPE_ERROR: 'TypeError',
+};
+
+export const BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP = {
+  [BROWSER_MEDIA_ERROR_NAMES.PERMISSION_DENIED_ERROR]: 4032, // User did not grant permission
+  [BROWSER_MEDIA_ERROR_NAMES.NOT_ALLOWED_ERROR]: 4032, // User did not grant permission
+  [BROWSER_MEDIA_ERROR_NAMES.NOT_READABLE_ERROR]: 2729, // Although the user granted permission to use the matching devices, a hardware error occurred at the operating system, browser, or Web page level which prevented access to the device.
+  [BROWSER_MEDIA_ERROR_NAMES.ABORT_ERROR]: 2729, // Although the user and operating system both granted access to the hardware device, and no hardware issues occurred that would cause a NotReadableError DOMException, throw if some problem occurred which prevented the device from being used.
+  [BROWSER_MEDIA_ERROR_NAMES.NOT_FOUND_ERROR]: 2729, // User did not grant permission
+  [BROWSER_MEDIA_ERROR_NAMES.OVERCONSTRAINED_ERROR]: 2729, // Thrown if the specified constraints resulted in no candidate devices which met the criteria requested.
+  [BROWSER_MEDIA_ERROR_NAMES.SECURITY_ERROR]: 2729, // Thrown if user media support is disabled on the Document on which getUserMedia() was called. The mechanism by which user media support is enabled and disabled is left up to the individual user agent.
+  [BROWSER_MEDIA_ERROR_NAMES.TYPE_ERROR]: 2729, // Thrown if the list of constraints specified is empty, or has all constraints set to false. This can also happen if you try to call getUserMedia() in an insecure context, since navigator.mediaDevices is undefined in an insecure context.
+};
 
 const ERROR_DESCRIPTIONS = {
   UNKNOWN_CALL_FAILURE: 'UnknownCallFailure',
@@ -63,41 +88,81 @@ const ERROR_DESCRIPTIONS = {
   RECORDING_IN_PROGRESS_FAILED: 'RecordingInProgressFailed',
   MEETING_INFO_LOOKUP_ERROR: 'MeetingInfoLookupError',
   CALL_FULL_ADD_GUEST: 'CallFullAddGuest',
+  REQUIRE_WEBEX_LOGIN: 'RequireWebexLogin',
+  USER_NOT_ALLOWED_ACCESS_MEETING: 'UserNotAllowedAccessMeeting',
+  USER_NEEDS_ACTIVATION: 'UserNeedsActivation',
+  SIGN_UP_INVALID_EMAIL: 'SignUpInvalidEmail',
+  UNKNOWN_ERROR: 'UnknownError',
+  NO_MEDIA_FOUND: 'NoMediaFound',
+  STREAM_ERROR_NO_MEDIA: 'StreamErrorNoMedia',
+  CAMERA_PERMISSION_DENIED: 'CameraPermissionDenied',
 };
 
 export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   // ---- Webex API ----
+  // Taken from https://wiki.cisco.com/display/HFWEB/MeetingInfo+API and https://sqbu-github.cisco.com/WebExSquared/spark-client-framework/blob/master/spark-client-framework/Services/WebexMeetingService/WebexMeetingModel.h
   // Site not support the URL's domain
   58400: 4100,
   99002: 4100,
-  // Cannot find the data
+  // Cannot find the data. Unkown meeting.
   99009: 4100,
+  // Meeting is not allow to cross env
+  58500: 4100,
+  // Input parameters contain invalit item
+  400001: 4100,
+  // Empty password or token. Meeting is not allow to access since require password
+  403004: 4005,
+  // Wrong password. Meeting is not allow to access since password error
+  403028: 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
+  403034: 4036,
+  // Meeting is not allow to access since require password or hostKey
+  // Empty password or host key
+  403036: 4005,
+  // Meeting is not allow to access since password or hostKey error
+  // Wrong password or host key
+  403038: 4005,
   // CMR Meeting Not Supported (meeting exists, but not CMR meeting)
   403040: 4100,
   // Requires Moderator Pin or Guest Pin
   403041: 4005,
-  // Meeting is not allow to access since password or hostKey error
-  403038: 4005,
-  // Meeting is not allow to access since require password or hostKey
-  403036: 4005,
+  // Email blocked
+  403047: 4101,
+  // Device not authenticated for your organization
+  403408: 4101,
   // Invalid panelist Pin
-  403043: 4100,
-  // Device not registered in org
-  403048: 4100,
-  // Not allowed to join external meetings
-  403049: 4100,
-  403100: 4100,
-  // Enforce sign in: need login before access when policy enforce sign in
-  403101: 4100,
+  403043: 4005,
+  // Device not registered in org. Device not authenticated.
+  403048: 4101,
+  // Not allowed to join external meetings. Violate meeting join policy. Your organization settings don't allow you to join this meeting.
+  403049: 4101,
+  // Invalid email. Requires sign in meeting's current site.
+  403100: 4101,
+  // Enforce sign in: need login before access when policy enforce sign in. GuestForceUserSignInPolicy
+  403101: 4036,
   // Enforce sign in: sign in with your email address that is approved by your organization
-  403102: 4100,
-  // Join internal Meeting: need login before access when policy enforce sign in
-  403103: 4100,
+  403102: 4036,
+  // Join internal Meeting: need login before access when policy enforce sign in. Guest force user sign in internal meeting policy.
+  403103: 4036,
   // Join internal Meeting: The host's organization policy doesn't allow your account to join this meeting. Try switching to another account
-  403104: 4100,
-  404001: 4100,
-  // Site data not found
+  403104: 4101,
+  404001: 4101,
+  // Site data not found. Unkonwn meeting. Site data not found(or null).
   404006: 4100,
+  // Invalid input with too many requests. Too many requests access, please input captcha code
+  423001: 4005,
+  // Wrong password with too many requests. PasswordError too many time, please input captcha code
+  423005: 4005,
+  // Wrong password or host key with too many requests
+  423006: 4005,
+  // PasswordError with right captcha, please input captcha code
+  423010: 4005,
+  // PasswordOrHostKeyError with right captcha, please input captcha code
+  423012: 4005,
+  // Unverified or invalid input. Force show captcha. Please input captcha code"
+  423013: 4005,
   // Too many requests access
   429005: 4100,
 
@@ -120,6 +185,10 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   2423004: 4003,
   // LOCUS_REQUIRES_MODERATOR_PIN_OR_GUEST
   2423005: 4005,
+  2423006: 4005,
+  2423016: 4005,
+  2423017: 4005,
+  2423018: 4005,
   // LOCUS_REQUIRES_MODERATOR_ROLE
   2423007: 4006,
   // LOCUS_JOIN_RESTRICTED_USER_NOT_IN_ROOM
@@ -164,6 +233,20 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   2405001: 4029,
   // LOCUS_RECORDING_NOT_ENABLED
   2409005: 4029,
+
+  // ---- U2C Sign in catalog ------
+  // The user exists, but hasn't completed activation. Needs to visit Atlas for more processing.
+  100002: 4102,
+  // The user exists, had completed activation earlier, but requires re-activation because of change in login strategy.
+  // Common example is: user signed up using an OAuth provider, but that OAuth provider was removed by org's admin. Now the user needs to re-activate using alternate login strategies: password-pin, new OAuth provider, SSO, etc.
+  100007: 4102,
+  // The user does not exist
+  100001: 4103,
+  // The user wasn't found, and the organization used for search is a domain-claimed organization.
+  100006: 4103,
+  100005: 4103, // Depracated because of an issue in the UCF Clients
+  // If both email-hash and domain-hash are null or undefined.
+  100004: 4103,
 };
 
 export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>> = {
@@ -269,10 +352,15 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     fatal: true,
   },
   3007: {
-    errorDescription: ERROR_DESCRIPTIONS.ROOM_TOO_LARGE_FREE_ACCOUNT,
+    errorDescription: ERROR_DESCRIPTIONS.STREAM_ERROR_NO_MEDIA,
     category: 'expected',
     fatal: true,
   },
+  3013: {
+    errorDescription: ERROR_DESCRIPTIONS.ROOM_TOO_LARGE_FREE_ACCOUNT,
+    category: 'expected',
+    fatal: false,
+  },
   4001: {
     errorDescription: ERROR_DESCRIPTIONS.MEETING_INACTIVE,
     category: 'expected',
@@ -428,6 +516,16 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  4032: {
+    errorDescription: ERROR_DESCRIPTIONS.CAMERA_PERMISSION_DENIED,
+    category: 'expected',
+    fatal: true,
+  },
+  4036: {
+    errorDescription: ERROR_DESCRIPTIONS.REQUIRE_WEBEX_LOGIN,
+    category: 'expected',
+    fatal: true,
+  },
   5000: {
     errorDescription: ERROR_DESCRIPTIONS.SIP_CALLEE_BUSY,
     category: 'expected',
@@ -450,6 +548,31 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: false,
   },
+  4101: {
+    errorDescription: ERROR_DESCRIPTIONS.USER_NOT_ALLOWED_ACCESS_MEETING,
+    category: 'expected',
+    fatal: true,
+  },
+  4102: {
+    errorDescription: ERROR_DESCRIPTIONS.USER_NEEDS_ACTIVATION,
+    category: 'expected',
+    fatal: true,
+  },
+  4103: {
+    errorDescription: ERROR_DESCRIPTIONS.SIGN_UP_INVALID_EMAIL,
+    category: 'expected',
+    fatal: true,
+  },
+  2729: {
+    errorDescription: ERROR_DESCRIPTIONS.NO_MEDIA_FOUND,
+    category: 'expected',
+    fatal: false,
+  },
+  9999: {
+    errorDescription: ERROR_DESCRIPTIONS.UNKNOWN_ERROR,
+    category: 'other',
+    fatal: true,
+  },
 };
 
 export const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = 'js_sdk_call_diagnostic_event_failed_to_send';

package/src/metrics.types.ts

@@ -90,6 +90,7 @@ export type NetworkType = NonNullable<RawEvent['origin']>['networkType'];
 
 export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
 export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
+export type ClientEventPayloadError = ClientEvent['payload']['errors'];
 
 export type MediaQualityEventAudioSetupDelayPayload = NonNullable<
   MediaQualityEvent['payload']