@atlaskit/react-ufo 3.13.19 → 3.13.21

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 3.13.21
+
+### Patch Changes
+
+- [#169263](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/169263)
+  [`42bff795e359c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/42bff795e359c) -
+  Add vc to interactions
+
+## 3.13.20
+
+### Patch Changes
+
+- [#169139](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/169139)
+  [`b4d6e4e5e7a39`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b4d6e4e5e7a39) -
+  AFO-4009 simplify UFO timeout to be 60s uniformly (behind fg)
+
 ## 3.13.19
 
 ### Patch Changes

package/dist/cjs/create-payload/utils/get-vc-metrics.js

@@ -34,30 +34,43 @@ function _getVCMetrics() {
           }
           return _context.abrupt("return", {});
         case 3:
+          if (!(0, _platformFeatureFlags.fg)('platform_ufo_enable_interactions_vc')) {
+            _context.next = 8;
+            break;
+          }
+          if (!(interaction.type !== 'page_load' && interaction.type !== 'transition' && interaction.type !== 'press')) {
+            _context.next = 6;
+            break;
+          }
+          return _context.abrupt("return", {});
+        case 6:
+          _context.next = 10;
+          break;
+        case 8:
           if (!(interaction.type !== 'page_load' && interaction.type !== 'transition')) {
-            _context.next = 5;
+            _context.next = 10;
             break;
           }
           return _context.abrupt("return", {});
-        case 5:
+        case 10:
           interactionStatus = (0, _getInteractionStatus.default)(interaction);
           pageVisibilityUpToTTAI = (0, _getPageVisibilityUpToTtai.default)(interaction);
           shouldReportVCMetrics = interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible';
           if (!(!shouldReportVCMetrics && (0, _platformFeatureFlags.fg)('platform_ufo_no_vc_on_aborted'))) {
-            _context.next = 11;
+            _context.next = 16;
             break;
           }
           (0, _vc.getVCObserver)().stop(interaction.ufoName);
           return _context.abrupt("return", {});
-        case 11:
-          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));
+        case 16:
+          isSSREnabled = interaction.type === 'page_load' && ((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)));
           ssr = interaction.type === 'page_load' && isSSREnabled ? {
             ssr: (0, _getSsrDoneTimeValue.default)(config)
           } : null;
           _interactionMetrics.postInteractionLog.setVCObserverSSRConfig(ssr);
           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 = 'ufo';
-          _context.next = 18;
+          _context.next = 23;
           return (0, _vc.getVCObserver)().getVCResult(_objectSpread({
             start: interaction.start,
             stop: interaction.end,
@@ -70,7 +83,7 @@ function _getVCMetrics() {
             interactionId: interaction.id,
             includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
           }, ssr));
-        case 18:
+        case 23:
           result = _context.sent;
           if ((_config$experimentalI = config.experimentalInteractionMetrics) !== null && _config$experimentalI !== void 0 && _config$experimentalI.enabled) {
             (0, _vc.getVCObserver)().stop(interaction.ufoName);
@@ -82,15 +95,15 @@ function _getVCMetrics() {
             return revision === mostRecentVCRevision;
           });
           if (!(!shouldReportVCMetrics || !(mostRecentVCRevisionPayload !== null && mostRecentVCRevisionPayload !== void 0 && mostRecentVCRevisionPayload.clean))) {
-            _context.next = 25;
+            _context.next = 30;
             break;
           }
           return _context.abrupt("return", result);
-        case 25:
+        case 30:
           return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
             'metric:vc90': mostRecentVCRevisionPayload['metric:vc90']
           }));
-        case 26:
+        case 31:
         case "end":
           return _context.stop();
       }

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

@@ -49,6 +49,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _uuid = require("uuid");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _coinflip = _interopRequireDefault(require("../coinflip"));
 var _config = require("../config");
 var _createExperimentalInteractionMetricsPayload = require("../create-experimental-interaction-metrics-payload");
@@ -855,6 +856,21 @@ function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelS
       });
     }
   }
+  if (type === 'press' && (0, _platformFeatureFlags.fg)('platform_ufo_enable_interactions_vc')) {
+    var _getConfig13;
+    (0, _vc.getVCObserver)().start({
+      startTime: startTime,
+      experienceKey: ufoName
+    });
+    postInteractionLog.startVCObserver({
+      startTime: startTime
+    });
+    if ((_getConfig13 = (0, _config.getConfig)()) !== null && _getConfig13 !== void 0 && (_getConfig13 = _getConfig13.experimentalInteractionMetrics) !== null && _getConfig13 !== void 0 && _getConfig13.enabled) {
+      _createExperimentalInteractionMetricsPayload.experimentalVC.start({
+        startTime: startTime
+      });
+    }
+  }
 }
 function addBrowserMetricEvent(event) {
   var interaction = getActiveInteraction();
@@ -863,7 +879,9 @@ function addBrowserMetricEvent(event) {
     interaction.legacyMetrics = interaction.legacyMetrics || [];
     interaction.legacyMetrics.push(event);
     if ((interaction.type === 'page_load' || interaction.type === 'transition') && ((_event$config = event.config) === null || _event$config === void 0 ? void 0 : _event$config.type) === 'PAGE_LOAD') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!(0, _platformFeatureFlags.fg)('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interaction.id, interaction.ufoName);
     }
   }
@@ -882,7 +900,9 @@ function addApdexToAll(apdex) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!(0, _platformFeatureFlags.fg)('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(key, interaction.ufoName);
     }
   });
@@ -902,7 +922,9 @@ function addApdex(interactionId, apdexInfo) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!(0, _platformFeatureFlags.fg)('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interactionId, interaction.ufoName);
     }
   }

package/dist/es2019/create-payload/utils/get-vc-metrics.js

@@ -11,8 +11,14 @@ async function getVCMetrics(interaction) {
   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 {};
+  if (fg('platform_ufo_enable_interactions_vc')) {
+    if (interaction.type !== 'page_load' && interaction.type !== 'transition' && interaction.type !== 'press') {
+      return {};
+    }
+  } else {
+    if (interaction.type !== 'page_load' && interaction.type !== 'transition') {
+      return {};
+    }
   }
   const interactionStatus = getInteractionStatus(interaction);
   const pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
@@ -21,7 +27,7 @@ async function getVCMetrics(interaction) {
     getVCObserver().stop(interaction.ufoName);
     return {};
   }
-  const isSSREnabled = (config === null || config === void 0 ? void 0 : config.ssr) || (config === null || config === void 0 ? void 0 : (_config$vc$ssrWhiteli = config.vc.ssrWhitelist) === null || _config$vc$ssrWhiteli === void 0 ? void 0 : _config$vc$ssrWhiteli.includes(interaction.ufoName));
+  const isSSREnabled = interaction.type === 'page_load' && ((config === null || config === void 0 ? void 0 : config.ssr) || (config === null || config === void 0 ? void 0 : (_config$vc$ssrWhiteli = config.vc.ssrWhitelist) === null || _config$vc$ssrWhiteli === void 0 ? void 0 : _config$vc$ssrWhiteli.includes(interaction.ufoName)));
   const ssr = interaction.type === 'page_load' && isSSREnabled ? {
     ssr: getSSRDoneTimeValue(config)
   } : null;

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

@@ -1,4 +1,5 @@
 import { v4 as createUUID } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig } from '../config';
 import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
@@ -731,6 +732,21 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
       });
     }
   }
+  if (type === 'press' && fg('platform_ufo_enable_interactions_vc')) {
+    var _getConfig13, _getConfig13$experime;
+    getVCObserver().start({
+      startTime,
+      experienceKey: ufoName
+    });
+    postInteractionLog.startVCObserver({
+      startTime
+    });
+    if ((_getConfig13 = getConfig()) !== null && _getConfig13 !== void 0 && (_getConfig13$experime = _getConfig13.experimentalInteractionMetrics) !== null && _getConfig13$experime !== void 0 && _getConfig13$experime.enabled) {
+      experimentalVC.start({
+        startTime
+      });
+    }
+  }
 }
 export function addBrowserMetricEvent(event) {
   const interaction = getActiveInteraction();
@@ -739,7 +755,9 @@ export function addBrowserMetricEvent(event) {
     interaction.legacyMetrics = interaction.legacyMetrics || [];
     interaction.legacyMetrics.push(event);
     if ((interaction.type === 'page_load' || interaction.type === 'transition') && ((_event$config = event.config) === null || _event$config === void 0 ? void 0 : _event$config.type) === 'PAGE_LOAD') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interaction.id, interaction.ufoName);
     }
   }
@@ -758,7 +776,9 @@ export function addApdexToAll(apdex) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(key, interaction.ufoName);
     }
   });
@@ -778,7 +798,9 @@ export function addApdex(interactionId, apdexInfo) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interactionId, interaction.ufoName);
     }
   }

package/dist/esm/create-payload/utils/get-vc-metrics.js

@@ -27,30 +27,43 @@ function _getVCMetrics() {
           }
           return _context.abrupt("return", {});
         case 3:
+          if (!fg('platform_ufo_enable_interactions_vc')) {
+            _context.next = 8;
+            break;
+          }
+          if (!(interaction.type !== 'page_load' && interaction.type !== 'transition' && interaction.type !== 'press')) {
+            _context.next = 6;
+            break;
+          }
+          return _context.abrupt("return", {});
+        case 6:
+          _context.next = 10;
+          break;
+        case 8:
           if (!(interaction.type !== 'page_load' && interaction.type !== 'transition')) {
-            _context.next = 5;
+            _context.next = 10;
             break;
           }
           return _context.abrupt("return", {});
-        case 5:
+        case 10:
           interactionStatus = getInteractionStatus(interaction);
           pageVisibilityUpToTTAI = getPageVisibilityUpToTTAI(interaction);
           shouldReportVCMetrics = interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible';
           if (!(!shouldReportVCMetrics && fg('platform_ufo_no_vc_on_aborted'))) {
-            _context.next = 11;
+            _context.next = 16;
             break;
           }
           getVCObserver().stop(interaction.ufoName);
           return _context.abrupt("return", {});
-        case 11:
-          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));
+        case 16:
+          isSSREnabled = interaction.type === 'page_load' && ((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)));
           ssr = interaction.type === 'page_load' && isSSREnabled ? {
             ssr: getSSRDoneTimeValue(config)
           } : null;
           postInteractionLog.setVCObserverSSRConfig(ssr);
           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 = 'ufo';
-          _context.next = 18;
+          _context.next = 23;
           return getVCObserver().getVCResult(_objectSpread({
             start: interaction.start,
             stop: interaction.end,
@@ -63,7 +76,7 @@ function _getVCMetrics() {
             interactionId: interaction.id,
             includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
           }, ssr));
-        case 18:
+        case 23:
           result = _context.sent;
           if ((_config$experimentalI = config.experimentalInteractionMetrics) !== null && _config$experimentalI !== void 0 && _config$experimentalI.enabled) {
             getVCObserver().stop(interaction.ufoName);
@@ -75,15 +88,15 @@ function _getVCMetrics() {
             return revision === mostRecentVCRevision;
           });
           if (!(!shouldReportVCMetrics || !(mostRecentVCRevisionPayload !== null && mostRecentVCRevisionPayload !== void 0 && mostRecentVCRevisionPayload.clean))) {
-            _context.next = 25;
+            _context.next = 30;
             break;
           }
           return _context.abrupt("return", result);
-        case 25:
+        case 30:
           return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
             'metric:vc90': mostRecentVCRevisionPayload['metric:vc90']
           }));
-        case 26:
+        case 31:
         case "end":
           return _context.stop();
       }

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

@@ -9,6 +9,7 @@ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 import { v4 as createUUID } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig } from '../config';
 import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
@@ -810,6 +811,21 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
       });
     }
   }
+  if (type === 'press' && fg('platform_ufo_enable_interactions_vc')) {
+    var _getConfig13;
+    getVCObserver().start({
+      startTime: startTime,
+      experienceKey: ufoName
+    });
+    postInteractionLog.startVCObserver({
+      startTime: startTime
+    });
+    if ((_getConfig13 = getConfig()) !== null && _getConfig13 !== void 0 && (_getConfig13 = _getConfig13.experimentalInteractionMetrics) !== null && _getConfig13 !== void 0 && _getConfig13.enabled) {
+      experimentalVC.start({
+        startTime: startTime
+      });
+    }
+  }
 }
 export function addBrowserMetricEvent(event) {
   var interaction = getActiveInteraction();
@@ -818,7 +834,9 @@ export function addBrowserMetricEvent(event) {
     interaction.legacyMetrics = interaction.legacyMetrics || [];
     interaction.legacyMetrics.push(event);
     if ((interaction.type === 'page_load' || interaction.type === 'transition') && ((_event$config = event.config) === null || _event$config === void 0 ? void 0 : _event$config.type) === 'PAGE_LOAD') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interaction.id, interaction.ufoName);
     }
   }
@@ -837,7 +855,9 @@ export function addApdexToAll(apdex) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(key, interaction.ufoName);
     }
   });
@@ -857,7 +877,9 @@ export function addApdex(interactionId, apdexInfo) {
       // do nothing
     }
     if (interaction.type === 'page_load' || interaction.type === 'transition') {
-      interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      if (!fg('platform_ufo_timeout_simplification')) {
+        interaction.changeTimeout(CLEANUP_TIMEOUT_AFTER_APDEX);
+      }
       removeHoldByID(interactionId, interaction.ufoName);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.13.19",
+	"version": "3.13.21",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -168,6 +168,12 @@
 		},
 		"platform_ufo_rll_placeholder_ignore": {
 			"type": "boolean"
+		},
+		"platform_ufo_timeout_simplification": {
+			"type": "boolean"
+		},
+		"platform_ufo_enable_interactions_vc": {
+			"type": "boolean"
 		}
 	}
 }