@atlaskit/react-ufo 4.5.3 → 4.5.5

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.5.5
+
+### Patch Changes
+
+- [`d2a5fe501a90f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2a5fe501a90f) -
+  useUFOReportError hook for centrally managed error reporting for UFO
+
+## 4.5.4
+
+### Patch Changes
+
+- [`f438ecb761bb1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f438ecb761bb1) -
+  Move check for initial page load earlier for React hydration stats
+
 ## 4.5.3
 
 ### Patch Changes

package/dist/cjs/create-payload/index.js

@@ -714,7 +714,7 @@ function _createInteractionMetricsPayload() {
             (0, _addPerformanceMeasures.addPerformanceMeasures)(interaction.start, (0, _toConsumableArray2.default)((finalVCMetrics === null || finalVCMetrics === void 0 ? void 0 : finalVCMetrics['ufo:vc:rev']) || []));
           }
           getReactHydrationStats = function getReactHydrationStats() {
-            if (!isPageLoad || !hydration) {
+            if (!hydration) {
               return {};
             }
             return {

package/dist/cjs/interaction-metrics/index.js

@@ -696,7 +696,9 @@ function finishInteraction(id, data) {
       data.vc = observer.getVCRawData();
     }
   }
-  data.hydration = (0, _config.getReactHydrationStats)();
+  if (data.type === 'page_load') {
+    data.hydration = (0, _config.getReactHydrationStats)();
+  }
 
   // By this time, stop the post interaction log observer if coinflip rate is 0
   var sanitisedUfoName = (0, _utils.sanitizeUfoName)(data.ufoName);

package/dist/cjs/report-error/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUFOReportError = useUFOReportError;
+var _interactionContext = require("../interaction-context");
+var _interactionMetrics = require("../interaction-metrics");
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+function useUFOReportError() {
+  var interaction = (0, _interactionMetrics.getActiveInteraction)();
+  var ufoContext = (0, _interactionContext.useInteractionContext)();
+  var reportError = function reportError(error) {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      (0, _interactionMetrics.addError)(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      (0, _interactionMetrics.addErrorToAll)(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/es2019/create-payload/index.js

@@ -699,7 +699,7 @@ async function createInteractionMetricsPayload(interaction, interactionId, exper
     addPerformanceMeasures(interaction.start, [...((finalVCMetrics === null || finalVCMetrics === void 0 ? void 0 : finalVCMetrics['ufo:vc:rev']) || [])]);
   }
   const getReactHydrationStats = () => {
-    if (!isPageLoad || !hydration) {
+    if (!hydration) {
       return {};
     }
     return {

package/dist/es2019/interaction-metrics/index.js

@@ -614,7 +614,9 @@ function finishInteraction(id, data, endTime = performance.now()) {
       data.vc = observer.getVCRawData();
     }
   }
-  data.hydration = getReactHydrationStats();
+  if (data.type === 'page_load') {
+    data.hydration = getReactHydrationStats();
+  }
 
   // By this time, stop the post interaction log observer if coinflip rate is 0
   const sanitisedUfoName = sanitizeUfoName(data.ufoName);

package/dist/es2019/report-error/index.js

@@ -0,0 +1,30 @@
+import { useInteractionContext } from '../interaction-context';
+import { addError, addErrorToAll, getActiveInteraction } from '../interaction-metrics';
+
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export function useUFOReportError() {
+  const interaction = getActiveInteraction();
+  const ufoContext = useInteractionContext();
+  const reportError = error => {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      addError(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      addErrorToAll(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/esm/create-payload/index.js

@@ -705,7 +705,7 @@ function _createInteractionMetricsPayload() {
             addPerformanceMeasures(interaction.start, _toConsumableArray((finalVCMetrics === null || finalVCMetrics === void 0 ? void 0 : finalVCMetrics['ufo:vc:rev']) || []));
           }
           getReactHydrationStats = function getReactHydrationStats() {
-            if (!isPageLoad || !hydration) {
+            if (!hydration) {
               return {};
             }
             return {

package/dist/esm/interaction-metrics/index.js

@@ -650,7 +650,9 @@ function finishInteraction(id, data) {
       data.vc = observer.getVCRawData();
     }
   }
-  data.hydration = getReactHydrationStats();
+  if (data.type === 'page_load') {
+    data.hydration = getReactHydrationStats();
+  }
 
   // By this time, stop the post interaction log observer if coinflip rate is 0
   var sanitisedUfoName = sanitizeUfoName(data.ufoName);

package/dist/esm/report-error/index.js

@@ -0,0 +1,30 @@
+import { useInteractionContext } from '../interaction-context';
+import { addError, addErrorToAll, getActiveInteraction } from '../interaction-metrics';
+
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export function useUFOReportError() {
+  var interaction = getActiveInteraction();
+  var ufoContext = useInteractionContext();
+  var reportError = function reportError(error) {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      addError(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      addErrorToAll(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/types/report-error/index.d.ts

@@ -0,0 +1,17 @@
+import { type InteractionError } from '../interaction-metrics';
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export declare function useUFOReportError(): (error: InteractionError) => void;

package/dist/types-ts4.5/report-error/index.d.ts

@@ -0,0 +1,17 @@
+import { type InteractionError } from '../interaction-metrics';
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export declare function useUFOReportError(): (error: InteractionError) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.5.3",
+	"version": "4.5.5",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,55 +25,6 @@
 	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		"./additional-payload": "./src/additional-payload/index.ts",
-		"./bundle-eval-timing": "./src/bundle-eval-timing/index.ts",
-		"./coinflip": "./src/coinflip/index.ts",
-		"./common": "./src/common/index.ts",
-		"./config": "./src/config/index.ts",
-		"./create-experimental-interaction-metrics-payload": "./src/create-experimental-interaction-metrics-payload/index.ts",
-		"./create-payload": "./src/create-payload/index.ts",
-		"./create-post-interaction-log-payload": "./src/create-post-interaction-log-payload/index.ts",
-		"./custom-data": "./src/custom-data/index.ts",
-		"./custom-cohort-data": "./src/custom-cohort-data/index.ts",
-		"./custom-mark": "./src/custom-mark/index.ts",
-		"./custom-spans": "./src/custom-spans/index.ts",
-		"./custom-timings": "./src/custom-timings/index.ts",
-		"./experience-trace-id-context": "./src/experience-trace-id-context/index.ts",
-		"./feature-flags-accessed": "./src/feature-flags-accessed/index.ts",
-		"./generate-id": "./src/generate-id/index.ts",
-		"./global-error-handler": "./src/global-error-handler/index.ts",
-		"./hidden-timing": "./src/hidden-timing/index.ts",
-		"./initial-page-load-extra-timing": "./src/initial-page-load-extra-timing/index.ts",
-		"./interaction-context": "./src/interaction-context/index.ts",
-		"./interaction-id-context": "./src/interaction-id-context/index.ts",
-		"./interaction-ignore": "./src/interaction-ignore/index.ts",
-		"./interaction-metrics": "./src/interaction-metrics/index.ts",
-		"./interaction-metrics-init": "./src/interaction-metrics-init/index.ts",
-		"./label": "./src/label/index.ts",
-		"./load-hold": "./src/load-hold/index.ts",
-		"./placeholder": "./src/placeholder/index.ts",
-		"./resource-timing": "./src/resource-timing/index.ts",
-		"./round-number": "./src/round-number/index.ts",
-		"./route-name": "./src/route-name/index.ts",
-		"./route-name-context": "./src/route-name-context/index.ts",
-		"./segment": "./src/segment/index.ts",
-		"./set-interaction-error": "./src/set-interaction-error/index.ts",
-		"./short-id": "./src/short-id/index.ts",
-		"./ssr": "./src/ssr/index.ts",
-		"./ssr-scripts": "./src/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/index.ts",
-		"./suspense": "./src/suspense/index.ts",
-		"./trace-interaction": "./src/trace-interaction/index.ts",
-		"./trace-pageload": "./src/trace-pageload/index.ts",
-		"./trace-press": "./src/trace-press/index.ts",
-		"./trace-redirect": "./src/trace-redirect/index.ts",
-		"./trace-transition": "./src/trace-transition/index.ts",
-		"./typing-performance-tracing": "./src/typing-performance-tracing/index.ts",
-		"./use-press-tracing": "./src/use-press-tracing/index.ts",
-		"./vc": "./src/vc/index.ts",
-		"./vc-media": "./src/vc/vc-observer/media-wrapper/index.ts",
-		".": "./src/index.ts"
-	},
 	"dependencies": {
 		"@atlaskit/browser-apis": "^0.0.1",
 		"@atlaskit/feature-gate-js-client": "^5.5.0",

package/report-error/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/react-ufo/report-error",
+  "main": "../dist/cjs/report-error/index.js",
+  "module": "../dist/esm/report-error/index.js",
+  "module:es2019": "../dist/es2019/report-error/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/report-error/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/report-error/index.d.ts"
+      ]
+    }
+  }
+}