@atlaskit/react-ufo 4.4.3 → 4.4.4

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.4.4
+
+### Patch Changes
+
+- [`bd5fbbc05c329`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bd5fbbc05c329) -
+  Enable TTVC and TTAI for third party segment
+- [`7ed8bff88d7c4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7ed8bff88d7c4) -
+  FG cleanup - ufo_chrome_devtools_uplift
+- [`c86a0e501d31c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c86a0e501d31c) -
+  FG cleanup - platform_ufo_ssr_size_field
+
 ## 4.4.3
 
 ### Patch Changes

package/dist/cjs/create-interaction-extra-metrics-payload/index.js

@@ -0,0 +1,116 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _config = require("../config");
+var _createPayload = require("../create-payload");
+var _utils = require("../create-payload/common/utils");
+var _getPageVisibilityUpToTtai = _interopRequireDefault(require("../create-payload/utils/get-page-visibility-up-to-ttai"));
+var _getPayloadSize = _interopRequireDefault(require("../create-payload/utils/get-payload-size"));
+var _getReactUfoPayloadVersion = require("../create-payload/utils/get-react-ufo-payload-version");
+var _getTtai = _interopRequireDefault(require("../create-payload/utils/get-ttai"));
+var _getVcMetrics = _interopRequireDefault(require("../create-payload/utils/get-vc-metrics"));
+function createInteractionExtraLogPayload(_x, _x2) {
+  return _createInteractionExtraLogPayload.apply(this, arguments);
+}
+function _createInteractionExtraLogPayload() {
+  _createInteractionExtraLogPayload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(interactionId, interaction) {
+    var _getTTAI, _finalVCMetrics$ufoV, _window$location;
+    var config, end, start, ufoName, rate, type, abortReason, routeName, previousInteractionName, isPreviousInteractionAborted, abortedByInteractionName, pageVisibilityAtTTAI, isPageLoad, calculatePageVisibilityFromTheStartOfPageLoad, moreAccuratePageVisibilityAtTTAI, extraTTAI, newUFOName, finalVCMetrics, ttvc, payload;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          config = (0, _config.getConfig)();
+          if (config) {
+            _context.next = 3;
+            break;
+          }
+          throw Error('UFO Configuration not provided');
+        case 3:
+          end = interaction.end, start = interaction.start, ufoName = interaction.ufoName, rate = interaction.rate, type = interaction.type, abortReason = interaction.abortReason, routeName = interaction.routeName, previousInteractionName = interaction.previousInteractionName, isPreviousInteractionAborted = interaction.isPreviousInteractionAborted, abortedByInteractionName = interaction.abortedByInteractionName;
+          pageVisibilityAtTTAI = (0, _getPageVisibilityUpToTtai.default)(interaction);
+          isPageLoad = type === 'page_load' || type === 'transition';
+          if (isPageLoad) {
+            _context.next = 8;
+            break;
+          }
+          return _context.abrupt("return", null);
+        case 8:
+          calculatePageVisibilityFromTheStartOfPageLoad = config.enableBetterPageVisibilityApi && isPageLoad;
+          moreAccuratePageVisibilityAtTTAI = calculatePageVisibilityFromTheStartOfPageLoad ? (0, _createPayload.getMoreAccuratePageVisibilityUpToTTAI)(interaction) : null;
+          extraTTAI = (_getTTAI = (0, _getTtai.default)(interaction)) !== null && _getTTAI !== void 0 ? _getTTAI : undefined;
+          newUFOName = (0, _utils.sanitizeUfoName)(ufoName);
+          _context.next = 14;
+          return (0, _getVcMetrics.default)(interaction, true);
+        case 14:
+          finalVCMetrics = _context.sent;
+          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) {
+              return null;
+            }
+            return {
+              revision: revision.revision,
+              vc90: revision['metric:vc90']
+            };
+          }).filter(function (revision) {
+            return revision != null;
+          });
+          payload = {
+            actionSubject: 'experience',
+            action: 'measured',
+            eventType: 'operational',
+            source: 'measured',
+            tags: ['observability'],
+            attributes: {
+              properties: {
+                // basic
+                'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
+                'event:product': config.product,
+                'event:schema': '1.0.0',
+                'event:sizeInKb': 0,
+                'event:source': {
+                  name: 'react-ufo/web',
+                  version: (0, _getReactUfoPayloadVersion.getReactUFOPayloadVersion)(interaction.type)
+                },
+                'event:region': config.region || 'unknown',
+                'experience:key': 'custom.interaction-extra-metrics',
+                'experience:name': newUFOName,
+                interactionMetrics: {
+                  namePrefix: config.namePrefix || '',
+                  segmentPrefix: config.segmentPrefix || '',
+                  interactionId: interactionId,
+                  pageVisibilityAtTTAI: pageVisibilityAtTTAI,
+                  experimental__pageVisibilityAtTTAI: moreAccuratePageVisibilityAtTTAI,
+                  // raw interaction metrics
+                  rate: rate,
+                  routeName: routeName,
+                  type: type,
+                  abortReason: abortReason,
+                  previousInteractionName: previousInteractionName,
+                  isPreviousInteractionAborted: isPreviousInteractionAborted,
+                  abortedByInteractionName: abortedByInteractionName,
+                  // performance
+                  end: Math.round(end),
+                  start: Math.round(start),
+                  'metric:ttai:3p': extraTTAI,
+                  ttvc: ttvc !== null && ttvc !== void 0 ? ttvc : undefined
+                }
+              }
+            }
+          };
+          payload.attributes.properties['event:sizeInKb'] = (0, _getPayloadSize.default)(payload.attributes.properties);
+          return _context.abrupt("return", payload);
+        case 19:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _createInteractionExtraLogPayload.apply(this, arguments);
+}
+var _default = exports.default = createInteractionExtraLogPayload;

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createExperimentalMetricsPayload = createExperimentalMetricsPayload;
 exports.createPayloads = createPayloads;
+exports.getMoreAccuratePageVisibilityUpToTTAI = getMoreAccuratePageVisibilityUpToTTAI;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
@@ -625,7 +626,7 @@ function _createInteractionMetricsPayload() {
             } : {};
             var isBM3ConfigSSRDoneAsFmp = interaction.metaData.__legacy__bm3ConfigSSRDoneAsFmp;
             var isUFOConfigSSRDoneAsFmp = interaction.metaData.__legacy__bm3ConfigSSRDoneAsFmp || !!(config !== null && config !== void 0 && (_config$ssr = config.ssr) !== null && _config$ssr !== void 0 && _config$ssr.getSSRDoneTime);
-            if (!experimental && (isBM3ConfigSSRDoneAsFmp || isUFOConfigSSRDoneAsFmp) && SSRDoneTimeValue !== undefined && (0, _platformFeatureFlags.fg)('ufo_chrome_devtools_uplift')) {
+            if (!experimental && (isBM3ConfigSSRDoneAsFmp || isUFOConfigSSRDoneAsFmp) && SSRDoneTimeValue !== undefined) {
               try {
                 performance.mark("FMP", {
                   startTime: SSRDoneTimeValue,
@@ -709,7 +710,7 @@ function _createInteractionMetricsPayload() {
           experimentalMetrics = _yield$Promise$all2[1];
           paintMetrics = _yield$Promise$all2[2];
           if (!experimental) {
-            (0, _platformFeatureFlags.fg)('ufo_chrome_devtools_uplift') && (0, _addPerformanceMeasures.addPerformanceMeasures)(interaction.start, (0, _toConsumableArray2.default)((finalVCMetrics === null || finalVCMetrics === void 0 ? void 0 : finalVCMetrics['ufo:vc:rev']) || []));
+            (0, _addPerformanceMeasures.addPerformanceMeasures)(interaction.start, (0, _toConsumableArray2.default)((finalVCMetrics === null || finalVCMetrics === void 0 ? void 0 : finalVCMetrics['ufo:vc:rev']) || []));
           }
           getReactHydrationStats = function getReactHydrationStats() {
             if (!isPageLoad || !hydration) {

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

@@ -22,53 +22,67 @@ function getVCMetrics(_x) {
 function _getVCMetrics() {
   _getVCMetrics = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(interaction) {
     var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$vc3, _result$ufoVcRev;
-    var config, interactionStatus, pageVisibilityUpToTTAI, shouldReportVCMetrics, observer, isSSREnabled, ssr, tti, prefix, result, mostRecentVCRevision, mostRecentVCRevisionPayload;
+    var include3p,
+      config,
+      interactionStatus,
+      pageVisibilityUpToTTAI,
+      shouldReportVCMetrics,
+      observer,
+      isSSREnabled,
+      ssr,
+      tti,
+      prefix,
+      result,
+      mostRecentVCRevision,
+      mostRecentVCRevisionPayload,
+      _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
+          include3p = _args.length > 1 && _args[1] !== undefined ? _args[1] : false;
           config = (0, _config.getConfig)();
           if (config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled) {
-            _context.next = 3;
+            _context.next = 4;
             break;
           }
           return _context.abrupt("return", {});
-        case 3:
+        case 4:
           if (!(0, _platformFeatureFlags.fg)('platform_ufo_enable_vc_press_interactions')) {
-            _context.next = 8;
+            _context.next = 9;
             break;
           }
           if (!(interaction.type !== 'page_load' && interaction.type !== 'transition' && interaction.type !== 'press')) {
-            _context.next = 6;
+            _context.next = 7;
             break;
           }
           return _context.abrupt("return", {});
-        case 6:
-          _context.next = 10;
+        case 7:
+          _context.next = 11;
           break;
-        case 8:
+        case 9:
           if (!(interaction.type !== 'page_load' && interaction.type !== 'transition')) {
-            _context.next = 10;
+            _context.next = 11;
             break;
           }
           return _context.abrupt("return", {});
-        case 10:
+        case 11:
           interactionStatus = (0, _getInteractionStatus.default)(interaction);
           pageVisibilityUpToTTAI = (0, _getPageVisibilityUpToTtai.default)(interaction);
           shouldReportVCMetrics = interactionStatus.originalInteractionStatus === 'SUCCEEDED' && pageVisibilityUpToTTAI === 'visible'; // Use per-interaction VC observer if available, otherwise fall back to global
           observer = interaction.vcObserver;
           if (observer) {
-            _context.next = 16;
+            _context.next = 17;
             break;
           }
           return _context.abrupt("return", {});
-        case 16:
+        case 17:
           if (!(!shouldReportVCMetrics && (0, _platformFeatureFlags.fg)('platform_ufo_no_vc_on_aborted'))) {
-            _context.next = 19;
+            _context.next = 20;
             break;
           }
           observer.stop(interaction.ufoName);
           return _context.abrupt("return", {});
-        case 19:
+        case 20:
           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)
@@ -76,8 +90,8 @@ function _getVCMetrics() {
           _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 = 26;
-          return observer.getVCResult(_objectSpread({
+          _context.next = 27;
+          return observer.getVCResult(_objectSpread(_objectSpread({
             start: interaction.start,
             stop: interaction.end,
             tti: tti,
@@ -88,8 +102,10 @@ function _getVCMetrics() {
             experienceKey: interaction.ufoName,
             interactionId: interaction.id,
             includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
-          }, ssr));
-        case 26:
+          }, ssr), {}, {
+            include3p: include3p
+          }));
+        case 27:
           result = _context.sent;
           observer.stop(interaction.ufoName);
           _interactionMetrics.postInteractionLog.setLastInteractionFinishVCResult(result);
@@ -99,15 +115,15 @@ function _getVCMetrics() {
             return revision === mostRecentVCRevision;
           });
           if (!(!shouldReportVCMetrics || !(mostRecentVCRevisionPayload !== null && mostRecentVCRevisionPayload !== void 0 && mostRecentVCRevisionPayload.clean))) {
-            _context.next = 33;
+            _context.next = 34;
             break;
           }
           return _context.abrupt("return", result);
-        case 33:
+        case 34:
           return _context.abrupt("return", _objectSpread(_objectSpread({}, result), {}, {
             'metric:vc90': mostRecentVCRevisionPayload['metric:vc90']
           }));
-        case 34:
+        case 35:
         case "end":
           return _context.stop();
       }