perf: avoid merging empty object in record

posva · posva · commit 4213eb665e52 · 2026-02-10T10:55:49.000+01:00
diff --git a/packages/router/src/unplugin/core/context.ts b/packages/router/src/unplugin/core/context.ts
@@ -166,10 +166,10 @@ export function createRoutesContext(options: ResolvedOptions) {
 
   async function writeRouteInfoToNode(node: TreeNode, filePath: string) {
     const content = await fs.readFile(filePath, 'utf8')
-    // TODO: cache the result of parsing the SFC (in the extractDefinePageAndName) so the transform can reuse the parsing
-    node.hasDefinePage ||= content.includes('definePage')
     // TODO: track if it changed and to not always trigger HMR
     const definedPageInfo = extractDefinePageInfo(content, filePath)
+    // TODO: add a test that this can be set to true and then to false
+    node.hasDefinePage = definedPageInfo?.hasRemainingProperties ?? false
     // TODO: track if it changed and if generateRoutes should be called again
     const routeBlock = getRouteBlock(filePath, content, options)
     // TODO: should warn if hasDefinePage and customRouteBlock
diff --git a/packages/router/src/unplugin/core/definePage.spec.ts b/packages/router/src/unplugin/core/definePage.spec.ts
@@ -183,6 +183,7 @@ definePage({
     expect(extractDefinePageInfo(sampleCode, 'src/pages/basic.vue')).toEqual({
       name: 'custom',
       path: '/custom',
+      hasRemainingProperties: false,
     })
   })
 
@@ -217,6 +218,7 @@ definePage({
     expect(
       extractDefinePageInfo(codeWithAllParams, 'src/pages/test.vue')
     ).toEqual({
+      hasRemainingProperties: false,
       params: {
         path: {
           userId: 'int',
@@ -253,6 +255,7 @@ definePage({
 `
     expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
       alias: ['/other'],
+      hasRemainingProperties: false,
     })
   })
 
@@ -266,6 +269,7 @@ definePage({
 `
     expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
       alias: ['/a', '/b'],
+      hasRemainingProperties: false,
     })
   })
 
@@ -277,7 +281,9 @@ definePage({
 })
 </script>
 `
-    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({})
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
+      hasRemainingProperties: false,
+    })
     expect(
       'route alias must be a string literal or an array of string literals'
     ).toHaveBeenWarned()
@@ -292,7 +298,9 @@ definePage({
 })
 </script>
 `
-    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({})
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
+      hasRemainingProperties: false,
+    })
     expect(
       'route alias must be a string literal or an array of string literals'
     ).toHaveBeenWarned()
@@ -308,6 +316,51 @@ definePage({
 `
     expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
       alias: ['/a', '/b'],
+      hasRemainingProperties: false,
+    })
+
+    expect(
+      `route alias array must only contain string literals.`
+    ).toHaveBeenWarned()
+  })
+
+  describe('hasRemainingProperties', () => {
+    it('is false when only name/path/alias/params are present', () => {
+      const code = vue`
+<script setup>
+definePage({
+  name: 'home',
+  path: '/home',
+  alias: ['/'],
+  params: { path: { id: 'int' } },
+})
+</script>
+`
+      const result = extractDefinePageInfo(code, 'src/pages/test.vue')
+      expect(result?.hasRemainingProperties).toBe(false)
+    })
+
+    it('is true when meta is present', () => {
+      const code = vue`
+<script setup>
+definePage({
+  name: 'home',
+  meta: { requiresAuth: true },
+})
+</script>
+`
+      const result = extractDefinePageInfo(code, 'src/pages/test.vue')
+      expect(result?.hasRemainingProperties).toBe(true)
+    })
+
+    it('is false for empty definePage object', () => {
+      const code = vue`
+<script setup>
+definePage({})
+</script>
+`
+      const result = extractDefinePageInfo(code, 'src/pages/test.vue')
+      expect(result?.hasRemainingProperties).toBe(false)
     })
   })
 
@@ -383,6 +436,7 @@ export default {
     ).toEqual({
       name: 'custom',
       path: '/custom',
+      hasRemainingProperties: false,
     })
   })
 
diff --git a/packages/router/src/unplugin/core/definePage.ts b/packages/router/src/unplugin/core/definePage.ts
@@ -14,6 +14,7 @@ import type {
   ObjectProperty,
   Program,
   Statement,
+  StringLiteral,
 } from '@babel/types'
 import { generate } from '@babel/generator'
 import { walkAST } from 'ast-walker-scope'
@@ -215,6 +216,11 @@ export interface DefinePageInfo {
   path?: string
   alias?: string[]
   params?: CustomRouteBlock['params']
+  /**
+   * Whether definePage has properties beyond the statically extracted ones
+   * (name, path, alias, params)
+   */
+  hasRemainingProperties: boolean
 }
 
 /**
@@ -265,7 +271,7 @@ export function extractDefinePageInfo(
     )
   }
 
-  const routeInfo: DefinePageInfo = {}
+  const routeInfo: DefinePageInfo = { hasRemainingProperties: false }
 
   for (const prop of routeRecord.properties) {
     if (prop.type === 'ObjectProperty' && prop.key.type === 'Identifier') {
@@ -293,6 +299,8 @@ export function extractDefinePageInfo(
         if (prop.value.type === 'ObjectExpression') {
           routeInfo.params = extractParamsInfo(prop.value, id)
         }
+      } else {
+        routeInfo.hasRemainingProperties = true
       }
     }
   }
@@ -436,7 +444,15 @@ export function extractRouteAlias(
     return aliasValue.type === 'StringLiteral'
       ? [aliasValue.value]
       : aliasValue.elements
-          .filter(node => node?.type === 'StringLiteral')
+          .filter((node): node is StringLiteral => {
+            if (node?.type === 'StringLiteral') {
+              return true
+            }
+            warn(
+              `route alias array must only contain string literals. Found ${node?.type ? `"${node.type}" ` : ''}in "${id}".`
+            )
+            return false
+          })
           .map(el => el.value)
   }
   return undefined
