feat(nextjs-mf): remove module-federation/utilities (#3038)

Author: ScriptedAlchemy

.changeset/ai-calm-bear.md

@@ -0,0 +1,7 @@
+---
+"@module-federation/enhanced": patch
+---
+
+Added a check to skip processing when virtualRuntimeEntry is present.
+
+- Added an early return in `FederationRuntimePlugin` to skip processing if `options.virtualRuntimeEntry` is defined.

packages/nextjs-mf/package.json

@@ -17,7 +17,6 @@
   ],
   "exports": {
     ".": "./dist/src/index.js",
-    "./utilities": "./dist/utilities.js",
     "./utils": "./dist/utils/index.js",
     "./*": "./*"
   },
@@ -28,9 +27,6 @@
       ],
       "utils": [
         "./dist/utils/index.d.ts"
-      ],
-      "utilities": [
-        "./dist/utilities.d.ts"
       ]
     }
   },
@@ -39,7 +35,6 @@
   },
   "dependencies": {
     "fast-glob": "^3.2.11",
-    "@module-federation/utilities": "workspace:*",
     "@module-federation/runtime": "workspace:*",
     "@module-federation/sdk": "workspace:*",
     "@module-federation/enhanced": "workspace:*",

packages/nextjs-mf/src/plugins/NextFederationPlugin/apply-client-plugins.ts

@@ -1,8 +1,8 @@
 import type { Compiler } from 'webpack';
-import { NextFederationPluginExtraOptions } from '@module-federation/utilities';
 import { ChunkCorrelationPlugin } from '@module-federation/node';
 import InvertedContainerPlugin from '../container/InvertedContainerPlugin';
 import type { moduleFederationPlugin } from '@module-federation/sdk';
+import type { NextFederationPluginExtraOptions } from './next-fragments';
 
 /**
  * Applies client-specific plugins.

packages/nextjs-mf/src/plugins/NextFederationPlugin/index.ts

@@ -8,7 +8,7 @@
 import type {
   NextFederationPluginExtraOptions,
   NextFederationPluginOptions,
-} from '@module-federation/utilities';
+} from './next-fragments';
 import type { Compiler, WebpackPluginInstance } from 'webpack';
 import { getWebpackPath } from '@module-federation/sdk/normalize-webpack-path';
 import CopyFederationPlugin from '../CopyFederationPlugin';
@@ -69,20 +69,6 @@ export class NextFederationPlugin {
     this.applyConditionalPlugins(compiler, isServer);
 
     new ModuleFederationPlugin(normalFederationPluginOptions).apply(compiler);
-    modifyEntry({
-      compiler,
-      prependEntry: (entry) => {
-        Object.keys(entry).forEach((entryName) => {
-          const entryItem = entry[entryName];
-          if (!entryName.startsWith('pages/api')) return;
-          if (!entryItem.import) return;
-          // unpatch entry of webpack api runtime
-          entryItem.import = entryItem.import.filter((i) => {
-            return !i.includes('.federation/entry');
-          });
-        });
-      },
-    });
 
     const noop = this.getNoopPath();
 

packages/nextjs-mf/src/plugins/NextFederationPlugin/next-fragments.ts

@@ -119,3 +119,17 @@ export const applyPathFixes = (
     }
   }
 };
+
+export interface NextFederationPluginExtraOptions {
+  enableImageLoaderFix?: boolean;
+  enableUrlLoaderFix?: boolean;
+  exposePages?: boolean;
+  skipSharingNextInternals?: boolean;
+  automaticPageStitching?: boolean;
+  debug?: boolean;
+}
+
+export interface NextFederationPluginOptions
+  extends moduleFederationPlugin.ModuleFederationPluginOptions {
+  extraOptions: NextFederationPluginExtraOptions;
+}

packages/nextjs-mf/src/plugins/NextFederationPlugin/set-options.test.ts

@@ -1,23 +1,19 @@
-import {
-  NextFederationPluginExtraOptions,
-  NextFederationPluginOptions,
-} from '@module-federation/utilities';
 import type { moduleFederationPlugin } from '@module-federation/sdk';
-/**
- * This function sets the main and extra options for NextFederationPlugin. It splits the options object into
- * the main options and extra options, and sets default values for any options that are not defined.
- *
- * @param {NextFederationPluginOptions} options - The options for NextFederationPlugin.
- * @returns {Object} An object containing the main options and extra options.
- *
- * @remarks
- * The default extra options are:
- * - automaticPageStitching: false
- * - enableImageLoaderFix: false
- * - enableUrlLoaderFix: false
- * - skipSharingNextInternals: false
- * - debug: false
- */
+
+export interface NextFederationPluginExtraOptions {
+  enableImageLoaderFix?: boolean;
+  enableUrlLoaderFix?: boolean;
+  exposePages?: boolean;
+  skipSharingNextInternals?: boolean;
+  automaticPageStitching?: boolean;
+  debug?: boolean;
+}
+
+export interface NextFederationPluginOptions
+  extends moduleFederationPlugin.ModuleFederationPluginOptions {
+  extraOptions: NextFederationPluginExtraOptions;
+}
+
 export function setOptions(options: NextFederationPluginOptions): {
   mainOptions: moduleFederationPlugin.ModuleFederationPluginOptions;
   extraOptions: NextFederationPluginExtraOptions;

packages/nextjs-mf/src/plugins/NextFederationPlugin/set-options.ts

@@ -1,9 +1,3 @@
-/**
- * Extracts the URL and global from the module federation utilities.
- * @module @module-federation/utilities/src/utils/pure
- */
-export { extractUrlAndGlobal } from '@module-federation/utilities';
-
 /**
  * Flushes chunks from the module federation node utilities.
  * @module @module-federation/node/utils