@webex/internal-plugin-metrics 1.155.0 → 1.156.2

package/dist/config.js

@@ -6,13 +6,15 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 
-exports.default = void 0;
+exports.default = exports.CLIENT_NAME = void 0;
 
 var _common = require("@webex/common");
 
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+var CLIENT_NAME = 'webex-js-sdk';
+exports.CLIENT_NAME = CLIENT_NAME;
 var _default = {
   device: {
     preDiscoveryServices: {

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["config.js"],"names":["device","preDiscoveryServices","metricsServiceUrl","process","env","METRICS_SERVICE_URL","metrics","appType","inBrowser","batcherWait","batcherMaxCalls","batcherMaxWait","batcherRetryPlateau"],"mappings":";;;;;;;;;;AAIA;;AAJA;AACA;AACA;eAIe;AACbA,EAAAA,MAAM,EAAE;AACNC,IAAAA,oBAAoB,EAAE;AACpBC,MAAAA,iBAAiB,EAAEC,OAAO,CAACC,GAAR,CAAYC,mBAAZ,IAAmC,2CADlC;AAEpBC,MAAAA,OAAO,EAAEH,OAAO,CAACC,GAAR,CAAYC,mBAAZ,IAAmC;AAFxB;AADhB,GADK;AAObC,EAAAA,OAAO,EAAE;AACPC,IAAAA,OAAO,EAAEC,oBAAY,SAAZ,GAAwB,QAD1B;AAEPC,IAAAA,WAAW,EAAE,GAFN;AAGPC,IAAAA,eAAe,EAAE,EAHV;AAIPC,IAAAA,cAAc,EAAE,IAJT;AAKPC,IAAAA,mBAAmB,EAAE;AALd;AAPI,C","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\n\nexport default {\n  device: {\n    preDiscoveryServices: {\n      metricsServiceUrl: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1'\n    }\n  },\n  metrics: {\n    appType: inBrowser ? 'browser' : 'nodejs',\n    batcherWait: 500,\n    batcherMaxCalls: 50,\n    batcherMaxWait: 1500,\n    batcherRetryPlateau: 32000\n  }\n};\n"]}
+{"version":3,"sources":["config.js"],"names":["CLIENT_NAME","device","preDiscoveryServices","metricsServiceUrl","process","env","METRICS_SERVICE_URL","metrics","appType","inBrowser","batcherWait","batcherMaxCalls","batcherMaxWait","batcherRetryPlateau"],"mappings":";;;;;;;;;;AAIA;;AAJA;AACA;AACA;AAIO,IAAMA,WAAW,GAAG,cAApB;;eACQ;AACbC,EAAAA,MAAM,EAAE;AACNC,IAAAA,oBAAoB,EAAE;AACpBC,MAAAA,iBAAiB,EAAEC,OAAO,CAACC,GAAR,CAAYC,mBAAZ,IAAmC,2CADlC;AAEpBC,MAAAA,OAAO,EAAEH,OAAO,CAACC,GAAR,CAAYC,mBAAZ,IAAmC;AAFxB;AADhB,GADK;AAObC,EAAAA,OAAO,EAAE;AACPC,IAAAA,OAAO,EAAEC,oBAAY,SAAZ,GAAwB,QAD1B;AAEPC,IAAAA,WAAW,EAAE,GAFN;AAGPC,IAAAA,eAAe,EAAE,EAHV;AAIPC,IAAAA,cAAc,EAAE,IAJT;AAKPC,IAAAA,mBAAmB,EAAE;AALd;AAPI,C","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\n\nexport const CLIENT_NAME = 'webex-js-sdk';\nexport default {\n  device: {\n    preDiscoveryServices: {\n      metricsServiceUrl: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1'\n    }\n  },\n  metrics: {\n    appType: inBrowser ? 'browser' : 'nodejs',\n    batcherWait: 500,\n    batcherMaxCalls: 50,\n    batcherMaxWait: 1500,\n    batcherRetryPlateau: 32000\n  }\n};\n"]}

package/dist/metrics.js

@@ -1,5 +1,15 @@
 "use strict";
 
+var _Object$keys = require("@babel/runtime-corejs2/core-js/object/keys");
+
+var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs2/core-js/object/get-own-property-symbols");
+
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
+
+var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptors");
+
+var _Object$defineProperties = require("@babel/runtime-corejs2/core-js/object/define-properties");
+
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
 
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
@@ -10,36 +20,62 @@ _Object$defineProperty(exports, "__esModule", {
 
 exports.default = void 0;
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+
 var _assign = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/assign"));
 
 var _now = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/date/now"));
 
-var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor"));
-
-var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/applyDecoratedDescriptor"));
-
 var _webexCore = require("@webex/webex-core");
 
 var _common = require("@webex/common");
 
+var _config = require("./config");
+
 var _batcher = _interopRequireDefault(require("./batcher"));
 
 var _clientMetricsBatcher = _interopRequireDefault(require("./client-metrics-batcher"));
 
 var _callDiagnosticEventsBatcher = _interopRequireDefault(require("./call-diagnostic-events-batcher"));
 
-var _dec, _obj;
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
-var Metrics = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Metrics#sendUnstructured() is deprecated; please use Metrics#submit()'), (_obj = {
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (_Object$getOwnPropertyDescriptors) { _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+var _BrowserDetection = (0, _common.BrowserDetection)(),
+    getOSName = _BrowserDetection.getOSName,
+    getOSVersion = _BrowserDetection.getOSVersion,
+    getBrowserName = _BrowserDetection.getBrowserName,
+    getBrowserVersion = _BrowserDetection.getBrowserVersion;
+
+function getSparkUserAgent(webex) {
+  var _webex$config;
+
+  var _ref = (_webex$config = webex === null || webex === void 0 ? void 0 : webex.config) !== null && _webex$config !== void 0 ? _webex$config : {},
+      appName = _ref.appName,
+      appVersion = _ref.appVersion,
+      appPlatform = _ref.appPlatform;
+
+  var sparkUserAgent = _config.CLIENT_NAME;
+
+  if (appName) {
+    sparkUserAgent += " ".concat(appName, "/").concat(appVersion !== null && appVersion !== void 0 ? appVersion : '0.0');
+  }
+
+  if (appPlatform) {
+    sparkUserAgent += " ".concat(appPlatform);
+  }
+
+  return sparkUserAgent;
+}
+
+var Metrics = _webexCore.WebexPlugin.extend({
   children: {
     batcher: _batcher.default,
     clientMetricsBatcher: _clientMetricsBatcher.default,
     callDiagnosticEventsBatcher: _callDiagnosticEventsBatcher.default
   },
   namespace: 'Metrics',
-  sendUnstructured: function sendUnstructured(key, value) {
-    return this.submit(key, value);
-  },
   submit: function submit(key, value) {
     return this.batcher.request((0, _assign.default)({
       key: key
@@ -53,26 +89,46 @@ var Metrics = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Met
    * @param {string} preLoginId
    * @returns {Object} HttpResponse object
    */
-  submitClientMetrics: function submitClientMetrics(eventName, props, preLoginId) {
-    var payload = {
-      metricName: eventName
-    };
-
-    if (props.tags) {
-      payload.tags = props.tags;
-    }
+  submitClientMetrics: function submitClientMetrics(eventName) {
+    var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var preLoginId = arguments.length > 2 ? arguments[2] : undefined;
 
-    if (props.fields) {
-      payload.fields = props.fields;
+    if (!eventName) {
+      throw Error('Missing behavioral metric name. Please provide one');
     }
 
-    if (props.type) {
-      payload.type = props.type;
-    }
-
-    if (props.context) {
-      payload.context = props.context;
-    }
+    var payload = {
+      metricName: eventName
+    };
+    payload.tags = _objectSpread(_objectSpread({}, props.tags), {}, {
+      browser: getBrowserName(),
+      org_id: this.webex.credentials.getOrgId(),
+      os: getOSName(),
+      // Node does not like this so we need to check if it exists or not
+      // eslint-disable-next-line no-undef
+      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser',
+      // Check what else we could measure
+      client_id: this.webex.credentials.config.client_id,
+      user_id: this.webex.internal.device.userId
+    });
+    payload.fields = _objectSpread(_objectSpread({}, props.fields), {}, {
+      browser_version: getBrowserVersion(),
+      os_version: getOSVersion(),
+      sdk_version: this.webex.version,
+      platform: 'Web',
+      spark_user_agent: getSparkUserAgent(this.webex)
+    });
+    payload.type = props.type || this.webex.config.metrics.type;
+    payload.context = _objectSpread(_objectSpread({}, props.context), {}, {
+      app: {
+        version: this.webex.version
+      },
+      locale: 'en-US',
+      os: {
+        name: getOSName(),
+        version: getOSVersion()
+      }
+    });
 
     if (props.eventPayload) {
       payload.eventPayload = props.eventPayload;
@@ -135,8 +191,8 @@ var Metrics = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Met
     };
     return this.callDiagnosticEventsBatcher.request(event);
   },
-  version: "1.155.0"
-}, ((0, _applyDecoratedDescriptor2.default)(_obj, "sendUnstructured", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "sendUnstructured"), _obj)), _obj)));
+  version: "1.156.2"
+});
 
 var _default = Metrics;
 exports.default = _default;

package/dist/metrics.js.map

@@ -1 +1 @@
-{"version":3,"sources":["metrics.js"],"names":["Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","callDiagnosticEventsBatcher","CallDiagnosticEventsBatcher","namespace","sendUnstructured","key","value","submit","request","submitClientMetrics","eventName","props","preLoginId","payload","metricName","tags","fields","type","context","eventPayload","timestamp","_payload","metrics","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","webex","credentials","getClientToken","then","token","authorization","toString","submitCallDiagnosticEvents","event"],"mappings":";;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AAEA;;AACA;;AACA;;;;AAEA,IAAMA,OAAO,GAAGC,uBAAYC,MAAZ,SASb,wBAAW,uEAAX,CATa,UAAmB;AACjCC,EAAAA,QAAQ,EAAE;AACRC,IAAAA,OAAO,EAAEC,gBADD;AAERC,IAAAA,oBAAoB,EAAEC,6BAFd;AAGRC,IAAAA,2BAA2B,EAAEC;AAHrB,GADuB;AAOjCC,EAAAA,SAAS,EAAE,SAPsB;AAUjCC,EAAAA,gBAViC,4BAUhBC,GAVgB,EAUXC,KAVW,EAUJ;AAC3B,WAAO,KAAKC,MAAL,CAAYF,GAAZ,EAAiBC,KAAjB,CAAP;AACD,GAZgC;AAcjCC,EAAAA,MAdiC,kBAc1BF,GAd0B,EAcrBC,KAdqB,EAcd;AACjB,WAAO,KAAKT,OAAL,CAAaW,OAAb,CAAqB,qBAAc;AAACH,MAAAA,GAAG,EAAHA;AAAD,KAAd,EAAqBC,KAArB,CAArB,CAAP;AACD,GAhBgC;;AAkBjC;AACF;AACA;AACA;AACA;AACA;AACA;AACEG,EAAAA,mBAzBiC,+BAyBbC,SAzBa,EAyBFC,KAzBE,EAyBKC,UAzBL,EAyBiB;AAChD,QAAMC,OAAO,GAAG;AAACC,MAAAA,UAAU,EAAEJ;AAAb,KAAhB;;AAEA,QAAIC,KAAK,CAACI,IAAV,EAAgB;AACdF,MAAAA,OAAO,CAACE,IAAR,GAAeJ,KAAK,CAACI,IAArB;AACD;;AACD,QAAIJ,KAAK,CAACK,MAAV,EAAkB;AAChBH,MAAAA,OAAO,CAACG,MAAR,GAAiBL,KAAK,CAACK,MAAvB;AACD;;AACD,QAAIL,KAAK,CAACM,IAAV,EAAgB;AACdJ,MAAAA,OAAO,CAACI,IAAR,GAAeN,KAAK,CAACM,IAArB;AACD;;AACD,QAAIN,KAAK,CAACO,OAAV,EAAmB;AACjBL,MAAAA,OAAO,CAACK,OAAR,GAAkBP,KAAK,CAACO,OAAxB;AACD;;AAED,QAAIP,KAAK,CAACQ,YAAV,EAAwB;AACtBN,MAAAA,OAAO,CAACM,YAAR,GAAuBR,KAAK,CAACQ,YAA7B;AACD;;AAEDN,IAAAA,OAAO,CAACO,SAAR,GAAoB,mBAApB;;AAEA,QAAIR,UAAJ,EAAgB;AACd,UAAMS,QAAQ,GAAG;AACfC,QAAAA,OAAO,EAAE,CAACT,OAAD;AADM,OAAjB,CADc,CAKd;AACA;AACA;;AACA,aAAO,KAAKU,kBAAL,CAAwBF,QAAxB,EAAkCT,UAAlC,CAAP;AACD;;AAED,WAAO,KAAKb,oBAAL,CAA0BS,OAA1B,CAAkCK,OAAlC,CAAP;AACD,GA3DgC;;AA6DjC;AACF;AACA;AACA;AACA;AACEW,EAAAA,SAlEiC,qBAkEvBZ,UAlEuB,EAkEX;AACpB,WAAO,KAAKJ,OAAL,CAAa;AAClBiB,MAAAA,MAAM,EAAE,MADU;AAElBC,MAAAA,GAAG,EAAE,SAFa;AAGlBC,MAAAA,QAAQ,EAAE,eAHQ;AAIlBC,MAAAA,OAAO,EAAE;AACP,6BAAqBhB;AADd,OAJS;AAOlBiB,MAAAA,IAAI,EAAE,EAPY;AAQlBC,MAAAA,EAAE,EAAE;AACFC,QAAAA,KAAK,EAAE;AADL;AARc,KAAb,CAAP;AAYD,GA/EgC;AAiFjCR,EAAAA,kBAjFiC,8BAiFdV,OAjFc,EAiFLD,UAjFK,EAiFO;AAAA;;AACtC,WAAO,KAAKoB,KAAL,CAAWC,WAAX,CAAuBC,cAAvB,GAAwCC,IAAxC,CAA6C,UAACC,KAAD;AAAA,aAClD,KAAI,CAAC5B,OAAL,CAAa;AACXiB,QAAAA,MAAM,EAAE,MADG;AAEXC,QAAAA,GAAG,EAAE,SAFM;AAGXC,QAAAA,QAAQ,EAAE,wBAHC;AAIXC,QAAAA,OAAO,EAAE;AACPS,UAAAA,aAAa,EAAED,KAAK,CAACE,QAAN,EADR;AAEP,+BAAqB1B;AAFd,SAJE;AAQXiB,QAAAA,IAAI,EAAEhB;AARK,OAAb,CADkD;AAAA,KAA7C,CAAP;AAWD,GA7FgC;AA+FjC0B,EAAAA,0BA/FiC,sCA+FN1B,OA/FM,EA+FG;AAClC,QAAM2B,KAAK,GAAG;AACZvB,MAAAA,IAAI,EAAE,kBADM;AAEZE,MAAAA,YAAY,EAAEN;AAFF,KAAd;AAKA,WAAO,KAAKZ,2BAAL,CAAiCO,OAAjC,CAAyCgC,KAAzC,CAAP;AACD,GAtGgC;AAAA;AAAA,CAAnB,8JAAhB;;eAyGe/C,O","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {deprecated} from '@webex/common';\n\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\nimport CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher\n  },\n\n  namespace: 'Metrics',\n\n  @deprecated('Metrics#sendUnstructured() is deprecated; please use Metrics#submit()')\n  sendUnstructured(key, value) {\n    return this.submit(key, value);\n  },\n\n  submit(key, value) {\n    return this.batcher.request(Object.assign({key}, value));\n  },\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props, preLoginId) {\n    const payload = {metricName: eventName};\n\n    if (props.tags) {\n      payload.tags = props.tags;\n    }\n    if (props.fields) {\n      payload.fields = props.fields;\n    }\n    if (props.type) {\n      payload.type = props.type;\n    }\n    if (props.context) {\n      payload.context = props.context;\n    }\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    payload.timestamp = Date.now();\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload]\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId\n      },\n      body: {},\n      qs: {\n        alias: true\n      }\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId\n        },\n        body: payload\n      }));\n  },\n\n  submitCallDiagnosticEvents(payload) {\n    const event = {\n      type: 'diagnostic-event',\n      eventPayload: payload\n    };\n\n    return this.callDiagnosticEventsBatcher.request(event);\n  }\n});\n\nexport default Metrics;\n"]}
+{"version":3,"sources":["metrics.js"],"names":["getOSName","getOSVersion","getBrowserName","getBrowserVersion","getSparkUserAgent","webex","config","appName","appVersion","appPlatform","sparkUserAgent","CLIENT_NAME","Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","callDiagnosticEventsBatcher","CallDiagnosticEventsBatcher","namespace","submit","key","value","request","submitClientMetrics","eventName","props","preLoginId","Error","payload","metricName","tags","browser","org_id","credentials","getOrgId","os","domain","window","location","hostname","client_id","user_id","internal","device","userId","fields","browser_version","os_version","sdk_version","version","platform","spark_user_agent","type","metrics","context","app","locale","name","eventPayload","timestamp","_payload","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","getClientToken","then","token","authorization","toString","submitCallDiagnosticEvents","event"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AAEA;;AACA;;AACA;;AACA;;;;;;AAEA,wBAKI,+BALJ;AAAA,IACEA,SADF,qBACEA,SADF;AAAA,IAEEC,YAFF,qBAEEA,YAFF;AAAA,IAGEC,cAHF,qBAGEA,cAHF;AAAA,IAIEC,iBAJF,qBAIEA,iBAJF;;AAOA,SAASC,iBAAT,CAA2BC,KAA3B,EAAkC;AAAA;;AAChC,8BAIIA,KAJJ,aAIIA,KAJJ,uBAIIA,KAAK,CAAEC,MAJX,yDAIqB,EAJrB;AAAA,MACEC,OADF,QACEA,OADF;AAAA,MAEEC,UAFF,QAEEA,UAFF;AAAA,MAGEC,WAHF,QAGEA,WAHF;;AAMA,MAAIC,cAAc,GAAGC,mBAArB;;AAEA,MAAIJ,OAAJ,EAAa;AACXG,IAAAA,cAAc,eAAQH,OAAR,cAAmBC,UAAnB,aAAmBA,UAAnB,cAAmBA,UAAnB,GAAiC,KAAjC,CAAd;AACD;;AAED,MAAIC,WAAJ,EAAiB;AACfC,IAAAA,cAAc,eAAQD,WAAR,CAAd;AACD;;AAED,SAAOC,cAAP;AACD;;AAGD,IAAME,OAAO,GAAGC,uBAAYC,MAAZ,CAAmB;AACjCC,EAAAA,QAAQ,EAAE;AACRC,IAAAA,OAAO,EAAEC,gBADD;AAERC,IAAAA,oBAAoB,EAAEC,6BAFd;AAGRC,IAAAA,2BAA2B,EAAEC;AAHrB,GADuB;AAOjCC,EAAAA,SAAS,EAAE,SAPsB;AASjCC,EAAAA,MATiC,kBAS1BC,GAT0B,EASrBC,KATqB,EASd;AACjB,WAAO,KAAKT,OAAL,CAAaU,OAAb,CAAqB,qBAAc;AAACF,MAAAA,GAAG,EAAHA;AAAD,KAAd,EAAqBC,KAArB,CAArB,CAAP;AACD,GAXgC;;AAcjC;AACF;AACA;AACA;AACA;AACA;AACA;AACEE,EAAAA,mBArBiC,+BAqBbC,SArBa,EAqBsB;AAAA,QAAxBC,KAAwB,uEAAhB,EAAgB;AAAA,QAAZC,UAAY;;AACrD,QAAI,CAACF,SAAL,EAAgB;AACd,YAAMG,KAAK,CAAC,oDAAD,CAAX;AACD;;AACD,QAAMC,OAAO,GAAG;AAACC,MAAAA,UAAU,EAAEL;AAAb,KAAhB;AAEAI,IAAAA,OAAO,CAACE,IAAR,mCACKL,KAAK,CAACK,IADX;AAEEC,MAAAA,OAAO,EAAEjC,cAAc,EAFzB;AAGEkC,MAAAA,MAAM,EAAE,KAAK/B,KAAL,CAAWgC,WAAX,CAAuBC,QAAvB,EAHV;AAIEC,MAAAA,EAAE,EAAEvC,SAAS,EAJf;AAME;AACA;AACAwC,MAAAA,MAAM,EAAE,OAAOC,MAAP,KAAkB,WAAlB,GAAgCA,MAAM,CAACC,QAAP,CAAgBC,QAAhB,IAA4B,aAA5D,GAA4E,aARtF;AAQqG;AACnGC,MAAAA,SAAS,EAAE,KAAKvC,KAAL,CAAWgC,WAAX,CAAuB/B,MAAvB,CAA8BsC,SAT3C;AAUEC,MAAAA,OAAO,EAAE,KAAKxC,KAAL,CAAWyC,QAAX,CAAoBC,MAApB,CAA2BC;AAVtC;AAcAhB,IAAAA,OAAO,CAACiB,MAAR,mCACKpB,KAAK,CAACoB,MADX;AAEEC,MAAAA,eAAe,EAAE/C,iBAAiB,EAFpC;AAGEgD,MAAAA,UAAU,EAAElD,YAAY,EAH1B;AAIEmD,MAAAA,WAAW,EAAE,KAAK/C,KAAL,CAAWgD,OAJ1B;AAKEC,MAAAA,QAAQ,EAAE,KALZ;AAMEC,MAAAA,gBAAgB,EAAEnD,iBAAiB,CAAC,KAAKC,KAAN;AANrC;AAUA2B,IAAAA,OAAO,CAACwB,IAAR,GAAe3B,KAAK,CAAC2B,IAAN,IAAc,KAAKnD,KAAL,CAAWC,MAAX,CAAkBmD,OAAlB,CAA0BD,IAAvD;AAGAxB,IAAAA,OAAO,CAAC0B,OAAR,mCACK7B,KAAK,CAAC6B,OADX;AAEEC,MAAAA,GAAG,EAAE;AACHN,QAAAA,OAAO,EAAE,KAAKhD,KAAL,CAAWgD;AADjB,OAFP;AAKEO,MAAAA,MAAM,EAAE,OALV;AAMErB,MAAAA,EAAE,EAAE;AACFsB,QAAAA,IAAI,EAAE7D,SAAS,EADb;AAEFqD,QAAAA,OAAO,EAAEpD,YAAY;AAFnB;AANN;;AAaA,QAAI4B,KAAK,CAACiC,YAAV,EAAwB;AACtB9B,MAAAA,OAAO,CAAC8B,YAAR,GAAuBjC,KAAK,CAACiC,YAA7B;AACD;;AAED9B,IAAAA,OAAO,CAAC+B,SAAR,GAAoB,mBAApB;;AAEA,QAAIjC,UAAJ,EAAgB;AACd,UAAMkC,QAAQ,GAAG;AACfP,QAAAA,OAAO,EAAE,CAACzB,OAAD;AADM,OAAjB,CADc,CAKd;AACA;AACA;;AACA,aAAO,KAAKiC,kBAAL,CAAwBD,QAAxB,EAAkClC,UAAlC,CAAP;AACD;;AAED,WAAO,KAAKZ,oBAAL,CAA0BQ,OAA1B,CAAkCM,OAAlC,CAAP;AACD,GArFgC;;AAuFjC;AACF;AACA;AACA;AACA;AACEkC,EAAAA,SA5FiC,qBA4FvBpC,UA5FuB,EA4FX;AACpB,WAAO,KAAKJ,OAAL,CAAa;AAClByC,MAAAA,MAAM,EAAE,MADU;AAElBC,MAAAA,GAAG,EAAE,SAFa;AAGlBC,MAAAA,QAAQ,EAAE,eAHQ;AAIlBC,MAAAA,OAAO,EAAE;AACP,6BAAqBxC;AADd,OAJS;AAOlByC,MAAAA,IAAI,EAAE,EAPY;AAQlBC,MAAAA,EAAE,EAAE;AACFC,QAAAA,KAAK,EAAE;AADL;AARc,KAAb,CAAP;AAYD,GAzGgC;AA2GjCR,EAAAA,kBA3GiC,8BA2GdjC,OA3Gc,EA2GLF,UA3GK,EA2GO;AAAA;;AACtC,WAAO,KAAKzB,KAAL,CAAWgC,WAAX,CAAuBqC,cAAvB,GAAwCC,IAAxC,CAA6C,UAACC,KAAD;AAAA,aAClD,KAAI,CAAClD,OAAL,CAAa;AACXyC,QAAAA,MAAM,EAAE,MADG;AAEXC,QAAAA,GAAG,EAAE,SAFM;AAGXC,QAAAA,QAAQ,EAAE,wBAHC;AAIXC,QAAAA,OAAO,EAAE;AACPO,UAAAA,aAAa,EAAED,KAAK,CAACE,QAAN,EADR;AAEP,+BAAqBhD;AAFd,SAJE;AAQXyC,QAAAA,IAAI,EAAEvC;AARK,OAAb,CADkD;AAAA,KAA7C,CAAP;AAWD,GAvHgC;AAyHjC+C,EAAAA,0BAzHiC,sCAyHN/C,OAzHM,EAyHG;AAClC,QAAMgD,KAAK,GAAG;AACZxB,MAAAA,IAAI,EAAE,kBADM;AAEZM,MAAAA,YAAY,EAAE9B;AAFF,KAAd;AAKA,WAAO,KAAKZ,2BAAL,CAAiCM,OAAjC,CAAyCsD,KAAzC,CAAP;AACD,GAhIgC;AAAA;AAAA,CAAnB,CAAhB;;eAmIepE,O","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {BrowserDetection} from '@webex/common';\n\nimport {CLIENT_NAME} from './config';\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\nimport CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';\n\nconst {\n  getOSName,\n  getOSVersion,\n  getBrowserName,\n  getBrowserVersion\n} = BrowserDetection();\n\nfunction getSparkUserAgent(webex) {\n  const {\n    appName,\n    appVersion,\n    appPlatform\n  } = webex?.config ?? {};\n\n  let sparkUserAgent = CLIENT_NAME;\n\n  if (appName) {\n    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n  }\n\n  if (appPlatform) {\n    sparkUserAgent += ` ${appPlatform}`;\n  }\n\n  return sparkUserAgent;\n}\n\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher\n  },\n\n  namespace: 'Metrics',\n\n  submit(key, value) {\n    return this.batcher.request(Object.assign({key}, value));\n  },\n\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props = {}, preLoginId) {\n    if (!eventName) {\n      throw Error('Missing behavioral metric name. Please provide one');\n    }\n    const payload = {metricName: eventName};\n\n    payload.tags = {\n      ...props.tags,\n      browser: getBrowserName(),\n      org_id: this.webex.credentials.getOrgId(),\n      os: getOSName(),\n\n      // Node does not like this so we need to check if it exists or not\n      // eslint-disable-next-line no-undef\n      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure\n      client_id: this.webex.credentials.config.client_id,\n      user_id: this.webex.internal.device.userId\n    };\n\n\n    payload.fields = {\n      ...props.fields,\n      browser_version: getBrowserVersion(),\n      os_version: getOSVersion(),\n      sdk_version: this.webex.version,\n      platform: 'Web',\n      spark_user_agent: getSparkUserAgent(this.webex)\n    };\n\n\n    payload.type = props.type || this.webex.config.metrics.type;\n\n\n    payload.context = {\n      ...props.context,\n      app: {\n        version: this.webex.version\n      },\n      locale: 'en-US',\n      os: {\n        name: getOSName(),\n        version: getOSVersion()\n      }\n    };\n\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    payload.timestamp = Date.now();\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload]\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId\n      },\n      body: {},\n      qs: {\n        alias: true\n      }\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId\n        },\n        body: payload\n      }));\n  },\n\n  submitCallDiagnosticEvents(payload) {\n    const event = {\n      type: 'diagnostic-event',\n      eventPayload: payload\n    };\n\n    return this.callDiagnosticEventsBatcher.request(event);\n  }\n});\n\nexport default Metrics;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "1.155.0",
+  "version": "1.156.2",
   "description": "",
   "license": "MIT",
   "author": "Ian W. Remmel <iremmel@cisco.com>",
@@ -17,10 +17,10 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.14.8",
-    "@webex/internal-plugin-device": "1.155.0",
-    "@webex/webex-core": "1.155.0",
-    "@webex/common": "1.155.0",
-    "@webex/common-timers": "1.155.0",
+    "@webex/internal-plugin-device": "1.156.2",
+    "@webex/webex-core": "1.156.2",
+    "@webex/common": "1.156.2",
+    "@webex/common-timers": "1.156.2",
     "envify": "^4.1.0"
   }
 }

package/src/config.js

@@ -4,6 +4,7 @@
 
 import {inBrowser} from '@webex/common';
 
+export const CLIENT_NAME = 'webex-js-sdk';
 export default {
   device: {
     preDiscoveryServices: {

package/src/metrics.js

@@ -3,12 +3,41 @@
  */
 
 import {WebexPlugin} from '@webex/webex-core';
-import {deprecated} from '@webex/common';
+import {BrowserDetection} from '@webex/common';
 
+import {CLIENT_NAME} from './config';
 import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
 import CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';
 
+const {
+  getOSName,
+  getOSVersion,
+  getBrowserName,
+  getBrowserVersion
+} = BrowserDetection();
+
+function getSparkUserAgent(webex) {
+  const {
+    appName,
+    appVersion,
+    appPlatform
+  } = webex?.config ?? {};
+
+  let sparkUserAgent = CLIENT_NAME;
+
+  if (appName) {
+    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;
+  }
+
+  if (appPlatform) {
+    sparkUserAgent += ` ${appPlatform}`;
+  }
+
+  return sparkUserAgent;
+}
+
+
 const Metrics = WebexPlugin.extend({
   children: {
     batcher: Batcher,
@@ -18,15 +47,11 @@ const Metrics = WebexPlugin.extend({
 
   namespace: 'Metrics',
 
-  @deprecated('Metrics#sendUnstructured() is deprecated; please use Metrics#submit()')
-  sendUnstructured(key, value) {
-    return this.submit(key, value);
-  },
-
   submit(key, value) {
     return this.batcher.request(Object.assign({key}, value));
   },
 
+
   /**
    * This corresponds to #sendSemiStructured() in the deprecated metrics handler
    * @param {string} eventName
@@ -34,21 +59,51 @@ const Metrics = WebexPlugin.extend({
    * @param {string} preLoginId
    * @returns {Object} HttpResponse object
    */
-  submitClientMetrics(eventName, props, preLoginId) {
+  submitClientMetrics(eventName, props = {}, preLoginId) {
+    if (!eventName) {
+      throw Error('Missing behavioral metric name. Please provide one');
+    }
     const payload = {metricName: eventName};
 
-    if (props.tags) {
-      payload.tags = props.tags;
-    }
-    if (props.fields) {
-      payload.fields = props.fields;
-    }
-    if (props.type) {
-      payload.type = props.type;
-    }
-    if (props.context) {
-      payload.context = props.context;
-    }
+    payload.tags = {
+      ...props.tags,
+      browser: getBrowserName(),
+      org_id: this.webex.credentials.getOrgId(),
+      os: getOSName(),
+
+      // Node does not like this so we need to check if it exists or not
+      // eslint-disable-next-line no-undef
+      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
+      client_id: this.webex.credentials.config.client_id,
+      user_id: this.webex.internal.device.userId
+    };
+
+
+    payload.fields = {
+      ...props.fields,
+      browser_version: getBrowserVersion(),
+      os_version: getOSVersion(),
+      sdk_version: this.webex.version,
+      platform: 'Web',
+      spark_user_agent: getSparkUserAgent(this.webex)
+    };
+
+
+    payload.type = props.type || this.webex.config.metrics.type;
+
+
+    payload.context = {
+      ...props.context,
+      app: {
+        version: this.webex.version
+      },
+      locale: 'en-US',
+      os: {
+        name: getOSName(),
+        version: getOSVersion()
+      }
+    };
+
 
     if (props.eventPayload) {
       payload.eventPayload = props.eventPayload;

package/test/unit/spec/metrics.js

@@ -84,6 +84,25 @@ describe('plugin-metrics', () => {
           options
         });
       };
+
+      webex.credentials = {
+        ...webex.credentials,
+        getOrgId: sinon.stub().returns('orgId'),
+        config: {
+          client_id: 'client_id'
+        }
+      };
+      webex.internal = {...webex.internal, device: {userId: 'userId'}};
+      webex.config = {
+        ...webex.config,
+        appName: 'appName',
+        appPlatform: 'appPlatform',
+        appVersion: 'appVersion'
+
+      };
+      webex.config.metrics.type = ['operational'];
+      webex.config.metrics.appType = 'sdk';
+
       sinon.spy(webex, 'request');
       sinon.spy(metrics, 'postPreLoginMetric');
       sinon.spy(metrics, 'aliasUser');
@@ -174,6 +193,24 @@ describe('plugin-metrics', () => {
               assert.property(metric, 'context');
               assert.property(metric, 'eventPayload');
 
+              assert.property(metric.tags, 'browser');
+              assert.property(metric.tags, 'org_id');
+              assert.property(metric.tags, 'os');
+              assert.property(metric.tags, 'domain');
+              assert.property(metric.tags, 'client_id');
+              assert.property(metric.tags, 'user_id');
+
+              assert.property(metric.fields, 'browser_version');
+              assert.property(metric.fields, 'os_version');
+              assert.property(metric.fields, 'sdk_version');
+              assert.property(metric.fields, 'platform');
+              assert.property(metric.fields, 'spark_user_agent');
+
+              assert.property(metric.context, 'app');
+              assert.property(metric.context, 'locale');
+              assert.property(metric.context, 'os');
+
+
               assert.equal(metric.timestamp, date);
               assert.equal(metric.metricName, 'test');
               assert.equal(metric.tags.success, true);