@atlaskit/react-ufo 4.14.2 → 4.14.4

package/dist/esm/vc/vc-observer-new/raw-data-handler/index.js

@@ -0,0 +1,231 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+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 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 getViewportHeight from '../metric-calculator/utils/get-viewport-height';
+import getViewportWidth from '../metric-calculator/utils/get-viewport-width';
+var ABORTING_WINDOW_EVENT = ['wheel', 'scroll', 'keydown', 'resize'];
+var MAX_OBSERVATIONS = 100;
+var RawDataHandler = /*#__PURE__*/function () {
+  function RawDataHandler() {
+    _classCallCheck(this, RawDataHandler);
+    _defineProperty(this, "revisionNo", 'raw-handler');
+  }
+  return _createClass(RawDataHandler, [{
+    key: "getVCCleanStatus",
+    value: function getVCCleanStatus(filteredEntries) {
+      var dirtyReason = '';
+      var abortTimestamp = -1;
+      var hasAbortEvent = filteredEntries.some(function (entry) {
+        if (entry.data.type === 'window:event') {
+          var data = entry.data;
+          if (ABORTING_WINDOW_EVENT.includes(data.eventType)) {
+            dirtyReason = data.eventType === 'keydown' ? 'keypress' : data.eventType;
+            abortTimestamp = Math.round(entry.time);
+            return true;
+          }
+        }
+        return false;
+      });
+      if (hasAbortEvent && dirtyReason) {
+        return {
+          isVCClean: false,
+          dirtyReason: dirtyReason,
+          abortTimestamp: abortTimestamp
+        };
+      }
+      return {
+        isVCClean: true
+      };
+    }
+  }, {
+    key: "getRawData",
+    value: function () {
+      var _getRawData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
+        var entries, startTime, stopTime, isPageVisible, isVCClean, dirtyReason, getVCCleanStatusResult, viewportEntries, targetNameToIdMap, elementMapEntriesMap, nextElementId, typeMap, typeMapEntriesMap, nextTypeId, attributeMap, attributeEntriesMap, nextAttributeId, rawObservations, firstObservation, lastObservations, referencedEids, referencedChgs, referencedAtts, _iterator, _step, observation, _iterator2, _step2, eid, _iterator3, _step3, chg, _iterator4, _step4, att, result;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              entries = _ref.entries, startTime = _ref.startTime, stopTime = _ref.stopTime, isPageVisible = _ref.isPageVisible;
+              getVCCleanStatusResult = this.getVCCleanStatus(entries);
+              isVCClean = getVCCleanStatusResult.isVCClean;
+              dirtyReason = getVCCleanStatusResult.dirtyReason;
+              if (isPageVisible) {
+                _context.next = 6;
+                break;
+              }
+              return _context.abrupt("return", {
+                revision: this.revisionNo,
+                clean: false,
+                'metric:vc90': null,
+                abortReason: 'browser_backgrounded',
+                abortTimestamp: -1,
+                viewport: {
+                  w: getViewportWidth(),
+                  h: getViewportHeight()
+                }
+              });
+            case 6:
+              viewportEntries = entries.filter(function (entry) {
+                return entry.time >= startTime && entry.time <= stopTime && entry.data && entry.data.visible;
+              });
+              targetNameToIdMap = new Map();
+              elementMapEntriesMap = {};
+              nextElementId = 1;
+              typeMap = new Map();
+              typeMapEntriesMap = {};
+              nextTypeId = 1;
+              attributeMap = new Map();
+              attributeEntriesMap = {};
+              nextAttributeId = 1;
+              rawObservations = viewportEntries.map(function (entry) {
+                var viewportEntry = entry.data;
+                var targetName = viewportEntry.elementName || '';
+                var type = viewportEntry.type || '';
+                var rect = viewportEntry.rect;
+                var attributeName = viewportEntry.attributeName || '';
+                var eid = targetNameToIdMap.get(viewportEntry.elementName || '') || 0;
+                if (eid === 0) {
+                  eid = nextElementId;
+                  nextElementId += 1;
+                  targetNameToIdMap.set(targetName, eid);
+                  elementMapEntriesMap[eid] = targetName;
+                }
+                var chg = typeMap.get(type || '') || 0;
+                if (chg === 0) {
+                  chg = nextTypeId;
+                  nextTypeId += 1;
+                  typeMap.set(type, chg);
+                  typeMapEntriesMap[chg] = type;
+                }
+                var att = 0;
+                if (attributeName) {
+                  att = attributeMap.get(attributeName) || 0;
+                  if (att === 0) {
+                    att = nextAttributeId;
+                    nextAttributeId += 1;
+                    attributeMap.set(attributeName, att);
+                    attributeEntriesMap[att] = attributeName;
+                  }
+                }
+                var observation = _objectSpread({
+                  t: Math.round(entry.time),
+                  r: [Math.round(rect.left * 10) / 10, Math.round(rect.top * 10) / 10, Math.round(rect.right * 10) / 10, Math.round(rect.bottom * 10) / 10],
+                  chg: chg,
+                  eid: eid || 0
+                }, att > 0 ? {
+                  att: att
+                } : {});
+                return observation;
+              }); // If the number of observations is greater than the maximum allowed, we need to trim the observations to the maximum allowed.
+              // We do this by keeping the first observation and the last MAX_OBSERVATIONS observations.
+              // We then collect the referenced IDs from the remaining observations and remove the unreferenced entries from the maps
+              if (rawObservations.length > MAX_OBSERVATIONS) {
+                firstObservation = rawObservations[0];
+                lastObservations = rawObservations.slice(-MAX_OBSERVATIONS);
+                rawObservations = [firstObservation].concat(_toConsumableArray(lastObservations));
+
+                // Collect referenced IDs from remaining observations
+                referencedEids = new Set();
+                referencedChgs = new Set();
+                referencedAtts = new Set();
+                _iterator = _createForOfIteratorHelper(rawObservations);
+                try {
+                  for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                    observation = _step.value;
+                    if (observation.eid > 0) {
+                      referencedEids.add(observation.eid);
+                    }
+                    if (typeof observation.chg === 'number' && observation.chg > 0) {
+                      referencedChgs.add(observation.chg);
+                    }
+                    if (observation.att !== undefined && observation.att > 0) {
+                      referencedAtts.add(observation.att);
+                    }
+                  }
+
+                  // Remove unreferenced entries from maps
+                } catch (err) {
+                  _iterator.e(err);
+                } finally {
+                  _iterator.f();
+                }
+                _iterator2 = _createForOfIteratorHelper(Object.keys(elementMapEntriesMap).map(Number));
+                try {
+                  for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                    eid = _step2.value;
+                    if (!referencedEids.has(eid)) {
+                      delete elementMapEntriesMap[eid];
+                    }
+                  }
+                } catch (err) {
+                  _iterator2.e(err);
+                } finally {
+                  _iterator2.f();
+                }
+                _iterator3 = _createForOfIteratorHelper(Object.keys(typeMapEntriesMap).map(Number));
+                try {
+                  for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+                    chg = _step3.value;
+                    if (!referencedChgs.has(chg)) {
+                      delete typeMapEntriesMap[chg];
+                    }
+                  }
+                } catch (err) {
+                  _iterator3.e(err);
+                } finally {
+                  _iterator3.f();
+                }
+                _iterator4 = _createForOfIteratorHelper(Object.keys(attributeEntriesMap).map(Number));
+                try {
+                  for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+                    att = _step4.value;
+                    if (!referencedAtts.has(att)) {
+                      delete attributeEntriesMap[att];
+                    }
+                  }
+                } catch (err) {
+                  _iterator4.e(err);
+                } finally {
+                  _iterator4.f();
+                }
+              }
+              result = {
+                revision: this.revisionNo,
+                clean: isVCClean,
+                'metric:vc90': null,
+                rawData: {
+                  obs: rawObservations !== null && rawObservations !== void 0 ? rawObservations : undefined,
+                  eid: elementMapEntriesMap !== null && elementMapEntriesMap !== void 0 ? elementMapEntriesMap : undefined,
+                  chg: typeMapEntriesMap !== null && typeMapEntriesMap !== void 0 ? typeMapEntriesMap : undefined,
+                  att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined
+                },
+                abortReason: dirtyReason,
+                abortTimestamp: getVCCleanStatusResult.abortTimestamp,
+                viewport: {
+                  w: getViewportWidth(),
+                  h: getViewportHeight()
+                }
+              };
+              return _context.abrupt("return", result);
+            case 20:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function getRawData(_x) {
+        return _getRawData.apply(this, arguments);
+      }
+      return getRawData;
+    }()
+  }]);
+}();
+export { RawDataHandler as default };

package/dist/types/common/vc/types.d.ts

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel' | 'browser_backgrounded';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -118,6 +118,13 @@ export type CalculateTTVCResult = {
     vcDetails: RevisionPayloadVCDetails;
     ssrRatio: number;
 };
+export type RawObservation = {
+    t: number;
+    r: [number, number, number, number];
+    chg: number | string;
+    eid: number;
+    att?: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -128,6 +135,18 @@ export type RevisionPayloadEntry = {
     labelStacks?: VCLabelStacks;
     abortReason?: VCAbortReason | null;
     abortTimestamp?: number;
+    rawData?: {
+        obs?: Array<RawObservation>;
+        eid?: Record<number, string>;
+        chg?: Record<number, string>;
+        att?: Record<number, string>;
+    };
+    viewport?: {
+        w: number;
+        h: number;
+    };
+    feVCTime?: number;
+    rawVCTime?: number;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

package/dist/types/config/index.d.ts

@@ -161,6 +161,11 @@ export type Config = {
         readonly enabled: boolean;
         readonly searchPageMetricName: string;
     };
+    readonly enableVCRawDataRates?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
@@ -170,6 +175,7 @@ export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRev
 export declare function getReactHydrationStats(): ReactHydrationStats | undefined;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
+export declare function getVCRawDataInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getCapabilityRate(capability: Capability): number;
 export declare function getExtraInteractionRate(name: string, interactionType: InteractionType): number;

package/dist/types/vc/types.d.ts

@@ -17,6 +17,7 @@ export type GetVCResultType = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };
 export type SelectorConfig = {
     id: boolean;

package/dist/types/vc/vc-observer-new/raw-data-handler/index.d.ts

@@ -0,0 +1,20 @@
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { VCObserverEntry } from '../types';
+export default class RawDataHandler {
+    private readonly revisionNo;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+        abortTimestamp: number;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+        abortTimestamp?: undefined;
+    };
+    getRawData({ entries, startTime, stopTime, isPageVisible, }: {
+        entries: ReadonlyArray<VCObserverEntry>;
+        startTime: number;
+        stopTime: number;
+        isPageVisible: boolean;
+    }): Promise<RevisionPayloadEntry | undefined>;
+}

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

@@ -23,6 +23,7 @@ export type WindowEventEntryData = {
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
     readonly data: ViewportEntryData | WindowEventEntryData;
+    ignoredInRevision?: string[];
 };
 export type VCObserverGetVCResultParam = {
     start: number;
@@ -35,4 +36,5 @@ export type VCObserverGetVCResultParam = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };

package/dist/types-ts4.5/common/vc/types.d.ts

@@ -4,7 +4,7 @@ export declare const AbortEvent: {
     readonly keydown: "keydown";
     readonly resize: "resize";
 };
-export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel';
+export type VCAbortReason = 'custom' | 'scroll' | 'keypress' | 'resize' | 'error' | 'not-supported' | 'wheel' | 'browser_backgrounded';
 export type VCAbortReasonType = {
     reason: null | VCAbortReason;
     info: string;
@@ -118,6 +118,18 @@ export type CalculateTTVCResult = {
     vcDetails: RevisionPayloadVCDetails;
     ssrRatio: number;
 };
+export type RawObservation = {
+    t: number;
+    r: [
+        number,
+        number,
+        number,
+        number
+    ];
+    chg: number | string;
+    eid: number;
+    att?: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -128,6 +140,18 @@ export type RevisionPayloadEntry = {
     labelStacks?: VCLabelStacks;
     abortReason?: VCAbortReason | null;
     abortTimestamp?: number;
+    rawData?: {
+        obs?: Array<RawObservation>;
+        eid?: Record<number, string>;
+        chg?: Record<number, string>;
+        att?: Record<number, string>;
+    };
+    viewport?: {
+        w: number;
+        h: number;
+    };
+    feVCTime?: number;
+    rawVCTime?: number;
 };
 export type RevisionPayload = RevisionPayloadEntry[];
 export {};

package/dist/types-ts4.5/config/index.d.ts

@@ -161,6 +161,11 @@ export type Config = {
         readonly enabled: boolean;
         readonly searchPageMetricName: string;
     };
+    readonly enableVCRawDataRates?: {
+        readonly enabled?: boolean;
+        readonly rates?: Rates;
+        readonly kind?: Record<InteractionType, number>;
+    };
 };
 export declare function setUFOConfig(newConfig: Config): void;
 export declare function getConfig(): Config | undefined;
@@ -170,6 +175,7 @@ export declare function getMostRecentVCRevision(experienceKey?: string): TTVCRev
 export declare function getReactHydrationStats(): ReactHydrationStats | undefined;
 export declare function getInteractionRate(name: string, interactionKind: InteractionKind): number;
 export declare function getExperimentalInteractionRate(name: string, interactionType: InteractionType): number;
+export declare function getVCRawDataInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getPostInteractionRate(name: string, interactionType: InteractionType): number;
 export declare function getCapabilityRate(capability: Capability): number;
 export declare function getExtraInteractionRate(name: string, interactionType: InteractionType): number;

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

@@ -17,6 +17,7 @@ export type GetVCResultType = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };
 export type SelectorConfig = {
     id: boolean;

package/dist/types-ts4.5/vc/vc-observer-new/raw-data-handler/index.d.ts

@@ -0,0 +1,20 @@
+import type { RevisionPayloadEntry } from '../../../common/vc/types';
+import type { VCObserverEntry } from '../types';
+export default class RawDataHandler {
+    private readonly revisionNo;
+    protected getVCCleanStatus(filteredEntries: readonly VCObserverEntry[]): {
+        isVCClean: boolean;
+        dirtyReason: never;
+        abortTimestamp: number;
+    } | {
+        isVCClean: boolean;
+        dirtyReason?: undefined;
+        abortTimestamp?: undefined;
+    };
+    getRawData({ entries, startTime, stopTime, isPageVisible, }: {
+        entries: ReadonlyArray<VCObserverEntry>;
+        startTime: number;
+        stopTime: number;
+        isPageVisible: boolean;
+    }): Promise<RevisionPayloadEntry | undefined>;
+}

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

@@ -23,6 +23,7 @@ export type WindowEventEntryData = {
 export type VCObserverEntry = {
     readonly time: DOMHighResTimeStamp;
     readonly data: ViewportEntryData | WindowEventEntryData;
+    ignoredInRevision?: string[];
 };
 export type VCObserverGetVCResultParam = {
     start: number;
@@ -35,4 +36,5 @@ export type VCObserverGetVCResultParam = {
     interactionType: InteractionType;
     isPageVisible: boolean;
     interactionAbortReason?: AbortReasonType;
+    includeRawData?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.14.2",
+	"version": "4.14.4",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -107,6 +107,9 @@
 		"platform_ufo_critical_metrics_payload": {
 			"type": "boolean"
 		},
+		"platform_ufo_remove_ssr_placeholder_in_ttvc_v4": {
+			"type": "boolean"
+		},
 		"platform_ufo_enable_interactivity_jsm": {
 			"type": "boolean"
 		},
@@ -166,6 +169,9 @@
 		},
 		"platform_ufo_exclude_3p_attribute_changes": {
 			"type": "boolean"
+		},
+		"platform_ufo_enable_vc_raw_data": {
+			"type": "boolean"
 		}
 	}
 }