chore: sync e2e tests with aws (#974)

Author: vicb

examples/e2e/app-pages-router/e2e/host.test.ts

@@ -2,7 +2,6 @@ import { expect, test } from "@playwright/test";
 
 /**
  * Tests that the request.url is correct
- *
  */
 test("Request.url is host", async ({ baseURL, page }) => {
 	await page.goto("/api/host");

examples/e2e/app-pages-router/e2e/middleware.test.ts

@@ -0,0 +1,16 @@
+import { expect, test } from "@playwright/test";
+
+test("should return correctly on HEAD request with an empty body", async ({ request }) => {
+	const response = await request.head("/head");
+	expect(response.status()).toBe(200);
+	const body = await response.text();
+	expect(body).toBe("");
+	expect(response.headers()["x-from-middleware"]).toBe("true");
+});
+
+test("should return correctly for directly returning a fetch response", async ({ request }) => {
+	const response = await request.get("/fetch");
+	expect(response.status()).toBe(200);
+	const body = await response.json();
+	expect(body).toEqual({ hello: "world" });
+});

examples/e2e/app-router/e2e/headers.test.ts

@@ -24,4 +24,21 @@ test("Headers", async ({ page }) => {
 	// Both these headers should not be present cause poweredByHeader is false in appRouter
 	expect(headers["x-powered-by"]).toBeFalsy();
 	expect(headers["x-opennext"]).toBeFalsy();
+
+	// Request ID header should be set
+	expect(headers["x-opennext-requestid"]).not.toBeFalsy();
+});
+/**
+ * Tests that the middleware headers are applied after next.config.js headers. Requires 'dangerous.middlewareHeadersOverrideNextConfigHeaders' to be set.
+ */
+test("Middleware headers override next.config.js headers", async ({ page }) => {
+	const responsePromise = page.waitForResponse((response) => {
+		return response.status() === 200;
+	});
+	await page.goto("/headers/override-from-middleware");
+	const response = await responsePromise;
+	// Response header should be set
+	const headers = response.headers();
+	// The next.config.js headers is overwritten by the middleware
+	expect(headers["e2e-headers"]).toEqual("middleware");
 });

examples/e2e/app-router/e2e/host.test.ts

@@ -2,7 +2,6 @@ import { expect, test } from "@playwright/test";
 
 /**
  * Tests that the request.url is correct
- *
  */
 test("Request.url is host", async ({ baseURL, page }) => {
 	await page.goto("/api/host");

examples/e2e/app-router/e2e/image-optimization.test.ts

@@ -17,3 +17,11 @@ test.skip("Image Optimization", async ({ page }) => {
 	await expect(el).toHaveJSProperty("complete", true);
 	await expect(el).not.toHaveJSProperty("naturalWidth", 0);
 });
+
+// Image Optimization is currently not supported: https://github.com/opennextjs/opennextjs-cloudflare/issues/106
+test.skip("should return 400 when validateParams returns an errorMessage", async ({ request }) => {
+	const res = await request.get("/_next/image");
+	expect(res.status()).toBe(400);
+	expect(res.headers()["cache-control"]).toBe("public,max-age=60,immutable");
+	expect(await res.text()).toBe(`"url" parameter is required`);
+});

examples/e2e/app-router/e2e/isr.test.ts

@@ -103,7 +103,6 @@ test.describe("dynamicParams set to true", () => {
 	test("should be HIT on a path that was prebuilt", async ({ page }) => {
 		const res = await page.goto("/isr/dynamic-params-true/1");
 		expect(res?.status()).toEqual(200);
-		// TODO: sync this to aws
 		const cacheHeader = res?.headers()["x-nextjs-cache"] ?? res?.headers()["x-opennext-cache"];
 		expect(cacheHeader).toEqual("HIT");
 		const title = await page.getByTestId("title").textContent();
@@ -117,7 +116,6 @@ test.describe("dynamicParams set to true", () => {
 	// We are gonna skip this one for now, turborepo caching can cause this page to be STALE once deployed
 	test.skip("should SSR on a path that was not prebuilt", async ({ page }) => {
 		const res = await page.goto("/isr/dynamic-params-true/11");
-		// TODO: sync this to aws
 		const cacheHeader = res?.headers()["x-nextjs-cache"] ?? res?.headers()["x-opennext-cache"];
 		expect(cacheHeader).toEqual("MISS");
 		const title = await page.getByTestId("title").textContent();
@@ -144,7 +142,6 @@ test.describe("dynamicParams set to false", () => {
 	test("should be HIT on a path that was prebuilt", async ({ page }) => {
 		const res = await page.goto("/isr/dynamic-params-false/1");
 		expect(res?.status()).toEqual(200);
-		// TODO: sync this to aws
 		const cacheHeader = res?.headers()["x-nextjs-cache"] ?? res?.headers()["x-opennext-cache"];
 		expect(cacheHeader).toEqual("HIT");
 		const title = await page.getByTestId("title").textContent();

examples/e2e/app-router/middleware.ts

@@ -47,6 +47,12 @@ export function middleware(request: NextRequest) {
 	// Response headers should show up in the client's response headers
 	responseHeaders.set("response-header", "response-header");
 
+	// For dangerous.middlewareHeadersOverrideNextConfigHeaders we need to verify that middleware headers override next.config.js headers.
+	if (path === "/headers/override-from-middleware") {
+		responseHeaders.set("e2e-headers", "middleware");
+		return NextResponse.json({}, { headers: responseHeaders });
+	}
+
 	// Set the cache control header with custom swr
 	// For: isr.test.ts
 	if (path === "/isr" && !request.headers.get("x-prerender-revalidate")) {

examples/e2e/app-router/open-next.config.ts

@@ -4,7 +4,7 @@ import shardedTagCache from "@opennextjs/cloudflare/overrides/tag-cache/do-shard
 import doQueue from "@opennextjs/cloudflare/overrides/queue/do-queue";
 import queueCache from "@opennextjs/cloudflare/overrides/queue/queue-cache";
 
-export default defineCloudflareConfig({
+const baseConfig = defineCloudflareConfig({
 	incrementalCache: r2IncrementalCache,
 	// With such a configuration, we could have up to 12 * (8 + 2) = 120 Durable Objects instances
 	tagCache: shardedTagCache({
@@ -24,3 +24,11 @@ export default defineCloudflareConfig({
 	enableCacheInterception: true,
 	queue: queueCache(doQueue),
 });
+
+export default {
+	...baseConfig,
+	dangerous: {
+		...baseConfig.dangerous,
+		middlewareHeadersOverrideNextConfigHeaders: true,
+	},
+};

examples/e2e/app-router/wrangler.jsonc

@@ -41,5 +41,8 @@
 			"binding": "WORKER_SELF_REFERENCE",
 			"service": "app-router"
 		}
-	]
+	],
+	"vars": {
+		"OPEN_NEXT_REQUEST_ID_HEADER": "true"
+	}
 }

examples/e2e/pages-router/e2e/catch-all-optional.test.ts

@@ -0,0 +1,27 @@
+import { expect, test } from "@playwright/test";
+// Going to `/`, `/conico974`, `/kheuzy` and `/sommeeer` should be catched by our `[[...page]]` route.
+// Also the /super/long/path/to/secret/page should be pregenerated by the `getStaticPaths` function.
+test.describe("Catch-all optional route in root should work", () => {
+	test("should be possible to visit home and a pregenerated subpage", async ({ page }) => {
+		await page.goto("/");
+		await page.locator("h1").getByText("Pages Router").isVisible();
+		await page.goto("/conico974");
+		const pElement = page.getByText("Path: conico974", { exact: true });
+		await pElement.isVisible();
+	});
+
+	test("should be possible to visit a long pregenerated path", async ({ page }) => {
+		await page.goto("/super/long/path/to/secret/page");
+		const h1Text = await page.getByTestId("page").textContent();
+		expect(h1Text).toBe("Page: super,long,path,to,secret,page");
+	});
+
+	test("should be possible to request an API route when you have a catch-all in root", async ({
+		request,
+	}) => {
+		const response = await request.get("/api/hello");
+		expect(response.status()).toBe(200);
+		const body = await response.json();
+		expect(body).toEqual({ hello: "OpenNext rocks!" });
+	});
+});