@module-federation/runtime 0.0.0-next-20231229074949 → 0.0.0-next-20231230034830

package/dist/helpers.cjs.js

@@ -3,7 +3,7 @@
 var share = require('./share.cjs.js');
 
 const ShareUtils = {
-    getGlobalShare: share.getGlobalShare,
+    getRegisteredShare: share.getRegisteredShare,
     getGlobalShareScope: share.getGlobalShareScope
 };
 const GlobalUtils = {

package/dist/helpers.esm.js

@@ -1,7 +1,7 @@
-import { l as getGlobalShare, x as getGlobalShareScope, F as nativeGlobal, H as resetFederationGlobalInfo, A as getGlobalFederationInstance, C as setGlobalFederationInstance, B as getGlobalFederationConstructor, z as setGlobalFederationConstructor, m as getInfoWithoutType, r as getGlobalSnapshot, I as getTargetSnapshotInfoByModuleInfo, p as getGlobalSnapshotInfoByModuleInfo, q as setGlobalSnapshotInfoByModuleInfo, J as addGlobalSnapshot, c as getRemoteEntryExports, E as registerGlobalPlugins, g as getGlobalHostPlugins, n as getPreloaded, o as setPreloaded } from './share.esm.js';
+import { l as getRegisteredShare, t as getGlobalShareScope, F as nativeGlobal, H as resetFederationGlobalInfo, A as getGlobalFederationInstance, C as setGlobalFederationInstance, B as getGlobalFederationConstructor, z as setGlobalFederationConstructor, m as getInfoWithoutType, r as getGlobalSnapshot, I as getTargetSnapshotInfoByModuleInfo, p as getGlobalSnapshotInfoByModuleInfo, q as setGlobalSnapshotInfoByModuleInfo, J as addGlobalSnapshot, c as getRemoteEntryExports, E as registerGlobalPlugins, g as getGlobalHostPlugins, n as getPreloaded, o as setPreloaded } from './share.esm.js';
 
 const ShareUtils = {
-    getGlobalShare,
+    getRegisteredShare,
     getGlobalShareScope
 };
 const GlobalUtils = {

package/dist/index.cjs.js

@@ -82,7 +82,7 @@ function registerPlugins(plugins, hookInstances) {
     if (plugins && plugins.length > 0) {
         plugins.forEach((plugin)=>{
             hookInstances.forEach((hookInstance)=>{
-                hookInstance.usePlugin(plugin);
+                hookInstance.applyPlugin(plugin);
             });
         });
     }
@@ -121,6 +121,27 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
     if (remoteEntryExports) {
         return remoteEntryExports;
     }
+    if (typeof document === 'undefined') {
+        return sdk.loadScriptNode(entry, {
+            attrs: {
+                name,
+                globalName
+            },
+            createScriptHook
+        }).then(()=>{
+            const { remoteEntryKey, entryExports } = share.getRemoteEntryExports(name, globalName);
+            share.assert(entryExports, `
+        Unable to use the ${name}'s '${entry}' URL with ${remoteEntryKey}'s globalName to get remoteEntry exports.
+        Possible reasons could be:\n
+        1. '${entry}' is not the correct URL, or the remoteEntry resource or name is incorrect.\n
+        2. ${remoteEntryKey} cannot be used to get remoteEntry exports in the window object.
+      `);
+            console.log(entryExports);
+            return entryExports;
+        }).catch((e)=>{
+            return e;
+        });
+    }
     return sdk.loadScript(entry, {
         attrs: {},
         createScriptHook
@@ -133,6 +154,8 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
       2. ${remoteEntryKey} cannot be used to get remoteEntry exports in the window object.
     `);
         return entryExports;
+    }).catch((e)=>{
+        return e;
     });
 }
 async function getRemoteEntry({ remoteEntryExports, remoteInfo, createScriptHook }) {
@@ -194,6 +217,10 @@ let Module = class Module {
                 const res = this.loaderHook.lifecycle.createScript.emit({
                     url
                 });
+                if (typeof document === 'undefined') {
+                    //todo: needs real fix
+                    return res;
+                }
                 if (res instanceof HTMLScriptElement) {
                     return res;
                 }
@@ -209,15 +236,16 @@ let Module = class Module {
         const { loadFactory = true } = options || {
             loadFactory: true
         };
+        this.hostInfo.name;
         // Get remoteEntry.js
         const remoteEntryExports = await this.getEntry();
         if (!this.inited) {
-            const globalShareScope = share.Global.__FEDERATION__.__SHARE__;
+            const localShareScopeMap = this.shareScopeMap;
             const remoteShareScope = this.remoteInfo.shareScope || 'default';
-            if (!globalShareScope[remoteShareScope]) {
-                globalShareScope[remoteShareScope] = {};
+            if (!localShareScopeMap[remoteShareScope]) {
+                localShareScopeMap[remoteShareScope] = {};
             }
-            const shareScope = globalShareScope[remoteShareScope];
+            const shareScope = localShareScopeMap[remoteShareScope];
             // TODO: compat logic , it could be moved after providing startup hooks
             const remoteEntryInitOptions = {
                 version: this.remoteInfo.version || '',
@@ -227,10 +255,18 @@ let Module = class Module {
             remoteEntryExports.init(shareScope, [], remoteEntryInitOptions);
             const federationInstance = share.Global.__FEDERATION__.__INSTANCES__.find((i)=>i.options.id === sdk.composeKeyWithSeparator(this.remoteInfo.name, this.remoteInfo.buildVersion));
             if (federationInstance) {
-                federationInstance.initOptions(_extends$4({}, remoteEntryInitOptions, {
-                    remotes: [],
-                    name: this.remoteInfo.name
-                }));
+                // means the instance is prev vmok instance
+                if (!federationInstance.releaseNumber || Number(federationInstance.releaseNumber) <= 100) {
+                    // 兼容旧的生产者传参
+                    federationInstance.initOptions(_extends$4({}, remoteEntryInitOptions, {
+                        remotes: [],
+                        name: this.remoteInfo.name
+                    }));
+                    if (!__FEDERATION__.__SHARE__['default'] && this.shareScopeMap && this.shareScopeMap['default']) {
+                        // @ts-ignore compat prev logic , and it will be optimized by supporting startup hook
+                        __FEDERATION__.__SHARE__['default'] = this.shareScopeMap['default'];
+                    }
+                }
             }
         }
         this.lib = remoteEntryExports;
@@ -245,7 +281,7 @@ let Module = class Module {
         return exposeContent;
     }
     // loading: Record<string, undefined | Promise<RemoteEntryExports | void>> = {};
-    constructor({ hostInfo, remoteInfo, shared, loaderHook }){
+    constructor({ hostInfo, remoteInfo, shared, loaderHook, shareScopeMap }){
         this.inited = false;
         this.shared = {};
         this.lib = undefined;
@@ -253,6 +289,7 @@ let Module = class Module {
         this.remoteInfo = remoteInfo;
         this.shared = shared;
         this.loaderHook = loaderHook;
+        this.shareScopeMap = shareScopeMap;
     }
 };
 
@@ -400,7 +437,7 @@ class AsyncWaterfallHook extends SyncHook {
 }
 
 class PluginSystem {
-    usePlugin(plugin) {
+    applyPlugin(plugin) {
         share.assert(share.isPlainObject(plugin), 'Plugin configuration is invalid.');
         // The plugin's name is mandatory and must be unique
         const pluginName = plugin.name;
@@ -433,7 +470,7 @@ class PluginSystem {
         });
         Object.keys(registerPlugins).forEach((pluginName)=>{
             share.assert(!this.registerPlugins[pluginName], `The plugin "${pluginName}" has a conflict and cannot be inherited.`);
-            this.usePlugin(registerPlugins[pluginName]);
+            this.applyPlugin(registerPlugins[pluginName]);
         });
     }
     constructor(lifecycle){
@@ -779,9 +816,9 @@ function generatePreloadAssets(origin, preloadOptions, remote, globalSnapshot, r
             if (!shareInfo) {
                 return;
             }
-            const globalShare = share.getGlobalShare(shared.sharedName, shareInfo);
+            const registeredShared = share.getRegisteredShare(origin.shareScopeMap, shared.sharedName, shareInfo, origin.hooks.lifecycle.resolveShare);
             // If the global share does not exist, or the lib function does not exist, it means that the shared has not been loaded yet and can be preloaded.
-            if (globalShare && typeof globalShare.lib === 'function') {
+            if (registeredShared && typeof registeredShared.lib === 'function') {
                 shared.assets.js.sync.forEach((asset)=>{
                     loadedSharedJsAssets.add(asset);
                 });
@@ -1108,6 +1145,13 @@ function _object_without_properties_loose(source, excluded) {
     return target;
 }
 class FederationHost {
+    _setGlobalShareScopeMap() {
+        const globalShareScopeMap = share.getGlobalShareScope();
+        const identifier = this.options.id || this.options.name;
+        if (identifier && !globalShareScopeMap[identifier]) {
+            globalShareScopeMap[identifier] = this.shareScopeMap;
+        }
+    }
     initOptions(userOptions) {
         this.registerPlugins(userOptions.plugins);
         const options = this.formatOptions(this.options, userOptions);
@@ -1122,6 +1166,11 @@ class FederationHost {
         // 2. Searches globally for a matching share, if found, it uses it directly
         // 3. If not found, it retrieves it from the current share and stores the obtained share globally.
         const shareInfo = Object.assign({}, (_this_options_shared = this.options.shared) == null ? void 0 : _this_options_shared[pkgName], customShareInfo);
+        if (shareInfo == null ? void 0 : shareInfo.scope) {
+            shareInfo.scope.forEach((shareScope)=>{
+                this.initializeSharing(shareScope, shareInfo.strategy);
+            });
+        }
         const loadShareRes = await this.hooks.lifecycle.beforeLoadShare.emit({
             pkgName,
             shareInfo,
@@ -1132,30 +1181,42 @@ class FederationHost {
         // Assert that shareInfoRes exists, if not, throw an error
         share.assert(shareInfoRes, `Cannot find ${pkgName} Share in the ${this.options.name}. Please ensure that the ${pkgName} Share parameters have been injected`);
         // Retrieve from cache
-        const globalShare = share.getGlobalShare(pkgName, shareInfoRes);
-        if (globalShare && globalShare.lib) {
-            share.addUniqueItem(globalShare.useIn, this.options.name);
-            return globalShare.lib;
-        } else if (globalShare && globalShare.loading) {
-            const factory = await globalShare.loading;
-            share.addUniqueItem(globalShare.useIn, this.options.name);
+        const registeredShared = share.getRegisteredShare(this.shareScopeMap, pkgName, shareInfoRes, this.hooks.lifecycle.resolveShare);
+        const addUseIn = (shared)=>{
+            if (!shared.useIn) {
+                shared.useIn = [];
+            }
+            share.addUniqueItem(shared.useIn, this.options.name);
+        };
+        if (registeredShared && registeredShared.lib) {
+            addUseIn(registeredShared);
+            return registeredShared.lib;
+        } else if (registeredShared && registeredShared.loading && !registeredShared.loaded) {
+            const factory = await registeredShared.loading;
+            registeredShared.loaded = true;
+            if (!registeredShared.lib) {
+                registeredShared.lib = factory;
+            }
+            addUseIn(registeredShared);
             return factory;
-        } else if (globalShare) {
+        } else if (registeredShared) {
             const asyncLoadProcess = async ()=>{
-                const factory = await globalShare.get();
+                const factory = await registeredShared.get();
                 shareInfoRes.lib = factory;
-                share.addUniqueItem(shareInfoRes.useIn, this.options.name);
-                const gShared = share.getGlobalShare(pkgName, shareInfoRes);
+                shareInfoRes.loaded = true;
+                addUseIn(shareInfoRes);
+                const gShared = share.getRegisteredShare(this.shareScopeMap, pkgName, shareInfoRes, this.hooks.lifecycle.resolveShare);
                 if (gShared) {
                     gShared.lib = factory;
+                    gShared.loaded = true;
                 }
                 return factory;
             };
             const loading = asyncLoadProcess();
             this.setShared({
                 pkgName,
-                loaded: true,
-                shared: shareInfoRes,
+                loaded: false,
+                shared: registeredShared,
                 from: this.options.name,
                 lib: null,
                 loading
@@ -1168,17 +1229,19 @@ class FederationHost {
             const asyncLoadProcess = async ()=>{
                 const factory = await shareInfoRes.get();
                 shareInfoRes.lib = factory;
-                share.addUniqueItem(shareInfoRes.useIn, this.options.name);
-                const gShared = share.getGlobalShare(pkgName, shareInfoRes);
+                shareInfoRes.loaded = true;
+                addUseIn(shareInfoRes);
+                const gShared = share.getRegisteredShare(this.shareScopeMap, pkgName, shareInfoRes, this.hooks.lifecycle.resolveShare);
                 if (gShared) {
                     gShared.lib = factory;
+                    gShared.loaded = true;
                 }
                 return factory;
             };
             const loading = asyncLoadProcess();
             this.setShared({
                 pkgName,
-                loaded: true,
+                loaded: false,
                 shared: shareInfoRes,
                 from: this.options.name,
                 lib: null,
@@ -1194,16 +1257,16 @@ class FederationHost {
     loadShareSync(pkgName) {
         var _this_options_shared;
         const shareInfo = (_this_options_shared = this.options.shared) == null ? void 0 : _this_options_shared[pkgName];
-        const globalShare = share.getGlobalShare(pkgName, shareInfo);
-        if (globalShare && typeof globalShare.lib === 'function') {
-            share.addUniqueItem(globalShare.useIn, this.options.name);
-            if (!globalShare.loaded) {
-                globalShare.loaded = true;
-                if (globalShare.from === this.options.name) {
+        const registeredShared = share.getRegisteredShare(this.shareScopeMap, pkgName, shareInfo, this.hooks.lifecycle.resolveShare);
+        if (registeredShared && typeof registeredShared.lib === 'function') {
+            share.addUniqueItem(registeredShared.useIn, this.options.name);
+            if (!registeredShared.loaded) {
+                registeredShared.loaded = true;
+                if (registeredShared.from === this.options.name) {
                     shareInfo.loaded = true;
                 }
             }
-            return globalShare.lib;
+            return registeredShared.lib;
         }
         if (shareInfo.lib) {
             if (!shareInfo.loaded) {
@@ -1274,7 +1337,8 @@ class FederationHost {
             remoteInfo,
             shared: this.options.shared || {},
             plugins: this.options.plugins,
-            loaderHook: this.loaderHook
+            loaderHook: this.loaderHook,
+            shareScopeMap: this.shareScopeMap
         };
         if (!module) {
             module = new Module(moduleOptions);
@@ -1316,11 +1380,19 @@ class FederationHost {
             });
             return moduleOrFactory;
         } catch (error) {
-            this.hooks.lifecycle.errorLoadRemote.emit({
+            const { from = 'runtime' } = options || {
+                from: 'runtime'
+            };
+            const failOver = await this.hooks.lifecycle.errorLoadRemote.emit({
                 id,
-                error
+                error,
+                from,
+                origin: this
             });
-            throw error;
+            if (!failOver) {
+                throw error;
+            }
+            return failOver;
         }
     }
     // eslint-disable-next-line @typescript-eslint/member-ordering
@@ -1354,14 +1426,9 @@ class FederationHost {
    * It accepts one argument, the name of the share scope.
    * If the share scope does not exist, it creates one.
    */ // eslint-disable-next-line @typescript-eslint/member-ordering
-    initializeSharing(shareScopeName = share.DEFAULT_SCOPE) {
-        const shareScopeLoading = share.Global.__FEDERATION__.__SHARE_SCOPE_LOADING__;
-        const shareScope = share.Global.__FEDERATION__.__SHARE__;
+    initializeSharing(shareScopeName = share.DEFAULT_SCOPE, strategy) {
+        const shareScope = this.shareScopeMap;
         const hostName = this.options.name;
-        // Executes only once
-        if (shareScopeLoading[shareScopeName]) {
-            return shareScopeLoading[shareScopeName];
-        }
         // Creates a new share scope if necessary
         if (!shareScope[shareScopeName]) {
             shareScope[shareScopeName] = {};
@@ -1369,21 +1436,27 @@ class FederationHost {
         // Executes all initialization snippets from all accessible modules
         const scope = shareScope[shareScopeName];
         const register = (name, shared)=>{
+            var _activeVersion_shareConfig;
             const { version, eager } = shared;
             scope[name] = scope[name] || {};
             const versions = scope[name];
             const activeVersion = versions[version];
-            const activeVersionEager = Boolean(activeVersion && (activeVersion.eager || activeVersion.shareConfig.eager));
+            const activeVersionEager = Boolean(activeVersion && (activeVersion.eager || ((_activeVersion_shareConfig = activeVersion.shareConfig) == null ? void 0 : _activeVersion_shareConfig.eager)));
             if (!activeVersion || !activeVersion.loaded && (Boolean(!eager) !== !activeVersionEager ? eager : hostName > activeVersion.from)) {
                 versions[version] = shared;
             }
         };
         const promises = [];
+        const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName]);
         const initRemoteModule = async (key)=>{
             const { module } = await this._getRemoteModuleAndOptions(key);
-            const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName]);
-            const entry = await module.getEntry();
-            initFn(entry);
+            if (module.getEntry) {
+                const entry = await module.getEntry();
+                if (!module.inited) {
+                    initFn(entry);
+                    module.inited = true;
+                }
+            }
         };
         Object.keys(this.options.shared).forEach((shareName)=>{
             const shared = this.options.shared[shareName];
@@ -1391,15 +1464,17 @@ class FederationHost {
                 register(shareName, shared);
             }
         });
-        this.options.remotes.forEach((remote)=>{
-            if (remote.shareScope === shareScopeName) {
-                promises.push(initRemoteModule(remote.name));
-            }
-        });
-        if (!promises.length) {
-            return shareScopeLoading[shareScopeName] = true;
+        if (strategy === 'version-first') {
+            this.options.remotes.forEach((remote)=>{
+                if (remote.shareScope === shareScopeName) {
+                    promises.push(initRemoteModule(remote.name));
+                }
+            });
         }
-        return shareScopeLoading[shareScopeName] = Promise.all(promises).then(()=>shareScopeLoading[shareScopeName] = true);
+        return promises;
+    }
+    initShareScopeMap(scopeName, shareScope) {
+        this.shareScopeMap[scopeName] = shareScope;
     }
     formatOptions(globalOptions, userOptions) {
         const formatShareOptions = share.formatShareConfigs(userOptions.shared || {}, userOptions.name);
@@ -1439,16 +1514,17 @@ class FederationHost {
             }
             return res;
         }, globalOptionsRes.remotes);
-        // register shared include lib
+        // register shared in shareScopeMap
         const sharedKeys = Object.keys(formatShareOptions);
         sharedKeys.forEach((sharedKey)=>{
             const sharedVal = formatShareOptions[sharedKey];
-            const globalShare = share.getGlobalShare(sharedKey, sharedVal);
-            if (!globalShare && sharedVal && sharedVal.lib) {
+            const registeredShared = share.getRegisteredShare(this.shareScopeMap, sharedKey, sharedVal, this.hooks.lifecycle.resolveShare);
+            if (!registeredShared && sharedVal && sharedVal.lib) {
                 this.setShared({
                     pkgName: sharedKey,
                     lib: sharedVal.lib,
                     get: sharedVal.get,
+                    loaded: true,
                     shared: sharedVal,
                     from: userOptions.name
                 });
@@ -1483,7 +1559,6 @@ class FederationHost {
         ]);
     }
     setShared({ pkgName, shared, from, lib, loading, loaded, get }) {
-        const target = share.getGlobalShareScope();
         const { version, scope = 'default' } = shared, shareInfo = _object_without_properties_loose(shared, [
             "version",
             "scope"
@@ -1492,23 +1567,23 @@ class FederationHost {
             scope
         ];
         scopes.forEach((sc)=>{
-            if (!target[sc]) {
-                target[sc] = {};
+            if (!this.shareScopeMap[sc]) {
+                this.shareScopeMap[sc] = {};
             }
-            if (!target[sc][pkgName]) {
-                target[sc][pkgName] = {};
+            if (!this.shareScopeMap[sc][pkgName]) {
+                this.shareScopeMap[sc][pkgName] = {};
             }
-            if (target[sc][pkgName][version]) {
+            if (this.shareScopeMap[sc][pkgName][version]) {
                 share.warn(// eslint-disable-next-line max-len
                 `The share \n ${share.safeToString({
                     scope: sc,
                     pkgName,
                     version,
-                    from: target[sc][pkgName][version].from
+                    from: this.shareScopeMap[sc][pkgName][version].from
                 })} has been registered`);
                 return;
             }
-            target[sc][pkgName][version] = _extends({
+            this.shareScopeMap[sc][pkgName][version] = _extends({
                 version,
                 scope: [
                     'default'
@@ -1519,7 +1594,7 @@ class FederationHost {
                 loading
             });
             if (get) {
-                target[sc][pkgName][version].get = get;
+                this.shareScopeMap[sc][pkgName][version].get = get;
             }
         });
     }
@@ -1534,11 +1609,13 @@ class FederationHost {
             errorLoadRemote: new AsyncHook('errorLoadRemote'),
             beforeLoadShare: new AsyncWaterfallHook('beforeLoadShare'),
             loadShare: new AsyncHook(),
+            resolveShare: new SyncWaterfallHook('resolveShare'),
             beforePreloadRemote: new AsyncHook(),
             generatePreloadAssets: new AsyncHook('generatePreloadAssets'),
             afterPreloadRemote: new AsyncHook()
         });
-        this.version = '0.0.4';
+        this.releaseNumber = `5`;
+        this.version = `0.0.5`;
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable
@@ -1546,7 +1623,6 @@ class FederationHost {
             createScript: new SyncHook(),
             fetch: new AsyncHook('fetch')
         });
-        this.loadingShare = {};
         // TODO: Validate the details of the options
         // Initialize options with default values
         const defaultOptions = {
@@ -1562,6 +1638,8 @@ class FederationHost {
         };
         this.name = userOptions.name;
         this.options = defaultOptions;
+        this.shareScopeMap = {};
+        this._setGlobalShareScopeMap();
         this.snapshotHandler = new SnapshotHandler(this);
         this.registerPlugins([
             ...defaultOptions.plugins,
@@ -1611,6 +1689,10 @@ function preloadRemote(...args) {
 share.setGlobalFederationConstructor(FederationHost);
 
 exports.registerGlobalPlugins = share.registerGlobalPlugins;
+Object.defineProperty(exports, 'loadScript', {
+  enumerable: true,
+  get: function () { return sdk.loadScript; }
+});
 exports.FederationHost = FederationHost;
 exports.init = init;
 exports.loadRemote = loadRemote;