@atlaskit/editor-core 223.1.2 → 223.1.3

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-core
 
+## 223.1.3
+
+### Patch Changes
+
+- [`60bbe3aea8c6e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/60bbe3aea8c6e) -
+  Register the page editor view's dom with insm so the insm measured event can report editorDomSize.
+  Secondary editors on the page (comment, chromeless, and editors nested inside a legacy content
+  extension) do not register. Behind the platform_editor_insm_dom_node_count experiment.
+- Updated dependencies
+
 ## 223.1.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -83,6 +83,9 @@
 		{
 			"path": "../../../design-system/icon/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../insm/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../../design-system/link/afm-cc/tsconfig.json"
 		},

package/dist/cjs/create-editor/ReactEditorView.js

@@ -35,6 +35,7 @@ var _view = require("@atlaskit/editor-prosemirror/view");
 var _editorSsrRenderer = require("@atlaskit/editor-ssr-renderer");
 var _createSsrEditorState = require("@atlaskit/editor-ssr-renderer/create-ssr-editor-state");
 var _createSsrPmPlugins = require("@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins");
+var _api = require("@atlaskit/insm/api");
 var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _customData = require("@atlaskit/react-ufo/custom-data");
@@ -950,6 +951,29 @@ function ReactEditorView(props) {
     }
   }, [createEditorView, onEditorCreated, eventDispatcher, onEditorDestroyed, handleAnalyticsEvent, mitigateScrollJump]);
   var isPageAppearance = (0, _isFullPage.isFullPage)(nextAppearance) || nextAppearance === 'max';
+
+  // insm measures a page, so only the page's own editor reports its dom size -- not a
+  // secondary editor such as a comment editor, or one nested inside a legacy content
+  // extension. This runs as an effect rather than from handleEditorViewRef because
+  // `isNestedEditor` is only resolved once `editorRef` is attached, which happens after
+  // the mount node's ref callback.
+  (0, _react.useEffect)(function () {
+    if (!editorView || isNestedEditor.current || !isPageAppearance) {
+      return;
+    }
+    if (!(0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_insm_dom_node_count')) {
+      return;
+    }
+
+    // insm has no reference to the editor, so the element it measures for `editorDomSize`
+    // on session events is provided here. It's captured rather than read again on cleanup,
+    // as the view is destroyed by then.
+    var editorDom = editorView.dom;
+    _api.insm.registerEditorDom(editorDom);
+    return function () {
+      _api.insm.unregisterEditorDom(editorDom);
+    };
+  }, [editorView, isPageAppearance]);
   var createEditor = (0, _react.useCallback)(function (assistiveLabel, assistiveDescribedBy) {
     return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, (0, _platformFeatureFlags.fg)('cc_editor_focus_before_editor_on_load') && /*#__PURE__*/_react.default.createElement("div", {
       tabIndex: -1,

package/dist/cjs/version-wrapper.js

@@ -6,4 +6,4 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-var version = exports.version = "223.1.1";
+var version = exports.version = "223.1.2";

package/dist/es2019/create-editor/ReactEditorView.js

@@ -24,6 +24,7 @@ import { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { EditorSSRRenderer } from '@atlaskit/editor-ssr-renderer';
 import { createSSREditorState } from '@atlaskit/editor-ssr-renderer/create-ssr-editor-state';
 import { createSSRPMPlugins } from '@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins';
+import { insm } from '@atlaskit/insm/api';
 import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addUFOCustomData } from '@atlaskit/react-ufo/custom-data';
@@ -880,6 +881,29 @@ export function ReactEditorView(props) {
     }
   }, [createEditorView, onEditorCreated, eventDispatcher, onEditorDestroyed, handleAnalyticsEvent, mitigateScrollJump]);
   const isPageAppearance = isFullPage(nextAppearance) || nextAppearance === 'max';
+
+  // insm measures a page, so only the page's own editor reports its dom size -- not a
+  // secondary editor such as a comment editor, or one nested inside a legacy content
+  // extension. This runs as an effect rather than from handleEditorViewRef because
+  // `isNestedEditor` is only resolved once `editorRef` is attached, which happens after
+  // the mount node's ref callback.
+  useEffect(() => {
+    if (!editorView || isNestedEditor.current || !isPageAppearance) {
+      return;
+    }
+    if (!isExperimentEnabled('platform_editor_insm_dom_node_count')) {
+      return;
+    }
+
+    // insm has no reference to the editor, so the element it measures for `editorDomSize`
+    // on session events is provided here. It's captured rather than read again on cleanup,
+    // as the view is destroyed by then.
+    const editorDom = editorView.dom;
+    insm.registerEditorDom(editorDom);
+    return () => {
+      insm.unregisterEditorDom(editorDom);
+    };
+  }, [editorView, isPageAppearance]);
   const createEditor = useCallback((assistiveLabel, assistiveDescribedBy) => {
     return /*#__PURE__*/React.createElement(React.Fragment, null, fg('cc_editor_focus_before_editor_on_load') && /*#__PURE__*/React.createElement("div", {
       tabIndex: -1,

package/dist/es2019/version-wrapper.js

@@ -1,3 +1,3 @@
 export const name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export const version = "223.1.1";
+export const version = "223.1.2";

package/dist/esm/create-editor/ReactEditorView.js

@@ -32,6 +32,7 @@ import { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { EditorSSRRenderer } from '@atlaskit/editor-ssr-renderer';
 import { createSSREditorState } from '@atlaskit/editor-ssr-renderer/create-ssr-editor-state';
 import { createSSRPMPlugins } from '@atlaskit/editor-ssr-renderer/create-ssr-pm-plugins';
+import { insm } from '@atlaskit/insm/api';
 import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { addUFOCustomData } from '@atlaskit/react-ufo/custom-data';
@@ -941,6 +942,29 @@ export function ReactEditorView(props) {
     }
   }, [createEditorView, onEditorCreated, eventDispatcher, onEditorDestroyed, handleAnalyticsEvent, mitigateScrollJump]);
   var isPageAppearance = isFullPage(nextAppearance) || nextAppearance === 'max';
+
+  // insm measures a page, so only the page's own editor reports its dom size -- not a
+  // secondary editor such as a comment editor, or one nested inside a legacy content
+  // extension. This runs as an effect rather than from handleEditorViewRef because
+  // `isNestedEditor` is only resolved once `editorRef` is attached, which happens after
+  // the mount node's ref callback.
+  useEffect(function () {
+    if (!editorView || isNestedEditor.current || !isPageAppearance) {
+      return;
+    }
+    if (!isExperimentEnabled('platform_editor_insm_dom_node_count')) {
+      return;
+    }
+
+    // insm has no reference to the editor, so the element it measures for `editorDomSize`
+    // on session events is provided here. It's captured rather than read again on cleanup,
+    // as the view is destroyed by then.
+    var editorDom = editorView.dom;
+    insm.registerEditorDom(editorDom);
+    return function () {
+      insm.unregisterEditorDom(editorDom);
+    };
+  }, [editorView, isPageAppearance]);
   var createEditor = useCallback(function (assistiveLabel, assistiveDescribedBy) {
     return /*#__PURE__*/React.createElement(React.Fragment, null, fg('cc_editor_focus_before_editor_on_load') && /*#__PURE__*/React.createElement("div", {
       tabIndex: -1,

package/dist/esm/version-wrapper.js

@@ -1,3 +1,3 @@
 export var name = "@atlaskit/editor-core";
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export var version = "223.1.1";
+export var version = "223.1.2";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "223.1.2",
+	"version": "223.1.3",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -59,6 +59,7 @@
 		"@atlaskit/emoji": "^71.16.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/icon": "^37.3.0",
+		"@atlaskit/insm": "^1.3.0",
 		"@atlaskit/link": "^5.0.0",
 		"@atlaskit/media-card": "^81.6.0",
 		"@atlaskit/mention": "^27.15.0",
@@ -66,7 +67,7 @@
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/platform-feature-flags-react": "^1.1.0",
 		"@atlaskit/react-compiler-gating": "^0.2.0",
-		"@atlaskit/react-ufo": "^7.4.0",
+		"@atlaskit/react-ufo": "^7.5.0",
 		"@atlaskit/task-decision": "^21.8.0",
 		"@atlaskit/tmp-editor-statsig": "^147.0.0",
 		"@atlaskit/tokens": "^16.7.0",