@atlaskit/react-ufo 3.3.1 → 3.3.2

package/dist/esm/create-payload/utils/get-interaction-status.js

@@ -0,0 +1,31 @@
+/**
+ * Determines the interaction status based on abort reason and BM3 TTI presence.
+ *
+ * @param {InteractionMetrics} interaction - The interaction metrics object containing abort reason and apdex data
+ * @returns {{
+ *   originalInteractionStatus: 'ABORTED' | 'SUCCEEDED',
+ *   overrideStatus: 'ABORTED' | 'SUCCEEDED'
+ * }} An object containing both the original and override status
+ *
+ * @description
+ * This function evaluates the interaction status in two ways:
+ * 1. originalInteractionStatus: Based on whether there's an abort reason
+ * 2. overrideStatus: Based on the presence of BM3 TTI (apdex data)
+ *
+ * @example
+ * const interaction = {
+ *   abortReason: null,
+ *   apdex: [1, 2, 3]
+ * };
+ * const result = getInteractionStatus(interaction);
+ * // Returns: { originalInteractionStatus: 'SUCCEEDED', overrideStatus: 'SUCCEEDED' }
+ */
+export default 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
+  };
+}

package/dist/esm/create-payload/utils/get-page-visibility-up-to-ttai.js

@@ -0,0 +1,6 @@
+import { getPageVisibilityState } from '../../hidden-timing';
+export default function getPageVisibilityUpToTTAI(interaction) {
+  var start = interaction.start,
+    end = interaction.end;
+  return getPageVisibilityState(start, end);
+}

package/dist/esm/create-payload/utils/get-ssr-done-time-value.js

@@ -0,0 +1,5 @@
+import * as ssr from '../../ssr';
+export default 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();
+}

package/dist/esm/create-payload/utils/get-vc-metrics.js

@@ -0,0 +1,89 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+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) { _defineProperty(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; }
+import { fg } from '@atlaskit/platform-feature-flags';
+import { getConfig } from '../../config';
+import { postInteractionLog } from '../../interaction-metrics';
+import { getVCObserver } from '../../vc';
+import getInteractionStatus from './get-interaction-status';
+import getPageVisibilityUpToTTAI from './get-page-visibility-up-to-ttai';
+import getSSRDoneTimeValue from './get-ssr-done-time-value';
+export default function getVCMetrics(_x) {
+  return _getVCMetrics.apply(this, arguments);
+}
+function _getVCMetrics() {
+  _getVCMetrics = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(interaction) {
+    var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$experimentalI;
+    var config, interactionStatus, pageVisibilityUpToTTAI, isSSREnabled, ssr, tti, prefix, result, VC;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          config = getConfig();
+          if (config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {
+            _context.next = 3;
+            break;
+          }
+          return _context.abrupt("return", {});
+        case 3:
+          if (!(interaction.type !== 'page_load' && interaction.type !== 'transition')) {
+            _context.next = 5;
+            break;
+          }
+          return _context.abrupt("return", {});
+        case 5:
+          interactionStatus = getInteractionStatus(interaction);
+          pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
+          if (!((interactionStatus.originalInteractionStatus !== 'SUCCEEDED' || pageVisibilityUpToTTAI !== 'visible') && fg('platform_ufo_no_vc_on_aborted'))) {
+            _context.next = 9;
+            break;
+          }
+          return _context.abrupt("return", {});
+        case 9:
+          isSSREnabled = (config === null || config === void 0 ? void 0 : config.ssr) || (config === null || config === void 0 || (_config$vc$ssrWhiteli = config.vc.ssrWhitelist) === null || _config$vc$ssrWhiteli === void 0 ? void 0 : _config$vc$ssrWhiteli.includes(interaction.ufoName));
+          ssr = interaction.type === 'page_load' && isSSREnabled ? {
+            ssr: getSSRDoneTimeValue(config)
+          } : null;
+          postInteractionLog.setVCObserverSSRConfig(ssr);
+          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 = 'ufo';
+          _context.next = 16;
+          return getVCObserver().getVCResult(_objectSpread({
+            start: interaction.start,
+            stop: interaction.end,
+            tti: tti,
+            prefix: prefix,
+            vc: interaction.vc,
+            isEventAborted: interactionStatus.originalInteractionStatus !== 'SUCCEEDED'
+          }, ssr));
+        case 16:
+          result = _context.sent;
+          if ((_config$experimentalI = config.experimentalInteractionMetrics) !== null && _config$experimentalI !== void 0 && _config$experimentalI.enabled) {
+            getVCObserver().stop();
+          }
+          postInteractionLog.setLastInteractionFinishVCResult(result);
+          VC = result === null || result === void 0 ? void 0 : result['metrics:vc'];
+          if (!(!VC || !(result !== null && result !== void 0 && result["".concat(prefix, ":vc:clean")]))) {
+            _context.next = 22;
+            break;
+          }
+          return _context.abrupt("return", result);
+        case 22:
+          if (!(interactionStatus.originalInteractionStatus !== 'SUCCEEDED' || pageVisibilityUpToTTAI !== 'visible')) {
+            _context.next = 24;
+            break;
+          }
+          return _context.abrupt("return", result);
+        case 24:
+          return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
+            'metric:vc90': VC['90']
+          }));
+        case 25:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _getVCMetrics.apply(this, arguments);
+}

package/dist/types/create-payload/utils/get-interaction-status.d.ts

@@ -0,0 +1,27 @@
+import type { InteractionMetrics } from '../../common';
+/**
+ * Determines the interaction status based on abort reason and BM3 TTI presence.
+ *
+ * @param {InteractionMetrics} interaction - The interaction metrics object containing abort reason and apdex data
+ * @returns {{
+ *   originalInteractionStatus: 'ABORTED' | 'SUCCEEDED',
+ *   overrideStatus: 'ABORTED' | 'SUCCEEDED'
+ * }} An object containing both the original and override status
+ *
+ * @description
+ * This function evaluates the interaction status in two ways:
+ * 1. originalInteractionStatus: Based on whether there's an abort reason
+ * 2. overrideStatus: Based on the presence of BM3 TTI (apdex data)
+ *
+ * @example
+ * const interaction = {
+ *   abortReason: null,
+ *   apdex: [1, 2, 3]
+ * };
+ * const result = getInteractionStatus(interaction);
+ * // Returns: { originalInteractionStatus: 'SUCCEEDED', overrideStatus: 'SUCCEEDED' }
+ */
+export default function getInteractionStatus(interaction: InteractionMetrics): {
+    readonly originalInteractionStatus: "ABORTED" | "SUCCEEDED";
+    readonly overrideStatus: "ABORTED" | "SUCCEEDED";
+};

package/dist/types/create-payload/utils/get-page-visibility-up-to-ttai.d.ts

@@ -0,0 +1,2 @@
+import type { InteractionMetrics } from '../../common';
+export default function getPageVisibilityUpToTTAI(interaction: InteractionMetrics): import("../../hidden-timing").PageVisibility;

package/dist/types/create-payload/utils/get-ssr-done-time-value.d.ts

@@ -0,0 +1,2 @@
+import { type Config } from '../../config';
+export default function getSSRDoneTimeValue(config: Config | undefined): number | undefined;

package/dist/types/create-payload/utils/get-vc-metrics.d.ts

@@ -0,0 +1,5 @@
+import { type InteractionMetrics } from '../../common';
+import type { VCResult } from '../../common/vc/types';
+export default function getVCMetrics(interaction: InteractionMetrics): Promise<VCResult & {
+    'metric:vc90'?: number | null;
+}>;

package/dist/types-ts4.5/create-payload/utils/get-interaction-status.d.ts

@@ -0,0 +1,27 @@
+import type { InteractionMetrics } from '../../common';
+/**
+ * Determines the interaction status based on abort reason and BM3 TTI presence.
+ *
+ * @param {InteractionMetrics} interaction - The interaction metrics object containing abort reason and apdex data
+ * @returns {{
+ *   originalInteractionStatus: 'ABORTED' | 'SUCCEEDED',
+ *   overrideStatus: 'ABORTED' | 'SUCCEEDED'
+ * }} An object containing both the original and override status
+ *
+ * @description
+ * This function evaluates the interaction status in two ways:
+ * 1. originalInteractionStatus: Based on whether there's an abort reason
+ * 2. overrideStatus: Based on the presence of BM3 TTI (apdex data)
+ *
+ * @example
+ * const interaction = {
+ *   abortReason: null,
+ *   apdex: [1, 2, 3]
+ * };
+ * const result = getInteractionStatus(interaction);
+ * // Returns: { originalInteractionStatus: 'SUCCEEDED', overrideStatus: 'SUCCEEDED' }
+ */
+export default function getInteractionStatus(interaction: InteractionMetrics): {
+    readonly originalInteractionStatus: "ABORTED" | "SUCCEEDED";
+    readonly overrideStatus: "ABORTED" | "SUCCEEDED";
+};

package/dist/types-ts4.5/create-payload/utils/get-page-visibility-up-to-ttai.d.ts

@@ -0,0 +1,2 @@
+import type { InteractionMetrics } from '../../common';
+export default function getPageVisibilityUpToTTAI(interaction: InteractionMetrics): import("../../hidden-timing").PageVisibility;

package/dist/types-ts4.5/create-payload/utils/get-ssr-done-time-value.d.ts

@@ -0,0 +1,2 @@
+import { type Config } from '../../config';
+export default function getSSRDoneTimeValue(config: Config | undefined): number | undefined;

package/dist/types-ts4.5/create-payload/utils/get-vc-metrics.d.ts

@@ -0,0 +1,5 @@
+import { type InteractionMetrics } from '../../common';
+import type { VCResult } from '../../common/vc/types';
+export default function getVCMetrics(interaction: InteractionMetrics): Promise<VCResult & {
+    'metric:vc90'?: number | null;
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.3.1",
+	"version": "3.3.2",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -174,6 +174,9 @@
 		},
 		"platform_ufo_multiheatmap_killswitch": {
 			"type": "boolean"
+		},
+		"platform_ufo_no_vc_on_aborted": {
+			"type": "boolean"
 		}
 	}
 }