@atlaskit/react-ufo 5.0.8 → 5.0.9

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 5.0.9
+
+### Patch Changes
+
+- [`ff09fea96cf45`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ff09fea96cf45) -
+  Add custom terminal error reporting metric
+
 ## 5.0.8
 
 ### Patch Changes

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

@@ -0,0 +1,40 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _config = require("../config");
+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) { (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; }
+function createTerminalErrorPayload(errorData, context) {
+  var _window$location;
+  var config = (0, _config.getConfig)();
+  if (!config) {
+    return null;
+  }
+  return {
+    actionSubject: 'experience',
+    action: 'measured',
+    eventType: 'operational',
+    source: 'measured',
+    tags: ['observability'],
+    attributes: {
+      properties: _objectSpread({
+        'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
+        'event:product': config.product,
+        'event:schema': '1.0.0',
+        'event:source': {
+          name: 'react-ufo/web',
+          version: '1.0.1'
+        },
+        'event:region': config.region || 'unknown',
+        'experience:key': 'custom.terminal-error',
+        terminalError: errorData
+      }, context)
+    }
+  };
+}
+var _default = exports.default = createTerminalErrorPayload;

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

@@ -18,6 +18,7 @@ var _hiddenTiming = require("../hidden-timing");
 var _interactionMetrics = require("../interaction-metrics");
 var _interactionsPerformanceObserver = require("../interactions-performance-observer");
 var _machineUtilisation = require("../machine-utilisation");
+var _setTerminalError = require("../set-terminal-error");
 var _scheduleIdleCallback = _interopRequireDefault(require("./schedule-idle-callback"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var initialized = false;
@@ -79,6 +80,22 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     });
   });
 }
+function sinkTerminalErrors(instance, createTerminalErrorPayload) {
+  (0, _setTerminalError.sinkTerminalErrorHandler)(function (errorData, context) {
+    (0, _scheduleIdleCallback.default)(function () {
+      var payload = createTerminalErrorPayload(errorData, context);
+      if (payload) {
+        if ((0, _platformFeatureFlags.fg)('enable_ufo_devtools_api_for_extra_events')) {
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
+        instance.sendOperationalEvent(payload);
+      }
+    });
+  });
+}
 function sinkInteractionExtraMetrics(instance, createInteractionExtraLogPayload) {
   _interactionMetrics.interactionExtraMetrics.sinkHandler(function (interactionId, interaction, lastInteractionFinish, lastInteractionFinishVCResult) {
     (0, _scheduleIdleCallback.default)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
@@ -174,17 +191,24 @@ function init(analyticsWebClientAsync, config) {
     return _interopRequireWildcard(require( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'));
   }), Promise.resolve().then(function () {
     return _interopRequireWildcard(require( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload'));
+  }), Promise.resolve().then(function () {
+    return _interopRequireWildcard(require( /* webpackChunkName: "create-terminal-error-payload@atlaskit-internal_terminal_errors" */'../create-terminal-error-payload'));
   })]).then(function (_ref2) {
-    var _ref3 = (0, _slicedToArray2.default)(_ref2, 4),
+    var _ref3 = (0, _slicedToArray2.default)(_ref2, 5),
       awc = _ref3[0],
       payloadPackage = _ref3[1],
       createPostInteractionLogPayloadPackage = _ref3[2],
-      createInteractionExtraMetricsPayloadPackage = _ref3[3];
+      createInteractionExtraMetricsPayloadPackage = _ref3[3],
+      createTerminalErrorPayloadPackage = _ref3[4];
     if (awc.getAnalyticsWebClientPromise) {
       awc.getAnalyticsWebClientPromise().then(function (client) {
         var _config$experimentalI2, _config$postInteracti, _config$extraInteract2, _config$extraSearchPa;
         var instance = client.getInstance();
         sinkInteraction(instance, payloadPackage);
+        // TODO: make this configurable
+        if ((0, _platformFeatureFlags.fg)('platform_ufo_enable_terminal_errors')) {
+          sinkTerminalErrors(instance, createTerminalErrorPayloadPackage.default);
+        }
         if (config !== null && config !== void 0 && (_config$experimentalI2 = config.experimentalInteractionMetrics) !== null && _config$experimentalI2 !== void 0 && _config$experimentalI2.enabled) {
           sinkExperimentalInteractionMetrics(instance, payloadPackage);
         }
@@ -201,6 +225,10 @@ function init(analyticsWebClientAsync, config) {
     } else if (awc.sendOperationalEvent) {
       var _config$experimentalI3, _config$postInteracti2, _config$extraInteract3, _config$extraSearchPa2;
       sinkInteraction(awc, payloadPackage);
+      // TODO: make this configurable
+      if ((0, _platformFeatureFlags.fg)('platform_ufo_enable_terminal_errors')) {
+        sinkTerminalErrors(awc, createTerminalErrorPayloadPackage.default);
+      }
       if (config !== null && config !== void 0 && (_config$experimentalI3 = config.experimentalInteractionMetrics) !== null && _config$experimentalI3 !== void 0 && _config$experimentalI3.enabled) {
         sinkExperimentalInteractionMetrics(awc, payloadPackage);
       }

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

@@ -0,0 +1,45 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setTerminalError = setTerminalError;
+exports.sinkTerminalErrorHandler = sinkTerminalErrorHandler;
+exports.useReportTerminalError = useReportTerminalError;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = require("react");
+var _interactionContext = require("../interaction-context");
+var _interactionMetrics = require("../interaction-metrics");
+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) { (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 sinkHandlerFn = function sinkHandlerFn() {};
+function sinkTerminalErrorHandler(fn) {
+  sinkHandlerFn = fn;
+}
+function setTerminalError(error, additionalAttributes, labelStack) {
+  var _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty;
+  var activeInteraction = (0, _interactionMetrics.getActiveInteraction)();
+  var errorData = _objectSpread({
+    errorType: error.name || 'Error',
+    errorMessage: error.message.slice(0, 100),
+    timestamp: performance.now()
+  }, additionalAttributes);
+  var context = {
+    labelStack: labelStack !== null && labelStack !== void 0 ? labelStack : null,
+    activeInteractionName: (_activeInteraction$uf = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.ufoName) !== null && _activeInteraction$uf !== void 0 ? _activeInteraction$uf : null,
+    activeInteractionId: (_activeInteraction$id = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.id) !== null && _activeInteraction$id !== void 0 ? _activeInteraction$id : null,
+    activeInteractionType: (_activeInteraction$ty = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.type) !== null && _activeInteraction$ty !== void 0 ? _activeInteraction$ty : null
+  };
+  sinkHandlerFn(errorData, context);
+}
+function useReportTerminalError(error, additionalAttributes) {
+  var interactionContext = (0, _interactionContext.useInteractionContext)();
+  var hasReportedRef = (0, _react.useRef)(false);
+  (0, _react.useEffect)(function () {
+    if (error && !hasReportedRef.current) {
+      hasReportedRef.current = true;
+      setTerminalError(error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack);
+    }
+  }, [error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack]);
+}

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

@@ -0,0 +1,31 @@
+import { getConfig } from '../config';
+function createTerminalErrorPayload(errorData, context) {
+  var _window$location;
+  const config = getConfig();
+  if (!config) {
+    return null;
+  }
+  return {
+    actionSubject: 'experience',
+    action: 'measured',
+    eventType: 'operational',
+    source: 'measured',
+    tags: ['observability'],
+    attributes: {
+      properties: {
+        'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
+        'event:product': config.product,
+        'event:schema': '1.0.0',
+        'event:source': {
+          name: 'react-ufo/web',
+          version: '1.0.1'
+        },
+        'event:region': config.region || 'unknown',
+        'experience:key': 'custom.terminal-error',
+        terminalError: errorData,
+        ...context
+      }
+    }
+  };
+}
+export default createTerminalErrorPayload;

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

@@ -7,6 +7,7 @@ import { setupHiddenTimingCapture } from '../hidden-timing';
 import { interactionExtraMetrics, postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getPerformanceObserver } from '../interactions-performance-observer';
 import { initialiseMemoryObserver, initialisePressureObserver } from '../machine-utilisation';
+import { sinkTerminalErrorHandler } from '../set-terminal-error';
 import scheduleIdleCallback from './schedule-idle-callback';
 let initialized = false;
 function sinkInteraction(instance, payloadPackage) {
@@ -67,6 +68,22 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     });
   });
 }
+function sinkTerminalErrors(instance, createTerminalErrorPayload) {
+  sinkTerminalErrorHandler((errorData, context) => {
+    scheduleIdleCallback(() => {
+      const payload = createTerminalErrorPayload(errorData, context);
+      if (payload) {
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          const devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 ? void 0 : devToolObserver(payload);
+          }
+        }
+        instance.sendOperationalEvent(payload);
+      }
+    });
+  });
+}
 function sinkInteractionExtraMetrics(instance, createInteractionExtraLogPayload) {
   interactionExtraMetrics.sinkHandler((interactionId, interaction, lastInteractionFinish, lastInteractionFinishVCResult) => {
     scheduleIdleCallback(async () => {
@@ -144,12 +161,16 @@ export function init(analyticsWebClientAsync, config) {
       durationThreshold: 16
     });
   }
-  Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'), import( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload')]).then(([awc, payloadPackage, createPostInteractionLogPayloadPackage, createInteractionExtraMetricsPayloadPackage]) => {
+  Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'), import( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload'), import( /* webpackChunkName: "create-terminal-error-payload@atlaskit-internal_terminal_errors" */'../create-terminal-error-payload')]).then(([awc, payloadPackage, createPostInteractionLogPayloadPackage, createInteractionExtraMetricsPayloadPackage, createTerminalErrorPayloadPackage]) => {
     if (awc.getAnalyticsWebClientPromise) {
       awc.getAnalyticsWebClientPromise().then(client => {
         var _config$experimentalI2, _config$postInteracti, _config$extraInteract2, _config$extraSearchPa;
         const instance = client.getInstance();
         sinkInteraction(instance, payloadPackage);
+        // TODO: make this configurable
+        if (fg('platform_ufo_enable_terminal_errors')) {
+          sinkTerminalErrors(instance, createTerminalErrorPayloadPackage.default);
+        }
         if (config !== null && config !== void 0 && (_config$experimentalI2 = config.experimentalInteractionMetrics) !== null && _config$experimentalI2 !== void 0 && _config$experimentalI2.enabled) {
           sinkExperimentalInteractionMetrics(instance, payloadPackage);
         }
@@ -166,6 +187,10 @@ export function init(analyticsWebClientAsync, config) {
     } else if (awc.sendOperationalEvent) {
       var _config$experimentalI3, _config$postInteracti2, _config$extraInteract3, _config$extraSearchPa2;
       sinkInteraction(awc, payloadPackage);
+      // TODO: make this configurable
+      if (fg('platform_ufo_enable_terminal_errors')) {
+        sinkTerminalErrors(awc, createTerminalErrorPayloadPackage.default);
+      }
       if (config !== null && config !== void 0 && (_config$experimentalI3 = config.experimentalInteractionMetrics) !== null && _config$experimentalI3 !== void 0 && _config$experimentalI3.enabled) {
         sinkExperimentalInteractionMetrics(awc, payloadPackage);
       }

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

@@ -0,0 +1,34 @@
+import { useEffect, useRef } from 'react';
+import { useInteractionContext } from '../interaction-context';
+import { getActiveInteraction } from '../interaction-metrics';
+let sinkHandlerFn = () => {};
+export function sinkTerminalErrorHandler(fn) {
+  sinkHandlerFn = fn;
+}
+export function setTerminalError(error, additionalAttributes, labelStack) {
+  var _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty;
+  const activeInteraction = getActiveInteraction();
+  const errorData = {
+    errorType: error.name || 'Error',
+    errorMessage: error.message.slice(0, 100),
+    timestamp: performance.now(),
+    ...additionalAttributes
+  };
+  const context = {
+    labelStack: labelStack !== null && labelStack !== void 0 ? labelStack : null,
+    activeInteractionName: (_activeInteraction$uf = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.ufoName) !== null && _activeInteraction$uf !== void 0 ? _activeInteraction$uf : null,
+    activeInteractionId: (_activeInteraction$id = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.id) !== null && _activeInteraction$id !== void 0 ? _activeInteraction$id : null,
+    activeInteractionType: (_activeInteraction$ty = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.type) !== null && _activeInteraction$ty !== void 0 ? _activeInteraction$ty : null
+  };
+  sinkHandlerFn(errorData, context);
+}
+export function useReportTerminalError(error, additionalAttributes) {
+  const interactionContext = useInteractionContext();
+  const hasReportedRef = useRef(false);
+  useEffect(() => {
+    if (error && !hasReportedRef.current) {
+      hasReportedRef.current = true;
+      setTerminalError(error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack);
+    }
+  }, [error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack]);
+}

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

@@ -0,0 +1,33 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { getConfig } from '../config';
+function createTerminalErrorPayload(errorData, context) {
+  var _window$location;
+  var config = getConfig();
+  if (!config) {
+    return null;
+  }
+  return {
+    actionSubject: 'experience',
+    action: 'measured',
+    eventType: 'operational',
+    source: 'measured',
+    tags: ['observability'],
+    attributes: {
+      properties: _objectSpread({
+        'event:hostname': ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || 'unknown',
+        'event:product': config.product,
+        'event:schema': '1.0.0',
+        'event:source': {
+          name: 'react-ufo/web',
+          version: '1.0.1'
+        },
+        'event:region': config.region || 'unknown',
+        'experience:key': 'custom.terminal-error',
+        terminalError: errorData
+      }, context)
+    }
+  };
+}
+export default createTerminalErrorPayload;

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

@@ -10,6 +10,7 @@ import { setupHiddenTimingCapture } from '../hidden-timing';
 import { interactionExtraMetrics, postInteractionLog, sinkInteractionHandler, sinkPostInteractionLogHandler } from '../interaction-metrics';
 import { getPerformanceObserver } from '../interactions-performance-observer';
 import { initialiseMemoryObserver, initialisePressureObserver } from '../machine-utilisation';
+import { sinkTerminalErrorHandler } from '../set-terminal-error';
 import scheduleIdleCallback from './schedule-idle-callback';
 var initialized = false;
 function sinkInteraction(instance, payloadPackage) {
@@ -70,6 +71,22 @@ function sinkPostInteractionLog(instance, createPostInteractionLogPayload) {
     });
   });
 }
+function sinkTerminalErrors(instance, createTerminalErrorPayload) {
+  sinkTerminalErrorHandler(function (errorData, context) {
+    scheduleIdleCallback(function () {
+      var payload = createTerminalErrorPayload(errorData, context);
+      if (payload) {
+        if (fg('enable_ufo_devtools_api_for_extra_events')) {
+          var devToolObserver = globalThis.__ufo_devtool_onUfoPayload;
+          if (typeof devToolObserver === 'function') {
+            devToolObserver === null || devToolObserver === void 0 || devToolObserver(payload);
+          }
+        }
+        instance.sendOperationalEvent(payload);
+      }
+    });
+  });
+}
 function sinkInteractionExtraMetrics(instance, createInteractionExtraLogPayload) {
   interactionExtraMetrics.sinkHandler(function (interactionId, interaction, lastInteractionFinish, lastInteractionFinishVCResult) {
     scheduleIdleCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
@@ -159,17 +176,22 @@ export function init(analyticsWebClientAsync, config) {
       durationThreshold: 16
     });
   }
-  Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'), import( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload')]).then(function (_ref2) {
-    var _ref3 = _slicedToArray(_ref2, 4),
+  Promise.all([analyticsWebClientAsync, import( /* webpackChunkName: "create-payloads" */'../create-payload'), import( /* webpackChunkName: "create-post-interaction-log-payload" */'../create-post-interaction-log-payload'), import( /* webpackChunkName: "create-interaction-extra-metrics-payload" */'../create-interaction-extra-metrics-payload'), import( /* webpackChunkName: "create-terminal-error-payload@atlaskit-internal_terminal_errors" */'../create-terminal-error-payload')]).then(function (_ref2) {
+    var _ref3 = _slicedToArray(_ref2, 5),
       awc = _ref3[0],
       payloadPackage = _ref3[1],
       createPostInteractionLogPayloadPackage = _ref3[2],
-      createInteractionExtraMetricsPayloadPackage = _ref3[3];
+      createInteractionExtraMetricsPayloadPackage = _ref3[3],
+      createTerminalErrorPayloadPackage = _ref3[4];
     if (awc.getAnalyticsWebClientPromise) {
       awc.getAnalyticsWebClientPromise().then(function (client) {
         var _config$experimentalI2, _config$postInteracti, _config$extraInteract2, _config$extraSearchPa;
         var instance = client.getInstance();
         sinkInteraction(instance, payloadPackage);
+        // TODO: make this configurable
+        if (fg('platform_ufo_enable_terminal_errors')) {
+          sinkTerminalErrors(instance, createTerminalErrorPayloadPackage.default);
+        }
         if (config !== null && config !== void 0 && (_config$experimentalI2 = config.experimentalInteractionMetrics) !== null && _config$experimentalI2 !== void 0 && _config$experimentalI2.enabled) {
           sinkExperimentalInteractionMetrics(instance, payloadPackage);
         }
@@ -186,6 +208,10 @@ export function init(analyticsWebClientAsync, config) {
     } else if (awc.sendOperationalEvent) {
       var _config$experimentalI3, _config$postInteracti2, _config$extraInteract3, _config$extraSearchPa2;
       sinkInteraction(awc, payloadPackage);
+      // TODO: make this configurable
+      if (fg('platform_ufo_enable_terminal_errors')) {
+        sinkTerminalErrors(awc, createTerminalErrorPayloadPackage.default);
+      }
       if (config !== null && config !== void 0 && (_config$experimentalI3 = config.experimentalInteractionMetrics) !== null && _config$experimentalI3 !== void 0 && _config$experimentalI3.enabled) {
         sinkExperimentalInteractionMetrics(awc, payloadPackage);
       }

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

@@ -0,0 +1,36 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { useInteractionContext } from '../interaction-context';
+import { getActiveInteraction } from '../interaction-metrics';
+var sinkHandlerFn = function sinkHandlerFn() {};
+export function sinkTerminalErrorHandler(fn) {
+  sinkHandlerFn = fn;
+}
+export function setTerminalError(error, additionalAttributes, labelStack) {
+  var _activeInteraction$uf, _activeInteraction$id, _activeInteraction$ty;
+  var activeInteraction = getActiveInteraction();
+  var errorData = _objectSpread({
+    errorType: error.name || 'Error',
+    errorMessage: error.message.slice(0, 100),
+    timestamp: performance.now()
+  }, additionalAttributes);
+  var context = {
+    labelStack: labelStack !== null && labelStack !== void 0 ? labelStack : null,
+    activeInteractionName: (_activeInteraction$uf = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.ufoName) !== null && _activeInteraction$uf !== void 0 ? _activeInteraction$uf : null,
+    activeInteractionId: (_activeInteraction$id = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.id) !== null && _activeInteraction$id !== void 0 ? _activeInteraction$id : null,
+    activeInteractionType: (_activeInteraction$ty = activeInteraction === null || activeInteraction === void 0 ? void 0 : activeInteraction.type) !== null && _activeInteraction$ty !== void 0 ? _activeInteraction$ty : null
+  };
+  sinkHandlerFn(errorData, context);
+}
+export function useReportTerminalError(error, additionalAttributes) {
+  var interactionContext = useInteractionContext();
+  var hasReportedRef = useRef(false);
+  useEffect(function () {
+    if (error && !hasReportedRef.current) {
+      hasReportedRef.current = true;
+      setTerminalError(error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack);
+    }
+  }, [error, additionalAttributes, interactionContext === null || interactionContext === void 0 ? void 0 : interactionContext.labelStack]);
+}

package/dist/types/create-terminal-error-payload/index.d.ts

@@ -0,0 +1,29 @@
+import type { LabelStack } from '../interaction-context';
+import type { TerminalErrorContext, TerminalErrorData } from '../set-terminal-error';
+export interface TerminalErrorPayload {
+    actionSubject: string;
+    action: string;
+    eventType: string;
+    source: string;
+    tags: string[];
+    attributes: {
+        properties: {
+            'event:hostname': string;
+            'event:product': string;
+            'event:schema': string;
+            'event:source': {
+                name: string;
+                version: string;
+            };
+            'event:region': string;
+            'experience:key': string;
+            terminalError: TerminalErrorData;
+            activeInteractionName: string | null;
+            activeInteractionId: string | null;
+            activeInteractionType: string | null;
+            labelStack: LabelStack | null;
+        };
+    };
+}
+declare function createTerminalErrorPayload(errorData: TerminalErrorData, context: TerminalErrorContext): TerminalErrorPayload | null;
+export default createTerminalErrorPayload;

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

@@ -0,0 +1,24 @@
+import { type LabelStack } from '../interaction-context';
+export interface TerminalErrorAdditionalAttributes {
+    teamName?: string;
+    packageName?: string;
+    errorBoundaryId?: string;
+    errorHash?: string;
+    traceId?: string;
+    fallbackType?: 'page' | 'flag' | 'custom';
+    statusCode?: number;
+}
+export interface TerminalErrorData extends TerminalErrorAdditionalAttributes {
+    errorType: string;
+    errorMessage: string;
+    timestamp: number;
+}
+export interface TerminalErrorContext {
+    labelStack: LabelStack | null;
+    activeInteractionName: string | null;
+    activeInteractionId: string | null;
+    activeInteractionType: string | null;
+}
+export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
+export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;
+export declare function useReportTerminalError(error: Error | null | undefined, additionalAttributes?: TerminalErrorAdditionalAttributes): void;

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

@@ -0,0 +1,29 @@
+import type { LabelStack } from '../interaction-context';
+import type { TerminalErrorContext, TerminalErrorData } from '../set-terminal-error';
+export interface TerminalErrorPayload {
+    actionSubject: string;
+    action: string;
+    eventType: string;
+    source: string;
+    tags: string[];
+    attributes: {
+        properties: {
+            'event:hostname': string;
+            'event:product': string;
+            'event:schema': string;
+            'event:source': {
+                name: string;
+                version: string;
+            };
+            'event:region': string;
+            'experience:key': string;
+            terminalError: TerminalErrorData;
+            activeInteractionName: string | null;
+            activeInteractionId: string | null;
+            activeInteractionType: string | null;
+            labelStack: LabelStack | null;
+        };
+    };
+}
+declare function createTerminalErrorPayload(errorData: TerminalErrorData, context: TerminalErrorContext): TerminalErrorPayload | null;
+export default createTerminalErrorPayload;

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

@@ -0,0 +1,24 @@
+import { type LabelStack } from '../interaction-context';
+export interface TerminalErrorAdditionalAttributes {
+    teamName?: string;
+    packageName?: string;
+    errorBoundaryId?: string;
+    errorHash?: string;
+    traceId?: string;
+    fallbackType?: 'page' | 'flag' | 'custom';
+    statusCode?: number;
+}
+export interface TerminalErrorData extends TerminalErrorAdditionalAttributes {
+    errorType: string;
+    errorMessage: string;
+    timestamp: number;
+}
+export interface TerminalErrorContext {
+    labelStack: LabelStack | null;
+    activeInteractionName: string | null;
+    activeInteractionId: string | null;
+    activeInteractionType: string | null;
+}
+export declare function sinkTerminalErrorHandler(fn: (errorData: TerminalErrorData, context: TerminalErrorContext) => void | Promise<void>): void;
+export declare function setTerminalError(error: Error, additionalAttributes?: TerminalErrorAdditionalAttributes, labelStack?: LabelStack): void;
+export declare function useReportTerminalError(error: Error | null | undefined, additionalAttributes?: TerminalErrorAdditionalAttributes): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.0.8",
+	"version": "5.0.9",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -219,6 +219,9 @@
 		},
 		"jfp-magma-ufo-event-listener-error": {
 			"type": "boolean"
+		},
+		"platform_ufo_enable_terminal_errors": {
+			"type": "boolean"
 		}
 	}
 }

package/set-terminal-error/package.json

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