@atlaskit/react-ufo 2.4.5 → 2.4.7

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 2.4.7
+
+### Patch Changes
+
+- [#175818](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/175818)
+  [`1401a5646d271`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1401a5646d271) -
+  Add experimentalTTAI and experimentalVC90 to custom.post-interaction-log
+- [#173211](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/173211)
+  [`202bc8df0c75a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/202bc8df0c75a) -
+  Experimental UFO holds, VC90 and TTAI metrics
+- [#175826](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/175826)
+  [`b5c5bf59d1cff`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b5c5bf59d1cff) -
+  add rate limiting to experimental interaction metrics
+
+## 2.4.6
+
+### Patch Changes
+
+- [#174829](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/174829)
+  [`381735c03773b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/381735c03773b) -
+  add ufo: prefix to error count and stylesheet count metrics
+- [#174760](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/174760)
+  [`0c5bbf0079bee`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0c5bbf0079bee) -
+  Remove display style attribute mutation check
+
 ## 2.4.5
 
 ### Patch Changes

package/create-experimental-interaction-metrics-payload/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/react-ufo/create-experimental-interaction-metrics-payload",
+  "main": "../dist/cjs/create-experimental-interaction-metrics-payload/index.js",
+  "module": "../dist/esm/create-experimental-interaction-metrics-payload/index.js",
+  "module:es2019": "../dist/es2019/create-experimental-interaction-metrics-payload/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/create-experimental-interaction-metrics-payload/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/create-experimental-interaction-metrics-payload/index.d.ts"
+      ]
+    }
+  }
+}

package/dist/cjs/config/index.js

@@ -8,6 +8,7 @@ exports.getCapabilityRate = getCapabilityRate;
 exports.getConfig = getConfig;
 exports.getDoNotAbortActivePressInteraction = getDoNotAbortActivePressInteraction;
 exports.getDoNotAbortActivePressInteractionOnTransition = getDoNotAbortActivePressInteractionOnTransition;
+exports.getExperimentalInteractionRate = getExperimentalInteractionRate;
 exports.getInteractionRate = getInteractionRate;
 exports.getPostInteractionRate = getPostInteractionRate;
 exports.getRemoveInteractionsUFOPrefixes = getRemoveInteractionsUFOPrefixes;
@@ -81,13 +82,34 @@ function getInteractionRate(name, interactionKind) {
     return 0;
   }
 }
-function getPostInteractionRate(name, interactionType) {
+function getExperimentalInteractionRate(name, interactionType) {
   try {
     if (!config) {
       return 0;
     }
     var _config2 = config,
-      postInteractionLog = _config2.postInteractionLog;
+      experimentalInteractionMetrics = _config2.experimentalInteractionMetrics;
+    if (!(experimentalInteractionMetrics !== null && experimentalInteractionMetrics !== void 0 && experimentalInteractionMetrics.enabled)) {
+      return 0;
+    }
+    if (experimentalInteractionMetrics.rates && typeof experimentalInteractionMetrics.rates[name] === 'number') {
+      return experimentalInteractionMetrics.rates[name];
+    }
+    if (experimentalInteractionMetrics.kind && typeof experimentalInteractionMetrics.kind[interactionType] === 'number') {
+      return experimentalInteractionMetrics.kind[interactionType];
+    }
+    return 0;
+  } catch (e) {
+    return 0;
+  }
+}
+function getPostInteractionRate(name, interactionType) {
+  try {
+    if (!config) {
+      return 0;
+    }
+    var _config3 = config,
+      postInteractionLog = _config3.postInteractionLog;
     if (!(postInteractionLog !== null && postInteractionLog !== void 0 && postInteractionLog.enabled)) {
       return 0;
     }
@@ -107,8 +129,8 @@ function getCapabilityRate(capability) {
     if (!config) {
       return 0;
     }
-    var _config3 = config,
-      capabilityRate = _config3.capability;
+    var _config4 = config,
+      capabilityRate = _config4.capability;
     if (capabilityRate != null) {
       var rate = capabilityRate[capability];
       if (rate != null) {
@@ -127,8 +149,8 @@ function getTypingPerformanceTracingMethod() {
     if (!config) {
       return defaultMethod;
     }
-    var _config4 = config,
-      typingMethod = _config4.typingMethod;
+    var _config5 = config,
+      typingMethod = _config5.typingMethod;
     if (typingMethod != null && validTypingMethods.find(function (m) {
       return m === typingMethod;
     })) {
@@ -147,8 +169,8 @@ function getAwaitBM3TTIList() {
     if (!config) {
       return [];
     }
-    var _config5 = config,
-      awaitBM3TTI = _config5.awaitBM3TTI;
+    var _config6 = config,
+      awaitBM3TTI = _config6.awaitBM3TTI;
     if (awaitBM3TTI != null) {
       return awaitBM3TTI;
     } else {
@@ -165,8 +187,8 @@ function getRemovePageSegmentsUFOPrefixes() {
     if (!config) {
       return false;
     }
-    var _config6 = config,
-      removePageSegmentsUFOPrefixes = _config6.removePageSegmentsUFOPrefixes;
+    var _config7 = config,
+      removePageSegmentsUFOPrefixes = _config7.removePageSegmentsUFOPrefixes;
     if (removePageSegmentsUFOPrefixes != null) {
       return removePageSegmentsUFOPrefixes;
     } else {
@@ -183,8 +205,8 @@ function getRemoveInteractionsUFOPrefixes() {
     if (!config) {
       return false;
     }
-    var _config7 = config,
-      removeInteractionsUFOPrefixes = _config7.removeInteractionsUFOPrefixes;
+    var _config8 = config,
+      removeInteractionsUFOPrefixes = _config8.removeInteractionsUFOPrefixes;
     if (removeInteractionsUFOPrefixes != null) {
       return removeInteractionsUFOPrefixes;
     } else {
@@ -204,8 +226,8 @@ function getUfoNameOverrides() {
     if (!config) {
       return undefined;
     }
-    var _config8 = config,
-      ufoNameOverrides = _config8.ufoNameOverrides;
+    var _config9 = config,
+      ufoNameOverrides = _config9.ufoNameOverrides;
     if (ufoNameOverrides != null) {
       return ufoNameOverrides;
     }
@@ -221,8 +243,8 @@ function getDoNotAbortActivePressInteraction() {
     if (!config) {
       return undefined;
     }
-    var _config9 = config,
-      doNotAbortActivePressInteraction = _config9.doNotAbortActivePressInteraction;
+    var _config10 = config,
+      doNotAbortActivePressInteraction = _config10.doNotAbortActivePressInteraction;
     return doNotAbortActivePressInteraction;
   } catch (e) {
     return undefined;
@@ -235,8 +257,8 @@ function getDoNotAbortActivePressInteractionOnTransition() {
     if (!config) {
       return undefined;
     }
-    var _config10 = config,
-      doNotAbortActivePressInteractionOnTransition = _config10.doNotAbortActivePressInteractionOnTransition;
+    var _config11 = config,
+      doNotAbortActivePressInteractionOnTransition = _config11.doNotAbortActivePressInteractionOnTransition;
     return doNotAbortActivePressInteractionOnTransition;
   } catch (e) {
     return undefined;

package/dist/cjs/create-experimental-interaction-metrics-payload/index.js

@@ -0,0 +1,89 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ExperimentalInteractionMetrics = void 0;
+exports.createExperimentalInteractionMetricsPayload = createExperimentalInteractionMetricsPayload;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _coinflip = _interopRequireDefault(require("../coinflip"));
+var _config = require("../config");
+var _createPayload = require("../create-payload");
+var _hiddenTiming = require("../hidden-timing");
+var _vcObserver = require("../vc/vc-observer");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var ExperimentalInteractionMetrics = exports.ExperimentalInteractionMetrics = /*#__PURE__*/function () {
+  function ExperimentalInteractionMetrics() {
+    (0, _classCallCheck2.default)(this, ExperimentalInteractionMetrics);
+    /**
+     * Handler function to process / send the observation data
+     */
+    (0, _defineProperty2.default)(this, "sinkHandlerFn", function () {});
+    /**
+     * independent VC observer that observes until `custom.post-interaction-logs` event is sent
+     */
+    (0, _defineProperty2.default)(this, "vcObserver", null);
+  }
+  (0, _createClass2.default)(ExperimentalInteractionMetrics, [{
+    key: "sinkHandler",
+    value:
+    /**
+     * Set the fn that would be invoked to process / send the observation data
+     */
+    function sinkHandler(sinkHandlerFn) {
+      this.sinkHandlerFn = sinkHandlerFn;
+    }
+  }, {
+    key: "onInteractionComplete",
+    value: function onInteractionComplete(interactionId, data) {
+      var endTime = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : performance.now();
+      if (data.ufoName) {
+        data.end = endTime;
+        this.sinkHandlerFn(interactionId, data);
+      }
+    }
+  }, {
+    key: "initializeVCObserver",
+    value: function initializeVCObserver(options) {
+      if (this.vcObserver === null) {
+        this.vcObserver = new _vcObserver.VCObserver(_objectSpread(_objectSpread({}, options), {}, {
+          isPostInteraction: true
+        }));
+      }
+      return this;
+    }
+  }, {
+    key: "startVCObserver",
+    value: function startVCObserver(_ref) {
+      var _this$vcObserver;
+      var startTime = _ref.startTime;
+      (_this$vcObserver = this.vcObserver) === null || _this$vcObserver === void 0 || _this$vcObserver.start({
+        startTime: startTime
+      });
+    }
+  }]);
+  return ExperimentalInteractionMetrics;
+}();
+function createExperimentalInteractionMetricsPayload(interactionId, interaction) {
+  var config = (0, _config.getConfig)();
+  if (!config) {
+    throw Error('UFO Configuration not provided');
+  }
+  var ufoName = (0, _createPayload.getUfoNameOverride)(interaction);
+  var modifiedInteraction = _objectSpread(_objectSpread({}, interaction), {}, {
+    ufoName: ufoName
+  });
+  var rate = (0, _config.getExperimentalInteractionRate)(ufoName, interaction.type);
+  if (!(0, _coinflip.default)(rate)) {
+    return null;
+  }
+  var pageVisibilityState = (0, _hiddenTiming.getPageVisibilityState)(interaction.start, interaction.end);
+  if (pageVisibilityState !== 'visible') {
+    return null;
+  }
+  return (0, _createPayload.createInteractionMetricsPayload)(modifiedInteraction, interactionId, true);
+}

package/dist/cjs/create-payload/common/utils/index.js

@@ -1,10 +1,14 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.buildSegmentTree = buildSegmentTree;
+exports.getPageVisibilityUpToTTAI = exports.getInteractionStatus = exports.getExperimentalVCMetrics = exports.calculateVCMetrics = void 0;
+exports.getSSRDoneTimeValue = getSSRDoneTimeValue;
+exports.getVCMetrics = exports.getTTAI = void 0;
 exports.isSegmentLabel = isSegmentLabel;
 exports.labelStackStartWith = labelStackStartWith;
 exports.optimizeLabelStack = optimizeLabelStack;
@@ -12,6 +16,13 @@ exports.sanitizeUfoName = void 0;
 exports.stringifyLabelStackFully = stringifyLabelStackFully;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _constants = require("../../../common/constants");
+var _config = require("../../../config");
+var _hiddenTiming = require("../../../hidden-timing");
+var _interactionMetrics = require("../../../interaction-metrics");
+var ssr = _interopRequireWildcard(require("../../../ssr"));
+var _vc = require("../../../vc");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
 var sanitizeUfoName = exports.sanitizeUfoName = function sanitizeUfoName(name) {
@@ -70,4 +81,77 @@ function optimizeLabelStack(labelStack) {
       s: ls.segmentId
     } : {});
   });
-}
+}
+var getInteractionStatus = exports.getInteractionStatus = function getInteractionStatus(interaction) {
+  var originalInteractionStatus = interaction.abortReason ? 'ABORTED' : 'SUCCEEDED';
+  var hasBm3TTI = interaction.apdex.length > 0;
+  var overrideStatus = hasBm3TTI ? 'SUCCEEDED' : originalInteractionStatus;
+  return {
+    originalInteractionStatus: originalInteractionStatus,
+    overrideStatus: overrideStatus
+  };
+};
+var getPageVisibilityUpToTTAI = exports.getPageVisibilityUpToTTAI = function getPageVisibilityUpToTTAI(interaction) {
+  var start = interaction.start,
+    end = interaction.end;
+  return (0, _hiddenTiming.getPageVisibilityState)(start, end);
+};
+var calculateVCMetrics = exports.calculateVCMetrics = function calculateVCMetrics(interaction, prefix, getVCResultFn) {
+  var _interaction$apdex;
+  var result = getVCResultFn({
+    start: interaction.start,
+    stop: interaction.end,
+    tti: (_interaction$apdex = interaction.apdex) === null || _interaction$apdex === void 0 || (_interaction$apdex = _interaction$apdex[0]) === null || _interaction$apdex === void 0 ? void 0 : _interaction$apdex.stopTime,
+    prefix: prefix,
+    vc: interaction.vc
+  });
+  var VC = result === null || result === void 0 ? void 0 : result['metrics:vc'];
+  if (!VC || !(result !== null && result !== void 0 && result["".concat(prefix, ":vc:clean")])) {
+    return result;
+  }
+  var interactionStatus = getInteractionStatus(interaction);
+  var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
+  if (interactionStatus.originalInteractionStatus !== 'SUCCEEDED' || pageVisibilityUpToTTAI !== 'visible') {
+    return result;
+  }
+  return result;
+};
+function getSSRDoneTimeValue(config) {
+  var _config$ssr, _config$ssr2;
+  return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 || (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : ssr.getSSRDoneTime();
+}
+var getVCMetrics = exports.getVCMetrics = function getVCMetrics(interaction) {
+  var _config$vc, _result$metricsVc;
+  var config = (0, _config.getConfig)();
+  if (!(config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled)) {
+    return {};
+  }
+  if (interaction.type !== 'page_load' && interaction.type !== 'transition') {
+    return {};
+  }
+  var ssr = interaction.type === 'page_load' && config !== null && config !== void 0 && config.ssr ? {
+    ssr: getSSRDoneTimeValue(config)
+  } : null;
+  _interactionMetrics.postInteractionLog.setVCObserverSSRConfig(ssr);
+  var result = calculateVCMetrics(interaction, 'ufo', (0, _vc.getVCObserver)().getVCResult);
+  return _objectSpread(_objectSpread({}, result), {}, {
+    'metric:vc90': result === null || result === void 0 || (_result$metricsVc = result['metrics:vc']) === null || _result$metricsVc === void 0 ? void 0 : _result$metricsVc['90']
+  });
+};
+var getExperimentalVCMetrics = exports.getExperimentalVCMetrics = function getExperimentalVCMetrics(interaction) {
+  if (_interactionMetrics.experimentalInteractionLog.vcObserver) {
+    var _result$metricsVc2;
+    var result = calculateVCMetrics(interaction, 'ufo-experimental', _interactionMetrics.experimentalInteractionLog.vcObserver.getVCResult);
+    return _objectSpread(_objectSpread({}, result), {}, {
+      'metric:experimental:vc90': result === null || result === void 0 || (_result$metricsVc2 = result['metrics:vc']) === null || _result$metricsVc2 === void 0 ? void 0 : _result$metricsVc2['90']
+    });
+  }
+  return null;
+};
+var getTTAI = exports.getTTAI = function getTTAI(interaction) {
+  var start = interaction.start,
+    end = interaction.end;
+  var interactionStatus = getInteractionStatus(interaction);
+  var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
+  return interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible' ? Math.round(end - start) : undefined;
+};