@nx/module-federation 0.0.0-pr-29047-57d3073 → 0.0.0-pr-28808-eac89e6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nx/module-federation",
   "description": "The Nx Plugin for Module Federation contains executors and utilities that support building applications using Module Federation.",
-  "version": "0.0.0-pr-29047-57d3073",
+  "version": "0.0.0-pr-28808-eac89e6",
   "type": "commonjs",
   "repository": {
     "type": "git",
@@ -25,11 +25,11 @@
   "executors": "./executors.json",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "0.0.0-pr-29047-57d3073",
-    "@nx/js": "0.0.0-pr-29047-57d3073",
+    "@nx/devkit": "0.0.0-pr-28808-eac89e6",
+    "@nx/js": "0.0.0-pr-28808-eac89e6",
     "picocolors": "^1.1.0",
     "webpack": "5.88.0",
-    "@rspack/core": "1.1.2",
+    "@rspack/core": "1.1.3",
     "@module-federation/enhanced": "0.7.6",
     "@module-federation/node": "2.6.11",
     "@module-federation/sdk": "0.7.6",

package/rspack.d.ts

@@ -0,0 +1,2 @@
+export * from './src/with-module-federation/rspack/with-module-federation';
+export * from './src/with-module-federation/rspack/with-module-federation-ssr';

package/rspack.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./src/with-module-federation/rspack/with-module-federation"), exports);
+tslib_1.__exportStar(require("./src/with-module-federation/rspack/with-module-federation-ssr"), exports);

package/src/with-module-federation/rspack/utils.d.ts

@@ -0,0 +1,12 @@
+import { ModuleFederationConfig } from '../../utils';
+export declare function getFunctionDeterminateRemoteUrl(isServer?: boolean): (remote: string) => string;
+export declare function getModuleFederationConfig(mfConfig: ModuleFederationConfig, options?: {
+    isServer: boolean;
+    determineRemoteUrl?: (remote: string) => string;
+}): Promise<{
+    sharedLibraries: import("../../utils").SharedWorkspaceLibraryConfig;
+    sharedDependencies: {
+        [x: string]: import("../../utils").SharedLibraryConfig;
+    };
+    mappedRemotes: {};
+}>;

package/src/with-module-federation/rspack/utils.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFunctionDeterminateRemoteUrl = getFunctionDeterminateRemoteUrl;
+exports.getModuleFederationConfig = getModuleFederationConfig;
+const devkit_1 = require("@nx/devkit");
+const project_graph_1 = require("nx/src/project-graph/project-graph");
+const utils_1 = require("../../utils");
+function getFunctionDeterminateRemoteUrl(isServer = false) {
+    const target = 'serve';
+    const remoteEntry = isServer ? 'server/remoteEntry.js' : 'remoteEntry.js';
+    return function (remote) {
+        const mappedStaticRemotesFromEnv = process.env
+            .NX_MF_DEV_SERVER_STATIC_REMOTES
+            ? JSON.parse(process.env.NX_MF_DEV_SERVER_STATIC_REMOTES)
+            : undefined;
+        if (mappedStaticRemotesFromEnv && mappedStaticRemotesFromEnv[remote]) {
+            return `${mappedStaticRemotesFromEnv[remote]}/${remoteEntry}`;
+        }
+        let remoteConfiguration = null;
+        try {
+            remoteConfiguration = (0, project_graph_1.readCachedProjectConfiguration)(remote);
+        }
+        catch (e) {
+            throw new Error(`Cannot find remote: "${remote}". Check that the remote name is correct in your module federation config file.\n`);
+        }
+        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 rspack config to configure your remotes. e.g. \`remotes: [['remote1', 'http://localhost:4201']]\``);
+        }
+        const host = serveTarget.options?.host ??
+            `http${serveTarget.options.ssl ? 's' : ''}://localhost`;
+        const port = serveTarget.options?.port ?? 4201;
+        return `${host.endsWith('/') ? host.slice(0, -1) : host}:${port}/${remoteEntry}`;
+    };
+}
+async function getModuleFederationConfig(mfConfig, options = { isServer: false }) {
+    let projectGraph;
+    try {
+        projectGraph = (0, devkit_1.readCachedProjectGraph)();
+    }
+    catch (e) {
+        projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    }
+    const project = projectGraph.nodes[mfConfig.name]?.data;
+    if (!project) {
+        throw Error(`Cannot find project "${mfConfig.name}". Check that the name is correct in module-federation.config.js`);
+    }
+    const dependencies = (0, utils_1.getDependentPackagesForProject)(projectGraph, mfConfig.name);
+    if (mfConfig.shared) {
+        dependencies.workspaceLibraries = dependencies.workspaceLibraries.filter((lib) => mfConfig.shared(lib.importKey, {}) !== false);
+        dependencies.npmPackages = dependencies.npmPackages.filter((pkg) => mfConfig.shared(pkg, {}) !== false);
+    }
+    const sharedLibraries = (0, utils_1.shareWorkspaceLibraries)(dependencies.workspaceLibraries);
+    const npmPackages = (0, utils_1.sharePackages)(dependencies.npmPackages);
+    const sharedDependencies = {
+        ...sharedLibraries.getLibraries(project.root),
+        ...npmPackages,
+    };
+    (0, utils_1.applySharedFunction)(sharedDependencies, mfConfig.shared);
+    (0, utils_1.applyAdditionalShared)(sharedDependencies, mfConfig.additionalShared, projectGraph);
+    // Choose the correct mapRemotes function based on the server state.
+    const mapRemotesFunction = options.isServer ? utils_1.mapRemotesForSSR : utils_1.mapRemotes;
+    // Determine the URL function, either from provided options or by using a default.
+    const determineRemoteUrlFunction = options.determineRemoteUrl
+        ? options.determineRemoteUrl
+        : getFunctionDeterminateRemoteUrl(options.isServer);
+    // Map the remotes if they exist, otherwise default to an empty object.
+    let mappedRemotes = {};
+    if (mfConfig.remotes && mfConfig.remotes.length > 0) {
+        mappedRemotes = mapRemotesFunction(mfConfig.remotes, 'js', determineRemoteUrlFunction, true);
+    }
+    return { sharedLibraries, sharedDependencies, mappedRemotes };
+}

package/src/with-module-federation/rspack/with-module-federation-ssr.d.ts

@@ -0,0 +1,4 @@
+import { ModuleFederationConfig, NxModuleFederationConfigOverride } from '../../utils';
+export declare function withModuleFederationForSSR(options: ModuleFederationConfig, configOverride?: NxModuleFederationConfigOverride): Promise<(config: any, { context }: {
+    context: any;
+}) => any>;

package/src/with-module-federation/rspack/with-module-federation-ssr.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withModuleFederationForSSR = withModuleFederationForSSR;
+const core_1 = require("@rspack/core");
+const utils_1 = require("./utils");
+async function withModuleFederationForSSR(options, configOverride) {
+    if (global.NX_GRAPH_CREATION) {
+        return (config) => config;
+    }
+    const { sharedLibraries, sharedDependencies, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options, {
+        isServer: true,
+    });
+    return (config, { context }) => {
+        config.target = 'async-node';
+        config.output.uniqueName = options.name;
+        config.output.library = {
+            type: 'commonjs-module',
+        };
+        config.optimization = {
+            ...(config.optimization ?? {}),
+            runtimeChunk: false,
+        };
+        config.plugins.push(
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        new (require('@module-federation/enhanced/rspack').ModuleFederationPlugin)({
+            name: options.name.replace(/-/g, '_'),
+            filename: 'remoteEntry.js',
+            exposes: options.exposes,
+            remotes: mappedRemotes,
+            shared: {
+                ...sharedDependencies,
+            },
+            isServer: true,
+            library: {
+                type: 'commonjs-module',
+            },
+            remoteType: 'script',
+            /**
+             * Apply user-defined config overrides
+             */
+            ...(configOverride ? configOverride : {}),
+            runtimePlugins: process.env.NX_MF_DEV_REMOTES &&
+                !options.disableNxRuntimeLibraryControlPlugin
+                ? [
+                    ...(configOverride?.runtimePlugins ?? []),
+                    require.resolve('@module-federation/node/runtimePlugin'),
+                    require.resolve('@nx/module-federation/src/utils/plugins/runtime-library-control.plugin.js'),
+                ]
+                : [
+                    ...(configOverride?.runtimePlugins ?? []),
+                    require.resolve('@module-federation/node/runtimePlugin'),
+                ],
+            virtualRuntimeEntry: true,
+        }, {}), sharedLibraries.getReplacementPlugin());
+        // The env var is only set from the module-federation-dev-server
+        // Attach the runtime plugin
+        config.plugins.push(new core_1.DefinePlugin({
+            'process.env.NX_MF_DEV_REMOTES': process.env.NX_MF_DEV_REMOTES,
+        }));
+        return config;
+    };
+}

package/src/with-module-federation/rspack/with-module-federation.d.ts

@@ -0,0 +1,9 @@
+import type { Configuration } from '@rspack/core';
+import { ModuleFederationConfig, NxModuleFederationConfigOverride } from '../../utils';
+/**
+ * @param {ModuleFederationConfig} options
+ * @param {NxModuleFederationConfigOverride} configOverride
+ */
+export declare function withModuleFederation(options: ModuleFederationConfig, configOverride?: NxModuleFederationConfigOverride): Promise<(config: Configuration, { context }: {
+    context: any;
+}) => Configuration>;

package/src/with-module-federation/rspack/with-module-federation.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withModuleFederation = withModuleFederation;
+const rspack_1 = require("@module-federation/enhanced/rspack");
+const core_1 = require("@rspack/core");
+const utils_1 = require("./utils");
+const isVarOrWindow = (libType) => libType === 'var' || libType === 'window';
+/**
+ * @param {ModuleFederationConfig} options
+ * @param {NxModuleFederationConfigOverride} configOverride
+ */
+async function withModuleFederation(options, configOverride) {
+    if (global.NX_GRAPH_CREATION) {
+        return function makeConfig(config) {
+            return config;
+        };
+    }
+    const { sharedDependencies, sharedLibraries, mappedRemotes } = await (0, utils_1.getModuleFederationConfig)(options);
+    const isGlobal = isVarOrWindow(options.library?.type);
+    return function makeConfig(config, { context }) {
+        config.output.uniqueName = options.name;
+        config.output.publicPath = 'auto';
+        if (isGlobal) {
+            config.output.scriptType = 'text/javascript';
+        }
+        config.optimization = {
+            ...(config.optimization ?? {}),
+            runtimeChunk: false,
+        };
+        if (config.mode === 'development' &&
+            Object.keys(mappedRemotes).length > 1 &&
+            !options.exposes) {
+            config.optimization.runtimeChunk = 'single';
+        }
+        config.plugins.push(new rspack_1.ModuleFederationPlugin({
+            name: options.name.replace(/-/g, '_'),
+            filename: 'remoteEntry.js',
+            exposes: options.exposes,
+            remotes: mappedRemotes,
+            shared: {
+                ...sharedDependencies,
+            },
+            /**
+             * remoteType: 'script' is required for the remote to be loaded as a script tag.
+             * remotes will need to be defined as:
+             *  { appX: 'appX@http://localhost:3001/remoteEntry.js' }
+             *  { appY: 'appY@http://localhost:3002/remoteEntry.js' }
+             */
+            ...(isGlobal ? { remoteType: 'script' } : {}),
+            /**
+             * Apply user-defined config overrides
+             */
+            ...(configOverride ? configOverride : {}),
+            runtimePlugins: process.env.NX_MF_DEV_REMOTES &&
+                !options.disableNxRuntimeLibraryControlPlugin
+                ? [
+                    ...(configOverride?.runtimePlugins ?? []),
+                    require.resolve('@nx/module-federation/src/utils/plugins/runtime-library-control.plugin.js'),
+                ]
+                : configOverride?.runtimePlugins,
+            virtualRuntimeEntry: true,
+        }), sharedLibraries.getReplacementPlugin());
+        // The env var is only set from the module-federation-dev-server
+        // Attach the runtime plugin
+        config.plugins.push(new core_1.DefinePlugin({
+            'process.env.NX_MF_DEV_REMOTES': process.env.NX_MF_DEV_REMOTES,
+        }));
+        return config;
+    };
+}