@atlaskit/react-ufo 4.8.0 → 4.9.1

package/dist/es2019/create-extra-search-page-interaction-payload/index.js

@@ -0,0 +1,32 @@
+const interactionBuffer = [];
+let bufferInteractionData = (interactionId, data) => {
+  interactionBuffer.push({
+    interactionId,
+    data
+  });
+};
+function clearInteractionBuffer() {
+  interactionBuffer.length = 0;
+}
+function appendInteractionData(interactionId, data) {
+  bufferInteractionData(interactionId, data);
+}
+function installInteractionSink(handler) {
+  for (const {
+    interactionId,
+    data
+  } of interactionBuffer) {
+    handler(interactionId, data);
+  }
+  clearInteractionBuffer();
+  bufferInteractionData = handler;
+}
+export function sinkExtraSearchPageInteractionHandler(sinkFn) {
+  installInteractionSink(sinkFn);
+}
+export function onSearchPageInteractionComplete(interactionId, data) {
+  if (data.ufoName) {
+    appendInteractionData(interactionId, data);
+    clearInteractionBuffer();
+  }
+}

package/dist/es2019/create-payload/index.js

@@ -644,4 +644,53 @@ export async function createExperimentalMetricsPayload(interactionId, interactio
   }
   const result = await createInteractionMetricsPayload(interaction, interactionId, true);
   return result;
+}
+export async function createExtraSearchPageInteractionPayload(interactionId, interaction) {
+  var _newEnd;
+  const SAIN_HOLD_NAMES = ['search-ai-dialog-visible-text-loading', 'search-ai-dialog-all-text-loading'];
+  const NAME_OVERRIDE = 'search-page-ignoring-smart-answers';
+  const SEARCH_PAGE_SMART_ANSWERS_SEGMENT_LABEL = 'search-page-smart-answers';
+  const newInteractionId = `${interactionId}-ignoring-smart-answers`;
+
+  // Calculate a new end time which excludes SAIN holds
+  let newEnd;
+  const {
+    holdInfo,
+    reactProfilerTimings
+  } = interaction;
+  const lastHold = holdInfo.at(-1);
+  const isLastHoldSAIN = Boolean(lastHold && SAIN_HOLD_NAMES.includes(lastHold.name));
+
+  // A new end time is only calculated if the last hold is a SAIN hold
+  if (isLastHoldSAIN) {
+    let lastFilteredTime = null;
+    const filteredReactProfilerTimings = reactProfilerTimings.filter(timing => {
+      if (timing.commitTime === lastFilteredTime) {
+        return false;
+      }
+      const isTimingSmartAnswersInSearch = timing.labelStack.some(label => label.name === SEARCH_PAGE_SMART_ANSWERS_SEGMENT_LABEL);
+      if (isTimingSmartAnswersInSearch) {
+        lastFilteredTime = timing.commitTime;
+        return false;
+      }
+      return true;
+    });
+    const lastTiming = filteredReactProfilerTimings.at(-1);
+    if (lastTiming) {
+      newEnd = lastTiming.commitTime;
+    }
+  }
+  const modifiedInteraction = {
+    ...interaction,
+    end: (_newEnd = newEnd) !== null && _newEnd !== void 0 ? _newEnd : interaction.end,
+    holdInfo: [],
+    knownSegments: [],
+    reactProfilerTimings: [],
+    ufoName: NAME_OVERRIDE
+  };
+  const payloads = [];
+  const vcMetrics = await getVCMetrics(interaction, false, true);
+  const interactionMetricsPayload = await createInteractionMetricsPayload(modifiedInteraction, newInteractionId, undefined, undefined, vcMetrics);
+  payloads.push(interactionMetricsPayload);
+  return payloads.filter(Boolean);
 }

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

@@ -3,7 +3,7 @@ import { postInteractionLog } from '../../interaction-metrics';
 import getInteractionStatus from './get-interaction-status';
 import getPageVisibilityUpToTTAI from './get-page-visibility-up-to-ttai';
 import getSSRDoneTimeValue from './get-ssr-done-time-value';
-async function getVCMetrics(interaction, include3p = false) {
+async function getVCMetrics(interaction, include3p = false, excludeSmartAnswersInSearch = false) {
   var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _interaction$apdex$, _config$vc2, _config$vc3, _result$ufoVcRev;
   const config = getConfig();
   if (!(config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled)) {
@@ -40,7 +40,8 @@ async function getVCMetrics(interaction, include3p = false) {
     interactionId: interaction.id,
     includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio,
     ...ssr,
-    include3p
+    include3p,
+    excludeSmartAnswersInSearch
   });
   observer.stop(interaction.ufoName);
   if (!include3p) {

package/dist/es2019/create-post-interaction-log-payload/index.js

@@ -139,7 +139,7 @@ function createPostInteractionLogPayload({
   if (lastInteractionFinish.errors.length > 0) {
     return null;
   }
-  const maxEndTimeFromProfiler = reactProfilerTimings ? Math.max(...reactProfilerTimings.map(t => t.commitTime)) : lastInteractionFinish.end;
+  const maxEndTimeFromProfiler = reactProfilerTimings && reactProfilerTimings.length > 0 ? Math.max(...reactProfilerTimings.map(t => t.commitTime)) : lastInteractionFinish.end;
   const revisedEndTime = Math.round(maxEndTimeFromProfiler);
   const revisedTtai = Math.round(maxEndTimeFromProfiler - lastInteractionFinish.start);
   const lastInteractionFinishStart = Math.round(lastInteractionFinish.start);

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

@@ -3,6 +3,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig, getExperimentalInteractionRate, getExtraInteractionRate, getFinishInteractionOnTransition, getInteractionTimeout, getPostInteractionRate, getReactHydrationStats } from '../config';
 import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
+import { onSearchPageInteractionComplete } from '../create-extra-search-page-interaction-payload';
 import { sanitizeUfoName, stringifyLabelStackFully } from '../create-payload/common/utils';
 import { clearActiveTrace } from '../experience-trace-id-context';
 import { allFeatureFlagsAccessed, currentFeatureFlagsAccessed } from '../feature-flags-accessed';
@@ -759,16 +760,19 @@ export function tryComplete(interactionId, endTime) {
       if (noMoreActiveHolds && interactionExtraMetrics.finishedInteractionId !== interactionId) {
         // If it's not waiting for extra metrics to complete, finish the interaction as normal
         if (!activeSubmitted) {
-          var _getConfig1, _getConfig1$extraInte;
+          var _getConfig1, _getConfig1$extraInte, _getConfig10, _getConfig10$extraSea, _getConfig11, _getConfig11$extraSea;
           finishInteraction(interactionId, interaction, endTime);
           if ((_getConfig1 = getConfig()) !== null && _getConfig1 !== void 0 && (_getConfig1$extraInte = _getConfig1.extraInteractionMetrics) !== null && _getConfig1$extraInte !== void 0 && _getConfig1$extraInte.enabled) {
             interactionExtraMetrics.updateFinishedInteractionId(interactionId);
           }
+          if ((_getConfig10 = getConfig()) !== null && _getConfig10 !== void 0 && (_getConfig10$extraSea = _getConfig10.extraSearchPageInteraction) !== null && _getConfig10$extraSea !== void 0 && _getConfig10$extraSea.enabled && interaction.ufoName === ((_getConfig11 = getConfig()) === null || _getConfig11 === void 0 ? void 0 : (_getConfig11$extraSea = _getConfig11.extraSearchPageInteraction) === null || _getConfig11$extraSea === void 0 ? void 0 : _getConfig11$extraSea.searchPageMetricName) && fg('react_ufo_unified_search_ignoring_sain_metric')) {
+            onSearchPageInteractionComplete(interactionId, interaction);
+          }
           activeSubmitted = true;
         }
         if (noMoreExpHolds) {
-          var _getConfig10, _getConfig10$experime;
-          if ((_getConfig10 = getConfig()) !== null && _getConfig10 !== void 0 && (_getConfig10$experime = _getConfig10.experimentalInteractionMetrics) !== null && _getConfig10$experime !== void 0 && _getConfig10$experime.enabled) {
+          var _getConfig12, _getConfig12$experime;
+          if ((_getConfig12 = getConfig()) !== null && _getConfig12 !== void 0 && (_getConfig12$experime = _getConfig12.experimentalInteractionMetrics) !== null && _getConfig12$experime !== void 0 && _getConfig12$experime.enabled) {
             onExperimentalInteractionComplete(interactionId, interaction, endTime);
           }
           postInteraction();
@@ -784,12 +788,16 @@ export function tryComplete(interactionId, endTime) {
     } else {
       if (noMoreActiveHolds) {
         if (!activeSubmitted) {
+          var _getConfig13, _getConfig13$extraSea, _getConfig14, _getConfig14$extraSea;
           finishInteraction(interactionId, interaction, endTime);
+          if ((_getConfig13 = getConfig()) !== null && _getConfig13 !== void 0 && (_getConfig13$extraSea = _getConfig13.extraSearchPageInteraction) !== null && _getConfig13$extraSea !== void 0 && _getConfig13$extraSea.enabled && interaction.ufoName === ((_getConfig14 = getConfig()) === null || _getConfig14 === void 0 ? void 0 : (_getConfig14$extraSea = _getConfig14.extraSearchPageInteraction) === null || _getConfig14$extraSea === void 0 ? void 0 : _getConfig14$extraSea.searchPageMetricName) && fg('react_ufo_unified_search_ignoring_sain_metric')) {
+            onSearchPageInteractionComplete(interactionId, interaction);
+          }
           activeSubmitted = true;
         }
         if (noMoreExpHolds) {
-          var _getConfig11, _getConfig11$experime;
-          if ((_getConfig11 = getConfig()) !== null && _getConfig11 !== void 0 && (_getConfig11$experime = _getConfig11.experimentalInteractionMetrics) !== null && _getConfig11$experime !== void 0 && _getConfig11$experime.enabled) {
+          var _getConfig15, _getConfig15$experime;
+          if ((_getConfig15 = getConfig()) !== null && _getConfig15 !== void 0 && (_getConfig15$experime = _getConfig15.experimentalInteractionMetrics) !== null && _getConfig15$experime !== void 0 && _getConfig15$experime.enabled) {
             onExperimentalInteractionComplete(interactionId, interaction, endTime);
           }
           postInteraction();
@@ -985,7 +993,7 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
     addHoldByID(interactionId, [], ufoName, ufoName, true);
   }
   if (type === 'transition' || type === 'page_load') {
-    var _getConfig12, _getConfig12$postInte, _config$extraInteract;
+    var _getConfig16, _getConfig16$postInte, _config$extraInteract;
     // Use per-interaction VC observer if available, otherwise fall back to global
     const observer = vcObserver;
     if (observer) {
@@ -996,7 +1004,7 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
     }
     // Start post interaction observer for all if config is enabled
     // in case ufoName is updated at later time
-    if ((_getConfig12 = getConfig()) !== null && _getConfig12 !== void 0 && (_getConfig12$postInte = _getConfig12.postInteractionLog) !== null && _getConfig12$postInte !== void 0 && _getConfig12$postInte.enabled) {
+    if ((_getConfig16 = getConfig()) !== null && _getConfig16 !== void 0 && (_getConfig16$postInte = _getConfig16.postInteractionLog) !== null && _getConfig16$postInte !== void 0 && _getConfig16$postInte.enabled) {
       postInteractionLog.startVCObserver({
         startTime
       });

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

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getConfig } from '../config';
 import { VCObserverWrapper } from '../vc';
 const POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT = 3000;
@@ -89,7 +90,7 @@ export default class PostInteractionLog {
    */
   async sendPostInteractionLog() {
     var _this$vcObserver4, _config$vc, _config$vc2, _this$vcObserver5;
-    if (!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn) {
+    if (!this.lastInteractionFinish || !this.sinkHandlerFn || !this.hasData() && !fg('platform_ufo_always_send_post_interaction_log')) {
       var _this$vcObserver3;
       this.reset();
       (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 ? void 0 : _this$vcObserver3.stop();

package/dist/es2019/interaction-metrics-init/index.js

@@ -2,6 +2,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
 import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-interaction-metrics-payload';
+import { sinkExtraSearchPageInteractionHandler } from '../create-extra-search-page-interaction-payload';
 import { setupHiddenTimingCapture } from '../hidden-timing';
 import { interactionExtraMetrics, postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getPerformanceObserver } from '../interactions-performance-observer';
@@ -86,6 +87,26 @@ function sinkInteractionExtraMetrics(instance, createInteractionExtraLogPayload)
     });
   });
 }
+function sinkExtraSearchPageInteraction(instance, payloadPackage) {
+  function sinkFn(interactionId, interaction) {
+    function onIdle() {
+      payloadPackage.createExtraSearchPageInteractionPayload(interactionId, interaction).then(payloads => {
+        // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
+        const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+        payloads === null || payloads === void 0 ? void 0 : payloads.forEach(payload => {
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 ? void 0 : devToolObserver(payload);
+          }
+          instance.sendOperationalEvent(payload);
+        });
+      }).catch(error => {
+        throw error;
+      });
+    }
+    scheduleIdleCallback(onIdle);
+  }
+  sinkExtraSearchPageInteractionHandler(sinkFn);
+}
 export function init(analyticsWebClientAsync, config) {
   var _config$vc;
   if (initialized) {
@@ -129,7 +150,7 @@ export function init(analyticsWebClientAsync, config) {
   Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'), import( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload')]).then(([awc, payloadPackage, createPostInteractionLogPayloadPackage, createInteractionExtraMetricsPayloadPackage]) => {
     if (awc.getAnalyticsWebClientPromise) {
       awc.getAnalyticsWebClientPromise().then(client => {
-        var _config$experimentalI2, _config$postInteracti, _config$extraInteract2;
+        var _config$experimentalI2, _config$postInteracti, _config$extraInteract2, _config$extraSearchPa;
         const instance = client.getInstance();
         sinkInteraction(instance, payloadPackage);
         if (config !== null && config !== void 0 && (_config$experimentalI2 = config.experimentalInteractionMetrics) !== null && _config$experimentalI2 !== void 0 && _config$experimentalI2.enabled) {
@@ -141,9 +162,12 @@ export function init(analyticsWebClientAsync, config) {
         if (config !== null && config !== void 0 && (_config$extraInteract2 = config.extraInteractionMetrics) !== null && _config$extraInteract2 !== void 0 && _config$extraInteract2.enabled && fg('platform_ufo_enable_ttai_with_3p')) {
           sinkInteractionExtraMetrics(instance, createInteractionExtraMetricsPayloadPackage.default);
         }
+        if (config !== null && config !== void 0 && (_config$extraSearchPa = config.extraSearchPageInteraction) !== null && _config$extraSearchPa !== void 0 && _config$extraSearchPa.enabled && fg('react_ufo_unified_search_ignoring_sain_metric')) {
+          sinkExtraSearchPageInteraction(instance, payloadPackage);
+        }
       });
     } else if (awc.sendOperationalEvent) {
-      var _config$experimentalI3, _config$postInteracti2, _config$extraInteract3;
+      var _config$experimentalI3, _config$postInteracti2, _config$extraInteract3, _config$extraSearchPa2;
       sinkInteraction(awc, payloadPackage);
       if (config !== null && config !== void 0 && (_config$experimentalI3 = config.experimentalInteractionMetrics) !== null && _config$experimentalI3 !== void 0 && _config$experimentalI3.enabled) {
         sinkExperimentalInteractionMetrics(awc, payloadPackage);
@@ -154,6 +178,9 @@ export function init(analyticsWebClientAsync, config) {
       if (config !== null && config !== void 0 && (_config$extraInteract3 = config.extraInteractionMetrics) !== null && _config$extraInteract3 !== void 0 && _config$extraInteract3.enabled && fg('platform_ufo_enable_ttai_with_3p')) {
         sinkInteractionExtraMetrics(awc, createInteractionExtraMetricsPayloadPackage.default);
       }
+      if (config !== null && config !== void 0 && (_config$extraSearchPa2 = config.extraSearchPageInteraction) !== null && _config$extraSearchPa2 !== void 0 && _config$extraSearchPa2.enabled) {
+        sinkExtraSearchPageInteraction(awc, payloadPackage);
+      }
     }
   });
 }

package/dist/es2019/vc/index.js

@@ -95,7 +95,8 @@ export class VCObserverWrapper {
     var _this$oldVCObserver4, _this$newVCObserver3, _ref;
     const {
       experienceKey,
-      include3p
+      include3p,
+      excludeSmartAnswersInSearch
     } = param;
     const v1v2Result = isVCRevisionEnabled('fy25.01', experienceKey) || isVCRevisionEnabled('fy25.02', experienceKey) ? await ((_this$oldVCObserver4 = this.oldVCObserver) === null || _this$oldVCObserver4 === void 0 ? void 0 : _this$oldVCObserver4.getVCResult(param)) : {};
     const v3Result = isVCRevisionEnabled('fy25.03', experienceKey) ? await ((_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.getVCResult({
@@ -103,7 +104,8 @@ export class VCObserverWrapper {
       stop: param.stop,
       interactionId: param.interactionId,
       ssr: param.includeSSRInV3 ? param.ssr : undefined,
-      include3p
+      include3p,
+      excludeSmartAnswersInSearch
     })) : [];
     if (!v3Result) {
       return v1v2Result !== null && v1v2Result !== void 0 ? v1v2Result : {};

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

@@ -196,7 +196,8 @@ export default class VCObserverNew {
       start,
       stop,
       interactionId,
-      include3p
+      include3p,
+      excludeSmartAnswersInSearch
     } = param;
     const results = [];
     this.addStartEntry(start);
@@ -214,7 +215,8 @@ export default class VCObserverNew {
       stopTime: stop,
       interactionId,
       isPostInteraction: this.isPostInteraction,
-      include3p
+      include3p,
+      excludeSmartAnswersInSearch
     });
     if (fy25_03) {
       results.push(fy25_03);

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

@@ -55,7 +55,7 @@ export default class AbstractVCCalculatorBase {
     }
     return labelStacks;
   }
-  async calculateWithDebugInfo(filteredEntries, startTime, stopTime, isPostInteraction, isVCClean, interactionId, dirtyReason, allEntries, include3p) {
+  async calculateWithDebugInfo(filteredEntries, startTime, stopTime, isPostInteraction, isVCClean, interactionId, dirtyReason, allEntries, include3p, excludeSmartAnswersInSearch) {
     var _window, _window2, _window6, _window8;
     const percentiles = [25, 50, 75, 80, 85, 90, 95, 98, 99, 100];
     const viewportEntries = this.filterViewportEntries(filteredEntries);
@@ -175,7 +175,7 @@ export default class AbstractVCCalculatorBase {
       // Group ignored entries by timestamp
       const ignoredEntriesByTime = new Map();
       for (const entry of allEntries) {
-        if ('rect' in entry.data && !this.isEntryIncluded(entry, include3p)) {
+        if ('rect' in entry.data && !this.isEntryIncluded(entry, include3p, excludeSmartAnswersInSearch)) {
           var _ignoredEntriesByTime, _viewportData$rect, _viewportData$previou;
           const viewportData = entry.data;
           const timestamp = Math.round(entry.time);
@@ -273,11 +273,12 @@ export default class AbstractVCCalculatorBase {
     orderedEntries,
     interactionId,
     isPostInteraction,
-    include3p
+    include3p,
+    excludeSmartAnswersInSearch
   }) {
     var _vcDetails$90$t, _vcDetails$;
     const filteredEntries = orderedEntries.filter(entry => {
-      return this.isEntryIncluded(entry, include3p);
+      return this.isEntryIncluded(entry, include3p, excludeSmartAnswersInSearch);
     });
     let isVCClean;
     let dirtyReason;
@@ -293,7 +294,7 @@ export default class AbstractVCCalculatorBase {
         abortTimestamp: getVCCleanStatusResult.abortTimestamp
       };
     }
-    const vcDetails = await this.calculateWithDebugInfo(filteredEntries, startTime, stopTime, isPostInteraction, isVCClean, interactionId, dirtyReason, orderedEntries, include3p);
+    const vcDetails = await this.calculateWithDebugInfo(filteredEntries, startTime, stopTime, isPostInteraction, isVCClean, interactionId, dirtyReason, orderedEntries, include3p, excludeSmartAnswersInSearch);
     const result = {
       revision: this.revisionNo,
       clean: true,

package/dist/es2019/vc/vc-observer-new/metric-calculator/fy25_03/index.js

@@ -1,5 +1,6 @@
 import { fg } from '@atlaskit/platform-feature-flags';
 import AbstractVCCalculatorBase from '../abstract-base-vc-calculator';
+import { isEntrySmartAnswersInSearch } from '../utils/is-entry-smart-answers-in-search';
 import isViewportEntryData from '../utils/is-viewport-entry-data';
 const ABORTING_WINDOW_EVENT = ['wheel', 'scroll', 'keydown', 'resize'];
 const REVISION_NO = 'fy25.03';
@@ -33,10 +34,13 @@ export default class VCCalculator_FY25_03 extends AbstractVCCalculatorBase {
   constructor(revisionNo) {
     super(revisionNo !== null && revisionNo !== void 0 ? revisionNo : REVISION_NO);
   }
-  isEntryIncluded(entry, include3p) {
+  isEntryIncluded(entry, include3p, excludeSmartAnswersInSearch) {
     if (!getConsideredEntryTypes(include3p).includes(entry.data.type)) {
       return false;
     }
+    if (excludeSmartAnswersInSearch && isEntrySmartAnswersInSearch(entry)) {
+      return false;
+    }
     if (entry.data.type === 'mutation:attribute') {
       const entryData = entry.data;
       const attributeName = entryData.attributeName;

package/dist/es2019/vc/vc-observer-new/metric-calculator/utils/is-entry-smart-answers-in-search.js

@@ -0,0 +1,22 @@
+import { getDocument } from '@atlaskit/browser-apis';
+export function isEntrySmartAnswersInSearch(entry) {
+  const {
+    elementName
+  } = entry.data;
+  if (!elementName || elementName === 'START') {
+    return false;
+  }
+  const doc = getDocument();
+  if (!doc) {
+    return false;
+  }
+  const smartAnswersElement = doc.getElementById('search-page-smart-answers');
+  if (!smartAnswersElement) {
+    return false;
+  }
+  const entryDOMElement = doc.querySelector(elementName);
+  if (!entryDOMElement) {
+    return false;
+  }
+  return smartAnswersElement.contains(entryDOMElement);
+}

package/dist/esm/additional-payload/utils/lighthouse-metrics/cls/index.js

@@ -1,9 +1,24 @@
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { fg } from '@atlaskit/platform-feature-flags';
+function isSameRects(rect1, rect2) {
+  return rect1.x === rect2.x && rect1.y === rect2.y && rect1.width === rect2.width && rect1.height === rect2.height && rect1.top === rect2.top && rect1.right === rect2.right && rect1.bottom === rect2.bottom && rect1.left === rect2.left;
+}
 export function getCLS(start, stop, buffer) {
-  var layoutShifts = buffer.getAll().filter(function (entry) {
-    return entry.startTime >= start && entry.startTime <= stop;
+  var layoutShifts = buffer.getAll().filter(function (_entry) {
+    var entry = _entry;
+    var isWithinObservationWindow = entry.startTime >= start && entry.startTime <= stop;
+    if (fg('platform_ufo_filter_cls_logs_same_rects_positions')) {
+      var _entry$sources;
+      var allSourcesHaveSameRects = entry === null || entry === void 0 || (_entry$sources = entry.sources) === null || _entry$sources === void 0 ? void 0 : _entry$sources.every(function (_ref) {
+        var previousRect = _ref.previousRect,
+          currentRect = _ref.currentRect;
+        return isSameRects(previousRect, currentRect);
+      });
+      return isWithinObservationWindow && !allSourcesHaveSameRects;
+    }
+    return isWithinObservationWindow;
   });
   var sessionWindows = [];
   var currentWindow = null;

package/dist/esm/create-extra-search-page-interaction-payload/index.js

@@ -0,0 +1,43 @@
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+var interactionBuffer = [];
+var bufferInteractionData = function bufferInteractionData(interactionId, data) {
+  interactionBuffer.push({
+    interactionId: interactionId,
+    data: data
+  });
+};
+function clearInteractionBuffer() {
+  interactionBuffer.length = 0;
+}
+function appendInteractionData(interactionId, data) {
+  bufferInteractionData(interactionId, data);
+}
+function installInteractionSink(handler) {
+  var _iterator = _createForOfIteratorHelper(interactionBuffer),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var _step$value = _step.value,
+        _interactionId = _step$value.interactionId,
+        data = _step$value.data;
+      handler(_interactionId, data);
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  clearInteractionBuffer();
+  bufferInteractionData = handler;
+}
+export function sinkExtraSearchPageInteractionHandler(sinkFn) {
+  installInteractionSink(sinkFn);
+}
+export function onSearchPageInteractionComplete(interactionId, data) {
+  if (data.ufoName) {
+    appendInteractionData(interactionId, data);
+    clearInteractionBuffer();
+  }
+}

package/dist/esm/create-payload/index.js

@@ -696,4 +696,66 @@ function _createExperimentalMetricsPayload() {
     }, _callee3);
   }));
   return _createExperimentalMetricsPayload.apply(this, arguments);
+}
+export function createExtraSearchPageInteractionPayload(_x0, _x1) {
+  return _createExtraSearchPageInteractionPayload.apply(this, arguments);
+}
+function _createExtraSearchPageInteractionPayload() {
+  _createExtraSearchPageInteractionPayload = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(interactionId, interaction) {
+    var SAIN_HOLD_NAMES, NAME_OVERRIDE, SEARCH_PAGE_SMART_ANSWERS_SEGMENT_LABEL, newInteractionId, newEnd, holdInfo, reactProfilerTimings, lastHold, isLastHoldSAIN, lastFilteredTime, filteredReactProfilerTimings, lastTiming, modifiedInteraction, payloads, vcMetrics, interactionMetricsPayload;
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          SAIN_HOLD_NAMES = ['search-ai-dialog-visible-text-loading', 'search-ai-dialog-all-text-loading'];
+          NAME_OVERRIDE = 'search-page-ignoring-smart-answers';
+          SEARCH_PAGE_SMART_ANSWERS_SEGMENT_LABEL = 'search-page-smart-answers';
+          newInteractionId = "".concat(interactionId, "-ignoring-smart-answers"); // Calculate a new end time which excludes SAIN holds
+          holdInfo = interaction.holdInfo, reactProfilerTimings = interaction.reactProfilerTimings;
+          lastHold = holdInfo.at(-1);
+          isLastHoldSAIN = Boolean(lastHold && SAIN_HOLD_NAMES.includes(lastHold.name)); // A new end time is only calculated if the last hold is a SAIN hold
+          if (isLastHoldSAIN) {
+            lastFilteredTime = null;
+            filteredReactProfilerTimings = reactProfilerTimings.filter(function (timing) {
+              if (timing.commitTime === lastFilteredTime) {
+                return false;
+              }
+              var isTimingSmartAnswersInSearch = timing.labelStack.some(function (label) {
+                return label.name === SEARCH_PAGE_SMART_ANSWERS_SEGMENT_LABEL;
+              });
+              if (isTimingSmartAnswersInSearch) {
+                lastFilteredTime = timing.commitTime;
+                return false;
+              }
+              return true;
+            });
+            lastTiming = filteredReactProfilerTimings.at(-1);
+            if (lastTiming) {
+              newEnd = lastTiming.commitTime;
+            }
+          }
+          modifiedInteraction = _objectSpread(_objectSpread({}, interaction), {}, {
+            end: newEnd !== null && newEnd !== void 0 ? newEnd : interaction.end,
+            holdInfo: [],
+            knownSegments: [],
+            reactProfilerTimings: [],
+            ufoName: NAME_OVERRIDE
+          });
+          payloads = [];
+          _context4.next = 12;
+          return getVCMetrics(interaction, false, true);
+        case 12:
+          vcMetrics = _context4.sent;
+          _context4.next = 15;
+          return createInteractionMetricsPayload(modifiedInteraction, newInteractionId, undefined, undefined, vcMetrics);
+        case 15:
+          interactionMetricsPayload = _context4.sent;
+          payloads.push(interactionMetricsPayload);
+          return _context4.abrupt("return", payloads.filter(Boolean));
+        case 18:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  }));
+  return _createExtraSearchPageInteractionPayload.apply(this, arguments);
 }

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

@@ -15,6 +15,7 @@ function _getVCMetrics() {
   _getVCMetrics = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(interaction) {
     var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$vc3, _result$ufoVcRev;
     var include3p,
+      excludeSmartAnswersInSearch,
       config,
       interactionStatus,
       pageVisibilityUpToTTAI,
@@ -32,29 +33,30 @@ function _getVCMetrics() {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           include3p = _args.length > 1 && _args[1] !== undefined ? _args[1] : false;
+          excludeSmartAnswersInSearch = _args.length > 2 && _args[2] !== undefined ? _args[2] : false;
           config = getConfig();
           if (config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {
-            _context.next = 4;
+            _context.next = 5;
             break;
           }
           return _context.abrupt("return", {});
-        case 4:
+        case 5:
           if (!(interaction.type !== 'page_load' && interaction.type !== 'transition' && interaction.type !== 'press')) {
-            _context.next = 6;
+            _context.next = 7;
             break;
           }
           return _context.abrupt("return", {});
-        case 6:
+        case 7:
           interactionStatus = getInteractionStatus(interaction);
           pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
           shouldReportVCMetrics = interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible'; // Use per-interaction VC observer if available, otherwise fall back to global
           observer = interaction.vcObserver;
           if (observer) {
-            _context.next = 12;
+            _context.next = 13;
             break;
           }
           return _context.abrupt("return", {});
-        case 12:
+        case 13:
           isSSREnabled = interaction.type === 'page_load' && ((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)
@@ -62,7 +64,7 @@ function _getVCMetrics() {
           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 = 19;
+          _context.next = 20;
           return observer.getVCResult(_objectSpread(_objectSpread({
             start: interaction.start,
             stop: interaction.end,
@@ -75,9 +77,10 @@ function _getVCMetrics() {
             interactionId: interaction.id,
             includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
           }, ssr), {}, {
-            include3p: include3p
+            include3p: include3p,
+            excludeSmartAnswersInSearch: excludeSmartAnswersInSearch
           }));
-        case 19:
+        case 20:
           result = _context.sent;
           observer.stop(interaction.ufoName);
           if (!include3p) {
@@ -90,15 +93,15 @@ function _getVCMetrics() {
             return revision === mostRecentVCRevision;
           });
           if (!(!shouldReportVCMetrics || !(mostRecentVCRevisionPayload !== null && mostRecentVCRevisionPayload !== void 0 && mostRecentVCRevisionPayload.clean))) {
-            _context.next = 26;
+            _context.next = 27;
             break;
           }
           return _context.abrupt("return", result);
-        case 26:
+        case 27:
           return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
             'metric:vc90': mostRecentVCRevisionPayload['metric:vc90']
           }));
-        case 27:
+        case 28:
         case "end":
           return _context.stop();
       }

package/dist/esm/create-post-interaction-log-payload/index.js

@@ -145,7 +145,7 @@ function createPostInteractionLogPayload(_ref2) {
   if (lastInteractionFinish.errors.length > 0) {
     return null;
   }
-  var maxEndTimeFromProfiler = reactProfilerTimings ? Math.max.apply(Math, _toConsumableArray(reactProfilerTimings.map(function (t) {
+  var maxEndTimeFromProfiler = reactProfilerTimings && reactProfilerTimings.length > 0 ? Math.max.apply(Math, _toConsumableArray(reactProfilerTimings.map(function (t) {
     return t.commitTime;
   }))) : lastInteractionFinish.end;
   var revisedEndTime = Math.round(maxEndTimeFromProfiler);