@atlaskit/editor-plugin-ufo 3.0.0 → 3.1.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-ufo
 
+## 3.1.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.1.0
+
+### Minor Changes
+
+- [#183937](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/183937)
+  [`5826fd37730ab`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5826fd37730ab) -
+  Triggers traceUFOInteraction on first editor interaction to avoid vc90 blindspots
+
 ## 3.0.0
 
 ### Major Changes

package/afm-cc/tsconfig.json

@@ -23,6 +23,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

@@ -23,6 +23,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-post-office/tsconfig.json

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

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

@@ -0,0 +1,48 @@
+"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 _interactionMetrics = require("@atlaskit/react-ufo/interaction-metrics");
+var _traceInteraction = _interopRequireDefault(require("@atlaskit/react-ufo/trace-interaction"));
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
+/* 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) {
+          if ((0, _expValEquals.expValEquals)('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mouseenter: function mouseenter(_view, event) {
+          if ((0, _expValEquals.expValEquals)('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mousedown: function mousedown(_view, event) {
+          return abortIfNotAborted(event);
+        }
+      }
+    }
+  });
+};

package/dist/cjs/ufoPlugin.js

@@ -4,23 +4,25 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.ufoPlugin = void 0;
-// import { abortUFOMeasurementOnFirstUserInteraction } from './pm-plugins/abortUFOMeasurementOnFirstUserInteraction';
-
+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',
     pmPlugins: function pmPlugins() {
-      return [];
-
-      // This experimental plugin has been abandoned as per ED-27989
-      /*
-      return [
-      	{
-      		name: 'abortUFOMeasurementOnFirstUserInteraction',
-      		plugin: abortUFOMeasurementOnFirstUserInteraction,
-      	},
-      ];
-      */
+      var _process;
+      var isSSR = Boolean((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.REACT_SSR);
+      if (isSSR) {
+        // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
+        return [];
+      }
+      if ((0, _expValEquals.expValEquals)('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'control')) {
+        return [];
+      }
+      return [{
+        name: 'traceUFOInteractionOnFirstInteraction',
+        plugin: _traceUFOInteractionOnFirstInteraction.traceUFOInteractionOnFirstInteraction
+      }];
     }
   };
 };

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

@@ -0,0 +1,38 @@
+/* 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 { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+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) => {
+          if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mouseenter: (_view, event) => {
+          if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mousedown: (_view, event) => abortIfNotAborted(event)
+      }
+    }
+  });
+};

package/dist/es2019/ufoPlugin.js

@@ -1,18 +1,20 @@
-// import { abortUFOMeasurementOnFirstUserInteraction } from './pm-plugins/abortUFOMeasurementOnFirstUserInteraction';
-
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { traceUFOInteractionOnFirstInteraction } from './pm-plugins/traceUFOInteractionOnFirstInteraction';
 export const ufoPlugin = () => ({
   name: 'ufo',
   pmPlugins() {
-    return [];
-
-    // This experimental plugin has been abandoned as per ED-27989
-    /*
-    return [
-    	{
-    		name: 'abortUFOMeasurementOnFirstUserInteraction',
-    		plugin: abortUFOMeasurementOnFirstUserInteraction,
-    	},
-    ];
-    */
+    var _process, _process$env;
+    const isSSR = Boolean((_process = process) === null || _process === void 0 ? void 0 : (_process$env = _process.env) === null || _process$env === void 0 ? void 0 : _process$env.REACT_SSR);
+    if (isSSR) {
+      // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
+      return [];
+    }
+    if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'control')) {
+      return [];
+    }
+    return [{
+      name: 'traceUFOInteractionOnFirstInteraction',
+      plugin: traceUFOInteractionOnFirstInteraction
+    }];
   }
 });

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

@@ -0,0 +1,40 @@
+/* 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 { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+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) {
+          if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mouseenter: function mouseenter(_view, event) {
+          if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'only_mousedown_event')) {
+            return;
+          }
+          abortIfNotAborted(event);
+        },
+        mousedown: function mousedown(_view, event) {
+          return abortIfNotAborted(event);
+        }
+      }
+    }
+  });
+};

package/dist/esm/ufoPlugin.js

@@ -1,20 +1,22 @@
-// import { abortUFOMeasurementOnFirstUserInteraction } from './pm-plugins/abortUFOMeasurementOnFirstUserInteraction';
-
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { traceUFOInteractionOnFirstInteraction } from './pm-plugins/traceUFOInteractionOnFirstInteraction';
 export var ufoPlugin = function ufoPlugin() {
   return {
     name: 'ufo',
     pmPlugins: function pmPlugins() {
-      return [];
-
-      // This experimental plugin has been abandoned as per ED-27989
-      /*
-      return [
-      	{
-      		name: 'abortUFOMeasurementOnFirstUserInteraction',
-      		plugin: abortUFOMeasurementOnFirstUserInteraction,
-      	},
-      ];
-      */
+      var _process;
+      var isSSR = Boolean((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.REACT_SSR);
+      if (isSSR) {
+        // This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
+        return [];
+      }
+      if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'control')) {
+        return [];
+      }
+      return [{
+        name: 'traceUFOInteractionOnFirstInteraction',
+        plugin: traceUFOInteractionOnFirstInteraction
+      }];
     }
   };
 };

package/dist/types/pm-plugins/traceUFOInteractionOnFirstInteraction.d.ts

@@ -0,0 +1,2 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export declare const traceUFOInteractionOnFirstInteraction: () => SafePlugin<any>;

package/dist/types-ts4.5/pm-plugins/traceUFOInteractionOnFirstInteraction.d.ts

@@ -0,0 +1,2 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export declare const traceUFOInteractionOnFirstInteraction: () => SafePlugin<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-ufo",
-	"version": "3.0.0",
+	"version": "3.1.1",
 	"description": "Ufo plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,11 +33,12 @@
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/react-ufo": "^3.14.0",
+		"@atlaskit/react-ufo": "^4.0.0",
+		"@atlaskit/tmp-editor-statsig": "^9.6.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.6.0",
+		"@atlaskit/editor-common": "^107.8.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -78,6 +79,5 @@
 				"import-no-extraneous-disable-for-examples-and-docs"
 			]
 		}
-	},
-	"platform-feature-flags": {}
+	}
 }

package/src/pm-plugins/traceUFOInteractionOnFirstInteraction.ts

@@ -0,0 +1,59 @@
+/* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+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 { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+
+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) => {
+					if (
+						expValEquals(
+							'cc_editor_interactions_trigger_traceufointeraction',
+							'cohort',
+							'only_mousedown_event',
+						)
+					) {
+						return;
+					}
+
+					abortIfNotAborted(event);
+				},
+				mouseenter: (_view: EditorView, event: Event) => {
+					if (
+						expValEquals(
+							'cc_editor_interactions_trigger_traceufointeraction',
+							'cohort',
+							'only_mousedown_event',
+						)
+					) {
+						return;
+					}
+
+					abortIfNotAborted(event);
+				},
+				mousedown: (_view: EditorView, event: Event) => abortIfNotAborted(event),
+			},
+		},
+	});
+};

package/src/ufoPlugin.tsx

@@ -1,20 +1,28 @@
-// import { abortUFOMeasurementOnFirstUserInteraction } from './pm-plugins/abortUFOMeasurementOnFirstUserInteraction';
+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 = () => ({
 	name: 'ufo',
 
 	pmPlugins() {
-		return [];
+		const isSSR = Boolean(process?.env?.REACT_SSR);
+
+		if (isSSR) {
+			// This plugin is not needed in SSR environments - and uses apis which are not available in SSR internally
+			return [];
+		}
+
+		if (expValEquals('cc_editor_interactions_trigger_traceufointeraction', 'cohort', 'control')) {
+			return [];
+		}
 
-		// This experimental plugin has been abandoned as per ED-27989
-		/*
 		return [
 			{
-				name: 'abortUFOMeasurementOnFirstUserInteraction',
-				plugin: abortUFOMeasurementOnFirstUserInteraction,
+				name: 'traceUFOInteractionOnFirstInteraction',
+				plugin: traceUFOInteractionOnFirstInteraction,
 			},
 		];
-		*/
 	},
 });

package/tsconfig.app.json

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