feat(enhanced): Layer via composite shareKey (#3415)

Author: ScriptedAlchemy

.changeset/ai-hungry-bear.md

@@ -0,0 +1,9 @@
+"@module-federation/enhanced": minor
+---
+
+Enhancements to layer handling in module federation tests and configuration.
+
+- Improved handling of `shareKey` for layers within `ConsumeSharedPlugin` and `ProvideSharedPlugin`.
+  - Conditionally prepend the `shareKey` with the `layer` if applicable.
+- Introduced new layer configurations to support more nuanced federation scenarios that consider multiple layers of dependency.
+```

.changeset/ai-sleepy-tiger.md

@@ -0,0 +1,6 @@
+---
+"@module-federation/runtime": minor
+---
+
+- Added a new property 'layer' of type string or null to SharedConfig.
+```

.cursorignore

@@ -1,16 +1,78 @@
-# Add directories or file patterns to ignore during indexing (e.g. foo/ or *.csv)
-./tmp
-./scripts
-./.git
-packages/storybook-addon
-packages/core
-packages/utilities
-packages/typescript
+**/.cache/
+**/.temp/
+**/coverage/
+**/*.md
+**/*.yaml
+**/*/stats.json
+**/*.yml
+**/.eslintrc*
+**/.prettierrc*
+**/.swcrc
+**/jest.config.*
+**/tsconfig.*
+apps/
+
+!packages/webpack-bundler-runtime/
+!packages/webpack-bundler-runtime/**/*
+!packages/sdk/
+!packages/sdk/**/*
+!packages/enhanced/
+!packages/enhanced/**/*
+!package.json
+!packages/*/package.json
+!**/package.json
+
+packages/dts-plugin/
+packages/typescript/
 packages/native-*
-apps
-**/configCases
-**/dist
-apps/**
-*.snap
-*.js
+packages/core/
+packages/assemble-release-plan/
+packages/native-federation-typescript/
+packages/esbuild/
+**/dist/
 
+webpack/tooling
+webpack/setup
+webpack/test
+webpack/benchmark
+.cursorignore
+jest.preset.js
+babel.config.json
+.husky
+.husky/_
+.husky/commit-msg
+.husky/pre-commit
+nx.json
+tools
+tools/scripts
+tools/scripts/ci-is-affected.mjs
+tools/scripts/publish.mjs
+tools/generators
+tools/generators/.gitkeep
+LICENSE
+.nxignore
+netlify.toml
+renovate.json
+.changeset
+.changeset/config.json
+.npmrc
+.cursorrules
+.prettierignore
+.editorconfig
+ai-lint-fix.js
+.github
+.github/workflows
+.github/.github
+.github/ISSUE_TEMPLATE
+manifest.json
+typedoc.json
+typedoc.base.json
+commitlint.config.js
+.eslintignore
+commit-gen.js
+.vscode
+.vscode/settings.json
+.vscode/launch.json
+main.py
+.verdaccio
+.verdaccio/htpasswd

.cursorrules

@@ -0,0 +1,2 @@
+- when running tests, ALWAYS run "pnpm enhanced:jest" command
+- issuerLayer is webpack specific and not used in the runtime code

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

@@ -125,7 +125,9 @@ class ConsumeSharedPlugin {
         return {
           import: item.import === false ? undefined : item.import || request,
           shareScope: item.shareScope || options.shareScope || 'default',
-          shareKey: item.shareKey || request,
+          shareKey: item.layer
+            ? `(${item.layer})${item.shareKey || request}`
+            : item.shareKey || request,
           requiredVersion:
             item.requiredVersion === false
               ? false

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

@@ -212,7 +212,7 @@ class ProvideSharedModule extends Module {
         requiredVersion: this._requiredVersion,
         strictVersion: this._strictVersion,
         singleton: this._singleton,
-        layer: this.layer
+        layer: this.layer,
       },
     });
     return { sources, data, runtimeRequirements };

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

@@ -39,7 +39,7 @@ class ProvideSharedModuleFactory extends ModuleFactory {
         dep.requiredVersion,
         dep.strictVersion,
         dep.singleton,
-        dep.layer
+        dep.layer,
       ),
     });
   }

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

@@ -95,17 +95,22 @@ class ProvideSharedPlugin {
         };
         return result;
       },
-      (item, key) => ({
-        shareKey: item.shareKey || key,
-        version: item.version,
-        shareScope: item.shareScope || options.shareScope || 'default',
-        eager: !!item.eager,
-        requiredVersion: item.requiredVersion || false,
-        strictVersion: item.strictVersion || false,
-        singleton: item.singleton || false,
-        layer: item.layer,
-        request: item.request || key,
-      }),
+      (item, key) => {
+        const request = item.request || key;
+        return {
+          shareScope: item.shareScope || options.shareScope || 'default',
+          shareKey: item.layer
+            ? `(${item.layer})${item.shareKey || request}`
+            : item.shareKey || request,
+          version: item.version,
+          eager: !!item.eager,
+          requiredVersion: item.requiredVersion,
+          strictVersion: item.strictVersion,
+          singleton: !!item.singleton,
+          layer: item.layer,
+          request,
+        };
+      },
     );
     this._provides.sort(([a], [b]) => {
       if (a < b) return -1;
@@ -265,7 +270,7 @@ class ProvideSharedPlugin {
                     config.requiredVersion!,
                     config.strictVersion!,
                     config.singleton!,
-                    config.layer
+                    config.layer,
                   ),
                   {
                     name: undefined,

packages/enhanced/test/ConfigTestCases.template.js

@@ -62,6 +62,7 @@ const describeCases = (config) => {
     for (const category of categories) {
       // eslint-disable-next-line no-loop-func
       describe(category.name, () => {
+        // category.tests = [category.tests[1]];
         for (const testName of category.tests) {
           // eslint-disable-next-line no-loop-func
           describe(testName, function () {