feat(enhanced): support layers in consume share plugin

.changeset/brown-badgers-fetch.md

@@ -0,0 +1,5 @@
+---
+'@module-federation/enhanced': minor
+---
+
+support request option on ConsumeSharePlugin. Allows matching requests like the object key of shared does

.changeset/shy-snails-battle.md

@@ -0,0 +1,5 @@
+---
+'@module-federation/enhanced': minor
+---
+
+Layer support for Provide Share Plugin

.gitignore

@@ -70,4 +70,7 @@ packages/enhanced/test/js
 # storybook cases
 !apps/rslib-module/@mf-types/**
 
-**/vite.config.{js,ts,mjs,mts,cjs,cts}.timestamp*
+**/vite.config.{js,ts,mjs,mts,cjs,cts}.timestamp*
+
+# Federation
+**/.federation

package.json

@@ -23,6 +23,7 @@
     "commit": "cz",
     "docs": "typedoc",
     "f": "nx format:write",
+    "enhanced:jest": "pnpm build && cd packages/enhanced && NODE_OPTIONS=--experimental-vm-modules npx jest test/ConfigTestCases.basictest.js",
     "lint": "nx run-many --target=lint",
     "test": "nx run-many --target=test",
     "build": "nx run-many --target=build --parallel=5  --projects=tag:type:pkg",
@@ -228,6 +229,7 @@
     "vue-tsc": "^2.0.26",
     "wait-on": "^7.2.0",
     "webpack": "5.93.0",
+    "webpack-cli": "^5.1.4",
     "webpack-virtual-modules": "0.6.2",
     "whatwg-fetch": "^3.6.20",
     "yargs": "^17.7.2"

packages/enhanced/src/declarations/plugins/sharing/ConsumeSharedModule.d.ts

@@ -0,0 +1,53 @@
+export type ConsumeOptions = {
+  /**
+   * fallback request
+   */
+  import?: string | undefined;
+  /**
+   * resolved fallback request
+   */
+  importResolved?: string | undefined;
+  /**
+   * The actual request to use for importing the module. If not specified, the property name/key will be used.
+   */
+  request?: string;
+  /**
+   * global share key
+   */
+  shareKey: string;
+  /**
+   * share scope
+   */
+  shareScope: string;
+  /**
+   * version requirement
+   */
+  requiredVersion:
+    | import('webpack/lib/util/semver').SemVerRange
+    | false
+    | undefined;
+  /**
+   * package name to determine required version automatically
+   */
+  packageName: string;
+  /**
+   * don't use shared version even if version isn't valid
+   */
+  strictVersion: boolean;
+  /**
+   * use single global version
+   */
+  singleton: boolean;
+  /**
+   * include the fallback module in a sync way
+   */
+  eager: boolean;
+  /**
+   * Share a specific layer of the module, if the module supports layers
+   */
+  layer?: string | null;
+  /**
+   * Issuer layer in which the module should be resolved
+   */
+  issuerLayer?: string | null;
+};

packages/enhanced/src/declarations/plugins/sharing/ConsumeSharedPlugin.d.ts

@@ -71,4 +71,16 @@ export interface ConsumesConfig {
    * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
    */
   strictVersion?: boolean;
+  /**
+   * Issuer layer in which the module should be resolved.
+   */
+  issuerLayer?: string;
+  /**
+   * Layer for the shared module.
+   */
+  layer?: string;
+  /**
+   * The actual request to use for importing the module. If not specified, the property name/key will be used.
+   */
+  request?: string;
 }

packages/enhanced/src/declarations/plugins/sharing/ProvideSharedPlugin.d.ts

@@ -64,4 +64,12 @@ export interface ProvidesConfig {
    * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
    */
   strictVersion?: boolean;
+  /**
+   * Layer for the shared module.
+   */
+  layer?: string;
+  /**
+   * The actual request to use for importing the module. If not specified, the property name/key will be used.
+   */
+  request?: string;
 }

packages/enhanced/src/declarations/plugins/sharing/SharePlugin.d.ts

@@ -75,4 +75,16 @@ export interface SharedConfig {
    * Version of the provided module. Will replace lower matching versions, but not higher.
    */
   version?: false | string;
+  /**
+   * Issuer layer in which the module should be resolved.
+   */
+  issuerLayer?: string;
+  /**
+   * Layer for the shared module.
+   */
+  layer?: string;
+  /**
+   * The actual request to use for importing the module. Defaults to the property name.
+   */
+  request?: string;
 }

packages/enhanced/src/lib/sharing/ConsumeSharedModule.ts

@@ -24,6 +24,7 @@ import type {
 import ConsumeSharedFallbackDependency from './ConsumeSharedFallbackDependency';
 import { normalizeConsumeShareOptions } from './utils';
 import { WEBPACK_MODULE_TYPE_CONSUME_SHARED_MODULE } from '../Constants';
+import type { ConsumeOptions } from '../../declarations/plugins/sharing/ConsumeSharedModule';
 
 const { rangeToString, stringifyHoley } = require(
   normalizeWebpackPath('webpack/lib/util/semver'),
@@ -38,48 +39,6 @@ const makeSerializable = require(
   normalizeWebpackPath('webpack/lib/util/makeSerializable'),
 ) as typeof import('webpack/lib/util/makeSerializable');
 
-export type ConsumeOptions = {
-  /**
-   * fallback request
-   */
-  import?: string | undefined;
-  /**
-   * resolved fallback request
-   */
-  importResolved?: string | undefined;
-  /**
-   * global share key
-   */
-  shareKey: string;
-  /**
-   * share scope
-   */
-  shareScope: string;
-  /**
-   * version requirement
-   */
-  requiredVersion:
-    | import('webpack/lib/util/semver').SemVerRange
-    | false
-    | undefined;
-  /**
-   * package name to determine required version automatically
-   */
-  packageName: string;
-  /**
-   * don't use shared version even if version isn't valid
-   */
-  strictVersion: boolean;
-  /**
-   * use single global version
-   */
-  singleton: boolean;
-  /**
-   * include the fallback module in a sync way
-   */
-  eager: boolean;
-};
-
 /**
  * @typedef {Object} ConsumeOptions
  * @property {string=} import fallback request
@@ -91,6 +50,8 @@ export type ConsumeOptions = {
  * @property {boolean} strictVersion don't use shared version even if version isn't valid
  * @property {boolean} singleton use single global version
  * @property {boolean} eager include the fallback module in a sync way
+ * @property {string | null=} layer Share a specific layer of the module, if the module supports layers
+ * @property {string | null=} issuerLayer Issuer layer in which the module should be resolved
  */
 
 const TYPES = new Set(['consume-shared']);
@@ -103,7 +64,11 @@ class ConsumeSharedModule extends Module {
    * @param {ConsumeOptions} options consume options
    */
   constructor(context: string, options: ConsumeOptions) {
-    super(WEBPACK_MODULE_TYPE_CONSUME_SHARED_MODULE, context);
+    super(
+      WEBPACK_MODULE_TYPE_CONSUME_SHARED_MODULE,
+      context,
+      options.layer ?? undefined,
+    );
     this.options = options;
   }
 
@@ -119,10 +84,11 @@ class ConsumeSharedModule extends Module {
       strictVersion,
       singleton,
       eager,
+      layer,
     } = this.options;
     return `${WEBPACK_MODULE_TYPE_CONSUME_SHARED_MODULE}|${shareScope}|${shareKey}|${
       requiredVersion && rangeToString(requiredVersion)
-    }|${strictVersion}|${importResolved}|${singleton}|${eager}`;
+    }|${strictVersion}|${importResolved}|${singleton}|${eager}|${layer}`;
   }
 
   /**
@@ -138,14 +104,15 @@ class ConsumeSharedModule extends Module {
       strictVersion,
       singleton,
       eager,
+      layer,
     } = this.options;
     return `consume shared module (${shareScope}) ${shareKey}@${
       requiredVersion ? rangeToString(requiredVersion) : '*'
     }${strictVersion ? ' (strict)' : ''}${singleton ? ' (singleton)' : ''}${
       importResolved
         ? ` (fallback: ${requestShortener.shorten(importResolved)})`
         : ''
-    }${eager ? ' (eager)' : ''}`;
+    }${eager ? ' (eager)' : ''}${layer ? ` (${layer})` : ''}`;
   }
 
   /**
@@ -166,7 +133,6 @@ class ConsumeSharedModule extends Module {
    * @param {function((WebpackError | null)=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
    * @returns {void}
    */
-  // @ts-ignore
   override needBuild(
     context: NeedBuildContext,
     callback: (error?: WebpackError | null, needsRebuild?: boolean) => void,
@@ -182,7 +148,6 @@ class ConsumeSharedModule extends Module {
    * @param {function(WebpackError=): void} callback callback function
    * @returns {void}
    */
-  // @ts-ignore
   override build(
     options: WebpackOptions,
     compilation: Compilation,
@@ -225,18 +190,15 @@ class ConsumeSharedModule extends Module {
    * @param {UpdateHashContext} context context
    * @returns {void}
    */
-  // @ts-ignore
   override updateHash(hash: Hash, context: UpdateHashContext): void {
     hash.update(JSON.stringify(this.options));
-    // @ts-ignore
     super.updateHash(hash, context);
   }
 
   /**
    * @param {CodeGenerationContext} context context for code generation
    * @returns {CodeGenerationResult} result
    */
-  // @ts-ignore
   override codeGeneration({
     chunkGraph,
     moduleGraph,
@@ -257,7 +219,6 @@ class ConsumeSharedModule extends Module {
       if (eager) {
         const dep = this.dependencies[0];
         fallbackCode = runtimeTemplate.syncModuleFactory({
-          // @ts-ignore
           dependency: dep,
           chunkGraph,
           runtimeRequirements,
@@ -266,7 +227,6 @@ class ConsumeSharedModule extends Module {
       } else {
         const block = this.blocks[0];
         fallbackCode = runtimeTemplate.asyncModuleFactory({
-          // @ts-ignore
           block,
           chunkGraph,
           runtimeRequirements,