@module-federation/runtime 0.0.7 → 0.0.8

package/dist/index.esm.js

@@ -1,6 +1,7 @@
-import { g as getGlobalHostPlugins, D as DEFAULT_REMOTE_TYPE, a as DEFAULT_SCOPE, b as globalLoading, c as getRemoteEntryExports, d as assert, s as safeToString, G as Global, e as getFMId, i as isObject, f as error, w as warn, h as isPlainObject, j as isRemoteInfoWithEntry, k as isPureRemoteEntry, l as getGlobalShare, m as getInfoWithoutType, n as getPreloaded, o as setPreloaded, p as getGlobalSnapshotInfoByModuleInfo, q as setGlobalSnapshotInfoByModuleInfo, r as getGlobalSnapshot, t as addUniqueItem, u as formatShareConfigs, v as isBrowserEnv, x as getGlobalShareScope, y as getBuilderId, z as setGlobalFederationConstructor, A as getGlobalFederationInstance, B as getGlobalFederationConstructor, C as setGlobalFederationInstance } from './share.esm.js';
+import { g as getGlobalHostPlugins, D as DEFAULT_REMOTE_TYPE, a as DEFAULT_SCOPE, b as globalLoading, c as getRemoteEntryExports, d as assert, s as safeToString, e as getFMId, i as isObject, f as error, w as warn, h as isPlainObject, j as isRemoteInfoWithEntry, k as isPureRemoteEntry, l as getRegisteredShare, m as getInfoWithoutType, n as getPreloaded, o as setPreloaded, p as getGlobalSnapshotInfoByModuleInfo, q as setGlobalSnapshotInfoByModuleInfo, r as getGlobalSnapshot, G as Global, t as getGlobalShareScope, u as formatShareConfigs, v as isBrowserEnv, x as getBuilderId, y as addUniqueItem, z as setGlobalFederationConstructor, A as getGlobalFederationInstance, B as getGlobalFederationConstructor, C as setGlobalFederationInstance } from './share.esm.js';
 export { E as registerGlobalPlugins } from './share.esm.js';
-import { composeKeyWithSeparator, loadScript, createScript, getResourceUrl, isManifestProvider, generateSnapshotFromManifest } from '@module-federation/sdk';
+import { composeKeyWithSeparator, loadScriptNode, loadScript, createScript, getResourceUrl, isManifestProvider, generateSnapshotFromManifest } from '@module-federation/sdk';
+export { loadScript } from '@module-federation/sdk';
 
 // Function to match a remote with its name and expose
 // id: pkgName(@federation/app1) + expose(button) = @federation/app1/button
@@ -118,6 +119,27 @@ async function loadEntryScript({ name, globalName, entry, createScriptHook }) {
     if (remoteEntryExports) {
         return remoteEntryExports;
     }
+    if (typeof document === 'undefined') {
+        return loadScriptNode(entry, {
+            attrs: {
+                name,
+                globalName
+            },
+            createScriptHook
+        }).then(()=>{
+            const { remoteEntryKey, entryExports } = getRemoteEntryExports(name, globalName);
+            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 loadScript(entry, {
         attrs: {},
         createScriptHook
@@ -130,6 +152,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 }) {
@@ -191,6 +215,10 @@ let Module = class Module {
                 const res = this.host.loaderHook.lifecycle.createScript.emit({
                     url
                 });
+                if (typeof document === 'undefined') {
+                    //todo: needs real fix
+                    return res;
+                }
                 if (res instanceof HTMLScriptElement) {
                     return res;
                 }
@@ -209,18 +237,25 @@ let Module = class Module {
         // Get remoteEntry.js
         const remoteEntryExports = await this.getEntry();
         if (!this.inited) {
-            const globalShareScope = Global.__FEDERATION__.__SHARE__;
+            const localShareScopeMap = this.host.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];
             const initScope = [];
             const remoteEntryInitOptions = {
                 version: this.remoteInfo.version || ''
             };
+            // Help to find host instance
+            Object.defineProperty(remoteEntryInitOptions, 'hostId', {
+                value: this.host.options.id || this.host.name,
+                // remoteEntryInitOptions will be traversed and assigned during container init, ,so this attribute is not allowed to be traversed
+                enumerable: false
+            });
             const initContainerOptions = await this.host.hooks.lifecycle.beforeInitContainer.emit({
                 shareScope,
+                // @ts-ignore hostId will be set by Object.defineProperty
                 remoteEntryInitOptions,
                 initScope,
                 remoteInfo: this.remoteInfo,
@@ -773,9 +808,9 @@ function generatePreloadAssets(origin, preloadOptions, remote, globalSnapshot, r
             if (!shareInfo) {
                 return;
             }
-            const globalShare = getGlobalShare(shared.sharedName, shareInfo);
+            const registeredShared = 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);
                 });
@@ -1102,13 +1137,19 @@ function _object_without_properties_loose(source, excluded) {
     return target;
 }
 class FederationHost {
+    _setGlobalShareScopeMap() {
+        const globalShareScopeMap = 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);
         this.options = options;
         return options;
     }
-    // overrideSharedOptions(shareScope: GlobalShareScope[string]): void {}
     async loadShare(pkgName, customShareInfo) {
         var _this_options_shared;
         // This function performs the following steps:
@@ -1116,6 +1157,12 @@ 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) {
+            await Promise.all(shareInfo.scope.map(async (shareScope)=>{
+                await Promise.all(this.initializeSharing(shareScope, shareInfo.strategy));
+                return;
+            }));
+        }
         const loadShareRes = await this.hooks.lifecycle.beforeLoadShare.emit({
             pkgName,
             shareInfo,
@@ -1126,30 +1173,42 @@ class FederationHost {
         // Assert that shareInfoRes exists, if not, throw an error
         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 = getGlobalShare(pkgName, shareInfoRes);
-        if (globalShare && globalShare.lib) {
-            addUniqueItem(globalShare.useIn, this.options.name);
-            return globalShare.lib;
-        } else if (globalShare && globalShare.loading) {
-            const factory = await globalShare.loading;
-            addUniqueItem(globalShare.useIn, this.options.name);
+        const registeredShared = getRegisteredShare(this.shareScopeMap, pkgName, shareInfoRes, this.hooks.lifecycle.resolveShare);
+        const addUseIn = (shared)=>{
+            if (!shared.useIn) {
+                shared.useIn = [];
+            }
+            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;
-                addUniqueItem(shareInfoRes.useIn, this.options.name);
-                const gShared = getGlobalShare(pkgName, shareInfoRes);
+                shareInfoRes.loaded = true;
+                addUseIn(shareInfoRes);
+                const gShared = 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
@@ -1162,17 +1221,19 @@ class FederationHost {
             const asyncLoadProcess = async ()=>{
                 const factory = await shareInfoRes.get();
                 shareInfoRes.lib = factory;
-                addUniqueItem(shareInfoRes.useIn, this.options.name);
-                const gShared = getGlobalShare(pkgName, shareInfoRes);
+                shareInfoRes.loaded = true;
+                addUseIn(shareInfoRes);
+                const gShared = 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,
@@ -1185,19 +1246,46 @@ class FederationHost {
     // 1. If the loaded shared already exists globally, then it will be reused
     // 2. If lib exists in local shared, it will be used directly
     // 3. If the local get returns something other than Promise, then it will be used directly
-    loadShareSync(pkgName) {
+    loadShareSync(pkgName, customShareInfo) {
         var _this_options_shared;
-        const shareInfo = (_this_options_shared = this.options.shared) == null ? void 0 : _this_options_shared[pkgName];
-        const globalShare = getGlobalShare(pkgName, shareInfo);
-        if (globalShare && typeof globalShare.lib === 'function') {
-            addUniqueItem(globalShare.useIn, this.options.name);
-            if (!globalShare.loaded) {
-                globalShare.loaded = true;
-                if (globalShare.from === this.options.name) {
-                    shareInfo.loaded = true;
+        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 registeredShared = getRegisteredShare(this.shareScopeMap, pkgName, shareInfo, this.hooks.lifecycle.resolveShare);
+        const addUseIn = (shared)=>{
+            if (!shared.useIn) {
+                shared.useIn = [];
+            }
+            addUniqueItem(shared.useIn, this.options.name);
+        };
+        if (registeredShared) {
+            if (typeof registeredShared.lib === 'function') {
+                addUseIn(registeredShared);
+                if (!registeredShared.loaded) {
+                    registeredShared.loaded = true;
+                    if (registeredShared.from === this.options.name) {
+                        shareInfo.loaded = true;
+                    }
+                }
+                return registeredShared.lib;
+            }
+            if (typeof registeredShared.get === 'function') {
+                const module = registeredShared.get();
+                if (!(module instanceof Promise)) {
+                    addUseIn(registeredShared);
+                    this.setShared({
+                        pkgName,
+                        loaded: true,
+                        from: this.options.name,
+                        lib: module,
+                        shared: registeredShared
+                    });
+                    return module;
                 }
             }
-            return globalShare.lib;
         }
         if (shareInfo.lib) {
             if (!shareInfo.loaded) {
@@ -1304,11 +1392,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
@@ -1342,14 +1438,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 = DEFAULT_SCOPE) {
-        const shareScopeLoading = Global.__FEDERATION__.__SHARE_SCOPE_LOADING__;
-        const shareScope = Global.__FEDERATION__.__SHARE__;
+    initializeSharing(shareScopeName = 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] = {};
@@ -1357,21 +1448,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];
@@ -1379,15 +1476,22 @@ 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;
+        this.hooks.lifecycle.initContainerShareScopeMap.emit({
+            shareScope,
+            options: this.options,
+            origin: this
+        });
     }
     formatOptions(globalOptions, userOptions) {
         const formatShareOptions = formatShareConfigs(userOptions.shared || {}, userOptions.name);
@@ -1420,23 +1524,23 @@ class FederationHost {
                     remote.shareScope = DEFAULT_SCOPE;
                 }
                 if (!remote.type) {
-                    // FIXME: The build plugin needs to support this field
                     remote.type = DEFAULT_REMOTE_TYPE;
                 }
                 res.push(remote);
             }
             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 = getGlobalShare(sharedKey, sharedVal);
-            if (!globalShare && sharedVal && sharedVal.lib) {
+            const registeredShared = 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
                 });
@@ -1471,7 +1575,6 @@ class FederationHost {
         ]);
     }
     setShared({ pkgName, shared, from, lib, loading, loaded, get }) {
-        const target = getGlobalShareScope();
         const { version, scope = 'default' } = shared, shareInfo = _object_without_properties_loose(shared, [
             "version",
             "scope"
@@ -1480,23 +1583,16 @@ 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]) {
-                warn(// eslint-disable-next-line max-len
-                `The share \n ${safeToString({
-                    scope: sc,
-                    pkgName,
-                    version,
-                    from: target[sc][pkgName][version].from
-                })} has been registered`);
+            if (this.shareScopeMap[sc][pkgName][version]) {
                 return;
             }
-            target[sc][pkgName][version] = _extends({
+            this.shareScopeMap[sc][pkgName][version] = _extends({
                 version,
                 scope: [
                     'default'
@@ -1507,7 +1603,7 @@ class FederationHost {
                 loading
             });
             if (get) {
-                target[sc][pkgName][version].get = get;
+                this.shareScopeMap[sc][pkgName][version].get = get;
             }
         });
     }
@@ -1517,26 +1613,33 @@ class FederationHost {
             init: new SyncHook(),
             beforeRequest: new AsyncWaterfallHook('beforeRequest'),
             afterResolve: new AsyncWaterfallHook('afterResolve'),
+            // maybe will change, temporarily for internal use only
             beforeInitContainer: new AsyncWaterfallHook('beforeInitContainer'),
+            // maybe will change, temporarily for internal use only
+            initContainerShareScopeMap: new AsyncWaterfallHook('initContainer'),
+            // maybe will change, temporarily for internal use only
             initContainer: new AsyncWaterfallHook('initContainer'),
             onLoad: new AsyncHook('onLoad'),
             handlePreloadModule: new SyncHook('handlePreloadModule'),
             errorLoadRemote: new AsyncHook('errorLoadRemote'),
             beforeLoadShare: new AsyncWaterfallHook('beforeLoadShare'),
+            // not used yet
             loadShare: new AsyncHook(),
+            resolveShare: new SyncWaterfallHook('resolveShare'),
             beforePreloadRemote: new AsyncHook(),
             generatePreloadAssets: new AsyncHook('generatePreloadAssets'),
+            // not used yet
             afterPreloadRemote: new AsyncHook()
         });
-        this.version = '0.0.7';
+        this.version = "0.0.8";
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
-            // FIXME: may not be suitable
+            // FIXME: may not be suitable , not open to the public yet
             getModuleInfo: new SyncHook(),
             createScript: new SyncHook(),
+            // only work for manifest , so not open to the public yet
             fetch: new AsyncHook('fetch')
         });
-        this.loadingShare = {};
         // TODO: Validate the details of the options
         // Initialize options with default values
         const defaultOptions = {
@@ -1552,6 +1655,8 @@ class FederationHost {
         };
         this.name = userOptions.name;
         this.options = defaultOptions;
+        this.shareScopeMap = {};
+        this._setGlobalShareScopeMap();
         this.snapshotHandler = new SnapshotHandler(this);
         this.registerPlugins([
             ...defaultOptions.plugins,
@@ -1574,6 +1679,9 @@ function init(options) {
     } else {
         // Merge options
         instance.initOptions(options);
+        if (!FederationInstance) {
+            FederationInstance = instance;
+        }
         return instance;
     }
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "author": "zhouxiao <codingzx@gmail.com>",
   "main": "./index.cjs.js",
   "module": "./index.esm.js",
@@ -39,8 +39,8 @@
       "helpers": [
         "./dist/helpers.cjs.d.ts"
       ],
-      "type": [
-        "./dist/type.cjs.d.ts"
+      "types": [
+        "./dist/types.cjs.d.ts"
       ]
     }
   },