wrangler 2.2.2 → 2.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.2.2",
+	"version": "2.2.3",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -119,7 +119,7 @@
 		"@databases/sql": "^3.2.0",
 		"@iarna/toml": "^3.0.0",
 		"@microsoft/api-extractor": "^7.28.3",
-		"@miniflare/tre": "3.0.0-next.2",
+		"@miniflare/tre": "^3.0.0-next.5",
 		"@types/better-sqlite3": "^7.6.0",
 		"@types/busboy": "^1.5.0",
 		"@types/command-exists": "^1.2.0",

package/src/__tests__/d1.test.ts

@@ -21,11 +21,12 @@ describe("d1", () => {
 		🗄  Interact with a D1 database
 
 		Commands:
-		  wrangler d1 list            List D1 databases
-		  wrangler d1 create <name>   Create D1 database
-		  wrangler d1 delete <name>   Delete D1 database
-		  wrangler d1 backup          Interact with D1 Backups
-		  wrangler d1 execute <name>  Executed command or SQL file
+		  wrangler d1 list                List D1 databases
+		  wrangler d1 create <name>       Create D1 database
+		  wrangler d1 delete <name>       Delete D1 database
+		  wrangler d1 backup              Interact with D1 Backups
+		  wrangler d1 execute <database>  Executed command or SQL file
+		  wrangler d1 migrations          Interact with D1 Migrations
 
 		Flags:
 		  -c, --config   Path to .toml configuration file  [string]
@@ -54,11 +55,12 @@ describe("d1", () => {
 		🗄  Interact with a D1 database
 
 		Commands:
-		  wrangler d1 list            List D1 databases
-		  wrangler d1 create <name>   Create D1 database
-		  wrangler d1 delete <name>   Delete D1 database
-		  wrangler d1 backup          Interact with D1 Backups
-		  wrangler d1 execute <name>  Executed command or SQL file
+		  wrangler d1 list                List D1 databases
+		  wrangler d1 create <name>       Create D1 database
+		  wrangler d1 delete <name>       Delete D1 database
+		  wrangler d1 backup              Interact with D1 Backups
+		  wrangler d1 execute <database>  Executed command or SQL file
+		  wrangler d1 migrations          Interact with D1 Migrations
 
 		Flags:
 		  -c, --config   Path to .toml configuration file  [string]

package/src/__tests__/generate.test.ts

@@ -55,7 +55,7 @@ describe("generate", () => {
 				`);
 		});
 
-		it("auto-increments the worker directory name", async () => {
+		it.skip("auto-increments the worker directory name", async () => {
 			fs.mkdirSync("my-worker");
 
 			expect(fs.existsSync("my-worker-1")).toBe(false);
@@ -104,7 +104,7 @@ describe("generate", () => {
 	});
 
 	describe("cloning", () => {
-		it("clones a cloudflare template with sparse checkouts", async () => {
+		it.skip("clones a cloudflare template with sparse checkouts", async () => {
 			await expect(
 				runWrangler("generate my-worker worker-typescript")
 			).resolves.toBeUndefined();
@@ -143,7 +143,7 @@ describe("generate", () => {
 			});
 		});
 
-		it("clones a user/repo/path/to/subdirectory template", async () => {
+		it.skip("clones a user/repo/path/to/subdirectory template", async () => {
 			await expect(
 				runWrangler("generate my-worker cloudflare/templates/worker-typescript")
 			).resolves.toBeUndefined();

package/src/__tests__/index.test.ts

@@ -42,7 +42,7 @@ describe("wrangler", () => {
 			  wrangler kv:key              🔑 Individually manage Workers KV key-value pairs
 			  wrangler kv:bulk             💪 Interact with multiple Workers KV key-value pairs at once
 			  wrangler pages               ⚡️ Configure Cloudflare Pages
-			  wrangler queues              🆀 Configure Workers Queues
+			  wrangler queues              🇶 Configure Workers Queues
 			  wrangler r2                  📦 Interact with an R2 store
 			  wrangler dispatch-namespace  📦 Interact with a dispatch namespace
 			  wrangler d1                  🗄  Interact with a D1 database
@@ -87,7 +87,7 @@ describe("wrangler", () => {
 			  wrangler kv:key              🔑 Individually manage Workers KV key-value pairs
 			  wrangler kv:bulk             💪 Interact with multiple Workers KV key-value pairs at once
 			  wrangler pages               ⚡️ Configure Cloudflare Pages
-			  wrangler queues              🆀 Configure Workers Queues
+			  wrangler queues              🇶 Configure Workers Queues
 			  wrangler r2                  📦 Interact with an R2 store
 			  wrangler dispatch-namespace  📦 Interact with a dispatch namespace
 			  wrangler d1                  🗄  Interact with a D1 database

package/src/__tests__/queues.test.ts

@@ -22,7 +22,7 @@ describe("wrangler", () => {
 			expect(std.out).toMatchInlineSnapshot(`
 			"wrangler queues
 
-			🆀 Configure Workers Queues
+			🇶 Configure Workers Queues
 
 			Commands:
 			  wrangler queues list           List Queues

package/src/config/environment.ts

@@ -411,6 +411,12 @@ interface EnvironmentNonInheritable {
 		database_id: string;
 		/** The UUID of this D1 database for Wrangler Dev (if specified). */
 		preview_database_id?: string;
+		/** The name of the migrations table for this D1 database (defaults to 'd1_migrations'). */
+		migrations_table?: string;
+		/** The path to the directory of migrations for this D1 database (defaults to './migrations'). */
+		migrations_dir?: string;
+		/** Internal use only. */
+		database_internal_env?: string;
 	}[];
 
 	/**

package/src/create-worker-upload-form.ts

@@ -41,7 +41,7 @@ type WorkerMetadataBinding =
 	  }
 	| { type: "queue"; name: string; queue_name: string }
 	| { type: "r2_bucket"; name: string; bucket_name: string }
-	| { type: "d1"; name: string; id: string }
+	| { type: "d1"; name: string; id: string; internalEnv?: string }
 	| { type: "service"; name: string; service: string; environment?: string }
 	| { type: "namespace"; name: string; namespace: string }
 	| {
@@ -129,13 +129,16 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		});
 	});
 
-	bindings.d1_databases?.forEach(({ binding, database_id }) => {
-		metadataBindings.push({
-			name: binding,
-			type: "d1",
-			id: database_id,
-		});
-	});
+	bindings.d1_databases?.forEach(
+		({ binding, database_id, database_internal_env }) => {
+			metadataBindings.push({
+				name: binding,
+				type: "d1",
+				id: database_id,
+				internalEnv: database_internal_env,
+			});
+		}
+	);
 
 	bindings.services?.forEach(({ binding, service, environment }) => {
 		metadataBindings.push({

package/src/d1/constants.ts

@@ -0,0 +1,2 @@
+export const DEFAULT_MIGRATION_PATH = "./migrations";
+export const DEFAULT_MIGRATION_TABLE = "d1_migrations";

package/src/d1/create.tsx

@@ -23,17 +23,26 @@ export async function Handler({
 	name,
 }: ArgumentsCamelCase<CreateArgs>): Promise<void> {
 	const accountId = await requireAuth({});
+
 	logger.log(d1BetaWarning);
 
-	const db: Database = await fetchResult(`/accounts/${accountId}/d1/database`, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-		},
-		body: JSON.stringify({
-			name,
-		}),
-	});
+	let db: Database;
+	try {
+		db = await fetchResult(`/accounts/${accountId}/d1/database`, {
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+			},
+			body: JSON.stringify({
+				name,
+			}),
+		});
+	} catch (e) {
+		if ((e as { code: number }).code === 7502) {
+			throw new Error("A database with that name already exists");
+		}
+		throw e;
+	}
 
 	render(
 		<Box flexDirection="column">

package/src/d1/execute.tsx

@@ -12,13 +12,13 @@ import { confirm, logDim } from "../dialogs";
 import { logger } from "../logger";
 import { readableRelative } from "../paths";
 import { requireAuth } from "../user";
-import { Name } from "./options";
+import * as options from "./options";
 import {
 	d1BetaWarning,
 	getDatabaseByNameOrBinding,
 	getDatabaseInfoFromConfig,
 } from "./utils";
-import type { Config } from "../config";
+import type { Config, ConfigFields, DevConfig, Environment } from "../config";
 import type { Database } from "./types";
 import type splitSqlQuery from "@databases/split-sql-query";
 import type { SQL, SQLQuery } from "@databases/sql";
@@ -35,26 +35,38 @@ type MiniflareNpxImportTypes = [
 	}
 ];
 
-type ExecuteArgs = {
+export type BaseSqlExecuteArgs = {
 	config?: string;
-	name: string;
-	file?: string;
-	command?: string;
+	database: string;
 	local?: boolean;
 	"persist-to"?: string;
+	yes?: boolean;
 };
 
-type QueryResult = {
+type ExecuteArgs = BaseSqlExecuteArgs & {
+	file?: string;
+	command?: string;
+};
+
+export type QueryResult = {
 	results: Record<string, string | number | boolean>[];
 	success: boolean;
-	duration: number;
+	meta?: {
+		duration?: number;
+	};
 	query?: string;
 };
 // Max number of bytes to send in a single /execute call
 const QUERY_LIMIT = 10_000;
 
 export function Options(yargs: Argv): Argv<ExecuteArgs> {
-	return Name(yargs)
+	return options
+		.Database(yargs)
+		.option("yes", {
+			describe: 'Answer "yes" to any prompts',
+			type: "boolean",
+			alias: "y",
+		})
 		.option("local", {
 			describe:
 				"Execute commands/files against a local DB for use with wrangler dev",
@@ -81,38 +93,66 @@ function shorten(query: string | undefined, length: number) {
 		: query;
 }
 
+export async function executeSql(
+	local: undefined | boolean,
+	config: ConfigFields<DevConfig> & Environment,
+	name: string,
+	shouldPrompt: boolean | undefined,
+	persistTo: undefined | string,
+	file?: string,
+	command?: string
+) {
+	const { parser, splitter } = await loadSqlUtils();
+
+	const sql = file
+		? parser.file(file)
+		: command
+		? parser.__dangerous__rawValue(command)
+		: null;
+
+	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`);
+
+	const queries = splitSql(splitter, sql);
+	if (file && sql) {
+		if (queries[0].startsWith("SQLite format 3")) {
+			//TODO: update this error to recommend using `wrangler d1 restore` when it exists
+			throw new Error(
+				"Provided file is a binary SQLite database file instead of an SQL text file.\nThe execute command can only process SQL text files.\nPlease export an SQL file from your SQLite database and try again."
+			);
+		}
+	}
+
+	return local
+		? await executeLocally(config, name, shouldPrompt, queries, persistTo)
+		: await executeRemotely(config, name, shouldPrompt, batchSplit(queries));
+}
+
 export const Handler = withConfig<ExecuteArgs>(
-	async ({ config, name, file, command, local, persistTo }): Promise<void> => {
+	async ({
+		config,
+		database,
+		file,
+		command,
+		local,
+		persistTo,
+		yes,
+	}): Promise<void> => {
 		logger.log(d1BetaWarning);
 		if (file && command)
 			return console.error(`Error: can't provide both --command and --file.`);
-		const { parser, splitter } = await loadSqlUtils();
-
-		const sql = file
-			? parser.file(file)
-			: command
-			? parser.__dangerous__rawValue(command)
-			: null;
-
-		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`);
 
 		const isInteractive = process.stdout.isTTY;
-		const response: QueryResult[] | null = local
-			? await executeLocally(
-					config,
-					name,
-					isInteractive,
-					splitSql(splitter, sql),
-					persistTo
-			  )
-			: await executeRemotely(
-					config,
-					name,
-					isInteractive,
-					batchSplit(splitter, sql)
-			  );
+		const response: QueryResult[] | null = await executeSql(
+			local,
+			config,
+			database,
+			isInteractive && !yes,
+			persistTo,
+			file,
+			command
+		);
 
 		// Early exit if prompt rejected
 		if (!response) return;
@@ -148,7 +188,7 @@ export const Handler = withConfig<ExecuteArgs>(
 async function executeLocally(
 	config: Config,
 	name: string,
-	isInteractive: boolean,
+	shouldPrompt: boolean | undefined,
 	queries: string[],
 	persistTo: string | undefined
 ) {
@@ -173,7 +213,7 @@ async function executeLocally(
 			logDim
 		);
 
-	if (!existsSync(dbDir) && isInteractive) {
+	if (!existsSync(dbDir) && shouldPrompt) {
 		const ok = await confirm(
 			`About to create ${readableRelative(dbPath)}, ok?`
 		);
@@ -196,13 +236,14 @@ async function executeLocally(
 async function executeRemotely(
 	config: Config,
 	name: string,
-	isInteractive: boolean,
+	shouldPrompt: boolean | undefined,
 	batches: string[]
 ) {
-	if (batches.length > 1) {
+	const multiple_batches = batches.length > 1;
+	if (multiple_batches) {
 		const warning = `⚠️  Too much SQL to send at once, this execution will be sent as ${batches.length} batches.`;
 
-		if (isInteractive) {
+		if (shouldPrompt) {
 			const ok = await confirm(
 				`${warning}\nℹ️  Each batch is sent individually and may leave your DB in an unexpected state if a later batch fails.\n⚠️  Make sure you have a recent backup. Ok to proceed?`
 			);
@@ -220,9 +261,11 @@ async function executeRemotely(
 		name
 	);
 
-	if (isInteractive) {
+	if (shouldPrompt) {
 		logger.log(`🌀 Executing on ${name} (${db.uuid}):`);
-	} else {
+
+		// Don't output if shouldPrompt is undefined
+	} else if (shouldPrompt !== undefined) {
 		// Pipe to error so we don't break jq
 		console.error(`Executing on ${name} (${db.uuid}):`);
 	}
@@ -235,6 +278,7 @@ async function executeRemotely(
 				method: "POST",
 				headers: {
 					"Content-Type": "application/json",
+					...(db.internal_env ? { "x-d1-internal-env": db.internal_env } : {}),
 				},
 				body: JSON.stringify({ sql }),
 			}
@@ -247,12 +291,14 @@ async function executeRemotely(
 
 function logResult(r: QueryResult | QueryResult[]) {
 	logger.log(
-		`🚣 Executed ${Array.isArray(r) ? r.length : "1"} command(s) in ${
+		`🚣 Executed ${
+			Array.isArray(r) ? `${r.length} commands` : "1 command"
+		} in ${
 			Array.isArray(r)
 				? r
-						.map((d: QueryResult) => d.duration)
+						.map((d: QueryResult) => d.meta?.duration || 0)
 						.reduce((a: number, b: number) => a + b, 0)
-				: r.duration
+				: r.meta?.duration
 		}ms`
 	);
 }
@@ -269,12 +315,11 @@ function splitSql(splitter: (query: SQLQuery) => SQLQuery[], sql: SQLQuery) {
 	);
 }
 
-function batchSplit(splitter: typeof splitSqlQuery, sql: SQLQuery) {
-	const queries = splitSql(splitter, sql);
+function batchSplit(queries: string[]) {
 	logger.log(`🌀 Parsing ${queries.length} statements`);
 	const batches: string[] = [];
-	const nbatches = Math.floor(queries.length / QUERY_LIMIT);
-	for (let i = 0; i <= nbatches; i++) {
+	const num_batches = Math.ceil(queries.length / QUERY_LIMIT);
+	for (let i = 0; i < num_batches; i++) {
 		batches.push(
 			queries.slice(i * QUERY_LIMIT, (i + 1) * QUERY_LIMIT).join("; ")
 		);

package/src/d1/index.ts

@@ -3,6 +3,7 @@ import * as Create from "./create";
 import * as Delete from "./delete";
 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";
@@ -66,11 +67,33 @@ export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 			//   }
 			// )
 			.command(
-				"execute <name>",
+				"execute <database>",
 				"Executed command or SQL file",
 				Execute.Options,
 				Execute.Handler
 			)
+			.command("migrations", "Interact with D1 Migrations", (yargs2) =>
+				yargs2
+					.command(
+						"list <database>",
+						"List your D1 migrations",
+						Migrations.ListOptions,
+						Migrations.ListHandler
+					)
+					.command(
+						"create <database> <message>",
+						"Create a new Migration",
+						Migrations.CreateOptions,
+						Migrations.CreateHandler
+					)
+					.command(
+						"apply <database>",
+						"Apply D1 Migrations",
+						Migrations.ApplyOptions,
+						Migrations.ApplyHandler
+					)
+					.epilogue(d1BetaWarning)
+			)
 			.epilogue(d1BetaWarning)
 	);
 };