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

feat(react): refactor util getModuleFederationConfig to avoid to pass function to determinate the remote url #16488

Merged
merged 5 commits into from
Apr 27, 2023
Merged

feat(react): refactor util getModuleFederationConfig to avoid to pass function to determinate the remote url #16488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4bab9bd
feat(react): refactor util `getModuleFederationConfig` to avoid to pa…
fyodorovandrei Apr 23, 2023
a70aeb2
feat(react): provide default function for `determineRemoteUrl` instea…
fyodorovandrei Apr 26, 2023
e70edd6
Merge branch 'master' of https://github.com/nrwl/nx into features/ref…
fyodorovandrei Apr 27, 2023
2d89603
fix(core): run prettier to fix code style issues
fyodorovandrei Apr 27, 2023
72fbdf1
feat(angular): ensure consistency with MF utils across frameworks
Coly010 Apr 27, 2023
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
35 changes: 32 additions & 3 deletions packages/angular/src/utils/mf/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
ProjectGraph,
readCachedProjectGraph,
} from '@nx/devkit';
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';

export function applyDefaultEagerPackages(
sharedConfig: Record<string, SharedLibraryConfig>
Expand Down Expand Up @@ -42,10 +43,35 @@ export const DEFAULT_ANGULAR_PACKAGES_TO_SHARE = [
'@angular/common',
];

export function getFunctionDeterminateRemoteUrl(isServer: boolean = false) {
const target = 'serve';
const remoteEntry = isServer ? 'server/remoteEntry.js' : 'remoteEntry.mjs';

return function (remote: string) {
const remoteConfiguration = readCachedProjectConfiguration(remote);
const serveTarget = remoteConfiguration?.targets?.[target];

if (!serveTarget) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "host" in the project's "serve" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}

const host = serveTarget.options?.host ?? 'http://localhost';
const port = serveTarget.options?.port ?? 4201;
return `${
host.endsWith('/') ? host.slice(0, -1) : host
}:${port}/${remoteEntry}`;
};
}

export async function getModuleFederationConfig(
mfConfig: ModuleFederationConfig,
determineRemoteUrl: (remote: string) => string,
options: { isServer: boolean } = { isServer: false }
options: {
isServer: boolean;
determineRemoteUrl?: (remote: string) => string;
} = { isServer: false }
) {
let projectGraph: ProjectGraph;
try {
Expand Down Expand Up @@ -107,11 +133,14 @@ export async function getModuleFederationConfig(
mfConfig.additionalShared,
projectGraph
);
const determineRemoteUrlFn =
options.determineRemoteUrl ||
getFunctionDeterminateRemoteUrl(options.isServer);

const mapRemotesFunction = options.isServer ? mapRemotesForSSR : mapRemotes;
const mappedRemotes =
!mfConfig.remotes || mfConfig.remotes.length === 0
? {}
: mapRemotesFunction(mfConfig.remotes, 'mjs', determineRemoteUrl);
: mapRemotesFunction(mfConfig.remotes, 'mjs', determineRemoteUrlFn);
return { sharedLibraries, sharedDependencies, mappedRemotes };
}
19 changes: 1 addition & 18 deletions packages/angular/src/utils/mf/with-module-federation-ssr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,11 @@
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
import { ModuleFederationConfig } from '@nx/devkit/src/utils/module-federation';
import { getModuleFederationConfig } from './utils';

function determineRemoteUrl(remote: string) {
const remoteProjectConfiguration = readCachedProjectConfiguration(remote);
let publicHost = '';
try {
publicHost = remoteProjectConfiguration.targets.serve.options.publicHost;
} catch (error) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "publicHost" in the project's "serve" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}
return `${
publicHost.endsWith('/') ? publicHost.slice(0, -1) : publicHost
}/server/remoteEntry.js`;
}

export async function withModuleFederationForSSR(
options: ModuleFederationConfig
) {
const { sharedLibraries, sharedDependencies, mappedRemotes } =
await getModuleFederationConfig(options, determineRemoteUrl, {
await getModuleFederationConfig(options, {
isServer: true,
});

Expand Down
19 changes: 1 addition & 18 deletions packages/angular/src/utils/mf/with-module-federation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,10 @@
import { ModuleFederationConfig } from '@nx/devkit/src/utils/module-federation';
import { getModuleFederationConfig } from './utils';
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
import ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');

function determineRemoteUrl(remote: string) {
const remoteProjectConfiguration = readCachedProjectConfiguration(remote);
let publicHost = '';
try {
publicHost = remoteProjectConfiguration.targets.serve.options.publicHost;
} catch (error) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "publicHost" in the project's "serve" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}
return `${
publicHost.endsWith('/') ? publicHost.slice(0, -1) : publicHost
}/remoteEntry.mjs`;
}

export async function withModuleFederation(options: ModuleFederationConfig) {
const { sharedLibraries, sharedDependencies, mappedRemotes } =
await getModuleFederationConfig(options, determineRemoteUrl);
await getModuleFederationConfig(options);

return (config) => ({
...(config ?? {}),
Expand Down
35 changes: 32 additions & 3 deletions packages/react/src/module-federation/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,37 @@ import {
ProjectGraph,
readCachedProjectGraph,
} from '@nx/devkit';
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';

export function getFunctionDeterminateRemoteUrl(isServer: boolean = false) {
const target = isServer ? 'serve-server' : 'serve';
const remoteEntry = isServer ? 'server/remoteEntry.js' : 'remoteEntry.js';

return function (remote: string) {
const remoteConfiguration = readCachedProjectConfiguration(remote);
const serveTarget = remoteConfiguration?.targets?.[target];

if (!serveTarget) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "host" in the project's "${serveTarget}" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}

const host = serveTarget.options?.host ?? 'http://localhost';
const port = serveTarget.options?.port ?? 4201;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about using/creating a similar function to the findNextAvailablePort to prevent local port collisions?

return `${
host.endsWith('/') ? host.slice(0, -1) : host
}:${port}/${remoteEntry}`;
};
}

export async function getModuleFederationConfig(
mfConfig: ModuleFederationConfig,
determineRemoteUrl: (remote: string) => string,
options: { isServer: boolean } = { isServer: false }
options: {
isServer: boolean;
determineRemoteUrl?: (remote: string) => string;
} = { isServer: false }
) {
let projectGraph: ProjectGraph;
try {
Expand Down Expand Up @@ -68,10 +94,13 @@ export async function getModuleFederationConfig(
);

const mapRemotesFunction = options.isServer ? mapRemotesForSSR : mapRemotes;
const determineRemoteUrlFn =
options.determineRemoteUrl ||
getFunctionDeterminateRemoteUrl(options.isServer);
const mappedRemotes =
!mfConfig.remotes || mfConfig.remotes.length === 0
? {}
: mapRemotesFunction(mfConfig.remotes, 'js', determineRemoteUrl);
: mapRemotesFunction(mfConfig.remotes, 'js', determineRemoteUrlFn);

return { sharedLibraries, sharedDependencies, mappedRemotes };
}
21 changes: 1 addition & 20 deletions packages/react/src/module-federation/with-module-federation-ssr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,13 @@
import { ModuleFederationConfig } from '@nx/devkit/src/utils/module-federation';
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
import { getModuleFederationConfig } from './utils';

function determineRemoteUrl(remote: string) {
const remoteConfiguration = readCachedProjectConfiguration(remote);
const serveTarget = remoteConfiguration?.targets?.['serve-server'];

if (!serveTarget) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "host" in the project's "serve-server" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}

const host = serveTarget.options?.host ?? 'http://localhost';
const port = serveTarget.options?.port ?? 4201;
return `${
host.endsWith('/') ? host.slice(0, -1) : host
}:${port}/server/remoteEntry.js`;
}

export async function withModuleFederationForSSR(
options: ModuleFederationConfig
) {
const reactWebpackConfig = require('../../plugins/webpack');

const { sharedLibraries, sharedDependencies, mappedRemotes } =
await getModuleFederationConfig(options, determineRemoteUrl, {
await getModuleFederationConfig(options, {
isServer: true,
});

Expand Down
21 changes: 1 addition & 20 deletions packages/react/src/module-federation/with-module-federation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,8 @@
import { ModuleFederationConfig } from '@nx/devkit/src/utils/module-federation';
import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
import { getModuleFederationConfig } from './utils';
import type { AsyncNxWebpackPlugin } from '@nx/webpack';
import ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');

function determineRemoteUrl(remote: string) {
const remoteConfiguration = readCachedProjectConfiguration(remote);
const serveTarget = remoteConfiguration?.targets?.serve;

if (!serveTarget) {
throw new Error(
`Cannot automatically determine URL of remote (${remote}). Looked for property "host" in the project's "serve" target.\n
You can also use the tuple syntax in your webpack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``
);
}

const host = serveTarget.options?.host ?? 'http://localhost';
const port = serveTarget.options?.port ?? 4201;
return `${
host.endsWith('/') ? host.slice(0, -1) : host
}:${port}/remoteEntry.js`;
}

/**
* @param {ModuleFederationConfig} options
* @return {Promise<AsyncNxWebpackPlugin>}
Expand All @@ -32,7 +13,7 @@ export async function withModuleFederation(
const reactWebpackConfig = require('../../plugins/webpack');

const { sharedDependencies, sharedLibraries, mappedRemotes } =
await getModuleFederationConfig(options, determineRemoteUrl);
await getModuleFederationConfig(options);

return (config, ctx) => {
config = reactWebpackConfig(config, ctx);
Expand Down