fixup! feat: support extending the user configuration

Author: petebacondarwin

packages/wrangler/src/__tests__/configuration.test.ts

@@ -76,7 +76,7 @@ describe("readConfig()", () => {
 				Object {
 				  "debug": "",
 				  "err": "",
-				  "info": "Extending with configuration found in .wrangler/config/extra.json.",
+				  "info": "Loading additional configuration from .wrangler/config/extra.json.",
 				  "out": "",
 				  "warn": "",
 				}
@@ -177,19 +177,23 @@ describe("readConfig()", () => {
 			}
 
 			expect(error.toString().replaceAll("\\", "/")).toMatchInlineSnapshot(`
-				"Error: Extending with configuration found in .wrangler/config/extra.json.
-				  - Expected \\"compatibility_date\\" to be of type string but got 2021."
+				"Error: Processing wrangler.toml configuration:
+
+				  - Processing extra configuration found in .wrangler/config/extra.json.
+				    - Expected \\"compatibility_date\\" to be of type string but got 2021."
 			`);
 
 			expect(std).toMatchInlineSnapshot(`
 				Object {
 				  "debug": "",
 				  "err": "",
-				  "info": "",
+				  "info": "Loading additional configuration from .wrangler/config/extra.json.",
 				  "out": "",
-				  "warn": "▲ [WARNING] Extending with configuration found in .wrangler/config/extra.json.
+				  "warn": "▲ [WARNING] Processing wrangler.toml configuration:
+
 
-				    - Unexpected fields found in extended config field: \\"unexpected_property\\"
+				    - Processing extra configuration found in .wrangler/config/extra.json.
+				      - Unexpected fields found in extended config field: \\"unexpected_property\\"
 
 				",
 				}
@@ -242,6 +246,32 @@ describe("readConfig()", () => {
 				})
 			);
 		});
+
+		it("should support extending with a Pages output directory property", () => {
+			const pages_build_output_dir = "./public";
+
+			writeWranglerToml({});
+			writeExtraJson({
+				pages_build_output_dir,
+			});
+
+			const config = readConfig("wrangler.toml", {});
+			expect(config).toEqual(
+				expect.objectContaining({
+					pages_build_output_dir: "./public",
+				})
+			);
+
+			expect(std).toMatchInlineSnapshot(`
+				Object {
+				  "debug": "",
+				  "err": "",
+				  "info": "Loading additional configuration from .wrangler/config/extra.json.",
+				  "out": "",
+				  "warn": "",
+				}
+			`);
+		});
 	});
 });
 

packages/wrangler/src/__tests__/helpers/write-wrangler-toml.ts

@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import TOML from "@iarna/toml";
+import { PagesConfigFields } from "../../config/config";
 import { ensureDirectoryExistsSync } from "../../utils/filesystem";
 import type { RawConfig, RawEnvironment } from "../../config";
 
@@ -36,7 +37,7 @@ export function writeWranglerJson(
 }
 
 export function writeExtraJson(
-	config: RawEnvironment = {},
+	config: RawEnvironment & Partial<PagesConfigFields> = {},
 	path = "./.wrangler/config/extra.json"
 ) {
 	ensureDirectoryExistsSync(path);

packages/wrangler/src/config/config.ts

@@ -30,18 +30,6 @@ export type RawConfig = Partial<ConfigFields<RawDevConfig>> &
 	DeprecatedConfigFields &
 	EnvironmentMap & { $schema?: string };
 
-// Pages-specific configuration fields
-interface PagesConfigFields {
-	/**
-	 * The directory of static assets to serve.
-	 *
-	 * The presence of this field in `wrangler.toml` indicates a Pages project,
-	 * and will prompt the handling of the configuration file according to the
-	 * Pages-specific validation rules.
-	 */
-	pages_build_output_dir?: string;
-}
-
 export interface ConfigFields<Dev extends RawDevConfig> {
 	configPath: string | undefined;
 
@@ -185,7 +173,7 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 }
 
 // Pages-specific configuration fields
-interface PagesConfigFields {
+export interface PagesConfigFields {
 	/**
 	 * The directory of static assets to serve.
 	 *

packages/wrangler/src/config/extra.ts

@@ -1,13 +1,12 @@
 import { existsSync } from "node:fs";
 import { dirname, relative, resolve } from "node:path";
 import { defu } from "defu";
-import { UserError } from "../errors";
 import { logger } from "../logger";
 import { parseJSONC, readFileSync } from "../parse";
 import { Diagnostics } from "./diagnostics";
 import { normalizeAndValidateEnvironment } from "./validation";
 import { validateAdditionalProperties } from "./validation-helpers";
-import type { Config } from "./config";
+import type { Config, PagesConfigFields } from "./config";
 import type { Environment } from "./environment";
 
 /**
@@ -17,26 +16,25 @@ import type { Environment } from "./environment";
 export function extendConfiguration(
 	configPath: string | undefined,
 	userConfig: Config,
-	hideWarnings: boolean
-): Config {
+	hideMessages: boolean
+): { config: Config; diagnostics: Diagnostics } {
 	// Handle extending the user configuration
 	const extraPath = getExtraConfigPath(configPath && dirname(configPath));
 	const extra = loadExtraConfig(extraPath);
 	if (extra === undefined) {
-		return userConfig;
+		return { config: userConfig, diagnostics: new Diagnostics("") };
 	}
 
-	const { config, diagnostics } = extra;
-	if (!hideWarnings && !diagnostics.hasWarnings() && !diagnostics.hasErrors()) {
-		logger.info(diagnostics.description);
+	if (!hideMessages) {
+		logger.info(
+			`Loading additional configuration from ${relative(process.cwd(), extraPath)}.`
+		);
 	}
-	if (diagnostics.hasWarnings() && !hideWarnings) {
-		logger.warn(diagnostics.renderWarnings());
-	}
-	if (diagnostics.hasErrors()) {
-		throw new UserError(diagnostics.renderErrors());
-	}
-	return defu<Config, [Config]>(config, userConfig);
+
+	return {
+		config: defu<Config, [Config]>(extra.config, userConfig),
+		diagnostics: extra.diagnostics,
+	};
 }
 
 /**
@@ -53,7 +51,7 @@ function getExtraConfigPath(projectRoot: string | undefined): string {
  */
 function loadExtraConfig(configPath: string):
 	| {
-			config: Environment;
+			config: Environment & PagesConfigFields;
 			diagnostics: Diagnostics;
 	  }
 	| undefined {
@@ -62,9 +60,12 @@ function loadExtraConfig(configPath: string):
 	}
 
 	const diagnostics = new Diagnostics(
-		`Extending with configuration found in ${relative(process.cwd(), configPath)}.`
+		`Processing extra configuration found in ${relative(process.cwd(), configPath)}.`
+	);
+	const raw = parseJSONC<Environment & PagesConfigFields>(
+		readFileSync(configPath),
+		configPath
 	);
-	const raw = parseJSONC<Environment>(readFileSync(configPath), configPath);
 	const config = normalizeAndValidateEnvironment(
 		diagnostics,
 		configPath,
@@ -76,8 +77,11 @@ function loadExtraConfig(configPath: string):
 		diagnostics,
 		"extended config",
 		Object.keys(raw),
-		[...Object.keys(config)]
+		[...Object.keys(config), "pages_build_output_dir"]
 	);
 
-	return { config, diagnostics };
+	return {
+		config: { ...config, pages_build_output_dir: raw.pages_build_output_dir },
+		diagnostics,
+	};
 }

packages/wrangler/src/config/index.ts

@@ -86,6 +86,18 @@ export function readConfig(
 		}
 	}
 
+	// Process the top-level configuration. This is common for both
+	// Workers and Pages
+	let { config, diagnostics } = normalizeAndValidateConfig(
+		rawConfig,
+		configPath,
+		args
+	);
+
+	const extra = extendConfiguration(configPath, config, hideWarnings);
+	config = extra.config;
+	diagnostics.addChild(extra.diagnostics);
+
 	/**
 	 * Check if configuration file belongs to a Pages project.
 	 *
@@ -116,14 +128,6 @@ export function readConfig(
 		);
 	}
 
-	// Process the top-level configuration. This is common for both
-	// Workers and Pages
-	const { config, diagnostics } = normalizeAndValidateConfig(
-		rawConfig,
-		configPath,
-		args
-	);
-
 	if (diagnostics.hasWarnings() && !hideWarnings) {
 		logger.warn(diagnostics.renderWarnings());
 	}
@@ -152,7 +156,7 @@ export function readConfig(
 
 	applyPythonConfig(config, args);
 
-	return extendConfiguration(configPath, config, hideWarnings);
+	return config;
 }
 
 /**