@atlaskit/react-ufo 4.5.11 → 4.6.0

package/dist/esm/interaction-metrics/index.js

@@ -1055,7 +1055,8 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
     trace: trace,
     vcObserver: vcObserver,
     hold3pActive: new Map(),
-    hold3pInfo: []
+    hold3pInfo: [],
+    minorInteractions: []
   };
   if (addFeatureFlagsToInteraction) {
     currentFeatureFlagsAccessed.clear();

package/dist/esm/segment/segment.js

@@ -5,12 +5,13 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import React, { lazy, Profiler, Suspense, useCallback, useContext, useEffect, useMemo, useRef } from 'react';
 import { unstable_NormalPriority as NormalPriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
 import { v4 as createUUID } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
-import { getConfig, getInteractionRate } from '../config';
+import { getConfig, getDoNotAbortActivePressInteraction, getInteractionRate, getMinorInteractions } from '../config';
 import { getActiveTrace, setInteractionActiveTrace } from '../experience-trace-id-context';
 import UFOInteractionContext from '../interaction-context';
 import UFOInteractionIDContext from '../interaction-id-context';
-import { abortByNewInteraction, addApdex as _addApdex, addCustomData as _addCustomData, addCustomTiming, addHold, addHoldByID, addMark as _addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
+import { abortByNewInteraction, addApdex as _addApdex, addCustomData as _addCustomData, addCustomTiming, addHold, addHoldByID, addMark as _addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, getActiveInteraction, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
 import generateId from '../short-id';
 import scheduleOnPaint from './schedule-on-paint';
@@ -161,8 +162,24 @@ export default function UFOSegment(_ref) {
       tracePress: function tracePress() {
         var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'unknown';
         var timestamp = arguments.length > 1 ? arguments[1] : undefined;
-        if (interactionId.current != null) {
-          abortByNewInteraction(interactionId.current, name);
+        if (fg('platform_ufo_enable_minor_interactions')) {
+          var _getDoNotAbortActiveP, _getMinorInteractions;
+          var minorInteractions = [].concat(_toConsumableArray((_getDoNotAbortActiveP = getDoNotAbortActivePressInteraction()) !== null && _getDoNotAbortActiveP !== void 0 ? _getDoNotAbortActiveP : []), _toConsumableArray((_getMinorInteractions = getMinorInteractions()) !== null && _getMinorInteractions !== void 0 ? _getMinorInteractions : []));
+          if (minorInteractions.includes(name)) {
+            var _activeInteraction$mi;
+            var activeInteraction = getActiveInteraction();
+            activeInteraction === null || activeInteraction === void 0 || (_activeInteraction$mi = activeInteraction.minorInteractions) === null || _activeInteraction$mi === void 0 || _activeInteraction$mi.push({
+              name: name,
+              startTime: timestamp !== null && timestamp !== void 0 ? timestamp : performance.now()
+            });
+            return;
+          } else if (interactionId.current != null) {
+            abortByNewInteraction(interactionId.current, name);
+          }
+        } else {
+          if (interactionId.current != null) {
+            abortByNewInteraction(interactionId.current, name);
+          }
         }
         var rate = getInteractionRate(name, 'press');
         if (coinflip(rate)) {

package/dist/esm/trace-hover/index.js

@@ -0,0 +1,5 @@
+import { default as internal_traceUFOInteraction } from '../trace-interaction/internal/trace-ufo-interaction';
+function traceUFOHover(name, timestamp) {
+  return internal_traceUFOInteraction(name, 'hover', timestamp);
+}
+export default traceUFOHover;

package/dist/esm/trace-interaction/internal/trace-ufo-interaction.js

@@ -1,6 +1,7 @@
 import { v4 as createUUID } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../../coinflip';
-import { getDoNotAbortActivePressInteraction, getInteractionRate } from '../../config';
+import { getDoNotAbortActivePressInteraction, getInteractionRate, getMinorInteractions } from '../../config';
 import { getActiveTrace, setInteractionActiveTrace } from '../../experience-trace-id-context';
 import { DefaultInteractionID } from '../../interaction-id-context';
 import { abortAll, addNewInteraction, getActiveInteraction } from '../../interaction-metrics';
@@ -8,15 +9,31 @@ import UFORouteName from '../../route-name-context';
 function traceUFOInteraction(name, interactionType, startTime) {
   var rate = getInteractionRate(name, interactionType);
   var pressInteractionsList = getDoNotAbortActivePressInteraction();
-  if (pressInteractionsList !== null && pressInteractionsList !== void 0 && pressInteractionsList.includes(name)) {
-    var interaction = getActiveInteraction();
-    if ((interaction === null || interaction === void 0 ? void 0 : interaction.ufoName) !== 'unknown' && (interaction === null || interaction === void 0 ? void 0 : interaction.type) === 'press') {
+  if (fg('platform_ufo_enable_minor_interactions')) {
+    var _getMinorInteractions;
+    var minorInteractions = (pressInteractionsList !== null && pressInteractionsList !== void 0 ? pressInteractionsList : []).concat((_getMinorInteractions = getMinorInteractions()) !== null && _getMinorInteractions !== void 0 ? _getMinorInteractions : []);
+    if (minorInteractions.includes(name)) {
+      var _activeInteraction$mi;
+      var activeInteraction = getActiveInteraction();
+      activeInteraction === null || activeInteraction === void 0 || (_activeInteraction$mi = activeInteraction.minorInteractions) === null || _activeInteraction$mi === void 0 || _activeInteraction$mi.push({
+        name: name,
+        startTime: startTime !== null && startTime !== void 0 ? startTime : performance.now()
+      });
       return;
+    } else {
+      abortAll('new_interaction', name);
     }
   } else {
-    // Abort any existing interaction regardless of the coinflip outcome
-    // Ensures measurements are not carried over between distinct interactions
-    abortAll('new_interaction', name);
+    if (pressInteractionsList !== null && pressInteractionsList !== void 0 && pressInteractionsList.includes(name)) {
+      var interaction = getActiveInteraction();
+      if ((interaction === null || interaction === void 0 ? void 0 : interaction.ufoName) !== 'unknown' && (interaction === null || interaction === void 0 ? void 0 : interaction.type) === 'press') {
+        return;
+      }
+    } else {
+      // Abort any existing interaction regardless of the coinflip outcome
+      // Ensures measurements are not carried over between distinct interactions
+      abortAll('new_interaction', name);
+    }
   }
   if (coinflip(rate)) {
     var startTimestamp = startTime !== null && startTime !== void 0 ? startTime : performance.now();

package/dist/esm/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js

@@ -81,7 +81,7 @@ var AbstractVCCalculatorBase = /*#__PURE__*/function () {
     value: function () {
       var _calculateWithDebugInfo = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(filteredEntries, startTime, stopTime, isPostInteraction, isVCClean, interactionId, dirtyReason, allEntries, include3p) {
         var _window, _window2, _window3, _window5;
-        var percentiles, viewportEntries, vcLogs, vcDetails, percentileIndex, entryDataBuffer, _iterator3, _step3, _entry2, time, viewportPercentage, entries, elementNames, previousResult, i, percentile, enhancedVcLogs, shouldCalculate3p, shouldCalculateDebugDetails, sortedVcLogs, maxViewportPercentageAtTime, maxSoFar, _iterator4, _step4, log, getBiggestPreviousViewportPercentage, ignoredEntriesByTime, _iterator5, _step5, _entry3, _ignoredEntriesByTime, viewportData, timestamp, additionalVcLogs, _iterator6, _step6, _step6$value, _timestamp, ignoredEntries, _viewportPercentage, v3RevisionDebugDetails, _window4, _window4$__ufo_devtoo, _window6, _window6$__on_ufo_vc_;
+        var percentiles, viewportEntries, vcLogs, vcDetails, percentileIndex, entryDataBuffer, _iterator3, _step3, _entry2, time, viewportPercentage, entries, elementNames, previousResult, i, percentile, enhancedVcLogs, shouldCalculate3p, shouldCalculateDebugDetails, sortedVcLogs, maxViewportPercentageAtTime, maxSoFar, _iterator4, _step4, log, getBiggestPreviousViewportPercentage, ignoredEntriesByTime, _iterator5, _step5, _entry3, _ignoredEntriesByTime, _viewportData$rect, _viewportData$previou, viewportData, timestamp, additionalVcLogs, _iterator6, _step6, _step6$value, _timestamp, ignoredEntries, _viewportPercentage, v3RevisionDebugDetails, _window4, _window4$__ufo_devtoo, _window6, _window6$__on_ufo_vc_;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -175,7 +175,15 @@ var AbstractVCCalculatorBase = /*#__PURE__*/function () {
                 }
               }
               enhancedVcLogs = vcLogs ? vcLogs.map(function (log) {
-                return _objectSpread(_objectSpread({}, log), {}, {
+                return _objectSpread(_objectSpread(_objectSpread({}, log), fg('platform_ufo_serialise_ttvc_v3_debug_data') && {
+                  entries: log.entries.map(function (entry) {
+                    var _entry$rect, _entry$previousRect;
+                    return _objectSpread(_objectSpread({}, entry), {}, {
+                      rect: (_entry$rect = entry.rect) === null || _entry$rect === void 0 ? void 0 : _entry$rect.toJSON(),
+                      previousRect: (_entry$previousRect = entry.previousRect) === null || _entry$previousRect === void 0 ? void 0 : _entry$previousRect.toJSON()
+                    });
+                  })
+                }), {}, {
                   viewportPercentage: log.viewportPercentage
                 });
               }) : []; // If 3p metric enabled - calculate the debug details
@@ -231,7 +239,10 @@ var AbstractVCCalculatorBase = /*#__PURE__*/function () {
                       if (!ignoredEntriesByTime.has(timestamp)) {
                         ignoredEntriesByTime.set(timestamp, []);
                       }
-                      (_ignoredEntriesByTime = ignoredEntriesByTime.get(timestamp)) === null || _ignoredEntriesByTime === void 0 || _ignoredEntriesByTime.push(_objectSpread(_objectSpread({}, viewportData), {}, {
+                      (_ignoredEntriesByTime = ignoredEntriesByTime.get(timestamp)) === null || _ignoredEntriesByTime === void 0 || _ignoredEntriesByTime.push(_objectSpread(_objectSpread(_objectSpread({}, viewportData), fg('platform_ufo_serialise_ttvc_v3_debug_data') && {
+                        rect: (_viewportData$rect = viewportData.rect) === null || _viewportData$rect === void 0 ? void 0 : _viewportData$rect.toJSON(),
+                        previousRect: (_viewportData$previou = viewportData.previousRect) === null || _viewportData$previou === void 0 ? void 0 : _viewportData$previou.toJSON()
+                      }), {}, {
                         ignoreReason: viewportData.visible ? viewportData.type : 'not-visible'
                       }));
                     }

package/dist/types/common/common/types.d.ts

@@ -90,6 +90,10 @@ export type ResponsivenessMetric = {
     visuallyComplete?: number;
     totalBlockingTime?: number;
 };
+export type MinorInteraction = {
+    name: string;
+    startTime: DOMHighResTimeStamp;
+};
 export interface InteractionMetrics {
     id: string;
     start: number;
@@ -170,6 +174,7 @@ export interface InteractionMetrics {
     unknownElementHierarchy?: string;
     hold3pActive?: Map<string, HoldActive>;
     hold3pInfo?: HoldInfo[];
+    minorInteractions?: MinorInteraction[];
 }
 export type LoadProfilerEventInfo = {
     identifier: string;

package/dist/types/common/react-ufo-payload-schema.d.ts

@@ -1,7 +1,7 @@
 import { type createPayloads } from '../create-payload';
 import { type LabelStack } from '../interaction-context';
 import { type VCObserver } from '../vc/vc-observer';
-import type { AbortReasonType, ApdexType, HoldActive, InteractionError, InteractionType, SegmentInfo } from './common/types';
+import type { AbortReasonType, ApdexType, HoldActive, InteractionError, InteractionType, MinorInteraction, SegmentInfo } from './common/types';
 import type { RevisionPayload } from './vc/types';
 type ExtractPromise<T> = T extends Promise<infer U> ? U : never;
 export type PageVisibility = 'hidden' | 'mixed' | 'visible';
@@ -158,6 +158,7 @@ export type ReactUFOPayload = {
                 holdActive: HoldActive[];
                 unknownElementName?: string;
                 unknownElementHierarchy?: string;
+                minorInteractions?: MinorInteraction[];
             };
             'ufo:vc:rev': RevisionPayload;
             'ufo:vc:ratios': Record<string, number>;

package/dist/types/config/index.d.ts

@@ -59,6 +59,7 @@ export type ReactHydrationStats = {
 export type Config = {
     readonly enabled?: boolean;
     readonly interactionTimeout?: Record<string, number>;
+    readonly minorInteractions?: string[];
     readonly doNotAbortActivePressInteraction?: string[];
     readonly doNotAbortActivePressInteractionOnTransition?: string[];
     readonly awaitBM3TTI?: string[];
@@ -165,6 +166,7 @@ type ValidTypingMethod = (typeof validTypingMethods)[number];
 export declare function getTypingPerformanceTracingMethod(): ValidTypingMethod;
 export declare function getAwaitBM3TTIList(): string[];
 export declare function getUfoNameOverrides(): UFONameOverride | undefined;
+export declare function getMinorInteractions(): string[] | undefined;
 export declare function getDoNotAbortActivePressInteraction(): string[] | undefined;
 export declare function getDoNotAbortActivePressInteractionOnTransition(): string[] | undefined;
 export declare const CLEANUP_TIMEOUT: number;