fix(nuxt): remove undefined keys in route object (#25667)

nuxt · Feb 18, 2024 · ec94929 · ec94929
1 parent 1bb71cf
commit ec94929
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/packages/nuxt/src/pages/utils.ts b/packages/nuxt/src/pages/utils.ts
@@ -139,8 +139,8 @@ const pageContentsCache: Record<string, string> = {}
 const metaCache: Record<string, Partial<Record<keyof NuxtPage, any>>> = {}
 async function getRouteMeta (contents: string, absolutePath: string): Promise<Partial<Record<keyof NuxtPage, any>>> {
   // set/update pageContentsCache, invalidate metaCache on cache mismatch
-  if (!(absolutePath in pageContentsCache) || pageContentsCache[absolutePath] !== contents) { 
-    pageContentsCache[absolutePath] = contents 
+  if (!(absolutePath in pageContentsCache) || pageContentsCache[absolutePath] !== contents) {
+    pageContentsCache[absolutePath] = contents
     delete metaCache[absolutePath]
   }
 
@@ -414,6 +414,12 @@ export function normalizeRoutes (routes: NuxtPage[], metaImports: Set<string> =
         redirect: serializeRouteValue(page.redirect),
       }
 
+      for (const key of ['path', 'name', 'meta', 'alias', 'redirect'] satisfies NormalizedRouteKeys) {
+        if (route[key] === undefined) {
+          delete route[key]
+        }
+      }
+
       if (page.children?.length) {
         route.children = normalizeRoutes(page.children, metaImports, overrideMeta).routes
       }

diff --git a/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap b/packages/nuxt/test/__snapshots__/pages-override-meta-disabled.test.ts.snap
@@ -15,7 +15,6 @@
       "meta": "{"hello":"world"}",
       "name": ""home"",
       "path": ""/"",
-      "redirect": undefined,
     },
   ],
   "should allow pages with `:` in their path": [

diff --git a/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap b/packages/nuxt/test/__snapshots__/pages-override-meta-enabled.test.ts.snap
@@ -14,7 +14,6 @@
       "meta": "{"hello":"world"}",
       "name": ""home"",
       "path": ""/"",
-      "redirect": undefined,
     },
   ],
   "should allow pages with `:` in their path": [

diff --git a/test/fixtures/basic/nuxt.config.ts b/test/fixtures/basic/nuxt.config.ts
@@ -102,6 +102,14 @@ export default defineNuxtConfig({
       }))
       addBuildPlugin(plugin)
     },
+    function (_options, nuxt) {
+      nuxt.hook('pages:extend', pages => {
+        pages.push({
+          path: '/manual-redirect',
+          redirect: '/',
+        })
+      })
+    },
     function (_options, nuxt) {
       const routesToDuplicate = ['/async-parent', '/fixed-keyed-child-parent', '/keyed-child-parent', '/with-layout', '/with-layout2']
       const stripLayout = (page: NuxtPage): NuxtPage => ({