@module-federation/vite
Version:
Vite plugin for Module Federation
1,506 lines (1,482 loc) • 54.1 kB
JavaScript
import defu from 'defu';
import * as fs from 'fs';
import { mkdirSync, writeFileSync, existsSync, writeFile } from 'fs';
import * as path from 'pathe';
import path__default, { resolve, basename, parse, join, dirname } from 'pathe';
import { createFilter } from '@rollup/pluginutils';
import { walk } from 'estree-walker';
import MagicString from 'magic-string';
function getFirstHtmlEntryFile(entryFiles) {
return entryFiles.find(file => file.endsWith('.html'));
}
const addEntry = ({
entryName,
entryPath,
fileName,
inject: _inject = 'entry'
}) => {
let devEntryPath = entryPath.startsWith('virtual:mf') ? '@id/' + entryPath : entryPath;
let entryFiles = [];
let htmlFilePath;
let _command;
let emitFileId;
let viteConfig;
function injectHtml() {
return _inject === 'html' && htmlFilePath;
}
function injectEntry() {
return _inject === 'entry' || !htmlFilePath;
}
return [{
name: 'add-entry',
apply: 'serve',
config(config, {
command
}) {
_command = command;
},
configResolved(config) {
viteConfig = config;
devEntryPath = config.base + devEntryPath.replace(/\\\\?/g, '/').replace(/.+?\:([/\\])[/\\]?/, '$1').replace(/^\//, '');
},
configureServer(server) {
server.middlewares.use((req, res, next) => {
if (!fileName) {
next();
return;
}
if (req.url && req.url.startsWith((viteConfig.base + fileName).replace(/^\/?/, '/'))) {
req.url = devEntryPath;
}
next();
});
},
transformIndexHtml(c) {
if (!injectHtml()) return;
return c.replace('<head>', `<head><script type="module" src=${JSON.stringify(devEntryPath.replace(/.+?\:([/\\])[/\\]?/, '$1').replace(/\\\\?/g, '/'))}></script>`);
},
transform(code, id) {
if (id.includes('node_modules') || _inject !== 'html' || htmlFilePath) {
return;
}
if (id.includes('.svelte-kit') && id.includes('internal.js')) {
const src = devEntryPath.replace(/.+?\:([/\\])[/\\]?/, '$1').replace(/\\\\?/g, '/');
return code.replace(/<head>/g, '<head><script type=\\"module\\" src=\\"' + src + '\\"></script>');
}
}
}, {
name: 'add-entry',
enforce: 'post',
configResolved(config) {
viteConfig = config;
const inputOptions = config.build.rollupOptions.input;
if (!inputOptions) {
htmlFilePath = path.resolve(config.root, 'index.html');
} else if (typeof inputOptions === 'string') {
entryFiles = [inputOptions];
} else if (Array.isArray(inputOptions)) {
entryFiles = inputOptions;
} else if (typeof inputOptions === 'object') {
entryFiles = Object.values(inputOptions);
}
if (entryFiles && entryFiles.length > 0) {
htmlFilePath = getFirstHtmlEntryFile(entryFiles);
}
},
buildStart() {
if (_command === 'serve') return;
const hasHash = fileName == null || fileName.includes == null ? void 0 : fileName.includes('[hash');
const emitFileOptions = {
name: entryName,
type: 'chunk',
id: entryPath,
preserveSignature: 'strict'
};
if (!hasHash) {
emitFileOptions.fileName = fileName;
}
emitFileId = this.emitFile(emitFileOptions);
if (htmlFilePath && fs.existsSync(htmlFilePath)) {
const htmlContent = fs.readFileSync(htmlFilePath, 'utf-8');
const scriptRegex = /<script\s+[^>]*src=["']([^"']+)["'][^>]*>/gi;
let match;
while ((match = scriptRegex.exec(htmlContent)) !== null) {
entryFiles.push(match[1]);
}
}
},
generateBundle(options, bundle) {
if (!injectHtml()) return;
const file = this.getFileName(emitFileId);
const scriptContent = `
<script type="module" src="${viteConfig.base + file}"></script>
`;
for (const fileName in bundle) {
if (fileName.endsWith('.html')) {
let htmlAsset = bundle[fileName];
if (htmlAsset.type === 'chunk') return;
let htmlContent = htmlAsset.source.toString() || '';
htmlContent = htmlContent.replace('<head>', `<head>${scriptContent}`);
htmlAsset.source = htmlContent;
}
}
},
transform(code, id) {
if (injectEntry() && entryFiles.some(file => id.endsWith(file))) {
const injection = `
import ${JSON.stringify(entryPath)};
`;
return injection + code;
}
}
}];
};
/**
* Solve the problem that dev mode dependency prebunding does not support top-level await syntax
*/
function PluginDevProxyModuleTopLevelAwait() {
const filterFunction = createFilter();
const processedFlag = '/* already-processed-by-dev-proxy-module-top-level-await */';
return {
name: 'dev-proxy-module-top-level-await',
apply: 'serve',
transform(code, id) {
if (code.includes(processedFlag)) {
return null;
}
if (!code.includes('/*mf top-level-await placeholder replacement mf*/')) {
return null;
}
if (!filterFunction(id)) return null;
let ast;
try {
ast = this.parse(code, {
allowReturnOutsideFunction: true
});
} catch (e) {
throw new Error(`${id}: ${e}`);
}
const magicString = new MagicString(code);
walk(ast, {
enter(node) {
if (node.type === 'ExportNamedDeclaration' && node.specifiers) {
const exportSpecifiers = node.specifiers.map(specifier => specifier.exported.name);
const proxyStatements = exportSpecifiers.map(name => `
const __mfproxy__await${name} = await ${name}();
const __mfproxy__${name} = () => __mfproxy__await${name};
`).join('\n');
const exportStatements = exportSpecifiers.map(name => `__mfproxy__${name} as ${name}`).join(', ');
const start = node.start;
const end = node.end;
const replacement = `${proxyStatements}\nexport { ${exportStatements} };`;
magicString.overwrite(start, end, replacement);
}
if (node.type === 'ExportDefaultDeclaration') {
const declaration = node.declaration;
const start = node.start;
const end = node.end;
let proxyStatement;
let exportStatement = 'default';
if (declaration.type === 'Identifier') {
// example: export default foo;
proxyStatement = `
const __mfproxy__awaitdefault = await ${declaration.name}();
const __mfproxy__default = __mfproxy__awaitdefault;
`;
} else if (declaration.type === 'CallExpression' || declaration.type === 'FunctionDeclaration') {
// example: export default someFunction();
const declarationCode = code.slice(declaration.start, declaration.end);
proxyStatement = `
const __mfproxy__awaitdefault = await (${declarationCode});
const __mfproxy__default = __mfproxy__awaitdefault;
`;
} else {
// other
proxyStatement = `
const __mfproxy__awaitdefault = await (${code.slice(declaration.start, declaration.end)});
const __mfproxy__default = __mfproxy__awaitdefault;
`;
}
const replacement = `${proxyStatement}\nexport { __mfproxy__default as ${exportStatement} };`;
magicString.overwrite(start, end, replacement);
}
}
});
const transformedCode = magicString.toString();
return {
code: `${processedFlag}\n${transformedCode}`,
map: magicString.generateMap({
hires: true
})
};
}
};
}
function _extends() {
return _extends = Object.assign ? Object.assign.bind() : function (n) {
for (var e = 1; e < arguments.length; e++) {
var t = arguments[e];
for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]);
}
return n;
}, _extends.apply(null, arguments);
}
const warn = message => message.split('\n').forEach(msg => console.warn('\x1b[33m%s\x1b[0m', msg));
function normalizeExposesItem(key, item) {
let importPath = '';
if (typeof item === 'string') {
importPath = item;
}
if (typeof item === 'object') {
importPath = item.import;
}
return {
import: importPath
};
}
function normalizeExposes(exposes) {
if (!exposes) return {};
const res = {};
Object.keys(exposes).forEach(key => {
res[key] = normalizeExposesItem(key, exposes[key]);
});
return res;
}
function normalizeRemotes(remotes) {
if (!remotes) return {};
const result = {};
if (typeof remotes === 'object') {
Object.keys(remotes).forEach(key => {
result[key] = normalizeRemoteItem(key, remotes[key]);
});
}
return result;
}
function normalizeRemoteItem(key, remote) {
if (typeof remote === 'string') {
const [entryGlobalName] = remote.split('@');
const entry = remote.replace(entryGlobalName + '@', '');
return {
type: 'var',
name: key,
entry,
entryGlobalName,
shareScope: 'default'
};
}
return Object.assign({
type: 'var',
name: key,
shareScope: 'default',
entryGlobalName: key
}, remote);
}
function removePathFromNpmPackage(packageString) {
// 匹配npm包名的正则表达式，忽略路径部分
const regex = /^(?:@[^/]+\/)?[^/]+/;
// 使用正则表达式匹配并提取包名
const match = packageString.match(regex);
// 返回匹配到的包名，如果没有匹配到则返回原字符串
return match ? match[0] : packageString;
}
/**
* Tries to find the package.json's version of a shared package
* if `package.json` is not declared in `exports`
* @param {string} sharedName
* @returns {string | undefined}
*/
function searchPackageVersion(sharedName) {
try {
const sharedPath = require.resolve(sharedName);
let potentialPackageJsonDir = path.dirname(sharedPath);
const rootDir = path.parse(potentialPackageJsonDir).root;
while (path.parse(potentialPackageJsonDir).base !== 'node_modules' && potentialPackageJsonDir !== rootDir) {
const potentialPackageJsonPath = path.join(potentialPackageJsonDir, 'package.json');
if (fs.existsSync(potentialPackageJsonPath)) {
const potentialPackageJson = require(potentialPackageJsonPath);
if (typeof potentialPackageJson == 'object' && potentialPackageJson !== null && typeof potentialPackageJson.version === 'string' && potentialPackageJson.name === sharedName) {
return potentialPackageJson.version;
}
}
potentialPackageJsonDir = path.dirname(potentialPackageJsonDir);
}
} catch (_) {}
return undefined;
}
function normalizeShareItem(key, shareItem) {
let version;
try {
try {
version = require(path.join(removePathFromNpmPackage(key), 'package.json')).version;
} catch (e1) {
try {
const localPath = path.join(process.cwd(), 'node_modules', removePathFromNpmPackage(key), 'package.json');
version = require(localPath).version;
} catch (e2) {
version = searchPackageVersion(key);
if (!version) console.error(e1);
}
}
} catch (e) {
console.error(`Unexpected error resolving version for ${key}:`, e);
}
if (typeof shareItem === 'string') {
return {
name: shareItem,
version,
scope: 'default',
from: '',
shareConfig: {
singleton: false,
requiredVersion: version ? `^${version}` : '*'
}
};
}
return {
name: key,
from: '',
version: shareItem.version || version,
scope: shareItem.shareScope || 'default',
shareConfig: {
singleton: shareItem.singleton || false,
requiredVersion: shareItem.requiredVersion || (version ? `^${version}` : '*'),
strictVersion: !!shareItem.strictVersion
}
};
}
function normalizeShared(shared) {
if (!shared) return {};
const result = {};
if (Array.isArray(shared)) {
shared.forEach(key => {
result[key] = normalizeShareItem(key, key);
});
return result;
}
if (typeof shared === 'object') {
Object.keys(shared).forEach(key => {
result[key] = normalizeShareItem(key, shared[key]);
});
}
return result;
}
function normalizeLibrary(library) {
if (!library) return undefined;
return library;
}
function normalizeManifest(manifest = false) {
if (typeof manifest === 'boolean') {
return manifest;
}
return Object.assign({
filePath: '',
disableAssetsAnalyze: false,
fileName: 'mf-manifest.json'
}, manifest);
}
let config;
function getNormalizeModuleFederationOptions() {
return config;
}
function getNormalizeShareItem(key) {
const options = getNormalizeModuleFederationOptions();
const shareItem = options.shared[key] || options.shared[removePathFromNpmPackage(key)] || options.shared[removePathFromNpmPackage(key) + '/'];
return shareItem;
}
function normalizeModuleFederationOptions(options) {
if (options.getPublicPath) {
warn(`We are ignoring the getPublicPath options because they are natively supported by Vite\nwith the "experimental.renderBuiltUrl" configuration https://vitejs.dev/guide/build#advanced-base-options`);
}
if (options.virtualModuleDir && options.virtualModuleDir.includes('/')) {
throw new Error(`Invalid virtualModuleDir: "${options.virtualModuleDir}". ` + `The virtualModuleDir option cannot contain slashes (/). ` + `Please use a single directory name like '__mf__virtual__your_app_name'.`);
}
return config = {
exposes: normalizeExposes(options.exposes),
filename: options.filename || 'remoteEntry-[hash]',
library: normalizeLibrary(options.library),
name: options.name,
// remoteType: options.remoteType,
remotes: normalizeRemotes(options.remotes),
runtime: options.runtime,
shareScope: options.shareScope || 'default',
shared: normalizeShared(options.shared),
runtimePlugins: options.runtimePlugins || [],
implementation: options.implementation || require.resolve('@module-federation/runtime'),
manifest: normalizeManifest(options.manifest),
dev: options.dev,
dts: options.dts,
getPublicPath: options.getPublicPath,
publicPath: options.publicPath,
shareStrategy: options.shareStrategy || 'version-first',
ignoreOrigin: options.ignoreOrigin || false,
virtualModuleDir: options.virtualModuleDir || '__mf__virtual'
};
}
/**
* Escaping rules:
* Convert using the format __${mapping}__, where _ and $ are not allowed in npm package names but can be used in variable names.
* @ => 1
* / => 2
* - => 3
* . => 4
*/
/**
* Encodes a package name into a valid file name.
* @param {string} name - The package name, e.g., "@scope/xx-xx.xx".
* @returns {string} - The encoded file name.
*/
function packageNameEncode(name) {
if (typeof name !== 'string') throw new Error('A string package name is required');
return name.replace(/@/g, '_mf_0_').replace(/\//g, '_mf_1_').replace(/-/g, '_mf_2_').replace(/\./g, '_mf_3_');
}
/**
* Decodes an encoded file name back to the original package name.
* @param {string} encoded - The encoded file name, e.g., "_mf_0_scope_mf_1_xx_mf_2_xx_mf_3_xx".
* @returns {string} - The decoded package name.
*/
function packageNameDecode(encoded) {
if (typeof encoded !== 'string') throw new Error('A string encoded file name is required');
return encoded.replace(/_mf_0_/g, '@').replace(/_mf_1_/g, '/').replace(/_mf_2_/g, '-').replace(/_mf_3_/g, '.');
}
/**
* https://github.com/module-federation/vite/issues/68
*/
function getLocalSharedImportMapPath_temp() {
const {
name
} = getNormalizeModuleFederationOptions();
return path__default.resolve('.__mf__temp', packageNameEncode(name), 'localSharedImportMap');
}
function writeLocalSharedImportMap_temp(content) {
const localSharedImportMapId = getLocalSharedImportMapPath_temp();
createFile(localSharedImportMapId + '.js', '\n// Windows temporarily needs this file, https://github.com/module-federation/vite/issues/68\n' + content);
}
function createFile(filePath, content) {
const dir = path__default.dirname(filePath);
mkdirSync(dir, {
recursive: true
});
writeFileSync(filePath, content);
}
// Cache root path
let rootDir;
function findNodeModulesDir(root = process.cwd()) {
let currentDir = root;
while (currentDir !== parse(currentDir).root) {
const nodeModulesPath = join(currentDir, 'node_modules');
if (existsSync(nodeModulesPath)) {
return nodeModulesPath;
}
currentDir = dirname(currentDir);
}
return '';
}
// Cache nodeModulesDir result to avoid repeated calculations
let cachedNodeModulesDir;
function getNodeModulesDir() {
if (!cachedNodeModulesDir) {
cachedNodeModulesDir = findNodeModulesDir(rootDir);
}
return cachedNodeModulesDir;
}
function getSuffix(name) {
const base = basename(name);
const dotIndex = base.lastIndexOf('.');
if (dotIndex > 0 && dotIndex < base.length - 1) {
return base.slice(dotIndex);
}
return '.js';
}
const patternMap = {};
const cacheMap = {};
/**
* Physically generate files as virtual modules under node_modules/__mf__virtual/*
*/
function assertModuleFound(tag, str = '') {
const module = VirtualModule.findModule(tag, str);
if (!module) {
throw new Error(`Module Federation shared module '${str}' not found. Please ensure it's installed as a dependency in your package.json.`);
}
return module;
}
class VirtualModule {
/**
* Set the root path for finding node_modules
* @param root - Root path
*/
static setRoot(root) {
rootDir = root;
// Reset cache to ensure using the new root path
cachedNodeModulesDir = undefined;
}
/**
* Ensure virtual package directory exists
*/
static ensureVirtualPackageExists() {
const nodeModulesDir = getNodeModulesDir();
const {
virtualModuleDir
} = getNormalizeModuleFederationOptions();
const virtualPackagePath = resolve(nodeModulesDir, virtualModuleDir);
if (!existsSync(virtualPackagePath)) {
mkdirSync(virtualPackagePath);
writeFileSync(resolve(virtualPackagePath, 'empty.js'), '');
writeFileSync(resolve(virtualPackagePath, 'package.json'), JSON.stringify({
name: virtualModuleDir,
main: 'empty.js'
}));
}
}
static findModule(tag, str = '') {
if (!patternMap[tag]) patternMap[tag] = new RegExp(`(.*${packageNameEncode(tag)}(.+?)${packageNameEncode(tag)}.*)`);
const moduleName = (str.match(patternMap[tag]) || [])[2];
if (moduleName) return cacheMap[tag][packageNameDecode(moduleName)];
return undefined;
}
constructor(name, tag = '__mf_v__', suffix = '') {
this.name = void 0;
this.tag = void 0;
this.suffix = void 0;
this.inited = false;
this.name = name;
this.tag = tag;
this.suffix = suffix || getSuffix(name);
if (!cacheMap[this.tag]) cacheMap[this.tag] = {};
cacheMap[this.tag][this.name] = this;
}
getPath() {
return resolve(getNodeModulesDir(), this.getImportId());
}
getImportId() {
const {
name: mfName,
virtualModuleDir
} = getNormalizeModuleFederationOptions();
return `${virtualModuleDir}/${packageNameEncode(`${mfName}${this.tag}${this.name}${this.tag}`)}${this.suffix}`;
}
writeSync(code, force) {
if (!force && this.inited) return;
if (!this.inited) {
this.inited = true;
}
writeFileSync(this.getPath(), code);
}
write(code) {
writeFile(this.getPath(), code, function () {});
}
}
const VIRTUAL_EXPOSES = 'virtual:mf-exposes';
function generateExposes() {
const options = getNormalizeModuleFederationOptions();
return `
export default {
${Object.keys(options.exposes).map(key => {
return `
${JSON.stringify(key)}: async () => {
const importModule = await import(${JSON.stringify(options.exposes[key].import)})
const exportModule = {}
Object.assign(exportModule, importModule)
Object.defineProperty(exportModule, "__esModule", {
value: true,
enumerable: false
})
return exportModule
}
`;
}).join(',')}
}
`;
}
const virtualRuntimeInitStatus = new VirtualModule('runtimeInit');
function writeRuntimeInitStatus() {
virtualRuntimeInitStatus.writeSync(`
let initResolve, initReject
const initPromise = new Promise((re, rj) => {
initResolve = re
initReject = rj
})
module.exports = {
initPromise,
initResolve,
initReject
}
`);
}
const cacheRemoteMap = {};
const LOAD_REMOTE_TAG = '__loadRemote__';
function getRemoteVirtualModule(remote, command) {
if (!cacheRemoteMap[remote]) {
cacheRemoteMap[remote] = new VirtualModule(remote, LOAD_REMOTE_TAG, '.js');
cacheRemoteMap[remote].writeSync(generateRemotes(remote, command));
}
const virtual = cacheRemoteMap[remote];
return virtual;
}
const usedRemotesMap = {
// remote1: {remote1/App, remote1, remote1/Button}
};
function addUsedRemote(remoteKey, remoteModule) {
if (!usedRemotesMap[remoteKey]) usedRemotesMap[remoteKey] = new Set();
usedRemotesMap[remoteKey].add(remoteModule);
}
function getUsedRemotesMap() {
return usedRemotesMap;
}
function generateRemotes(id, command) {
return `
const {loadRemote} = require("@module-federation/runtime")
const {initPromise} = require("${virtualRuntimeInitStatus.getImportId()}")
const res = initPromise.then(_ => loadRemote(${JSON.stringify(id)}))
const exportModule = ${command !== 'build' ? '/*mf top-level-await placeholder replacement mf*/' : 'await '}initPromise.then(_ => res)
module.exports = exportModule
`;
}
/**
* Even the resolveId hook cannot interfere with vite pre-build,
* and adding query parameter virtual modules will also fail.
* You can only proxy to the real file through alias
*/
// *** __prebuild__
const preBuildCacheMap = {};
const PREBUILD_TAG = '__prebuild__';
function writePreBuildLibPath(pkg) {
if (!preBuildCacheMap[pkg]) preBuildCacheMap[pkg] = new VirtualModule(pkg, PREBUILD_TAG);
preBuildCacheMap[pkg].writeSync('');
}
function getPreBuildLibImportId(pkg) {
if (!preBuildCacheMap[pkg]) preBuildCacheMap[pkg] = new VirtualModule(pkg, PREBUILD_TAG);
const importId = preBuildCacheMap[pkg].getImportId();
return importId;
}
// *** __loadShare__
const LOAD_SHARE_TAG = '__loadShare__';
const loadShareCacheMap = {};
function getLoadShareModulePath(pkg) {
if (!loadShareCacheMap[pkg]) loadShareCacheMap[pkg] = new VirtualModule(pkg, LOAD_SHARE_TAG, '.js');
const filepath = loadShareCacheMap[pkg].getPath();
return filepath;
}
function writeLoadShareModule(pkg, shareItem, command) {
loadShareCacheMap[pkg].writeSync(`
;() => import(${JSON.stringify(getPreBuildLibImportId(pkg))}).catch(() => {});
// dev uses dynamic import to separate chunks
${command !== 'build' ? `;() => import(${JSON.stringify(pkg)}).catch(() => {});` : ''}
const {loadShare} = require("@module-federation/runtime")
const {initPromise} = require("${virtualRuntimeInitStatus.getImportId()}")
const res = initPromise.then(_ => loadShare(${JSON.stringify(pkg)}, {
customShareInfo: {shareConfig:{
singleton: ${shareItem.shareConfig.singleton},
strictVersion: ${shareItem.shareConfig.strictVersion},
requiredVersion: ${JSON.stringify(shareItem.shareConfig.requiredVersion)}
}}}))
const exportModule = ${command !== 'build' ? '/*mf top-level-await placeholder replacement mf*/' : 'await '}res.then(factory => factory())
module.exports = exportModule
`);
}
let usedShares = new Set();
function getUsedShares() {
return usedShares;
}
function addUsedShares(pkg) {
usedShares.add(pkg);
}
// *** Expose locally provided shared modules here
new VirtualModule('localSharedImportMap');
function getLocalSharedImportMapPath() {
return getLocalSharedImportMapPath_temp();
// return localSharedImportMapModule.getPath()
}
let prevSharedCount;
function writeLocalSharedImportMap() {
const sharedCount = getUsedShares().size;
if (prevSharedCount !== sharedCount) {
prevSharedCount = sharedCount;
writeLocalSharedImportMap_temp(generateLocalSharedImportMap());
// localSharedImportMapModule.writeSync(generateLocalSharedImportMap(), true)
}
}
function generateLocalSharedImportMap() {
const options = getNormalizeModuleFederationOptions();
return `
const importMap = {
${Array.from(getUsedShares()).sort().map(pkg => `
${JSON.stringify(pkg)}: async () => {
let pkg = await import("${getPreBuildLibImportId(pkg)}")
return pkg
}
`).join(',')}
}
const usedShared = {
${Array.from(getUsedShares()).sort().map(key => {
const shareItem = getNormalizeShareItem(key);
if (!shareItem) return null;
return `
${JSON.stringify(key)}: {
name: ${JSON.stringify(key)},
version: ${JSON.stringify(shareItem.version)},
scope: [${JSON.stringify(shareItem.scope)}],
loaded: false,
from: ${JSON.stringify(options.name)},
async get () {
usedShared[${JSON.stringify(key)}].loaded = true
const {${JSON.stringify(key)}: pkgDynamicImport} = importMap
const res = await pkgDynamicImport()
const exportModule = {...res}
// All npm packages pre-built by vite will be converted to esm
Object.defineProperty(exportModule, "__esModule", {
value: true,
enumerable: false
})
return function () {
return exportModule
}
},
shareConfig: {
singleton: ${shareItem.shareConfig.singleton},
requiredVersion: ${JSON.stringify(shareItem.shareConfig.requiredVersion)}
}
}
`;
}).filter(x => x !== null).join(',')}
}
const usedRemotes = [${Object.keys(getUsedRemotesMap()).map(key => {
var _JSON$stringify;
const remote = options.remotes[key];
if (!remote) return null;
return `
{
entryGlobalName: ${JSON.stringify(remote.entryGlobalName)},
name: ${JSON.stringify(remote.name)},
type: ${JSON.stringify(remote.type)},
entry: ${JSON.stringify(remote.entry)},
shareScope: ${(_JSON$stringify = JSON.stringify(remote.shareScope)) != null ? _JSON$stringify : 'default'},
}
`;
}).filter(x => x !== null).join(',')}
]
export {
usedShared,
usedRemotes
}
`;
}
const REMOTE_ENTRY_ID = 'virtual:mf-REMOTE_ENTRY_ID';
function generateRemoteEntry(options) {
const pluginImportNames = options.runtimePlugins.map((p, i) => [`$runtimePlugin_${i}`, `import $runtimePlugin_${i} from "${p}";`]);
return `
import {init as runtimeInit, loadRemote} from "@module-federation/runtime";
${pluginImportNames.map(item => item[1]).join('\n')}
import exposesMap from "${VIRTUAL_EXPOSES}"
import {usedShared, usedRemotes} from "${getLocalSharedImportMapPath()}"
import {
initResolve
} from "${virtualRuntimeInitStatus.getImportId()}"
const initTokens = {}
const shareScopeName = ${JSON.stringify(options.shareScope)}
const mfName = ${JSON.stringify(options.name)}
async function init(shared = {}, initScope = []) {
const initRes = runtimeInit({
name: mfName,
remotes: usedRemotes,
shared: usedShared,
plugins: [${pluginImportNames.map(item => `${item[0]}()`).join(', ')}],
${options.shareStrategy ? `shareStrategy: '${options.shareStrategy}'` : ''}
});
// handling circular init calls
var initToken = initTokens[shareScopeName];
if (!initToken)
initToken = initTokens[shareScopeName] = { from: mfName };
if (initScope.indexOf(initToken) >= 0) return;
initScope.push(initToken);
initRes.initShareScopeMap('${options.shareScope}', shared);
try {
await Promise.all(await initRes.initializeSharing('${options.shareScope}', {
strategy: '${options.shareStrategy}',
from: "build",
initScope
}));
} catch (e) {
console.error(e)
}
initResolve(initRes)
return initRes
}
function getExposes(moduleName) {
if (!(moduleName in exposesMap)) throw new Error(\`Module \${moduleName} does not exist in container.\`)
return (exposesMap[moduleName])().then(res => () => res)
}
export {
init,
getExposes as get
}
`;
}
/**
* Inject entry file, automatically init when used as host,
* and will not inject remoteEntry
*/
const HOST_AUTO_INIT_TAG = '__H_A_I__';
const hostAutoInitModule = new VirtualModule('hostAutoInit', HOST_AUTO_INIT_TAG);
function writeHostAutoInit() {
hostAutoInitModule.writeSync(`
const remoteEntryPromise = import("${REMOTE_ENTRY_ID}")
// __tla only serves as a hack for vite-plugin-top-level-await.
Promise.resolve(remoteEntryPromise)
.then(remoteEntry => {
return Promise.resolve(remoteEntry.__tla)
.then(remoteEntry.init).catch(remoteEntry.init)
})
`);
}
function getHostAutoInitImportId() {
return hostAutoInitModule.getImportId();
}
function getHostAutoInitPath() {
return hostAutoInitModule.getPath();
}
function initVirtualModules() {
writeLocalSharedImportMap();
writeHostAutoInit();
writeRuntimeInitStatus();
}
const ASSET_TYPES = ['js', 'css'];
const LOAD_TIMINGS = ['sync', 'async'];
const JS_EXTENSIONS = ['.ts', '.tsx', '.jsx', '.mjs', '.cjs'];
/**
* Creates an empty asset map structure for tracking JS and CSS assets
* @returns Initialized asset map with sync/async arrays for JS and CSS
*/
const createEmptyAssetMap = () => ({
js: {
sync: [],
async: []
},
css: {
sync: [],
async: []
}
});
/**
* Tracks an asset in the preload map with deduplication
* @param map - The preload map to update
* @param key - The module key to track under
* @param fileName - The asset filename to track
* @param isAsync - Whether the asset is loaded async
* @param type - The asset type ('js' or 'css')
*/
const trackAsset = (map, key, fileName, isAsync, type) => {
if (!map[key]) {
map[key] = createEmptyAssetMap();
}
const target = isAsync ? map[key][type].async : map[key][type].sync;
if (!target.includes(fileName)) {
target.push(fileName);
}
};
/**
* Checks if a file is a CSS file by extension
* @param fileName - The filename to check
* @returns True if file has a CSS extension (.css, .scss, .less)
*/
const isCSSFile = fileName => {
return fileName.endsWith('.css') || fileName.endsWith('.scss') || fileName.endsWith('.less');
};
/**
* Collects all CSS assets from the bundle
* @param bundle - The Rollup output bundle
* @returns Set of CSS asset filenames
*/
const collectCssAssets = bundle => {
const cssAssets = new Set();
for (const [fileName, fileData] of Object.entries(bundle)) {
if (fileData.type === 'asset' && isCSSFile(fileName)) {
cssAssets.add(fileName);
}
}
return cssAssets;
};
/**
* Processes module assets and tracks them in the files map
* @param bundle - The Rollup output bundle
* @param filesMap - The preload map to populate
* @param moduleMatcher - Function that matches module paths to keys
*/
const processModuleAssets = (bundle, filesMap, moduleMatcher) => {
for (const [fileName, fileData] of Object.entries(bundle)) {
if (fileData.type !== 'chunk') continue;
if (!fileData.modules) continue;
for (const modulePath of Object.keys(fileData.modules)) {
const matchKey = moduleMatcher(modulePath);
if (!matchKey) continue;
// Track main JS chunk
trackAsset(filesMap, matchKey, fileName, false, 'js');
// Handle dynamic imports
if (fileData.dynamicImports) {
for (const dynamicImport of fileData.dynamicImports) {
const importData = bundle[dynamicImport];
if (!importData) continue;
const isCss = isCSSFile(dynamicImport);
trackAsset(filesMap, matchKey, dynamicImport, true, isCss ? 'css' : 'js');
}
}
}
}
};
/**
* Deduplicates assets in the files map
* @param filesMap - The preload map to deduplicate
* @returns New deduplicated preload map
*/
const deduplicateAssets = filesMap => {
const result = {};
for (const [key, assetMaps] of Object.entries(filesMap)) {
result[key] = createEmptyAssetMap();
for (const type of ASSET_TYPES) {
for (const timing of LOAD_TIMINGS) {
result[key][type][timing] = Array.from(new Set(assetMaps[type][timing]));
}
}
}
return result;
};
/**
* Builds a mapping between module files and their share keys
* @param shareKeys - Set of share keys to map
* @param resolveFn - Function to resolve module paths
* @returns Map of file paths to their corresponding share keys
*/
const buildFileToShareKeyMap = async (shareKeys, resolveFn) => {
const fileToShareKey = new Map();
const resolutions = await Promise.all(Array.from(shareKeys).map(shareKey => resolveFn(getPreBuildLibImportId(shareKey)).then(resolution => {
var _resolution$id;
return {
shareKey,
file: resolution == null || (_resolution$id = resolution.id) == null ? void 0 : _resolution$id.split('?')[0]
};
}).catch(() => null)));
for (const resolution of resolutions) {
if (resolution != null && resolution.file) {
fileToShareKey.set(resolution.file, resolution.shareKey);
}
}
return fileToShareKey;
};
/**
* Resolves the public path for remote entries
* @param options - Module Federation options
* @param viteBase - Vite's base config value
* @param originalBase - Original base config before any transformations
* @returns The resolved public path
*/
function resolvePublicPath(options, viteBase, originalBase) {
// Use explicitly set publicPath if provided
if (options.publicPath) {
return options.publicPath;
}
// Handle empty original base case
if (originalBase === '') {
return 'auto';
}
// Use viteBase if available, ensuring it ends with a slash
if (viteBase) {
return viteBase.replace(/\/?$/, '/');
}
// Fallback to auto if no base is specified
return 'auto';
}
const Manifest = () => {
const mfOptions = getNormalizeModuleFederationOptions();
const {
name,
filename,
getPublicPath,
manifest: manifestOptions
} = mfOptions;
let mfManifestName = '';
if (manifestOptions === true) {
mfManifestName = 'mf-manifest.json';
}
if (typeof manifestOptions !== 'boolean') {
mfManifestName = path.join((manifestOptions == null ? void 0 : manifestOptions.filePath) || '', (manifestOptions == null ? void 0 : manifestOptions.fileName) || '');
}
let root;
let remoteEntryFile;
let publicPath;
let _command;
let _originalConfigBase;
let viteConfig;
/**
* Adds global CSS assets to all module exports
* @param filesMap - The preload map to update
* @param cssAssets - Set of CSS asset filenames to add
*/
const addCssAssetsToAllExports = (filesMap, cssAssets) => {
Object.keys(filesMap).forEach(key => {
cssAssets.forEach(cssAsset => {
trackAsset(filesMap, key, cssAsset, false, 'css');
});
});
};
return [{
name: 'module-federation-manifest',
apply: 'serve',
/**
* Stores resolved Vite config for later use
*/
/**
* Finalizes configuration after all plugins are resolved
* @param config - Fully resolved Vite config
*/
configResolved(config) {
viteConfig = config;
},
/**
* Configures dev server middleware to handle manifest requests
* @param server - Vite dev server instance
*/
configureServer(server) {
server.middlewares.use((req, res, next) => {
var _req$url;
if (!mfManifestName) {
next();
return;
}
if (((_req$url = req.url) == null ? void 0 : _req$url.replace(/\?.*/, '')) === (viteConfig.base + mfManifestName).replace(/^\/?/, '/')) {
res.setHeader('Content-Type', 'application/json');
res.setHeader('Access-Control-Allow-Origin', '*');
res.end(JSON.stringify(_extends({}, generateMFManifest({}), {
id: name,
name: name,
metaData: {
name: name,
type: 'app',
buildInfo: {
buildVersion: '1.0.0',
buildName: name
},
remoteEntry: {
name: filename,
path: '',
type: 'module'
},
ssrRemoteEntry: {
name: filename,
path: '',
type: 'module'
},
types: {
path: '',
name: ''
},
globalName: name,
pluginVersion: '0.2.5',
publicPath
}
})));
} else {
next();
}
});
}
}, {
name: 'module-federation-manifest',
enforce: 'post',
/**
* Initial plugin configuration
* @param config - Vite config object
* @param command - Current Vite command (serve/build)
*/
config(config, {
command
}) {
if (!config.build) config.build = {};
if (!config.build.manifest) {
config.build.manifest = config.build.manifest || !!manifestOptions;
}
_command = command;
_originalConfigBase = config.base;
},
configResolved(config) {
root = config.root;
let base = config.base;
if (_command === 'serve') {
base = (config.server.origin || '') + config.base;
}
publicPath = resolvePublicPath(mfOptions, base, _originalConfigBase);
},
/**
* Generates the module federation manifest file
* @param options - Rollup output options
* @param bundle - Generated bundle assets
*/
async generateBundle(options, bundle) {
if (!mfManifestName) return;
let filesMap = {};
// First pass: Find remoteEntry file
for (const [_, fileData] of Object.entries(bundle)) {
if (mfOptions.filename.replace(/[\[\]]/g, '_').replace(/\.[^/.]+$/, '') === fileData.name || fileData.name === 'remoteEntry') {
remoteEntryFile = fileData.fileName;
break; // We can break early since we only need to find remoteEntry once
}
}
// Second pass: Collect all CSS assets
const allCssAssets = collectCssAssets(bundle);
const exposesModules = Object.keys(mfOptions.exposes).map(item => mfOptions.exposes[item].import);
// Process exposed modules
processModuleAssets(bundle, filesMap, modulePath => {
const absoluteModulePath = path.resolve(root, modulePath);
return exposesModules.find(exposeModule => {
const exposePath = path.resolve(root, exposeModule);
// First try exact path match
if (absoluteModulePath === exposePath) {
return true;
}
// Then try path match without known extensions
const getPathWithoutKnownExt = filePath => {
const ext = path.extname(filePath);
return JS_EXTENSIONS.includes(ext) ? path.join(path.dirname(filePath), path.basename(filePath, ext)) : filePath;
};
const modulePathNoExt = getPathWithoutKnownExt(absoluteModulePath);
const exposePathNoExt = getPathWithoutKnownExt(exposePath);
return modulePathNoExt === exposePathNoExt;
});
});
// Process shared modules
const fileToShareKey = await buildFileToShareKeyMap(getUsedShares(), this.resolve.bind(this));
processModuleAssets(bundle, filesMap, modulePath => fileToShareKey.get(modulePath));
// Add all CSS assets to every export
addCssAssetsToAllExports(filesMap, allCssAssets);
// Final deduplication of all assets
filesMap = deduplicateAssets(filesMap);
this.emitFile({
type: 'asset',
fileName: mfManifestName,
source: JSON.stringify(generateMFManifest(filesMap))
});
}
}];
/**
* Generates the final manifest JSON structure
* @param preloadMap - Map of module assets to include
* @returns Complete manifest object
*/
function generateMFManifest(preloadMap) {
const options = getNormalizeModuleFederationOptions();
const {
name
} = options;
const remoteEntry = {
name: remoteEntryFile,
path: '',
type: 'module'
};
// Process remotes
const remotes = Array.from(Object.entries(getUsedRemotesMap())).flatMap(([remoteKey, modules]) => Array.from(modules).map(moduleKey => ({
federationContainerName: options.remotes[remoteKey].entry,
moduleName: moduleKey.replace(remoteKey, '').replace('/', ''),
alias: remoteKey,
entry: '*'
})));
// Process shared dependencies
const shared = Array.from(getUsedShares()).map(shareKey => {
const shareItem = getNormalizeShareItem(shareKey);
const assets = preloadMap[shareKey] || createEmptyAssetMap();
return {
id: `${name}:${shareKey}`,
name: shareKey,
version: shareItem.version,
requiredVersion: shareItem.shareConfig.requiredVersion,
assets: {
js: {
async: assets.js.async,
sync: assets.js.sync
},
css: {
async: assets.css.async,
sync: assets.css.sync
}
}
};
}).filter(Boolean);
// Process exposed modules
const exposes = Object.entries(options.exposes).map(([key, value]) => {
const formatKey = key.replace('./', '');
const sourceFile = value.import;
const assets = preloadMap[sourceFile] || createEmptyAssetMap();
return {
id: `${name}:${formatKey}`,
name: formatKey,
assets: {
js: {
async: assets.js.async,
sync: assets.js.sync
},
css: {
async: assets.css.async,
sync: assets.css.sync
}
},
path: key
};
}).filter(Boolean);
return {
id: name,
name,
metaData: _extends({
name,
type: 'app',
buildInfo: {
buildVersion: '1.0.0',
buildName: name
},
remoteEntry,
ssrRemoteEntry: remoteEntry,
types: {
path: '',
name: ''
},
globalName: name,
pluginVersion: '0.2.5'
}, !!getPublicPath ? {
getPublicPath
} : {
publicPath
}),
shared,
remotes,
exposes
};
}
};
let _resolve,
promise = new Promise((resolve, reject) => {
_resolve = resolve;
});
let parsePromise = promise;
let exposesParseEnd = false;
const parseStartSet = new Set();
const parseEndSet = new Set();
function pluginModuleParseEnd (excludeFn) {
return [{
name: '_',
apply: 'serve',
config() {
// No waiting in development mode
_resolve(1);
}
}, {
enforce: 'pre',
name: 'parseStart',
apply: 'build',
load(id) {
if (excludeFn(id)) {
return;
}
parseStartSet.add(id);
}
}, {
enforce: 'post',
name: 'parseEnd',
apply: 'build',
moduleParsed(module) {
const id = module.id;
if (id === VIRTUAL_EXPOSES) {
// When the entry JS file is empty and only contains exposes export code, it’s necessary to wait for the exposes modules to be resolved in order to collect the dependencies being used.
exposesParseEnd = true;
}
if (excludeFn(id)) {
return;
}
parseEndSet.add(id);
if (exposesParseEnd && parseStartSet.size === parseEndSet.size) {
_resolve(1);
}
}
}];
}
const filter = createFilter();
function pluginProxyRemoteEntry () {
let viteConfig, _command;
return {
name: 'proxyRemoteEntry',
enforce: 'post',
configResolved(config) {
viteConfig = config;
},
config(config, {
command
}) {
_command = command;
},
resolveId(id) {
if (id === REMOTE_ENTRY_ID) {
return REMOTE_ENTRY_ID;
}
if (id === VIRTUAL_EXPOSES) {
return VIRTUAL_EXPOSES;
}
if (_command === 'serve' && id.includes(getHostAutoInitPath())) {
return id;
}
},
load(id) {
if (id === REMOTE_ENTRY_ID) {
return parsePromise.then(_ => generateRemoteEntry(getNormalizeModuleFederationOptions()));
}
if (id === VIRTUAL_EXPOSES) {
return generateExposes();
}
if (_command === 'serve' && id.includes(getHostAutoInitPath())) {
return id;
}
},
async transform(code, id) {
if (!filter(id)) return;
if (id.includes(REMOTE_ENTRY_ID)) {
return parsePromise.then(_ => generateRemoteEntry(getNormalizeModuleFederationOptions()));
}
if (id === VIRTUAL_EXPOSES) {
return generateExposes();
}
if (id.includes(getHostAutoInitPath())) {
const options = getNormalizeModuleFederationOptions();
if (_command === 'serve') {
var _viteConfig$server, _viteConfig$server2;
const host = typeof ((_viteConfig$server = viteConfig.server) == null ? void 0 : _viteConfig$server.host) === 'string' && viteConfig.server.host !== '0.0.0.0' ? viteConfig.server.host : 'localhost';
const publicPath = JSON.stringify(resolvePublicPath(options, viteConfig.base) + options.filename);
return `
const origin = (window && ${!options.ignoreOrigin}) ? window.origin : "//${host}:${(_viteConfig$server2 = viteConfig.server) == null ? void 0 : _viteConfig$server2.port}"
const remoteEntryPromise = await import(origin + ${publicPath})
// __tla only serves as a hack for vite-plugin-top-level-await.
Promise.resolve(remoteEntryPromise)
.then(remoteEntry => {
return Promise.resolve(remoteEntry.__tla)
.then(remoteEntry.init).catch(remoteEntry.init)
})
`;
}
return code;
}
}
};
}
createFilter();
function pluginProxyRemotes (options) {
const {
remotes
} = options;
return {
name: 'proxyRemotes',
config(config, {
command: _command
}) {
Object.keys(remotes).forEach(key => {
const remote = remotes[key];
config.resolve.alias.push({
find: new RegExp(`^(${remote.name}(\/.*|$))`),
replacement: '$1',
customResolver(source) {
const remoteModule = getRemoteVirtualModule(source, _command);
addUsedRemote(remote.name, source);
return remoteModule.getPath();
}
});
});
}
};
}
/**
* example:
* const store = new PromiseStore<number>();
* store.get("example").then((result) => {
* console.log("Result from example:", result); // 42
* });
* setTimeout(() => {
* store.set("example", Promise.resolve(42));
* }, 2000);
*/
class PromiseStore {
constructor() {
this.promiseMap = new Map();
this.resolveMap = new Map();
}
set(id, promise) {
if (this.resolveMap.has(id)) {
promise.then(this.resolveMap.get(id));
this.resolveMap.delete(id);
}
this.promiseMap.set(id, promise);
}
get(id) {
if (this.promiseMap.has(id)) {
return this.promiseMap.get(id);
}
const pendingPromise = new Promise(resolve => {
this.resolveMap.set(id, resolve);
});
this.promiseMap.set(id, pendingPromise);
return pendingPromise;
}
}
function proxySharedModule(options) {
let {
shared = {},
include,
exclude
} = options;
let _config;
return [{
name: 'generateLocalSharedImportMap',
enforce: 'post',
load(id) {
if (id.includes(getLocalSharedImportMapPath())) {
return parsePromise.then(_ => generateLocalSharedImportMap());
}
},
transform(code, id) {
if (id.includes(getLocalSharedImportMapPath())) {
return parsePromise.then(_ => generateLocalSharedImportMap());
}
}
}, {
name: 'proxyPreBuildShared',
enforce: 'post',
configResolved(config) {
_config = config;
},
config(config, {
command
}) {
config.resolve.alias.push(...Object.keys(shared).map(key => {
const pattern = key.endsWith('/') ? `(^${key.replace(/\/$/, '')}(\/.+)?$)` : `(^${key}$)`;
return {
// Intercept all shared requests and proxy them to loadShare
find: new RegExp(pattern),
replacement: '$1',
customResolver(source, importer) {
if (/\.css$/.test(source)) return;
const loadSharePath = getLoadShareModulePath(source);
writeLoadShareModule(source, shared[key], command);
writePreBuildLibPath(source);
addUsedShares(source);
writeLocalSharedImportMap();
return this.resolve(loadSharePath, importer);
}
};
}));
const savePrebuild = new PromiseStore();
config.resolve.alias.push(...Object.keys(shared).map(key => {
return command === 'build' ? {
find: new RegExp(`(.*${PREBUILD_TAG}.*)`),
replacement: function ($1) {
const module = assertModuleFound(PREBUILD_TAG, $1);
const pkgName = module.name;
return pkgName;
}
} : {
find: new RegExp(`(.*${PREBUILD_TAG}.*)`),
replacement: '$1',
async customResolver(source, importer) {
const module = assertModuleFound(PREBUILD_TAG, source);
const pkgName = module.name;
const result = await this.resolve(pkgName, importer).then(it