@webex/internal-plugin-metrics 3.9.0-webinar5k.1 → 3.10.0-next.1

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"));
@@ -75,6 +78,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     (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) {
@@ -261,6 +266,9 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         if (options !== null && options !== void 0 && options.browserLaunchMethod) {
           origin.clientInfo.browserLaunchMethod = options.browserLaunchMethod;
         }
+        if (options !== null && options !== void 0 && options.vendorId) {
+          origin.clientInfo.vendorId = options.vendorId;
+        }
         return origin;
       }
       throw new Error("ClientType and SubClientType can't be undefined");
@@ -613,6 +621,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
@@ -725,12 +855,12 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "createCommonEventObjectInMeeting",
-    value: function createCommonEventObjectInMeeting(_ref7) {
+    value: function createCommonEventObjectInMeeting(_ref8) {
       var _this$webex$meetings2, _this$webex$meetings3, _this$webex$meetings4, _options$joinFlowVers, _meeting$callStateFor;
-      var name = _ref7.name,
-        options = _ref7.options,
-        _ref7$eventType = _ref7.eventType,
-        eventType = _ref7$eventType === void 0 ? 'client' : _ref7$eventType;
+      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,
@@ -808,10 +938,10 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "createClientEventObjectInMeeting",
-    value: function createClientEventObjectInMeeting(_ref8) {
-      var name = _ref8.name,
-        options = _ref8.options,
-        errors = _ref8.errors;
+    value: function createClientEventObjectInMeeting(_ref9) {
+      var name = _ref9.name,
+        options = _ref9.options,
+        errors = _ref9.errors;
       var commonObject = this.createCommonEventObjectInMeeting({
         name: name,
         options: options,
@@ -834,9 +964,9 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "createFeatureEventObjectInMeeting",
-    value: function createFeatureEventObjectInMeeting(_ref9) {
-      var name = _ref9.name,
-        options = _ref9.options;
+    value: function createFeatureEventObjectInMeeting(_ref10) {
+      var name = _ref10.name,
+        options = _ref10.options;
       var commonObject = this.createCommonEventObjectInMeeting({
         name: name,
         options: options,
@@ -857,11 +987,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "createClientEventObjectPreMeeting",
-    value: function createClientEventObjectPreMeeting(_ref10) {
+    value: function createClientEventObjectPreMeeting(_ref11) {
       var _this$webex$meetings5, _this$webex$meetings6, _this$webex$meetings7;
-      var name = _ref10.name,
-        options = _ref10.options,
-        errors = _ref10.errors;
+      var name = _ref11.name,
+        options = _ref11.options,
+        errors = _ref11.errors;
       var correlationId = options.correlationId,
         globalMeetingId = options.globalMeetingId,
         webexConferenceIdStr = options.webexConferenceIdStr,
@@ -917,10 +1047,10 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "prepareClientEvent",
-    value: function prepareClientEvent(_ref11) {
-      var name = _ref11.name,
-        payload = _ref11.payload,
-        options = _ref11.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;
@@ -976,11 +1106,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "submitClientEvent",
-    value: function submitClientEvent(_ref12) {
-      var name = _ref12.name,
-        payload = _ref12.payload,
-        options = _ref12.options,
-        delaySubmitEvent = _ref12.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), {}, {
@@ -999,6 +1129,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);
       }
@@ -1089,12 +1222,12 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      * @throws
      */
     function () {
-      var _buildClientEventFetchRequestOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref13) {
+      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 = _ref13.name, payload = _ref13.payload, options = _ref13.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,
@@ -1161,7 +1294,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     key: "setDeviceInfo",
     value: function setDeviceInfo(device) {
       // This was created to fix the circular dependency between internal-plugin-device and internal-plugin-metrics
-      this.logger.log('CallDiagnosticMetrics: @setDeviceInfo called', device);
+      this.logger.log('CallDiagnosticMetrics: @setDeviceInfo called', {
+        userId: device === null || device === void 0 ? void 0 : device.userId,
+        deviceId: device === null || device === void 0 ? void 0 : device.url,
+        orgId: device === null || device === void 0 ? void 0 : device.orgId
+      });
       this.device = device;
     }
   }]);