@webex/internal-plugin-metrics 3.0.0-beta.163 → 3.0.0-beta.165

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

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

package/dist/types/config.d.ts

@@ -0,0 +1,35 @@
+export const CLIENT_NAME: "webex-js-sdk";
+declare namespace _default {
+    export namespace device {
+        namespace preDiscoveryServices {
+            const metricsServiceUrl: string;
+            const metrics: string;
+        }
+    }
+    export namespace metrics_1 {
+        const appType: string;
+        const batcherWait: number;
+        const batcherMaxCalls: number;
+        const batcherMaxWait: number;
+        const batcherRetryPlateau: 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

@@ -0,0 +1,11 @@
+/*!
+ * 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 { ClientEvent, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitMQE } from './metrics.types';
+import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
+export { default, getOSNameInternal } from './metrics';
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics };
+export type { ClientEvent, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, };

package/dist/types/metrics.d.ts

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

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

@@ -0,0 +1,89 @@
+import { ClientEvent as RawClientEvent } from './call-diagnostic/generated-types-temp/ClientEvent';
+import { Event as RawEvent } from './call-diagnostic/generated-types-temp/Event';
+import { MediaQualityEvent as RawMediaQualityEvent } from './call-diagnostic/generated-types-temp/MediaQualityEvent';
+export type Event = Omit<RawEvent, 'event'> & {
+    event: RawClientEvent | RawMediaQualityEvent;
+};
+export type ClientEventError = NonNullable<RawClientEvent['errors']>[0];
+export type SubmitClientEventOptions = {
+    meetingId?: string;
+    mediaConnections?: any[];
+    rawError?: any;
+    showToUser?: boolean;
+    correlationId?: string;
+};
+export type SubmitMQEOptions = {
+    meetingId: string;
+    mediaConnections?: any[];
+    networkType?: Event['origin']['networkType'];
+};
+export type InternalEvent = {
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.reset.join.latencies' | 'internal.client.interstitial-window.launched' | 'internal.client.meeting.click.joinbutton' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.pageJMT.received' | 'internal.client.interstitial-window.click.joinbutton';
+    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 ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientType'];
+export type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];
+export type NetworkType = RawEvent['origin']['networkType'];
+export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
+export type MediaQualityEventAudioSetupDelayPayload = MediaQualityEvent['payload']['audioSetupDelay'];
+export type MediaQualityEventVideoSetupDelayPayload = MediaQualityEvent['payload']['videoSetupDelay'];
+export type SubmitMQEPayload = RecursivePartial<MediaQualityEvent['payload']> & {
+    intervals: 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;
+}) => void;
+export type SubmitOperationalEvent = (args: {
+    name: OperationalEvent['name'];
+    payload?: RecursivePartial<OperationalEvent['payload']>;
+    options: any;
+}) => void;
+export type SubmitMQE = (args: {
+    name: MediaQualityEvent['name'];
+    payload: RecursivePartial<MediaQualityEvent['payload']> & {
+        intervals: MediaQualityEvent['payload']['intervals'];
+    };
+    options: any;
+}) => void;

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

@@ -0,0 +1,83 @@
+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;
+    }): void;
+}
+export default Metrics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-beta.163",
+  "version": "3.0.0-beta.165",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
@@ -28,12 +28,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.163",
-    "@webex/common-timers": "3.0.0-beta.163",
-    "@webex/internal-plugin-device": "3.0.0-beta.163",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.163",
-    "@webex/test-helper-chai": "3.0.0-beta.163",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.163",
-    "@webex/webex-core": "3.0.0-beta.163"
+    "@webex/common": "3.0.0-beta.165",
+    "@webex/common-timers": "3.0.0-beta.165",
+    "@webex/internal-plugin-device": "3.0.0-beta.165",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.165",
+    "@webex/test-helper-chai": "3.0.0-beta.165",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.165",
+    "@webex/webex-core": "3.0.0-beta.165"
   }
 }

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

@@ -81,9 +81,10 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
         joinTimes.localSDPGenRemoteSDPRecv = cdl.getLocalSDPGenRemoteSDPRecv();
         break;
 
-      // TODO: Figure out equivalent for WEBRTC
       case 'client.media-engine.ready':
         joinTimes.totalMediaJMT = cdl.getTotalMediaJMT();
+        joinTimes.interstitialToMediaOKJMT = cdl.getInterstitialToMediaOKJMT();
+        joinTimes.callInitMediaEngineReady = cdl.getInterstitialToMediaOKJMT(); // same as interstitialToMediaOKJMT
         break;
 
       case 'client.mediaquality.event':

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

@@ -267,6 +267,17 @@ export default class CallDiagnosticLatencies {
     return undefined;
   }
 
+  /**
+   * Interstitial To Media OK JMT
+   * @returns - latency
+   */
+  public getInterstitialToMediaOKJMT() {
+    return this.getDiffBetweenTimestamps(
+      'internal.client.interstitial-window.click.joinbutton',
+      'client.media-engine.ready'
+    );
+  }
+
   /**
    * Audio setup delay receive
    */

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics-batcher.ts

@@ -185,6 +185,8 @@ describe('plugin-metrics', () => {
             name: 'client.media-engine.ready',
             joinTimes: {
               totalMediaJMT: 30,
+              interstitialToMediaOKJMT: 10,
+              callInitMediaEngineReady: 10,
             },
           });
           assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics-latencies.ts

@@ -189,5 +189,11 @@ describe("internal-plugin-metrics", () => {
       cdl.saveTimestamp('client.media.tx.start', 7);
       assert.deepEqual(cdl.getVideoJoinRespTxStart(), 2);
     });
+
+    it('calculates getInterstitialToMediaOKJMT correctly', () => {
+      cdl.saveTimestamp('internal.client.interstitial-window.click.joinbutton', 5);
+      cdl.saveTimestamp('client.media-engine.ready', 7);
+      assert.deepEqual(cdl.getInterstitialToMediaOKJMT(), 2);
+    });
   })
 })