wrangler 2.8.1 → 2.9.1

package/src/d1/execute.tsx

@@ -7,7 +7,7 @@ import Table from "ink-table";
 import { npxImport } from "npx-import";
 import React from "react";
 import { fetchResult } from "../cfetch";
-import { withConfig } from "../config";
+import { readConfig } from "../config";
 import { getLocalPersistencePath } from "../dev/get-local-persistence-path";
 import { confirm } from "../dialogs";
 import { logger } from "../logger";
@@ -22,10 +22,13 @@ import {
 	getDatabaseInfoFromConfig,
 } from "./utils";
 import type { Config, ConfigFields, DevConfig, Environment } from "../config";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Database } from "./types";
 import type { Statement as StatementType } from "@miniflare/d1";
 import type { createSQLiteDB as createSQLiteDBType } from "@miniflare/shared";
-import type { Argv } from "yargs";
 
 type MiniflareNpxImportTypes = [
 	{
@@ -36,19 +39,6 @@ type MiniflareNpxImportTypes = [
 	}
 ];
 
-export type BaseSqlExecuteArgs = {
-	config?: string;
-	database: string;
-	local?: boolean;
-	"persist-to"?: string;
-	yes?: boolean;
-};
-
-type ExecuteArgs = BaseSqlExecuteArgs & {
-	file?: string;
-	command?: string;
-};
-
 export type QueryResult = {
 	results: Record<string, string | number | boolean>[];
 	success: boolean;
@@ -60,7 +50,7 @@ export type QueryResult = {
 // Max number of bytes to send in a single /execute call
 const QUERY_LIMIT = 10_000;
 
-export function Options(yargs: Argv): Argv<ExecuteArgs> {
+export function Options(yargs: CommonYargsArgv) {
 	return options
 		.Database(yargs)
 		.option("yes", {
@@ -74,7 +64,7 @@ export function Options(yargs: Argv): Argv<ExecuteArgs> {
 			type: "boolean",
 		})
 		.option("file", {
-			describe: "A .sql file to injest",
+			describe: "A .sql file to ingest",
 			type: "string",
 		})
 		.option("command", {
@@ -85,6 +75,11 @@ export function Options(yargs: Argv): Argv<ExecuteArgs> {
 			describe: "Specify directory to use for local persistence (for --local)",
 			type: "string",
 			requiresArg: true,
+		})
+		.option("json", {
+			describe: "Return output as clean JSON",
+			type: "boolean",
+			default: false,
 		});
 }
 
@@ -101,14 +96,13 @@ export async function executeSql(
 	shouldPrompt: boolean | undefined,
 	persistTo: undefined | string,
 	file?: string,
-	command?: string
+	command?: string,
+	json?: boolean
 ) {
 	const sql = file ? readFileSync(file) : command;
-
 	if (!sql) throw new Error(`Error: must provide --command or --file.`);
 	if (persistTo && !local)
 		throw new Error(`Error: can't use --persist-to without --local`);
-
 	logger.log(`🌀 Mapping SQL input into an array of statements`);
 	const queries = splitSqlQuery(sql);
 
@@ -122,72 +116,80 @@ export async function executeSql(
 	}
 
 	return local
-		? await executeLocally(config, name, shouldPrompt, queries, persistTo)
-		: await executeRemotely(config, name, shouldPrompt, batchSplit(queries));
+		? await executeLocally(config, name, shouldPrompt, queries, persistTo, json)
+		: await executeRemotely(
+				config,
+				name,
+				shouldPrompt,
+				batchSplit(queries),
+				json
+		  );
 }
+type HandlerOptions = StrictYargsOptionsToInterface<typeof Options>;
+
+export const Handler = async (args: HandlerOptions): Promise<void> => {
+	const { local, database, yes, persistTo, file, command, json } = args;
+	const existingLogLevel = logger.loggerLevel;
+	if (json) {
+		// set loggerLevel to error to avoid readConfig warnings appearing in JSON output
+		logger.loggerLevel = "error";
+	}
+	const config = readConfig(args.config, args);
+	logger.log(d1BetaWarning);
+	if (file && command)
+		return logger.error(`Error: can't provide both --command and --file.`);
 
-export const Handler = withConfig<ExecuteArgs>(
-	async ({
+	const isInteractive = process.stdout.isTTY;
+	const response: QueryResult[] | null = await executeSql(
+		local,
 		config,
 		database,
+		isInteractive && !yes,
+		persistTo,
 		file,
 		command,
-		local,
-		persistTo,
-		yes,
-	}): Promise<void> => {
-		logger.log(d1BetaWarning);
-		if (file && command)
-			return logger.error(`Error: can't provide both --command and --file.`);
-
-		const isInteractive = process.stdout.isTTY;
-		const response: QueryResult[] | null = await executeSql(
-			local,
-			config,
-			database,
-			isInteractive && !yes,
-			persistTo,
-			file,
-			command
-		);
-
-		// Early exit if prompt rejected
-		if (!response) return;
-
-		if (isInteractive) {
-			// Render table if single result
-			render(
-				<Static items={response}>
-					{(result) => {
-						// batch results
-						if (!Array.isArray(result)) {
-							const { results, query } = result;
+		json
+	);
 
-							if (Array.isArray(results) && results.length > 0) {
-								const shortQuery = shorten(query, 48);
-								return (
-									<>
-										{shortQuery ? <Text dimColor>{shortQuery}</Text> : null}
-										<Table data={results}></Table>
-									</>
-								);
-							}
+	// Early exit if prompt rejected
+	if (!response) return;
+
+	if (isInteractive && !json) {
+		// Render table if single result
+		render(
+			<Static items={response}>
+				{(result) => {
+					// batch results
+					if (!Array.isArray(result)) {
+						const { results, query } = result;
+
+						if (Array.isArray(results) && results.length > 0) {
+							const shortQuery = shorten(query, 48);
+							return (
+								<>
+									{shortQuery ? <Text dimColor>{shortQuery}</Text> : null}
+									<Table data={results}></Table>
+								</>
+							);
 						}
-					}}
-				</Static>
-			);
-		} else {
-			logger.log(JSON.stringify(response, null, 2));
-		}
+					}
+				}}
+			</Static>
+		);
+	} else {
+		// set loggerLevel back to what it was before to actually output the JSON in stdout
+		logger.loggerLevel = existingLogLevel;
+		logger.log(JSON.stringify(response, null, 2));
 	}
-);
+};
 
 async function executeLocally(
 	config: Config,
 	name: string,
 	shouldPrompt: boolean | undefined,
 	queries: string[],
-	persistTo: string | undefined
+	persistTo: string | undefined,
+	json?: boolean
 ) {
 	const localDB = getDatabaseInfoFromConfig(config, name);
 	if (!localDB) {
@@ -210,10 +212,11 @@ async function executeLocally(
 			logger.log
 		);
 
-	if (!existsSync(dbDir) && shouldPrompt) {
-		const ok = await confirm(
-			`About to create ${readableRelative(dbPath)}, ok?`
-		);
+	if (!existsSync(dbDir)) {
+		const ok =
+			json ||
+			!shouldPrompt ||
+			(await confirm(`About to create ${readableRelative(dbPath)}, ok?`));
 		if (!ok) return null;
 		await mkdir(dbDir, { recursive: true });
 	}
@@ -234,10 +237,12 @@ async function executeRemotely(
 	config: Config,
 	name: string,
 	shouldPrompt: boolean | undefined,
-	batches: string[]
+	batches: string[],
+	json?: boolean
 ) {
 	const multiple_batches = batches.length > 1;
-	if (multiple_batches) {
+	// in JSON mode, we don't want a prompt here
+	if (multiple_batches && !json) {
 		const warning = `⚠️  Too much SQL to send at once, this execution will be sent as ${batches.length} batches.`;
 
 		if (shouldPrompt) {
@@ -258,14 +263,7 @@ async function executeRemotely(
 		name
 	);
 
-	if (shouldPrompt) {
-		logger.log(`🌀 Executing on ${name} (${db.uuid}):`);
-
-		// Don't output if shouldPrompt is undefined
-	} else if (shouldPrompt !== undefined) {
-		// Pipe to error so we don't break jq
-		logger.error(`Executing on ${name} (${db.uuid}):`);
-	}
+	logger.log(`🌀 Executing on ${name} (${db.uuid}):`);
 
 	const results: QueryResult[] = [];
 	for (const sql of batches) {

package/src/d1/index.ts

@@ -5,10 +5,9 @@ import * as Execute from "./execute";
 import * as List from "./list";
 import * as Migrations from "./migrations";
 import { d1BetaWarning } from "./utils";
-import type { CommonYargsOptions } from "../yargs-types";
-import type { Argv } from "yargs";
+import type { CommonYargsArgv } from "../yargs-types";
 
-export const d1 = (yargs: Argv<CommonYargsOptions>) => {
+export function d1(yargs: CommonYargsArgv) {
 	return (
 		yargs
 			.command("list", "List D1 databases", List.Options, List.Handler)
@@ -24,8 +23,8 @@ export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 				Delete.Options,
 				Delete.Handler
 			)
-			.command("backup", "Interact with D1 Backups", (yargs2) =>
-				yargs2
+			.command("backup", "Interact with D1 Backups", (backupArgs) =>
+				backupArgs
 					.demandCommand()
 					.command(
 						"list <name>",
@@ -98,4 +97,4 @@ export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 			)
 			.epilogue(d1BetaWarning)
 	);
-};
+}

package/src/d1/list.tsx

@@ -5,22 +5,34 @@ import { fetchResult } from "../cfetch";
 import { logger } from "../logger";
 import { requireAuth } from "../user";
 import { d1BetaWarning } from "./utils";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Database } from "./types";
-import type { ArgumentsCamelCase, Argv } from "yargs";
 
-type ListArgs = Record<string, never>;
-
-export function Options(d1ListYargs: Argv): Argv<ListArgs> {
-	return d1ListYargs.epilogue(d1BetaWarning);
+export function Options(d1ListYargs: CommonYargsArgv) {
+	return d1ListYargs
+		.option("json", {
+			describe: "return output as clean JSON",
+			type: "boolean",
+			default: false,
+		})
+		.epilogue(d1BetaWarning);
 }
 
-export async function Handler(_: ArgumentsCamelCase<ListArgs>): Promise<void> {
+export async function Handler({
+	json,
+}: StrictYargsOptionsToInterface<typeof Options>): Promise<void> {
 	const accountId = await requireAuth({});
-	logger.log(d1BetaWarning);
-
 	const dbs: Array<Database> = await listDatabases(accountId);
 
-	render(<Table data={dbs}></Table>);
+	if (json) {
+		logger.log(JSON.stringify(dbs, null, 2));
+	} else {
+		logger.log(d1BetaWarning);
+		render(<Table data={dbs}></Table>);
+	}
 }
 
 export const listDatabases = async (

package/src/d1/migrations/apply.tsx

@@ -21,18 +21,22 @@ import {
 } from "./helpers";
 import { DatabaseWithLocal } from "./options";
 import type { ParseError } from "../../parse";
-import type { BaseSqlExecuteArgs } from "../execute";
-import type { Argv } from "yargs";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../yargs-types";
 
-export function ApplyOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
+export function ApplyOptions(yargs: CommonYargsArgv) {
 	return DatabaseWithLocal(yargs);
 }
 
-export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
+type ApplyHandlerOptions = StrictYargsOptionsToInterface<typeof ApplyOptions>;
+
+export const ApplyHandler = withConfig<ApplyHandlerOptions>(
 	async ({ config, database, local, persistTo }): Promise<void> => {
 		logger.log(d1BetaWarning);
 
-		const databaseInfo = await getDatabaseInfoFromConfig(config, database);
+		const databaseInfo = getDatabaseInfoFromConfig(config, database);
 		if (!databaseInfo && !local) {
 			throw new Error(
 				`Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`
@@ -49,10 +53,10 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
 			false
 		);
 
-		const migrationTableName =
+		const migrationsTableName =
 			databaseInfo?.migrationsTableName ?? DEFAULT_MIGRATION_TABLE;
 		await initMigrationsTable(
-			migrationTableName,
+			migrationsTableName,
 			local,
 			config,
 			database,
@@ -61,7 +65,7 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
 
 		const unappliedMigrations = (
 			await getUnappliedMigrations(
-				migrationTableName,
+				migrationsTableName,
 				migrationsPath,
 				local,
 				config,
@@ -122,7 +126,7 @@ Your database may not be available to serve requests during the migration, conti
 				"utf8"
 			);
 			query += `
-								INSERT INTO ${migrationTableName} (name)
+								INSERT INTO ${migrationsTableName} (name)
 								values ('${migration.Name}');
 						`;
 

package/src/d1/migrations/create.tsx

@@ -8,15 +8,12 @@ import { requireAuth } from "../../user";
 import { Database } from "../options";
 import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
 import { getMigrationsPath, getNextMigrationNumber } from "./helpers";
-import type { Argv } from "yargs";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../yargs-types";
 
-type MigrationsCreateArgs = {
-	config?: string;
-	database: string;
-	message: string;
-};
-
-export function CreateOptions(yargs: Argv): Argv<MigrationsCreateArgs> {
+export function CreateOptions(yargs: CommonYargsArgv) {
 	return Database(yargs).positional("message", {
 		describe: "The Migration message",
 		type: "string",
@@ -24,12 +21,14 @@ export function CreateOptions(yargs: Argv): Argv<MigrationsCreateArgs> {
 	});
 }
 
-export const CreateHandler = withConfig<MigrationsCreateArgs>(
+type CreateHandlerOptions = StrictYargsOptionsToInterface<typeof CreateOptions>;
+
+export const CreateHandler = withConfig<CreateHandlerOptions>(
 	async ({ config, database, message }): Promise<void> => {
 		await requireAuth({});
 		logger.log(d1BetaWarning);
 
-		const databaseInfo = await getDatabaseInfoFromConfig(config, database);
+		const databaseInfo = getDatabaseInfoFromConfig(config, database);
 		if (!databaseInfo) {
 			throw new Error(
 				`Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`

package/src/d1/migrations/list.tsx

@@ -5,6 +5,7 @@ import React from "react";
 import { withConfig } from "../../config";
 import { logger } from "../../logger";
 import { requireAuth } from "../../user";
+import { DEFAULT_MIGRATION_PATH, DEFAULT_MIGRATION_TABLE } from "../constants";
 import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
 import {
 	getMigrationsPath,
@@ -12,20 +13,26 @@ import {
 	initMigrationsTable,
 } from "./helpers";
 import { DatabaseWithLocal } from "./options";
-import type { BaseSqlExecuteArgs } from "../execute";
-import type { Argv } from "yargs";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../yargs-types";
 
-export function ListOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
+export function ListOptions(yargs: CommonYargsArgv) {
 	return DatabaseWithLocal(yargs);
 }
 
-export const ListHandler = withConfig<BaseSqlExecuteArgs>(
+type ListHandlerOptions = StrictYargsOptionsToInterface<typeof ListOptions>;
+
+export const ListHandler = withConfig<ListHandlerOptions>(
 	async ({ config, database, local, persistTo }): Promise<void> => {
-		await requireAuth({});
+		if (!local) {
+			await requireAuth({});
+		}
 		logger.log(d1BetaWarning);
 
-		const databaseInfo = await getDatabaseInfoFromConfig(config, database);
-		if (!databaseInfo) {
+		const databaseInfo = getDatabaseInfoFromConfig(config, database);
+		if (!databaseInfo && !local) {
 			throw new Error(
 				`Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`
 			);
@@ -34,13 +41,16 @@ export const ListHandler = withConfig<BaseSqlExecuteArgs>(
 		if (!config.configPath) {
 			return;
 		}
-		const { migrationsTableName, migrationsFolderPath } = databaseInfo;
 
 		const migrationsPath = await getMigrationsPath(
 			path.dirname(config.configPath),
-			migrationsFolderPath,
+			databaseInfo?.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
 			false
 		);
+
+		const migrationsTableName =
+			databaseInfo?.migrationsTableName ?? DEFAULT_MIGRATION_TABLE;
+
 		await initMigrationsTable(
 			migrationsTableName,
 			local,

package/src/d1/migrations/options.ts

@@ -1,7 +1,7 @@
 import { Database } from "../options";
-import type { Argv } from "yargs";
+import type { CommonYargsArgv } from "../../yargs-types";
 
-export function DatabaseWithLocal(yargs: Argv) {
+export function DatabaseWithLocal(yargs: CommonYargsArgv) {
 	return Database(yargs)
 		.option("local", {
 			describe:

package/src/d1/options.ts

@@ -1,7 +1,7 @@
 import { d1BetaWarning } from "./utils";
-import type { Argv } from "yargs";
+import type { CommonYargsArgv } from "../yargs-types";
 
-export function Name(yargs: Argv) {
+export function Name(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("name", {
 			describe: "The name or binding of the DB",
@@ -11,7 +11,7 @@ export function Name(yargs: Argv) {
 		.epilogue(d1BetaWarning);
 }
 
-export function Database(yargs: Argv) {
+export function Database(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("database", {
 			describe: "The name or binding of the DB",

package/src/delete.ts

@@ -8,14 +8,12 @@ import { logger } from "./logger";
 import * as metrics from "./metrics";
 import { requireAuth } from "./user";
 import { getScriptName, printWranglerBanner } from "./index";
-import type { ConfigPath } from "./index";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "./yargs-types";
-import type { Argv } from "yargs";
 
-export function deleteOptions(yargs: Argv<CommonYargsOptions>) {
+export function deleteOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("script", {
 			describe: "The path to an entry point for your worker",
@@ -38,14 +36,13 @@ export function deleteOptions(yargs: Argv<CommonYargsOptions>) {
 		});
 }
 
-type DeleteArgs = YargsOptionsToInterface<typeof deleteOptions>;
+type DeleteArgs = StrictYargsOptionsToInterface<typeof deleteOptions>;
 
 export async function deleteHandler(args: DeleteArgs) {
 	await printWranglerBanner();
 
 	const configPath =
-		(args.config as ConfigPath) ||
-		(args.script && findWranglerToml(path.dirname(args.script)));
+		args.config || (args.script && findWranglerToml(path.dirname(args.script)));
 	const config = readConfig(configPath, args);
 	await metrics.sendMetricsEvent(
 		"delete worker script",

package/src/deprecated/index.ts

@@ -3,15 +3,14 @@ import { createCLIParser } from "../index";
 import { logger } from "../logger";
 import { formatMessage } from "../parse";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
-import type { Argv, BuilderCallback } from "yargs";
 
-export function buildOptions(yargs: Argv<CommonYargsOptions>) {
+export function buildOptions(yargs: CommonYargsArgv) {
 	return yargs;
 }
-type BuildArgs = YargsOptionsToInterface<typeof buildOptions>;
+type BuildArgs = StrictYargsOptionsToInterface<typeof buildOptions>;
 export async function buildHandler(buildArgs: BuildArgs) {
 	// "[DEPRECATED] 🦀 Build your project (if applicable)",
 
@@ -47,7 +46,7 @@ export const configHandler = () => {
 	);
 };
 
-export function previewOptions(yargs: Argv<CommonYargsOptions>) {
+export function previewOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("method", {
 			type: "string",
@@ -71,7 +70,7 @@ export function previewHandler() {
 	);
 }
 
-export const route: BuilderCallback<unknown, unknown> = (routeYargs: Argv) => {
+export const route = (routeYargs: CommonYargsArgv) => {
 	return routeYargs
 		.command(
 			"list",
@@ -134,7 +133,7 @@ export const routeHandler = () => {
 	throw new DeprecationError(`${deprecationNotice}\n${shouldDo}`);
 };
 
-export const subdomainOptions = (yargs: Argv<CommonYargsOptions>) => {
+export const subdomainOptions = (yargs: CommonYargsArgv) => {
 	return yargs.positional("name", { type: "string" });
 };