feat: provide experimental flags to the defineCommand handler (#7455)

* provide experimental flags in defineCommand handler * fixup
cloudflare · Dec 11, 2024 · fa5a8fc · fa5a8fc
1 parent 8371748
commit fa5a8fc
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 21 deletions.
diff --git a/packages/wrangler/src/core/register-yargs-command.ts b/packages/wrangler/src/core/register-yargs-command.ts
@@ -2,6 +2,7 @@ import { fetchResult } from "../cfetch";
 import { readConfig } from "../config";
 import { defaultWranglerConfig } from "../config/config";
 import { FatalError, UserError } from "../errors";
+import { run } from "../experimental-flags";
 import { logger } from "../logger";
 import { printWranglerBanner } from "../wrangler-banner";
 import { demandSingleValue } from "./helpers";
@@ -89,18 +90,27 @@ function createHandler(def: CommandDefinition) {
 			// TODO(telemetry): send command started event
 
 			await def.validateArgs?.(args);
+			const experimentalFlags = def.behaviour?.overrideExperimentalFlags
+				? def.behaviour?.overrideExperimentalFlags(args)
+				: {
+						FILE_BASED_REGISTRY: false,
+						MULTIWORKER: false,
+						RESOURCES_PROVISION: args.experimentalProvision ?? false,
+					};
 
-			await def.handler(args, {
-				config:
-					def.behaviour?.provideConfig ?? true
-						? readConfig(args, {
-								hideWarnings: !(def.behaviour?.printConfigWarnings ?? true),
-							})
-						: defaultWranglerConfig,
-				errors: { UserError, FatalError },
-				logger,
-				fetchResult,
-			});
+			await run(experimentalFlags, () =>
+				def.handler(args, {
+					config:
+						def.behaviour?.provideConfig ?? true
+							? readConfig(args, {
+									hideWarnings: !(def.behaviour?.printConfigWarnings ?? true),
+								})
+							: defaultWranglerConfig,
+					errors: { UserError, FatalError },
+					logger,
+					fetchResult,
+				})
+			);
 
 			// TODO(telemetry): send command completed event
 		} catch (err) {

diff --git a/packages/wrangler/src/core/types.ts b/packages/wrangler/src/core/types.ts
@@ -2,6 +2,7 @@ import type { fetchResult } from "../cfetch";
 import type { Config } from "../config";
 import type { OnlyCamelCase } from "../config/config";
 import type { FatalError, UserError } from "../errors";
+import type { ExperimentalFlags } from "../experimental-flags";
 import type { Logger } from "../logger";
 import type { CommonYargsOptions, RemoveIndex } from "../yargs-types";
 import type { Teams } from "./teams";
@@ -106,6 +107,15 @@ export type CommandDefinition<
 		 * Set this value to `false` to skip this.
 		 */
 		provideConfig?: boolean;
+
+		/**
+		 * By default, wrangler will provide experimental flags in the handler context,
+		 * according to the default values in register-yargs.command.ts
+		 * Use this to override those defaults per command.
+		 */
+		overrideExperimentalFlags?: (
+			args: HandlerArgs<NamedArgDefs>
+		) => ExperimentalFlags;
 	};
 
 	/**

diff --git a/packages/wrangler/src/deploy/index.ts b/packages/wrangler/src/deploy/index.ts
@@ -235,6 +235,7 @@ export function deployOptions(yargs: CommonYargsArgv) {
 
 export type DeployArgs = StrictYargsOptionsToInterface<typeof deployOptions>;
 
+// TODO: move this into defineCommand behaviour
 export async function deployHandler(args: DeployArgs) {
 	await run(
 		{

diff --git a/packages/wrangler/src/dev.ts b/packages/wrangler/src/dev.ts
@@ -20,7 +20,6 @@ import { getVarsForDev } from "./dev/dev-vars";
 import registerDevHotKeys from "./dev/hotkeys";
 import { maybeRegisterLocalWorker } from "./dev/local";
 import { UserError } from "./errors";
-import { run } from "./experimental-flags";
 import isInteractive from "./is-interactive";
 import { logger } from "./logger";
 import { getLegacyAssetPaths, getSiteAssetPaths } from "./sites";
@@ -59,6 +58,11 @@ import type { Json } from "miniflare";
 export const dev = createCommand({
 	behaviour: {
 		provideConfig: false,
+		overrideExperimentalFlags: (args) => ({
+			FILE_BASED_REGISTRY: args.experimentalRegistry,
+			MULTIWORKER: Array.isArray(args.config),
+			RESOURCES_PROVISION: args.experimentalProvision ?? false,
+		}),
 	},
 	metadata: {
 		description: "👂 Start a local server for developing your Worker",
@@ -373,14 +377,7 @@ export const dev = createCommand({
 		}
 	},
 	async handler(args) {
-		const devInstance = await run(
-			{
-				FILE_BASED_REGISTRY: args.experimentalRegistry,
-				MULTIWORKER: Array.isArray(args.config),
-				RESOURCES_PROVISION: false,
-			},
-			() => startDev(args)
-		);
+		const devInstance = await startDev(args);
 		assert(devInstance.devEnv !== undefined);
 		await events.once(devInstance.devEnv, "teardown");
 		await Promise.all(devInstance.secondary.map((d) => d.teardown()));

diff --git a/packages/wrangler/src/experimental-flags.ts b/packages/wrangler/src/experimental-flags.ts
@@ -1,7 +1,7 @@
 import { AsyncLocalStorage } from "async_hooks";
 import { logger } from "./logger";
 
-type ExperimentalFlags = {
+export type ExperimentalFlags = {
 	FILE_BASED_REGISTRY: boolean;
 	MULTIWORKER: boolean;
 	RESOURCES_PROVISION: boolean;