@webex/plugin-meetings 3.0.0-beta.162 → 3.0.0-beta.164

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

@@ -1,3 +1,6 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
 /**
  * @description Metrics handles all the call metrics events
  * @export
@@ -5,9 +8,6 @@
  */
 declare class Metrics {
     static instance: Metrics;
-    _events: any;
-    keys: any;
-    meetingCollection: any;
     webex: any;
     /**
      * Create Metrics Object
@@ -19,135 +19,11 @@ declare class Metrics {
     /**
      * Initializes the Metrics singleton with a meeting Collection.
      *
-     * @param {Object} meetingCollection meetings object
      * @param {Object} webex  webex SDK object
      *
      * @returns {void}
      */
-    initialSetup(meetingCollection: object, webex: object): void;
-    /**
-     * poste Meeting event metrics
-     * @param {object} options {meetingId/meeting} as a json object
-     * @param {Meeting} options.meeting Meeting object
-     * @param {String} options.meetingId
-     * @param {object} options.data
-     * @param {object} options.event
-     * @returns {object} null
-     */
-    postEvent(options: {
-        meeting?: any;
-        meetingId?: string;
-        data?: object;
-        event?: any;
-    } | any): void;
-    /**
-     *  Docs for Call analyzer metrics
-     *   https://sqbu-github.cisco.com/WebExSquared/call-analyzer/wiki
-     *   https://sqbu-github.cisco.com/WebExSquared/event-dictionary/blob/master/diagnostic-events.raml
-     */
-    initPayload(eventType: any, identifiers: any, options: any): any;
-    /**
-     * get the payload specific for a media quality event through call analyzer
-     * @param {String} eventType the event name
-     * @param {Object} identifiers contains the identifiers needed for CA
-     * @param {String} identifiers.correlationId
-     * @param {String} identifiers.locusUrl
-     * @param {String} identifiers.locusId
-     * @param {Object} options
-     * @param {Object} options.intervalData
-     * @param {String} options.clientType
-     * @returns {Object}
-     * @public
-     * @memberof Metrics
-     */
-    initMediaPayload(eventType: string, identifiers: {
-        correlationId: string;
-        locusUrl: string;
-        locusId: string;
-    }, options?: {
-        intervalData: object;
-        clientType: string;
-    } | any): {
-        eventId: any;
-        version: number;
-        origin: {
-            audioSetupDelay: any;
-            videoSetupDelay: any;
-            name: string;
-            networkType: any;
-            userAgent: string;
-            clientInfo: {
-                clientType: any;
-                clientVersion: string;
-                localNetworkPrefix: string;
-                os: any;
-                osVersion: any;
-                subClientType: any;
-                browser: any;
-                browserVersion: any;
-            };
-        };
-        originTime: {
-            triggered: string;
-        };
-        senderCountryCode: any;
-        event: {
-            name: string;
-            canProceed: boolean;
-            identifiers: {
-                correlationId: string;
-                locusUrl: string;
-                locusId: string;
-            };
-            intervals: any[];
-            joinTimes: any;
-            eventData: {
-                webClientDomain: any;
-            };
-            sourceMetadata: {
-                applicationSoftwareType: string;
-                applicationSoftwareVersion: any;
-                mediaEngineSoftwareType: any;
-                mediaEngineSoftwareVersion: any;
-                startTime: string;
-            };
-        };
-    };
-    /**
-     * This function Parses a Locus error and returns a diagnostic event payload.
-     * It should keep updating from:
-     * https://sqbu-github.cisco.com/WebExSquared/spark-client-framework/blob/master/spark-client-framework/Adapters/TelephonyAdapter/TelephonyAdapter.cpp#L920
-     *
-     * @param {Object} err the error Object from Locus response
-     * @param {boolean} showToUser true if a toast is shown to user
-     * @returns {{showToUser: boolean, category: string, errorDescription: string,
-     *  errorCode: number, errorData: *, fatal: boolean, name: string}}
-     */
-    parseLocusError(err: any, showToUser: boolean): any;
-    /**
-     * Pareses webex api error.
-     *
-     * @param {object} err
-     * @param {boolean} showToUser
-     * @returns {object | null}
-     */
-    parseWebexApiError(err: any, showToUser: boolean): any;
-    /**
-     * Generates Error for the CA event
-     *
-     * @param {integer} errorCode
-     * @param {boolean} shownToUser
-     * @param {string} name
-     * @param {any} err
-     * @returns {any}
-     */
-    generateErrorPayload(errorCode: any, shownToUser: any, name: any, err: any): any;
-    /**
-     * Returns a formated string of the user agent.
-     *
-     * @returns {string} formatted user agent information
-     */
-    userAgentToString(): string;
+    initialSetup(webex: object): void;
     /**
      * Uploads given metric to the Metrics service as an Behavioral metric.
      * Metadata about the environment such as browser, OS, SDK and their versions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.162",
+  "version": "3.0.0-beta.164",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.162",
-    "@webex/test-helper-chai": "3.0.0-beta.162",
-    "@webex/test-helper-mocha": "3.0.0-beta.162",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.162",
-    "@webex/test-helper-retry": "3.0.0-beta.162",
-    "@webex/test-helper-test-users": "3.0.0-beta.162",
+    "@webex/plugin-meetings": "3.0.0-beta.164",
+    "@webex/test-helper-chai": "3.0.0-beta.164",
+    "@webex/test-helper-mocha": "3.0.0-beta.164",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.164",
+    "@webex/test-helper-retry": "3.0.0-beta.164",
+    "@webex/test-helper-test-users": "3.0.0-beta.164",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.162",
+    "@webex/common": "3.0.0-beta.164",
     "@webex/internal-media-core": "1.38.6",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.162",
-    "@webex/internal-plugin-device": "3.0.0-beta.162",
-    "@webex/internal-plugin-llm": "3.0.0-beta.162",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.162",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.162",
-    "@webex/internal-plugin-support": "3.0.0-beta.162",
-    "@webex/internal-plugin-user": "3.0.0-beta.162",
-    "@webex/media-helpers": "3.0.0-beta.162",
-    "@webex/plugin-people": "3.0.0-beta.162",
-    "@webex/plugin-rooms": "3.0.0-beta.162",
-    "@webex/webex-core": "3.0.0-beta.162",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.164",
+    "@webex/internal-plugin-device": "3.0.0-beta.164",
+    "@webex/internal-plugin-llm": "3.0.0-beta.164",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.164",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.164",
+    "@webex/internal-plugin-support": "3.0.0-beta.164",
+    "@webex/internal-plugin-user": "3.0.0-beta.164",
+    "@webex/media-helpers": "3.0.0-beta.164",
+    "@webex/plugin-people": "3.0.0-beta.164",
+    "@webex/plugin-rooms": "3.0.0-beta.164",
+    "@webex/webex-core": "3.0.0-beta.164",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/breakouts/breakout.ts

@@ -65,7 +65,11 @@ const Breakout = WebexPlugin.extend({
     const deviceUrl = this.webex.internal.device.url;
     const {meetingId} = this.collection.parent;
     const meeting = this.webex.meetings.getMeetingByType(_ID_, meetingId);
-    breakoutEvent.onBreakoutMoveRequest({currentSession: this, meeting, breakoutMoveId});
+    breakoutEvent.onBreakoutMoveRequest(
+      {currentSession: this, meeting, breakoutMoveId},
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent
+    );
     const result = await this.request({
       method: HTTP_VERBS.POST,
       uri: `${this.url}/move`,
@@ -76,7 +80,11 @@ const Breakout = WebexPlugin.extend({
         sessionId: this.sessionId,
       },
     });
-    breakoutEvent.onBreakoutMoveResponse({currentSession: this, meeting, breakoutMoveId});
+    breakoutEvent.onBreakoutMoveResponse(
+      {currentSession: this, meeting, breakoutMoveId},
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent
+    );
 
     return result;
   },

package/src/breakouts/events.ts

@@ -1,37 +1,56 @@
 // eslint-disable-next-line import/prefer-default-export
-import Metrics from '../metrics';
-import {eventType} from '../metrics/config';
+import {ClientEvent} from '@webex/internal-plugin-metrics';
 
-const breakoutEvent: any = {};
-
-breakoutEvent.onBreakoutMoveRequest = (eventInfo) => {
-  breakoutEvent.postMoveCallAnalyzer(eventType.BREAKOUT_MOVE_REQUEST, eventInfo);
-};
-
-breakoutEvent.onBreakoutMoveResponse = (eventInfo) => {
-  breakoutEvent.postMoveCallAnalyzer(eventType.BREAKOUT_MOVE_RESPONSE, eventInfo);
-};
-
-breakoutEvent.onBreakoutJoinResponse = (eventInfo) => {
-  breakoutEvent.postMoveCallAnalyzer(eventType.BREAKOUT_JOIN_RESPONSE, eventInfo);
-};
-
-breakoutEvent.postMoveCallAnalyzer = (events: string, eventInfo: any) => {
-  if (!eventInfo?.breakoutMoveId || !eventInfo?.meeting) {
-    return;
-  }
-  if (!eventInfo.meeting.meetingInfo?.enableConvergedArchitecture) {
-    return;
-  }
-  Metrics.postEvent({
-    event: events,
-    meetingId: eventInfo.meeting.id,
-    data: {
-      breakoutMoveId: eventInfo.breakoutMoveId,
-      breakoutSessionId: eventInfo?.currentSession?.sessionId,
-      breakoutGroupId: eventInfo?.currentSession?.groupId,
-    },
-  });
+const breakoutEvent: {
+  onBreakoutMoveRequest: (eventInfo: any, submitClientEvent: any) => void;
+  onBreakoutMoveResponse: (eventInfo: any, submitClientEvent: any) => void;
+  onBreakoutJoinResponse: (eventInfo: any, submitClientEvent: any) => void;
+  postMoveCallAnalyzer: (
+    event: ClientEvent['name'],
+    eventInfo: any,
+    submitClientEvent: any
+  ) => void;
+} = {
+  onBreakoutMoveRequest: (eventInfo, submitClientEvent) => {
+    breakoutEvent.postMoveCallAnalyzer(
+      'client.breakout-session.move.request',
+      eventInfo,
+      submitClientEvent
+    );
+  },
+  onBreakoutMoveResponse: (eventInfo, submitClientEvent) => {
+    breakoutEvent.postMoveCallAnalyzer(
+      'client.breakout-session.move.response',
+      eventInfo,
+      submitClientEvent
+    );
+  },
+  onBreakoutJoinResponse: (eventInfo, submitClientEvent) => {
+    breakoutEvent.postMoveCallAnalyzer(
+      'client.breakout-session.join.response',
+      eventInfo,
+      submitClientEvent
+    );
+  },
+  postMoveCallAnalyzer: (event: ClientEvent['name'], eventInfo: any, submitClientEvent) => {
+    if (!eventInfo?.breakoutMoveId || !eventInfo?.meeting) {
+      return;
+    }
+    if (!eventInfo.meeting.meetingInfo?.enableConvergedArchitecture) {
+      return;
+    }
+    submitClientEvent({
+      name: event,
+      payload: {
+        identifiers: {
+          breakoutMoveId: eventInfo.breakoutMoveId,
+          breakoutSessionId: eventInfo?.currentSession?.sessionId,
+          breakoutGroupId: eventInfo?.currentSession?.groupId,
+        },
+      },
+      options: {meetingId: eventInfo.meeting.id},
+    });
+  },
 };
 
 export default breakoutEvent;

package/src/breakouts/index.ts

@@ -349,11 +349,15 @@ const Breakouts = WebexPlugin.extend({
     ) {
       // should report joined session changed
       const meeting = this.webex.meetings.getMeetingByType(_ID_, this.meetingId);
-      breakoutEvent.onBreakoutJoinResponse({
-        currentSession: this.currentBreakoutSession,
-        meeting,
-        breakoutMoveId: params.breakoutMoveId,
-      });
+      breakoutEvent.onBreakoutJoinResponse(
+        {
+          currentSession: this.currentBreakoutSession,
+          meeting,
+          breakoutMoveId: params.breakoutMoveId,
+        },
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent
+      );
     }
   },
 

package/src/constants.ts

@@ -1157,8 +1157,6 @@ export const MEDIA_DEVICES = {
   CAMERA: 'camera',
 };
 
-export const METRICS_JOIN_TIMES_MAX_DURATION = 1200000;
-
 export const PSTN_STATUS = {
   JOINED: 'JOINED', // we have provisioned a pstn device, which can be used to connect
   CONNECTED: 'CONNECTED', // user is connected to audio with pstn device

package/src/locus-info/index.ts

@@ -17,8 +17,6 @@ import {
   CALL_REMOVED_REASON,
   RECORDING_STATE,
 } from '../constants';
-import Metrics from '../metrics';
-import {eventType} from '../metrics/config';
 import InfoUtils from './infoUtils';
 import FullState from './fullState';
 import SelfUtils from './selfUtils';
@@ -430,10 +428,15 @@ export default class LocusInfo extends EventsScope {
         LoggerProxy.logger.warn(
           'Locus-info:index#isMeetingActive --> Call Ended, locus state is inactive.'
         );
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -452,9 +455,12 @@ export default class LocusInfo extends EventsScope {
           this.parsedLocus.self.state === MEETING_STATE.STATES.NOTIFIED ||
           this.parsedLocus.self.state === MEETING_STATE.STATES.JOINED)
       ) {
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {
@@ -476,10 +482,14 @@ export default class LocusInfo extends EventsScope {
           partner.state === MEETING_STATE.STATES.NOTIFIED ||
           partner.state === MEETING_STATE.STATES.IDLE) // Happens when user just joins and adds no Media
       ) {
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -502,9 +512,13 @@ export default class LocusInfo extends EventsScope {
         LoggerProxy.logger.warn(
           'Locus-info:index#isMeetingActive --> Meeting is ending due to inactive or terminating'
         );
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {
@@ -519,9 +533,13 @@ export default class LocusInfo extends EventsScope {
         );
       } else if (this.fullState && this.fullState.removed) {
         // user has been dropped from a meeting
-        Metrics.postEvent({
-          event: eventType.REMOTE_ENDED,
-          meetingId: this.meetingId,
+
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.remote-ended',
+          options: {
+            meetingId: this.meetingId,
+          },
         });
         this.emitScoped(
           {