test: more extractions for helpers in tests

Author: palmer-cl

tests/behavior/helpers/editor-interactions.ts

@@ -0,0 +1,35 @@
+import type { Page } from '@playwright/test';
+
+/**
+ * Right-clicks at the screen location corresponding to a document position in the SuperDoc editor.
+ *
+ * This helper queries the editor's coordinates for the given logical document position, calculates a suitable
+ * (x, y) point within the bounding rectangle, and dispatches a mouse right-click at that spot.
+ *
+ * Throws if coordinates cannot be resolved for the given position.
+ *
+ * @param {Page} page - The Playwright test page instance.
+ * @param {number} pos - The logical document position (character offset) at which to right-click.
+ * @returns {Promise<void>} Resolves when the click has been dispatched.
+ */
+export async function rightClickAtDocPos(page: Page, pos: number): Promise<void> {
+  const coords = await page.evaluate((targetPos) => {
+    const editor = (window as any).editor;
+    const rect = editor?.coordsAtPos?.(targetPos);
+    if (!rect) return null;
+    return {
+      left: Number(rect.left),
+      right: Number(rect.right),
+      top: Number(rect.top),
+      bottom: Number(rect.bottom),
+    };
+  }, pos);
+
+  if (!coords) {
+    throw new Error(`Could not resolve coordinates for document position ${pos}`);
+  }
+
+  const x = Math.min(Math.max(coords.left + 1, coords.left), Math.max(coords.right - 1, coords.left + 1));
+  const y = (coords.top + coords.bottom) / 2;
+  await page.mouse.click(x, y, { button: 'right' });
+}

tests/behavior/helpers/tracked-changes.ts

@@ -1,5 +1,11 @@
 import type { Page } from '@playwright/test';
 
+type InsertTrackedChangeOptions = {
+  from: number;
+  to: number;
+  text: string;
+};
+
 /**
  * Reject all tracked changes in the document via document-api.
  */
@@ -12,3 +18,36 @@ export async function rejectAllTrackedChanges(page: Page): Promise<void> {
     decide({ decision: 'reject', target: { scope: 'all' } });
   });
 }
+
+export async function insertTrackedChange(page: Page, options: InsertTrackedChangeOptions): Promise<void> {
+  await page.evaluate((payload) => {
+    (window as any).editor.commands.insertTrackedChange({
+      ...payload,
+      user: { name: 'Track Tester', email: 'track@example.com' },
+    });
+  }, options);
+}
+
+export async function getMarkedText(page: Page, markName: string): Promise<string> {
+  return page.evaluate((name) => {
+    let text = '';
+    const doc = (window as any).editor.state.doc;
+
+    doc.descendants((node: any) => {
+      if (!node.isText) return;
+      if (node.marks.some((mark: any) => mark.type.name === name)) {
+        text += node.text ?? '';
+      }
+    });
+
+    return text;
+  }, markName);
+}
+
+export async function getSelectedText(page: Page): Promise<string> {
+  return page.evaluate(() => {
+    const { from, to, empty } = (window as any).editor.state.selection;
+    if (empty) return '';
+    return (window as any).editor.state.doc.textBetween(from, to);
+  });
+}

tests/behavior/tests/comments/tracked-change-partial-resolution.spec.ts

@@ -1,74 +1,14 @@
 import { test, expect } from '../../fixtures/superdoc.js';
 import { getDocumentText } from '../../helpers/document-api.js';
+import { rightClickAtDocPos } from '../../helpers/editor-interactions.js';
+import { getMarkedText, getSelectedText, insertTrackedChange } from '../../helpers/tracked-changes.js';
 
 test.use({ config: { toolbar: 'full', comments: 'panel', trackChanges: true, showSelection: true } });
 
 const TRACK_TEXT = 'ABCDE';
 const PARTIAL_TEXT = 'BC';
 const ACCEPT_TRACKED_CHANGES_BUTTON = 'Accept tracked changes';
 
-async function insertTrackedChange(
-  page: import('@playwright/test').Page,
-  options: {
-    from: number;
-    to: number;
-    text: string;
-  },
-) {
-  await page.evaluate((payload) => {
-    (window as any).editor.commands.insertTrackedChange({
-      ...payload,
-      user: { name: 'Track Tester', email: 'track@example.com' },
-    });
-  }, options);
-}
-
-async function getMarkedText(page: import('@playwright/test').Page, markName: string): Promise<string> {
-  return page.evaluate((name) => {
-    let text = '';
-    const doc = (window as any).editor.state.doc;
-
-    doc.descendants((node: any) => {
-      if (!node.isText) return;
-      if (node.marks.some((mark: any) => mark.type.name === name)) {
-        text += node.text ?? '';
-      }
-    });
-
-    return text;
-  }, markName);
-}
-
-async function getSelectedText(page: import('@playwright/test').Page): Promise<string> {
-  return page.evaluate(() => {
-    const { from, to, empty } = (window as any).editor.state.selection;
-    if (empty) return '';
-    return (window as any).editor.state.doc.textBetween(from, to);
-  });
-}
-
-async function rightClickAtDocPos(page: import('@playwright/test').Page, pos: number) {
-  const coords = await page.evaluate((p) => {
-    const editor = (window as any).editor;
-    const rect = editor?.coordsAtPos?.(p);
-    if (!rect) return null;
-    return {
-      left: Number(rect.left),
-      right: Number(rect.right),
-      top: Number(rect.top),
-      bottom: Number(rect.bottom),
-    };
-  }, pos);
-
-  if (!coords) {
-    throw new Error(`Could not resolve coordinates for document position ${pos}`);
-  }
-
-  const x = Math.min(Math.max(coords.left + 1, coords.left), Math.max(coords.right - 1, coords.left + 1));
-  const y = (coords.top + coords.bottom) / 2;
-  await page.mouse.click(x, y, { button: 'right' });
-}
-
 test('toolbar accept partially resolves a tracked insertion and updates the bubble text', async ({ superdoc }) => {
   await insertTrackedChange(superdoc.page, { from: 1, to: 1, text: TRACK_TEXT });
   await superdoc.waitForStable();

tests/behavior/tests/slash-menu/paste.spec.ts

@@ -1,4 +1,5 @@
 import { test, expect } from '../../fixtures/superdoc.js';
+import { rightClickAtDocPos } from '../../helpers/editor-interactions.js';
 
 test.use({ config: { toolbar: 'full' } });
 
@@ -16,28 +17,6 @@ async function writeToClipboard(page: import('@playwright/test').Page, text: str
   await page.evaluate((t) => navigator.clipboard.writeText(t), text);
 }
 
-async function rightClickAtDocPos(page: import('@playwright/test').Page, pos: number) {
-  const coords = await page.evaluate((p) => {
-    const editor = (window as any).editor;
-    const rect = editor?.coordsAtPos?.(p);
-    if (!rect) return null;
-    return {
-      left: Number(rect.left),
-      right: Number(rect.right),
-      top: Number(rect.top),
-      bottom: Number(rect.bottom),
-    };
-  }, pos);
-
-  if (!coords) {
-    throw new Error(`Could not resolve coordinates for document position ${pos}`);
-  }
-
-  const x = Math.min(Math.max(coords.left + 1, coords.left), Math.max(coords.right - 1, coords.left + 1));
-  const y = (coords.top + coords.bottom) / 2;
-  await page.mouse.click(x, y, { button: 'right' });
-}
-
 test('right-click opens context menu and paste inserts clipboard text', async ({ superdoc }) => {
   await superdoc.type('Hello world');
   await superdoc.newLine();

tests/visual/tests/behavior/tracked-change-partial-resolution.spec.ts

@@ -1,4 +1,6 @@
 import { test, expect } from '../fixtures/superdoc.ts';
+import { rightClickAtDocPos } from '../../../behavior/helpers/editor-interactions.js';
+import { getMarkedText, getSelectedText, insertTrackedChange } from '../../../behavior/helpers/tracked-changes.js';
 
 test.use({
   config: {
@@ -11,72 +13,11 @@ test.use({
 
 const TRACK_TEXT = 'ABCDE';
 const PARTIAL_TEXT = 'BC';
-async function insertTrackedChange(
-  page: import('@playwright/test').Page,
-  options: {
-    from: number;
-    to: number;
-    text: string;
-  },
-) {
-  await page.evaluate((payload) => {
-    (window as any).editor.commands.insertTrackedChange({
-      ...payload,
-      user: { name: 'Track Tester', email: 'track@example.com' },
-    });
-  }, options);
-}
-
-async function getMarkedText(page: import('@playwright/test').Page, markName: string): Promise<string> {
-  return page.evaluate((name) => {
-    let text = '';
-    const doc = (window as any).editor.state.doc;
-
-    doc.descendants((node: any) => {
-      if (!node.isText) return;
-      if (node.marks.some((mark: any) => mark.type.name === name)) {
-        text += node.text ?? '';
-      }
-    });
-
-    return text;
-  }, markName);
-}
 
 async function getDocumentText(page: import('@playwright/test').Page): Promise<string> {
   return page.evaluate(() => (window as any).editor.doc.getText({}));
 }
 
-async function getSelectedText(page: import('@playwright/test').Page): Promise<string> {
-  return page.evaluate(() => {
-    const { from, to, empty } = (window as any).editor.state.selection;
-    if (empty) return '';
-    return (window as any).editor.state.doc.textBetween(from, to);
-  });
-}
-
-async function rightClickAtDocPos(page: import('@playwright/test').Page, pos: number) {
-  const coords = await page.evaluate((p) => {
-    const editor = (window as any).editor;
-    const rect = editor?.coordsAtPos?.(p);
-    if (!rect) return null;
-    return {
-      left: Number(rect.left),
-      right: Number(rect.right),
-      top: Number(rect.top),
-      bottom: Number(rect.bottom),
-    };
-  }, pos);
-
-  if (!coords) {
-    throw new Error(`Could not resolve coordinates for document position ${pos}`);
-  }
-
-  const x = Math.min(Math.max(coords.left + 1, coords.left), Math.max(coords.right - 1, coords.left + 1));
-  const y = (coords.top + coords.bottom) / 2;
-  await page.mouse.click(x, y, { button: 'right' });
-}
-
 test('@behavior toolbar accept partially resolves a tracked insertion', async ({ superdoc }) => {
   await insertTrackedChange(superdoc.page, { from: 1, to: 1, text: TRACK_TEXT });
   await superdoc.waitForStable();