Fix basePath and public folder check ending routes early (#16356)

ijjk · web-flow · commit 681fbbd04d21 · 2020-08-19T17:30:33.000Z
This corrects the basePath being required check for filesystem routes to not consider the public folder catch-all route since it always matches even if the public file isn't present and instead moves the basePath check inside of the public-folder catch-all. Tests already exist that catch this by adding a public folder to the existing `basepath` test suite Fixes: #16332 Closes: #16350
diff --git a/packages/next/next-server/server/next-server.ts b/packages/next/next-server/server/next-server.ts
@@ -783,6 +783,14 @@ export default class Server {
         name: 'public folder catchall',
         fn: async (req, res, params, parsedUrl) => {
           const pathParts: string[] = params.path || []
+          const { basePath } = this.nextConfig
+
+          // if basePath is defined require it be present
+          if (basePath) {
+            if (pathParts[0] !== basePath.substr(1)) return { finished: false }
+            pathParts.shift()
+          }
+
           const path = `/${pathParts.join('/')}`
 
           if (publicFiles.has(path)) {
diff --git a/packages/next/next-server/server/router.ts b/packages/next/next-server/server/router.ts
@@ -37,6 +37,7 @@ export type PageChecker = (pathname: string) => Promise<boolean>
 const customRouteTypes = new Set(['rewrite', 'redirect', 'header'])
 
 function replaceBasePath(basePath: string, pathname: string) {
+  // If replace ends up replacing the full url it'll be `undefined`, meaning we have to default it to `/`
   return pathname!.replace(basePath, '') || '/'
 }
 
@@ -166,9 +167,10 @@ export default class Router {
       const originalPathname = currentPathname
       const requireBasePath = testRoute.requireBasePath !== false
       const isCustomRoute = customRouteTypes.has(testRoute.type)
+      const isPublicFolderCatchall = testRoute.name === 'public folder catchall'
+      const keepBasePath = isCustomRoute || isPublicFolderCatchall
 
-      if (!isCustomRoute) {
-        // If replace ends up replacing the full url it'll be `undefined`, meaning we have to default it to `/`
+      if (!keepBasePath) {
         currentPathname = replaceBasePath(this.basePath, currentPathname!)
       }
 
@@ -178,7 +180,7 @@ export default class Router {
       if (newParams) {
         // since we require basePath be present for non-custom-routes we
         // 404 here when we matched an fs route
-        if (!isCustomRoute) {
+        if (!keepBasePath) {
           if (!originallyHadBasePath && !(req as any)._nextDidRewrite) {
             if (requireBasePath) {
               // consider this a non-match so the 404 renders
@@ -201,7 +203,7 @@ export default class Router {
 
         // since the fs route didn't match we need to re-add the basePath
         // to continue checking rewrites with the basePath present
-        if (!isCustomRoute) {
+        if (!keepBasePath) {
           parsedUrlUpdated.pathname = originalPathname
         }
 
@@ -272,7 +274,6 @@ export default class Router {
         }
       }
     }
-
     return false
   }
 }
diff --git a/test/integration/basepath/public/data.txt b/test/integration/basepath/public/data.txt
@@ -0,0 +1 @@
+hello world
diff --git a/test/integration/basepath/test/index.test.js b/test/integration/basepath/test/index.test.js
@@ -135,6 +135,17 @@ const runTests = (context, dev = false) => {
     })
   }
 
+  it('should 404 for public file without basePath', async () => {
+    const res = await fetchViaHTTP(context.appPort, '/data.txt')
+    expect(res.status).toBe(404)
+  })
+
+  it('should serve public file with basePath correctly', async () => {
+    const res = await fetchViaHTTP(context.appPort, '/docs/data.txt')
+    expect(res.status).toBe(200)
+    expect(await res.text()).toBe('hello world')
+  })
+
   it('should rewrite with basePath by default', async () => {
     const html = await renderViaHTTP(context.appPort, '/docs/rewrite-1')
     expect(html).toContain('getServerSideProps')

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ export type PageChecker = (pathname: string) => Promise<boolean>`
`37`	`37`	`const customRouteTypes = new Set(['rewrite', 'redirect', 'header'])`
`38`	`38`
`39`	`39`	`function replaceBasePath(basePath: string, pathname: string) {`
	`40`	+ // If replace ends up replacing the full url it'll be `undefined`, meaning we have to default it to `/`
`40`	`41`	`return pathname!.replace(basePath, '') \|\| '/'`
`41`	`42`	`}`
`42`	`43`
`@@ -166,9 +167,10 @@ export default class Router {`
`166`	`167`	`const originalPathname = currentPathname`
`167`	`168`	`const requireBasePath = testRoute.requireBasePath !== false`
`168`	`169`	`const isCustomRoute = customRouteTypes.has(testRoute.type)`
	`170`	`+ const isPublicFolderCatchall = testRoute.name === 'public folder catchall'`
	`171`	`+ const keepBasePath = isCustomRoute \|\| isPublicFolderCatchall`
`169`	`172`
`170`		`- if (!isCustomRoute) {`
`171`		- // If replace ends up replacing the full url it'll be `undefined`, meaning we have to default it to `/`
	`173`	`+ if (!keepBasePath) {`
`172`	`174`	`currentPathname = replaceBasePath(this.basePath, currentPathname!)`
`173`	`175`	`}`
`174`	`176`
`@@ -178,7 +180,7 @@ export default class Router {`
`178`	`180`	`if (newParams) {`
`179`	`181`	`// since we require basePath be present for non-custom-routes we`
`180`	`182`	`// 404 here when we matched an fs route`
`181`		`- if (!isCustomRoute) {`
	`183`	`+ if (!keepBasePath) {`
`182`	`184`	`if (!originallyHadBasePath && !(req as any)._nextDidRewrite) {`
`183`	`185`	`if (requireBasePath) {`
`184`	`186`	`// consider this a non-match so the 404 renders`
`@@ -201,7 +203,7 @@ export default class Router {`
`201`	`203`
`202`	`204`	`// since the fs route didn't match we need to re-add the basePath`
`203`	`205`	`// to continue checking rewrites with the basePath present`
`204`		`- if (!isCustomRoute) {`
	`206`	`+ if (!keepBasePath) {`
`205`	`207`	`parsedUrlUpdated.pathname = originalPathname`
`206`	`208`	`}`
`207`	`209`
`@@ -272,7 +274,6 @@ export default class Router {`
`272`	`274`	`}`
`273`	`275`	`}`
`274`	`276`	`}`
`275`		`-`
`276`	`277`	`return false`
`277`	`278`	`}`
`278`	`279`	`}`