@nx/module-federation 20.2.0-beta.5 → 20.2.0-beta.7

package/README.md

@@ -25,6 +25,8 @@
 Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.
 
 This package is a [Module Federation plugin for Nx](https://nx.dev/nx-api/module-federation).
+Module Federation allows developers to share code between deployed applications easier and makes team collaboration more efficient.  
+To learn more about Module Federation, check out the [official documentation](https://module-federation.io/).
 
 ## Getting Started
 

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": "20.2.0-beta.5",
+  "version": "20.2.0-beta.7",
   "type": "commonjs",
   "repository": {
     "type": "git",
@@ -25,8 +25,9 @@
   "executors": "./executors.json",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "20.2.0-beta.5",
-    "@nx/js": "20.2.0-beta.5",
+    "@nx/devkit": "20.2.0-beta.7",
+    "@nx/js": "20.2.0-beta.7",
+    "@nx/web": "20.2.0-beta.7",
     "picocolors": "^1.1.0",
     "webpack": "5.88.0",
     "@rspack/core": "1.1.3",

package/src/executors/utils/build-static-remotes.d.ts

@@ -0,0 +1,4 @@
+import { ExecutorContext } from '@nx/devkit';
+import { type StaticRemotesConfig } from '../../utils';
+import { type BuildStaticRemotesOptions } from './models';
+export declare function buildStaticRemotes(staticRemotesConfig: StaticRemotesConfig, nxBin: any, context: ExecutorContext, options: BuildStaticRemotesOptions, buildTarget?: 'build' | 'server'): Promise<Record<string, string>>;

package/src/executors/utils/build-static-remotes.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildStaticRemotes = buildStaticRemotes;
+const devkit_1 = require("@nx/devkit");
+const node_child_process_1 = require("node:child_process");
+const path_1 = require("path");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
+const fs_1 = require("fs");
+async function buildStaticRemotes(staticRemotesConfig, nxBin, context, options, buildTarget = 'build') {
+    if (!staticRemotesConfig.remotes.length) {
+        return;
+    }
+    devkit_1.logger.info(`NX Building ${staticRemotesConfig.remotes.length} static remotes...`);
+    const mappedLocationOfRemotes = {};
+    for (const app of staticRemotesConfig.remotes) {
+        mappedLocationOfRemotes[app] = `http${options.ssl ? 's' : ''}://${options.host}:${options.staticRemotesPort}/${staticRemotesConfig.config[app].urlSegment}`;
+    }
+    await new Promise((res, rej) => {
+        const staticProcess = (0, node_child_process_1.fork)(nxBin, [
+            'run-many',
+            `--target=${buildTarget}`,
+            `--projects=${staticRemotesConfig.remotes.join(',')}`,
+            ...(context.configurationName
+                ? [`--configuration=${context.configurationName}`]
+                : []),
+            ...(options.parallel ? [`--parallel=${options.parallel}`] : []),
+        ], {
+            cwd: context.root,
+            stdio: ['ignore', 'pipe', 'pipe', 'ipc'],
+        });
+        // File to debug build failures e.g. 2024-01-01T00_00_0_0Z-build.log'
+        const remoteBuildLogFile = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `${new Date().toISOString().replace(/[:\.]/g, '_')}-build.log`);
+        const stdoutStream = (0, fs_1.createWriteStream)(remoteBuildLogFile);
+        staticProcess.stdout.on('data', (data) => {
+            const ANSII_CODE_REGEX = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g;
+            const stdoutString = data.toString().replace(ANSII_CODE_REGEX, '');
+            stdoutStream.write(stdoutString);
+            // in addition to writing into the stdout stream, also show error directly in console
+            // so the error is easily discoverable. 'ERROR in' is the key word to search in webpack output.
+            if (stdoutString.includes('ERROR in')) {
+                devkit_1.logger.log(stdoutString);
+            }
+            if (stdoutString.includes(`Successfully ran target ${buildTarget}`)) {
+                staticProcess.stdout.removeAllListeners('data');
+                devkit_1.logger.info(`NX Built ${staticRemotesConfig.remotes.length} static remotes`);
+                res();
+            }
+        });
+        staticProcess.stderr.on('data', (data) => devkit_1.logger.info(data.toString()));
+        staticProcess.once('exit', (code) => {
+            stdoutStream.end();
+            staticProcess.stdout.removeAllListeners('data');
+            staticProcess.stderr.removeAllListeners('data');
+            if (code !== 0) {
+                rej(`Remote failed to start. A complete log can be found in: ${remoteBuildLogFile}`);
+            }
+            else {
+                res();
+            }
+        });
+        process.on('SIGTERM', () => staticProcess.kill('SIGTERM'));
+        process.on('exit', () => staticProcess.kill('SIGTERM'));
+    });
+    return mappedLocationOfRemotes;
+}

package/src/executors/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './start-static-remotes-file-server';
+export * from './build-static-remotes';
+export * from './start-remote-iterators';
+export { DevRemoteDefinition } from './models';

package/src/executors/utils/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./start-static-remotes-file-server"), exports);
+tslib_1.__exportStar(require("./build-static-remotes"), exports);
+tslib_1.__exportStar(require("./start-remote-iterators"), exports);

package/src/executors/utils/models.d.ts

@@ -0,0 +1,30 @@
+import type { ProjectConfiguration, ExecutorContext } from '@nx/devkit';
+export type DevRemoteDefinition = string | {
+    remoteName: string;
+    configuration: string;
+};
+export type StartRemoteFn = (remotes: string[], workspaceProjects: Record<string, ProjectConfiguration>, options: {
+    devRemotes: DevRemoteDefinition[];
+    verbose: boolean;
+}, context: ExecutorContext, target: 'serve' | 'serve-static') => Promise<AsyncIterable<{
+    success: boolean;
+}>[]>;
+export interface StaticRemotesOptions {
+    staticRemotesPort?: number;
+    host?: string;
+    ssl?: boolean;
+    sslCert?: string;
+    sslKey?: string;
+}
+export interface BuildStaticRemotesOptions extends StaticRemotesOptions {
+    parallel?: number;
+}
+export interface StartRemoteIteratorsOptions extends BuildStaticRemotesOptions {
+    devRemotes: DevRemoteDefinition[];
+    skipRemotes?: string[];
+    buildTarget?: string;
+    liveReload?: boolean;
+    open?: boolean;
+    ssl?: boolean;
+    verbose: boolean;
+}

package/src/executors/utils/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/executors/utils/start-remote-iterators.d.ts

@@ -0,0 +1,25 @@
+import { StartRemoteFn, type StartRemoteIteratorsOptions } from './models';
+import { type ExecutorContext } from '@nx/devkit';
+export declare function startRemoteIterators(options: StartRemoteIteratorsOptions, context: ExecutorContext, startRemoteFn: StartRemoteFn, pathToManifestFile: string | undefined, pluginName?: 'react' | 'angular', isServer?: boolean): Promise<{
+    remotes: {
+        staticRemotes: string[];
+        devRemotes: any[];
+        dynamicRemotes: any[];
+        remotePorts: any[];
+        staticRemotePort: number;
+    };
+    devRemoteIters: AsyncIterable<{
+        success: boolean;
+    }>[];
+    staticRemotesIter: AsyncGenerator<{
+        success: boolean;
+        baseUrl: string;
+    }, {
+        success: boolean;
+    }, unknown> | AsyncGenerator<{
+        success: boolean;
+        baseUrl: string;
+    } | {
+        success: boolean;
+    }, void, unknown>;
+}>;

package/src/executors/utils/start-remote-iterators.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startRemoteIterators = startRemoteIterators;
+const utils_1 = require("../../utils");
+const build_static_remotes_1 = require("./build-static-remotes");
+const start_static_remotes_file_server_1 = require("./start-static-remotes-file-server");
+const devkit_1 = require("@nx/devkit");
+async function startRemoteIterators(options, context, startRemoteFn, pathToManifestFile, pluginName = 'react', isServer = false) {
+    const nxBin = require.resolve('nx/bin/nx');
+    const { projects: workspaceProjects } = (0, devkit_1.readProjectsConfigurationFromProjectGraph)(context.projectGraph);
+    const project = workspaceProjects[context.projectName];
+    const moduleFederationConfig = (0, utils_1.getModuleFederationConfig)(project.targets.build.options.tsConfig, context.root, project.root, pluginName);
+    const remoteNames = options.devRemotes.map((r) => typeof r === 'string' ? r : r.remoteName);
+    const remotes = (0, utils_1.getRemotes)(remoteNames, options.skipRemotes, moduleFederationConfig, {
+        projectName: project.name,
+        projectGraph: context.projectGraph,
+        root: context.root,
+    }, pathToManifestFile);
+    options.staticRemotesPort ??= remotes.staticRemotePort;
+    // Set NX_MF_DEV_REMOTES for the Nx Runtime Library Control Plugin
+    process.env.NX_MF_DEV_REMOTES = JSON.stringify([
+        ...(remotes.devRemotes.map((r) => typeof r === 'string' ? r : r.remoteName) ?? []).map((r) => r.replace(/-/g, '_')),
+        project.name.replace(/-/g, '_'),
+    ]);
+    const staticRemotesConfig = isServer
+        ? (0, utils_1.parseStaticSsrRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context)
+        : (0, utils_1.parseStaticRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context);
+    const mappedLocationsOfStaticRemotes = await (0, build_static_remotes_1.buildStaticRemotes)(staticRemotesConfig, nxBin, context, options, isServer ? 'server' : 'build');
+    const devRemoteIters = await startRemoteFn(remotes.devRemotes, workspaceProjects, options, context, 'serve');
+    const staticRemotesIter = isServer
+        ? (0, start_static_remotes_file_server_1.startSsrStaticRemotesFileServer)(staticRemotesConfig, context, options)
+        : (0, start_static_remotes_file_server_1.startStaticRemotesFileServer)(staticRemotesConfig, context, options);
+    isServer
+        ? (0, utils_1.startSsrRemoteProxies)(staticRemotesConfig, mappedLocationsOfStaticRemotes, options.ssl
+            ? {
+                pathToCert: options.sslCert,
+                pathToKey: options.sslKey,
+            }
+            : undefined)
+        : (0, utils_1.startRemoteProxies)(staticRemotesConfig, mappedLocationsOfStaticRemotes, options.ssl
+            ? {
+                pathToCert: options.sslCert,
+                pathToKey: options.sslKey,
+            }
+            : undefined);
+    return {
+        remotes,
+        devRemoteIters,
+        staticRemotesIter,
+    };
+}

package/src/executors/utils/start-static-remotes-file-server.d.ts

@@ -0,0 +1,15 @@
+import { type ExecutorContext } from '@nx/devkit';
+import { type StaticRemotesOptions } from './models';
+import type { StaticRemotesConfig } from '../../utils';
+export declare function startStaticRemotesFileServer(staticRemotesConfig: StaticRemotesConfig, context: ExecutorContext, options: StaticRemotesOptions, forceMoveToCommonLocation?: boolean): AsyncGenerator<{
+    success: boolean;
+    baseUrl: string;
+}, {
+    success: boolean;
+}, unknown>;
+export declare function startSsrStaticRemotesFileServer(staticRemotesConfig: StaticRemotesConfig, context: ExecutorContext, options: StaticRemotesOptions): AsyncGenerator<{
+    success: boolean;
+    baseUrl: string;
+} | {
+    success: boolean;
+}, void, unknown>;

package/src/executors/utils/start-static-remotes-file-server.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startStaticRemotesFileServer = startStaticRemotesFileServer;
+exports.startSsrStaticRemotesFileServer = startSsrStaticRemotesFileServer;
+const devkit_1 = require("@nx/devkit");
+const file_server_impl_1 = require("@nx/web/src/executors/file-server/file-server.impl");
+const path_1 = require("path");
+const fs_1 = require("fs");
+function startStaticRemotesFileServer(staticRemotesConfig, context, options, forceMoveToCommonLocation = false) {
+    if (!staticRemotesConfig.remotes ||
+        staticRemotesConfig.remotes.length === 0) {
+        return;
+    }
+    let shouldMoveToCommonLocation = forceMoveToCommonLocation || false;
+    let commonOutputDirectory;
+    if (!forceMoveToCommonLocation) {
+        for (const app of staticRemotesConfig.remotes) {
+            const remoteBasePath = staticRemotesConfig.config[app].basePath;
+            if (!commonOutputDirectory) {
+                commonOutputDirectory = remoteBasePath;
+            }
+            else if (commonOutputDirectory !== remoteBasePath) {
+                shouldMoveToCommonLocation = true;
+                break;
+            }
+        }
+    }
+    if (shouldMoveToCommonLocation) {
+        commonOutputDirectory = (0, path_1.join)(devkit_1.workspaceRoot, 'tmp/static-remotes');
+        for (const app of staticRemotesConfig.remotes) {
+            const remoteConfig = staticRemotesConfig.config[app];
+            (0, fs_1.cpSync)(remoteConfig.outputPath, (0, path_1.join)(commonOutputDirectory, remoteConfig.urlSegment), {
+                force: true,
+                recursive: true,
+            });
+        }
+    }
+    const staticRemotesIter = (0, file_server_impl_1.default)({
+        cors: true,
+        watch: false,
+        staticFilePath: commonOutputDirectory,
+        parallel: false,
+        spa: false,
+        withDeps: false,
+        host: options.host,
+        port: options.staticRemotesPort,
+        ssl: options.ssl,
+        sslCert: options.sslCert,
+        sslKey: options.sslKey,
+        cacheSeconds: -1,
+    }, context);
+    return staticRemotesIter;
+}
+async function* startSsrStaticRemotesFileServer(staticRemotesConfig, context, options) {
+    const staticRemotesIter = startStaticRemotesFileServer(staticRemotesConfig, context, options, true);
+    if (!staticRemotesIter) {
+        yield { success: true };
+        return;
+    }
+    yield* staticRemotesIter;
+}