@webex/internal-plugin-metrics 3.5.0 → 3.6.0-next.2

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

@@ -274,7 +274,7 @@ describe('internal-plugin-metrics', () => {
   describe('prepareDiagnosticMetricItem', () => {
     let webex: any;
 
-    const check = (eventName: string, expectedEvent: any) => {
+    const check = (eventName: string, expectedEvent: any, expectedUpgradeChannel: string) => {
       const eventPayload = {event: {name: eventName}};
       const item = prepareDiagnosticMetricItem(webex, {
         eventPayload,
@@ -286,6 +286,7 @@ describe('internal-plugin-metrics', () => {
           origin: {
             buildType: 'prod',
             networkType: 'unknown',
+            upgradeChannel: expectedUpgradeChannel
           },
           event: {name: eventName, ...expectedEvent},
         },
@@ -417,11 +418,11 @@ describe('internal-plugin-metrics', () => {
       ],
     ].forEach(([eventName, expectedEvent]) => {
       it(`returns expected result for ${eventName}`, () => {
-        check(eventName as string, expectedEvent);
+        check(eventName as string, expectedEvent, 'gold');
       });
     });
 
-    it('getBuildType returns correct value', () => {
+    it('sets buildType and upgradeChannel correctly', () => {
       const item: any = {
         eventPayload: {
           event: {
@@ -438,11 +439,14 @@ describe('internal-plugin-metrics', () => {
       // just submit any event
       prepareDiagnosticMetricItem(webex, item);
       assert.deepEqual(item.eventPayload.origin.buildType, 'test');
+      assert.deepEqual(item.eventPayload.origin.upgradeChannel, 'test');
 
       delete item.eventPayload.origin.buildType;
+      delete item.eventPayload.origin.upgradeChannel;
       item.eventPayload.event.eventData.markAsTestEvent = false;
       prepareDiagnosticMetricItem(webex, item);
       assert.deepEqual(item.eventPayload.origin.buildType, 'prod');
+      assert.deepEqual(item.eventPayload.origin.upgradeChannel, 'gold');
     });
   });
 

package/test/unit/spec/new-metrics.ts

@@ -11,9 +11,6 @@ describe('internal-plugin-metrics', () => {
       newMetrics: NewMetrics,
     },
     meetings: {
-      meetingCollection: {
-        get: sinon.stub(),
-      },
     },
     request: sinon.stub().resolves({}),
     logger: {
@@ -86,6 +83,24 @@ describe('internal-plugin-metrics', () => {
       webex.internal.newMetrics.isReadyToSubmitBusinessEvents();
       assert.isDefined(webex.internal.newMetrics.businessMetrics);
     })
+
+    it('passes the table through to the business metrics', () => {
+      assert.isUndefined(webex.internal.newMetrics.businessMetrics)
+      webex.internal.newMetrics.isReadyToSubmitBusinessEvents();
+      assert.isDefined(webex.internal.newMetrics.businessMetrics);
+      webex.internal.newMetrics.businessMetrics.submitBusinessEvent = sinon.stub();
+      webex.internal.newMetrics.submitBusinessEvent({
+        name: 'foobar',
+        payload: {},
+        table: 'test',
+      });
+
+      assert.calledWith(webex.internal.newMetrics.businessMetrics.submitBusinessEvent, {
+        name: 'foobar',
+        payload: {},
+        table: 'test',
+      });
+    });
   
     it('submits Client Event successfully', () => {
       webex.internal.newMetrics.submitClientEvent({

package/test/unit/spec/prelogin-metrics-batcher.ts

@@ -82,6 +82,7 @@ describe('internal-plugin-metrics', () => {
                   origin: {
                     buildType: 'test',
                     networkType: 'unknown',
+                    upgradeChannel: 'test',
                   },
                   originTime: {
                     sent: dateAfterBatcherWait.toISOString(),
@@ -211,7 +212,7 @@ describe('internal-plugin-metrics', () => {
         // item also gets assigned a delay property but the key is a Symbol and haven't been able to test that..
         assert.deepEqual(calls.args[0].eventPayload, {
           event: 'my.event',
-          origin: {buildType: 'test', networkType: 'unknown'},
+          origin: {buildType: 'test', networkType: 'unknown', upgradeChannel: 'test'},
         });
 
         assert.deepEqual(calls.args[0].type, ['diagnostic-event']);
@@ -225,6 +226,7 @@ describe('internal-plugin-metrics', () => {
           origin: {
             buildType: 'test',
             networkType: 'unknown',
+            upgradeChannel: 'test',
           },
         });
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);

package/test/unit/spec/rtcMetrics/index.ts

@@ -0,0 +1,196 @@
+import 'jsdom-global/register';
+import RtcMetrics from '../../../../src/rtcMetrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {assert} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+import RTC_METRICS from '../../../../src/rtcMetrics/constants';
+
+const FAKE_METRICS_ITEM = {payload: ['{"type":"string","value":"fake-metrics","id":""}']};
+const FAILURE_METRICS_ITEM = {
+  name: "onconnectionstatechange",
+  payload: ['{"type":"string","value":"failed","id":""}'],
+  timestamp: 1707929986667
+};
+
+const STATS_WITH_IP = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.255","address":"11.22.111.255","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
+const STATS_WITH_IP_RESULT = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.240","address":"11.22.111.240","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
+
+describe('RtcMetrics', () => {
+  let metrics: RtcMetrics;
+  let webex: MockWebex;
+  let clock;
+  let anonymizeIpSpy;
+
+  const sandbox = sinon.createSandbox();
+
+  beforeEach(() => {
+    clock = sinon.useFakeTimers();
+    window.setInterval = setInterval;
+    webex = new MockWebex();
+    metrics = new RtcMetrics(webex, {meetingId: 'mock-meeting-id'}, 'mock-correlation-id');
+    anonymizeIpSpy = sandbox.spy(metrics, 'anonymizeIp');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('sendMetrics should send a webex request', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetrics();
+
+    assert.callCount(webex.request, 1);
+    assert.calledWithMatch(webex.request, sinon.match.has('headers', {
+      type: 'webrtcMedia',
+      appId: RTC_METRICS.APP_ID,
+    }));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].data[0].payload', FAKE_METRICS_ITEM.payload));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].meetingId', 'mock-meeting-id'));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
+  });
+
+  it('should have a defined sendMetricsInQueue function which is public', () => {
+    assert.isDefined(metrics.sendMetricsInQueue);
+    assert.isFunction(metrics.sendMetricsInQueue);
+  });
+
+  it('should send metrics requests over time', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.deepEqual(metrics.metricsQueue, [FAKE_METRICS_ITEM]);
+    clock.tick(60 * 1000);
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should not send requests with no items in the queue', () => {
+    clock.tick(60 * 1000);
+    assert.notCalled(webex.request);
+  });
+
+  it('sendMetricsInQueue should send metrics if any exist in the queue', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetricsInQueue();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should clear out metrics on close', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    metrics.closeMetrics();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should clear out metrics on failure', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should have the same connectionId on success', () => {
+    const originalId = metrics.connectionId;
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+
+    assert.strictEqual(originalId, metrics.connectionId);
+  });
+
+  it('should have a new connectionId on failure', () => {
+    const originalId = metrics.connectionId;
+
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+
+    assert.notEqual(originalId, metrics.connectionId);
+  });
+
+  it('should anonymize IP addresses', () => {
+    assert.strictEqual(metrics.anonymizeIp(STATS_WITH_IP), STATS_WITH_IP_RESULT);
+  });
+
+  it('should call anonymizeIp', () => {
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.calledOnce(anonymizeIpSpy);
+  })
+
+  it('should send metrics on first stats-report', () => {
+    assert.callCount(webex.request, 0);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should send metrics on first stats-report after a new connection', () => {
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // subsequent stats-report doesn't trigger it
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // now, simulate a failure - that triggers a new connection and upload of the metrics
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+    assert.callCount(webex.request, 2);
+
+    // and another stats-report should trigger another upload of the metrics
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 3);
+  });
+
+  describe('RtcMetrics - callId', () => {
+    let metrics: RtcMetrics;
+    let webex: MockWebex;
+    let clock;
+    let sandbox;
+  
+    beforeEach(() => {
+      clock = sinon.useFakeTimers();
+      window.setInterval = setInterval;
+      webex = new MockWebex();
+      metrics = new RtcMetrics(webex, {callId: 'mock-call-id'}, 'mock-correlation-id');
+      sandbox = sinon.createSandbox();
+    });
+  
+    afterEach(() => {
+      sandbox.restore();
+    });
+  
+    it('sendMetrics should send a webex request with callId', () => {
+      assert.notCalled(webex.request);
+  
+      metrics.addMetrics(FAKE_METRICS_ITEM);
+      (metrics as any).sendMetrics();
+  
+      assert.callCount(webex.request, 1);
+      assert.calledWithMatch(webex.request, sinon.match.has('headers', {
+        type: 'webrtcMedia',
+        appId: RTC_METRICS.APP_ID,
+      }));
+      assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].data[0].payload', FAKE_METRICS_ITEM.payload));
+      assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].callId', 'mock-call-id'));
+      assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
+    });
+
+    it('should update the callId correctly', () => {
+      const newCallId = 'new-call-id';
+      metrics.updateCallId(newCallId);
+      assert.strictEqual(metrics.callId, newCallId);
+    });
+  });
+});

package/dist/behavioral/behavioral-metrics.js

@@ -1,199 +0,0 @@
-"use strict";
-
-var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _now = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/date/now"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
-var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-var _lodash = require("lodash");
-var _common = require("@webex/common");
-var _webexCore = require("@webex/webex-core");
-var _metrics = require("../metrics");
-var _config = require("./config");
-var _clientMetricsBatcher = _interopRequireDefault(require("../client-metrics-batcher"));
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-var _BrowserDetection = (0, _common.BrowserDetection)(),
-  getOSVersion = _BrowserDetection.getOSVersion,
-  getBrowserName = _BrowserDetection.getBrowserName,
-  getBrowserVersion = _BrowserDetection.getBrowserVersion;
-
-/**
- * @description Util class to handle Behavioral Metrics
- * @export
- * @class BehavioralMetrics
- */
-var BehavioralMetrics = exports.default = /*#__PURE__*/function (_StatelessWebexPlugin) {
-  (0, _inherits2.default)(BehavioralMetrics, _StatelessWebexPlugin);
-  var _super = _createSuper(BehavioralMetrics);
-  /**
-   * Constructor
-   * @param {any[]} args
-   */
-  function BehavioralMetrics() {
-    var _this;
-    (0, _classCallCheck2.default)(this, BehavioralMetrics);
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    _this = _super.call.apply(_super, [this].concat(args));
-    // @ts-ignore
-    // @ts-ignore
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "clientMetricsBatcher", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "logger", void 0);
-    // to avoid adding @ts-ignore everywhere
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "device", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "version", void 0);
-    _this.logger = _this.webex.logger;
-    // @ts-ignore
-    _this.device = _this.webex.internal.device;
-    // @ts-ignore
-    _this.version = _this.webex.version;
-    // @ts-ignore
-    _this.clientMetricsBatcher = new _clientMetricsBatcher.default({}, {
-      parent: _this.webex
-    });
-    return _this;
-  }
-
-  /**
-   * Returns the deviceId from our registration with WDM.
-   * @returns {string} deviceId or empty string
-   */
-  (0, _createClass2.default)(BehavioralMetrics, [{
-    key: "getDeviceId",
-    value: function getDeviceId() {
-      var url = this.device.url;
-      if (url && url.length !== 0) {
-        var n = url.lastIndexOf('/');
-        if (n !== -1) {
-          return url.substring(n + 1);
-        }
-      }
-      return '';
-    }
-
-    /**
-     * Returns the context object to be submitted with all behavioral metrics.
-     * @returns {BehavioralEventContext}
-     */
-  }, {
-    key: "getContext",
-    value: function getContext() {
-      var context = {
-        app: {
-          version: this.version
-        },
-        device: {
-          id: this.getDeviceId()
-        },
-        locale: window.navigator.language,
-        os: {
-          name: (0, _metrics.getOSNameInternal)(),
-          version: getOSVersion()
-        }
-      };
-      return context;
-    }
-
-    /**
-     * Returns the default tags to be included with all behavioral metrics.
-     * @returns {BehavioralEventPayload}
-     */
-  }, {
-    key: "getDefaultTags",
-    value: function getDefaultTags() {
-      var tags = {
-        browser: getBrowserName(),
-        browserHeight: window.innerHeight,
-        browserVersion: getBrowserVersion(),
-        browserWidth: window.innerWidth,
-        domain: window.location.hostname,
-        inIframe: window.self !== window.top,
-        locale: window.navigator.language,
-        os: (0, _metrics.getOSNameInternal)()
-      };
-      return tags;
-    }
-
-    /**
-     * Creates the object to send to our metrics endpoint for a behavioral event
-     * @param {MetricEventProduct} product
-     * @param {MetricEventAgent} agent
-     * @param {string} target
-     * @param {MetricEventVerb} verb
-     * @returns {BehavioralEventPayload}
-     */
-  }, {
-    key: "createEventObject",
-    value: function createEventObject(_ref) {
-      var product = _ref.product,
-        agent = _ref.agent,
-        target = _ref.target,
-        verb = _ref.verb,
-        payload = _ref.payload;
-      var metricName = "".concat(product, ".").concat(agent, ".").concat(target, ".").concat(verb);
-      var allTags = payload;
-      allTags = (0, _lodash.merge)(allTags, this.getDefaultTags());
-      var event = {
-        context: this.getContext(),
-        metricName: metricName,
-        tags: allTags,
-        timestamp: (0, _now.default)(),
-        type: ['behavioral']
-      };
-      return event;
-    }
-
-    /**
-     * Returns true once we're ready to submit behavioral metrics, after startup.
-     * @returns {boolean} true when deviceId is defined and non-empty
-     */
-  }, {
-    key: "isReadyToSubmitBehavioralEvents",
-    value: function isReadyToSubmitBehavioralEvents() {
-      var deviceId = this.getDeviceId();
-      return deviceId && deviceId.length !== 0;
-    }
-
-    /**
-     * Submit a behavioral metric to our metrics endpoint.
-     * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'
-     * @param {MetricEventAgent} agent the source of the action for this metric
-     * @param {string} target the 'thing' that this metric includes information about
-     * @param {MetricEventVerb} verb the action that this metric includes information about
-     * @param {BehavioralEventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.
-     * @returns {Promise<any>}
-     */
-  }, {
-    key: "submitBehavioralEvent",
-    value: function submitBehavioralEvent(_ref2) {
-      var product = _ref2.product,
-        agent = _ref2.agent,
-        target = _ref2.target,
-        verb = _ref2.verb,
-        payload = _ref2.payload;
-      this.logger.log(_config.BEHAVIORAL_LOG_IDENTIFIER, "BehavioralMetrics: @submitBehavioralEvent. Submit Behavioral event: ".concat(product, ".").concat(agent, ".").concat(target, ".").concat(verb));
-      var behavioralEvent = this.createEventObject({
-        product: product,
-        agent: agent,
-        target: target,
-        verb: verb,
-        payload: payload
-      });
-      return this.clientMetricsBatcher.request(behavioralEvent);
-    }
-  }]);
-  return BehavioralMetrics;
-}(_webexCore.StatelessWebexPlugin);
-//# sourceMappingURL=behavioral-metrics.js.map

package/dist/behavioral/behavioral-metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_lodash","require","_common","_webexCore","_metrics","_config","_clientMetricsBatcher","_interopRequireDefault","_createSuper","Derived","hasNativeReflectConstruct","_isNativeReflectConstruct","_createSuperInternal","Super","_getPrototypeOf2","default","result","NewTarget","constructor","_Reflect$construct","arguments","apply","_possibleConstructorReturn2","Reflect","sham","Proxy","Boolean","prototype","valueOf","call","e","_BrowserDetection","BrowserDetection","getOSVersion","getBrowserName","getBrowserVersion","BehavioralMetrics","exports","_StatelessWebexPlugin","_inherits2","_super","_this","_classCallCheck2","_len","length","args","Array","_key","concat","_defineProperty2","_assertThisInitialized2","logger","webex","device","internal","version","clientMetricsBatcher","ClientMetricsBatcher","parent","_createClass2","key","value","getDeviceId","url","n","lastIndexOf","substring","getContext","context","app","id","locale","window","navigator","language","os","name","getOSNameInternal","getDefaultTags","tags","browser","browserHeight","innerHeight","browserVersion","browserWidth","innerWidth","domain","location","hostname","inIframe","self","top","createEventObject","_ref","product","agent","target","verb","payload","metricName","allTags","merge","event","timestamp","_now","type","isReadyToSubmitBehavioralEvents","deviceId","submitBehavioralEvent","_ref2","log","BEHAVIORAL_LOG_IDENTIFIER","behavioralEvent","request","StatelessWebexPlugin"],"sources":["behavioral-metrics.ts"],"sourcesContent":["import {merge} from 'lodash';\nimport {BrowserDetection} from '@webex/common';\nimport {StatelessWebexPlugin} from '@webex/webex-core';\nimport {getOSNameInternal} from '../metrics';\nimport {BEHAVIORAL_LOG_IDENTIFIER} from './config';\nimport {\n  MetricEventProduct,\n  MetricEventAgent,\n  MetricEventVerb,\n  BehavioralEventContext,\n  BehavioralEvent,\n  BehavioralEventPayload,\n} from '../metrics.types';\nimport ClientMetricsBatcher from '../client-metrics-batcher';\n\nconst {getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();\n\n/**\n * @description Util class to handle Behavioral Metrics\n * @export\n * @class BehavioralMetrics\n */\nexport default class BehavioralMetrics extends StatelessWebexPlugin {\n  // @ts-ignore\n  private clientMetricsBatcher: ClientMetricsBatcher;\n  private logger: any; // to avoid adding @ts-ignore everywhere\n  private device: any;\n  private version: string;\n\n  /**\n   * Constructor\n   * @param {any[]} args\n   */\n  constructor(...args) {\n    super(...args);\n    // @ts-ignore\n    this.logger = this.webex.logger;\n    // @ts-ignore\n    this.device = this.webex.internal.device;\n    // @ts-ignore\n    this.version = this.webex.version;\n    // @ts-ignore\n    this.clientMetricsBatcher = new ClientMetricsBatcher({}, {parent: this.webex});\n  }\n\n  /**\n   * Returns the deviceId from our registration with WDM.\n   * @returns {string} deviceId or empty string\n   */\n  private getDeviceId(): string {\n    const {url} = this.device;\n    if (url && url.length !== 0) {\n      const n = url.lastIndexOf('/');\n      if (n !== -1) {\n        return url.substring(n + 1);\n      }\n    }\n\n    return '';\n  }\n\n  /**\n   * Returns the context object to be submitted with all behavioral metrics.\n   * @returns {BehavioralEventContext}\n   */\n  private getContext(): BehavioralEventContext {\n    const context: BehavioralEventContext = {\n      app: {\n        version: this.version,\n      },\n      device: {\n        id: this.getDeviceId(),\n      },\n      locale: window.navigator.language,\n      os: {\n        name: getOSNameInternal(),\n        version: getOSVersion(),\n      },\n    };\n\n    return context;\n  }\n\n  /**\n   * Returns the default tags to be included with all behavioral metrics.\n   * @returns {BehavioralEventPayload}\n   */\n  private getDefaultTags(): BehavioralEventPayload {\n    const tags = {\n      browser: getBrowserName(),\n      browserHeight: window.innerHeight,\n      browserVersion: getBrowserVersion(),\n      browserWidth: window.innerWidth,\n      domain: window.location.hostname,\n      inIframe: window.self !== window.top,\n      locale: window.navigator.language,\n      os: getOSNameInternal(),\n    };\n\n    return tags;\n  }\n\n  /**\n   * Creates the object to send to our metrics endpoint for a behavioral event\n   * @param {MetricEventProduct} product\n   * @param {MetricEventAgent} agent\n   * @param {string} target\n   * @param {MetricEventVerb} verb\n   * @returns {BehavioralEventPayload}\n   */\n  private createEventObject({\n    product,\n    agent,\n    target,\n    verb,\n    payload,\n  }: {\n    product: MetricEventProduct;\n    agent: MetricEventAgent;\n    target: string;\n    verb: MetricEventVerb;\n    payload?: BehavioralEventPayload;\n  }): BehavioralEvent {\n    const metricName = `${product}.${agent}.${target}.${verb}`;\n    let allTags: BehavioralEventPayload = payload;\n    allTags = merge(allTags, this.getDefaultTags());\n\n    const event: BehavioralEvent = {\n      context: this.getContext(),\n      metricName,\n      tags: allTags,\n      timestamp: Date.now(),\n      type: ['behavioral'],\n    };\n\n    return event;\n  }\n\n  /**\n   * Returns true once we're ready to submit behavioral metrics, after startup.\n   * @returns {boolean} true when deviceId is defined and non-empty\n   */\n  public isReadyToSubmitBehavioralEvents(): boolean {\n    const deviceId = this.getDeviceId();\n\n    return deviceId && deviceId.length !== 0;\n  }\n\n  /**\n   * Submit a behavioral metric to our metrics endpoint.\n   * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'\n   * @param {MetricEventAgent} agent the source of the action for this metric\n   * @param {string} target the 'thing' that this metric includes information about\n   * @param {MetricEventVerb} verb the action that this metric includes information about\n   * @param {BehavioralEventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.\n   * @returns {Promise<any>}\n   */\n  public submitBehavioralEvent({\n    product,\n    agent,\n    target,\n    verb,\n    payload,\n  }: {\n    product: MetricEventProduct;\n    agent: MetricEventAgent;\n    target: string;\n    verb: MetricEventVerb;\n    payload?: BehavioralEventPayload;\n  }) {\n    this.logger.log(\n      BEHAVIORAL_LOG_IDENTIFIER,\n      `BehavioralMetrics: @submitBehavioralEvent. Submit Behavioral event: ${product}.${agent}.${target}.${verb}`\n    );\n    const behavioralEvent = this.createEventObject({product, agent, target, verb, payload});\n\n    return this.clientMetricsBatcher.request(behavioralEvent);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AACA,IAAAI,OAAA,GAAAJ,OAAA;AASA,IAAAK,qBAAA,GAAAC,sBAAA,CAAAN,OAAA;AAA6D,SAAAO,aAAAC,OAAA,QAAAC,yBAAA,GAAAC,yBAAA,oBAAAC,qBAAA,QAAAC,KAAA,OAAAC,gBAAA,CAAAC,OAAA,EAAAN,OAAA,GAAAO,MAAA,MAAAN,yBAAA,QAAAO,SAAA,OAAAH,gBAAA,CAAAC,OAAA,QAAAG,WAAA,EAAAF,MAAA,GAAAG,kBAAA,CAAAN,KAAA,EAAAO,SAAA,EAAAH,SAAA,YAAAD,MAAA,GAAAH,KAAA,CAAAQ,KAAA,OAAAD,SAAA,gBAAAE,2BAAA,CAAAP,OAAA,QAAAC,MAAA;AAAA,SAAAL,0BAAA,eAAAY,OAAA,qBAAAJ,kBAAA,oBAAAA,kBAAA,CAAAK,IAAA,2BAAAC,KAAA,oCAAAC,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAV,kBAAA,CAAAO,OAAA,8CAAAI,CAAA;AAE7D,IAAAC,iBAAA,GAA0D,IAAAC,wBAAgB,EAAC,CAAC;EAArEC,YAAY,GAAAF,iBAAA,CAAZE,YAAY;EAAEC,cAAc,GAAAH,iBAAA,CAAdG,cAAc;EAAEC,iBAAiB,GAAAJ,iBAAA,CAAjBI,iBAAiB;;AAEtD;AACA;AACA;AACA;AACA;AAJA,IAKqBC,iBAAiB,GAAAC,OAAA,CAAAtB,OAAA,0BAAAuB,qBAAA;EAAA,IAAAC,UAAA,CAAAxB,OAAA,EAAAqB,iBAAA,EAAAE,qBAAA;EAAA,IAAAE,MAAA,GAAAhC,YAAA,CAAA4B,iBAAA;EAOpC;AACF;AACA;AACA;EACE,SAAAA,kBAAA,EAAqB;IAAA,IAAAK,KAAA;IAAA,IAAAC,gBAAA,CAAA3B,OAAA,QAAAqB,iBAAA;IAAA,SAAAO,IAAA,GAAAvB,SAAA,CAAAwB,MAAA,EAANC,IAAI,OAAAC,KAAA,CAAAH,IAAA,GAAAI,IAAA,MAAAA,IAAA,GAAAJ,IAAA,EAAAI,IAAA;MAAJF,IAAI,CAAAE,IAAA,IAAA3B,SAAA,CAAA2B,IAAA;IAAA;IACjBN,KAAA,GAAAD,MAAA,CAAAX,IAAA,CAAAR,KAAA,CAAAmB,MAAA,SAAAQ,MAAA,CAASH,IAAI;IACb;IAZF;IAAA,IAAAI,gBAAA,CAAAlC,OAAA,MAAAmC,uBAAA,CAAAnC,OAAA,EAAA0B,KAAA;IAAA,IAAAQ,gBAAA,CAAAlC,OAAA,MAAAmC,uBAAA,CAAAnC,OAAA,EAAA0B,KAAA;IAEqB;IAAA,IAAAQ,gBAAA,CAAAlC,OAAA,MAAAmC,uBAAA,CAAAnC,OAAA,EAAA0B,KAAA;IAAA,IAAAQ,gBAAA,CAAAlC,OAAA,MAAAmC,uBAAA,CAAAnC,OAAA,EAAA0B,KAAA;IAWnBA,KAAA,CAAKU,MAAM,GAAGV,KAAA,CAAKW,KAAK,CAACD,MAAM;IAC/B;IACAV,KAAA,CAAKY,MAAM,GAAGZ,KAAA,CAAKW,KAAK,CAACE,QAAQ,CAACD,MAAM;IACxC;IACAZ,KAAA,CAAKc,OAAO,GAAGd,KAAA,CAAKW,KAAK,CAACG,OAAO;IACjC;IACAd,KAAA,CAAKe,oBAAoB,GAAG,IAAIC,6BAAoB,CAAC,CAAC,CAAC,EAAE;MAACC,MAAM,EAAEjB,KAAA,CAAKW;IAAK,CAAC,CAAC;IAAC,OAAAX,KAAA;EACjF;;EAEA;AACF;AACA;AACA;EAHE,IAAAkB,aAAA,CAAA5C,OAAA,EAAAqB,iBAAA;IAAAwB,GAAA;IAAAC,KAAA,EAIA,SAAAC,YAAA,EAA8B;MAC5B,IAAOC,GAAG,GAAI,IAAI,CAACV,MAAM,CAAlBU,GAAG;MACV,IAAIA,GAAG,IAAIA,GAAG,CAACnB,MAAM,KAAK,CAAC,EAAE;QAC3B,IAAMoB,CAAC,GAAGD,GAAG,CAACE,WAAW,CAAC,GAAG,CAAC;QAC9B,IAAID,CAAC,KAAK,CAAC,CAAC,EAAE;UACZ,OAAOD,GAAG,CAACG,SAAS,CAACF,CAAC,GAAG,CAAC,CAAC;QAC7B;MACF;MAEA,OAAO,EAAE;IACX;;IAEA;AACF;AACA;AACA;EAHE;IAAAJ,GAAA;IAAAC,KAAA,EAIA,SAAAM,WAAA,EAA6C;MAC3C,IAAMC,OAA+B,GAAG;QACtCC,GAAG,EAAE;UACHd,OAAO,EAAE,IAAI,CAACA;QAChB,CAAC;QACDF,MAAM,EAAE;UACNiB,EAAE,EAAE,IAAI,CAACR,WAAW,CAAC;QACvB,CAAC;QACDS,MAAM,EAAEC,MAAM,CAACC,SAAS,CAACC,QAAQ;QACjCC,EAAE,EAAE;UACFC,IAAI,EAAE,IAAAC,0BAAiB,EAAC,CAAC;UACzBtB,OAAO,EAAEtB,YAAY,CAAC;QACxB;MACF,CAAC;MAED,OAAOmC,OAAO;IAChB;;IAEA;AACF;AACA;AACA;EAHE;IAAAR,GAAA;IAAAC,KAAA,EAIA,SAAAiB,eAAA,EAAiD;MAC/C,IAAMC,IAAI,GAAG;QACXC,OAAO,EAAE9C,cAAc,CAAC,CAAC;QACzB+C,aAAa,EAAET,MAAM,CAACU,WAAW;QACjCC,cAAc,EAAEhD,iBAAiB,CAAC,CAAC;QACnCiD,YAAY,EAAEZ,MAAM,CAACa,UAAU;QAC/BC,MAAM,EAAEd,MAAM,CAACe,QAAQ,CAACC,QAAQ;QAChCC,QAAQ,EAAEjB,MAAM,CAACkB,IAAI,KAAKlB,MAAM,CAACmB,GAAG;QACpCpB,MAAM,EAAEC,MAAM,CAACC,SAAS,CAACC,QAAQ;QACjCC,EAAE,EAAE,IAAAE,0BAAiB,EAAC;MACxB,CAAC;MAED,OAAOE,IAAI;IACb;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAnB,GAAA;IAAAC,KAAA,EAQA,SAAA+B,kBAAAC,IAAA,EAYoB;MAAA,IAXlBC,OAAO,GAAAD,IAAA,CAAPC,OAAO;QACPC,KAAK,GAAAF,IAAA,CAALE,KAAK;QACLC,MAAM,GAAAH,IAAA,CAANG,MAAM;QACNC,IAAI,GAAAJ,IAAA,CAAJI,IAAI;QACJC,OAAO,GAAAL,IAAA,CAAPK,OAAO;MAQP,IAAMC,UAAU,MAAAnD,MAAA,CAAM8C,OAAO,OAAA9C,MAAA,CAAI+C,KAAK,OAAA/C,MAAA,CAAIgD,MAAM,OAAAhD,MAAA,CAAIiD,IAAI,CAAE;MAC1D,IAAIG,OAA+B,GAAGF,OAAO;MAC7CE,OAAO,GAAG,IAAAC,aAAK,EAACD,OAAO,EAAE,IAAI,CAACtB,cAAc,CAAC,CAAC,CAAC;MAE/C,IAAMwB,KAAsB,GAAG;QAC7BlC,OAAO,EAAE,IAAI,CAACD,UAAU,CAAC,CAAC;QAC1BgC,UAAU,EAAVA,UAAU;QACVpB,IAAI,EAAEqB,OAAO;QACbG,SAAS,EAAE,IAAAC,IAAA,CAAAzF,OAAA,EAAS,CAAC;QACrB0F,IAAI,EAAE,CAAC,YAAY;MACrB,CAAC;MAED,OAAOH,KAAK;IACd;;IAEA;AACF;AACA;AACA;EAHE;IAAA1C,GAAA;IAAAC,KAAA,EAIA,SAAA6C,gCAAA,EAAkD;MAChD,IAAMC,QAAQ,GAAG,IAAI,CAAC7C,WAAW,CAAC,CAAC;MAEnC,OAAO6C,QAAQ,IAAIA,QAAQ,CAAC/D,MAAM,KAAK,CAAC;IAC1C;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EARE;IAAAgB,GAAA;IAAAC,KAAA,EASA,SAAA+C,sBAAAC,KAAA,EAYG;MAAA,IAXDf,OAAO,GAAAe,KAAA,CAAPf,OAAO;QACPC,KAAK,GAAAc,KAAA,CAALd,KAAK;QACLC,MAAM,GAAAa,KAAA,CAANb,MAAM;QACNC,IAAI,GAAAY,KAAA,CAAJZ,IAAI;QACJC,OAAO,GAAAW,KAAA,CAAPX,OAAO;MAQP,IAAI,CAAC/C,MAAM,CAAC2D,GAAG,CACbC,iCAAyB,yEAAA/D,MAAA,CAC8C8C,OAAO,OAAA9C,MAAA,CAAI+C,KAAK,OAAA/C,MAAA,CAAIgD,MAAM,OAAAhD,MAAA,CAAIiD,IAAI,CAC3G,CAAC;MACD,IAAMe,eAAe,GAAG,IAAI,CAACpB,iBAAiB,CAAC;QAACE,OAAO,EAAPA,OAAO;QAAEC,KAAK,EAALA,KAAK;QAAEC,MAAM,EAANA,MAAM;QAAEC,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;MAEvF,OAAO,IAAI,CAAC1C,oBAAoB,CAACyD,OAAO,CAACD,eAAe,CAAC;IAC3D;EAAC;EAAA,OAAA5E,iBAAA;AAAA,EA3J4C8E,+BAAoB"}

package/dist/behavioral/config.js

@@ -1,11 +0,0 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.BEHAVIORAL_LOG_IDENTIFIER = void 0;
-/* eslint-disable import/prefer-default-export */
-
-var BEHAVIORAL_LOG_IDENTIFIER = exports.BEHAVIORAL_LOG_IDENTIFIER = 'behavioral-events -> ';
-//# sourceMappingURL=config.js.map

package/dist/behavioral/config.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["BEHAVIORAL_LOG_IDENTIFIER","exports"],"sources":["config.ts"],"sourcesContent":["/* eslint-disable import/prefer-default-export */\n\nexport const BEHAVIORAL_LOG_IDENTIFIER = 'behavioral-events -> ';\n"],"mappings":";;;;;;;AAAA;;AAEO,IAAMA,yBAAyB,GAAAC,OAAA,CAAAD,yBAAA,GAAG,uBAAuB"}

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

@@ -1,63 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-import { MetricEventProduct, MetricEventAgent, MetricEventVerb, BehavioralEventPayload } from '../metrics.types';
-/**
- * @description Util class to handle Behavioral Metrics
- * @export
- * @class BehavioralMetrics
- */
-export default class BehavioralMetrics extends StatelessWebexPlugin {
-    private clientMetricsBatcher;
-    private logger;
-    private device;
-    private version;
-    /**
-     * Constructor
-     * @param {any[]} args
-     */
-    constructor(...args: any[]);
-    /**
-     * Returns the deviceId from our registration with WDM.
-     * @returns {string} deviceId or empty string
-     */
-    private getDeviceId;
-    /**
-     * Returns the context object to be submitted with all behavioral metrics.
-     * @returns {BehavioralEventContext}
-     */
-    private getContext;
-    /**
-     * Returns the default tags to be included with all behavioral metrics.
-     * @returns {BehavioralEventPayload}
-     */
-    private getDefaultTags;
-    /**
-     * Creates the object to send to our metrics endpoint for a behavioral event
-     * @param {MetricEventProduct} product
-     * @param {MetricEventAgent} agent
-     * @param {string} target
-     * @param {MetricEventVerb} verb
-     * @returns {BehavioralEventPayload}
-     */
-    private createEventObject;
-    /**
-     * Returns true once we're ready to submit behavioral metrics, after startup.
-     * @returns {boolean} true when deviceId is defined and non-empty
-     */
-    isReadyToSubmitBehavioralEvents(): boolean;
-    /**
-     * Submit a behavioral metric to our metrics endpoint.
-     * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'
-     * @param {MetricEventAgent} agent the source of the action for this metric
-     * @param {string} target the 'thing' that this metric includes information about
-     * @param {MetricEventVerb} verb the action that this metric includes information about
-     * @param {BehavioralEventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.
-     * @returns {Promise<any>}
-     */
-    submitBehavioralEvent({ product, agent, target, verb, payload, }: {
-        product: MetricEventProduct;
-        agent: MetricEventAgent;
-        target: string;
-        verb: MetricEventVerb;
-        payload?: BehavioralEventPayload;
-    }): any;
-}

package/dist/types/behavioral/config.d.ts

@@ -1 +0,0 @@
-export declare const BEHAVIORAL_LOG_IDENTIFIER = "behavioral-events -> ";