fix(virtual-module): should addDependencies in virtual-module for persistent cache (#2519)

Author: SoonIter

packages/core/src/node/runtimeModule/pageData/createPageData.ts

@@ -1,6 +1,5 @@
 import { type PageData, SEARCH_INDEX_NAME } from '@rspress/shared';
 import { groupBy } from 'lodash-es';
-import { isProduction } from '../../constants';
 import { extractPageData } from '../../route/extractPageData';
 import { createHash } from '../../utils';
 import type { FactoryContext } from '../types';
@@ -19,6 +18,7 @@ function deletePrivateField<T>(obj: T): T {
 }
 
 export async function createPageData(context: FactoryContext): Promise<{
+  filepaths: string[]; // for addDependencies
   pageData: PageData;
   searchIndex: Record<string, string>;
   indexHashByGroup: Record<string, string>;
@@ -93,6 +93,7 @@ export async function createPageData(context: FactoryContext): Promise<{
     pages.map(async pageData => pluginDriver.extendPageData(pageData)),
   );
 
+  const filepaths: string[] = [];
   const pageData: PageData = {
     pages: pages.map(page => {
       // omit some fields for runtime size
@@ -103,13 +104,13 @@ export async function createPageData(context: FactoryContext): Promise<{
         _flattenContent,
         ...rest
       } = page;
-      // FIXME: should not have differences from development
-      // In production, we cannot expose the complete filepath for security reasons
-      return isProduction() ? rest : { ...rest, _filepath };
+      filepaths.push(_filepath);
+      return rest;
     }),
   };
 
   return {
+    filepaths,
     pageData,
     searchIndex,
     indexHashByGroup,

packages/core/src/node/runtimeModule/pageData/rsbuildPlugin.ts

@@ -14,13 +14,19 @@ export const rsbuildPluginDocVM = async ({
     pageData: PageData | null;
     searchIndex: Record<string, string> | null;
     indexHashByGroup: Record<string, string> | null;
-  } = { pageData: null, searchIndex: null, indexHashByGroup: null };
+    filepaths: string[];
+  } = {
+    pageData: null,
+    searchIndex: null,
+    indexHashByGroup: null,
+    filepaths: [],
+  };
   const searchIndexRsbuildPlugin: RsbuildPlugin = {
     name: 'rsbuild-plugin-searchIndex',
     async setup(api) {
       api.modifyBundlerChain(async bundlerChain => {
         const alias = bundlerChain.resolve.alias.entries();
-        const { pageData, indexHashByGroup, searchIndex } =
+        const { pageData, indexHashByGroup, searchIndex, filepaths } =
           await createPageData({
             config,
             alias: alias as Record<string, string>,
@@ -32,6 +38,8 @@ export const rsbuildPluginDocVM = async ({
         ref.pageData = pageData;
         ref.searchIndex = searchIndex;
         ref.indexHashByGroup = indexHashByGroup;
+        ref.filepaths = filepaths;
+
         api.processAssets(
           { stage: 'report', environments: ['web'] },
           ({ compilation, compiler }) => {
@@ -54,10 +62,16 @@ export const rsbuildPluginDocVM = async ({
     pluginVirtualModule({
       tempDir: '.rspress',
       virtualModules: {
-        [RuntimeModuleID.PageData]: () =>
-          `export default ${JSON.stringify(ref.pageData, null, 2)}`,
-        [RuntimeModuleID.SearchIndexHash]: () =>
-          `export default ${JSON.stringify(ref.indexHashByGroup, null, 2)}`,
+        [RuntimeModuleID.PageData]: async ({ addDependency }) => {
+          // TODO: support hmr
+          // This place needs to obtain the specific file that has been modified and update the file information.
+          for (const file of ref.filepaths) {
+            addDependency(file);
+          }
+
+          return `export const pageData = ${JSON.stringify(ref.pageData, null, 2)};
+          export const searchIndexHash = ${JSON.stringify(ref.indexHashByGroup, null, 2)};`;
+        },
       },
     }),
   ];

packages/core/src/node/runtimeModule/types.ts

@@ -21,7 +21,6 @@ export enum RuntimeModuleID {
   Routes = 'virtual-routes',
   SiteData = 'virtual-site-data',
   PageData = 'virtual-page-data',
-  SearchIndexHash = 'virtual-search-index-hash',
   socialLinks = 'virtual-social-links',
   I18nText = 'virtual-i18n-text',
   SearchHooks = 'virtual-search-hooks',

packages/core/src/runtime/env.d.ts

@@ -13,14 +13,9 @@ declare module 'virtual-site-data' {
 
 declare module 'virtual-page-data' {
   import { PageData } from '@rspress/shared';
-
-  const data: PageData;
-  export default data;
-}
-
-declare module 'virtual-search-index-hash' {
-  const hash: string;
-  export default hash;
+  const searchIndexHash: Record<string, string>;
+  const pageData: PageData;
+  export { pageData, searchIndexHash };
 }
 
 declare module 'virtual-global-components' {

packages/core/src/runtime/initPageData.ts

@@ -7,7 +7,7 @@ import {
   MDX_OR_MD_REGEXP,
   type PageDataLegacy,
 } from '@rspress/shared';
-import pageData from 'virtual-page-data';
+import { pageData } from 'virtual-page-data';
 import siteData from 'virtual-site-data';
 
 type PageMeta = {

packages/runtime/rslib.config.ts

@@ -16,7 +16,7 @@ export default defineConfig({
         externals: [
           '@theme',
           'virtual-routes',
-          'virtual-search-index-hash',
+          'virtual-page-data',
           'virtual-site-data',
           'virtual-global-styles',
           'virtual-global-components',

packages/runtime/src/env.d.ts

@@ -11,9 +11,9 @@ declare module 'virtual-site-data' {
 
 declare module 'virtual-page-data' {
   import { PageData } from '@rspress/shared';
-
-  const data: PageData;
-  export default data;
+  const searchIndexHash: Record<string, string>;
+  const pageData: PageData;
+  export { pageData, searchIndexHash };
 }
 
 declare module 'virtual-i18n-text';

packages/runtime/src/hooks/usePages.ts

@@ -1,6 +1,6 @@
 import type { PageData } from '@rspress/shared';
-import pages from 'virtual-page-data';
+import { pageData } from 'virtual-page-data';
 
 export function usePages(): { pages: PageData['pages'] } {
-  return { pages: pages.pages };
+  return { pages: pageData.pages };
 }

packages/theme-default/rslib.config.ts

@@ -6,7 +6,6 @@ import { pluginPublint } from 'rsbuild-plugin-publint';
 
 const COMMON_EXTERNALS = [
   'virtual-routes',
-  'virtual-search-index-hash',
   'virtual-site-data',
   'virtual-global-styles',
   'virtual-global-components',

packages/theme-default/src/components/Search/logic/providers/LocalProvider.ts

@@ -13,7 +13,7 @@ import Index, {
   type EnrichedDocumentSearchResultSetUnit,
   type IndexOptionsForDocumentSearch,
 } from 'flexsearch';
-import searchIndexHash from 'virtual-search-index-hash';
+import { searchIndexHash } from 'virtual-page-data';
 import { LOCAL_INDEX, type Provider, type SearchQuery } from '../Provider';
 import type { SearchOptions } from '../types';
 import { normalizeTextCase } from '../util';