@atlaskit/react-ufo 3.10.4 → 3.11.1

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

@@ -1,4 +1,5 @@
 import { InteractionMetrics } from '../../common/common/types';
+import { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {
@@ -8,7 +9,7 @@ type CalculatedVC = {
         [key: string]: string[] | null;
     };
 };
-export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, }: {
+export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, experienceKey, }: {
     fullPrefix?: string;
     interaction: Pick<InteractionMetrics, 'start' | 'end'>;
     isVCClean: boolean;
@@ -16,9 +17,10 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
     multiHeatmap: MultiRevisionHeatmap | null;
     calculatedVC: CalculatedVC;
     calculatedVCNext: CalculatedVC;
+    experienceKey: string;
     ssr?: number;
 }): {
-    [x: string]: import("../../common").RevisionPayload;
+    [x: string]: RevisionPayload;
 } | {
     [x: string]: {
         revision: string;
@@ -26,7 +28,7 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
         'metric:vc90': number | null;
         vcDetails: {
             [key: string]: {
-                t: number | null | undefined;
+                t: number;
                 e: string[];
             };
         };

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

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

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 { 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/config/index.d.ts

@@ -74,7 +74,17 @@ export type Config = {
         readonly ssr?: boolean;
         readonly ssrWhitelist?: string[];
         readonly stopVCAtInteractionFinish?: boolean;
-        readonly enabledVCRevisions?: readonly TTVCRevisions[];
+        /**
+         * The revisions of TTVC that will be calculated
+         * - `all` is the TTVC revisions that are used on a product level
+         * - `byExperience` is the version that is used on an experience level.
+         *   Note that an entry in the `byExperience` config should only be a SUBSET of the `all` config,
+         *   i.e. every element for all `byExperience` entry configs should exist in the `all` config
+         */
+        readonly enabledVCRevisions?: {
+            all: readonly TTVCRevisions[];
+            byExperience?: Record<string, readonly TTVCRevisions[]>;
+        };
     };
     readonly postInteractionLog?: {
         readonly enabled?: boolean;
@@ -99,8 +109,9 @@ export type Config = {
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
-export declare function getEnabledVCRevisions(): TTVCRevisions[];
-export declare function isVCRevisionEnabled(revision: TTVCRevisions): boolean;
+export declare function getEnabledVCRevisions(experienceKey?: string): readonly TTVCRevisions[];
+export declare function isVCRevisionEnabled(revision: TTVCRevisions, experienceKey?: string): boolean;
+export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRevisions;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;

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

@@ -26,12 +26,13 @@ declare function createPostInteractionLogPayload({ lastInteractionFinish, reactP
                     vc90: number | null;
                     vcClean: boolean;
                     type: import("../common").InteractionType;
-                    id: string;
                     abortReason?: import("../common").AbortReasonType | undefined;
+                    id: string;
                     abortedByInteractionName?: string | undefined;
                     routeName: string | null;
-                    experimentalTTAI?: number | undefined;
                     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/types.d.ts

@@ -7,6 +7,7 @@ export type GetVCResultType = {
     prefix?: string;
     ssr?: number;
     vc?: VCRawDataType | null;
+    experienceKey: string;
 };
 export type SelectorConfig = {
     id: boolean;
@@ -25,8 +26,9 @@ export type VCObserverOptions = {
 export interface VCObserverInterface {
     start(startArg: {
         startTime: number;
+        experienceKey?: string;
     }): void;
-    stop(): void;
+    stop(experienceKey?: string): void;
     getVCRawData(): VCRawDataType | null;
     getVCResult(param: GetVCResultType): Promise<VCResult>;
     setSSRElement(element: HTMLElement): void;

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

@@ -1,4 +1,5 @@
 import { InteractionMetrics } from '../../common/common/types';
+import { RevisionPayload } from '../../common/vc/types';
 import type { MultiRevisionHeatmap } from './heatmap/heatmap';
 type CalculatedVC = {
     VC: {
@@ -8,7 +9,7 @@ type CalculatedVC = {
         [key: string]: string[] | null;
     };
 };
-export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, }: {
+export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean, isEventAborted, multiHeatmap, ssr, calculatedVC, calculatedVCNext, experienceKey, }: {
     fullPrefix?: string;
     interaction: Pick<InteractionMetrics, 'start' | 'end'>;
     isVCClean: boolean;
@@ -16,9 +17,10 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
     multiHeatmap: MultiRevisionHeatmap | null;
     calculatedVC: CalculatedVC;
     calculatedVCNext: CalculatedVC;
+    experienceKey: string;
     ssr?: number;
 }): {
-    [x: string]: import("../../common").RevisionPayload;
+    [x: string]: RevisionPayload;
 } | {
     [x: string]: {
         revision: string;
@@ -26,7 +28,7 @@ export declare function getVCRevisionsData({ fullPrefix, interaction, isVCClean,
         'metric:vc90': number | null;
         vcDetails: {
             [key: string]: {
-                t: number | null | undefined;
+                t: number;
                 e: string[];
             };
         };

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.10.4",
+	"version": "3.11.1",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -130,9 +130,15 @@
 		"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"
 		},
+		"platform_ufo_vc_enable_revisions_by_experience": {
+			"type": "boolean"
+		},
 		"ufo_return_relative_request_start": {
 			"type": "boolean"
 		},