From 4e13ef7199ba540a1bb7a232a2411926cc3106d1 Mon Sep 17 00:00:00 2001 From: Rob Stanford Date: Fri, 15 Nov 2024 14:03:16 +0000 Subject: [PATCH 1/5] tests: add routing tests --- tests/e2e/routing.test.ts | 38 +++++++++++++++++++ .../page.js | 0 .../app/static-fetch-dynamic/[id]/page.js | 33 ++++++++++++++++ .../fixtures/server-components/next-env.d.ts | 3 +- .../server-components/pages/api/okay.js | 3 ++ .../server-components/pages/api/posts/[id].js | 4 ++ .../server-components/pages/dynamic.js | 11 ++++++ .../pages/posts/dynamic/[id].js | 25 ++++++++++++ .../pages/posts/prerendered/[id].js | 33 ++++++++++++++++ .../server-components/pages/prerendered.js | 11 ++++++ .../server-components/pages/static.js | 3 ++ .../fixtures/server-components/tsconfig.json | 20 ++++++++-- 12 files changed, 179 insertions(+), 5 deletions(-) create mode 100644 tests/e2e/routing.test.ts rename tests/fixtures/server-components/app/{static-fetch-dynamic => static-fetch-dynamic-1}/page.js (100%) create mode 100644 tests/fixtures/server-components/app/static-fetch-dynamic/[id]/page.js create mode 100644 tests/fixtures/server-components/pages/api/okay.js create mode 100644 tests/fixtures/server-components/pages/api/posts/[id].js create mode 100644 tests/fixtures/server-components/pages/dynamic.js create mode 100644 tests/fixtures/server-components/pages/posts/dynamic/[id].js create mode 100644 tests/fixtures/server-components/pages/posts/prerendered/[id].js create mode 100644 tests/fixtures/server-components/pages/prerendered.js create mode 100644 tests/fixtures/server-components/pages/static.js diff --git a/tests/e2e/routing.test.ts b/tests/e2e/routing.test.ts new file mode 100644 index 0000000000..ad51cf0536 --- /dev/null +++ b/tests/e2e/routing.test.ts @@ -0,0 +1,38 @@ +import { expect } from '@playwright/test' +import { test } from '../utils/playwright-helpers.js' + +const ssrRoutes = [ + ['/static', 'pages router, static rendering, static routing'], + ['/prerendered', 'pages router, prerendering, static routing'], + ['/posts/prerendered/1', 'pages router, prerendering, dynamic routing'], + ['/dynamic', 'pages router, dynamic rendering, static routing'], + ['/posts/dynamic/1', 'pages router, dynamic rendering, dynamic routing'], + ['/api/okay', 'pages router, api route, static routing'], + ['/api/posts/1', 'pages router, api route, dynamic routing'], + ['/static-fetch-1', 'app router, prerendering, static routing'], + ['/static-fetch/1', 'app router, prerendering, dynamic routing'], + ['/static-fetch-dynamic-1', 'app router, dynamic rendering, static routing'], + ['/static-fetch-dynamic/1', 'app router, dynamic rendering, dynamic routing'], + ['/api/revalidate-handler', 'app router, route handler, static routing'], + ['/api/static/1', 'app router, route handler, dynamic routing'], +] + +const notFoundRoutes = [ + ['/non-existing', 'default'], + ['/prerendered/3', 'prerendering, dynamic routing'], + ['/dynamic/3', 'dynamic rendering, dynamic routing'], + ['/api/non-existing', 'route handler, static routing'], +] + +test(`routing works correctly`, async ({ page, serverComponents }) => { + for (const [path, description] of ssrRoutes) { + const url = new URL(path, serverComponents.url).href + const response = await page.goto(url) + expect(response?.status(), `expected 200 response for ${description}`).toBe(200) + } + for (const [path, description] of notFoundRoutes) { + const url = new URL(path, serverComponents.url).href + const response = await page.goto(url) + expect(response?.status(), `expected 404 response for ${description}`).toBe(404) + } +}) diff --git a/tests/fixtures/server-components/app/static-fetch-dynamic/page.js b/tests/fixtures/server-components/app/static-fetch-dynamic-1/page.js similarity index 100% rename from tests/fixtures/server-components/app/static-fetch-dynamic/page.js rename to tests/fixtures/server-components/app/static-fetch-dynamic-1/page.js diff --git a/tests/fixtures/server-components/app/static-fetch-dynamic/[id]/page.js b/tests/fixtures/server-components/app/static-fetch-dynamic/[id]/page.js new file mode 100644 index 0000000000..85c8019450 --- /dev/null +++ b/tests/fixtures/server-components/app/static-fetch-dynamic/[id]/page.js @@ -0,0 +1,33 @@ +export async function generateStaticParams() { + return [{ id: '1' }, { id: '2' }] +} + +async function getData(params) { + const res = await fetch(`https://api.tvmaze.com/shows/${params.id}`, { + next: { + tags: [`show-${params.id}`], + }, + }) + return res.json() +} + +export default async function Page({ params }) { + const data = await getData(params) + + return ( + <> +

Hello, Force Dynamically Rendered Server Component

+

Paths /1 and /2 prerendered; other paths not found

+
+
Show
+
{data.name}
+
Param
+
{params.id}
+
Time
+
{new Date().toISOString()}
+
+ + ) +} + +export const dynamic = 'force-dynamic' diff --git a/tests/fixtures/server-components/next-env.d.ts b/tests/fixtures/server-components/next-env.d.ts index 4f11a03dc6..725dd6f245 100644 --- a/tests/fixtures/server-components/next-env.d.ts +++ b/tests/fixtures/server-components/next-env.d.ts @@ -1,5 +1,6 @@ /// /// +/// // NOTE: This file should not be edited -// see https://nextjs.org/docs/basic-features/typescript for more information. +// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information. diff --git a/tests/fixtures/server-components/pages/api/okay.js b/tests/fixtures/server-components/pages/api/okay.js new file mode 100644 index 0000000000..45a65589e6 --- /dev/null +++ b/tests/fixtures/server-components/pages/api/okay.js @@ -0,0 +1,3 @@ +export default async function handler(req, res) { + return res.send({ code: 200, message: 'okay' }) +} diff --git a/tests/fixtures/server-components/pages/api/posts/[id].js b/tests/fixtures/server-components/pages/api/posts/[id].js new file mode 100644 index 0000000000..3fd01f0efb --- /dev/null +++ b/tests/fixtures/server-components/pages/api/posts/[id].js @@ -0,0 +1,4 @@ +export default function handler(req, res) { + const { id } = req.query + res.send({ code: 200, message: `okay ${id}` }) +} diff --git a/tests/fixtures/server-components/pages/dynamic.js b/tests/fixtures/server-components/pages/dynamic.js new file mode 100644 index 0000000000..c0b8aae2ba --- /dev/null +++ b/tests/fixtures/server-components/pages/dynamic.js @@ -0,0 +1,11 @@ +export default function Yar({ title }) { + return

{title}

+} + +export async function getServerSideProps() { + return { + props: { + title: 'My Page', + }, + } +} diff --git a/tests/fixtures/server-components/pages/posts/dynamic/[id].js b/tests/fixtures/server-components/pages/posts/dynamic/[id].js new file mode 100644 index 0000000000..3b4b8d565d --- /dev/null +++ b/tests/fixtures/server-components/pages/posts/dynamic/[id].js @@ -0,0 +1,25 @@ +export default function Page({ params }) { + return ( + <> +

Hello, Dyanmically fetched show

+
+
Param
+
{params.id}
+
Time
+
{new Date().toISOString()}
+
+ + ) +} + +export async function getServerSideProps({ params }) { + const res = await fetch(`https://api.tvmaze.com/shows/${params.id}`) + const data = await res.json() + + return { + props: { + params, + data, + }, + } +} diff --git a/tests/fixtures/server-components/pages/posts/prerendered/[id].js b/tests/fixtures/server-components/pages/posts/prerendered/[id].js new file mode 100644 index 0000000000..d797fbf74b --- /dev/null +++ b/tests/fixtures/server-components/pages/posts/prerendered/[id].js @@ -0,0 +1,33 @@ +export default function Page({ params }) { + return ( + <> +

Hello, Statically fetched show

+

Paths /1 and /2 prerendered; other paths not found

+
+
Param
+
{params.id}
+
Time
+
{new Date().toISOString()}
+
+ + ) +} + +export async function getStaticPaths() { + return { + paths: [{ params: { id: '1' } }, { params: { id: '2' } }], + fallback: false, + } +} + +export async function getStaticProps({ params }) { + const res = await fetch(`https://api.tvmaze.com/shows/${params.id}`) + const data = await res.json() + + return { + props: { + params, + data, + }, + } +} diff --git a/tests/fixtures/server-components/pages/prerendered.js b/tests/fixtures/server-components/pages/prerendered.js new file mode 100644 index 0000000000..520a3d0b96 --- /dev/null +++ b/tests/fixtures/server-components/pages/prerendered.js @@ -0,0 +1,11 @@ +export default function Yar({ title }) { + return

{title}

+} + +export async function getStaticProps() { + return { + props: { + title: 'My Page', + }, + } +} diff --git a/tests/fixtures/server-components/pages/static.js b/tests/fixtures/server-components/pages/static.js new file mode 100644 index 0000000000..b6992717b0 --- /dev/null +++ b/tests/fixtures/server-components/pages/static.js @@ -0,0 +1,3 @@ +export default function Yup() { + return

Yup

+} diff --git a/tests/fixtures/server-components/tsconfig.json b/tests/fixtures/server-components/tsconfig.json index b3222239ed..fc46f3d6cf 100644 --- a/tests/fixtures/server-components/tsconfig.json +++ b/tests/fixtures/server-components/tsconfig.json @@ -1,6 +1,10 @@ { "compilerOptions": { - "lib": ["dom", "dom.iterable", "esnext"], + "lib": [ + "dom", + "dom.iterable", + "esnext" + ], "allowJs": true, "skipLibCheck": true, "strict": false, @@ -16,8 +20,16 @@ { "name": "next" } - ] + ], + "strictNullChecks": true }, - "include": ["next-env.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"], - "exclude": ["node_modules"] + "include": [ + "next-env.d.ts", + ".next/types/**/*.ts", + "**/*.ts", + "**/*.tsx" + ], + "exclude": [ + "node_modules" + ] } From 47be7cb21be7e70080ccfc0bb1e8b45cdaa74965 Mon Sep 17 00:00:00 2001 From: Rob Stanford Date: Fri, 15 Nov 2024 14:10:52 +0000 Subject: [PATCH 2/5] feat: configure ssr handler with known routes --- src/build/functions/server.ts | 14 ++++++++++++++ src/build/templates/handler.tmpl.js | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/build/functions/server.ts b/src/build/functions/server.ts index bd38a82162..b3cb217989 100644 --- a/src/build/functions/server.ts +++ b/src/build/functions/server.ts @@ -100,12 +100,26 @@ const applyTemplateVariables = (template: string, variables: Record { + return route + .replace(/\[\[\.\.\.(\w+)]]/g, ':$1*') // [[...slug]] -> :slug* + .replace(/\[\.{3}(\w+)]/g, ':$1+') // [...slug] -> :slug+ + .replace(/\[(\w+)]/g, ':$1') // [id] -> :id +} + /** Get's the content of the handler file that will be written to the lambda */ const getHandlerFile = async (ctx: PluginContext): Promise => { const templatesDir = join(ctx.pluginDir, 'dist/build/templates') + const routesManifest = await ctx.getRoutesManifest() + const routes = [...routesManifest.staticRoutes, ...routesManifest.dynamicRoutes] + .map((route) => transformRoutePattern(route.page)) + .join("','") + const templateVariables: Record = { '{{useRegionalBlobs}}': ctx.useRegionalBlobs.toString(), + '{{paths}}': routes, } // In this case it is a monorepo and we need to use a own template for it // as we have to change the process working directory diff --git a/src/build/templates/handler.tmpl.js b/src/build/templates/handler.tmpl.js index 0b10bcd902..1a089cb09f 100644 --- a/src/build/templates/handler.tmpl.js +++ b/src/build/templates/handler.tmpl.js @@ -44,6 +44,6 @@ export default async function handler(req, context) { } export const config = { - path: '/*', + path: ['{{paths}}'], preferStatic: true, } From 93b950a522b241fb6e32d52693d79786449e0096 Mon Sep 17 00:00:00 2001 From: Rob Stanford Date: Wed, 27 Nov 2024 20:07:14 +0000 Subject: [PATCH 3/5] feat: add additional routes to ssr paths --- src/build/functions/server.ts | 52 +++++++++++++++++++++++++++++------ src/build/plugin-context.ts | 16 +++++++++++ 2 files changed, 60 insertions(+), 8 deletions(-) diff --git a/src/build/functions/server.ts b/src/build/functions/server.ts index b3cb217989..95d743e8dc 100644 --- a/src/build/functions/server.ts +++ b/src/build/functions/server.ts @@ -101,25 +101,61 @@ const applyTemplateVariables = (template: string, variables: Record { +const transformRoutePatterns = (route: string): string => { return route .replace(/\[\[\.\.\.(\w+)]]/g, ':$1*') // [[...slug]] -> :slug* .replace(/\[\.{3}(\w+)]/g, ':$1+') // [...slug] -> :slug+ .replace(/\[(\w+)]/g, ':$1') // [id] -> :id } -/** Get's the content of the handler file that will be written to the lambda */ -const getHandlerFile = async (ctx: PluginContext): Promise => { - const templatesDir = join(ctx.pluginDir, 'dist/build/templates') +const getRoutes = async (ctx: PluginContext) => { + const internalRoutes = [ + '/_next/static/*', + '/_next/data/*', + '/_next/image/*', + '/_next/postponed/*', + ] const routesManifest = await ctx.getRoutesManifest() - const routes = [...routesManifest.staticRoutes, ...routesManifest.dynamicRoutes] - .map((route) => transformRoutePattern(route.page)) - .join("','") + const staticRoutes = routesManifest.staticRoutes.map((route) => route.page) + const dynamicRoutes = routesManifest.dynamicRoutes.map((route) => route.page) + + // route.source conforms to the URLPattern syntax, which will work with our redirect engine + // however this will be a superset of possible routes as it does not parse the + // header/cookie/query matching that Next.js offers + const redirects = routesManifest.redirects.map((route) => route.source) + const rewrites = Array.isArray(routesManifest.rewrites) + ? routesManifest.rewrites.map((route) => route.source) + : [] + + // this contains the static Route Handler routes + const appPathRoutesManifest = await ctx.getAppPathRoutesManifest() + const appRoutes = Object.values(appPathRoutesManifest) + + // this contains the API handler routes + const pagesManifest = await ctx.getPagesManifest() + const pagesRoutes = Object.keys(pagesManifest) + + return [ + ...internalRoutes, + ...staticRoutes, + ...dynamicRoutes, + ...redirects, + ...rewrites, + ...appRoutes, + ...pagesRoutes, + '/*', // retain the catch-all route for our initial testing + ].map(transformRoutePatterns) +} +/** Get's the content of the handler file that will be written to the lambda */ +const getHandlerFile = async (ctx: PluginContext): Promise => { + const routes = await getRoutes(ctx) + + const templatesDir = join(ctx.pluginDir, 'dist/build/templates') const templateVariables: Record = { '{{useRegionalBlobs}}': ctx.useRegionalBlobs.toString(), - '{{paths}}': routes, + '{{paths}}': routes.join("','"), } // In this case it is a monorepo and we need to use a own template for it // as we have to change the process working directory diff --git a/src/build/plugin-context.ts b/src/build/plugin-context.ts index 74c0ffc329..c71eeb8721 100644 --- a/src/build/plugin-context.ts +++ b/src/build/plugin-context.ts @@ -315,6 +315,22 @@ export class PluginContext { return JSON.parse(await readFile(join(this.publishDir, 'routes-manifest.json'), 'utf-8')) } + /** + * Get Next.js app path routes manifest from the build output + */ + async getAppPathRoutesManifest(): Promise> { + return JSON.parse( + await readFile(join(this.publishDir, 'app-path-routes-manifest.json'), 'utf-8'), + ) + } + + /** + * Get Next.js app path routes manifest from the build output + */ + async getPagesManifest(): Promise> { + return JSON.parse(await readFile(join(this.publishDir, 'server/pages-manifest.json'), 'utf-8')) + } + #nextVersion: string | null | undefined = undefined /** From 0900155e15592dec9b8548528224623ef209eb72 Mon Sep 17 00:00:00 2001 From: Rob Stanford Date: Thu, 12 Dec 2024 21:01:19 +0000 Subject: [PATCH 4/5] feat: add basepath and i18n route handling to ssr function --- src/build/functions/server.ts | 72 ++++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 23 deletions(-) diff --git a/src/build/functions/server.ts b/src/build/functions/server.ts index 95d743e8dc..72ed76f23b 100644 --- a/src/build/functions/server.ts +++ b/src/build/functions/server.ts @@ -100,15 +100,54 @@ const applyTemplateVariables = (template: string, variables: Record { - return route +// Convert Next.js route syntax to URLPattern syntax and add basePath and locales if present +const transformRoutePatterns = ( + route: string, + basePath: string, + locales: string[] = [], +): string[] => { + const transformedRoute = route .replace(/\[\[\.\.\.(\w+)]]/g, ':$1*') // [[...slug]] -> :slug* .replace(/\[\.{3}(\w+)]/g, ':$1+') // [...slug] -> :slug+ .replace(/\[(\w+)]/g, ':$1') // [id] -> :id + + return [ + posixJoin('/', basePath, transformedRoute), + ...locales.map((locale) => posixJoin('/', basePath, locale, transformedRoute)), + ] } -const getRoutes = async (ctx: PluginContext) => { +export const getRoutes = async (ctx: PluginContext) => { + const routesManifest = await ctx.getRoutesManifest() + const prerenderManifest = await ctx.getPrerenderManifest() + + // static routes + const staticRoutes = routesManifest.staticRoutes.map((route) => route.page) + + // dynamic routes (no wildcard for routes without fallback) + const dynamicRoutes = routesManifest.dynamicRoutes + .filter((route) => prerenderManifest.dynamicRoutes[route.page]?.fallback !== false) + .map((route) => route.page) + const prerenderedDynamicRoutes = Object.keys(prerenderManifest.routes) + + // static Route Handler routes (App Router) + const appPathRoutesManifest = await ctx.getAppPathRoutesManifest() + const appRoutes = Object.values(appPathRoutesManifest) + + // API handler routes (Page Router) + const pagesManifest = await ctx.getPagesManifest() + const pagesRoutes = Object.keys(pagesManifest).filter((route) => route.startsWith('/api')) + + const transformedRoutes = [ + ...staticRoutes, + ...dynamicRoutes, + ...prerenderedDynamicRoutes, + ...appRoutes, + ...pagesRoutes, + ].flatMap((route) => + transformRoutePatterns(route, ctx.buildConfig.basePath, ctx.buildConfig.i18n?.locales), + ) + const internalRoutes = [ '/_next/static/*', '/_next/data/*', @@ -116,10 +155,6 @@ const getRoutes = async (ctx: PluginContext) => { '/_next/postponed/*', ] - const routesManifest = await ctx.getRoutesManifest() - const staticRoutes = routesManifest.staticRoutes.map((route) => route.page) - const dynamicRoutes = routesManifest.dynamicRoutes.map((route) => route.page) - // route.source conforms to the URLPattern syntax, which will work with our redirect engine // however this will be a superset of possible routes as it does not parse the // header/cookie/query matching that Next.js offers @@ -128,24 +163,15 @@ const getRoutes = async (ctx: PluginContext) => { ? routesManifest.rewrites.map((route) => route.source) : [] - // this contains the static Route Handler routes - const appPathRoutesManifest = await ctx.getAppPathRoutesManifest() - const appRoutes = Object.values(appPathRoutesManifest) - - // this contains the API handler routes - const pagesManifest = await ctx.getPagesManifest() - const pagesRoutes = Object.keys(pagesManifest) - - return [ + const uniqueRoutes = new Set([ + ...transformedRoutes, ...internalRoutes, - ...staticRoutes, - ...dynamicRoutes, ...redirects, ...rewrites, - ...appRoutes, - ...pagesRoutes, - '/*', // retain the catch-all route for our initial testing - ].map(transformRoutePatterns) + // '/*', // retain the catch-all route for our initial testing + ]) + + return [...uniqueRoutes] } /** Get's the content of the handler file that will be written to the lambda */ From e0a86dd6606ecbdbb5cd7dd59df0dedeeadf67fc Mon Sep 17 00:00:00 2001 From: Rob Stanford Date: Thu, 12 Dec 2024 21:01:34 +0000 Subject: [PATCH 5/5] test: migrate from e2e to integration tests --- package-lock.json | 63 +++++++++++++++++++++++++--- package.json | 1 + tests/e2e/routing.test.ts | 38 ----------------- tests/integration/routing.test.ts | 70 +++++++++++++++++++++++++++++++ 4 files changed, 128 insertions(+), 44 deletions(-) delete mode 100644 tests/e2e/routing.test.ts create mode 100644 tests/integration/routing.test.ts diff --git a/package-lock.json b/package-lock.json index 410fb9d3b5..099b0eeb1a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -51,6 +51,7 @@ "semver": "^7.6.0", "typescript": "^5.4.5", "unionfs": "^4.5.4", + "urlpattern-polyfill": "^10.0.0", "uuid": "^10.0.0", "vitest": "^1.5.3" }, @@ -4639,6 +4640,12 @@ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true }, + "node_modules/@netlify/edge-bundler/node_modules/urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + }, "node_modules/@netlify/edge-bundler/node_modules/uuid": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/uuid/-/uuid-9.0.1.tgz", @@ -4818,6 +4825,12 @@ "node": ">=18.0.0" } }, + "node_modules/@netlify/functions/node_modules/urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + }, "node_modules/@netlify/git-utils": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/@netlify/git-utils/-/git-utils-5.1.1.tgz", @@ -5041,6 +5054,12 @@ "node": ">=18.0.0" } }, + "node_modules/@netlify/serverless-functions-api/node_modules/urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + }, "node_modules/@netlify/zip-it-and-ship-it": { "version": "9.41.0", "resolved": "https://registry.npmjs.org/@netlify/zip-it-and-ship-it/-/zip-it-and-ship-it-9.41.0.tgz", @@ -5197,6 +5216,12 @@ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true }, + "node_modules/@netlify/zip-it-and-ship-it/node_modules/urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + }, "node_modules/@next/env": { "version": "15.0.0-canary.28", "resolved": "https://registry.npmjs.org/@next/env/-/env-15.0.0-canary.28.tgz", @@ -35080,9 +35105,9 @@ } }, "node_modules/urlpattern-polyfill": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", - "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-10.0.0.tgz", + "integrity": "sha512-H/A06tKD7sS1O1X2SshBVeA5FLycRpjqiBeqGKmBwBDBy28EnRjORxTNe269KSSr5un5qyWi1iL61wLxpd+ZOg==", "dev": true }, "node_modules/util-deprecate": { @@ -39356,6 +39381,12 @@ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true }, + "urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + }, "uuid": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/uuid/-/uuid-9.0.1.tgz", @@ -39482,6 +39513,12 @@ "@netlify/node-cookies": "^0.1.0", "urlpattern-polyfill": "8.0.2" } + }, + "urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true } } }, @@ -39661,6 +39698,14 @@ "requires": { "@netlify/node-cookies": "^0.1.0", "urlpattern-polyfill": "8.0.2" + }, + "dependencies": { + "urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true + } } }, "@netlify/zip-it-and-ship-it": { @@ -39788,6 +39833,12 @@ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true + }, + "urlpattern-polyfill": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", + "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "dev": true } } }, @@ -61040,9 +61091,9 @@ } }, "urlpattern-polyfill": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-8.0.2.tgz", - "integrity": "sha512-Qp95D4TPJl1kC9SKigDcqgyM2VDVO4RiJc2d4qe5GrYm+zbIQCWWKAFaJNQ4BhdFeDGwBmAxqJBwWSJDb9T3BQ==", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/urlpattern-polyfill/-/urlpattern-polyfill-10.0.0.tgz", + "integrity": "sha512-H/A06tKD7sS1O1X2SshBVeA5FLycRpjqiBeqGKmBwBDBy28EnRjORxTNe269KSSr5un5qyWi1iL61wLxpd+ZOg==", "dev": true }, "util-deprecate": { diff --git a/package.json b/package.json index f490872995..db649300fb 100644 --- a/package.json +++ b/package.json @@ -90,6 +90,7 @@ "semver": "^7.6.0", "typescript": "^5.4.5", "unionfs": "^4.5.4", + "urlpattern-polyfill": "^10.0.0", "uuid": "^10.0.0", "vitest": "^1.5.3" }, diff --git a/tests/e2e/routing.test.ts b/tests/e2e/routing.test.ts deleted file mode 100644 index ad51cf0536..0000000000 --- a/tests/e2e/routing.test.ts +++ /dev/null @@ -1,38 +0,0 @@ -import { expect } from '@playwright/test' -import { test } from '../utils/playwright-helpers.js' - -const ssrRoutes = [ - ['/static', 'pages router, static rendering, static routing'], - ['/prerendered', 'pages router, prerendering, static routing'], - ['/posts/prerendered/1', 'pages router, prerendering, dynamic routing'], - ['/dynamic', 'pages router, dynamic rendering, static routing'], - ['/posts/dynamic/1', 'pages router, dynamic rendering, dynamic routing'], - ['/api/okay', 'pages router, api route, static routing'], - ['/api/posts/1', 'pages router, api route, dynamic routing'], - ['/static-fetch-1', 'app router, prerendering, static routing'], - ['/static-fetch/1', 'app router, prerendering, dynamic routing'], - ['/static-fetch-dynamic-1', 'app router, dynamic rendering, static routing'], - ['/static-fetch-dynamic/1', 'app router, dynamic rendering, dynamic routing'], - ['/api/revalidate-handler', 'app router, route handler, static routing'], - ['/api/static/1', 'app router, route handler, dynamic routing'], -] - -const notFoundRoutes = [ - ['/non-existing', 'default'], - ['/prerendered/3', 'prerendering, dynamic routing'], - ['/dynamic/3', 'dynamic rendering, dynamic routing'], - ['/api/non-existing', 'route handler, static routing'], -] - -test(`routing works correctly`, async ({ page, serverComponents }) => { - for (const [path, description] of ssrRoutes) { - const url = new URL(path, serverComponents.url).href - const response = await page.goto(url) - expect(response?.status(), `expected 200 response for ${description}`).toBe(200) - } - for (const [path, description] of notFoundRoutes) { - const url = new URL(path, serverComponents.url).href - const response = await page.goto(url) - expect(response?.status(), `expected 404 response for ${description}`).toBe(404) - } -}) diff --git a/tests/integration/routing.test.ts b/tests/integration/routing.test.ts new file mode 100644 index 0000000000..b807fa5481 --- /dev/null +++ b/tests/integration/routing.test.ts @@ -0,0 +1,70 @@ +import { join as posixJoin } from 'node:path/posix' +import 'urlpattern-polyfill' +import { v4 } from 'uuid' +import { beforeEach, expect, test, vi } from 'vitest' +import { SERVER_HANDLER_NAME } from '../../src/build/plugin-context.js' +import { type FixtureTestContext } from '../utils/contexts.js' +import { createFixture, runPlugin } from '../utils/fixture.js' +import { generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js' + +const ssrRoutes = [ + ['/static', 'pages router, static rendering, static routing'], + ['/prerendered', 'pages router, prerendering, static routing'], + ['/posts/prerendered/1', 'pages router, prerendering, dynamic routing'], + ['/dynamic', 'pages router, dynamic rendering, static routing'], + ['/posts/dynamic/1', 'pages router, dynamic rendering, dynamic routing'], + ['/api/okay', 'pages router, api route, static routing'], + ['/api/posts/1', 'pages router, api route, dynamic routing'], + ['/static-fetch-1', 'app router, prerendering, static routing'], + ['/static-fetch/1', 'app router, prerendering, dynamic routing'], + ['/static-fetch-dynamic-1', 'app router, dynamic rendering, static routing'], + ['/static-fetch-dynamic/1', 'app router, dynamic rendering, dynamic routing'], + ['/api/revalidate-handler', 'app router, route handler, static routing'], + ['/api/static/1', 'app router, route handler, dynamic routing'], +] + +const notFoundRoutes = [ + ['/non-existing', 'default'], + ['/posts/prerendered/3', 'pages router, prerendering, dynamic routing'], + ['/api/non-existing', 'pages router, api route, static routing'], +] + +const baseURL = 'http://localhost' + +beforeEach(async (ctx) => { + // set for each test a new deployID and siteID + ctx.deployID = generateRandomObjectID() + ctx.siteID = v4() + vi.stubEnv('DEPLOY_ID', ctx.deployID) + + await startMockBlobStore(ctx) +}) + +test('that the SSR handler routing works correctly', async (ctx) => { + await createFixture('server-components', ctx) + await runPlugin(ctx) + + const handler = await import( + posixJoin( + ctx.cwd, + '.netlify/functions-internal', + SERVER_HANDLER_NAME, + `${SERVER_HANDLER_NAME}.mjs`, + ) + ) + + const matcher = (path: string) => + handler.config.path.some((pattern) => + new URLPattern({ pathname: pattern, baseURL }).test(posixJoin(baseURL, path)), + ) + + // check ssr routes are satisfied by the url patterns + for (const [path, description] of ssrRoutes) { + expect(path, `expected 200 response for ${description}`).toSatisfy(matcher) + } + + // check not found routes are not satisfied by the url patterns + for (const [path, description] of notFoundRoutes) { + expect(path, `expected 404 response for ${description}`).not.toSatisfy(matcher) + } +})