@atlaskit/editor-common 121.0.0 → 121.1.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @atlaskit/editor-common
 
+## 121.1.0
+
+### Minor Changes
+
+- [`aec3fcfe13ff9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/aec3fcfe13ff9) -
+  EDITOR-8303 Add runtime input-latency trigger for limited mode behind
+  platform_editor_dynamic_limited_mode. Limited mode can now latch mid-session when sustained slow
+  input or repeated browser freezes indicate the device is struggling, in addition to the existing
+  document-size decision. The latch is one-way. Nothing is constructed when the experiment is off.
+
+  How much evidence is needed is a single tunable, `requiredConfirmations`: that many qualifying
+  windows, each separated from the last by `confirmationGapMs`. The hardware no longer feeds into
+  the decision — `navigator.hardwareConcurrency` and `navigator.deviceMemory` are reported with the
+  `limitedModeLatched` event instead, so which devices latch can be answered from the data rather
+  than assumed up front.
+
+  `LimitedModePluginState` gains a derived `enabled` flag, which is now the single thing consumers
+  should branch on — the individual reasons (`documentSizeBreachesThreshold`, `latchPolicyBreached`)
+  no longer need to be combined at each call site, so a future reason needs no change outside this
+  plugin. `sharedState.enabled` reads from it.
+
+  Under the experiment the document decision is also evaluated on load and on document replacement
+  only, rather than on every transaction that changes the document. That check walks the whole
+  document, so it was a full-document scan per keystroke on exactly the pages least able to afford
+  one. The trade-off is that a document editing its way past the thresholds is not re-judged until
+  it next loads.
+
+  Consumers updated to react to a mid-session change: table sticky headers now subscribe instead of
+  reading once at construction, block-controls resets rather than freezes its state on entry, and
+  the expand, media and table nodeviews read the derived flag so they no longer miss a runtime
+  latch.
+
 ## 121.0.0
 
 ### Major Changes

package/dist/cjs/analytics/types/enums.js

@@ -95,6 +95,7 @@ var ACTION = exports.ACTION = /*#__PURE__*/function (ACTION) {
   /** used in @atlassian/editor-referentiality */
   ACTION["GOT_CONNECTIONS"] = "gotConnections";
   ACTION["LANGUAGE_SELECTED"] = "languageSelected";
+  ACTION["LIMITED_MODE_LATCHED"] = "limitedModeLatched";
   ACTION["LANGUAGE_AUTO_DETECTED"] = "languageAutoDetected";
   ACTION["LIST_ITEM_JOINED"] = "listItemJoined";
   ACTION["MATCHED"] = "matched";

package/dist/cjs/analytics/types/general-events.js

@@ -26,4 +26,8 @@ var BROWSER_FREEZE_INTERACTION_TYPE = exports.BROWSER_FREEZE_INTERACTION_TYPE =
   BROWSER_FREEZE_INTERACTION_TYPE["CLICKING"] = "clicking";
   BROWSER_FREEZE_INTERACTION_TYPE["PASTING"] = "pasting";
   return BROWSER_FREEZE_INTERACTION_TYPE;
-}({});
+}({});
+/**
+ * Fired when the runtime performance detector decides the device is struggling badly enough to
+ * warrant limited mode.
+ */

package/dist/cjs/monitoring/error.js

@@ -27,7 +27,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.16.5";
+var packageVersion = "121.0.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/node-anchor/should-enable-limited-mode.js

@@ -20,16 +20,17 @@ var LEGACY_CONTENT_EXTENSION_KEY = 'legacy-content';
  * 2. the document contains a legacy-content macro (LCM)
  * 3. node count exceeds the node-count threshold
  *
- * The thresholds come from `getLimitedModeThresholds()`, which is where the
+ * Thresholds default to `getLimitedModeThresholds()` but can be passed in, which is how the
+ * limited-mode plugin's latch policy supplies them from its own config. That default is where the
  * `platform_editor_limited_threshold_tweaks` cohort is resolved — see
  * `limited-mode-document-thresholds.ts` for the values and the data behind them.
  *
  * Performance: doc size is checked first so an oversized document skips the traversal entirely.
  */
 var shouldEnableLimitedModeForDocument = exports.shouldEnableLimitedModeForDocument = function shouldEnableLimitedModeForDocument(doc) {
-  var _getLimitedModeThresh = (0, _limitedModeDocumentThresholds.getLimitedModeThresholds)(),
-    docSizeThreshold = _getLimitedModeThresh.docSizeThreshold,
-    nodeCountThreshold = _getLimitedModeThresh.nodeCountThreshold;
+  var thresholds = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : (0, _limitedModeDocumentThresholds.getLimitedModeThresholds)();
+  var docSizeThreshold = thresholds.docSizeThreshold,
+    nodeCountThreshold = thresholds.nodeCountThreshold;
   if (doc.nodeSize > docSizeThreshold) {
     return true;
   }

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.16.5";
+var packageVersion = "121.0.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/analytics/types/enums.js

@@ -91,6 +91,7 @@ export let ACTION = /*#__PURE__*/function (ACTION) {
   /** used in @atlassian/editor-referentiality */
   ACTION["GOT_CONNECTIONS"] = "gotConnections";
   ACTION["LANGUAGE_SELECTED"] = "languageSelected";
+  ACTION["LIMITED_MODE_LATCHED"] = "limitedModeLatched";
   ACTION["LANGUAGE_AUTO_DETECTED"] = "languageAutoDetected";
   ACTION["LIST_ITEM_JOINED"] = "listItemJoined";
   ACTION["MATCHED"] = "matched";

package/dist/es2019/analytics/types/general-events.js

@@ -26,4 +26,9 @@ export let BROWSER_FREEZE_INTERACTION_TYPE = /*#__PURE__*/function (BROWSER_FREE
   BROWSER_FREEZE_INTERACTION_TYPE["CLICKING"] = "clicking";
   BROWSER_FREEZE_INTERACTION_TYPE["PASTING"] = "pasting";
   return BROWSER_FREEZE_INTERACTION_TYPE;
-}({});
+}({});
+
+/**
+ * Fired when the runtime performance detector decides the device is struggling badly enough to
+ * warrant limited mode.
+ */

package/dist/es2019/monitoring/error.js

@@ -13,7 +13,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.16.5";
+const packageVersion = "121.0.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/node-anchor/should-enable-limited-mode.js

@@ -14,17 +14,18 @@ const LEGACY_CONTENT_EXTENSION_KEY = 'legacy-content';
  * 2. the document contains a legacy-content macro (LCM)
  * 3. node count exceeds the node-count threshold
  *
- * The thresholds come from `getLimitedModeThresholds()`, which is where the
+ * Thresholds default to `getLimitedModeThresholds()` but can be passed in, which is how the
+ * limited-mode plugin's latch policy supplies them from its own config. That default is where the
  * `platform_editor_limited_threshold_tweaks` cohort is resolved — see
  * `limited-mode-document-thresholds.ts` for the values and the data behind them.
  *
  * Performance: doc size is checked first so an oversized document skips the traversal entirely.
  */
-export const shouldEnableLimitedModeForDocument = doc => {
+export const shouldEnableLimitedModeForDocument = (doc, thresholds = getLimitedModeThresholds()) => {
   const {
     docSizeThreshold,
     nodeCountThreshold
-  } = getLimitedModeThresholds();
+  } = thresholds;
   if (doc.nodeSize > docSizeThreshold) {
     return true;
   }

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.16.5";
+const packageVersion = "121.0.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/analytics/types/enums.js

@@ -91,6 +91,7 @@ export var ACTION = /*#__PURE__*/function (ACTION) {
   /** used in @atlassian/editor-referentiality */
   ACTION["GOT_CONNECTIONS"] = "gotConnections";
   ACTION["LANGUAGE_SELECTED"] = "languageSelected";
+  ACTION["LIMITED_MODE_LATCHED"] = "limitedModeLatched";
   ACTION["LANGUAGE_AUTO_DETECTED"] = "languageAutoDetected";
   ACTION["LIST_ITEM_JOINED"] = "listItemJoined";
   ACTION["MATCHED"] = "matched";

package/dist/esm/analytics/types/general-events.js

@@ -26,4 +26,9 @@ export var BROWSER_FREEZE_INTERACTION_TYPE = /*#__PURE__*/function (BROWSER_FREE
   BROWSER_FREEZE_INTERACTION_TYPE["CLICKING"] = "clicking";
   BROWSER_FREEZE_INTERACTION_TYPE["PASTING"] = "pasting";
   return BROWSER_FREEZE_INTERACTION_TYPE;
-}({});
+}({});
+
+/**
+ * Fired when the runtime performance detector decides the device is struggling badly enough to
+ * warrant limited mode.
+ */

package/dist/esm/monitoring/error.js

@@ -19,7 +19,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.16.5";
+var packageVersion = "121.0.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/node-anchor/should-enable-limited-mode.js

@@ -14,16 +14,17 @@ var LEGACY_CONTENT_EXTENSION_KEY = 'legacy-content';
  * 2. the document contains a legacy-content macro (LCM)
  * 3. node count exceeds the node-count threshold
  *
- * The thresholds come from `getLimitedModeThresholds()`, which is where the
+ * Thresholds default to `getLimitedModeThresholds()` but can be passed in, which is how the
+ * limited-mode plugin's latch policy supplies them from its own config. That default is where the
  * `platform_editor_limited_threshold_tweaks` cohort is resolved — see
  * `limited-mode-document-thresholds.ts` for the values and the data behind them.
  *
  * Performance: doc size is checked first so an oversized document skips the traversal entirely.
  */
 export var shouldEnableLimitedModeForDocument = function shouldEnableLimitedModeForDocument(doc) {
-  var _getLimitedModeThresh = getLimitedModeThresholds(),
-    docSizeThreshold = _getLimitedModeThresh.docSizeThreshold,
-    nodeCountThreshold = _getLimitedModeThresh.nodeCountThreshold;
+  var thresholds = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : getLimitedModeThresholds();
+  var docSizeThreshold = thresholds.docSizeThreshold,
+    nodeCountThreshold = thresholds.nodeCountThreshold;
   if (doc.nodeSize > docSizeThreshold) {
     return true;
   }

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.16.5";
+var packageVersion = "121.0.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/analytics/types/enums.d.ts

@@ -88,6 +88,7 @@ export declare enum ACTION {
     /** used in @atlassian/editor-referentiality */
     GOT_CONNECTIONS = "gotConnections",
     LANGUAGE_SELECTED = "languageSelected",
+    LIMITED_MODE_LATCHED = "limitedModeLatched",
     LANGUAGE_AUTO_DETECTED = "languageAutoDetected",
     LIST_ITEM_JOINED = "listItemJoined",
     MATCHED = "matched",

package/dist/types/analytics/types/general-events.d.ts

@@ -71,6 +71,50 @@ type SlowInputAEP = OperationalAEPWithObjectId<ACTION.SLOW_INPUT, ACTION_SUBJECT
     nodeSize: number;
     time: number;
 }>;
+/**
+ * Fired when the runtime performance detector decides the device is struggling badly enough to
+ * warrant limited mode.
+ */
+type LimitedModeLatchedAEP = OperationalAEPWithObjectId<ACTION.LIMITED_MODE_LATCHED, ACTION_SUBJECT.EDITOR, undefined, {
+    /**
+     * `navigator.deviceMemory` in GB. Reported for correlation only — the hardware does not feed
+     * into the decision. Absent outside Chromium, which does not expose the hint.
+     */
+    deviceMemoryGb?: number;
+    /** Whether the document was already breaching its thresholds when the runtime bar was met. */
+    documentAlreadyBreached: boolean;
+    /** Which criterion closed the first qualifying window. */
+    firstWindowReason: string;
+    /** `navigator.hardwareConcurrency`, i.e. logical cores. Reported for correlation only. */
+    hardwareConcurrency?: number;
+    /** Whether limited mode was actually applied, i.e. whether the session is in the treatment. */
+    latched: boolean;
+    /** Median of the closing keystroke window, present only when `reason` is `inputLatency`. */
+    latencyMedianMs?: number;
+    /**
+     * Elapsed time from the first qualifying window to the latch, spanning every confirmation gap
+     * that was waited out. `0` when a single window latched.
+     */
+    msFromFirstWindow?: number;
+    nodeSize: number;
+    /**
+     * Which criterion closed the window that latched — `inputLatency`, `freeze` or `forced`.
+     * Together with `firstWindowReason` this shows whether one signal latched on its own or two
+     * different ones agreed.
+     */
+    reason: string;
+    /** How many qualifying windows this session required, i.e. the bar that was met. */
+    requiredConfirmations: number;
+    /** Milliseconds from the detector starting to the bar being met. */
+    timeToLatch: number;
+    /**
+     * Cumulative counts for the whole session, never reset by a qualifying window — so these show
+     * how much evidence accrued overall, not just in the window that happened to close.
+     */
+    totalFreezes: number;
+    totalInputSamples: number;
+    totalSlowInputs: number;
+}>;
 type InputPerfSamplingAEP = OperationalAEPWithObjectId<ACTION.INPUT_PERF_SAMPLING, ACTION_SUBJECT.EDITOR, undefined, {
     nodeCount?: Record<string, number>;
     nodeSize: number;
@@ -267,5 +311,5 @@ type ChangeToneMenuItemClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.TOOLBAR
 type TranslateMenuItemClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.TOOLBAR_DROPDOWN_MENU_ITEM, ACTION_SUBJECT_ID.AI_TRANSLATE, {
     inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.FLOATING_TB;
 }>;
-export type GeneralEventPayload<T = void> = AnnotateButtonAEP | AnnotationAEP | AnnotationErrorAEP | BrowserFreezePayload | ButtonFeedbackAEP | ButtonHelpAEP | ButtonUploadMediaAEP | ColorPickerAEP | EditorPerfAEP | EditorRenderedAEP<T> | EditorStartAEP | EditorStopAEP | ExpandToggleAEP | FeedbackAEP | FullWidthModeAEP | HelpQuickInsertAEP | InputPerfSamplingAEP | InputPerfSamplingAvgAEP | PickerEmojiAEP | PickerImageAEP | PickerMediaInsertAEP | PickerMediaInsertTabViewedAEP | PickerMediaInsertImageGenerationSubmittedAEP | PickerMediaInsertClosedAEP | PickerMediaInsertCancelledAEP | ReactNodeViewRenderedAEP | RichMediaLayoutAEP | SelectionAEP | SlowInputAEP | TransactionMutatedAEP | UploadExternalFailedAEP | WithPluginStateCalledAEP | CodeBlockLanguageAutoDetectedAEP | CodeBlockLanguageSelectedAEP | CodeBlockFormatCodeSuccessAEP | CodeBlockFormatCodeFailedAEP | EditorContentRetrievalPerformedAEP | MediaLinkTransformedAEP | TextLinkCodeMarkTransformedAEP | DedupeMarksTransformedAEP | IndentationMarksTransformedAEP | NodesMissingContentTransformedAEP | InvalidProsemirrorDocumentErrorAEP | DocumentProcessingErrorAEP | InvalidMediaContentTransformedAEP | HeadingAnchorLinkButtonAEP | CollabStepsTrackerPayloadAEP | CollabOrganicChangesTrackerPayloadAEP | BlocksDragInitAEP | CodeBlockFoldingToggleAEP | CodeBlockWordWrapToggleAEP | CodeBlockLineNumbersToggleAEP | RequestToEditAEP | SingleColumLayoutDetectedAEP | CopyLinkToAnchorButtonAEP | DockedPrimaryToolbarRenderedAEP | RovoMoreOptionsClickedAEP | AskRovoButtonClickedAEP | SmartLinkRovoButtonClickedAEP | SmartLinkSummarizeButtonClickedAEP | AIRemixButtonClickedAEP | ChangeToneMenuItemClickedAEP | TranslateMenuItemClickedAEP | MediaSingleWidthTransformedAEP;
+export type GeneralEventPayload<T = void> = AnnotateButtonAEP | AnnotationAEP | AnnotationErrorAEP | BrowserFreezePayload | ButtonFeedbackAEP | ButtonHelpAEP | ButtonUploadMediaAEP | ColorPickerAEP | EditorPerfAEP | EditorRenderedAEP<T> | EditorStartAEP | EditorStopAEP | ExpandToggleAEP | FeedbackAEP | FullWidthModeAEP | HelpQuickInsertAEP | InputPerfSamplingAEP | InputPerfSamplingAvgAEP | LimitedModeLatchedAEP | PickerEmojiAEP | PickerImageAEP | PickerMediaInsertAEP | PickerMediaInsertTabViewedAEP | PickerMediaInsertImageGenerationSubmittedAEP | PickerMediaInsertClosedAEP | PickerMediaInsertCancelledAEP | ReactNodeViewRenderedAEP | RichMediaLayoutAEP | SelectionAEP | SlowInputAEP | TransactionMutatedAEP | UploadExternalFailedAEP | WithPluginStateCalledAEP | CodeBlockLanguageAutoDetectedAEP | CodeBlockLanguageSelectedAEP | CodeBlockFormatCodeSuccessAEP | CodeBlockFormatCodeFailedAEP | EditorContentRetrievalPerformedAEP | MediaLinkTransformedAEP | TextLinkCodeMarkTransformedAEP | DedupeMarksTransformedAEP | IndentationMarksTransformedAEP | NodesMissingContentTransformedAEP | InvalidProsemirrorDocumentErrorAEP | DocumentProcessingErrorAEP | InvalidMediaContentTransformedAEP | HeadingAnchorLinkButtonAEP | CollabStepsTrackerPayloadAEP | CollabOrganicChangesTrackerPayloadAEP | BlocksDragInitAEP | CodeBlockFoldingToggleAEP | CodeBlockWordWrapToggleAEP | CodeBlockLineNumbersToggleAEP | RequestToEditAEP | SingleColumLayoutDetectedAEP | CopyLinkToAnchorButtonAEP | DockedPrimaryToolbarRenderedAEP | RovoMoreOptionsClickedAEP | AskRovoButtonClickedAEP | SmartLinkRovoButtonClickedAEP | SmartLinkSummarizeButtonClickedAEP | AIRemixButtonClickedAEP | ChangeToneMenuItemClickedAEP | TranslateMenuItemClickedAEP | MediaSingleWidthTransformedAEP;
 export {};

package/dist/types/node-anchor/should-enable-limited-mode.d.ts

@@ -1,4 +1,5 @@
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { LimitedModeThresholds } from './limited-mode-document-thresholds';
 /**
  * Single source of truth for the limited (performance) mode decision.
  *
@@ -12,10 +13,11 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
  * 2. the document contains a legacy-content macro (LCM)
  * 3. node count exceeds the node-count threshold
  *
- * The thresholds come from `getLimitedModeThresholds()`, which is where the
+ * Thresholds default to `getLimitedModeThresholds()` but can be passed in, which is how the
+ * limited-mode plugin's latch policy supplies them from its own config. That default is where the
  * `platform_editor_limited_threshold_tweaks` cohort is resolved — see
  * `limited-mode-document-thresholds.ts` for the values and the data behind them.
  *
  * Performance: doc size is checked first so an oversized document skips the traversal entirely.
  */
-export declare const shouldEnableLimitedModeForDocument: (doc: PMNode) => boolean;
+export declare const shouldEnableLimitedModeForDocument: (doc: PMNode, thresholds?: LimitedModeThresholds) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "121.0.0",
+	"version": "121.1.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"