@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/src/metrics/{index.js → index.ts}

@@ -8,30 +8,21 @@ import uuid from 'uuid';
 import window from 'global/window';
 import anonymize from 'ip-anonymize';
 
+import {getOSNameInternal} from '@webex/internal-plugin-metrics';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {MEETING_ERRORS} from '../constants';
 import BrowserDetection from '../common/browser-detection';
 
 import {
-  error, eventType, errorCodes as ERROR_CODE, OS_NAME, UNKNOWN, CLIENT_NAME,
-  mediaType
+  error,
+  eventType,
+  errorCodes as ERROR_CODE,
+  UNKNOWN,
+  CLIENT_NAME,
+  mediaType,
 } from './config';
 
-const OSMap = {
-  'Chrome OS': OS_NAME.chrome,
-  macOS: OS_NAME.MAC,
-  Windows: OS_NAME.WINDOWS,
-  iOS: OS_NAME.IOS,
-  Android: OS_NAME.ANDROID,
-  Linux: OS_NAME.LINUX
-};
-
-const {
-  getOSName,
-  getOSVersion,
-  getBrowserName,
-  getBrowserVersion
-} = BrowserDetection();
+const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
 // Apply a CIDR /28 format to the IPV4 and /96 to the IPV6 addresses
 // For reference : https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing
@@ -40,10 +31,10 @@ const anonymizeIPAddress = (localIp) => anonymize(localIp, 28, 96);
 const triggerTimers = ({event, meeting, data}) => {
   switch (event) {
     case eventType.CALL_INITIATED:
-      meeting.setStartCallInitiateJoinReq();
+      meeting.setStartCallInitJoinReq();
       break;
     case eventType.LOCUS_JOIN_REQUEST:
-      meeting.setEndCallInitiateJoinReq();
+      meeting.setEndCallInitJoinReq();
       meeting.setStartJoinReqResp();
       break;
     case eventType.LOCUS_JOIN_RESPONSE:
@@ -76,34 +67,41 @@ const triggerTimers = ({event, meeting, data}) => {
  * @class Metrics
  */
 class Metrics {
+  static instance: Metrics;
+
+  _events: any;
+  keys: any;
+  meetingCollection: any;
+  webex: any;
+
   /**
-     * Create Metrics Object
-     * @constructor
-     * @public
-     * @memberof Meetings
-     */
+   * Create Metrics Object
+   * @constructor
+   * @public
+   * @memberof Meetings
+   */
   constructor() {
     if (!Metrics.instance) {
-    /**
-     * @instance
-     * @type {Array}
-     * @private
-     * @memberof Metrics
-     */
+      /**
+       * @instance
+       * @type {Array}
+       * @private
+       * @memberof Metrics
+       */
       this._events = [];
       /**
-     * @instance
-     * @type {MeetingCollection}
-     * @private
-     * @memberof Metrics
-     */
+       * @instance
+       * @type {MeetingCollection}
+       * @private
+       * @memberof Metrics
+       */
       this.meetingCollection = null;
       /**
-     * @instance
-     * @type {MeetingCollection}
-     * @private
-     * @memberof Metrics
-     */
+       * @instance
+       * @type {MeetingCollection}
+       * @private
+       * @memberof Metrics
+       */
       this.keys = Object.values(eventType);
       /**
        * @instance
@@ -114,6 +112,7 @@ class Metrics {
       Metrics.instance = this;
     }
 
+    // eslint-disable-next-line no-constructor-return
     return Metrics.instance;
   }
 
@@ -125,7 +124,7 @@ class Metrics {
    *
    * @returns {void}
    */
-  initialSetup(meetingCollection, webex) {
+  initialSetup(meetingCollection: object, webex: object) {
     this.meetingCollection = meetingCollection;
     this.webex = webex;
   }
@@ -139,12 +138,14 @@ class Metrics {
    * @param {object} options.event
    * @returns {object} null
    */
-  postEvent(options) {
+  postEvent(options: {meeting?: any; meetingId?: string; data?: object; event?: any} | any) {
     const {meetingId, data = {}, event} = options;
     let {meeting} = options;
 
     if (this.keys.indexOf(event) === -1) {
-      LoggerProxy.logger.error(`Metrics:index#postEvent --> Event ${event} doesn't exist in dictionary`);
+      LoggerProxy.logger.error(
+        `Metrics:index#postEvent --> Event ${event} doesn't exist in dictionary`
+      );
     }
 
     if (!meeting && meetingId) {
@@ -161,54 +162,57 @@ class Metrics {
       if (event === eventType.MEDIA_QUALITY) {
         data.event = event;
         meeting.sendMediaQualityAnalyzerMetrics(data);
-      }
-      else {
+      } else {
         meeting.callEvents.push(event);
         data.event = event;
         meeting.sendCallAnalyzerMetrics(data);
       }
-    }
-
-    else {
-      LoggerProxy.logger.info(`Metrics:index#postEvent --> Event received for meetingId:${meetingId}, but meeting not found in collection.`);
+    } else {
+      LoggerProxy.logger.info(
+        `Metrics:index#postEvent --> Event received for meetingId:${meetingId}, but meeting not found in collection.`
+      );
     }
   }
 
   /**
    *  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
- */
+   *   https://sqbu-github.cisco.com/WebExSquared/call-analyzer/wiki
+   *   https://sqbu-github.cisco.com/WebExSquared/event-dictionary/blob/master/diagnostic-events.raml
+   */
 
+  // eslint-disable-next-line @typescript-eslint/no-shadow
   initPayload(eventType, identifiers, options) {
-    const payload = {
+    const payload: any = {
       eventId: uuid.v4(),
       version: 1,
       origin: {
         name: 'endpoint',
         networkType: 'unknown',
         userAgent: this.userAgentToString(),
+        userType: options.userType,
+        loginType: options.loginType,
+        channel: options.channel,
         clientInfo: {
           clientType: options.clientType,
           clientVersion: `${CLIENT_NAME}/${this.webex.version}`,
           localNetworkPrefix: anonymizeIPAddress(this.webex.meetings.geoHintInfo?.clientAddress),
           osVersion: getOSVersion() || 'unknown',
           subClientType: options.subClientType,
-          os: this.getOsName(),
+          os: getOSNameInternal(),
           browser: getBrowserName(),
-          browserVersion: getBrowserVersion()
-        }
+          browserVersion: getBrowserVersion(),
+        },
       },
       originTime: {
-        triggered: new Date().toISOString()
+        triggered: new Date().toISOString(),
       },
       senderCountryCode: this.webex.meetings.geoHintInfo?.countryCode,
       event: {
         name: eventType,
         canProceed: true,
         identifiers,
-        eventData: {webClientDomain: window.location.hostname}
-      }
+        eventData: {webClientDomain: window.location.hostname},
+      },
     };
 
     // TODO: more options should be checked and some of them should be mandatory in certain conditions
@@ -240,22 +244,16 @@ class Metrics {
       if (options.isRoapCallEnabled) {
         payload.event.isRoapCallEnabled = options.isRoapCallEnabled;
       }
+      ['breakoutMoveId', 'breakoutSessionId', 'breakoutGroupId'].forEach((item) => {
+        if (options[item]) {
+          payload.event.identifiers[item] = options[item];
+        }
+      });
     }
 
     return payload;
   }
 
-  /**
-   * returns metrics friendly OS versions
-   * @param {String} osName Os name
-   * @returns {String}
-   * @private
-   * @memberof Metrics
-   */
-  getOsName() {
-    return OSMap[getOSName()] ?? OS_NAME.OTHERS;
-  }
-
   /**
    * get the payload specific for a media quality event through call analyzer
    * @param {String} eventType the event name
@@ -270,7 +268,21 @@ class Metrics {
    * @public
    * @memberof Metrics
    */
-  initMediaPayload(eventType, identifiers, options = {}) {
+  public initMediaPayload(
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    eventType: string,
+    identifiers: {
+      correlationId: string;
+      locusUrl: string;
+      locusId: string;
+    },
+    options:
+      | {
+          intervalData: object;
+          clientType: string;
+        }
+      | any = {}
+  ) {
     const {audioSetupDelay, videoSetupDelay, joinTimes} = options;
 
     const payload = {
@@ -286,15 +298,15 @@ class Metrics {
           clientType: options.clientType, // TODO: Only clientType: 'TEAMS_CLIENT' is whitelisted
           clientVersion: `${CLIENT_NAME}/${this.webex.version}`,
           localNetworkPrefix: anonymizeIPAddress(this.webex.meetings.geoHintInfo?.clientAddress),
-          os: this.getOsName(),
+          os: getOSNameInternal(),
           osVersion: getOSVersion() || UNKNOWN,
           subClientType: options.subClientType,
           browser: getBrowserName(),
-          browserVersion: getBrowserVersion()
-        }
+          browserVersion: getBrowserVersion(),
+        },
       },
       originTime: {
-        triggered: new Date().toISOString()
+        triggered: new Date().toISOString(),
       },
       senderCountryCode: this.webex.meetings.geoHintInfo?.countryCode,
       event: {
@@ -304,16 +316,16 @@ class Metrics {
         intervals: [options.intervalData],
         joinTimes,
         eventData: {
-          webClientDomain: window.location.hostname
+          webClientDomain: window.location.hostname,
         },
         sourceMetadata: {
           applicationSoftwareType: CLIENT_NAME,
           applicationSoftwareVersion: this.webex.version,
           mediaEngineSoftwareType: getBrowserName() || 'browser',
           mediaEngineSoftwareVersion: getOSVersion() || UNKNOWN,
-          startTime: new Date().toISOString()
-        }
-      }
+          startTime: new Date().toISOString(),
+        },
+      },
     };
 
     return payload;
@@ -329,13 +341,12 @@ class Metrics {
    * @returns {{showToUser: boolean, category: string, errorDescription: string,
    *  errorCode: number, errorData: *, fatal: boolean, name: string}}
    */
-  parseLocusError(err, showToUser) {
+  parseLocusError(err: any, showToUser: boolean) {
     let errorCode;
 
     if (err && err.statusCode && err.statusCode >= 500) {
       errorCode = 1003;
-    }
-    else if (err && err.body && err.body.errorCode) {
+    } else if (err && err.body && err.body.errorCode) {
       // locus error codes: https://sqbu-github.cisco.com/WebExSquared/locus/blob/master/server/src/main/resources/locus-error-codes.properties
       switch (ERROR_CODE[err.body.errorCode]) {
         case MEETING_ERRORS.FREE_USER_MAX_PARTICIPANTS_EXCEEDED:
@@ -434,30 +445,26 @@ class Metrics {
         default:
           errorCode = 4008;
       }
-    }
-    else {
+    } else {
       errorCode = 4008;
     }
 
-    return this.generateErrorPayload(
-      errorCode, showToUser, error.name.LOCUS_RESPONSE, err
-    );
+    return this.generateErrorPayload(errorCode, showToUser, error.name.LOCUS_RESPONSE, err);
   }
 
-
   generateErrorPayload(errorCode, shownToUser, name, err) {
     if (error.errors[errorCode]) {
-      const errorPayload = {
+      const errorPayload: any = {
         shownToUser: shownToUser || false,
         category: error.errors[errorCode][2],
         errorDescription: error.errors[errorCode][0],
         errorCode,
         fatal: !includes(error.notFatalErrorList, errorCode),
-        name: name || error.name.OTHER
+        name: name || error.name.OTHER,
       };
 
       if (err && err.body) {
-        errorPayload.errorData = err.body;
+        errorPayload.errorData = {error: err.body};
       }
 
       if (err && err.statusCode) {
@@ -480,8 +487,14 @@ class Metrics {
     let browserInfo;
     const clientInfo = util.format('client=%s', `${this.webex.meetings?.metrics?.clientName}`);
 
-    if (['chrome', 'firefox', 'msie', 'msedge', 'safari'].indexOf(getBrowserName().toLowerCase()) !== -1) {
-      browserInfo = util.format('browser=%s', `${getBrowserName().toLowerCase()}/${getBrowserVersion().split('.')[0]}`);
+    if (
+      ['chrome', 'firefox', 'msie', 'msedge', 'safari'].indexOf(getBrowserName().toLowerCase()) !==
+      -1
+    ) {
+      browserInfo = util.format(
+        'browser=%s',
+        `${getBrowserName().toLowerCase()}/${getBrowserVersion().split('.')[0]}`
+      );
     }
     const osInfo = util.format('os=%s', `${getOSName()}/${getOSVersion().split('.')[0]}`);
 
@@ -489,12 +502,18 @@ class Metrics {
       userAgentOption = `(${browserInfo}`;
     }
     if (osInfo) {
-      userAgentOption = userAgentOption ? `${userAgentOption}; ${clientInfo}; ${osInfo}` : `${clientInfo}; (${osInfo}`;
+      userAgentOption = userAgentOption
+        ? `${userAgentOption}; ${clientInfo}; ${osInfo}`
+        : `${clientInfo}; (${osInfo}`;
     }
     if (userAgentOption) {
       userAgentOption += ')';
 
-      return util.format('webex-js-sdk/%s %s', `${process.env.NODE_ENV}-${this.webex.version}`, userAgentOption);
+      return util.format(
+        'webex-js-sdk/%s %s',
+        `${process.env.NODE_ENV}-${this.webex.version}`,
+        userAgentOption
+      );
     }
 
     return util.format('webex-js-sdk/%s', `${process.env.NODE_ENV}-${this.webex.version}`);
@@ -515,11 +534,11 @@ class Metrics {
    *
    * @returns {void}
    */
-  sendBehavioralMetric(metricName, metricFields = {}, metricTags = {}) {
+  sendBehavioralMetric(metricName: string, metricFields: object = {}, metricTags: object = {}) {
     this.webex.internal.metrics.submitClientMetrics(metricName, {
       type: this.webex.config.metrics.type,
       fields: metricFields,
-      tags: metricTags
+      tags: metricTags,
     });
   }
 }