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.

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

tools: try to reduce flake in image upload e2e tests #2415

Merged
merged 1 commit into from
Sep 5, 2024
Merged

tools: try to reduce flake in image upload e2e tests #2415

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
6 changes: 5 additions & 1 deletion app/forms/image-upload.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@ function Step({ children, state, label, className }: StepProps) {
/* eslint-enable react/jsx-key */
return (
// data-status used only for e2e testing
<div className={cn('items-top flex gap-2 px-4 py-3', className)} data-status={status}>
<div
className={cn('items-top flex gap-2 px-4 py-3', className)}
data-testid="upload-step"
data-status={status}
>
{/* padding on icon to align it with text since everything is aligned to top */}
<div className="pt-px">{icon}</div>
<div
Expand Down
16 changes: 4 additions & 12 deletions test/e2e/image-upload.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@ import {
// to complete in time, so we just assert that they all start out ready and end
// up complete
async function expectUploadProcess(page: Page) {
const steps = page.locator('div[data-status]')

for (const step of await steps.all()) {
await expect(step).toHaveAttribute('data-status', 'ready', { timeout: 10000 })
}

// check these here instead of first because if we don't look for the ready
// states right away we won't catch them in time
const progressModal = page.getByRole('dialog', { name: 'Image upload progress' })
await expect(progressModal).toBeVisible()

const steps = page.getByTestId('upload-step')
await expect(steps).toHaveCount(8)

const done = progressModal.getByRole('button', { name: 'Done' })

for (const step of await steps.all()) {
Expand Down Expand Up @@ -234,12 +232,6 @@ test.describe('Image upload', () => {

await page.click('role=button[name="Upload image"]')

const steps = page.locator('div[data-status]')

for (const step of await steps.all()) {
await expect(step).toHaveAttribute('data-status', 'ready')
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When I ran this locally, it passed because steps.all() was coming back empty, so the whole loop is being skipped. Boo. This is due to this approach being sort of a hack — normal expect will auto-wait a bit for the thing to become visible before asserting, but this all() approach just gets the list of things matching at the moment it's called, and if it's empty, it's empty.

const step = page.locator('[data-status]').filter({ hasText: stepText }).first()
await expect(step).toHaveAttribute('data-status', 'error', { timeout: 15000 })
await expectVisible(page, [
Expand Down
Loading