chore: remove getConfig helper function, centralising logic surroundi…

…ng how to find the config file given various command line args (#7477)
cloudflare · Dec 9, 2024 · a29a41c · a29a41c
1 parent 90fa58b
commit a29a41c
Show file tree

Hide file tree

Showing 67 changed files with 183 additions and 193 deletions.
diff --git a/fixtures/import-npm/package-lock.json b/fixtures/import-npm/package-lock.json
diff --git a/packages/wrangler/src/__tests__/configuration.test.ts b/packages/wrangler/src/__tests__/configuration.test.ts
@@ -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(

diff --git a/packages/wrangler/src/api/integrations/platform/index.ts b/packages/wrangler/src/api/integrations/platform/index.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

diff --git a/packages/wrangler/src/api/pages/deploy.ts b/packages/wrangler/src/api/pages/deploy.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 (
 			!(

diff --git a/packages/wrangler/src/api/startDevWorker/ConfigController.ts b/packages/wrangler/src/api/startDevWorker/ConfigController.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,

diff --git a/packages/wrangler/src/cloudchamber/common.ts b/packages/wrangler/src/cloudchamber/common.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;
 			}
 

diff --git a/packages/wrangler/src/config/config-helpers.ts b/packages/wrangler/src/config/config-helpers.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 })
 	);
 }
diff --git a/packages/wrangler/src/config/index.ts b/packages/wrangler/src/config/index.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) });
 	};
 }
 

diff --git a/packages/wrangler/src/core/register-yargs-command.ts b/packages/wrangler/src/core/register-yargs-command.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,

diff --git a/packages/wrangler/src/d1/execute.ts b/packages/wrangler/src/d1/execute.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(

diff --git a/packages/wrangler/src/d1/export.ts b/packages/wrangler/src/d1/export.ts
@@ -74,7  74,7 @@ type HandlerOptions = StrictYargsOptionsToInterface<typeof Options>;
 export const Handler = async (args: HandlerOptions): Promise<void> => {
 	const { local, remote, name, output, schema, data, table } = args;
 	await printWranglerBanner();
-	const config = readConfig(args.config, args);
 	const config = readConfig(args);
 
 	if (!local && !remote) {
 		throw new UserError(`You must specify either --local or --remote`);

diff --git a/packages/wrangler/src/delete.ts b/packages/wrangler/src/delete.ts
@@ -1,7  1,6 @@
 import assert from "assert";
-import path from "path";
 import { fetchResult } from "./cfetch";
-import { configFileName, findWranglerConfig, readConfig } from "./config";
 import { configFileName, readConfig } from "./config";
 import { confirm } from "./dialogs";
 import { UserError } from "./errors";
 import { deleteKVNamespace, listKVNamespaces } from "./kv/helpers";
@@ -94,10  93,7 @@ type DeleteArgs = StrictYargsOptionsToInterface<typeof deleteOptions>;
 export async function deleteHandler(args: DeleteArgs) {
 	await printWranglerBanner();
 
-	const configPath =
-		args.config ||
-		(args.script && findWranglerConfig(path.dirname(args.script)));
-	const config = readConfig(configPath, args);
 	const config = readConfig(args);
 	if (config.pages_build_output_dir) {
 		throw new UserError(
 			"It looks like you've run a Workers-specific command in a Pages project.\n"  

diff --git a/packages/wrangler/src/deploy/index.ts b/packages/wrangler/src/deploy/index.ts
@@ -1,7  1,8 @@
 import assert from "node:assert";
 import path from "node:path";
 import { getAssetsOptions, validateAssetsArgsAndConfig } from "../assets";
-import { configFileName, findWranglerConfig, readConfig } from "../config";
 import { configFileName, readConfig } from "../config";
 import { resolveWranglerConfigPath } from "../config/config-helpers";
 import { getEntry } from "../deployment-bundle/entry";
 import { UserError } from "../errors";
 import { run } from "../experimental-flags";
@@ -262,11  263,9 @@ async function deployWorker(args: DeployArgs) {
 		);
 	}
 
-	const configPath =
-		args.config ||
-		(args.script && findWranglerConfig(path.dirname(args.script)));
 	const configPath = resolveWranglerConfigPath(args);
 	const projectRoot = configPath && path.dirname(configPath);
-	const config = readConfig(configPath, args);
 	const config = readConfig(args);
 	if (config.pages_build_output_dir) {
 		throw new UserError(
 			"It looks like you've run a Workers-specific command in a Pages project.\n"  

diff --git a/packages/wrangler/src/deployments.ts b/packages/wrangler/src/deployments.ts
@@ -323,7  323,7 @@ export async function commonDeploymentCMDSetup(
 	yargs: ArgumentsCamelCase<CommonYargsOptions>
 ) {
 	await printWranglerBanner();
-	const config = readConfig(yargs.config, yargs);
 	const config = readConfig(yargs);
 	const accountId = await requireAuth(config);
 	const scriptName = getScriptName(
 		{ name: yargs.name as string, env: undefined },

diff --git a/packages/wrangler/src/dev.ts b/packages/wrangler/src/dev.ts
@@ -10,11  10,8 @@ import {
 	convertCfWorkerInitBindingstoBindings,
 	extractBindingsOfType,
 } from "./api/startDevWorker/utils";
-import {
-	configFileName,
-	findWranglerConfig,
-	formatConfigSnippet,
-} from "./config";
 import { configFileName, formatConfigSnippet } from "./config";
 import { resolveWranglerConfigPath } from "./config/config-helpers";
 import { createCommand } from "./core/create-command";
 import { validateRoutes } from "./deploy/deploy";
 import { validateNodeCompatMode } from "./deployment-bundle/node-compat";
@@ -703,9  700,7 @@ export async function startDev(args: StartDevOptions) {
 			);
 		}
 
-		const configPath =
-			args.config ||
-			(args.script && findWranglerConfig(path.dirname(args.script)));
 		const configPath = resolveWranglerConfigPath(args);
 
 		const authHook: AsyncHook<CfAccount, [Pick<Config, "account_id">]> = async (
 			config

diff --git a/packages/wrangler/src/dispatch-namespace.ts b/packages/wrangler/src/dispatch-namespace.ts
@@ -113,7  113,7 @@ export function workerNamespaceCommands(
 			"List all dispatch namespaces",
 			(args) => args,
 			async (args) => {
-				const config = readConfig(args.config, args);
 				const config = readConfig(args);
 				const accountId = await requireAuth(config);
 				await listWorkerNamespaces(accountId);
 				metrics.sendMetricsEvent("list dispatch namespaces", {
@@ -132,7  132,7 @@ export function workerNamespaceCommands(
 				});
 			},
 			async (args) => {
-				const config = readConfig(args.config, args);
 				const config = readConfig(args);
 				const accountId = await requireAuth(config);
 				await getWorkerNamespaceInfo(accountId, args.name);
 				metrics.sendMetricsEvent("view dispatch namespace", {
@@ -152,7  152,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config, args);
 				const config = readConfig(args);
 				const accountId = await requireAuth(config);
 				await createWorkerNamespace(accountId, args.name);
 				metrics.sendMetricsEvent("create dispatch namespace", {
@@ -172,7  172,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config, args);
 				const config = readConfig(args);
 				const accountId = await requireAuth(config);
 				await deleteWorkerNamespace(accountId, args.name);
 				metrics.sendMetricsEvent("delete dispatch namespace", {
@@ -198,7  198,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config, args);
 				const config = readConfig(args);
 				const accountId = await requireAuth(config);
 				await renameWorkerNamespace(accountId, args.oldName, args.newName);
 				metrics.sendMetricsEvent("rename dispatch namespace", {