perf: implement custom routes (#1447)

BREAKING CHANGE: vue-router's route records have been replaced by custom route records to get better performance. It should not break common usage, but could be a potential breaking change for some themes. vue-router is suitable for SPAs, but not for static sites. It has a negative impact on the performance of vuepress sites, especially large-scale ones. In the long run we'll replace vue-router with a light-weighted custom router totally.

--------

Co-authored-by: Xinyu Liu <[email protected]>

Author: Mister-Hope

e2e/docs/.vuepress/config.ts

@@ -52,4 +52,14 @@ export default defineUserConfig({
   bundler: E2E_BUNDLER === 'webpack' ? webpackBundler() : viteBundler(),
 
   theme: e2eTheme(),
+
+  extendsPage: (page) => {
+    if (page.path === '/page-data/route-meta.html') {
+      page.routeMeta = {
+        a: 1,
+        b: 2,
+        ...page.routeMeta,
+      }
+    }
+  },
 })

e2e/docs/404.md

@@ -0,0 +1,4 @@
+---
+routeMeta:
+  foo: bar
+---

e2e/docs/page-data/route-meta.md

@@ -0,0 +1,5 @@
+---
+routeMeta:
+  a: 0
+  c: 3
+---

e2e/docs/router/resolve-route.md

@@ -0,0 +1,43 @@
+## resolve
+
+### Path
+
+#### Index
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/index.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/README.md')) }}
+
+#### Non-Index
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/router/resolve-route')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/router/resolve-route.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/router/resolve-route.md')) }}
+
+#### Non-ASCII
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/routes/non-ascii-paths/中文目录名/中文文件名.md')) }}
+
+#### Non-ASCII Encoded
+
+- Clean URL: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名'))) }}
+- HTML: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'))) }}
+- Markdown: {{ JSON.stringify(resolveRoute(encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.md'))) }}
+
+#### Non-Existent
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/non-existent')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/non-existent.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/non-existent.md')) }}
+
+#### Route Meta
+
+- Clean URL: {{ JSON.stringify(resolveRoute('/page-data/route-meta')) }}
+- HTML: {{ JSON.stringify(resolveRoute('/page-data/route-meta.html')) }}
+- Markdown: {{ JSON.stringify(resolveRoute('/page-data/route-meta.md')) }}
+
+<script setup>
+import { resolveRoute } from 'vuepress/client'
+</script>

e2e/tests/router/resolve-route.cy.ts

@@ -0,0 +1,66 @@
+const testCases = [
+  {
+    selector: '#index',
+    expected: {
+      path: '/',
+      meta: {},
+      notFound: false,
+    },
+  },
+  {
+    selector: '#non-index',
+    expected: {
+      path: '/router/resolve-route.html',
+      meta: {},
+      notFound: false,
+    },
+  },
+  {
+    selector: '#non-ascii',
+    expected: {
+      path: encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'),
+      meta: {},
+      notFound: false,
+    },
+  },
+  {
+    selector: '#non-ascii-encoded',
+    expected: {
+      path: encodeURI('/routes/non-ascii-paths/中文目录名/中文文件名.html'),
+      meta: {},
+      notFound: false,
+    },
+  },
+  {
+    selector: '#non-existent',
+    expected: {
+      path: '/non-existent.html',
+      meta: { foo: 'bar' },
+      notFound: true,
+    },
+  },
+  {
+    selector: '#route-meta',
+    expected: {
+      path: '/page-data/route-meta.html',
+      meta: { a: 0, b: 2, c: 3 },
+      notFound: false,
+    },
+  },
+]
+
+const parseResolvedRouteFromElement = (el: Cypress.JQueryWithSelector) =>
+  JSON.parse(/: (\{.*\})\s*$/.exec(el.text())![1])
+
+it('should resolve routes correctly', () => {
+  cy.visit('/router/resolve-route.html')
+
+  testCases.forEach(({ selector, expected }) => {
+    cy.get(`.e2e-theme-content ${selector} + ul > li`).each((el) => {
+      const resolvedRoute = parseResolvedRouteFromElement(el)
+      expect(resolvedRoute.path).to.equal(expected.path)
+      expect(resolvedRoute.meta).to.deep.equal(expected.meta)
+      expect(resolvedRoute.notFound).to.equal(expected.notFound)
+    })
+  })
+})

packages/bundler-vite/src/build/resolvePageChunkFiles.ts

@@ -11,9 +11,7 @@ export const resolvePageChunkFiles = ({
   output
     .filter(
       (item): item is OutputChunk =>
-        item.type === 'chunk' &&
-        (item.facadeModuleId === page.componentFilePath ||
-          item.facadeModuleId === page.dataFilePath),
+        item.type === 'chunk' && item.facadeModuleId === page.chunkFilePath,
     )
     .flatMap(({ fileName, imports, dynamicImports }) => [
       fileName,

packages/cli/src/commands/dev/handlePageAdd.ts

@@ -1,10 +1,8 @@
 import {
   createPage,
+  preparePageChunk,
   preparePageComponent,
-  preparePageData,
-  preparePagesComponents,
-  preparePagesData,
-  preparePagesRoutes,
+  prepareRoutes,
 } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
@@ -33,12 +31,10 @@ export const handlePageAdd = async (
 
   // prepare page files
   await preparePageComponent(app, page)
-  await preparePageData(app, page)
+  await preparePageChunk(app, page)
 
-  // prepare pages entry
-  await preparePagesComponents(app)
-  await preparePagesData(app)
-  await preparePagesRoutes(app)
+  // prepare routes file
+  await prepareRoutes(app)
 
   return page
 }

packages/cli/src/commands/dev/handlePageChange.ts

@@ -1,10 +1,8 @@
 import {
   createPage,
+  preparePageChunk,
   preparePageComponent,
-  preparePageData,
-  preparePagesComponents,
-  preparePagesData,
-  preparePagesRoutes,
+  prepareRoutes,
 } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
@@ -36,21 +34,15 @@ export const handlePageChange = async (
 
   // prepare page files
   await preparePageComponent(app, pageNew)
-  await preparePageData(app, pageNew)
+  await preparePageChunk(app, pageNew)
 
   const isPathChanged = pageOld.path !== pageNew.path
   const isRouteMetaChanged =
     JSON.stringify(pageOld.routeMeta) !== JSON.stringify(pageNew.routeMeta)
 
-  // prepare pages entry if the path is changed
-  if (isPathChanged) {
-    await preparePagesComponents(app)
-    await preparePagesData(app)
-  }
-
-  // prepare pages routes if the path or routeMeta is changed
+  // prepare routes file if the path or route meta is changed
   if (isPathChanged || isRouteMetaChanged) {
-    await preparePagesRoutes(app)
+    await prepareRoutes(app)
   }
 
   return [pageOld, pageNew]

packages/cli/src/commands/dev/handlePageUnlink.ts

@@ -1,8 +1,4 @@
-import {
-  preparePagesComponents,
-  preparePagesData,
-  preparePagesRoutes,
-} from '@vuepress/core'
+import { prepareRoutes } from '@vuepress/core'
 import type { App, Page } from '@vuepress/core'
 
 /**
@@ -25,10 +21,8 @@ export const handlePageUnlink = async (
   // remove the old page
   app.pages.splice(pageIndex, 1)
 
-  // re-prepare page files
-  await preparePagesComponents(app)
-  await preparePagesData(app)
-  await preparePagesRoutes(app)
+  // re-prepare routes file
+  await prepareRoutes(app)
 
   return page
 }

packages/client/package.json

@@ -59,9 +59,7 @@
     "external": [
       "@internal/clientConfigs",
       "@internal/layoutComponents",
-      "@internal/pagesComponents",
-      "@internal/pagesData",
-      "@internal/pagesRoutes",
+      "@internal/routes",
       "@internal/siteData"
     ],
     "format": [