@module-federation/runtime 0.5.1 → 0.5.2

package/dist/index.cjs.js

@@ -1300,7 +1300,9 @@ class SharedHandler {
         });
         if (shareInfo == null ? void 0 : shareInfo.scope) {
             await Promise.all(shareInfo.scope.map(async (shareScope)=>{
-                await Promise.all(this.initializeSharing(shareScope, shareInfo.strategy));
+                await Promise.all(this.initializeSharing(shareScope, {
+                    strategy: shareInfo.strategy
+                }));
                 return;
             }));
         }
@@ -1388,8 +1390,22 @@ class SharedHandler {
    * 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, strategy) {
+    initializeSharing(shareScopeName = share.DEFAULT_SCOPE, extraOptions) {
         const { host } = this;
+        const from = extraOptions == null ? void 0 : extraOptions.from;
+        const strategy = extraOptions == null ? void 0 : extraOptions.strategy;
+        let initScope = extraOptions == null ? void 0 : extraOptions.initScope;
+        const promises = [];
+        if (from !== 'build') {
+            const { initTokens } = this;
+            if (!initScope) initScope = [];
+            let initToken = initTokens[shareScopeName];
+            if (!initToken) initToken = initTokens[shareScopeName] = {
+                from: this.host.name
+            };
+            if (initScope.indexOf(initToken) >= 0) return promises;
+            initScope.push(initToken);
+        }
         const shareScope = this.shareScopeMap;
         const hostName = host.options.name;
         // Creates a new share scope if necessary
@@ -1409,8 +1425,7 @@ class SharedHandler {
                 versions[version] = shared;
             }
         };
-        const promises = [];
-        const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName]);
+        const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName], initScope);
         const initRemoteModule = async (key)=>{
             const { module } = await host.remoteHandler.getRemoteModuleAndOptions({
                 id: key
@@ -1418,7 +1433,7 @@ class SharedHandler {
             if (module.getEntry) {
                 const entry = await module.getEntry();
                 if (!module.inited) {
-                    initFn(entry);
+                    await initFn(entry);
                     module.inited = true;
                 }
             }
@@ -1431,7 +1446,8 @@ class SharedHandler {
                 }
             });
         });
-        if (strategy === 'version-first') {
+        // TODO: strategy==='version-first' need to be removed in the future
+        if (host.options.shareStrategy === 'version-first' || strategy === 'version-first') {
             host.options.remotes.forEach((remote)=>{
                 if (remote.shareScope === shareScopeName) {
                     promises.push(initRemoteModule(remote.name));
@@ -1453,7 +1469,9 @@ class SharedHandler {
         });
         if (shareInfo == null ? void 0 : shareInfo.scope) {
             shareInfo.scope.forEach((shareScope)=>{
-                this.initializeSharing(shareScope, shareInfo.strategy);
+                this.initializeSharing(shareScope, {
+                    strategy: shareInfo.strategy
+                });
             });
         }
         const registeredShared = share.getRegisteredShare(this.shareScopeMap, pkgName, shareInfo, this.hooks.lifecycle.resolveShare);
@@ -1585,6 +1603,7 @@ class SharedHandler {
         });
         this.host = host;
         this.shareScopeMap = {};
+        this.initTokens = {};
         this._setGlobalShareScopeMap(host.options);
     }
 }
@@ -1989,8 +2008,8 @@ class FederationHost {
     loadShareSync(pkgName, extraOptions) {
         return this.sharedHandler.loadShareSync(pkgName, extraOptions);
     }
-    initializeSharing(shareScopeName = share.DEFAULT_SCOPE, strategy) {
-        return this.sharedHandler.initializeSharing(shareScopeName, strategy);
+    initializeSharing(shareScopeName = share.DEFAULT_SCOPE, extraOptions) {
+        return this.sharedHandler.initializeSharing(shareScopeName, extraOptions);
     }
     initRawContainer(name, url, container) {
         const remoteInfo = getRemoteInfo({
@@ -2077,7 +2096,7 @@ class FederationHost {
             // maybe will change, temporarily for internal use only
             initContainer: new AsyncWaterfallHook('initContainer')
         });
-        this.version = "0.5.1";
+        this.version = "0.5.2";
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable , not open to the public yet

package/dist/index.esm.js

@@ -1298,7 +1298,9 @@ class SharedHandler {
         });
         if (shareInfo == null ? void 0 : shareInfo.scope) {
             await Promise.all(shareInfo.scope.map(async (shareScope)=>{
-                await Promise.all(this.initializeSharing(shareScope, shareInfo.strategy));
+                await Promise.all(this.initializeSharing(shareScope, {
+                    strategy: shareInfo.strategy
+                }));
                 return;
             }));
         }
@@ -1386,8 +1388,22 @@ class SharedHandler {
    * 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, strategy) {
+    initializeSharing(shareScopeName = DEFAULT_SCOPE, extraOptions) {
         const { host } = this;
+        const from = extraOptions == null ? void 0 : extraOptions.from;
+        const strategy = extraOptions == null ? void 0 : extraOptions.strategy;
+        let initScope = extraOptions == null ? void 0 : extraOptions.initScope;
+        const promises = [];
+        if (from !== 'build') {
+            const { initTokens } = this;
+            if (!initScope) initScope = [];
+            let initToken = initTokens[shareScopeName];
+            if (!initToken) initToken = initTokens[shareScopeName] = {
+                from: this.host.name
+            };
+            if (initScope.indexOf(initToken) >= 0) return promises;
+            initScope.push(initToken);
+        }
         const shareScope = this.shareScopeMap;
         const hostName = host.options.name;
         // Creates a new share scope if necessary
@@ -1407,8 +1423,7 @@ class SharedHandler {
                 versions[version] = shared;
             }
         };
-        const promises = [];
-        const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName]);
+        const initFn = (mod)=>mod && mod.init && mod.init(shareScope[shareScopeName], initScope);
         const initRemoteModule = async (key)=>{
             const { module } = await host.remoteHandler.getRemoteModuleAndOptions({
                 id: key
@@ -1416,7 +1431,7 @@ class SharedHandler {
             if (module.getEntry) {
                 const entry = await module.getEntry();
                 if (!module.inited) {
-                    initFn(entry);
+                    await initFn(entry);
                     module.inited = true;
                 }
             }
@@ -1429,7 +1444,8 @@ class SharedHandler {
                 }
             });
         });
-        if (strategy === 'version-first') {
+        // TODO: strategy==='version-first' need to be removed in the future
+        if (host.options.shareStrategy === 'version-first' || strategy === 'version-first') {
             host.options.remotes.forEach((remote)=>{
                 if (remote.shareScope === shareScopeName) {
                     promises.push(initRemoteModule(remote.name));
@@ -1451,7 +1467,9 @@ class SharedHandler {
         });
         if (shareInfo == null ? void 0 : shareInfo.scope) {
             shareInfo.scope.forEach((shareScope)=>{
-                this.initializeSharing(shareScope, shareInfo.strategy);
+                this.initializeSharing(shareScope, {
+                    strategy: shareInfo.strategy
+                });
             });
         }
         const registeredShared = getRegisteredShare(this.shareScopeMap, pkgName, shareInfo, this.hooks.lifecycle.resolveShare);
@@ -1583,6 +1601,7 @@ class SharedHandler {
         });
         this.host = host;
         this.shareScopeMap = {};
+        this.initTokens = {};
         this._setGlobalShareScopeMap(host.options);
     }
 }
@@ -1987,8 +2006,8 @@ class FederationHost {
     loadShareSync(pkgName, extraOptions) {
         return this.sharedHandler.loadShareSync(pkgName, extraOptions);
     }
-    initializeSharing(shareScopeName = DEFAULT_SCOPE, strategy) {
-        return this.sharedHandler.initializeSharing(shareScopeName, strategy);
+    initializeSharing(shareScopeName = DEFAULT_SCOPE, extraOptions) {
+        return this.sharedHandler.initializeSharing(shareScopeName, extraOptions);
     }
     initRawContainer(name, url, container) {
         const remoteInfo = getRemoteInfo({
@@ -2075,7 +2094,7 @@ class FederationHost {
             // maybe will change, temporarily for internal use only
             initContainer: new AsyncWaterfallHook('initContainer')
         });
-        this.version = "0.5.1";
+        this.version = "0.5.2";
         this.moduleCache = new Map();
         this.loaderHook = new PluginSystem({
             // FIXME: may not be suitable , not open to the public yet

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "author": "zhouxiao <codingzx@gmail.com>",
   "main": "./index.cjs.js",
   "module": "./index.esm.js",

package/dist/share.cjs.js

@@ -212,7 +212,7 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor, isDebug = isDebugMode()) {
     if (isDebug) {
         globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.5.1";
+        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.5.2";
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -685,7 +685,7 @@ function _extends() {
     };
     return _extends.apply(this, arguments);
 }
-function formatShare(shareArgs, from, name) {
+function formatShare(shareArgs, from, name, shareStrategy) {
     let get;
     if ('get' in shareArgs) {
         // eslint-disable-next-line prefer-destructuring
@@ -697,7 +697,10 @@ function formatShare(shareArgs, from, name) {
                 throw new Error(`Can not get shared '${name}'!`);
             });
     }
-    var _shareArgs_version, _shareArgs_scope;
+    if (shareArgs.strategy) {
+        warn(`"shared.strategy is deprecated, please set in initOptions.shareStrategy instead!"`);
+    }
+    var _shareArgs_version, _shareArgs_scope, _shareArgs_strategy;
     return _extends({
         deps: [],
         useIn: [],
@@ -716,7 +719,7 @@ function formatShare(shareArgs, from, name) {
         scope: Array.isArray(shareArgs.scope) ? shareArgs.scope : [
             (_shareArgs_scope = shareArgs.scope) != null ? _shareArgs_scope : 'default'
         ],
-        strategy: shareArgs.strategy || 'version-first'
+        strategy: ((_shareArgs_strategy = shareArgs.strategy) != null ? _shareArgs_strategy : shareStrategy) || 'version-first'
     });
 }
 function formatShareConfigs(globalOptions, userOptions) {
@@ -726,7 +729,7 @@ function formatShareConfigs(globalOptions, userOptions) {
         const arrayShareArgs = arrayOptions(shareArgs[pkgName]);
         res[pkgName] = res[pkgName] || [];
         arrayShareArgs.forEach((shareConfig)=>{
-            res[pkgName].push(formatShare(shareConfig, from, pkgName));
+            res[pkgName].push(formatShare(shareConfig, from, pkgName, userOptions.shareStrategy));
         });
         return res;
     }, {});

package/dist/share.esm.js

@@ -210,7 +210,7 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor, isDebug = isDebugMode()) {
     if (isDebug) {
         globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.5.1";
+        globalThis.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = "0.5.2";
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types
@@ -683,7 +683,7 @@ function _extends() {
     };
     return _extends.apply(this, arguments);
 }
-function formatShare(shareArgs, from, name) {
+function formatShare(shareArgs, from, name, shareStrategy) {
     let get;
     if ('get' in shareArgs) {
         // eslint-disable-next-line prefer-destructuring
@@ -695,7 +695,10 @@ function formatShare(shareArgs, from, name) {
                 throw new Error(`Can not get shared '${name}'!`);
             });
     }
-    var _shareArgs_version, _shareArgs_scope;
+    if (shareArgs.strategy) {
+        warn(`"shared.strategy is deprecated, please set in initOptions.shareStrategy instead!"`);
+    }
+    var _shareArgs_version, _shareArgs_scope, _shareArgs_strategy;
     return _extends({
         deps: [],
         useIn: [],
@@ -714,7 +717,7 @@ function formatShare(shareArgs, from, name) {
         scope: Array.isArray(shareArgs.scope) ? shareArgs.scope : [
             (_shareArgs_scope = shareArgs.scope) != null ? _shareArgs_scope : 'default'
         ],
-        strategy: shareArgs.strategy || 'version-first'
+        strategy: ((_shareArgs_strategy = shareArgs.strategy) != null ? _shareArgs_strategy : shareStrategy) || 'version-first'
     });
 }
 function formatShareConfigs(globalOptions, userOptions) {
@@ -724,7 +727,7 @@ function formatShareConfigs(globalOptions, userOptions) {
         const arrayShareArgs = arrayOptions(shareArgs[pkgName]);
         res[pkgName] = res[pkgName] || [];
         arrayShareArgs.forEach((shareConfig)=>{
-            res[pkgName].push(formatShare(shareConfig, from, pkgName));
+            res[pkgName].push(formatShare(shareConfig, from, pkgName, userOptions.shareStrategy));
         });
         return res;
     }, {});

package/dist/src/core.d.ts

@@ -1,5 +1,5 @@
 import type { CreateScriptHookReturn } from '@module-federation/sdk';
-import { Options, PreloadRemoteArgs, RemoteEntryExports, Remote, Shared, ShareInfos, UserOptions, RemoteInfo, ShareScopeMap, InitScope, RemoteEntryInitOptions } from './type';
+import { Options, PreloadRemoteArgs, RemoteEntryExports, Remote, Shared, ShareInfos, UserOptions, RemoteInfo, ShareScopeMap, InitScope, RemoteEntryInitOptions, CallFrom } from './type';
 import { Module } from './module';
 import { AsyncHook, AsyncWaterfallHook, PluginSystem, SyncHook, SyncWaterfallHook } from './utils/hooks';
 import { SnapshotHandler } from './plugins/snapshot/SnapshotHandler';
@@ -69,11 +69,15 @@ export declare class FederationHost {
         customShareInfo?: Partial<Shared>;
         resolver?: (sharedOptions: ShareInfos[string]) => Shared;
     }): () => T | never;
-    initializeSharing(shareScopeName?: string, strategy?: Shared['strategy']): Array<Promise<void>>;
+    initializeSharing(shareScopeName?: string, extraOptions?: {
+        initScope?: InitScope;
+        from?: CallFrom;
+        strategy?: Shared['strategy'];
+    }): Array<Promise<void>>;
     initRawContainer(name: string, url: string, container: RemoteEntryExports): Module;
     loadRemote<T>(id: string, options?: {
         loadFactory?: boolean;
-        from: 'build' | 'runtime';
+        from: CallFrom;
     }): Promise<T | null>;
     preloadRemote(preloadOptions: Array<PreloadRemoteArgs>): Promise<void>;
     initShareScopeMap(scopeName: string, shareScope: ShareScopeMap[string], extraOptions?: {

package/dist/src/remote/index.d.ts

@@ -1,5 +1,5 @@
 import type { ModuleInfo, GlobalModuleInfo } from '@module-federation/sdk';
-import { Options, UserOptions, PreloadAssets, PreloadOptions, PreloadRemoteArgs, Remote, RemoteInfo, RemoteEntryExports } from '../type';
+import { Options, UserOptions, PreloadAssets, PreloadOptions, PreloadRemoteArgs, Remote, RemoteInfo, RemoteEntryExports, CallFrom } from '../type';
 import { FederationHost } from '../core';
 import { PluginSystem, AsyncHook, AsyncWaterfallHook, SyncHook, SyncWaterfallHook } from '../utils/hooks';
 import { Module, ModuleOptions } from '../module';
@@ -56,7 +56,7 @@ export declare class RemoteHandler {
             id: string;
             error: unknown;
             options?: any;
-            from: "build" | "runtime";
+            from: CallFrom;
             lifecycle: "onLoad" | "beforeRequest";
             origin: FederationHost;
         }], unknown>;
@@ -89,7 +89,7 @@ export declare class RemoteHandler {
     setIdToRemoteMap(id: string, remoteMatchInfo: LoadRemoteMatch): void;
     loadRemote<T>(id: string, options?: {
         loadFactory?: boolean;
-        from: 'build' | 'runtime';
+        from: CallFrom;
     }): Promise<T | null>;
     preloadRemote(preloadOptions: Array<PreloadRemoteArgs>): Promise<void>;
     registerRemotes(remotes: Remote[], options?: {

package/dist/src/shared/index.d.ts

@@ -1,5 +1,5 @@
 import { Federation } from '../global';
-import { Options, ShareScopeMap, ShareInfos, Shared, UserOptions } from '../type';
+import { Options, ShareScopeMap, ShareInfos, Shared, UserOptions, ShareStrategy, InitScope, InitTokens, CallFrom } from '../type';
 import { FederationHost } from '../core';
 import { PluginSystem, AsyncHook, AsyncWaterfallHook, SyncWaterfallHook } from '../utils/hooks';
 import { LoadRemoteMatch } from '../remote';
@@ -31,6 +31,7 @@ export declare class SharedHandler {
             hostShareScopeMap?: ShareScopeMap;
         }>;
     }>;
+    initTokens: InitTokens;
     constructor(host: FederationHost);
     registerShared(globalOptions: Options, userOptions: UserOptions): {
         shareInfos: ShareInfos;
@@ -47,7 +48,11 @@ export declare class SharedHandler {
      * It accepts one argument, the name of the share scope.
      * If the share scope does not exist, it creates one.
      */
-    initializeSharing(shareScopeName?: string, strategy?: Shared['strategy']): Array<Promise<void>>;
+    initializeSharing(shareScopeName?: string, extraOptions?: {
+        initScope?: InitScope;
+        from?: CallFrom;
+        strategy?: ShareStrategy;
+    }): Array<Promise<void>>;
     loadShareSync<T>(pkgName: string, extraOptions?: {
         customShareInfo?: Partial<Shared>;
         resolver?: (sharedOptions: ShareInfos[string]) => Shared;

package/dist/src/type/config.d.ts

@@ -49,6 +49,7 @@ export type ShareArgs = (SharedBaseArgs & {
 }) | (SharedBaseArgs & {
     lib: () => Module;
 }) | SharedBaseArgs;
+export type ShareStrategy = 'version-first' | 'loaded-first';
 export type Shared = {
     version: string;
     get: SharedGetter;
@@ -61,7 +62,10 @@ export type Shared = {
     loaded?: boolean;
     loading?: null | Promise<any>;
     eager?: boolean;
-    strategy: 'version-first' | 'loaded-first';
+    /**
+     * @deprecated set in initOptions.shareStrategy instead
+     */
+    strategy: ShareStrategy;
 };
 export type ShareScopeMap = {
     [scope: string]: {
@@ -84,6 +88,7 @@ export interface Options {
     shared: ShareInfos;
     plugins: Array<FederationRuntimePlugin>;
     inBrowser: boolean;
+    shareStrategy?: ShareStrategy;
 }
 export type UserOptions = Omit<Optional<Options, 'plugins'>, 'shared' | 'inBrowser'> & {
     shared?: {
@@ -97,7 +102,9 @@ export type RemoteEntryInitOptions = {
     version: string;
     shareScopeMap: ShareScopeMap;
 };
-export type InitScope = Array<Record<string, never>>;
+export type InitTokens = Record<string, Record<string, any>>;
+export type InitScope = InitTokens[];
+export type CallFrom = 'build' | 'runtime';
 export type RemoteEntryExports = {
     get: (id: string) => () => Promise<Module>;
     init: (shareScope: ShareScopeMap[string], initScope?: InitScope, remoteEntryInitOPtions?: RemoteEntryInitOptions) => void | Promise<void>;

package/dist/src/utils/share.d.ts

@@ -1,7 +1,7 @@
 import { Federation } from '../global';
-import { GlobalShareScopeMap, Shared, ShareArgs, ShareInfos, ShareScopeMap, LoadShareExtraOptions, UserOptions, Options } from '../type';
+import { GlobalShareScopeMap, Shared, ShareArgs, ShareInfos, ShareScopeMap, LoadShareExtraOptions, UserOptions, Options, ShareStrategy } from '../type';
 import { SyncWaterfallHook } from './hooks';
-export declare function formatShare(shareArgs: ShareArgs, from: string, name: string): Shared;
+export declare function formatShare(shareArgs: ShareArgs, from: string, name: string, shareStrategy?: ShareStrategy): Shared;
 export declare function formatShareConfigs(globalOptions: Options, userOptions: UserOptions): {
     shared: {
         [x: string]: Shared[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/runtime",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "author": "zhouxiao <codingzx@gmail.com>",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -53,6 +53,6 @@
     }
   },
   "dependencies": {
-    "@module-federation/sdk": "0.5.1"
+    "@module-federation/sdk": "0.5.2"
   }
 }