feat: check rewrites against static routes

Author: ascorbic

plugin/src/helpers/files.ts

@@ -404,4 +404,24 @@ export const movePublicFiles = async ({
     await copy(publicDir, `${publish}/`)
   }
 }
+
+export const writeStaticRouteManifest = async ({
+  appDir,
+  outdir,
+  publish,
+}: {
+  appDir: string
+  outdir?: string
+  publish: string
+}): Promise<void> => {
+  const publicDir = outdir ? join(appDir, outdir, 'public') : join(appDir, 'public')
+  const fileList = existsSync(publicDir) ? await globby(['**/*'], { cwd: publicDir }) : []
+
+  const pagesManifest = await readJson(join(publish, 'server', 'pages-manifest.json'))
+
+  const staticRoutes = Object.keys(pagesManifest).filter((route) => !isDynamicRoute(route))
+
+  await writeJson(join(publish, 'public-manifest.json'), [...fileList.map((file) => `/${file}`), ...staticRoutes])
+}
+
 /* eslint-enable max-lines */

plugin/src/index.ts

@@ -16,7 +16,13 @@ import {
   generateCustomHeaders,
 } from './helpers/config'
 import { updateConfig, writeEdgeFunctions, loadMiddlewareManifest } from './helpers/edge'
-import { moveStaticPages, movePublicFiles, patchNextFiles, unpatchNextFiles } from './helpers/files'
+import {
+  moveStaticPages,
+  movePublicFiles,
+  patchNextFiles,
+  unpatchNextFiles,
+  writeStaticRouteManifest,
+} from './helpers/files'
 import { generateFunctions, setupImageFunction, generatePagesResolver } from './helpers/functions'
 import { generateRedirects, generateStaticRedirects } from './helpers/redirects'
 import { shouldSkip, isNextAuthInstalled } from './helpers/utils'
@@ -112,6 +118,8 @@ const plugin: NetlifyPlugin = {
 
     await movePublicFiles({ appDir, outdir, publish })
 
+    await writeStaticRouteManifest({ appDir, outdir, publish })
+
     await patchNextFiles(basePath)
 
     if (!process.env.SERVE_STATIC_FILES_FROM_ORIGIN) {

plugin/src/templates/edge/router.test.ts

@@ -11,6 +11,25 @@ import {
 } from './router.ts'
 import manifest from './test-routes-manifest.json' assert { type: 'json' }
 
+const staticRoutes = new Set([
+  '/blog/data.json',
+  '/static/hello.txt',
+  '/_error',
+  '/_app',
+  '/auto-export/another',
+  '/api/hello',
+  '/hello-again',
+  '/docs/v2/more/now-for-github',
+  '/hello',
+  '/nav',
+  '/multi-rewrites',
+  '/redirect-override',
+  '/with-params',
+  '/overridden',
+  '/_document',
+  '/404',
+])
+
 Deno.test('rewrites paths', () => {
   const rule = {
     source: '/catchall-query/:path*',
@@ -360,15 +379,47 @@ Deno.test('redirects', async (t) => {
     assertEquals(result.status, 307)
   })
 })
+
 Deno.test('rewrites', async (t) => {
-  await t.step('simple rewrite', () => {
-    const result = applyRewrites(new Request('http://localhost/to-another'), manifest.rewrites.afterFiles as Rewrite[])
+  await t.step('afterFiles rewrite', () => {
+    const result = applyRewrites({
+      request: new Request('http://localhost/to-another'),
+      rules: manifest.rewrites.afterFiles as Rewrite[],
+      checkStaticRoutes: true,
+      staticRoutes,
+    })
     assert(result)
     assertEquals(result.url, 'http://localhost/another/one')
   })
-  await t.step('with params', () => {
-    const result = applyRewrites(new Request('http://localhost/test/hello'), manifest.rewrites.afterFiles as Rewrite[])
+  await t.step('afterFiles with params', () => {
+    const result = applyRewrites({
+      request: new Request('http://localhost/test/hello'),
+      rules: manifest.rewrites.afterFiles as Rewrite[],
+      checkStaticRoutes: true,
+      staticRoutes,
+    })
     assert(result)
     assertEquals(result.url, 'http://localhost/hello')
   })
+
+  await t.step('afterFiles matching static file', () => {
+    const result = applyRewrites({
+      request: new Request('http://localhost/hello-world'),
+      rules: manifest.rewrites.afterFiles as Rewrite[],
+      checkStaticRoutes: true,
+      staticRoutes,
+    })
+    assert(result)
+    assertEquals(result.url, 'http://localhost/static/hello.txt')
+  })
+
+  await t.step('non-matching', () => {
+    const result = applyRewrites({
+      request: new Request('http://localhost/no-match'),
+      rules: manifest.rewrites.afterFiles as Rewrite[],
+      checkStaticRoutes: true,
+      staticRoutes,
+    })
+    assertFalse(result)
+  })
 })

plugin/src/templates/edge/router.ts

@@ -208,9 +208,40 @@ export function applyRedirects(request: Request, rules: Redirect[]): Response |
   return false
 }
 
-export function applyRewrites(request: Request, rules: Rewrite[]): Request | false {
+export function applyRewrites({
+  request,
+  rules,
+  staticRoutes,
+  checkStaticRoutes,
+}: {
+  request: Request
+  rules: Rewrite[]
+  checkStaticRoutes: boolean
+  staticRoutes?: Set<string>
+}): Request | false {
+  let result: Request | false = false
+
+  if (checkStaticRoutes && !staticRoutes) {
+    throw new Error('staticRoutes must be provided if checkStaticRoutes is true')
+  }
+
   // Apply all rewrite rules in order
-  return rules.reduce((request, rule) => {
-    return applyRewriteRule({ request, rule }) || request
-  }, request)
+  for (const rule of rules) {
+    const rewritten = applyRewriteRule({ request, rule })
+    if (rewritten) {
+      result = rewritten
+      // If a static route is matched, then we exit early
+      if (checkStaticRoutes && staticRoutes!.has(new URL(result.url).pathname)) {
+        return result
+      }
+    }
+  }
+  return result
+}
+
+export function matchesStaticRoute(route: string, staticRoutes: Set<string>, staticFiles: Set<string>): boolean {
+  if (staticFiles.has(route)) {
+    return true
+  }
+  return staticRoutes.has(route.endsWith('/') ? route.slice(0, -1) : route)
 }