wrangler 0.0.0-e3ce82b → 0.0.0-e4047cab

package/src/__tests__/queues.test.ts

@@ -0,0 +1,522 @@
+import { rest } from "msw";
+import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { msw } from "./helpers/msw";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import type { QueueResponse, PostConsumerBody } from "../queues/client";
+
+describe("wrangler", () => {
+	mockAccountId();
+	mockApiToken();
+	runInTempDir();
+	const std = mockConsoleMethods();
+
+	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 };
+				msw.use(
+					rest.get(
+						"*/accounts/:accountId/workers/queues?*",
+						async (request, response, context) => {
+							requests.count += 1;
+							const query = request.url.searchParams;
+							expect(Number(query.get("page"))).toEqual(page);
+							expect(await request.text()).toEqual("");
+							return response.once(
+								context.json({
+									success: true,
+									errors: [],
+									messages: [],
+									result: 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 };
+
+				msw.use(
+					rest.post(
+						"*/accounts/:accountId/workers/queues",
+						async (request, response, context) => {
+							requests.count += 1;
+							const body = (await request.json()) as {
+								queue_name: string;
+							};
+							expect(body.queue_name).toEqual(expectedQueueName);
+							return response.once(
+								context.json({
+									success: true,
+									errors: [],
+									messages: [],
+									result: {
+										queue_name: expectedQueueName,
+										created_on: "01-01-2001",
+										modified_on: "01-01-2001",
+									},
+								})
+							);
+						}
+					)
+				);
+				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);
+			});
+
+			it("should show link to dash when not enabled", async () => {
+				const queueName = "testQueue";
+				msw.use(
+					rest.post(
+						"*/accounts/:accountId/workers/queues",
+						async (request, response, context) => {
+							expect(request.params.accountId).toEqual("some-account-id");
+							return response.once(
+								context.status(403),
+								context.json({
+									success: false,
+									errors: [
+										{ message: "workers.api.error.unauthorized", code: 10023 },
+									],
+									messages: [],
+								})
+							);
+						}
+					)
+				);
+
+				await expect(
+					runWrangler(`queues create ${queueName}`)
+				).rejects.toThrowError();
+				expect(std.out).toMatchInlineSnapshot(`
+			"Creating queue testQueue.
+			Queues is not currently enabled on this account. Go to https://dash.cloudflare.com/some-account-id/workers/queues to enable it.
+
+			X [ERROR] A request to the Cloudflare API (/accounts/some-account-id/workers/queues) failed.
+
+			  workers.api.error.unauthorized [code: 10023]
+
+			  If you think this is a bug, please open an issue at:
+			  https://github.com/cloudflare/wrangler2/issues/new/choose
+
+			"
+		`);
+			});
+		});
+
+		describe("delete", () => {
+			function mockDeleteRequest(expectedQueueName: string) {
+				const requests = { count: 0 };
+				msw.use(
+					rest.delete(
+						"*/accounts/:accountId/workers/queues/:queueName",
+						async (request, response, context) => {
+							requests.count += 1;
+							expect(request.params.queueName).toEqual(expectedQueueName);
+							expect(request.params.accountId).toEqual("some-account-id");
+							return response.once(
+								context.json({
+									success: true,
+									errors: [],
+									messages: [],
+									result: {},
+								})
+							);
+						}
+					)
+				);
+				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 };
+					msw.use(
+						rest.post(
+							"*/accounts/:accountId/workers/queues/:queueName/consumers",
+							async (request, response, context) => {
+								requests.count += 1;
+								expect(request.params.queueName).toEqual(expectedQueueName);
+								expect(request.params.accountId).toEqual("some-account-id");
+								expect(await request.json()).toEqual(expectedBody);
+								return response.once(
+									context.json({
+										success: true,
+										errors: [],
+										messages: [],
+										result: {},
+									})
+								);
+							}
+						)
+					);
+					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."
+					`);
+				});
+
+				it("should show link to dash when not enabled", async () => {
+					const queueName = "testQueue";
+					msw.use(
+						rest.post(
+							"*/accounts/:accountId/workers/queues/:queueName/consumers",
+							async (request, response, context) => {
+								expect(request.params.queueName).toEqual(queueName);
+								expect(request.params.accountId).toEqual("some-account-id");
+								return response.once(
+									context.status(403),
+									context.json({
+										success: false,
+										errors: [
+											{
+												code: 10023,
+												message: "workers.api.error.unauthorized",
+											},
+										],
+										messages: [],
+										result: {},
+									})
+								);
+							}
+						)
+					);
+
+					await expect(
+						runWrangler(`queues consumer add ${queueName} testScript`)
+					).rejects.toThrowError();
+					expect(std.out).toMatchInlineSnapshot(`
+				"Adding consumer to queue testQueue.
+				Queues is not currently enabled on this account. Go to https://dash.cloudflare.com/some-account-id/workers/queues to enable it.
+
+				X [ERROR] A request to the Cloudflare API (/accounts/some-account-id/workers/queues/testQueue/consumers) failed.
+
+				  workers.api.error.unauthorized [code: 10023]
+
+				  If you think this is a bug, please open an issue at:
+				  https://github.com/cloudflare/wrangler2/issues/new/choose
+
+				"
+			`);
+				});
+			});
+
+			describe("delete", () => {
+				function mockDeleteRequest(
+					expectedQueueName: string,
+					expectedScriptName: string,
+					expectedEnvName?: string
+				) {
+					const requests = { count: 0 };
+					let resource = `accounts/:accountId/workers/queues/:expectedQueueName/consumers/:expectedScriptName`;
+					if (expectedEnvName !== undefined) {
+						resource += `/environments/:expectedEnvName`;
+					}
+					msw.use(
+						rest.delete(`*/${resource}`, async (request, response, context) => {
+							requests.count++;
+							expect(request.params.accountId).toBe("some-account-id");
+							expect(request.params.expectedQueueName).toBe(expectedQueueName);
+							expect(request.params.expectedScriptName).toBe(
+								expectedScriptName
+							);
+							return response.once(
+								context.status(200),
+								context.json({
+									success: true,
+									errors: [],
+									messages: [],
+									result: {},
+								})
+							);
+						})
+					);
+
+					return requests;
+				}
+
+				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 () => {
+					const requests = mockDeleteRequest("testQueue", "testScript");
+					await runWrangler("queues consumer remove testQueue testScript");
+
+					expect(requests.count).toEqual(1);
+					expect(std.out).toMatchInlineSnapshot(`
+						"Removing consumer from queue testQueue.
+						Removed consumer from queue testQueue."
+					`);
+				});
+
+				it("should delete a consumer with --env", async () => {
+					const requests = mockDeleteRequest(
+						"testQueue",
+						"testScript",
+						"myEnv"
+					);
+					await runWrangler(
+						"queues consumer remove testQueue testScript --env myEnv"
+					);
+
+					expect(requests.count).toEqual(1);
+					expect(std.out).toMatchInlineSnapshot(`
+						"Removing consumer from queue testQueue.
+						Removed consumer from queue testQueue."
+					`);
+				});
+			});
+		});
+	});
+});