Beanz/pdf.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement a helper function for selecting an editor in the integration tests

Browse Source 
This has multiple advantages:

- it improves consistency between the various editor integration tests;
- it makes the code easier to read/understand;
- it reduces code duplication;
- it reduces the number of `getEditorSelector` calls that contained
  hardcoded IDs, which helps to isolate the tests and to simplify
  follow-up patches.
This commit is contained in:
Tim van der Meij 2025-01-18 19:21:55 +01:00
parent 5026af107f
commit c051dd78cf
No known key found for this signature in database
GPG Key ID: 8C3FD2925A5F2762
4 changed files with 37 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
test/integration/freetext_editor_spec.mjs
View File

@ -43,6 +43,7 @@ import {
paste, paste,
pasteFromClipboard, pasteFromClipboard,
scrollIntoView, scrollIntoView,
selectEditor,
switchToEditor, switchToEditor,
waitForAnnotationEditorLayer, waitForAnnotationEditorLayer,
waitForAnnotationModeChanged, waitForAnnotationModeChanged,
@ -171,15 +172,7 @@ describe("FreeText Editor", () => {
it("must copy/paste", async () => { it("must copy/paste", async () => {
// Run sequentially to avoid clipboard issues. // Run sequentially to avoid clipboard issues.
for (const [browserName, page] of pages) { for (const [browserName, page] of pages) {
const editorRect = await getRect(page, getEditorSelector(0)); await selectEditor(page, getEditorSelector(0));
// Select the editor created previously.
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(0));
await copy(page); await copy(page);
await paste(page); await paste(page);
await page.waitForSelector(getEditorSelector(1), { await page.waitForSelector(getEditorSelector(1), {
@ -243,14 +236,7 @@ describe("FreeText Editor", () => {
await page.type(`${getEditorSelector(3)} .internal`, data); await page.type(`${getEditorSelector(3)} .internal`, data);
await commit(page); await commit(page);
// And select it again. await selectEditor(page, getEditorSelector(3));
const editorRect = await getRect(page, getEditorSelector(3));
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(3));
await copy(page); await copy(page);
await paste(page); await paste(page);
await page.waitForSelector(getEditorSelector(4), { await page.waitForSelector(getEditorSelector(4), {
@ -350,14 +336,7 @@ describe("FreeText Editor", () => {
() => !document.querySelector(".selectedEditor") () => !document.querySelector(".selectedEditor")
); );
const editorRect = await getRect(page, getEditorSelector(8)); await selectEditor(page, getEditorSelector(8));
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(8));
expect(await getEditors(page, "selected")) expect(await getEditors(page, "selected"))
.withContext(`In ${browserName}`) .withContext(`In ${browserName}`)
.toEqual([8]); .toEqual([8]);
@ -397,16 +376,7 @@ describe("FreeText Editor", () => {
await commit(page); await commit(page);
if (i < 4) { if (i < 4) {
// And select it again. await selectEditor(page, editorSelector, /* count = */ 2);
const editorRect = await getRect(page, editorSelector);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(
`${editorSelector} .overlay:not(.enabled)`
);
} }
} }
@ -467,13 +437,7 @@ describe("FreeText Editor", () => {
expect(text).withContext(`In ${browserName}`).toEqual("A"); expect(text).withContext(`In ${browserName}`).toEqual("A");
// Add a new A. // Add a new A.
const editorRect = await getRect(page, editorSelector); await selectEditor(page, editorSelector, /* count = */ 2);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(`${editorSelector} .overlay:not(.enabled)`);
await page.type(`${editorSelector} .internal`, "A"); await page.type(`${editorSelector} .internal`, "A");
await commit(page); await commit(page);
@ -904,12 +868,9 @@ describe("FreeText Editor", () => {
const serialized = await getSerialized(page); const serialized = await getSerialized(page);
expect(serialized).withContext(`In ${browserName}`).toEqual([]); expect(serialized).withContext(`In ${browserName}`).toEqual([]);
const editorSelector = getEditorSelector(0);
const editorRect = await getRect(page, editorSelector);
// Select the annotation we want to move. // Select the annotation we want to move.
await page.mouse.click(editorRect.x + 2, editorRect.y + 2); const editorSelector = getEditorSelector(0);
await waitForSelectedEditor(page, editorSelector); await selectEditor(page, editorSelector);
await dragAndDrop(page, editorSelector, [[100, 100]]); await dragAndDrop(page, editorSelector, [[100, 100]]);
await waitForSerialized(page, 1); await waitForSerialized(page, 1);
@ -942,15 +903,7 @@ describe("FreeText Editor", () => {
expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6); expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6);
const editorRect = await getRect(page, getEditorSelector(0)); const editorRect = await getRect(page, getEditorSelector(0));
await page.mouse.click( await selectEditor(page, getEditorSelector(0), /* count = */ 2);
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(
`${getEditorSelector(0)} .overlay:not(.enabled)`
);
await kbGoToEnd(page); await kbGoToEnd(page);
await page.waitForFunction( await page.waitForFunction(
sel => sel =>
@ -1048,16 +1001,7 @@ describe("FreeText Editor", () => {
}); });
const editorSelector = getEditorSelector(1); const editorSelector = getEditorSelector(1);
const editorRect = await getRect(page, editorSelector); await selectEditor(page, editorSelector, /* count = */ 2);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(
`${editorSelector} .overlay:not(.enabled)`
);
await kbGoToEnd(page); await kbGoToEnd(page);
await page.waitForFunction( await page.waitForFunction(
sel => sel =>
@ -1134,12 +1078,7 @@ describe("FreeText Editor", () => {
let editorIds = await getEditors(page, "freeText"); let editorIds = await getEditors(page, "freeText");
expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6); expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6);
const editorRect = await getRect(page, getEditorSelector(3)); await selectEditor(page, getEditorSelector(3));
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(3));
await page.keyboard.press("Backspace"); await page.keyboard.press("Backspace");
await page.waitForFunction( await page.waitForFunction(
sel => !document.querySelector(sel), sel => !document.querySelector(sel),
@ -1199,13 +1138,7 @@ describe("FreeText Editor", () => {
const editorIds = await getEditors(page, "freeText"); const editorIds = await getEditors(page, "freeText");
expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6); expect(editorIds.length).withContext(`In ${browserName}`).toEqual(6);
const editorRect = await getRect(page, getEditorSelector(1)); await selectEditor(page, getEditorSelector(1));
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(1));
await copy(page); await copy(page);
await paste(page); await paste(page);
await page.waitForSelector(getEditorSelector(6), { await page.waitForSelector(getEditorSelector(6), {
@ -2106,12 +2039,7 @@ describe("FreeText Editor", () => {
await commit(page); await commit(page);
// Select the second editor. // Select the second editor.
rect = await getRect(page, getEditorSelector(1)); await selectEditor(page, getEditorSelector(1));
await page.mouse.click(
rect.x + 0.5 * rect.width,
rect.y + 0.5 * rect.height
);
await waitForSelectedEditor(page, getEditorSelector(1));
const pos = n => const pos = n =>
page.evaluate(sel => { page.evaluate(sel => {
@ -2300,13 +2228,8 @@ describe("FreeText Editor", () => {
await page.keyboard.press("Escape"); await page.keyboard.press("Escape");
await waitForUnselectedEditor(page, editorSelector); await waitForUnselectedEditor(page, editorSelector);
const editorRect = await getRect(page, editorSelector);
// Select the editor created previously. // Select the editor created previously.
await page.mouse.click( await selectEditor(page, editorSelector);
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
// Go to the last page. // Go to the last page.
await scrollIntoView(page, `.page[data-page-number = "14"]`); await scrollIntoView(page, `.page[data-page-number = "14"]`);
@ -2339,15 +2262,7 @@ describe("FreeText Editor", () => {
await page.waitForSelector(getEditorSelector(0), { await page.waitForSelector(getEditorSelector(0), {
visible: true, visible: true,
}); });
await selectEditor(page, getEditorSelector(0));
rect = await getRect(page, getEditorSelector(0));
await page.mouse.click(
rect.x + rect.width / 2,
rect.y + rect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(0));
const content = await page.$eval(getEditorSelector(0), el => const content = await page.$eval(getEditorSelector(0), el =>
el.innerText.trimEnd() el.innerText.trimEnd()
); );
@ -2388,13 +2303,8 @@ describe("FreeText Editor", () => {
await page.keyboard.press("Escape"); await page.keyboard.press("Escape");
await waitForUnselectedEditor(page, editorSelector); await waitForUnselectedEditor(page, editorSelector);
const editorRect = await getRect(page, editorSelector);
// Select the editor created previously. // Select the editor created previously.
await page.mouse.click( await selectEditor(page, editorSelector);
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
// Go to the last page. // Go to the last page.
await scrollIntoView(page, `.page[data-page-number = "14"]`); await scrollIntoView(page, `.page[data-page-number = "14"]`);
@ -2769,12 +2679,7 @@ describe("FreeText Editor", () => {
} }
// Select the editor created previously. // Select the editor created previously.
const editorRect = await getRect(page, getEditorSelector(0)); await selectEditor(page, getEditorSelector(0));
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, getEditorSelector(0));
await selectAll(page); await selectAll(page);
@ -3137,13 +3042,7 @@ describe("FreeText Editor", () => {
const getText = edSelector => const getText = edSelector =>
page.$eval(`${edSelector} .internal`, el => el.innerText.trimEnd()); page.$eval(`${edSelector} .internal`, el => el.innerText.trimEnd());
const editorRect = await getRect(page, editorSelector); await selectEditor(page, editorSelector, /* count = */ 2);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(`${editorSelector} .overlay:not(.enabled)`);
const select = position => const select = position =>
page.evaluate( page.evaluate(
@ -3254,15 +3153,7 @@ describe("FreeText Editor", () => {
const editorSelector = getEditorSelector(0); const editorSelector = getEditorSelector(0);
const editorRect = await getRect(page, editorSelector); const editorRect = await getRect(page, editorSelector);
await page.mouse.click( await selectEditor(page, editorSelector, /* count = */ 2);
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count: 2 }
);
await page.waitForSelector(
`${editorSelector} .overlay:not(.enabled)`
);
await kbGoToEnd(page); await kbGoToEnd(page);
await page.waitForFunction( await page.waitForFunction(
sel => sel =>

19
test/integration/ink_editor_spec.mjs
View File

@ -29,6 +29,7 @@ import {
kbUndo, kbUndo,
loadAndWait, loadAndWait,
scrollIntoView, scrollIntoView,
selectEditor,
switchToEditor, switchToEditor,
waitForAnnotationModeChanged, waitForAnnotationModeChanged,
waitForNoElement, waitForNoElement,
@ -719,11 +720,7 @@ describe("Ink Editor", () => {
const pdfjsA = getEditorSelector(0); const pdfjsA = getEditorSelector(0);
const editorRect = await getRect(page, pdfjsA); const editorRect = await getRect(page, pdfjsA);
await page.mouse.click( await selectEditor(page, pdfjsA);
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, pdfjsA);
const red = "#ff0000"; const red = "#ff0000";
page.evaluate(value => { page.evaluate(value => {
@ -815,11 +812,8 @@ describe("Ink Editor", () => {
const serialized = await getSerialized(page); const serialized = await getSerialized(page);
expect(serialized).withContext(`In ${browserName}`).toEqual([]); expect(serialized).withContext(`In ${browserName}`).toEqual([]);
const editorRect = await getRect(page, edgeB);
// Select the annotation we want to move. // Select the annotation we want to move.
await page.mouse.click(editorRect.x + 2, editorRect.y + 2); await selectEditor(page, edgeB);
await waitForSelectedEditor(page, edgeB);
await dragAndDrop(page, edgeB, [[100, 100]]); await dragAndDrop(page, edgeB, [[100, 100]]);
await waitForSerialized(page, 1); await waitForSerialized(page, 1);
@ -1067,12 +1061,7 @@ describe("Ink Editor", () => {
await page.waitForSelector("#editorUndoBar", { hidden: true }); await page.waitForSelector("#editorUndoBar", { hidden: true });
editorSelector = getEditorSelector(0); editorSelector = getEditorSelector(0);
const editorRect = await getRect(page, editorSelector); await selectEditor(page, editorSelector);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2
);
await waitForSelectedEditor(page, editorSelector);
await dragAndDrop(page, editorSelector, [[30, 30]], /* steps = */ 10); await dragAndDrop(page, editorSelector, [[30, 30]], /* steps = */ 10);
const finalRect = await getRect(page, `${pageOneSelector} svg`); const finalRect = await getRect(page, `${pageOneSelector} svg`);

10
test/integration/stamp_editor_spec.mjs
View File

@ -38,6 +38,7 @@ import {
paste, paste,
pasteFromClipboard, pasteFromClipboard,
scrollIntoView, scrollIntoView,
selectEditor,
serializeBitmapDimensions, serializeBitmapDimensions,
switchToEditor, switchToEditor,
waitForAnnotationEditorLayer, waitForAnnotationEditorLayer,
@ -524,9 +525,7 @@ describe("Stamp Editor", () => {
await copyImage(page, "../images/firefox_logo.png", 0); await copyImage(page, "../images/firefox_logo.png", 0);
const editorSelector = getEditorSelector(0); const editorSelector = getEditorSelector(0);
await selectEditor(page, editorSelector);
await page.click(editorSelector);
await waitForSelectedEditor(page, editorSelector);
await page.waitForSelector( await page.waitForSelector(
`${editorSelector} .resizer.topLeft[tabindex="-1"]` `${editorSelector} .resizer.topLeft[tabindex="-1"]`
@ -1494,11 +1493,8 @@ describe("Stamp Editor", () => {
const serialized = await getSerialized(page); const serialized = await getSerialized(page);
expect(serialized).withContext(`In ${browserName}`).toEqual([]); expect(serialized).withContext(`In ${browserName}`).toEqual([]);
const editorRect = await getRect(page, editorSelector);
// Select the annotation we want to move. // Select the annotation we want to move.
await page.mouse.click(editorRect.x + 2, editorRect.y + 2); await selectEditor(page, editorSelector);
await waitForSelectedEditor(page, editorSelector);
await dragAndDrop(page, editorSelector, [[100, 100]]); await dragAndDrop(page, editorSelector, [[100, 100]]);
await waitForSerialized(page, 1); await waitForSerialized(page, 1);

11
test/integration/test_utils.mjs
View File

@ -347,6 +347,16 @@ async function applyFunctionToEditor(page, editorId, func) {
); );
} }
async function selectEditor(page, selector, count = 1) {
const editorRect = await getRect(page, selector);
await page.mouse.click(
editorRect.x + editorRect.width / 2,
editorRect.y + editorRect.height / 2,
{ count }
);
await waitForSelectedEditor(page, selector);
}
async function waitForSelectedEditor(page, selector) { async function waitForSelectedEditor(page, selector) {
return page.waitForSelector(`${selector}.selectedEditor`); return page.waitForSelector(`${selector}.selectedEditor`);
} }
@ -868,6 +878,7 @@ export {
paste, paste,
pasteFromClipboard, pasteFromClipboard,
scrollIntoView, scrollIntoView,
selectEditor,
serializeBitmapDimensions, serializeBitmapDimensions,
setCaretAt, setCaretAt,
switchToEditor, switchToEditor,