@webex/internal-plugin-metrics 3.0.0-beta.2 → 3.0.0-beta.200

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

@@ -0,0 +1,233 @@
+/* eslint-disable valid-jsdoc */
+import anonymize from 'ip-anonymize';
+import util from 'util';
+
+import {BrowserDetection} from '@webex/common';
+import {isEmpty, merge} from 'lodash';
+import {
+  ClientEvent,
+  MediaQualityEventAudioSetupDelayPayload,
+  MediaQualityEventVideoSetupDelayPayload,
+  MetricEventNames,
+} from '../metrics.types';
+
+const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
+
+export const anonymizeIPAddress = (localIp) => anonymize(localIp, 28, 96);
+
+/**
+ * Returns a formated string of the user agent.
+ *
+ * @returns {string} formatted user agent information
+ */
+export const userAgentToString = ({clientName, webexVersion}) => {
+  let userAgentOption;
+  let browserInfo;
+  const clientInfo = util.format('client=%s', `${clientName}`);
+
+  if (
+    ['chrome', 'firefox', 'msie', 'msedge', 'safari'].indexOf(getBrowserName().toLowerCase()) !== -1
+  ) {
+    browserInfo = util.format(
+      'browser=%s',
+      `${getBrowserName().toLowerCase()}/${getBrowserVersion().split('.')[0]}`
+    );
+  }
+  const osInfo = util.format('os=%s', `${getOSName()}/${getOSVersion().split('.')[0]}`);
+
+  if (browserInfo) {
+    userAgentOption = `(${browserInfo}`;
+  }
+  if (osInfo) {
+    userAgentOption = userAgentOption
+      ? `${userAgentOption}; ${clientInfo}; ${osInfo}`
+      : `${clientInfo}; (${osInfo}`;
+  }
+  if (userAgentOption) {
+    userAgentOption += ')';
+
+    return util.format(
+      'webex-js-sdk/%s %s',
+      `${process.env.NODE_ENV}-${webexVersion}`,
+      userAgentOption
+    );
+  }
+
+  return util.format('webex-js-sdk/%s', `${process.env.NODE_ENV}-${webexVersion}`);
+};
+
+/**
+ * Iterates object recursively and removes any
+ * property that returns isEmpty for it's associated value
+ * isEmpty = implementation from Lodash.
+ *
+ * It modifies the object in place (mutable)
+ *
+ * @param obj - input
+ * @returns
+ */
+export const clearEmptyKeysRecursively = (obj: any) => {
+  // Check if the object is empty
+  if (Object.keys(obj).length === 0) {
+    return;
+  }
+
+  Object.keys(obj).forEach((key) => {
+    if (
+      (typeof obj[key] === 'object' || typeof obj[key] === 'string' || Array.isArray(obj[key])) &&
+      isEmpty(obj[key])
+    ) {
+      delete obj[key];
+    }
+    if (Array.isArray(obj[key])) {
+      obj[key] = [...obj[key].filter((x) => !!x)];
+    }
+    if (typeof obj[key] === 'object') {
+      clearEmptyKeysRecursively(obj[key]);
+    }
+  });
+};
+
+/**
+ * Locus error codes start with 2. The next three digits are the
+ * HTTP status code related to the error code (like 400, 403, 502, etc.)
+ * The remaining three digits are just an increasing integer.
+ * If it is 7 digits and starts with a 2, it is locus.
+ *
+ * @param errorCode
+ * @returns
+ */
+export const isLocusServiceErrorCode = (errorCode: string | number) => {
+  const code = `${errorCode}`;
+
+  if (code.length === 7 && code.charAt(0) === '2') {
+    return true;
+  }
+
+  return false;
+};
+
+/**
+ * @param webClientDomain
+ * @returns
+ */
+export const getBuildType = (webClientDomain) => {
+  if (
+    webClientDomain?.includes('localhost') ||
+    webClientDomain?.includes('127.0.0.1') ||
+    process.env.NODE_ENV !== 'production'
+  ) {
+    return 'test';
+  }
+
+  return 'production';
+};
+
+/**
+ * Prepare metric item for submission.
+ * @param {Object} webex sdk instance
+ * @param {Object} item
+ * @returns {Object} prepared item
+ */
+export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
+  const origin = {
+    buildType: getBuildType(item.event?.eventData?.webClientDomain),
+    networkType: 'unknown',
+  };
+
+  // check event names and append latencies?
+  const eventName = item.eventPayload?.event?.name as MetricEventNames;
+  const joinTimes: ClientEvent['payload']['joinTimes'] = {};
+  const audioSetupDelay: MediaQualityEventAudioSetupDelayPayload = {};
+  const videoSetupDelay: MediaQualityEventVideoSetupDelayPayload = {};
+
+  const cdl = webex.internal.newMetrics.callDiagnosticLatencies;
+
+  switch (eventName) {
+    case 'client.interstitial-window.launched':
+      joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+      joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
+      break;
+
+    case 'client.call.initiated':
+      joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+      joinTimes.showInterstitialTime = cdl.getShowInterstitialTime();
+      break;
+
+    case 'client.locus.join.response':
+      joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+      joinTimes.callInitJoinReq = cdl.getCallInitJoinReq();
+      joinTimes.joinReqResp = cdl.getJoinReqResp();
+      joinTimes.joinReqSentReceived = cdl.getJoinRespSentReceived();
+      joinTimes.pageJmt = cdl.getPageJMT();
+      joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
+      joinTimes.interstitialToJoinOK = cdl.getInterstitialToJoinOK();
+      joinTimes.totalJmt = cdl.getTotalJMT();
+      joinTimes.clientJmt = cdl.getClientJMT();
+      break;
+
+    case 'client.ice.end':
+      joinTimes.ICESetupTime = cdl.getICESetupTime();
+      joinTimes.audioICESetupTime = cdl.getAudioICESetupTime();
+      joinTimes.videoICESetupTime = cdl.getVideoICESetupTime();
+      joinTimes.shareICESetupTime = cdl.getShareICESetupTime();
+      break;
+
+    case 'client.media.rx.start':
+      joinTimes.localSDPGenRemoteSDPRecv = cdl.getLocalSDPGenRemoteSDPRecv();
+      break;
+
+    case 'client.media-engine.ready':
+      joinTimes.totalMediaJMT = cdl.getTotalMediaJMT();
+      joinTimes.interstitialToMediaOKJMT = cdl.getInterstitialToMediaOKJMT();
+      joinTimes.callInitMediaEngineReady = cdl.getCallInitMediaEngineReady();
+      joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
+      break;
+
+    case 'client.mediaquality.event':
+      audioSetupDelay.joinRespRxStart = cdl.getAudioJoinRespRxStart();
+      audioSetupDelay.joinRespTxStart = cdl.getAudioJoinRespTxStart();
+      videoSetupDelay.joinRespRxStart = cdl.getVideoJoinRespRxStart();
+      videoSetupDelay.joinRespTxStart = cdl.getVideoJoinRespTxStart();
+  }
+
+  if (!isEmpty(joinTimes)) {
+    item.eventPayload.event = merge(item.eventPayload.event, {joinTimes});
+  }
+
+  if (!isEmpty(audioSetupDelay)) {
+    item.eventPayload.event = merge(item.eventPayload.event, {audioSetupDelay});
+  }
+
+  if (!isEmpty(videoSetupDelay)) {
+    item.eventPayload.event = merge(item.eventPayload.event, {videoSetupDelay});
+  }
+
+  item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
+
+  return item;
+};
+
+/**
+ * Sets the originTime value(s) before the request/fetch.
+ * This function is only useful if you are about to submit a metrics
+ * request using pre-built fetch options;
+ *
+ * @param {any} options
+ * @returns {any} the updated options object
+ */
+export const setMetricTimings = (options) => {
+  if (options.body?.metrics) {
+    const now = new Date().toISOString();
+    options.body.metrics.forEach((metric) => {
+      if (metric.eventPayload) {
+        metric.eventPayload.originTime = {
+          triggered: now,
+          sent: now,
+        };
+      }
+    });
+  }
+
+  return options;
+};

package/src/call-diagnostic/config.ts

@@ -0,0 +1,455 @@
+/* eslint-disable import/prefer-default-export */
+// Most client error codes are mapped based on
+// https://sqbu-github.cisco.com/WebExSquared/event-dictionary/wiki/Error-codes-for-metric-events
+
+import {ClientEventError} from '../metrics.types';
+
+export const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
+export const MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE = 4100;
+export const ICE_FAILURE_CLIENT_CODE = 2004;
+
+const ERROR_DESCRIPTIONS = {
+  UNKNOWN_CALL_FAILURE: 'UnknownCallFailure',
+  LOCUS_RATE_LIMITED_INCOMING: 'LocusRateLimitedIncoming',
+  LOCUS_RATE_LIMITED_OUTGOING: 'LocusRateLimitedOutgoing',
+  LOCUS_UNAVAILABLE: 'LocusUnavailable',
+  LOCUS_CONFLICT: 'LocusConflict',
+  TIMEOUT: 'Timeout',
+  LOCUS_INVALID_SEQUENCE_HASH: 'LocusInvalidSequenceHash',
+  UPDATE_MEDIA_FAILED: 'UpdateMediaFailed',
+  FAILED_TO_CONNECT_MEDIA: 'FailedToConnectMedia',
+  MEDIA_ENGINE_LOST: 'MediaEngineLost',
+  MEDIA_CONNECTION_LOST: 'MediaConnectionLost',
+  ICE_FAILURE: 'IceFailure',
+  MEDIA_ENGINE_HANG: 'MediaEngineHang',
+  ICE_SERVER_REJECTED: 'IceServerRejected',
+  CALL_FULL: 'CallFull',
+  ROOM_TOO_LARGE: 'RoomTooLarge',
+  GUEST_ALREADY_ADDED: 'GuestAlreadyAdded',
+  LOCUS_USER_NOT_AUTHORISED: 'LocusUserNotAuthorised',
+  CLOUDBERRY_UNAVAILABLE: 'CloudberryUnavailable',
+  ROOM_TOO_LARGE_FREE_ACCOUNT: 'RoomTooLarge_FreeAccount',
+  MEETING_INACTIVE: 'MeetingInactive',
+  MEETING_LOCKED: 'MeetingLocked',
+  MEETING_TERMINATING: 'MeetingTerminating',
+  MODERATOR_PIN_OR_GUEST_REQUIRED: 'Moderator_Pin_Or_Guest_Required',
+  MODERATOR_PIN_OR_GUEST_PIN_REQUIRED: 'Moderator_Pin_Or_Guest_PIN_Required',
+  MODERATOR_REQUIRED: 'Moderator_Required',
+  USER_NOT_MEMBER_OF_ROOM: 'UserNotMemberOfRoom',
+  NEW_LOCUS_ERROR: 'NewLocusError',
+  NETWORK_UNAVAILABLE: 'NetworkUnavailable',
+  MEETING_UNAVAILABLE: 'MeetingUnavailable',
+  MEETING_ID_INVALID: 'MeetingIDInvalid',
+  MEETING_SITE_INVALID: 'MeetingSiteInvalid',
+  LOCUS_INVALID_JOINTIME: 'LocusInvalidJoinTime',
+  LOBBY_EXPIRED: 'LobbyExpired',
+  MEDIA_CONNECTION_LOST_PAIRED: 'MediaConnectionLostPaired',
+  PHONE_NUMBER_NOT_A_NUMBER: 'PhoneNumberNotANumber',
+  PHONE_NUMBER_TOO_LONG: 'PhoneNumberTooLong',
+  INVALID_DIALABLE_KEY: 'InvalidDialableKey',
+  ONE_ON_ONE_TO_SELF_NOT_ALLOWED: 'OneOnOneToSelfNotAllowed',
+  REMOVED_PARTICIPANT: 'RemovedParticipant',
+  MEETING_LINK_NOT_FOUND: 'MeetingLinkNotFound',
+  PHONE_NUMBER_TOO_SHORT_AFTER_IDD: 'PhoneNumberTooShortAfterIdd',
+  INVALID_INVITEE_ADDRESS: 'InvalidInviteeAddress',
+  PMR_USER_ACCOUNT_LOCKED_OUT: 'PMRUserAccountLockedOut',
+  GUEST_FORBIDDEN: 'GuestForbidden',
+  PMR_ACCOUNT_SUSPENDED: 'PMRAccountSuspended',
+  EMPTY_PHONE_NUMBER_OR_COUNTRY_CODE: 'EmptyPhoneNumberOrCountryCode',
+  CONVERSATION_NOT_FOUND: 'ConversationNotFound',
+  SIP_CALLEE_BUSY: 'SIPCalleeBusy',
+  SIP_CALLEE_NOT_FOUND: 'SIPCalleeNotFound',
+  START_RECORDING_FAILED: 'StartRecordingFailed',
+  RECORDING_IN_PROGRESS_FAILED: 'RecordingInProgressFailed',
+  MEETING_INFO_LOOKUP_ERROR: 'MeetingInfoLookupError',
+  CALL_FULL_ADD_GUEST: 'CallFullAddGuest',
+};
+
+export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
+  // ---- Webex API ----
+  // Site not support the URL's domain
+  58400: 4100,
+  99002: 4100,
+  // Cannot find the data
+  99009: 4100,
+  // 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,
+  // 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,
+  // 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,
+  // 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
+  404006: 4100,
+  // Too many requests access
+  429005: 4100,
+
+  // ---- Locus ------
+  // FREE_USER_MAX_PARTICIPANTS_EXCEEDED
+  2403001: 3007,
+  // PAID_USER_MAX_PARTICIPANTS_EXCEEDED
+  2403002: 3002,
+  // SERVICE_MAX_PARTICIPANTS_EXCEEDED
+  2403003: 3002,
+  // LOCUS_INACTIVE
+  2403004: 4001,
+  // LOCUS_FREE_USER_MAX_PARTICIPANTS_JOINED_EXCEEDED
+  2403018: 3001,
+  // LOCUS_PAID_USER_MAX_PARTICIPANTS_JOINED_EXCEEDED
+  2403019: 3001,
+  // LOCUS_LOCKED
+  2423003: 4002,
+  // LOCUS_TERMINATING
+  2423004: 4003,
+  // LOCUS_REQUIRES_MODERATOR_PIN_OR_GUEST
+  2423005: 4005,
+  // LOCUS_REQUIRES_MODERATOR_ROLE
+  2423007: 4006,
+  // LOCUS_JOIN_RESTRICTED_USER_NOT_IN_ROOM
+  2403010: 4007,
+  // LOCUS_MEETING_NOT_FOUND
+  2403014: 4011,
+  // LOCUS_NOT_WEBEX_SITE
+  2403015: 4012,
+  // LOCUS_INVALID_JOIN_TIME
+  2423010: 4013,
+  // LOCUS_PHONE_NUMBER_NOT_A_NUMBER
+  2400008: 4016,
+  // LOCUS_PHONE_NUMBER_TOO_LONG
+  2400011: 4017,
+  // LOCUS_INVALID_DIALABLE_KEY
+  2400012: 4018,
+  // LOCUS_ONE_ON_ONE_TO_SELF_NOT_ALLOWED
+  2403007: 4019,
+  // LOCUS_REMOVED_PARTICIPANT
+  2401002: 4020,
+  // LOCUS_MEETING_LINK_NOT_FOUND
+  2404002: 4021,
+  // LOCUS_PHONE_NUMBER_TOO_SHORT_AFTER_IDD
+  2400009: 4022,
+  // LOCUS_INVALID_INVITEE_ADDRESS
+  2400025: 4023,
+  // LOCUS_PMR_USER_ACCOUNT_LOCKEDOUT
+  2423009: 4024,
+  // LOCUS_RESOURCE_GUEST_FORBIDDEN
+  2403022: 4025,
+  // LOCUS_PMR_SUSPENDED
+  2423008: 4026,
+  // LOCUS_EMPTY_PHONE_NUMBER_OR_COUNTRY_CODE
+  2400006: 4027,
+  // LOCUS_INVALID_SINCE_OR_SEQUENCE_HASH_IN_REQUEST
+  2400014: 1006,
+  // LOCUS_CONVERSATION_NOT_FOUND
+  2404001: 4028,
+  // LOCUS_RECORDING_CONTROL_NOT_SUPPORTED
+  2403025: 4029,
+  // LOCUS_RECORDING_NOT_STARTED
+  2405001: 4029,
+  // LOCUS_RECORDING_NOT_ENABLED
+  2409005: 4029,
+};
+
+export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>> = {
+  1000: {
+    errorDescription: ERROR_DESCRIPTIONS.UNKNOWN_CALL_FAILURE,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1001: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_RATE_LIMITED_INCOMING,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1002: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_RATE_LIMITED_OUTGOING,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1003: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_UNAVAILABLE,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1004: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_CONFLICT,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1005: {
+    errorDescription: ERROR_DESCRIPTIONS.TIMEOUT,
+    category: 'signaling',
+    fatal: true,
+    name: 'locus.response',
+  },
+  1006: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_INVALID_SEQUENCE_HASH,
+    category: 'signaling',
+    fatal: true,
+  },
+  1007: {
+    errorDescription: ERROR_DESCRIPTIONS.UPDATE_MEDIA_FAILED,
+    category: 'signaling',
+    fatal: true,
+  },
+  2001: {
+    errorDescription: ERROR_DESCRIPTIONS.FAILED_TO_CONNECT_MEDIA,
+    category: 'signaling',
+    fatal: true,
+  },
+  2002: {
+    errorDescription: ERROR_DESCRIPTIONS.MEDIA_ENGINE_LOST,
+    category: 'signaling',
+    fatal: true,
+  },
+  2003: {
+    errorDescription: ERROR_DESCRIPTIONS.MEDIA_CONNECTION_LOST,
+    category: 'signaling',
+    fatal: true,
+  },
+  2004: {
+    errorDescription: ERROR_DESCRIPTIONS.ICE_FAILURE,
+    category: 'signaling',
+    fatal: true,
+  },
+  2005: {
+    errorDescription: ERROR_DESCRIPTIONS.MEDIA_ENGINE_HANG,
+    category: 'signaling',
+    fatal: true,
+  },
+  2006: {
+    errorDescription: ERROR_DESCRIPTIONS.ICE_SERVER_REJECTED,
+    category: 'signaling',
+    fatal: true,
+  },
+  3001: {
+    errorDescription: ERROR_DESCRIPTIONS.CALL_FULL,
+    category: 'expected',
+    fatal: true,
+  },
+  3002: {
+    errorDescription: ERROR_DESCRIPTIONS.ROOM_TOO_LARGE,
+    category: 'expected',
+    fatal: true,
+  },
+  3004: {
+    errorDescription: ERROR_DESCRIPTIONS.GUEST_ALREADY_ADDED,
+    category: 'expected',
+    fatal: false,
+  },
+  3005: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_USER_NOT_AUTHORISED,
+    category: 'expected',
+    fatal: true,
+  },
+  3006: {
+    errorDescription: ERROR_DESCRIPTIONS.CLOUDBERRY_UNAVAILABLE,
+    category: 'expected',
+    fatal: true,
+  },
+  3007: {
+    errorDescription: ERROR_DESCRIPTIONS.ROOM_TOO_LARGE_FREE_ACCOUNT,
+    category: 'expected',
+    fatal: true,
+  },
+  4001: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_INACTIVE,
+    category: 'expected',
+    fatal: true,
+  },
+  4002: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_LOCKED,
+    category: 'expected',
+    fatal: true,
+    name: 'locus.response',
+  },
+  4003: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_TERMINATING,
+    category: 'expected',
+    fatal: true,
+    name: 'locus.leave',
+  },
+  4004: {
+    errorDescription: ERROR_DESCRIPTIONS.MODERATOR_PIN_OR_GUEST_REQUIRED,
+    category: 'expected',
+    fatal: false,
+  },
+  4005: {
+    errorDescription: ERROR_DESCRIPTIONS.MODERATOR_PIN_OR_GUEST_PIN_REQUIRED,
+    category: 'expected',
+    fatal: false,
+  },
+  4006: {
+    errorDescription: ERROR_DESCRIPTIONS.MODERATOR_REQUIRED,
+    category: 'expected',
+    fatal: false,
+  },
+  4007: {
+    errorDescription: ERROR_DESCRIPTIONS.USER_NOT_MEMBER_OF_ROOM,
+    category: 'expected',
+    fatal: true,
+  },
+  4008: {
+    errorDescription: ERROR_DESCRIPTIONS.NEW_LOCUS_ERROR,
+    category: 'signaling',
+    fatal: true,
+  },
+  4009: {
+    errorDescription: ERROR_DESCRIPTIONS.NETWORK_UNAVAILABLE,
+    category: 'expected',
+    fatal: true,
+  },
+  4010: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_UNAVAILABLE,
+    category: 'expected',
+    fatal: true,
+  },
+  4011: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_ID_INVALID,
+    category: 'expected',
+    fatal: true,
+  },
+  4012: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_SITE_INVALID,
+    category: 'expected',
+    fatal: true,
+  },
+  4013: {
+    errorDescription: ERROR_DESCRIPTIONS.LOCUS_INVALID_JOINTIME,
+    category: 'expected',
+    fatal: true,
+  },
+  4014: {
+    errorDescription: ERROR_DESCRIPTIONS.LOBBY_EXPIRED,
+    category: 'expected',
+    fatal: true,
+  },
+  4015: {
+    errorDescription: ERROR_DESCRIPTIONS.MEDIA_CONNECTION_LOST_PAIRED,
+    category: 'expected',
+    fatal: false,
+  },
+  4016: {
+    errorDescription: ERROR_DESCRIPTIONS.PHONE_NUMBER_NOT_A_NUMBER,
+    category: 'expected',
+    fatal: true,
+    name: 'locus.response',
+  },
+  4017: {
+    errorDescription: ERROR_DESCRIPTIONS.PHONE_NUMBER_TOO_LONG,
+    category: 'expected',
+    fatal: true,
+    name: 'locus.response',
+  },
+  4018: {
+    errorDescription: ERROR_DESCRIPTIONS.INVALID_DIALABLE_KEY,
+    category: 'expected',
+    fatal: true,
+    name: 'locus.response',
+  },
+  4019: {
+    errorDescription: ERROR_DESCRIPTIONS.ONE_ON_ONE_TO_SELF_NOT_ALLOWED,
+    category: 'expected',
+    fatal: true,
+  },
+  4020: {
+    errorDescription: ERROR_DESCRIPTIONS.REMOVED_PARTICIPANT,
+    category: 'expected',
+    fatal: true,
+  },
+  4021: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_LINK_NOT_FOUND,
+    category: 'expected',
+    fatal: true,
+  },
+  4022: {
+    errorDescription: ERROR_DESCRIPTIONS.PHONE_NUMBER_TOO_SHORT_AFTER_IDD,
+    category: 'expected',
+    fatal: true,
+  },
+  4023: {
+    errorDescription: ERROR_DESCRIPTIONS.INVALID_INVITEE_ADDRESS,
+    category: 'expected',
+    fatal: true,
+  },
+  4024: {
+    errorDescription: ERROR_DESCRIPTIONS.PMR_USER_ACCOUNT_LOCKED_OUT,
+    category: 'expected',
+    fatal: true,
+  },
+  4025: {
+    errorDescription: ERROR_DESCRIPTIONS.GUEST_FORBIDDEN,
+    category: 'expected',
+    fatal: true,
+  },
+  4026: {
+    errorDescription: ERROR_DESCRIPTIONS.PMR_ACCOUNT_SUSPENDED,
+    category: 'expected',
+    fatal: true,
+  },
+  4027: {
+    errorDescription: ERROR_DESCRIPTIONS.EMPTY_PHONE_NUMBER_OR_COUNTRY_CODE,
+    category: 'expected',
+    fatal: true,
+  },
+  4028: {
+    errorDescription: ERROR_DESCRIPTIONS.CONVERSATION_NOT_FOUND,
+    category: 'expected',
+    fatal: true,
+  },
+  4029: {
+    errorDescription: ERROR_DESCRIPTIONS.START_RECORDING_FAILED,
+    category: 'expected',
+    fatal: true,
+  },
+  4030: {
+    errorDescription: ERROR_DESCRIPTIONS.RECORDING_IN_PROGRESS_FAILED,
+    category: 'expected',
+    fatal: true,
+  },
+  5000: {
+    errorDescription: ERROR_DESCRIPTIONS.SIP_CALLEE_BUSY,
+    category: 'expected',
+    fatal: true,
+  },
+  5001: {
+    errorDescription: ERROR_DESCRIPTIONS.SIP_CALLEE_NOT_FOUND,
+    category: 'expected',
+    fatal: true,
+  },
+
+  // Webex App API Error Codes
+  4100: {
+    errorDescription: ERROR_DESCRIPTIONS.MEETING_INFO_LOOKUP_ERROR,
+    category: 'signaling',
+    fatal: true,
+  },
+  3003: {
+    errorDescription: ERROR_DESCRIPTIONS.CALL_FULL_ADD_GUEST,
+    category: 'expected',
+    fatal: false,
+  },
+};
+
+export const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = 'js_sdk_call_diagnostic_event_failed_to_send';