feat(angular): add withModuleFederationForSSR function (#13172)

docs/generated/devkit/index.md

@@ -162,6 +162,7 @@ It only uses language primitives and immutable objects
 - [isStandaloneProject](../../devkit/index#isstandaloneproject)
 - [joinPathFragments](../../devkit/index#joinpathfragments)
 - [mapRemotes](../../devkit/index#mapremotes)
+- [mapRemotesForSSR](../../devkit/index#mapremotesforssr)
 - [moveFilesToNewDirectory](../../devkit/index#movefilestonewdirectory)
 - [names](../../devkit/index#names)
 - [normalizePath](../../devkit/index#normalizepath)
@@ -1495,6 +1496,27 @@ Federation.
 
 ---
 
+### mapRemotesForSSR
+
+▸ **mapRemotesForSSR**(`remotes`, `remoteEntryExt`, `determineRemoteUrl`): `Record`<`string`, `string`\>
+
+Map remote names to a format that can be understood and used by Module
+Federation.
+
+#### Parameters
+
+| Name                 | Type                                    | Description                                              |
+| :------------------- | :-------------------------------------- | :------------------------------------------------------- |
+| `remotes`            | [`Remotes`](../../devkit/index#remotes) | The remotes to map                                       |
+| `remoteEntryExt`     | `"js"` \| `"mjs"`                       | The file extension of the remoteEntry file               |
+| `determineRemoteUrl` | (`remote`: `string`) => `string`        | The function used to lookup the URL of the served remote |
+
+#### Returns
+
+`Record`<`string`, `string`\>
+
+---
+
 ### moveFilesToNewDirectory
 
 ▸ **moveFilesToNewDirectory**(`tree`, `oldDir`, `newDir`): `void`

packages/angular/module-federation/index.ts

@@ -1 +1,2 @@
 export { withModuleFederation } from '../src/utils/mf/with-module-federation';
+export { withModuleFederationForSSR } from '../src/utils/mf/with-module-federation-ssr';

packages/angular/src/utils/mf/utils.ts

@@ -0,0 +1,94 @@
+import {
+  applyAdditionalShared,
+  applySharedFunction,
+  createProjectGraphAsync,
+  getDependentPackagesForProject,
+  mapRemotes,
+  mapRemotesForSSR,
+  ModuleFederationConfig,
+  ProjectGraph,
+  readCachedProjectGraph,
+  SharedLibraryConfig,
+  sharePackages,
+  shareWorkspaceLibraries,
+} from '@nrwl/devkit';
+
+export function applyDefaultEagerPackages(
+  sharedConfig: Record<string, SharedLibraryConfig>
+) {
+  const DEFAULT_PACKAGES_TO_LOAD_EAGERLY = [
+    '@angular/localize',
+    '@angular/localize/init',
+  ];
+  for (const pkg of DEFAULT_PACKAGES_TO_LOAD_EAGERLY) {
+    if (!sharedConfig[pkg]) {
+      continue;
+    }
+
+    sharedConfig[pkg] = { ...sharedConfig[pkg], eager: true };
+  }
+}
+
+export const DEFAULT_NPM_PACKAGES_TO_AVOID = ['zone.js', '@nrwl/angular/mf'];
+export const DEFAULT_ANGULAR_PACKAGES_TO_SHARE = [
+  '@angular/animations',
+  '@angular/common',
+];
+
+export async function getModuleFederationConfig(
+  mfConfig: ModuleFederationConfig,
+  determineRemoteUrl: (remote: string) => string,
+  options: { isServer: boolean } = { isServer: false }
+) {
+  let projectGraph: ProjectGraph<any>;
+  try {
+    projectGraph = readCachedProjectGraph();
+  } catch (e) {
+    projectGraph = await createProjectGraphAsync();
+  }
+
+  const dependencies = getDependentPackagesForProject(
+    projectGraph,
+    mfConfig.name
+  );
+  const sharedLibraries = shareWorkspaceLibraries(
+    dependencies.workspaceLibraries
+  );
+
+  const npmPackages = sharePackages(
+    Array.from(
+      new Set([
+        ...DEFAULT_ANGULAR_PACKAGES_TO_SHARE,
+        ...dependencies.npmPackages.filter(
+          (pkg) => !DEFAULT_NPM_PACKAGES_TO_AVOID.includes(pkg)
+        ),
+      ])
+    )
+  );
+
+  DEFAULT_NPM_PACKAGES_TO_AVOID.forEach((pkgName) => {
+    if (pkgName in npmPackages) {
+      delete npmPackages[pkgName];
+    }
+  });
+
+  const sharedDependencies = {
+    ...sharedLibraries.getLibraries(),
+    ...npmPackages,
+  };
+
+  applyDefaultEagerPackages(sharedDependencies);
+  applySharedFunction(sharedDependencies, mfConfig.shared);
+  applyAdditionalShared(
+    sharedDependencies,
+    mfConfig.additionalShared,
+    projectGraph
+  );
+
+  const mapRemotesFunction = options.isServer ? mapRemotesForSSR : mapRemotes;
+  const mappedRemotes =
+    !mfConfig.remotes || mfConfig.remotes.length === 0
+      ? {}
+      : mapRemotesFunction(mfConfig.remotes, 'mjs', determineRemoteUrl);
+  return { sharedLibraries, sharedDependencies, mappedRemotes };
+}

packages/angular/src/utils/mf/with-module-federation-ssr.ts

@@ -0,0 +1,68 @@
+import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
+import { ModuleFederationConfig } from '@nrwl/devkit';
+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, {
+      isServer: true,
+    });
+
+  return (config) => ({
+    ...(config ?? {}),
+    target: false,
+    output: {
+      ...(config.output ?? {}),
+      uniqueName: options.name,
+    },
+    optimization: {
+      ...(config.optimization ?? {}),
+      runtimeChunk: false,
+    },
+    resolve: {
+      ...(config.resolve ?? {}),
+      alias: {
+        ...(config.resolve?.alias ?? {}),
+        ...sharedLibraries.getAliases(),
+      },
+    },
+    plugins: [
+      ...(config.plugins ?? []),
+      new (require('@module-federation/node').UniversalFederationPlugin)(
+        {
+          name: options.name,
+          filename: 'remoteEntry.js',
+          exposes: options.exposes,
+          remotes: mappedRemotes,
+          shared: {
+            ...sharedDependencies,
+          },
+          library: {
+            type: 'commonjs-module',
+          },
+          isServer: true,
+        },
+        {}
+      ),
+      sharedLibraries.getReplacementPlugin(),
+    ],
+  });
+}

packages/angular/src/utils/mf/with-module-federation.ts

@@ -1,16 +1,5 @@
-import {
-  applyAdditionalShared,
-  applySharedFunction,
-  createProjectGraphAsync,
-  getDependentPackagesForProject,
-  mapRemotes,
-  ModuleFederationConfig,
-  ProjectGraph,
-  readCachedProjectGraph,
-  SharedLibraryConfig,
-  sharePackages,
-  shareWorkspaceLibraries,
-} from '@nrwl/devkit';
+import { ModuleFederationConfig } from '@nrwl/devkit';
+import { getModuleFederationConfig } from './utils';
 import { readCachedProjectConfiguration } from 'nx/src/project-graph/project-graph';
 import ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');
 
@@ -30,78 +19,9 @@ function determineRemoteUrl(remote: string) {
   }/remoteEntry.mjs`;
 }
 
-function applyDefaultEagerPackages(
-  sharedConfig: Record<string, SharedLibraryConfig>
-) {
-  const DEFAULT_PACKAGES_TO_LOAD_EAGERLY = [
-    '@angular/localize',
-    '@angular/localize/init',
-  ];
-  for (const pkg of DEFAULT_PACKAGES_TO_LOAD_EAGERLY) {
-    if (!sharedConfig[pkg]) {
-      continue;
-    }
-
-    sharedConfig[pkg] = { ...sharedConfig[pkg], eager: true };
-  }
-}
-
 export async function withModuleFederation(options: ModuleFederationConfig) {
-  const DEFAULT_NPM_PACKAGES_TO_AVOID = ['zone.js', '@nrwl/angular/mf'];
-  const DEFAULT_ANGULAR_PACKAGES_TO_SHARE = [
-    '@angular/animations',
-    '@angular/common',
-  ];
-
-  let projectGraph: ProjectGraph<any>;
-  try {
-    projectGraph = readCachedProjectGraph();
-  } catch (e) {
-    projectGraph = await createProjectGraphAsync();
-  }
-
-  const dependencies = getDependentPackagesForProject(
-    projectGraph,
-    options.name
-  );
-  const sharedLibraries = shareWorkspaceLibraries(
-    dependencies.workspaceLibraries
-  );
-
-  const npmPackages = sharePackages(
-    Array.from(
-      new Set([
-        ...DEFAULT_ANGULAR_PACKAGES_TO_SHARE,
-        ...dependencies.npmPackages.filter(
-          (pkg) => !DEFAULT_NPM_PACKAGES_TO_AVOID.includes(pkg)
-        ),
-      ])
-    )
-  );
-
-  DEFAULT_NPM_PACKAGES_TO_AVOID.forEach((pkgName) => {
-    if (pkgName in npmPackages) {
-      delete npmPackages[pkgName];
-    }
-  });
-
-  const sharedDependencies = {
-    ...sharedLibraries.getLibraries(),
-    ...npmPackages,
-  };
-
-  applyDefaultEagerPackages(sharedDependencies);
-  applySharedFunction(sharedDependencies, options.shared);
-  applyAdditionalShared(
-    sharedDependencies,
-    options.additionalShared,
-    projectGraph
-  );
-
-  const mappedRemotes =
-    !options.remotes || options.remotes.length === 0
-      ? {}
-      : mapRemotes(options.remotes, 'mjs', determineRemoteUrl);
+  const { sharedLibraries, sharedDependencies, mappedRemotes } =
+    await getModuleFederationConfig(options, determineRemoteUrl);
 
   return (config) => ({
     ...(config ?? {}),

packages/devkit/index.ts

@@ -305,6 +305,7 @@ export {
   applySharedFunction,
   applyAdditionalShared,
   mapRemotes,
+  mapRemotesForSSR,
   getNpmPackageSharedConfig,
   shareWorkspaceLibraries,
   sharePackages,

packages/devkit/src/utils/module-federation/remotes.ts

@@ -34,3 +34,39 @@ export function mapRemotes(
 
   return mappedRemotes;
 }
+
+/**
+ * Map remote names to a format that can be understood and used by Module
+ * Federation.
+ *
+ * @param remotes - The remotes to map
+ * @param remoteEntryExt - The file extension of the remoteEntry file
+ * @param determineRemoteUrl - The function used to lookup the URL of the served remote
+ */
+export function mapRemotesForSSR(
+  remotes: Remotes,
+  remoteEntryExt: 'js' | 'mjs',
+  determineRemoteUrl: (remote: string) => string
+): Record<string, string> {
+  const mappedRemotes = {};
+
+  for (const remote of remotes) {
+    if (Array.isArray(remote)) {
+      const [remoteName, remoteLocation] = remote;
+      const remoteLocationExt = extname(remoteLocation);
+      mappedRemotes[remoteName] = `${remoteName}@${
+        ['.js', '.mjs'].includes(remoteLocationExt)
+          ? remoteLocation
+          : `${
+              remoteLocation.endsWith('/')
+                ? remoteLocation.slice(0, -1)
+                : remoteLocation
+            }/remoteEntry.${remoteEntryExt}`
+      }`;
+    } else if (typeof remote === 'string') {
+      mappedRemotes[remote] = `${remote}@${determineRemoteUrl(remote)}`;
+    }
+  }
+
+  return mappedRemotes;
+}

scripts/depcheck/missing.ts

@@ -16,6 +16,7 @@ const IGNORE_MATCHES_IN_PACKAGE = {
     '@ngrx/router-store',
     '@ngrx/store',
     '@storybook/angular',
+    '@module-federation/node',
     'rxjs',
     'semver',
     // installed dynamically by the library generator