Merge pull request #16388 from indeediansbrett/feat/issue-16374

feat: ignoreBrowserWarnings option to ignore browser console warnings
webpack · Apr 26, 2023 · 2c6dc77 · 2c6dc77
2 parents 7398dbd + f5d368e
commit 2c6dc77
Show file tree

Hide file tree

Showing 39 changed files with 548 additions and 17 deletions.
diff --git a/declarations/WebpackOptions.d.ts b/declarations/WebpackOptions.d.ts
@@ -2096,6 +2096,10 @@ export interface Output {
 	 * The filename of the Hot Update Main File. It is inside the 'output.path' directory.
 	 */
 	hotUpdateMainFilename?: HotUpdateMainFilename;
+	/**
+	 * Ignore warnings in the browser.
+	 */
+	ignoreBrowserWarnings?: boolean;
 	/**
 	 * Wrap javascript code into IIFE's to avoid leaking into global scope.
 	 */
@@ -3305,6 +3309,10 @@ export interface OutputNormalized {
 	 * The filename of the Hot Update Main File. It is inside the 'output.path' directory.
 	 */
 	hotUpdateMainFilename?: HotUpdateMainFilename;
+	/**
+	 * Ignore warnings in the browser.
+	 */
+	ignoreBrowserWarnings?: boolean;
 	/**
 	 * Wrap javascript code into IIFE's to avoid leaking into global scope.
 	 */

diff --git a/examples/module-federation/README.md b/examples/module-federation/README.md
@@ -679,7 +679,11 @@ module.exports = new Promise((resolve, reject) => {
 /******/ 			if(!__webpack_require__.o(__webpack_require__.S, name)) __webpack_require__.S[name] = {};
 /******/ 			// runs all init snippets from all modules reachable
 /******/ 			var scope = __webpack_require__.S[name];
-/******/ 			var warn = (msg) => (typeof console !== "undefined" && console.warn && console.warn(msg));
+/******/ 			var warn = (msg) => {
+/******/ 				typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 				})()
+/******/ 			};
 /******/ 			var uniqueName = "module-federation-aaa";
 /******/ 			var register = (name, version, factory, eager) => {
 /******/ 				var versions = scope[name] = scope[name] || {};
@@ -789,8 +793,13 @@ module.exports = new Promise((resolve, reject) => {
 /******/ 			if(entry) return get(entry);
 /******/ 			throw new Error(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
+/******/ 		var warn = (msg) => {
+/******/ 			typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 			})()
+/******/ 		};
 /******/ 		var warnInvalidVersion = (scope, scopeName, key, requiredVersion) => {
-/******/ 			typeof console !== "undefined" && console.warn && console.warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
+/******/ 			warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
 /******/ 		var get = (entry) => {
 /******/ 			entry.loaded = 1;
@@ -1208,7 +1217,11 @@ __webpack_require__.d(exports, {
 /******/ 			if(!__webpack_require__.o(__webpack_require__.S, name)) __webpack_require__.S[name] = {};
 /******/ 			// runs all init snippets from all modules reachable
 /******/ 			var scope = __webpack_require__.S[name];
-/******/ 			var warn = (msg) => (typeof console !== "undefined" && console.warn && console.warn(msg));
+/******/ 			var warn = (msg) => {
+/******/ 				typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 				})()
+/******/ 			};
 /******/ 			var uniqueName = "module-federation-bbb";
 /******/ 			var register = (name, version, factory, eager) => {
 /******/ 				var versions = scope[name] = scope[name] || {};
@@ -1289,7 +1302,7 @@ __webpack_require__.d(exports, {
 /******/ 		};
 /******/ 		var getSingletonVersion = (scope, scopeName, key, requiredVersion) => {
 /******/ 			var version = findSingletonVersionKey(scope, key);
-/******/ 			if (!satisfy(requiredVersion, version)) typeof console !== "undefined" && console.warn && console.warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));
+/******/ 			if (!satisfy(requiredVersion, version)) warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));
 /******/ 			return get(scope[key][version]);
 /******/ 		};
 /******/ 		var getStrictSingletonVersion = (scope, scopeName, key, requiredVersion) => {
@@ -1317,8 +1330,13 @@ __webpack_require__.d(exports, {
 /******/ 			if(entry) return get(entry);
 /******/ 			throw new Error(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
+/******/ 		var warn = (msg) => {
+/******/ 			typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 			})()
+/******/ 		};
 /******/ 		var warnInvalidVersion = (scope, scopeName, key, requiredVersion) => {
-/******/ 			typeof console !== "undefined" && console.warn && console.warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
+/******/ 			warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
 /******/ 		var get = (entry) => {
 /******/ 			entry.loaded = 1;
@@ -1754,7 +1772,11 @@ __webpack_require__.d(exports, {
 /******/ 			if(!__webpack_require__.o(__webpack_require__.S, name)) __webpack_require__.S[name] = {};
 /******/ 			// runs all init snippets from all modules reachable
 /******/ 			var scope = __webpack_require__.S[name];
-/******/ 			var warn = (msg) => (typeof console !== "undefined" && console.warn && console.warn(msg));
+/******/ 			var warn = (msg) => {
+/******/ 				typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 				})()
+/******/ 			};
 /******/ 			var uniqueName = "module-federation-ccc";
 /******/ 			var register = (name, version, factory, eager) => {
 /******/ 				var versions = scope[name] = scope[name] || {};
@@ -1835,7 +1857,7 @@ __webpack_require__.d(exports, {
 /******/ 		};
 /******/ 		var getSingletonVersion = (scope, scopeName, key, requiredVersion) => {
 /******/ 			var version = findSingletonVersionKey(scope, key);
-/******/ 			if (!satisfy(requiredVersion, version)) typeof console !== "undefined" && console.warn && console.warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));
+/******/ 			if (!satisfy(requiredVersion, version)) warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));
 /******/ 			return get(scope[key][version]);
 /******/ 		};
 /******/ 		var getStrictSingletonVersion = (scope, scopeName, key, requiredVersion) => {
@@ -1863,8 +1885,13 @@ __webpack_require__.d(exports, {
 /******/ 			if(entry) return get(entry);
 /******/ 			throw new Error(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
+/******/ 		var warn = (msg) => {
+/******/ 			typeof console !== "undefined" && console.warn ? console.warn(msg) : (() => {
+/******/ 		
+/******/ 			})()
+/******/ 		};
 /******/ 		var warnInvalidVersion = (scope, scopeName, key, requiredVersion) => {
-/******/ 			typeof console !== "undefined" && console.warn && console.warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
+/******/ 			warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));
 /******/ 		};
 /******/ 		var get = (entry) => {
 /******/ 			entry.loaded = 1;

diff --git a/lib/config/normalization.js b/lib/config/normalization.js
@@ -327,6 +327,7 @@ const getNormalizedWebpackOptions = config => {
 				hotUpdateChunkFilename: output.hotUpdateChunkFilename,
 				hotUpdateGlobal: output.hotUpdateGlobal,
 				hotUpdateMainFilename: output.hotUpdateMainFilename,
+				ignoreBrowserWarnings: output.ignoreBrowserWarnings,
 				iife: output.iife,
 				importFunctionName: output.importFunctionName,
 				importMetaName: output.importMetaName,

diff --git a/lib/sharing/ConsumeSharedRuntimeModule.js b/lib/sharing/ConsumeSharedRuntimeModule.js
@@ -119,8 +119,7 @@ class ConsumeSharedRuntimeModule extends RuntimeModule {
 				"scope, scopeName, key, requiredVersion",
 				[
 					"var version = findSingletonVersionKey(scope, key);",
-					"if (!satisfy(requiredVersion, version)) " +
-						'typeof console !== "undefined" && console.warn && console.warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));',
+					"if (!satisfy(requiredVersion, version)) warn(getInvalidSingletonVersionMessage(scope, key, version, requiredVersion));",
 					"return get(scope[key][version]);"
 				]
 			)};`,
@@ -166,10 +165,17 @@ class ConsumeSharedRuntimeModule extends RuntimeModule {
 					"throw new Error(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));"
 				]
 			)};`,
+			`var warn = ${
+				this.compilation.options.output.ignoreBrowserWarnings
+					? runtimeTemplate.basicFunction("", "")
+					: runtimeTemplate.basicFunction("msg", [
+							'if (typeof console !== "undefined" && console.warn) console.warn(msg);'
+					  ])
+			};`,
 			`var warnInvalidVersion = ${runtimeTemplate.basicFunction(
 				"scope, scopeName, key, requiredVersion",
 				[
-					'typeof console !== "undefined" && console.warn && console.warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));'
+					"warn(getInvalidVersionMessage(scope, scopeName, key, requiredVersion));"
 				]
 			)};`,
 			`var get = ${runtimeTemplate.basicFunction("entry", [

diff --git a/lib/sharing/ShareRuntimeModule.js b/lib/sharing/ShareRuntimeModule.js
@@ -77,10 +77,13 @@ class ShareRuntimeModule extends RuntimeModule {
 					`if(!${RuntimeGlobals.hasOwnProperty}(${RuntimeGlobals.shareScopeMap}, name)) ${RuntimeGlobals.shareScopeMap}[name] = {};`,
 					"// runs all init snippets from all modules reachable",
 					`var scope = ${RuntimeGlobals.shareScopeMap}[name];`,
-					`var warn = ${runtimeTemplate.returningFunction(
-						'typeof console !== "undefined" && console.warn && console.warn(msg)',
-						"msg"
-					)};`,
+					`var warn = ${
+						this.compilation.options.output.ignoreBrowserWarnings
+							? runtimeTemplate.basicFunction("", "")
+							: runtimeTemplate.basicFunction("msg", [
+									'if (typeof console !== "undefined" && console.warn) console.warn(msg);'
+							  ])
+					};`,
 					`var uniqueName = ${JSON.stringify(uniqueName || undefined)};`,
 					`var register = ${runtimeTemplate.basicFunction(
 						"name, version, factory, eager",

diff --git a/schemas/WebpackOptions.check.js b/schemas/WebpackOptions.check.js
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -3162,6 +3162,10 @@
         "hotUpdateMainFilename": {
           "$ref": "#/definitions/HotUpdateMainFilename"
         },
+        "ignoreBrowserWarnings": {
+          "description": "Ignore warnings in the browser.",
+          "type": "boolean"
+        },
         "iife": {
           "$ref": "#/definitions/Iife"
         },
@@ -3364,6 +3368,10 @@
         "hotUpdateMainFilename": {
           "$ref": "#/definitions/HotUpdateMainFilename"
         },
+        "ignoreBrowserWarnings": {
+          "description": "Ignore warnings in the browser.",
+          "type": "boolean"
+        },
         "iife": {
           "$ref": "#/definitions/Iife"
         },

diff --git a/test/Defaults.unittest.js b/test/Defaults.unittest.js
@@ -343,6 +343,7 @@ describe("snapshots", () => {
 		    "hotUpdateChunkFilename": "[id].[fullhash].hot-update.js",
 		    "hotUpdateGlobal": "webpackHotUpdatewebpack",
 		    "hotUpdateMainFilename": "[runtime].[fullhash].hot-update.json",
+		    "ignoreBrowserWarnings": undefined,
 		    "iife": true,
 		    "importFunctionName": "import",
 		    "importMetaName": "import.meta",

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 { 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? }
+			   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?, ignoreBrowserWarnings?, 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
@@ -6076,6 +6076,19 @@ Object {
     "multiple": false,
     "simpleType": "string",
   },
+  "output-ignore-browser-warnings": Object {
+    "configs": Array [
+      Object {
+        "description": "Ignore warnings in the browser.",
+        "multiple": false,
+        "path": "output.ignoreBrowserWarnings",
+        "type": "boolean",
+      },
+    ],
+    "description": "Ignore warnings in the browser.",
+    "multiple": false,
+    "simpleType": "boolean",
+  },
   "output-iife": Object {
     "configs": Array [
       Object {

diff --git a/test/configCases/sharing/consume-module-ignore-warnings/errors.js b/test/configCases/sharing/consume-module-ignore-warnings/errors.js
@@ -0,0 +1 @@
+module.exports = [[/prefix\/deep\/c/]];