@atlaskit/react-ufo 5.0.12 → 5.1.0

package/dist/types-ts4.5/experience-trace-id-context/context-manager.d.ts

@@ -0,0 +1,65 @@
+import { type Context, type ContextManager } from '@opentelemetry/api';
+export declare function setContextManager(ctxMgr: ContextManager): void;
+export declare function getContextManager(): ContextManager;
+/**
+ * The below is shamelessly borrowed from StackContextManager from @opentelemetry/sdk-trace-web
+ * Using this rather than importing the entire package because this is all we need for now
+ */
+/**
+ * UFO Context Manager for managing the state in web
+ * it doesn't fully support the async calls though
+ */
+export declare class UFOContextManager implements ContextManager {
+    /**
+     * whether the context manager is enabled or not
+     */
+    private _enabled;
+    /**
+     * Keeps the reference to current context
+     */
+    _currentContext: Context;
+    /**
+     *
+     * @param context
+     * @param target Function to be executed within the context
+     */
+    private _bindFunction;
+    /**
+     * Returns the active context
+     */
+    active(): Context;
+    /**
+     * Binds a the certain context or the active one to the target function and then returns the target
+     * @param context A context (span) to be bind to target
+     * @param target a function or event emitter. When target or one of its callbacks is called,
+     *  the provided context will be used as the active context for the duration of the call.
+     */
+    bind<T>(context: Context, target: T): T;
+    /**
+     * Disable the context manager (clears the current context)
+     */
+    disable(): this;
+    /**
+     * Enables the context manager and creates a default(root) context
+     */
+    enable(): this;
+    /**
+     * Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the window.
+     * The context will be set as active
+     * @param context
+     * @param fn Callback function
+     * @param thisArg optional receiver to be used for calling fn
+     * @param args optional arguments forwarded to fn
+     */
+    with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(context: Context | null, fn: F, thisArg?: ThisParameterType<F>, ...args: A): ReturnType<F>;
+    /**
+     * Sets the active context.
+     * This function is an extension of the OTel spec, in order to facilitate the current API of React UFO trace context handling.
+     * It doesn't keep track of any previously set active contexts, because it's assumed (for now) that only one trace context
+     * will ever exist at a time.
+     * The next step in the work to improve tracing in the FE will likely remove this function as we need to track the
+     * hierarchy of contexts (likely using the `with()` function above).
+     * @param context The context to be made the globally active one
+     */
+    setActive(context: Context): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.0.12",
+	"version": "5.1.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,6 +32,7 @@
 		"@atlaskit/interaction-context": "^3.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
+		"@opentelemetry/api": "^1.9.0",
 		"bind-event-listener": "^3.0.0",
 		"bowser-ultralight": "^1.0.6",
 		"scheduler": "0.23.2",
@@ -42,7 +43,7 @@
 	},
 	"devDependencies": {
 		"@af/integration-testing": "workspace:^",
-		"@atlassian/a11y-jest-testing": "^0.8.0",
+		"@atlassian/a11y-jest-testing": "^0.9.0",
 		"@atlassian/feature-flags-test-utils": "^1.0.0",
 		"@testing-library/react": "^16.3.0",
 		"@types/is-ci": "^3.0.0",
@@ -115,9 +116,6 @@
 		"platform_ufo_critical_metrics_payload": {
 			"type": "boolean"
 		},
-		"platform_ufo_disable_vcnext_observations": {
-			"type": "boolean"
-		},
 		"platform_ufo_exclude_3p_elements_from_ttai": {
 			"type": "boolean"
 		},
@@ -196,6 +194,9 @@
 		"platform_ufo_keypress_interaction_abort": {
 			"type": "boolean"
 		},
+		"platform_ufo_enable_otel_context_manager": {
+			"type": "boolean"
+		},
 		"platform_ufo_raw_data_thirdparty": {
 			"type": "boolean"
 		},

package/dist/cjs/vc/vc-observer-new/viewport-observer/utils/get-mutated-elements.js

@@ -1,68 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getMutatedElements = getMutatedElements;
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-function isElementStyledWithDisplayContents(element) {
-  var _window2;
-  // To minimise calling `getComputedStyle`, we are making an assumption that if an element is from the Entrypoints framework, then it will have `display: contents` styling
-  // as per https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/e4ccf437262ef4c0fd3c651ffb7ad4770b15aed4/jira/src/packages/platform/entry-points/entry-point-placeholder/src/index.tsx#lines-136
-  if ((0, _platformFeatureFlags.fg)('platform_ufo_detect_entrypoint_parent')) {
-    var _window;
-    if (element.hasAttribute('data-ep-placeholder-id')) {
-      return true;
-    }
-    return ((_window = window) === null || _window === void 0 || (_window = _window.getComputedStyle(element)) === null || _window === void 0 ? void 0 : _window.display) === 'contents';
-  }
-  return ((_window2 = window) === null || _window2 === void 0 || (_window2 = _window2.getComputedStyle(element)) === null || _window2 === void 0 ? void 0 : _window2.display) === 'contents';
-}
-var MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED = 3;
-function getMutatedElements(element) {
-  var depthLevel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-  if ((0, _platformFeatureFlags.fg)('platform_ufo_disable_vcnext_observations')) {
-    return [{
-      element: element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-  if (isElementStyledWithDisplayContents(element)) {
-    var mutatedElements = [];
-    var nestedDisplayContentsElementChildren = [];
-    var _iterator = _createForOfIteratorHelper(element.children),
-      _step;
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var child = _step.value;
-        if (isElementStyledWithDisplayContents(child)) {
-          nestedDisplayContentsElementChildren.push(child);
-        }
-        mutatedElements.push({
-          element: child,
-          isDisplayContentsElementChildren: true
-        });
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-    if (depthLevel < MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED && nestedDisplayContentsElementChildren.length > 0) {
-      return [].concat(mutatedElements, (0, _toConsumableArray2.default)(nestedDisplayContentsElementChildren.map(function (element) {
-        return getMutatedElements(element, depthLevel + 1);
-      }).flat()));
-    }
-    return mutatedElements;
-  } else {
-    return [{
-      element: element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-}

package/dist/es2019/vc/vc-observer-new/viewport-observer/utils/get-mutated-elements.js

@@ -1,45 +0,0 @@
-import { fg } from '@atlaskit/platform-feature-flags';
-function isElementStyledWithDisplayContents(element) {
-  var _window2, _window2$getComputedS;
-  // To minimise calling `getComputedStyle`, we are making an assumption that if an element is from the Entrypoints framework, then it will have `display: contents` styling
-  // as per https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/e4ccf437262ef4c0fd3c651ffb7ad4770b15aed4/jira/src/packages/platform/entry-points/entry-point-placeholder/src/index.tsx#lines-136
-  if (fg('platform_ufo_detect_entrypoint_parent')) {
-    var _window, _window$getComputedSt;
-    if (element.hasAttribute('data-ep-placeholder-id')) {
-      return true;
-    }
-    return ((_window = window) === null || _window === void 0 ? void 0 : (_window$getComputedSt = _window.getComputedStyle(element)) === null || _window$getComputedSt === void 0 ? void 0 : _window$getComputedSt.display) === 'contents';
-  }
-  return ((_window2 = window) === null || _window2 === void 0 ? void 0 : (_window2$getComputedS = _window2.getComputedStyle(element)) === null || _window2$getComputedS === void 0 ? void 0 : _window2$getComputedS.display) === 'contents';
-}
-const MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED = 3;
-export function getMutatedElements(element, depthLevel = 0) {
-  if (fg('platform_ufo_disable_vcnext_observations')) {
-    return [{
-      element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-  if (isElementStyledWithDisplayContents(element)) {
-    const mutatedElements = [];
-    const nestedDisplayContentsElementChildren = [];
-    for (const child of element.children) {
-      if (isElementStyledWithDisplayContents(child)) {
-        nestedDisplayContentsElementChildren.push(child);
-      }
-      mutatedElements.push({
-        element: child,
-        isDisplayContentsElementChildren: true
-      });
-    }
-    if (depthLevel < MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED && nestedDisplayContentsElementChildren.length > 0) {
-      return [...mutatedElements, ...nestedDisplayContentsElementChildren.map(element => getMutatedElements(element, depthLevel + 1)).flat()];
-    }
-    return mutatedElements;
-  } else {
-    return [{
-      element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-}

package/dist/esm/vc/vc-observer-new/viewport-observer/utils/get-mutated-elements.js

@@ -1,61 +0,0 @@
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-import { fg } from '@atlaskit/platform-feature-flags';
-function isElementStyledWithDisplayContents(element) {
-  var _window2;
-  // To minimise calling `getComputedStyle`, we are making an assumption that if an element is from the Entrypoints framework, then it will have `display: contents` styling
-  // as per https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/e4ccf437262ef4c0fd3c651ffb7ad4770b15aed4/jira/src/packages/platform/entry-points/entry-point-placeholder/src/index.tsx#lines-136
-  if (fg('platform_ufo_detect_entrypoint_parent')) {
-    var _window;
-    if (element.hasAttribute('data-ep-placeholder-id')) {
-      return true;
-    }
-    return ((_window = window) === null || _window === void 0 || (_window = _window.getComputedStyle(element)) === null || _window === void 0 ? void 0 : _window.display) === 'contents';
-  }
-  return ((_window2 = window) === null || _window2 === void 0 || (_window2 = _window2.getComputedStyle(element)) === null || _window2 === void 0 ? void 0 : _window2.display) === 'contents';
-}
-var MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED = 3;
-export function getMutatedElements(element) {
-  var depthLevel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-  if (fg('platform_ufo_disable_vcnext_observations')) {
-    return [{
-      element: element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-  if (isElementStyledWithDisplayContents(element)) {
-    var mutatedElements = [];
-    var nestedDisplayContentsElementChildren = [];
-    var _iterator = _createForOfIteratorHelper(element.children),
-      _step;
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var child = _step.value;
-        if (isElementStyledWithDisplayContents(child)) {
-          nestedDisplayContentsElementChildren.push(child);
-        }
-        mutatedElements.push({
-          element: child,
-          isDisplayContentsElementChildren: true
-        });
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-    if (depthLevel < MAX_NESTED_LEVELS_OF_DISPLAY_CONTENT_ELEMENTS_HANDLED && nestedDisplayContentsElementChildren.length > 0) {
-      return [].concat(mutatedElements, _toConsumableArray(nestedDisplayContentsElementChildren.map(function (element) {
-        return getMutatedElements(element, depthLevel + 1);
-      }).flat()));
-    }
-    return mutatedElements;
-  } else {
-    return [{
-      element: element,
-      isDisplayContentsElementChildren: false
-    }];
-  }
-}

package/dist/types/vc/vc-observer-new/viewport-observer/utils/get-mutated-elements.d.ts

@@ -1,6 +0,0 @@
-type MutatedElement = {
-    isDisplayContentsElementChildren: boolean;
-    element: Element;
-};
-export declare function getMutatedElements(element: Element, depthLevel?: number): MutatedElement[];
-export {};

package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/utils/get-mutated-elements.d.ts

@@ -1,6 +0,0 @@
-type MutatedElement = {
-    isDisplayContentsElementChildren: boolean;
-    element: Element;
-};
-export declare function getMutatedElements(element: Element, depthLevel?: number): MutatedElement[];
-export {};