chore: remove getConfig helper function, centralising logic surrounding how to find the config file given various command line args (#7477)

Author: andyjessop

fixtures/import-npm/package-lock.json

@@ -19,7 +19,7 @@ describe("readConfig()", () => {
 			main: "index.py",
 			compatibility_flags: ["python_workers"],
 		});
-		const config = readConfig("wrangler.toml", {});
+		const config = readConfig({ config: "wrangler.toml" });
 		expect(config.rules).toMatchInlineSnapshot(`
 			Array [
 			  Object {
@@ -36,7 +36,7 @@ describe("readConfig()", () => {
 			main: "index.py",
 		});
 		try {
-			readConfig("wrangler.toml", {});
+			readConfig({ config: "wrangler.toml" });
 			expect.fail();
 		} catch (e) {
 			expect(e).toMatchInlineSnapshot(

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

@@ -103,7 +103,8 @@ export async function getPlatformProxy<
 ): Promise<PlatformProxy<Env, CfProperties>> {
 	const env = options.environment;
 
-	const rawConfig = readConfig(options.configPath, {
+	const rawConfig = readConfig({
+		config: options.configPath,
 		env,
 	});
 
@@ -263,7 +264,7 @@ export function unstable_getMiniflareWorkerOptions(
 ): Unstable_MiniflareWorkerOptions {
 	const config =
 		typeof configOrConfigPath === "string"
-			? readConfig(configOrConfigPath, { env })
+			? readConfig({ config: configOrConfigPath, env })
 			: configOrConfigPath;
 
 	const modulesRules: ModuleRule[] = config.rules

packages/wrangler/src/api/integrations/platform/index.ts

@@ -160,7 +160,7 @@ export async function deploy({
 	let config: Config | undefined;
 
 	try {
-		config = readPagesConfig(undefined, { ...args, env });
+		config = readPagesConfig({ ...args, env });
 	} catch (err) {
 		if (
 			!(

packages/wrangler/src/api/pages/deploy.ts

@@ -414,7 +414,8 @@ export class ConfigController extends Controller<ConfigControllerEventMap> {
 		const signal = this.#abortController.signal;
 		this.latestInput = input;
 		try {
-			const fileConfig = readConfig(input.config, {
+			const fileConfig = readConfig({
+				config: input.config,
 				env: input.env,
 				"dispatch-namespace": undefined,
 				"legacy-env": !input.legacy?.enableServiceEnvironments,

packages/wrangler/src/api/startDevWorker/ConfigController.ts

@@ -97,19 +97,19 @@ export function handleFailure<
 		? K
 		: never,
 >(
-	cb: (t: CommandArgumentsObject, config: Config) => Promise<void>
+	cb: (args: CommandArgumentsObject, config: Config) => Promise<void>
 ): (
-	t: CommonYargsOptions &
+	args: CommonYargsOptions &
 		CommandArgumentsObject &
 		CommonCloudchamberConfiguration
 ) => Promise<void> {
-	return async (t) => {
+	return async (args) => {
 		try {
-			const config = readConfig(t.config, t);
-			await fillOpenAPIConfiguration(config, t.json);
-			await cb(t, config);
+			const config = readConfig(args);
+			await fillOpenAPIConfiguration(config, args.json);
+			await cb(args, config);
 		} catch (err) {
-			if (!t.json) {
+			if (!args.json) {
 				throw err;
 			}
 

packages/wrangler/src/cloudchamber/common.ts

@@ -0,0 +1,36 @@
+import path from "path";
+import { findUpSync } from "find-up";
+
+/**
+ * Resolve the path to the configuration file, given the `config` and `script` optional command line arguments.
+ * `config` takes precedence, then `script`, then we just use the cwd.
+ */
+export function resolveWranglerConfigPath({
+	config,
+	script,
+}: {
+	config?: string;
+	script?: string;
+}): string | undefined {
+	if (config !== undefined) {
+		return config;
+	}
+
+	const leafPath = script !== undefined ? path.dirname(script) : process.cwd();
+
+	return findWranglerConfig(leafPath);
+}
+
+/**
+ * Find the wrangler config file by searching up the file-system
+ * from the current working directory.
+ */
+export function findWranglerConfig(
+	referencePath: string = process.cwd()
+): string | undefined {
+	return (
+		findUpSync(`wrangler.json`, { cwd: referencePath }) ??
+		findUpSync(`wrangler.jsonc`, { cwd: referencePath }) ??
+		findUpSync(`wrangler.toml`, { cwd: referencePath })
+	);
+}

packages/wrangler/src/config/config-helpers.ts

@@ -2,12 +2,12 @@ import fs from "node:fs";
 import TOML from "@iarna/toml";
 import chalk from "chalk";
 import dotenv from "dotenv";
-import { findUpSync } from "find-up";
 import { FatalError, UserError } from "../errors";
 import { getFlag } from "../experimental-flags";
 import { logger } from "../logger";
 import { EXIT_CODE_INVALID_PAGES_CONFIG } from "../pages/errors";
 import { parseJSONC, parseTOML, readFileSync } from "../parse";
+import { resolveWranglerConfigPath } from "./config-helpers";
 import { isPagesConfig, normalizeAndValidateConfig } from "./validation";
 import { validatePagesConfig } from "./validation-pages";
 import type { CfWorkerInit } from "../deployment-bundle/worker";
@@ -66,25 +66,23 @@ export function formatConfigSnippet(
 	}
 }
 
-type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs;
+type ReadConfigCommandArgs = NormalizeAndValidateConfigArgs & {
+	config?: string;
+	script?: string;
+};
 
 /**
  * Get the Wrangler configuration; read it from the give `configPath` if available.
  */
 export function readConfig(
-	configPath: string | undefined,
 	args: ReadConfigCommandArgs,
 	options?: { hideWarnings?: boolean }
 ): Config;
 export function readConfig(
-	configPath: string | undefined,
 	args: ReadConfigCommandArgs,
 	{ hideWarnings = false }: { hideWarnings?: boolean } = {}
 ): Config {
-	if (!configPath) {
-		configPath = findWranglerConfig(process.cwd());
-	}
-
+	const configPath = resolveWranglerConfigPath(args);
 	const rawConfig = readRawConfig(configPath);
 
 	const { config, diagnostics } = normalizeAndValidateConfig(
@@ -104,13 +102,10 @@ export function readConfig(
 }
 
 export function readPagesConfig(
-	configPath: string | undefined,
 	args: ReadConfigCommandArgs,
 	{ hideWarnings = false }: { hideWarnings?: boolean } = {}
 ): Omit<Config, "pages_build_output_dir"> & { pages_build_output_dir: string } {
-	if (!configPath) {
-		configPath = findWranglerConfig(process.cwd());
-	}
+	const configPath = resolveWranglerConfigPath(args);
 
 	let rawConfig: RawConfig;
 	try {
@@ -173,20 +168,6 @@ export const readRawConfig = (configPath: string | undefined): RawConfig => {
 	return {};
 };
 
-/**
- * Find the wrangler config file by searching up the file-system
- * from the current working directory.
- */
-export function findWranglerConfig(
-	referencePath: string = process.cwd()
-): string | undefined {
-	return (
-		findUpSync(`wrangler.json`, { cwd: referencePath }) ??
-		findUpSync(`wrangler.jsonc`, { cwd: referencePath }) ??
-		findUpSync(`wrangler.toml`, { cwd: referencePath })
-	);
-}
-
 function addLocalSuffix(
 	id: string | symbol | undefined,
 	local: boolean = false
@@ -660,12 +641,12 @@ export function printBindings(
 
 export function withConfig<T>(
 	handler: (
-		t: OnlyCamelCase<T & CommonYargsOptions> & { config: Config }
+		args: OnlyCamelCase<T & CommonYargsOptions> & { config: Config }
 	) => Promise<void>,
-	options?: Parameters<typeof readConfig>[2]
+	options?: Parameters<typeof readConfig>[1]
 ) {
-	return (t: OnlyCamelCase<T & CommonYargsOptions>) => {
-		return handler({ ...t, config: readConfig(t.config, t, options) });
+	return (args: OnlyCamelCase<T & CommonYargsOptions>) => {
+		return handler({ ...args, config: readConfig(args, options) });
 	};
 }
 

packages/wrangler/src/config/index.ts

@@ -82,7 +82,7 @@ function createHandler(def: CommandDefinition) {
 			await def.handler(args, {
 				config:
 					def.behaviour?.provideConfig ?? true
-						? readConfig(args.config, args, {
+						? readConfig(args, {
 								hideWarnings: !(def.behaviour?.printConfigWarnings ?? true),
 							})
 						: defaultWranglerConfig,

packages/wrangler/src/core/register-yargs-command.ts

@@ -111,7 +111,7 @@ export const Handler = async (args: HandlerOptions): Promise<void> => {
 	}
 	await printWranglerBanner();
 
-	const config = readConfig(args.config, args);
+	const config = readConfig(args);
 
 	if (file && command) {
 		throw createFatalError(