Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/tidy-cats-optimize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@module-federation/modern-js": patch
"@module-federation/modern-js-v3": patch
---

Automatically select federation optimization targets for Modern.js browser and
SSR builds, with an option to disable this behavior.
57 changes: 56 additions & 1 deletion packages/modernjs-v3/src/cli/configPlugin.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { it, expect, describe, rs, afterEach } from '@rstest/core';
import { moduleFederationConfigPlugin, patchMFConfig } from './configPlugin';
import {
moduleFederationConfigPlugin,
patchMFConfig,
setDefaultOptimizationTarget,
} from './configPlugin';
import logger from '../logger';

const mfConfig = {
Expand Down Expand Up @@ -110,6 +114,57 @@ describe('patchMFConfig', async () => {
});
});

describe('setDefaultOptimizationTarget', () => {
it('defaults to web when SSR is disabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, false, false);

expect(config).toMatchObject({
experiments: { optimization: { target: 'web' } },
});
});

it('defaults to web for the browser target when SSR is enabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, false);

expect(config).toMatchObject({
experiments: { optimization: { target: 'web' } },
});
});

it('defaults to node for the server target when SSR is enabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, true);

expect(config).toMatchObject({
experiments: { optimization: { target: 'node' } },
});
});

it('preserves an explicitly configured target', () => {
const config = {
name: 'host',
experiments: { optimization: { target: 'web' as const } },
};

setDefaultOptimizationTarget(config, true, true);

expect(config.experiments.optimization.target).toBe('web');
});

it('does not set a target when autoOptimization is disabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, true, false);

expect(config).toStrictEqual({ name: 'host' });
});
});

describe('moduleFederationConfigPlugin', async () => {
it('disables lazyCompilation when the project is a producer', async () => {
const warnSpy = rs.spyOn(logger, 'warn').mockImplementation(() => {});
Expand Down
22 changes: 22 additions & 0 deletions packages/modernjs-v3/src/cli/configPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,22 @@ export const patchMFConfig = (
return mfConfig;
};

export const setDefaultOptimizationTarget = (
mfConfig: moduleFederationPlugin.ModuleFederationPluginOptions,
enableSSR: boolean,
isServer: boolean,
autoOptimization = true,
) => {
if (!autoOptimization) {
return;
}

mfConfig.experiments ||= {};
mfConfig.experiments.optimization ||= {};
mfConfig.experiments.optimization.target ??=
enableSSR && isServer ? 'node' : 'web';
};

function patchIgnoreWarning(chain: BundlerChainConfig) {
const ignoreWarnings = chain.get('ignoreWarnings') || [];
const ignoredMsgs = [
Expand Down Expand Up @@ -404,6 +420,12 @@ export const moduleFederationConfigPlugin = (
addMyTypes2Ignored(chain, !isWeb ? ssrConfig : csrConfig);

const targetMFConfig = !isWeb ? ssrConfig : csrConfig;
setDefaultOptimizationTarget(
targetMFConfig,
enableSSR,
!isWeb,
userConfig.originPluginOptions.autoOptimization,
);
patchMFConfig(targetMFConfig, !isWeb);

if (
Expand Down
6 changes: 6 additions & 0 deletions packages/modernjs-v3/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ import type { StatsAssetResource } from '@module-federation/rsbuild-plugin/utils
export interface PluginOptions {
config?: moduleFederationPlugin.ModuleFederationPluginOptions;
configPath?: string;
/**
* Automatically set the federation optimization target from the Modern.js
* SSR and bundler target configuration.
* @default true
*/
autoOptimization?: boolean;
ssr?:
| {
distOutputDir?: string;
Expand Down
53 changes: 52 additions & 1 deletion packages/modernjs/src/cli/configPlugin.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { it, expect, describe } from '@rstest/core';
import { patchMFConfig } from './configPlugin';
import { patchMFConfig, setDefaultOptimizationTarget } from './configPlugin';
import { getIPV4 } from './utils';

const mfConfig = {
Expand Down Expand Up @@ -80,3 +80,54 @@ describe('patchMFConfig', async () => {
});
});
});

describe('setDefaultOptimizationTarget', () => {
it('defaults to web when SSR is disabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, false, false);

expect(config).toMatchObject({
experiments: { optimization: { target: 'web' } },
});
});

it('defaults to web for the browser target when SSR is enabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, false);

expect(config).toMatchObject({
experiments: { optimization: { target: 'web' } },
});
});

it('defaults to node for the server target when SSR is enabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, true);

expect(config).toMatchObject({
experiments: { optimization: { target: 'node' } },
});
});

it('preserves an explicitly configured target', () => {
const config = {
name: 'host',
experiments: { optimization: { target: 'web' as const } },
};

setDefaultOptimizationTarget(config, true, true);

expect(config.experiments.optimization.target).toBe('web');
});

it('does not set a target when autoOptimization is disabled', () => {
const config = { name: 'host' };

setDefaultOptimizationTarget(config, true, true, false);

expect(config).toStrictEqual({ name: 'host' });
});
});
22 changes: 22 additions & 0 deletions packages/modernjs/src/cli/configPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,22 @@ export const patchMFConfig = (
return mfConfig;
};

export const setDefaultOptimizationTarget = (
mfConfig: moduleFederationPlugin.ModuleFederationPluginOptions,
enableSSR: boolean,
isServer: boolean,
autoOptimization = true,
) => {
if (!autoOptimization) {
return;
}

mfConfig.experiments ||= {};
mfConfig.experiments.optimization ||= {};
mfConfig.experiments.optimization.target ??=
enableSSR && isServer ? 'node' : 'web';
};

function patchIgnoreWarning(chain: BundlerChainConfig) {
const ignoreWarnings = chain.get('ignoreWarnings') || [];
const ignoredMsgs = [
Expand Down Expand Up @@ -414,6 +430,12 @@ export const moduleFederationConfigPlugin = (
addMyTypes2Ignored(chain, !isWeb ? ssrConfig : csrConfig);

const targetMFConfig = !isWeb ? ssrConfig : csrConfig;
setDefaultOptimizationTarget(
targetMFConfig,
enableSSR,
!isWeb,
userConfig.originPluginOptions.autoOptimization,
);
patchMFConfig(targetMFConfig, !isWeb);

if (
Expand Down
6 changes: 6 additions & 0 deletions packages/modernjs/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ import type { StatsAssetResource } from '@module-federation/rsbuild-plugin/utils
export interface PluginOptions {
config?: moduleFederationPlugin.ModuleFederationPluginOptions;
configPath?: string;
/**
* Automatically set the federation optimization target from the Modern.js
* SSR and bundler target configuration.
* @default true
*/
autoOptimization?: boolean;
ssr?:
| {
distOutputDir?: string;
Expand Down
Loading