feat: add ssr routeRule (#593)

nuxt · Oct 25, 2022 · de9e5c2 · de9e5c2
1 parent a725a7a
commit de9e5c2
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 3 deletions.
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -23,6 +23,9 @@ export default defineNuxtConfig({
   buildDir: process.env.NITRO_BUILD_DIR,
   plugins: ['~/plugins/setup.js'],
   nitro: {
+    routeRules: {
+      '/route-rules/spa': { ssr: false }
+    },
     output: { dir: process.env.NITRO_OUTPUT_DIR }
   },
   bridge: {

diff --git a/playground/pages/route-rules/spa.vue b/playground/pages/route-rules/spa.vue
@@ -0,0 +1,5 @@
+<template>
+  <div>
+    should not be rendered on ssr
+  </div>
+</template>
diff --git a/src/runtime/nitro/renderer.ts b/src/runtime/nitro/renderer.ts
@@ -5,7 +5,7 @@ import devalue from '@nuxt/devalue'
 import type { RuntimeConfig } from '@nuxt/schema'
 import type { RenderResponse } from 'nitropack'
 // @ts-ignore
-import { useRuntimeConfig, useNitroApp, defineRenderHandler } from '#internal/nitro'
+import { useRuntimeConfig, useNitroApp, defineRenderHandler, getRouteRules } from '#internal/nitro'
 // @ts-ignore
 import { buildAssetsURL } from '#paths'
 // @ts-ignore
@@ -131,6 +131,9 @@ export default defineRenderHandler(async (event) => {
     url = url.slice(STATIC_ASSETS_BASE.length, url.length - PAYLOAD_JS.length) || '/'
   }
 
+  // Get route options (currently to apply `ssr: false`)
+  const routeOptions = getRouteRules(event)
+
   // Initialize ssr context
   const config = useRuntimeConfig()
   const ssrContext: NuxtSSRContext = {
@@ -139,7 +142,7 @@ export default defineRenderHandler(async (event) => {
     req: event.req,
     res: event.res,
     runtimeConfig: { private: config, public: { public: config.public, app: config.app } },
-    noSSR: !!event.req.headers['x-nuxt-no-ssr'],
+    noSSR: !!event.req.headers['x-nuxt-no-ssr'] || routeOptions.ssr === false,
     error: ssrError,
     redirected: undefined,
     nuxt: undefined as undefined | Record<string, any>, /* Nuxt 2 payload */

diff --git a/test/bridge.test.ts b/test/bridge.test.ts
@@ -62,6 +62,12 @@ describe('errors', () => {
   })
 })
 
+describe('route rules', () => {
+  it('should enable spa mode', async () => {
+    expect(await $fetch('/route-rules/spa')).toContain('serverRendered:false')
+  })
+})
+
 describe('dynamic paths', () => {
   if (process.env.NUXT_TEST_DEV) {
     // TODO:
@@ -143,7 +149,11 @@ describe('dynamic paths', () => {
           \\"buildAssetsDir\\": \\"/_nuxt/\\"
         },
         \\"nitro\\": {
-          \\"routeRules\\": {},
+          \\"routeRules\\": {
+            \\"/route-rules/spa\\": {
+              \\"ssr\\": false
+            }
+          },
           \\"envPrefix\\": \\"NUXT_\\"
         },
         \\"public\\": {

diff --git a/types.d.ts b/types.d.ts
@@ -31,4 +31,13 @@ declare module '@nuxt/schema' {
   }
 }
 
+declare module 'nitropack' {
+  interface NitroRouteConfig {
+    ssr?: boolean
+  }
+  interface NitroRouteOptions {
+    ssr?: boolean
+  }
+}
+
 export declare function defineNuxtConfig (config: NuxtConfig): NuxtConfig