Fix autoconfig for Astro 6+ projects to skip wrangler config generation (#12856)

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: Edmund Hung <edmund@cloudflare.com>

Author: 3 people

.changeset/real-plants-slide.md

@@ -0,0 +1,7 @@
+---
+"wrangler": patch
+---
+
+Fix autoconfig for Astro v6 projects to skip wrangler config generation
+
+Astro 6+ generates its own wrangler configuration on build, so autoconfig now detects the Astro version and skips creating a `wrangler.jsonc` file for projects using Astro 6 or later. This prevents conflicts between the autoconfig-generated config and Astro's built-in config generation.

packages/create-cloudflare/e2e/tests/frameworks/test-config.ts

@@ -723,7 +723,6 @@ function getExperimentalFrameworkTestConfig(
 		{
 			name: "astro:workers",
 			argv: ["--platform", "workers"],
-			quarantine: true,
 			testCommitMessage: true,
 			unsupportedOSs: ["win32"],
 			verifyDeploy: {

packages/wrangler/src/autoconfig/frameworks/astro.ts

@@ -1,6 +1,9 @@
+import assert from "node:assert";
 import { writeFileSync } from "node:fs";
 import { brandColor, dim } from "@cloudflare/cli/colors";
+import semiver from "semiver";
 import { runCommand } from "../c3-vendor/command";
+import { getInstalledPackageVersion } from "./utils/packages";
 import { Framework } from ".";
 import type { ConfigurationOptions, ConfigurationResults } from ".";
 
@@ -9,7 +12,10 @@ export class Astro extends Framework {
 		outputDir,
 		dryRun,
 		packageManager,
+		projectPath,
 	}: ConfigurationOptions): Promise<ConfigurationResults> {
+		const astroVersion = getAstroVersion(projectPath);
+
 		const { npx } = packageManager;
 		if (!dryRun) {
 			await runCommand([npx, "astro", "add", "cloudflare", "-y"], {
@@ -21,18 +27,43 @@ export class Astro extends Framework {
 			});
 			writeFileSync("public/.assetsignore", "_worker.js\n_routes.json");
 		}
-		return {
-			wranglerConfig: {
-				main: `${outputDir}/_worker.js/index.js`,
-				compatibility_flags: ["global_fetch_strictly_public"],
-				assets: {
-					binding: "ASSETS",
-					directory: outputDir,
+
+		if (semiver(astroVersion, "6.0.0") < 0) {
+			// Before version 6 Astro required a wrangler config file
+			return {
+				wranglerConfig: {
+					main: `${outputDir}/_worker.js/index.js`,
+					compatibility_flags: ["global_fetch_strictly_public"],
+					assets: {
+						binding: "ASSETS",
+						directory: outputDir,
+					},
 				},
-			},
+			};
+		}
+
+		// From version 6 Astro doesn't need a wrangler config file but generates a redirected config on build
+		return {
+			wranglerConfig: null,
 		};
 	}
 
 	configurationDescription =
 		'Configuring project for Astro with "astro add cloudflare"';
 }
+
+/**
+ * Gets the installed version of the "astro" package
+ * @param projectPath The path of the project
+ */
+function getAstroVersion(projectPath: string): string {
+	const packageName = "astro";
+	const astroVersion = getInstalledPackageVersion(packageName, projectPath);
+
+	assert(
+		astroVersion,
+		`Unable to discern the version of the \`${packageName}\` package`
+	);
+
+	return astroVersion;
+}

packages/wrangler/src/autoconfig/frameworks/index.ts

@@ -18,7 +18,7 @@ export type PackageJsonScriptsOverrides = {
 
 export type ConfigurationResults = {
 	/** The wrangler configuration that the framework's `configure()` hook should generate. `null` if autoconfig should not create the wrangler file (in case an external tool already does that) */
-	wranglerConfig: RawConfig;
+	wranglerConfig: RawConfig | null;
 	// Scripts to override in the package.json. Most frameworks should not need to do this, as their default detected build command will be sufficient
 	packageJsonScriptsOverrides?: PackageJsonScriptsOverrides;
 	// Build command to override the standard one (`npm run build` or framework's build command)

packages/wrangler/src/autoconfig/run.ts

@@ -116,10 +116,12 @@ export async function runAutoConfig(
 
 		autoConfigSummary = await buildOperationsSummary(
 			{ ...autoConfigDetails, outputDir: autoConfigDetails.outputDir },
-			ensureNodejsCompatIsInConfig({
-				...wranglerConfig,
-				...dryRunConfigurationResults.wranglerConfig,
-			}),
+			dryRunConfigurationResults.wranglerConfig === null
+				? null
+				: ensureNodejsCompatIsInConfig({
+						...wranglerConfig,
+						...dryRunConfigurationResults.wranglerConfig,
+					}),
 			{
 				build:
 					dryRunConfigurationResults.buildCommandOverride ??
@@ -199,13 +201,15 @@ export async function runAutoConfig(
 			);
 		}
 
-		await saveWranglerJsonc(
-			autoConfigDetails.projectPath,
-			ensureNodejsCompatIsInConfig({
-				...wranglerConfig,
-				...configurationResults.wranglerConfig,
-			})
-		);
+		if (configurationResults.wranglerConfig !== null) {
+			await saveWranglerJsonc(
+				autoConfigDetails.projectPath,
+				ensureNodejsCompatIsInConfig({
+					...wranglerConfig,
+					...configurationResults.wranglerConfig,
+				})
+			);
+		}
 
 		addWranglerToGitIgnore(autoConfigDetails.projectPath);
 
@@ -316,7 +320,7 @@ export async function buildOperationsSummary(
 	autoConfigDetails: AutoConfigDetailsForNonConfiguredProject & {
 		outputDir: NonNullable<AutoConfigDetails["outputDir"]>;
 	},
-	wranglerConfigToWrite: RawConfig,
+	wranglerConfigToWrite: RawConfig | null,
 	projectCommands: {
 		build?: string;
 		deploy: string;
@@ -329,7 +333,11 @@ export async function buildOperationsSummary(
 	const summary: AutoConfigSummary = {
 		wranglerInstall: false,
 		scripts: {},
-		wranglerConfig: wranglerConfigToWrite,
+		...(wranglerConfigToWrite !== null
+			? {
+					wranglerConfig: wranglerConfigToWrite,
+				}
+			: {}),
 		outputDir: autoConfigDetails.outputDir,
 		frameworkId: autoConfigDetails.framework.id,
 		buildCommand: projectCommands.build,
@@ -360,7 +368,7 @@ export async function buildOperationsSummary(
 
 		const containsServerSideCode =
 			// If there is an entrypoint then we know that there is server side code
-			!!wranglerConfigToWrite.main;
+			!!wranglerConfigToWrite?.main;
 
 		if (
 			// If there is no server side code, then there is no need to add the cf-typegen script

packages/wrangler/src/autoconfig/types.ts

@@ -63,7 +63,7 @@ export type AutoConfigOptions = {
 export type AutoConfigSummary = {
 	scripts: Record<string, string>;
 	wranglerInstall: boolean;
-	wranglerConfig: RawConfig;
+	wranglerConfig?: RawConfig;
 	frameworkConfiguration?: string;
 	outputDir: string;
 	frameworkId?: string;