@webex/internal-plugin-metrics 3.0.0-beta.19 → 3.0.0-beta.190

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,87 @@
+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.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 = NonNullable<RawEvent['origin']>['networkType'];
+export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
+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;
+}) => void;
+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;

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,10 +1,11 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-beta.19",
+  "version": "3.0.0-beta.190",
   "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",
@@ -23,13 +24,16 @@
     "@sinonjs/fake-timers": "^6.0.1",
     "sinon": "^9.2.4"
   },
+  "scripts": {
+    "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
+  },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.19",
-    "@webex/common-timers": "3.0.0-beta.19",
-    "@webex/internal-plugin-device": "3.0.0-beta.19",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.19",
-    "@webex/test-helper-chai": "3.0.0-beta.19",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.19",
-    "@webex/webex-core": "3.0.0-beta.19"
+    "@webex/common": "3.0.0-beta.190",
+    "@webex/common-timers": "3.0.0-beta.190",
+    "@webex/internal-plugin-device": "3.0.0-beta.190",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.190",
+    "@webex/test-helper-chai": "3.0.0-beta.190",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.190",
+    "@webex/webex-core": "3.0.0-beta.190"
   }
 }

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

@@ -0,0 +1,148 @@
+/* eslint-disable class-methods-use-this */
+/* eslint-disable valid-jsdoc */
+
+import {isEmpty, merge} from 'lodash';
+import Batcher from '../batcher';
+import {
+  ClientEvent,
+  MetricEventNames,
+  MediaQualityEventAudioSetupDelayPayload,
+  MediaQualityEventVideoSetupDelayPayload,
+} from '../metrics.types';
+
+const CallDiagnosticEventsBatcher = Batcher.extend({
+  namespace: 'Metrics',
+
+  /**
+   * @param webClientDomain
+   * @returns
+   */
+  getBuildType(webClientDomain) {
+    if (
+      webClientDomain?.includes('localhost') ||
+      webClientDomain?.includes('127.0.0.1') ||
+      process.env.NODE_ENV !== 'production'
+    ) {
+      return 'test';
+    }
+
+    return process.env.NODE_ENV === 'production' ? 'prod' : 'test';
+  },
+
+  /**
+   * Prepare item
+   * @param item
+   * @returns
+   */
+  prepareItem(item) {
+    const origin = {
+      buildType: this.getBuildType(item.event?.eventData?.webClientDomain),
+      networkType: 'unknown',
+    };
+
+    // check event names and append latencies?
+    const eventName = item.eventPayload?.event?.name as MetricEventNames;
+    const joinTimes: ClientEvent['payload']['joinTimes'] = {};
+    const audioSetupDelay: MediaQualityEventAudioSetupDelayPayload = {};
+    const videoSetupDelay: MediaQualityEventVideoSetupDelayPayload = {};
+
+    const cdl = this.webex.internal.newMetrics.callDiagnosticLatencies;
+
+    switch (eventName) {
+      case 'client.interstitial-window.launched':
+        joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+        joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
+        break;
+
+      case 'client.call.initiated':
+        joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+        joinTimes.showInterstitialTime = cdl.getShowInterstitialTime();
+        break;
+
+      case 'client.locus.join.response':
+        joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
+        joinTimes.callInitJoinReq = cdl.getCallInitJoinReq();
+        joinTimes.joinReqResp = cdl.getJoinReqResp();
+        joinTimes.joinReqSentReceived = cdl.getJoinRespSentReceived();
+        joinTimes.pageJmt = cdl.getPageJMT();
+        joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
+        joinTimes.interstitialToJoinOK = cdl.getInterstitialToJoinOK();
+        joinTimes.totalJmt = cdl.getTotalJMT();
+        joinTimes.clientJmt = cdl.getClientJMT();
+        break;
+
+      case 'client.ice.end':
+        joinTimes.ICESetupTime = cdl.getICESetupTime();
+        joinTimes.audioICESetupTime = cdl.getAudioICESetupTime();
+        joinTimes.videoICESetupTime = cdl.getVideoICESetupTime();
+        joinTimes.shareICESetupTime = cdl.getShareICESetupTime();
+        break;
+
+      case 'client.media.rx.start':
+        joinTimes.localSDPGenRemoteSDPRecv = cdl.getLocalSDPGenRemoteSDPRecv();
+        break;
+
+      case 'client.media-engine.ready':
+        joinTimes.totalMediaJMT = cdl.getTotalMediaJMT();
+        joinTimes.interstitialToMediaOKJMT = cdl.getInterstitialToMediaOKJMT();
+        joinTimes.callInitMediaEngineReady = cdl.getCallInitMediaEngineReady();
+        joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
+        break;
+
+      case 'client.mediaquality.event':
+        audioSetupDelay.joinRespRxStart = cdl.getAudioJoinRespRxStart();
+        audioSetupDelay.joinRespTxStart = cdl.getAudioJoinRespTxStart();
+        videoSetupDelay.joinRespRxStart = cdl.getVideoJoinRespRxStart();
+        videoSetupDelay.joinRespTxStart = cdl.getVideoJoinRespTxStart();
+    }
+
+    if (!isEmpty(joinTimes)) {
+      item.eventPayload.event = merge(item.eventPayload.event, {joinTimes});
+    }
+
+    if (!isEmpty(audioSetupDelay)) {
+      item.eventPayload.event = merge(item.eventPayload.event, {audioSetupDelay});
+    }
+
+    if (!isEmpty(videoSetupDelay)) {
+      item.eventPayload.event = merge(item.eventPayload.event, {videoSetupDelay});
+    }
+
+    item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
+
+    return Promise.resolve(item);
+  },
+
+  /**
+   * Prepare request, add time sensitive date etc.
+   * @param queue
+   * @returns
+   */
+  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 payload
+   * @returns
+   */
+  submitHttpRequest(payload) {
+    return this.webex.request({
+      method: 'POST',
+      service: 'metrics',
+      resource: 'clientmetrics',
+      body: {
+        metrics: payload,
+      },
+    });
+  },
+});
+
+export default CallDiagnosticEventsBatcher;