wrangler 2.0.21 → 2.0.24

package/src/__tests__/r2.test.ts

@@ -1,5 +1,10 @@
+import * as fs from "node:fs";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
-import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
+import {
+	setMockFetchR2Objects,
+	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";
@@ -22,26 +27,26 @@ describe("wrangler", () => {
 					runWrangler("r2 bucket foo")
 				).rejects.toThrowErrorMatchingInlineSnapshot(`"Unknown argument: foo"`);
 				expect(std.err).toMatchInlineSnapshot(`
-          "X [ERROR] Unknown argument: foo
+			          "X [ERROR] Unknown argument: foo
 
-          "
-        `);
+			          "
+		        `);
 				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]
+			            -h, --help     Show help  [boolean]
+			            -v, --version  Show version number  [boolean]"
+		        `);
 			});
 
 			describe("list", () => {
@@ -95,24 +100,24 @@ describe("wrangler", () => {
 						`"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]
+				              -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
+				            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
-            "
-          `);
+				            "
+			          `);
 				});
 
 				it("should error if the bucket to create contains spaces", async () => {
@@ -122,33 +127,33 @@ describe("wrangler", () => {
 						`"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]
+				              -h, --help     Show help  [boolean]
+				              -v, --version  Show version number  [boolean]"
+			          `);
 					expect(std.err).toMatchInlineSnapshot(`
-            "X [ERROR] Unknown arguments: def, ghi
+				            "X [ERROR] Unknown arguments: def, ghi
 
-            "
-          `);
+				            "
+			          `);
 				});
 
 				it("should create a bucket", async () => {
 					const requests = mockCreateRequest("testBucket");
 					await runWrangler("r2 bucket create testBucket");
 					expect(std.out).toMatchInlineSnapshot(`
-            "Creating bucket testBucket.
-            Created bucket testBucket."
-          `);
+				            "Creating bucket testBucket.
+				            Created bucket testBucket."
+			          `);
 					expect(requests.count).toEqual(1);
 				});
 			});
@@ -175,24 +180,24 @@ describe("wrangler", () => {
 						`"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]
+				              -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
+				            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
-            "
-          `);
+				            "
+			          `);
 				});
 
 				it("should error if the bucket name to delete contains spaces", async () => {
@@ -202,24 +207,24 @@ describe("wrangler", () => {
 						`"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]
+				              -h, --help     Show help  [boolean]
+				              -v, --version  Show version number  [boolean]"
+			          `);
 					expect(std.err).toMatchInlineSnapshot(`
-            "X [ERROR] Unknown arguments: def, ghi
+				            "X [ERROR] Unknown arguments: def, ghi
 
-            "
-          `);
+				            "
+			          `);
 				});
 
 				it("should delete a bucket specified by name", async () => {
@@ -229,5 +234,84 @@ describe("wrangler", () => {
 				});
 			});
 		});
+
+		describe("r2 object", () => {
+			it("should download R2 object from bucket", async () => {
+				setMockFetchR2Objects({
+					accountId: "some-account-id",
+					bucketName: "bucketName-object-test",
+					objectName: "wormhole-img.png",
+					mockResponse: "R2-objects-test-data",
+				});
+
+				await runWrangler(
+					`r2 object get bucketName-object-test/wormhole-img.png --file ./wormhole-img.png`
+				);
+
+				expect(std.out).toMatchInlineSnapshot(`
+			"Downloading \\"wormhole-img.png\\" from \\"bucketName-object-test\\".
+			Download complete."
+		`);
+			});
+
+			it("should upload R2 object from bucket", async () => {
+				setMockFetchR2Objects({
+					accountId: "some-account-id",
+					bucketName: "bucketName-object-test",
+					objectName: "wormhole-img.png",
+				});
+				fs.writeFileSync("wormhole-img.png", "passageway");
+				await runWrangler(
+					`r2 object put bucketName-object-test/wormhole-img.png --file ./wormhole-img.png`
+				);
+
+				expect(std.out).toMatchInlineSnapshot(`
+			"Creating object \\"wormhole-img.png\\" in bucket \\"bucketName-object-test\\".
+			Upload complete."
+		`);
+			});
+
+			it("should pass all fetch option flags into requestInit", async () => {
+				fs.writeFileSync("wormhole-img.png", "passageway");
+				setMockFetchR2Objects({
+					accountId: "some-account-id",
+					bucketName: "bucketName-object-test",
+					objectName: "wormhole-img.png",
+				});
+				const flags =
+					"--ct content-type --cd content-disposition --ce content-encoding --cl content-lang --cc cache-control --e expire-time";
+
+				await runWrangler(
+					`r2 object put bucketName-object-test/wormhole-img.png ${flags} --file wormhole-img.png`
+				);
+
+				expect(std.out).toMatchInlineSnapshot(`
+			"Creating object \\"wormhole-img.png\\" in bucket \\"bucketName-object-test\\".
+			Upload complete."
+		`);
+			});
+			it("should not allow `--pipe` & `--file` to run together", async () => {
+				fs.writeFileSync("wormhole-img.png", "passageway");
+				setMockFetchR2Objects({
+					accountId: "some-account-id",
+					bucketName: "bucketName-object-test",
+					objectName: "wormhole-img.png",
+				});
+
+				await expect(
+					runWrangler(
+						`r2 object put bucketName-object-test/wormhole-img.png --pipe --file wormhole-img.png`
+					)
+				).rejects.toThrowErrorMatchingInlineSnapshot(
+					`"Arguments pipe and file are mutually exclusive"`
+				);
+
+				expect(std.err).toMatchInlineSnapshot(`
+			"X [ERROR] Arguments pipe and file are mutually exclusive
+
+			"
+		`);
+			});
+		});
 	});
 });

package/src/__tests__/user.test.ts

@@ -56,6 +56,7 @@ describe("User", () => {
 				oauth_token: "test-access-token",
 				refresh_token: "test-refresh-token",
 				expiration_time: expect.any(String),
+				scopes: ["account:read"],
 			});
 		});
 	});

package/src/__tests__/validate-dev-props.test.ts

@@ -0,0 +1,56 @@
+import { validateDevProps } from "../dev/validate-dev-props";
+import type { DevProps } from "../dev/dev";
+
+describe("validateDevProps", () => {
+	it("should throw if the user tries to use the service-worker format with an `assets` directory", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: ["assets"],
+			entry: { format: "service-worker" },
+			bindings: {},
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot use the service-worker format with an `assets` directory yet. For information on how to migrate to the module-worker format, see: https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/"
+		);
+	});
+
+	it("should throw if the user tries to configure [wasm_modules] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { wasm_modules: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
+		);
+	});
+
+	it("should throw if the user tries to configure [text_blobs] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { text_blobs: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
+		);
+	});
+
+	it("should throw if the user tries to configure [data_blobs] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { data_blobs: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [data_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
+		);
+	});
+});

package/src/__tests__/version.test.ts

@@ -0,0 +1,35 @@
+import { version } from "./../../package.json";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { useMockIsTTY } from "./helpers/mock-istty";
+import { runWrangler } from "./helpers/run-wrangler";
+
+describe("version", () => {
+	const std = mockConsoleMethods();
+	const { setIsTTY } = useMockIsTTY();
+
+	// We cannot test output of version banner,
+	// as it is disabled in jest environments
+
+	// it("should output version banner", async () => {
+	// 	await runWrangler("-v");
+	// 	expect(std.out).toMatchInlineSnapshot(`
+	// 	" ⛅️ wrangler 2.0.22
+	// 	--------------------"
+	// `);
+	// });
+
+	it("should output current version if !isTTY calling -v", async () => {
+		setIsTTY(false);
+
+		await runWrangler("-v");
+		expect(std.out).toMatch(version);
+	});
+
+	// This run separately as command handling is different
+	it("should output current version if !isTTY calling --version", async () => {
+		setIsTTY(false);
+
+		await runWrangler("--version");
+		expect(std.out).toMatch(version);
+	});
+});

package/src/__tests__/whoami.test.tsx

@@ -205,11 +205,12 @@ describe("WhoAmI component", () => {
 		);
 	});
 
-	it("should display the user's email and accounts", async () => {
+	it("should display the user's email, accounts and OAuth scopes", async () => {
 		const user: UserInfo = {
 			authType: "OAuth Token",
 			apiToken: "some-oauth-token",
 			email: "user@example.com",
+			tokenPermissions: ["scope1:read", "scope2:write", "scope3"],
 			accounts: [
 				{ name: "Account One", id: "account-1" },
 				{ name: "Account Two", id: "account-2" },
@@ -226,5 +227,63 @@ describe("WhoAmI component", () => {
 		expect(lastFrame()).toMatch(/Account One .+ account-1/);
 		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
 		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+		expect(lastFrame()).toContain(
+			"Token Permissions: If scopes are missing, you may need to logout and re-login."
+		);
+		expect(lastFrame()).toContain("- scope1 (read)");
+		expect(lastFrame()).toContain("- scope2 (write)");
+		expect(lastFrame()).toContain("- scope3");
+	});
+
+	// For the case where the cache hasn't updated to include the scopes array
+	it("should display the user's email and accounts, but no OAuth scopes if none provided", async () => {
+		const user: UserInfo = {
+			authType: "OAuth Token",
+			apiToken: "some-oauth-token",
+			email: "user@example.com",
+			tokenPermissions: undefined,
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		};
+
+		const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+		expect(lastFrame()).toContain(
+			"You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
+		);
+		expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+		expect(lastFrame()).toMatch(/Account One .+ account-1/);
+		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+	});
+
+	it("should display the user's email, accounts and link to view token permissions for non-OAuth tokens", async () => {
+		const user: UserInfo = {
+			authType: "API Token",
+			apiToken: "some-api-token",
+			email: "user@example.com",
+			tokenPermissions: undefined,
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		};
+
+		const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+		expect(lastFrame()).toContain(
+			"You are logged in with an API Token, associated with the email 'user@example.com'!"
+		);
+		expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+		expect(lastFrame()).toMatch(/Account One .+ account-1/);
+		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+		expect(lastFrame()).toContain(
+			"To see token permissions visit https://dash.cloudflare.com/profile/api-tokens"
+		);
 	});
 });

package/src/api/dev.ts

@@ -1,6 +1,7 @@
 import { startDev } from "../dev";
 import { logger } from "../logger";
 
+import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli";
 import type { RequestInit, Response } from "undici";
 
 interface DevOptions {
@@ -13,39 +14,72 @@ interface DevOptions {
 	siteInclude?: string[];
 	siteExclude?: string[];
 	nodeCompat?: boolean;
+	compatibilityDate?: string;
 	experimentalEnableLocalPersistence?: boolean;
-	_: (string | number)[]; //yargs wants this
-	$0: string; //yargs wants this
+	liveReload?: boolean;
+	watch?: boolean;
+	vars: {
+		[key: string]: unknown;
+	};
+	kv?: {
+		binding: string;
+		id: string;
+		preview_id?: string;
+	}[];
+	durableObjects?: {
+		name: string;
+		class_name: string;
+		script_name?: string | undefined;
+		environment?: string | undefined;
+	}[];
+	showInteractiveDevSession?: boolean;
+	logLevel?: "none" | "error" | "log" | "warn" | "debug";
+	logPrefix?: string;
+	inspect?: boolean;
+	forceLocal?: boolean;
+	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
+	_?: (string | number)[]; //yargs wants this
+	$0?: string; //yargs wants this
 }
 /**
  *  unstable_dev starts a wrangler dev server, and returns a promise that resolves with utility functions to interact with it.
  *  @param {string} script
  *  @param {DevOptions} options
  */
-export async function unstable_dev(script: string, options: DevOptions) {
-	logger.warn(
-		`unstable_dev() is experimental\nunstable_dev()'s behaviour will likely change in future releases`
-	);
+export async function unstable_dev(
+	script: string,
+	options: DevOptions,
+	disableExperimentalWarning?: boolean
+) {
+	if (!disableExperimentalWarning) {
+		logger.warn(
+			`unstable_dev() is experimental\nunstable_dev()'s behaviour will likely change in future releases`
+		);
+	}
 
 	return new Promise<{
 		stop: () => void;
 		fetch: (init?: RequestInit) => Promise<Response | undefined>;
+		waitUntilExit: () => Promise<void>;
 	}>((resolve) => {
 		//lmao
 		return new Promise<Awaited<ReturnType<typeof startDev>>>((ready) => {
 			const devServer = startDev({
 				script: script,
-				...options,
-				local: true,
-				onReady: () => ready(devServer),
 				inspect: false,
 				logLevel: "none",
 				showInteractiveDevSession: false,
+				_: [],
+				$0: "",
+				...options,
+				local: true,
+				onReady: () => ready(devServer),
 			});
 		}).then((devServer) => {
 			resolve({
 				stop: devServer.stop,
 				fetch: devServer.fetch,
+				waitUntilExit: devServer.devReactElement.waitUntilExit,
 			});
 		});
 	});