@atlaskit/react-ufo 5.0.0 → 5.0.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 5.0.2
+
+### Patch Changes
+
+- [`a394e2061cccd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a394e2061cccd) -
+  classify attribute changes from routing as mutation:attribute:framework-routing in VC observer,
+  and exclude it from TTVC v3 onwards
+
+## 5.0.1
+
+### Patch Changes
+
+- [`60444262e8606`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/60444262e8606) -
+  Deduplicate reported VC offenders in UFO payload
+
 ## 5.0.0
 
 ### Major Changes

package/dist/cjs/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -164,9 +164,18 @@ var AbstractVCCalculatorBase = exports.default = /*#__PURE__*/function () {
             case 19:
               // Check if this entry matches any checkpoint percentiles
               if (viewportPercentage >= percentiles[percentileIndex]) {
-                elementNames = entries.map(function (e) {
-                  return e.elementName;
-                }); // Process all matching percentiles in one go
+                elementNames = [];
+                if ((0, _platformFeatureFlags.fg)('platform_ufo_dedupe_repeated_vc_offenders')) {
+                  elementNames = (0, _toConsumableArray2.default)(new Set(entries.map(function (e) {
+                    return e.elementName;
+                  })));
+                } else {
+                  elementNames = entries.map(function (e) {
+                    return e.elementName;
+                  });
+                }
+
+                // Process all matching percentiles in one go
                 while (percentileIndex < percentiles.length && viewportPercentage >= percentiles[percentileIndex]) {
                   vcDetails["".concat(percentiles[percentileIndex])] = {
                     t: Math.round(time),

package/dist/cjs/vc/vc-observer-new/metric-calculator/fy25_03/index.js

@@ -54,6 +54,9 @@ var VCCalculator_FY25_03 = exports.default = /*#__PURE__*/function (_AbstractVCC
       if (!getConsideredEntryTypes(include3p, excludeSmartAnswersInSearch).includes(entry.data.type)) {
         return false;
       }
+      if (entry.data.type === 'mutation:attribute:framework-routing' && (0, _platformFeatureFlags.fg)('platform_ufo_vc_ignore_display_none_mutations')) {
+        return false;
+      }
       if (excludeSmartAnswersInSearch && (0, _isEntrySmartAnswersInSearch.isEntrySmartAnswersInSearch)(entry) && !(0, _platformFeatureFlags.fg)('rovo_search_page_ttvc_ignoring_smart_answers_fix')) {
         return false;
       }

package/dist/cjs/vc/vc-observer-new/viewport-observer/intersection-observer/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createIntersectionObserver = createIntersectionObserver;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _isZeroDimensionRectangle = require("../utils/is-zero-dimension-rectangle");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 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; } }
@@ -37,10 +38,28 @@ function createIntersectionObserver(_ref) {
 
           // override as display-contents mutation
           if (tagOrCallbackResult && typeof tagOrCallbackResult !== 'string' && tagOrCallbackResult.type === 'mutation:attribute') {
-            return {
-              type: 'mutation:display-contents-children-attribute',
-              mutationData: tagOrCallbackResult.mutationData
-            };
+            if ((0, _platformFeatureFlags.fg)('platform_ufo_vc_ignore_display_none_mutations')) {
+              var _tagOrCallbackResult$ = tagOrCallbackResult.mutationData,
+                attributeName = _tagOrCallbackResult$.attributeName,
+                oldValue = _tagOrCallbackResult$.oldValue,
+                newValue = _tagOrCallbackResult$.newValue;
+              var isRoutingMutation = attributeName === 'style' && (!oldValue && newValue === 'display: none !important;' || oldValue === 'display: none !important;' && !newValue);
+              if (isRoutingMutation) {
+                return {
+                  type: 'mutation:attribute:framework-routing',
+                  mutationData: tagOrCallbackResult.mutationData
+                };
+              }
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            } else {
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            }
           }
           return tagOrCallbackResult;
         };

package/dist/cjs/vc/vc-observer-new/viewport-observer/mutation-observer/index.js

@@ -43,13 +43,13 @@ function createMutationObserver(_ref) {
           if (mut.type === 'attributes') {
             var _mut$oldValue;
             /*
-            			"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
-            			I think it might have been something along the lines that for consistency every setAttribute call should create a record.
-            			Conceptually there is after all a mutation: there is an old value replaced with a new one,
-            			and whether or not they are the same doesn't really matter.
-            			And Custom elements should work the same way as MutationObserver."
-            			https://github.com/whatwg/dom/issues/520#issuecomment-336574796
-            		*/
+            	"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
+            	I think it might have been something along the lines that for consistency every setAttribute call should create a record.
+            	Conceptually there is after all a mutation: there is an old value replaced with a new one,
+            	and whether or not they are the same doesn't really matter.
+            	And Custom elements should work the same way as MutationObserver."
+            	https://github.com/whatwg/dom/issues/520#issuecomment-336574796
+            */
             var oldValue = (_mut$oldValue = mut.oldValue) !== null && _mut$oldValue !== void 0 ? _mut$oldValue : undefined;
             var newValue = mut.attributeName ? mut.target.getAttribute(mut.attributeName) : undefined;
             if (oldValue !== newValue) {

package/dist/es2019/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js

@@ -90,7 +90,12 @@ export default class AbstractVCCalculatorBase {
 
         // Check if this entry matches any checkpoint percentiles
         if (viewportPercentage >= percentiles[percentileIndex]) {
-          const elementNames = entries.map(e => e.elementName);
+          let elementNames = [];
+          if (fg('platform_ufo_dedupe_repeated_vc_offenders')) {
+            elementNames = [...new Set(entries.map(e => e.elementName))];
+          } else {
+            elementNames = entries.map(e => e.elementName);
+          }
 
           // Process all matching percentiles in one go
           while (percentileIndex < percentiles.length && viewportPercentage >= percentiles[percentileIndex]) {

package/dist/es2019/vc/vc-observer-new/metric-calculator/fy25_03/index.js

@@ -36,6 +36,9 @@ export default class VCCalculator_FY25_03 extends AbstractVCCalculatorBase {
     if (!getConsideredEntryTypes(include3p, excludeSmartAnswersInSearch).includes(entry.data.type)) {
       return false;
     }
+    if (entry.data.type === 'mutation:attribute:framework-routing' && fg('platform_ufo_vc_ignore_display_none_mutations')) {
+      return false;
+    }
     if (excludeSmartAnswersInSearch && isEntrySmartAnswersInSearch(entry) && !fg('rovo_search_page_ttvc_ignoring_smart_answers_fix')) {
       return false;
     }

package/dist/es2019/vc/vc-observer-new/viewport-observer/intersection-observer/index.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { isZeroDimensionRectangle } from '../utils/is-zero-dimension-rectangle';
 function isValidEntry(entry) {
   return entry.isIntersecting && entry.intersectionRect.width > 0 && entry.intersectionRect.height > 0;
@@ -30,10 +31,29 @@ export function createIntersectionObserver({
 
           // override as display-contents mutation
           if (tagOrCallbackResult && typeof tagOrCallbackResult !== 'string' && tagOrCallbackResult.type === 'mutation:attribute') {
-            return {
-              type: 'mutation:display-contents-children-attribute',
-              mutationData: tagOrCallbackResult.mutationData
-            };
+            if (fg('platform_ufo_vc_ignore_display_none_mutations')) {
+              const {
+                attributeName,
+                oldValue,
+                newValue
+              } = tagOrCallbackResult.mutationData;
+              const isRoutingMutation = attributeName === 'style' && (!oldValue && newValue === 'display: none !important;' || oldValue === 'display: none !important;' && !newValue);
+              if (isRoutingMutation) {
+                return {
+                  type: 'mutation:attribute:framework-routing',
+                  mutationData: tagOrCallbackResult.mutationData
+                };
+              }
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            } else {
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            }
           }
           return tagOrCallbackResult;
         };

package/dist/es2019/vc/vc-observer-new/viewport-observer/mutation-observer/index.js

@@ -30,13 +30,13 @@ function createMutationObserver({
       if (mut.type === 'attributes') {
         var _mut$oldValue;
         /*
-        			"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
-        			I think it might have been something along the lines that for consistency every setAttribute call should create a record.
-        			Conceptually there is after all a mutation: there is an old value replaced with a new one,
-        			and whether or not they are the same doesn't really matter.
-        			And Custom elements should work the same way as MutationObserver."
-        			https://github.com/whatwg/dom/issues/520#issuecomment-336574796
-        		*/
+        	"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
+        	I think it might have been something along the lines that for consistency every setAttribute call should create a record.
+        	Conceptually there is after all a mutation: there is an old value replaced with a new one,
+        	and whether or not they are the same doesn't really matter.
+        	And Custom elements should work the same way as MutationObserver."
+        	https://github.com/whatwg/dom/issues/520#issuecomment-336574796
+        */
         const oldValue = (_mut$oldValue = mut.oldValue) !== null && _mut$oldValue !== void 0 ? _mut$oldValue : undefined;
         const newValue = mut.attributeName ? mut.target.getAttribute(mut.attributeName) : undefined;
         if (oldValue !== newValue) {

package/dist/esm/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js

@@ -1,5 +1,5 @@
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
@@ -158,9 +158,18 @@ var AbstractVCCalculatorBase = /*#__PURE__*/function () {
             case 19:
               // Check if this entry matches any checkpoint percentiles
               if (viewportPercentage >= percentiles[percentileIndex]) {
-                elementNames = entries.map(function (e) {
-                  return e.elementName;
-                }); // Process all matching percentiles in one go
+                elementNames = [];
+                if (fg('platform_ufo_dedupe_repeated_vc_offenders')) {
+                  elementNames = _toConsumableArray(new Set(entries.map(function (e) {
+                    return e.elementName;
+                  })));
+                } else {
+                  elementNames = entries.map(function (e) {
+                    return e.elementName;
+                  });
+                }
+
+                // Process all matching percentiles in one go
                 while (percentileIndex < percentiles.length && viewportPercentage >= percentiles[percentileIndex]) {
                   vcDetails["".concat(percentiles[percentileIndex])] = {
                     t: Math.round(time),

package/dist/esm/vc/vc-observer-new/metric-calculator/fy25_03/index.js

@@ -47,6 +47,9 @@ var VCCalculator_FY25_03 = /*#__PURE__*/function (_AbstractVCCalculator) {
       if (!getConsideredEntryTypes(include3p, excludeSmartAnswersInSearch).includes(entry.data.type)) {
         return false;
       }
+      if (entry.data.type === 'mutation:attribute:framework-routing' && fg('platform_ufo_vc_ignore_display_none_mutations')) {
+        return false;
+      }
       if (excludeSmartAnswersInSearch && isEntrySmartAnswersInSearch(entry) && !fg('rovo_search_page_ttvc_ignoring_smart_answers_fix')) {
         return false;
       }

package/dist/esm/vc/vc-observer-new/viewport-observer/intersection-observer/index.js

@@ -1,6 +1,7 @@
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 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 { fg } from '@atlaskit/platform-feature-flags';
 import { isZeroDimensionRectangle } from '../utils/is-zero-dimension-rectangle';
 function isValidEntry(entry) {
   return entry.isIntersecting && entry.intersectionRect.width > 0 && entry.intersectionRect.height > 0;
@@ -31,10 +32,28 @@ export function createIntersectionObserver(_ref) {
 
           // override as display-contents mutation
           if (tagOrCallbackResult && typeof tagOrCallbackResult !== 'string' && tagOrCallbackResult.type === 'mutation:attribute') {
-            return {
-              type: 'mutation:display-contents-children-attribute',
-              mutationData: tagOrCallbackResult.mutationData
-            };
+            if (fg('platform_ufo_vc_ignore_display_none_mutations')) {
+              var _tagOrCallbackResult$ = tagOrCallbackResult.mutationData,
+                attributeName = _tagOrCallbackResult$.attributeName,
+                oldValue = _tagOrCallbackResult$.oldValue,
+                newValue = _tagOrCallbackResult$.newValue;
+              var isRoutingMutation = attributeName === 'style' && (!oldValue && newValue === 'display: none !important;' || oldValue === 'display: none !important;' && !newValue);
+              if (isRoutingMutation) {
+                return {
+                  type: 'mutation:attribute:framework-routing',
+                  mutationData: tagOrCallbackResult.mutationData
+                };
+              }
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            } else {
+              return {
+                type: 'mutation:display-contents-children-attribute',
+                mutationData: tagOrCallbackResult.mutationData
+              };
+            }
           }
           return tagOrCallbackResult;
         };

package/dist/esm/vc/vc-observer-new/viewport-observer/mutation-observer/index.js

@@ -38,13 +38,13 @@ function createMutationObserver(_ref) {
           if (mut.type === 'attributes') {
             var _mut$oldValue;
             /*
-            			"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
-            			I think it might have been something along the lines that for consistency every setAttribute call should create a record.
-            			Conceptually there is after all a mutation: there is an old value replaced with a new one,
-            			and whether or not they are the same doesn't really matter.
-            			And Custom elements should work the same way as MutationObserver."
-            			https://github.com/whatwg/dom/issues/520#issuecomment-336574796
-            		*/
+            	"MutationObserver was explicitly designed to work that way, but I can't now recall the reasoning.
+            	I think it might have been something along the lines that for consistency every setAttribute call should create a record.
+            	Conceptually there is after all a mutation: there is an old value replaced with a new one,
+            	and whether or not they are the same doesn't really matter.
+            	And Custom elements should work the same way as MutationObserver."
+            	https://github.com/whatwg/dom/issues/520#issuecomment-336574796
+            */
             var oldValue = (_mut$oldValue = mut.oldValue) !== null && _mut$oldValue !== void 0 ? _mut$oldValue : undefined;
             var newValue = mut.attributeName ? mut.target.getAttribute(mut.attributeName) : undefined;
             if (oldValue !== newValue) {

package/dist/types/vc/vc-observer-new/types.d.ts

@@ -1,6 +1,6 @@
 import type { AbortReasonType, InteractionType } from '../../common/common/types';
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:display-contents-children-element' | 'mutation:display-contents-children-attribute' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute:non-visual-input-name' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:third-party-attribute' | 'mutation:smart-answers-element' | 'mutation:smart-answers-attribute' | 'mutation:ssr-placeholder' | 'layout-shift' | 'layout-shift:same-rect' | 'window:event' | 'ssr-hydration' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:display-contents-children-element' | 'mutation:display-contents-children-attribute' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute:non-visual-input-name' | 'mutation:attribute:framework-routing' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:third-party-attribute' | 'mutation:smart-answers-element' | 'mutation:smart-answers-attribute' | 'mutation:ssr-placeholder' | 'layout-shift' | 'layout-shift:same-rect' | 'window:event' | 'ssr-hydration' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

package/dist/types-ts4.5/vc/vc-observer-new/types.d.ts

@@ -1,6 +1,6 @@
 import type { AbortReasonType, InteractionType } from '../../common/common/types';
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:display-contents-children-element' | 'mutation:display-contents-children-attribute' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute:non-visual-input-name' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:third-party-attribute' | 'mutation:smart-answers-element' | 'mutation:smart-answers-attribute' | 'mutation:ssr-placeholder' | 'layout-shift' | 'layout-shift:same-rect' | 'window:event' | 'ssr-hydration' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:display-contents-children-element' | 'mutation:display-contents-children-attribute' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute:non-visual-input-name' | 'mutation:attribute:framework-routing' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:third-party-attribute' | 'mutation:smart-answers-element' | 'mutation:smart-answers-attribute' | 'mutation:ssr-placeholder' | 'layout-shift' | 'layout-shift:same-rect' | 'window:event' | 'ssr-hydration' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.0.0",
+	"version": "5.0.2",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -192,9 +192,15 @@
 		"platform_ufo_enable_vc_raw_data": {
 			"type": "boolean"
 		},
+		"platform_ufo_dedupe_repeated_vc_offenders": {
+			"type": "boolean"
+		},
 		"platform_mark_ufo_segment_first_load": {
 			"type": "boolean"
 		},
+		"platform_ufo_vc_ignore_display_none_mutations": {
+			"type": "boolean"
+		},
 		"platform_ufo_keypress_interaction_abort": {
 			"type": "boolean"
 		},