wrangler 2.1.14 → 2.2.0

package/src/__tests__/pubsub.test.ts

@@ -38,6 +38,7 @@ describe("wrangler", () => {
 
 			Flags:
 			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
 			  -h, --help     Show help  [boolean]
 			  -v, --version  Show version number  [boolean]
 
@@ -68,6 +69,7 @@ describe("wrangler", () => {
 
 				Flags:
 				  -c, --config   Path to .toml configuration file  [string]
+				  -e, --env      Environment to use for operations and .env files  [string]
 				  -h, --help     Show help  [boolean]
 				  -v, --version  Show version number  [boolean]
 
@@ -158,6 +160,7 @@ describe("wrangler", () => {
 
 				Flags:
 				  -c, --config   Path to .toml configuration file  [string]
+				  -e, --env      Environment to use for operations and .env files  [string]
 				  -h, --help     Show help  [boolean]
 				  -v, --version  Show version number  [boolean]
 

package/src/__tests__/queues.test.ts

@@ -0,0 +1,371 @@
+import { type QueueResponse, type PostConsumerBody } from "../queues/client";
+import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
+import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+
+describe("wrangler", () => {
+	mockAccountId();
+	mockApiToken();
+	runInTempDir();
+	const std = mockConsoleMethods();
+
+	afterEach(() => {
+		unsetAllMocks();
+	});
+
+	describe("queues", () => {
+		it("should show the correct help text", async () => {
+			await runWrangler("queues --help");
+			expect(std.err).toMatchInlineSnapshot(`""`);
+			expect(std.out).toMatchInlineSnapshot(`
+			"wrangler queues
+
+			🆀 Configure Workers Queues
+
+			Commands:
+			  wrangler queues list           List Queues
+			  wrangler queues create <name>  Create a Queue
+			  wrangler queues delete <name>  Delete a Queue
+			  wrangler queues consumer       Configure Queue Consumers
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
+		});
+
+		describe("list", () => {
+			function mockListRequest(queues: QueueResponse[], page: number) {
+				const requests = { count: 0 };
+				setMockResponse(
+					"/accounts/:accountId/workers/queues",
+					([_url, accountId], init, params) => {
+						requests.count++;
+						expect(params.get("page")).toEqual((page || 1).toString());
+						expect(accountId).toEqual("some-account-id");
+						expect(init).toEqual({});
+						return queues;
+					}
+				);
+				return requests;
+			}
+
+			it("should show the correct help text", async () => {
+				await runWrangler("queues list --help");
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				expect(std.out).toMatchInlineSnapshot(`
+			"wrangler queues list
+
+			List Queues
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]
+
+			Options:
+			      --page  Page number for pagination  [number]"
+		`);
+			});
+
+			it("should list queues on page 1 with no --page", async () => {
+				const expectedQueues: QueueResponse[] = [
+					{
+						queue_name: "queue-1",
+						created_on: "01-01-2001",
+						modified_on: "01-01-2001",
+					},
+					{
+						queue_name: "queue-2",
+						created_on: "01-01-2001",
+						modified_on: "01-01-2001",
+					},
+				];
+				const expectedPage = 1;
+				mockListRequest(expectedQueues, expectedPage);
+				await runWrangler("queues list");
+
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				const buckets = JSON.parse(std.out);
+				expect(buckets).toEqual(expectedQueues);
+			});
+
+			it("should list queues using --page=2", async () => {
+				const expectedQueues: QueueResponse[] = [
+					{
+						queue_name: "queue-100",
+						created_on: "01-01-2001",
+						modified_on: "01-01-2001",
+					},
+				];
+				const expectedPage = 2;
+				mockListRequest(expectedQueues, expectedPage);
+				await runWrangler("queues list --page=2");
+
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				const buckets = JSON.parse(std.out);
+				expect(buckets).toEqual(expectedQueues);
+			});
+		});
+
+		describe("create", () => {
+			function mockCreateRequest(expectedQueueName: string) {
+				const requests = { count: 0 };
+				setMockResponse(
+					"/accounts/:accountId/workers/queues",
+					"POST",
+					([_url, accountId], { body }) => {
+						expect(accountId).toEqual("some-account-id");
+						const queueName = JSON.parse(body as string).queue_name;
+						expect(queueName).toEqual(expectedQueueName);
+						requests.count += 1;
+					}
+				);
+				return requests;
+			}
+
+			it("should show the correct help text", async () => {
+				await runWrangler("queues create --help");
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				expect(std.out).toMatchInlineSnapshot(`
+			"wrangler queues create <name>
+
+			Create a Queue
+
+			Positionals:
+			  name  The name of the queue  [string] [required]
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
+			});
+
+			it("should create a queue", async () => {
+				const requests = mockCreateRequest("testQueue");
+				await runWrangler("queues create testQueue");
+				expect(std.out).toMatchInlineSnapshot(`
+					"Creating queue testQueue.
+					Created queue testQueue."
+			  `);
+				expect(requests.count).toEqual(1);
+			});
+		});
+
+		describe("delete", () => {
+			function mockDeleteRequest(expectedQueueName: string) {
+				const requests = { count: 0 };
+				setMockResponse(
+					`/accounts/:accountId/workers/queues/${expectedQueueName}`,
+					"DELETE",
+					([_url, accountId]) => {
+						expect(accountId).toEqual("some-account-id");
+						requests.count += 1;
+					}
+				);
+				return requests;
+			}
+
+			it("should show the correct help text", async () => {
+				await runWrangler("queues delete --help");
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				expect(std.out).toMatchInlineSnapshot(`
+			"wrangler queues delete <name>
+
+			Delete a Queue
+
+			Positionals:
+			  name  The name of the queue  [string] [required]
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
+			});
+
+			it("should delete a queue", async () => {
+				const requests = mockDeleteRequest("testQueue");
+				await runWrangler("queues delete testQueue");
+				expect(std.out).toMatchInlineSnapshot(`
+					"Deleting queue testQueue.
+					Deleted queue testQueue."
+			  `);
+				expect(requests.count).toEqual(1);
+			});
+		});
+
+		describe("consumers", () => {
+			it("should show the correct help text", async () => {
+				await runWrangler("queues consumer --help");
+
+				expect(std.err).toMatchInlineSnapshot(`""`);
+				expect(std.out).toMatchInlineSnapshot(`
+			"wrangler queues consumer
+
+			Configure Queue Consumers
+
+			Commands:
+			  wrangler queues consumer add <queue-name> <script-name>     Add a Queue Consumer
+			  wrangler queues consumer remove <queue-name> <script-name>  Remove a Queue Consumer
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
+			});
+
+			describe("add", () => {
+				function mockPostRequest(
+					expectedQueueName: string,
+					expectedBody: PostConsumerBody
+				) {
+					const requests = { count: 0 };
+					setMockResponse(
+						`/accounts/:accountId/workers/queues/${expectedQueueName}/consumers`,
+						"POST",
+						([_url, accountId], { body }) => {
+							expect(accountId).toEqual("some-account-id");
+							expect(JSON.parse(body as string)).toEqual(expectedBody);
+							requests.count += 1;
+						}
+					);
+					return requests;
+				}
+
+				it("should show the correct help text", async () => {
+					await runWrangler("queues consumer add --help");
+					expect(std.err).toMatchInlineSnapshot(`""`);
+					expect(std.out).toMatchInlineSnapshot(`
+				"wrangler queues consumer add <queue-name> <script-name>
+
+				Add a Queue Consumer
+
+				Positionals:
+				  queue-name   Name of the queue to configure  [string] [required]
+				  script-name  Name of the consumer script  [string] [required]
+
+				Flags:
+				  -c, --config   Path to .toml configuration file  [string]
+				  -e, --env      Environment to use for operations and .env files  [string]
+				  -h, --help     Show help  [boolean]
+				  -v, --version  Show version number  [boolean]
+
+				Options:
+				      --batch-size         Maximum number of messages per batch  [number]
+				      --batch-timeout      Maximum number of seconds to wait to fill a batch with messages  [number]
+				      --message-retries    Maximum number of retries for each message  [number]
+				      --dead-letter-queue  Queue to send messages that failed to be consumed  [string]"
+			`);
+				});
+
+				it("should add a consumer using defaults", async () => {
+					const expectedBody: PostConsumerBody = {
+						script_name: "testScript",
+						environment_name: "",
+						settings: {
+							batch_size: undefined,
+							max_retries: undefined,
+							max_wait_time_ms: undefined,
+						},
+						dead_letter_queue: undefined,
+					};
+					mockPostRequest("testQueue", expectedBody);
+					await runWrangler("queues consumer add testQueue testScript");
+					expect(std.out).toMatchInlineSnapshot(`
+							"Adding consumer to queue testQueue.
+							Added consumer to queue testQueue."
+					`);
+				});
+
+				it("should add a consumer using custom values", async () => {
+					const expectedBody: PostConsumerBody = {
+						script_name: "testScript",
+						environment_name: "myEnv",
+						settings: {
+							batch_size: 20,
+							max_retries: 3,
+							max_wait_time_ms: 10 * 1000,
+						},
+						dead_letter_queue: "myDLQ",
+					};
+					mockPostRequest("testQueue", expectedBody);
+
+					await runWrangler(
+						"queues consumer add testQueue testScript --env myEnv --batch-size 20 --batch-timeout 10 --message-retries 3 --dead-letter-queue myDLQ"
+					);
+					expect(std.out).toMatchInlineSnapshot(`
+						"Adding consumer to queue testQueue.
+						Added consumer to queue testQueue."
+					`);
+				});
+			});
+
+			describe("delete", () => {
+				function mockDeleteRequest(
+					expectedQueueName: string,
+					expectedScriptName: string,
+					expectedEnvName?: string
+				) {
+					let resource = `/accounts/:accountId/workers/queues/${expectedQueueName}/consumers/${expectedScriptName}`;
+					if (expectedEnvName !== undefined) {
+						resource += `/environments/${expectedEnvName}`;
+					}
+					setMockResponse(resource, "DELETE", ([_url, accountId]) => {
+						expect(accountId).toEqual("some-account-id");
+					});
+				}
+
+				it("should show the correct help text", async () => {
+					await runWrangler("queues consumer remove --help");
+					expect(std.err).toMatchInlineSnapshot(`""`);
+					expect(std.out).toMatchInlineSnapshot(`
+				"wrangler queues consumer remove <queue-name> <script-name>
+
+				Remove a Queue Consumer
+
+				Positionals:
+				  queue-name   Name of the queue to configure  [string] [required]
+				  script-name  Name of the consumer script  [string] [required]
+
+				Flags:
+				  -c, --config   Path to .toml configuration file  [string]
+				  -e, --env      Environment to use for operations and .env files  [string]
+				  -h, --help     Show help  [boolean]
+				  -v, --version  Show version number  [boolean]"
+			`);
+				});
+
+				it("should delete a consumer with no --env", async () => {
+					mockDeleteRequest("testQueue", "testScript");
+					await runWrangler("queues consumer remove testQueue testScript");
+					expect(std.out).toMatchInlineSnapshot(`
+						"Removing consumer from queue testQueue.
+						Removed consumer from queue testQueue."
+					`);
+				});
+
+				it("should delete a consumer with --env", async () => {
+					mockDeleteRequest("testQueue", "testScript", "myEnv");
+					await runWrangler(
+						"queues consumer remove testQueue testScript --env myEnv"
+					);
+					expect(std.out).toMatchInlineSnapshot(`
+						"Removing consumer from queue testQueue.
+						Removed consumer from queue testQueue."
+					`);
+				});
+			});
+		});
+	});
+});

package/src/__tests__/r2.test.ts

@@ -26,21 +26,22 @@ describe("r2", () => {
 			          "
 		        `);
 			expect(std.out).toMatchInlineSnapshot(`
-			          "
-			          wrangler r2 bucket
+			"
+			wrangler r2 bucket
 
-			          Manage R2 buckets
+			Manage R2 buckets
 
-			          Commands:
-			            wrangler r2 bucket create <name>  Create a new R2 bucket
-			            wrangler r2 bucket list           List R2 buckets
-			            wrangler r2 bucket delete <name>  Delete an R2 bucket
+			Commands:
+			  wrangler r2 bucket create <name>  Create a new R2 bucket
+			  wrangler r2 bucket list           List R2 buckets
+			  wrangler r2 bucket delete <name>  Delete an R2 bucket
 
-			          Flags:
-			            -c, --config   Path to .toml configuration file  [string]
-			            -h, --help     Show help  [boolean]
-			            -v, --version  Show version number  [boolean]"
-		        `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 		});
 
 		describe("list", () => {
@@ -95,19 +96,20 @@ describe("r2", () => {
 					`"Not enough non-option arguments: got 0, need at least 1"`
 				);
 				expect(std.out).toMatchInlineSnapshot(`
-				            "
-				            wrangler r2 bucket create <name>
+			"
+			wrangler r2 bucket create <name>
 
-				            Create a new R2 bucket
+			Create a new R2 bucket
 
-				            Positionals:
-				              name  The name of the new bucket  [string] [required]
+			Positionals:
+			  name  The name of the new bucket  [string] [required]
 
-				            Flags:
-				              -c, --config   Path to .toml configuration file  [string]
-				              -h, --help     Show help  [boolean]
-				              -v, --version  Show version number  [boolean]"
-			          `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 				expect(std.err).toMatchInlineSnapshot(`
 				            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
@@ -122,19 +124,20 @@ describe("r2", () => {
 					`"Unknown arguments: def, ghi"`
 				);
 				expect(std.out).toMatchInlineSnapshot(`
-				            "
-				            wrangler r2 bucket create <name>
+			"
+			wrangler r2 bucket create <name>
 
-				            Create a new R2 bucket
+			Create a new R2 bucket
 
-				            Positionals:
-				              name  The name of the new bucket  [string] [required]
+			Positionals:
+			  name  The name of the new bucket  [string] [required]
 
-				            Flags:
-				              -c, --config   Path to .toml configuration file  [string]
-				              -h, --help     Show help  [boolean]
-				              -v, --version  Show version number  [boolean]"
-			          `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 				expect(std.err).toMatchInlineSnapshot(`
 				            "X [ERROR] Unknown arguments: def, ghi
 
@@ -178,19 +181,20 @@ describe("r2", () => {
 					`"Not enough non-option arguments: got 0, need at least 1"`
 				);
 				expect(std.out).toMatchInlineSnapshot(`
-				            "
-				            wrangler r2 bucket delete <name>
+			"
+			wrangler r2 bucket delete <name>
 
-				            Delete an R2 bucket
+			Delete an R2 bucket
 
-				            Positionals:
-				              name  The name of the bucket to delete  [string] [required]
+			Positionals:
+			  name  The name of the bucket to delete  [string] [required]
 
-				            Flags:
-				              -c, --config   Path to .toml configuration file  [string]
-				              -h, --help     Show help  [boolean]
-				              -v, --version  Show version number  [boolean]"
-			          `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 				expect(std.err).toMatchInlineSnapshot(`
 				            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
@@ -205,19 +209,20 @@ describe("r2", () => {
 					`"Unknown arguments: def, ghi"`
 				);
 				expect(std.out).toMatchInlineSnapshot(`
-				            "
-				            wrangler r2 bucket delete <name>
+			"
+			wrangler r2 bucket delete <name>
 
-				            Delete an R2 bucket
+			Delete an R2 bucket
 
-				            Positionals:
-				              name  The name of the bucket to delete  [string] [required]
+			Positionals:
+			  name  The name of the bucket to delete  [string] [required]
 
-				            Flags:
-				              -c, --config   Path to .toml configuration file  [string]
-				              -h, --help     Show help  [boolean]
-				              -v, --version  Show version number  [boolean]"
-			          `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 				expect(std.err).toMatchInlineSnapshot(`
 				            "X [ERROR] Unknown arguments: def, ghi
 

package/src/__tests__/worker-namespace.test.ts

@@ -36,6 +36,7 @@ describe("dispatch-namespace", () => {
 
 		Flags:
 		  -c, --config   Path to .toml configuration file  [string]
+		  -e, --env      Environment to use for operations and .env files  [string]
 		  -h, --help     Show help  [boolean]
 		  -v, --version  Show version number  [boolean]",
 		  "warn": "",
@@ -87,6 +88,7 @@ describe("dispatch-namespace", () => {
 
 			Flags:
 			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
 			  -h, --help     Show help  [boolean]
 			  -v, --version  Show version number  [boolean]"
 		`);
@@ -135,6 +137,7 @@ describe("dispatch-namespace", () => {
 
 			Flags:
 			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
 			  -h, --help     Show help  [boolean]
 			  -v, --version  Show version number  [boolean]"
 		`);
@@ -183,19 +186,20 @@ describe("dispatch-namespace", () => {
 			);
 
 			expect(std.out).toMatchInlineSnapshot(`
-			        "
-			        wrangler dispatch-namespace get <name>
+			"
+			wrangler dispatch-namespace get <name>
 
-			        Get information about a dispatch namespace
+			Get information about a dispatch namespace
 
-			        Positionals:
-			          name  Name of the dispatch namespace  [string] [required]
+			Positionals:
+			  name  Name of the dispatch namespace  [string] [required]
 
-			        Flags:
-			          -c, --config   Path to .toml configuration file  [string]
-			          -h, --help     Show help  [boolean]
-			          -v, --version  Show version number  [boolean]"
-		      `);
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 		});
 
 		it("should attempt to get info for the given namespace", async () => {
@@ -302,6 +306,7 @@ describe("dispatch-namespace", () => {
 
 			Flags:
 			  -c, --config   Path to .toml configuration file  [string]
+			  -e, --env      Environment to use for operations and .env files  [string]
 			  -h, --help     Show help  [boolean]
 			  -v, --version  Show version number  [boolean]"
 		`);

package/src/bundle-reporter.tsx

@@ -2,6 +2,10 @@ import { Blob } from "node:buffer";
 import { gzipSync } from "node:zlib";
 import { logger } from "./logger";
 import type { CfModule } from "./worker";
+import type { Metafile } from "esbuild";
+
+const ONE_KIB_BYTES = 1024;
+const ONE_MIB_BYTES = ONE_KIB_BYTES * 1024;
 
 async function getSize(modules: CfModule[]) {
 	const gzipSize = gzipSync(
@@ -21,9 +25,44 @@ export async function printBundleSize(
 ) {
 	const { size, gzipSize } = await getSize([...modules, main]);
 
-	const bundleReport = `${(size / 1024).toFixed(2)} KiB / gzip: ${(
-		gzipSize / 1024
+	const bundleReport = `${(size / ONE_KIB_BYTES).toFixed(2)} KiB / gzip: ${(
+		gzipSize / ONE_KIB_BYTES
 	).toFixed(2)} KiB`;
 
 	logger.log(`Total Upload: ${bundleReport}`);
+
+	if (gzipSize > ONE_MIB_BYTES && !process.env.NO_SCRIPT_SIZE_WARNING) {
+		logger.warn(
+			"We recommend keeping your script less than 1MiB (1024 KiB) after gzip. Exceeding past this can affect cold start time"
+		);
+	}
+}
+
+export function printOffendingDependencies(
+	dependencies: Metafile["outputs"][string]["inputs"]
+) {
+	const warning: string[] = [];
+
+	const dependenciesSorted = Object.entries(dependencies);
+	dependenciesSorted.sort(
+		([_adep, aData], [_bdep, bData]) =>
+			bData.bytesInOutput - aData.bytesInOutput
+	);
+	const topLargest = dependenciesSorted.slice(0, 5);
+
+	if (topLargest.length > 0) {
+		warning.push(
+			`Here are the ${topLargest.length} largest dependencies included in your script:`
+		);
+
+		for (const [dep, data] of topLargest) {
+			warning.push(
+				`- ${dep} - ${(data.bytesInOutput / ONE_KIB_BYTES).toFixed(2)} KiB`
+			);
+		}
+
+		warning.push("If these are unnecessary, consider removing them");
+
+		logger.warn(warning.join("\n"));
+	}
 }