@atlaskit/react-ufo 4.14.4 → 4.14.5

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.14.5
+
+### Patch Changes
+
+- [`7fa9699d9340f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7fa9699d9340f) -
+  Marks first ufo segment load time
+
 ## 4.14.4
 
 ### Patch Changes

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

@@ -35,7 +35,9 @@ exports.addSpanToAll = addSpanToAll;
 exports.extractModuleName = extractModuleName;
 exports.getActiveInteraction = getActiveInteraction;
 exports.getCurrentInteractionType = getCurrentInteractionType;
-exports.postInteractionLog = exports.interactionSpans = exports.interactionExtraMetrics = exports.getPerformanceObserver = void 0;
+exports.interactionSpans = exports.interactionExtraMetrics = exports.getPerformanceObserver = void 0;
+exports.markFirstSegmentLoad = markFirstSegmentLoad;
+exports.postInteractionLog = void 0;
 exports.remove = remove;
 exports.removeHoldByID = removeHoldByID;
 exports.removeSegment = removeSegment;
@@ -78,6 +80,7 @@ var interactionQueue = [];
 var segmentCache = new Map();
 var segmentUnmountCache = exports.segmentUnmountCache = new Map(); // Temporarily store segment unmount counts
 
+var firstSegmentLoadMarked = false;
 var segmentObservers = [];
 function getActiveInteraction() {
   var interactionId = (0, _interactionIdContext.getInteractionId)();
@@ -274,6 +277,22 @@ function addMark(interactionId, type, name, labelStack) {
     });
   }
 }
+function markFirstSegmentLoad(interactionId, labelStack) {
+  var time = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : performance.now();
+  if (!(0, _platformFeatureFlags.fg)('platform_mark_ufo_segment_first_load')) {
+    return;
+  }
+  var interaction = _constants.interactions.get(interactionId);
+  if (interaction != null && !firstSegmentLoadMarked) {
+    firstSegmentLoadMarked = true;
+    interaction.marks.push({
+      type: 'first_segment_load',
+      name: 'first_segment_load',
+      labelStack: labelStack,
+      time: time
+    });
+  }
+}
 function addMarkToAll(type, name, labelStack) {
   var time = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : performance.now();
   _constants.interactions.forEach(function (interaction) {

package/dist/cjs/segment/segment.js

@@ -24,6 +24,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
 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; } // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 var tryCompleteHandle;
+var hasMarkedFirstSegmentLoad = false;
 
 /** A portion of the page we apply measurement to */
 function UFOSegment(_ref) {
@@ -66,6 +67,10 @@ function UFOSegment(_ref) {
     } : {})];
   }, [parentContext, segmentName, segmentId, type]);
   var interactionId = (0, _react.useContext)(_interactionIdContext.default);
+  if (interactionId.current != null && !hasMarkedFirstSegmentLoad) {
+    (0, _interactionMetrics.markFirstSegmentLoad)(interactionId.current, labelStack, performance.now());
+    hasMarkedFirstSegmentLoad = true;
+  }
   var interactionContext = (0, _react.useMemo)(function () {
     var lastCompleteEndTime = 0;
     function complete() {

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

@@ -23,6 +23,7 @@ const interactionQueue = [];
 const segmentCache = new Map();
 export const segmentUnmountCache = new Map(); // Temporarily store segment unmount counts
 
+let firstSegmentLoadMarked = false;
 const segmentObservers = [];
 export function getActiveInteraction() {
   const interactionId = getInteractionId();
@@ -194,6 +195,21 @@ export function addMark(interactionId, type, name, labelStack, time = performanc
     });
   }
 }
+export function markFirstSegmentLoad(interactionId, labelStack, time = performance.now()) {
+  if (!fg('platform_mark_ufo_segment_first_load')) {
+    return;
+  }
+  const interaction = interactions.get(interactionId);
+  if (interaction != null && !firstSegmentLoadMarked) {
+    firstSegmentLoadMarked = true;
+    interaction.marks.push({
+      type: 'first_segment_load',
+      name: 'first_segment_load',
+      labelStack,
+      time
+    });
+  }
+}
 export function addMarkToAll(type, name, labelStack, time = performance.now()) {
   interactions.forEach(interaction => {
     interaction.marks.push({

package/dist/es2019/segment/segment.js

@@ -7,11 +7,12 @@ import { getConfig, getDoNotAbortActivePressInteraction, getInteractionRate, get
 import { getActiveTrace, setInteractionActiveTrace } from '../experience-trace-id-context';
 import UFOInteractionContext from '../interaction-context';
 import UFOInteractionIDContext from '../interaction-id-context';
-import { abortByNewInteraction, addApdex, addCustomData, addCustomTiming, addHold, addHoldByID, addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, getActiveInteraction, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
+import { abortByNewInteraction, addApdex, addCustomData, addCustomTiming, addHold, addHoldByID, addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, getActiveInteraction, markFirstSegmentLoad, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
 import generateId from '../short-id';
 import scheduleOnPaint from './schedule-on-paint';
 let tryCompleteHandle;
+let hasMarkedFirstSegmentLoad = false;
 
 /** A portion of the page we apply measurement to */
 export default function UFOSegment({
@@ -53,6 +54,10 @@ export default function UFOSegment({
     } : {})
   }], [parentContext, segmentName, segmentId, type]);
   const interactionId = useContext(UFOInteractionIDContext);
+  if (interactionId.current != null && !hasMarkedFirstSegmentLoad) {
+    markFirstSegmentLoad(interactionId.current, labelStack, performance.now());
+    hasMarkedFirstSegmentLoad = true;
+  }
   const interactionContext = useMemo(() => {
     let lastCompleteEndTime = 0;
     function complete(endTime = performance.now()) {

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

@@ -33,6 +33,7 @@ var interactionQueue = [];
 var segmentCache = new Map();
 export var segmentUnmountCache = new Map(); // Temporarily store segment unmount counts
 
+var firstSegmentLoadMarked = false;
 var segmentObservers = [];
 export function getActiveInteraction() {
   var interactionId = getInteractionId();
@@ -229,6 +230,22 @@ export function addMark(interactionId, type, name, labelStack) {
     });
   }
 }
+export function markFirstSegmentLoad(interactionId, labelStack) {
+  var time = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : performance.now();
+  if (!fg('platform_mark_ufo_segment_first_load')) {
+    return;
+  }
+  var interaction = interactions.get(interactionId);
+  if (interaction != null && !firstSegmentLoadMarked) {
+    firstSegmentLoadMarked = true;
+    interaction.marks.push({
+      type: 'first_segment_load',
+      name: 'first_segment_load',
+      labelStack: labelStack,
+      time: time
+    });
+  }
+}
 export function addMarkToAll(type, name, labelStack) {
   var time = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : performance.now();
   interactions.forEach(function (interaction) {

package/dist/esm/segment/segment.js

@@ -11,11 +11,12 @@ import { getConfig, getDoNotAbortActivePressInteraction, getInteractionRate, get
 import { getActiveTrace, setInteractionActiveTrace } from '../experience-trace-id-context';
 import UFOInteractionContext from '../interaction-context';
 import UFOInteractionIDContext from '../interaction-id-context';
-import { abortByNewInteraction, addApdex as _addApdex, addCustomData as _addCustomData, addCustomTiming, addHold, addHoldByID, addMark as _addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, getActiveInteraction, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
+import { abortByNewInteraction, addApdex as _addApdex, addCustomData as _addCustomData, addCustomTiming, addHold, addHoldByID, addMark as _addMark, addNewInteraction, addProfilerTimings, addRequestInfo, addSegment, addSpan, getActiveInteraction, markFirstSegmentLoad, removeHoldByID, removeSegment, tryComplete } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
 import generateId from '../short-id';
 import scheduleOnPaint from './schedule-on-paint';
 var tryCompleteHandle;
+var hasMarkedFirstSegmentLoad = false;
 
 /** A portion of the page we apply measurement to */
 export default function UFOSegment(_ref) {
@@ -58,6 +59,10 @@ export default function UFOSegment(_ref) {
     } : {})];
   }, [parentContext, segmentName, segmentId, type]);
   var interactionId = useContext(UFOInteractionIDContext);
+  if (interactionId.current != null && !hasMarkedFirstSegmentLoad) {
+    markFirstSegmentLoad(interactionId.current, labelStack, performance.now());
+    hasMarkedFirstSegmentLoad = true;
+  }
   var interactionContext = useMemo(function () {
     var lastCompleteEndTime = 0;
     function complete() {

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

@@ -4,7 +4,7 @@ import type { LabelStack, UFOInteractionContextType } from '../../interaction-co
 import type { VCObserverInterface } from '../../vc/types';
 import { type VCRawDataType, type VCResult } from '../vc/types';
 export type LifecycleMarkType = 'render' | 'beforePaint' | 'afterPaint' | 'nextTick' | 'mount' | 'commit';
-export type MarkType = ('placeholder' | 'bm3_stop' | 'bundle_preload' | 'custom') | LifecycleMarkType;
+export type MarkType = ('placeholder' | 'bm3_stop' | 'bundle_preload' | 'custom' | 'first_segment_load') | LifecycleMarkType;
 export type SpanType = 'placeholder' | 'relay' | 'hidden_timing' | 'bundle_load' | 'graphql' | 'fetch' | 'reducer' | 'custom';
 export type InteractionType = 'page_load' | 'press' | 'typing' | 'transition' | 'segment';
 export type AbortReasonType = 'new_interaction' | 'unload' | 'transition' | 'timeout' | 'excluded_by_sampling';

package/dist/types/interaction-metrics/index.d.ts

@@ -18,6 +18,7 @@ export declare function addCustomData(interactionId: string, labelStack: LabelSt
 export declare function addCohortingCustomData(interactionId: string, key: string, value: number | boolean | string | null | undefined): void;
 export declare function addCustomTiming(interactionId: string, labelStack: LabelStack, data: CustomTiming): void;
 export declare function addMark(interactionId: string, type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;
+export declare function markFirstSegmentLoad(interactionId: string, labelStack: LabelStack | null, time?: number): void;
 export declare function addMarkToAll(type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;
 export declare function addSpan(interactionId: string, type: SpanType, name: string, labelStack: LabelStack | null, start: number, end?: number, size?: number): void;
 export declare function addSpanToAll(type: SpanType, name: string, labelStack: LabelStack | null, start: number, end?: number, size?: number): void;

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

@@ -4,7 +4,7 @@ import type { LabelStack, UFOInteractionContextType } from '../../interaction-co
 import type { VCObserverInterface } from '../../vc/types';
 import { type VCRawDataType, type VCResult } from '../vc/types';
 export type LifecycleMarkType = 'render' | 'beforePaint' | 'afterPaint' | 'nextTick' | 'mount' | 'commit';
-export type MarkType = ('placeholder' | 'bm3_stop' | 'bundle_preload' | 'custom') | LifecycleMarkType;
+export type MarkType = ('placeholder' | 'bm3_stop' | 'bundle_preload' | 'custom' | 'first_segment_load') | LifecycleMarkType;
 export type SpanType = 'placeholder' | 'relay' | 'hidden_timing' | 'bundle_load' | 'graphql' | 'fetch' | 'reducer' | 'custom';
 export type InteractionType = 'page_load' | 'press' | 'typing' | 'transition' | 'segment';
 export type AbortReasonType = 'new_interaction' | 'unload' | 'transition' | 'timeout' | 'excluded_by_sampling';

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

@@ -18,6 +18,7 @@ export declare function addCustomData(interactionId: string, labelStack: LabelSt
 export declare function addCohortingCustomData(interactionId: string, key: string, value: number | boolean | string | null | undefined): void;
 export declare function addCustomTiming(interactionId: string, labelStack: LabelStack, data: CustomTiming): void;
 export declare function addMark(interactionId: string, type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;
+export declare function markFirstSegmentLoad(interactionId: string, labelStack: LabelStack | null, time?: number): void;
 export declare function addMarkToAll(type: MarkType, name: string, labelStack: LabelStack | null, time?: number): void;
 export declare function addSpan(interactionId: string, type: SpanType, name: string, labelStack: LabelStack | null, start: number, end?: number, size?: number): void;
 export declare function addSpanToAll(type: SpanType, name: string, labelStack: LabelStack | null, start: number, end?: number, size?: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.14.4",
+	"version": "4.14.5",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -172,6 +172,9 @@
 		},
 		"platform_ufo_enable_vc_raw_data": {
 			"type": "boolean"
+		},
+		"platform_mark_ufo_segment_first_load": {
+			"type": "boolean"
 		}
 	}
 }