wrangler 0.0.0-e6c9c5c0 → 0.0.0-e6e1daba

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,32 +22,11 @@ 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 = [
-	{
-		Statement: typeof StatementType;
-	},
-	{
-		createSQLiteDB: typeof createSQLiteDBType;
-	}
-];
-
-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>[];
@@ -60,7 +39,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 +53,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,30 +64,106 @@ 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,
+		})
+		.option("preview", {
+			describe: "Execute commands/files against a preview D1 DB",
+			type: "boolean",
+			default: false,
 		});
 }
 
-function shorten(query: string | undefined, length: number) {
-	return query && query.length > length
-		? query.slice(0, length) + "..."
-		: query;
-}
+type HandlerOptions = StrictYargsOptionsToInterface<typeof Options>;
 
-export async function executeSql(
-	local: undefined | boolean,
-	config: ConfigFields<DevConfig> & Environment,
-	name: string,
-	shouldPrompt: boolean | undefined,
-	persistTo: undefined | string,
-	file?: string,
-	command?: string
-) {
-	const sql = file ? readFileSync(file) : command;
+export const Handler = async (args: HandlerOptions): Promise<void> => {
+	const { local, database, yes, persistTo, file, command, json, preview } =
+		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.`);
 
+	const isInteractive = process.stdout.isTTY;
+	const response: QueryResult[] | null = await executeSql({
+		local,
+		config,
+		name: database,
+		shouldPrompt: isInteractive && !yes,
+		persistTo,
+		file,
+		command,
+		json,
+		preview,
+	});
+
+	// 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 {
+		// 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));
+	}
+};
+
+export async function executeSql({
+	local,
+	config,
+	name,
+	shouldPrompt,
+	persistTo,
+	file,
+	command,
+	json,
+	preview,
+}: {
+	local: boolean | undefined;
+	config: ConfigFields<DevConfig> & Environment;
+	name: string;
+	shouldPrompt: boolean | undefined;
+	persistTo: string | undefined;
+	file: string | undefined;
+	command: string | undefined;
+	json: boolean | undefined;
+	preview: boolean | undefined;
+}) {
+	const sql = file ? readFileSync(file) : command;
 	if (!sql) throw new Error(`Error: must provide --command or --file.`);
+	if (preview && local)
+		throw new Error(`Error: can't use --preview with --local`);
 	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,73 +177,39 @@ 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,
+				batches: batchSplit(queries),
+				json,
+				preview,
+		  });
 }
 
-export const Handler = withConfig<ExecuteArgs>(
-	async ({
-		config,
-		database,
-		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;
-
-							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));
-		}
-	}
-);
-
-async function executeLocally(
-	config: Config,
-	name: string,
-	shouldPrompt: boolean | undefined,
-	queries: string[],
-	persistTo: string | undefined
-) {
+async function executeLocally({
+	config,
+	name,
+	shouldPrompt,
+	queries,
+	persistTo,
+	json,
+}: {
+	config: Config;
+	name: string;
+	shouldPrompt: boolean | undefined;
+	queries: string[];
+	persistTo: string | undefined;
+	json: boolean | undefined;
+}) {
 	const localDB = getDatabaseInfoFromConfig(config, name);
 	if (!localDB) {
 		throw new Error(
@@ -204,40 +225,46 @@ async function executeLocally(
 
 	const dbDir = path.join(persistencePath, "d1");
 	const dbPath = path.join(dbDir, `${localDB.binding}.sqlite3`);
-	const [{ Statement }, { createSQLiteDB }] =
-		await npxImport<MiniflareNpxImportTypes>(
-			["@miniflare/d1", "@miniflare/shared"],
-			logger.log
-		);
-
-	if (!existsSync(dbDir) && shouldPrompt) {
-		const ok = await confirm(
-			`About to create ${readableRelative(dbPath)}, ok?`
-		);
+	const [{ D1Database, D1DatabaseAPI }, { createSQLiteDB }] = await npxImport<
+		// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+		[typeof import("@miniflare/d1"), typeof import("@miniflare/shared")]
+	>(["@miniflare/d1", "@miniflare/shared"], logger.log);
+
+	if (!existsSync(dbDir)) {
+		const ok =
+			json ||
+			!shouldPrompt ||
+			(await confirm(`About to create ${readableRelative(dbPath)}, ok?`));
 		if (!ok) return null;
 		await mkdir(dbDir, { recursive: true });
 	}
 
 	logger.log(`🌀 Loading DB at ${readableRelative(dbPath)}`);
-	const db = await createSQLiteDB(dbPath);
-
-	const results: QueryResult[] = [];
-	for (const sql of queries) {
-		const statement = new Statement(db, sql);
-		results.push((await statement.all()) as QueryResult);
-	}
 
-	return results;
+	const sqliteDb = await createSQLiteDB(dbPath);
+	const db = new D1Database(new D1DatabaseAPI(sqliteDb));
+	const stmts = queries.map((query) => db.prepare(query));
+	return (await db.batch(stmts)) as QueryResult[];
 }
 
-async function executeRemotely(
-	config: Config,
-	name: string,
-	shouldPrompt: boolean | undefined,
-	batches: string[]
-) {
+async function executeRemotely({
+	config,
+	name,
+	shouldPrompt,
+	batches,
+	json,
+	preview,
+}: {
+	config: Config;
+	name: string;
+	shouldPrompt: boolean | undefined;
+	batches: string[];
+	json: boolean | undefined;
+	preview: boolean | undefined;
+}) {
 	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) {
@@ -257,15 +284,13 @@ async function executeRemotely(
 		accountId,
 		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}):`);
+	if (preview && !db.previewDatabaseUuid) {
+		throw logger.error(
+			"Please define a `preview_database_id` in your wrangler.toml to execute your queries against a preview database"
+		);
 	}
+	const dbUuid = preview ? db.previewDatabaseUuid : db.uuid;
+	logger.log(`🌀 Executing on ${name} (${dbUuid}):`);
 
 	const results: QueryResult[] = [];
 	for (const sql of batches) {
@@ -275,7 +300,7 @@ async function executeRemotely(
 			);
 
 		const result = await fetchResult<QueryResult[]>(
-			`/accounts/${accountId}/d1/database/${db.uuid}/query`,
+			`/accounts/${accountId}/d1/database/${dbUuid}/query`,
 			{
 				method: "POST",
 				headers: {
@@ -321,3 +346,9 @@ function batchSplit(queries: string[]) {
 	}
 	return batches;
 }
+
+function shorten(query: string | undefined, length: number) {
+	return query && query.length > length
+		? query.slice(0, length) + "..."
+		: query;
+}

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

@@ -19,20 +19,24 @@ import {
 	getUnappliedMigrations,
 	initMigrationsTable,
 } from "./helpers";
-import { DatabaseWithLocal } from "./options";
+import { MigrationOptions } 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> {
-	return DatabaseWithLocal(yargs);
+export function ApplyOptions(yargs: CommonYargsArgv) {
+	return MigrationOptions(yargs);
 }
 
-export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
-	async ({ config, database, local, persistTo }): Promise<void> => {
+type ApplyHandlerOptions = StrictYargsOptionsToInterface<typeof ApplyOptions>;
+
+export const ApplyHandler = withConfig<ApplyHandlerOptions>(
+	async ({ config, database, local, persistTo, preview }): 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...`
@@ -43,31 +47,34 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
 			return;
 		}
 
-		const migrationsPath = await getMigrationsPath(
-			path.dirname(config.configPath),
-			databaseInfo?.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
-			false
-		);
+		const migrationsPath = await getMigrationsPath({
+			projectPath: path.dirname(config.configPath),
+			migrationsFolderPath:
+				databaseInfo?.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
+			createIfMissing: false,
+		});
 
-		const migrationTableName =
+		const migrationsTableName =
 			databaseInfo?.migrationsTableName ?? DEFAULT_MIGRATION_TABLE;
-		await initMigrationsTable(
-			migrationTableName,
+		await initMigrationsTable({
+			migrationsTableName,
 			local,
 			config,
-			database,
-			persistTo
-		);
+			name: database,
+			persistTo,
+			preview,
+		});
 
 		const unappliedMigrations = (
-			await getUnappliedMigrations(
-				migrationTableName,
+			await getUnappliedMigrations({
+				migrationsTableName,
 				migrationsPath,
 				local,
 				config,
-				database,
-				persistTo
-			)
+				name: database,
+				persistTo,
+				preview,
+			})
 		)
 			.map((migration) => {
 				return {
@@ -105,8 +112,8 @@ Your database may not be available to serve requests during the migration, conti
 		);
 		if (!ok) return;
 
-		// don't backup prod db when applying migrations locally
-		if (!local) {
+		// don't backup prod db when applying migrations locally or in preview
+		if (!local && !preview) {
 			assert(
 				databaseInfo,
 				"In non-local mode `databaseInfo` should be defined."
@@ -122,22 +129,24 @@ 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}');
 						`;
 
 			let success = true;
 			let errorNotes: Array<string> = [];
 			try {
-				const response = await executeSql(
+				const response = await executeSql({
 					local,
 					config,
-					database,
-					isInteractive() && !CI.isCI(),
+					name: database,
+					shouldPrompt: isInteractive() && !CI.isCI(),
 					persistTo,
-					undefined,
-					query
-				);
+					command: query,
+					file: undefined,
+					json: undefined,
+					preview,
+				});
 
 				if (response === null) {
 					// TODO:  return error

package/src/d1/migrations/create.tsx

@@ -4,19 +4,16 @@ import { Box, render, Text } from "ink";
 import React from "react";
 import { withConfig } from "../../config";
 import { logger } from "../../logger";
-import { requireAuth } from "../../user";
+import { DEFAULT_MIGRATION_PATH } from "../constants";
 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,13 @@ 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...`
@@ -40,11 +38,12 @@ export const CreateHandler = withConfig<MigrationsCreateArgs>(
 			return;
 		}
 
-		const migrationsPath = await getMigrationsPath(
-			path.dirname(config.configPath),
-			databaseInfo.migrationsFolderPath,
-			true
-		);
+		const migrationsPath = await getMigrationsPath({
+			projectPath: path.dirname(config.configPath),
+			migrationsFolderPath:
+				databaseInfo.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
+			createIfMissing: true,
+		});
 		const nextMigrationNumber = pad(getNextMigrationNumber(migrationsPath), 4);
 		const migrationName = message.replaceAll(" ", "_");