@webex/internal-plugin-metrics 3.12.0-next.3 → 3.12.0-next.30

package/dist/prelogin-metrics-batcher.js

@@ -7,6 +7,7 @@ _Object$defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _isArray = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/array/is-array"));
 var _lodash = require("lodash");
 var _batcher = _interopRequireDefault(require("./batcher"));
 var _callDiagnosticMetrics = require("./call-diagnostic/call-diagnostic-metrics.util");
@@ -70,11 +71,33 @@ var PreLoginMetricsBatcher = _batcher.default.extend({
       waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout
     }).then(function (res) {
       _this.webex.logger.log(PRE_LOGIN_METRICS_IDENTIFIER, "PreLoginMetricsBatcher: @submitHttpRequest#".concat(batchId, ". Request successful."));
+      _this.handleHttpResponseStatus(res === null || res === void 0 ? void 0 : res.statusCode, payload);
       return res;
     }).catch(function (err) {
       _this.webex.logger.error(PRE_LOGIN_METRICS_IDENTIFIER, "PreLoginMetricsBatcher: @submitHttpRequest#".concat(batchId, ". Request failed:"), "error: ".concat((0, _utils.generateCommonErrorMetadata)(err)));
+      _this.handleHttpResponseStatus(err === null || err === void 0 ? void 0 : err.statusCode, payload);
       return _promise.default.reject(err);
     });
+  },
+  /**
+   * React to the HTTP status code returned by the prelogin metrics endpoint.
+   * Only items submitted with `markTelemetryOptOutOnResponse: true` opt into
+   * this behavior.
+   * @param {number | undefined} statusCode
+   * @param {any[]} payload Items flushed in this HTTP batch.
+   * @returns {void}
+   */
+  handleHttpResponseStatus: function handleHttpResponseStatus(statusCode, payload) {
+    var shouldMark = (0, _isArray.default)(payload) && payload.some(function (item) {
+      return (item === null || item === void 0 ? void 0 : item.markTelemetryOptOutOnResponse) === true;
+    });
+    if (!shouldMark) {
+      return;
+    }
+    if (statusCode === 200) {
+      var _this$webex$internal$, _this$webex$internal$2;
+      (_this$webex$internal$ = this.webex.internal.newMetrics) === null || _this$webex$internal$ === void 0 ? void 0 : (_this$webex$internal$2 = _this$webex$internal$.callDiagnosticMetrics) === null || _this$webex$internal$2 === void 0 ? void 0 : _this$webex$internal$2.setIsTelemetryOptOutAutomatic(true);
+    }
   }
 });
 var _default = exports.default = PreLoginMetricsBatcher;

package/dist/prelogin-metrics-batcher.js.map

@@ -1 +1 @@
-{"version":3,"names":["_lodash","require","_batcher","_interopRequireDefault","_callDiagnosticMetrics","_utils","PRE_LOGIN_METRICS_IDENTIFIER","PreLoginMetricsBatcher","Batcher","extend","namespace","preLoginId","undefined","savePreLoginId","prepareItem","item","_promise","default","resolve","prepareDiagnosticMetricItem","webex","prepareRequest","queue","forEach","eventPayload","originTime","sent","Date","toISOString","submitHttpRequest","payload","_this","batchId","uniqueId","logger","error","concat","reject","Error","request","method","service","resource","headers","authorization","body","metrics","waitForServiceTimeout","config","then","res","log","catch","err","generateCommonErrorMetadata","_default","exports"],"sources":["prelogin-metrics-batcher.ts"],"sourcesContent":["import {uniqueId} from 'lodash';\nimport Batcher from './batcher';\nimport {prepareDiagnosticMetricItem} from './call-diagnostic/call-diagnostic-metrics.util';\nimport {generateCommonErrorMetadata} from './utils';\n\nconst PRE_LOGIN_METRICS_IDENTIFIER = 'Pre Login Metrics -->';\n\nconst PreLoginMetricsBatcher = Batcher.extend({\n  namespace: 'Metrics',\n  preLoginId: undefined,\n\n  /**\n   * Save the pre-login ID.\n   * @param {string} preLoginId The pre-login ID to be saved.\n   * @returns {void}\n   */\n  savePreLoginId(preLoginId) {\n    this.preLoginId = preLoginId;\n  },\n\n  /**\n   * Prepare item\n   * @param {any} item\n   * @returns {Promise<any>}\n   */\n  prepareItem(item) {\n    return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));\n  },\n\n  /**\n   * Prepare request, add time sensitive date etc.\n   * @param {any[]} queue\n   * @returns {Promise<any[]>}\n   */\n  prepareRequest(queue) {\n    // Add sent timestamp\n    queue.forEach((item) => {\n      item.eventPayload.originTime = item.eventPayload.originTime || {};\n      item.eventPayload.originTime.sent = new Date().toISOString();\n    });\n\n    return Promise.resolve(queue);\n  },\n\n  /**\n   *\n   * @param {any} payload\n   * @returns {Promise<any>}\n   */\n  submitHttpRequest(payload: any) {\n    const batchId = uniqueId('prelogin-batch-');\n    if (this.preLoginId === undefined) {\n      this.webex.logger.error(\n        PRE_LOGIN_METRICS_IDENTIFIER,\n        `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. PreLoginId is not set.`\n      );\n\n      return Promise.reject(new Error('PreLoginId is not set.'));\n    }\n\n    return this.webex\n      .request({\n        method: 'POST',\n        service: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: false,\n          'x-prelogin-userid': this.preLoginId,\n        },\n        body: {\n          metrics: payload,\n        },\n        waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout,\n      })\n      .then((res) => {\n        this.webex.logger.log(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`\n        );\n\n        return res;\n      })\n      .catch((err) => {\n        this.webex.logger.error(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request failed:`,\n          `error: ${generateCommonErrorMetadata(err)}`\n        );\n\n        return Promise.reject(err);\n      });\n  },\n});\n\nexport default PreLoginMetricsBatcher;\n"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,sBAAA,GAAAH,OAAA;AACA,IAAAI,MAAA,GAAAJ,OAAA;AAEA,IAAMK,4BAA4B,GAAG,uBAAuB;AAE5D,IAAMC,sBAAsB,GAAGC,gBAAO,CAACC,MAAM,CAAC;EAC5CC,SAAS,EAAE,SAAS;EACpBC,UAAU,EAAEC,SAAS;EAErB;AACF;AACA;AACA;AACA;EACEC,cAAc,WAAdA,cAAcA,CAACF,UAAU,EAAE;IACzB,IAAI,CAACA,UAAU,GAAGA,UAAU;EAC9B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEG,WAAW,WAAXA,WAAWA,CAACC,IAAI,EAAE;IAChB,OAAOC,QAAA,CAAAC,OAAA,CAAQC,OAAO,CAAC,IAAAC,kDAA2B,EAAC,IAAI,CAACC,KAAK,EAAEL,IAAI,CAAC,CAAC;EACvE,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,cAAc,WAAdA,cAAcA,CAACC,KAAK,EAAE;IACpB;IACAA,KAAK,CAACC,OAAO,CAAC,UAACR,IAAI,EAAK;MACtBA,IAAI,CAACS,YAAY,CAACC,UAAU,GAAGV,IAAI,CAACS,YAAY,CAACC,UAAU,IAAI,CAAC,CAAC;MACjEV,IAAI,CAACS,YAAY,CAACC,UAAU,CAACC,IAAI,GAAG,IAAIC,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC;IAC9D,CAAC,CAAC;IAEF,OAAOZ,QAAA,CAAAC,OAAA,CAAQC,OAAO,CAACI,KAAK,CAAC;EAC/B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEO,iBAAiB,WAAjBA,iBAAiBA,CAACC,OAAY,EAAE;IAAA,IAAAC,KAAA;IAC9B,IAAMC,OAAO,GAAG,IAAAC,gBAAQ,EAAC,iBAAiB,CAAC;IAC3C,IAAI,IAAI,CAACtB,UAAU,KAAKC,SAAS,EAAE;MACjC,IAAI,CAACQ,KAAK,CAACc,MAAM,CAACC,KAAK,CACrB7B,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,6BACvD,CAAC;MAED,OAAOhB,QAAA,CAAAC,OAAA,CAAQoB,MAAM,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5D;IAEA,OAAO,IAAI,CAAClB,KAAK,CACdmB,OAAO,CAAC;MACPC,MAAM,EAAE,MAAM;MACdC,OAAO,EAAE,SAAS;MAClBC,QAAQ,EAAE,wBAAwB;MAClCC,OAAO,EAAE;QACPC,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,IAAI,CAACjC;MAC5B,CAAC;MACDkC,IAAI,EAAE;QACJC,OAAO,EAAEhB;MACX,CAAC;MACDiB,qBAAqB,EAAE,IAAI,CAAC3B,KAAK,CAAC4B,MAAM,CAACF,OAAO,CAACC;IACnD,CAAC,CAAC,CACDE,IAAI,CAAC,UAACC,GAAG,EAAK;MACbnB,KAAI,CAACX,KAAK,CAACc,MAAM,CAACiB,GAAG,CACnB7C,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,0BACvD,CAAC;MAED,OAAOkB,GAAG;IACZ,CAAC,CAAC,CACDE,KAAK,CAAC,UAACC,GAAG,EAAK;MACdtB,KAAI,CAACX,KAAK,CAACc,MAAM,CAACC,KAAK,CACrB7B,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,kCAAAI,MAAA,CAC3C,IAAAkB,kCAA2B,EAACD,GAAG,CAAC,CAC5C,CAAC;MAED,OAAOrC,QAAA,CAAAC,OAAA,CAAQoB,MAAM,CAACgB,GAAG,CAAC;IAC5B,CAAC,CAAC;EACN;AACF,CAAC,CAAC;AAAC,IAAAE,QAAA,GAAAC,OAAA,CAAAvC,OAAA,GAEYV,sBAAsB","ignoreList":[]}
+{"version":3,"names":["_lodash","require","_batcher","_interopRequireDefault","_callDiagnosticMetrics","_utils","PRE_LOGIN_METRICS_IDENTIFIER","PreLoginMetricsBatcher","Batcher","extend","namespace","preLoginId","undefined","savePreLoginId","prepareItem","item","_promise","default","resolve","prepareDiagnosticMetricItem","webex","prepareRequest","queue","forEach","eventPayload","originTime","sent","Date","toISOString","submitHttpRequest","payload","_this","batchId","uniqueId","logger","error","concat","reject","Error","request","method","service","resource","headers","authorization","body","metrics","waitForServiceTimeout","config","then","res","log","handleHttpResponseStatus","statusCode","catch","err","generateCommonErrorMetadata","shouldMark","_isArray","some","markTelemetryOptOutOnResponse","_this$webex$internal$","_this$webex$internal$2","internal","newMetrics","callDiagnosticMetrics","setIsTelemetryOptOutAutomatic","_default","exports"],"sources":["prelogin-metrics-batcher.ts"],"sourcesContent":["import {uniqueId} from 'lodash';\nimport Batcher from './batcher';\nimport {prepareDiagnosticMetricItem} from './call-diagnostic/call-diagnostic-metrics.util';\nimport {generateCommonErrorMetadata} from './utils';\n\nconst PRE_LOGIN_METRICS_IDENTIFIER = 'Pre Login Metrics -->';\n\nconst PreLoginMetricsBatcher = Batcher.extend({\n  namespace: 'Metrics',\n  preLoginId: undefined,\n\n  /**\n   * Save the pre-login ID.\n   * @param {string} preLoginId The pre-login ID to be saved.\n   * @returns {void}\n   */\n  savePreLoginId(preLoginId) {\n    this.preLoginId = preLoginId;\n  },\n\n  /**\n   * Prepare item\n   * @param {any} item\n   * @returns {Promise<any>}\n   */\n  prepareItem(item) {\n    return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));\n  },\n\n  /**\n   * Prepare request, add time sensitive date etc.\n   * @param {any[]} queue\n   * @returns {Promise<any[]>}\n   */\n  prepareRequest(queue) {\n    // Add sent timestamp\n    queue.forEach((item) => {\n      item.eventPayload.originTime = item.eventPayload.originTime || {};\n      item.eventPayload.originTime.sent = new Date().toISOString();\n    });\n\n    return Promise.resolve(queue);\n  },\n\n  /**\n   *\n   * @param {any} payload\n   * @returns {Promise<any>}\n   */\n  submitHttpRequest(payload: any) {\n    const batchId = uniqueId('prelogin-batch-');\n    if (this.preLoginId === undefined) {\n      this.webex.logger.error(\n        PRE_LOGIN_METRICS_IDENTIFIER,\n        `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. PreLoginId is not set.`\n      );\n\n      return Promise.reject(new Error('PreLoginId is not set.'));\n    }\n\n    return this.webex\n      .request({\n        method: 'POST',\n        service: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: false,\n          'x-prelogin-userid': this.preLoginId,\n        },\n        body: {\n          metrics: payload,\n        },\n        waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout,\n      })\n      .then((res) => {\n        this.webex.logger.log(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`\n        );\n\n        this.handleHttpResponseStatus(res?.statusCode, payload);\n\n        return res;\n      })\n      .catch((err) => {\n        this.webex.logger.error(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request failed:`,\n          `error: ${generateCommonErrorMetadata(err)}`\n        );\n\n        this.handleHttpResponseStatus(err?.statusCode, payload);\n\n        return Promise.reject(err);\n      });\n  },\n\n  /**\n   * React to the HTTP status code returned by the prelogin metrics endpoint.\n   * Only items submitted with `markTelemetryOptOutOnResponse: true` opt into\n   * this behavior.\n   * @param {number | undefined} statusCode\n   * @param {any[]} payload Items flushed in this HTTP batch.\n   * @returns {void}\n   */\n  handleHttpResponseStatus(statusCode: number | undefined, payload: any[]) {\n    const shouldMark =\n      Array.isArray(payload) &&\n      payload.some((item) => item?.markTelemetryOptOutOnResponse === true);\n\n    if (!shouldMark) {\n      return;\n    }\n\n    if (statusCode === 200) {\n      this.webex.internal.newMetrics?.callDiagnosticMetrics?.setIsTelemetryOptOutAutomatic(true);\n    }\n  },\n});\n\nexport default PreLoginMetricsBatcher;\n"],"mappings":";;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,sBAAA,GAAAH,OAAA;AACA,IAAAI,MAAA,GAAAJ,OAAA;AAEA,IAAMK,4BAA4B,GAAG,uBAAuB;AAE5D,IAAMC,sBAAsB,GAAGC,gBAAO,CAACC,MAAM,CAAC;EAC5CC,SAAS,EAAE,SAAS;EACpBC,UAAU,EAAEC,SAAS;EAErB;AACF;AACA;AACA;AACA;EACEC,cAAc,WAAdA,cAAcA,CAACF,UAAU,EAAE;IACzB,IAAI,CAACA,UAAU,GAAGA,UAAU;EAC9B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEG,WAAW,WAAXA,WAAWA,CAACC,IAAI,EAAE;IAChB,OAAOC,QAAA,CAAAC,OAAA,CAAQC,OAAO,CAAC,IAAAC,kDAA2B,EAAC,IAAI,CAACC,KAAK,EAAEL,IAAI,CAAC,CAAC;EACvE,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,cAAc,WAAdA,cAAcA,CAACC,KAAK,EAAE;IACpB;IACAA,KAAK,CAACC,OAAO,CAAC,UAACR,IAAI,EAAK;MACtBA,IAAI,CAACS,YAAY,CAACC,UAAU,GAAGV,IAAI,CAACS,YAAY,CAACC,UAAU,IAAI,CAAC,CAAC;MACjEV,IAAI,CAACS,YAAY,CAACC,UAAU,CAACC,IAAI,GAAG,IAAIC,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC;IAC9D,CAAC,CAAC;IAEF,OAAOZ,QAAA,CAAAC,OAAA,CAAQC,OAAO,CAACI,KAAK,CAAC;EAC/B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEO,iBAAiB,WAAjBA,iBAAiBA,CAACC,OAAY,EAAE;IAAA,IAAAC,KAAA;IAC9B,IAAMC,OAAO,GAAG,IAAAC,gBAAQ,EAAC,iBAAiB,CAAC;IAC3C,IAAI,IAAI,CAACtB,UAAU,KAAKC,SAAS,EAAE;MACjC,IAAI,CAACQ,KAAK,CAACc,MAAM,CAACC,KAAK,CACrB7B,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,6BACvD,CAAC;MAED,OAAOhB,QAAA,CAAAC,OAAA,CAAQoB,MAAM,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5D;IAEA,OAAO,IAAI,CAAClB,KAAK,CACdmB,OAAO,CAAC;MACPC,MAAM,EAAE,MAAM;MACdC,OAAO,EAAE,SAAS;MAClBC,QAAQ,EAAE,wBAAwB;MAClCC,OAAO,EAAE;QACPC,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,IAAI,CAACjC;MAC5B,CAAC;MACDkC,IAAI,EAAE;QACJC,OAAO,EAAEhB;MACX,CAAC;MACDiB,qBAAqB,EAAE,IAAI,CAAC3B,KAAK,CAAC4B,MAAM,CAACF,OAAO,CAACC;IACnD,CAAC,CAAC,CACDE,IAAI,CAAC,UAACC,GAAG,EAAK;MACbnB,KAAI,CAACX,KAAK,CAACc,MAAM,CAACiB,GAAG,CACnB7C,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,0BACvD,CAAC;MAEDD,KAAI,CAACqB,wBAAwB,CAACF,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAEG,UAAU,EAAEvB,OAAO,CAAC;MAEvD,OAAOoB,GAAG;IACZ,CAAC,CAAC,CACDI,KAAK,CAAC,UAACC,GAAG,EAAK;MACdxB,KAAI,CAACX,KAAK,CAACc,MAAM,CAACC,KAAK,CACrB7B,4BAA4B,gDAAA8B,MAAA,CACkBJ,OAAO,kCAAAI,MAAA,CAC3C,IAAAoB,kCAA2B,EAACD,GAAG,CAAC,CAC5C,CAAC;MAEDxB,KAAI,CAACqB,wBAAwB,CAACG,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAEF,UAAU,EAAEvB,OAAO,CAAC;MAEvD,OAAOd,QAAA,CAAAC,OAAA,CAAQoB,MAAM,CAACkB,GAAG,CAAC;IAC5B,CAAC,CAAC;EACN,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEH,wBAAwB,WAAxBA,wBAAwBA,CAACC,UAA8B,EAAEvB,OAAc,EAAE;IACvE,IAAM2B,UAAU,GACd,IAAAC,QAAA,CAAAzC,OAAA,EAAca,OAAO,CAAC,IACtBA,OAAO,CAAC6B,IAAI,CAAC,UAAC5C,IAAI;MAAA,OAAK,CAAAA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAE6C,6BAA6B,MAAK,IAAI;IAAA,EAAC;IAEtE,IAAI,CAACH,UAAU,EAAE;MACf;IACF;IAEA,IAAIJ,UAAU,KAAK,GAAG,EAAE;MAAA,IAAAQ,qBAAA,EAAAC,sBAAA;MACtB,CAAAD,qBAAA,OAAI,CAACzC,KAAK,CAAC2C,QAAQ,CAACC,UAAU,cAAAH,qBAAA,wBAAAC,sBAAA,GAA9BD,qBAAA,CAAgCI,qBAAqB,cAAAH,sBAAA,uBAArDA,sBAAA,CAAuDI,6BAA6B,CAAC,IAAI,CAAC;IAC5F;EACF;AACF,CAAC,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAnD,OAAA,GAEYV,sBAAsB","ignoreList":[]}

package/dist/types/call-diagnostic/call-diagnostic-metrics-latencies.d.ts

@@ -149,6 +149,15 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * @returns - latency
      */
     getStayLobbyTime(): number;
+    /**
+     * Stay lobby time capped by a certain timestamp.
+     * This is to handle the case where the target end timestamp could happen before the lobby is exited,
+     * for example media-engine.ready or client.ice.end
+     * This is supposed to be called AFTER the end timestamp happens
+     * @param endTimestampKey name of the target end event
+     * @returns - latency
+     */
+    getStayLobbyTimeCappedBy(endTimestampKey: MetricEventNames): number;
     /**
      * Page JMT
      * @returns - latency

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -36,6 +36,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private isMercuryConnected;
     private eventLimitTracker;
     private eventLimitWarningsLogged;
+    private isTelemetryOptOutManual;
+    private isTelemetryOptOutAutomatic;
     validator: (options: {
         type: 'mqe' | 'ce';
         event: Event;
@@ -53,6 +55,21 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns one of 'login-ci','unverified-guest', null
      */
     getCurLoginType(): "unverified-guest" | "login-ci";
+    /**
+     * Returns the telemetryOptOut value of the current user
+     * @returns one of 'manual', 'automatic', undefined
+     */
+    getTelemetryOptOut(): "manual" | "automatic";
+    /**
+     * Sets the manual telemetry opt-out status for the current user
+     * @param value - boolean value indicating manual telemetry opt-out status
+     */
+    setIsTelemetryOptOutManual(value: boolean): void;
+    /**
+     * Sets the automatic telemetry opt-out status for the current user
+     * @param value - boolean value indicating automatic telemetry opt-out status
+     */
+    setIsTelemetryOptOutAutomatic(value: boolean): void;
     /**
      * Returns if the meeting has converged architecture enabled
      * @param options.meetingId
@@ -84,6 +101,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
+        upgradeSource?: string;
         instanceId?: string;
         networkType: "wifi" | "ethernet" | "cellular" | "unknown";
         localIP?: string;
@@ -137,11 +155,12 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
                 architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64" | "armv9" | "armv8" | "armv7" | "armv6" | "x86_64" | "x86_32";
                 staticPerformance?: string;
                 clockSpeedGigaHertz?: number;
-                additionalProperties?: false;
+                additionalProperties?: never;
             };
             shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
             videoDisplayMode?: "grid-view" | "active-speaker-view";
-            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery";
+            videoLayoutType?: "auto" | "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery" | "autoWithShare";
+            appliedLayout?: "auto" | "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery" | "autoWithShare";
             videoRenderType?: "wme" | "client_d3d" | "client_gdi";
             vdiInfo?: {};
             is64BitsClient?: boolean;
@@ -153,13 +172,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             vendorId?: string;
             staticPerformanceLevel?: string;
             staticPerformanceScore?: number;
-            additionalProperties?: false;
+            preInstalledTime?: string;
+            preInstalledType?: "installer" | "launcher" | "app";
+            preInstalledVersion?: string;
+            additionalProperties?: never;
         };
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
         serviceVersion?: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Gather identifier details for call diagnostic payload.
@@ -183,7 +205,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -200,6 +222,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -227,7 +250,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -255,7 +278,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
@@ -273,7 +296,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -290,6 +313,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -317,7 +341,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -345,7 +369,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
@@ -363,7 +387,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -380,6 +404,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -407,7 +432,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -435,7 +460,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Create diagnostic event, which can hold client event, feature event or MQE event data.
@@ -606,6 +631,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * Prepare the event and send the request to metrics-a service, pre login.
      * @param event
      * @param preLoginId
+     * @param markTelemetryOptOutOnResponse
      * @returns
      */
     submitToCallDiagnosticsPreLogin: (event: Event, preLoginId?: string) => Promise<any>;

package/dist/types/call-diagnostic/config.d.ts

@@ -102,11 +102,13 @@ export declare const ERROR_DESCRIPTIONS: {
     WEBRTC_API_NOT_AVAILABLE: string;
     WDM_RESTRICTED_REGION: string;
     USER_NOT_ALLOWED_JOIN_WEBINAR: string;
+    INVALID_MEETING_INFO: string;
 };
 export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     58400: number;
     99002: number;
     99009: number;
+    99019: number;
     58500: number;
     400001: number;
     403004: number;
@@ -134,6 +136,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     423001: number;
     423005: number;
     423006: number;
+    423008: number;
     423010: number;
     423012: number;
     423013: number;
@@ -147,6 +150,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     403037: number;
     403003: number;
     403030: number;
+    403106: number;
     2403001: number;
     2403002: number;
     2403003: number;

package/dist/types/config.d.ts

@@ -12,6 +12,7 @@ declare namespace _default {
         const batcherMaxCalls: number;
         const batcherMaxWait: number;
         const batcherRetryPlateau: number;
+        const batcherRetryOnNetworkError: boolean;
         const waitForServiceTimeout: number;
     }
     export { metrics_1 as metrics };

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

@@ -42,7 +42,7 @@ export type SubmitMQEOptions = {
     globalMeetingId?: string;
 };
 export type InternalEvent = {
-    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | 'internal.client.meeting.click.joinbutton' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.interstitial-window.click.joinbutton' | 'internal.client.add-media.turn-discovery.start' | 'internal.client.add-media.turn-discovery.end' | 'internal.client.share.initiated' | 'internal.client.share.stopped';
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.interstitial-window.click.joinbutton' | 'internal.client.add-media.turn-discovery.start' | 'internal.client.add-media.turn-discovery.end' | 'internal.client.share.initiated' | 'internal.client.share.stopped';
     payload?: never;
     options?: never;
 };
@@ -154,7 +154,7 @@ export type BuildClientEventFetchRequestOptions = (args: {
     payload?: RecursivePartial<ClientEvent['payload']>;
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
-export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.click.to.interstitial.with.user.delay' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
+export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.click.to.interstitial.with.user.delay' | 'internal.click.to.interstitial.for.client.jmt' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
 export interface IdType {
     meetingId?: string;
     callId?: string;

package/package.json

@@ -24,23 +24,23 @@
     "@sinonjs/fake-timers": "^6.0.1",
     "@webex/babel-config-legacy": "0.0.0",
     "@webex/eslint-config-legacy": "0.0.0",
-    "@webex/event-dictionary-ts": "^1.0.2073",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.11.0-next.1",
-    "@webex/test-helper-mocha": "3.11.0-next.1",
-    "@webex/test-helper-mock-webex": "3.11.0-next.1",
-    "@webex/test-helper-test-users": "3.11.0-next.1",
+    "@webex/test-helper-chai": "3.12.0-next.5",
+    "@webex/test-helper-mocha": "3.12.0-next.5",
+    "@webex/test-helper-mock-webex": "3.12.0-next.5",
+    "@webex/test-helper-test-users": "3.12.0-next.5",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.11.0-next.1",
-    "@webex/common-timers": "3.11.0-next.1",
-    "@webex/test-helper-chai": "3.11.0-next.1",
-    "@webex/test-helper-mock-webex": "3.11.0-next.1",
-    "@webex/webex-core": "3.12.0-next.3",
+    "@webex/common": "3.12.0-next.5",
+    "@webex/common-timers": "3.12.0-next.5",
+    "@webex/event-dictionary-ts": "^1.0.2191",
+    "@webex/test-helper-chai": "3.12.0-next.5",
+    "@webex/test-helper-mock-webex": "3.12.0-next.5",
+    "@webex/webex-core": "3.12.0-next.30",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -53,5 +53,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.12.0-next.3"
+  "version": "3.12.0-next.30"
 }

package/src/batcher.js

@@ -75,6 +75,10 @@ const MetricsBatcher = Batcher.extend({
    */
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
+      if (!this.config.batcherRetryOnNetworkError) {
+        return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
+      }
+
       this.logger.warn(
         'metrics-batcher: received network error submitting metrics, reenqueuing payload'
       );

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

@@ -55,6 +55,8 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
           `CallDiagnosticEventsBatcher: @submitHttpRequest#${batchId}. Request successful.`
         );
 
+        this.handleHttpResponseStatus(res?.statusCode, payload);
+
         return res;
       })
       .catch((err) => {
@@ -64,9 +66,33 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
           `error: ${generateCommonErrorMetadata(err)}`
         );
 
+        this.handleHttpResponseStatus(err?.statusCode, payload);
+
         return Promise.reject(err);
       });
   },
+
+  /**
+   * React to the HTTP status code returned by the metrics endpoint.
+   * Only items submitted with `markTelemetryOptOutOnResponse: true` opt into
+   * this behavior.
+   * @param {number | undefined} statusCode
+   * @param {any[]} payload Items flushed in this HTTP batch.
+   * @returns {void}
+   */
+  handleHttpResponseStatus(statusCode: number | undefined, payload: any[]) {
+    const shouldMark =
+      Array.isArray(payload) &&
+      payload.some((item) => item?.markTelemetryOptOutOnResponse === true);
+
+    if (!shouldMark) {
+      return;
+    }
+
+    if (statusCode === 200) {
+      this.webex.internal.newMetrics?.callDiagnosticMetrics?.setIsTelemetryOptOutAutomatic(true);
+    }
+  },
 });
 
 export default CallDiagnosticEventsBatcher;