@atlaskit/renderer 137.4.6 → 138.0.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @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
+
+- [`3422261e7a40e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3422261e7a40e) -
+  Clean up experiment `platform_editor_smartlink_local_cache`.
+- [`7c7646bee3e68`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7c7646bee3e68) -
+  Clean up feature gate `platform_editor_table_height_analytics_event`
+- Updated dependencies
+
 ## 137.4.6
 
 ### Patch Changes

package/dist/cjs/react/nodes/inlineCard.js

@@ -202,7 +202,7 @@ var InlineCard = function InlineCard(props) {
     }
   };
   (0, _react.useEffect)(function () {
-    if ((0, _expValEquals.expValEquals)('platform_editor_smartlink_local_cache', 'isEnabled', true) && url) {
+    if (url) {
       // Refresh cache in the background
       provider === null || provider === void 0 || provider.then(function (providerInstance) {
         var _refreshCache, _ref5;
@@ -217,7 +217,7 @@ var InlineCard = function InlineCard(props) {
     }
   }, [provider, url]);
   var MaybeOverlay = cardContext !== null && cardContext !== void 0 && cardContext.value ? OverlayWithCardContext : HoverLinkOverlayNoop;
-  if ((ssr || cardState && (0, _expValEquals.expValEquals)('platform_editor_smartlink_local_cache', 'isEnabled', true)) && url) {
+  if ((ssr || cardState) && url) {
     if (
     // eslint-disable-next-line @atlaskit/platform/no-invalid-feature-flag-usage
     (0, _fg.fg)('editor_inline_comments_on_inline_nodes')) {

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

@@ -25,7 +25,6 @@ var _navigation = require("@atlaskit/editor-common/performance/navigation");
 var _useScrollToBlock = require("../hooks/useScrollToBlock");
 var _utils = require("@atlaskit/editor-common/utils");
 var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
-var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _types = require("@atlaskit/analytics-listeners/types");
 var _FabricEditorAnalyticsContext = require("@atlaskit/analytics-namespaced-context/FabricEditorAnalyticsContext");
 var _analytics = require("@atlaskit/editor-common/analytics");
@@ -74,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.5";
+var packageVersion = "138.0.0";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -425,11 +424,9 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
             if (payload) {
               _fireAnalyticsEvent(payload);
             }
-            if ((0, _fg.fg)('platform_editor_table_height_analytics_event')) {
-              var payloadHeight = (0, _analyticsUtils.getHeightInfoPayload)(renderer);
-              if (payloadHeight) {
-                _fireAnalyticsEvent(payloadHeight);
-              }
+            var payloadHeight = (0, _analyticsUtils.getHeightInfoPayload)(renderer);
+            if (payloadHeight) {
+              _fireAnalyticsEvent(payloadHeight);
             }
           }
         };
@@ -489,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);
@@ -497,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/react/nodes/inlineCard.js

@@ -189,7 +189,7 @@ const InlineCard = props => {
     }
   };
   useEffect(() => {
-    if (expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true) && url) {
+    if (url) {
       // Refresh cache in the background
       provider === null || provider === void 0 ? void 0 : provider.then(providerInstance => {
         var _refreshCache, _ref;
@@ -204,7 +204,7 @@ const InlineCard = props => {
     }
   }, [provider, url]);
   const MaybeOverlay = cardContext !== null && cardContext !== void 0 && cardContext.value ? OverlayWithCardContext : HoverLinkOverlayNoop;
-  if ((ssr || cardState && expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true)) && url) {
+  if ((ssr || cardState) && url) {
     if (
     // eslint-disable-next-line @atlaskit/platform/no-invalid-feature-flag-usage
     fg('editor_inline_comments_on_inline_nodes')) {

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

@@ -19,7 +19,6 @@ import { getResponseEndTime } from '@atlaskit/editor-common/performance/navigati
 import { useScrollToBlock } from '../hooks/useScrollToBlock';
 import { getAnalyticsAppearance, getAnalyticsEventSeverity, shouldForceTracking } from '@atlaskit/editor-common/utils';
 import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FabricChannel } from '@atlaskit/analytics-listeners/types';
 import { FabricEditorAnalyticsContext } from '@atlaskit/analytics-namespaced-context/FabricEditorAnalyticsContext';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
@@ -60,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.5";
+const packageVersion = "138.0.0";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -415,11 +414,9 @@ export const RendererFunctionalComponent = props => {
             if (payload) {
               fireAnalyticsEvent(payload);
             }
-            if (fg('platform_editor_table_height_analytics_event')) {
-              const payloadHeight = getHeightInfoPayload(renderer);
-              if (payloadHeight) {
-                fireAnalyticsEvent(payloadHeight);
-              }
+            const payloadHeight = getHeightInfoPayload(renderer);
+            if (payloadHeight) {
+              fireAnalyticsEvent(payloadHeight);
             }
           }
         };
@@ -482,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);
@@ -491,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/react/nodes/inlineCard.js

@@ -193,7 +193,7 @@ var InlineCard = function InlineCard(props) {
     }
   };
   useEffect(function () {
-    if (expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true) && url) {
+    if (url) {
       // Refresh cache in the background
       provider === null || provider === void 0 || provider.then(function (providerInstance) {
         var _refreshCache, _ref5;
@@ -208,7 +208,7 @@ var InlineCard = function InlineCard(props) {
     }
   }, [provider, url]);
   var MaybeOverlay = cardContext !== null && cardContext !== void 0 && cardContext.value ? OverlayWithCardContext : HoverLinkOverlayNoop;
-  if ((ssr || cardState && expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true)) && url) {
+  if ((ssr || cardState) && url) {
     if (
     // eslint-disable-next-line @atlaskit/platform/no-invalid-feature-flag-usage
     fg('editor_inline_comments_on_inline_nodes')) {

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

@@ -24,7 +24,6 @@ import { getResponseEndTime } from '@atlaskit/editor-common/performance/navigati
 import { useScrollToBlock } from '../hooks/useScrollToBlock';
 import { getAnalyticsAppearance, getAnalyticsEventSeverity, shouldForceTracking } from '@atlaskit/editor-common/utils';
 import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { FabricChannel } from '@atlaskit/analytics-listeners/types';
 import { FabricEditorAnalyticsContext } from '@atlaskit/analytics-namespaced-context/FabricEditorAnalyticsContext';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
@@ -65,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.5";
+var packageVersion = "138.0.0";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'
@@ -416,11 +415,9 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
             if (payload) {
               _fireAnalyticsEvent(payload);
             }
-            if (fg('platform_editor_table_height_analytics_event')) {
-              var payloadHeight = getHeightInfoPayload(renderer);
-              if (payloadHeight) {
-                _fireAnalyticsEvent(payloadHeight);
-              }
+            var payloadHeight = getHeightInfoPayload(renderer);
+            if (payloadHeight) {
+              _fireAnalyticsEvent(payloadHeight);
             }
           }
         };
@@ -480,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);
@@ -488,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": "137.4.6",
+	"version": "138.0.1",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -30,7 +30,7 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^57.3.0",
+		"@atlaskit/adf-schema": "^57.4.0",
 		"@atlaskit/adf-utils": "^20.9.0",
 		"@atlaskit/afm-i18n-platform-editor-renderer": "2.200.0",
 		"@atlaskit/analytics-listeners": "^11.3.0",
@@ -70,7 +70,7 @@
 		"@atlaskit/status": "^5.9.0",
 		"@atlaskit/task-decision": "^21.9.0",
 		"@atlaskit/theme": "^28.2.0",
-		"@atlaskit/tmp-editor-statsig": "^178.0.0",
+		"@atlaskit/tmp-editor-statsig": "^179.0.0",
 		"@atlaskit/tokens": "^16.11.0",
 		"@atlaskit/tooltip": "^24.3.0",
 		"@atlaskit/visually-hidden": "^4.4.0",
@@ -85,7 +85,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.16.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": "^18.1.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",
@@ -212,9 +212,6 @@
 		"media-perf-uplift-mutation-fix": {
 			"type": "boolean"
 		},
-		"platform_editor_table_height_analytics_event": {
-			"type": "boolean"
-		},
 		"platform_fix_macro_renders_in_layouts": {
 			"type": "boolean"
 		},