Skip to content

Update e2e tests to support new configuration step order #3389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2025
Merged

Update e2e tests to support new configuration step order #3389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/SIL.XForge.Scripture/ClientApp/e2e/workflows/generate-draft.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,7 @@ export async function generateDraft(
await user.click(page.getByRole('button', { name: 'Configure sources' }));
await screenshot(page, { pageName: 'configure_sources_initial', ...context });

await user.click(page.getByRole('combobox'));
await user.type('ntv');
await user.click(page.getByRole('option', { name: 'NTV - Nueva Traducción' }));
await user.click(page.getByRole('button', { name: 'Next' }));
// Step 1: Reference projects
await user.click(page.getByRole('combobox').first());
await user.type('ntv');
await user.click(page.getByRole('option', { name: 'NTV - Nueva Traducción' }));
Expand All @@ -60,6 +57,14 @@ export async function generateDraft(
await user.type('dhh94');
await user.click(page.getByRole('option', { name: 'DHH94 - Spanish: Dios Habla' }));
await user.click(page.getByRole('button', { name: 'Next' }));

// Step 2: Source project
await user.click(page.getByRole('combobox'));
await user.type('ntv');
await user.click(page.getByRole('option', { name: 'NTV - Nueva Traducción' }));
await user.click(page.getByRole('button', { name: 'Next' }));

// Step 3: Main project and other training data
await user.check(page.getByRole('checkbox', { name: 'All the language codes are correct' }));
await screenshot(page, { pageName: 'configure_sources_final', ...context });
await user.click(page.getByRole('button', { name: 'Save & sync' }));
Expand Down
125 changes: 66 additions & 59 deletions src/SIL.XForge.Scripture/ClientApp/e2e/workflows/localized-screenshots.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,53 +85,53 @@ export async function localizedScreenshots(

const homePageSignUpButtonLocator = page.locator('.login-buttons a').first();

for (const localeCode of preset.locales) {
console.log(`Taking screenshots of login process for locale ${localeCode}`);

await page.goto(preset.rootUrl);
await switchToLocaleOnHomePage(page, localeCode);
await expect(homePageSignUpButtonLocator).toBeVisible();
if (preset.showArrow) await installMouseFollower(page);

// Scripture Forge home page
const signUpButtonScreenshotClip = {
x: 0,
y: 0,
width: (await page.viewportSize())!.width,
height: 400
};

await user.hover(homePageSignUpButtonLocator, defaultArrowLocation);
await screenshot(
page,
{ ...context, pageName: 'page_sign_up', locale: localeCode },
{ clip: signUpButtonScreenshotClip }
);

// Auth0 login page
await homePageSignUpButtonLocator.click();
await page.waitForSelector('.auth0-lock-social-button');
if (preset.showArrow) await installMouseFollower(page);
await user.hover(page.locator('.auth0-lock-social-button').first(), { x: 0.85, y: 0.6 });
await screenshotElements(page, [page.locator('.auth0-lock-widget-container')], {
...context,
pageName: 'auth0_sign_up_with_pt',
locale: localeCode
});
await page.locator('.auth0-lock-social-button').first().click();

// Paratext login page
await expect(page.getByRole('heading', { name: 'Authorise Application' })).toBeVisible();
if (preset.showArrow) await installMouseFollower(page);
await page.getByRole('alert').getByText('Warning: This server is for').getByRole('button').click();
await page.locator('#email').fill('[email protected]');
await user.hover(page.locator('#password-group').getByRole('button'));
await screenshot(
page,
{ ...context, pageName: 'pt_registry_login', locale: localeCode },
{ animations: 'disabled' }
);
}
// for (const localeCode of preset.locales) {
// console.log(`Taking screenshots of login process for locale ${localeCode}`);

// await page.goto(preset.rootUrl);
// await switchToLocaleOnHomePage(page, localeCode);
// await expect(homePageSignUpButtonLocator).toBeVisible();
// if (preset.showArrow) await installMouseFollower(page);

// // Scripture Forge home page
// const signUpButtonScreenshotClip = {
// x: 0,
// y: 0,
// width: (await page.viewportSize())!.width,
// height: 400
// };

// await user.hover(homePageSignUpButtonLocator, defaultArrowLocation);
// await screenshot(
// page,
// { ...context, pageName: 'page_sign_up', locale: localeCode },
// { clip: signUpButtonScreenshotClip }
// );

// // Auth0 login page
// await homePageSignUpButtonLocator.click();
// await page.waitForSelector('.auth0-lock-social-button');
// if (preset.showArrow) await installMouseFollower(page);
// await user.hover(page.locator('.auth0-lock-social-button').first(), { x: 0.85, y: 0.6 });
// await screenshotElements(page, [page.locator('.auth0-lock-widget-container')], {
// ...context,
// pageName: 'auth0_sign_up_with_pt',
// locale: localeCode
// });
// await page.locator('.auth0-lock-social-button').first().click();

// // Paratext login page
// await expect(page.getByRole('heading', { name: 'Authorise Application' })).toBeVisible();
// if (preset.showArrow) await installMouseFollower(page);
// await page.getByRole('alert').getByText('Warning: This server is for').getByRole('button').click();
// await page.locator('#email').fill('[email protected]');
// await user.hover(page.locator('#password-group').getByRole('button'));
// await screenshot(
// page,
// { ...context, pageName: 'pt_registry_login', locale: localeCode },
// { animations: 'disabled' }
// );
// }

const shortName = 'SEEDSP2';
await logInAsPTUser(page, credentials);
Expand Down Expand Up @@ -207,28 +207,38 @@ export async function localizedScreenshots(
await screenshot(page, { ...context, pageName: 'configure_sources_button', locale });
});

const originalViewportSize = await page.viewportSize();
await page.locator('[data-test-id="configure-button"]').click();

const originalViewportSize = await page.viewportSize()!;
Copy link
Preview

Copilot AI Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The non-null assertion operator (!) is unsafe here. The viewportSize() method can return null, and forcing it with ! could cause a runtime error. Use null checking instead: const originalViewportSize = await page.viewportSize(); if (!originalViewportSize) throw new Error('Viewport size not available');

Suggested change
const originalViewportSize = await page.viewportSize()!;
const originalViewportSize = await page.viewportSize();
if (!originalViewportSize) throw new Error('Viewport size not available');

Copilot uses AI. Check for mistakes.

// Increase the height of the viewport to ensure all elements are visible
await page.setViewportSize({ width: originalViewportSize.width, height: 1200 });

await page.locator('[data-test-id="configure-button"]').click();
await page.getByRole('combobox').fill('ntv');
await page.getByRole('option', { name: 'NTV - Nueva Traducción' }).click();

const addReference = page.locator('.add-another-project');
const nextButton = page.locator('.step-button-wrapper').getByRole('button').last();

await forEachLocale(async locale => {
await page.getByRole('combobox').fill('ntv');
await user.hover(page.getByRole('option', { name: 'NTV - Nueva Traducción' }), defaultArrowLocation);
await user.hover(addReference);
await screenshotElements(
page,
[page.locator('app-draft-sources > .draft-sources-stepper'), page.locator('app-draft-sources > .overview')],
{ ...context, pageName: 'configure_sources_draft_source', locale },
{ ...context, pageName: 'configure_sources_draft_reference', locale },
{ margin: 8 }
);
});
await page.getByRole('combobox').fill('ntv');
await page.getByRole('option', { name: 'NTV - Nueva Traducción' }).click();
await page.getByRole('button', { name: 'Next' }).click();
await user.click(addReference);
await page.getByRole('combobox').last().fill('dhh94');
await page.getByRole('option', { name: 'DHH94 - Spanish: Dios Habla' }).click();
await nextButton.click();

await forEachLocale(async locale => {
await user.hover(await page.getByRole('combobox'), defaultArrowLocation);
await page.waitForTimeout(200); // Wait for the hover effect on the input
await page.getByRole('combobox').fill('ntv');
await page.getByRole('option', { name: 'NTV - Nueva Traducción' }).click();
await user.hover(nextButton);
await screenshotElements(
page,
[page.locator('app-draft-sources > .draft-sources-stepper'), page.locator('app-draft-sources > .overview')],
Expand All @@ -239,10 +249,7 @@ export async function localizedScreenshots(

await page.getByRole('combobox').fill('ntv');
await page.getByRole('option', { name: 'NTV - Nueva Traducción' }).click();
await user.click(page.getByRole('button', { name: 'Add another reference project' }));
await page.getByRole('combobox').last().fill('dhh94');
await page.getByRole('option', { name: 'DHH94 - Spanish: Dios Habla' }).click();
await page.getByRole('button', { name: 'Next' }).click();
await nextButton.click();

await forEachLocale(async locale => {
await user.hover(await page.getByRole('checkbox'));
Expand Down
Loading