root
/
webpack
mirror of https://github.com/webpack/webpack.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix: consumption of eager shared modules for module federation

This commit is contained in:
Alexander Akait 2024-06-21 17:22:29 +03:00 committed by GitHub
parent e38e2bc31b f36ae6c702
commit dd44b206a9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 374 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
lib/sharing/ConsumeSharedModule.js
View File

@ -207,26 +207,31 @@ class ConsumeSharedModule extends Module {
}); });
} }
} }
let fn = "load";
const args = [JSON.stringify(shareScope), JSON.stringify(shareKey)]; const args = [
JSON.stringify(shareScope),
JSON.stringify(shareKey),
JSON.stringify(eager)
];
if (requiredVersion) { if (requiredVersion) {
if (strictVersion) {
fn += "Strict";
}
if (singleton) {
fn += "Singleton";
}
args.push(stringifyHoley(requiredVersion)); args.push(stringifyHoley(requiredVersion));
fn += "VersionCheck";
} else {
if (singleton) {
fn += "Singleton";
}
} }
if (fallbackCode) { if (fallbackCode) {
fn += "Fallback";
args.push(fallbackCode); args.push(fallbackCode);
} }
let fn;
if (requiredVersion) {
if (strictVersion) {
fn = singleton ? "loadStrictSingletonVersion" : "loadStrictVersion";
} else {
fn = singleton ? "loadSingletonVersion" : "loadVersion";
}
} else {
fn = singleton ? "loadSingleton" : "load";
}
const code = runtimeTemplate.returningFunction(`${fn}(${args.join(", ")})`); const code = runtimeTemplate.returningFunction(`${fn}(${args.join(", ")})`);
const sources = new Map(); const sources = new Map();
sources.set("consume-shared", new RawSource(code)); sources.set("consume-shared", new RawSource(code));

241
lib/sharing/ConsumeSharedRuntimeModule.js
View File

@ -95,63 +95,39 @@ class ConsumeSharedRuntimeModule extends RuntimeModule {
versionLtRuntimeCode(runtimeTemplate), versionLtRuntimeCode(runtimeTemplate),
rangeToStringRuntimeCode(runtimeTemplate), rangeToStringRuntimeCode(runtimeTemplate),
satisfyRuntimeCode(runtimeTemplate), satisfyRuntimeCode(runtimeTemplate),
`var ensureExistence = ${runtimeTemplate.basicFunction("scopeName, key", [ `var exists = ${runtimeTemplate.basicFunction("scope, key", [
`var scope = ${RuntimeGlobals.shareScopeMap}[scopeName];`, `return scope && ${RuntimeGlobals.hasOwnProperty}(scope, key);`
`if(!scope || !${RuntimeGlobals.hasOwnProperty}(scope, key)) throw new Error("Shared module " + key + " doesn't exist in shared scope " + scopeName);`, ])}`,
"return scope;" `var get = ${runtimeTemplate.basicFunction("entry", [
"entry.loaded = 1;",
"return entry.get()"
])};`, ])};`,
`var findVersion = ${runtimeTemplate.basicFunction("scope, key", [ `var eagerOnly = ${runtimeTemplate.basicFunction("versions", [
"var versions = scope[key];", `return Object.keys(versions).reduce(${runtimeTemplate.basicFunction(
`var key = Object.keys(versions).reduce(${runtimeTemplate.basicFunction( "filtered, version",
"a, b", Template.indent([
["return !a || versionLt(a, b) ? b : a;"] "if (versions[version].eager) {",
)}, 0);`, Template.indent(["filtered[version] = versions[version];"]),
"return key && versions[key]" "}",
"return filtered;"
])
)}, {});`
])};`, ])};`,
`var findSingletonVersionKey = ${runtimeTemplate.basicFunction( `var findLatestVersion = ${runtimeTemplate.basicFunction(
"scope, key", "scope, key, eager",
[ [
"var versions = scope[key];", "var versions = eager ? eagerOnly(scope[key]) : scope[key];",
`return Object.keys(versions).reduce(${runtimeTemplate.basicFunction( `var key = Object.keys(versions).reduce(${runtimeTemplate.basicFunction(
"a, b", "a, b",
["return !a || (!versions[a].loaded && versionLt(a, b)) ? b : a;"] ["return !a || versionLt(a, b) ? b : a;"]
)}, 0);` )}, 0);`,
"return key && versions[key];"
] ]
)};`, )};`,
`var getInvalidSingletonVersionMessage = ${runtimeTemplate.basicFunction( `var findSatisfyingVersion = ${runtimeTemplate.basicFunction(
"scope, key, version, requiredVersion", "scope, key, requiredVersion, eager",
[ [
`return "Unsatisfied version " + version + " from " + (version && scope[key][version].from) + " of shared singleton module " + key + " (required " + rangeToString(requiredVersion) + ")"` "var versions = eager ? eagerOnly(scope[key]) : scope[key];",
]
)};`,
`var getSingleton = ${runtimeTemplate.basicFunction(
"scope, scopeName, key, requiredVersion",
[
"var version = findSingletonVersionKey(scope, key);",
"return get(scope[key][version]);"
]
)};`,
`var getSingletonVersion = ${runtimeTemplate.basicFunction(
"scope, scopeName, key, requiredVersion",
[
"var version = findSingletonVersionKey(scope, key);",
"if (!satisfy(requiredVersion, version)) warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));",
"return get(scope[key][version]);"
]
)};`,
`var getStrictSingletonVersion = ${runtimeTemplate.basicFunction(
"scope, scopeName, key, requiredVersion",
[
"var version = findSingletonVersionKey(scope, key);",
"if (!satisfy(requiredVersion, version)) " +
"throw new Error(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));",
"return get(scope[key][version]);"
]
)};`,
`var findValidVersion = ${runtimeTemplate.basicFunction(
"scope, key, requiredVersion",
[
"var versions = scope[key];",
`var key = Object.keys(versions).reduce(${runtimeTemplate.basicFunction( `var key = Object.keys(versions).reduce(${runtimeTemplate.basicFunction(
"a, b", "a, b",
[ [
@ -162,136 +138,127 @@ class ConsumeSharedRuntimeModule extends RuntimeModule {
"return key && versions[key]" "return key && versions[key]"
] ]
)};`, )};`,
`var findSingletonVersionKey = ${runtimeTemplate.basicFunction(
"scope, key, eager",
[
"var versions = eager ? eagerOnly(scope[key]) : scope[key];",
`return Object.keys(versions).reduce(${runtimeTemplate.basicFunction(
"a, b",
["return !a || (!versions[a].loaded && versionLt(a, b)) ? b : a;"]
)}, 0);`
]
)};`,
`var getInvalidSingletonVersionMessage = ${runtimeTemplate.basicFunction(
"scope, key, version, requiredVersion",
[
'return "Unsatisfied version " + version + " from " + (version && scope[key][version].from) + " of shared singleton module " + key + " (required " + rangeToString(requiredVersion) + ")"'
]
)};`,
`var getInvalidVersionMessage = ${runtimeTemplate.basicFunction( `var getInvalidVersionMessage = ${runtimeTemplate.basicFunction(
"scope, scopeName, key, requiredVersion", "scope, scopeName, key, requiredVersion, eager",
[ [
"var versions = scope[key];", "var versions = scope[key];",
'return "No satisfying version (" + rangeToString(requiredVersion) + ") of shared module " + key + " found in shared scope " + scopeName + ".\\n" +', 'return "No satisfying version (" + rangeToString(requiredVersion) + ")" + (eager ? " for eager consumption" : "") + " of shared module " + key + " found in shared scope " + scopeName + ".\\n" +',
`\t"Available versions: " + Object.keys(versions).map(${runtimeTemplate.basicFunction( `\t"Available versions: " + Object.keys(versions).map(${runtimeTemplate.basicFunction(
"key", "key",
['return key + " from " + versions[key].from;'] ['return key + " from " + versions[key].from;']
)}).join(", ");` )}).join(", ");`
] ]
)};`, )};`,
`var getValidVersion = ${runtimeTemplate.basicFunction( `var fail = ${runtimeTemplate.basicFunction("msg", [
"scope, scopeName, key, requiredVersion", "throw new Error(msg);"
[ ])}`,
"var entry = findValidVersion(scope, key, requiredVersion);", `var failAsNotExist = ${runtimeTemplate.basicFunction("scopeName, key", [
"if(entry) return get(entry);", 'return fail("Shared module " + key + " doesn\'t exist in shared scope " + scopeName);'
"throw new Error(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));" ])}`,
] `var warn = /*#__PURE__*/ ${
)};`,
`var warn = ${
compilation.outputOptions.ignoreBrowserWarnings compilation.outputOptions.ignoreBrowserWarnings
? runtimeTemplate.basicFunction("", "") ? runtimeTemplate.basicFunction("", "")
: runtimeTemplate.basicFunction("msg", [ : runtimeTemplate.basicFunction("msg", [
'if (typeof console !== "undefined" && console.warn) console.warn(msg);' 'if (typeof console !== "undefined" && console.warn) console.warn(msg);'
]) ])
};`, };`,
`var warnInvalidVersion = ${runtimeTemplate.basicFunction(
"scope, scopeName, key, requiredVersion",
[
"warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));"
]
)};`,
`var get = ${runtimeTemplate.basicFunction("entry", [
"entry.loaded = 1;",
"return entry.get()"
])};`,
`var init = ${runtimeTemplate.returningFunction( `var init = ${runtimeTemplate.returningFunction(
Template.asString([ Template.asString([
"function(scopeName, a, b, c) {", "function(scopeName, key, eager, c, d) {",
Template.indent([ Template.indent([
`var promise = ${RuntimeGlobals.initializeSharing}(scopeName);`, `var promise = ${RuntimeGlobals.initializeSharing}(scopeName);`,
`if (promise && promise.then) return promise.then(fn.bind(fn, scopeName, ${RuntimeGlobals.shareScopeMap}[scopeName], a, b, c));`, // if we require eager shared, we expect it to be already loaded before it requested, no need to wait the whole scope loaded.
`return fn(scopeName, ${RuntimeGlobals.shareScopeMap}[scopeName], a, b, c);` "if (promise && promise.then && !eager) { ",
Template.indent([
`return promise.then(fn.bind(fn, scopeName, ${RuntimeGlobals.shareScopeMap}[scopeName], key, false, c, d));`
]),
"}",
`return fn(scopeName, ${RuntimeGlobals.shareScopeMap}[scopeName], key, eager, c, d);`
]), ]),
"}" "}"
]), ]),
"fn" "fn"
)};`, )};`,
"", "",
`var useFallback = ${runtimeTemplate.basicFunction(
"scopeName, key, fallback",
["return fallback ? fallback() : failAsNotExist(scopeName, key);"]
)}`,
`var load = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var load = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key", "scopeName, scope, key, eager, fallback",
[ [
"ensureExistence(scopeName, key);", "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"return get(findVersion(scope, key));" "return get(findLatestVersion(scope, key, eager));"
] ]
)});`, )});`,
`var loadFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var loadVersion = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, fallback", "scopeName, scope, key, eager, requiredVersion, fallback",
[ [
`return scope && ${RuntimeGlobals.hasOwnProperty}(scope, key) ? get(findVersion(scope, key)) : fallback();` "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"var satisfyingVersion = findSatisfyingVersion(scope, key, requiredVersion, eager);",
"if (satisfyingVersion) return get(satisfyingVersion);",
"warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion, eager))",
"return get(findLatestVersion(scope, key, eager));"
] ]
)});`, )});`,
`var loadVersionCheck = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var loadStrictVersion = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version", "scopeName, scope, key, eager, requiredVersion, fallback",
[ [
"ensureExistence(scopeName, key);", "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"return get(findValidVersion(scope, key, version) || warnInvalidVersion(scope, scopeName, key, version) || findVersion(scope, key));" "var satisfyingVersion = findSatisfyingVersion(scope, key, requiredVersion, eager);",
"if (satisfyingVersion) return get(satisfyingVersion);",
"if (fallback) return fallback();",
"fail(getInvalidVersionMessage(scope, scopeName, key, requiredVersion, eager));"
] ]
)});`, )});`,
`var loadSingleton = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var loadSingleton = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key", "scopeName, scope, key, eager, fallback",
[ [
"ensureExistence(scopeName, key);", "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"return getSingleton(scope, scopeName, key);" "var version = findSingletonVersionKey(scope, key, eager);",
"return get(scope[key][version]);"
] ]
)});`, )});`,
`var loadSingletonVersionCheck = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var loadSingletonVersion = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version", "scopeName, scope, key, eager, requiredVersion, fallback",
[ [
"ensureExistence(scopeName, key);", "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"return getSingletonVersion(scope, scopeName, key, version);" "var version = findSingletonVersionKey(scope, key, eager);",
"if (!satisfy(requiredVersion, version)) {",
Template.indent([
"warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));"
]),
"}",
"return get(scope[key][version]);"
] ]
)});`, )});`,
`var loadStrictVersionCheck = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( `var loadStrictSingletonVersion = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version", "scopeName, scope, key, eager, requiredVersion, fallback",
[ [
"ensureExistence(scopeName, key);", "if (!exists(scope, key)) return useFallback(scopeName, key, fallback);",
"return getValidVersion(scope, scopeName, key, version);" "var version = findSingletonVersionKey(scope, key, eager);",
] "if (!satisfy(requiredVersion, version)) {",
)});`, Template.indent([
`var loadStrictSingletonVersionCheck = /*#__PURE__*/ init(${runtimeTemplate.basicFunction( "fail(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));"
"scopeName, scope, key, version", ]),
[ "}",
"ensureExistence(scopeName, key);", "return get(scope[key][version]);"
"return getStrictSingletonVersion(scope, scopeName, key, version);"
]
)});`,
`var loadVersionCheckFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version, fallback",
[
`if(!scope || !${RuntimeGlobals.hasOwnProperty}(scope, key)) return fallback();`,
"return get(findValidVersion(scope, key, version) || warnInvalidVersion(scope, scopeName, key, version) || findVersion(scope, key));"
]
)});`,
`var loadSingletonFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, fallback",
[
`if(!scope || !${RuntimeGlobals.hasOwnProperty}(scope, key)) return fallback();`,
"return getSingleton(scope, scopeName, key);"
]
)});`,
`var loadSingletonVersionCheckFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version, fallback",
[
`if(!scope || !${RuntimeGlobals.hasOwnProperty}(scope, key)) return fallback();`,
"return getSingletonVersion(scope, scopeName, key, version);"
]
)});`,
`var loadStrictVersionCheckFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version, fallback",
[
`var entry = scope && ${RuntimeGlobals.hasOwnProperty}(scope, key) && findValidVersion(scope, key, version);`,
`return entry ? get(entry) : fallback();`
]
)});`,
`var loadStrictSingletonVersionCheckFallback = /*#__PURE__*/ init(${runtimeTemplate.basicFunction(
"scopeName, scope, key, version, fallback",
[
`if(!scope || !${RuntimeGlobals.hasOwnProperty}(scope, key)) return fallback();`,
"return getStrictSingletonVersion(scope, scopeName, key, version);"
] ]
)});`, )});`,
"var installedModules = {};", "var installedModules = {};",

7
test/configCases/container/0-eager-shared/App.js Normal file
View File

@ -0,0 +1,7 @@
import { emitter } from "./emitter.js";
function App() {
return emitter;
}
export default App;

9
test/configCases/container/0-eager-shared/emitter.js Normal file
View File

@ -0,0 +1,9 @@
import { TinyEmitter } from 'tiny-emitter'
const emitter = new TinyEmitter()
emitter.on('hello', () => console.log('hello[service]'))
export {
emitter,
}

6
test/configCases/container/0-eager-shared/index.js Normal file
View File

@ -0,0 +1,6 @@
it("should allow to import exposed modules sync", () => {
return import("./App").then(({ default: App }) => {
expect(App().e.hello).toBeDefined();
});
});

67
test/configCases/container/0-eager-shared/node_modules/tiny-emitter/index.js generated vendored Normal file
View File

@ -0,0 +1,67 @@
function E () {
// Keep this empty so it's easier to inherit from
// (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)
}
E.prototype = {
on: function (name, callback, ctx) {
var e = this.e || (this.e = {});
(e[name] || (e[name] = [])).push({
fn: callback,
ctx: ctx
});
return this;
},
once: function (name, callback, ctx) {
var self = this;
function listener () {
self.off(name, listener);
callback.apply(ctx, arguments);
};
listener._ = callback
return this.on(name, listener, ctx);
},
emit: function (name) {
var data = [].slice.call(arguments, 1);
var evtArr = ((this.e || (this.e = {}))[name] || []).slice();
var i = 0;
var len = evtArr.length;
for (i; i < len; i++) {
evtArr[i].fn.apply(evtArr[i].ctx, data);
}
return this;
},
off: function (name, callback) {
var e = this.e || (this.e = {});
var evts = e[name];
var liveEvents = [];
if (evts && callback) {
for (var i = 0, len = evts.length; i < len; i++) {
if (evts[i].fn !== callback && evts[i].fn._ !== callback)
liveEvents.push(evts[i]);
}
}
// Remove event from queue to prevent memory leak
// Suggested by https://github.com/lazd
// Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910
(liveEvents.length)
? e[name] = liveEvents
: delete e[name];
return this;
}
};
module.exports = E;
module.exports.TinyEmitter = E;

7
test/configCases/container/0-eager-shared/node_modules/tiny-emitter/package.json generated vendored Normal file
View File

@ -0,0 +1,7 @@
{
"name": "tiny-emitter",
"version": "2.1.0",
"description": "A tiny (less than 1k) event emitter library",
"main": "index.js",
"license": "MIT"
}

9
test/configCases/container/0-eager-shared/package.json Normal file
View File

@ -0,0 +1,9 @@
{
"private": true,
"engines": {
"node": ">=10.13.0"
},
"dependencies": {
"tiny-emitter": "^2.1.0"
}
}

26
test/configCases/container/0-eager-shared/webpack.config.js Normal file
View File

@ -0,0 +1,26 @@
const { dependencies } = require("./package.json");
const { ModuleFederationPlugin } = require("../../../../").container;
/** @type {import("../../../../").Configuration} */
module.exports = {
optimization: {
chunkIds: "named",
moduleIds: "named"
},
plugins: [
new ModuleFederationPlugin({
name: "container",
filename: "container.js",
library: { type: "commonjs-module" },
exposes: {
"./emitter": {
name: "emitter",
import: "./emitter.js"
}
},
shared: {
...dependencies
}
})
]
};

13
test/configCases/container/eager-shared/index.js Normal file
View File

@ -0,0 +1,13 @@
import TinyEmitter from 'tiny-emitter'
it("should load the component from container", () => {
const emitter = new TinyEmitter()
emitter.on('hello', () => {})
expect(emitter.e.hello).toBeDefined();
return import('service/emitter').then(({ emitter }) => {
expect(emitter.e.hello).toBeDefined();
})
});

66
test/configCases/container/eager-shared/node_modules/tiny-emitter/index.js generated vendored Normal file
View File

@ -0,0 +1,66 @@
function E () {
// Keep this empty so it's easier to inherit from
// (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)
}
E.prototype = {
on: function (name, callback, ctx) {
var e = this.e || (this.e = {});
(e[name] || (e[name] = [])).push({
fn: callback,
ctx: ctx
});
return this;
},
once: function (name, callback, ctx) {
var self = this;
function listener () {
self.off(name, listener);
callback.apply(ctx, arguments);
};
listener._ = callback
return this.on(name, listener, ctx);
},
emit: function (name) {
var data = [].slice.call(arguments, 1);
var evtArr = ((this.e || (this.e = {}))[name] || []).slice();
var i = 0;
var len = evtArr.length;
for (i; i < len; i++) {
evtArr[i].fn.apply(evtArr[i].ctx, data);
}
return this;
},
off: function (name, callback) {
var e = this.e || (this.e = {});
var evts = e[name];
var liveEvents = [];
if (evts && callback) {
for (var i = 0, len = evts.length; i < len; i++) {
if (evts[i].fn !== callback && evts[i].fn._ !== callback)
liveEvents.push(evts[i]);
}
}
// Remove event from queue to prevent memory leak
// Suggested by https://github.com/lazd
// Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910
(liveEvents.length)
? e[name] = liveEvents
: delete e[name];
return this;
}
};
module.exports = E;

7
test/configCases/container/eager-shared/node_modules/tiny-emitter/package.json generated vendored Normal file
View File

@ -0,0 +1,7 @@
{
"name": "tiny-emitter",
"version": "2.0.0",
"description": "A tiny (less than 1k) event emitter library",
"main": "index.js",
"license": "MIT"
}

9
test/configCases/container/eager-shared/package.json Normal file
View File

@ -0,0 +1,9 @@
{
"private": true,
"engines": {
"node": ">=10.13.0"
},
"dependencies": {
"tiny-emitter": "=2.0.0"
}
}

25
test/configCases/container/eager-shared/webpack.config.js Normal file
View File

@ -0,0 +1,25 @@
const { dependencies } = require("./package.json");
const { ModuleFederationPlugin } = require("../../../../").container;
/** @type {import("../../../../").Configuration} */
module.exports = {
optimization: {
chunkIds: "named",
moduleIds: "named"
},
plugins: [
new ModuleFederationPlugin({
remoteType: "commonjs-module",
remotes: {
service: "../0-eager-shared/container.js"
},
shared: {
"tiny-emitter": {
eager: true,
singleton: true,
requiredVersion: dependencies["tiny-emitter"]
}
}
})
]
};