@atlaskit/react-ufo 3.13.16 → 3.13.17

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 3.13.17
+
+### Patch Changes
+
+- [#160542](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/160542)
+  [`eadf6fec0762d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/eadf6fec0762d) -
+  Added extension to VC v3 to include SSR
+
 ## 3.13.16
 
 ### Patch Changes

package/dist/cjs/create-payload/utils/get-vc-metrics.js

@@ -22,7 +22,7 @@ function getVCMetrics(_x) {
 }
 function _getVCMetrics() {
   _getVCMetrics = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(interaction) {
-    var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$experimentalI, _result$ufoVcRev;
+    var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$vc3, _config$experimentalI, _result$ufoVcRev;
     var config, interactionStatus, pageVisibilityUpToTTAI, shouldReportVCMetrics, isSSREnabled, ssr, tti, prefix, result, mostRecentVCRevision, mostRecentVCRevisionPayload;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -63,11 +63,12 @@ function _getVCMetrics() {
             stop: interaction.end,
             tti: tti,
             prefix: prefix,
+            includeSSRInV3: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRInV3,
             vc: interaction.vc,
             isEventAborted: interactionStatus.originalInteractionStatus !== 'SUCCEEDED',
             experienceKey: interaction.ufoName,
             interactionId: interaction.id,
-            includeSSRRatio: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio
+            includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
           }, ssr));
         case 18:
           result = _context.sent;

package/dist/cjs/vc/index.js

@@ -129,7 +129,8 @@ var VCObserverWrapper = exports.VCObserverWrapper = /*#__PURE__*/function () {
               return (_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.getVCResult({
                 start: param.start,
                 stop: param.stop,
-                interactionId: param.interactionId
+                interactionId: param.interactionId,
+                ssr: param.includeSSRInV3 ? param.ssr : undefined
               });
             case 12:
               _context.t1 = _context.sent;

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

@@ -16,6 +16,8 @@ var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _entriesTimeline = _interopRequireDefault(require("./entries-timeline"));
 var _getElementName2 = _interopRequireDefault(require("./get-element-name"));
 var _fy25_ = _interopRequireDefault(require("./metric-calculator/fy25_03"));
+var _getViewportHeight = _interopRequireDefault(require("./metric-calculator/utils/get-viewport-height"));
+var _getViewportWidth = _interopRequireDefault(require("./metric-calculator/utils/get-viewport-width"));
 var _viewportObserver = _interopRequireDefault(require("./viewport-observer"));
 var _windowEventObserver = _interopRequireDefault(require("./window-event-observer"));
 var DEFAULT_SELECTOR_CONFIG = {
@@ -118,6 +120,31 @@ var VCObserverNew = exports.default = /*#__PURE__*/function () {
       (_this$viewportObserve2 = this.viewportObserver) === null || _this$viewportObserve2 === void 0 || _this$viewportObserve2.stop();
       (_this$windowEventObse2 = this.windowEventObserver) === null || _this$windowEventObse2 === void 0 || _this$windowEventObse2.stop();
     }
+  }, {
+    key: "addSSR",
+    value: function addSSR(ssr) {
+      this.entriesTimeline.push({
+        time: ssr,
+        data: {
+          elementName: 'SSR',
+          type: 'mutation:element',
+          rect: {
+            height: (0, _getViewportHeight.default)(),
+            width: (0, _getViewportWidth.default)(),
+            left: 0,
+            top: 0,
+            x: 0,
+            y: 0,
+            bottom: (0, _getViewportHeight.default)(),
+            right: (0, _getViewportWidth.default)(),
+            toJSON: function toJSON() {
+              return null;
+            }
+          },
+          visible: true
+        }
+      });
+    }
   }, {
     key: "getVCResult",
     value: function () {
@@ -130,11 +157,14 @@ var VCObserverNew = exports.default = /*#__PURE__*/function () {
               results = [];
               this.addStartEntry(start);
               calculator_fy25_03 = new _fy25_.default();
+              if (param.ssr) {
+                this.addSSR(param.ssr);
+              }
               orderedEntries = this.entriesTimeline.getOrderedEntries({
                 start: start,
                 stop: stop
               });
-              _context.next = 7;
+              _context.next = 8;
               return calculator_fy25_03.calculate({
                 orderedEntries: orderedEntries,
                 startTime: start,
@@ -142,13 +172,13 @@ var VCObserverNew = exports.default = /*#__PURE__*/function () {
                 interactionId: interactionId,
                 isPostInteraction: this.isPostInteraction
               });
-            case 7:
+            case 8:
               fy25_03 = _context.sent;
               if (fy25_03) {
                 results.push(fy25_03);
               }
               return _context.abrupt("return", results);
-            case 10:
+            case 11:
             case "end":
               return _context.stop();
           }

package/dist/es2019/create-payload/utils/get-vc-metrics.js

@@ -6,7 +6,7 @@ import getInteractionStatus from './get-interaction-status';
 import getPageVisibilityUpToTTAI from './get-page-visibility-up-to-ttai';
 import getSSRDoneTimeValue from './get-ssr-done-time-value';
 async function getVCMetrics(interaction) {
-  var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _interaction$apdex$, _config$vc2, _config$experimentalI, _result$ufoVcRev;
+  var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _interaction$apdex$, _config$vc2, _config$vc3, _config$experimentalI, _result$ufoVcRev;
   const config = getConfig();
   if (!(config !== null && config !== void 0 && (_config$vc = config.vc) !== null && _config$vc !== void 0 && _config$vc.enabled)) {
     return {};
@@ -33,11 +33,12 @@ async function getVCMetrics(interaction) {
     stop: interaction.end,
     tti,
     prefix,
+    includeSSRInV3: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRInV3,
     vc: interaction.vc,
     isEventAborted: interactionStatus.originalInteractionStatus !== 'SUCCEEDED',
     experienceKey: interaction.ufoName,
     interactionId: interaction.id,
-    includeSSRRatio: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio,
+    includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio,
     ...ssr
   });
   if ((_config$experimentalI = config.experimentalInteractionMetrics) !== null && _config$experimentalI !== void 0 && _config$experimentalI.enabled) {

package/dist/es2019/vc/index.js

@@ -80,7 +80,8 @@ export class VCObserverWrapper {
     const v3Result = isVCRevisionEnabled('fy25.03', experienceKey) ? await ((_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.getVCResult({
       start: param.start,
       stop: param.stop,
-      interactionId: param.interactionId
+      interactionId: param.interactionId,
+      ssr: param.includeSSRInV3 ? param.ssr : undefined
     })) : [];
     if (!v3Result) {
       return v1v2Result !== null && v1v2Result !== void 0 ? v1v2Result : {};

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

@@ -3,6 +3,8 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import EntriesTimeline from './entries-timeline';
 import getElementName from './get-element-name';
 import VCCalculator_FY25_03 from './metric-calculator/fy25_03';
+import getViewportHeight from './metric-calculator/utils/get-viewport-height';
+import getViewportWidth from './metric-calculator/utils/get-viewport-width';
 import ViewportObserver from './viewport-observer';
 import WindowEventObserver from './window-event-observer';
 const DEFAULT_SELECTOR_CONFIG = {
@@ -96,6 +98,29 @@ export default class VCObserverNew {
     (_this$viewportObserve2 = this.viewportObserver) === null || _this$viewportObserve2 === void 0 ? void 0 : _this$viewportObserve2.stop();
     (_this$windowEventObse2 = this.windowEventObserver) === null || _this$windowEventObse2 === void 0 ? void 0 : _this$windowEventObse2.stop();
   }
+  addSSR(ssr) {
+    this.entriesTimeline.push({
+      time: ssr,
+      data: {
+        elementName: 'SSR',
+        type: 'mutation:element',
+        rect: {
+          height: getViewportHeight(),
+          width: getViewportWidth(),
+          left: 0,
+          top: 0,
+          x: 0,
+          y: 0,
+          bottom: getViewportHeight(),
+          right: getViewportWidth(),
+          toJSON() {
+            return null;
+          }
+        },
+        visible: true
+      }
+    });
+  }
   async getVCResult(param) {
     const {
       start,
@@ -105,6 +130,9 @@ export default class VCObserverNew {
     const results = [];
     this.addStartEntry(start);
     const calculator_fy25_03 = new VCCalculator_FY25_03();
+    if (param.ssr) {
+      this.addSSR(param.ssr);
+    }
     const orderedEntries = this.entriesTimeline.getOrderedEntries({
       start,
       stop

package/dist/esm/create-payload/utils/get-vc-metrics.js

@@ -15,7 +15,7 @@ function getVCMetrics(_x) {
 }
 function _getVCMetrics() {
   _getVCMetrics = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(interaction) {
-    var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$experimentalI, _result$ufoVcRev;
+    var _config$vc, _config$vc$ssrWhiteli, _interaction$apdex, _config$vc2, _config$vc3, _config$experimentalI, _result$ufoVcRev;
     var config, interactionStatus, pageVisibilityUpToTTAI, shouldReportVCMetrics, isSSREnabled, ssr, tti, prefix, result, mostRecentVCRevision, mostRecentVCRevisionPayload;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -56,11 +56,12 @@ function _getVCMetrics() {
             stop: interaction.end,
             tti: tti,
             prefix: prefix,
+            includeSSRInV3: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRInV3,
             vc: interaction.vc,
             isEventAborted: interactionStatus.originalInteractionStatus !== 'SUCCEEDED',
             experienceKey: interaction.ufoName,
             interactionId: interaction.id,
-            includeSSRRatio: (_config$vc2 = config.vc) === null || _config$vc2 === void 0 ? void 0 : _config$vc2.includeSSRRatio
+            includeSSRRatio: (_config$vc3 = config.vc) === null || _config$vc3 === void 0 ? void 0 : _config$vc3.includeSSRRatio
           }, ssr));
         case 18:
           result = _context.sent;

package/dist/esm/vc/index.js

@@ -120,7 +120,8 @@ export var VCObserverWrapper = /*#__PURE__*/function () {
               return (_this$newVCObserver3 = this.newVCObserver) === null || _this$newVCObserver3 === void 0 ? void 0 : _this$newVCObserver3.getVCResult({
                 start: param.start,
                 stop: param.stop,
-                interactionId: param.interactionId
+                interactionId: param.interactionId,
+                ssr: param.includeSSRInV3 ? param.ssr : undefined
               });
             case 12:
               _context.t1 = _context.sent;

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

@@ -9,6 +9,8 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import EntriesTimeline from './entries-timeline';
 import _getElementName from './get-element-name';
 import VCCalculator_FY25_03 from './metric-calculator/fy25_03';
+import getViewportHeight from './metric-calculator/utils/get-viewport-height';
+import getViewportWidth from './metric-calculator/utils/get-viewport-width';
 import ViewportObserver from './viewport-observer';
 import WindowEventObserver from './window-event-observer';
 var DEFAULT_SELECTOR_CONFIG = {
@@ -111,6 +113,31 @@ var VCObserverNew = /*#__PURE__*/function () {
       (_this$viewportObserve2 = this.viewportObserver) === null || _this$viewportObserve2 === void 0 || _this$viewportObserve2.stop();
       (_this$windowEventObse2 = this.windowEventObserver) === null || _this$windowEventObse2 === void 0 || _this$windowEventObse2.stop();
     }
+  }, {
+    key: "addSSR",
+    value: function addSSR(ssr) {
+      this.entriesTimeline.push({
+        time: ssr,
+        data: {
+          elementName: 'SSR',
+          type: 'mutation:element',
+          rect: {
+            height: getViewportHeight(),
+            width: getViewportWidth(),
+            left: 0,
+            top: 0,
+            x: 0,
+            y: 0,
+            bottom: getViewportHeight(),
+            right: getViewportWidth(),
+            toJSON: function toJSON() {
+              return null;
+            }
+          },
+          visible: true
+        }
+      });
+    }
   }, {
     key: "getVCResult",
     value: function () {
@@ -123,11 +150,14 @@ var VCObserverNew = /*#__PURE__*/function () {
               results = [];
               this.addStartEntry(start);
               calculator_fy25_03 = new VCCalculator_FY25_03();
+              if (param.ssr) {
+                this.addSSR(param.ssr);
+              }
               orderedEntries = this.entriesTimeline.getOrderedEntries({
                 start: start,
                 stop: stop
               });
-              _context.next = 7;
+              _context.next = 8;
               return calculator_fy25_03.calculate({
                 orderedEntries: orderedEntries,
                 startTime: start,
@@ -135,13 +165,13 @@ var VCObserverNew = /*#__PURE__*/function () {
                 interactionId: interactionId,
                 isPostInteraction: this.isPostInteraction
               });
-            case 7:
+            case 8:
               fy25_03 = _context.sent;
               if (fy25_03) {
                 results.push(fy25_03);
               }
               return _context.abrupt("return", results);
-            case 10:
+            case 11:
             case "end":
               return _context.stop();
           }

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

@@ -74,6 +74,7 @@ export type Config = {
         readonly ssr?: boolean;
         readonly ssrWhitelist?: string[];
         readonly ssrEnablePageLayoutPlaceholder?: boolean;
+        readonly includeSSRInV3?: boolean;
         readonly stopVCAtInteractionFinish?: boolean;
         readonly includeSSRRatio?: boolean;
         /**

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

@@ -6,6 +6,7 @@ export type GetVCResultType = {
     isEventAborted: boolean;
     prefix?: string;
     ssr?: number;
+    includeSSRInV3?: boolean;
     vc?: VCRawDataType | null;
     experienceKey: string;
     interactionId?: string;

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

@@ -16,6 +16,7 @@ export default class VCObserverNew {
         startTime: DOMHighResTimeStamp;
     }): void;
     stop(): void;
+    addSSR(ssr: number): void;
     getVCResult(param: VCObserverGetVCResultParam): Promise<RevisionPayloadEntry[]>;
     private addStartEntry;
     private getElementName;

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

@@ -22,4 +22,5 @@ export type VCObserverGetVCResultParam = {
     start: number;
     stop: number;
     interactionId?: string;
+    ssr?: number;
 };

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

@@ -74,6 +74,7 @@ export type Config = {
         readonly ssr?: boolean;
         readonly ssrWhitelist?: string[];
         readonly ssrEnablePageLayoutPlaceholder?: boolean;
+        readonly includeSSRInV3?: boolean;
         readonly stopVCAtInteractionFinish?: boolean;
         readonly includeSSRRatio?: boolean;
         /**

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

@@ -6,6 +6,7 @@ export type GetVCResultType = {
     isEventAborted: boolean;
     prefix?: string;
     ssr?: number;
+    includeSSRInV3?: boolean;
     vc?: VCRawDataType | null;
     experienceKey: string;
     interactionId?: string;

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

@@ -16,6 +16,7 @@ export default class VCObserverNew {
         startTime: DOMHighResTimeStamp;
     }): void;
     stop(): void;
+    addSSR(ssr: number): void;
     getVCResult(param: VCObserverGetVCResultParam): Promise<RevisionPayloadEntry[]>;
     private addStartEntry;
     private getElementName;

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

@@ -22,4 +22,5 @@ export type VCObserverGetVCResultParam = {
     start: number;
     stop: number;
     interactionId?: string;
+    ssr?: number;
 };

package/package.json

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