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

package/dist/call-diagnostic/call-diagnostic-metrics.js

@@ -77,6 +77,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     (0, _defineProperty2.default)(_this, "isMercuryConnected", false);
     (0, _defineProperty2.default)(_this, "eventLimitTracker", new _map.default());
     (0, _defineProperty2.default)(_this, "eventLimitWarningsLogged", new _set.default());
+    (0, _defineProperty2.default)(_this, "isTelemetryOptOutManual", false);
+    (0, _defineProperty2.default)(_this, "isTelemetryOptOutAutomatic", false);
     // the default validator before piping an event to the batcher
     // this function can be overridden by the user
     (0, _defineProperty2.default)(_this, "validator", function (options) {
@@ -89,13 +91,15 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      * Prepare the event and send the request to metrics-a service, pre login.
      * @param event
      * @param preLoginId
+     * @param markTelemetryOptOutOnResponse
      * @returns
      */
     (0, _defineProperty2.default)(_this, "submitToCallDiagnosticsPreLogin", function (event, preLoginId) {
       // build metrics-a event type
       var finalEvent = {
         eventPayload: event,
-        type: ['diagnostic-event']
+        type: ['diagnostic-event'],
+        markTelemetryOptOutOnResponse: true
       };
       _this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
       return _this.preLoginMetricsBatcher.request(finalEvent);
@@ -128,6 +132,59 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       return null;
     }
 
+    /**
+     * Returns the user activation state reported from the browser's navigator.userActivation API
+     * @returns object with hasBeenActive and isActive booleans, or undefined if unavailable
+     */
+  }, {
+    key: "getUserActivation",
+    value: function getUserActivation() {
+      var userActivation = typeof navigator !== 'undefined' ? navigator.userActivation : undefined;
+      if (userActivation) {
+        return {
+          hasBeenActive: userActivation.hasBeenActive,
+          isActive: userActivation.isActive
+        };
+      }
+      return undefined;
+    }
+
+    /**
+     * Returns the telemetryOptOut value of the current user
+     * @returns one of 'manual', 'automatic', undefined
+     */
+  }, {
+    key: "getTelemetryOptOut",
+    value: function getTelemetryOptOut() {
+      if (this.isTelemetryOptOutManual) {
+        return 'manual';
+      }
+      if (this.isTelemetryOptOutAutomatic) {
+        return 'automatic';
+      }
+      return undefined;
+    }
+
+    /**
+     * Sets the manual telemetry opt-out status for the current user
+     * @param value - boolean value indicating manual telemetry opt-out status
+     */
+  }, {
+    key: "setIsTelemetryOptOutManual",
+    value: function setIsTelemetryOptOutManual(value) {
+      this.isTelemetryOptOutManual = value;
+    }
+
+    /**
+     * Sets the automatic telemetry opt-out status for the current user
+     * @param value - boolean value indicating automatic telemetry opt-out status
+     */
+  }, {
+    key: "setIsTelemetryOptOutAutomatic",
+    value: function setIsTelemetryOptOutAutomatic(value) {
+      this.isTelemetryOptOutAutomatic = value;
+    }
+
     /**
      * Returns if the meeting has converged architecture enabled
      * @param options.meetingId
@@ -179,6 +236,10 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
 
         // if ConvergedArchitecture enable and isConvergedWebinarWebcast -- then webcast
         if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableConvergedArchitecture && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent) {
+          // if enableConvergedWebinarLargeScale - then large scale webinar
+          if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableConvergedWebinarLargeScale) {
+            return _config2.WEBEX_SUB_SERVICE_TYPES.LARGE_SCALE_WEBINAR;
+          }
           return meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.isConvergedWebinarWebcast ? _config2.WEBEX_SUB_SERVICE_TYPES.WEBCAST : _config2.WEBEX_SUB_SERVICE_TYPES.WEBINAR;
         }
 
@@ -544,7 +605,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
             mediaEngineSoftwareType: getBrowserName() || 'browser',
             mediaEngineSoftwareVersion: getOSVersion() || 'unknown',
             startTime: new Date().toISOString()
-          }
+          },
+          webexSubServiceType: this.getSubServiceType(meeting)
         };
 
         // merge any new properties, or override existing ones
@@ -854,7 +916,7 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
   }, {
     key: "createCommonEventObjectInMeeting",
     value: function createCommonEventObjectInMeeting(_ref8) {
-      var _this$webex$meetings2, _this$webex$meetings3, _this$webex$meetings4, _options$joinFlowVers, _meeting$callStateFor;
+      var _this$webex$meetings2, _this$webex$meetings3, _this$webex$meetings4, _meeting$meetingInfo0, _navigator, _options$joinFlowVers, _meeting$callStateFor;
       var name = _ref8.name,
         options = _ref8.options,
         _ref8$eventType = _ref8.eventType,
@@ -888,7 +950,7 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         sessionCorrelationId: sessionCorrelationId
       });
 
-      // create common event object structur
+      // create common event object structure
       var commonEventObject = _objectSpread(_objectSpread(_objectSpread({
         name: name,
         canProceed: true,
@@ -898,6 +960,7 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         },
         userType: meeting.getCurUserType(),
         loginType: 'loginType' in meeting.callStateForMetrics ? meeting.callStateForMetrics.loginType : this.getCurLoginType(),
+        telemetryOptOut: this.getTelemetryOptOut(),
         isConvergedArchitectureEnabled: this.getIsConvergedArchitectureEnabled({
           meetingId: meetingId
         })
@@ -908,7 +971,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       }), {}, {
         webexSubServiceType: this.getSubServiceType(meeting),
         // @ts-ignore
-        webClientPreload: (_this$webex$meetings2 = this.webex.meetings) === null || _this$webex$meetings2 === void 0 ? void 0 : (_this$webex$meetings3 = _this$webex$meetings2.config) === null || _this$webex$meetings3 === void 0 ? void 0 : (_this$webex$meetings4 = _this$webex$meetings3.metrics) === null || _this$webex$meetings4 === void 0 ? void 0 : _this$webex$meetings4.webClientPreload
+        webClientPreload: (_this$webex$meetings2 = this.webex.meetings) === null || _this$webex$meetings2 === void 0 ? void 0 : (_this$webex$meetings3 = _this$webex$meetings2.config) === null || _this$webex$meetings3 === void 0 ? void 0 : (_this$webex$meetings4 = _this$webex$meetings3.metrics) === null || _this$webex$meetings4 === void 0 ? void 0 : _this$webex$meetings4.webClientPreload,
+        isVipMeeting: (meeting === null || meeting === void 0 ? void 0 : (_meeting$meetingInfo0 = meeting.meetingInfo) === null || _meeting$meetingInfo0 === void 0 ? void 0 : _meeting$meetingInfo0.vipmeeting) || false,
+        isAutomatedUser: typeof window !== 'undefined' && typeof navigator !== 'undefined' && !!((_navigator = navigator) !== null && _navigator !== void 0 && _navigator.webdriver),
+        // if webdriver is true, it's most likely in a test environment
+        userActivation: this.getUserActivation()
       });
       var joinFlowVersion = (_options$joinFlowVers = options.joinFlowVersion) !== null && _options$joinFlowVers !== void 0 ? _options$joinFlowVers : (_meeting$callStateFor = meeting.callStateForMetrics) === null || _meeting$callStateFor === void 0 ? void 0 : _meeting$callStateFor.joinFlowVersion;
       if (joinFlowVersion) {
@@ -986,7 +1053,7 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
   }, {
     key: "createClientEventObjectPreMeeting",
     value: function createClientEventObjectPreMeeting(_ref1) {
-      var _this$webex$meetings5, _this$webex$meetings6, _this$webex$meetings7;
+      var _this$webex$meetings5, _this$webex$meetings6, _this$webex$meetings7, _navigator2;
       var name = _ref1.name,
         options = _ref1.options,
         errors = _ref1.errors;
@@ -1016,8 +1083,12 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
           isMercuryConnected: this.isMercuryConnected
         },
         loginType: this.getCurLoginType(),
+        telemetryOptOut: this.getTelemetryOptOut(),
         // @ts-ignore
-        webClientPreload: (_this$webex$meetings5 = this.webex.meetings) === null || _this$webex$meetings5 === void 0 ? void 0 : (_this$webex$meetings6 = _this$webex$meetings5.config) === null || _this$webex$meetings6 === void 0 ? void 0 : (_this$webex$meetings7 = _this$webex$meetings6.metrics) === null || _this$webex$meetings7 === void 0 ? void 0 : _this$webex$meetings7.webClientPreload
+        webClientPreload: (_this$webex$meetings5 = this.webex.meetings) === null || _this$webex$meetings5 === void 0 ? void 0 : (_this$webex$meetings6 = _this$webex$meetings5.config) === null || _this$webex$meetings6 === void 0 ? void 0 : (_this$webex$meetings7 = _this$webex$meetings6.metrics) === null || _this$webex$meetings7 === void 0 ? void 0 : _this$webex$meetings7.webClientPreload,
+        isAutomatedUser: typeof window !== 'undefined' && typeof navigator !== 'undefined' && !!((_navigator2 = navigator) !== null && _navigator2 !== void 0 && _navigator2.webdriver),
+        // if webdriver is true, it's most likely in a test environment
+        userActivation: this.getUserActivation()
       };
       if (options.joinFlowVersion) {
         clientEventObject.joinFlowVersion = options.joinFlowVersion;
@@ -1203,7 +1274,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       // build metrics-a event type
       var finalEvent = {
         eventPayload: event,
-        type: ['diagnostic-event']
+        type: ['diagnostic-event'],
+        markTelemetryOptOutOnResponse: true
       };
       return this.callDiagnosticEventsBatcher.request(finalEvent);
     }