@atlaskit/renderer 136.1.2 → 136.1.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/renderer
 
+## 136.1.3
+
+### Patch Changes
+
+- [`07c45974a615f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/07c45974a615f) -
+  Reduce ADF validation cost on large documents, behind the new `platform_editor_adf_validator_perf`
+  experiment. The validator resolves the `platform_editor_fix_adf-validator_mutation_bug` gate once
+  per validator instead of once per node and per mark, and caches allowed-content lookups per node
+  type. The renderer compares `validationOverrides` by value so its validation memo stops missing on
+  every render, and compares ProseMirror documents with `Node.eq` rather than stringifying both. Its
+  memo comparator now runs the cheap checks before the document comparison. Behaviour is unchanged
+  in both cohorts.
+- Updated dependencies
+
 ## 136.1.2
 
 ### Patch Changes

package/dist/cjs/render-document.js

@@ -11,6 +11,7 @@ var _transforms = require("@atlaskit/adf-utils/transforms");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _utils = require("@atlaskit/editor-common/utils");
 var _validator = require("@atlaskit/editor-common/validator");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _memoizeOne = _interopRequireDefault(require("memoize-one"));
@@ -31,6 +32,9 @@ var withStopwatch = function withStopwatch(cb) {
     time: time
   };
 };
+
+/** Schema-variant escape hatches handed to the ADF validator. */
+
 var _validation = function _validation(doc, schema, adfStage, useSpecBasedValidator, dispatchAnalyticsEvent, skipValidation, validationOverrides) {
   var result;
   if (useSpecBasedValidator) {
@@ -160,7 +164,14 @@ var memoValidation = (0, _memoizeOne.default)(_validation, function (newArgs, la
     oldUseSpecValidator = _lastArgs[3],
     /* ignoring dispatchAnalyticsEvent */oldSkipValidation = _lastArgs[5],
     oldValidationOverrides = _lastArgs[6];
-  return areDocsEqual(newDoc, oldDoc) && newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && newValidationOverrides === oldValidationOverrides;
+
+  // Reference-compared before, which never matched — see `areValidationOverridesEqual`.
+  var validationOverridesAreEqual = (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_adf_validator_perf') ? areValidationOverridesEqual(newValidationOverrides, oldValidationOverrides) : newValidationOverrides === oldValidationOverrides;
+
+  // `areDocsEqual` stringifies the whole document, so it goes last and only runs once everything
+  // cheaper has matched. Pure predicates, so ordering cannot change the result; the experiment is
+  // resolved above regardless, so exposure does not depend on reaching it.
+  return newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && validationOverridesAreEqual && areDocsEqual(newDoc, oldDoc);
 });
 
 // Ignored via go/ees005
@@ -175,12 +186,42 @@ var areDocsEqual = function areDocsEqual(docA, docB) {
 
   // PMNode
   if (docA.type && docA.toJSON && docB.type && docB.toJSON) {
+    // `Node.eq` compares markup and content directly. The stringify path builds two JSON trees via
+    // `toJSON`, then two strings from them, and discards all four — ~14x slower on a 5k-node
+    // document. Same result either way; `Node.eq` is the comparison ProseMirror intends for this.
+    if (typeof docA.eq === 'function' && typeof docB.eq === 'function' && (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_adf_validator_perf')) {
+      return docA.eq(docB);
+    }
     return JSON.stringify(docA.toJSON()) === JSON.stringify(docB.toJSON());
   }
 
   // Object
   return JSON.stringify(docA) === JSON.stringify(docB);
 };
+
+/**
+ * `Renderer` rebuilds this object in its render body, so a reference check never matches and the memo
+ * re-validates (and re-transforms) an unchanged document every render. A flat bag of optional
+ * booleans, so a shallow key/value comparison is exact and free next to what it protects.
+ */
+var areValidationOverridesEqual = function areValidationOverridesEqual(a, b) {
+  if (a === b) {
+    return true;
+  }
+  if (!a || !b) {
+    return false;
+  }
+  var aEntries = Object.entries(a);
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  var bRecord = b;
+  return aEntries.length === Object.keys(b).length && aEntries.every(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    return bRecord[key] === value;
+  });
+};
 var _serializeFragment = function _serializeFragment(serializer, doc) {
   return serializer.serializeFragment(doc.content);
 };

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 = "136.1.1";
+var packageVersion = "136.1.2";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/es2019/render-document.js

@@ -6,6 +6,7 @@ import { nativeEmbedsFallbackTransform, transformContainerNodes, transformMediaL
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { findAndTrackUnsupportedContentNodes, validateADFEntity } from '@atlaskit/editor-common/utils';
 import { getValidDocument } from '@atlaskit/editor-common/validator';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import memoizeOne from 'memoize-one';
@@ -23,6 +24,9 @@ const withStopwatch = cb => {
     time
   };
 };
+
+/** Schema-variant escape hatches handed to the ADF validator. */
+
 const _validation = (doc, schema, adfStage, useSpecBasedValidator, dispatchAnalyticsEvent, skipValidation, validationOverrides) => {
   let result;
   if (useSpecBasedValidator) {
@@ -144,7 +148,14 @@ const _validation = (doc, schema, adfStage, useSpecBasedValidator, dispatchAnaly
 const memoValidation = memoizeOne(_validation, (newArgs, lastArgs) => {
   const [newDoc, newSchema, newADFStage, newUseSpecValidator,, /* ignoring dispatchAnalyticsEvent */newSkipValidation, newValidationOverrides] = newArgs;
   const [oldDoc, oldSchema, oldADFStage, oldUseSpecValidator,, /* ignoring dispatchAnalyticsEvent */oldSkipValidation, oldValidationOverrides] = lastArgs;
-  return areDocsEqual(newDoc, oldDoc) && newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && newValidationOverrides === oldValidationOverrides;
+
+  // Reference-compared before, which never matched — see `areValidationOverridesEqual`.
+  const validationOverridesAreEqual = isExperimentEnabled('platform_editor_adf_validator_perf') ? areValidationOverridesEqual(newValidationOverrides, oldValidationOverrides) : newValidationOverrides === oldValidationOverrides;
+
+  // `areDocsEqual` stringifies the whole document, so it goes last and only runs once everything
+  // cheaper has matched. Pure predicates, so ordering cannot change the result; the experiment is
+  // resolved above regardless, so exposure does not depend on reaching it.
+  return newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && validationOverridesAreEqual && areDocsEqual(newDoc, oldDoc);
 });
 
 // Ignored via go/ees005
@@ -159,12 +170,37 @@ const areDocsEqual = (docA, docB) => {
 
   // PMNode
   if (docA.type && docA.toJSON && docB.type && docB.toJSON) {
+    // `Node.eq` compares markup and content directly. The stringify path builds two JSON trees via
+    // `toJSON`, then two strings from them, and discards all four — ~14x slower on a 5k-node
+    // document. Same result either way; `Node.eq` is the comparison ProseMirror intends for this.
+    if (typeof docA.eq === 'function' && typeof docB.eq === 'function' && isExperimentEnabled('platform_editor_adf_validator_perf')) {
+      return docA.eq(docB);
+    }
     return JSON.stringify(docA.toJSON()) === JSON.stringify(docB.toJSON());
   }
 
   // Object
   return JSON.stringify(docA) === JSON.stringify(docB);
 };
+
+/**
+ * `Renderer` rebuilds this object in its render body, so a reference check never matches and the memo
+ * re-validates (and re-transforms) an unchanged document every render. A flat bag of optional
+ * booleans, so a shallow key/value comparison is exact and free next to what it protects.
+ */
+const areValidationOverridesEqual = (a, b) => {
+  if (a === b) {
+    return true;
+  }
+  if (!a || !b) {
+    return false;
+  }
+  const aEntries = Object.entries(a);
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const bRecord = b;
+  return aEntries.length === Object.keys(b).length && aEntries.every(([key, value]) => bRecord[key] === value);
+};
 const _serializeFragment = (serializer, doc) => {
   return serializer.serializeFragment(doc.content);
 };

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 = "136.1.1";
+const packageVersion = "136.1.2";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/esm/render-document.js

@@ -7,6 +7,7 @@ import { nativeEmbedsFallbackTransform, transformContainerNodes, transformMediaL
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { findAndTrackUnsupportedContentNodes, validateADFEntity } from '@atlaskit/editor-common/utils';
 import { getValidDocument } from '@atlaskit/editor-common/validator';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import memoizeOne from 'memoize-one';
@@ -24,6 +25,9 @@ var withStopwatch = function withStopwatch(cb) {
     time: time
   };
 };
+
+/** Schema-variant escape hatches handed to the ADF validator. */
+
 var _validation = function _validation(doc, schema, adfStage, useSpecBasedValidator, dispatchAnalyticsEvent, skipValidation, validationOverrides) {
   var result;
   if (useSpecBasedValidator) {
@@ -153,7 +157,14 @@ var memoValidation = memoizeOne(_validation, function (newArgs, lastArgs) {
     oldUseSpecValidator = _lastArgs[3],
     /* ignoring dispatchAnalyticsEvent */oldSkipValidation = _lastArgs[5],
     oldValidationOverrides = _lastArgs[6];
-  return areDocsEqual(newDoc, oldDoc) && newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && newValidationOverrides === oldValidationOverrides;
+
+  // Reference-compared before, which never matched — see `areValidationOverridesEqual`.
+  var validationOverridesAreEqual = isExperimentEnabled('platform_editor_adf_validator_perf') ? areValidationOverridesEqual(newValidationOverrides, oldValidationOverrides) : newValidationOverrides === oldValidationOverrides;
+
+  // `areDocsEqual` stringifies the whole document, so it goes last and only runs once everything
+  // cheaper has matched. Pure predicates, so ordering cannot change the result; the experiment is
+  // resolved above regardless, so exposure does not depend on reaching it.
+  return newSchema === oldSchema && newADFStage === oldADFStage && newUseSpecValidator === oldUseSpecValidator && newSkipValidation === oldSkipValidation && validationOverridesAreEqual && areDocsEqual(newDoc, oldDoc);
 });
 
 // Ignored via go/ees005
@@ -168,12 +179,42 @@ var areDocsEqual = function areDocsEqual(docA, docB) {
 
   // PMNode
   if (docA.type && docA.toJSON && docB.type && docB.toJSON) {
+    // `Node.eq` compares markup and content directly. The stringify path builds two JSON trees via
+    // `toJSON`, then two strings from them, and discards all four — ~14x slower on a 5k-node
+    // document. Same result either way; `Node.eq` is the comparison ProseMirror intends for this.
+    if (typeof docA.eq === 'function' && typeof docB.eq === 'function' && isExperimentEnabled('platform_editor_adf_validator_perf')) {
+      return docA.eq(docB);
+    }
     return JSON.stringify(docA.toJSON()) === JSON.stringify(docB.toJSON());
   }
 
   // Object
   return JSON.stringify(docA) === JSON.stringify(docB);
 };
+
+/**
+ * `Renderer` rebuilds this object in its render body, so a reference check never matches and the memo
+ * re-validates (and re-transforms) an unchanged document every render. A flat bag of optional
+ * booleans, so a shallow key/value comparison is exact and free next to what it protects.
+ */
+var areValidationOverridesEqual = function areValidationOverridesEqual(a, b) {
+  if (a === b) {
+    return true;
+  }
+  if (!a || !b) {
+    return false;
+  }
+  var aEntries = Object.entries(a);
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  var bRecord = b;
+  return aEntries.length === Object.keys(b).length && aEntries.every(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    return bRecord[key] === value;
+  });
+};
 var _serializeFragment = function _serializeFragment(serializer, doc) {
   return serializer.serializeFragment(doc.content);
 };

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 = "136.1.1";
+var packageVersion = "136.1.2";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/types/render-document.d.ts

@@ -20,8 +20,10 @@ export interface ResultWithTime<T> {
     time: number;
 }
 type DispatchAnalyticsEvent = (event: AnalyticsEventPayload) => void;
-export declare const renderDocument: <T>(doc: any, serializer: Serializer<T>, schema?: Schema, adfStage?: ADFStage, useSpecBasedValidator?: boolean, rendererId?: string, dispatchAnalyticsEvent?: DispatchAnalyticsEvent, unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking, appearance?: RendererAppearance, includeNodesCountInStats?: boolean, skipValidation?: boolean, validationOverrides?: {
+/** Schema-variant escape hatches handed to the ADF validator. */
+type ValidationOverrides = {
     allowNestedTables?: boolean;
     allowTableInPanel?: boolean;
-}) => RenderOutput<T | null>;
+};
+export declare const renderDocument: <T>(doc: any, serializer: Serializer<T>, schema?: Schema, adfStage?: ADFStage, useSpecBasedValidator?: boolean, rendererId?: string, dispatchAnalyticsEvent?: DispatchAnalyticsEvent, unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking, appearance?: RendererAppearance, includeNodesCountInStats?: boolean, skipValidation?: boolean, validationOverrides?: ValidationOverrides) => RenderOutput<T | null>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "136.1.2",
+	"version": "136.1.3",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"