@atlaskit/renderer 138.0.0 → 138.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/renderer
 
+## 138.0.1
+
+### Patch Changes
+
+- [`8d65b130dff43`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8d65b130dff43) -
+  Behind the `platform_renderer_on_complete_after_commit` experiment, `onComplete` is invoked from
+  an effect after the rendered document is committed instead of synchronously during render. Calling
+  it during render let consumers set state on other components mid-render, which React forbids and
+  which could feed a render loop on pages that never reached commit. With the experiment off the
+  callback fires exactly as before.
+- Updated dependencies
+
 ## 138.0.0
 
 ### Patch Changes

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

@@ -73,7 +73,7 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "137.4.6";
+var packageVersion = "138.0.0";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -486,6 +486,21 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
   // render; elsewhere both arms are already identical. Control keeps the copy-per-render
   // behaviour, which is what makes `renderDocument`'s validation memo miss.
   var validationOverrides = stableValidationOverrides.allowTableInPanel && !(0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_adf_validator_perf') ? _objectSpread({}, stableValidationOverrides) : stableValidationOverrides;
+
+  // Invoking `onComplete` during render lets consumers set state on other components mid-render,
+  // so the stat is parked here and delivered once the rendered document has been committed.
+  // No dependency array: `renderDocument` produces a new stat on every render, so the callback
+  // must run after every commit to keep its historical once-per-render cadence.
+  var pendingOnCompleteStatRef = (0, _react.useRef)(null);
+  var onComplete = props.onComplete;
+  (0, _react.useEffect)(function () {
+    var stat = pendingOnCompleteStatRef.current;
+    if (stat === null || !onComplete) {
+      return;
+    }
+    pendingOnCompleteStatRef.current = null;
+    onComplete(stat);
+  });
   try {
     var _rendererContext$feat, _props$media;
     var schema = getSchema(props.schema, props.adfStage);
@@ -494,7 +509,11 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
       stat = _renderDocument.stat,
       pmDoc = _renderDocument.pmDoc;
     if (props.onComplete) {
-      props.onComplete(stat);
+      if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_renderer_on_complete_after_commit')) {
+        pendingOnCompleteStatRef.current = stat;
+      } else {
+        props.onComplete(stat);
+      }
     }
     var rendererOutput = (0, _react2.jsx)(_rendererContext.RendererContextProvider, {
       value: rendererContext

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

@@ -59,7 +59,7 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const TABLE_INFO_TIMEOUT = 10000;
 const RENDER_EVENT_SAMPLE_RATE = 0.1;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "137.4.6";
+const packageVersion = "138.0.0";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -479,6 +479,23 @@ export const RendererFunctionalComponent = props => {
   const validationOverrides = stableValidationOverrides.allowTableInPanel && !isExperimentEnabled('platform_editor_adf_validator_perf') ? {
     ...stableValidationOverrides
   } : stableValidationOverrides;
+
+  // Invoking `onComplete` during render lets consumers set state on other components mid-render,
+  // so the stat is parked here and delivered once the rendered document has been committed.
+  // No dependency array: `renderDocument` produces a new stat on every render, so the callback
+  // must run after every commit to keep its historical once-per-render cadence.
+  const pendingOnCompleteStatRef = useRef(null);
+  const {
+    onComplete
+  } = props;
+  useEffect(() => {
+    const stat = pendingOnCompleteStatRef.current;
+    if (stat === null || !onComplete) {
+      return;
+    }
+    pendingOnCompleteStatRef.current = null;
+    onComplete(stat);
+  });
   try {
     var _rendererContext$feat, _props$media;
     const schema = getSchema(props.schema, props.adfStage);
@@ -488,7 +505,11 @@ export const RendererFunctionalComponent = props => {
       pmDoc
     } = renderDocument(props.shouldRemoveEmptySpaceAroundContent ? removeEmptySpaceAroundContent(props.document) : props.document, serializer, schema, props.adfStage, props.useSpecBasedValidator, id, fireAnalyticsEvent, props.unsupportedContentLevelsTracking, props.appearance, props.includeNodesCountInStats, props.skipValidation, validationOverrides);
     if (props.onComplete) {
-      props.onComplete(stat);
+      if (isExperimentEnabled('platform_renderer_on_complete_after_commit')) {
+        pendingOnCompleteStatRef.current = stat;
+      } else {
+        props.onComplete(stat);
+      }
     }
     const rendererOutput = jsx(RendererContextProvider, {
       value: rendererContext

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

@@ -64,7 +64,7 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "137.4.6";
+var packageVersion = "138.0.0";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -477,6 +477,21 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
   // render; elsewhere both arms are already identical. Control keeps the copy-per-render
   // behaviour, which is what makes `renderDocument`'s validation memo miss.
   var validationOverrides = stableValidationOverrides.allowTableInPanel && !isExperimentEnabled('platform_editor_adf_validator_perf') ? _objectSpread({}, stableValidationOverrides) : stableValidationOverrides;
+
+  // Invoking `onComplete` during render lets consumers set state on other components mid-render,
+  // so the stat is parked here and delivered once the rendered document has been committed.
+  // No dependency array: `renderDocument` produces a new stat on every render, so the callback
+  // must run after every commit to keep its historical once-per-render cadence.
+  var pendingOnCompleteStatRef = useRef(null);
+  var onComplete = props.onComplete;
+  useEffect(function () {
+    var stat = pendingOnCompleteStatRef.current;
+    if (stat === null || !onComplete) {
+      return;
+    }
+    pendingOnCompleteStatRef.current = null;
+    onComplete(stat);
+  });
   try {
     var _rendererContext$feat, _props$media;
     var schema = getSchema(props.schema, props.adfStage);
@@ -485,7 +500,11 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
       stat = _renderDocument.stat,
       pmDoc = _renderDocument.pmDoc;
     if (props.onComplete) {
-      props.onComplete(stat);
+      if (isExperimentEnabled('platform_renderer_on_complete_after_commit')) {
+        pendingOnCompleteStatRef.current = stat;
+      } else {
+        props.onComplete(stat);
+      }
     }
     var rendererOutput = jsx(RendererContextProvider, {
       value: rendererContext

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "138.0.0",
+	"version": "138.0.1",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -85,7 +85,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^121.0.0",
+		"@atlaskit/editor-common": "^121.1.0",
 		"@atlaskit/link-provider": "^5.5.0",
 		"@atlaskit/media-core": "^38.2.0",
 		"react": "^18.2.0",
@@ -97,7 +97,7 @@
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/analytics-gas-types": "^6.2.0",
 		"@atlaskit/checkbox": "^19.2.0",
-		"@atlaskit/editor-plugin-media": "^19.0.0",
+		"@atlaskit/editor-plugin-media": "^19.1.0",
 		"@atlaskit/editor-test-helpers": "workspace:^",
 		"@atlaskit/inline-edit": "^16.4.0",
 		"@atlaskit/json-ld-types": "^2.0.0",