@atlaskit/react-ufo 3.10.3 → 3.11.0

package/dist/es2019/interaction-metrics/post-interaction-log.js

@@ -103,7 +103,8 @@ export default class PostInteractionLog {
       // no need for TTI value here
       isEventAborted: !!this.lastInteractionFinish.abortReason,
       prefix: 'ufo',
-      ...this.vcObserverSSRConfig
+      ...this.vcObserverSSRConfig,
+      experienceKey: this.lastInteractionFinish.ufoName
     }));
     if ((_getConfig2 = getConfig()) !== null && _getConfig2 !== void 0 && (_getConfig2$experimen = _getConfig2.experimentalInteractionMetrics) !== null && _getConfig2$experimen !== void 0 && _getConfig2$experimen.enabled) {
       var _this$vcObserver4;

package/dist/es2019/vc/index.js

@@ -1,4 +1,5 @@
 var _process, _process$env;
+import { fg } from '@atlaskit/platform-feature-flags';
 import { isVCRevisionEnabled } from '../config';
 import { VCObserverNOOP } from './no-op-vc-observer';
 import { VCObserver } from './vc-observer';
@@ -6,55 +7,117 @@ import VCObserverNew from './vc-observer-new';
 class VCObserverWrapper {
   constructor(opts = {}) {
     this.newVCObserver = null;
-    if (isVCRevisionEnabled('fy25.03')) {
-      this.newVCObserver = new VCObserverNew({
-        selectorConfig: opts.selectorConfig
-      });
+    if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+      this.oldVCObserver = null;
+      if (isVCRevisionEnabled('fy25.03')) {
+        this.newVCObserver = new VCObserverNew({
+          selectorConfig: opts.selectorConfig
+        });
+      }
+      if (isVCRevisionEnabled('fy25.01') || isVCRevisionEnabled('fy25.02')) {
+        this.oldVCObserver = new VCObserver(opts);
+      }
+    } else {
+      if (isVCRevisionEnabled('fy25.03')) {
+        this.newVCObserver = new VCObserverNew({
+          selectorConfig: opts.selectorConfig
+        });
+      }
+      this.oldVCObserver = new VCObserver(opts);
     }
-    this.oldVCObserver = new VCObserver(opts);
   }
-  start(startArg) {
-    var _this$oldVCObserver, _this$newVCObserver;
-    (_this$oldVCObserver = this.oldVCObserver) === null || _this$oldVCObserver === void 0 ? void 0 : _this$oldVCObserver.start(startArg);
-    (_this$newVCObserver = this.newVCObserver) === null || _this$newVCObserver === void 0 ? void 0 : _this$newVCObserver.start({
-      startTime: startArg.startTime
-    });
+  start({
+    startTime,
+    experienceKey
+  }) {
+    if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+      if (isVCRevisionEnabled('fy25.01', experienceKey) || isVCRevisionEnabled('fy25.02', experienceKey)) {
+        var _this$oldVCObserver;
+        (_this$oldVCObserver = this.oldVCObserver) === null || _this$oldVCObserver === void 0 ? void 0 : _this$oldVCObserver.start({
+          startTime
+        });
+      }
+      if (isVCRevisionEnabled('fy25.03', experienceKey)) {
+        var _this$newVCObserver;
+        (_this$newVCObserver = this.newVCObserver) === null || _this$newVCObserver === void 0 ? void 0 : _this$newVCObserver.start({
+          startTime
+        });
+      }
+    } else {
+      var _this$oldVCObserver2, _this$newVCObserver2;
+      (_this$oldVCObserver2 = this.oldVCObserver) === null || _this$oldVCObserver2 === void 0 ? void 0 : _this$oldVCObserver2.start({
+        startTime
+      });
+      (_this$newVCObserver2 = this.newVCObserver) === null || _this$newVCObserver2 === void 0 ? void 0 : _this$newVCObserver2.start({
+        startTime
+      });
+    }
   }
-  stop() {
-    var _this$oldVCObserver2, _this$newVCObserver2;
-    (_this$oldVCObserver2 = this.oldVCObserver) === null || _this$oldVCObserver2 === void 0 ? void 0 : _this$oldVCObserver2.stop();
-    (_this$newVCObserver2 = this.newVCObserver) === null || _this$newVCObserver2 === void 0 ? void 0 : _this$newVCObserver2.stop();
+  stop(experienceKey) {
+    if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+      if (isVCRevisionEnabled('fy25.01', experienceKey) || isVCRevisionEnabled('fy25.02', experienceKey)) {
+        var _this$oldVCObserver3;
+        (_this$oldVCObserver3 = this.oldVCObserver) === null || _this$oldVCObserver3 === void 0 ? void 0 : _this$oldVCObserver3.stop();
+      }
+      if (isVCRevisionEnabled('fy25.03', experienceKey)) {
+        var _this$newVCObserver3;
+        (_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.stop();
+      }
+    } else {
+      var _this$oldVCObserver4, _this$newVCObserver4;
+      (_this$oldVCObserver4 = this.oldVCObserver) === null || _this$oldVCObserver4 === void 0 ? void 0 : _this$oldVCObserver4.stop();
+      (_this$newVCObserver4 = this.newVCObserver) === null || _this$newVCObserver4 === void 0 ? void 0 : _this$newVCObserver4.stop();
+    }
   }
   getVCRawData() {
-    var _this$oldVCObserver$g, _this$oldVCObserver3;
-    return (_this$oldVCObserver$g = (_this$oldVCObserver3 = this.oldVCObserver) === null || _this$oldVCObserver3 === void 0 ? void 0 : _this$oldVCObserver3.getVCRawData()) !== null && _this$oldVCObserver$g !== void 0 ? _this$oldVCObserver$g : null;
+    var _this$oldVCObserver$g, _this$oldVCObserver5;
+    return (_this$oldVCObserver$g = (_this$oldVCObserver5 = this.oldVCObserver) === null || _this$oldVCObserver5 === void 0 ? void 0 : _this$oldVCObserver5.getVCRawData()) !== null && _this$oldVCObserver$g !== void 0 ? _this$oldVCObserver$g : null;
   }
   async getVCResult(param) {
-    var _this$oldVCObserver4, _this$newVCObserver3, _ref;
-    const oldResult = await ((_this$oldVCObserver4 = this.oldVCObserver) === null || _this$oldVCObserver4 === void 0 ? void 0 : _this$oldVCObserver4.getVCResult(param));
-    const newResult = await ((_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.getVCResult({
-      start: param.start,
-      stop: param.stop
-    }));
-    if (oldResult && !newResult) {
-      return oldResult;
+    if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+      var _this$oldVCObserver6, _this$newVCObserver5, _ref;
+      const {
+        experienceKey
+      } = param;
+      const v1v2Result = isVCRevisionEnabled('fy25.01', experienceKey) || isVCRevisionEnabled('fy25.02', experienceKey) ? await ((_this$oldVCObserver6 = this.oldVCObserver) === null || _this$oldVCObserver6 === void 0 ? void 0 : _this$oldVCObserver6.getVCResult(param)) : {};
+      const v3Result = isVCRevisionEnabled('fy25.03', experienceKey) ? await ((_this$newVCObserver5 = this.newVCObserver) === null || _this$newVCObserver5 === void 0 ? void 0 : _this$newVCObserver5.getVCResult({
+        start: param.start,
+        stop: param.stop
+      })) : [];
+      if (!v3Result) {
+        return v1v2Result !== null && v1v2Result !== void 0 ? v1v2Result : {};
+      }
+      return {
+        ...v1v2Result,
+        'ufo:vc:rev': [...((_ref = v1v2Result === null || v1v2Result === void 0 ? void 0 : v1v2Result['ufo:vc:rev']) !== null && _ref !== void 0 ? _ref : []), ...(v3Result !== null && v3Result !== void 0 ? v3Result : [])]
+      };
+    } else {
+      var _this$oldVCObserver7, _this$newVCObserver6, _ref2;
+      const oldResult = await ((_this$oldVCObserver7 = this.oldVCObserver) === null || _this$oldVCObserver7 === void 0 ? void 0 : _this$oldVCObserver7.getVCResult(param));
+      const newResult = await ((_this$newVCObserver6 = this.newVCObserver) === null || _this$newVCObserver6 === void 0 ? void 0 : _this$newVCObserver6.getVCResult({
+        start: param.start,
+        stop: param.stop
+      }));
+      if (oldResult && !newResult) {
+        return oldResult;
+      }
+      return {
+        ...(oldResult !== null && oldResult !== void 0 ? oldResult : {}),
+        'ufo:vc:rev': [...((_ref2 = oldResult === null || oldResult === void 0 ? void 0 : oldResult['ufo:vc:rev']) !== null && _ref2 !== void 0 ? _ref2 : []), ...(newResult !== null && newResult !== void 0 ? newResult : [])]
+      };
     }
-    return {
-      ...(oldResult !== null && oldResult !== void 0 ? oldResult : {}),
-      'ufo:vc:rev': [...((_ref = oldResult === null || oldResult === void 0 ? void 0 : oldResult['ufo:vc:rev']) !== null && _ref !== void 0 ? _ref : []), ...(newResult !== null && newResult !== void 0 ? newResult : [])]
-    };
   }
   setSSRElement(element) {
-    var _this$oldVCObserver5;
-    (_this$oldVCObserver5 = this.oldVCObserver) === null || _this$oldVCObserver5 === void 0 ? void 0 : _this$oldVCObserver5.setSSRElement(element);
+    var _this$oldVCObserver8;
+    (_this$oldVCObserver8 = this.oldVCObserver) === null || _this$oldVCObserver8 === void 0 ? void 0 : _this$oldVCObserver8.setSSRElement(element);
   }
   setReactRootRenderStart(startTime) {
-    var _this$oldVCObserver6;
-    (_this$oldVCObserver6 = this.oldVCObserver) === null || _this$oldVCObserver6 === void 0 ? void 0 : _this$oldVCObserver6.setReactRootRenderStart(startTime || performance.now());
+    var _this$oldVCObserver9;
+    (_this$oldVCObserver9 = this.oldVCObserver) === null || _this$oldVCObserver9 === void 0 ? void 0 : _this$oldVCObserver9.setReactRootRenderStart(startTime || performance.now());
   }
   setReactRootRenderStop(stopTime) {
-    var _this$oldVCObserver7;
-    (_this$oldVCObserver7 = this.oldVCObserver) === null || _this$oldVCObserver7 === void 0 ? void 0 : _this$oldVCObserver7.setReactRootRenderStop(stopTime || performance.now());
+    var _this$oldVCObserver10;
+    (_this$oldVCObserver10 = this.oldVCObserver) === null || _this$oldVCObserver10 === void 0 ? void 0 : _this$oldVCObserver10.setReactRootRenderStop(stopTime || performance.now());
   }
 }
 

package/dist/es2019/vc/vc-observer/getVCRevisionsData.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { isVCRevisionEnabled } from '../../config';
 import { getPageVisibilityState } from '../../hidden-timing';
 import { getRevisions } from './revisions/revisions';
@@ -19,7 +20,7 @@ function createVCDetails(calculatedVC, shouldHaveVCmetric) {
 
   for (const key of VCParts) {
     details[key] = {
-      t: VC[key],
+      t: VC[key] || -1,
       e: VCBox[key] || READONLY_EMPTY_ARRAY
     };
   }
@@ -35,9 +36,14 @@ export function getVCRevisionsData({
   multiHeatmap,
   ssr,
   calculatedVC,
-  calculatedVCNext
+  calculatedVCNext,
+  experienceKey
 }) {
-  if (!isVCRevisionEnabled('fy25.03')) {
+  const isTTVCv3Enabled = fg('platform_ufo_vc_enable_revisions_by_experience') ? isVCRevisionEnabled('fy25.03', experienceKey) : isVCRevisionEnabled('fy25.03');
+
+  // As part of `platform_ufo_vc_enable_revisions_by_experience`, we are looking to turn off the `multiHeatmap` branch of code
+  // for calculating TTVC, and instead rely on existing values already available, e.g. `calculatedVC` and `calculatedVCNext`
+  if (!isTTVCv3Enabled && !fg('platform_ufo_vc_enable_revisions_by_experience')) {
     if (!multiHeatmap) {
       return null;
     }
@@ -58,33 +64,54 @@ export function getVCRevisionsData({
       })
     };
   }
-
-  // Calculate these conditions once
   const pageVisibilityUpToTTAI = getPageVisibilityState(interaction.start, interaction.end);
   const isVisiblePageVisibleUpToTTAI = pageVisibilityUpToTTAI === 'visible';
   const shouldHaveVCmetric = isVCClean && !isEventAborted && isVisiblePageVisibleUpToTTAI;
+  if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+    const availableVCRevisionPayloads = [];
+    if (isVCRevisionEnabled('fy25.01', experienceKey)) {
+      availableVCRevisionPayloads.push({
+        revision: 'fy25.01',
+        clean: isVCClean,
+        'metric:vc90': shouldHaveVCmetric ? calculatedVC.VC['90'] : null,
+        vcDetails: createVCDetails(calculatedVC, shouldHaveVCmetric)
+      });
+    }
+    if (isVCRevisionEnabled('fy25.02', experienceKey)) {
+      availableVCRevisionPayloads.push({
+        revision: 'fy25.02',
+        clean: isVCClean,
+        'metric:vc90': shouldHaveVCmetric ? calculatedVCNext.VC['90'] : null,
+        vcDetails: createVCDetails(calculatedVCNext, shouldHaveVCmetric)
+      });
+    }
+    return {
+      [`${fullPrefix}vc:rev`]: availableVCRevisionPayloads
+    };
+  } else {
+    // Create the V2 revision object which is always needed
+    const ttvcV2Revision = {
+      revision: 'fy25.02',
+      clean: isVCClean,
+      'metric:vc90': shouldHaveVCmetric ? calculatedVCNext.VC['90'] : null,
+      vcDetails: createVCDetails(calculatedVCNext, shouldHaveVCmetric)
+    };
+    const isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01');
+    if (isTTVCv1Disabled) {
+      return {
+        [`${fullPrefix}vc:rev`]: [ttvcV2Revision]
+      };
+    }
 
-  // Create the V2 revision object which is always needed
-  const ttvcV2Revision = {
-    revision: 'fy25.02',
-    clean: isVCClean,
-    'metric:vc90': shouldHaveVCmetric ? calculatedVCNext.VC['90'] : null,
-    vcDetails: createVCDetails(calculatedVCNext, shouldHaveVCmetric)
-  };
-  if (!isVCRevisionEnabled('fy25.01')) {
+    // Only create ttvcV1Revision when we're actually going to use it
+    const ttvcV1Revision = {
+      revision: 'fy25.01',
+      clean: isVCClean,
+      'metric:vc90': shouldHaveVCmetric ? calculatedVC.VC['90'] : null,
+      vcDetails: createVCDetails(calculatedVC, shouldHaveVCmetric)
+    };
     return {
-      [`${fullPrefix}vc:rev`]: [ttvcV2Revision]
+      [`${fullPrefix}vc:rev`]: [ttvcV1Revision, ttvcV2Revision]
     };
   }
-
-  // Only create ttvcV1Revision when we're actually going to use it
-  const ttvcV1Revision = {
-    revision: 'fy25.01',
-    clean: isVCClean,
-    'metric:vc90': shouldHaveVCmetric ? calculatedVC.VC['90'] : null,
-    vcDetails: createVCDetails(calculatedVC, shouldHaveVCmetric)
-  };
-  return {
-    [`${fullPrefix}vc:rev`]: [ttvcV1Revision, ttvcV2Revision]
-  };
 }

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

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { fg } from '@atlaskit/platform-feature-flags';
 import { isVCRevisionEnabled } from '../../config';
+import { getActiveInteraction } from '../../interaction-metrics';
 import { attachAbortListeners } from './attachAbortListeners';
 import { getVCRevisionsData } from './getVCRevisionsData';
 import { getViewportHeight, getViewportWidth } from './getViewport';
@@ -94,7 +95,8 @@ export class VCObserver {
       prefix,
       ssr,
       vc,
-      isEventAborted
+      isEventAborted,
+      experienceKey
     }) => {
       const startTime = performance.now();
       // add local measurement
@@ -116,7 +118,7 @@ export class VCObserver {
         ratios,
         multiHeatmap
       } = rawData;
-      const isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01');
+      const isTTVCv1Disabled = fg('platform_ufo_vc_enable_revisions_by_experience') ? !isVCRevisionEnabled('fy25.01', experienceKey) : !isVCRevisionEnabled('fy25.01');
 
       // NOTE: as part of platform_ufo_add_vc_abort_reason_by_revisions feature,
       // we want to report abort by scroll events the same way as other abort reasons
@@ -318,7 +320,8 @@ export class VCObserver {
           VC: vcNext.VC,
           VCBox: vcNext.VCBox
         },
-        isEventAborted
+        isEventAborted,
+        experienceKey
       });
       const speedIndex = {
         [`ufo:speedIndex`]: isTTVCv1Disabled ? vcNext.VCEntries.speedIndex : VCEntries.speedIndex,
@@ -335,7 +338,7 @@ export class VCObserver {
           ...speedIndex
         };
       }
-      const isTTVCv3Enabled = isVCRevisionEnabled('fy25.03');
+      const isTTVCv3Enabled = fg('platform_ufo_vc_enable_revisions_by_experience') ? isVCRevisionEnabled('fy25.03', experienceKey) : isVCRevisionEnabled('fy25.03');
       return {
         'metrics:vc': VC,
         [`${fullPrefix}vc:state`]: true,
@@ -360,7 +363,12 @@ export class VCObserver {
     _defineProperty(this, "handleUpdate", (rawTime, intersectionRect, targetName, element, type, ignoreReason, attributeName, oldValue, newValue) => {
       this.measureStart();
       this.legacyHandleUpdate(rawTime, intersectionRect, targetName, element, type, ignoreReason, attributeName, oldValue, newValue);
-      if (!isVCRevisionEnabled('fy25.03')) {
+      let isTTVCv3Disabled = !isVCRevisionEnabled('fy25.03');
+      if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+        const interaction = getActiveInteraction();
+        isTTVCv3Disabled = !isVCRevisionEnabled('fy25.03', interaction === null || interaction === void 0 ? void 0 : interaction.ufoName);
+      }
+      if (isTTVCv3Disabled) {
         this.onViewportChangeDetected({
           timestamp: rawTime,
           intersectionRect,
@@ -383,7 +391,11 @@ export class VCObserver {
         if (!ignoreReason) {
           this.applyChangesToHeatMap(mappedValues, time, this.heatmapNext);
         }
-        const isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01');
+        let isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01');
+        if (fg('platform_ufo_vc_enable_revisions_by_experience')) {
+          const interaction = getActiveInteraction();
+          isTTVCv1Disabled = !isVCRevisionEnabled('fy25.01', interaction === null || interaction === void 0 ? void 0 : interaction.ufoName);
+        }
         if (!isTTVCv1Disabled && (!ignoreReason || ignoreReason === 'not-visible') && type !== 'attr') {
           this.applyChangesToHeatMap(mappedValues, time, this.heatmap);
         }

package/dist/es2019/vc/vc-observer-new/entries-timeline/index.js

@@ -1,9 +1,7 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 export default class EntriesTimeline {
   constructor() {
-    _defineProperty(this, "unorderedEntries", []);
-    _defineProperty(this, "sortedEntriesCache", new Map());
     this.unorderedEntries = [];
+    this.sortedEntriesCache = new Map();
   }
   push(entry) {
     this.unorderedEntries.push(entry);

package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/canvas-pixel.js

@@ -1,14 +1,15 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import taskYield from '../../utils/task-yield';
 
 // 24-bit color value
 
 /**
  * Class responsible for managing a scaled canvas and tracking pixel drawing operations.
- * It uses an OffscreenCanvas for better performance and maintains a mapping between
- * colors and timestamps for pixel counting purposes.
+ * It uses either an OffscreenCanvas (if available) or a regular HTML Canvas for better performance
+ * and maintains a mapping between colors and timestamps for pixel counting purposes.
  */
 export class ViewportCanvas {
-  /** The underlying OffscreenCanvas instance */
+  /** The underlying Canvas instance (either OffscreenCanvas or HTMLCanvasElement) */
 
   /** The 2D rendering context of the canvas */
 
@@ -37,10 +38,8 @@ export class ViewportCanvas {
     this.scaleX = this.scaledWidth / safeViewportWidth;
     this.scaleY = this.scaledHeight / safeViewportHeight;
 
-    // Initialize OffscreenCanvas with scaled dimensions
-    this.canvas = document.createElement('canvas');
-    this.canvas.width = this.scaledWidth;
-    this.canvas.height = this.scaledHeight;
+    // Initialize canvas with scaled dimensions
+    this.canvas = this.createCanvas(this.scaledWidth, this.scaledHeight);
     const ctx = this.canvas.getContext('2d', {
       alpha: false,
       // Disable alpha channel for better performance
@@ -53,8 +52,25 @@ export class ViewportCanvas {
     }
     this.ctx = ctx;
     this.ctx.globalCompositeOperation = 'source-over';
+    if (fg('platform_ufo_use_offscreen_canvas')) {
+      this.ctx.imageSmoothingEnabled = false; // Disable image smoothing for better performance
+    }
     this.clear();
   }
+
+  /**
+   * Creates a canvas instance, falling back to HTMLCanvasElement if OffscreenCanvas is not available
+   * or if the feature flag is disabled
+   */
+  createCanvas(width, height) {
+    if (typeof OffscreenCanvas !== 'undefined' && fg('platform_ufo_use_offscreen_canvas')) {
+      return new OffscreenCanvas(width, height);
+    }
+    const canvas = document.createElement('canvas');
+    canvas.width = width;
+    canvas.height = height;
+    return canvas;
+  }
   getScaledDimensions() {
     return {
       width: this.scaledWidth,