@nx/react 0.0.0-pr-31222-862e973 → 0.0.0-pr-31313-387cdca

package/src/executors/module-federation-ssr-dev-server/module-federation-ssr-dev-server.impl.js

@@ -4,143 +4,16 @@ exports.default = moduleFederationSsrDevServer;
 const devkit_1 = require("@nx/devkit");
 const ssr_dev_server_impl_1 = require("@nx/webpack/src/executors/ssr-dev-server/ssr-dev-server.impl");
 const path_1 = require("path");
-const module_federation_1 = require("@nx/webpack/src/utils/module-federation");
+const utils_1 = require("@nx/module-federation/src/executors/utils");
 const async_iterable_1 = require("@nx/devkit/src/utils/async-iterable");
-const child_process_1 = require("child_process");
 const fs_1 = require("fs");
-const parse_static_remotes_config_1 = require("@nx/webpack/src/utils/module-federation/parse-static-remotes-config");
-const file_server_impl_1 = require("@nx/web/src/executors/file-server/file-server.impl");
-const cache_directory_1 = require("nx/src/utils/cache-directory");
-const start_ssr_remote_proxies_1 = require("@nx/webpack/src/utils/module-federation/start-ssr-remote-proxies");
 const wait_for_port_open_1 = require("@nx/web/src/utils/wait-for-port-open");
-function normalizeOptions(options) {
-    return {
-        ...options,
-        ssl: options.ssl ?? false,
-        sslCert: options.sslCert ? (0, path_1.join)(devkit_1.workspaceRoot, options.sslCert) : undefined,
-        sslKey: options.sslKey ? (0, path_1.join)(devkit_1.workspaceRoot, options.sslKey) : undefined,
-    };
-}
-function getBuildOptions(buildTarget, context) {
-    const target = (0, devkit_1.parseTargetString)(buildTarget, context);
-    const buildOptions = (0, devkit_1.readTargetOptions)(target, context);
-    return {
-        ...buildOptions,
-    };
-}
-async function* startSsrStaticRemotesFileServer(ssrStaticRemotesConfig, context, options) {
-    if (ssrStaticRemotesConfig.remotes.length === 0) {
-        yield { success: true };
-        return;
-    }
-    // The directories are usually generated with /browser and /server suffixes so we need to copy them to a common directory
-    const commonOutputDirectory = (0, path_1.join)(devkit_1.workspaceRoot, 'tmp/static-remotes');
-    for (const app of ssrStaticRemotesConfig.remotes) {
-        const remoteConfig = ssrStaticRemotesConfig.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);
-    yield* staticRemotesIter;
-}
-async function startRemotes(remotes, context, options) {
-    const remoteIters = [];
-    const target = 'serve';
-    for (const app of remotes) {
-        const remoteProjectServeTarget = context.projectGraph.nodes[app].data.targets[target];
-        const isUsingModuleFederationSsrDevServerExecutor = remoteProjectServeTarget.executor.includes('module-federation-ssr-dev-server');
-        const configurationOverride = options.devRemotes?.find((remote) => typeof remote !== 'string' && remote.remoteName === app)?.configuration;
-        {
-            const defaultOverrides = {
-                ...(options.host ? { host: options.host } : {}),
-                ...(options.ssl ? { ssl: options.ssl } : {}),
-                ...(options.sslCert ? { sslCert: options.sslCert } : {}),
-                ...(options.sslKey ? { sslKey: options.sslKey } : {}),
-            };
-            const overrides = {
-                watch: true,
-                ...defaultOverrides,
-                ...(isUsingModuleFederationSsrDevServerExecutor
-                    ? { isInitialHost: false }
-                    : {}),
-            };
-            remoteIters.push(await (0, devkit_1.runExecutor)({
-                project: app,
-                target,
-                configuration: configurationOverride ?? context.configurationName,
-            }, overrides, context));
-        }
-    }
-    return remoteIters;
-}
-async function buildSsrStaticRemotes(staticRemotesConfig, nxBin, context, options) {
-    if (!staticRemotesConfig.remotes.length) {
-        return;
-    }
-    devkit_1.logger.info(`Nx is building ${staticRemotesConfig.remotes.length} static remotes...`);
-    const mapLocationOfRemotes = {};
-    for (const remoteApp of staticRemotesConfig.remotes) {
-        mapLocationOfRemotes[remoteApp] = `http${options.ssl ? 's' : ''}://${options.host}:${options.staticRemotesPort}/${staticRemotesConfig.config[remoteApp].urlSegment}`;
-    }
-    await new Promise((resolve) => {
-        const childProcess = (0, child_process_1.fork)(nxBin, [
-            'run-many',
-            '--target=server',
-            '--projects',
-            staticRemotesConfig.remotes.join(','),
-            ...(context.configurationName
-                ? [`--configuration=${context.configurationName}`]
-                : []),
-            ...(options.parallel ? [`--parallel=${options.parallel}`] : []),
-        ], {
-            cwd: context.root,
-            stdio: ['ignore', 'pipe', 'pipe', 'ipc'],
-        });
-        // Add a listener to the child process to capture the build log
-        const remoteBuildLogFile = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `${new Date().toISOString().replace(/[:\.]/g, '_')}-build.log`);
-        const remoteBuildLogStream = (0, fs_1.createWriteStream)(remoteBuildLogFile);
-        childProcess.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, '');
-            remoteBuildLogStream.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 server')) {
-                childProcess.stdout.removeAllListeners('data');
-                devkit_1.logger.info(`Nx Built ${staticRemotesConfig.remotes.length} static remotes.`);
-                resolve();
-            }
-        });
-        process.on('SIGTERM', () => childProcess.kill('SIGTERM'));
-        process.on('exit', () => childProcess.kill('SIGTERM'));
-    });
-    return mapLocationOfRemotes;
-}
+const lib_1 = require("./lib");
 async function* moduleFederationSsrDevServer(ssrDevServerOptions, context) {
-    const options = normalizeOptions(ssrDevServerOptions);
-    // Force Node to resolve to look for the nx binary that is inside node_modules
-    const nxBin = require.resolve('nx/bin/nx');
+    const options = (0, lib_1.normalizeOptions)(ssrDevServerOptions);
     let iter = (0, ssr_dev_server_impl_1.default)(options, context);
     const projectConfig = context.projectsConfigurations.projects[context.projectName];
-    const buildOptions = getBuildOptions(options.browserTarget, context);
+    const buildOptions = (0, lib_1.getBuildOptions)(options.browserTarget, context);
     let pathToManifestFile = (0, path_1.join)(context.root, projectConfig.sourceRoot, 'assets/module-federation.manifest.json');
     if (options.pathToManifestFile) {
         const userPathToManifestFile = (0, path_1.join)(context.root, options.pathToManifestFile);
@@ -155,28 +28,7 @@ async function* moduleFederationSsrDevServer(ssrDevServerOptions, context) {
     if (!options.isInitialHost) {
         return yield* iter;
     }
-    const moduleFederationConfig = (0, module_federation_1.getModuleFederationConfig)(buildOptions.tsConfig, context.root, projectConfig.root, 'react');
-    const remoteNames = options.devRemotes?.map((remote) => typeof remote === 'string' ? remote : remote.remoteName);
-    const remotes = (0, module_federation_1.getRemotes)(remoteNames, options.skipRemotes, moduleFederationConfig, {
-        projectName: context.projectName,
-        projectGraph: context.projectGraph,
-        root: context.root,
-    }, pathToManifestFile);
-    options.staticRemotesPort ??= remotes.staticRemotePort;
-    process.env.NX_MF_DEV_REMOTES = JSON.stringify([
-        ...(remotes.devRemotes.map((r) => typeof r === 'string' ? r : r.remoteName) ?? []),
-        projectConfig.name,
-    ]);
-    const staticRemotesConfig = (0, parse_static_remotes_config_1.parseStaticSsrRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context);
-    const mappedLocationsOfStaticRemotes = await buildSsrStaticRemotes(staticRemotesConfig, nxBin, context, options);
-    const devRemoteIters = await startRemotes(remotes.devRemotes, context, options);
-    const staticRemotesIter = startSsrStaticRemotesFileServer(staticRemotesConfig, context, options);
-    (0, start_ssr_remote_proxies_1.startSsrRemoteProxies)(staticRemotesConfig, mappedLocationsOfStaticRemotes, options.ssl
-        ? {
-            pathToCert: options.sslCert,
-            pathToKey: options.sslKey,
-        }
-        : undefined);
+    const { staticRemotesIter, devRemoteIters, remotes } = await (0, utils_1.startRemoteIterators)(options, context, lib_1.startRemotes, pathToManifestFile, 'react', true);
     const combined = (0, async_iterable_1.combineAsyncIterables)(staticRemotesIter, ...devRemoteIters);
     let refs = 1 + (devRemoteIters?.length ?? 0);
     for await (const result of combined) {

package/src/executors/module-federation-ssr-dev-server/schema.d.ts

@@ -0,0 +1,29 @@
+import { WebSsrDevServerOptions } from '@nx/webpack/src/executors/ssr-dev-server/schema';
+import { DevRemoteDefinition } from '@nx/module-federation/src/executors/utils';
+
+export type ModuleFederationSsrDevServerOptions = WebSsrDevServerOptions & {
+  devRemotes?: (
+    | string
+    | {
+        remoteName: string;
+        configuration: string;
+      }
+  )[];
+
+  skipRemotes?: string[];
+  host: string;
+  pathToManifestFile?: string;
+  staticRemotesPort?: number;
+  parallel?: number;
+  ssl?: boolean;
+  sslKey?: string;
+  sslCert?: string;
+  isInitialHost?: boolean;
+  verbose?: boolean;
+};
+
+export type NormalizedModuleFederationSsrDevServerOptions =
+  ModuleFederationSsrDevServerOptions & {
+    devRemotes: DevRemoteDefinition[];
+    verbose: boolean;
+  };

package/src/executors/module-federation-ssr-dev-server/schema.json

@@ -1,8 +1,9 @@
 {
   "version": 2,
+  "continuous": true,
   "outputCapture": "direct-nodejs",
   "title": "Module Federation SSR Dev Server",
-  "description": "Serve a SSR host application along with its known remotes.",
+  "description": "Serve a SSR Consumer (host) application along with its known Producers (remotes).",
   "cli": "nx",
   "type": "object",
   "properties": {
@@ -27,16 +28,18 @@
       "items": {
         "type": "string"
       },
-      "description": "List of remote applications to run in development mode (i.e. using serve target).",
-      "x-priority": "important"
+      "description": "List of Producer (remote) applications to run in development mode (i.e. using serve target).",
+      "x-priority": "important",
+      "alias": "devProducers"
     },
     "skipRemotes": {
       "type": "array",
       "items": {
         "type": "string"
       },
-      "description": "List of remote applications to not automatically serve, either statically or in development mode.",
-      "x-priority": "important"
+      "description": "List of Producer (remote) applications to not automatically serve, either statically or in development mode.",
+      "x-priority": "important",
+      "alias": "skipProducers"
     },
     "host": {
       "type": "string",
@@ -45,11 +48,12 @@
     },
     "staticRemotesPort": {
       "type": "number",
-      "description": "The port at which to serve the file-server for the static remotes."
+      "description": "The port at which to serve the file-server for the static Producers (remotes).",
+      "alias": "staticProducersPort"
     },
     "pathToManifestFile": {
       "type": "string",
-      "description": "Path to a Module Federation manifest file (e.g. `my/path/to/module-federation.manifest.json`) containing the dynamic remote applications relative to the workspace root."
+      "description": "Path to a Module Federation manifest file (e.g. `my/path/to/module-federation.manifest.json`) containing the dynamic Producer (remote) applications relative to the workspace root."
     },
     "ssl": {
       "type": "boolean",
@@ -66,9 +70,10 @@
     },
     "isInitialHost": {
       "type": "boolean",
-      "description": "Whether the host that is running this executor is the first in the project tree to do so.",
+      "description": "Whether the Consumer (host) that is running this executor is the first in the project tree to do so.",
       "default": true,
-      "x-priority": "internal"
+      "x-priority": "internal",
+      "alias": "isInitialConsumer"
     }
   },
   "required": ["browserTarget", "serverTarget"]

package/src/executors/module-federation-static-server/module-federation-static-server.impl.d.ts

@@ -1,7 +1,7 @@
 import { ModuleFederationStaticServerSchema } from './schema';
 import { ModuleFederationDevServerOptions } from '../module-federation-dev-server/schema';
 import { ExecutorContext } from 'nx/src/config/misc-interfaces';
-import { StaticRemotesConfig } from '@nx/webpack/src/utils/module-federation/parse-static-remotes-config';
+import { StaticRemotesConfig } from '@nx/module-federation/src/utils';
 export declare function startProxies(staticRemotesConfig: StaticRemotesConfig, hostServeOptions: ModuleFederationDevServerOptions, mappedLocationOfHost: string, mappedLocationsOfRemotes: Record<string, string>, sslOptions?: {
     pathToCert: string;
     pathToKey: string;
@@ -9,4 +9,4 @@ export declare function startProxies(staticRemotesConfig: StaticRemotesConfig, h
 export default function moduleFederationStaticServer(schema: ModuleFederationStaticServerSchema, context: ExecutorContext): AsyncGenerator<{
     success: boolean;
     baseUrl: string;
-}, any, unknown>;
+}, any, any>;

package/src/executors/module-federation-static-server/module-federation-static-server.impl.js

@@ -5,9 +5,8 @@ exports.default = moduleFederationStaticServer;
 const path_1 = require("path");
 const devkit_1 = require("@nx/devkit");
 const fs_1 = require("fs");
-const module_federation_1 = require("@nx/webpack/src/utils/module-federation");
-const parse_static_remotes_config_1 = require("@nx/webpack/src/utils/module-federation/parse-static-remotes-config");
-const build_static_remotes_1 = require("../../utils/build-static.remotes");
+const utils_1 = require("@nx/module-federation/src/utils");
+const utils_2 = require("@nx/module-federation/src/executors/utils");
 const child_process_1 = require("child_process");
 const process = require("node:process");
 const file_server_impl_1 = require("@nx/web/src/executors/file-server/file-server.impl");
@@ -59,7 +58,7 @@ async function buildHost(nxBin, buildTarget, context) {
             }
             if (stdoutString.includes('Successfully ran target build')) {
                 staticProcess.stdout.removeAllListeners('data');
-                devkit_1.logger.info(`NX Built host`);
+                devkit_1.logger.info(`NX Built Consumer (host)`);
                 res();
             }
         });
@@ -68,7 +67,7 @@ async function buildHost(nxBin, buildTarget, context) {
             staticProcess.stdout.removeAllListeners('data');
             staticProcess.stderr.removeAllListeners('data');
             if (code !== 0) {
-                rej(`Host failed to build. See above for details.`);
+                rej(`Consumer (host) failed to build. See above for details.`);
             }
             else {
                 res();
@@ -133,8 +132,8 @@ function startProxies(staticRemotesConfig, hostServeOptions, mappedLocationOfHos
         process.on('SIGTERM', () => proxyServer.close());
         process.on('exit', () => proxyServer.close());
     }
-    devkit_1.logger.info(`NX Static remotes proxies started successfully`);
-    devkit_1.logger.info(`NX Starting static host proxy...`);
+    devkit_1.logger.info(`NX Static Producers (remotes) proxies started successfully`);
+    devkit_1.logger.info(`NX Starting static Consumer (host) proxy...`);
     const expressProxy = express();
     expressProxy.use(createProxyMiddleware({
         target: mappedLocationOfHost,
@@ -156,7 +155,7 @@ function startProxies(staticRemotesConfig, hostServeOptions, mappedLocationOfHos
         .listen(hostServeOptions.port);
     process.on('SIGTERM', () => proxyServer.close());
     process.on('exit', () => proxyServer.close());
-    devkit_1.logger.info('NX Static host proxy started successfully');
+    devkit_1.logger.info('NX Static Consumer (host) proxy started successfully');
 }
 async function* moduleFederationStaticServer(schema, context) {
     // Force Node to resolve to look for the nx binary that is inside node_modules
@@ -164,15 +163,15 @@ async function* moduleFederationStaticServer(schema, context) {
     // Get the remotes from the module federation config
     const p = context.projectsConfigurations.projects[context.projectName];
     const options = getBuildAndServeOptionsFromServeTarget(schema.serveTarget, context);
-    const moduleFederationConfig = (0, module_federation_1.getModuleFederationConfig)(options.buildOptions.tsConfig, context.root, p.root, 'react');
-    const remotes = (0, module_federation_1.getRemotes)([], options.serveOptions.skipRemotes, moduleFederationConfig, {
+    const moduleFederationConfig = (0, utils_1.getModuleFederationConfig)(options.buildOptions.tsConfig, context.root, p.root, 'react');
+    const remotes = (0, utils_1.getRemotes)([], options.serveOptions.skipRemotes, moduleFederationConfig, {
         projectName: context.projectName,
         projectGraph: context.projectGraph,
         root: context.root,
     }, options.pathToManifestFile);
-    const staticRemotesConfig = (0, parse_static_remotes_config_1.parseStaticRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context);
+    const staticRemotesConfig = (0, utils_1.parseStaticRemotesConfig)([...remotes.staticRemotes, ...remotes.dynamicRemotes], context);
     options.serveOptions.staticRemotesPort ??= remotes.staticRemotePort;
-    const mappedLocationsOfStaticRemotes = await (0, build_static_remotes_1.buildStaticRemotes)(staticRemotesConfig, nxBin, context, options.serveOptions);
+    const mappedLocationsOfStaticRemotes = await (0, utils_2.buildStaticRemotes)(staticRemotesConfig, nxBin, context, options.serveOptions);
     // Build the host
     const hostUrlSegment = (0, path_1.basename)(options.buildOptions.outputPath);
     const mappedLocationOfHost = `http${options.serveOptions.ssl ? 's' : ''}://${options.serveOptions.host}:${options.serveOptions.staticRemotesPort}/${hostUrlSegment}`;

package/src/executors/module-federation-static-server/schema.json

@@ -1,8 +1,9 @@
 {
   "version": 2,
+  "continuous": true,
   "outputCapture": "direct-nodejs",
   "title": "Module Federation Static Dev Server",
-  "description": "Serve a host application statically along with it's remotes.",
+  "description": "Serve a Consumer (host) application statically along with its Producers (remotes).",
   "cli": "nx",
   "type": "object",
   "properties": {

package/src/generators/application/application.d.ts

@@ -1,5 +1,5 @@
-import { Schema } from './schema';
 import { GeneratorCallback, Tree } from '@nx/devkit';
-export declare function applicationGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
-export declare function applicationGeneratorInternal(host: Tree, schema: Schema): Promise<GeneratorCallback>;
+import { Schema } from './schema';
+export declare function applicationGenerator(tree: Tree, schema: Schema): Promise<GeneratorCallback>;
+export declare function applicationGeneratorInternal(tree: Tree, schema: Schema): Promise<GeneratorCallback>;
 export default applicationGenerator;