@webex/internal-plugin-metrics 3.0.0-bnr.5 → 3.0.0-next.10

package/dist/types/config.d.ts

@@ -12,7 +12,25 @@ declare namespace _default {
         const batcherMaxCalls: number;
         const batcherMaxWait: number;
         const batcherRetryPlateau: number;
+        const waitForServiceTimeout: number;
     }
     export { metrics_1 as metrics };
 }
 export default _default;
+export namespace OS_NAME {
+    const WINDOWS: string;
+    const MAC: string;
+    const IOS: string;
+    const ANDROID: string;
+    const CHROME: string;
+    const LINUX: string;
+    const OTHERS: string;
+}
+export const OSMap: {
+    'Chrome OS': string;
+    macOS: string;
+    Windows: string;
+    iOS: string;
+    Android: string;
+    Linux: string;
+};

package/dist/types/index.d.ts

@@ -1,3 +1,15 @@
-export { default } from "./metrics";
-export { config };
-import config from "./config";
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+import '@webex/internal-plugin-device';
+import config from './config';
+import NewMetrics from './new-metrics';
+import * as Utils from './utils';
+import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitMQE, PreComputedLatencies } from './metrics.types';
+import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
+import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
+import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
+import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
+export { default, getOSNameInternal } from './metrics';
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, };
+export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, PreComputedLatencies, };

package/dist/types/metrics.d.ts

@@ -1,2 +1,3 @@
+export function getOSNameInternal(): any;
 export default Metrics;
 declare const Metrics: any;

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

@@ -0,0 +1,107 @@
+import { ClientEvent as RawClientEvent, Event as RawEvent, MediaQualityEvent as RawMediaQualityEvent } from '@webex/event-dictionary-ts';
+export type Event = Omit<RawEvent, 'event'> & {
+    event: RawClientEvent | RawMediaQualityEvent;
+};
+export type ClientEventError = NonNullable<RawClientEvent['errors']>[0];
+export type EnvironmentType = NonNullable<RawEvent['origin']['environment']>;
+export type NewEnvironmentType = NonNullable<RawEvent['origin']['newEnvironment']>;
+export type ClientLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['clientLaunchMethod'];
+export type BrowserLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['browserLaunchMethod'];
+export type SubmitClientEventOptions = {
+    meetingId?: string;
+    mediaConnections?: any[];
+    rawError?: any;
+    correlationId?: string;
+    preLoginId?: string;
+    environment?: EnvironmentType;
+    newEnvironmentType?: NewEnvironmentType;
+    clientLaunchMethod?: ClientLaunchMethodType;
+    browserLaunchMethod?: BrowserLaunchMethodType;
+    webexConferenceIdStr?: string;
+    globalMeetingId?: string;
+};
+export type SubmitMQEOptions = {
+    meetingId: string;
+    mediaConnections?: any[];
+    networkType?: Event['origin']['networkType'];
+    webexConferenceIdStr?: string;
+    globalMeetingId?: string;
+};
+export type InternalEvent = {
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | 'internal.client.meeting.click.joinbutton' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.interstitial-window.click.joinbutton' | 'internal.client.add-media.turn-discovery.start' | 'internal.client.add-media.turn-discovery.end';
+    payload?: never;
+    options?: never;
+};
+export interface ClientEvent {
+    name: RawClientEvent['name'];
+    payload?: RawClientEvent;
+    options?: SubmitClientEventOptions;
+}
+export interface BehavioralEvent {
+    name: 'host.meeting.participant.admitted' | 'sdk.media-flow.started';
+    payload?: never;
+    options?: never;
+}
+export interface OperationalEvent {
+    name: never;
+    payload?: never;
+    options?: never;
+}
+export interface FeatureEvent {
+    name: never;
+    payload?: never;
+    options?: never;
+}
+export interface MediaQualityEvent {
+    name: RawMediaQualityEvent['name'];
+    payload?: RawMediaQualityEvent;
+    options: SubmitMQEOptions;
+}
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};
+export type MetricEventNames = InternalEvent['name'] | ClientEvent['name'] | BehavioralEvent['name'] | OperationalEvent['name'] | FeatureEvent['name'] | MediaQualityEvent['name'];
+export type ClientInfo = NonNullable<RawEvent['origin']['clientInfo']>;
+export type ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientType'];
+export type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];
+export type NetworkType = NonNullable<RawEvent['origin']>['networkType'];
+export type ClientSubServiceType = ClientEvent['payload']['webexSubServiceType'];
+export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
+export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
+export type ClientEventPayloadError = ClientEvent['payload']['errors'];
+export type MediaQualityEventAudioSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['audioSetupDelay'];
+export type MediaQualityEventVideoSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['videoSetupDelay'];
+export type SubmitMQEPayload = RecursivePartial<MediaQualityEvent['payload']> & {
+    intervals: NonNullable<MediaQualityEvent['payload']>['intervals'];
+};
+export type SubmitInternalEvent = (args: {
+    name: InternalEvent['name'];
+    payload?: RecursivePartial<InternalEvent['payload']>;
+    options?: any;
+}) => void;
+export type SubmitBehavioralEvent = (args: {
+    name: BehavioralEvent['name'];
+    payload?: RecursivePartial<BehavioralEvent['payload']>;
+    options?: any;
+}) => void;
+export type SubmitClientEvent = (args: {
+    name: ClientEvent['name'];
+    payload?: RecursivePartial<ClientEvent['payload']>;
+    options?: SubmitClientEventOptions;
+}) => Promise<any>;
+export type SubmitOperationalEvent = (args: {
+    name: OperationalEvent['name'];
+    payload?: RecursivePartial<OperationalEvent['payload']>;
+    options?: any;
+}) => void;
+export type SubmitMQE = (args: {
+    name: MediaQualityEvent['name'];
+    payload: SubmitMQEPayload;
+    options: any;
+}) => void;
+export type BuildClientEventFetchRequestOptions = (args: {
+    name: ClientEvent['name'];
+    payload?: RecursivePartial<ClientEvent['payload']>;
+    options?: SubmitClientEventOptions;
+}) => Promise<any>;
+export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';

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

@@ -0,0 +1,131 @@
+import { WebexPlugin } from '@webex/webex-core';
+import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
+import { RecursivePartial, ClientEvent, FeatureEvent, BehavioralEvent, OperationalEvent, MediaQualityEvent, InternalEvent, SubmitClientEventOptions } from './metrics.types';
+import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
+/**
+ * Metrics plugin to centralize all types of metrics.
+ * @class
+ */
+declare class Metrics extends WebexPlugin {
+    static instance: Metrics;
+    callDiagnosticLatencies: CallDiagnosticLatencies;
+    callDiagnosticMetrics: CallDiagnosticMetrics;
+    /**
+     * Constructor
+     * @param args
+     * @constructor
+     * @private
+     * @returns
+     */
+    constructor(...args: any[]);
+    /**
+     * On Ready
+     */
+    private onReady;
+    /**
+     * Used for internal purposes only
+     * @param args
+     */
+    submitInternalEvent({ name, payload, options, }: {
+        name: InternalEvent['name'];
+        payload?: RecursivePartial<InternalEvent['payload']>;
+        options?: any;
+    }): void;
+    /**
+     * Behavioral event
+     * @param args
+     */
+    submitBehavioralEvent({ name, payload, options, }: {
+        name: BehavioralEvent['name'];
+        payload?: RecursivePartial<BehavioralEvent['payload']>;
+        options?: any;
+    }): void;
+    /**
+     * Operational event
+     * @param args
+     */
+    submitOperationalEvent({ name, payload, options, }: {
+        name: OperationalEvent['name'];
+        payload?: RecursivePartial<OperationalEvent['payload']>;
+        options?: any;
+    }): void;
+    /**
+     * Call Analyzer: Media Quality Event
+     * @param args
+     */
+    submitMQE({ name, payload, options, }: {
+        name: MediaQualityEvent['name'];
+        payload: RecursivePartial<MediaQualityEvent['payload']> & {
+            intervals: MediaQualityEvent['payload']['intervals'];
+        };
+        options: any;
+    }): void;
+    /**
+     * Call Analyzer: Feature Usage Event
+     * @param args
+     */
+    submitFeatureEvent({ name, payload, options, }: {
+        name: FeatureEvent['name'];
+        payload?: RecursivePartial<FeatureEvent['payload']>;
+        options: any;
+    }): void;
+    /**
+     * Call Analyzer: Client Event
+     * @public
+     * @param args
+     */
+    submitClientEvent({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: RecursivePartial<ClientEvent['payload']>;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+    /**
+     * Issue request to alias a user's pre-login ID with their CI UUID
+     * @param {string} preLoginId
+     * @returns {Object} HttpResponse object
+     */
+    clientMetricsAliasUser(preLoginId: string): any;
+    /**
+     * Returns a promise that will resolve to fetch options for submitting a metric.
+     *
+     * This is to support quickly submitting metrics when the browser/tab is closing.
+     * Calling submitClientEvent will not work because there some async steps that will
+     * not complete before the browser is closed.  Instead, we pre-gather all the
+     * information/options needed for the request(s), and then simply and quickly
+     * fire the fetch(es) when beforeUnload is triggered.
+     *
+     * We must use fetch instead of request because fetch has a keepalive option that
+     * allows the request it to outlive the page.
+     *
+     * Note: the timings values will be wrong, but setMetricTimingsAndFetch() will
+     * properly adjust them before submitting.
+     *
+     * @public
+     * @param {Object} arg
+     * @param {String} arg.name - event name
+     * @param {Object} arg.payload - event payload
+     * @param {Object} arg.options - other options
+     * @returns {Promise} promise that resolves to options to be used with fetch
+     */
+    buildClientEventFetchRequestOptions({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: RecursivePartial<ClientEvent['payload']>;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+    /**
+     * Submits a metric from pre-built request options via the fetch API. Updates
+     * the "$timings" and "originTime" values to Date.now() since the existing times
+     * were set when the options were built (not submitted).
+  
+     * @param {any} options - the pre-built request options for submitting a metric
+     * @returns {Promise} promise that resolves to the response object
+     */
+    setMetricTimingsAndFetch(options: any): Promise<any>;
+    /**
+     * Returns true if the specified serviceErrorCode maps to an expected error.
+     * @param {number} serviceErrorCode the service error code
+     * @returns {boolean}
+     */
+    isServiceErrorExpected(serviceErrorCode: number): boolean;
+}
+export default Metrics;

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

@@ -0,0 +1,2 @@
+declare const PreLoginMetricsBatcher: any;
+export default PreLoginMetricsBatcher;

package/dist/types/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates common metadata for errors
+ * @param {any} error
+ * @returns {object}
+ */
+export declare const generateCommonErrorMetadata: (error: any) => any;

package/dist/utils.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateCommonErrorMetadata = void 0;
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+/* eslint-disable import/prefer-default-export */
+/**
+ * Generates common metadata for errors
+ * @param {any} error
+ * @returns {object}
+ */
+var generateCommonErrorMetadata = exports.generateCommonErrorMetadata = function generateCommonErrorMetadata(error) {
+  if (error instanceof Error) {
+    return (0, _stringify.default)({
+      message: error === null || error === void 0 ? void 0 : error.message,
+      name: error === null || error === void 0 ? void 0 : error.name,
+      stack: error === null || error === void 0 ? void 0 : error.stack
+    });
+  }
+  return error;
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["generateCommonErrorMetadata","exports","error","Error","_stringify","default","message","name","stack"],"sources":["utils.ts"],"sourcesContent":["/* eslint-disable import/prefer-default-export */\n/**\n * Generates common metadata for errors\n * @param {any} error\n * @returns {object}\n */\nexport const generateCommonErrorMetadata = (error) => {\n  if (error instanceof Error) {\n    return JSON.stringify({\n      message: error?.message,\n      name: error?.name,\n      stack: error?.stack,\n    });\n  }\n\n  return error;\n};\n"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACO,IAAMA,2BAA2B,GAAAC,OAAA,CAAAD,2BAAA,GAAG,SAA9BA,2BAA2BA,CAAIE,KAAK,EAAK;EACpD,IAAIA,KAAK,YAAYC,KAAK,EAAE;IAC1B,OAAO,IAAAC,UAAA,CAAAC,OAAA,EAAe;MACpBC,OAAO,EAAEJ,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEI,OAAO;MACvBC,IAAI,EAAEL,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEK,IAAI;MACjBC,KAAK,EAAEN,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEM;IAChB,CAAC,CAAC;EACJ;EAEA,OAAON,KAAK;AACd,CAAC"}

package/jest.config.js

@@ -0,0 +1,3 @@
+const config = require('@webex/jest-config-legacy');
+
+module.exports = config;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-bnr.5",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
   "devMain": "src/index.js",
+  "types": "dist/types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/webex/webex-js-sdk.git",
@@ -20,16 +20,40 @@
     ]
   },
   "devDependencies": {
+    "@babel/core": "^7.17.10",
     "@sinonjs/fake-timers": "^6.0.1",
+    "@webex/babel-config-legacy": "0.0.0",
+    "@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.0.0-next.10",
+    "@webex/test-helper-mocha": "3.0.0-next.10",
+    "@webex/test-helper-mock-webex": "3.0.0-next.10",
+    "@webex/test-helper-test-users": "3.0.0-next.10",
+    "eslint": "^8.24.0",
+    "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-bnr.5",
-    "@webex/common-timers": "3.0.0-bnr.5",
-    "@webex/internal-plugin-device": "3.0.0-bnr.5",
-    "@webex/internal-plugin-metrics": "3.0.0-bnr.5",
-    "@webex/test-helper-chai": "3.0.0-bnr.5",
-    "@webex/test-helper-mock-webex": "3.0.0-bnr.5",
-    "@webex/webex-core": "3.0.0-bnr.5"
-  }
-}
+    "@webex/common": "3.0.0-next.10",
+    "@webex/common-timers": "3.0.0-next.10",
+    "@webex/event-dictionary-ts": "^1.0.1406",
+    "@webex/internal-plugin-device": "3.0.0-next.10",
+    "@webex/internal-plugin-metrics": "3.0.0-next.10",
+    "@webex/test-helper-chai": "3.0.0-next.10",
+    "@webex/test-helper-mock-webex": "3.0.0-next.10",
+    "@webex/webex-core": "3.0.0-next.10",
+    "ip-anonymize": "^0.1.0",
+    "lodash": "^4.17.21",
+    "uuid": "^3.3.2"
+  },
+  "scripts": {
+    "build": " yarn run -T tsc --declaration true --declarationDir ./dist/types",
+    "build:src": "webex-legacy-tools build -dest \"./dist\" -src \"./src\" -js -ts -maps && yarn build",
+    "deploy:npm": "yarn npm publish",
+    "test": "yarn test:style && yarn test:unit && yarn test:integration && yarn test:browser",
+    "test:style": "eslint ./src/**/*.*",
+    "test:unit": "webex-legacy-tools test --unit --runner mocha"
+  },
+  "version": "3.0.0-next.10"
+}

package/process

@@ -0,0 +1 @@
+module.exports = {browser: true};

package/src/batcher.js

@@ -7,9 +7,18 @@ import {safeSetTimeout} from '@webex/common-timers';
 
 const sym = Symbol('metric id');
 
+/**
+ * @class
+ * @extends Batcher
+ * @memberof Metrics
+ */
 const MetricsBatcher = Batcher.extend({
   namespace: 'Metrics',
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   prepareItem(item) {
     // Keep non-prod data out of metrics
     const env = process.env.NODE_ENV === 'production' ? null : 'TEST';
@@ -22,6 +31,10 @@ const MetricsBatcher = Batcher.extend({
     return Promise.resolve(item);
   },
 
+  /**
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
   prepareRequest(queue) {
     return Promise.resolve(
       queue.map((item) => {
@@ -32,6 +45,10 @@ const MetricsBatcher = Batcher.extend({
     );
   },
 
+  /**
+   * @param {any} payload
+   * @returns {Promise<any>}
+   */
   submitHttpRequest(payload) {
     return this.webex.request({
       method: 'POST',
@@ -40,13 +57,22 @@ const MetricsBatcher = Batcher.extend({
       body: {
         metrics: payload,
       },
+      waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout,
     });
   },
 
+  /**
+   * @param {any} res
+   * @returns {Promise<any>}
+   */
   handleHttpSuccess(res) {
     return Promise.all(res.options.body.metrics.map((item) => this.acceptItem(item)));
   },
 
+  /**
+   * @param {any} reason
+   * @returns {Promise<any>}
+   */
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
       this.logger.warn(
@@ -73,6 +99,10 @@ const MetricsBatcher = Batcher.extend({
     return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   rerequest(item) {
     return Promise.all([this.getDeferredForRequest(item), this.prepareItem(item)]).then(
       ([defer, req]) => {
@@ -83,6 +113,10 @@ const MetricsBatcher = Batcher.extend({
     );
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   fingerprintRequest(item) {
     item[sym] = item[sym] || {
       nextDelay: 1000,
@@ -91,6 +125,10 @@ const MetricsBatcher = Batcher.extend({
     return Promise.resolve(item[sym]);
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   fingerprintResponse(item) {
     return Promise.resolve(item[sym]);
   },

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

@@ -0,0 +1,72 @@
+import {uniqueId} from 'lodash';
+import Batcher from '../batcher';
+import {prepareDiagnosticMetricItem} from './call-diagnostic-metrics.util';
+import {CALL_DIAGNOSTIC_LOG_IDENTIFIER} from './config';
+import {generateCommonErrorMetadata} from '../utils';
+
+const CallDiagnosticEventsBatcher = Batcher.extend({
+  namespace: 'Metrics',
+
+  /**
+   * Prepare item
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
+  prepareItem(item) {
+    return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));
+  },
+
+  /**
+   * Prepare request, add time sensitive date etc.
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
+  prepareRequest(queue) {
+    // Add sent timestamp
+    queue.forEach((item) => {
+      item.eventPayload.originTime = item.eventPayload.originTime || {};
+      item.eventPayload.originTime.sent = new Date().toISOString();
+    });
+
+    return Promise.resolve(queue);
+  },
+
+  /**
+   *
+   * @param {any} payload
+   * @returns {Promise<any>}
+   */
+  submitHttpRequest(payload) {
+    const batchId = uniqueId('ca-batch-');
+
+    return this.webex
+      .request({
+        method: 'POST',
+        service: 'metrics',
+        resource: 'clientmetrics',
+        body: {
+          metrics: payload,
+        },
+        waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout,
+      })
+      .then((res) => {
+        this.webex.logger.log(
+          CALL_DIAGNOSTIC_LOG_IDENTIFIER,
+          `CallDiagnosticEventsBatcher: @submitHttpRequest#${batchId}. Request successful.`
+        );
+
+        return res;
+      })
+      .catch((err) => {
+        this.webex.logger.error(
+          CALL_DIAGNOSTIC_LOG_IDENTIFIER,
+          `CallDiagnosticEventsBatcher: @submitHttpRequest#${batchId}. Request failed:`,
+          `error: ${generateCommonErrorMetadata(err)}`
+        );
+
+        return Promise.reject(err);
+      });
+  },
+});
+
+export default CallDiagnosticEventsBatcher;