@webex/internal-plugin-metrics 3.12.0-llmrefactor.1 → 3.12.0-llmrefactor.10

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;
@@ -385,6 +392,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.
@@ -429,7 +450,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
@@ -440,6 +460,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();
@@ -702,7 +726,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({
@@ -711,14 +735,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;
 
@@ -732,7 +756,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           serviceErrorName ? {errorData: {errorName: serviceErrorName}} : {},
           {serviceErrorCode},
           {rawErrorMessage},
-          httpStatusCode === undefined ? {} : {httpStatusCode},
+          httpCode === undefined ? {} : {httpCode},
           partialParsedError,
           payloadOverrides || {}
         );
@@ -901,7 +925,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) {
@@ -911,7 +940,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,
         });
       }
     }
@@ -926,16 +955,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) {
@@ -943,17 +966,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,
         });
       }
     }
@@ -963,7 +999,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         clientErrorCode: MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
         serviceErrorCode,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -973,7 +1009,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -983,7 +1019,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorCode,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 
@@ -995,7 +1031,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         serviceErrorName: rawError?.name,
         payloadOverrides: rawError.payloadOverrides,
         rawErrorMessage,
-        httpStatusCode,
+        httpCode,
       });
     }
 

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;

package/src/config.js

@@ -15,6 +15,13 @@ export default {
   },
   metrics: {
     appType: inBrowser ? 'browser' : 'nodejs',
+    unhandledExceptionTelemetry: {
+      enabled: false,
+    },
+    networkTelemetry: {
+      enabled: false,
+      intervalMs: 10 * 60 * 1_000,
+    },
     batcherWait: 500,
     batcherMaxCalls: 50,
     batcherMaxWait: 1500,

package/src/index.ts

@@ -2,6 +2,8 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
+/* eslint-disable valid-jsdoc */
+
 import {registerInternalPlugin} from '@webex/webex-core';
 
 import Metrics from './metrics';
@@ -21,6 +23,7 @@ import {
   PreComputedLatencies,
   SubmitFeatureEvent,
   LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
@@ -34,6 +37,13 @@ import PreLoginMetrics from './prelogin-metrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
+  /**
+   * Stops network telemetry before SDK logout.
+   * @returns
+   */
+  onBeforeLogout() {
+    return this.stopNetworkTelemetry();
+  },
 });
 
 registerInternalPlugin('newMetrics', NewMetrics, {
@@ -70,4 +80,5 @@ export type {
   PreComputedLatencies,
   SubmitFeatureEvent,
   LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 };

package/src/metrics.js

@@ -1,4 +1,5 @@
 /* eslint-disable default-param-last */
+/* eslint-disable valid-jsdoc */
 
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
@@ -11,6 +12,7 @@ import {OS_NAME, OSMap, CLIENT_NAME} from './config';
 import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
 import ClientMetricsPreloginBatcher from './client-metrics-prelogin-batcher';
+import {createNetworkTelemetryCollector} from './network-telemetry';
 
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
@@ -43,6 +45,119 @@ const Metrics = WebexPlugin.extend({
 
   namespace: 'Metrics',
 
+  /**
+   * Registers SDK request outcome monitoring.
+   * @param args
+   * @returns
+   */
+  initialize(...args) {
+    WebexPlugin.prototype.initialize.call(this, ...args);
+
+    // Metrics may also be constructed as a standalone plugin. Request events are
+    // available only when it is attached to a Webex instance.
+    if (!this.parent && !this.collection) {
+      return;
+    }
+
+    const initializeNetworkTelemetry = () => {
+      if (
+        this.networkTelemetry ||
+        this.webex?.config?.metrics?.networkTelemetry?.enabled !== true
+      ) {
+        return;
+      }
+
+      this.networkTelemetry = createNetworkTelemetryCollector({
+        intervalMs: this.webex.config.metrics.networkTelemetry.intervalMs,
+        submitMetric: this.submitNetworkTelemetryMetric.bind(this),
+        onSubmissionFailure: this.handleNetworkTelemetrySubmissionFailure.bind(this),
+      });
+      this.listenTo(this.webex, 'request:start', this.recordNetworkRequestStart);
+      this.listenTo(this.webex, 'request:success', this.recordNetworkRequestSuccess);
+      this.listenTo(this.webex, 'request:failure', this.recordNetworkRequestFailure);
+    };
+
+    // Ampersand initializes children before WebexCore.initialize() populates
+    // webex.config. Run immediately for already-configured hosts (including
+    // MockWebex), and listen for the real core's post-initialization notification.
+    this.listenToOnce(this.webex, 'change:config', initializeNetworkTelemetry);
+    initializeNetworkTelemetry();
+  },
+
+  /**
+   * Records an SDK request being sent in the current reporting window.
+   * @param options
+   * @returns
+   */
+  recordNetworkRequestStart(options) {
+    this.networkTelemetry.recordRequest(options);
+  },
+
+  /**
+   * Records a successful SDK request for the current reporting window.
+   * @param options
+   * @returns
+   */
+  recordNetworkRequestSuccess(options) {
+    this.networkTelemetry.recordResponse(options);
+  },
+
+  /**
+   * Records a failed SDK request for the current reporting window.
+   * @param options
+   * @param reason
+   * @returns
+   */
+  recordNetworkRequestFailure(options, reason) {
+    this.networkTelemetry.recordFailure(options, reason);
+  },
+
+  /**
+   * Submits the current network telemetry window immediately.
+   * @returns
+   */
+  flushNetworkTelemetry() {
+    if (!this.networkTelemetry) {
+      return Promise.resolve();
+    }
+
+    return this.networkTelemetry.flush();
+  },
+
+  /**
+   * Submits a completed network telemetry window through client metrics.
+   * @param name
+   * @param properties
+   * @returns
+   */
+  submitNetworkTelemetryMetric(name, properties) {
+    return this.submitClientMetrics(name, properties);
+  },
+
+  /**
+   * Logs a network telemetry submission failure without affecting SDK requests.
+   * @returns
+   */
+  handleNetworkTelemetrySubmissionFailure() {
+    this.webex.logger?.warn('metrics: failed to submit network request summary telemetry');
+  },
+
+  /**
+   * Stops network telemetry collection and submission.
+   * @returns
+   */
+  stopNetworkTelemetry() {
+    if (!this.networkTelemetry) {
+      return Promise.resolve();
+    }
+
+    this.stopListening(this.webex, 'request:start', this.recordNetworkRequestStart);
+    this.stopListening(this.webex, 'request:success', this.recordNetworkRequestSuccess);
+    this.stopListening(this.webex, 'request:failure', this.recordNetworkRequestFailure);
+
+    return this.networkTelemetry.stop();
+  },
+
   submit(key, value) {
     return this.batcher.request({key, ...value});
   },
@@ -60,17 +175,20 @@ const Metrics = WebexPlugin.extend({
     const payload = {metricName: eventName};
     // @ts-ignore
     const providedClientVersion = this.webex.meetings?.config?.metrics?.clientVersion;
+    const {appName, appVersion} = this.webex.config;
+    // Browser location is unavailable when the SDK runs in Node.js.
+    // eslint-disable-next-line no-undef
+    const browserLocation = typeof window !== 'undefined' ? window.location : undefined;
 
     payload.tags = {
       ...props.tags,
+      app_name: appName ?? 'unknown',
+      app_url: browserLocation?.origin || browserLocation?.hostname || 'non-browser',
+      app_version: appVersion ?? 'unknown',
       browser: getBrowserName(),
       os: getOSNameInternal(),
       appVersion: providedClientVersion,
-
-      // Node does not like this so we need to check if it exists or not
-      // eslint-disable-next-line no-undef
-      domain:
-        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
+      domain: browserLocation?.hostname || 'non-browser',
     };
 
     payload.fields = {

package/src/metrics.types.ts

@@ -23,6 +23,15 @@ export type ClientUserNameInput = NonNullable<RawClientEvent['userNameInput']>;
 
 export type ClientEmailInput = NonNullable<RawClientEvent['emailInput']>;
 
+export type PrivacyAndSecurityPermission = NonNullable<
+  RawClientEvent['privacyAndSecurityPermission']
+>;
+
+export type PrivacyAndSecurityPermissionResource = keyof PrivacyAndSecurityPermission;
+
+export type PrivacyAndSecurityPermissionState =
+  PrivacyAndSecurityPermission[PrivacyAndSecurityPermissionResource];
+
 export type BrowserLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['browserLaunchMethod'];