feat: option to disable SPA catch-all

vitejs · May 7, 2022 · aee24d9 · aee24d9
1 parent 9f8381e
commit aee24d9
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/packages/vite/src/node/http.ts b/packages/vite/src/node/http.ts
@@ -69,6 +69,14 @@ export interface CommonServerOptions {
    * Specify server response headers.
    */
   headers?: HttpServerHeaders
+  /**
+   * Disable SPA catch-all routing.
+   *
+   * By default, Vite's dev/preview server redirects all routes to the root
+   * URL `/`. (In order to enable client-side routed SPAs.) For SSR or MPA apps,
+   * this behavior should be disabled and this option allows you to do so.
+   */
+  disableSPACatchAll?: boolean
 }
 
 /**

diff --git a/packages/vite/src/node/preview.ts b/packages/vite/src/node/preview.ts
@@ -1,4 +1,5 @@
 import path from 'path'
+import fs from 'fs'
 import sirv from 'sirv'
 import connect from 'connect'
 import compression from './server/middlewares/compression'
@@ -35,7 +36,8 @@ export function resolvePreviewOptions(
     open: preview?.open ?? server.open,
     proxy: preview?.proxy ?? server.proxy,
     cors: preview?.cors ?? server.cors,
-    headers: preview?.headers ?? server.headers
+    headers: preview?.headers ?? server.headers,
+    disableSPACatchAll: preview?.disableSPACatchAll ?? server.disableSPACatchAll
   }
 }
 
@@ -100,19 +102,33 @@ export async function preview(
   app.use(compression())
 
   // static assets
+  const { disableSPACatchAll } = config.preview
   const distDir = path.resolve(config.root, config.build.outDir)
   app.use(
     config.base,
     sirv(distDir, {
       etag: true,
       dev: true,
-      single: true
+      single: !disableSPACatchAll
     })
   )
 
   // apply post server hooks from plugins
   postHooks.forEach((fn) => fn && fn())
 
+  // 404 handling
+  if (disableSPACatchAll) {
+    app.use(config.base, (_, res, next) => {
+      const file = path.join(distDir, './404.html')
+      if (fs.existsSync(file)) {
+        res.statusCode = 404
+        res.end(fs.readFileSync(file))
+      } else {
+        next()
+      }
+    })
+  }
+
   const options = config.preview
   const hostname = resolveHostname(options.host)
   const port = options.port ?? 4173

diff --git a/packages/vite/src/node/server/index.ts b/packages/vite/src/node/server/index.ts
@@ -524,7 +524,10 @@ export async function createServer(
   middlewares.use(serveStaticMiddleware(root, server))
 
   // spa fallback
-  if (!middlewareMode || middlewareMode === 'html') {
+  if (
+    !serverConfig.disableSPACatchAll &&
+    (!middlewareMode || middlewareMode === 'html')
+  ) {
     middlewares.use(spaFallbackMiddleware(root))
   }