@webex/internal-plugin-metrics 3.12.0-webex-services-ready.4 → 3.13.0

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

@@ -64,10 +64,17 @@ import {
   SDP_OFFER_CREATION_ERROR_MAP,
   CALL_FEATURE_LOG_IDENTIFIER,
   CALL_FEATURE_EVENT_FAILED_TO_SEND,
+  LOCUS_RATE_LIMITED_OUTGOING_CLIENT_CODE,
+  LOCUS_UNAVAILABLE_CLIENT_CODE,
 } from './config';
 
 const {getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
+const LOCUS_HTTP_STATUS_TO_CLIENT_ERROR_CODE: Partial<Record<number, number>> = {
+  429: LOCUS_RATE_LIMITED_OUTGOING_CLIENT_CODE,
+  503: LOCUS_UNAVAILABLE_CLIENT_CODE,
+};
+
 type GetOriginOptions = {
   clientType: ClientType;
   subClientType: SubClientType;
@@ -87,6 +94,7 @@ type GetIdentifiersOptions = {
   preLoginId?: string;
   globalMeetingId?: string;
   webexConferenceIdStr?: string;
+  locusCluster?: string;
 };
 
 /**
@@ -292,6 +300,18 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       versionMetadata = extractVersionMetadata(providedClientVersion);
     }
 
+    // Browser details and the support verdict can all be supplied by the host client, which is able
+    // to resolve wrapper browsers (Electron, WebOS) to the engine that actually determines
+    // capability. The browser fields fall back to the SDK's own detection when not supplied, the
+    // same way clientVersion falls back to the SDK version.
+    const {
+      browser: providedBrowser,
+      browserVersion: providedBrowserVersion,
+      isSupportedBrowserFamily,
+      isOutdatedBrowserVersion,
+      // @ts-ignore
+    } = this.webex.meetings?.config?.metrics ?? {};
+
     if (!this.hasLoggedBrowserSerial) {
       this.logger.log(
         CALL_DIAGNOSTIC_LOG_IDENTIFIER,
@@ -332,14 +352,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           osVersion: getOSVersion() || 'unknown',
           subClientType: options?.subClientType || defaultSubClientType,
           os: getOSNameInternal(),
-          browser: getBrowserName(),
-          browserVersion: getBrowserVersion(),
+          browser: providedBrowser || getBrowserName(),
+          browserVersion: providedBrowserVersion || getBrowserVersion(),
+          ...(isSupportedBrowserFamily === undefined ? {} : {isSupportedBrowserFamily}),
+          ...(isOutdatedBrowserVersion === undefined ? {} : {isOutdatedBrowserVersion}),
         },
       };
 
       if (meetingId) {
         // @ts-ignore
-        const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+        const meeting = this.webex.meetings?.getBasicMeetingInformation(meetingId);
         if (meeting?.environment) {
           origin.environment = meeting.environment;
         }
@@ -371,6 +393,20 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     throw new Error("ClientType and SubClientType can't be undefined");
   }
 
+  /**
+   * Returns the signed-in user's CI ID derived from credentials tokens.
+   * Used as a fallback when no device is registered.
+   * @returns the userId, or undefined if it can't be determined
+   */
+  private getUserIdFromCredentials(): string | undefined {
+    try {
+      // @ts-ignore
+      return this.webex.credentials.getUserId();
+    } catch {
+      return undefined;
+    }
+  }
+
   /**
    * Gather identifier details for call diagnostic payload.
    * @throws Error if initialization fails.
@@ -385,6 +421,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       globalMeetingId,
       preLoginId,
       sessionCorrelationId,
+      locusCluster,
     } = options;
     const identifiers: Event['event']['identifiers'] = {
       correlationId: 'unknown', // concerned with setting this to unknown. This will fail diagnostic events parsing because it's not a uuid pattern
@@ -415,7 +452,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       const {device} = this;
       const {installationId} = device?.config || {};
 
-      identifiers.userId = device?.userId || preLoginId;
       identifiers.deviceId = device?.url;
       identifiers.orgId = device?.orgId;
       // @ts-ignore
@@ -426,6 +462,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       }
     }
 
+    // Prefer the device's userId, but fall back to the signed-in user's ID from
+    // credentials when no device is registered, then to the pre-login ID.
+    identifiers.userId = this.device?.userId || this.getUserIdFromCredentials() || preLoginId;
+
     if (meeting?.locusInfo?.fullState) {
       identifiers.locusUrl = meeting.locusUrl;
       identifiers.locusId = meeting.locusUrl && meeting.locusUrl.split('/').pop();
@@ -448,6 +488,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       identifiers.webexSiteName = meeting.meetingInfo?.siteName;
     }
 
+    if (meeting?.meetingInfo?.locusClusterUrl) {
+      identifiers.locusCluster = meeting.meetingInfo.locusClusterUrl;
+    }
+
     if (mediaConnections) {
       identifiers.mediaAgentAlias = mediaConnections?.[0]?.mediaAgentAlias;
       identifiers.mediaAgentGroupId = mediaConnections?.[0]?.mediaAgentGroupId;
@@ -461,6 +505,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       identifiers.globalMeetingId = globalMeetingId;
     }
 
+    if (!identifiers?.locusCluster && locusCluster) {
+      identifiers.locusCluster = locusCluster;
+    }
+
     if (identifiers.correlationId === undefined) {
       throw new Error('Identifiers initialization failed.');
     }
@@ -688,7 +736,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * @param arg.clientErrorCode
    * @param arg.serviceErrorCode
    * @param arg.payloadOverrides
-   * @param arg.httpStatusCode
+   * @param arg.httpCode
    * @returns
    */
   public getErrorPayloadForClientErrorCode({
@@ -697,14 +745,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     serviceErrorName,
     rawErrorMessage,
     payloadOverrides,
-    httpStatusCode,
+    httpCode,
   }: {
     clientErrorCode: number;
     serviceErrorCode: any;
     serviceErrorName?: any;
     rawErrorMessage?: string;
     payloadOverrides?: any;
-    httpStatusCode?: number;
+    httpCode?: number;
   }): ClientEventError {
     let error: ClientEventError;
 
@@ -718,7 +766,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           serviceErrorName ? {errorData: {errorName: serviceErrorName}} : {},
           {serviceErrorCode},
           {rawErrorMessage},
-          httpStatusCode === undefined ? {} : {httpStatusCode},
+          httpCode === undefined ? {} : {httpCode},
           partialParsedError,
           payloadOverrides || {}
         );
@@ -887,7 +935,12 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     }
 
     const rawErrorMessage = rawError.message;
-    const httpStatusCode = rawError.statusCode;
+    const httpCode = rawError.statusCode;
+    const serviceErrorCode =
+      rawError?.error?.body?.errorCode ||
+      rawError?.body?.errorCode ||
+      rawError?.body?.code ||
+      rawError?.body?.reason?.reasonCode;
     let payload;
 
     if (rawError.name) {
@@ -897,7 +950,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           clientErrorCode: BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[rawError.name],
           serviceErrorName: rawError.name,
           rawErrorMessage,
-          httpStatusCode,
+          httpCode,
         });
       }
     }
@@ -912,16 +965,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           SDP_OFFER_CREATION_ERROR_MAP[causeType] || SDP_OFFER_CREATION_ERROR_MAP.GENERAL,
         serviceErrorName: rawError.name,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
-    const serviceErrorCode =
-      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 && !payload) {
@@ -929,17 +976,30 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           clientErrorCode,
           serviceErrorCode,
           rawErrorMessage,
-          httpStatusCode,
+          httpCode,
         });
       }
+    }
+
+    const locusHttpClientErrorCode = LOCUS_HTTP_STATUS_TO_CLIENT_ERROR_CODE[httpCode];
+    const requestUrl = rawError.options?.uri || rawError.options?.url;
+    if (locusHttpClientErrorCode && !payload && requestUrl?.includes('locus')) {
+      payload = this.getErrorPayloadForClientErrorCode({
+        clientErrorCode: locusHttpClientErrorCode,
+        serviceErrorCode,
+        rawErrorMessage,
+        httpCode,
+      });
+    }
 
+    if (serviceErrorCode) {
       // by default, if it is locus error, return new locus err
       if (isLocusServiceErrorCode(serviceErrorCode) && !payload) {
         payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode: NEW_LOCUS_ERROR_CLIENT_CODE,
           serviceErrorCode,
           rawErrorMessage,
-          httpStatusCode,
+          httpCode,
         });
       }
     }
@@ -949,7 +1009,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         clientErrorCode: MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
         serviceErrorCode,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -959,7 +1019,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -969,7 +1029,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -981,7 +1041,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorName: rawError?.name,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -1013,6 +1073,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       globalMeetingId,
       webexConferenceIdStr,
       sessionCorrelationId,
+      locusCluster,
     } = options;
 
     // @ts-ignore
@@ -1046,6 +1107,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       webexConferenceIdStr,
       globalMeetingId,
       sessionCorrelationId,
+      locusCluster,
     });
 
     // create common event object structure
@@ -1086,9 +1148,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       commonEventObject.meetingJoinedTime = meetingJoinedTime;
     }
 
-    if (options.meetingJoinPhase) {
+    const meetingJoinPhase =
+      options.meetingJoinPhase ?? meeting.callStateForMetrics?.meetingJoinPhase;
+    if (meetingJoinPhase) {
       // @ts-ignore
-      commonEventObject.meetingJoinPhase = options.meetingJoinPhase;
+      commonEventObject.meetingJoinPhase = meetingJoinPhase;
     }
 
     return commonEventObject;
@@ -1169,8 +1233,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     options?: SubmitClientEventOptions;
     errors?: ClientEventPayloadError;
   }) {
-    const {correlationId, globalMeetingId, webexConferenceIdStr, preLoginId, sessionCorrelationId} =
-      options;
+    const {
+      correlationId,
+      globalMeetingId,
+      webexConferenceIdStr,
+      preLoginId,
+      sessionCorrelationId,
+      locusCluster,
+    } = options;
 
     // grab identifiers
     const identifiers = this.getIdentifiers({
@@ -1179,6 +1249,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       preLoginId,
       globalMeetingId,
       webexConferenceIdStr,
+      locusCluster,
     });
 
     // create client event object
@@ -1203,9 +1274,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       clientEventObject.joinFlowVersion = options.joinFlowVersion;
     }
 
-    if (options.meetingJoinPhase) {
-      clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
-    }
+    // No meeting exists yet for pre-meeting events, so the join phase is pre-join by construction
+    clientEventObject.meetingJoinPhase = options.meetingJoinPhase ?? 'pre-join';
 
     if (options.userNameInput) {
       clientEventObject.userNameInput = options.userNameInput;

package/src/call-diagnostic/config.ts

@@ -8,6 +8,8 @@ export const CALL_DIAGNOSTIC_LOG_IDENTIFIER = 'call-diagnostic-events -> ';
 export const CALL_FEATURE_LOG_IDENTIFIER = 'call-diagnostic-events-feature -> ';
 
 export const AUTHENTICATION_FAILED_CODE = 1010;
+export const LOCUS_RATE_LIMITED_OUTGOING_CLIENT_CODE = 1002;
+export const LOCUS_UNAVAILABLE_CLIENT_CODE = 1003;
 export const NETWORK_ERROR = 1026;
 export const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
 export const MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE = 4100;