{Date.now()}
+} + +export const revalidate = 1000 diff --git a/test/e2e/on-request-error/isr/app/app/route/on-demand/route.js b/test/e2e/on-request-error/isr/app/app/route/on-demand/route.js new file mode 100644 index 0000000000000..368a11ce7c61f --- /dev/null +++ b/test/e2e/on-request-error/isr/app/app/route/on-demand/route.js @@ -0,0 +1,8 @@ +export function GET() { + if (process.env.NEXT_PHASE !== 'phase-production-build') { + throw new Error('app:route:on-demand') + } + return new Response('app:route') +} + +export const revalidate = 1000 diff --git a/test/e2e/on-request-error/isr/app/app/route/stale/route.js b/test/e2e/on-request-error/isr/app/app/route/stale/route.js new file mode 100644 index 0000000000000..70431034886a9 --- /dev/null +++ b/test/e2e/on-request-error/isr/app/app/route/stale/route.js @@ -0,0 +1,8 @@ +export function GET() { + if (process.env.NEXT_PHASE !== 'phase-production-build') { + throw new Error('app:route:stale') + } + return new Response('app:route') +} + +export const revalidate = 2 diff --git a/test/e2e/on-request-error/isr/app/app/self-revalidate/action.js b/test/e2e/on-request-error/isr/app/app/self-revalidate/action.js new file mode 100644 index 0000000000000..815a97b132a45 --- /dev/null +++ b/test/e2e/on-request-error/isr/app/app/self-revalidate/action.js @@ -0,0 +1,7 @@ +'use server' + +import { revalidatePath } from 'next/cache' + +export async function revalidateSelf() { + revalidatePath('/app/self-revalidate') +} diff --git a/test/e2e/on-request-error/isr/app/app/self-revalidate/page.js b/test/e2e/on-request-error/isr/app/app/self-revalidate/page.js new file mode 100644 index 0000000000000..42330d94f5fc6 --- /dev/null +++ b/test/e2e/on-request-error/isr/app/app/self-revalidate/page.js @@ -0,0 +1,21 @@ +'use client' + +import { revalidateSelf } from './action' + +export default function Page() { + if (typeof window === 'undefined') { + if (process.env.NEXT_PHASE !== 'phase-production-build') { + throw new Error('app:self-revalidate') + } + } + return ( + + ) +} diff --git a/test/e2e/on-request-error/isr/app/app/stale/page.js b/test/e2e/on-request-error/isr/app/app/stale/page.js new file mode 100644 index 0000000000000..68e00ffdfe226 --- /dev/null +++ b/test/e2e/on-request-error/isr/app/app/stale/page.js @@ -0,0 +1,7 @@ +export default function Page() { + if (process.env.NEXT_PHASE !== 'phase-production-build') + throw new Error('app:stale') + return{Date.now()}
+} + +export const revalidate = 2 diff --git a/test/e2e/on-request-error/isr/app/layout.js b/test/e2e/on-request-error/isr/app/layout.js new file mode 100644 index 0000000000000..8525f5f8c0b2a --- /dev/null +++ b/test/e2e/on-request-error/isr/app/layout.js @@ -0,0 +1,12 @@ +export const metadata = { + title: 'Next.js', + description: 'Generated by Next.js', +} + +export default function RootLayout({ children }) { + return ( + + {children} + + ) +} diff --git a/test/e2e/on-request-error/isr/instrumentation.js b/test/e2e/on-request-error/isr/instrumentation.js new file mode 100644 index 0000000000000..bceaf1dda7512 --- /dev/null +++ b/test/e2e/on-request-error/isr/instrumentation.js @@ -0,0 +1,31 @@ +import fs from 'fs' +import fsp from 'fs/promises' +import path from 'path' + +const dir = path.dirname(new URL(import.meta.url).pathname) +const logPath = path.join(dir, 'output-log.json') + +export async function register() { + await fsp.writeFile(logPath, '{}', 'utf8') +} + +// Since only Node.js runtime support ISR, we can just write the error state to a file here. +// `onRequestError` will only be bundled within the Node.js runtime. +export async function onRequestError(err, request, context) { + const payload = { + message: err.message, + request, + context, + } + + const json = fs.existsSync(logPath) + ? JSON.parse(await fsp.readFile(logPath, 'utf8')) + : {} + + json[payload.message] = payload + + console.log( + `[instrumentation] write-log:${payload.message} ${payload.context.revalidateReason}` + ) + await fsp.writeFile(logPath, JSON.stringify(json, null, 2), 'utf8') +} diff --git a/test/e2e/on-request-error/isr/isr.test.ts b/test/e2e/on-request-error/isr/isr.test.ts new file mode 100644 index 0000000000000..3bb73ced425a0 --- /dev/null +++ b/test/e2e/on-request-error/isr/isr.test.ts @@ -0,0 +1,93 @@ +import { nextTestSetup } from 'e2e-utils' +import { retry, waitFor } from 'next-test-utils' +import { getOutputLogJson } from '../_testing/utils' + +const outputLogPath = 'output-log.json' + +describe('on-request-error - isr', () => { + const { next, skipped, isNextDev } = nextTestSetup({ + files: __dirname, + skipDeployment: true, + }) + + if (skipped) { + return + } + + if (isNextDev) { + it('should skip in development mode', () => { + // This ISR test is only applicable for production mode + }) + return + } + + async function matchRevalidateReason( + errorMessage: string, + revalidateReason: string + ) { + await retry(async () => { + const json = await getOutputLogJson(next, outputLogPath) + expect(json[errorMessage]).toMatchObject({ + context: { + revalidateReason, + }, + }) + }) + } + + describe('app router ISR', () => { + it('should capture correct reason for stale errored page', async () => { + await next.fetch('/app/stale') + await waitFor(2 * 1000) // wait for revalidation + await next.fetch('/app/stale') + + await matchRevalidateReason('app:stale', 'stale') + }) + + it('should capture correct reason for on-demand revalidated page', async () => { + await next.fetch('/api/revalidate-path?path=/app/on-demand') + + await matchRevalidateReason('app:on-demand', 'on-demand') + }) + + it('should capture correct reason for build errored route', async () => { + await next.fetch('/app/route/stale') + await waitFor(2 * 1000) // wait for revalidation + await next.fetch('/app/route/stale') + + await matchRevalidateReason('app:route:stale', 'stale') + }) + + it('should capture correct reason for on-demand revalidated route', async () => { + await next.fetch('/api/revalidate-path?path=/app/route/on-demand') + + await matchRevalidateReason('app:route:on-demand', 'on-demand') + }) + + it('should capture revalidate from server action', async () => { + const browser = await next.browser('/app/self-revalidate') + const button = await browser.elementByCss('button') + await button.click() + + await retry(async () => { + await next.fetch('/app/self-revalidate') + await matchRevalidateReason('app:self-revalidate', 'stale') + }) + }) + }) + + describe('pages router ISR', () => { + it('should capture correct reason for stale errored page', async () => { + await next.fetch('/pages/stale') + await waitFor(2 * 1000) // wait for revalidation + await next.fetch('/pages/stale') + + await matchRevalidateReason('pages:stale', 'stale') + }) + + it('should capture correct reason for on-demand revalidated page', async () => { + await next.fetch('/api/revalidate-path?path=/pages/on-demand') + await matchRevalidateReason('pages:on-demand', 'on-demand') + }) + }) +}) diff --git a/test/e2e/on-request-error/isr/next.config.js b/test/e2e/on-request-error/isr/next.config.js new file mode 100644 index 0000000000000..c4cf84a76553b --- /dev/null +++ b/test/e2e/on-request-error/isr/next.config.js @@ -0,0 +1,5 @@ +module.exports = { + experimental: { + instrumentationHook: true, + }, +} diff --git a/test/e2e/on-request-error/isr/pages/api/revalidate-path.js b/test/e2e/on-request-error/isr/pages/api/revalidate-path.js new file mode 100644 index 0000000000000..2183f8cfd0f70 --- /dev/null +++ b/test/e2e/on-request-error/isr/pages/api/revalidate-path.js @@ -0,0 +1,11 @@ +export default async function handler(req, res) { + const { path } = req.query + try { + await res.revalidate(path) + return res.json({ revalidated: true }) + } catch (err) { + console.error('Failed to revalidate:', err) + } + + res.json({ revalidated: false }) +} diff --git a/test/e2e/on-request-error/isr/pages/pages/on-demand.js b/test/e2e/on-request-error/isr/pages/pages/on-demand.js new file mode 100644 index 0000000000000..4b6d507ec8223 --- /dev/null +++ b/test/e2e/on-request-error/isr/pages/pages/on-demand.js @@ -0,0 +1,16 @@ +export default function Page() { + if (typeof window === 'undefined') { + if (process.env.NEXT_PHASE !== 'phase-production-build') + throw new Error('pages:on-demand') + } + return{Date.now()}
+} + +export async function getStaticProps() { + return { + props: { + key: 'value', + }, + revalidate: 1000, + } +} diff --git a/test/e2e/on-request-error/isr/pages/pages/stale.js b/test/e2e/on-request-error/isr/pages/pages/stale.js new file mode 100644 index 0000000000000..65244cc825153 --- /dev/null +++ b/test/e2e/on-request-error/isr/pages/pages/stale.js @@ -0,0 +1,17 @@ +export default function Page() { + if (typeof window === 'undefined') { + if (process.env.NEXT_PHASE !== 'phase-production-build') + throw new Error('pages:stale') + } + + return{Date.now()}
+} + +export async function getStaticProps() { + return { + props: { + key: 'value', + }, + revalidate: 2, + } +} diff --git a/test/ppr-tests-manifest.json b/test/ppr-tests-manifest.json index 8bf04079f667b..b8fab0c850b44 100644 --- a/test/ppr-tests-manifest.json +++ b/test/ppr-tests-manifest.json @@ -30,6 +30,13 @@ "app dir - not found navigation - with overridden node env should be able to navigate to other page from root not-found page" ] }, + "test/e2e/on-request-error/isr/isr.test.ts": { + "failed": [ + "on-request-error - isr app router ISR should capture correct reason for stale errored page", + "on-request-error - isr app router ISR should capture correct reason for on-demand revalidated page", + "on-request-error - isr app router ISR should capture revalidate from server action" + ] + }, "test/e2e/opentelemetry/opentelemetry.test.ts": { "failed": [ "opentelemetry root context app router should handle RSC with fetch",