@atlaskit/react-ufo 3.4.4 → 3.4.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 3.4.5
+
+### Patch Changes
+
+- [#130268](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/130268)
+  [`597d9e0c5582d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/597d9e0c5582d) -
+  use requestIdleCallback for payload creation if its available
+
 ## 3.4.4
 
 ### Patch Changes

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

@@ -7,7 +7,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.init = void 0;
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _scheduler = require("scheduler");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _additionalPayload = require("../additional-payload");
 var _config = require("../config");
@@ -15,12 +14,13 @@ var _createExperimentalInteractionMetricsPayload = require("../create-experiment
 var _hiddenTiming = require("../hidden-timing");
 var _interactionMetrics = require("../interaction-metrics");
 var _vc = require("../vc");
+var _scheduleIdleCallback = _interopRequireDefault(require("./schedule-idle-callback"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != (0, _typeof2.default)(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var initialized = false;
 function sinkInteraction(instance, payloadPackage) {
   (0, _interactionMetrics.sinkInteractionHandler)(function (interactionId, interaction) {
-    (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
+    (0, _scheduleIdleCallback.default)(function () {
       payloadPackage.createPayloads(interactionId, interaction).then(function (payloads) {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
@@ -38,7 +38,7 @@ function sinkInteraction(instance, payloadPackage) {
 }
 function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
   (0, _createExperimentalInteractionMetricsPayload.sinkExperimentalHandler)(function (interactionId, interaction) {
-    (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
+    (0, _scheduleIdleCallback.default)(function () {
       var payloadPromise = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       payloadPromise.then(function (payload) {
         if (payload) {
@@ -57,7 +57,7 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
 }
 function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
   (0, _interactionMetrics.sinkPostInteractionLogHandler)(function (logOutput) {
-    (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, function () {
+    (0, _scheduleIdleCallback.default)(function () {
       var payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion

package/dist/cjs/interaction-metrics-init/schedule-idle-callback.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = scheduleIdleCallback;
+var _scheduler = require("scheduler");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+function scheduleIdleCallback(work) {
+  if (typeof window !== 'undefined' && typeof window.requestIdleCallback === 'function' && (0, _platformFeatureFlags.fg)('ufo_payload_use_idle_callback')) {
+    window.requestIdleCallback(work);
+  } else {
+    (0, _scheduler.unstable_scheduleCallback)(_scheduler.unstable_IdlePriority, work);
+  }
+}

package/dist/cjs/vc/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getVCObserver = void 0;
+exports.isEnvironmentSupported = isEnvironmentSupported;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
@@ -114,12 +115,13 @@ var VCObserverWrapper = /*#__PURE__*/function () {
       (_this$oldVCObserver7 = this.oldVCObserver) === null || _this$oldVCObserver7 === void 0 || _this$oldVCObserver7.setReactRootRenderStop(stopTime || performance.now());
     }
   }]);
-}();
+}(); // Some products set this variable to indicate it is running in SSR
 var isServer = Boolean(globalThis === null || globalThis === void 0 ? void 0 : globalThis.__SERVER__);
-var isReactSSR = isServer && Boolean(((_process = process) === null || _process === void 0 ? void 0 : _process.env.REACT_SSR) || false);
+// 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);
 function isEnvironmentSupported() {
   // SSR environment aren't supported
-  if (isReactSSR) {
+  if (isReactSSR || isServer) {
     return false;
   }
 

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

@@ -1,4 +1,3 @@
-import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
@@ -6,10 +5,11 @@ import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-
 import { setupHiddenTimingCapture } from '../hidden-timing';
 import { postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getVCObserver } from '../vc';
+import scheduleIdleCallback from './schedule-idle-callback';
 let initialized = false;
 function sinkInteraction(instance, payloadPackage) {
   sinkInteractionHandler((interactionId, interaction) => {
-    scheduleCallback(idlePriority, () => {
+    scheduleIdleCallback(() => {
       payloadPackage.createPayloads(interactionId, interaction).then(payloads => {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
@@ -27,7 +27,7 @@ function sinkInteraction(instance, payloadPackage) {
 }
 function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
   sinkExperimentalHandler((interactionId, interaction) => {
-    scheduleCallback(idlePriority, () => {
+    scheduleIdleCallback(() => {
       const payloadPromise = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       payloadPromise.then(payload => {
         if (payload) {
@@ -46,7 +46,7 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
 }
 function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
   sinkPostInteractionLogHandler(logOutput => {
-    scheduleCallback(idlePriority, () => {
+    scheduleIdleCallback(() => {
       const payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion

package/dist/es2019/interaction-metrics-init/schedule-idle-callback.js

@@ -0,0 +1,9 @@
+import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
+import { fg } from '@atlaskit/platform-feature-flags';
+export default function scheduleIdleCallback(work) {
+  if (typeof window !== 'undefined' && typeof window.requestIdleCallback === 'function' && fg('ufo_payload_use_idle_callback')) {
+    window.requestIdleCallback(work);
+  } else {
+    scheduleCallback(idlePriority, work);
+  }
+}

package/dist/es2019/vc/index.js

@@ -1,4 +1,4 @@
-var _process;
+var _process, _process$env;
 import { fg } from '@atlaskit/platform-feature-flags';
 import { getConfig } from '../config';
 import { VCObserverNOOP } from './no-op-vc-observer';
@@ -60,11 +60,14 @@ class VCObserverWrapper {
     (_this$oldVCObserver7 = this.oldVCObserver) === null || _this$oldVCObserver7 === void 0 ? void 0 : _this$oldVCObserver7.setReactRootRenderStop(stopTime || performance.now());
   }
 }
-const isServer = Boolean(globalThis === null || globalThis === void 0 ? void 0 : globalThis.__SERVER__);
-const isReactSSR = isServer && Boolean(((_process = process) === null || _process === void 0 ? void 0 : _process.env.REACT_SSR) || false);
-function isEnvironmentSupported() {
+
+// Some products set this variable to indicate it is running in SSR
+let isServer = Boolean(globalThis === null || globalThis === void 0 ? void 0 : globalThis.__SERVER__);
+// Other products set this other variable to indicate it is running in SSR
+let isReactSSR = typeof process !== 'undefined' && Boolean(((_process = process) === null || _process === void 0 ? void 0 : (_process$env = _process.env) === null || _process$env === void 0 ? void 0 : _process$env.REACT_SSR) || false);
+export function isEnvironmentSupported() {
   // SSR environment aren't supported
-  if (isReactSSR) {
+  if (isReactSSR || isServer) {
     return false;
   }
 

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

@@ -1,5 +1,4 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { startLighthouseObserver } from '../additional-payload';
 import { setUFOConfig } from '../config';
@@ -7,10 +6,11 @@ import { experimentalVC, sinkExperimentalHandler } from '../create-experimental-
 import { setupHiddenTimingCapture } from '../hidden-timing';
 import { postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getVCObserver } from '../vc';
+import scheduleIdleCallback from './schedule-idle-callback';
 var initialized = false;
 function sinkInteraction(instance, payloadPackage) {
   sinkInteractionHandler(function (interactionId, interaction) {
-    scheduleCallback(idlePriority, function () {
+    scheduleIdleCallback(function () {
       payloadPackage.createPayloads(interactionId, interaction).then(function (payloads) {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and Criterion
         var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
@@ -28,7 +28,7 @@ function sinkInteraction(instance, payloadPackage) {
 }
 function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
   sinkExperimentalHandler(function (interactionId, interaction) {
-    scheduleCallback(idlePriority, function () {
+    scheduleIdleCallback(function () {
       var payloadPromise = payloadPackage.createExperimentalMetricsPayload(interactionId, interaction);
       payloadPromise.then(function (payload) {
         if (payload) {
@@ -47,7 +47,7 @@ function sinkExperimentalInteractionMetrics(instance, payloadPackage) {
 }
 function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
   sinkPostInteractionLogHandler(function (logOutput) {
-    scheduleCallback(idlePriority, function () {
+    scheduleIdleCallback(function () {
       var payload = createPostInteractionLogPayload(logOutput);
       if (payload) {
         // NOTE: This API is used by the UFO DevTool Chrome Extension and also by Criterion

package/dist/esm/interaction-metrics-init/schedule-idle-callback.js

@@ -0,0 +1,9 @@
+import { unstable_IdlePriority as idlePriority, unstable_scheduleCallback as scheduleCallback } from 'scheduler';
+import { fg } from '@atlaskit/platform-feature-flags';
+export default function scheduleIdleCallback(work) {
+  if (typeof window !== 'undefined' && typeof window.requestIdleCallback === 'function' && fg('ufo_payload_use_idle_callback')) {
+    window.requestIdleCallback(work);
+  } else {
+    scheduleCallback(idlePriority, work);
+  }
+}

package/dist/esm/vc/index.js

@@ -107,12 +107,13 @@ var VCObserverWrapper = /*#__PURE__*/function () {
       (_this$oldVCObserver7 = this.oldVCObserver) === null || _this$oldVCObserver7 === void 0 || _this$oldVCObserver7.setReactRootRenderStop(stopTime || performance.now());
     }
   }]);
-}();
+}(); // Some products set this variable to indicate it is running in SSR
 var isServer = Boolean(globalThis === null || globalThis === void 0 ? void 0 : globalThis.__SERVER__);
-var isReactSSR = isServer && Boolean(((_process = process) === null || _process === void 0 ? void 0 : _process.env.REACT_SSR) || false);
-function isEnvironmentSupported() {
+// 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);
+export function isEnvironmentSupported() {
   // SSR environment aren't supported
-  if (isReactSSR) {
+  if (isReactSSR || isServer) {
     return false;
   }
 

package/dist/types/interaction-metrics-init/schedule-idle-callback.d.ts

@@ -0,0 +1 @@
+export default function scheduleIdleCallback(work: () => void): void;

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

@@ -2,4 +2,5 @@ import type { VCObserverInterface, VCObserverOptions } from './types';
 declare global {
     var __vcObserver: VCObserverInterface;
 }
+export declare function isEnvironmentSupported(): boolean;
 export declare const getVCObserver: (opts?: VCObserverOptions) => VCObserverInterface;

package/dist/types-ts4.5/interaction-metrics-init/schedule-idle-callback.d.ts

@@ -0,0 +1 @@
+export default function scheduleIdleCallback(work: () => void): void;

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

@@ -2,4 +2,5 @@ import type { VCObserverInterface, VCObserverOptions } from './types';
 declare global {
     var __vcObserver: VCObserverInterface;
 }
+export declare function isEnvironmentSupported(): boolean;
 export declare const getVCObserver: (opts?: VCObserverOptions) => VCObserverInterface;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.4.4",
+	"version": "3.4.5",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -183,6 +183,9 @@
 		},
 		"ufo_lcp": {
 			"type": "boolean"
+		},
+		"ufo_payload_use_idle_callback": {
+			"type": "boolean"
 		}
 	}
 }