@atlaskit/react-ufo 4.9.0 → 4.10.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.10.0
+
+### Minor Changes
+
+- [`012e311801a01`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/012e311801a01) -
+  ensure singleton bundling of the package
+
+### Patch Changes
+
+- Updated dependencies
+
+## 4.9.1
+
+### Patch Changes
+
+- [`70c6ad9a84f0a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/70c6ad9a84f0a) -
+  filter out layout shifts where every source is the same rectangle
+
 ## 4.9.0
 
 ### Minor Changes

package/dist/cjs/additional-payload/utils/lighthouse-metrics/cls/index.js

@@ -4,12 +4,27 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getCLS = getCLS;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 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; }
+function isSameRects(rect1, rect2) {
+  return rect1.x === rect2.x && rect1.y === rect2.y && rect1.width === rect2.width && rect1.height === rect2.height && rect1.top === rect2.top && rect1.right === rect2.right && rect1.bottom === rect2.bottom && rect1.left === rect2.left;
+}
 function getCLS(start, stop, buffer) {
-  var layoutShifts = buffer.getAll().filter(function (entry) {
-    return entry.startTime >= start && entry.startTime <= stop;
+  var layoutShifts = buffer.getAll().filter(function (_entry) {
+    var entry = _entry;
+    var isWithinObservationWindow = entry.startTime >= start && entry.startTime <= stop;
+    if ((0, _platformFeatureFlags.fg)('platform_ufo_filter_cls_logs_same_rects_positions')) {
+      var _entry$sources;
+      var allSourcesHaveSameRects = entry === null || entry === void 0 || (_entry$sources = entry.sources) === null || _entry$sources === void 0 ? void 0 : _entry$sources.every(function (_ref) {
+        var previousRect = _ref.previousRect,
+          currentRect = _ref.currentRect;
+        return isSameRects(previousRect, currentRect);
+      });
+      return isWithinObservationWindow && !allSourcesHaveSameRects;
+    }
+    return isWithinObservationWindow;
   });
   var sessionWindows = [];
   var currentWindow = null;

package/dist/cjs/create-post-interaction-log-payload/index.js

@@ -152,7 +152,7 @@ function createPostInteractionLogPayload(_ref2) {
   if (lastInteractionFinish.errors.length > 0) {
     return null;
   }
-  var maxEndTimeFromProfiler = reactProfilerTimings ? Math.max.apply(Math, (0, _toConsumableArray2.default)(reactProfilerTimings.map(function (t) {
+  var maxEndTimeFromProfiler = reactProfilerTimings && reactProfilerTimings.length > 0 ? Math.max.apply(Math, (0, _toConsumableArray2.default)(reactProfilerTimings.map(function (t) {
     return t.commitTime;
   }))) : lastInteractionFinish.end;
   var revisedEndTime = Math.round(maxEndTimeFromProfiler);

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

@@ -10,6 +10,7 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _config = require("../config");
 var _vc = require("../vc");
 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; }
@@ -125,7 +126,7 @@ var PostInteractionLog = exports.default = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              if (!(!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn)) {
+              if (!(!this.lastInteractionFinish || !this.sinkHandlerFn || !this.hasData() && !(0, _platformFeatureFlags.fg)('platform_ufo_always_send_post_interaction_log'))) {
                 _context.next = 4;
                 break;
               }

package/dist/es2019/additional-payload/utils/lighthouse-metrics/cls/index.js

@@ -1,5 +1,21 @@
+import { fg } from '@atlaskit/platform-feature-flags';
+function isSameRects(rect1, rect2) {
+  return rect1.x === rect2.x && rect1.y === rect2.y && rect1.width === rect2.width && rect1.height === rect2.height && rect1.top === rect2.top && rect1.right === rect2.right && rect1.bottom === rect2.bottom && rect1.left === rect2.left;
+}
 export function getCLS(start, stop, buffer) {
-  const layoutShifts = buffer.getAll().filter(entry => entry.startTime >= start && entry.startTime <= stop);
+  const layoutShifts = buffer.getAll().filter(_entry => {
+    const entry = _entry;
+    const isWithinObservationWindow = entry.startTime >= start && entry.startTime <= stop;
+    if (fg('platform_ufo_filter_cls_logs_same_rects_positions')) {
+      var _entry$sources;
+      const allSourcesHaveSameRects = entry === null || entry === void 0 ? void 0 : (_entry$sources = entry.sources) === null || _entry$sources === void 0 ? void 0 : _entry$sources.every(({
+        previousRect,
+        currentRect
+      }) => isSameRects(previousRect, currentRect));
+      return isWithinObservationWindow && !allSourcesHaveSameRects;
+    }
+    return isWithinObservationWindow;
+  });
   const sessionWindows = [];
   let currentWindow = null;
 

package/dist/es2019/create-post-interaction-log-payload/index.js

@@ -139,7 +139,7 @@ function createPostInteractionLogPayload({
   if (lastInteractionFinish.errors.length > 0) {
     return null;
   }
-  const maxEndTimeFromProfiler = reactProfilerTimings ? Math.max(...reactProfilerTimings.map(t => t.commitTime)) : lastInteractionFinish.end;
+  const maxEndTimeFromProfiler = reactProfilerTimings && reactProfilerTimings.length > 0 ? Math.max(...reactProfilerTimings.map(t => t.commitTime)) : lastInteractionFinish.end;
   const revisedEndTime = Math.round(maxEndTimeFromProfiler);
   const revisedTtai = Math.round(maxEndTimeFromProfiler - lastInteractionFinish.start);
   const lastInteractionFinishStart = Math.round(lastInteractionFinish.start);

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

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getConfig } from '../config';
 import { VCObserverWrapper } from '../vc';
 const POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT = 3000;
@@ -89,7 +90,7 @@ export default class PostInteractionLog {
    */
   async sendPostInteractionLog() {
     var _this$vcObserver4, _config$vc, _config$vc2, _this$vcObserver5;
-    if (!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn) {
+    if (!this.lastInteractionFinish || !this.sinkHandlerFn || !this.hasData() && !fg('platform_ufo_always_send_post_interaction_log')) {
       var _this$vcObserver3;
       this.reset();
       (_this$vcObserver3 = this.vcObserver) === null || _this$vcObserver3 === void 0 ? void 0 : _this$vcObserver3.stop();

package/dist/esm/additional-payload/utils/lighthouse-metrics/cls/index.js

@@ -1,9 +1,24 @@
 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';
+function isSameRects(rect1, rect2) {
+  return rect1.x === rect2.x && rect1.y === rect2.y && rect1.width === rect2.width && rect1.height === rect2.height && rect1.top === rect2.top && rect1.right === rect2.right && rect1.bottom === rect2.bottom && rect1.left === rect2.left;
+}
 export function getCLS(start, stop, buffer) {
-  var layoutShifts = buffer.getAll().filter(function (entry) {
-    return entry.startTime >= start && entry.startTime <= stop;
+  var layoutShifts = buffer.getAll().filter(function (_entry) {
+    var entry = _entry;
+    var isWithinObservationWindow = entry.startTime >= start && entry.startTime <= stop;
+    if (fg('platform_ufo_filter_cls_logs_same_rects_positions')) {
+      var _entry$sources;
+      var allSourcesHaveSameRects = entry === null || entry === void 0 || (_entry$sources = entry.sources) === null || _entry$sources === void 0 ? void 0 : _entry$sources.every(function (_ref) {
+        var previousRect = _ref.previousRect,
+          currentRect = _ref.currentRect;
+        return isSameRects(previousRect, currentRect);
+      });
+      return isWithinObservationWindow && !allSourcesHaveSameRects;
+    }
+    return isWithinObservationWindow;
   });
   var sessionWindows = [];
   var currentWindow = null;

package/dist/esm/create-post-interaction-log-payload/index.js

@@ -145,7 +145,7 @@ function createPostInteractionLogPayload(_ref2) {
   if (lastInteractionFinish.errors.length > 0) {
     return null;
   }
-  var maxEndTimeFromProfiler = reactProfilerTimings ? Math.max.apply(Math, _toConsumableArray(reactProfilerTimings.map(function (t) {
+  var maxEndTimeFromProfiler = reactProfilerTimings && reactProfilerTimings.length > 0 ? Math.max.apply(Math, _toConsumableArray(reactProfilerTimings.map(function (t) {
     return t.commitTime;
   }))) : lastInteractionFinish.end;
   var revisedEndTime = Math.round(maxEndTimeFromProfiler);

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

@@ -5,6 +5,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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; }
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getConfig } from '../config';
 import { VCObserverWrapper } from '../vc';
 var POST_INTERACTION_LOG_SEND_DEFAULT_TIMEOUT = 3000;
@@ -118,7 +119,7 @@ var PostInteractionLog = /*#__PURE__*/function () {
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              if (!(!this.hasData() || !this.lastInteractionFinish || !this.sinkHandlerFn)) {
+              if (!(!this.lastInteractionFinish || !this.sinkHandlerFn || !this.hasData() && !fg('platform_ufo_always_send_post_interaction_log'))) {
                 _context.next = 4;
                 break;
               }

package/dist/types/additional-payload/utils/lighthouse-metrics/cls/types.d.ts

@@ -1,3 +1,10 @@
+export interface LayoutShiftAttribution {
+    readonly node: Node;
+    readonly previousRect: DOMRectReadOnly;
+    readonly currentRect: DOMRectReadOnly;
+    readonly toJSON: () => object;
+}
 export interface LayoutShiftPerformanceEntry extends PerformanceEntry {
     value: number;
+    sources: LayoutShiftAttribution[];
 }

package/dist/types-ts4.5/additional-payload/utils/lighthouse-metrics/cls/types.d.ts

@@ -1,3 +1,10 @@
+export interface LayoutShiftAttribution {
+    readonly node: Node;
+    readonly previousRect: DOMRectReadOnly;
+    readonly currentRect: DOMRectReadOnly;
+    readonly toJSON: () => object;
+}
 export interface LayoutShiftPerformanceEntry extends PerformanceEntry {
     value: number;
+    sources: LayoutShiftAttribution[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.9.0",
+	"version": "4.10.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -8,6 +8,7 @@
 		"registry": "https://registry.npmjs.org/"
 	},
 	"atlassian": {
+		"singleton": true,
 		"team": "UIP Frontend Observability"
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
@@ -28,7 +29,7 @@
 	"dependencies": {
 		"@atlaskit/browser-apis": "^0.0.1",
 		"@atlaskit/feature-gate-js-client": "^5.5.0",
-		"@atlaskit/interaction-context": "^3.0.0",
+		"@atlaskit/interaction-context": "^3.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
@@ -156,6 +157,9 @@
 		"platform_ufo_enable_late_mutation_label_stacks": {
 			"type": "boolean"
 		},
+		"platform_ufo_filter_cls_logs_same_rects_positions": {
+			"type": "boolean"
+		},
 		"platform_editor_exclude_dnd_anchor_name_from_ttvc": {
 			"type": "boolean"
 		},
@@ -164,6 +168,9 @@
 		},
 		"react_ufo_unified_search_ignoring_sain_metric": {
 			"type": "boolean"
+		},
+		"platform_ufo_always_send_post_interaction_log": {
+			"type": "boolean"
 		}
 	}
 }