feat: add unit test

packages/slate/src/interfaces/transforms/node.ts

@@ -9,6 +9,7 @@ export interface NodeInsertNodesOptions<T extends Node> {
   hanging?: boolean
   select?: boolean
   voids?: boolean
+  batchDirty?: boolean
 }
 
 export interface NodeTransforms {

packages/slate/src/interfaces/transforms/text.ts

@@ -15,6 +15,7 @@ export interface TextInsertFragmentOptions {
   at?: Location
   hanging?: boolean
   voids?: boolean
+  batchDirty?: boolean
 }
 
 export interface TextInsertTextOptions {

packages/slate/src/transforms-node/insert-nodes.ts

@@ -18,7 +18,12 @@ export const insertNodes: NodeTransforms['insertNodes'] = (
   options = {}
 ) => {
   Editor.withoutNormalizing(editor, () => {
-    const { hanging = false, voids = false, mode = 'lowest' } = options
+    const {
+      hanging = false,
+      voids = false,
+      mode = 'lowest',
+      batchDirty = true,
+    } = options
     let { at, match, select } = options
 
     if (Node.isNode(nodes)) {
@@ -92,50 +97,60 @@ export const insertNodes: NodeTransforms['insertNodes'] = (
       return
     }
 
-    // PERF: batch update dirty paths
-    // batched ops used to transform existing dirty paths
-    const batchedOps: BaseInsertNodeOperation[] = []
-    const newDirtyPaths: Path[] = Path.levels(parentPath)
-    batchDirtyPaths(
-      editor,
-      () => {
-        for (const node of nodes as Node[]) {
-          const path = parentPath.concat(index)
-          index++
-
-          const op: BaseInsertNodeOperation = {
-            type: 'insert_node',
-            path,
-            node,
-          }
-          editor.apply(op)
-          at = Path.next(at as Path)
-
-          batchedOps.push(op)
-          if (!Text.isText) {
-            newDirtyPaths.push(path)
-          } else {
-            newDirtyPaths.push(
-              ...Array.from(Node.nodes(node), ([, p]) => path.concat(p))
-            )
+    if (batchDirty) {
+      // PERF: batch update dirty paths
+      // batched ops used to transform existing dirty paths
+      const batchedOps: BaseInsertNodeOperation[] = []
+      const newDirtyPaths: Path[] = Path.levels(parentPath)
+      batchDirtyPaths(
+        editor,
+        () => {
+          for (const node of nodes as Node[]) {
+            const path = parentPath.concat(index)
+            index++
+
+            const op: BaseInsertNodeOperation = {
+              type: 'insert_node',
+              path,
+              node,
+            }
+            editor.apply(op)
+            at = Path.next(at as Path)
+
+            batchedOps.push(op)
+            if (!Text.isText) {
+              newDirtyPaths.push(path)
+            } else {
+              newDirtyPaths.push(
+                ...Array.from(Node.nodes(node), ([, p]) => path.concat(p))
+              )
+            }
           }
-        }
-      },
-      () => {
-        updateDirtyPaths(editor, newDirtyPaths, p => {
-          let newPath: Path | null = p
-          for (const op of batchedOps) {
-            if (Path.operationCanTransformPath(op)) {
-              newPath = Path.transform(newPath, op)
-              if (!newPath) {
-                return null
+        },
+        () => {
+          updateDirtyPaths(editor, newDirtyPaths, p => {
+            let newPath: Path | null = p
+            for (const op of batchedOps) {
+              if (Path.operationCanTransformPath(op)) {
+                newPath = Path.transform(newPath, op)
+                if (!newPath) {
+                  return null
+                }
               }
             }
-          }
-          return newPath
-        })
+            return newPath
+          })
+        }
+      )
+    } else {
+      for (const node of nodes as Node[]) {
+        const path = parentPath.concat(index)
+        index++
+
+        editor.apply({ type: 'insert_node', path, node })
+        at = Path.next(at as Path)
       }
-    )
+    }
 
     at = Path.previous(at)
 

packages/slate/src/transforms-text/insert-fragment.ts

@@ -15,7 +15,7 @@ export const insertFragment: TextTransforms['insertFragment'] = (
 ) => {
   Editor.withoutNormalizing(editor, () => {
     const { hanging = false, voids = false } = options
-    let { at = getDefaultInsertLocation(editor) } = options
+    let { at = getDefaultInsertLocation(editor), batchDirty = true } = options
 
     if (!fragment.length) {
       return
@@ -187,6 +187,7 @@ export const insertFragment: TextTransforms['insertFragment'] = (
       match: n => Text.isText(n) || Editor.isInline(editor, n),
       mode: 'highest',
       voids,
+      batchDirty,
     })
 
     if (isBlockEmpty && !starts.length && middles.length && !ends.length) {
@@ -198,13 +199,15 @@ export const insertFragment: TextTransforms['insertFragment'] = (
       match: n => Element.isElement(n) && Editor.isBlock(editor, n),
       mode: 'lowest',
       voids,
+      batchDirty,
     })
 
     Transforms.insertNodes(editor, ends, {
       at: endRef.current!,
       match: n => Text.isText(n) || Editor.isInline(editor, n),
       mode: 'highest',
       voids,
+      batchDirty,
     })
 
     if (!options.at) {

packages/slate/test/index.js

@@ -1,6 +1,7 @@
 import assert from 'assert'
+import { cloneDeep } from 'lodash';
 import { fixtures } from '../../../support/fixtures'
-import { Editor } from 'slate'
+import { Editor, createEditor } from 'slate'
 import { createHyperscript } from 'slate-hyperscript'
 
 describe('slate', () => {
@@ -45,6 +46,31 @@ describe('slate', () => {
     const result = test(input)
     assert.deepEqual(result, output)
   })
+  // make sure with or without batchDirty, the normalize result is the same
+  const testBatchDirty = ({ module }) => {
+    const { input, run } = module
+
+    const input2 = createEditor();
+    input2.children = cloneDeep(input.children);
+    input2.selection = cloneDeep(input.selection);
+
+    const dirties1 = [];
+    const dirties2 = [];
+
+    const editor1 = withBatchTest(withTest(input), dirties1);
+    const editor2 = withBatchTest(withTest(input2), dirties2);
+
+    run(editor1, { batchDirty: true })
+    run(editor2, { batchDirty: false })
+
+    assert.equal(dirties1.join(' '), dirties2.join(' '));
+  }
+  fixtures(__dirname, 'transforms/insertNodes', ({ module }) => {
+    testBatchDirty({ module })
+  })
+  fixtures(__dirname, 'transforms/insertFragment', ({ module }) => {
+    testBatchDirty({ module })
+  })
 })
 const withTest = editor => {
   const { isInline, isVoid, isElementReadOnly, isSelectable } = editor
@@ -62,6 +88,14 @@ const withTest = editor => {
   }
   return editor
 }
+const withBatchTest = (editor, dirties) => {
+  const { normalizeNode } = editor
+  editor.normalizeNode = ([node, path]) => {
+    dirties.push(JSON.stringify(path));
+    normalizeNode([node, path])
+  }
+  return editor
+}
 export const jsx = createHyperscript({
   elements: {
     block: {},

packages/slate/test/transforms/insertFragment/of-blocks/block-empty.tsx

@@ -2,7 +2,7 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
@@ -11,7 +11,8 @@ export const run = editor => {
       </block>
       <block>two</block>
       <block>three</block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-blocks/block-end.tsx

@@ -2,14 +2,15 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <block>one</block>
       <block>two</block>
       <block>three</block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-blocks/block-hanging.tsx

@@ -8,8 +8,8 @@ const fragment = (
     <block>two</block>
   </fragment>
 )
-export const run = editor => {
-  Transforms.insertFragment(editor, fragment)
+export const run = (editor, options = {}) => {
+  Transforms.insertFragment(editor, fragment, options)
 }
 export const input = (
   <editor>

packages/slate/test/transforms/insertFragment/of-blocks/block-middle.tsx

@@ -2,14 +2,15 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <block>one</block>
       <block>two</block>
       <block>three</block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-blocks/block-nested.tsx

@@ -2,14 +2,15 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <block>one</block>
       <block>two</block>
       <block>three</block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-blocks/block-start.tsx

@@ -2,14 +2,15 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <block>one</block>
       <block>two</block>
       <block>three</block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-blocks/with-inline.tsx

@@ -2,7 +2,7 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
@@ -15,7 +15,8 @@ export const run = editor => {
       <block>
         seven<inline>eight</inline>nine
       </block>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-inlines/block-empty.tsx

@@ -2,12 +2,13 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <inline>fragment</inline>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-inlines/block-end.tsx

@@ -2,12 +2,13 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <inline>fragment</inline>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (

packages/slate/test/transforms/insertFragment/of-inlines/block-middle.tsx

@@ -2,12 +2,13 @@
 import { Transforms } from 'slate'
 import { jsx } from '../../..'
 
-export const run = editor => {
+export const run = (editor, options = {}) => {
   Transforms.insertFragment(
     editor,
     <fragment>
       <inline>fragment</inline>
-    </fragment>
+    </fragment>,
+    options,
   )
 }
 export const input = (