[wrangler] Fix types --check incorrectly reporting out of date in multi-worker setups (#14034)

Author: matingathani

.changeset/fix-types-check-multi-worker-secondary-configs.md

@@ -0,0 +1,9 @@
+---
+"wrangler": patch
+---
+
+Fix `wrangler types --check` reporting types as out of date in multi-worker setups
+
+Previously, running `wrangler types --check -c primary/wrangler.jsonc` in a multi-worker project would incorrectly report types as out of date, even when they were current. This happened because the secondary worker config paths (passed via additional `-c` flags during generation) were not stored in the generated types file header, so `--check` had no way to resolve the secondary workers' service bindings when verifying the hash.
+
+The fix stores secondary config paths in the generated file's header comment so that `--check` can recover them automatically. Users no longer need to re-pass every `-c` flag when running `--check` — only the primary config is required.

packages/wrangler/e2e/types.test.ts

@@ -133,7 +133,7 @@ describe("types", () => {
 		).split("\n");
 
 		expect(lines[1]).toMatchInlineSnapshot(
-			`"// Generated by Wrangler by running \`wrangler types -c wranglerA.toml --env-interface MyCloudflareEnv ./cflare-env.d.ts\` (hash: b5768def7c11ba0a77ed50583b661706)"`
+			`"// Generated by Wrangler by running \`wrangler types --config=wranglerA.toml --env-interface=MyCloudflareEnv ./cflare-env.d.ts\` (hash: b5768def7c11ba0a77ed50583b661706)"`
 		);
 		expect(lines[2]).match(
 			/\/\/ Runtime types generated with workerd@1\.\d{8}\.\d \d{4}-\d{2}-\d{2} ([a-z_]+,?)*/
@@ -432,7 +432,7 @@ describe("types", () => {
 				expect(output.status).toBe(1);
 			});
 
-			it("should error when --check omits secondary configs that were used during generation", async ({
+			it("should not error when --check omits secondary configs (auto-recovered from header)", async ({
 				expect,
 			}) => {
 				await helper.run(
@@ -442,8 +442,9 @@ describe("types", () => {
 				const output = await helper.run(
 					`wrangler types --check --include-runtime=false -c primary/wrangler.jsonc --path primary/worker-configuration.d.ts`
 				);
-				expect(output.stderr).toContain("out of date");
-				expect(output.status).toBe(1);
+				expect(output.stderr).toBeFalsy();
+				expect(output.stdout).toContain("up to date");
+				expect(output.status).toBe(0);
 			});
 		});
 	});

packages/wrangler/src/__tests__/type-generation.test.ts

@@ -1297,7 +1297,7 @@ describe("generate types - CLI", () => {
 		expect(fs.readFileSync("./worker-configuration.d.ts", "utf-8"))
 			.toMatchInlineSnapshot(`
 				"/* eslint-disable */
-				// Generated by Wrangler by running \`wrangler\` (hash: 87f2cdaf48add6af8118936351f2fdf6)
+				// Generated by Wrangler by running \`wrangler types\` (hash: 87f2cdaf48add6af8118936351f2fdf6)
 				// Runtime types generated with workerd@
 				interface __BaseEnv_Env {
 					SOMETHING: "asdasdfasdf";
@@ -1747,6 +1747,59 @@ describe("generate types - CLI", () => {
 		);
 	});
 
+	it("should report types as up to date for multi-worker setup without re-passing -c flags (--check)", async ({
+		expect,
+	}) => {
+		fs.mkdirSync("primary", { recursive: true });
+		fs.mkdirSync("secondary", { recursive: true });
+
+		fs.writeFileSync(
+			"./primary/index.ts",
+			`export default { async fetch() { return new Response("ok"); } };`,
+			"utf-8"
+		);
+		fs.writeFileSync(
+			"./primary/wrangler.jsonc",
+			JSON.stringify({
+				name: "primary-worker",
+				main: "./index.ts",
+				compatibility_date: "2024-01-01",
+				services: [{ binding: "SECONDARY", service: "secondary-worker" }],
+			}),
+			"utf-8"
+		);
+
+		fs.writeFileSync(
+			"./secondary/index.ts",
+			`export default { async fetch() { return new Response("ok"); } };`,
+			"utf-8"
+		);
+		fs.writeFileSync(
+			"./secondary/wrangler.jsonc",
+			JSON.stringify({
+				name: "secondary-worker",
+				main: "./index.ts",
+				compatibility_date: "2024-01-01",
+			}),
+			"utf-8"
+		);
+
+		// Generate types with both configs
+		await runWrangler(
+			"types --include-runtime=false -c primary/wrangler.jsonc -c secondary/wrangler.jsonc --path primary/worker-configuration.d.ts"
+		);
+
+		// --check with only the primary -c (no secondary -c) should still detect
+		// the types as up to date by recovering the secondary config from the header.
+		await runWrangler(
+			"types --check --include-runtime=false -c primary/wrangler.jsonc --path primary/worker-configuration.d.ts"
+		);
+
+		expect(std.out).toContain(
+			"Types at primary/worker-configuration.d.ts are up to date."
+		);
+	});
+
 	it("should include secret keys from .env, if there is no .dev.vars", async ({
 		expect,
 	}) => {
@@ -3317,7 +3370,7 @@ describe("generate types - CLI", () => {
 				expect(fs.readFileSync("./cloudflare-env.d.ts", "utf-8"))
 					.toMatchInlineSnapshot(`
 						"/* eslint-disable */
-						// Generated by Wrangler by running \`wrangler\` (hash: d3ba65ad57f6692e19d214b1925cf9fc)
+						// Generated by Wrangler by running \`wrangler types cloudflare-env.d.ts\` (hash: d3ba65ad57f6692e19d214b1925cf9fc)
 						// Runtime types generated with workerd@
 						interface __BaseEnv_Env {
 							SOMETHING: "asdasdfasdf";
@@ -3380,7 +3433,7 @@ describe("generate types - CLI", () => {
 			expect(fs.readFileSync("./my-cloudflare-env-interface.d.ts", "utf-8"))
 				.toMatchInlineSnapshot(`
 					"/* eslint-disable */
-					// Generated by Wrangler by running \`wrangler\` (hash: 98b5807d9daed69f691128b816dc9f4d)
+					// Generated by Wrangler by running \`wrangler types --env-interface=MyCloudflareEnvInterface my-cloudflare-env-interface.d.ts\` (hash: 98b5807d9daed69f691128b816dc9f4d)
 					// Runtime types generated with workerd@
 					interface __BaseEnv_MyCloudflareEnvInterface {
 						SOMETHING: "asdasdfasdf";

packages/wrangler/src/type-generation/index.ts

@@ -12,6 +12,7 @@ import {
 import chalk from "chalk";
 import * as find from "empathic/find";
 import { getNodeCompat } from "miniflare";
+import yargs from "yargs";
 import { readConfig } from "../config";
 import { createCommand } from "../core/create-command";
 import { getEntry } from "../deployment-bundle/entry";
@@ -208,6 +209,11 @@ export const typesCommand = createCommand({
 			validateOutputPath: false,
 		});
 
+		resolvedOptions.envHeaderCommand = buildGenerateTypesHeaderCommand(
+			args,
+			resolvedOptions
+		);
+
 		const {
 			config,
 			envInterface,
@@ -216,11 +222,19 @@ export const typesCommand = createCommand({
 		} = resolvedOptions;
 
 		if (args.check) {
+			// If the user didn't supply secondary configs via -c, try to recover
+			// them from the paths stored in the types file header so --check is
+			// self-contained for multi-worker setups.
+			const effectiveSecondaryEntries =
+				secondaryEntries.size > 0
+					? secondaryEntries
+					: await recoverSecondaryEntriesFromTypesFile(outputPath);
+
 			const outOfDate = await checkTypesUpToDate(
 				config,
 				envInterface,
 				outputPath,
-				secondaryEntries,
+				effectiveSecondaryEntries,
 				args.envFile,
 				args.env
 			);
@@ -292,12 +306,60 @@ export async function generateTypesFromWranglerOptions(
 	return generateTypesFromResolvedOptions(resolvedOptions, false);
 }
 
+async function recoverSecondaryEntriesFromTypesFile(
+	typesPath: string
+): Promise<Map<string, Entry>> {
+	try {
+		const lines = fs.readFileSync(typesPath, "utf-8").split("\n");
+		const headerLine = lines.find((l) =>
+			l.startsWith("// Generated by Wrangler by running `")
+		);
+		const storedCommand =
+			headerLine?.match(
+				/\/\/ Generated by Wrangler by running `(?<command>.*)`/
+			)?.groups?.command ?? "";
+
+		const rawArgs = await yargs(storedCommand).parse();
+		const configArg = rawArgs.config as string | string[] | undefined;
+		// The stored command has primary config first, then secondaries.
+		// Skip the first entry (primary — the user always re-passes it via -c).
+		const allConfigs = Array.isArray(configArg)
+			? configArg
+			: typeof configArg === "string"
+				? [configArg]
+				: [];
+		const secondaryPaths = allConfigs.slice(1);
+
+		if (secondaryPaths.length === 0) {
+			return new Map();
+		}
+
+		const secondaryConfigs = secondaryPaths.map((p) =>
+			readConfig({ config: p })
+		);
+		return resolveSecondaryEntries(secondaryConfigs, false);
+	} catch {
+		return new Map();
+	}
+}
+
 function buildGenerateTypesHeaderCommand(
 	options: GenerateTypesOptions,
 	resolvedOptions: ResolvedGenerateTypesOptions
 ): string {
 	const commandParts: string[] = ["wrangler", "types"];
 
+	// Store all config paths (primary first, then secondaries) so --check can
+	// recover secondary entries without requiring the user to re-pass every -c.
+	const configs = Array.isArray(options.config)
+		? options.config
+		: typeof options.config === "string"
+			? [options.config]
+			: [];
+	for (const configPath of configs) {
+		commandParts.push(`--config=${configPath}`);
+	}
+
 	if (options.env !== undefined) {
 		commandParts.push(`--env=${options.env}`);
 	}