Skip to content

test(e2e): use page.waitForTimeout #700

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 2 commits into from
Jan 16, 2025
Merged

test(e2e): use page.waitForTimeout #700

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b013a2
test(e2e): use page.waitForTimeout
vicb Jan 15, 2025
5d84643
fixup! review feedback
vicb Jan 16, 2025
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
8 changes: 6 additions & 2 deletions packages/tests-e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,30 @@ Their respective `packages/` are located at:

The GitHub actions will trigger the [e2e test](/.github/workflows//e2e.yml), which deploys the app in the [Example](/example/) folder. The deploy command is:

### Running the tests against the deployed app
## Running the tests against the deployed app

1. Deploy the app

```bash
cd examples/sst
npx sst deploy --stage e2e
```

2. Export the URLS

```bash
export APP_ROUTER_URL=$(jq -r '.["e2e-example-AppRouter"].url' .sst/outputs.json)
export PAGES_ROUTER_URL=$(jq -r '.["e2e-example-PagesRouter"].url' .sst/outputs.json)
export APP_PAGES_ROUTER_URL=$(jq -r '.["e2e-example-AppPagesRouter"].url' .sst/outputs.json)
```

3. Run the test

```bash
cd ../../packages/tests-e2e
pnpm run e2e:dev
```


## Gotchas

`isr.test.ts` returns a timestamp, when running `next dev`, ISR does not cache so each reload is a new timestamp. You'll need to `next build` and `next start` for Next to not cache.
10 changes: 4 additions & 6 deletions packages/tests-e2e/tests/appPagesRouter/isr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Incremental Static Regeneration", async ({ page }) => {
test.setTimeout(60000);
await page.goto("/");
Expand All @@ -14,7 +12,7 @@ test("Incremental Static Regeneration", async ({ page }) => {
let newTime: typeof time;
let tempTime = time;
do {
await wait(1000);
await page.waitForTimeout(1000);
await page.reload();
time = tempTime;
el = page.getByText("Time:");
Expand All @@ -23,17 +21,17 @@ test("Incremental Static Regeneration", async ({ page }) => {
} while (time !== newTime);
await page.reload();

await wait(1000);
await page.waitForTimeout(1000);
el = page.getByText("Time:");
const midTime = await el.textContent();
// Expect that the time is still stale
expect(midTime).toEqual(newTime);

// Wait 10 + 1 seconds for ISR to regenerate time
await wait(11000);
await page.waitForTimeout(11000);
let finalTime = newTime;
do {
await wait(2000);
await page.waitForTimeout(2000);
el = page.getByText("Time:");
finalTime = await el.textContent();
await page.reload();
Expand Down
10 changes: 4 additions & 6 deletions packages/tests-e2e/tests/appPagesRouter/pages_isr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Incremental Static Regeneration", async ({ page }) => {
test.setTimeout(60000);
await page.goto("/");
Expand All @@ -16,25 +14,25 @@ test("Incremental Static Regeneration", async ({ page }) => {
let newTime: typeof time;
let tempTime = time;
do {
await wait(1000);
await page.waitForTimeout(1000);
await page.reload();
time = tempTime;
el = page.getByText("Time:");
newTime = await el.textContent();
tempTime = newTime;
} while (time !== newTime);
await page.reload();
await wait(1000);
await page.waitForTimeout(1000);
el = page.getByText("Time:");
const midTime = await el.textContent();
// Expect that the time is still stale
expect(midTime).toEqual(newTime);

// Wait 10 + 1 seconds for ISR to regenerate time
await wait(11000);
await page.waitForTimeout(11000);
let finalTime = newTime;
do {
await wait(2000);
await page.waitForTimeout(2000);
el = page.getByText("Time:");
finalTime = await el.textContent();
await page.reload();
Expand Down
4 changes: 1 addition & 3 deletions packages/tests-e2e/tests/appPagesRouter/pages_ssr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Server Side Render", async ({ page }) => {
await page.goto("/");
await page.locator('[href="/pages_ssr"]').click();
Expand All @@ -24,6 +22,6 @@ test("Server Side Render", async ({ page }) => {
await expect(el).toBeVisible();
expect(time).not.toEqual(newTime);
time = newTime;
await wait(250);
await page.waitForTimeout(250);
}
});
4 changes: 1 addition & 3 deletions packages/tests-e2e/tests/appPagesRouter/ssr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Server Side Render", async ({ page }) => {
await page.goto("/");
await page.locator('[href="/ssr"]').click();
Expand All @@ -24,7 +22,7 @@ test("Server Side Render", async ({ page }) => {
await expect(el).toBeVisible();
expect(time).not.toEqual(newTime);
time = newTime;
await wait(250);
await page.waitForTimeout(250);
}
});

Expand Down
12 changes: 5 additions & 7 deletions packages/tests-e2e/tests/appRouter/isr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Incremental Static Regeneration", async ({ page }) => {
test.setTimeout(45000);
await page.goto("/");
Expand All @@ -14,7 +12,7 @@ test("Incremental Static Regeneration", async ({ page }) => {
let newTime: typeof time;
let tempTime = time;
do {
await wait(1000);
await page.waitForTimeout(1000);
await page.reload();
time = tempTime;
el = page.getByText("Time:");
Expand All @@ -23,17 +21,17 @@ test("Incremental Static Regeneration", async ({ page }) => {
} while (time !== newTime);
await page.reload();

await wait(1000);
await page.waitForTimeout(1000);
el = page.getByText("Time:");
const midTime = await el.textContent();
// Expect that the time is still stale
expect(midTime).toEqual(newTime);

// Wait 10 + 1 seconds for ISR to regenerate time
await wait(11000);
await page.waitForTimeout(11000);
let finalTime = newTime;
do {
await wait(2000);
await page.waitForTimeout(2000);
el = page.getByText("Time:");
finalTime = await el.textContent();
await page.reload();
Expand All @@ -56,7 +54,7 @@ test("headers", async ({ page }) => {
if (headers["cache-control"] === "max-age=10, stale-while-revalidate=999") {
break;
}
await wait(1000);
await page.waitForTimeout(1000);
responsePromise = page.waitForResponse((response) => {
return response.status() === 200;
});
Expand Down
10 changes: 4 additions & 6 deletions packages/tests-e2e/tests/appRouter/sse.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

import { expect, test } from "@playwright/test";

import { wait } from "../utils";

// NOTE: We don't await page load b/c we want to see the Loading page
test("Server Sent Events", async ({ page }) => {
await page.goto("/");
Expand All @@ -17,31 +15,31 @@ test("Server Sent Events", async ({ page }) => {
// 2nd message shouldn't arrive yet
let msg2 = page.getByText(`Message 2: {"message":"hello:2"`);
await expect(msg2).not.toBeVisible();
await wait(2000);
await page.waitForTimeout(2000);
// 2nd message should arrive after 2s
msg2 = page.getByText(`Message 2: {"message":"hello:2"`);
await expect(msg2).toBeVisible();

// 3rd message shouldn't arrive yet
let msg3 = page.getByText(`Message 3: {"message":"hello:3"`);
await expect(msg3).not.toBeVisible();
await wait(2000);
await page.waitForTimeout(2000);
// 3rd message should arrive after 2s
msg3 = page.getByText(`Message 3: {"message":"hello:3"`);
await expect(msg3).toBeVisible();

// 4th message shouldn't arrive yet
let msg4 = page.getByText(`Message 4: {"message":"hello:4"`);
await expect(msg4).not.toBeVisible();
await wait(2000);
await page.waitForTimeout(2000);
// 4th message should arrive after 2s
msg4 = page.getByText(`Message 4: {"message":"hello:4"`);
await expect(msg4).toBeVisible();

let close = page.getByText(`Message 5: {"message":"close"`);
await expect(close).not.toBeVisible();

await wait(2000);
await page.waitForTimeout(2000);
close = page.getByText(`Message 5: {"message":"close"`);
await expect(close).toBeVisible();
});
8 changes: 3 additions & 5 deletions packages/tests-e2e/tests/appRouter/ssr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

import { expect, test } from "@playwright/test";

import { wait } from "../utils";

// NOTE: We don't await page load b/c we want to see the Loading page
test("Server Side Render and loading.tsx", async ({ page }) => {
test.setTimeout(600000);
Expand All @@ -25,7 +23,7 @@ test("Server Side Render and loading.tsx", async ({ page }) => {
const time = await el.textContent();
expect(time).not.toEqual(lastTime);
lastTime = time!;
await wait(1000);
await page.waitForTimeout(1000);
}

// let loading = page.getByText("Loading...");
Expand All @@ -44,7 +42,7 @@ test("Server Side Render and loading.tsx", async ({ page }) => {
// await expect(el).toBeVisible();
// await expect(time).not.toEqual(newTime);

// await wait(5000);
// await page.waitForTimeout(5000);
Copy link
Contributor

Choose a reason for hiding this comment

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

We can just remove everything in the comments here, i don't think it's useful anymore

// page.reload();
// loading = page.getByText("Loading...");
// await expect(loading).toBeVisible();
Expand All @@ -58,7 +56,7 @@ test("Server Side Render and loading.tsx", async ({ page }) => {
test("Fetch cache properly cached", async ({ page }) => {
await page.goto("/ssr");
const originalDate = await page.getByText("Cached fetch:").textContent();
await wait(2000);
await page.waitForTimeout(2000);
await page.reload();
const newDate = await page.getByText("Cached fetch:").textContent();
expect(originalDate).toEqual(newDate);
Expand Down
10 changes: 4 additions & 6 deletions packages/tests-e2e/tests/pagesRouter/isr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Incremental Static Regeneration", async ({ page }) => {
test.setTimeout(45000);
await page.goto("/");
Expand All @@ -15,25 +13,25 @@ test("Incremental Static Regeneration", async ({ page }) => {
let newTime: typeof time;
let tempTime = time;
do {
await wait(1000);
await page.waitForTimeout(1000);
await page.reload();
time = tempTime;
el = page.getByText("Time:");
newTime = await el.textContent();
tempTime = newTime;
} while (time !== newTime);
await page.reload();
await wait(1000);
await page.waitForTimeout(1000);
el = page.getByText("Time:");
const midTime = await el.textContent();
// Expect that the time is still stale
expect(midTime).toEqual(newTime);

// Wait 10 + 1 seconds for ISR to regenerate time
await wait(11000);
await page.waitForTimeout(11000);
let finalTime = newTime;
do {
await wait(2000);
await page.waitForTimeout(2000);
el = page.getByText("Time:");
finalTime = await el.textContent();
await page.reload();
Expand Down
4 changes: 1 addition & 3 deletions packages/tests-e2e/tests/pagesRouter/ssr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { expect, test } from "@playwright/test";

import { wait } from "../utils";

test("Server Side Render", async ({ page }) => {
await page.goto("/");
await page.locator('[href="/ssr/"]').click();
Expand All @@ -24,7 +22,7 @@ test("Server Side Render", async ({ page }) => {
await expect(el).toBeVisible();
expect(time).not.toEqual(newTime);
time = newTime;
await wait(250);
await page.waitForTimeout(250);
}
});

Expand Down
3 changes: 0 additions & 3 deletions packages/tests-e2e/tests/utils.ts
View file
Open in desktop

This file was deleted.

Loading