@webex/internal-plugin-metrics 3.8.1 → 3.9.0

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

@@ -14,8 +14,11 @@ _Object$defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
 var _weakMap = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/weak-map"));
+var _map = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/map"));
+var _set = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/set"));
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _from = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/array/from"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
@@ -72,7 +75,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "hasLoggedBrowserSerial", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "device", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "delayedClientEvents", []);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "delayedClientFeatureEvents", []);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "eventErrorCache", new _weakMap.default());
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isMercuryConnected", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "eventLimitTracker", new _map.default());
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "eventLimitWarningsLogged", new _set.default());
     // the default validator before piping an event to the batcher
     // this function can be overridden by the user
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "validator", function (options) {
@@ -140,6 +147,18 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       return undefined;
     }
 
+    /**
+     * Sets mercury connected status for event data object in CA events
+     * @public
+     * @param status - boolean value indicating mercury connection status
+     * @return {void}
+     */
+  }, {
+    key: "setMercuryConnectedStatus",
+    value: function setMercuryConnectedStatus(status) {
+      this.isMercuryConnected = status;
+    }
+
     /**
      * Returns meeting's subServiceType
      * @param meeting
@@ -375,14 +394,91 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     }
 
     /**
-     * TODO: NOT IMPLEMENTED
+     * Create feature event
+     * @param name
+     * @param payload
+     * @param options
+     * @returns
+     */
+  }, {
+    key: "prepareClientFeatureEvent",
+    value: function prepareClientFeatureEvent(_ref3) {
+      var name = _ref3.name,
+        payload = _ref3.payload,
+        options = _ref3.options;
+      var meetingId = options.meetingId,
+        correlationId = options.correlationId;
+      var featureEventObject;
+
+      // events that will most likely happen in join phase
+      if (meetingId) {
+        featureEventObject = this.createFeatureEventObjectInMeeting({
+          name: name,
+          options: options
+        });
+      } else {
+        throw new Error('Not implemented');
+      }
+
+      // merge any new properties, or override existing ones
+      featureEventObject = (0, _lodash.merge)(featureEventObject, payload);
+
+      // append client event data to the call diagnostic event
+      var featureEvent = this.prepareDiagnosticEvent(featureEventObject, options);
+      return featureEvent;
+    }
+
+    /**
      * Submit Feature Event
+     * submit to business_ucf
      * @returns
      */
   }, {
     key: "submitFeatureEvent",
-    value: function submitFeatureEvent() {
-      throw Error('Not implemented');
+    value: function submitFeatureEvent(_ref4) {
+      var name = _ref4.name,
+        payload = _ref4.payload,
+        options = _ref4.options,
+        delaySubmitEvent = _ref4.delaySubmitEvent;
+      if (delaySubmitEvent) {
+        // Preserve the time when the event was triggered if delaying the submission to Call Features
+        var delayedOptions = _objectSpread(_objectSpread({}, options), {}, {
+          triggeredTime: new Date().toISOString()
+        });
+        this.delayedClientFeatureEvents.push({
+          name: name,
+          payload: payload,
+          options: delayedOptions
+        });
+        return _promise.default.resolve();
+      }
+      this.logger.log(_config2.CALL_FEATURE_LOG_IDENTIFIER, 'CallFeatureMetrics: @submitFeatureEvent. Submit Client Feature Event CA event.', "name: ".concat(name));
+      var featureEvent = this.prepareClientFeatureEvent({
+        name: name,
+        payload: payload,
+        options: options
+      });
+      this.validator({
+        type: 'ce',
+        event: featureEvent
+      });
+      return this.submitToCallFeatures(featureEvent);
+    }
+
+    /**
+     * Submit Feature Event
+     * type is business
+     * @param event
+     */
+  }, {
+    key: "submitToCallFeatures",
+    value: function submitToCallFeatures(event) {
+      // build metrics-a event type
+      var finalEvent = {
+        eventPayload: event,
+        type: ['business']
+      };
+      return this.callDiagnosticEventsBatcher.request(finalEvent);
     }
 
     /**
@@ -394,10 +490,10 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "submitMQE",
-    value: function submitMQE(_ref3) {
-      var name = _ref3.name,
-        payload = _ref3.payload,
-        options = _ref3.options;
+    value: function submitMQE(_ref5) {
+      var name = _ref5.name,
+        payload = _ref5.payload,
+        options = _ref5.options;
       var meetingId = options.meetingId,
         mediaConnections = options.mediaConnections,
         webexConferenceIdStr = options.webexConferenceIdStr,
@@ -476,13 +572,13 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "getErrorPayloadForClientErrorCode",
-    value: function getErrorPayloadForClientErrorCode(_ref4) {
-      var clientErrorCode = _ref4.clientErrorCode,
-        serviceErrorCode = _ref4.serviceErrorCode,
-        serviceErrorName = _ref4.serviceErrorName,
-        rawErrorMessage = _ref4.rawErrorMessage,
-        payloadOverrides = _ref4.payloadOverrides,
-        httpStatusCode = _ref4.httpStatusCode;
+    value: function getErrorPayloadForClientErrorCode(_ref6) {
+      var clientErrorCode = _ref6.clientErrorCode,
+        serviceErrorCode = _ref6.serviceErrorCode,
+        serviceErrorName = _ref6.serviceErrorName,
+        rawErrorMessage = _ref6.rawErrorMessage,
+        payloadOverrides = _ref6.payloadOverrides,
+        httpStatusCode = _ref6.httpStatusCode;
       var error;
       if (clientErrorCode) {
         var partialParsedError = _config2.CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD[clientErrorCode];
@@ -522,6 +618,128 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       this.eventErrorCache = new _weakMap.default();
     }
 
+    /**
+     * Checks if an event should be limited based on criteria defined in the event dictionary.
+     * Returns true if the event should be sent, false if it has reached its limit.
+     * @param event - The diagnostic event object
+     * @returns boolean indicating whether the event should be sent
+     */
+  }, {
+    key: "shouldSendEvent",
+    value: function shouldSendEvent(_ref7) {
+      var _event$identifiers;
+      var event = _ref7.event;
+      var eventName = event === null || event === void 0 ? void 0 : event.name;
+      var correlationId = event === null || event === void 0 ? void 0 : (_event$identifiers = event.identifiers) === null || _event$identifiers === void 0 ? void 0 : _event$identifiers.correlationId;
+      if (!correlationId || correlationId === 'unknown') {
+        return true;
+      }
+      var limitKeyPrefix = "".concat(eventName, ":").concat(correlationId);
+      switch (eventName) {
+        case 'client.media.render.start':
+        case 'client.media.render.stop':
+        case 'client.media.rx.start':
+        case 'client.media.rx.stop':
+        case 'client.media.tx.start':
+        case 'client.media.tx.stop':
+          {
+            // Send only once per mediaType-correlationId pair (or mediaType-correlationId-shareInstanceId for share/share_audio)
+            var mediaType = event === null || event === void 0 ? void 0 : event.mediaType;
+            if (mediaType) {
+              if (mediaType === 'share' || mediaType === 'share_audio') {
+                var shareInstanceId = event === null || event === void 0 ? void 0 : event.shareInstanceId;
+                if (shareInstanceId) {
+                  var limitKey = "".concat(limitKeyPrefix, ":").concat(mediaType, ":").concat(shareInstanceId);
+                  return this.checkAndIncrementEventCount(limitKey, 1, "".concat(eventName, " for ").concat(mediaType, " instance ").concat(shareInstanceId));
+                }
+              } else {
+                var _limitKey = "".concat(limitKeyPrefix, ":").concat(mediaType);
+                return this.checkAndIncrementEventCount(_limitKey, 1, "".concat(eventName, " for mediaType ").concat(mediaType));
+              }
+            }
+            break;
+          }
+        case 'client.roap-message.received':
+        case 'client.roap-message.sent':
+          {
+            var _event$roap, _event$roap2;
+            // Send only once per correlationId and roap.messageType/roap.type
+            var roapMessageType = (event === null || event === void 0 ? void 0 : (_event$roap = event.roap) === null || _event$roap === void 0 ? void 0 : _event$roap.messageType) || (event === null || event === void 0 ? void 0 : (_event$roap2 = event.roap) === null || _event$roap2 === void 0 ? void 0 : _event$roap2.type);
+            if (roapMessageType) {
+              var _limitKey2 = "".concat(limitKeyPrefix, ":").concat(roapMessageType);
+              return this.checkAndIncrementEventCount(_limitKey2, 1, "".concat(eventName, " for ROAP type ").concat(roapMessageType));
+            }
+            break;
+          }
+        default:
+          return true;
+      }
+      return true;
+    }
+
+    /**
+     * Checks the current count for a limit key and increments if under limit.
+     * @param limitKey - The unique key for this limit combination
+     * @param maxCount - Maximum allowed count
+     * @param eventDescription - Description for logging
+     * @returns true if under limit and incremented, false if at/over limit
+     */
+  }, {
+    key: "checkAndIncrementEventCount",
+    value: function checkAndIncrementEventCount(limitKey, maxCount, eventDescription) {
+      var currentCount = this.eventLimitTracker.get(limitKey) || 0;
+      if (currentCount >= maxCount) {
+        // Log warning only once per limit key
+        if (!this.eventLimitWarningsLogged.has(limitKey)) {
+          this.logger.log(_config2.CALL_DIAGNOSTIC_LOG_IDENTIFIER, "CallDiagnosticMetrics: Event limit reached for ".concat(eventDescription, ". ") + "Max count ".concat(maxCount, " exceeded. Event will not be sent."), "limitKey: ".concat(limitKey));
+          this.eventLimitWarningsLogged.add(limitKey);
+        }
+        return false;
+      }
+
+      // Increment count and allow event
+      this.eventLimitTracker.set(limitKey, currentCount + 1);
+      return true;
+    }
+
+    /**
+     * Clears event limit tracking
+     */
+  }, {
+    key: "clearEventLimits",
+    value: function clearEventLimits() {
+      this.eventLimitTracker.clear();
+      this.eventLimitWarningsLogged.clear();
+    }
+
+    /**
+     * Clears event limit tracking for a specific correlationId only.
+     * Keeps limits for other meetings intact.
+     */
+  }, {
+    key: "clearEventLimitsForCorrelationId",
+    value: function clearEventLimitsForCorrelationId(correlationId) {
+      if (!correlationId) {
+        return;
+      }
+      // Keys are formatted as "eventName:correlationId:..." across all limiters.
+      var hasCorrIdAtSecondToken = function hasCorrIdAtSecondToken(key) {
+        return key.split(':')[1] === correlationId;
+      };
+      for (var _i = 0, _Array$from = (0, _from.default)(this.eventLimitTracker.keys()); _i < _Array$from.length; _i++) {
+        var key = _Array$from[_i];
+        if (hasCorrIdAtSecondToken(key)) {
+          this.eventLimitTracker.delete(key);
+        }
+      }
+      for (var _i2 = 0, _Array$from3 = (0, _from.default)(this.eventLimitWarningsLogged.values()); _i2 < _Array$from3.length; _i2++) {
+        var _key2 = _Array$from3[_i2];
+        if (hasCorrIdAtSecondToken(_key2)) {
+          this.eventLimitWarningsLogged.delete(_key2);
+        }
+      }
+    }
+
     /**
      * Generate error payload for Client Event
      * @param rawError
@@ -626,19 +844,20 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     }
 
     /**
-     * Create client event object for in meeting events
-     * @param arg - create args
-     * @param arg.event - event key
-     * @param arg.options - options
+     * Create common object for in meeting events
+     * @param name
+     * @param options
+     * @param eventType - 'client' | 'feature'
      * @returns object
      */
   }, {
-    key: "createClientEventObjectInMeeting",
-    value: function createClientEventObjectInMeeting(_ref5) {
+    key: "createCommonEventObjectInMeeting",
+    value: function createCommonEventObjectInMeeting(_ref8) {
       var _this$webex$meetings2, _this$webex$meetings3, _this$webex$meetings4, _options$joinFlowVers, _meeting$callStateFor;
-      var name = _ref5.name,
-        options = _ref5.options,
-        errors = _ref5.errors;
+      var name = _ref8.name,
+        options = _ref8.options,
+        _ref8$eventType = _ref8.eventType,
+        eventType = _ref8$eventType === void 0 ? 'client' : _ref8$eventType;
       var meetingId = options.meetingId,
         mediaConnections = options.mediaConnections,
         globalMeetingId = options.globalMeetingId,
@@ -648,9 +867,9 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       // @ts-ignore
       var meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
       if (!meeting) {
-        console.warn('Attempt to send client event but no meeting was found...', "name: ".concat(name, ", meetingId: ").concat(meetingId));
+        console.warn('Attempt to send common event but no meeting was found...', "name: ".concat(name, ", meetingId: ").concat(meetingId));
         // @ts-ignore
-        this.webex.internal.metrics.submitClientMetrics(_config2.CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND, {
+        this.webex.internal.metrics.submitClientMetrics(eventType === 'feature' ? _config2.CALL_FEATURE_EVENT_FAILED_TO_SEND : _config2.CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND, {
           fields: {
             meetingId: meetingId,
             name: name
@@ -668,12 +887,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         sessionCorrelationId: sessionCorrelationId
       });
 
-      // create client event object
-      var clientEventObject = _objectSpread(_objectSpread(_objectSpread({
+      // create common event object structur
+      var commonEventObject = _objectSpread(_objectSpread(_objectSpread({
         name: name,
         canProceed: true,
         identifiers: identifiers,
-        errors: errors,
         eventData: {
           webClientDomain: window.location.hostname
         },
@@ -693,16 +911,68 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       });
       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) {
-        clientEventObject.joinFlowVersion = joinFlowVersion;
+        // @ts-ignore
+        commonEventObject.joinFlowVersion = joinFlowVersion;
       }
       var meetingJoinedTime = meeting.isoLocalClientMeetingJoinTime;
       if (meetingJoinedTime) {
-        clientEventObject.meetingJoinedTime = meetingJoinedTime;
+        // @ts-ignore
+        commonEventObject.meetingJoinedTime = meetingJoinedTime;
       }
       if (options.meetingJoinPhase) {
-        clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
+        // @ts-ignore
+        commonEventObject.meetingJoinPhase = options.meetingJoinPhase;
       }
-      return clientEventObject;
+      return commonEventObject;
+    }
+
+    /**
+     * Create client event object for in meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - options
+     * @returns object
+     */
+  }, {
+    key: "createClientEventObjectInMeeting",
+    value: function createClientEventObjectInMeeting(_ref9) {
+      var name = _ref9.name,
+        options = _ref9.options,
+        errors = _ref9.errors;
+      var commonObject = this.createCommonEventObjectInMeeting({
+        name: name,
+        options: options,
+        eventType: 'client'
+      });
+      if (!commonObject) return undefined;
+      return _objectSpread(_objectSpread({}, commonObject), {}, {
+        errors: errors,
+        eventData: _objectSpread(_objectSpread({}, commonObject.eventData), {}, {
+          isMercuryConnected: this.isMercuryConnected
+        })
+      });
+    }
+
+    /**
+     * Create feature event object for in meeting function event
+     * @param name
+     * @param options
+     * @returns object
+     */
+  }, {
+    key: "createFeatureEventObjectInMeeting",
+    value: function createFeatureEventObjectInMeeting(_ref10) {
+      var name = _ref10.name,
+        options = _ref10.options;
+      var commonObject = this.createCommonEventObjectInMeeting({
+        name: name,
+        options: options,
+        eventType: 'feature'
+      });
+      if (!commonObject) return undefined;
+      return _objectSpread(_objectSpread({}, commonObject), {}, {
+        key: 'UcfFeatureUsage'
+      });
     }
 
     /**
@@ -714,11 +984,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "createClientEventObjectPreMeeting",
-    value: function createClientEventObjectPreMeeting(_ref6) {
+    value: function createClientEventObjectPreMeeting(_ref11) {
       var _this$webex$meetings5, _this$webex$meetings6, _this$webex$meetings7;
-      var name = _ref6.name,
-        options = _ref6.options,
-        errors = _ref6.errors;
+      var name = _ref11.name,
+        options = _ref11.options,
+        errors = _ref11.errors;
       var correlationId = options.correlationId,
         globalMeetingId = options.globalMeetingId,
         webexConferenceIdStr = options.webexConferenceIdStr,
@@ -741,7 +1011,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         canProceed: true,
         identifiers: identifiers,
         eventData: {
-          webClientDomain: window.location.hostname
+          webClientDomain: window.location.hostname,
+          isMercuryConnected: this.isMercuryConnected
         },
         loginType: this.getCurLoginType(),
         // @ts-ignore
@@ -773,10 +1044,10 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "prepareClientEvent",
-    value: function prepareClientEvent(_ref7) {
-      var name = _ref7.name,
-        payload = _ref7.payload,
-        options = _ref7.options;
+    value: function prepareClientEvent(_ref12) {
+      var name = _ref12.name,
+        payload = _ref12.payload,
+        options = _ref12.options;
       var meetingId = options.meetingId,
         correlationId = options.correlationId,
         rawError = options.rawError;
@@ -832,11 +1103,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "submitClientEvent",
-    value: function submitClientEvent(_ref8) {
-      var name = _ref8.name,
-        payload = _ref8.payload,
-        options = _ref8.options,
-        delaySubmitEvent = _ref8.delaySubmitEvent;
+    value: function submitClientEvent(_ref13) {
+      var name = _ref13.name,
+        payload = _ref13.payload,
+        options = _ref13.options,
+        delaySubmitEvent = _ref13.delaySubmitEvent;
       if (delaySubmitEvent) {
         // Preserve the time when the event was triggered if delaying the submission to Call Diagnostics
         var delayedOptions = _objectSpread(_objectSpread({}, options), {}, {
@@ -855,6 +1126,9 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         payload: payload,
         options: options
       });
+      if (!this.shouldSendEvent(diagnosticEvent)) {
+        return _promise.default.resolve();
+      }
       if (options !== null && options !== void 0 && options.preLoginId) {
         return this.submitToCallDiagnosticsPreLogin(diagnosticEvent, options === null || options === void 0 ? void 0 : options.preLoginId);
       }
@@ -891,6 +1165,32 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       return _promise.default.all(promises);
     }
 
+    /**
+     * Submit Delayed feature Event CA events. Clears submitDelayedClientFeatureEvents array after submission.
+     */
+  }, {
+    key: "submitDelayedClientFeatureEvents",
+    value: function submitDelayedClientFeatureEvents(overrides) {
+      var _this3 = this;
+      this.logger.log(_config2.CALL_FEATURE_LOG_IDENTIFIER, 'CallDiagnosticMetrics: @submitDelayedClientFeatureEvents. Submitting delayed feature events.');
+      if (this.delayedClientFeatureEvents.length === 0) {
+        return _promise.default.resolve();
+      }
+      var promises = this.delayedClientFeatureEvents.map(function (delayedSubmitClientEventParams) {
+        var name = delayedSubmitClientEventParams.name,
+          payload = delayedSubmitClientEventParams.payload,
+          options = delayedSubmitClientEventParams.options;
+        var optionsWithOverrides = _objectSpread(_objectSpread({}, options), overrides);
+        return _this3.submitFeatureEvent({
+          name: name,
+          payload: payload,
+          options: optionsWithOverrides
+        });
+      });
+      this.delayedClientFeatureEvents = [];
+      return _promise.default.all(promises);
+    }
+
     /**
      * Prepare the event and send the request to metrics-a service.
      * @param event
@@ -919,12 +1219,12 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      * @throws
      */
     function () {
-      var _buildClientEventFetchRequestOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref9) {
+      var _buildClientEventFetchRequestOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref14) {
         var name, payload, options, clientEvent, diagnosticEvent, request;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              name = _ref9.name, payload = _ref9.payload, options = _ref9.options;
+              name = _ref14.name, payload = _ref14.payload, options = _ref14.options;
               this.logger.log(_config2.CALL_DIAGNOSTIC_LOG_IDENTIFIER, 'CallDiagnosticMetrics: @buildClientEventFetchRequestOptions. Building request options object for fetch()...', "name: ".concat(name));
               clientEvent = this.prepareClientEvent({
                 name: name,