feat: add support for disabling imports for shared modules

- Add import flag to shareConfig interface and normalization
- Handle import: false modules in virtual remote entry generation

Author: pcfreak30

package.json

@@ -47,6 +47,7 @@
   "packageManager": "[email protected]",
   "dependencies": {
     "@module-federation/runtime": "^0.17.1",
+    "@module-federation/sdk": "^0.18.3",
     "@rollup/pluginutils": "^5.1.0",
     "defu": "^6.1.4",
     "estree-walker": "^2",

pnpm-lock.yaml

@@ -1,4 +1,5 @@
 import { SharedConfig, ShareStrategy } from '@module-federation/runtime/types';
+import type { sharePlugin } from '@module-federation/sdk';
 
 export type RemoteEntryType =
   | 'var'
@@ -104,7 +105,7 @@ export interface ShareItem {
   version: string | undefined;
   scope: string;
   from: string;
-  shareConfig: SharedConfig;
+  shareConfig: SharedConfig & sharePlugin.SharedConfig;
 }
 
 function removePathFromNpmPackage(packageString: string): string {
@@ -157,6 +158,7 @@ function normalizeShareItem(
     | string
     | {
         name: string;
+        import: sharePlugin.SharedConfig['import'];
         version?: string;
         shareScope?: string;
         singleton?: boolean;
@@ -192,6 +194,7 @@ function normalizeShareItem(
       scope: 'default',
       from: '',
       shareConfig: {
+        import: undefined,
         singleton: false,
         requiredVersion: version ? `^${version}` : '*',
       },
@@ -203,6 +206,7 @@ function normalizeShareItem(
     version: shareItem.version || version,
     scope: shareItem.shareScope || 'default',
     shareConfig: {
+      import: typeof shareItem === 'object' ? shareItem.import : undefined,
       singleton: shareItem.singleton || false,
       requiredVersion: shareItem.requiredVersion || (version ? `^${version}` : '*'),
       strictVersion: !!shareItem.strictVersion,
@@ -289,6 +293,7 @@ export type ModuleFederationOptions = {
             singleton?: boolean;
             requiredVersion?: string;
             strictVersion?: boolean;
+            import?: sharePlugin.SharedConfig['import'];
           }
       >
     | undefined;

src/utils/normalizeModuleFederationOptions.ts

@@ -38,16 +38,22 @@ export function writeLocalSharedImportMap() {
 export function generateLocalSharedImportMap() {
   const options = getNormalizeModuleFederationOptions();
   return `
+    import {loadShare} from "@module-federation/runtime";
     const importMap = {
       ${Array.from(getUsedShares())
-        .map(
-          (pkg) => `
+        .map((pkg) => {
+          const shareItem = getNormalizeShareItem(pkg);
+          return `
         ${JSON.stringify(pkg)}: async () => {
-          let pkg = await import("${getPreBuildLibImportId(pkg)}")
-          return pkg
+          ${
+            shareItem?.shareConfig.import === false
+              ? `throw new Error(\`Shared module '\${${JSON.stringify(pkg)}}' must be provided by host\`);`
+              : `let pkg = await import("${getPreBuildLibImportId(pkg)}");
+            return pkg;`
+          }
         }
-      `
-        )
+      `;
+        })
         .join(',')}
     }
       const usedShared = {
@@ -63,8 +69,13 @@ export function generateLocalSharedImportMap() {
             loaded: false,
             from: ${JSON.stringify(options.name)},
             async get () {
+              if (${shareItem.shareConfig.import === false}) {
+                const shared = await loadShare(${JSON.stringify(key)});
+                if (shared) return () => shared;
+                throw new Error(\`Shared module '\${${JSON.stringify(key)}}' must be provided by host\`);
+              }
               usedShared[${JSON.stringify(key)}].loaded = true
-              const {${JSON.stringify(key)}: pkgDynamicImport} = importMap 
+              const {${JSON.stringify(key)}: pkgDynamicImport} = importMap
               const res = await pkgDynamicImport()
               const exportModule = {...res}
               // All npm packages pre-built by vite will be converted to esm
@@ -78,7 +89,8 @@ export function generateLocalSharedImportMap() {
             },
             shareConfig: {
               singleton: ${shareItem.shareConfig.singleton},
-              requiredVersion: ${JSON.stringify(shareItem.shareConfig.requiredVersion)}
+              requiredVersion: ${JSON.stringify(shareItem.shareConfig.requiredVersion)},
+              ${shareItem.shareConfig.import === false ? 'import: false,' : ''}
             }
           }
         `;
@@ -176,7 +188,7 @@ const hostAutoInitModule = new VirtualModule('hostAutoInit', HOST_AUTO_INIT_TAG)
 export function writeHostAutoInit() {
   hostAutoInitModule.writeSync(`
     const remoteEntryPromise = import("${REMOTE_ENTRY_ID}")
-    // __tla only serves as a hack for vite-plugin-top-level-await. 
+    // __tla only serves as a hack for vite-plugin-top-level-await.
     Promise.resolve(remoteEntryPromise)
       .then(remoteEntry => {
         return Promise.resolve(remoteEntry.__tla)