@webex/internal-plugin-metrics 3.3.1 → 3.4.0-next.2

package/dist/operational-metrics.js

@@ -0,0 +1,56 @@
+"use strict";
+
+var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
+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.default = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
+var _genericMetrics = _interopRequireDefault(require("./generic-metrics"));
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+/**
+ * @description Util class to handle Operational Metrics
+ * @export
+ * @class OperationalMetrics
+ */
+var OperationalMetrics = exports.default = /*#__PURE__*/function (_GenericMetrics) {
+  (0, _inherits2.default)(OperationalMetrics, _GenericMetrics);
+  var _super = _createSuper(OperationalMetrics);
+  function OperationalMetrics() {
+    (0, _classCallCheck2.default)(this, OperationalMetrics);
+    return _super.apply(this, arguments);
+  }
+  (0, _createClass2.default)(OperationalMetrics, [{
+    key: "submitOperationalEvent",
+    value:
+    /**
+     * Submit an operational metric to our metrics endpoint.
+     * @param {string} name of the metric
+     * @param {EventPayload} user payload of the metric
+     * @returns {Promise<any>}
+     */
+    function submitOperationalEvent(_ref) {
+      var name = _ref.name,
+        payload = _ref.payload;
+      var event = this.createTaggedEventObject({
+        type: ['operational'],
+        name: name,
+        payload: payload
+      });
+      this.submitEvent({
+        kind: 'operational-events -> ',
+        name: name,
+        event: event
+      });
+    }
+  }]);
+  return OperationalMetrics;
+}(_genericMetrics.default);
+//# sourceMappingURL=operational-metrics.js.map

package/dist/operational-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_genericMetrics","_interopRequireDefault","require","_createSuper","Derived","hasNativeReflectConstruct","_isNativeReflectConstruct","_createSuperInternal","Super","_getPrototypeOf2","default","result","NewTarget","constructor","_Reflect$construct","arguments","apply","_possibleConstructorReturn2","Reflect","sham","Proxy","Boolean","prototype","valueOf","call","e","OperationalMetrics","exports","_GenericMetrics","_inherits2","_super","_classCallCheck2","_createClass2","key","value","submitOperationalEvent","_ref","name","payload","event","createTaggedEventObject","type","submitEvent","kind","GenericMetrics"],"sources":["operational-metrics.ts"],"sourcesContent":["import GenericMetrics from './generic-metrics';\nimport {EventPayload} from './metrics.types';\n\n/**\n * @description Util class to handle Operational Metrics\n * @export\n * @class OperationalMetrics\n */\nexport default class OperationalMetrics extends GenericMetrics {\n  /**\n   * Submit an operational metric to our metrics endpoint.\n   * @param {string} name of the metric\n   * @param {EventPayload} user payload of the metric\n   * @returns {Promise<any>}\n   */\n  public submitOperationalEvent({name, payload}: {name: string; payload: EventPayload}) {\n    const event = this.createTaggedEventObject({\n      type: ['operational'],\n      name,\n      payload,\n    });\n    this.submitEvent({kind: 'operational-events -> ', name, event});\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,IAAAA,eAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA+C,SAAAC,aAAAC,OAAA,QAAAC,yBAAA,GAAAC,yBAAA,oBAAAC,qBAAA,QAAAC,KAAA,OAAAC,gBAAA,CAAAC,OAAA,EAAAN,OAAA,GAAAO,MAAA,MAAAN,yBAAA,QAAAO,SAAA,OAAAH,gBAAA,CAAAC,OAAA,QAAAG,WAAA,EAAAF,MAAA,GAAAG,kBAAA,CAAAN,KAAA,EAAAO,SAAA,EAAAH,SAAA,YAAAD,MAAA,GAAAH,KAAA,CAAAQ,KAAA,OAAAD,SAAA,gBAAAE,2BAAA,CAAAP,OAAA,QAAAC,MAAA;AAAA,SAAAL,0BAAA,eAAAY,OAAA,qBAAAJ,kBAAA,oBAAAA,kBAAA,CAAAK,IAAA,2BAAAC,KAAA,oCAAAC,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAV,kBAAA,CAAAO,OAAA,8CAAAI,CAAA;AAG/C;AACA;AACA;AACA;AACA;AAJA,IAKqBC,kBAAkB,GAAAC,OAAA,CAAAjB,OAAA,0BAAAkB,eAAA;EAAA,IAAAC,UAAA,CAAAnB,OAAA,EAAAgB,kBAAA,EAAAE,eAAA;EAAA,IAAAE,MAAA,GAAA3B,YAAA,CAAAuB,kBAAA;EAAA,SAAAA,mBAAA;IAAA,IAAAK,gBAAA,CAAArB,OAAA,QAAAgB,kBAAA;IAAA,OAAAI,MAAA,CAAAd,KAAA,OAAAD,SAAA;EAAA;EAAA,IAAAiB,aAAA,CAAAtB,OAAA,EAAAgB,kBAAA;IAAAO,GAAA;IAAAC,KAAA;IACrC;AACF;AACA;AACA;AACA;AACA;IACE,SAAAC,uBAAAC,IAAA,EAAsF;MAAA,IAAvDC,IAAI,GAAAD,IAAA,CAAJC,IAAI;QAAEC,OAAO,GAAAF,IAAA,CAAPE,OAAO;MAC1C,IAAMC,KAAK,GAAG,IAAI,CAACC,uBAAuB,CAAC;QACzCC,IAAI,EAAE,CAAC,aAAa,CAAC;QACrBJ,IAAI,EAAJA,IAAI;QACJC,OAAO,EAAPA;MACF,CAAC,CAAC;MACF,IAAI,CAACI,WAAW,CAAC;QAACC,IAAI,EAAE,wBAAwB;QAAEN,IAAI,EAAJA,IAAI;QAAEE,KAAK,EAALA;MAAK,CAAC,CAAC;IACjE;EAAC;EAAA,OAAAb,kBAAA;AAAA,EAd6CkB,uBAAc"}

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

@@ -0,0 +1,25 @@
+import { MetricEventProduct, MetricEventAgent, MetricEventVerb, EventPayload } from './metrics.types';
+import GenericMetrics from './generic-metrics';
+/**
+ * @description Util class to handle Behavioral Metrics
+ * @export
+ * @class BehavioralMetrics
+ */
+export default class BehavioralMetrics extends GenericMetrics {
+    /**
+     * Submit a behavioral metric to our metrics endpoint.
+     * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'
+     * @param {MetricEventAgent} agent the source of the action for this metric
+     * @param {string} target the 'thing' that this metric includes information about
+     * @param {MetricEventVerb} verb the action that this metric includes information about
+     * @param {EventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.
+     * @returns {Promise<any>}
+     */
+    submitBehavioralEvent({ product, agent, target, verb, payload, }: {
+        product: MetricEventProduct;
+        agent: MetricEventAgent;
+        target: string;
+        verb: MetricEventVerb;
+        payload?: EventPayload;
+    }): void;
+}

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

@@ -0,0 +1,19 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+/**
+ * @description Util class to handle Buisness Metrics
+ * @export
+ * @class BusinessMetrics
+ */
+export default class BusinessMetrics extends GenericMetrics {
+    /**
+     * Submit a buisness metric to our metrics endpoint.
+     * @param {string} name of the metric
+     * @param {EventPayload} user payload of the metric
+     * @returns {Promise<any>}
+     */
+    submitBusinessEvent({ name, payload }: {
+        name: string;
+        payload: EventPayload;
+    }): void;
+}

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -77,7 +77,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         environment?: string;
         newEnvironment?: string;
         clientInfo?: {
-            os?: "other" | "chrome" | "windows" | "mac" | "ios" | "android" | "linux" | "android-x64" | "android-arm64" | "uwp-arm64";
+            os?: "windows" | "mac" | "ios" | "android" | "chrome" | "linux" | "other" | "android-x64" | "android-arm64" | "uwp-arm64";
             osVersion?: string;
             localIP?: string;
             gatewayIP?: string;
@@ -336,7 +336,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     generateClientEventErrorPayload(rawError: any): {
         fatal: boolean;
-        category: "signaling" | "media" | "network" | "other" | "expected";
+        category: "other" | "signaling" | "media" | "network" | "expected";
         errorDescription?: string;
         errorCode?: number;
         errorCodeStr?: string;

package/dist/types/call-diagnostic/call-diagnostic-metrics.util.d.ts

@@ -96,8 +96,9 @@ export declare const extractVersionMetadata: (version: string) => {
  * Generates client error codes for specific ice failures
  * that happen when trying to add media in a meeting.
  */
-export declare const generateClientErrorCodeForIceFailure: ({ signalingState, iceConnectionState, turnServerUsed, }: {
+export declare const generateClientErrorCodeForIceFailure: ({ signalingState, iceConnected, turnServerUsed, unreachable, }: {
     signalingState: RTCPeerConnection['signalingState'];
-    iceConnectionState: RTCPeerConnection['iceConnectionState'];
+    iceConnected: boolean;
     turnServerUsed: boolean;
+    unreachable: boolean;
 }) => number;

package/dist/types/call-diagnostic/config.d.ts

@@ -10,6 +10,7 @@ export declare const MISSING_ROAP_ANSWER_CLIENT_CODE = 2007;
 export declare const DTLS_HANDSHAKE_FAILED_CLIENT_CODE = 2008;
 export declare const ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE = 2010;
 export declare const ICE_FAILED_WITHOUT_TURN_TLS_CLIENT_CODE = 2009;
+export declare const ICE_AND_REACHABILITY_FAILED_CLIENT_CODE = 2011;
 export declare const WBX_APP_API_URL = "wbxappapi";
 export declare const WEBEX_SUB_SERVICE_TYPES: Record<string, ClientSubServiceType>;
 export declare const BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP: {
@@ -92,6 +93,7 @@ export declare const ERROR_DESCRIPTIONS: {
     DTLS_HANDSHAKE_FAILED: string;
     ICE_FAILED_WITHOUT_TURN_TLS: string;
     ICE_FAILED_WITH_TURN_TLS: string;
+    ICE_AND_REACHABILITY_FAILED: string;
     SDP_OFFER_CREATION_ERROR: string;
     SDP_OFFER_CREATION_ERROR_MISSING_CODEC: string;
 };

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

@@ -0,0 +1,63 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { DeviceContext, TaggedEvent, EventPayload, MetricType } from './metrics.types';
+/**
+ * @description top-level abstract class to handle Metrics and common routines.
+ * @export
+ * @class GenericMetrics
+ */
+export default abstract class GenericMetrics extends StatelessWebexPlugin {
+    private clientMetricsBatcher;
+    private logger;
+    private device;
+    private version;
+    private deviceId;
+    /**
+     * Constructor
+     * @param {any[]} args
+     */
+    constructor(...args: any[]);
+    /**
+     * Submit a buisness metric to our metrics endpoint.
+     * @param {string} kind of metric for logging
+     * @param {string} name of the metric
+     * @param {object} event
+     * @returns {Promise<any>}
+     */
+    protected submitEvent({ kind, name, event }: {
+        kind: string;
+        name: string;
+        event: object;
+    }): any;
+    /**
+     * Returns the deviceId from our registration with WDM.
+     * @returns {string} deviceId or empty string
+     */
+    protected getDeviceId(): string;
+    /**
+     * Returns the context object to be submitted with all metrics.
+     * @returns {DeviceContext}
+     */
+    protected getContext(): DeviceContext;
+    /**
+     * Returns the browser details to be included with all metrics.
+     * @returns {object}
+     */
+    protected getBrowserDetails(): object;
+    /**
+     * Returns true once we have the deviceId we need to submit behavioral/operational/buisness events
+     * @returns {boolean}
+     */
+    isReadyToSubmitEvents(): boolean;
+    /**
+     * Creates the object to send to our metrics endpoint for a tagged event (i.e. behavoral or operational)
+     * @param {[MetricType]} list of event type (i.e. ['behavioral'], ['operational', 'behavioral'])
+     * @param {string} metric name
+     * @param {EventPayload} user payload
+     * @returns {EventPayload}
+     */
+    protected createTaggedEventObject({ type, name, payload, }: {
+        type: [MetricType];
+        name: string;
+        payload: EventPayload;
+    }): TaggedEvent;
+}

package/dist/types/index.d.ts

@@ -9,6 +9,9 @@ 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';
+import BehavioralMetrics from './behavioral-metrics';
+import OperationalMetrics from './operational-metrics';
+import BusinessMetrics from './business-metrics';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, };
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, };
 export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, PreComputedLatencies, };

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

@@ -7,6 +7,9 @@ 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 MetricEventProduct = 'webex' | 'wxcc_desktop';
+export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service';
+export type MetricEventVerb = 'create' | 'get' | 'fetch' | 'update' | 'list' | 'delete' | 'select' | 'view' | 'set' | 'toggle' | 'load' | 'reload' | 'click' | 'hover' | 'register' | 'unregister' | 'enable' | 'disable' | 'use' | 'complete' | 'submit' | 'apply' | 'cancel' | 'abort' | 'sync' | 'login' | 'logout' | 'answer' | 'activate' | 'deactivate';
 export type SubmitClientEventOptions = {
     meetingId?: string;
     mediaConnections?: any[];
@@ -37,16 +40,43 @@ export interface ClientEvent {
     payload?: RawClientEvent;
     options?: SubmitClientEventOptions;
 }
-export interface BehavioralEvent {
-    name: 'host.meeting.participant.admitted' | 'sdk.media-flow.started';
-    payload?: never;
-    options?: never;
+export interface DeviceContext {
+    app: {
+        version: string;
+    };
+    device: {
+        id: string;
+    };
+    locale: string;
+    os: {
+        name: string;
+        version: string;
+    };
 }
-export interface OperationalEvent {
-    name: never;
-    payload?: never;
-    options?: never;
+export type MetricType = 'behavioral' | 'operational' | 'business';
+type InternalEventPayload = string | number | boolean;
+export type EventPayload = Record<string, InternalEventPayload>;
+export type BehavioralEventPayload = EventPayload;
+export interface BusinessEventPayload {
+    metricName: string;
+    timestamp: number;
+    context: DeviceContext;
+    browserDetails: EventPayload;
+    value: EventPayload;
 }
+export interface BusinessEvent {
+    type: string[];
+    eventPayload: BusinessEventPayload;
+}
+export interface TaggedEvent {
+    context: DeviceContext;
+    metricName: string;
+    tags: EventPayload;
+    timestamp: number;
+    type: [MetricType];
+}
+export type BehavioralEvent = TaggedEvent;
+export type OperationalEvent = TaggedEvent;
 export interface FeatureEvent {
     name: never;
     payload?: never;
@@ -60,7 +90,7 @@ export interface MediaQualityEvent {
 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 MetricEventNames = InternalEvent['name'] | ClientEvent['name'] | BehavioralEvent['metricName'] | OperationalEvent['metricName'] | BusinessEvent['eventPayload']['metricName'] | 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'];
@@ -80,9 +110,11 @@ export type SubmitInternalEvent = (args: {
     options?: any;
 }) => void;
 export type SubmitBehavioralEvent = (args: {
-    name: BehavioralEvent['name'];
-    payload?: RecursivePartial<BehavioralEvent['payload']>;
-    options?: any;
+    product: MetricEventProduct;
+    agent: MetricEventAgent;
+    target: string;
+    verb: MetricEventVerb;
+    payload?: EventPayload;
 }) => void;
 export type SubmitClientEvent = (args: {
     name: ClientEvent['name'];
@@ -90,9 +122,8 @@ export type SubmitClientEvent = (args: {
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
 export type SubmitOperationalEvent = (args: {
-    name: OperationalEvent['name'];
-    payload?: RecursivePartial<OperationalEvent['payload']>;
-    options?: any;
+    name: OperationalEvent['metricName'];
+    payload: EventPayload;
 }) => void;
 export type SubmitMQE = (args: {
     name: MediaQualityEvent['name'];
@@ -105,3 +136,4 @@ export type BuildClientEventFetchRequestOptions = (args: {
     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';
+export {};

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

@@ -1,6 +1,9 @@
 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 BehavioralMetrics from './behavioral-metrics';
+import OperationalMetrics from './operational-metrics';
+import BusinessMetrics from './business-metrics';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -10,6 +13,10 @@ declare class Metrics extends WebexPlugin {
     static instance: Metrics;
     callDiagnosticLatencies: CallDiagnosticLatencies;
     callDiagnosticMetrics: CallDiagnosticMetrics;
+    behavioralMetrics: BehavioralMetrics;
+    operationalMetrics: OperationalMetrics;
+    businessMetrics: BusinessMetrics;
+    isReady: boolean;
     /**
      * Constructor
      * @param args
@@ -31,24 +38,45 @@ declare class Metrics extends WebexPlugin {
         payload?: RecursivePartial<InternalEvent['payload']>;
         options?: any;
     }): void;
+    /**
+     * @returns true once we have the deviceId we need to submit behavioral events to Amplitude
+     */
+    isReadyToSubmitBehavioralEvents(): boolean;
+    /**
+     * @returns true once we have the deviceId we need to submit operational events
+     */
+    isReadyToSubmitOperationalEvents(): boolean;
+    /**
+     * @returns true once we have the deviceId we need to submit buisness events
+     */
+    isReadyToSubmitBusinessEvents(): boolean;
     /**
      * Behavioral event
      * @param args
      */
-    submitBehavioralEvent({ name, payload, options, }: {
-        name: BehavioralEvent['name'];
-        payload?: RecursivePartial<BehavioralEvent['payload']>;
-        options?: any;
-    }): void;
+    submitBehavioralEvent({ product, agent, target, verb, payload, }: {
+        product: MetricEventProduct;
+        agent: MetricEventAgent;
+        target: string;
+        verb: MetricEventVerb;
+        payload?: EventPayload;
+    }): void | Promise<void>;
     /**
      * Operational event
      * @param args
      */
-    submitOperationalEvent({ name, payload, options, }: {
-        name: OperationalEvent['name'];
-        payload?: RecursivePartial<OperationalEvent['payload']>;
-        options?: any;
-    }): void;
+    submitOperationalEvent({ name, payload }: {
+        name: string;
+        payload?: EventPayload;
+    }): void | Promise<void>;
+    /**
+     * Buisness event
+     * @param args
+     */
+    submitBusinessEvent({ name, payload }: {
+        name: string;
+        payload: EventPayload;
+    }): void | Promise<void>;
     /**
      * Call Analyzer: Media Quality Event
      * @param args

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

@@ -0,0 +1,19 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+/**
+ * @description Util class to handle Operational Metrics
+ * @export
+ * @class OperationalMetrics
+ */
+export default class OperationalMetrics extends GenericMetrics {
+    /**
+     * Submit an operational metric to our metrics endpoint.
+     * @param {string} name of the metric
+     * @param {EventPayload} user payload of the metric
+     * @returns {Promise<any>}
+     */
+    submitOperationalEvent({ name, payload }: {
+        name: string;
+        payload: EventPayload;
+    }): void;
+}

package/package.json

@@ -26,22 +26,22 @@
     "@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.3.1",
-    "@webex/test-helper-mocha": "3.3.1",
-    "@webex/test-helper-mock-webex": "3.3.1",
-    "@webex/test-helper-test-users": "3.3.1",
+    "@webex/test-helper-chai": "3.4.0-next.2",
+    "@webex/test-helper-mocha": "3.4.0-next.2",
+    "@webex/test-helper-mock-webex": "3.4.0-next.2",
+    "@webex/test-helper-test-users": "3.4.0-next.2",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.3.1",
-    "@webex/common-timers": "3.3.1",
+    "@webex/common": "3.4.0-next.2",
+    "@webex/common-timers": "3.4.0-next.2",
     "@webex/event-dictionary-ts": "^1.0.1406",
-    "@webex/internal-plugin-metrics": "3.3.1",
-    "@webex/test-helper-chai": "3.3.1",
-    "@webex/test-helper-mock-webex": "3.3.1",
-    "@webex/webex-core": "3.3.1",
+    "@webex/internal-plugin-metrics": "3.4.0-next.2",
+    "@webex/test-helper-chai": "3.4.0-next.2",
+    "@webex/test-helper-mock-webex": "3.4.0-next.2",
+    "@webex/webex-core": "3.4.0-next.2",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.3.1"
+  "version": "3.4.0-next.2"
 }

package/src/behavioral-metrics.ts

@@ -0,0 +1,40 @@
+import {MetricEventProduct, MetricEventAgent, MetricEventVerb, EventPayload} from './metrics.types';
+import GenericMetrics from './generic-metrics';
+
+/**
+ * @description Util class to handle Behavioral Metrics
+ * @export
+ * @class BehavioralMetrics
+ */
+export default class BehavioralMetrics extends GenericMetrics {
+  /**
+   * Submit a behavioral metric to our metrics endpoint.
+   * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'
+   * @param {MetricEventAgent} agent the source of the action for this metric
+   * @param {string} target the 'thing' that this metric includes information about
+   * @param {MetricEventVerb} verb the action that this metric includes information about
+   * @param {EventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.
+   * @returns {Promise<any>}
+   */
+  public submitBehavioralEvent({
+    product,
+    agent,
+    target,
+    verb,
+    payload,
+  }: {
+    product: MetricEventProduct;
+    agent: MetricEventAgent;
+    target: string;
+    verb: MetricEventVerb;
+    payload?: EventPayload;
+  }) {
+    const name = `${product}.${agent}.${target}.${verb}`;
+    const event = this.createTaggedEventObject({
+      type: ['behavioral'],
+      name,
+      payload,
+    });
+    this.submitEvent({kind: 'behavioral-events -> ', name, event});
+  }
+}

package/src/business-metrics.ts

@@ -0,0 +1,30 @@
+import GenericMetrics from './generic-metrics';
+import {EventPayload} from './metrics.types';
+
+/**
+ * @description Util class to handle Buisness Metrics
+ * @export
+ * @class BusinessMetrics
+ */
+export default class BusinessMetrics extends GenericMetrics {
+  /**
+   * Submit a buisness metric to our metrics endpoint.
+   * @param {string} name of the metric
+   * @param {EventPayload} user payload of the metric
+   * @returns {Promise<any>}
+   */
+  public submitBusinessEvent({name, payload}: {name: string; payload: EventPayload}) {
+    const event = {
+      type: ['business'],
+      eventPayload: {
+        metricName: name,
+        timestamp: Date.now(),
+        context: this.getContext(),
+        browserDetails: this.getBrowserDetails(),
+        value: payload,
+      },
+    };
+
+    this.submitEvent({kind: 'buisness-events -> ', name, event});
+  }
+}

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

@@ -455,6 +455,9 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         },
         intervals: payload.intervals,
         callingServiceType: 'LOCUS',
+        meetingJoinInfo: {
+          clientSignallingProtocol: 'WebRTC',
+        },
         sourceMetadata: {
           applicationSoftwareType: CLIENT_NAME,
           // @ts-ignore

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

@@ -21,6 +21,7 @@ import {
   MISSING_ROAP_ANSWER_CLIENT_CODE,
   WBX_APP_API_URL,
   ERROR_DESCRIPTIONS,
+  ICE_AND_REACHABILITY_FAILED_CLIENT_CODE,
 } from './config';
 
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
@@ -225,7 +226,7 @@ export const getBuildType = (
  */
 export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
   const origin: Partial<Event['origin']> = {
-    buildType: exports.getBuildType(
+    buildType: getBuildType(
       item.eventPayload?.event?.eventData?.webClientDomain,
       item.eventPayload?.event?.eventData?.markAsTestEvent
     ),
@@ -284,6 +285,8 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
 
     case 'client.media.rx.start':
       joinTimes.localSDPGenRemoteSDPRecv = cdl.getLocalSDPGenRemoteSDPRecv();
+      audioSetupDelay.joinRespRxStart = cdl.getAudioJoinRespRxStart();
+      videoSetupDelay.joinRespRxStart = cdl.getVideoJoinRespRxStart();
       break;
 
     case 'client.media-engine.ready':
@@ -293,10 +296,8 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
       joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
       break;
 
-    case 'client.mediaquality.event':
-      audioSetupDelay.joinRespRxStart = cdl.getAudioJoinRespRxStart();
+    case 'client.media.tx.start':
       audioSetupDelay.joinRespTxStart = cdl.getAudioJoinRespTxStart();
-      videoSetupDelay.joinRespRxStart = cdl.getVideoJoinRespRxStart();
       videoSetupDelay.joinRespTxStart = cdl.getVideoJoinRespTxStart();
   }
 
@@ -314,7 +315,6 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
 
   item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
 
-  // @ts-ignore
   webex.logger.log(
     `CallDiagnosticLatencies,prepareDiagnosticMetricItem: ${JSON.stringify({
       latencies: Object.fromEntries(cdl.latencyTimestamps),
@@ -370,12 +370,14 @@ export const extractVersionMetadata = (version: string) => {
  */
 export const generateClientErrorCodeForIceFailure = ({
   signalingState,
-  iceConnectionState,
+  iceConnected,
   turnServerUsed,
+  unreachable,
 }: {
   signalingState: RTCPeerConnection['signalingState'];
-  iceConnectionState: RTCPeerConnection['iceConnectionState'];
+  iceConnected: boolean;
   turnServerUsed: boolean;
+  unreachable: boolean;
 }) => {
   let errorCode = ICE_FAILURE_CLIENT_CODE; // default;
 
@@ -383,20 +385,17 @@ export const generateClientErrorCodeForIceFailure = ({
     errorCode = MISSING_ROAP_ANSWER_CLIENT_CODE;
   }
 
-  if (
-    signalingState === 'stable' &&
-    (iceConnectionState === 'connected' || iceConnectionState === 'disconnected')
-  ) {
+  if (signalingState === 'stable' && iceConnected) {
     errorCode = DTLS_HANDSHAKE_FAILED_CLIENT_CODE;
   }
 
-  if (
-    signalingState !== 'have-local-offer' &&
-    iceConnectionState !== 'connected' &&
-    iceConnectionState !== 'disconnected'
-  ) {
+  if (signalingState !== 'have-local-offer' && !iceConnected) {
     if (turnServerUsed) {
-      errorCode = ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE;
+      if (unreachable) {
+        errorCode = ICE_AND_REACHABILITY_FAILED_CLIENT_CODE;
+      } else {
+        errorCode = ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE;
+      }
     } else {
       errorCode = ICE_FAILED_WITHOUT_TURN_TLS_CLIENT_CODE;
     }