wrangler 0.0.0-e3278fa → 0.0.0-e33bea9b

package/src/queues/cli/commands/consumer/remove.ts

@@ -0,0 +1,31 @@
+import { readConfig } from "../../../../config";
+import { logger } from "../../../../logger";
+import { deleteConsumer } from "../../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../../yargs-types";
+
+export function options(yargs: CommonYargsArgv) {
+	return yargs
+		.positional("queue-name", {
+			type: "string",
+			demandOption: true,
+			description: "Name of the queue to configure",
+		})
+		.positional("script-name", {
+			type: "string",
+			demandOption: true,
+			description: "Name of the consumer script",
+		});
+}
+
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
+	const config = readConfig(args.config, args);
+
+	logger.log(`Removing consumer from queue ${args.queueName}.`);
+	await deleteConsumer(config, args.queueName, args.scriptName, args.env);
+	logger.log(`Removed consumer from queue ${args.queueName}.`);
+}

package/src/queues/cli/commands/create.ts

@@ -0,0 +1,25 @@
+import { readConfig } from "../../../config";
+import { logger } from "../../../logger";
+import { createQueue } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
+
+export function options(yargs: CommonYargsArgv) {
+	return yargs.positional("name", {
+		type: "string",
+		demandOption: true,
+		description: "The name of the queue",
+	});
+}
+
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
+	const config = readConfig(args.config, args);
+
+	logger.log(`Creating queue ${args.name}.`);
+	await createQueue(config, { queue_name: args.name });
+	logger.log(`Created queue ${args.name}.`);
+}

package/src/queues/cli/commands/delete.ts

@@ -0,0 +1,26 @@
+import { readConfig } from "../../../config";
+import { logger } from "../../../logger";
+import { deleteQueue } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
+
+export function options(yargs: CommonYargsArgv) {
+	// TODO(soon) --force option
+	return yargs.positional("name", {
+		type: "string",
+		demandOption: true,
+		description: "The name of the queue",
+	});
+}
+
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
+	const config = readConfig(args.config, args);
+
+	logger.log(`Deleting queue ${args.name}.`);
+	await deleteQueue(config, args.name);
+	logger.log(`Deleted queue ${args.name}.`);
+}

package/src/queues/cli/commands/index.ts

@@ -0,0 +1,35 @@
+import { HandleUnauthorizedError } from "../../utils";
+import { consumers } from "./consumer";
+
+import { options as createOptions, handler as createHandler } from "./create";
+import { options as deleteOptions, handler as deleteHandler } from "./delete";
+import { options as listOptions, handler as listHandler } from "./list";
+import type { CommonYargsArgv } from "../../../yargs-types";
+
+export function queues(yargs: CommonYargsArgv) {
+	yargs.command("list", "List Queues", listOptions, listHandler);
+
+	yargs.command(
+		"create <name>",
+		"Create a Queue",
+		createOptions,
+		createHandler
+	);
+
+	yargs.command(
+		"delete <name>",
+		"Delete a Queue",
+		deleteOptions,
+		deleteHandler
+	);
+
+	yargs.command(
+		"consumer",
+		"Configure Queue Consumers",
+		async (consumersYargs) => {
+			await consumers(consumersYargs);
+		}
+	);
+
+	yargs.fail(HandleUnauthorizedError);
+}

package/src/queues/cli/commands/list.ts

@@ -0,0 +1,25 @@
+import { readConfig } from "../../../config";
+import { logger } from "../../../logger";
+import { listQueues } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
+
+export function options(yargs: CommonYargsArgv) {
+	return yargs.options({
+		page: {
+			type: "number",
+			describe: "Page number for pagination",
+		},
+	});
+}
+
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
+	const config = readConfig(args.config, args);
+
+	const queues = await listQueues(config, args.page);
+	logger.log(JSON.stringify(queues));
+}

package/src/queues/client.ts

@@ -0,0 +1,135 @@
+import { fetchResult } from "../cfetch";
+import { type Config } from "../config";
+import { requireAuth } from "../user";
+
+export async function createQueue(
+	config: Config,
+	body: CreateQueueBody
+): Promise<QueueResponse> {
+	const accountId = await requireAuth(config);
+	return await fetchResult(`/accounts/${accountId}/workers/queues`, {
+		method: "POST",
+		body: JSON.stringify(body),
+	});
+}
+
+export interface CreateQueueBody {
+	queue_name: string;
+}
+
+export interface QueueResponse {
+	queue_name: string;
+	created_on: string;
+	modified_on: string;
+}
+
+export async function deleteQueue(
+	config: Config,
+	queueName: string
+): Promise<void> {
+	const accountId = await requireAuth(config);
+	return await fetchResult(
+		`/accounts/${accountId}/workers/queues/${queueName}`,
+		{
+			method: "DELETE",
+		}
+	);
+}
+
+// TODO(soon) show detailed queue response
+export async function listQueues(
+	config: Config,
+	page?: number
+): Promise<QueueResponse[]> {
+	page = page ?? 1;
+	const accountId = await requireAuth(config);
+	return await fetchResult(
+		`/accounts/${accountId}/workers/queues`,
+		{},
+		new URLSearchParams({ page: page.toString() })
+	);
+}
+
+export async function getQueue(
+	config: Config,
+	queueName: string
+): Promise<QueueResponse> {
+	const accountId = await requireAuth(config);
+	return await fetchResult(
+		`/accounts/${accountId}/workers/queues/${queueName}`,
+		{}
+	);
+}
+
+export async function postConsumer(
+	config: Config,
+	queueName: string,
+	body: PostConsumerBody
+): Promise<ConsumerResponse> {
+	const accountId = await requireAuth(config);
+	return fetchResult(
+		`/accounts/${accountId}/workers/queues/${queueName}/consumers`,
+		{
+			method: "POST",
+			body: JSON.stringify(body),
+		}
+	);
+}
+
+export interface PutConsumerBody {
+	settings: ConsumerSettings;
+	dead_letter_queue?: string;
+}
+
+export interface PostConsumerBody extends PutConsumerBody {
+	script_name: string;
+	environment_name: string;
+}
+
+export interface ConsumerSettings {
+	batch_size?: number;
+	max_retries?: number;
+	max_wait_time_ms?: number;
+}
+
+export interface ConsumerResponse extends PostConsumerBody {
+	queue_name: string;
+	script_name: string;
+	environment_name: string;
+	settings: ConsumerSettings;
+	dead_letter_queue?: string;
+}
+
+export async function deleteConsumer(
+	config: Config,
+	queueName: string,
+	scriptName: string,
+	envName?: string
+): Promise<void> {
+	const accountId = await requireAuth(config);
+	let resource = `/accounts/${accountId}/workers/queues/${queueName}/consumers/${scriptName}`;
+	if (envName !== undefined) {
+		resource += `/environments/${envName}`;
+	}
+	return fetchResult(resource, {
+		method: "DELETE",
+	});
+}
+
+export async function putConsumer(
+	config: Config,
+	queueName: string,
+	scriptName: string,
+	envName: string | undefined,
+	body: PutConsumerBody
+): Promise<ConsumerResponse> {
+	const accountId = await requireAuth(config);
+	let resource = `/accounts/${accountId}/workers/queues/${queueName}/consumers/${scriptName}`;
+	if (envName !== undefined) {
+		resource += `/environments/${envName}`;
+	}
+	return fetchResult(resource, {
+		method: "PUT",
+		body: JSON.stringify(body),
+	});
+}

package/src/queues/utils.ts

@@ -0,0 +1,18 @@
+import { logger } from "../logger";
+import { type ParseError } from "../parse";
+import { getAccountId } from "../user";
+
+const isFetchError = (err: unknown): err is ParseError => err instanceof Error;
+
+export const HandleUnauthorizedError = async (_msg: string, err: Error) => {
+	//@ts-expect-error non-standard property on Error
+	if (isFetchError(err) && err.code === 10023) {
+		const accountId = await getAccountId();
+		if (accountId) {
+			return logger.log(
+				`Queues is not currently enabled on this account. Go to https://dash.cloudflare.com/${accountId}/workers/queues to enable it.`
+			);
+		}
+	}
+	throw err;
+};

package/src/r2/constants.ts

@@ -0,0 +1,4 @@
+/**
+ * The maximum file size we can upload using the V4 API.
+ */
+export const MAX_UPLOAD_SIZE = 300 * 1024 * 1024;

package/src/r2/helpers.ts

@@ -0,0 +1,132 @@
+import { Readable } from "node:stream";
+import { fetchResult } from "../cfetch";
+import { fetchR2Objects } from "../cfetch/internal";
+import type { HeadersInit } from "undici";
+
+/**
+ * Information about a bucket, returned from `listR2Buckets()`.
+ */
+export interface R2BucketInfo {
+	name: string;
+	creation_date: string;
+}
+
+/**
+ * Fetch a list of all the buckets under the given `accountId`.
+ */
+export async function listR2Buckets(
+	accountId: string
+): Promise<R2BucketInfo[]> {
+	const results = await fetchResult<{
+		buckets: R2BucketInfo[];
+	}>(`/accounts/${accountId}/r2/buckets`);
+	return results.buckets;
+}
+
+/**
+ * Create a bucket with the given `bucketName` within the account given by `accountId`.
+ *
+ * A 400 is returned if the account already owns a bucket with this name.
+ * A bucket must be explicitly deleted to be replaced.
+ */
+export async function createR2Bucket(
+	accountId: string,
+	bucketName: string
+): Promise<void> {
+	return await fetchResult<void>(`/accounts/${accountId}/r2/buckets`, {
+		method: "POST",
+		body: JSON.stringify({ name: bucketName }),
+	});
+}
+
+/**
+ * Delete a bucket with the given name
+ */
+export async function deleteR2Bucket(
+	accountId: string,
+	bucketName: string
+): Promise<void> {
+	return await fetchResult<void>(
+		`/accounts/${accountId}/r2/buckets/${bucketName}`,
+		{ method: "DELETE" }
+	);
+}
+
+export function bucketAndKeyFromObjectPath(objectPath = ""): {
+	bucket: string;
+	key: string;
+} {
+	const match = /^([^/]+)\/(.*)/.exec(objectPath);
+	if (match === null) {
+		throw new Error(
+			`The object path must be in the form of {bucket}/{key} you provided ${objectPath}`
+		);
+	}
+
+	return { bucket: match[1], key: match[2] };
+}
+
+/**
+ * Downloads an object
+ */
+export async function getR2Object(
+	accountId: string,
+	bucketName: string,
+	objectName: string
+): Promise<Readable> {
+	const response = await fetchR2Objects(
+		`/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
+		{ method: "GET" }
+	);
+
+	return Readable.from(response.body);
+}
+
+/**
+ * Uploads an object
+ */
+export async function putR2Object(
+	accountId: string,
+	bucketName: string,
+	objectName: string,
+	object: Readable | Buffer,
+	options: Record<string, unknown>
+): Promise<void> {
+	const headerKeys = [
+		"content-length",
+		"content-type",
+		"content-disposition",
+		"content-encoding",
+		"content-language",
+		"cache-control",
+		"expires",
+	];
+	const headers: HeadersInit = {};
+	for (const key of headerKeys) {
+		const value = options[key] || "";
+		if (value && typeof value === "string") headers[key] = value;
+	}
+
+	await fetchR2Objects(
+		`/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
+		{
+			body: object,
+			headers,
+			method: "PUT",
+			duplex: "half",
+		}
+	);
+}
+/**
+ * Delete an Object
+ */
+export async function deleteR2Object(
+	accountId: string,
+	bucketName: string,
+	objectName: string
+): Promise<void> {
+	await fetchR2Objects(
+		`/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
+		{ method: "DELETE" }
+	);
+}