@module-federation/webpack-bundler-runtime 0.11.4 → 0.12.0

package/dist/index.esm.js

@@ -0,0 +1,361 @@
+import * as runtime from '@module-federation/runtime';
+import { FEDERATION_SUPPORTED_TYPES } from './constant.esm.js';
+import { decodeName, ENCODE_NAME_PREFIX } from '@module-federation/sdk';
+
+function attachShareScopeMap(webpackRequire) {
+    if (!webpackRequire.S || webpackRequire.federation.hasAttachShareScopeMap || !webpackRequire.federation.instance || !webpackRequire.federation.instance.shareScopeMap) {
+        return;
+    }
+    webpackRequire.S = webpackRequire.federation.instance.shareScopeMap;
+    webpackRequire.federation.hasAttachShareScopeMap = true;
+}
+
+function remotes(options) {
+    const { chunkId, promises, chunkMapping, idToExternalAndNameMapping, webpackRequire, idToRemoteMap } = options;
+    attachShareScopeMap(webpackRequire);
+    if (webpackRequire.o(chunkMapping, chunkId)) {
+        chunkMapping[chunkId].forEach((id)=>{
+            let getScope = webpackRequire.R;
+            if (!getScope) {
+                getScope = [];
+            }
+            const data = idToExternalAndNameMapping[id];
+            const remoteInfos = idToRemoteMap[id];
+            // @ts-ignore seems not work
+            if (getScope.indexOf(data) >= 0) {
+                return;
+            }
+            // @ts-ignore seems not work
+            getScope.push(data);
+            if (data.p) {
+                return promises.push(data.p);
+            }
+            const onError = (error)=>{
+                if (!error) {
+                    error = new Error('Container missing');
+                }
+                if (typeof error.message === 'string') {
+                    error.message += `\nwhile loading "${data[1]}" from ${data[2]}`;
+                }
+                webpackRequire.m[id] = ()=>{
+                    throw error;
+                };
+                data.p = 0;
+            };
+            const handleFunction = (fn, arg1, arg2, d, next, first)=>{
+                try {
+                    const promise = fn(arg1, arg2);
+                    if (promise && promise.then) {
+                        const p = promise.then((result)=>next(result, d), onError);
+                        if (first) {
+                            promises.push(data.p = p);
+                        } else {
+                            return p;
+                        }
+                    } else {
+                        return next(promise, d, first);
+                    }
+                } catch (error) {
+                    onError(error);
+                }
+            };
+            const onExternal = (external, _, first)=>external ? handleFunction(webpackRequire.I, data[0], 0, external, onInitialized, first) : onError();
+            // eslint-disable-next-line no-var
+            var onInitialized = (_, external, first)=>handleFunction(external.get, data[1], getScope, 0, onFactory, first);
+            // eslint-disable-next-line no-var
+            var onFactory = (factory)=>{
+                data.p = 1;
+                webpackRequire.m[id] = (module)=>{
+                    module.exports = factory();
+                };
+            };
+            const onRemoteLoaded = ()=>{
+                try {
+                    const remoteName = decodeName(remoteInfos[0].name, ENCODE_NAME_PREFIX);
+                    const remoteModuleName = remoteName + data[1].slice(1);
+                    const instance = webpackRequire.federation.instance;
+                    const loadRemote = ()=>webpackRequire.federation.instance.loadRemote(remoteModuleName, {
+                            loadFactory: false,
+                            from: 'build'
+                        });
+                    if (instance.options.shareStrategy === 'version-first') {
+                        return Promise.all(instance.sharedHandler.initializeSharing(data[0])).then(()=>{
+                            return loadRemote();
+                        });
+                    }
+                    return loadRemote();
+                } catch (error) {
+                    onError(error);
+                }
+            };
+            const useRuntimeLoad = remoteInfos.length === 1 && FEDERATION_SUPPORTED_TYPES.includes(remoteInfos[0].externalType) && remoteInfos[0].name;
+            if (useRuntimeLoad) {
+                handleFunction(onRemoteLoaded, data[2], 0, 0, onFactory, 1);
+            } else {
+                handleFunction(webpackRequire, data[2], 0, 0, onExternal, 1);
+            }
+        });
+    }
+}
+
+function consumes(options) {
+    const { chunkId, promises, chunkMapping, installedModules, moduleToHandlerMapping, webpackRequire } = options;
+    attachShareScopeMap(webpackRequire);
+    if (webpackRequire.o(chunkMapping, chunkId)) {
+        chunkMapping[chunkId].forEach((id)=>{
+            if (webpackRequire.o(installedModules, id)) {
+                return promises.push(installedModules[id]);
+            }
+            const onFactory = (factory)=>{
+                installedModules[id] = 0;
+                webpackRequire.m[id] = (module)=>{
+                    delete webpackRequire.c[id];
+                    module.exports = factory();
+                };
+            };
+            const onError = (error)=>{
+                delete installedModules[id];
+                webpackRequire.m[id] = (module)=>{
+                    delete webpackRequire.c[id];
+                    throw error;
+                };
+            };
+            try {
+                const federationInstance = webpackRequire.federation.instance;
+                if (!federationInstance) {
+                    throw new Error('Federation instance not found!');
+                }
+                const { shareKey, getter, shareInfo } = moduleToHandlerMapping[id];
+                const promise = federationInstance.loadShare(shareKey, {
+                    customShareInfo: shareInfo
+                }).then((factory)=>{
+                    if (factory === false) {
+                        return getter();
+                    }
+                    return factory;
+                });
+                if (promise.then) {
+                    promises.push(installedModules[id] = promise.then(onFactory).catch(onError));
+                } else {
+                    // @ts-ignore maintain previous logic
+                    onFactory(promise);
+                }
+            } catch (e) {
+                onError(e);
+            }
+        });
+    }
+}
+
+function initializeSharing({ shareScopeName, webpackRequire, initPromises, initTokens, initScope }) {
+    const shareScopeKeys = Array.isArray(shareScopeName) ? shareScopeName : [
+        shareScopeName
+    ];
+    var initializeSharingPromises = [];
+    var _initializeSharing = function(shareScopeKey) {
+        if (!initScope) initScope = [];
+        const mfInstance = webpackRequire.federation.instance;
+        // handling circular init calls
+        var initToken = initTokens[shareScopeKey];
+        if (!initToken) initToken = initTokens[shareScopeKey] = {
+            from: mfInstance.name
+        };
+        if (initScope.indexOf(initToken) >= 0) return;
+        initScope.push(initToken);
+        const promise = initPromises[shareScopeKey];
+        if (promise) return promise;
+        var warn = (msg)=>typeof console !== 'undefined' && console.warn && console.warn(msg);
+        var initExternal = (id)=>{
+            var handleError = (err)=>warn('Initialization of sharing external failed: ' + err);
+            try {
+                var module = webpackRequire(id);
+                if (!module) return;
+                var initFn = (module)=>module && module.init && // @ts-ignore compat legacy mf shared behavior
+                    module.init(webpackRequire.S[shareScopeKey], initScope, {
+                        shareScopeMap: webpackRequire.S || {},
+                        shareScopeKeys: shareScopeName
+                    });
+                if (module.then) return promises.push(module.then(initFn, handleError));
+                var initResult = initFn(module);
+                // @ts-ignore
+                if (initResult && typeof initResult !== 'boolean' && initResult.then) // @ts-ignore
+                return promises.push(initResult['catch'](handleError));
+            } catch (err) {
+                handleError(err);
+            }
+        };
+        const promises = mfInstance.initializeSharing(shareScopeKey, {
+            strategy: mfInstance.options.shareStrategy,
+            initScope,
+            from: 'build'
+        });
+        attachShareScopeMap(webpackRequire);
+        const bundlerRuntimeRemotesOptions = webpackRequire.federation.bundlerRuntimeOptions.remotes;
+        if (bundlerRuntimeRemotesOptions) {
+            Object.keys(bundlerRuntimeRemotesOptions.idToRemoteMap).forEach((moduleId)=>{
+                const info = bundlerRuntimeRemotesOptions.idToRemoteMap[moduleId];
+                const externalModuleId = bundlerRuntimeRemotesOptions.idToExternalAndNameMapping[moduleId][2];
+                if (info.length > 1) {
+                    initExternal(externalModuleId);
+                } else if (info.length === 1) {
+                    const remoteInfo = info[0];
+                    if (!FEDERATION_SUPPORTED_TYPES.includes(remoteInfo.externalType)) {
+                        initExternal(externalModuleId);
+                    }
+                }
+            });
+        }
+        if (!promises.length) {
+            return initPromises[shareScopeKey] = true;
+        }
+        return initPromises[shareScopeKey] = Promise.all(promises).then(()=>initPromises[shareScopeKey] = true);
+    };
+    shareScopeKeys.forEach((key)=>{
+        initializeSharingPromises.push(_initializeSharing(key));
+    });
+    return Promise.all(initializeSharingPromises).then(()=>true);
+}
+
+function handleInitialConsumes(options) {
+    const { moduleId, moduleToHandlerMapping, webpackRequire } = options;
+    const federationInstance = webpackRequire.federation.instance;
+    if (!federationInstance) {
+        throw new Error('Federation instance not found!');
+    }
+    const { shareKey, shareInfo } = moduleToHandlerMapping[moduleId];
+    try {
+        return federationInstance.loadShareSync(shareKey, {
+            customShareInfo: shareInfo
+        });
+    } catch (err) {
+        console.error('loadShareSync failed! The function should not be called unless you set "eager:true". If you do not set it, and encounter this issue, you can check whether an async boundary is implemented.');
+        console.error('The original error message is as follows: ');
+        throw err;
+    }
+}
+function installInitialConsumes(options) {
+    const { moduleToHandlerMapping, webpackRequire, installedModules, initialConsumes } = options;
+    initialConsumes.forEach((id)=>{
+        webpackRequire.m[id] = (module)=>{
+            // Handle scenario when module is used synchronously
+            installedModules[id] = 0;
+            delete webpackRequire.c[id];
+            const factory = handleInitialConsumes({
+                moduleId: id,
+                moduleToHandlerMapping,
+                webpackRequire
+            });
+            if (typeof factory !== 'function') {
+                throw new Error(`Shared module is not available for eager consumption: ${id}`);
+            }
+            module.exports = factory();
+        };
+    });
+}
+
+function _extends() {
+    _extends = Object.assign || function assign(target) {
+        for(var i = 1; i < arguments.length; i++){
+            var source = arguments[i];
+            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
+        }
+        return target;
+    };
+    return _extends.apply(this, arguments);
+}
+
+function initContainerEntry(options) {
+    const { webpackRequire, shareScope, initScope, shareScopeKey, remoteEntryInitOptions } = options;
+    if (!webpackRequire.S) return;
+    if (!webpackRequire.federation || !webpackRequire.federation.instance || !webpackRequire.federation.initOptions) return;
+    const federationInstance = webpackRequire.federation.instance;
+    federationInstance.initOptions(_extends({
+        name: webpackRequire.federation.initOptions.name,
+        remotes: []
+    }, remoteEntryInitOptions));
+    const hostShareScopeKeys = remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeKeys;
+    const hostShareScopeMap = remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeMap;
+    // host: 'default' remote: 'default'  remote['default'] = hostShareScopeMap['default']
+    // host: ['default', 'scope1'] remote: 'default'  remote['default'] = hostShareScopeMap['default']; remote['scope1'] = hostShareScopeMap['scop1']
+    // host: 'default' remote: ['default','scope1']  remote['default'] = hostShareScopeMap['default']; remote['scope1'] = hostShareScopeMap['scope1'] = {}
+    // host: ['scope1','default'] remote: ['scope1','scope2'] => remote['scope1'] = hostShareScopeMap['scope1']; remote['scope2'] = hostShareScopeMap['scope2'] = {};
+    if (!shareScopeKey || typeof shareScopeKey === 'string') {
+        const key = shareScopeKey || 'default';
+        if (Array.isArray(hostShareScopeKeys)) {
+            // const sc = hostShareScopeMap![key];
+            // if (!sc) {
+            //   throw new Error('shareScopeKey is not exist in hostShareScopeMap');
+            // }
+            // federationInstance.initShareScopeMap(key, sc, {
+            //   hostShareScopeMap: remoteEntryInitOptions?.shareScopeMap || {},
+            // });
+            hostShareScopeKeys.forEach((hostKey)=>{
+                if (!hostShareScopeMap[hostKey]) {
+                    hostShareScopeMap[hostKey] = {};
+                }
+                const sc = hostShareScopeMap[hostKey];
+                federationInstance.initShareScopeMap(hostKey, sc, {
+                    hostShareScopeMap: (remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeMap) || {}
+                });
+            });
+        } else {
+            federationInstance.initShareScopeMap(key, shareScope, {
+                hostShareScopeMap: (remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeMap) || {}
+            });
+        }
+    } else {
+        shareScopeKey.forEach((key)=>{
+            if (!hostShareScopeKeys || !hostShareScopeMap) {
+                federationInstance.initShareScopeMap(key, shareScope, {
+                    hostShareScopeMap: (remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeMap) || {}
+                });
+                return;
+            }
+            if (!hostShareScopeMap[key]) {
+                hostShareScopeMap[key] = {};
+            }
+            const sc = hostShareScopeMap[key];
+            federationInstance.initShareScopeMap(key, sc, {
+                hostShareScopeMap: (remoteEntryInitOptions == null ? void 0 : remoteEntryInitOptions.shareScopeMap) || {}
+            });
+        });
+    }
+    if (webpackRequire.federation.attachShareScopeMap) {
+        webpackRequire.federation.attachShareScopeMap(webpackRequire);
+    }
+    if (typeof webpackRequire.federation.prefetch === 'function') {
+        webpackRequire.federation.prefetch();
+    }
+    if (!Array.isArray(shareScopeKey)) {
+        // @ts-ignore
+        return webpackRequire.I(shareScopeKey || 'default', initScope);
+    }
+    var proxyInitializeSharing = Boolean(webpackRequire.federation.initOptions.shared);
+    if (proxyInitializeSharing) {
+        // @ts-ignore
+        return webpackRequire.I(shareScopeKey, initScope);
+    }
+    // @ts-ignore
+    return Promise.all(shareScopeKey.map((key)=>{
+        // @ts-ignore
+        return webpackRequire.I(key, initScope);
+    })).then(()=>true);
+}
+
+const federation = {
+    runtime,
+    instance: undefined,
+    initOptions: undefined,
+    bundlerRuntime: {
+        remotes,
+        consumes,
+        I: initializeSharing,
+        S: {},
+        installInitialConsumes,
+        initContainerEntry
+    },
+    attachShareScopeMap,
+    bundlerRuntimeOptions: {}
+};
+
+export { federation as default };

package/dist/src/types.d.ts

@@ -13,7 +13,7 @@ type InferredModule = InferModule<ModuleCache>;
 export type ShareScopeMap = runtime.FederationHost['shareScopeMap'];
 type InitToken = Record<string, Record<string, any>>;
 export interface InitializeSharingOptions {
-    shareScopeName: string;
+    shareScopeName: string | string[];
     webpackRequire: WebpackRequire;
     initPromises: Record<string, Promise<boolean> | boolean>;
     initTokens: InitToken;
@@ -37,7 +37,7 @@ export interface WebpackRequire {
     R: Array<string | number>;
     m: Record<string, (mod: any) => any>;
     c: Record<string, any>;
-    I: (scopeName: string, initScope?: InitializeSharingOptions['initScope']) => ReturnType<typeof initializeSharing>;
+    I: (scopeName: string | string[], initScope?: InitializeSharingOptions['initScope']) => ReturnType<typeof initializeSharing>;
     S?: InferredGlobalShareScope;
     federation: Federation;
 }
@@ -84,7 +84,7 @@ export interface ConsumesOptions {
 }
 export interface InitContainerEntryOptions {
     shareScope: ShareScopeMap[string];
-    shareScopeKey: string;
+    shareScopeKey: string | string[];
     webpackRequire: WebpackRequire;
     remoteEntryInitOptions?: RemoteEntryInitOptions;
     initScope?: InitializeSharingOptions['initScope'];

package/package.json

@@ -1,7 +1,8 @@
 {
   "public": true,
   "name": "@module-federation/webpack-bundler-runtime",
-  "version": "0.11.4",
+  "version": "0.12.0",
+  "type": "module",
   "license": "MIT",
   "description": "Module Federation Runtime for webpack",
   "keywords": [
@@ -21,21 +22,33 @@
     "directory": "packages/webpack-bundler-runtime"
   },
   "author": "zhanghang <hanric.zhang@gmail.com>",
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.esm.mjs",
+  "main": "./dist/index.cjs.cjs",
+  "module": "./dist/index.esm.js",
   "types": "./dist/index.cjs.d.ts",
   "dependencies": {
-    "@module-federation/runtime": "0.11.4",
-    "@module-federation/sdk": "0.11.4"
+    "@module-federation/runtime": "0.12.0",
+    "@module-federation/sdk": "0.12.0"
   },
   "exports": {
     ".": {
-      "import": "./dist/index.esm.mjs",
-      "require": "./dist/index.cjs.js"
+      "import": {
+        "types": "./dist/index.esm.d.ts",
+        "default": "./dist/index.esm.js"
+      },
+      "require": {
+        "types": "./dist/index.cjs.d.ts",
+        "default": "./dist/index.cjs.cjs"
+      }
     },
     "./constant": {
-      "import": "./dist/constant.esm.mjs",
-      "require": "./dist/constant.cjs.js"
+      "import": {
+        "types": "./dist/constant.esm.d.ts",
+        "default": "./dist/constant.esm.js"
+      },
+      "require": {
+        "types": "./dist/constant.cjs.d.ts",
+        "default": "./dist/constant.cjs.cjs"
+      }
     },
     "./*": "./*"
   },
@@ -50,6 +63,6 @@
     }
   },
   "devDependencies": {
-    "@module-federation/runtime": "0.11.4"
+    "@module-federation/runtime": "0.12.0"
   }
 }

package/dist/constant.esm.mjs

@@ -1,3 +0,0 @@
-const FEDERATION_SUPPORTED_TYPES = ['script'];
-
-export { FEDERATION_SUPPORTED_TYPES };