Skip to content
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.

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

SWC-6536: handle timing issues related to using larger runner #5184

Merged
merged 2 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions e2e/auth.setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ for (const {
})

setup('create and authenticate user', async () => {
// This may be the first test to run and trigger SWC compilation
// ...which may take 15+ seconds. Mark this test as slow,
// ...so the test will be given triple timeout.
// https://playwright.dev/docs/api/class-test#test-slow-1
setup.slow()
Comment on lines -37 to -41
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Successful auth.setup tests are taking 2-4 seconds on the larger Linux runner, 4-6 seconds locally, and 7-11 seconds on the macOS runner. Generally, this test is much faster than the other e2e tests, so stop marking this test as "slow" -- allow the test to fail faster when flaky, so we spend spend less money on larger runner in CI.


await setup.step('create test user', async () => {
userId = await createTestUser(user, getAdminPAT(), userPage)
expect(userId).not.toBeUndefined()
Expand Down
20 changes: 18 additions & 2 deletions e2e/helpers/testUser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,26 @@ export async function loginTestUser(

await page.getByRole('link', { name: 'Log in to Synapse' }).first().click()
await page.getByRole('button', { name: 'Sign in with your email' }).click()
await page.getByLabel('Username or Email Address').fill(testUserName)
await page.getByLabel('Password').fill(testUserPassword)

const usernameInput = page.getByLabel('Username or Email Address')
await usernameInput.fill(testUserName)
await expect(usernameInput).toHaveValue(testUserName)

const passwordInput = page.getByLabel('Password')
await expect(passwordInput).toBeEmpty()
await passwordInput.fill(testUserPassword)
await expect(passwordInput).not.toBeEmpty()
Comment on lines +75 to +82
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ensure that the username/password values have been set before trying to sign in


await page.getByRole('button', { name: 'Sign in' }).click()

// Ensure that correct username/password were received
const loadingButton = page.getByRole('button', { name: 'Logging you in' })
await expect(loadingButton).toBeVisible()
await expect(loadingButton).not.toBeVisible()
await expect(
page.getByText('The provided username/password combination is incorrect'),
).not.toBeVisible()
Comment on lines +86 to +92
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Confirm that the correct username/password were received, hopefully will help us troubleshoot if login fails to redirect as in this run


// Wait for redirect
await expect(async () => {
expect(page.url()).not.toContain('LoginPlace')
Expand Down
6 changes: 5 additions & 1 deletion e2e/projects.loggedin.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ const PROJECT_NAME = 'swc-e2e-project-' + uuidv4()
async function createProject(page: Page, projectName: string) {
await page.getByLabel('Projects', { exact: true }).click()
await page.getByLabel('Create a New Project').click()
await page.getByLabel('Project Name').type(projectName)

const projectNameInput = page.getByLabel('Project Name')
await projectNameInput.fill(projectName)
await expect(projectNameInput).toHaveValue(projectName)

await page.getByRole('button', { name: 'Save' }).click()
}

Expand Down
5 changes: 4 additions & 1 deletion e2e/teams.loggedin.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ test.describe('Teams', () => {
).toBeVisible()

await userPage.getByRole('button', { name: 'Create a New Team' }).click()
await userPage.getByRole('textbox').nth(1).fill(TEAM_NAME)
const teamNameInput = userPage.getByRole('textbox').nth(1)
await teamNameInput.fill(TEAM_NAME)
await expect(teamNameInput).toHaveValue(TEAM_NAME)

await userPage.getByRole('button', { name: 'OK' }).click()
await expect(
userPage.getByText(`Team Created: ${TEAM_NAME}`),
Expand Down
2 changes: 1 addition & 1 deletion playwright.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ dotenv.config()
export default defineConfig({
testDir: './e2e',
/* Timeout to allow portal enough time to compile when running locally */
timeout: 5 * 60 * 1000,
timeout: 2 * 60 * 1000,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reduce overall test timeout, so flaky tests fail faster -- currently, the longest test (teams.loggedin) takes about 25s locally, 17s on larger runner, and 35-40s on macOS runner, so 2 minutes should be enough time for now. If we add a longer test in the future, we can configure a longer timeout just for that test.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the idea of having these fail faster if making these longer doesn't substantially make these less flaky. Optimizing for resilience is good, but I wouldn't worry much about shaving seconds or minutes off to save money.

/* Increase expectation timeout on CI */
expect: { timeout: process.env.CI ? 30 * 1000 : 5 * 1000 },
/* Run tests in files in parallel */
Expand Down