@webex/internal-plugin-metrics 3.8.0 → 3.8.1-next.2

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

@@ -13,9 +13,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 _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
 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"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
 var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
@@ -70,6 +72,8 @@ 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), "eventErrorCache", new _weakMap.default());
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isMercuryConnected", false);
     // 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) {
@@ -137,6 +141,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
@@ -156,13 +172,15 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.webexScheduled && !(meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent) && !(meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.pmr)) {
           return _config2.WEBEX_SUB_SERVICE_TYPES.SCHEDULED_MEETING;
         }
-        // if Scheduled, Webinar, not pmr - then Webinar
-        if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.webexScheduled && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent && !(meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.pmr) && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.isConvergedWebinar) {
-          return _config2.WEBEX_SUB_SERVICE_TYPES.WEBINAR;
+
+        // if ConvergedArchitecture enable and isConvergedWebinarWebcast -- then webcast
+        if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableConvergedArchitecture && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent) {
+          return meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.isConvergedWebinarWebcast ? _config2.WEBEX_SUB_SERVICE_TYPES.WEBCAST : _config2.WEBEX_SUB_SERVICE_TYPES.WEBINAR;
         }
-        // if Scheduled, Webinar enable webcast - then webcast
-        if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.webexScheduled && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent && !(meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.pmr) && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.isConvergedWebinarWebcast) {
-          return _config2.WEBEX_SUB_SERVICE_TYPES.WEBCAST;
+
+        // if Scheduled, enable event, not pmr - then Webinar
+        if (meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.webexScheduled && meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.enableEvent && !(meetingInfo !== null && meetingInfo !== void 0 && meetingInfo.pmr)) {
+          return _config2.WEBEX_SUB_SERVICE_TYPES.WEBINAR;
         }
       }
       return undefined;
@@ -508,6 +526,15 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       return undefined;
     }
 
+    /**
+     * Clear the error cache
+     */
+  }, {
+    key: "clearErrorCache",
+    value: function clearErrorCache() {
+      this.eventErrorCache = new _weakMap.default();
+    }
+
     /**
      * Generate error payload for Client Event
      * @param rawError
@@ -516,11 +543,16 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
     key: "generateClientEventErrorPayload",
     value: function generateClientEventErrorPayload(rawError) {
       var _rawError$error, _rawError$error$body, _rawError$body, _rawError$body2, _rawError$body3, _rawError$body3$reaso;
+      var cachedError = this.eventErrorCache.get(rawError);
+      if (cachedError) {
+        return [cachedError, true];
+      }
       var rawErrorMessage = rawError.message;
       var httpStatusCode = rawError.statusCode;
+      var payload;
       if (rawError.name) {
         if ((0, _callDiagnosticMetrics.isBrowserMediaErrorName)(rawError.name)) {
-          return this.getErrorPayloadForClientErrorCode({
+          payload = this.getErrorPayloadForClientErrorCode({
             serviceErrorCode: undefined,
             clientErrorCode: _config2.BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[rawError.name],
             serviceErrorName: rawError.name,
@@ -529,11 +561,11 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
           });
         }
       }
-      if ((0, _callDiagnosticMetrics.isSdpOfferCreationError)(rawError)) {
+      if ((0, _callDiagnosticMetrics.isSdpOfferCreationError)(rawError) && !payload) {
         var _rawError$cause;
         // error code is 30005, but that's not specific enough. we also need to check error.cause.type
         var causeType = (_rawError$cause = rawError.cause) === null || _rawError$cause === void 0 ? void 0 : _rawError$cause.type;
-        return this.getErrorPayloadForClientErrorCode({
+        payload = this.getErrorPayloadForClientErrorCode({
           serviceErrorCode: undefined,
           clientErrorCode: _config2.SDP_OFFER_CREATION_ERROR_MAP[causeType] || _config2.SDP_OFFER_CREATION_ERROR_MAP.GENERAL,
           serviceErrorName: rawError.name,
@@ -544,8 +576,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       var serviceErrorCode = (rawError === null || rawError === void 0 ? void 0 : (_rawError$error = rawError.error) === null || _rawError$error === void 0 ? void 0 : (_rawError$error$body = _rawError$error.body) === null || _rawError$error$body === void 0 ? void 0 : _rawError$error$body.errorCode) || (rawError === null || rawError === void 0 ? void 0 : (_rawError$body = rawError.body) === null || _rawError$body === void 0 ? void 0 : _rawError$body.errorCode) || (rawError === null || rawError === void 0 ? void 0 : (_rawError$body2 = rawError.body) === null || _rawError$body2 === void 0 ? void 0 : _rawError$body2.code) || (rawError === null || rawError === void 0 ? void 0 : (_rawError$body3 = rawError.body) === null || _rawError$body3 === void 0 ? void 0 : (_rawError$body3$reaso = _rawError$body3.reason) === null || _rawError$body3$reaso === void 0 ? void 0 : _rawError$body3$reaso.reasonCode);
       if (serviceErrorCode) {
         var clientErrorCode = _config2.SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP[serviceErrorCode];
-        if (clientErrorCode) {
-          return this.getErrorPayloadForClientErrorCode({
+        if (clientErrorCode && !payload) {
+          payload = this.getErrorPayloadForClientErrorCode({
             clientErrorCode: clientErrorCode,
             serviceErrorCode: serviceErrorCode,
             rawErrorMessage: rawErrorMessage,
@@ -554,8 +586,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
         }
 
         // by default, if it is locus error, return new locus err
-        if ((0, _callDiagnosticMetrics.isLocusServiceErrorCode)(serviceErrorCode)) {
-          return this.getErrorPayloadForClientErrorCode({
+        if ((0, _callDiagnosticMetrics.isLocusServiceErrorCode)(serviceErrorCode) && !payload) {
+          payload = this.getErrorPayloadForClientErrorCode({
             clientErrorCode: _config2.NEW_LOCUS_ERROR_CLIENT_CODE,
             serviceErrorCode: serviceErrorCode,
             rawErrorMessage: rawErrorMessage,
@@ -563,16 +595,16 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
           });
         }
       }
-      if ((0, _callDiagnosticMetrics.isMeetingInfoServiceError)(rawError)) {
-        return this.getErrorPayloadForClientErrorCode({
+      if ((0, _callDiagnosticMetrics.isMeetingInfoServiceError)(rawError) && !payload) {
+        payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode: _config2.MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE,
           serviceErrorCode: serviceErrorCode,
           rawErrorMessage: rawErrorMessage,
           httpStatusCode: httpStatusCode
         });
       }
-      if ((0, _callDiagnosticMetrics.isNetworkError)(rawError)) {
-        return this.getErrorPayloadForClientErrorCode({
+      if ((0, _callDiagnosticMetrics.isNetworkError)(rawError) && !payload) {
+        payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode: _config2.NETWORK_ERROR,
           serviceErrorCode: serviceErrorCode,
           payloadOverrides: rawError.payloadOverrides,
@@ -580,8 +612,8 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
           httpStatusCode: httpStatusCode
         });
       }
-      if ((0, _callDiagnosticMetrics.isUnauthorizedError)(rawError)) {
-        return this.getErrorPayloadForClientErrorCode({
+      if ((0, _callDiagnosticMetrics.isUnauthorizedError)(rawError) && !payload) {
+        payload = this.getErrorPayloadForClientErrorCode({
           clientErrorCode: _config2.AUTHENTICATION_FAILED_CODE,
           serviceErrorCode: serviceErrorCode,
           payloadOverrides: rawError.payloadOverrides,
@@ -589,16 +621,21 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
           httpStatusCode: httpStatusCode
         });
       }
+      if (!payload) {
+        // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
+        payload = this.getErrorPayloadForClientErrorCode({
+          clientErrorCode: _config2.UNKNOWN_ERROR,
+          serviceErrorCode: serviceErrorCode || _config2.UNKNOWN_ERROR,
+          serviceErrorName: rawError === null || rawError === void 0 ? void 0 : rawError.name,
+          payloadOverrides: rawError.payloadOverrides,
+          rawErrorMessage: rawErrorMessage,
+          httpStatusCode: httpStatusCode
+        });
+      }
 
-      // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
-      return this.getErrorPayloadForClientErrorCode({
-        clientErrorCode: _config2.UNKNOWN_ERROR,
-        serviceErrorCode: serviceErrorCode || _config2.UNKNOWN_ERROR,
-        serviceErrorName: rawError === null || rawError === void 0 ? void 0 : rawError.name,
-        payloadOverrides: rawError.payloadOverrides,
-        rawErrorMessage: rawErrorMessage,
-        httpStatusCode: httpStatusCode
-      });
+      // cache the payload for future use
+      this.eventErrorCache.set(rawError, payload);
+      return [payload, false];
     }
 
     /**
@@ -645,27 +682,37 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       });
 
       // create client event object
-      var clientEventObject = {
+      var clientEventObject = _objectSpread(_objectSpread(_objectSpread({
         name: name,
         canProceed: true,
         identifiers: identifiers,
         errors: errors,
         eventData: {
-          webClientDomain: window.location.hostname
+          webClientDomain: window.location.hostname,
+          isMercuryConnected: this.isMercuryConnected
         },
         userType: meeting.getCurUserType(),
         loginType: 'loginType' in meeting.callStateForMetrics ? meeting.callStateForMetrics.loginType : this.getCurLoginType(),
         isConvergedArchitectureEnabled: this.getIsConvergedArchitectureEnabled({
           meetingId: meetingId
-        }),
+        })
+      }, meeting.userNameInput && {
+        userNameInput: meeting.userNameInput
+      }), meeting.emailInput && {
+        emailInput: meeting.emailInput
+      }), {}, {
         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
-      };
+      });
       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;
       }
+      var meetingJoinedTime = meeting.isoLocalClientMeetingJoinTime;
+      if (meetingJoinedTime) {
+        clientEventObject.meetingJoinedTime = meetingJoinedTime;
+      }
       if (options.meetingJoinPhase) {
         clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
       }
@@ -708,7 +755,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
@@ -720,6 +768,12 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       if (options.meetingJoinPhase) {
         clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
       }
+      if (options.userNameInput) {
+        clientEventObject.userNameInput = options.userNameInput;
+      }
+      if (options.emailInput) {
+        clientEventObject.emailInput = options.emailInput;
+      }
       return clientEventObject;
     }
 
@@ -746,11 +800,14 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
       // check if we need to generate errors
       var errors = [];
       if (rawError) {
-        var generatedError = this.generateClientEventErrorPayload(rawError);
+        var _this$generateClientE = this.generateClientEventErrorPayload(rawError),
+          _this$generateClientE2 = (0, _slicedToArray2.default)(_this$generateClientE, 2),
+          generatedError = _this$generateClientE2[0],
+          cached = _this$generateClientE2[1];
         if (generatedError) {
           errors.push(generatedError);
         }
-        this.logger.log(_config2.CALL_DIAGNOSTIC_LOG_IDENTIFIER, 'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:', "generatedError: ".concat((0, _stringify.default)(generatedError)));
+        this.logger.log(_config2.CALL_DIAGNOSTIC_LOG_IDENTIFIER, 'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:', "generatedError (cached: ".concat(cached, "): ").concat((0, _stringify.default)(generatedError)));
       }
 
       // events that will most likely happen in join phase
@@ -828,14 +885,22 @@ var CallDiagnosticMetrics = exports.default = /*#__PURE__*/function (_StatelessW
      */
   }, {
     key: "submitDelayedClientEvents",
-    value: function submitDelayedClientEvents() {
+    value: function submitDelayedClientEvents(overrides) {
       var _this2 = this;
       this.logger.log(_config2.CALL_DIAGNOSTIC_LOG_IDENTIFIER, 'CallDiagnosticMetrics: @submitDelayedClientEvents. Submitting delayed client events.');
       if (this.delayedClientEvents.length === 0) {
         return _promise.default.resolve();
       }
       var promises = this.delayedClientEvents.map(function (delayedSubmitClientEventParams) {
-        return _this2.submitClientEvent(delayedSubmitClientEventParams);
+        var name = delayedSubmitClientEventParams.name,
+          payload = delayedSubmitClientEventParams.payload,
+          options = delayedSubmitClientEventParams.options;
+        var optionsWithOverrides = _objectSpread(_objectSpread({}, options), overrides);
+        return _this2.submitClientEvent({
+          name: name,
+          payload: payload,
+          options: optionsWithOverrides
+        });
       });
       this.delayedClientEvents = [];
       return _promise.default.all(promises);