@atlaskit/react-ufo 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.0.3
+
+### Patch Changes
+
+- [#186813](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/186813)
+  [`b0dd8177f1f10`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b0dd8177f1f10) -
+  HOT-119287 only produce critical metrics for root and successful interaction
+
 ## 4.0.2
 
 ### Patch Changes

package/dist/cjs/create-payload/critical-metrics-payload/index.js

@@ -9,6 +9,7 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _rootMetrics = require("./root-metrics");
 var _createSegmentMetrics = require("./segment-metrics/create-segment-metrics");
 function createCriticalMetricsPayloads(_x, _x2, _x3) {
@@ -21,13 +22,15 @@ function _createCriticalMetricsPayloads() {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           _context.next = 2;
-          return Promise.all([(0, _rootMetrics.createRootCriticalMetricsPayload)(interactionId, interaction, vcMetrics), (0, _createSegmentMetrics.createSegmentMetricsPayloads)(interactionId, interaction)]);
+          return Promise.all([(0, _rootMetrics.createRootCriticalMetricsPayload)(interactionId, interaction, vcMetrics), (0, _platformFeatureFlags.fg)('platform_ufo_segment_critical_metrics') ? (0, _createSegmentMetrics.createSegmentMetricsPayloads)(interactionId, interaction) : []]);
         case 2:
           _yield$Promise$all = _context.sent;
           _yield$Promise$all2 = (0, _slicedToArray2.default)(_yield$Promise$all, 2);
           rootPayload = _yield$Promise$all2[0];
           segmentPayloads = _yield$Promise$all2[1];
-          return _context.abrupt("return", [rootPayload].concat((0, _toConsumableArray2.default)(segmentPayloads)));
+          return _context.abrupt("return", [rootPayload].concat((0, _toConsumableArray2.default)(segmentPayloads)).filter(function (v) {
+            return v != null;
+          }));
         case 7:
         case "end":
           return _context.stop();

package/dist/cjs/create-payload/critical-metrics-payload/root-metrics.js

@@ -57,11 +57,17 @@ function _createRootCriticalMetricsPayload() {
           pageVisibilityAtTTI = getPageVisibilityUpToTTI(interaction);
           pageVisibilityAtTTAI = (0, _getPageVisibilityUpToTtai.default)(interaction);
           interactionStatus = (0, _getInteractionStatus.default)(interaction);
+          if (!(interactionStatus.originalInteractionStatus !== 'SUCCEEDED')) {
+            _context.next = 9;
+            break;
+          }
+          return _context.abrupt("return", null);
+        case 9:
           newUFOName = (0, _utils.sanitizeUfoName)(ufoName); // Get performance metrics
           ttai = (0, _getTtai.default)(interaction);
-          _context.next = 11;
+          _context.next = 13;
           return (0, _getPaintMetrics.default)(type, end);
-        case 11:
+        case 13:
           paintMetrics = _context.sent;
           navigationMetrics = (0, _getNavigationMetrics.default)(type);
           ssrSuccess = (0, _getSsrSuccess.default)(type); // Calculate BM3 metrics (TTI and FMP) directly
@@ -74,14 +80,14 @@ function _createRootCriticalMetricsPayload() {
           }); // Use provided vcMetrics or calculate if not provided
           _context.t0 = vcMetrics;
           if (_context.t0) {
-            _context.next = 23;
+            _context.next = 25;
             break;
           }
-          _context.next = 22;
+          _context.next = 24;
           return (0, _getVcMetrics.default)(interaction);
-        case 22:
+        case 24:
           _context.t0 = _context.sent;
-        case 23:
+        case 25:
           finalVCMetrics = _context.t0;
           ttvc = (_finalVCMetrics$ufoV = finalVCMetrics['ufo:vc:rev']) === null || _finalVCMetrics$ufoV === void 0 ? void 0 : _finalVCMetrics$ufoV.map(function (revision) {
             if (revision['metric:vc90'] === null || revision.clean !== true) {
@@ -170,7 +176,7 @@ function _createRootCriticalMetricsPayload() {
             }
           };
           return _context.abrupt("return", payload);
-        case 30:
+        case 32:
         case "end":
           return _context.stop();
       }

package/dist/cjs/create-payload/critical-metrics-payload/segment-metrics/create-segment-metrics.js

@@ -26,7 +26,7 @@ function createSegmentMetricsPayloads(_x, _x2) {
 function _createSegmentMetricsPayloads() {
   _createSegmentMetricsPayloads = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(interactionId, interaction) {
     var _interaction$cohortin;
-    var config, browserMetadata, cohortingCustomData, pageVisibilityAtTTAI, knownSegments, reactProfilerTimings, rate, routeName, previousInteractionName, isPreviousInteractionAborted, abortedByInteractionName, segmentsByName, _iterator, _step, _loop, _ret, payloads, _iterator2, _step2, _loop2;
+    var config, browserMetadata, cohortingCustomData, pageVisibilityAtTTAI, knownSegments, reactProfilerTimings, rate, routeName, previousInteractionName, isPreviousInteractionAborted, abortedByInteractionName, segmentsByName, _iterator, _step, _loop, _ret, payloads, _iterator2, _step2, _loop2, _ret2;
     return _regenerator.default.wrap(function _callee$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
@@ -148,13 +148,19 @@ function _createSegmentMetricsPayloads() {
                     _context2.next = 8;
                     break;
                   }
-                  return _context2.abrupt("return", 1);
+                  return _context2.abrupt("return", 0);
                 case 8:
                   lastTiming = segmentProfilerTimings[segmentProfilerTimings.length - 1];
                   startTime = isRootSegment ? interaction.start : firstMountTiming.startTime;
                   endTime = lastTiming.commitTime;
                   ttai = Math.round(endTime - startTime);
                   _getSegmentStatus = (0, _getSegmentStatus2.default)(interaction, segment), status = _getSegmentStatus.status, segmentAbortReason = _getSegmentStatus.abortReason;
+                  if (!(status !== 'SUCCEEDED')) {
+                    _context2.next = 15;
+                    break;
+                  }
+                  return _context2.abrupt("return", 0);
+                case 15:
                   properties = _objectSpread({
                     // Basic metadata
                     'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
@@ -206,7 +212,7 @@ function _createSegmentMetricsPayloads() {
                     }
                   };
                   payloads.push(payload);
-                case 16:
+                case 18:
                 case "end":
                   return _context2.stop();
               }
@@ -215,37 +221,38 @@ function _createSegmentMetricsPayloads() {
           _iterator2.s();
         case 32:
           if ((_step2 = _iterator2.n()).done) {
-            _context3.next = 38;
+            _context3.next = 39;
             break;
           }
           return _context3.delegateYield(_loop2(), "t2", 34);
         case 34:
-          if (!_context3.t2) {
-            _context3.next = 36;
+          _ret2 = _context3.t2;
+          if (!(_ret2 === 0)) {
+            _context3.next = 37;
             break;
           }
-          return _context3.abrupt("continue", 36);
-        case 36:
+          return _context3.abrupt("continue", 37);
+        case 37:
           _context3.next = 32;
           break;
-        case 38:
-          _context3.next = 43;
+        case 39:
+          _context3.next = 44;
           break;
-        case 40:
-          _context3.prev = 40;
+        case 41:
+          _context3.prev = 41;
           _context3.t3 = _context3["catch"](29);
           _iterator2.e(_context3.t3);
-        case 43:
-          _context3.prev = 43;
+        case 44:
+          _context3.prev = 44;
           _iterator2.f();
-          return _context3.finish(43);
-        case 46:
-          return _context3.abrupt("return", payloads);
+          return _context3.finish(44);
         case 47:
+          return _context3.abrupt("return", payloads);
+        case 48:
         case "end":
           return _context3.stop();
       }
-    }, _callee, null, [[9, 21, 24, 27], [29, 40, 43, 46]]);
+    }, _callee, null, [[9, 21, 24, 27], [29, 41, 44, 47]]);
   }));
   return _createSegmentMetricsPayloads.apply(this, arguments);
 }

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

@@ -1,6 +1,7 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { createRootCriticalMetricsPayload } from './root-metrics';
 import { createSegmentMetricsPayloads } from './segment-metrics/create-segment-metrics';
 export async function createCriticalMetricsPayloads(interactionId, interaction, vcMetrics) {
-  const [rootPayload, segmentPayloads] = await Promise.all([createRootCriticalMetricsPayload(interactionId, interaction, vcMetrics), createSegmentMetricsPayloads(interactionId, interaction)]);
-  return [rootPayload, ...segmentPayloads];
+  const [rootPayload, segmentPayloads] = await Promise.all([createRootCriticalMetricsPayload(interactionId, interaction, vcMetrics), fg('platform_ufo_segment_critical_metrics') ? createSegmentMetricsPayloads(interactionId, interaction) : []]);
+  return [rootPayload, ...segmentPayloads].filter(v => v != null);
 }

package/dist/es2019/create-payload/critical-metrics-payload/root-metrics.js

@@ -50,6 +50,10 @@ export async function createRootCriticalMetricsPayload(interactionId, interactio
   const pageVisibilityAtTTI = getPageVisibilityUpToTTI(interaction);
   const pageVisibilityAtTTAI = getPageVisibilityUpToTTAI(interaction);
   const interactionStatus = getInteractionStatus(interaction);
+  if (interactionStatus.originalInteractionStatus !== 'SUCCEEDED') {
+    // To reduce payload sent from the client, we don't send critical perf metrics for non-success interactions
+    return null;
+  }
   const newUFOName = sanitizeUfoName(ufoName);
 
   // Get performance metrics

package/dist/es2019/create-payload/critical-metrics-payload/segment-metrics/create-segment-metrics.js

@@ -97,6 +97,10 @@ export async function createSegmentMetricsPayloads(interactionId, interaction) {
       status,
       abortReason: segmentAbortReason
     } = getSegmentStatus(interaction, segment);
+    if (status !== 'SUCCEEDED') {
+      // To reduce payload sent from the client, we don't send critical perf metrics for non-success interactions
+      continue;
+    }
     const properties = {
       // Basic metadata
       'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',

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

@@ -2,6 +2,7 @@ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { createRootCriticalMetricsPayload } from './root-metrics';
 import { createSegmentMetricsPayloads } from './segment-metrics/create-segment-metrics';
 export function createCriticalMetricsPayloads(_x, _x2, _x3) {
@@ -14,13 +15,15 @@ function _createCriticalMetricsPayloads() {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           _context.next = 2;
-          return Promise.all([createRootCriticalMetricsPayload(interactionId, interaction, vcMetrics), createSegmentMetricsPayloads(interactionId, interaction)]);
+          return Promise.all([createRootCriticalMetricsPayload(interactionId, interaction, vcMetrics), fg('platform_ufo_segment_critical_metrics') ? createSegmentMetricsPayloads(interactionId, interaction) : []]);
         case 2:
           _yield$Promise$all = _context.sent;
           _yield$Promise$all2 = _slicedToArray(_yield$Promise$all, 2);
           rootPayload = _yield$Promise$all2[0];
           segmentPayloads = _yield$Promise$all2[1];
-          return _context.abrupt("return", [rootPayload].concat(_toConsumableArray(segmentPayloads)));
+          return _context.abrupt("return", [rootPayload].concat(_toConsumableArray(segmentPayloads)).filter(function (v) {
+            return v != null;
+          }));
         case 7:
         case "end":
           return _context.stop();

package/dist/esm/create-payload/critical-metrics-payload/root-metrics.js

@@ -51,11 +51,17 @@ function _createRootCriticalMetricsPayload() {
           pageVisibilityAtTTI = getPageVisibilityUpToTTI(interaction);
           pageVisibilityAtTTAI = getPageVisibilityUpToTTAI(interaction);
           interactionStatus = getInteractionStatus(interaction);
+          if (!(interactionStatus.originalInteractionStatus !== 'SUCCEEDED')) {
+            _context.next = 9;
+            break;
+          }
+          return _context.abrupt("return", null);
+        case 9:
           newUFOName = sanitizeUfoName(ufoName); // Get performance metrics
           ttai = getTTAI(interaction);
-          _context.next = 11;
+          _context.next = 13;
           return getPaintMetrics(type, end);
-        case 11:
+        case 13:
           paintMetrics = _context.sent;
           navigationMetrics = getNavigationMetrics(type);
           ssrSuccess = getSSRSuccess(type); // Calculate BM3 metrics (TTI and FMP) directly
@@ -68,14 +74,14 @@ function _createRootCriticalMetricsPayload() {
           }); // Use provided vcMetrics or calculate if not provided
           _context.t0 = vcMetrics;
           if (_context.t0) {
-            _context.next = 23;
+            _context.next = 25;
             break;
           }
-          _context.next = 22;
+          _context.next = 24;
           return getVCMetrics(interaction);
-        case 22:
+        case 24:
           _context.t0 = _context.sent;
-        case 23:
+        case 25:
           finalVCMetrics = _context.t0;
           ttvc = (_finalVCMetrics$ufoV = finalVCMetrics['ufo:vc:rev']) === null || _finalVCMetrics$ufoV === void 0 ? void 0 : _finalVCMetrics$ufoV.map(function (revision) {
             if (revision['metric:vc90'] === null || revision.clean !== true) {
@@ -164,7 +170,7 @@ function _createRootCriticalMetricsPayload() {
             }
           };
           return _context.abrupt("return", payload);
-        case 30:
+        case 32:
         case "end":
           return _context.stop();
       }

package/dist/esm/create-payload/critical-metrics-payload/segment-metrics/create-segment-metrics.js

@@ -19,7 +19,7 @@ export function createSegmentMetricsPayloads(_x, _x2) {
 function _createSegmentMetricsPayloads() {
   _createSegmentMetricsPayloads = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(interactionId, interaction) {
     var _interaction$cohortin;
-    var config, browserMetadata, cohortingCustomData, pageVisibilityAtTTAI, knownSegments, reactProfilerTimings, rate, routeName, previousInteractionName, isPreviousInteractionAborted, abortedByInteractionName, segmentsByName, _iterator, _step, _loop, _ret, payloads, _iterator2, _step2, _loop2;
+    var config, browserMetadata, cohortingCustomData, pageVisibilityAtTTAI, knownSegments, reactProfilerTimings, rate, routeName, previousInteractionName, isPreviousInteractionAborted, abortedByInteractionName, segmentsByName, _iterator, _step, _loop, _ret, payloads, _iterator2, _step2, _loop2, _ret2;
     return _regeneratorRuntime.wrap(function _callee$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
@@ -141,13 +141,19 @@ function _createSegmentMetricsPayloads() {
                     _context2.next = 8;
                     break;
                   }
-                  return _context2.abrupt("return", 1);
+                  return _context2.abrupt("return", 0);
                 case 8:
                   lastTiming = segmentProfilerTimings[segmentProfilerTimings.length - 1];
                   startTime = isRootSegment ? interaction.start : firstMountTiming.startTime;
                   endTime = lastTiming.commitTime;
                   ttai = Math.round(endTime - startTime);
                   _getSegmentStatus = getSegmentStatus(interaction, segment), status = _getSegmentStatus.status, segmentAbortReason = _getSegmentStatus.abortReason;
+                  if (!(status !== 'SUCCEEDED')) {
+                    _context2.next = 15;
+                    break;
+                  }
+                  return _context2.abrupt("return", 0);
+                case 15:
                   properties = _objectSpread({
                     // Basic metadata
                     'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
@@ -199,7 +205,7 @@ function _createSegmentMetricsPayloads() {
                     }
                   };
                   payloads.push(payload);
-                case 16:
+                case 18:
                 case "end":
                   return _context2.stop();
               }
@@ -208,37 +214,38 @@ function _createSegmentMetricsPayloads() {
           _iterator2.s();
         case 32:
           if ((_step2 = _iterator2.n()).done) {
-            _context3.next = 38;
+            _context3.next = 39;
             break;
           }
           return _context3.delegateYield(_loop2(), "t2", 34);
         case 34:
-          if (!_context3.t2) {
-            _context3.next = 36;
+          _ret2 = _context3.t2;
+          if (!(_ret2 === 0)) {
+            _context3.next = 37;
             break;
           }
-          return _context3.abrupt("continue", 36);
-        case 36:
+          return _context3.abrupt("continue", 37);
+        case 37:
           _context3.next = 32;
           break;
-        case 38:
-          _context3.next = 43;
+        case 39:
+          _context3.next = 44;
           break;
-        case 40:
-          _context3.prev = 40;
+        case 41:
+          _context3.prev = 41;
           _context3.t3 = _context3["catch"](29);
           _iterator2.e(_context3.t3);
-        case 43:
-          _context3.prev = 43;
+        case 44:
+          _context3.prev = 44;
           _iterator2.f();
-          return _context3.finish(43);
-        case 46:
-          return _context3.abrupt("return", payloads);
+          return _context3.finish(44);
         case 47:
+          return _context3.abrupt("return", payloads);
+        case 48:
         case "end":
           return _context3.stop();
       }
-    }, _callee, null, [[9, 21, 24, 27], [29, 40, 43, 46]]);
+    }, _callee, null, [[9, 21, 24, 27], [29, 41, 44, 47]]);
   }));
   return _createSegmentMetricsPayloads.apply(this, arguments);
 }

package/dist/types/create-payload/critical-metrics-payload/root-metrics.d.ts

@@ -4,4 +4,4 @@ import type { CriticalMetricsPayload } from './types';
 export type { CriticalMetricsPayload, CriticalMetricsPayloadProperties } from './types';
 export declare function createRootCriticalMetricsPayload(interactionId: string, interaction: InteractionMetrics, vcMetrics?: VCResult & {
     'metric:vc90'?: number | null;
-}): Promise<CriticalMetricsPayload>;
+}): Promise<CriticalMetricsPayload | null>;

package/dist/types-ts4.5/create-payload/critical-metrics-payload/root-metrics.d.ts

@@ -4,4 +4,4 @@ import type { CriticalMetricsPayload } from './types';
 export type { CriticalMetricsPayload, CriticalMetricsPayloadProperties } from './types';
 export declare function createRootCriticalMetricsPayload(interactionId: string, interaction: InteractionMetrics, vcMetrics?: VCResult & {
     'metric:vc90'?: number | null;
-}): Promise<CriticalMetricsPayload>;
+}): Promise<CriticalMetricsPayload | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.0.2",
+	"version": "4.0.3",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -214,6 +214,9 @@
 		},
 		"platform_ufo_handle_non_react_element_for_3p": {
 			"type": "boolean"
+		},
+		"platform_ufo_segment_critical_metrics": {
+			"type": "boolean"
 		}
 	}
 }