@webex/internal-plugin-metrics 3.12.0-next.26 → 3.12.0-next.28

package/dist/metrics.js

@@ -147,7 +147,7 @@ var Metrics = _webexCore.WebexPlugin.extend({
       }
     });
   },
-  version: "3.12.0-next.26"
+  version: "3.12.0-next.28"
 });
 var _default = exports.default = Metrics;
 //# sourceMappingURL=metrics.js.map

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.d.ts

@@ -36,7 +36,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private isMercuryConnected;
     private eventLimitTracker;
     private eventLimitWarningsLogged;
-    private telemetryOptOut;
+    private isTelemetryOptOutManual;
+    private isTelemetryOptOutAutomatic;
     validator: (options: {
         type: 'mqe' | 'ce';
         event: Event;
@@ -60,10 +61,15 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     getTelemetryOptOut(): "manual" | "automatic";
     /**
-     * Sets the telemetryOptOut value of the current user
-     * @param value - one of 'manual', 'automatic', undefined
+     * Sets the manual telemetry opt-out status for the current user
+     * @param value - boolean value indicating manual telemetry opt-out status
      */
-    setTelemetryOptOut(value: NonNullable<ClientEventPayload>['telemetryOptOut']): void;
+    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
@@ -91,7 +97,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns
      */
     getOrigin(options: GetOriginOptions, meetingId?: string): {
-        name: "breakout" | "endpoint" | "addin" | "antares" | "appapi" | "beech" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "crc" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "idbroker" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mrs" | "mygdon" | "ngpage" | "ngservice" | "oauth" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "sbs" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr" | "meetingcontainer";
+        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "crc" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "idbroker" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mrs" | "mygdon" | "ngpage" | "ngservice" | "oauth" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "sbs" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr" | "meetingcontainer";
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
@@ -119,10 +125,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             browser?: string;
             browserVersion?: string;
             clientType?: "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "SIP" | "RECORDING" | "CLOUD_AWARE_SIP" | "TEAMS_WXC_CLIENT" | "WXC_CLIENT" | "WXC_DEVICE" | "WEBEX_JS_SDK" | "VOICEA_CLIENT" | "CISCO_SIP_GW" | "WEBEX_SDK" | "CPAAS_THIRD_PARTY_SDK" | "WXC_THIRD_PARTY" | "WXCC" | "TEAMS_PHONE" | "WEBEX_RELAY";
-            subClientType?: "TEAMS_DEVICE" | "SIP" | "AUTOMOTIVE_APP" | "BROWSER_EXTENSION" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MIXED" | "MOBILE_APP" | "MOBILE_NETWORK" | "PAGE" | "VDI_APP" | "WEB_APP" | "PHONE_NOVUM" | "PHONE_ESPRESSO" | "PHONE_BUMBLEBEE" | "SIP_PSTN"; /**
-             * Returns the telemetryOptOut value of the current user
-             * @returns one of 'manual', 'automatic', undefined
-             */
+            subClientType?: "TEAMS_DEVICE" | "SIP" | "AUTOMOTIVE_APP" | "BROWSER_EXTENSION" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MIXED" | "MOBILE_APP" | "MOBILE_NETWORK" | "PAGE" | "VDI_APP" | "WEB_APP" | "PHONE_NOVUM" | "PHONE_ESPRESSO" | "PHONE_BUMBLEBEE" | "SIP_PSTN";
             schedulingClientType?: "TEAMS_CLIENT" | "GOOGLE_ADDON" | "PT" | "PUBLIC_API" | "UNIFIED_PAGE" | "WEBEX_PAGE" | "GOOGLE_NOTIFICATION_CALENDAR" | "MSFT_NOTIFICATION_ADDIN" | "MSFT_NOTIFICATION_CALENDAR" | "OUTLOOK_ADDIN";
             clientVersion?: string;
             clientVersionStatus?: "CURRENT" | "LEGACY" | "UNSUPPORTED";
@@ -628,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/package.json

@@ -40,7 +40,7 @@
     "@webex/common-timers": "3.12.0-next.5",
     "@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.26",
+    "@webex/webex-core": "3.12.0-next.28",
     "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.26"
+  "version": "3.12.0-next.28"
 }

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;

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

@@ -108,7 +108,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private isMercuryConnected = false;
   private eventLimitTracker: Map<string, number> = new Map();
   private eventLimitWarningsLogged: Set<string> = new Set();
-  private telemetryOptOut: NonNullable<ClientEventPayload>['telemetryOptOut'] = undefined;
+  private isTelemetryOptOutManual = false;
+  private isTelemetryOptOutAutomatic = false;
 
   // the default validator before piping an event to the batcher
   // this function can be overridden by the user
@@ -150,16 +151,31 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * Returns the telemetryOptOut value of the current user
    * @returns one of 'manual', 'automatic', undefined
    */
-  getTelemetryOptOut() {
-    return this.telemetryOptOut;
+  public getTelemetryOptOut() {
+    if (this.isTelemetryOptOutManual) {
+      return 'manual';
+    }
+    if (this.isTelemetryOptOutAutomatic) {
+      return 'automatic';
+    }
+
+    return undefined;
   }
 
   /**
-   * Sets the telemetryOptOut value of the current user
-   * @param value - one of 'manual', 'automatic', undefined
+   * Sets the manual telemetry opt-out status for the current user
+   * @param value - boolean value indicating manual telemetry opt-out status
    */
-  public setTelemetryOptOut(value: NonNullable<ClientEventPayload>['telemetryOptOut']) {
-    this.telemetryOptOut = value;
+  public setIsTelemetryOptOutManual(value: boolean) {
+    this.isTelemetryOptOutManual = value;
+  }
+
+  /**
+   * Sets the automatic telemetry opt-out status for the current user
+   * @param value - boolean value indicating automatic telemetry opt-out status
+   */
+  public setIsTelemetryOptOutAutomatic(value: boolean) {
+    this.isTelemetryOptOutAutomatic = value;
   }
 
   /**
@@ -1348,6 +1364,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
+      markTelemetryOptOutOnResponse: true,
     };
 
     return this.callDiagnosticEventsBatcher.request(finalEvent);
@@ -1357,6 +1374,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> => {
@@ -1364,7 +1382,9 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
+      markTelemetryOptOutOnResponse: true,
     };
+
     this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
 
     return this.preLoginMetricsBatcher.request(finalEvent);

package/src/prelogin-metrics-batcher.ts

@@ -78,6 +78,8 @@ const PreLoginMetricsBatcher = Batcher.extend({
           `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`
         );
 
+        this.handleHttpResponseStatus(res?.statusCode, payload);
+
         return res;
       })
       .catch((err) => {
@@ -87,9 +89,33 @@ const PreLoginMetricsBatcher = Batcher.extend({
           `error: ${generateCommonErrorMetadata(err)}`
         );
 
+        this.handleHttpResponseStatus(err?.statusCode, payload);
+
         return Promise.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(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 PreLoginMetricsBatcher;

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

@@ -516,5 +516,141 @@ describe('plugin-metrics', () => {
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);
       });
     });
+
+    describe('#submitHttpRequest', () => {
+      it('calls handleHttpResponseStatus with response status on success', async () => {
+        const payload = [
+          {
+            eventPayload: {event: 'my.event'},
+            type: ['diagnostic-event'],
+          },
+        ];
+
+        webex.request = sinon.stub().resolves({statusCode: 200});
+
+        const handleHttpResponseStatusSpy = sinon.spy(
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher,
+          'handleHttpResponseStatus'
+        );
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.submitHttpRequest(
+            payload
+          );
+
+        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
+
+        await flushPromises();
+        clock.tick(config.metrics.batcherWait);
+
+        await promise;
+
+        assert.calledOnce(webex.request);
+        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 1);
+        assert.deepEqual(handleHttpResponseStatusSpy.args[0][0], 200);
+        assert.deepEqual(handleHttpResponseStatusSpy.args[0][1], payload);
+      });
+
+      it('calls handleHttpResponseStatus with error status on failure', async () => {
+        const payload = [
+          {
+            eventPayload: {event: 'my.event'},
+            type: ['diagnostic-event'],
+          },
+        ];
+
+        webex.request = sinon.stub().rejects({statusCode: 503});
+
+        const handleHttpResponseStatusSpy = sinon.spy(
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher,
+          'handleHttpResponseStatus'
+        );
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.submitHttpRequest(
+            payload
+          );
+
+        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
+
+        await flushPromises();
+        clock.tick(config.metrics.batcherWait);
+
+        let error: any;
+
+        try {
+          await promise;
+        } catch (err) {
+          error = err;
+        }
+
+        assert.deepEqual(error.statusCode, 503);
+        assert.calledOnce(webex.request);
+        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 1);
+        assert.deepEqual(handleHttpResponseStatusSpy.args[0][0], 503);
+        assert.deepEqual(handleHttpResponseStatusSpy.args[0][1], payload);
+      });
+    });
+
+    describe('#handleHttpResponseStatus', () => {
+      let setIsTelemetryOptOutAutomaticStub;
+
+      beforeEach(() => {
+        setIsTelemetryOptOutAutomaticStub = sinon.stub(
+          webex.internal.newMetrics.callDiagnosticMetrics,
+          'setIsTelemetryOptOutAutomatic'
+        );
+      });
+
+      [201, 400, 503, undefined].forEach((statusCode) => {
+        it(`does not call setIsTelemetryOptOutAutomatic() when statusCode is ${statusCode} and markTelemetryOptOutOnResponse is true`, () => {
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
+            statusCode,
+            [{markTelemetryOptOutOnResponse: true}]
+          );
+
+          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
+        });
+      });
+
+      it('calls setIsTelemetryOptOutAutomatic(true) when statusCode is 200 and markTelemetryOptOutOnResponse is true', () => {
+        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
+          200,
+          [{markTelemetryOptOutOnResponse: true}]
+        );
+
+        assert.calledOnce(setIsTelemetryOptOutAutomaticStub);
+        assert.calledWithExactly(setIsTelemetryOptOutAutomaticStub, true);
+      });
+
+      [200, 201, 400, 503, undefined].forEach((statusCode) => {
+        it(`does not call setIsTelemetryOptOutAutomatic when shouldMark is false (statusCode: ${statusCode})`, () => {
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
+            statusCode,
+            [{markTelemetryOptOutOnResponse: false}]
+          );
+
+          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
+        });
+      });
+
+      it('does not call setIsTelemetryOptOutAutomatic when payload is empty', () => {
+        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
+          200,
+          []
+        );
+
+        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
+      });
+
+      it('does not call setIsTelemetryOptOutAutomatic when payload is not an array', () => {
+        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
+          200,
+          null
+        );
+
+        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
+      });
+    });
   });
 });

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

@@ -3119,7 +3119,11 @@ describe('internal-plugin-metrics', () => {
         cd.callDiagnosticEventsBatcher = {request: requestStub};
         //@ts-ignore
         cd.submitToCallDiagnostics({event: 'test'});
-        assert.calledWith(requestStub, {eventPayload: {event: 'test'}, type: ['diagnostic-event']});
+        assert.calledWith(requestStub, {
+          eventPayload: {event: 'test'},
+          type: ['diagnostic-event'],
+          markTelemetryOptOutOnResponse: true,
+        });
       });
     });
 
@@ -4031,15 +4035,93 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#getTelemetryOptOut', () => {
-      ['manual', 'automatic', undefined].forEach((telemetryOptOut) => {
-        it(`returns ${telemetryOptOut} if telemetryOptOut is ${telemetryOptOut}`, () => {
-          cd.setTelemetryOptOut(telemetryOptOut);
-          assert.deepEqual(cd.getTelemetryOptOut(), telemetryOptOut);
-        });
+      it('returns "manual" when manual telemetry opt-out is enabled', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+      });
 
-        it('returns undefined if telemetryOptOut is not set', () => {
-          assert.deepEqual(cd.getTelemetryOptOut(), undefined);
-        });
+      it('returns "automatic" when automatic telemetry opt-out is enabled', () => {
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'automatic');
+      });
+
+      it('returns "manual" when manual opt-out takes precedence over automatic', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+      });
+
+      it('returns undefined when neither manual nor automatic opt-out is set', () => {
+        assert.isUndefined(cd.getTelemetryOptOut());
+      });
+
+      it('returns undefined after disabling manual opt-out', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        cd.setIsTelemetryOptOutManual(false);
+        assert.isUndefined(cd.getTelemetryOptOut());
+      });
+    });
+
+    describe('#setIsTelemetryOptOutManual', () => {
+      it('sets manual telemetry opt-out to true', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+      });
+
+      it('sets manual telemetry opt-out to false', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        cd.setIsTelemetryOptOutManual(false);
+        assert.isUndefined(cd.getTelemetryOptOut());
+      });
+
+      it('can toggle manual telemetry opt-out multiple times', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+
+        cd.setIsTelemetryOptOutManual(false);
+        assert.isUndefined(cd.getTelemetryOptOut());
+
+        cd.setIsTelemetryOptOutManual(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+      });
+
+      it('manual opt-out takes precedence when automatic is also set', () => {
+        cd.setIsTelemetryOptOutAutomatic(true);
+        cd.setIsTelemetryOptOutManual(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+      });
+    });
+
+    describe('#setIsTelemetryOptOutAutomatic', () => {
+      it('sets automatic telemetry opt-out to true', () => {
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'automatic');
+      });
+
+      it('sets automatic telemetry opt-out to false', () => {
+        cd.setIsTelemetryOptOutAutomatic(true);
+        cd.setIsTelemetryOptOutAutomatic(false);
+        assert.isUndefined(cd.getTelemetryOptOut());
+      });
+
+      it('can toggle automatic telemetry opt-out multiple times', () => {
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'automatic');
+
+        cd.setIsTelemetryOptOutAutomatic(false);
+        assert.isUndefined(cd.getTelemetryOptOut());
+
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'automatic');
+      });
+
+      it('does not override manual opt-out', () => {
+        cd.setIsTelemetryOptOutManual(true);
+        cd.setIsTelemetryOptOutAutomatic(true);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
+
+        cd.setIsTelemetryOptOutAutomatic(false);
+        assert.equal(cd.getTelemetryOptOut(), 'manual');
       });
     });
 
@@ -4337,7 +4419,11 @@ describe('internal-plugin-metrics', () => {
         cd.submitToCallDiagnosticsPreLogin({event: 'test'}, preLoginId);
         //@ts-ignore
         assert.calledWith(cd.preLoginMetricsBatcher.savePreLoginId, preLoginId);
-        assert.calledWith(requestStub, {eventPayload: {event: 'test'}, type: ['diagnostic-event']});
+        assert.calledWith(requestStub, {
+          eventPayload: {event: 'test'},
+          type: ['diagnostic-event'],
+          markTelemetryOptOutOnResponse: true,
+        });
       });
     });