wrangler 2.1.14 → 2.2.0

package/src/proxy.ts

@@ -8,6 +8,7 @@ import { useEffect, useRef, useState } from "react";
 import serveStatic from "serve-static";
 import { getHttpsOptions } from "./https-options";
 import { logger } from "./logger";
+import { getAccessToken } from "./user/access";
 import type { CfPreviewToken } from "./create-worker-preview";
 import type { HttpTerminator } from "http-terminator";
 import type {
@@ -42,6 +43,27 @@ function addCfPreviewTokenHeader(
 	headers["cf-workers-preview-token"] = previewTokenValue;
 }
 
+export async function addCfAccessToken(
+	headers: IncomingHttpHeaders,
+	domain: string,
+	accessTokenRef: { current: string | undefined | null }
+) {
+	if (accessTokenRef.current === null) {
+		return;
+	}
+	if (typeof accessTokenRef.current === "string") {
+		headers[
+			"cookie"
+		] = `${headers["cookie"]};CF_Authorization=${accessTokenRef.current}`;
+		return;
+	}
+	const token = await getAccessToken(domain);
+	accessTokenRef.current = token;
+	if (token)
+		headers[
+			"cookie"
+		] = `${headers["cookie"]};CF_Authorization=${accessTokenRef.current}`;
+}
 /**
  * Rewrite references in request headers
  * from the preview host to the local host.
@@ -120,6 +142,7 @@ export async function startPreviewServer({
 		// We have a token. Let's proxy requests to the preview end point.
 		const streamBufferRef = { current: [] };
 		const requestResponseBufferRef = { current: [] };
+		const accessTokenRef = { current: undefined };
 		const cleanupListeners = configureProxyServer({
 			proxy,
 			previewToken,
@@ -129,6 +152,7 @@ export async function startPreviewServer({
 			assetDirectory,
 			localProtocol,
 			port,
+			accessTokenRef,
 		});
 
 		await waitForPortToBeAvailable(port, {
@@ -215,6 +239,7 @@ export function usePreviewServer({
 	const requestResponseBufferRef = useRef<
 		{ request: IncomingMessage; response: ServerResponse }[]
 	>([]);
+	const accessTokenRef = useRef<string | undefined | null>(undefined);
 
 	/**
 	 * The session doesn't last forever, and will eventually drop
@@ -237,6 +262,7 @@ export function usePreviewServer({
 			assetDirectory,
 			localProtocol,
 			port,
+			accessTokenRef,
 		});
 		return () => {
 			cleanupListeners?.forEach((cleanup) => cleanup());
@@ -307,6 +333,7 @@ function configureProxyServer({
 	port,
 	localProtocol,
 	assetDirectory,
+	accessTokenRef,
 }: {
 	proxy: PreviewProxy | undefined;
 	previewToken: CfPreviewToken | undefined;
@@ -324,6 +351,7 @@ function configureProxyServer({
 	port: number;
 	localProtocol: "https" | "http";
 	assetDirectory: string | undefined;
+	accessTokenRef: { current: string | null | undefined };
 }) {
 	if (proxy === undefined) {
 		return;
@@ -376,7 +404,8 @@ function configureProxyServer({
 		previewToken,
 		remote,
 		port,
-		localProtocol
+		localProtocol,
+		accessTokenRef
 	);
 	proxy.server.on("stream", handleStream);
 	cleanupListeners.push(() => proxy.server.off("stream", handleStream));
@@ -389,7 +418,7 @@ function configureProxyServer({
 	streamBufferRef.current = [];
 
 	/** HTTP/1 -> HTTP/2  */
-	const handleRequest: RequestListener = (
+	const handleRequest: RequestListener = async (
 		message: IncomingMessage,
 		response: ServerResponse
 	) => {
@@ -397,6 +426,7 @@ function configureProxyServer({
 		if (httpVersionMajor >= 2) {
 			return; // Already handled by the "stream" event.
 		}
+		await addCfAccessToken(headers, previewToken.host, accessTokenRef);
 		addCfPreviewTokenHeader(headers, previewToken.value);
 		headers[":method"] = method;
 		headers[":path"] = url;
@@ -419,7 +449,6 @@ function configureProxyServer({
 
 		request.on("response", (responseHeaders) => {
 			const status = responseHeaders[":status"] ?? 500;
-
 			// log all requests to terminal
 			logger.log(new Date().toLocaleTimeString(), method, url, status);
 
@@ -461,12 +490,13 @@ function configureProxyServer({
 	requestResponseBufferRef.current = [];
 
 	/** HTTP/1 -> WebSocket (over HTTP/1)  */
-	const handleUpgrade = (
+	const handleUpgrade = async (
 		originalMessage: IncomingMessage,
 		originalSocket: Duplex,
 		originalHead: Buffer
 	) => {
 		const { headers, method, url } = originalMessage;
+		await addCfAccessToken(headers, previewToken.host, accessTokenRef);
 		addCfPreviewTokenHeader(headers, previewToken.value);
 		headers["host"] = previewToken.host;
 
@@ -562,12 +592,14 @@ function createStreamHandler(
 	previewToken: CfPreviewToken,
 	remote: ClientHttp2Session,
 	localPort: number,
-	localProtocol: "https" | "http"
+	localProtocol: "https" | "http",
+	accessTokenRef: { current: string | undefined | null }
 ) {
-	return function handleStream(
+	return async function handleStream(
 		stream: ServerHttp2Stream,
 		headers: IncomingHttpHeaders
 	) {
+		await addCfAccessToken(headers, previewToken.host, accessTokenRef);
 		addCfPreviewTokenHeader(headers, previewToken.value);
 		headers[":authority"] = previewToken.host;
 		const request = stream.pipe(remote.request(headers));

package/src/publish/index.ts

@@ -14,18 +14,15 @@ import { requireAuth } from "../user";
 import { collectKeyValues } from "../utils/collectKeyValues";
 import publish from "./publish";
 import type { ConfigPath } from "../index";
-import type { YargsOptionsToInterface } from "../yargs-types";
+import type {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "../yargs-types";
 import type { Argv, ArgumentsCamelCase } from "yargs";
 
-export function publishOptions(yargs: Argv) {
+export function publishOptions(yargs: Argv<CommonYargsOptions>) {
 	return (
 		yargs
-			.option("env", {
-				type: "string",
-				requiresArg: true,
-				describe: "Perform on a specific environment",
-				alias: "e",
-			})
 			.positional("script", {
 				describe: "The path to an entry point for your worker",
 				type: "string",
@@ -174,6 +171,11 @@ export function publishOptions(yargs: Argv) {
 				describe: "Use legacy environments",
 				hidden: true,
 			})
+			.option("logpush", {
+				type: "boolean",
+				describe:
+					"Send Trace Events from this worker to Workers Logpush.\nThis will not configure a corresponding Logpush job automatically.",
+			})
 	);
 }
 
@@ -263,5 +265,6 @@ export async function publishHandler(args: ArgumentsCamelCase<PublishArgs>) {
 		dryRun: args.dryRun,
 		noBundle: !(args.bundle ?? !config.no_bundle),
 		keepVars: args.keepVars,
+		logpush: args.logpush,
 	});
 }

package/src/publish/publish.ts

@@ -5,7 +5,10 @@ import { URLSearchParams } from "node:url";
 import chalk from "chalk";
 import tmp from "tmp-promise";
 import { bundleWorker } from "../bundle";
-import { printBundleSize } from "../bundle-reporter";
+import {
+	printBundleSize,
+	printOffendingDependencies,
+} from "../bundle-reporter";
 import { fetchListResult, fetchResult } from "../cfetch";
 import { printBindings } from "../config";
 import { createWorkerUploadForm } from "../create-worker-upload-form";
@@ -14,10 +17,12 @@ import { getMigrationsToUpload } from "../durable";
 import { logger } from "../logger";
 import { getMetricsUsageHeaders } from "../metrics";
 import { ParseError } from "../parse";
+import { getQueue, putConsumer } from "../queues/client";
 import { getWorkersDevSubdomain } from "../routes";
 import { syncAssets } from "../sites";
 import { identifyD1BindingsAsBeta } from "../worker";
 import { getZoneForRoute } from "../zones";
+import type { FetchError } from "../cfetch";
 import type { Config } from "../config";
 import type {
 	Route,
@@ -25,7 +30,9 @@ import type {
 	ZoneNameRoute,
 	CustomDomainRoute,
 } from "../config/environment";
+import type { DeploymentListRes } from "../deployments";
 import type { Entry } from "../entry";
+import type { PutConsumerBody } from "../queues/client";
 import type { AssetPaths } from "../sites";
 import type { CfWorkerInit } from "../worker";
 
@@ -54,6 +61,7 @@ type Props = {
 	dryRun: boolean | undefined;
 	noBundle: boolean | undefined;
 	keepVars: boolean | undefined;
+	logpush: boolean | undefined;
 };
 
 type RouteObject = ZoneIdRoute | ZoneNameRoute | CustomDomainRoute;
@@ -83,6 +91,33 @@ function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+const scriptStartupErrorRegex = /startup/i;
+
+function errIsScriptSizeOrStartupErr(err: unknown) {
+	if (!err) return false;
+
+	// 10027 = workers.api.error.script_too_large
+	if ((err as { code: number }).code === 10027) {
+		return true;
+	}
+
+	// 10021 = validation error
+	// no explicit error code for more granular errors than "invalid script"
+	// but the error will contain a string error message directly from the
+	// validator.
+	// the error always SHOULD look like "Script startup exceeded CPU limit."
+	// (or the less likely "Script startup exceeded memory limits.")
+	if (
+		(err as { code: number }).code === 10021 &&
+		err instanceof ParseError &&
+		scriptStartupErrorRegex.test(err.notes[0]?.text)
+	) {
+		return true;
+	}
+
+	return false;
+}
+
 function renderRoute(route: Route): string {
 	let result = "";
 	if (typeof route === "string") {
@@ -350,6 +385,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 		: `/accounts/${accountId}/workers/scripts/${scriptName}`;
 
 	let available_on_subdomain: boolean | undefined = undefined; // we'll set this later
+	let scriptTag: string | null = null;
 
 	const { format } = props.entry;
 
@@ -407,12 +443,14 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 
 		const {
 			modules,
+			dependencies,
 			resolvedEntryPointPath,
 			bundleType,
 		}: Awaited<ReturnType<typeof bundleWorker>> = props.noBundle
 			? // we can skip the whole bundling step and mock a bundle here
 			  {
 					modules: [],
+					dependencies: {},
 					resolvedEntryPointPath: props.entry.file,
 					bundleType: props.entry.format === "modules" ? "esm" : "commonjs",
 					stop: undefined,
@@ -496,6 +534,9 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			},
 			data_blobs: config.data_blobs,
 			durable_objects: config.durable_objects,
+			queues: config.queues.producers?.map((producer) => {
+				return { binding: producer.binding, queue_name: producer.queue };
+			}),
 			r2_buckets: config.r2_buckets,
 			d1_databases: identifyD1BindingsAsBeta(config.d1_databases),
 			services: config.services,
@@ -527,6 +568,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 				props.compatibilityFlags ?? config.compatibility_flags,
 			usage_model: config.usage_model,
 			keepVars,
+			logpush: props.logpush !== undefined ? props.logpush : config.logpush,
 		};
 
 		// As this is not deterministic for testing, we detect if in a jest environment and run asynchronously
@@ -557,39 +599,50 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 
 		printBindings({ ...withoutStaticAssets, vars: maskedVars });
 
+		await ensureQueuesExist(config);
+
 		if (!props.dryRun) {
 			// Upload the script so it has time to propagate.
 			// We can also now tell whether available_on_subdomain is set
-			const result = await fetchResult<{
-				available_on_subdomain: boolean;
-				id: string | null;
-				etag: string | null;
-				pipeline_hash: string | null;
-			}>(
-				workerUrl,
-				{
-					method: "PUT",
-					body: createWorkerUploadForm(worker),
-					headers: await getMetricsUsageHeaders(config.send_metrics),
-				},
-				new URLSearchParams({
-					include_subdomain_availability: "true",
-					// pass excludeScript so the whole body of the
-					// script doesn't get included in the response
-					excludeScript: "true",
-				})
-			);
-
-			available_on_subdomain = result.available_on_subdomain;
+			try {
+				const result = await fetchResult<{
+					available_on_subdomain: boolean;
+					id: string | null;
+					etag: string | null;
+					pipeline_hash: string | null;
+					tag: string | null;
+				}>(
+					workerUrl,
+					{
+						method: "PUT",
+						body: createWorkerUploadForm(worker),
+						headers: await getMetricsUsageHeaders(config.send_metrics),
+					},
+					new URLSearchParams({
+						include_subdomain_availability: "true",
+						// pass excludeScript so the whole body of the
+						// script doesn't get included in the response
+						excludeScript: "true",
+					})
+				);
 
-			if (config.first_party_worker) {
-				// Print some useful information returned after publishing
-				// Not all fields will be populated for every worker
-				// These fields are likely to be scraped by tools, so do not rename
-				if (result.id) logger.log("Worker ID: ", result.id);
-				if (result.etag) logger.log("Worker ETag: ", result.etag);
-				if (result.pipeline_hash)
-					logger.log("Worker PipelineHash: ", result.pipeline_hash);
+				available_on_subdomain = result.available_on_subdomain;
+				scriptTag = result.tag;
+
+				if (config.first_party_worker) {
+					// Print some useful information returned after publishing
+					// Not all fields will be populated for every worker
+					// These fields are likely to be scraped by tools, so do not rename
+					if (result.id) logger.log("Worker ID: ", result.id);
+					if (result.etag) logger.log("Worker ETag: ", result.etag);
+					if (result.pipeline_hash)
+						logger.log("Worker PipelineHash: ", result.pipeline_hash);
+				}
+			} catch (err) {
+				if (errIsScriptSizeOrStartupErr(err)) {
+					printOffendingDependencies(dependencies);
+				}
+				throw err;
 			}
 		}
 	} finally {
@@ -746,6 +799,10 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 		);
 	}
 
+	if (config.queues.consumers && config.queues.consumers.length) {
+		deployments.push(...updateQueueConsumers(config));
+	}
+
 	const targets = await Promise.all(deployments);
 	const deployMs = Date.now() - start - uploadMs;
 
@@ -761,6 +818,19 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 	} else {
 		logger.log("No publish targets for", workerName, formatTime(deployMs));
 	}
+
+	try {
+		const deploymentsList = await fetchResult<DeploymentListRes>(
+			`/accounts/${accountId}/workers/versions/by-script/${scriptTag}`
+		);
+
+		logger.log("Current Deployment ID:", deploymentsList.latest.id);
+	} catch (e) {
+		if ((e as { code: number }).code === 10023) {
+			// TODO: remove this try/catch once versions is completely rolled out
+		}
+		throw e;
+	}
 }
 
 function formatTime(duration: number) {
@@ -911,3 +981,54 @@ async function publishRoutesFallback(
 function isAuthenticationError(e: unknown): e is ParseError {
 	return e instanceof ParseError && (e as { code?: number }).code === 10000;
 }
+
+async function ensureQueuesExist(config: Config) {
+	const producers = (config.queues.producers || []).map(
+		(producer) => producer.queue
+	);
+	const consumers = (config.queues.consumers || []).map(
+		(consumer) => consumer.queue
+	);
+
+	const queueNames = producers.concat(consumers);
+	for (const queue of queueNames) {
+		try {
+			await getQueue(config, queue);
+		} catch (err) {
+			const queueErr = err as FetchError;
+			if (queueErr.code === 100123) {
+				// queue_not_found
+				throw new Error(
+					`Queue "${queue}" does not exist. To create it, run: wrangler queues create ${queue}`
+				);
+			}
+			throw err;
+		}
+	}
+}
+
+function updateQueueConsumers(config: Config): Promise<string[]>[] {
+	const consumers = config.queues.consumers || [];
+	return consumers.map((consumer) => {
+		const body: PutConsumerBody = {
+			dead_letter_queue: consumer.dead_letter_queue,
+			settings: {
+				batch_size: consumer.max_batch_size,
+				max_retries: consumer.max_retries,
+				max_wait_time_ms: consumer.max_batch_timeout
+					? 1000 * consumer.max_batch_timeout
+					: undefined,
+			},
+		};
+
+		if (config.name === undefined) {
+			// TODO: how can we reliably get the current script name?
+			throw new Error("Script name is required to update queue consumers");
+		}
+		const scriptName = config.name;
+		const envName = undefined; // TODO: script environment for wrangler publish?
+		return putConsumer(config, consumer.queue, scriptName, envName, body).then(
+			() => [`Consumer for ${consumer.queue}`]
+		);
+	});
+}

package/src/pubsub/pubsub-commands.tsx

@@ -7,11 +7,12 @@ import * as metrics from "../metrics";
 import { parseHumanDuration } from "../parse";
 import { requireAuth } from "../user";
 import * as pubsub from ".";
+import type { CommonYargsOptions } from "../yargs-types";
 import type { Argv, CommandModule } from "yargs";
 
 export function pubSubCommands(
-	pubsubYargs: Argv,
-	subHelp: CommandModule
+	pubsubYargs: Argv<CommonYargsOptions>,
+	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
 ): Argv {
 	return pubsubYargs
 		.command(subHelp)

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

@@ -0,0 +1,71 @@
+import { type Argv } from "yargs";
+import { readConfig } from "../../../../config";
+import { logger } from "../../../../logger";
+import { postConsumer } from "../../../client";
+import type { CommonYargsOptions } from "../../../../yargs-types";
+import type { PostConsumerBody } from "../../../client";
+
+type Args = CommonYargsOptions & {
+	config?: string;
+	["queue-name"]: string;
+	["script-name"]: string;
+	["batch-size"]?: number;
+	["batch-timeout"]?: number;
+	["message-retries"]?: number;
+	["dead-letter-queue"]?: string;
+};
+
+export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
+	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",
+		})
+		.options({
+			"batch-size": {
+				type: "number",
+				describe: "Maximum number of messages per batch",
+			},
+			"batch-timeout": {
+				type: "number",
+				describe:
+					"Maximum number of seconds to wait to fill a batch with messages",
+			},
+			"message-retries": {
+				type: "number",
+				describe: "Maximum number of retries for each message",
+			},
+			"dead-letter-queue": {
+				type: "string",
+				describe: "Queue to send messages that failed to be consumed",
+			},
+		});
+}
+
+export async function handler(args: Args) {
+	const config = readConfig(args.config, args);
+
+	const body: PostConsumerBody = {
+		script_name: args["script-name"],
+		// TODO(soon) is this still the correct usage of the environment?
+		environment_name: args.env || "", // API expects empty string as default
+		settings: {
+			batch_size: args["batch-size"],
+			max_retries: args["message-retries"],
+			max_wait_time_ms: args["batch-timeout"] // API expects milliseconds
+				? 1000 * args["batch-timeout"]
+				: undefined,
+		},
+		dead_letter_queue: args["dead-letter-queue"],
+	};
+
+	logger.log(`Adding consumer to queue ${args["queue-name"]}.`);
+	await postConsumer(config, args["queue-name"], body);
+	logger.log(`Added consumer to queue ${args["queue-name"]}.`);
+}

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

@@ -0,0 +1,22 @@
+import { type BuilderCallback } from "yargs";
+import { type CommonYargsOptions } from "../../../../yargs-types";
+import { options as addOptions, handler as addHandler } from "./add";
+import { options as removeOptions, handler as removeHandler } from "./remove";
+
+export const consumers: BuilderCallback<CommonYargsOptions, unknown> = (
+	yargs
+) => {
+	yargs.command(
+		"add <queue-name> <script-name>",
+		"Add a Queue Consumer",
+		addOptions,
+		addHandler
+	);
+
+	yargs.command(
+		"remove <queue-name> <script-name>",
+		"Remove a Queue Consumer",
+		removeOptions,
+		removeHandler
+	);
+};

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

@@ -0,0 +1,38 @@
+import { type Argv } from "yargs";
+import { readConfig } from "../../../../config";
+import { logger } from "../../../../logger";
+import { deleteConsumer } from "../../../client";
+import type { CommonYargsOptions } from "../../../../yargs-types";
+
+type Args = CommonYargsOptions & {
+	config?: string;
+	["queue-name"]: string;
+	["script-name"]: string;
+};
+
+export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
+	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: Args) {
+	const config = readConfig(args.config, args);
+
+	logger.log(`Removing consumer from queue ${args["queue-name"]}.`);
+	await deleteConsumer(
+		config,
+		args["queue-name"],
+		args["script-name"],
+		args.env
+	);
+	logger.log(`Removed consumer from queue ${args["queue-name"]}.`);
+}

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

@@ -0,0 +1,25 @@
+import { type Argv } from "yargs";
+import { readConfig } from "../../../config";
+import { logger } from "../../../logger";
+import { createQueue } from "../../client";
+
+interface Args {
+	config?: string;
+	name: string;
+}
+
+export function options(yargs: Argv): Argv<Args> {
+	return yargs.positional("name", {
+		type: "string",
+		demandOption: true,
+		description: "The name of the queue",
+	});
+}
+
+export async function handler(args: Args) {
+	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 { type Argv } from "yargs";
+import { readConfig } from "../../../config";
+import { logger } from "../../../logger";
+import { deleteQueue } from "../../client";
+
+interface Args {
+	config?: string;
+	name: string;
+}
+
+export function options(yargs: Argv): Argv<Args> {
+	// TODO(soon) --force option
+	return yargs.positional("name", {
+		type: "string",
+		demandOption: true,
+		description: "The name of the queue",
+	});
+}
+
+export async function handler(args: Args) {
+	const config = readConfig(args.config, args);
+
+	logger.log(`Deleting queue ${args.name}.`);
+	await deleteQueue(config, args.name);
+	logger.log(`Deleted queue ${args.name}.`);
+}