@atlaskit/react-ufo 4.15.14 → 4.15.15

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.15.15
+
+### Patch Changes
+
+- [`e50c3c4b27b3d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e50c3c4b27b3d) -
+  Added even data to raw data handler
+
 ## 4.15.14
 
 ### Patch Changes

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

@@ -20,6 +20,9 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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) { (0, _defineProperty2.default)(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; }
 var ABORTING_WINDOW_EVENT = ['wheel', 'scroll', 'keydown', 'resize'];
 var MAX_OBSERVATIONS = 100;
+function isWindowEventEntryData(data) {
+  return data.type === 'window:event' && 'eventType' in data;
+}
 var RawDataHandler = exports.default = /*#__PURE__*/function () {
   function RawDataHandler() {
     (0, _classCallCheck2.default)(this, RawDataHandler);
@@ -56,7 +59,7 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
     key: "getRawData",
     value: function () {
       var _getRawData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.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;
+        var entries, startTime, stopTime, isPageVisible, isVCClean, dirtyReason, getVCCleanStatusResult, viewportEntries, windowEventEntries, targetNameToIdMap, elementMapEntriesMap, nextElementId, typeMap, typeMapEntriesMap, nextTypeId, attributeMap, attributeEntriesMap, nextAttributeId, eventTypeMap, eventTypeMapEntriesMap, nextEventTypeId, rawObservations, rawEventObservations, firstObservation, lastObservations, referencedEids, referencedChgs, referencedAtts, _iterator, _step, observation, _iterator2, _step2, eid, _iterator3, _step3, chg, _iterator4, _step4, att, firstEventObservation, lastEventObservations, referencedEvts, _iterator5, _step5, _observation, _iterator6, _step6, evt, result;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -83,6 +86,9 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
               viewportEntries = entries.filter(function (entry) {
                 return entry.time >= startTime && entry.time <= stopTime && entry.data && entry.data.visible;
               });
+              windowEventEntries = entries.filter(function (entry) {
+                return entry.time >= startTime && entry.time <= stopTime && entry.data && isWindowEventEntryData(entry.data);
+              });
               targetNameToIdMap = new Map();
               elementMapEntriesMap = {};
               nextElementId = 1;
@@ -92,6 +98,9 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
               attributeMap = new Map();
               attributeEntriesMap = {};
               nextAttributeId = 1;
+              eventTypeMap = new Map();
+              eventTypeMapEntriesMap = {};
+              nextEventTypeId = 1;
               rawObservations = viewportEntries.map(function (entry) {
                 var viewportEntry = entry.data;
                 var targetName = viewportEntry.elementName || '';
@@ -131,6 +140,22 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
                   att: att
                 } : {});
                 return observation;
+              });
+              rawEventObservations = windowEventEntries.map(function (entry) {
+                var windowEventEntry = entry.data;
+                var eventType = windowEventEntry.eventType;
+                var evtId = eventTypeMap.get(eventType) || 0;
+                if (evtId === 0) {
+                  evtId = nextEventTypeId;
+                  nextEventTypeId += 1;
+                  eventTypeMap.set(eventType, evtId);
+                  eventTypeMapEntriesMap[evtId] = eventType;
+                }
+                var eventObservation = {
+                  t: Math.round(entry.time - startTime),
+                  evt: evtId
+                };
+                return eventObservation;
               }); // 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
@@ -204,6 +229,46 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
                   _iterator4.f();
                 }
               }
+
+              // If the number of event observations is greater than the maximum allowed, we need to trim the event 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 (rawEventObservations.length > MAX_OBSERVATIONS) {
+                firstEventObservation = rawEventObservations[0];
+                lastEventObservations = rawEventObservations.slice(-MAX_OBSERVATIONS);
+                rawEventObservations = [firstEventObservation].concat((0, _toConsumableArray2.default)(lastEventObservations));
+
+                // Collect referenced IDs from remaining observations
+                referencedEvts = new Set();
+                _iterator5 = _createForOfIteratorHelper(rawEventObservations);
+                try {
+                  for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+                    _observation = _step5.value;
+                    if (_observation.evt > 0) {
+                      referencedEvts.add(_observation.evt);
+                    }
+                  }
+
+                  // Remove unreferenced entries from maps
+                } catch (err) {
+                  _iterator5.e(err);
+                } finally {
+                  _iterator5.f();
+                }
+                _iterator6 = _createForOfIteratorHelper(Object.keys(eventTypeMapEntriesMap).map(Number));
+                try {
+                  for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+                    evt = _step6.value;
+                    if (!referencedEvts.has(evt)) {
+                      delete eventTypeMapEntriesMap[evt];
+                    }
+                  }
+                } catch (err) {
+                  _iterator6.e(err);
+                } finally {
+                  _iterator6.f();
+                }
+              }
               result = {
                 revision: this.revisionNo,
                 clean: isVCClean,
@@ -212,7 +277,9 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
                   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
+                  att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined,
+                  evts: rawEventObservations.length > 0 ? rawEventObservations : undefined,
+                  evt: Object.keys(eventTypeMapEntriesMap).length > 0 ? eventTypeMapEntriesMap : undefined
                 },
                 abortReason: dirtyReason,
                 abortTimestamp: getVCCleanStatusResult.abortTimestamp,
@@ -222,7 +289,7 @@ var RawDataHandler = exports.default = /*#__PURE__*/function () {
                 }
               };
               return _context.abrupt("return", result);
-            case 20:
+            case 26:
             case "end":
               return _context.stop();
           }

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

@@ -3,6 +3,9 @@ import getViewportHeight from '../metric-calculator/utils/get-viewport-height';
 import getViewportWidth from '../metric-calculator/utils/get-viewport-width';
 const ABORTING_WINDOW_EVENT = ['wheel', 'scroll', 'keydown', 'resize'];
 const MAX_OBSERVATIONS = 100;
+function isWindowEventEntryData(data) {
+  return data.type === 'window:event' && 'eventType' in data;
+}
 export default class RawDataHandler {
   constructor() {
     _defineProperty(this, "revisionNo", 'raw-handler');
@@ -60,6 +63,9 @@ export default class RawDataHandler {
     const viewportEntries = entries.filter(entry => {
       return entry.time >= startTime && entry.time <= stopTime && entry.data && entry.data.visible;
     });
+    const windowEventEntries = entries.filter(entry => {
+      return entry.time >= startTime && entry.time <= stopTime && entry.data && isWindowEventEntryData(entry.data);
+    });
     const targetNameToIdMap = new Map();
     const elementMapEntriesMap = {};
     let nextElementId = 1;
@@ -69,6 +75,9 @@ export default class RawDataHandler {
     const attributeMap = new Map();
     const attributeEntriesMap = {};
     let nextAttributeId = 1;
+    const eventTypeMap = new Map();
+    const eventTypeMapEntriesMap = {};
+    let nextEventTypeId = 1;
     let rawObservations = viewportEntries.map(entry => {
       const viewportEntry = entry.data;
       const targetName = viewportEntry.elementName || '';
@@ -110,6 +119,23 @@ export default class RawDataHandler {
       };
       return observation;
     });
+    let rawEventObservations = windowEventEntries.map(entry => {
+      const windowEventEntry = entry.data;
+      const eventType = windowEventEntry.eventType;
+      let evtId = eventTypeMap.get(eventType) || 0;
+      if (evtId === 0) {
+        evtId = nextEventTypeId;
+        nextEventTypeId += 1;
+        eventTypeMap.set(eventType, evtId);
+        eventTypeMapEntriesMap[evtId] = eventType;
+      }
+      const eventObservation = {
+        t: Math.round(entry.time - startTime),
+        evt: evtId
+      };
+      return eventObservation;
+    });
+
     // 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
@@ -151,6 +177,30 @@ export default class RawDataHandler {
         }
       }
     }
+
+    // If the number of event observations is greater than the maximum allowed, we need to trim the event 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 (rawEventObservations.length > MAX_OBSERVATIONS) {
+      const firstEventObservation = rawEventObservations[0];
+      const lastEventObservations = rawEventObservations.slice(-MAX_OBSERVATIONS);
+      rawEventObservations = [firstEventObservation, ...lastEventObservations];
+
+      // Collect referenced IDs from remaining observations
+      const referencedEvts = new Set();
+      for (const observation of rawEventObservations) {
+        if (observation.evt > 0) {
+          referencedEvts.add(observation.evt);
+        }
+      }
+
+      // Remove unreferenced entries from maps
+      for (const evt of Object.keys(eventTypeMapEntriesMap).map(Number)) {
+        if (!referencedEvts.has(evt)) {
+          delete eventTypeMapEntriesMap[evt];
+        }
+      }
+    }
     const result = {
       revision: this.revisionNo,
       clean: isVCClean,
@@ -159,7 +209,9 @@ export default class RawDataHandler {
         obs: (_rawObservations = 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
+        att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined,
+        evts: rawEventObservations.length > 0 ? rawEventObservations : undefined,
+        evt: Object.keys(eventTypeMapEntriesMap).length > 0 ? eventTypeMapEntriesMap : undefined
       },
       abortReason: dirtyReason,
       abortTimestamp: getVCCleanStatusResult.abortTimestamp,

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

@@ -13,6 +13,9 @@ 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;
+function isWindowEventEntryData(data) {
+  return data.type === 'window:event' && 'eventType' in data;
+}
 var RawDataHandler = /*#__PURE__*/function () {
   function RawDataHandler() {
     _classCallCheck(this, RawDataHandler);
@@ -49,7 +52,7 @@ var RawDataHandler = /*#__PURE__*/function () {
     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;
+        var entries, startTime, stopTime, isPageVisible, isVCClean, dirtyReason, getVCCleanStatusResult, viewportEntries, windowEventEntries, targetNameToIdMap, elementMapEntriesMap, nextElementId, typeMap, typeMapEntriesMap, nextTypeId, attributeMap, attributeEntriesMap, nextAttributeId, eventTypeMap, eventTypeMapEntriesMap, nextEventTypeId, rawObservations, rawEventObservations, firstObservation, lastObservations, referencedEids, referencedChgs, referencedAtts, _iterator, _step, observation, _iterator2, _step2, eid, _iterator3, _step3, chg, _iterator4, _step4, att, firstEventObservation, lastEventObservations, referencedEvts, _iterator5, _step5, _observation, _iterator6, _step6, evt, result;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -76,6 +79,9 @@ var RawDataHandler = /*#__PURE__*/function () {
               viewportEntries = entries.filter(function (entry) {
                 return entry.time >= startTime && entry.time <= stopTime && entry.data && entry.data.visible;
               });
+              windowEventEntries = entries.filter(function (entry) {
+                return entry.time >= startTime && entry.time <= stopTime && entry.data && isWindowEventEntryData(entry.data);
+              });
               targetNameToIdMap = new Map();
               elementMapEntriesMap = {};
               nextElementId = 1;
@@ -85,6 +91,9 @@ var RawDataHandler = /*#__PURE__*/function () {
               attributeMap = new Map();
               attributeEntriesMap = {};
               nextAttributeId = 1;
+              eventTypeMap = new Map();
+              eventTypeMapEntriesMap = {};
+              nextEventTypeId = 1;
               rawObservations = viewportEntries.map(function (entry) {
                 var viewportEntry = entry.data;
                 var targetName = viewportEntry.elementName || '';
@@ -124,6 +133,22 @@ var RawDataHandler = /*#__PURE__*/function () {
                   att: att
                 } : {});
                 return observation;
+              });
+              rawEventObservations = windowEventEntries.map(function (entry) {
+                var windowEventEntry = entry.data;
+                var eventType = windowEventEntry.eventType;
+                var evtId = eventTypeMap.get(eventType) || 0;
+                if (evtId === 0) {
+                  evtId = nextEventTypeId;
+                  nextEventTypeId += 1;
+                  eventTypeMap.set(eventType, evtId);
+                  eventTypeMapEntriesMap[evtId] = eventType;
+                }
+                var eventObservation = {
+                  t: Math.round(entry.time - startTime),
+                  evt: evtId
+                };
+                return eventObservation;
               }); // 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
@@ -197,6 +222,46 @@ var RawDataHandler = /*#__PURE__*/function () {
                   _iterator4.f();
                 }
               }
+
+              // If the number of event observations is greater than the maximum allowed, we need to trim the event 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 (rawEventObservations.length > MAX_OBSERVATIONS) {
+                firstEventObservation = rawEventObservations[0];
+                lastEventObservations = rawEventObservations.slice(-MAX_OBSERVATIONS);
+                rawEventObservations = [firstEventObservation].concat(_toConsumableArray(lastEventObservations));
+
+                // Collect referenced IDs from remaining observations
+                referencedEvts = new Set();
+                _iterator5 = _createForOfIteratorHelper(rawEventObservations);
+                try {
+                  for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+                    _observation = _step5.value;
+                    if (_observation.evt > 0) {
+                      referencedEvts.add(_observation.evt);
+                    }
+                  }
+
+                  // Remove unreferenced entries from maps
+                } catch (err) {
+                  _iterator5.e(err);
+                } finally {
+                  _iterator5.f();
+                }
+                _iterator6 = _createForOfIteratorHelper(Object.keys(eventTypeMapEntriesMap).map(Number));
+                try {
+                  for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+                    evt = _step6.value;
+                    if (!referencedEvts.has(evt)) {
+                      delete eventTypeMapEntriesMap[evt];
+                    }
+                  }
+                } catch (err) {
+                  _iterator6.e(err);
+                } finally {
+                  _iterator6.f();
+                }
+              }
               result = {
                 revision: this.revisionNo,
                 clean: isVCClean,
@@ -205,7 +270,9 @@ var RawDataHandler = /*#__PURE__*/function () {
                   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
+                  att: attributeEntriesMap !== null && attributeEntriesMap !== void 0 ? attributeEntriesMap : undefined,
+                  evts: rawEventObservations.length > 0 ? rawEventObservations : undefined,
+                  evt: Object.keys(eventTypeMapEntriesMap).length > 0 ? eventTypeMapEntriesMap : undefined
                 },
                 abortReason: dirtyReason,
                 abortTimestamp: getVCCleanStatusResult.abortTimestamp,
@@ -215,7 +282,7 @@ var RawDataHandler = /*#__PURE__*/function () {
                 }
               };
               return _context.abrupt("return", result);
-            case 20:
+            case 26:
             case "end":
               return _context.stop();
           }

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

@@ -125,6 +125,10 @@ export type RawObservation = {
     eid: number;
     att?: number;
 };
+export type RawEventObservation = {
+    t: number;
+    evt: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -140,6 +144,8 @@ export type RevisionPayloadEntry = {
         eid?: Record<number, string>;
         chg?: Record<number, string>;
         att?: Record<number, string>;
+        evts?: Array<RawEventObservation>;
+        evt?: Record<number, string>;
     };
     viewport?: {
         w: number;

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

@@ -55,6 +55,10 @@ export type ReactHydrationStats = {
      * The depth in the React component tree of the deepest warning.
      */
     maxWarningComponentDepth?: number;
+    /**
+     * The ratio of DOM nodes preserved during hydration (between 0 and 1).
+     */
+    preservationRatio?: number;
 };
 export type Config = {
     readonly enabled?: boolean;

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

@@ -130,6 +130,10 @@ export type RawObservation = {
     eid: number;
     att?: number;
 };
+export type RawEventObservation = {
+    t: number;
+    evt: number;
+};
 export type RevisionPayloadEntry = {
     'metric:vc90': number | null;
     revision: string;
@@ -145,6 +149,8 @@ export type RevisionPayloadEntry = {
         eid?: Record<number, string>;
         chg?: Record<number, string>;
         att?: Record<number, string>;
+        evts?: Array<RawEventObservation>;
+        evt?: Record<number, string>;
     };
     viewport?: {
         w: number;

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

@@ -55,6 +55,10 @@ export type ReactHydrationStats = {
      * The depth in the React component tree of the deepest warning.
      */
     maxWarningComponentDepth?: number;
+    /**
+     * The ratio of DOM nodes preserved during hydration (between 0 and 1).
+     */
+    preservationRatio?: number;
 };
 export type Config = {
     readonly enabled?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.15.14",
+	"version": "4.15.15",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",