Merge pull request #16562 from long76/patch-1

Introduce amdContainer support
webpack · Apr 5, 2023 · 7a6e950 · 7a6e950
2 parents 9875719 + 4eaa6ab
commit 7a6e950
Show file tree

Hide file tree

Showing 21 changed files with 208 additions and 10 deletions.
diff --git a/declarations/WebpackOptions.d.ts b/declarations/WebpackOptions.d.ts
@@ -82,6 +82,10 @@ export type FilenameTemplate =
  * Specifies the layer in which modules of this entrypoint are placed.
  */
 export type Layer = null | string;
+/**
+ * Add a container for define/require functions in the AMD module.
+ */
+export type AmdContainer = string;
 /**
  * Add a comment in the UMD wrapper.
  */
@@ -1091,6 +1095,10 @@ export interface EntryDescription {
  * Options for library.
  */
 export interface LibraryOptions {
+	/**
+	 * Add a container for define/require functions in the AMD module.
+	 */
+	amdContainer?: AmdContainer;
 	/**
 	 * Add a comment in the UMD wrapper.
 	 */
@@ -1964,6 +1972,10 @@ export interface OptimizationSplitChunksCacheGroup {
  * Options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk.
  */
 export interface Output {
+	/**
+	 * Add a container for define/require functions in the AMD module.
+	 */
+	amdContainer?: AmdContainer;
 	/**
 	 * The filename of asset modules as relative path inside the 'output.path' directory.
 	 */

diff --git a/declarations/plugins/container/ContainerPlugin.d.ts b/declarations/plugins/container/ContainerPlugin.d.ts
@@ -16,6 +16,10 @@ export type ExposesItem = string;
  * Modules that should be exposed by this container.
  */
 export type ExposesItems = ExposesItem[];
+/**
+ * Add a container for define/require functions in the AMD module.
+ */
+export type AmdContainer = string;
 /**
  * Add a comment in the UMD wrapper.
  */
@@ -114,6 +118,10 @@ export interface ExposesConfig {
  * Options for library.
  */
 export interface LibraryOptions {
+	/**
+	 * Add a container for define/require functions in the AMD module.
+	 */
+	amdContainer?: AmdContainer;
 	/**
 	 * Add a comment in the UMD wrapper.
 	 */

diff --git a/declarations/plugins/container/ModuleFederationPlugin.d.ts b/declarations/plugins/container/ModuleFederationPlugin.d.ts
@@ -16,6 +16,10 @@ export type ExposesItem = string;
  * Modules that should be exposed by this container.
  */
 export type ExposesItems = ExposesItem[];
+/**
+ * Add a container for define/require functions in the AMD module.
+ */
+export type AmdContainer = string;
 /**
  * Add a comment in the UMD wrapper.
  */
@@ -171,6 +175,10 @@ export interface ExposesConfig {
  * Options for library.
  */
 export interface LibraryOptions {
+	/**
+	 * Add a container for define/require functions in the AMD module.
+	 */
+	amdContainer?: AmdContainer;
 	/**
 	 * Add a comment in the UMD wrapper.
 	 */

diff --git a/lib/config/normalization.js b/lib/config/normalization.js
@@ -340,6 +340,10 @@ const getNormalizedWebpackOptions = config => {
 						output.auxiliaryComment !== undefined
 							? output.auxiliaryComment
 							: libraryBase.auxiliaryComment,
+					amdContainer:
+						output.amdContainer !== undefined
+							? output.amdContainer
+							: libraryBase.amdContainer,
 					export:
 						output.libraryExport !== undefined
 							? output.libraryExport

diff --git a/lib/library/AmdLibraryPlugin.js b/lib/library/AmdLibraryPlugin.js
@@ -29,6 +29,7 @@ const AbstractLibraryPlugin = require("./AbstractLibraryPlugin");
 /**
  * @typedef {Object} AmdLibraryPluginParsed
  * @property {string} name
+ * @property {string} amdContainer
  */
 
 /**
@@ -52,7 +53,7 @@ class AmdLibraryPlugin extends AbstractLibraryPlugin {
 	 * @returns {T | false} preprocess as needed by overriding
 	 */
 	parseOptions(library) {
-		const { name } = library;
+		const { name, amdContainer } = library;
 		if (this.requireAsWrapper) {
 			if (name) {
 				throw new Error(
@@ -67,7 +68,8 @@ class AmdLibraryPlugin extends AbstractLibraryPlugin {
 			}
 		}
 		return {
-			name: /** @type {string=} */ (name)
+			name: /** @type {string=} */ (name),
+			amdContainer: /** @type {string=} */ (amdContainer)
 		};
 	}
 
@@ -111,9 +113,14 @@ class AmdLibraryPlugin extends AbstractLibraryPlugin {
 			(iife || !chunk.hasRuntime() ? " return " : "\n");
 		const fnEnd = iife ? ";\n}" : "\n}";
 
+		let amdContainerPrefix = "";
+		if (options.amdContainer) {
+			amdContainerPrefix = `${options.amdContainer}.`;
+		}
+
 		if (this.requireAsWrapper) {
 			return new ConcatSource(
-				`require(${externalsDepsArray}, ${fnStart}`,
+				`${amdContainerPrefix}require(${externalsDepsArray}, ${fnStart}`,
 				source,
 				`${fnEnd});`
 			);
@@ -123,18 +130,24 @@ class AmdLibraryPlugin extends AbstractLibraryPlugin {
 			});
 
 			return new ConcatSource(
-				`define(${JSON.stringify(name)}, ${externalsDepsArray}, ${fnStart}`,
+				`${amdContainerPrefix}define(${JSON.stringify(
+					name
+				)}, ${externalsDepsArray}, ${fnStart}`,
 				source,
 				`${fnEnd});`
 			);
 		} else if (externalsArguments) {
 			return new ConcatSource(
-				`define(${externalsDepsArray}, ${fnStart}`,
+				`${amdContainerPrefix}define(${externalsDepsArray}, ${fnStart}`,
 				source,
 				`${fnEnd});`
 			);
 		} else {
-			return new ConcatSource(`define(${fnStart}`, source, `${fnEnd});`);
+			return new ConcatSource(
+				`${amdContainerPrefix}define(${fnStart}`,
+				source,
+				`${fnEnd});`
+			);
 		}
 	}
 
@@ -155,6 +168,9 @@ class AmdLibraryPlugin extends AbstractLibraryPlugin {
 				chunk
 			});
 			hash.update(name);
+		} else if (options.amdContainer) {
+			hash.update("amdContainer");
+			hash.update(options.amdContainer);
 		}
 	}
 }

diff --git a/schemas/WebpackOptions.check.js b/schemas/WebpackOptions.check.js
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -13,6 +13,11 @@
         }
       ]
     },
+    "AmdContainer": {
+      "description": "Add a container for define/require functions in the AMD module.",
+      "type": "string",
+      "minLength": 1
+    },
     "AssetFilterItemTypes": {
       "description": "Filtering value, regexp or function.",
       "cli": {
@@ -2001,6 +2006,9 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
+        "amdContainer": {
+          "$ref": "#/definitions/AmdContainer"
+        },
         "auxiliaryComment": {
           "$ref": "#/definitions/AuxiliaryComment"
         },
@@ -3046,6 +3054,16 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
+        "amdContainer": {
+          "cli": {
+            "exclude": true
+          },
+          "oneOf": [
+            {
+              "$ref": "#/definitions/AmdContainer"
+            }
+          ]
+        },
         "assetModuleFilename": {
           "$ref": "#/definitions/AssetModuleFilename"
         },

diff --git a/schemas/plugins/container/ContainerPlugin.check.js b/schemas/plugins/container/ContainerPlugin.check.js
diff --git a/schemas/plugins/container/ContainerPlugin.json b/schemas/plugins/container/ContainerPlugin.json
@@ -1,5 +1,10 @@
 {
   "definitions": {
+    "AmdContainer": {
+      "description": "Add a container for define/require functions in the AMD module.",
+      "type": "string",
+      "minLength": 1
+    },
     "AuxiliaryComment": {
       "description": "Add a comment in the UMD wrapper.",
       "anyOf": [
@@ -199,6 +204,9 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
+        "amdContainer": {
+          "$ref": "#/definitions/AmdContainer"
+        },
         "auxiliaryComment": {
           "$ref": "#/definitions/AuxiliaryComment"
         },

diff --git a/schemas/plugins/container/ModuleFederationPlugin.check.js b/schemas/plugins/container/ModuleFederationPlugin.check.js
diff --git a/schemas/plugins/container/ModuleFederationPlugin.json b/schemas/plugins/container/ModuleFederationPlugin.json
@@ -1,5 +1,10 @@
 {
   "definitions": {
+    "AmdContainer": {
+      "description": "Add a container for define/require functions in the AMD module.",
+      "type": "string",
+      "minLength": 1
+    },
     "AuxiliaryComment": {
       "description": "Add a comment in the UMD wrapper.",
       "anyOf": [
@@ -225,6 +230,9 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
+        "amdContainer": {
+          "$ref": "#/definitions/AmdContainer"
+        },
         "auxiliaryComment": {
           "$ref": "#/definitions/AuxiliaryComment"
         },

diff --git a/test/Defaults.unittest.js b/test/Defaults.unittest.js
@@ -1051,6 +1051,7 @@ describe("snapshots", () => {
 		@@ ... @@
 		-     "library": undefined,
 		+     "library": Object {
+		+       "amdContainer": undefined,
 		+       "auxiliaryComment": undefined,
 		+       "export": undefined,
 		+       "name": Array [
@@ -1094,6 +1095,7 @@ describe("snapshots", () => {
 			@@ ... @@
 			-     "library": undefined,
 			+     "library": Object {
+			+       "amdContainer": undefined,
 			+       "auxiliaryComment": undefined,
 			+       "export": undefined,
 			+       "name": Array [
@@ -1140,6 +1142,7 @@ describe("snapshots", () => {
 			@@ ... @@
 			-     "library": undefined,
 			+     "library": Object {
+			+       "amdContainer": undefined,
 			+       "auxiliaryComment": undefined,
 			+       "export": undefined,
 			+       "name": Array [
@@ -1189,6 +1192,7 @@ describe("snapshots", () => {
 			@@ ... @@
 			-     "library": undefined,
 			+     "library": Object {
+			+       "amdContainer": undefined,
 			+       "auxiliaryComment": undefined,
 			+       "export": undefined,
 			+       "name": Object {
@@ -1239,6 +1243,7 @@ describe("snapshots", () => {
 			@@ ... @@
 			-     "library": undefined,
 			+     "library": Object {
+			+       "amdContainer": undefined,
 			+       "auxiliaryComment": undefined,
 			+       "export": undefined,
 			+       "name": Object {

diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -498,7 +498,7 @@ describe("Validation", () => {
 			expect(msg).toMatchInlineSnapshot(`
 			"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 			 - configuration.output has an unknown property 'ecmaVersion'. These properties are valid:
-			   object { assetModuleFilename?, asyncChunks?, auxiliaryComment?, charset?, chunkFilename?, chunkFormat?, chunkLoadTimeout?, chunkLoading?, chunkLoadingGlobal?, clean?, compareBeforeEmit?, crossOriginLoading?, cssChunkFilename?, cssFilename?, devtoolFallbackModuleFilenameTemplate?, devtoolModuleFilenameTemplate?, devtoolNamespace?, enabledChunkLoadingTypes?, enabledLibraryTypes?, enabledWasmLoadingTypes?, environment?, filename?, globalObject?, hashDigest?, hashDigestLength?, hashFunction?, hashSalt?, hotUpdateChunkFilename?, hotUpdateGlobal?, hotUpdateMainFilename?, iife?, importFunctionName?, importMetaName?, library?, libraryExport?, libraryTarget?, module?, path?, pathinfo?, publicPath?, scriptType?, sourceMapFilename?, sourcePrefix?, strictModuleErrorHandling?, strictModuleExceptionHandling?, trustedTypes?, umdNamedDefine?, uniqueName?, wasmLoading?, webassemblyModuleFilename?, workerChunkLoading?, workerPublicPath?, workerWasmLoading? }
+			   object { amdContainer?, assetModuleFilename?, asyncChunks?, auxiliaryComment?, charset?, chunkFilename?, chunkFormat?, chunkLoadTimeout?, chunkLoading?, chunkLoadingGlobal?, clean?, compareBeforeEmit?, crossOriginLoading?, cssChunkFilename?, cssFilename?, devtoolFallbackModuleFilenameTemplate?, devtoolModuleFilenameTemplate?, devtoolNamespace?, enabledChunkLoadingTypes?, enabledLibraryTypes?, enabledWasmLoadingTypes?, environment?, filename?, globalObject?, hashDigest?, hashDigestLength?, hashFunction?, hashSalt?, hotUpdateChunkFilename?, hotUpdateGlobal?, hotUpdateMainFilename?, iife?, importFunctionName?, importMetaName?, library?, libraryExport?, libraryTarget?, module?, path?, pathinfo?, publicPath?, scriptType?, sourceMapFilename?, sourcePrefix?, strictModuleErrorHandling?, strictModuleExceptionHandling?, trustedTypes?, umdNamedDefine?, uniqueName?, wasmLoading?, webassemblyModuleFilename?, workerChunkLoading?, workerPublicPath?, workerWasmLoading? }
 			   -> Options affecting the output of the compilation. \`output\` options tell webpack how to write the compiled files to disk.
 			   Did you mean output.environment (output.ecmaVersion was a temporary configuration option during webpack 5 beta)?"
 		`)

diff --git a/test/__snapshots__/Cli.basictest.js.snap b/test/__snapshots__/Cli.basictest.js.snap
@@ -6141,6 +6141,19 @@ Object {
     "multiple": false,
     "simpleType": "string",
   },
+  "output-library-amd-container": Object {
+    "configs": Array [
+      Object {
+        "description": "Add a container for define/require functions in the AMD module.",
+        "multiple": false,
+        "path": "output.library.amdContainer",
+        "type": "string",
+      },
+    ],
+    "description": "Add a container for define/require functions in the AMD module.",
+    "multiple": false,
+    "simpleType": "string",
+  },
   "output-library-auxiliary-comment": Object {
     "configs": Array [
       Object {

diff --git a/test/configCases/target/amd-container-named/index.js b/test/configCases/target/amd-container-named/index.js
@@ -0,0 +1,8 @@
+it("should run", function() {});
+
+it("should name define", function() {
+	var fs = require("fs");
+	var source = fs.readFileSync(__filename, "utf-8");
+
+	expect(source).toMatch("window['clientContainer'].define(\"clientContainer\",");
+});
diff --git a/test/configCases/target/amd-container-named/webpack.config.js b/test/configCases/target/amd-container-named/webpack.config.js
@@ -0,0 +1,22 @@
+const webpack = require("../../../../");
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+	output: {
+		library: {
+			type: "amd",
+			name: "clientContainer",
+			amdContainer: "window['clientContainer']"
+		}
+	},
+	node: {
+		__dirname: false,
+		__filename: false
+	},
+	plugins: [
+		new webpack.BannerPlugin({
+			raw: true,
+			banner:
+				"function define(name, deps, fn) { fn(); }\nconst window = {};\nwindow['clientContainer'] = { define };\n"
+		})
+	]
+};
diff --git a/test/configCases/target/amd-container-require/index.js b/test/configCases/target/amd-container-require/index.js
@@ -0,0 +1,8 @@
+it("should run", function() {});
+
+it("should name require", function() {
+	var fs = nodeRequire("fs");
+	var source = fs.readFileSync(__filename, "utf-8");
+
+	expect(source).toMatch(/window\['clientContainer'\]\.require\(\[[^\]]*\], (function)?\(/);
+});
diff --git a/test/configCases/target/amd-container-require/webpack.config.js b/test/configCases/target/amd-container-require/webpack.config.js
@@ -0,0 +1,21 @@
+const webpack = require("../../../../");
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+	output: {
+		library: {
+			type: "amd-require",
+			amdContainer: "window['clientContainer']"
+		}
+	},
+	node: {
+		__dirname: false,
+		__filename: false
+	},
+	plugins: [
+		new webpack.BannerPlugin({
+			raw: true,
+			banner:
+				"var nodeRequire = require;\nvar require = function(deps, fn) { fn(); }\nconst window = {};\nwindow['clientContainer'] = { require };\n"
+		})
+	]
+};
diff --git a/test/configCases/target/amd-container-unnamed/index.js b/test/configCases/target/amd-container-unnamed/index.js
@@ -0,0 +1,8 @@
+it("should run", function() {});
+
+it("should name define", function() {
+	var fs = require("fs");
+	var source = fs.readFileSync(__filename, "utf-8");
+
+	expect(source).toMatch(/window\['clientContainer'\]\.define\(\[[^\]]*\], (function)?\(/);
+});