@atlaskit/react-ufo 4.1.11 → 4.1.12

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.1.12
+
+### Patch Changes
+
+- [#195371](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/195371)
+  [`928a3cc316c8f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/928a3cc316c8f) -
+  Fix post interaction log naming issue
+
 ## 4.1.11
 
 ### Patch Changes

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

@@ -54,6 +54,7 @@ var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _coinflip = _interopRequireDefault(require("../coinflip"));
 var _config = require("../config");
 var _createExperimentalInteractionMetricsPayload = require("../create-experimental-interaction-metrics-payload");
+var _utils = require("../create-payload/common/utils");
 var _experienceTraceIdContext = require("../experience-trace-id-context");
 var _featureFlagsAccessed = require("../feature-flags-accessed");
 var _interactionIdContext = require("../interaction-id-context");
@@ -653,6 +654,18 @@ function finishInteraction(id, data) {
       data.vc = observer.getVCRawData();
     }
   }
+
+  // By this time, stop the post interaction log observer if coinflip rate is 0
+  if ((0, _platformFeatureFlags.fg)('platform_ufo_post_interaction_check_name')) {
+    var sanitisedUfoName = (0, _utils.sanitizeUfoName)(data.ufoName);
+    if (!(0, _coinflip.default)((0, _config.getPostInteractionRate)(sanitisedUfoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  } else {
+    if (!(0, _coinflip.default)((0, _config.getPostInteractionRate)(data.routeName || data.ufoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  }
   if (!((_getConfig5 = (0, _config.getConfig)()) !== null && _getConfig5 !== void 0 && (_getConfig5 = _getConfig5.experimentalInteractionMetrics) !== null && _getConfig5 !== void 0 && _getConfig5.enabled)) {
     remove(id);
   }
@@ -875,8 +888,12 @@ function addOnCancelCallback(id, cancelCallback) {
 }
 function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelStack, routeName) {
   var trace = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : null;
-  if ((0, _coinflip.default)((0, _config.getPostInteractionRate)(routeName || ufoName, type))) {
+  if ((0, _platformFeatureFlags.fg)('platform_ufo_post_interaction_check_name')) {
     postInteractionLog.reset();
+  } else {
+    if ((0, _coinflip.default)((0, _config.getPostInteractionRate)(routeName || ufoName, type))) {
+      postInteractionLog.reset();
+    }
   }
   var vcObserver;
   var previousTime = startTime;
@@ -995,10 +1012,21 @@ function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelS
         experienceKey: ufoName
       });
     }
-    if ((0, _coinflip.default)((0, _config.getPostInteractionRate)(routeName || ufoName, type))) {
-      postInteractionLog.startVCObserver({
-        startTime: startTime
-      });
+    if ((0, _platformFeatureFlags.fg)('platform_ufo_post_interaction_check_name')) {
+      var _getConfig0;
+      // Start post interaction observer for all if config is enabled
+      // in case ufoName is updated at later time
+      if ((_getConfig0 = (0, _config.getConfig)()) !== null && _getConfig0 !== void 0 && (_getConfig0 = _getConfig0.postInteractionLog) !== null && _getConfig0 !== void 0 && _getConfig0.enabled) {
+        postInteractionLog.startVCObserver({
+          startTime: startTime
+        });
+      }
+    } else {
+      if ((0, _coinflip.default)((0, _config.getPostInteractionRate)(routeName || ufoName, type))) {
+        postInteractionLog.startVCObserver({
+          startTime: startTime
+        });
+      }
     }
     if ((0, _coinflip.default)((0, _config.getExperimentalInteractionRate)(ufoName, type))) {
       _createExperimentalInteractionMetricsPayload.experimentalVC.start({

package/dist/cjs/interaction-metrics/post-interaction-log.js

@@ -120,8 +120,8 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
     key: "sendPostInteractionLog",
     value: (function () {
       var _sendPostInteractionLog = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-        var _this$vcObserver4, _this$vcObserver5;
-        var _this$vcObserver3, postInteractionFinishVCResult;
+        var _this$vcObserver4, _config$vc, _config$vc2, _this$vcObserver5;
+        var _this$vcObserver3, config, postInteractionFinishVCResult;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -133,18 +133,21 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
               (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 || _this$vcObserver3.stop();
               return _context.abrupt("return");
             case 4:
-              _context.next = 6;
-              return (_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 ? void 0 : _this$vcObserver4.getVCResult(_objectSpread(_objectSpread({
+              config = (0, _config.getConfig)();
+              _context.next = 7;
+              return (_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 ? void 0 : _this$vcObserver4.getVCResult(_objectSpread({
                 start: this.lastInteractionFinish.start,
                 stop: performance.now(),
                 tti: -1,
                 // no need for TTI value here
                 isEventAborted: !!this.lastInteractionFinish.abortReason,
-                prefix: 'ufo'
-              }, this.vcObserverSSRConfig), {}, {
-                experienceKey: this.lastInteractionFinish.ufoName
-              }));
-            case 6:
+                prefix: 'ufo',
+                experienceKey: this.lastInteractionFinish.ufoName,
+                interactionId: this.lastInteractionFinish.id,
+                includeSSRInV3: config === null || config === void 0 || (_config$vc = config.vc) === null || _config$vc === void 0 ? void 0 : _config$vc.includeSSRInV3,
+                includeSSRRatio: config === null || config === void 0 || (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio
+              }, this.vcObserverSSRConfig));
+            case 7:
               postInteractionFinishVCResult = _context.sent;
               (_this$vcObserver5 = this.vcObserver) === null || _this$vcObserver5 === void 0 || _this$vcObserver5.stop();
               this.sinkHandlerFn({
@@ -154,7 +157,7 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
                 lastInteractionFinishVCResult: this.lastInteractionFinishVCResult
               });
               this.reset();
-            case 10:
+            case 11:
             case "end":
               return _context.stop();
           }

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

@@ -3,6 +3,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig, getExperimentalInteractionRate, getInteractionTimeout, getPostInteractionRate } from '../config';
 import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
+import { sanitizeUfoName } from '../create-payload/common/utils';
 import { clearActiveTrace } from '../experience-trace-id-context';
 import { allFeatureFlagsAccessed, currentFeatureFlagsAccessed } from '../feature-flags-accessed';
 import { getInteractionId } from '../interaction-id-context';
@@ -571,6 +572,18 @@ function finishInteraction(id, data, endTime = performance.now()) {
       data.vc = observer.getVCRawData();
     }
   }
+
+  // By this time, stop the post interaction log observer if coinflip rate is 0
+  if (fg('platform_ufo_post_interaction_check_name')) {
+    const sanitisedUfoName = sanitizeUfoName(data.ufoName);
+    if (!coinflip(getPostInteractionRate(sanitisedUfoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  } else {
+    if (!coinflip(getPostInteractionRate(data.routeName || data.ufoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  }
   if (!((_getConfig5 = getConfig()) !== null && _getConfig5 !== void 0 && (_getConfig5$experimen = _getConfig5.experimentalInteractionMetrics) !== null && _getConfig5$experimen !== void 0 && _getConfig5$experimen.enabled)) {
     remove(id);
   }
@@ -750,8 +763,12 @@ export function addOnCancelCallback(id, cancelCallback) {
   interaction === null || interaction === void 0 ? void 0 : interaction.cancelCallbacks.push(cancelCallback);
 }
 export function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelStack, routeName, trace = null) {
-  if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+  if (fg('platform_ufo_post_interaction_check_name')) {
     postInteractionLog.reset();
+  } else {
+    if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+      postInteractionLog.reset();
+    }
   }
   let vcObserver;
   let previousTime = startTime;
@@ -870,10 +887,21 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
         experienceKey: ufoName
       });
     }
-    if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
-      postInteractionLog.startVCObserver({
-        startTime
-      });
+    if (fg('platform_ufo_post_interaction_check_name')) {
+      var _getConfig0, _getConfig0$postInter;
+      // Start post interaction observer for all if config is enabled
+      // in case ufoName is updated at later time
+      if ((_getConfig0 = getConfig()) !== null && _getConfig0 !== void 0 && (_getConfig0$postInter = _getConfig0.postInteractionLog) !== null && _getConfig0$postInter !== void 0 && _getConfig0$postInter.enabled) {
+        postInteractionLog.startVCObserver({
+          startTime
+        });
+      }
+    } else {
+      if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+        postInteractionLog.startVCObserver({
+          startTime
+        });
+      }
     }
     if (coinflip(getExperimentalInteractionRate(ufoName, type))) {
       experimentalVC.start({

package/dist/es2019/interaction-metrics/post-interaction-log.js

@@ -88,13 +88,14 @@ export default class PostInteractionLog {
    * Send the log if there is data
    */
   async sendPostInteractionLog() {
-    var _this$vcObserver4, _this$vcObserver5;
+    var _this$vcObserver4, _config$vc, _config$vc2, _this$vcObserver5;
     if (!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn) {
       var _this$vcObserver3;
       this.reset();
       (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 ? void 0 : _this$vcObserver3.stop();
       return;
     }
+    const config = getConfig();
     const postInteractionFinishVCResult = await ((_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 ? void 0 : _this$vcObserver4.getVCResult({
       start: this.lastInteractionFinish.start,
       stop: performance.now(),
@@ -102,8 +103,11 @@ export default class PostInteractionLog {
       // no need for TTI value here
       isEventAborted: !!this.lastInteractionFinish.abortReason,
       prefix: 'ufo',
-      ...this.vcObserverSSRConfig,
-      experienceKey: this.lastInteractionFinish.ufoName
+      experienceKey: this.lastInteractionFinish.ufoName,
+      interactionId: this.lastInteractionFinish.id,
+      includeSSRInV3: config === null || config === void 0 ? void 0 : (_config$vc = config.vc) === null || _config$vc === void 0 ? void 0 : _config$vc.includeSSRInV3,
+      includeSSRRatio: config === null || config === void 0 ? void 0 : (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio,
+      ...this.vcObserverSSRConfig
     }));
     (_this$vcObserver5 = this.vcObserver) === null || _this$vcObserver5 === void 0 ? void 0 : _this$vcObserver5.stop();
     this.sinkHandlerFn({

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

@@ -13,6 +13,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import coinflip from '../coinflip';
 import { getAwaitBM3TTIList, getCapabilityRate, getConfig, getExperimentalInteractionRate, getInteractionTimeout, getPostInteractionRate } from '../config';
 import { experimentalVC, getExperimentalVCMetrics, onExperimentalInteractionComplete } from '../create-experimental-interaction-metrics-payload';
+import { sanitizeUfoName } from '../create-payload/common/utils';
 import { clearActiveTrace } from '../experience-trace-id-context';
 import { allFeatureFlagsAccessed, currentFeatureFlagsAccessed } from '../feature-flags-accessed';
 import { getInteractionId } from '../interaction-id-context';
@@ -607,6 +608,18 @@ function finishInteraction(id, data) {
       data.vc = observer.getVCRawData();
     }
   }
+
+  // By this time, stop the post interaction log observer if coinflip rate is 0
+  if (fg('platform_ufo_post_interaction_check_name')) {
+    var sanitisedUfoName = sanitizeUfoName(data.ufoName);
+    if (!coinflip(getPostInteractionRate(sanitisedUfoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  } else {
+    if (!coinflip(getPostInteractionRate(data.routeName || data.ufoName, data.type))) {
+      postInteractionLog.stopVCObserver();
+    }
+  }
   if (!((_getConfig5 = getConfig()) !== null && _getConfig5 !== void 0 && (_getConfig5 = _getConfig5.experimentalInteractionMetrics) !== null && _getConfig5 !== void 0 && _getConfig5.enabled)) {
     remove(id);
   }
@@ -829,8 +842,12 @@ export function addOnCancelCallback(id, cancelCallback) {
 }
 export function addNewInteraction(interactionId, ufoName, type, startTime, rate, labelStack, routeName) {
   var trace = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : null;
-  if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+  if (fg('platform_ufo_post_interaction_check_name')) {
     postInteractionLog.reset();
+  } else {
+    if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+      postInteractionLog.reset();
+    }
   }
   var vcObserver;
   var previousTime = startTime;
@@ -949,10 +966,21 @@ export function addNewInteraction(interactionId, ufoName, type, startTime, rate,
         experienceKey: ufoName
       });
     }
-    if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
-      postInteractionLog.startVCObserver({
-        startTime: startTime
-      });
+    if (fg('platform_ufo_post_interaction_check_name')) {
+      var _getConfig0;
+      // Start post interaction observer for all if config is enabled
+      // in case ufoName is updated at later time
+      if ((_getConfig0 = getConfig()) !== null && _getConfig0 !== void 0 && (_getConfig0 = _getConfig0.postInteractionLog) !== null && _getConfig0 !== void 0 && _getConfig0.enabled) {
+        postInteractionLog.startVCObserver({
+          startTime: startTime
+        });
+      }
+    } else {
+      if (coinflip(getPostInteractionRate(routeName || ufoName, type))) {
+        postInteractionLog.startVCObserver({
+          startTime: startTime
+        });
+      }
     }
     if (coinflip(getExperimentalInteractionRate(ufoName, type))) {
       experimentalVC.start({

package/dist/esm/interaction-metrics/post-interaction-log.js

@@ -113,8 +113,8 @@ var PostInteractionLog = /*#__PURE__*/function () {
     key: "sendPostInteractionLog",
     value: (function () {
       var _sendPostInteractionLog = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-        var _this$vcObserver4, _this$vcObserver5;
-        var _this$vcObserver3, postInteractionFinishVCResult;
+        var _this$vcObserver4, _config$vc, _config$vc2, _this$vcObserver5;
+        var _this$vcObserver3, config, postInteractionFinishVCResult;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -126,18 +126,21 @@ var PostInteractionLog = /*#__PURE__*/function () {
               (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 || _this$vcObserver3.stop();
               return _context.abrupt("return");
             case 4:
-              _context.next = 6;
-              return (_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 ? void 0 : _this$vcObserver4.getVCResult(_objectSpread(_objectSpread({
+              config = getConfig();
+              _context.next = 7;
+              return (_this$vcObserver4 = this.vcObserver) === null || _this$vcObserver4 === void 0 ? void 0 : _this$vcObserver4.getVCResult(_objectSpread({
                 start: this.lastInteractionFinish.start,
                 stop: performance.now(),
                 tti: -1,
                 // no need for TTI value here
                 isEventAborted: !!this.lastInteractionFinish.abortReason,
-                prefix: 'ufo'
-              }, this.vcObserverSSRConfig), {}, {
-                experienceKey: this.lastInteractionFinish.ufoName
-              }));
-            case 6:
+                prefix: 'ufo',
+                experienceKey: this.lastInteractionFinish.ufoName,
+                interactionId: this.lastInteractionFinish.id,
+                includeSSRInV3: config === null || config === void 0 || (_config$vc = config.vc) === null || _config$vc === void 0 ? void 0 : _config$vc.includeSSRInV3,
+                includeSSRRatio: config === null || config === void 0 || (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio
+              }, this.vcObserverSSRConfig));
+            case 7:
               postInteractionFinishVCResult = _context.sent;
               (_this$vcObserver5 = this.vcObserver) === null || _this$vcObserver5 === void 0 || _this$vcObserver5.stop();
               this.sinkHandlerFn({
@@ -147,7 +150,7 @@ var PostInteractionLog = /*#__PURE__*/function () {
                 lastInteractionFinishVCResult: this.lastInteractionFinishVCResult
               });
               this.reset();
-            case 10:
+            case 11:
             case "end":
               return _context.stop();
           }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.1.11",
+	"version": "4.1.12",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -194,6 +194,9 @@
 		},
 		"ufo_chrome_devtools_uplift": {
 			"type": "boolean"
+		},
+		"platform_ufo_post_interaction_check_name": {
+			"type": "boolean"
 		}
 	}
 }