@atlaskit/react-ufo 2.7.0 → 2.8.0

package/dist/esm/create-payload/common/utils/index.js

@@ -2,14 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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; }
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
-
 import { REACT_UFO_VERSION } from '../../../common/constants';
-import { getConfig } from '../../../config';
-import { getPageVisibilityState } from '../../../hidden-timing';
-import PostInteractionLog from '../../../interaction-metrics/post-interaction-log';
-import { getSSRDoneTime } from '../../../ssr';
-import { getVCObserver } from '../../../vc';
-export var postInteractionLog = new PostInteractionLog();
 export var sanitizeUfoName = function sanitizeUfoName(name) {
   return name.replace(/_/g, '-');
 };
@@ -66,59 +59,4 @@ export function optimizeLabelStack(labelStack) {
       s: ls.segmentId
     } : {});
   });
-}
-export var getPageVisibilityUpToTTAI = function getPageVisibilityUpToTTAI(interaction) {
-  var start = interaction.start,
-    end = interaction.end;
-  return getPageVisibilityState(start, end);
-};
-export var calculateVCMetrics = function calculateVCMetrics(interaction, prefix, getVCResultFn) {
-  var _interaction$apdex;
-  var result = getVCResultFn({
-    start: interaction.start,
-    stop: interaction.end,
-    tti: (_interaction$apdex = interaction.apdex) === null || _interaction$apdex === void 0 || (_interaction$apdex = _interaction$apdex[0]) === null || _interaction$apdex === void 0 ? void 0 : _interaction$apdex.stopTime,
-    prefix: prefix,
-    vc: interaction.vc
-  });
-  var VC = result === null || result === void 0 ? void 0 : result['metrics:vc'];
-  if (!VC || !(result !== null && result !== void 0 && result["".concat(prefix, ":vc:clean")])) {
-    return result;
-  }
-  var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
-  if (interaction.abortReason || pageVisibilityUpToTTAI !== 'visible') {
-    return result;
-  }
-  return result;
-};
-export function getSSRDoneTimeValue(config) {
-  var _config$ssr, _config$ssr2;
-  return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 || (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : getSSRDoneTime();
-}
-export var getVCMetrics = function getVCMetrics(interaction) {
-  var _config$vc, _config$vc$ssrWhiteli, _result$metricsVc;
-  var config = getConfig();
-  if (!(config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled)) {
-    return {};
-  }
-  if (interaction.type !== 'page_load' && interaction.type !== 'transition') {
-    return {};
-  }
-  var isSSREnabled = (config === null || config === void 0 ? void 0 : config.ssr) || (config === null || config === void 0 || (_config$vc$ssrWhiteli = config.vc.ssrWhitelist) === null || _config$vc$ssrWhiteli === void 0 ? void 0 : _config$vc$ssrWhiteli.includes(interaction.ufoName));
-  var ssr = interaction.type === 'page_load' && isSSREnabled ? {
-    ssr: getSSRDoneTimeValue(config)
-  } : null;
-  postInteractionLog.setVCObserverSSRConfig(ssr);
-  var result = calculateVCMetrics(interaction, 'ufo', getVCObserver().getVCResult);
-  getVCObserver().stop();
-  postInteractionLog.setLastInteractionFinishVCResult(result);
-  return _objectSpread(_objectSpread({}, result), {}, {
-    'metric:vc90': result === null || result === void 0 || (_result$metricsVc = result['metrics:vc']) === null || _result$metricsVc === void 0 ? void 0 : _result$metricsVc['90']
-  });
-};
-export var getTTAI = function getTTAI(interaction) {
-  var start = interaction.start,
-    end = interaction.end;
-  var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
-  return !interaction.abortReason && pageVisibilityUpToTTAI === 'visible' ? Math.round(end - start) : undefined;
-};
+}

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

@@ -12,20 +12,19 @@ import Bowser from 'bowser-ultralight';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { getLighthouseMetrics } from '../additional-payload';
 import * as bundleEvalTiming from '../bundle-eval-timing';
-import coinflip from '../coinflip';
 import { REACT_UFO_VERSION } from '../common/constants';
-import { getConfig, getExperimentalInteractionRate, getUfoNameOverrides } from '../config';
-import { getExperimentalVCMetrics } from '../create-experimental-interaction-metrics-payload';
+import { getConfig, getUfoNameOverrides } from '../config';
 import { getBm3Timings } from '../custom-timings';
 import { getGlobalErrorCount } from '../global-error-handler';
 import { getPageVisibilityState } from '../hidden-timing';
 import * as initialPageLoadExtraTiming from '../initial-page-load-extra-timing';
-import { interactionSpans as atlaskitInteractionSpans } from '../interaction-metrics';
+import { interactionSpans as atlaskitInteractionSpans, postInteractionLog } from '../interaction-metrics';
 import * as resourceTiming from '../resource-timing';
 import { roundEpsilon } from '../round-number';
 import * as ssr from '../ssr';
-import { buildSegmentTree, getPageVisibilityUpToTTAI, getSSRDoneTimeValue, getTTAI, getVCMetrics, labelStackStartWith, optimizeLabelStack, sanitizeUfoName, stringifyLabelStackFully } from './common/utils';
-export function getUfoNameOverride(interaction) {
+import { getVCObserver } from '../vc';
+import { buildSegmentTree, labelStackStartWith, optimizeLabelStack, sanitizeUfoName, stringifyLabelStackFully } from './common/utils';
+function getUfoNameOverride(interaction) {
   var ufoName = interaction.ufoName,
     apdex = interaction.apdex;
   try {
@@ -37,6 +36,7 @@ export function getUfoNameOverride(interaction) {
       }
     }
     return ufoName;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (e) {
     return ufoName;
   }
@@ -71,6 +71,11 @@ var getPageVisibilityUpToTTI = function getPageVisibilityUpToTTI(interaction) {
   var bm3EndTimeOrInteractionEndTime = getBm3EndTimeOrFallbackValue(interaction);
   return getPageVisibilityState(start, bm3EndTimeOrInteractionEndTime);
 };
+var getPageVisibilityUpToTTAI = function getPageVisibilityUpToTTAI(interaction) {
+  var start = interaction.start,
+    end = interaction.end;
+  return getPageVisibilityState(start, end);
+};
 var getVisibilityStateFromPerformance = function getVisibilityStateFromPerformance(stop) {
   try {
     var results = performance.getEntriesByType('visibility-state');
@@ -126,6 +131,15 @@ var getMoreAccuratePageVisibilityUpToTTAI = function getMoreAccuratePageVisibili
   }
   return old;
 };
+var getInteractionStatus = function getInteractionStatus(interaction) {
+  var originalInteractionStatus = interaction.abortReason ? 'ABORTED' : 'SUCCEEDED';
+  var hasBm3TTI = interaction.apdex.length > 0;
+  var overrideStatus = hasBm3TTI ? 'SUCCEEDED' : originalInteractionStatus;
+  return {
+    originalInteractionStatus: originalInteractionStatus,
+    overrideStatus: overrideStatus
+  };
+};
 var getResourceTimings = function getResourceTimings(start, end) {
   var _resourceTiming$getRe;
   return (_resourceTiming$getRe = resourceTiming.getResourceTimings(start, end)) !== null && _resourceTiming$getRe !== void 0 ? _resourceTiming$getRe : undefined;
@@ -154,6 +168,42 @@ var getPaintMetrics = function getPaintMetrics(type) {
   });
   return metrics;
 };
+var getVCMetrics = function getVCMetrics(interaction) {
+  var _config$vc, _interaction$apdex;
+  var config = getConfig();
+  if (!(config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled)) {
+    return {};
+  }
+  if (interaction.type !== 'page_load' && interaction.type !== 'transition') {
+    return {};
+  }
+  var ssr = interaction.type === 'page_load' && config !== null && config !== void 0 && config.ssr ? {
+    ssr: getSSRDoneTimeValue(config)
+  } : null;
+  postInteractionLog.setVCObserverSSRConfig(ssr);
+  var tti = (_interaction$apdex = interaction.apdex) === null || _interaction$apdex === void 0 || (_interaction$apdex = _interaction$apdex[0]) === null || _interaction$apdex === void 0 ? void 0 : _interaction$apdex.stopTime;
+  var prefix = 'ufo';
+  var result = getVCObserver().getVCResult(_objectSpread({
+    start: interaction.start,
+    stop: interaction.end,
+    tti: tti,
+    prefix: prefix,
+    vc: interaction.vc
+  }, ssr));
+  postInteractionLog.setLastInteractionFinishVCResult(result);
+  var VC = result === null || result === void 0 ? void 0 : result['metrics:vc'];
+  if (!VC || !(result !== null && result !== void 0 && result["".concat(prefix, ":vc:clean")])) {
+    return result;
+  }
+  var interactionStatus = getInteractionStatus(interaction);
+  var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
+  if (interactionStatus.originalInteractionStatus !== 'SUCCEEDED' || pageVisibilityUpToTTAI !== 'visible') {
+    return result;
+  }
+  return _objectSpread(_objectSpread({}, result), {}, {
+    'metric:vc90': VC['90']
+  });
+};
 var getNavigationMetrics = function getNavigationMetrics(type) {
   if (type !== 'page_load') {
     return {};
@@ -201,13 +251,14 @@ var getNavigationMetrics = function getNavigationMetrics(type) {
   };
 };
 var getPPSMetrics = function getPPSMetrics(interaction) {
-  var _interaction$apdex;
+  var _interaction$apdex2;
   var start = interaction.start,
     end = interaction.end;
   var config = getConfig();
+  var interactionStatus = getInteractionStatus(interaction);
   var pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
-  var tti = (_interaction$apdex = interaction.apdex) === null || _interaction$apdex === void 0 || (_interaction$apdex = _interaction$apdex[0]) === null || _interaction$apdex === void 0 ? void 0 : _interaction$apdex.stopTime;
-  var ttai = !interaction.abortReason && pageVisibilityUpToTTAI === 'visible' ? Math.round(end - start) : undefined;
+  var tti = (_interaction$apdex2 = interaction.apdex) === null || _interaction$apdex2 === void 0 || (_interaction$apdex2 = _interaction$apdex2[0]) === null || _interaction$apdex2 === void 0 ? void 0 : _interaction$apdex2.stopTime;
+  var ttai = interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible' ? Math.round(end - start) : undefined;
   var PPSMetricsAtTTI = tti !== undefined ? getLighthouseMetrics({
     start: start,
     stop: tti
@@ -297,13 +348,13 @@ function optimizeCustomData(interaction) {
       for (var _i = 0, _Object$entries = Object.entries(currentValue.custom || {}); _i < _Object$entries.length; _i++) {
         var _result$get$data2, _result$get2;
         var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
-          key = _Object$entries$_i[0],
+          _key = _Object$entries$_i[0],
           value = _Object$entries$_i[1];
         var label = stringifyLabelStackFully([]);
         var labelValue = (_result$get$data2 = (_result$get2 = result.get(label)) === null || _result$get2 === void 0 ? void 0 : _result$get2.data) !== null && _result$get$data2 !== void 0 ? _result$get$data2 : {};
         result.set(label, {
           labelStack: optimizeLabelStack([]),
-          data: Object.assign(labelValue, _defineProperty({}, key, value))
+          data: Object.assign(labelValue, _defineProperty({}, _key, value))
         });
       }
       return result;
@@ -541,6 +592,10 @@ function getBm3TrackerTimings(interaction) {
     legacyMetrics: legacyMetrics
   };
 }
+function getSSRDoneTimeValue(config) {
+  var _config$ssr, _config$ssr2;
+  return config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime ? config === null || config === void 0 || (_config$ssr2 = config.ssr) === null || _config$ssr2 === void 0 ? void 0 : _config$ssr2.getSSRDoneTime() : ssr.getSSRDoneTime();
+}
 function getPayloadSize(payload) {
   return Math.round(new TextEncoder().encode(JSON.stringify(payload)).length / 1024);
 }
@@ -583,15 +638,13 @@ function getStylesheetMetrics() {
     return {};
   }
 }
-var regularTTAI;
-var expTTAI;
 function getErrorCounts(interaction) {
   return {
     'ufo:errors:globalCount': getGlobalErrorCount(),
     'ufo:errors:count': interaction.errors.length
   };
 }
-function createInteractionMetricsPayload(interaction, interactionId, experimental) {
+function createInteractionMetricsPayload(interaction, interactionId) {
   var _window$location, _config$additionalPay;
   var interactionPayloadStart = performance.now();
   var config = getConfig();
@@ -626,7 +679,7 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
   } : {};
   // Page Load
   var getPageLoadInteractionMetrics = function getPageLoadInteractionMetrics() {
-    var _config$ssr;
+    var _config$ssr3;
     if (!isPageLoad) {
       return {};
     }
@@ -637,12 +690,12 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
     } : {};
     return _objectSpread(_objectSpread({}, SSRDoneTime), {}, {
       isBM3ConfigSSRDoneAsFmp: interaction.metaData.__legacy__bm3ConfigSSRDoneAsFmp,
-      isUFOConfigSSRDoneAsFmp: interaction.metaData.__legacy__bm3ConfigSSRDoneAsFmp || !!(config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime)
+      isUFOConfigSSRDoneAsFmp: interaction.metaData.__legacy__bm3ConfigSSRDoneAsFmp || !!(config !== null && config !== void 0 && (_config$ssr3 = config.ssr) !== null && _config$ssr3 !== void 0 && _config$ssr3.getSSRDoneTime)
     });
   };
   // Detailed payload. Page visibility = visible
   var getDetailedInteractionMetrics = function getDetailedInteractionMetrics() {
-    if (experimental || window.__UFO_COMPACT_PAYLOAD__ || !isDetailedPayload) {
+    if (window.__UFO_COMPACT_PAYLOAD__ || !isDetailedPayload) {
       return {};
     }
     var spans = [].concat(_toConsumableArray(interaction.spans), _toConsumableArray(atlaskitInteractionSpans));
@@ -657,7 +710,7 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
       }),
       holdActive: _toConsumableArray(interaction.holdActive.values()),
       redirects: optimizeRedirects(interaction.redirects, start),
-      holdInfo: optimizeHoldInfo(experimental ? interaction.holdExpInfo : interaction.holdInfo, start),
+      holdInfo: optimizeHoldInfo(interaction.holdInfo, start),
       spans: optimizeSpans(spans, start),
       requestInfo: optimizeRequestInfo(interaction.requestInfo, start),
       customTimings: optimizeCustomTimings(interaction.customTimings, start),
@@ -667,21 +720,16 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
   };
   // Page load & detailed payload
   var getPageLoadDetailedInteractionMetrics = function getPageLoadDetailedInteractionMetrics() {
-    var _config$ssr2;
+    var _config$ssr4;
     if (!isPageLoad || !isDetailedPayload) {
       return {};
     }
     var config = getConfig();
     return {
       initialPageLoadExtraTimings: objectToArray(initialPageLoadExtraTiming.getTimings()),
-      SSRTimings: config !== null && config !== void 0 && (_config$ssr2 = config.ssr) !== null && _config$ssr2 !== void 0 && _config$ssr2.getSSRTimings ? config.ssr.getSSRTimings() : objectToArray(ssr.getSSRTimings())
+      SSRTimings: config !== null && config !== void 0 && (_config$ssr4 = config.ssr) !== null && _config$ssr4 !== void 0 && _config$ssr4.getSSRTimings ? config.ssr.getSSRTimings() : objectToArray(ssr.getSSRTimings())
     };
   };
-  if (experimental) {
-    expTTAI = getTTAI(interaction);
-  } else {
-    regularTTAI = getTTAI(interaction);
-  }
   var newUFOName = sanitizeUfoName(ufoName);
   var payload = {
     actionSubject: 'experience',
@@ -690,7 +738,7 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
     source: 'measured',
     tags: ['observability'],
     attributes: {
-      properties: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+      properties: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
         // basic
         'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
         'event:product': config.product,
@@ -702,10 +750,10 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
           payloadSource: 'platform'
         },
         'event:region': config.region || 'unknown',
-        'experience:key': experimental ? 'custom.experimental-interaction-metrics' : 'custom.interaction-metrics',
+        'experience:key': 'custom.interaction-metrics',
         'experience:name': newUFOName
-      }, getBrowserMetadata()), getSSRProperties(type)), getPPSMetrics(interaction)), getPaintMetrics(type)), getNavigationMetrics(type)), getVCMetrics(interaction)), experimental ? getExperimentalVCMetrics(interaction) : undefined), (_config$additionalPay = config.additionalPayloadData) === null || _config$additionalPay === void 0 ? void 0 : _config$additionalPay.call(config, interaction)), getTracingContextData(interaction)), getStylesheetMetrics()), getErrorCounts(interaction)), {}, {
-        interactionMetrics: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+      }, getBrowserMetadata()), getSSRProperties(type)), getPPSMetrics(interaction)), getPaintMetrics(type)), getNavigationMetrics(type)), getVCMetrics(interaction)), (_config$additionalPay = config.additionalPayloadData) === null || _config$additionalPay === void 0 ? void 0 : _config$additionalPay.call(config, interaction)), getTracingContextData(interaction)), getStylesheetMetrics()), getErrorCounts(interaction)), {}, {
+        interactionMetrics: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
           namePrefix: config.namePrefix || '',
           segmentPrefix: config.segmentPrefix || '',
           interactionId: interactionId,
@@ -736,18 +784,11 @@ function createInteractionMetricsPayload(interaction, interactionId, experimenta
           marks: optimizeMarks(interaction.marks),
           customData: optimizeCustomData(interaction),
           reactProfilerTimings: optimizeReactProfilerTimings(interaction.reactProfilerTimings, start)
-        }, labelStack), getPageLoadInteractionMetrics()), getDetailedInteractionMetrics()), getPageLoadDetailedInteractionMetrics()), getBm3TrackerTimings(interaction)), {}, {
-          'metric:ttai': experimental ? regularTTAI || expTTAI : undefined,
-          'metric:experimental:ttai': expTTAI
-        }),
+        }, labelStack), getPageLoadInteractionMetrics()), getDetailedInteractionMetrics()), getPageLoadDetailedInteractionMetrics()), getBm3TrackerTimings(interaction)),
         'ufo:payloadTime': roundEpsilon(performance.now() - interactionPayloadStart)
       })
     }
   };
-  if (experimental) {
-    regularTTAI = undefined;
-    expTTAI = undefined;
-  }
   payload.attributes.properties['event:sizeInKb'] = getPayloadSize(payload.attributes.properties);
   return payload;
 }
@@ -758,20 +799,4 @@ export function createPayloads(interactionId, interaction) {
   });
   var interactionMetricsPayload = createInteractionMetricsPayload(modifiedInteraction, interactionId);
   return [interactionMetricsPayload];
-}
-export function createExperimentalMetricsPayload(interactionId, interaction) {
-  var config = getConfig();
-  if (!config) {
-    throw Error('UFO Configuration not provided');
-  }
-  var ufoName = sanitizeUfoName(interaction.ufoName);
-  var rate = getExperimentalInteractionRate(ufoName, interaction.type);
-  if (!coinflip(rate)) {
-    return null;
-  }
-  var pageVisibilityState = getPageVisibilityState(interaction.start, interaction.end);
-  if (pageVisibilityState !== 'visible') {
-    return null;
-  }
-  return createInteractionMetricsPayload(interaction, interactionId, true);
 }

package/dist/esm/interaction-metrics/common/constants.js

@@ -1,7 +1,2 @@
-export var interactions = new Map();
-export var CLEANUP_TIMEOUT = 60 * 1000;
-export var CLEANUP_TIMEOUT_AFTER_APDEX = 15 * 1000;
-export var interactionQueue = [];
-export var segmentCache = new Map();
-export var segmentObservers = [];
-export var moduleLoadingRequests = {};
+var interactions = new Map();
+export default interactions;