[wrangler] add validation to redirected configs in regards to environments (#8596)

* [wrangler] add validation to redirected configs in regards to environments

* error instead of warning on specified environments

* Update packages/wrangler/src/config/validation.ts

Co-authored-by: emily-shen <[email protected]>

* Update packages/wrangler/src/config/validation.ts

Co-authored-by: James Opstad <[email protected]>

* update lock file

* update fixture tests

---------

Co-authored-by: emily-shen <[email protected]>
Co-authored-by: James Opstad <[email protected]>

Author: 3 people

.changeset/sour-things-run.md

@@ -0,0 +1,16 @@
+---
+"wrangler": patch
+---
+
+add validation to redirected configs in regards to environments
+
+add the following validation behaviors to wrangler deploy commands, that relate
+to redirected configs (i.e. config files specified by `.wrangler/deploy/config.json` files):
+
+- redirected configs are supposed to be already flattened configurations without any
+  environment (i.e. a build tool should generate redirected configs already targeting specific
+  environments), so if wrangler encounters a redirected config with some environments defined
+  it should error
+- given the point above, specifying an environment (`--env=my-env`) when using redirected
+  configs is incorrect, so these environments should be ignored and a warning should be
+  presented to the user

.prettierignore

@@ -46,6 +46,7 @@ fixtures/interactive-dev-tests/src/startup-error.ts
 # These are generated by the build step
 fixtures/pages-redirected-config/build/*
 fixtures/redirected-config-worker/build/*
+fixtures/redirected-config-worker-with-environments/build/*
 
 # Import attributes generate an error
 packages/unenv-preset/src/preset.ts

fixtures/redirected-config-worker-with-environments/.gitignore

@@ -0,0 +1,2 @@
+dist
+build

fixtures/redirected-config-worker-with-environments/package.json

@@ -0,0 +1,23 @@
+{
+	"name": "redirected-config-worker-with-environments",
+	"private": true,
+	"description": "",
+	"license": "ISC",
+	"author": "",
+	"main": "src/index.js",
+	"scripts": {
+		"build": "node -r esbuild-register tools/build.ts",
+		"check:type": "tsc",
+		"dev": "pnpm run build && wrangler dev",
+		"test:ci": "pnpm run build && vitest run"
+	},
+	"devDependencies": {
+		"@cloudflare/workers-tsconfig": "workspace:^",
+		"undici": "catalog:default",
+		"vitest": "catalog:default",
+		"wrangler": "workspace:*"
+	},
+	"volta": {
+		"extends": "../../package.json"
+	}
+}

fixtures/redirected-config-worker-with-environments/src/index.js

@@ -0,0 +1,5 @@
+export default {
+	async fetch(request, env) {
+		return new Response("Generated: " + env.generated ?? false);
+	},
+};

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

@@ -0,0 +1,15 @@
+import { resolve } from "path";
+import { describe, it } from "vitest";
+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\"/
+		);
+	});
+});

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

@@ -0,0 +1,30 @@
+import { copyFileSync, mkdirSync, rmSync, writeFileSync } from "fs";
+
+// Create a pseudo build directory
+rmSync("build", { recursive: true, force: true });
+mkdirSync("build");
+const config = {
+	name: "redirected-config-worker",
+	compatibility_date: "2024-12-01",
+	main: "index.js",
+	vars: { generated: true, environmentName: "top-level" },
+	env: {
+		staging: {
+			vars: {
+				generated: true,
+				environmentName: "staging",
+			},
+		},
+	},
+};
+writeFileSync("build/wrangler.json", JSON.stringify(config, undefined, 2));
+copyFileSync("src/index.js", "build/index.js");
+
+// Create the redirect file
+rmSync(".wrangler/deploy", { recursive: true, force: true });
+mkdirSync(".wrangler/deploy", { recursive: true });
+const redirect = { configPath: "../../build/wrangler.json" };
+writeFileSync(
+	".wrangler/deploy/config.json",
+	JSON.stringify(redirect, undefined, 2)
+);

fixtures/redirected-config-worker-with-environments/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"esModuleInterop": true,
+		"module": "CommonJS",
+		"lib": ["ES2020"],
+		"types": ["node"],
+		"skipLibCheck": true,
+		"moduleResolution": "node",
+		"noEmit": true
+	},
+	"include": ["tests", "../../node-types.d.ts"]
+}

fixtures/redirected-config-worker-with-environments/turbo.json

@@ -0,0 +1,9 @@
+{
+	"$schema": "http://turbo.build/schema.json",
+	"extends": ["//"],
+	"tasks": {
+		"build": {
+			"outputs": ["build/**"]
+		}
+	}
+}

fixtures/redirected-config-worker-with-environments/vitest.config.mts

@@ -0,0 +1,9 @@
+import { defineProject, mergeConfig } from "vitest/config";
+import configShared from "../../vitest.shared";
+
+export default mergeConfig(
+	configShared,
+	defineProject({
+		test: {},
+	})
+);