@atlaskit/react-ufo 3.11.0 → 3.11.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 3.11.2
+
+### Patch Changes
+
+- [#153697](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/153697)
+  [`e513d2cda4042`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e513d2cda4042) -
+  AFO-3823 improve VCObserver stop() performance
+
+## 3.11.1
+
+### Patch Changes
+
+- [#154164](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/154164)
+  [`59249901f5291`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/59249901f5291) -
+  align logic for UFO events and watchdog event
+
 ## 3.11.0
 
 ### Minor Changes

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

@@ -133,6 +133,17 @@ function createPostInteractionLogPayload(_ref2) {
   if (pageVisibilityState !== 'visible') {
     return null;
   }
+
+  // Align post-interaction-logs closer to UFO event behaviour,
+  // e.g. also check for aborted or failed events
+  if ((0, _platformFeatureFlags.fg)('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+    if (lastInteractionFinish.abortReason) {
+      return null;
+    }
+    if (lastInteractionFinish.errors.length > 0) {
+      return null;
+    }
+  }
   var maxEndTimeFromProfiler = reactProfilerTimings ? Math.max.apply(Math, (0, _toConsumableArray2.default)(reactProfilerTimings.map(function (t) {
     return t.commitTime;
   }))) : lastInteractionFinish.end;

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

@@ -10,7 +10,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _config = require("../config");
+var _vc = require("../vc");
 var _vcObserver = require("../vc/vc-observer");
 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) { (0, _defineProperty2.default)(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; }
@@ -43,7 +45,11 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
   return (0, _createClass2.default)(PostInteractionLog, [{
     key: "initializeVCObserver",
     value: function initializeVCObserver(options) {
-      if (this.vcObserver === null) {
+      if ((0, _platformFeatureFlags.fg)('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+        this.vcObserver = new _vc.VCObserverWrapper(_objectSpread(_objectSpread({}, options), {}, {
+          isPostInteraction: true
+        }));
+      } else if (this.vcObserver === null) {
         this.vcObserver = new _vcObserver.VCObserver(_objectSpread(_objectSpread({}, options), {}, {
           isPostInteraction: true
         }));
@@ -186,7 +192,8 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
         routeName = _ref2.routeName,
         type = _ref2.type,
         experimentalTTAI = _ref2.experimentalTTAI,
-        experimentalVC90 = _ref2.experimentalVC90;
+        experimentalVC90 = _ref2.experimentalVC90,
+        errors = _ref2.errors;
       this.lastInteractionFinish = {
         ufoName: ufoName,
         start: start,
@@ -197,7 +204,8 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
         routeName: routeName,
         type: type,
         experimentalTTAI: experimentalTTAI,
-        experimentalVC90: experimentalVC90
+        experimentalVC90: experimentalVC90,
+        errors: errors
       };
       var timeout = ((_getConfig3 = (0, _config.getConfig)()) === null || _getConfig3 === void 0 ? void 0 : _getConfig3.timeWindowForLateMutationsInMilliseconds) || POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT;
       this.sinkTimeoutId = window.setTimeout( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {

package/dist/cjs/vc/index.js

@@ -4,6 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.VCObserverWrapper = void 0;
 exports.getVCObserver = getVCObserver;
 exports.isEnvironmentSupported = isEnvironmentSupported;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
@@ -20,7 +21,7 @@ var _vcObserverNew = _interopRequireDefault(require("./vc-observer-new"));
 var _process;
 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) { (0, _defineProperty2.default)(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; }
-var VCObserverWrapper = /*#__PURE__*/function () {
+var VCObserverWrapper = exports.VCObserverWrapper = /*#__PURE__*/function () {
   function VCObserverWrapper() {
     var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     (0, _classCallCheck2.default)(this, VCObserverWrapper);

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

@@ -644,11 +644,12 @@ var VCObserver = exports.VCObserver = /*#__PURE__*/function () {
   }, {
     key: "detachAbortListeners",
     value: function detachAbortListeners() {
-      if (Array.isArray(this.unbind)) {
-        this.unbind.forEach(function (fn) {
-          return fn();
-        });
-        this.unbind = [];
+      if (this.unbind) {
+        var unbind = this.unbind;
+        for (var i = 0; i < unbind.length; i++) {
+          unbind[i]();
+        }
+        this.unbind.length = 0;
       }
     }
   }, {

package/dist/cjs/vc/vc-observer/observers/index.js

@@ -104,8 +104,8 @@ var Observers = exports.Observers = /*#__PURE__*/function () {
       (_this$mutationObserve2 = this.mutationObserver) === null || _this$mutationObserve2 === void 0 || _this$mutationObserve2.disconnect();
       (_this$intersectionObs2 = this.intersectionObserver) === null || _this$intersectionObs2 === void 0 || _this$intersectionObs2.disconnect();
       this.observedMutations = new WeakMap();
-      this.elementsInView = new Set();
-      this.callbacks = new Set();
+      this.elementsInView.clear();
+      this.callbacks.clear();
       this.ssr.reactRootElement = null;
       this.ssrPlaceholderHandler.clear();
     }

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

@@ -120,6 +120,17 @@ function createPostInteractionLogPayload({
   if (pageVisibilityState !== 'visible') {
     return null;
   }
+
+  // Align post-interaction-logs closer to UFO event behaviour,
+  // e.g. also check for aborted or failed events
+  if (fg('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+    if (lastInteractionFinish.abortReason) {
+      return null;
+    }
+    if (lastInteractionFinish.errors.length > 0) {
+      return null;
+    }
+  }
   const maxEndTimeFromProfiler = reactProfilerTimings ? Math.max(...reactProfilerTimings.map(t => t.commitTime)) : lastInteractionFinish.end;
   const revisedEndTime = Math.round(maxEndTimeFromProfiler);
   const revisedTtai = Math.round(maxEndTimeFromProfiler - lastInteractionFinish.start);

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

@@ -1,5 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getConfig } from '../config';
+import { VCObserverWrapper } from '../vc';
 import { VCObserver } from '../vc/vc-observer';
 const POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT = 3000;
 export default class PostInteractionLog {
@@ -27,7 +29,12 @@ export default class PostInteractionLog {
     _defineProperty(this, "sinkHandlerFn", () => {});
   }
   initializeVCObserver(options) {
-    if (this.vcObserver === null) {
+    if (fg('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+      this.vcObserver = new VCObserverWrapper({
+        ...options,
+        isPostInteraction: true
+      });
+    } else if (this.vcObserver === null) {
       this.vcObserver = new VCObserver({
         ...options,
         isPostInteraction: true
@@ -135,7 +142,8 @@ export default class PostInteractionLog {
     routeName,
     type,
     experimentalTTAI,
-    experimentalVC90
+    experimentalVC90,
+    errors
   }) {
     var _getConfig3;
     this.lastInteractionFinish = {
@@ -148,7 +156,8 @@ export default class PostInteractionLog {
       routeName,
       type,
       experimentalTTAI,
-      experimentalVC90
+      experimentalVC90,
+      errors
     };
     const timeout = ((_getConfig3 = getConfig()) === null || _getConfig3 === void 0 ? void 0 : _getConfig3.timeWindowForLateMutationsInMilliseconds) || POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT;
     this.sinkTimeoutId = window.setTimeout(async () => {

package/dist/es2019/vc/index.js

@@ -4,7 +4,7 @@ import { isVCRevisionEnabled } from '../config';
 import { VCObserverNOOP } from './no-op-vc-observer';
 import { VCObserver } from './vc-observer';
 import VCObserverNew from './vc-observer-new';
-class VCObserverWrapper {
+export class VCObserverWrapper {
   constructor(opts = {}) {
     this.newVCObserver = null;
     if (fg('platform_ufo_vc_enable_revisions_by_experience')) {

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

@@ -739,9 +739,14 @@ export class VCObserver {
     return vc;
   }
   detachAbortListeners() {
-    if (Array.isArray(this.unbind)) {
-      this.unbind.forEach(fn => fn());
-      this.unbind = [];
+    if (this.unbind) {
+      const {
+        unbind
+      } = this;
+      for (let i = 0; i < unbind.length; i++) {
+        unbind[i]();
+      }
+      this.unbind.length = 0;
     }
   }
   measureStart() {

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

@@ -86,8 +86,8 @@ export class Observers {
     (_this$mutationObserve2 = this.mutationObserver) === null || _this$mutationObserve2 === void 0 ? void 0 : _this$mutationObserve2.disconnect();
     (_this$intersectionObs2 = this.intersectionObserver) === null || _this$intersectionObs2 === void 0 ? void 0 : _this$intersectionObs2.disconnect();
     this.observedMutations = new WeakMap();
-    this.elementsInView = new Set();
-    this.callbacks = new Set();
+    this.elementsInView.clear();
+    this.callbacks.clear();
     this.ssr.reactRootElement = null;
     this.ssrPlaceholderHandler.clear();
   }

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

@@ -126,6 +126,17 @@ function createPostInteractionLogPayload(_ref2) {
   if (pageVisibilityState !== 'visible') {
     return null;
   }
+
+  // Align post-interaction-logs closer to UFO event behaviour,
+  // e.g. also check for aborted or failed events
+  if (fg('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+    if (lastInteractionFinish.abortReason) {
+      return null;
+    }
+    if (lastInteractionFinish.errors.length > 0) {
+      return null;
+    }
+  }
   var maxEndTimeFromProfiler = reactProfilerTimings ? Math.max.apply(Math, _toConsumableArray(reactProfilerTimings.map(function (t) {
     return t.commitTime;
   }))) : lastInteractionFinish.end;

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

@@ -5,7 +5,9 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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 { VCObserverWrapper } from '../vc';
 import { VCObserver } from '../vc/vc-observer';
 var POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT = 3000;
 var PostInteractionLog = /*#__PURE__*/function () {
@@ -36,7 +38,11 @@ var PostInteractionLog = /*#__PURE__*/function () {
   return _createClass(PostInteractionLog, [{
     key: "initializeVCObserver",
     value: function initializeVCObserver(options) {
-      if (this.vcObserver === null) {
+      if (fg('platform_ufo_vc_align_revisions_on_watchdog_event')) {
+        this.vcObserver = new VCObserverWrapper(_objectSpread(_objectSpread({}, options), {}, {
+          isPostInteraction: true
+        }));
+      } else if (this.vcObserver === null) {
         this.vcObserver = new VCObserver(_objectSpread(_objectSpread({}, options), {}, {
           isPostInteraction: true
         }));
@@ -179,7 +185,8 @@ var PostInteractionLog = /*#__PURE__*/function () {
         routeName = _ref2.routeName,
         type = _ref2.type,
         experimentalTTAI = _ref2.experimentalTTAI,
-        experimentalVC90 = _ref2.experimentalVC90;
+        experimentalVC90 = _ref2.experimentalVC90,
+        errors = _ref2.errors;
       this.lastInteractionFinish = {
         ufoName: ufoName,
         start: start,
@@ -190,7 +197,8 @@ var PostInteractionLog = /*#__PURE__*/function () {
         routeName: routeName,
         type: type,
         experimentalTTAI: experimentalTTAI,
-        experimentalVC90: experimentalVC90
+        experimentalVC90: experimentalVC90,
+        errors: errors
       };
       var timeout = ((_getConfig3 = getConfig()) === null || _getConfig3 === void 0 ? void 0 : _getConfig3.timeWindowForLateMutationsInMilliseconds) || POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT;
       this.sinkTimeoutId = window.setTimeout( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {

package/dist/esm/vc/index.js

@@ -12,7 +12,7 @@ import { isVCRevisionEnabled } from '../config';
 import { VCObserverNOOP } from './no-op-vc-observer';
 import { VCObserver } from './vc-observer';
 import VCObserverNew from './vc-observer-new';
-var VCObserverWrapper = /*#__PURE__*/function () {
+export var VCObserverWrapper = /*#__PURE__*/function () {
   function VCObserverWrapper() {
     var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     _classCallCheck(this, VCObserverWrapper);
@@ -192,7 +192,9 @@ var VCObserverWrapper = /*#__PURE__*/function () {
       (_this$oldVCObserver10 = this.oldVCObserver) === null || _this$oldVCObserver10 === void 0 || _this$oldVCObserver10.setReactRootRenderStop(stopTime || performance.now());
     }
   }]);
-}(); // Some products set this variable to indicate it is running in SSR
+}();
+
+// Some products set this variable to indicate it is running in SSR
 var isServer = Boolean(globalThis === null || globalThis === void 0 ? void 0 : globalThis.__SERVER__);
 // Other products set this other variable to indicate it is running in SSR
 var isReactSSR = typeof process !== 'undefined' && Boolean(((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.REACT_SSR) || false);

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

@@ -637,11 +637,12 @@ export var VCObserver = /*#__PURE__*/function () {
   }, {
     key: "detachAbortListeners",
     value: function detachAbortListeners() {
-      if (Array.isArray(this.unbind)) {
-        this.unbind.forEach(function (fn) {
-          return fn();
-        });
-        this.unbind = [];
+      if (this.unbind) {
+        var unbind = this.unbind;
+        for (var i = 0; i < unbind.length; i++) {
+          unbind[i]();
+        }
+        this.unbind.length = 0;
       }
     }
   }, {

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

@@ -97,8 +97,8 @@ export var Observers = /*#__PURE__*/function () {
       (_this$mutationObserve2 = this.mutationObserver) === null || _this$mutationObserve2 === void 0 || _this$mutationObserve2.disconnect();
       (_this$intersectionObs2 = this.intersectionObserver) === null || _this$intersectionObs2 === void 0 || _this$intersectionObs2.disconnect();
       this.observedMutations = new WeakMap();
-      this.elementsInView = new Set();
-      this.callbacks = new Set();
+      this.elementsInView.clear();
+      this.callbacks.clear();
       this.ssr.reactRootElement = null;
       this.ssrPlaceholderHandler.clear();
     }

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

@@ -202,7 +202,7 @@ export type BM3Event = {
     pageVisibleState?: string;
     type: string;
 };
-export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI'>;
+export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI' | 'errors'>;
 export type PostInteractionLogOutput = {
     lastInteractionFinish: LastInteractionFinishInfo;
     reactProfilerTimings?: ReactProfilerTiming[];

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

@@ -1,7 +1,7 @@
 import { createPayloads } from '../create-payload';
-import { LabelStack } from '../interaction-context';
+import { type LabelStack } from '../interaction-context';
 import { VCObserver } from '../vc/vc-observer';
-import type { AbortReasonType, ApdexType, InteractionType, SegmentInfo } from './common/types';
+import type { AbortReasonType, ApdexType, InteractionError, InteractionType, 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';
@@ -135,6 +135,7 @@ export type ReactUFOPayload = {
                 segments: SegmentInfo[] | RootSegment;
                 reactProfilerTimings: ReactProfilerTiming[];
                 holdInfo: HoldInfo[];
+                errors: InteractionError[];
             };
             'ufo:vc:rev': RevisionPayload;
             'ufo:vc:ratios': Record<string, number>;
@@ -143,6 +144,8 @@ export type ReactUFOPayload = {
                 h: number;
             };
             'ufo:vc:time': number;
+            'ufo:speedIndex'?: number;
+            'ufo:vc:ignored'?: string[];
             'ufo:vc:abort:reason'?: string;
             'ufo:vc:state'?: boolean;
             'ufo:vc:clean'?: boolean;
@@ -161,9 +164,7 @@ export type ReactUFOPayload = {
                 elements: string[];
             }>;
             'ufo:vc:next:dom'?: Record<VCParts, string[]>;
-            'ufo:vc:ignored'?: string[];
             'metric:vc90'?: number;
-            'ufo:speedIndex'?: number;
             'ufo:next:speedIndex'?: number;
             'ufo:vc:updates:next'?: Array<{
                 time: number;
@@ -173,4 +174,49 @@ export type ReactUFOPayload = {
         };
     };
 };
+type LateElement = {
+    time: number;
+    element: string;
+    viewportHeatmapPercentage: number;
+};
+export type PostInteractionLogPayload = {
+    actionSubject: 'experience';
+    action: 'measured';
+    eventType: 'operational';
+    source: 'measured';
+    tags: ['observability'];
+    attributes: {
+        properties: {
+            'event:hostname': string;
+            'event:product': string;
+            'event:schema': '1.0.0';
+            'event:source': {
+                name: 'react-ufo/web';
+                version: '1.0.1';
+            };
+            'event:region': string;
+            'experience:key': 'custom.post-interaction-logs';
+            postInteractionLog: {
+                lastInteractionFinish: {
+                    ufoName: string;
+                    start: number;
+                    end: number;
+                    id: string;
+                    routeName: string;
+                    type: InteractionType;
+                    errors: InteractionError[];
+                    ttai: number;
+                    vc90: number;
+                    vcClean: boolean;
+                };
+                revisedEndTime: number;
+                revisedTtai: number;
+                revisedVC90: number;
+                vcClean: boolean;
+                lateMutations: LateElement[];
+                reactProfilerTimings: ReactProfilerTiming[];
+            };
+        };
+    };
+};
 export {};

package/dist/types/create-payload/index.d.ts

@@ -1,5 +1,5 @@
 import type { InteractionMetrics, InteractionType } from '../common';
-import { ResourceTiming } from '../common/react-ufo-payload-schema';
+import { type ResourceTiming } from '../common/react-ufo-payload-schema';
 import * as ssr from '../ssr';
 import type { OptimizedLabelStack } from './common/types';
 export declare function createPayloads(interactionId: string, interaction: InteractionMetrics): Promise<{

package/dist/types/create-post-interaction-log-payload/get-late-mutations.d.ts

@@ -1,5 +1,5 @@
-import { LastInteractionFinishInfo } from '../common';
-import { RevisionPayloadVCDetails } from '../common/vc/types';
-import { LateMutation } from './types';
+import type { LastInteractionFinishInfo } from '../common';
+import type { RevisionPayloadVCDetails } from '../common/vc/types';
+import type { LateMutation } from './types';
 declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios: Record<string, number>): LateMutation[];
 export default getLateMutations;

package/dist/types/create-post-interaction-log-payload/index.d.ts

@@ -1,5 +1,5 @@
 import { type PostInteractionLogOutput } from '../common';
-import { LateMutation } from './types';
+import type { LateMutation } from './types';
 declare function createPostInteractionLogPayload({ lastInteractionFinish, reactProfilerTimings, lastInteractionFinishVCResult, postInteractionFinishVCResult, }: PostInteractionLogOutput): {
     actionSubject: string;
     action: string;
@@ -32,6 +32,7 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     routeName: string | null;
                     experimentalVC90?: number | undefined;
                     experimentalTTAI?: number | undefined;
+                    errors: import("../common").InteractionError[];
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

package/dist/types/interaction-metrics/post-interaction-log.d.ts

@@ -1,8 +1,7 @@
 import { type LastInteractionFinishInfo, type PostInteractionLogOutput, type ReactProfilerTiming } from '../common/common/types';
 import type { VCResult } from '../common/vc/types';
 import type { LabelStack } from '../interaction-context';
-import type { VCObserverOptions } from '../vc/types';
-import { VCObserver } from '../vc/vc-observer';
+import type { VCObserverInterface, VCObserverOptions } from '../vc/types';
 export default class PostInteractionLog {
     /**
      * Basic info about interaction that has just finished
@@ -19,7 +18,7 @@ export default class PostInteractionLog {
     /**
      * independent VC observer, that observes until `custom.post-interaction-logs` event is sent
      */
-    vcObserver: VCObserver | null;
+    vcObserver: VCObserverInterface | null;
     vcObserverSSRConfig: {
         ssr: number | undefined;
     } | null;
@@ -62,7 +61,7 @@ export default class PostInteractionLog {
      * Basic details about the finished interaction will be recorded
      * A timeout will be setup to send the post interaction observation after some time.
      */
-    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, experimentalTTAI, experimentalVC90, }: LastInteractionFinishInfo): void;
+    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, experimentalTTAI, experimentalVC90, errors, }: LastInteractionFinishInfo): void;
     /**
      * This fn should be invoked when a React render happens after interaction has finished
      */

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

@@ -1,6 +1,22 @@
-import type { VCObserverInterface, VCObserverOptions } from './types';
+import type { VCRawDataType, VCResult } from '../common/vc/types';
+import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from './types';
 declare global {
     var __vcObserver: VCObserverInterface;
 }
+export declare class VCObserverWrapper implements VCObserverInterface {
+    private oldVCObserver;
+    private newVCObserver;
+    constructor(opts?: VCObserverOptions);
+    start({ startTime, experienceKey }: {
+        startTime: number;
+        experienceKey: string;
+    }): void;
+    stop(experienceKey?: string): void;
+    getVCRawData(): VCRawDataType | null;
+    getVCResult(param: GetVCResultType): Promise<VCResult>;
+    setSSRElement(element: HTMLElement): void;
+    setReactRootRenderStart(startTime: number): void;
+    setReactRootRenderStop(stopTime: number): void;
+}
 export declare function isEnvironmentSupported(): boolean;
 export declare function getVCObserver(opts?: VCObserverOptions): VCObserverInterface;

package/dist/types/vc/no-op-vc-observer.d.ts

@@ -1,4 +1,4 @@
-import { VCResult } from '../common/vc/types';
+import type { VCResult } from '../common/vc/types';
 import type { GetVCResultType, VCObserverInterface } from './types';
 export declare class VCObserverNOOP implements VCObserverInterface {
     start(startArg: {

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

@@ -1,5 +1,5 @@
-import { InteractionMetrics } from '../../common/common/types';
-import { RevisionPayload } from '../../common/vc/types';
+import type { InteractionMetrics } from '../../common/common/types';
+import type { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {

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

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry } from '../../common/vc/types';
+import { type RevisionPayloadEntry } from '../../common/vc/types';
 import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {

package/dist/types/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
+import type { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
 import type { VCCalculator, VCCalculatorParam } from './types';
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {

package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.d.ts

@@ -1,5 +1,5 @@
 import type { VCObserverEntry } from '../../../types';
-import { HeatmapCheckpointMetrics, HeatmapEntry, HeatmapOptions } from './types';
+import type { HeatmapCheckpointMetrics, HeatmapEntry, HeatmapOptions } from './types';
 export default class Heatmap {
     private viewport;
     /**

package/dist/types/vc/vc-observer-new/metric-calculator/types.d.ts

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
 export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;

package/dist/types-ts4.5/common/common/types.d.ts

@@ -202,7 +202,7 @@ export type BM3Event = {
     pageVisibleState?: string;
     type: string;
 };
-export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI'>;
+export type LastInteractionFinishInfo = Pick<InteractionMetrics, 'ufoName' | 'start' | 'end' | 'id' | 'abortReason' | 'abortedByInteractionName' | 'routeName' | 'type' | 'experimentalVC90' | 'experimentalTTAI' | 'errors'>;
 export type PostInteractionLogOutput = {
     lastInteractionFinish: LastInteractionFinishInfo;
     reactProfilerTimings?: ReactProfilerTiming[];

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

@@ -1,7 +1,7 @@
 import { createPayloads } from '../create-payload';
-import { LabelStack } from '../interaction-context';
+import { type LabelStack } from '../interaction-context';
 import { VCObserver } from '../vc/vc-observer';
-import type { AbortReasonType, ApdexType, InteractionType, SegmentInfo } from './common/types';
+import type { AbortReasonType, ApdexType, InteractionError, InteractionType, 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';
@@ -137,6 +137,7 @@ export type ReactUFOPayload = {
                 segments: SegmentInfo[] | RootSegment;
                 reactProfilerTimings: ReactProfilerTiming[];
                 holdInfo: HoldInfo[];
+                errors: InteractionError[];
             };
             'ufo:vc:rev': RevisionPayload;
             'ufo:vc:ratios': Record<string, number>;
@@ -145,6 +146,8 @@ export type ReactUFOPayload = {
                 h: number;
             };
             'ufo:vc:time': number;
+            'ufo:speedIndex'?: number;
+            'ufo:vc:ignored'?: string[];
             'ufo:vc:abort:reason'?: string;
             'ufo:vc:state'?: boolean;
             'ufo:vc:clean'?: boolean;
@@ -163,9 +166,7 @@ export type ReactUFOPayload = {
                 elements: string[];
             }>;
             'ufo:vc:next:dom'?: Record<VCParts, string[]>;
-            'ufo:vc:ignored'?: string[];
             'metric:vc90'?: number;
-            'ufo:speedIndex'?: number;
             'ufo:next:speedIndex'?: number;
             'ufo:vc:updates:next'?: Array<{
                 time: number;
@@ -175,4 +176,51 @@ export type ReactUFOPayload = {
         };
     };
 };
+type LateElement = {
+    time: number;
+    element: string;
+    viewportHeatmapPercentage: number;
+};
+export type PostInteractionLogPayload = {
+    actionSubject: 'experience';
+    action: 'measured';
+    eventType: 'operational';
+    source: 'measured';
+    tags: [
+        'observability'
+    ];
+    attributes: {
+        properties: {
+            'event:hostname': string;
+            'event:product': string;
+            'event:schema': '1.0.0';
+            'event:source': {
+                name: 'react-ufo/web';
+                version: '1.0.1';
+            };
+            'event:region': string;
+            'experience:key': 'custom.post-interaction-logs';
+            postInteractionLog: {
+                lastInteractionFinish: {
+                    ufoName: string;
+                    start: number;
+                    end: number;
+                    id: string;
+                    routeName: string;
+                    type: InteractionType;
+                    errors: InteractionError[];
+                    ttai: number;
+                    vc90: number;
+                    vcClean: boolean;
+                };
+                revisedEndTime: number;
+                revisedTtai: number;
+                revisedVC90: number;
+                vcClean: boolean;
+                lateMutations: LateElement[];
+                reactProfilerTimings: ReactProfilerTiming[];
+            };
+        };
+    };
+};
 export {};

package/dist/types-ts4.5/create-payload/index.d.ts

@@ -1,5 +1,5 @@
 import type { InteractionMetrics, InteractionType } from '../common';
-import { ResourceTiming } from '../common/react-ufo-payload-schema';
+import { type ResourceTiming } from '../common/react-ufo-payload-schema';
 import * as ssr from '../ssr';
 import type { OptimizedLabelStack } from './common/types';
 export declare function createPayloads(interactionId: string, interaction: InteractionMetrics): Promise<{

package/dist/types-ts4.5/create-post-interaction-log-payload/get-late-mutations.d.ts

@@ -1,5 +1,5 @@
-import { LastInteractionFinishInfo } from '../common';
-import { RevisionPayloadVCDetails } from '../common/vc/types';
-import { LateMutation } from './types';
+import type { LastInteractionFinishInfo } from '../common';
+import type { RevisionPayloadVCDetails } from '../common/vc/types';
+import type { LateMutation } from './types';
 declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios: Record<string, number>): LateMutation[];
 export default getLateMutations;

package/dist/types-ts4.5/create-post-interaction-log-payload/index.d.ts

@@ -1,5 +1,5 @@
 import { type PostInteractionLogOutput } from '../common';
-import { LateMutation } from './types';
+import type { LateMutation } from './types';
 declare function createPostInteractionLogPayload({ lastInteractionFinish, reactProfilerTimings, lastInteractionFinishVCResult, postInteractionFinishVCResult, }: PostInteractionLogOutput): {
     actionSubject: string;
     action: string;
@@ -32,6 +32,7 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     routeName: string | null;
                     experimentalVC90?: number | undefined;
                     experimentalTTAI?: number | undefined;
+                    errors: import("../common").InteractionError[];
                 };
                 revisedEndTime: number;
                 revisedTtai: number;

package/dist/types-ts4.5/interaction-metrics/post-interaction-log.d.ts

@@ -1,8 +1,7 @@
 import { type LastInteractionFinishInfo, type PostInteractionLogOutput, type ReactProfilerTiming } from '../common/common/types';
 import type { VCResult } from '../common/vc/types';
 import type { LabelStack } from '../interaction-context';
-import type { VCObserverOptions } from '../vc/types';
-import { VCObserver } from '../vc/vc-observer';
+import type { VCObserverInterface, VCObserverOptions } from '../vc/types';
 export default class PostInteractionLog {
     /**
      * Basic info about interaction that has just finished
@@ -19,7 +18,7 @@ export default class PostInteractionLog {
     /**
      * independent VC observer, that observes until `custom.post-interaction-logs` event is sent
      */
-    vcObserver: VCObserver | null;
+    vcObserver: VCObserverInterface | null;
     vcObserverSSRConfig: {
         ssr: number | undefined;
     } | null;
@@ -62,7 +61,7 @@ export default class PostInteractionLog {
      * Basic details about the finished interaction will be recorded
      * A timeout will be setup to send the post interaction observation after some time.
      */
-    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, experimentalTTAI, experimentalVC90, }: LastInteractionFinishInfo): void;
+    onInteractionComplete({ ufoName, start, end, id, abortReason, abortedByInteractionName, routeName, type, experimentalTTAI, experimentalVC90, errors, }: LastInteractionFinishInfo): void;
     /**
      * This fn should be invoked when a React render happens after interaction has finished
      */

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

@@ -1,6 +1,22 @@
-import type { VCObserverInterface, VCObserverOptions } from './types';
+import type { VCRawDataType, VCResult } from '../common/vc/types';
+import type { GetVCResultType, VCObserverInterface, VCObserverOptions } from './types';
 declare global {
     var __vcObserver: VCObserverInterface;
 }
+export declare class VCObserverWrapper implements VCObserverInterface {
+    private oldVCObserver;
+    private newVCObserver;
+    constructor(opts?: VCObserverOptions);
+    start({ startTime, experienceKey }: {
+        startTime: number;
+        experienceKey: string;
+    }): void;
+    stop(experienceKey?: string): void;
+    getVCRawData(): VCRawDataType | null;
+    getVCResult(param: GetVCResultType): Promise<VCResult>;
+    setSSRElement(element: HTMLElement): void;
+    setReactRootRenderStart(startTime: number): void;
+    setReactRootRenderStop(stopTime: number): void;
+}
 export declare function isEnvironmentSupported(): boolean;
 export declare function getVCObserver(opts?: VCObserverOptions): VCObserverInterface;

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

@@ -1,4 +1,4 @@
-import { VCResult } from '../common/vc/types';
+import type { VCResult } from '../common/vc/types';
 import type { GetVCResultType, VCObserverInterface } from './types';
 export declare class VCObserverNOOP implements VCObserverInterface {
     start(startArg: {

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

@@ -1,5 +1,5 @@
-import { InteractionMetrics } from '../../common/common/types';
-import { RevisionPayload } from '../../common/vc/types';
+import type { InteractionMetrics } from '../../common/common/types';
+import type { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {

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

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry } from '../../common/vc/types';
+import { type RevisionPayloadEntry } from '../../common/vc/types';
 import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
+import type { RevisionPayloadEntry, VCAbortReason } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
 import type { VCCalculator, VCCalculatorParam } from './types';
 export default abstract class AbstractVCCalculatorBase implements VCCalculator {

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.d.ts

@@ -1,5 +1,5 @@
 import type { VCObserverEntry } from '../../../types';
-import { HeatmapCheckpointMetrics, HeatmapEntry, HeatmapOptions } from './types';
+import type { HeatmapCheckpointMetrics, HeatmapEntry, HeatmapOptions } from './types';
 export default class Heatmap {
     private viewport;
     /**

package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/types.d.ts

@@ -1,4 +1,4 @@
-import { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
 import type { VCObserverEntry } from '../types';
 export type VCCalculatorParam = {
     startTime: DOMHighResTimeStamp;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.11.0",
+	"version": "3.11.2",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -130,6 +130,9 @@
 		"platform_ufo_use_offscreen_canvas": {
 			"type": "boolean"
 		},
+		"platform_ufo_vc_align_revisions_on_watchdog_event": {
+			"type": "boolean"
+		},
 		"platform_ufo_canvas_heatmap_full_precision": {
 			"type": "boolean"
 		},