module-federation · ScriptedAlchemy · Jul 12, 2025 · Jul 12, 2025 · Jul 12, 2025
diff --git a/.changeset/hook-renaming-cleanup.md b/.changeset/hook-renaming-cleanup.md
@@ -0,0 +1,12 @@
+---
+"@module-federation/enhanced": patch
+"@module-federation/nextjs-mf": patch
+---
+
+refactor: rename container hooks for clarity and consistency
+
+- Renamed `addContainerEntryModule` to `addContainerEntryDependency`
+- Renamed `addFederationRuntimeModule` to `addFederationRuntimeDependency`
+- Added new `addRemoteDependency` hook for remote module tracking
+- Updated all hook usages across the codebase to use new names
+- This is an internal refactoring with no breaking changes to external APIs
diff --git a/INCREMENTAL_PR_PLAN_REVISED.md b/INCREMENTAL_PR_PLAN_REVISED.md
@@ -1,4 +1,4 @@
-# Revised Incremental PR Plan for packages/enhanced Changes
+f# Revised Incremental PR Plan for packages/enhanced Changes
 
 ## Overview
 Based on a detailed diff analysis, this document provides a more accurate breakdown of changes into focused, incremental PRs. Each PR represents a distinct feature, fix, or refactor that can be merged independently.
@@ -21,7 +21,7 @@ Based on a detailed diff analysis, this document provides a more accurate breakd
 
 ### PR 2: Hook Renaming and Cleanup
 **Size**: Small (~6 files)
-**Risk**: Medium (potential breaking change)
+**Risk**: Low (internal refactoring only - all usages updated)
 **Type**: Refactor
 **Feature**: Rename container hooks for clarity and consistency
 
@@ -31,18 +31,23 @@ Based on a detailed diff analysis, this document provides a more accurate breakd
 - `src/lib/container/runtime/FederationModulesPlugin.ts`
 - `src/lib/container/runtime/EmbedFederationRuntimePlugin.ts`
 - `src/lib/container/RemoteModule.ts` (use new hook)
+- Any other files that reference these hooks
 
 **Changes**:
 - `addContainerEntryModule` → `addContainerEntryDependency`
 - `addFederationRuntimeModule` → `addFederationRuntimeDependency`
 - Add new `addRemoteDependency` hook
 
-**Implementation with backward compatibility**:
+**Implementation**:
 ```javascript
+// Direct rename - all usages updated in same PR
 compiler.hooks.addContainerEntryDependency = new SyncHook([...]);
-compiler.hooks.addContainerEntryModule = compiler.hooks.addContainerEntryDependency; // deprecated
+compiler.hooks.addFederationRuntimeDependency = new SyncHook([...]);
+compiler.hooks.addRemoteDependency = new SyncHook([...]);
 ```
 
+**Note**: This is NOT a breaking change because all hook usages within the codebase are updated in the same PR.
+
 ---
 
 ### PR 3: Enhanced HoistContainerReferencesPlugin
@@ -282,4 +287,4 @@ All Feature PRs ─────────────────────
 2. **Reduced Risk**: Smaller, focused changes are easier to review and test
 3. **Flexibility**: Some PRs can be developed in parallel
 4. **Progressive Enhancement**: Each filtering feature builds on the previous
-5. **Early Wins**: Runtime fixes and hook renaming can be merged quickly
+5. **Early Wins**: Runtime fixes and hook renaming can be merged quickly
diff --git a/packages/enhanced/src/lib/container/ContainerPlugin.ts b/packages/enhanced/src/lib/container/ContainerPlugin.ts
@@ -218,7 +218,7 @@ class ContainerPlugin {
             },
             (error: WebpackError | null | undefined) => {
               if (error) return reject(error);
-              hooks.addContainerEntryModule.call(dep);
+              hooks.addContainerEntryDependency.call(dep);
               resolve(undefined);
             },
           );
@@ -233,7 +233,7 @@ class ContainerPlugin {
               if (err) {
                 return reject(err);
               }
-              hooks.addFederationRuntimeModule.call(
+              hooks.addFederationRuntimeDependency.call(
                 federationRuntimeDependency,
               );
               resolve(undefined);
@@ -291,7 +291,7 @@ class ContainerPlugin {
           { name: undefined },
           (error: WebpackError | null | undefined) => {
             if (error) return callback(error);
-            hooks.addContainerEntryModule.call(dep);
+            hooks.addContainerEntryDependency.call(dep);
             callback();
           },
         );

diff --git a/packages/enhanced/src/lib/container/ContainerReferencePlugin.ts b/packages/enhanced/src/lib/container/ContainerReferencePlugin.ts
@@ -15,6 +15,7 @@ import RemoteToExternalDependency from './RemoteToExternalDependency';
 import { parseOptions } from './options';
 import { containerReferencePlugin } from '@module-federation/sdk';
 import FederationRuntimePlugin from './runtime/FederationRuntimePlugin';
+import FederationModulesPlugin from './runtime/FederationModulesPlugin';
 import schema from '../../schemas/container/ContainerReferencePlugin';
 import checkOptions from '../../schemas/container/ContainerReferencePlugin.check';
 
@@ -107,6 +108,8 @@ class ContainerReferencePlugin {
           new FallbackModuleFactory(),
         );
 
+        const hooks = FederationModulesPlugin.getCompilationHooks(compilation);
+
         normalModuleFactory.hooks.factorize.tap(
           'ContainerReferencePlugin',
           //@ts-ignore
@@ -118,7 +121,7 @@ class ContainerReferencePlugin {
                   (data.request.length === key.length ||
                     data.request.charCodeAt(key.length) === slashCode)
                 ) {
-                  return new RemoteModule(
+                  const remoteModule = new RemoteModule(
                     data.request,
                     //@ts-ignore
                     config.external.map((external: any, i: any) =>
@@ -132,6 +135,8 @@ class ContainerReferencePlugin {
                     //@ts-ignore
                     config.shareScope,
                   );
+                  hooks.addRemoteDependency.call(remoteModule);
+                  return remoteModule;
                 }
               }
             }

diff --git a/packages/enhanced/src/lib/container/HoistContainerReferencesPlugin.ts b/packages/enhanced/src/lib/container/HoistContainerReferencesPlugin.ts
@@ -28,13 +28,13 @@ export class HoistContainerReferences implements WebpackPluginInstance {
         const logger = compilation.getLogger(PLUGIN_NAME);
         const hooks = FederationModulesPlugin.getCompilationHooks(compilation);
         const containerEntryDependencies = new Set<Dependency>();
-        hooks.addContainerEntryModule.tap(
+        hooks.addContainerEntryDependency.tap(
           'HoistContainerReferences',
           (dep: ContainerEntryDependency) => {
             containerEntryDependencies.add(dep);
           },
         );
-        hooks.addFederationRuntimeModule.tap(
+        hooks.addFederationRuntimeDependency.tap(
           'HoistContainerReferences',
           (dep: FederationRuntimeDependency) => {
             containerEntryDependencies.add(dep);

diff --git a/packages/enhanced/src/lib/container/runtime/EmbedFederationRuntimePlugin.ts b/packages/enhanced/src/lib/container/runtime/EmbedFederationRuntimePlugin.ts
@@ -124,7 +124,7 @@ class EmbedFederationRuntimePlugin {
         );
 
         // Collect federation runtime dependencies.
-        federationHooks.addFederationRuntimeModule.tap(
+        federationHooks.addFederationRuntimeDependency.tap(
           PLUGIN_NAME,
           (dependency: FederationRuntimeDependency) => {
             containerEntrySet.add(dependency);

diff --git a/packages/enhanced/src/lib/container/runtime/FederationModulesPlugin.ts b/packages/enhanced/src/lib/container/runtime/FederationModulesPlugin.ts
@@ -16,8 +16,9 @@ const PLUGIN_NAME = 'FederationModulesPlugin';
 /** @typedef {{ header: string[], beforeStartup: string[], startup: string[], afterStartup: string[], allowInlineStartup: boolean }} Bootstrap */
 
 type CompilationHooks = {
-  addContainerEntryModule: SyncHook<[ContainerEntryDependency], void>;
-  addFederationRuntimeModule: SyncHook<[FederationRuntimeDependency], void>;
+  addContainerEntryDependency: SyncHook<[ContainerEntryDependency], void>;
+  addFederationRuntimeDependency: SyncHook<[FederationRuntimeDependency], void>;
+  addRemoteDependency: SyncHook<[any], void>;
 };
 
 class FederationModulesPlugin {
@@ -36,8 +37,9 @@ class FederationModulesPlugin {
     let hooks = compilationHooksMap.get(compilation);
     if (hooks === undefined) {
       hooks = {
-        addContainerEntryModule: new SyncHook(['dependency']),
-        addFederationRuntimeModule: new SyncHook(['module']),
+        addContainerEntryDependency: new SyncHook(['dependency']),
+        addFederationRuntimeDependency: new SyncHook(['dependency']),
+        addRemoteDependency: new SyncHook(['dependency']),
       };
       compilationHooksMap.set(compilation, hooks);
     }

diff --git a/packages/enhanced/src/lib/container/runtime/FederationRuntimePlugin.ts b/packages/enhanced/src/lib/container/runtime/FederationRuntimePlugin.ts
@@ -255,7 +255,9 @@ class FederationRuntimePlugin {
             if (err) {
               return callback(err);
             }
-            hooks.addFederationRuntimeModule.call(federationRuntimeDependency);
+            hooks.addFederationRuntimeDependency.call(
+              federationRuntimeDependency,
+            );
             callback();
           },
         );

diff --git a/packages/enhanced/test/unit/container/ContainerReferencePlugin.test.ts b/packages/enhanced/test/unit/container/ContainerReferencePlugin.test.ts
@@ -58,6 +58,20 @@ jest.mock('../../../src/lib/container/runtime/FederationRuntimePlugin', () => {
   return mockFederationRuntimePlugin;
 });
 
+// Mock FederationModulesPlugin
+jest.mock('../../../src/lib/container/runtime/FederationModulesPlugin', () => {
+  return {
+    __esModule: true,
+    default: {
+      getCompilationHooks: jest.fn(() => ({
+        addContainerEntryDependency: { tap: jest.fn() },
+        addFederationRuntimeDependency: { tap: jest.fn() },
+        addRemoteDependency: { tap: jest.fn() },
+      })),
+    },
+  };
+});
+
 // Mock FallbackModuleFactory
 jest.mock(
   '../../../src/lib/container/FallbackModuleFactory',

diff --git a/packages/nextjs-mf/src/plugins/container/InvertedContainerPlugin.ts b/packages/nextjs-mf/src/plugins/container/InvertedContainerPlugin.ts
@@ -12,7 +12,7 @@ class InvertedContainerPlugin {
       (compilation: Compilation) => {
         const hooks = FederationModulesPlugin.getCompilationHooks(compilation);
         const containers = new Set();
-        hooks.addContainerEntryModule.tap(
+        hooks.addContainerEntryDependency.tap(
           'EmbeddedContainerPlugin',
           (dependency) => {
             if (dependency instanceof dependencies.ContainerEntryDependency) {