feat: add moduleParseTimeout config (#391)

Author: gioboa

README.md

@@ -118,6 +118,9 @@ export default defineConfig({
       // When false (default), the plugin will not process any CSS assets.
       // When true, all CSS assets are bundled into every exposed module.
       bundleAllCSS: false, // or true
+      // Timeout for parsing modules in seconds.
+      // Defaults to 10 seconds.
+      moduleParseTimeout: 10,
     }),
   ],
   server: {
@@ -134,6 +137,7 @@ export default defineConfig({
 
 The host app configuration specifies its name, the filename of its exposed remote entry remoteEntry.js, and importantly, the configuration of the remote application to load.
 You can specify the place the host initialization file is injected with the **hostInitInjectLocation** option, which is described in the example code above.
+The **moduleParseTimeout** option allows you to configure the maximum time to wait for module parsing during the build process.
 
 ## Load the Remote App
 

examples/vite-webpack-rspack/host/vite.config.js

@@ -23,6 +23,7 @@ const mfConfig = {
     },
   },
   shared: ['react', 'react-dom', 'lodash'],
+  moduleParseTimeout: 2,
 };
 
 // https://vitejs.dev/config/

src/index.ts

@@ -3,11 +3,11 @@ import { Plugin } from 'vite';
 import addEntry from './plugins/pluginAddEntry';
 import { checkAliasConflicts } from './plugins/pluginCheckAliasConflicts';
 import { PluginDevProxyModuleTopLevelAwait } from './plugins/pluginDevProxyModuleTopLevelAwait';
+import pluginDts from './plugins/pluginDts';
 import pluginManifest from './plugins/pluginMFManifest';
 import pluginModuleParseEnd from './plugins/pluginModuleParseEnd';
 import pluginProxyRemoteEntry from './plugins/pluginProxyRemoteEntry';
 import pluginProxyRemotes from './plugins/pluginProxyRemotes';
-import pluginDts from './plugins/pluginDts';
 import { proxySharedModule } from './plugins/pluginProxySharedModule_preBuild';
 import aliasToArrayPlugin from './utils/aliasToArrayPlugin';
 import {
@@ -62,14 +62,19 @@ function federation(mfUserOptions: ModuleFederationOptions): Plugin[] {
     }),
     pluginProxyRemoteEntry(),
     pluginProxyRemotes(options),
-    ...pluginModuleParseEnd((id: string) => {
-      return (
-        id.includes(getHostAutoInitImportId()) ||
-        id.includes(REMOTE_ENTRY_ID) ||
-        id.includes(VIRTUAL_EXPOSES) ||
-        id.includes(getLocalSharedImportMapPath())
-      );
-    }),
+    ...pluginModuleParseEnd(
+      (id: string) => {
+        return (
+          id.includes(getHostAutoInitImportId()) ||
+          id.includes(REMOTE_ENTRY_ID) ||
+          id.includes(VIRTUAL_EXPOSES) ||
+          id.includes(getLocalSharedImportMapPath())
+        );
+      },
+      {
+        moduleParseTimeout: options.moduleParseTimeout,
+      }
+    ),
     ...proxySharedModule({
       shared,
     }),

src/plugins/pluginModuleParseEnd.ts

@@ -5,26 +5,37 @@
 import { Plugin } from 'vite';
 import { VIRTUAL_EXPOSES } from '../virtualModules';
 
-let _resolve: any,
-  _reject: any,
-  _parseTimeout: any,
-  promise = new Promise((resolve, reject) => {
+let _resolve: any, _reject: any, _parseTimeout: any;
+
+const promise = new Promise((resolve, reject) => {
+  _resolve = (v: any) => {
+    clearTimeout(_parseTimeout);
+    _parseTimeout = null;
+    resolve(v);
+  };
+  _reject = (e: any) => {
+    clearTimeout(_parseTimeout);
+    _parseTimeout = null;
+    reject(e);
+  };
+});
+
+function setParseTimeout(timeout: number) {
+  if (!_parseTimeout) {
     _parseTimeout = setTimeout(() => {
-      console.warn('Parse timeout (5s) - forcing resolve');
-      resolve(1);
-    }, 5000);
-    _resolve = (v: any) => {
-      clearTimeout(_parseTimeout);
-      resolve(v);
-    };
-    _reject = reject;
-  });
+      console.warn(`Parse timeout (${timeout}s) - forcing resolve`);
+      _resolve(1);
+    }, timeout * 1000);
+  }
+}
+
 let parsePromise = promise;
 let exposesParseEnd = false;
 
 const parseStartSet = new Set();
 const parseEndSet = new Set();
-export default function (excludeFn: Function): Plugin[] {
+export default function (excludeFn: Function, options: { moduleParseTimeout: number }): Plugin[] {
+  setParseTimeout(options.moduleParseTimeout);
   return [
     {
       name: '_',

src/utils/__tests__/normalizeModuleFederationOption.test.ts

@@ -31,6 +31,7 @@ describe('normalizeModuleFederationOption', () => {
       bundleAllCSS: false,
       getPublicPath: undefined,
       publicPath: undefined,
+      moduleParseTimeout: 10,
     });
   });
 

src/utils/normalizeModuleFederationOptions.ts

@@ -317,6 +317,11 @@ export type ModuleFederationOptions = {
   ignoreOrigin?: boolean;
   virtualModuleDir?: string;
   hostInitInjectLocation?: HostInitInjectLocationOptions;
+  /**
+   * Timeout for parsing modules in seconds.
+   * Defaults to 10 seconds.
+   */
+  moduleParseTimeout?: number;
 };
 
 export interface NormalizedModuleFederationOptions {
@@ -346,6 +351,7 @@ export interface NormalizedModuleFederationOptions {
    * When true, all CSS assets are bundled into every exposed module.
    */
   bundleAllCSS: boolean;
+  moduleParseTimeout: number;
 }
 
 type HostInitInjectLocationOptions = 'entry' | 'html';
@@ -457,5 +463,6 @@ export function normalizeModuleFederationOptions(
     virtualModuleDir: options.virtualModuleDir || '__mf__virtual',
     hostInitInjectLocation: options.hostInitInjectLocation || 'html',
     bundleAllCSS: options.bundleAllCSS || false,
+    moduleParseTimeout: options.moduleParseTimeout || 10,
   });
 }