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

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

@@ -3,6 +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 PreLoginMetrics from './prelogin-metrics';
 import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent, DelayedClientFeatureEvent } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
@@ -17,6 +18,7 @@ declare class Metrics extends WebexPlugin {
     behavioralMetrics: BehavioralMetrics;
     operationalMetrics: OperationalMetrics;
     businessMetrics: BusinessMetrics;
+    preLoginMetrics: PreLoginMetrics;
     isReady: boolean;
     /**
      * Whether or not to delay the submission of client events.
@@ -76,6 +78,10 @@ declare class Metrics extends WebexPlugin {
      * @returns true once we have the deviceId we need to submit business events
      */
     isReadyToSubmitBusinessEvents(): boolean;
+    /**
+     * @returns whether the current user agent belongs to an automated user
+     */
+    isAutomatedUser(): boolean;
     /**
      * Behavioral event
      * @param args
@@ -105,6 +111,16 @@ declare class Metrics extends WebexPlugin {
         table?: Table;
         metadata?: EventPayload;
     }): Promise<void>;
+    /**
+     * Call Analyzer: Pre-Login Event
+     * @param args
+     */
+    submitPreLoginEvent({ name, preLoginId, payload, metadata, }: {
+        name: string;
+        preLoginId: string;
+        payload: EventPayload;
+        metadata?: EventPayload;
+    }): Promise<void>;
     /**
      * Call Analyzer: Media Quality Event
      * @param args

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

@@ -0,0 +1,47 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
+/**
+ * @description Util class to handle PreLogin Metrics
+ * @export
+ * @class PreLoginMetrics
+ */
+export default class PreLoginMetrics extends GenericMetrics {
+    private preLoginMetricsBatcher;
+    /**
+     * Constructor
+     * @param {PreLoginMetricsBatcher} preLoginMetricsBatcher - Pre-login metrics batcher
+     * @param {any} attrs - Attributes
+     * @param {any} options - Options
+     * @constructor
+     */
+    constructor(preLoginMetricsBatcher: typeof PreLoginMetricsBatcher, attrs?: any, options?: {
+        parent?: any;
+    });
+    /**
+     * Submit a business metric to our metrics endpoint.
+     * Routes to the correct table with the correct schema payload by table.
+     * @see https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+     * @param {Object} options - The options object
+     * @param {string} options.name - Name of the metric
+     * @param {string} options.preLoginId - ID to identify pre-login user
+     * @param {EventPayload} options.payload - User payload of the metric
+     * @param {EventPayload} [options.metadata] - Optional metadata to include outside of eventPayload.value
+     * @returns {Promise<void>} Promise that resolves when the metric is submitted
+     */
+    submitPreLoginEvent({ name, preLoginId, payload, metadata, }: {
+        name: string;
+        preLoginId: string;
+        payload: EventPayload;
+        metadata?: EventPayload;
+    }): Promise<void>;
+    /**
+     * Builds a formatted event object for metrics submission.
+     * @param {string} metricName - Metric name
+     * @param {string} preLoginId - Pre-login user identifier
+     * @param {EventPayload} payload - Metric payload data
+     * @param {EventPayload} metadata - Additional metadata to include in the event
+     * @returns {object} Formatted metrics event object with type, eventPayload, and timestamp
+     */
+    private buildEvent;
+}

package/package.json

@@ -26,22 +26,23 @@
     "@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.11.0",
-    "@webex/test-helper-mocha": "3.11.0",
-    "@webex/test-helper-mock-webex": "3.11.0",
-    "@webex/test-helper-test-users": "3.11.0",
+    "@webex/test-helper-chai": "3.12.0-llmrefactor.1",
+    "@webex/test-helper-mocha": "3.12.0-llmrefactor.1",
+    "@webex/test-helper-mock-webex": "3.12.0-llmrefactor.1",
+    "@webex/test-helper-test-users": "3.12.0-llmrefactor.1",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.11.0",
-    "@webex/common-timers": "3.11.0",
-    "@webex/event-dictionary-ts": "^1.0.1930",
-    "@webex/test-helper-chai": "3.11.0",
-    "@webex/test-helper-mock-webex": "3.11.0",
-    "@webex/webex-core": "3.11.0",
+    "@webex/common": "3.12.0-llmrefactor.1",
+    "@webex/common-timers": "3.12.0-llmrefactor.1",
+    "@webex/event-dictionary-ts": "^1.0.2220",
+    "@webex/test-helper-chai": "3.12.0-llmrefactor.1",
+    "@webex/test-helper-mock-webex": "3.12.0-llmrefactor.1",
+    "@webex/webex-core": "3.12.0-llmrefactor.1",
     "ip-anonymize": "^0.1.0",
+    "isbot": "5.2.1",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
   },
@@ -53,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.11.0"
+  "version": "3.12.0-llmrefactor.1"
 }

package/src/automated-user.ts

@@ -0,0 +1,16 @@
+import {isBot} from 'isbot';
+
+export const isAutomatedUserAgent = (userAgent?: string | null): boolean => isBot(userAgent);
+
+let automatedUser: boolean | undefined;
+
+export const isAutomatedUser = (): boolean => {
+  if (automatedUser === undefined) {
+    automatedUser =
+      typeof window !== 'undefined' &&
+      typeof navigator !== 'undefined' &&
+      (Boolean(navigator.webdriver) || isAutomatedUserAgent(navigator.userAgent));
+  }
+
+  return automatedUser;
+};

package/src/batcher.js

@@ -75,6 +75,10 @@ const MetricsBatcher = Batcher.extend({
    */
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
+      if (!this.config.batcherRetryOnNetworkError) {
+        return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
+      }
+
       this.logger.warn(
         'metrics-batcher: received network error submitting metrics, reenqueuing payload'
       );