@atlaskit/editor-plugin-ufo 7.0.1 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-ufo
 
+## 8.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.0.2
+
+### Patch Changes
+
+- [`83792cc1d590e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/83792cc1d590e) -
+  Abort UFO measurements when user interacts with the editor during VC90 load tracking, gated behind
+  platform_editor_abort_ufo_on_user_interaction experiment
+- Updated dependencies
+
 ## 7.0.1
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -29,6 +29,9 @@
 		{
 			"path": "../../../react-ufo/atlaskit/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../tmp-editor-statsig/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-cc/tsconfig.json"
 		}

package/afm-jira/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"target": "es5",
 		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-plugin-ufo/app",
@@ -29,6 +29,9 @@
 		{
 			"path": "../../../react-ufo/atlaskit/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../tmp-editor-statsig/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-jira/tsconfig.json"
 		}

package/afm-products/tsconfig.json

@@ -29,6 +29,9 @@
 		{
 			"path": "../../../react-ufo/atlaskit/afm-products/tsconfig.json"
 		},
+		{
+			"path": "../../tmp-editor-statsig/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-products/tsconfig.json"
 		}

package/dist/cjs/pm-plugins/traceUFOInteractionOnFirstInteraction.js

@@ -1,50 +1,32 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.traceUFOInteractionOnFirstInteraction = void 0;
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _selection = require("@atlaskit/editor-common/selection");
+var _utils = require("@atlaskit/editor-common/utils");
 var _interactionMetrics = require("@atlaskit/react-ufo/interaction-metrics");
-var _traceInteraction = _interopRequireDefault(require("@atlaskit/react-ufo/trace-interaction"));
-/* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
-
 var traceUFOInteractionOnFirstInteraction = exports.traceUFOInteractionOnFirstInteraction = function traceUFOInteractionOnFirstInteraction() {
-  var aborted = false;
-  function abortIfNotAborted(event) {
-    if (aborted) {
-      // opt out of additional logic if already aborted
-      return;
-    }
-    var activeInteraction = (0, _interactionMetrics.getActiveInteraction)();
-    if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
-      (0, _traceInteraction.default)('new_interaction', event);
-    }
-    aborted = true;
-  }
   return new _safePlugin.SafePlugin({
-    props: {
-      handleDOMEvents: {
-        mouseover: function mouseover(_view, event) {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-          abortIfNotAborted(event);
-        },
-        mouseenter: function mouseenter(_view, event) {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-
-          abortIfNotAborted(event);
-        },
-        mousedown: function mousedown(_view, event) {
-          return abortIfNotAborted(event);
+    view: function view() {
+      var aborted = false;
+      return {
+        update: function update(view, prevState) {
+          if (aborted) {
+            // opt out of additional logic if already aborted
+            return;
+          }
+          if (!view.state.selection.eq(prevState.selection) && !(0, _selection.atTheBeginningOfDoc)(view.state) && !(0, _utils.isEmptyDocument)(view.state.doc)) {
+            var activeInteraction = (0, _interactionMetrics.getActiveInteraction)();
+            if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
+              (0, _interactionMetrics.abortAll)('new_interaction', "selection-changed-on-editor-element");
+            }
+            aborted = true;
+          }
         }
-      }
+      };
     }
   });
 };

package/dist/cjs/ufoPlugin.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.ufoPlugin = void 0;
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+var _traceUFOInteractionOnFirstInteraction = require("./pm-plugins/traceUFOInteractionOnFirstInteraction");
 var ufoPlugin = exports.ufoPlugin = function ufoPlugin() {
   return {
     name: 'ufo',
@@ -14,17 +16,13 @@ var ufoPlugin = exports.ufoPlugin = function ufoPlugin() {
         // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
         return [];
       }
-
-      // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-      // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
+      if ((0, _expValEquals.expValEquals)('platform_editor_abort_ufo_on_user_interaction', 'isEnabled', true)) {
+        return [{
+          name: 'traceUFOInteractionOnFirstInteraction',
+          plugin: _traceUFOInteractionOnFirstInteraction.traceUFOInteractionOnFirstInteraction
+        }];
+      }
       return [];
-
-      // return [
-      // 	{
-      // 		name: 'traceUFOInteractionOnFirstInteraction',
-      // 		plugin: traceUFOInteractionOnFirstInteraction,
-      // 	},
-      // ];
     }
   };
 };

package/dist/es2019/pm-plugins/traceUFOInteractionOnFirstInteraction.js

@@ -1,40 +1,26 @@
-/* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
-import traceUFOInteraction from '@atlaskit/react-ufo/trace-interaction';
+import { atTheBeginningOfDoc } from '@atlaskit/editor-common/selection';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils';
+import { abortAll, getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
 export const traceUFOInteractionOnFirstInteraction = () => {
-  let aborted = false;
-  function abortIfNotAborted(event) {
-    if (aborted) {
-      // opt out of additional logic if already aborted
-      return;
-    }
-    const activeInteraction = getActiveInteraction();
-    if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
-      traceUFOInteraction('new_interaction', event);
-    }
-    aborted = true;
-  }
   return new SafePlugin({
-    props: {
-      handleDOMEvents: {
-        mouseover: (_view, event) => {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-          abortIfNotAborted(event);
-        },
-        mouseenter: (_view, event) => {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-
-          abortIfNotAborted(event);
-        },
-        mousedown: (_view, event) => abortIfNotAborted(event)
-      }
+    view() {
+      let aborted = false;
+      return {
+        update(view, prevState) {
+          if (aborted) {
+            // opt out of additional logic if already aborted
+            return;
+          }
+          if (!view.state.selection.eq(prevState.selection) && !atTheBeginningOfDoc(view.state) && !isEmptyDocument(view.state.doc)) {
+            const activeInteraction = getActiveInteraction();
+            if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
+              abortAll('new_interaction', `selection-changed-on-editor-element`);
+            }
+            aborted = true;
+          }
+        }
+      };
     }
   });
 };

package/dist/es2019/ufoPlugin.js

@@ -1,3 +1,5 @@
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { traceUFOInteractionOnFirstInteraction } from './pm-plugins/traceUFOInteractionOnFirstInteraction';
 export const ufoPlugin = () => ({
   name: 'ufo',
   pmPlugins() {
@@ -7,16 +9,12 @@ export const ufoPlugin = () => ({
       // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
       return [];
     }
-
-    // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-    // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
+    if (expValEquals('platform_editor_abort_ufo_on_user_interaction', 'isEnabled', true)) {
+      return [{
+        name: 'traceUFOInteractionOnFirstInteraction',
+        plugin: traceUFOInteractionOnFirstInteraction
+      }];
+    }
     return [];
-
-    // return [
-    // 	{
-    // 		name: 'traceUFOInteractionOnFirstInteraction',
-    // 		plugin: traceUFOInteractionOnFirstInteraction,
-    // 	},
-    // ];
   }
 });

package/dist/esm/pm-plugins/traceUFOInteractionOnFirstInteraction.js

@@ -1,42 +1,26 @@
-/* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
-import traceUFOInteraction from '@atlaskit/react-ufo/trace-interaction';
+import { atTheBeginningOfDoc } from '@atlaskit/editor-common/selection';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils';
+import { abortAll, getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
 export var traceUFOInteractionOnFirstInteraction = function traceUFOInteractionOnFirstInteraction() {
-  var aborted = false;
-  function abortIfNotAborted(event) {
-    if (aborted) {
-      // opt out of additional logic if already aborted
-      return;
-    }
-    var activeInteraction = getActiveInteraction();
-    if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
-      traceUFOInteraction('new_interaction', event);
-    }
-    aborted = true;
-  }
   return new SafePlugin({
-    props: {
-      handleDOMEvents: {
-        mouseover: function mouseover(_view, event) {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-          abortIfNotAborted(event);
-        },
-        mouseenter: function mouseenter(_view, event) {
-          // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-          // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-          // If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-          // if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-
-          abortIfNotAborted(event);
-        },
-        mousedown: function mousedown(_view, event) {
-          return abortIfNotAborted(event);
+    view: function view() {
+      var aborted = false;
+      return {
+        update: function update(view, prevState) {
+          if (aborted) {
+            // opt out of additional logic if already aborted
+            return;
+          }
+          if (!view.state.selection.eq(prevState.selection) && !atTheBeginningOfDoc(view.state) && !isEmptyDocument(view.state.doc)) {
+            var activeInteraction = getActiveInteraction();
+            if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
+              abortAll('new_interaction', "selection-changed-on-editor-element");
+            }
+            aborted = true;
+          }
         }
-      }
+      };
     }
   });
 };

package/dist/esm/ufoPlugin.js

@@ -1,3 +1,5 @@
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { traceUFOInteractionOnFirstInteraction } from './pm-plugins/traceUFOInteractionOnFirstInteraction';
 export var ufoPlugin = function ufoPlugin() {
   return {
     name: 'ufo',
@@ -8,17 +10,13 @@ export var ufoPlugin = function ufoPlugin() {
         // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
         return [];
       }
-
-      // This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-      // This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
+      if (expValEquals('platform_editor_abort_ufo_on_user_interaction', 'isEnabled', true)) {
+        return [{
+          name: 'traceUFOInteractionOnFirstInteraction',
+          plugin: traceUFOInteractionOnFirstInteraction
+        }];
+      }
       return [];
-
-      // return [
-      // 	{
-      // 		name: 'traceUFOInteractionOnFirstInteraction',
-      // 		plugin: traceUFOInteractionOnFirstInteraction,
-      // 	},
-      // ];
     }
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-ufo",
-	"version": "7.0.1",
+	"version": "8.0.0",
 	"description": "Ufo plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,12 +28,13 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/editor-prosemirror": "^7.2.0",
-		"@atlaskit/react-ufo": "^5.0.0",
+		"@atlaskit/editor-prosemirror": "^7.3.0",
+		"@atlaskit/react-ufo": "^5.4.0",
+		"@atlaskit/tmp-editor-statsig": "^35.10.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.8.0",
+		"@atlaskit/editor-common": "^112.0.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {

package/src/pm-plugins/traceUFOInteractionOnFirstInteraction.ts

@@ -1,47 +1,38 @@
-/* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { atTheBeginningOfDoc } from '@atlaskit/editor-common/selection';
+import { isEmptyDocument } from '@atlaskit/editor-common/utils';
+import { type EditorState } from '@atlaskit/editor-prosemirror/state';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
-import { getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
-import traceUFOInteraction from '@atlaskit/react-ufo/trace-interaction';
+import { abortAll, getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
 
 export const traceUFOInteractionOnFirstInteraction = () => {
-	let aborted = false;
-
-	function abortIfNotAborted(event: Event) {
-		if (aborted) {
-			// opt out of additional logic if already aborted
-			return;
-		}
-
-		const activeInteraction = getActiveInteraction();
-
-		if (activeInteraction && ['edit-page', 'live-edit'].includes(activeInteraction.ufoName)) {
-			traceUFOInteraction('new_interaction', event);
-		}
-
-		aborted = true;
-	}
-
 	return new SafePlugin({
-		props: {
-			handleDOMEvents: {
-				mouseover: (_view: EditorView, event: Event) => {
-					// This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-					// This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-					// If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-					// if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
-					abortIfNotAborted(event);
-				},
-				mouseenter: (_view: EditorView, event: Event) => {
-					// This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-					// This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-					// If we did want to re-enable it, we would want to rollout with the ability to gate to specific events like below:
-					// if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) { return }
+		view() {
+			let aborted = false;
+			return {
+				update(view: EditorView, prevState: EditorState) {
+					if (aborted) {
+						// opt out of additional logic if already aborted
+						return;
+					}
+
+					if (
+						!view.state.selection.eq(prevState.selection) &&
+						!atTheBeginningOfDoc(view.state) &&
+						!isEmptyDocument(view.state.doc)
+					) {
+						const activeInteraction = getActiveInteraction();
 
-					abortIfNotAborted(event);
+						if (
+							activeInteraction &&
+							['edit-page', 'live-edit'].includes(activeInteraction.ufoName)
+						) {
+							abortAll('new_interaction', `selection-changed-on-editor-element`);
+						}
+						aborted = true;
+					}
 				},
-				mousedown: (_view: EditorView, event: Event) => abortIfNotAborted(event),
-			},
+			};
 		},
 	});
 };

package/src/ufoPlugin.tsx

@@ -1,3 +1,6 @@
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+
+import { traceUFOInteractionOnFirstInteraction } from './pm-plugins/traceUFOInteractionOnFirstInteraction';
 import type { UfoPlugin } from './ufoPluginType';
 
 export const ufoPlugin: UfoPlugin = () => ({
@@ -11,15 +14,15 @@ export const ufoPlugin: UfoPlugin = () => ({
 			return [];
 		}
 
-		// This Plugin is not currently used as it leads to too high a level of abortions (due to the current TTAI timing being long, and users starting click before TTAI completes).
-		// This can be reconsidered if we meaningfully reduce our TTAI (ie. <7 seconds)
-		return [];
+		if (expValEquals('platform_editor_abort_ufo_on_user_interaction', 'isEnabled', true)) {
+			return [
+				{
+					name: 'traceUFOInteractionOnFirstInteraction',
+					plugin: traceUFOInteractionOnFirstInteraction,
+				},
+			];
+		}
 
-		// return [
-		// 	{
-		// 		name: 'traceUFOInteractionOnFirstInteraction',
-		// 		plugin: traceUFOInteractionOnFirstInteraction,
-		// 	},
-		// ];
+		return [];
 	},
 });

package/tsconfig.app.json

@@ -39,6 +39,9 @@
 		},
 		{
 			"path": "../../react-ufo/atlaskit/tsconfig.app.json"
+		},
+		{
+			"path": "../tmp-editor-statsig/tsconfig.app.json"
 		}
 	]
 }

package/tsconfig.json

@@ -3,7 +3,5 @@
 	"include": [
 		"src/**/*.ts",
 		"src/**/*.tsx"
-	],
-	"compilerOptions": {
-	}
+	]
 }