fix: copy-pasted text in suggestion mode (#3576)

* fix: track SuperDoc slice paste in suggestion mode

Author: harbournick

packages/super-editor/src/editors/v1/extensions/track-changes/trackChangesHelpers/trackChangesHelpers.test.js

@@ -700,6 +700,37 @@ describe('trackChangesHelpers', () => {
     expect(result).toBe(tr);
   });
 
+  it('trackedTransaction does not treat addToHistory as tracking intent by itself', () => {
+    const state = createState(createDocWithText('abc'));
+    const tr = state.tr.insertText('!', 1);
+    tr.setMeta('addToHistory', false);
+
+    const result = trackedTransaction({ tr, state, user });
+
+    expect(result).toBe(tr);
+  });
+
+  it('trackedTransaction tracks SuperDoc slice paste transactions and preserves paste metadata', () => {
+    const state = createState(createDocWithText('abc'));
+    const tr = state.tr.insertText('Pasted', 2);
+    tr.setMeta('superdocSlicePaste', true);
+    tr.setMeta('paste', true);
+    tr.setMeta('uiEvent', 'paste');
+
+    const tracked = trackedTransaction({ tr, state, user });
+    const nextState = state.apply(tracked);
+
+    expect(tracked).not.toBe(tr);
+    expect(tracked.getMeta('superdocSlicePaste')).toBe(true);
+    expect(tracked.getMeta('paste')).toBe(true);
+    expect(tracked.getMeta('uiEvent')).toBe('paste');
+
+    const hasTrackedPastedText = documentHelpers
+      .findInlineNodes(nextState.doc)
+      .some(({ node }) => node.text === 'Pasted' && node.marks.some((mark) => mark.type.name === TrackInsertMarkName));
+    expect(hasTrackedPastedText).toBe(true);
+  });
+
   it('trackedTransaction skips Yjs-origin transactions', () => {
     const state = createState(createDocWithText('abc'));
     const tr = state.tr.insertText('!', 1);

packages/super-editor/src/editors/v1/extensions/track-changes/trackChangesHelpers/trackedTransaction.js

@@ -32,6 +32,29 @@ const DEAD_KEY_PLACEHOLDER_MARKS = new Map([
   ['¨', '\u0308'],
 ]);
 
+const TRACKABLE_META_KEYS = [
+  'inputType',
+  'uiEvent',
+  'paste',
+  'pointer',
+  'composition',
+  'superdocSlicePaste',
+  'forceTrackChanges',
+  'protectTrackedReviewState',
+];
+
+const PASSTHROUGH_META_KEYS = [
+  'inputType',
+  'uiEvent',
+  'paste',
+  'pointer',
+  'composition',
+  'addToHistory',
+  'superdocSlicePaste',
+];
+
+const ALLOWED_META_KEYS = new Set([...TRACKABLE_META_KEYS, ySyncPluginKey.key]);
+
 const getTextNodeAtPos = ({ doc, pos }) => {
   let found = null;
 
@@ -275,6 +298,15 @@ const mergeTrackChangesMeta = (tr, extraMeta) => {
   tr.setMeta(TrackChangesBasePluginKey, { ...existingMeta, ...extraMeta });
 };
 
+const copyPassthroughMeta = (sourceTr, targetTr) => {
+  PASSTHROUGH_META_KEYS.forEach((key) => {
+    const value = sourceTr.getMeta(key);
+    if (value !== undefined) {
+      targetTr.setMeta(key, value);
+    }
+  });
+};
+
 const getPendingDeadKeyPlaceholder = ({ tr, newTr, user }) => {
   if (!isCompositionTransaction(tr) || tr.steps.length !== 1) {
     return null;
@@ -343,18 +375,11 @@ const getPendingDeadKeyPlaceholder = ({ tr, newTr, user }) => {
  *   transaction ready to dispatch.
  */
 export const trackedTransaction = ({ tr, state, user, replacements = 'paired' }) => {
-  const onlyInputTypeMeta = ['inputType', 'uiEvent', 'paste', 'pointer', 'composition'];
   const notAllowedMeta = ['historyUndo', 'historyRedo', 'acceptReject'];
   const isProgrammaticInput = tr.getMeta('inputType') === 'programmatic';
   const ySyncMeta = tr.getMeta(ySyncPluginKey);
   const pendingDeadKeyPlaceholder = TrackChangesBasePluginKey.getState(state)?.pendingDeadKeyPlaceholder ?? null;
-  const allowedMeta = new Set([
-    ...onlyInputTypeMeta,
-    ySyncPluginKey.key,
-    'forceTrackChanges',
-    'protectTrackedReviewState',
-  ]);
-  const hasDisallowedMeta = tr.meta && Object.keys(tr.meta).some((meta) => !allowedMeta.has(meta));
+  const hasDisallowedMeta = tr.meta && Object.keys(tr.meta).some((meta) => !ALLOWED_META_KEYS.has(meta));
 
   if (
     ySyncMeta?.isChangeOrigin || // Skip Yjs-origin transactions (remote/rehydration).
@@ -442,21 +467,7 @@ export const trackedTransaction = ({ tr, state, user, replacements = 'paired' })
     }
   });
 
-  if (tr.getMeta('inputType')) {
-    newTr.setMeta('inputType', tr.getMeta('inputType'));
-  }
-
-  if (tr.getMeta('uiEvent')) {
-    newTr.setMeta('uiEvent', tr.getMeta('uiEvent'));
-  }
-
-  if (tr.getMeta('composition') !== undefined) {
-    newTr.setMeta('composition', tr.getMeta('composition'));
-  }
-
-  if (tr.getMeta('addToHistory') !== undefined) {
-    newTr.setMeta('addToHistory', tr.getMeta('addToHistory'));
-  }
+  copyPassthroughMeta(tr, newTr);
 
   mergeTrackChangesMeta(newTr, {
     pendingDeadKeyPlaceholder: getPendingDeadKeyPlaceholder({ tr, newTr, user }),