@atlaskit/react-ufo 3.3.0 → 3.3.2

package/dist/esm/vc/vc-observer/index.js

@@ -96,11 +96,11 @@ export var VCObserver = /*#__PURE__*/function () {
     });
     _defineProperty(this, "getVCResult", /*#__PURE__*/function () {
       var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref3) {
-        var start, stop, tti, prefix, ssr, vc, startTime, fullPrefix, rawData, abortReason, abortReasonInfo, heatmap, heatmapNext, outOfBoundaryInfo, totalTime, componentsLog, viewport, devToolsEnabled, ratios, multiHeatmap, _VCObserver$calculate, VC, VCBox, VCEntries, totalPainted, _componentsLog, vcNext, outOfBoundary, stopTime, isMultiHeatmapEnabled, revisionsData, isCalcSpeedIndexEnabled;
+        var start, stop, tti, prefix, ssr, vc, isEventAborted, startTime, fullPrefix, rawData, abortReason, abortReasonInfo, heatmap, heatmapNext, outOfBoundaryInfo, totalTime, componentsLog, viewport, devToolsEnabled, ratios, multiHeatmap, _VCObserver$calculate, VC, VCBox, VCEntries, totalPainted, _componentsLog, vcNext, outOfBoundary, stopTime, isMultiHeatmapEnabled, revisionsData, isCalcSpeedIndexEnabled, speedIndex;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              start = _ref3.start, stop = _ref3.stop, tti = _ref3.tti, prefix = _ref3.prefix, ssr = _ref3.ssr, vc = _ref3.vc;
+              start = _ref3.start, stop = _ref3.stop, tti = _ref3.tti, prefix = _ref3.prefix, ssr = _ref3.ssr, vc = _ref3.vc, isEventAborted = _ref3.isEventAborted;
               startTime = performance.now(); // add local measurement
               fullPrefix = prefix !== undefined && prefix !== '' ? "".concat(prefix, ":") : '';
               rawData = vc !== undefined ? vc : _this.getVCRawData();
@@ -233,8 +233,8 @@ export var VCObserver = /*#__PURE__*/function () {
               } catch (e) {
                 /*  do nothing */
               }
-              isMultiHeatmapEnabled = fg('ufo_vc_multiheatmap');
-              revisionsData = isMultiHeatmapEnabled && multiHeatmap !== null ? _defineProperty({}, "".concat(fullPrefix, "vc:rev"), multiHeatmap.getPayloadShapedData({
+              isMultiHeatmapEnabled = !fg('platform_ufo_multiheatmap_killswitch');
+              revisionsData = isMultiHeatmapEnabled && multiHeatmap !== null ? _defineProperty({}, "".concat(fullPrefix, "vc:rev"), multiHeatmap === null || multiHeatmap === void 0 ? void 0 : multiHeatmap.getPayloadShapedData({
                 VCParts: VCObserver.VCParts.map(function (v) {
                   return parseInt(v);
                 }),
@@ -246,15 +246,18 @@ export var VCObserver = /*#__PURE__*/function () {
                   var classifier = _ref10.classifier;
                   return classifier.filterComponentsLog;
                 }),
+                isEventAborted: isEventAborted,
+                interactionStart: start,
                 ttai: stop,
                 ssr: ssr,
                 clean: !abortReasonInfo
               })) : null; // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
               isCalcSpeedIndexEnabled = fg('ufo-calc-speed-index');
+              speedIndex = _defineProperty(_defineProperty({}, "ufo:speedIndex", VCEntries.speedIndex), "ufo:next:speedIndex", vcNext.VCEntries.speedIndex);
               return _context.abrupt("return", _objectSpread(_objectSpread(_objectSpread(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({
                 'metrics:vc': VC
-              }, "".concat(fullPrefix, "vc:state"), true), "".concat(fullPrefix, "vc:clean"), !abortReasonInfo), "".concat(fullPrefix, "vc:dom"), VCBox), "".concat(fullPrefix, "vc:updates"), VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:size"), viewport), "".concat(fullPrefix, "vc:time"), Math.round(totalTime + (stopTime - startTime))), "".concat(fullPrefix, "vc:total"), totalPainted), "".concat(fullPrefix, "vc:ratios"), ratios), outOfBoundary), {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(fullPrefix, "vc:next"), vcNext.VC), "".concat(fullPrefix, "vc:next:updates"), vcNext.VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:next:dom"), vcNext.VCBox), "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)), revisionsData), {}, _defineProperty(_defineProperty({}, "ufo:speedIndex", isCalcSpeedIndexEnabled ? VCEntries.speedIndex : undefined), "ufo:next:speedIndex", isCalcSpeedIndexEnabled ? vcNext.VCEntries.speedIndex : undefined)));
-            case 23:
+              }, "".concat(fullPrefix, "vc:state"), true), "".concat(fullPrefix, "vc:clean"), !abortReasonInfo), "".concat(fullPrefix, "vc:dom"), VCBox), "".concat(fullPrefix, "vc:updates"), VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:size"), viewport), "".concat(fullPrefix, "vc:time"), Math.round(totalTime + (stopTime - startTime))), "".concat(fullPrefix, "vc:total"), totalPainted), "".concat(fullPrefix, "vc:ratios"), ratios), outOfBoundary), {}, _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(fullPrefix, "vc:next"), vcNext.VC), "".concat(fullPrefix, "vc:next:updates"), vcNext.VCEntries.rel.slice(0, 50)), "".concat(fullPrefix, "vc:next:dom"), vcNext.VCBox), "".concat(fullPrefix, "vc:ignored"), _this.getIgnoredElements(componentsLog)), revisionsData), isCalcSpeedIndexEnabled ? speedIndex : {}));
+            case 24:
             case "end":
               return _context.stop();
           }
@@ -267,16 +270,14 @@ export var VCObserver = /*#__PURE__*/function () {
     _defineProperty(this, "handleUpdate", function (rawTime, intersectionRect, targetName, element, type, ignoreReason) {
       _this.measureStart();
       _this.legacyHandleUpdate(rawTime, intersectionRect, targetName, element, type, ignoreReason);
-      if (fg('ufo_vc_multiheatmap')) {
-        _this.onViewportChangeDetected({
-          timestamp: rawTime,
-          intersectionRect: intersectionRect,
-          targetName: targetName,
-          element: element,
-          type: type,
-          ignoreReason: ignoreReason
-        });
-      }
+      _this.onViewportChangeDetected({
+        timestamp: rawTime,
+        intersectionRect: intersectionRect,
+        targetName: targetName,
+        element: element,
+        type: type,
+        ignoreReason: ignoreReason
+      });
       _this.measureStop();
     });
     _defineProperty(this, "legacyHandleUpdate", function (rawTime, intersectionRect, targetName, element, type, ignoreReason) {
@@ -416,13 +417,11 @@ export var VCObserver = /*#__PURE__*/function () {
     });
     this.heatmap = this.getCleanHeatmap();
     this.heatmapNext = this.getCleanHeatmap();
-    if (fg('ufo_vc_multiheatmap')) {
-      this.multiHeatmap = new MultiRevisionHeatmap({
-        viewport: this.viewport,
-        revisions: getRevisions(),
-        devToolsEnabled: this.devToolsEnabled
-      });
-    }
+    this.multiHeatmap = new MultiRevisionHeatmap({
+      viewport: this.viewport,
+      revisions: getRevisions(),
+      devToolsEnabled: this.devToolsEnabled
+    });
     this.isPostInteraction = options.isPostInteraction || false;
   }
   return _createClass(VCObserver, [{
@@ -505,13 +504,11 @@ export var VCObserver = /*#__PURE__*/function () {
       this.detachAbortListeners();
       this.heatmap = this.getCleanHeatmap();
       this.heatmapNext = this.getCleanHeatmap();
-      if (fg('ufo_vc_multiheatmap')) {
-        this.multiHeatmap = new MultiRevisionHeatmap({
-          viewport: this.viewport,
-          revisions: getRevisions(),
-          devToolsEnabled: this.devToolsEnabled
-        });
-      }
+      this.multiHeatmap = new MultiRevisionHeatmap({
+        viewport: this.viewport,
+        revisions: getRevisions(),
+        devToolsEnabled: this.devToolsEnabled
+      });
       this.totalTime = 0;
       this.componentsLog = {};
       this.vcRatios = {};

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/vc/types.d.ts

@@ -3,6 +3,7 @@ export type GetVCResultType = {
     start: number;
     stop: number;
     tti: number;
+    isEventAborted: boolean;
     prefix?: string;
     ssr?: number;
     vc?: VCRawDataType | null;

package/dist/types/vc/vc-observer/heatmap/heatmap.d.ts

@@ -20,6 +20,8 @@ type ProcessDataArgs = {
     VCParts: number[];
     VCCalculationMethods: VCCalculationMethodType[];
     clean: boolean;
+    isEventAborted: boolean;
+    interactionStart: number;
     ttai: number;
     filterComponentsLog: FilterComponentsLogType[];
     ssr?: number;

package/dist/types/vc/vc-observer/index.d.ts

@@ -41,7 +41,7 @@ export declare class VCObserver implements VCObserverInterface {
         targetName: string;
         ignoreReason: VCIgnoreReason | undefined;
     }[];
-    getVCResult: ({ start, stop, tti, prefix, ssr, vc, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

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/dist/types-ts4.5/vc/types.d.ts

@@ -3,6 +3,7 @@ export type GetVCResultType = {
     start: number;
     stop: number;
     tti: number;
+    isEventAborted: boolean;
     prefix?: string;
     ssr?: number;
     vc?: VCRawDataType | null;

package/dist/types-ts4.5/vc/vc-observer/heatmap/heatmap.d.ts

@@ -20,6 +20,8 @@ type ProcessDataArgs = {
     VCParts: number[];
     VCCalculationMethods: VCCalculationMethodType[];
     clean: boolean;
+    isEventAborted: boolean;
+    interactionStart: number;
     ttai: number;
     filterComponentsLog: FilterComponentsLogType[];
     ssr?: number;

package/dist/types-ts4.5/vc/vc-observer/index.d.ts

@@ -51,7 +51,7 @@ export declare class VCObserver implements VCObserverInterface {
         targetName: string;
         ignoreReason: VCIgnoreReason | undefined;
     }[];
-    getVCResult: ({ start, stop, tti, prefix, ssr, vc, }: GetVCResultType) => Promise<VCResult>;
+    getVCResult: ({ start, stop, tti, prefix, ssr, vc, isEventAborted, }: GetVCResultType) => Promise<VCResult>;
     static calculateVC({ heatmap, ssr, componentsLog, viewport, }: {
         heatmap: number[][];
         ssr?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.3.0",
+	"version": "3.3.2",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -151,9 +151,6 @@
 		"ufo-remove-vc-component-observations-after-ttai": {
 			"type": "boolean"
 		},
-		"ufo_vc_multiheatmap": {
-			"type": "boolean"
-		},
 		"ufo-calc-speed-index": {
 			"type": "boolean"
 		},
@@ -174,6 +171,12 @@
 		},
 		"enable_ufo_devtools_api_for_extra_events": {
 			"type": "boolean"
+		},
+		"platform_ufo_multiheatmap_killswitch": {
+			"type": "boolean"
+		},
+		"platform_ufo_no_vc_on_aborted": {
+			"type": "boolean"
 		}
 	}
 }