@atlaskit/editor-core 207.16.0 → 207.17.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-core
 
+## 207.17.0
+
+### Minor Changes
+
+- [#167295](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/167295)
+  [`6c94765105520`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6c94765105520) -
+  [https://product-fabric.atlassian.net/browse/ED-28212](ED-28212) - the `validNode()` function from
+  @atlaskit/editor-core package will use memoization
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 207.16.0
 
 ### Minor Changes

package/dist/cjs/utils/validateNodes.js

@@ -4,9 +4,54 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.validateNodes = exports.validNode = void 0;
+var _model = require("@atlaskit/editor-prosemirror/model");
+var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
+// We don't want to use memoize from lodash, because we need to use WeakMap or WeakSet
+// to avoid memory leaks, but lodash allow to change the cache type only globally
+// like `memoize.Cache = WeakMap`, and we don't want to do that.
+// So we use our own cache implementation.
+var cache = new WeakSet();
+
+// See https://github.com/ProseMirror/prosemirror-model/blob/20d26c9843d6a69a1d417d937c401537ee0b2342/src/node.ts#L303
+function checkNode(node) {
+  if (cache.has(node)) {
+    return;
+  }
+
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkContent(node.content);
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkAttrs(node.attrs);
+  var copy = _model.Mark.none;
+  for (var i = 0; i < node.marks.length; i++) {
+    var mark = node.marks[i];
+    // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+    mark.type.checkAttrs(mark.attrs);
+    copy = mark.addToSet(copy);
+  }
+  if (!_model.Mark.sameSet(copy, node.marks)) {
+    throw new RangeError("Invalid collection of marks for node ".concat(node.type.name, ": ").concat(node.marks.map(function (m) {
+      return m.type.name;
+    })));
+  }
+  node.content.forEach(function (node) {
+    return checkNode(node);
+  });
+
+  // The set value should be added in the end of the function,
+  // because any previous check can throw an error,
+  // and we don't want to add invalid node to the cache.
+  cache.add(node);
+}
 var validNode = exports.validNode = function validNode(node) {
   try {
-    node.check(); // this will throw an error if the node is invalid
+    if ((0, _experiments.editorExperiment)('platform_editor_memoized_node_check', true, {
+      exposure: true
+    })) {
+      checkNode(node);
+    } else {
+      node.check();
+    }
   } catch (error) {
     return false;
   }

package/dist/cjs/version-wrapper.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
-var version = exports.version = "207.16.0";
+var version = exports.version = "207.17.0";

package/dist/es2019/utils/validateNodes.js

@@ -1,6 +1,48 @@
+import { Mark } from '@atlaskit/editor-prosemirror/model';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+
+// We don't want to use memoize from lodash, because we need to use WeakMap or WeakSet
+// to avoid memory leaks, but lodash allow to change the cache type only globally
+// like `memoize.Cache = WeakMap`, and we don't want to do that.
+// So we use our own cache implementation.
+const cache = new WeakSet();
+
+// See https://github.com/ProseMirror/prosemirror-model/blob/20d26c9843d6a69a1d417d937c401537ee0b2342/src/node.ts#L303
+function checkNode(node) {
+  if (cache.has(node)) {
+    return;
+  }
+
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkContent(node.content);
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkAttrs(node.attrs);
+  let copy = Mark.none;
+  for (let i = 0; i < node.marks.length; i++) {
+    const mark = node.marks[i];
+    // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+    mark.type.checkAttrs(mark.attrs);
+    copy = mark.addToSet(copy);
+  }
+  if (!Mark.sameSet(copy, node.marks)) {
+    throw new RangeError(`Invalid collection of marks for node ${node.type.name}: ${node.marks.map(m => m.type.name)}`);
+  }
+  node.content.forEach(node => checkNode(node));
+
+  // The set value should be added in the end of the function,
+  // because any previous check can throw an error,
+  // and we don't want to add invalid node to the cache.
+  cache.add(node);
+}
 export const validNode = node => {
   try {
-    node.check(); // this will throw an error if the node is invalid
+    if (editorExperiment('platform_editor_memoized_node_check', true, {
+      exposure: true
+    })) {
+      checkNode(node);
+    } else {
+      node.check();
+    }
   } catch (error) {
     return false;
   }

package/dist/es2019/version-wrapper.js

@@ -1,2 +1,2 @@
 export const name = "@atlaskit/editor-core";
-export const version = "207.16.0";
+export const version = "207.17.0";

package/dist/esm/utils/validateNodes.js

@@ -1,6 +1,52 @@
+import { Mark } from '@atlaskit/editor-prosemirror/model';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+
+// We don't want to use memoize from lodash, because we need to use WeakMap or WeakSet
+// to avoid memory leaks, but lodash allow to change the cache type only globally
+// like `memoize.Cache = WeakMap`, and we don't want to do that.
+// So we use our own cache implementation.
+var cache = new WeakSet();
+
+// See https://github.com/ProseMirror/prosemirror-model/blob/20d26c9843d6a69a1d417d937c401537ee0b2342/src/node.ts#L303
+function checkNode(node) {
+  if (cache.has(node)) {
+    return;
+  }
+
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkContent(node.content);
+  // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+  node.type.checkAttrs(node.attrs);
+  var copy = Mark.none;
+  for (var i = 0; i < node.marks.length; i++) {
+    var mark = node.marks[i];
+    // @ts-expect-error - This is internal ProseMirror API, but we okay with it
+    mark.type.checkAttrs(mark.attrs);
+    copy = mark.addToSet(copy);
+  }
+  if (!Mark.sameSet(copy, node.marks)) {
+    throw new RangeError("Invalid collection of marks for node ".concat(node.type.name, ": ").concat(node.marks.map(function (m) {
+      return m.type.name;
+    })));
+  }
+  node.content.forEach(function (node) {
+    return checkNode(node);
+  });
+
+  // The set value should be added in the end of the function,
+  // because any previous check can throw an error,
+  // and we don't want to add invalid node to the cache.
+  cache.add(node);
+}
 export var validNode = function validNode(node) {
   try {
-    node.check(); // this will throw an error if the node is invalid
+    if (editorExperiment('platform_editor_memoized_node_check', true, {
+      exposure: true
+    })) {
+      checkNode(node);
+    } else {
+      node.check();
+    }
   } catch (error) {
     return false;
   }

package/dist/esm/version-wrapper.js

@@ -1,2 +1,2 @@
 export var name = "@atlaskit/editor-core";
-export var version = "207.16.0";
+export var version = "207.17.0";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "207.16.0",
+	"version": "207.17.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -62,7 +62,7 @@
 		"@atlaskit/platform-feature-flags-react": "^0.2.0",
 		"@atlaskit/react-ufo": "^3.13.0",
 		"@atlaskit/task-decision": "^19.2.0",
-		"@atlaskit/tmp-editor-statsig": "^5.13.0",
+		"@atlaskit/tmp-editor-statsig": "^5.14.0",
 		"@atlaskit/tokens": "^5.1.0",
 		"@atlaskit/tooltip": "^20.3.0",
 		"@atlaskit/width-detector": "^5.0.0",