@atlaskit/react-ufo 5.4.11 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 5.5.0
+
+### Minor Changes
+
+- [`b6474459ca8ec`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b6474459ca8ec) -
+  Improve Terminal Error Metric to internally extract statusCode & traceId
+
 ## 5.4.11
 
 ### Patch Changes

package/dist/cjs/set-terminal-error/index.js

@@ -4,11 +4,15 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.isRelayNetworkError = void 0;
 exports.setTerminalError = setTerminalError;
 exports.sinkTerminalErrorHandler = sinkTerminalErrorHandler;
 exports.useReportTerminalError = useReportTerminalError;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _react = require("react");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _experienceTraceIdContext = require("../experience-trace-id-context");
 var _interactionContext = require("../interaction-context");
 var _interactionMetrics = require("../interaction-metrics");
 var _routeNameContext = _interopRequireDefault(require("../route-name-context"));
@@ -18,19 +22,56 @@ var sinkHandlerFn = function sinkHandlerFn() {};
 function sinkTerminalErrorHandler(fn) {
   sinkHandlerFn = fn;
 }
+var RELAY_NETWORK_ERRORS_NAME = 'RelayNetwork';
+/**
+ * Relay error structure
+ */
+
+var isRelayNetworkError = exports.isRelayNetworkError = function isRelayNetworkError(error) {
+  return error.name === RELAY_NETWORK_ERRORS_NAME;
+};
+var isErrorObject = function isErrorObject(error) {
+  return (0, _typeof2.default)(error) === 'object' && error !== null;
+};
+var getErrorStatusCode = function getErrorStatusCode(error) {
+  if (!isErrorObject(error)) {
+    return undefined;
+  }
+  if (isRelayNetworkError(error)) {
+    var _error$source;
+    return (_error$source = error.source) === null || _error$source === void 0 || (_error$source = _error$source.errors) === null || _error$source === void 0 || (_error$source = _error$source[0]) === null || _error$source === void 0 || (_error$source = _error$source.extensions) === null || _error$source === void 0 ? void 0 : _error$source.statusCode;
+  }
+  if ('statusCode' in error && typeof error.statusCode === 'number') {
+    return error.statusCode;
+  }
+  return undefined;
+};
+var getErrorTraceId = function getErrorTraceId(error) {
+  return isErrorObject(error) && 'traceId' in error && typeof error.traceId === 'string' ? error.traceId : undefined;
+};
 function setTerminalError(error, additionalAttributes, labelStack) {
-  var _error$message, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
+  var _error$message, _getActiveTrace$trace, _getActiveTrace, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
   if (additionalAttributes !== null && additionalAttributes !== void 0 && additionalAttributes.isClientNetworkError) {
     // Exclude client network errors from being reported to UFO
     return;
   }
   var activeInteraction = (0, _interactionMetrics.getActiveInteraction)();
   var currentTime = performance.now();
-  var errorData = _objectSpread({
+  var baseErrorData = {
     errorType: error.name || 'Error',
     errorMessage: ((_error$message = error.message) === null || _error$message === void 0 ? void 0 : _error$message.slice(0, 100)) || 'Unknown error',
     timestamp: currentTime
-  }, additionalAttributes);
+  };
+  var errorData = (0, _platformFeatureFlags.fg)('platform_ufo_terminal_errors_fix_missing_data') ? _objectSpread(_objectSpread({}, baseErrorData), {}, {
+    statusCode: getErrorStatusCode(error),
+    // Fallback to traceId from error object if it exists (e.g. FetchError)
+    traceId: (_getActiveTrace$trace = (_getActiveTrace = (0, _experienceTraceIdContext.getActiveTrace)()) === null || _getActiveTrace === void 0 ? void 0 : _getActiveTrace.traceId) !== null && _getActiveTrace$trace !== void 0 ? _getActiveTrace$trace : getErrorTraceId(error),
+    teamName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.teamName,
+    packageName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.packageName,
+    errorBoundaryId: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorBoundaryId,
+    errorHash: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorHash,
+    fallbackType: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.fallbackType
+  }) : _objectSpread(_objectSpread({}, baseErrorData), additionalAttributes);
 
   // Calculate time since previous interaction
   var timeSincePreviousInteraction = _interactionMetrics.PreviousInteractionLog.timestamp != null ? currentTime - _interactionMetrics.PreviousInteractionLog.timestamp : null;

package/dist/es2019/set-terminal-error/index.js

@@ -1,4 +1,6 @@
 import { useEffect, useRef } from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { getActiveTrace } from '../experience-trace-id-context';
 import { useInteractionContext } from '../interaction-context';
 import { getActiveInteraction, PreviousInteractionLog } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
@@ -6,18 +8,52 @@ let sinkHandlerFn = () => {};
 export function sinkTerminalErrorHandler(fn) {
   sinkHandlerFn = fn;
 }
+const RELAY_NETWORK_ERRORS_NAME = 'RelayNetwork';
+/**
+ * Relay error structure
+ */
+
+export const isRelayNetworkError = error => error.name === RELAY_NETWORK_ERRORS_NAME;
+const isErrorObject = error => typeof error === 'object' && error !== null;
+const getErrorStatusCode = error => {
+  if (!isErrorObject(error)) {
+    return undefined;
+  }
+  if (isRelayNetworkError(error)) {
+    var _error$source, _error$source$errors, _error$source$errors$, _error$source$errors$2;
+    return (_error$source = error.source) === null || _error$source === void 0 ? void 0 : (_error$source$errors = _error$source.errors) === null || _error$source$errors === void 0 ? void 0 : (_error$source$errors$ = _error$source$errors[0]) === null || _error$source$errors$ === void 0 ? void 0 : (_error$source$errors$2 = _error$source$errors$.extensions) === null || _error$source$errors$2 === void 0 ? void 0 : _error$source$errors$2.statusCode;
+  }
+  if ('statusCode' in error && typeof error.statusCode === 'number') {
+    return error.statusCode;
+  }
+  return undefined;
+};
+const getErrorTraceId = error => isErrorObject(error) && 'traceId' in error && typeof error.traceId === 'string' ? error.traceId : undefined;
 export function setTerminalError(error, additionalAttributes, labelStack) {
-  var _error$message, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
+  var _error$message, _getActiveTrace$trace, _getActiveTrace, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
   if (additionalAttributes !== null && additionalAttributes !== void 0 && additionalAttributes.isClientNetworkError) {
     // Exclude client network errors from being reported to UFO
     return;
   }
   const activeInteraction = getActiveInteraction();
   const currentTime = performance.now();
-  const errorData = {
+  const baseErrorData = {
     errorType: error.name || 'Error',
     errorMessage: ((_error$message = error.message) === null || _error$message === void 0 ? void 0 : _error$message.slice(0, 100)) || 'Unknown error',
-    timestamp: currentTime,
+    timestamp: currentTime
+  };
+  const errorData = fg('platform_ufo_terminal_errors_fix_missing_data') ? {
+    ...baseErrorData,
+    statusCode: getErrorStatusCode(error),
+    // Fallback to traceId from error object if it exists (e.g. FetchError)
+    traceId: (_getActiveTrace$trace = (_getActiveTrace = getActiveTrace()) === null || _getActiveTrace === void 0 ? void 0 : _getActiveTrace.traceId) !== null && _getActiveTrace$trace !== void 0 ? _getActiveTrace$trace : getErrorTraceId(error),
+    teamName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.teamName,
+    packageName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.packageName,
+    errorBoundaryId: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorBoundaryId,
+    errorHash: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorHash,
+    fallbackType: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.fallbackType
+  } : {
+    ...baseErrorData,
     ...additionalAttributes
   };
 

package/dist/esm/set-terminal-error/index.js

@@ -1,7 +1,10 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _typeof from "@babel/runtime/helpers/typeof";
 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 { useEffect, useRef } from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { getActiveTrace } from '../experience-trace-id-context';
 import { useInteractionContext } from '../interaction-context';
 import { getActiveInteraction, PreviousInteractionLog } from '../interaction-metrics';
 import UFORouteName from '../route-name-context';
@@ -9,19 +12,56 @@ var sinkHandlerFn = function sinkHandlerFn() {};
 export function sinkTerminalErrorHandler(fn) {
   sinkHandlerFn = fn;
 }
+var RELAY_NETWORK_ERRORS_NAME = 'RelayNetwork';
+/**
+ * Relay error structure
+ */
+
+export var isRelayNetworkError = function isRelayNetworkError(error) {
+  return error.name === RELAY_NETWORK_ERRORS_NAME;
+};
+var isErrorObject = function isErrorObject(error) {
+  return _typeof(error) === 'object' && error !== null;
+};
+var getErrorStatusCode = function getErrorStatusCode(error) {
+  if (!isErrorObject(error)) {
+    return undefined;
+  }
+  if (isRelayNetworkError(error)) {
+    var _error$source;
+    return (_error$source = error.source) === null || _error$source === void 0 || (_error$source = _error$source.errors) === null || _error$source === void 0 || (_error$source = _error$source[0]) === null || _error$source === void 0 || (_error$source = _error$source.extensions) === null || _error$source === void 0 ? void 0 : _error$source.statusCode;
+  }
+  if ('statusCode' in error && typeof error.statusCode === 'number') {
+    return error.statusCode;
+  }
+  return undefined;
+};
+var getErrorTraceId = function getErrorTraceId(error) {
+  return isErrorObject(error) && 'traceId' in error && typeof error.traceId === 'string' ? error.traceId : undefined;
+};
 export function setTerminalError(error, additionalAttributes, labelStack) {
-  var _error$message, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
+  var _error$message, _getActiveTrace$trace, _getActiveTrace, _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty, _PreviousInteractionL, _PreviousInteractionL2, _PreviousInteractionL3, _UFORouteName$current;
   if (additionalAttributes !== null && additionalAttributes !== void 0 && additionalAttributes.isClientNetworkError) {
     // Exclude client network errors from being reported to UFO
     return;
   }
   var activeInteraction = getActiveInteraction();
   var currentTime = performance.now();
-  var errorData = _objectSpread({
+  var baseErrorData = {
     errorType: error.name || 'Error',
     errorMessage: ((_error$message = error.message) === null || _error$message === void 0 ? void 0 : _error$message.slice(0, 100)) || 'Unknown error',
     timestamp: currentTime
-  }, additionalAttributes);
+  };
+  var errorData = fg('platform_ufo_terminal_errors_fix_missing_data') ? _objectSpread(_objectSpread({}, baseErrorData), {}, {
+    statusCode: getErrorStatusCode(error),
+    // Fallback to traceId from error object if it exists (e.g. FetchError)
+    traceId: (_getActiveTrace$trace = (_getActiveTrace = getActiveTrace()) === null || _getActiveTrace === void 0 ? void 0 : _getActiveTrace.traceId) !== null && _getActiveTrace$trace !== void 0 ? _getActiveTrace$trace : getErrorTraceId(error),
+    teamName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.teamName,
+    packageName: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.packageName,
+    errorBoundaryId: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorBoundaryId,
+    errorHash: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.errorHash,
+    fallbackType: additionalAttributes === null || additionalAttributes === void 0 ? void 0 : additionalAttributes.fallbackType
+  }) : _objectSpread(_objectSpread({}, baseErrorData), additionalAttributes);
 
   // Calculate time since previous interaction
   var timeSincePreviousInteraction = PreviousInteractionLog.timestamp != null ? currentTime - PreviousInteractionLog.timestamp : null;

package/dist/types/set-terminal-error/index.d.ts

@@ -4,10 +4,10 @@ export interface TerminalErrorAdditionalAttributes {
     packageName?: string;
     errorBoundaryId?: string;
     errorHash?: string;
-    traceId?: string;
     fallbackType?: 'page' | 'flag' | 'custom';
-    statusCode?: number;
     isClientNetworkError?: boolean;
+    traceId?: string;
+    statusCode?: number;
 }
 export interface TerminalErrorData extends TerminalErrorAdditionalAttributes {
     errorType: string;
@@ -26,5 +26,21 @@ export interface TerminalErrorContext {
     routeName: string | null;
 }
 export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
+/**
+ * Relay error structure
+ */
+type RelayNetworkErrors = {
+    name: string;
+    type: string;
+    source?: {
+        errors?: {
+            extensions?: {
+                statusCode?: number;
+            };
+        }[];
+    };
+};
+export declare const isRelayNetworkError: (error: RelayNetworkErrors | Error) => error is RelayNetworkErrors;
 export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;
 export declare function useReportTerminalError(error: Error | null | undefined, additionalAttributes?: TerminalErrorAdditionalAttributes): void;
+export {};

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

@@ -4,10 +4,10 @@ export interface TerminalErrorAdditionalAttributes {
     packageName?: string;
     errorBoundaryId?: string;
     errorHash?: string;
-    traceId?: string;
     fallbackType?: 'page' | 'flag' | 'custom';
-    statusCode?: number;
     isClientNetworkError?: boolean;
+    traceId?: string;
+    statusCode?: number;
 }
 export interface TerminalErrorData extends TerminalErrorAdditionalAttributes {
     errorType: string;
@@ -26,5 +26,21 @@ export interface TerminalErrorContext {
     routeName: string | null;
 }
 export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
+/**
+ * Relay error structure
+ */
+type RelayNetworkErrors = {
+    name: string;
+    type: string;
+    source?: {
+        errors?: {
+            extensions?: {
+                statusCode?: number;
+            };
+        }[];
+    };
+};
+export declare const isRelayNetworkError: (error: RelayNetworkErrors | Error) => error is RelayNetworkErrors;
 export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;
 export declare function useReportTerminalError(error: Error | null | undefined, additionalAttributes?: TerminalErrorAdditionalAttributes): void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.4.11",
+	"version": "5.5.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -200,6 +200,9 @@
 		"platform_ufo_enable_terminal_errors": {
 			"type": "boolean"
 		},
+		"platform_ufo_terminal_errors_fix_missing_data": {
+			"type": "boolean"
+		},
 		"ufo_vc_revision_trim_enabled": {
 			"type": "boolean"
 		},