Merge pull request #17281 from webpack/feat-environment-to-loader-con…

…text feat: support `environment` in loader context
webpack · May 31, 2023 · 6d8d96b · 6d8d96b
2 parents e0cd928 + 9c7693b
commit 6d8d96b
Show file tree

Hide file tree

Showing 16 changed files with 201 additions and 9 deletions.
diff --git a/declarations/LoaderContext.d.ts b/declarations/LoaderContext.d.ts
@@ -13,6 +13,7 @@ import type {
 	ImportModuleOptions
 } from "../lib/dependencies/LoaderPlugin";
 import type { Resolver } from "enhanced-resolve";
+import type { Environment } from "./WebpackOptions";
 
 type ResolveCallback = Parameters<Resolver["resolve"]>[4];
 type Schema = Parameters<typeof validate>[0];
@@ -219,6 +220,12 @@ export interface LoaderRunnerLoaderContext<OptionsType> {
 	 * Example: "web"
 	 */
 	target: string;
+
+	/**
+	 * Tell what kind of ES-features may be used in the generated runtime-code.
+	 * Example: { arrowFunction: true }
+	 */
+	environment: Environment;
 }
 
 type AdditionalData = {

diff --git a/declarations/WebpackOptions.d.ts b/declarations/WebpackOptions.d.ts
@@ -2246,10 +2246,18 @@ export interface Environment {
 	 * The environment supports an async import() function to import EcmaScript modules.
 	 */
 	dynamicImport?: boolean;
+	/**
+	 * The environment supports an async import() is available when creating a worker.
+	 */
+	dynamicImportInWorker?: boolean;
 	/**
 	 * The environment supports 'for of' iteration ('for (const x of array) { ... }').
 	 */
 	forOf?: boolean;
+	/**
+	 * The environment supports 'globalThis'.
+	 */
+	globalThis?: boolean;
 	/**
 	 * The environment supports EcmaScript Module syntax to import EcmaScript modules (import ... from '...').
 	 */

diff --git a/lib/config/defaults.js b/lib/config/defaults.js
@@ -248,7 +248,7 @@ const applyWebpackOptionsDefaults = options => {
 
 	applyLoaderDefaults(
 		/** @type {NonNullable<WebpackOptions["loader"]>} */ (options.loader),
-		{ targetProperties }
+		{ targetProperties, environment: options.output.environment }
 	);
 
 	F(options, "externalsType", () => {
@@ -1036,6 +1036,22 @@ const applyOutputDefaults = (
 	 * @returns {boolean | undefined} true, when v is truthy or undefined, or c is truthy
 	 */
 	const conditionallyOptimistic = (v, c) => (v === undefined && c) || v;
+
+	F(
+		environment,
+		"globalThis",
+		() => /** @type {boolean | undefined} */ (tp && tp.globalThis)
+	);
+	F(
+		environment,
+		"bigIntLiteral",
+		() => /** @type {boolean | undefined} */ (tp && tp.bigIntLiteral)
+	);
+	F(
+		environment,
+		"const",
+		() => tp && optimistic(/** @type {boolean | undefined} */ (tp.const))
+	);
 	F(
 		environment,
 		"arrowFunction",
@@ -1044,8 +1060,8 @@ const applyOutputDefaults = (
 	);
 	F(
 		environment,
-		"const",
-		() => tp && optimistic(/** @type {boolean | undefined} */ (tp.const))
+		"forOf",
+		() => tp && optimistic(/** @type {boolean | undefined} */ (tp.forOf))
 	);
 	F(
 		environment,
@@ -1055,20 +1071,28 @@ const applyOutputDefaults = (
 	);
 	F(
 		environment,
-		"forOf",
-		() => tp && optimistic(/** @type {boolean | undefined} */ (tp.forOf))
+		"optionalChaining",
+		() =>
+			tp && optimistic(/** @type {boolean | undefined} */ (tp.optionalChaining))
 	);
 	F(
 		environment,
-		"bigIntLiteral",
-		() => /** @type {boolean | undefined} */ (tp && tp.bigIntLiteral)
+		"templateLiteral",
+		() =>
+			tp && optimistic(/** @type {boolean | undefined} */ (tp.templateLiteral))
 	);
 	F(environment, "dynamicImport", () =>
 		conditionallyOptimistic(
 			/** @type {boolean | undefined} */ (tp && tp.dynamicImport),
 			output.module
 		)
 	);
+	F(environment, "dynamicImportInWorker", () =>
+		conditionallyOptimistic(
+			/** @type {boolean | undefined} */ (tp && tp.dynamicImportInWorker),
+			output.module
+		)
+	);
 	F(environment, "module", () =>
 		conditionallyOptimistic(
 			/** @type {boolean | undefined} */ (tp && tp.module),
@@ -1215,9 +1239,10 @@ const applyExternalsPresetsDefaults = (
  * @param {Loader} loader options
  * @param {Object} options options
  * @param {TargetProperties | false} options.targetProperties target properties
+ * @param {Environment} options.environment environment
  * @returns {void}
  */
-const applyLoaderDefaults = (loader, { targetProperties }) => {
+const applyLoaderDefaults = (loader, { targetProperties, environment }) => {
 	F(loader, "target", () => {
 		if (targetProperties) {
 			if (targetProperties.electron) {
@@ -1231,6 +1256,7 @@ const applyLoaderDefaults = (loader, { targetProperties }) => {
 			if (targetProperties.web) return "web";
 		}
 	});
+	D(loader, "environment", environment);
 };
 
 /**

diff --git a/schemas/WebpackOptions.check.js b/schemas/WebpackOptions.check.js
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -744,10 +744,18 @@
           "description": "The environment supports an async import() function to import EcmaScript modules.",
           "type": "boolean"
         },
+        "dynamicImportInWorker": {
+          "description": "The environment supports an async import() is available when creating a worker.",
+          "type": "boolean"
+        },
         "forOf": {
           "description": "The environment supports 'for of' iteration ('for (const x of array) { ... }').",
           "type": "boolean"
         },
+        "globalThis": {
+          "description": "The environment supports 'globalThis'.",
+          "type": "boolean"
+        },
         "module": {
           "description": "The environment supports EcmaScript Module syntax to import EcmaScript modules (import ... from '...').",
           "type": "boolean"

diff --git a/test/Defaults.unittest.js b/test/Defaults.unittest.js
@@ -117,6 +117,19 @@ describe("snapshots", () => {
 		  "ignoreWarnings": undefined,
 		  "infrastructureLogging": Object {},
 		  "loader": Object {
+		    "environment": Object {
+		      "arrowFunction": true,
+		      "bigIntLiteral": undefined,
+		      "const": true,
+		      "destructuring": true,
+		      "dynamicImport": undefined,
+		      "dynamicImportInWorker": undefined,
+		      "forOf": true,
+		      "globalThis": undefined,
+		      "module": undefined,
+		      "optionalChaining": true,
+		      "templateLiteral": true,
+		    },
 		    "target": "web",
 		  },
 		  "mode": "none",
@@ -331,8 +344,12 @@ describe("snapshots", () => {
 		      "const": true,
 		      "destructuring": true,
 		      "dynamicImport": undefined,
+		      "dynamicImportInWorker": undefined,
 		      "forOf": true,
+		      "globalThis": undefined,
 		      "module": undefined,
+		      "optionalChaining": true,
+		      "templateLiteral": true,
 		    },
 		    "filename": "[name].js",
 		    "globalObject": "self",
@@ -885,11 +902,21 @@ describe("snapshots", () => {
 		-   "externalsType": "var",
 		+   "externalsType": "module",
 		@@ ... @@
+		-       "dynamicImport": undefined,
+		-       "dynamicImportInWorker": undefined,
+		+       "dynamicImport": true,
+		+       "dynamicImportInWorker": true,
+		@@ ... @@
+		-       "module": undefined,
+		+       "module": true,
+		@@ ... @@
 		-     "chunkFilename": "[name].js",
 		+     "chunkFilename": "[name].mjs",
 		@@ ... @@
 		-       "dynamicImport": undefined,
+		-       "dynamicImportInWorker": undefined,
 		+       "dynamicImport": true,
+		+       "dynamicImportInWorker": true,
 		@@ ... @@
 		-       "module": undefined,
 		+       "module": true,
@@ -1991,6 +2018,29 @@ describe("snapshots", () => {
 			-   "context": "<cwd>",
 			+   "context": "<cwd>/test/fixtures/browserslist",
 			@@ ... @@
+			-       "arrowFunction": true,
+			-       "bigIntLiteral": undefined,
+			-       "const": true,
+			-       "destructuring": true,
+			-       "dynamicImport": undefined,
+			-       "dynamicImportInWorker": undefined,
+			-       "forOf": true,
+			-       "globalThis": undefined,
+			-       "module": undefined,
+			-       "optionalChaining": true,
+			-       "templateLiteral": true,
+			+       "arrowFunction": false,
+			+       "bigIntLiteral": false,
+			+       "const": false,
+			+       "destructuring": false,
+			+       "dynamicImport": false,
+			+       "dynamicImportInWorker": false,
+			+       "forOf": false,
+			+       "globalThis": false,
+			+       "module": false,
+			+       "optionalChaining": false,
+			+       "templateLiteral": false,
+			@@ ... @@
 			-     "chunkLoadingGlobal": "webpackChunkwebpack",
 			+     "chunkLoadingGlobal": "webpackChunkbrowserslist_test",
 			@@ ... @@
@@ -2002,15 +2052,23 @@ describe("snapshots", () => {
 			-       "const": true,
 			-       "destructuring": true,
 			-       "dynamicImport": undefined,
+			-       "dynamicImportInWorker": undefined,
 			-       "forOf": true,
+			-       "globalThis": undefined,
 			-       "module": undefined,
+			-       "optionalChaining": true,
+			-       "templateLiteral": true,
 			+       "arrowFunction": false,
 			+       "bigIntLiteral": false,
 			+       "const": false,
 			+       "destructuring": false,
 			+       "dynamicImport": false,
+			+       "dynamicImportInWorker": false,
 			+       "forOf": false,
+			+       "globalThis": false,
 			+       "module": false,
+			+       "optionalChaining": false,
+			+       "templateLiteral": false,
 			@@ ... @@
 			-     "hotUpdateGlobal": "webpackHotUpdatewebpack",
 			+     "hotUpdateGlobal": "webpackHotUpdatebrowserslist_test",

diff --git a/test/__snapshots__/Cli.basictest.js.snap b/test/__snapshots__/Cli.basictest.js.snap
@@ -5946,6 +5946,19 @@ Object {
     "multiple": false,
     "simpleType": "boolean",
   },
+  "output-environment-dynamic-import-in-worker": Object {
+    "configs": Array [
+      Object {
+        "description": "The environment supports an async import() is available when creating a worker.",
+        "multiple": false,
+        "path": "output.environment.dynamicImportInWorker",
+        "type": "boolean",
+      },
+    ],
+    "description": "The environment supports an async import() is available when creating a worker.",
+    "multiple": false,
+    "simpleType": "boolean",
+  },
   "output-environment-for-of": Object {
     "configs": Array [
       Object {
@@ -5959,6 +5972,19 @@ Object {
     "multiple": false,
     "simpleType": "boolean",
   },
+  "output-environment-global-this": Object {
+    "configs": Array [
+      Object {
+        "description": "The environment supports 'globalThis'.",
+        "multiple": false,
+        "path": "output.environment.globalThis",
+        "type": "boolean",
+      },
+    ],
+    "description": "The environment supports 'globalThis'.",
+    "multiple": false,
+    "simpleType": "boolean",
+  },
   "output-environment-module": Object {
     "configs": Array [
       Object {

diff --git a/test/configCases/ecmaVersion/browserslist-config-env/webpack.config.js b/test/configCases/ecmaVersion/browserslist-config-env/webpack.config.js
@@ -13,8 +13,12 @@ module.exports = {
 			  "const": false,
 			  "destructuring": false,
 			  "dynamicImport": false,
+			  "dynamicImportInWorker": false,
 			  "forOf": false,
+			  "globalThis": false,
 			  "module": false,
+			  "optionalChaining": false,
+			  "templateLiteral": false,
 			}
 		`);
 				expect(compilation.options.externalsPresets).toMatchInlineSnapshot(`

diff --git a/test/configCases/ecmaVersion/browserslist-config/webpack.config.js b/test/configCases/ecmaVersion/browserslist-config/webpack.config.js
@@ -13,8 +13,12 @@ module.exports = {
 			  "const": false,
 			  "destructuring": false,
 			  "dynamicImport": false,
+			  "dynamicImportInWorker": false,
 			  "forOf": false,
+			  "globalThis": false,
 			  "module": false,
+			  "optionalChaining": false,
+			  "templateLiteral": false,
 			}
 		`);
 				expect(compilation.options.externalsPresets).toMatchInlineSnapshot(`

diff --git a/test/configCases/ecmaVersion/browserslist-query/webpack.config.js b/test/configCases/ecmaVersion/browserslist-query/webpack.config.js
@@ -11,8 +11,12 @@ module.exports = {
 			  "const": false,
 			  "destructuring": false,
 			  "dynamicImport": false,
+			  "dynamicImportInWorker": false,
 			  "forOf": false,
+			  "globalThis": false,
 			  "module": false,
+			  "optionalChaining": false,
+			  "templateLiteral": false,
 			}
 		`);
 				expect(compilation.options.externalsPresets).toMatchInlineSnapshot(`

diff --git a/test/configCases/ecmaVersion/browserslist/webpack.config.js b/test/configCases/ecmaVersion/browserslist/webpack.config.js
@@ -11,8 +11,12 @@ module.exports = {
 			  "const": true,
 			  "destructuring": true,
 			  "dynamicImport": true,
+			  "dynamicImportInWorker": false,
 			  "forOf": true,
+			  "globalThis": true,
 			  "module": true,
+			  "optionalChaining": true,
+			  "templateLiteral": true,
 			}
 		`);
 				expect(compilation.options.externalsPresets).toMatchInlineSnapshot(`

diff --git a/test/configCases/ecmaVersion/loader-context/index.js b/test/configCases/ecmaVersion/loader-context/index.js
@@ -0,0 +1,9 @@
+import mod from "./loader.js!./module";
+
+it("should compile and export target and environment", function() {
+	expect(mod.target).toBe("node");
+	expect(mod.environment.globalThis).toBe(false);
+	expect(mod.environment.optionalChaining).toBe(true);
+	expect(mod.environment.templateLiteral).toBe(true);
+	expect(mod.environment.dynamicImportInWorker).toBe(true);
+});
diff --git a/test/configCases/ecmaVersion/loader-context/loader.js b/test/configCases/ecmaVersion/loader-context/loader.js
@@ -0,0 +1,7 @@
+/** @type {import("../../../../types").LoaderDefinition<{}>} */
+module.exports = function loader(content) {
+	const target = this.target;
+	const environment = this.environment;
+
+	return `export default ${JSON.stringify({ target, environment})}`;
+}
diff --git a/test/configCases/ecmaVersion/loader-context/module.js b/test/configCases/ecmaVersion/loader-context/module.js
@@ -0,0 +1 @@
+export default "test";
diff --git a/test/configCases/ecmaVersion/loader-context/webpack.config.js b/test/configCases/ecmaVersion/loader-context/webpack.config.js
@@ -0,0 +1,10 @@
+/** @type {import("../../../../").Configuration} */
+module.exports = {
+	target: ["node", "es2020"],
+	output: {
+		environment: {
+			// Our target supports `globalThis`, but for test purposes we set it to `false`
+			globalThis: false
+		}
+	}
+};