@atlaskit/editor-common 120.6.2 → 120.7.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @atlaskit/editor-common
 
+## 120.7.0
+
+### Minor Changes
+
+- [`d6fdb2e0f375c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d6fdb2e0f375c) -
+  Make `limitedModePlugin` the single source of truth for whether limited (performance) mode is on.
+
+  `NodeAnchorProvider` used to run the document-size / node-count / legacy-content-macro heuristic
+  itself, ignoring the plugin. Since the plugin is optional, removing it from a preset — or setting
+  `killSwitchEnabled: true` — did not actually disable limited mode: node anchors were still
+  suppressed, so no `data-node-anchor` attributes were written and block controls lost its drag
+  handles entirely.
+
+  Behind the `platform_editor_fix_limited_mode_leaking` feature gate, `getNodeIdProvider` now reads
+  the limited-mode plugin's state instead. No public API changes: `limitedModePluginKey` stays owned
+  by and exported from `@atlaskit/editor-plugin-limited-mode`, and `editor-common` reads the
+  plugin's state off `EditorState` by property name so it does not have to depend on a plugin
+  package. With the gate off the old document heuristic runs unchanged.
+
+  **Behaviour change once the gate is on.** With the plugin absent, limited mode is off: presets
+  that do not register it, and any product setting `killSwitchEnabled: true`, lose limited mode's
+  protection on very large documents and on documents containing a legacy content macro. Presets
+  that do register the plugin are unaffected.
+
+  `NodeAnchorProvider`'s limited-mode flag remains one-way — `documentSizeBreachesThreshold` can
+  return to `false` on a `replaceDocument` transaction, but the provider stays latched on, because
+  recovering would require re-rendering every nodeview to restore its anchor attribute.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 120.6.2
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -28,7 +28,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "120.6.1";
+var packageVersion = "120.6.2";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/node-anchor/node-anchor-provider.js

@@ -8,9 +8,26 @@ exports.getNodeIdProvider = exports.NodeAnchorProvider = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _utils = require("../utils");
 var _dynamicBitArray = require("./dynamic-bit-array");
 var _shouldEnableLimitedMode = require("./should-enable-limited-mode");
+// The slice of `@atlaskit/editor-plugin-limited-mode`'s state read below. Declared
+// structurally because `editor-common` must not depend on a plugin package.
+
+// The real key stays in `@atlaskit/editor-plugin-limited-mode`; importing it would make
+// `editor-common` depend on a plugin package, so match the state property by name.
+// `'limitedModePlugin$'` is what ProseMirror derives for `new PluginKey('limitedModePlugin')`,
+// and editor-plugin-limited-mode-tests asserts that literal to catch it shifting to `$1`.
+// Please, do not copy or use this kind of code below
+// @ts-ignore
+var limitedModePluginKey = {
+  key: 'limitedModePlugin$',
+  getState: function getState(state) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['limitedModePlugin$'];
+  }
+};
 var NodeAnchorProvider = exports.NodeAnchorProvider = /*#__PURE__*/function () {
   function NodeAnchorProvider() {
     var limitedMode = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
@@ -81,6 +98,9 @@ var NodeAnchorProvider = exports.NodeAnchorProvider = /*#__PURE__*/function () {
     // After set to limited mode, we clear the cache to free up memory
     // and prevent further ids from being generated
     // Once in limited mode, we won't exit it
+    //
+    // One-way by design, so this can stay latched on after the plugin flips back to
+    // off: recovering would mean re-rendering every nodeview to restore its anchor.
   }, {
     key: "setLimitedMode",
     value: function setLimitedMode() {
@@ -94,12 +114,16 @@ var NodeAnchorProvider = exports.NodeAnchorProvider = /*#__PURE__*/function () {
 var nodeIdProviderMap = new WeakMap();
 
 /**
- * Determines whether limited mode should be enabled for the given editor view.
- * Delegates to the shared decision in `should-enable-limited-mode.ts` so the provider and the
- * limited-mode plugin can never drift.
+ * Reads the limited-mode plugin's state and nothing else, so a preset without the plugin no longer
+ * gets anchor suppression (and with it, no drag handles). No plugin means limited mode is off.
+ *
+ * Read off the state rather than the plugin injection API because plugin `state.init` is the only
+ * thing that has run by the time the `EditorView` constructor builds its first nodeview and calls
+ * `getNodeIdProvider`. Plugin views and `usePluginHook` both run later.
  */
 var isLimitedModeEnabled = function isLimitedModeEnabled(editorView) {
-  return (0, _shouldEnableLimitedMode.shouldEnableLimitedModeForDocument)(editorView.state.doc);
+  var _limitedModePluginKey, _limitedModePluginKey2;
+  return (0, _fg.fg)('platform_editor_fix_limited_mode_leaking') ? (_limitedModePluginKey = (_limitedModePluginKey2 = limitedModePluginKey.getState(editorView.state)) === null || _limitedModePluginKey2 === void 0 ? void 0 : _limitedModePluginKey2.documentSizeBreachesThreshold) !== null && _limitedModePluginKey !== void 0 ? _limitedModePluginKey : false : (0, _shouldEnableLimitedMode.shouldEnableLimitedModeForDocument)(editorView.state.doc);
 };
 
 // Get the NodeIdProvider for a specific EditorView instance.
@@ -107,8 +131,6 @@ var isLimitedModeEnabled = function isLimitedModeEnabled(editorView) {
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
 var getNodeIdProvider = exports.getNodeIdProvider = function getNodeIdProvider(editorView) {
   if (!nodeIdProviderMap.has(editorView)) {
-    // if the limited mode flag is on, enable limited mode based on the threshold
-    // only for the first time
     var limitedMode = isLimitedModeEnabled(editorView);
     var isEmptyDoc = (0, _utils.isEmptyDocument)(editorView.state.doc);
     var provider = new NodeAnchorProvider(limitedMode, isEmptyDoc);

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "120.6.1";
+var packageVersion = "120.6.2";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/monitoring/error.js

@@ -14,7 +14,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "120.6.1";
+const packageVersion = "120.6.2";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/node-anchor/node-anchor-provider.js

@@ -1,7 +1,25 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { isEmptyDocument } from '../utils';
 import { DynamicBitArray } from './dynamic-bit-array';
 import { shouldEnableLimitedModeForDocument } from './should-enable-limited-mode';
+
+// The slice of `@atlaskit/editor-plugin-limited-mode`'s state read below. Declared
+// structurally because `editor-common` must not depend on a plugin package.
+
+// The real key stays in `@atlaskit/editor-plugin-limited-mode`; importing it would make
+// `editor-common` depend on a plugin package, so match the state property by name.
+// `'limitedModePlugin$'` is what ProseMirror derives for `new PluginKey('limitedModePlugin')`,
+// and editor-plugin-limited-mode-tests asserts that literal to catch it shifting to `$1`.
+// Please, do not copy or use this kind of code below
+// @ts-ignore
+const limitedModePluginKey = {
+  key: 'limitedModePlugin$',
+  getState: state => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['limitedModePlugin$'];
+  }
+};
 export class NodeAnchorProvider {
   constructor(limitedMode = false, emptyDoc = false) {
     _defineProperty(this, "cache", new WeakMap());
@@ -57,6 +75,9 @@ export class NodeAnchorProvider {
   // After set to limited mode, we clear the cache to free up memory
   // and prevent further ids from being generated
   // Once in limited mode, we won't exit it
+  //
+  // One-way by design, so this can stay latched on after the plugin flips back to
+  // off: recovering would mean re-rendering every nodeview to restore its anchor.
   setLimitedMode() {
     this.limitedMode = true;
     this.cache = new WeakMap();
@@ -67,19 +88,23 @@ export class NodeAnchorProvider {
 const nodeIdProviderMap = new WeakMap();
 
 /**
- * Determines whether limited mode should be enabled for the given editor view.
- * Delegates to the shared decision in `should-enable-limited-mode.ts` so the provider and the
- * limited-mode plugin can never drift.
+ * Reads the limited-mode plugin's state and nothing else, so a preset without the plugin no longer
+ * gets anchor suppression (and with it, no drag handles). No plugin means limited mode is off.
+ *
+ * Read off the state rather than the plugin injection API because plugin `state.init` is the only
+ * thing that has run by the time the `EditorView` constructor builds its first nodeview and calls
+ * `getNodeIdProvider`. Plugin views and `usePluginHook` both run later.
  */
-const isLimitedModeEnabled = editorView => shouldEnableLimitedModeForDocument(editorView.state.doc);
+const isLimitedModeEnabled = editorView => {
+  var _limitedModePluginKey, _limitedModePluginKey2;
+  return fg('platform_editor_fix_limited_mode_leaking') ? (_limitedModePluginKey = (_limitedModePluginKey2 = limitedModePluginKey.getState(editorView.state)) === null || _limitedModePluginKey2 === void 0 ? void 0 : _limitedModePluginKey2.documentSizeBreachesThreshold) !== null && _limitedModePluginKey !== void 0 ? _limitedModePluginKey : false : shouldEnableLimitedModeForDocument(editorView.state.doc);
+};
 
 // Get the NodeIdProvider for a specific EditorView instance.
 // This allows access to the node ids anywhere.
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
 export const getNodeIdProvider = editorView => {
   if (!nodeIdProviderMap.has(editorView)) {
-    // if the limited mode flag is on, enable limited mode based on the threshold
-    // only for the first time
     const limitedMode = isLimitedModeEnabled(editorView);
     const isEmptyDoc = isEmptyDocument(editorView.state.doc);
     const provider = new NodeAnchorProvider(limitedMode, isEmptyDoc);

package/dist/es2019/ui/DropList/index.js

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "120.6.1";
+const packageVersion = "120.6.2";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/monitoring/error.js

@@ -20,7 +20,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "120.6.1";
+var packageVersion = "120.6.2";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/node-anchor/node-anchor-provider.js

@@ -1,9 +1,27 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { isEmptyDocument } from '../utils';
 import { DynamicBitArray } from './dynamic-bit-array';
 import { shouldEnableLimitedModeForDocument } from './should-enable-limited-mode';
+
+// The slice of `@atlaskit/editor-plugin-limited-mode`'s state read below. Declared
+// structurally because `editor-common` must not depend on a plugin package.
+
+// The real key stays in `@atlaskit/editor-plugin-limited-mode`; importing it would make
+// `editor-common` depend on a plugin package, so match the state property by name.
+// `'limitedModePlugin$'` is what ProseMirror derives for `new PluginKey('limitedModePlugin')`,
+// and editor-plugin-limited-mode-tests asserts that literal to catch it shifting to `$1`.
+// Please, do not copy or use this kind of code below
+// @ts-ignore
+var limitedModePluginKey = {
+  key: 'limitedModePlugin$',
+  getState: function getState(state) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['limitedModePlugin$'];
+  }
+};
 export var NodeAnchorProvider = /*#__PURE__*/function () {
   function NodeAnchorProvider() {
     var limitedMode = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
@@ -74,6 +92,9 @@ export var NodeAnchorProvider = /*#__PURE__*/function () {
     // After set to limited mode, we clear the cache to free up memory
     // and prevent further ids from being generated
     // Once in limited mode, we won't exit it
+    //
+    // One-way by design, so this can stay latched on after the plugin flips back to
+    // off: recovering would mean re-rendering every nodeview to restore its anchor.
   }, {
     key: "setLimitedMode",
     value: function setLimitedMode() {
@@ -87,12 +108,16 @@ export var NodeAnchorProvider = /*#__PURE__*/function () {
 var nodeIdProviderMap = new WeakMap();
 
 /**
- * Determines whether limited mode should be enabled for the given editor view.
- * Delegates to the shared decision in `should-enable-limited-mode.ts` so the provider and the
- * limited-mode plugin can never drift.
+ * Reads the limited-mode plugin's state and nothing else, so a preset without the plugin no longer
+ * gets anchor suppression (and with it, no drag handles). No plugin means limited mode is off.
+ *
+ * Read off the state rather than the plugin injection API because plugin `state.init` is the only
+ * thing that has run by the time the `EditorView` constructor builds its first nodeview and calls
+ * `getNodeIdProvider`. Plugin views and `usePluginHook` both run later.
  */
 var isLimitedModeEnabled = function isLimitedModeEnabled(editorView) {
-  return shouldEnableLimitedModeForDocument(editorView.state.doc);
+  var _limitedModePluginKey, _limitedModePluginKey2;
+  return fg('platform_editor_fix_limited_mode_leaking') ? (_limitedModePluginKey = (_limitedModePluginKey2 = limitedModePluginKey.getState(editorView.state)) === null || _limitedModePluginKey2 === void 0 ? void 0 : _limitedModePluginKey2.documentSizeBreachesThreshold) !== null && _limitedModePluginKey !== void 0 ? _limitedModePluginKey : false : shouldEnableLimitedModeForDocument(editorView.state.doc);
 };
 
 // Get the NodeIdProvider for a specific EditorView instance.
@@ -100,8 +125,6 @@ var isLimitedModeEnabled = function isLimitedModeEnabled(editorView) {
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
 export var getNodeIdProvider = function getNodeIdProvider(editorView) {
   if (!nodeIdProviderMap.has(editorView)) {
-    // if the limited mode flag is on, enable limited mode based on the threshold
-    // only for the first time
     var limitedMode = isLimitedModeEnabled(editorView);
     var isEmptyDoc = isEmptyDocument(editorView.state.doc);
     var provider = new NodeAnchorProvider(limitedMode, isEmptyDoc);

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "120.6.1";
+var packageVersion = "120.6.2";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "120.6.2",
+	"version": "120.7.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -84,8 +84,8 @@
 		"@atlaskit/task-decision": "^21.8.0",
 		"@atlaskit/teams-app-config": "^3.0.0",
 		"@atlaskit/textfield": "^10.1.0",
-		"@atlaskit/tmp-editor-statsig": "^166.0.0",
-		"@atlaskit/tokens": "^16.8.0",
+		"@atlaskit/tmp-editor-statsig": "^167.0.0",
+		"@atlaskit/tokens": "^16.9.0",
 		"@atlaskit/tooltip": "^24.2.0",
 		"@atlaskit/width-detector": "^7.1.0",
 		"@babel/runtime": "^7.0.0",
@@ -208,6 +208,9 @@
 		"platform_editor_inline_node_virt_threshold_override": {
 			"type": "boolean"
 		},
+		"platform_editor_fix_limited_mode_leaking": {
+			"type": "boolean"
+		},
 		"confluence-issue-terminology-refresh": {
 			"type": "boolean"
 		},