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

use dynamic import for prerender manifest in e2e #728

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+22 −12
Open

use dynamic import for prerender manifest in e2e #728

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
545fbd5
use dynamic import for prerender manifest in e2e
james-elicx Feb 6, 2025
02944a5
use suggested path
james-elicx Feb 7, 2025
a337c0d
fix e2e
conico974 Feb 7, 2025
57c5e8f
use with instead of assert
james-elicx Feb 7, 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
32 changes: 20 additions & 12 deletions examples/app-router/app/api/isr/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
import fs from "node:fs/promises";
import path from "node:path";
import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";

export const dynamic = "force-dynamic";

// This endpoint simulates an on demand revalidation request
export async function GET(request: NextRequest) {
const cwd = process.cwd();
const prerenderManifest = await fs.readFile(
path.join(cwd, ".next/prerender-manifest.json"),
"utf-8",
);
const manifest = JSON.parse(prerenderManifest);
let manifest: { preview: { previewModeId: string } };
// This fails at build time when next.js tries to evaluate the route
try {
const prerenderManifest = await import(
// @ts-expect-error
/* webpackIgnore: true */ "./.next/prerender-manifest.json"
);
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't work here, the file are not at the right place.
Probably something like that "../../../../prerender-manifest.json" should do the trick.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To be honest I didn't run it locally because the e2e readme said the first step was to deploy the app...

If I run it with next start, it still returns a 500 for the route with this - I presume it's because of how Next.js serves the app. Unsure what will happen in the OpenNext build though as I can't run e2es locally.

Copy link
Contributor

Choose a reason for hiding this comment

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

What if we fallback on readFile on error and add a comment that the import is specific for @opennextjs/cloudflare?

If not we can diverge an reconcile later (add a comment in our version of the tests)

Copy link
Contributor

Choose a reason for hiding this comment

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

I found the issue actually, they were 2 issues locally :
host is undefined with next start
and you need to add { assert: { type: "json" } } in the import

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Interesting. Thanks for taking a look. Although we'll want to use with instead of assert as it's deprecated.

manifest = prerenderManifest.default;
} catch {
return new Response(null, { status: 500 });
}

const previewId = manifest.preview.previewModeId;

const result = await fetch(`https://${request.headers.get("host")}/isr`, {
headers: { "x-prerender-revalidate": previewId },
method: "HEAD",
});
const host = request.headers.get("host");
const result = await fetch(
`http${host?.includes("localhost") ? "" : "s"}://${host}/isr`,
{
headers: { "x-prerender-revalidate": previewId },
method: "HEAD",
},
);

return NextResponse.json({
status: 200,
Expand Down
Loading