Improve error message displayed when a redirected config includes multiple environments (#8809)

* update wrong test `it` text

* improve error message when redirected config contains environments

* combine tests

Author: dario-piotrowicz

.changeset/silent-keys-bake.md

@@ -0,0 +1,13 @@
+---
+"wrangler": patch
+---
+
+improve error message when redirected config contains environments
+
+this change improves that validation error message that users see
+when a redirected config file contains environments, by:
+
+- cleaning the message formatting and displaying the
+  offending environments in a list
+- prompting the user to report the issue to the author
+  of the tool which has generated the config

fixtures/redirected-config-worker-with-environments/tests/index.test.ts

@@ -4,12 +4,25 @@ import { runWranglerDev } from "../../shared/src/run-wrangler-long-lived";
 
 const basePath = resolve(__dirname, "..");
 
-describe("'wrangler dev' errors because redirected configs can't include environments", () => {
-	it("uses the generated config", async ({ expect }) => {
-		await expect(
-			runWranglerDev(basePath, ["--port=0", "--inspector-port=0"])
-		).rejects.toThrowError(
-			/Redirected configurations cannot include environments but the following have been found: \"staging\"/
+describe("'wrangler dev' errors when a redirected config includes environments", () => {
+	it("A clear error message is presented which includes the offending environments and prompting the user to contact the tool's author", async ({
+		expect,
+	}) => {
+		let error: string | undefined;
+		try {
+			await runWranglerDev(basePath, ["--port=0", "--inspector-port=0"]);
+		} catch (e) {
+			if (typeof e === "string") {
+				error = e;
+			}
+		}
+		expect(error).toBeTruthy();
+		expect(error).toMatch(
+			/Redirected configurations cannot include environments but the following have been found:/
 		);
+		expect(error).toContain("staging");
+		expect(error).toContain("testing");
+
+		expect(error).toContain("Report this issue to the tool's author");
 	});
 });

fixtures/redirected-config-worker-with-environments/tools/build.ts

@@ -15,6 +15,12 @@ const config = {
 				environmentName: "staging",
 			},
 		},
+		testing: {
+			vars: {
+				generated: true,
+				environmentName: "testing",
+			},
+		},
 	},
 };
 writeFileSync("build/wrangler.json", JSON.stringify(config, undefined, 2));

fixtures/redirected-config-worker/tests/index.test.ts

@@ -20,7 +20,7 @@ describe("'wrangler dev' correctly renders pages", () => {
 		expect(text).toMatchInlineSnapshot(`"Generated: true"`);
 	});
 
-	it("specifying an environment cause an error since they are supported in redirected configs", async ({
+	it("specifying an environment causes an error since they are not supported in redirected configs", async ({
 		expect,
 	}) => {
 		await expect(

packages/wrangler/src/config/validation.ts

@@ -161,7 +161,16 @@ export function normalizeAndValidateConfig(
 
 	if (isRedirectedConfig && definedEnvironments.length > 0) {
 		diagnostics.errors.push(
-			`Redirected configurations cannot include environments but the following have been found: ${definedEnvironments.map((env) => JSON.stringify(env)).join(", ")}`
+			dedent`
+				Redirected configurations cannot include environments but the following have been found:\n${definedEnvironments
+					.map((env) => `	- ${env}`)
+					.join("\n")}
+
+
+				Such configurations are generated by tools, meaning that one of the tools
+				your application is using is generating the incorrect configuration.
+				Report this issue to the tool's author so that this can be fixed there.
+				`
 		);
 	}