wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

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

@@ -23,6 +23,34 @@ export function toMimeType(type: CfModuleType): string {
 	}
 }
 
+type WorkerMetadataBinding =
+	// If you add any new binding types here, also add it to safeBindings
+	// under validateUnsafeBinding in config/validation.ts
+	| { type: "plain_text"; name: string; text: string }
+	| { type: "json"; name: string; json: unknown }
+	| { type: "wasm_module"; name: string; part: string }
+	| { type: "text_blob"; name: string; part: string }
+	| { type: "data_blob"; name: string; part: string }
+	| { type: "kv_namespace"; name: string; namespace_id: string }
+	| {
+			type: "durable_object_namespace";
+			name: string;
+			class_name: string;
+			script_name?: string;
+			environment?: string;
+	  }
+	| { type: "queue"; name: string; queue_name: string }
+	| { type: "r2_bucket"; name: string; bucket_name: string }
+	| { type: "d1"; name: string; id: string; internalEnv?: string }
+	| { type: "service"; name: string; service: string; environment?: string }
+	| { type: "analytics_engine"; name: string; dataset?: string }
+	| { type: "dispatch_namespace"; name: string; namespace: string }
+	| {
+			type: "logfwdr";
+			name: string;
+			destination: string;
+	  };
+
 export interface WorkerMetadata {
 	/** The name of the entry point module. Only exists when the worker is in the ES module format */
 	main_module?: string;
@@ -32,26 +60,10 @@ export interface WorkerMetadata {
 	compatibility_flags?: string[];
 	usage_model?: "bundled" | "unbound";
 	migrations?: CfDurableObjectMigrations;
-	// If you add any new binding types here, also add it to safeBindings
-	// under validateUnsafeBinding in config/validation.ts
-	bindings: (
-		| { type: "plain_text"; name: string; text: string }
-		| { type: "json"; name: string; json: unknown }
-		| { type: "wasm_module"; name: string; part: string }
-		| { type: "text_blob"; name: string; part: string }
-		| { type: "data_blob"; name: string; part: string }
-		| { type: "kv_namespace"; name: string; namespace_id: string }
-		| {
-				type: "durable_object_namespace";
-				name: string;
-				class_name: string;
-				script_name?: string;
-				environment?: string;
-		  }
-		| { type: "r2_bucket"; name: string; bucket_name: string }
-		| { type: "service"; name: string; service: string; environment?: string }
-		| { type: "namespace"; name: string; namespace: string }
-	)[];
+	capnp_schema?: string;
+	bindings: WorkerMetadataBinding[];
+	keep_bindings?: WorkerMetadataBinding["type"][];
+	logpush?: boolean;
 }
 
 /**
@@ -66,6 +78,8 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		usage_model,
 		compatibility_date,
 		compatibility_flags,
+		keepVars,
+		logpush,
 	} = worker;
 
 	let { modules } = worker;
@@ -100,6 +114,14 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		}
 	);
 
+	bindings.queues?.forEach(({ binding, queue_name }) => {
+		metadataBindings.push({
+			type: "queue",
+			name: binding,
+			queue_name,
+		});
+	});
+
 	bindings.r2_buckets?.forEach(({ binding, bucket_name }) => {
 		metadataBindings.push({
 			name: binding,
@@ -108,6 +130,17 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		});
 	});
 
+	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({
 			name: binding,
@@ -117,14 +150,30 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		});
 	});
 
-	bindings.worker_namespaces?.forEach(({ binding, namespace }) => {
+	bindings.analytics_engine_datasets?.forEach(({ binding, dataset }) => {
 		metadataBindings.push({
 			name: binding,
-			type: "namespace",
+			type: "analytics_engine",
+			dataset,
+		});
+	});
+
+	bindings.dispatch_namespaces?.forEach(({ binding, namespace }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "dispatch_namespace",
 			namespace,
 		});
 	});
 
+	bindings.logfwdr?.bindings.forEach(({ name, destination }) => {
+		metadataBindings.push({
+			name: name,
+			type: "logfwdr",
+			destination,
+		});
+	});
+
 	for (const [name, filePath] of Object.entries(bindings.wasm_modules || {})) {
 		metadataBindings.push({
 			name,
@@ -240,6 +289,9 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		...(compatibility_flags && { compatibility_flags }),
 		...(usage_model && { usage_model }),
 		...(migrations && { migrations }),
+		capnp_schema: bindings.logfwdr?.schema,
+		...(keepVars && { keep_bindings: ["plain_text", "json"] }),
+		...(logpush !== undefined && { logpush }),
 	};
 
 	formData.set("metadata", JSON.stringify(metadata));
@@ -259,5 +311,15 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		);
 	}
 
+	if (bindings.logfwdr && bindings.logfwdr.schema) {
+		const filePath = bindings.logfwdr.schema;
+		formData.set(
+			filePath,
+			new File([readFileSync(filePath)], filePath, {
+				type: "application/octet-stream",
+			})
+		);
+	}
+
 	return formData;
 }

package/src/d1/backups.tsx

@@ -0,0 +1,223 @@
+import fs from "node:fs/promises";
+import * as path from "path";
+import { render } from "ink";
+import Table from "ink-table";
+import React from "react";
+import { fetchResult } from "../cfetch";
+import { performApiFetch } from "../cfetch/internal";
+import { withConfig } from "../config";
+import { logger } from "../logger";
+import { requireAuth } from "../user";
+import { formatBytes, formatTimeAgo } from "./formatTimeAgo";
+import { Name } from "./options";
+import { d1BetaWarning, getDatabaseByNameOrBinding } from "./utils";
+import type { Backup, Database } from "./types";
+import type { Response } from "undici";
+import type { Argv } from "yargs";
+
+type BackupListArgs = { config?: string; name: string };
+
+export function ListOptions(yargs: Argv): Argv<BackupListArgs> {
+	return Name(yargs);
+}
+
+export const ListHandler = withConfig<BackupListArgs>(
+	async ({ config, name }): Promise<void> => {
+		const accountId = await requireAuth({});
+		logger.log(d1BetaWarning);
+		const db: Database = await getDatabaseByNameOrBinding(
+			config,
+			accountId,
+			name
+		);
+
+		const backups: Backup[] = await listBackups(accountId, db.uuid);
+		render(
+			<Table
+				data={backups}
+				columns={["created_at", "id", "num_tables", "size"]}
+			></Table>
+		);
+	}
+);
+
+export const listBackups = async (
+	accountId: string,
+	uuid: string
+): Promise<Array<Backup>> => {
+	const json: Backup[] = await fetchResult(
+		`/accounts/${accountId}/d1/database/${uuid}/backup`,
+		{}
+	);
+	const results: Record<string, Backup> = {};
+
+	json
+		// First, convert created_at to a Date
+		.map((backup) => ({
+			...backup,
+			created_at: new Date(backup.created_at),
+		}))
+		// Then, sort descending based on created_at
+		.sort((a, b) => +b.created_at - +a.created_at)
+		// then group_by their human-readable timestamp i.e. "2 days ago"
+		// (storing only the first of each group)
+		// and replace the Date version with this new human-readable one
+		.forEach((backup) => {
+			const timeAgo = formatTimeAgo(backup.created_at);
+			if (!results[timeAgo]) {
+				results[timeAgo] = {
+					...backup,
+					created_at: timeAgo,
+					size: formatBytes(backup.file_size),
+				};
+			}
+		});
+
+	// Take advantage of JS objects' sorting to return the newest backup of a certain age
+	return Object.values(results);
+};
+
+type BackupCreateArgs = BackupListArgs;
+
+export function CreateOptions(yargs: Argv): Argv<BackupCreateArgs> {
+	return ListOptions(yargs);
+}
+
+export const CreateHandler = withConfig<BackupCreateArgs>(
+	async ({ config, name }): Promise<void> => {
+		const accountId = await requireAuth({});
+		logger.log(d1BetaWarning);
+		const db: Database = await getDatabaseByNameOrBinding(
+			config,
+			accountId,
+			name
+		);
+
+		const backup: Backup = await createBackup(accountId, db.uuid);
+		render(
+			<Table
+				data={[backup]}
+				columns={["created_at", "id", "num_tables", "size", "state"]}
+			></Table>
+		);
+	}
+);
+
+export const createBackup = async (
+	accountId: string,
+	uuid: string
+): Promise<Backup> => {
+	const backup: Backup = await fetchResult(
+		`/accounts/${accountId}/d1/database/${uuid}/backup`,
+		{
+			method: "POST",
+		}
+	);
+	return {
+		...backup,
+		size: formatBytes(backup.file_size),
+	};
+};
+
+type BackupRestoreArgs = BackupListArgs & {
+	"backup-id": string;
+};
+
+export function RestoreOptions(yargs: Argv): Argv<BackupRestoreArgs> {
+	return ListOptions(yargs).positional("backup-id", {
+		describe: "The Backup ID to restore",
+		type: "string",
+		demandOption: true,
+	});
+}
+
+export const RestoreHandler = withConfig<BackupRestoreArgs>(
+	async ({ config, name, backupId }): Promise<void> => {
+		const accountId = await requireAuth({});
+		logger.log(d1BetaWarning);
+		const db: Database = await getDatabaseByNameOrBinding(
+			config,
+			accountId,
+			name
+		);
+
+		logger.log(`Restoring ${name} from backup ${backupId}....`);
+		await restoreBackup(accountId, db.uuid, backupId);
+		logger.log(`Done!`);
+	}
+);
+
+export const restoreBackup = async (
+	accountId: string,
+	uuid: string,
+	backupId: string
+): Promise<void> => {
+	await fetchResult(
+		`/accounts/${accountId}/d1/database/${uuid}/backup/${backupId}/restore`,
+		{
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+			},
+		}
+	);
+};
+
+type BackupDownloadArgs = BackupRestoreArgs & {
+	output?: string;
+};
+
+export function DownloadOptions(yargs: Argv): Argv<BackupDownloadArgs> {
+	return ListOptions(yargs)
+		.positional("backup-id", {
+			describe: "The Backup ID to download",
+			type: "string",
+			demandOption: true,
+		})
+		.option("output", {
+			describe:
+				"The .sqlite3 file to write to (defaults to '<db-name>.<short-backup-id>.sqlite3'",
+			type: "string",
+		});
+}
+
+export const DownloadHandler = withConfig<BackupDownloadArgs>(
+	async ({ name, backupId, output, config }): Promise<void> => {
+		const accountId = await requireAuth({});
+		logger.log(d1BetaWarning);
+		const db: Database = await getDatabaseByNameOrBinding(
+			config,
+			accountId,
+			name
+		);
+		const filename =
+			output ||
+			path.join(
+				process.env.INIT_CWD as string,
+				`${name}.${backupId.slice(0, 8)}.sqlite3`
+			);
+
+		logger.log(`🌀 Downloading backup ${backupId} from '${name}'`);
+		const response = await getBackupResponse(accountId, db.uuid, backupId);
+		if (!response.ok) {
+			throw new Error(
+				`Failed to download backup ${backupId} from '${name}' - got ${response.status} from the API`
+			);
+		}
+		logger.log(`🌀 Saving to ${filename}`);
+		// TODO: stream this once we upgrade to Node18 and can use Writable.fromWeb
+		const buffer = await response.arrayBuffer();
+		await fs.writeFile(filename, new Buffer(buffer));
+		logger.log(`🌀 Done!`);
+	}
+);
+
+export const getBackupResponse = async (
+	accountId: string,
+	uuid: string,
+	backupId: string
+): Promise<Response> => {
+	return await performApiFetch(
+		`/accounts/${accountId}/d1/database/${uuid}/backup/${backupId}/download`
+	);
+};

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

@@ -0,0 +1,63 @@
+import { render, Text, Box } from "ink";
+import React from "react";
+import { fetchResult } from "../cfetch";
+import { logger } from "../logger";
+import { requireAuth } from "../user";
+import { d1BetaWarning } from "./utils";
+import type { Database } from "./types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+type CreateArgs = { name: string };
+
+export function Options(yargs: Argv): Argv<CreateArgs> {
+	return yargs
+		.positional("name", {
+			describe: "The name of the new DB",
+			type: "string",
+			demandOption: true,
+		})
+		.epilogue(d1BetaWarning);
+}
+
+export async function Handler({
+	name,
+}: ArgumentsCamelCase<CreateArgs>): Promise<void> {
+	const accountId = await requireAuth({});
+
+	logger.log(d1BetaWarning);
+
+	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">
+			<Text>✅ Successfully created DB &apos;{db.name}&apos;!</Text>
+			<Text>&nbsp;</Text>
+			<Text>
+				Add the following to your wrangler.toml to connect to it from a Worker:
+			</Text>
+			<Text>&nbsp;</Text>
+			<Text>[[ d1_databases ]]</Text>
+			<Text>
+				binding = &quot;DB&quot; # i.e. available in your Worker on env.DB
+			</Text>
+			<Text>database_name = &quot;{db.name}&quot;</Text>
+			<Text>database_id = &quot;{db.uuid}&quot;</Text>
+		</Box>
+	);
+}

package/src/d1/delete.tsx

@@ -0,0 +1,56 @@
+import { fetchResult } from "../cfetch";
+import { withConfig } from "../config";
+import { confirm } from "../dialogs";
+import { logger } from "../logger";
+import { requireAuth } from "../user";
+import { Name } from "./options";
+import { d1BetaWarning, getDatabaseByNameOrBinding } from "./utils";
+import type { Database } from "./types";
+import type { Argv } from "yargs";
+
+type CreateArgs = {
+	config?: string;
+	name: string;
+	"skip-confirmation": boolean;
+};
+
+export function Options(d1ListYargs: Argv): Argv<CreateArgs> {
+	return Name(d1ListYargs)
+		.option("skip-confirmation", {
+			describe: "Skip confirmation",
+			type: "boolean",
+			alias: "y",
+			default: false,
+		})
+		.epilogue(d1BetaWarning);
+}
+
+export const Handler = withConfig<CreateArgs>(
+	async ({ name, skipConfirmation, config }): Promise<void> => {
+		const accountId = await requireAuth({});
+		logger.log(d1BetaWarning);
+
+		const db: Database = await getDatabaseByNameOrBinding(
+			config,
+			accountId,
+			name
+		);
+
+		logger.log(`About to delete DB '${name}' (${db.uuid}).`);
+		if (!skipConfirmation) {
+			const response = await confirm(`Ok to proceed?`);
+			if (!response) {
+				logger.log(`Not deleting.`);
+				return;
+			}
+		}
+
+		logger.log("Deleting...");
+
+		await fetchResult(`/accounts/${accountId}/d1/database/${db.uuid}`, {
+			method: "DELETE",
+		});
+
+		logger.log(`Deleted '${name}' successfully.`);
+	}
+);