Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(module-federation): handle parsing static remote config correctly #30168

Merged
merged 1 commit into from
Feb 25, 2025
Merged

fix(module-federation): handle parsing static remote config correctly #30168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
299 changes: 299 additions & 0 deletions packages/module-federation/src/utils/parse-static-remotes-config.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
import {
parseStaticRemotesConfig,
parseStaticSsrRemotesConfig,
} from './parse-static-remotes-config';

describe('parseStaticRemotesConfig', () => {
it('should parse static remotes config', () => {
const staticRemotes = ['remote1', 'remote2'];
const context = {
projectGraph: {
nodes: {
remote1: {
data: {
targets: {
build: {
options: {
outputPath: 'dist/remote1',
},
},
serve: {
options: {
port: 4200,
},
},
},
},
},
remote2: {
data: {
targets: {
build: {
options: {
outputPath: 'dist/remote2',
},
},
serve: {
options: {
port: 4201,
},
},
},
},
},
},
},
};
expect(parseStaticRemotesConfig(staticRemotes, context as any)).toEqual({
remotes: ['remote1', 'remote2'],
config: {
remote1: {
basePath: 'dist',
outputPath: 'dist/remote1',
urlSegment: 'remote1',
port: 4200,
},
remote2: {
basePath: 'dist',
outputPath: 'dist/remote2',
urlSegment: 'remote2',
port: 4201,
},
},
});
});
it('should parse static remotes config when dist in project root', () => {
const staticRemotes = ['remote1', 'remote2'];
const context = {
projectGraph: {
nodes: {
remote1: {
data: {
targets: {
build: {
options: {
outputPath: 'apps/remote1/dist',
},
},
serve: {
options: {
port: 4200,
},
},
},
},
},
remote2: {
data: {
targets: {
build: {
options: {
outputPath: 'apps/remote2/dist',
},
},
serve: {
options: {
port: 4201,
},
},
},
},
},
},
},
};
expect(parseStaticRemotesConfig(staticRemotes, context as any)).toEqual({
remotes: ['remote1', 'remote2'],
config: {
remote1: {
basePath: 'apps/remote1',
outputPath: 'apps/remote1/dist',
urlSegment: 'remote1',
port: 4200,
},
remote2: {
basePath: 'apps/remote2',
outputPath: 'apps/remote2/dist',
urlSegment: 'remote2',
port: 4201,
},
},
});
});
it('should parse static remotes config when dist is root and different name', () => {
const staticRemotes = ['remote1', 'remote2'];
const context = {
projectGraph: {
nodes: {
remote1: {
data: {
targets: {
build: {
options: {
outputPath: 'build',
},
},
serve: {
options: {
port: 4200,
},
},
},
},
},
remote2: {
data: {
targets: {
build: {
options: {
outputPath: 'dist',
},
},
serve: {
options: {
port: 4201,
},
},
},
},
},
},
},
};
expect(parseStaticRemotesConfig(staticRemotes, context as any)).toEqual({
remotes: ['remote1', 'remote2'],
config: {
remote1: {
basePath: 'build',
outputPath: 'build',
urlSegment: 'remote1',
port: 4200,
},
remote2: {
basePath: 'dist',
outputPath: 'dist',
urlSegment: 'remote2',
port: 4201,
},
},
});
});

it('should parse ssr static remotes config', () => {
const staticRemotes = ['remote1', 'remote2'];
const context = {
projectGraph: {
nodes: {
remote1: {
data: {
targets: {
build: {
options: {
outputPath: 'dist/remote1/browser',
},
},
serve: {
options: {
port: 4200,
},
},
},
},
},
remote2: {
data: {
targets: {
build: {
options: {
outputPath: 'dist/remote2/browser',
},
},
serve: {
options: {
port: 4201,
},
},
},
},
},
},
},
};
expect(parseStaticSsrRemotesConfig(staticRemotes, context as any)).toEqual({
remotes: ['remote1', 'remote2'],
config: {
remote1: {
basePath: 'dist',
outputPath: 'dist/remote1',
urlSegment: 'remote1',
port: 4200,
},
remote2: {
basePath: 'dist',
outputPath: 'dist/remote2',
urlSegment: 'remote2',
port: 4201,
},
},
});
});

it('should parse ssr static remotes config when dist in project root', () => {
const staticRemotes = ['remote1', 'remote2'];
const context = {
projectGraph: {
nodes: {
remote1: {
data: {
targets: {
build: {
options: {
outputPath: 'apps/remote1/dist/browser',
},
},
serve: {
options: {
port: 4200,
},
},
},
},
},
remote2: {
data: {
targets: {
build: {
options: {
outputPath: 'apps/remote2/dist/browser',
},
},
serve: {
options: {
port: 4201,
},
},
},
},
},
},
},
};
expect(parseStaticSsrRemotesConfig(staticRemotes, context as any)).toEqual({
remotes: ['remote1', 'remote2'],
config: {
remote1: {
basePath: 'apps/remote1',
outputPath: 'apps/remote1/dist',
urlSegment: 'remote1',
port: 4200,
},
remote2: {
basePath: 'apps/remote2',
outputPath: 'apps/remote2/dist',
urlSegment: 'remote2',
port: 4201,
},
},
});
});
});
21 changes: 13 additions & 8 deletions packages/module-federation/src/utils/parse-static-remotes-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ export function parseStaticRemotesConfig(
const config: Record<string, StaticRemoteConfig> = {};
for (const app of staticRemotes) {
const outputPath =
context.projectGraph.nodes[app].data.targets['build'].options.outputPath;
const basePath = dirname(outputPath);
const urlSegment = basename(outputPath);
context.projectGraph.nodes[app].data.targets['build'].options.outputPath; // dist || dist/checkout
const basePath = ['', '/', '.'].some((p) => dirname(outputPath) === p)
? outputPath
: dirname(outputPath); // dist || dist/checkout -> dist
const urlSegment = app;
const port =
context.projectGraph.nodes[app].data.targets['serve'].options.port;
config[app] = { basePath, outputPath, urlSegment, port };
Expand All @@ -43,11 +45,14 @@ export function parseStaticSsrRemotesConfig(
}
const config: Record<string, StaticRemoteConfig> = {};
for (const app of staticRemotes) {
const outputPath = dirname(
context.projectGraph.nodes[app].data.targets['build'].options.outputPath // dist/checkout/browser -> checkout
) as string;
const basePath = dirname(outputPath); // dist/checkout -> dist
const urlSegment = basename(outputPath); // dist/checkout -> checkout
let outputPath = context.projectGraph.nodes[app].data.targets['build']
.options.outputPath as string;
outputPath = dirname(outputPath); // dist/browser => dist || dist/checkout/browser -> checkout

const basePath = ['', '/', '.'].some((p) => dirname(outputPath) === p)
? outputPath
: dirname(outputPath); // dist || dist/checkout -> dist
const urlSegment = app;
const port =
context.projectGraph.nodes[app].data.targets['serve'].options.port;
config[app] = { basePath, outputPath, urlSegment, port };
Expand Down