wrangler 2.0.16 → 2.0.17

package/bin/wrangler.js

@@ -6,6 +6,10 @@ const os = require("os");
 const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";
+const debug =
+	process.env["WRANGLER_LOG"] === "debug"
+		? (...args) => console.log(...args)
+		: () => {};
 
 let wranglerProcess;
 
@@ -84,9 +88,8 @@ function runDelegatedWrangler() {
 	} = JSON.parse(fs.readFileSync(packageJsonPath));
 	const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
 
-	console.log(
-		`Delegating to locally-installed version of wrangler @ v${version}`
-	);
+	debug(`Delegating to locally-installed version of wrangler @ v${version}`);
+
 	// this call to `spawn` is simpler because the delegated version will do all
 	// of the other work.
 	return spawn(

package/miniflare-dist/index.mjs

@@ -4871,6 +4871,7 @@ async function main() {
   try {
     await mf.startServer();
     await mf.startScheduler();
+    process.send && process.send("ready");
   } catch (e) {
     mf.log.error(e);
     process.exitCode = 1;

package/package.json

@@ -1,18 +1,7 @@
 {
 	"name": "wrangler",
-	"version": "2.0.16",
-	"author": "wrangler@cloudflare.com",
+	"version": "2.0.17",
 	"description": "Command-line interface for all things Cloudflare Workers",
-	"bin": {
-		"wrangler": "./bin/wrangler.js",
-		"wrangler2": "./bin/wrangler.js"
-	},
-	"main": "wrangler-dist/cli.js",
-	"license": "MIT OR Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/cloudflare/wrangler2/issues"
-	},
-	"homepage": "https://github.com/cloudflare/wrangler2#readme",
 	"keywords": [
 		"wrangler",
 		"cloudflare",
@@ -29,31 +18,87 @@
 		"webassembly",
 		"rust",
 		"emscripten",
-		"rust",
 		"typescript",
 		"graphql",
 		"router",
 		"http",
 		"cli"
 	],
+	"homepage": "https://github.com/cloudflare/wrangler2#readme",
+	"bugs": {
+		"url": "https://github.com/cloudflare/wrangler2/issues"
+	},
+	"license": "MIT OR Apache-2.0",
+	"author": "wrangler@cloudflare.com",
+	"main": "wrangler-dist/cli.js",
+	"types": "wrangler-dist/cli.d.ts",
+	"bin": {
+		"wrangler": "./bin/wrangler.js",
+		"wrangler2": "./bin/wrangler.js"
+	},
+	"files": [
+		"src",
+		"bin",
+		"miniflare-config-stubs",
+		"miniflare-dist",
+		"wrangler-dist",
+		"templates",
+		"vendor",
+		"import_meta_url.js",
+		"kv-asset-handler.js",
+		"Cloudflare_CA.pem"
+	],
+	"scripts": {
+		"build": "npm run clean && npm run bundle && npm run emit-types",
+		"bundle": "node -r esbuild-register scripts/bundle.ts",
+		"check:type": "tsc",
+		"clean": "rm -rf wrangler-dist miniflare-dist emitted-types",
+		"dev": "npm run clean && concurrently -c black,blue 'npm run bundle -- --watch' 'npm run check:type -- --watch --preserveWatchOutput'",
+		"emit-types": "tsc -p tsconfig.emit.json && node -r esbuild-register scripts/emit-types.ts",
+		"prepublishOnly": "SOURCEMAPS=false npm run build",
+		"start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
+		"test": "jest --silent=false --verbose=true",
+		"test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
+	},
+	"jest": {
+		"moduleNameMapper": {
+			"clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js",
+			"miniflare/cli": "<rootDir>/../../node_modules/miniflare/dist/src/cli.js"
+		},
+		"restoreMocks": true,
+		"setupFilesAfterEnv": [
+			"<rootDir>/src/__tests__/jest.setup.ts"
+		],
+		"testRegex": ".*.(test|spec)\\.[jt]sx?$",
+		"testTimeout": 30000,
+		"transform": {
+			"^.+\\.c?(t|j)sx?$": [
+				"esbuild-jest",
+				{
+					"sourcemap": true
+				}
+			]
+		},
+		"transformIgnorePatterns": [
+			"node_modules/(?!find-up|locate-path|p-locate|p-limit|p-timeout|p-queue|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream|get-port|supports-color|pretty-bytes)"
+		]
+	},
 	"dependencies": {
 		"@cloudflare/kv-asset-handler": "^0.2.0",
 		"@esbuild-plugins/node-globals-polyfill": "^0.1.1",
 		"@esbuild-plugins/node-modules-polyfill": "^0.1.4",
 		"blake3-wasm": "^2.1.5",
 		"esbuild": "0.14.47",
-		"miniflare": "^2.5.1",
+		"miniflare": "^2.6.0",
 		"nanoid": "^3.3.3",
 		"path-to-regexp": "^6.2.0",
 		"selfsigned": "^2.0.1",
 		"semiver": "^1.1.0",
 		"xxhash-wasm": "^1.0.1"
 	},
-	"optionalDependencies": {
-		"fsevents": "~2.3.2"
-	},
 	"devDependencies": {
 		"@iarna/toml": "^3.0.0",
+		"@microsoft/api-extractor": "^7.28.3",
 		"@types/command-exists": "^1.2.0",
 		"@types/glob-to-regexp": "0.4.1",
 		"@types/mime": "^2.0.3",
@@ -106,53 +151,10 @@
 		"ws": "^8.5.0",
 		"yargs": "^17.4.1"
 	},
-	"files": [
-		"src",
-		"bin",
-		"miniflare-config-stubs",
-		"miniflare-dist",
-		"wrangler-dist",
-		"templates",
-		"vendor",
-		"import_meta_url.js",
-		"kv-asset-handler.js",
-		"Cloudflare_CA.pem"
-	],
-	"scripts": {
-		"clean": "rm -rf wrangler-dist miniflare-dist",
-		"check:type": "tsc",
-		"bundle": "node -r esbuild-register scripts/bundle.ts",
-		"build": "npm run clean && npm run bundle",
-		"dev": "npm run clean && concurrently -c black,blue 'npm run bundle -- --watch' 'npm run check:type -- --watch --preserveWatchOutput'",
-		"prepublishOnly": "SOURCEMAPS=false npm run build",
-		"start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
-		"test": "jest --silent=false --verbose=true",
-		"test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
+	"optionalDependencies": {
+		"fsevents": "~2.3.2"
 	},
 	"engines": {
 		"node": ">=16.7.0"
-	},
-	"jest": {
-		"restoreMocks": true,
-		"testTimeout": 30000,
-		"testRegex": ".*.(test|spec)\\.[jt]sx?$",
-		"transformIgnorePatterns": [
-			"node_modules/(?!find-up|locate-path|p-locate|p-limit|p-timeout|p-queue|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream|get-port|supports-color|pretty-bytes)"
-		],
-		"moduleNameMapper": {
-			"clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js",
-			"miniflare/cli": "<rootDir>/../../node_modules/miniflare/dist/src/cli.js"
-		},
-		"transform": {
-			"^.+\\.c?(t|j)sx?$": [
-				"esbuild-jest",
-				{
-					"sourcemap": true
-				}
-			]
-		},
-		"setupFilesAfterEnv": [
-			"<rootDir>/src/__tests__/jest.setup.ts"
-		]
 	}
 }

package/src/__tests__/helpers/run-in-tmp.ts

@@ -5,7 +5,9 @@ import { reinitialiseAuthTokens } from "../../user";
 
 const originalCwd = process.cwd();
 
-export function runInTempDir({ homedir }: { homedir?: string } = {}) {
+export function runInTempDir(
+	{ homedir }: { homedir?: string } = { homedir: "./home" }
+) {
 	let tmpDir: string;
 
 	beforeAll(() => {
@@ -16,17 +18,22 @@ export function runInTempDir({ homedir }: { homedir?: string } = {}) {
 	});
 
 	beforeEach(() => {
-		tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"));
+		// Use realpath because the temporary path can point to a symlink rather than the actual path.
+		tmpDir = fs.realpathSync(
+			fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"))
+		);
 		process.chdir(tmpDir);
 		if (homedir !== undefined) {
+			// The path that is returned from `homedir()` should be absolute.
+			const absHomedir = path.resolve(tmpDir, homedir);
 			// Override where the home directory is so that we can write our own user config,
 			// without destroying the real thing.
-			fs.mkdirSync(homedir);
+			fs.mkdirSync(absHomedir, { recursive: true });
 			// Note it is very important that we use the "default" value from "node:os" (e.g. `import os from "node:os";`)
 			// rather than an alias to the module (e.g. `import * as os from "node:os";`).
 			// This is because the module gets transpiled so that the "method" `homedir()` gets converted to a
 			// getter that is not configurable (and so cannot be spied upon).
-			jest.spyOn(os, "homedir").mockReturnValue(homedir);
+			jest.spyOn(os, "homedir").mockReturnValue(absHomedir);
 			// Now that we have changed the home directory location, we must reinitialize the user auth state
 			reinitialiseAuthTokens();
 		}

package/src/__tests__/https-options.test.ts

@@ -6,7 +6,7 @@ import { mockConsoleMethods } from "./helpers/mock-console";
 import { runInTempDir } from "./helpers/run-in-tmp";
 
 describe("getHttpsOptions()", () => {
-	runInTempDir({ homedir: "./home" });
+	runInTempDir();
 	const std = mockConsoleMethods();
 
 	it("should use cached values if they have not expired", async () => {

package/src/__tests__/index.test.ts

@@ -35,7 +35,7 @@ describe("wrangler", () => {
 			  wrangler dev [script]      👂 Start a local server for developing your worker
 			  wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
 			  wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
-			  wrangler secret            🤫 Generate a secret that can be referenced in the worker script
+			  wrangler secret            🤫 Generate a secret that can be referenced in a Worker
 			  wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
 			  wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
 			  wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
@@ -74,7 +74,7 @@ describe("wrangler", () => {
 			  wrangler dev [script]      👂 Start a local server for developing your worker
 			  wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
 			  wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
-			  wrangler secret            🤫 Generate a secret that can be referenced in the worker script
+			  wrangler secret            🤫 Generate a secret that can be referenced in a Worker
 			  wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
 			  wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
 			  wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
@@ -123,20 +123,20 @@ describe("wrangler", () => {
 			await runWrangler("secret");
 			await endEventLoop();
 			expect(std.out).toMatchInlineSnapshot(`
-			        "wrangler secret
+			"wrangler secret
 
-			        🤫 Generate a secret that can be referenced in the worker script
+			🤫 Generate a secret that can be referenced in a Worker
 
-			        Commands:
-			          wrangler secret put <key>     Create or update a secret variable for a script
-			          wrangler secret delete <key>  Delete a secret variable from a script
-			          wrangler secret list          List all secrets for a script
+			Commands:
+			  wrangler secret put <key>     Create or update a secret variable for a Worker
+			  wrangler secret delete <key>  Delete a secret variable from a Worker
+			  wrangler secret list          List all secrets for a Worker
 
-			        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]"
+		`);
 		});
 
 		it("no subcommand 'kv:namespace' should display a list of available subcommands", async () => {

package/src/__tests__/kv.test.ts

@@ -1,5 +1,5 @@
 import { writeFileSync } from "node:fs";
-import { Headers } from "undici";
+import { FormData, Headers } from "undici";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import {
 	setMockResponse,
@@ -330,7 +330,15 @@ describe("wrangler", () => {
 						expect(accountId).toEqual("some-account-id");
 						expect(namespaceId).toEqual(expectedNamespaceId);
 						expect(key).toEqual(expectedKV.key);
-						expect(body).toEqual(expectedKV.value);
+						if (expectedKV.metadata) {
+							expect(body).toBeInstanceOf(FormData);
+							expect((body as FormData).get("value")).toEqual(expectedKV.value);
+							expect((body as FormData).get("metadata")).toEqual(
+								JSON.stringify(expectedKV.metadata)
+							);
+						} else {
+							expect(body).toEqual(expectedKV.value);
+						}
 						if (expectedKV.expiration !== undefined) {
 							expect(query.get("expiration")).toEqual(
 								`${expectedKV.expiration}`
@@ -488,6 +496,24 @@ describe("wrangler", () => {
 				expect(requests.count).toEqual(1);
 			});
 
+			it("should put a key with metadata", async () => {
+				const requests = mockKeyPutRequest("some-namespace-id", {
+					key: "dKey",
+					value: "dVal",
+					metadata: {
+						mKey: "mValue",
+					},
+				});
+				await runWrangler(
+					`kv:key put dKey dVal --namespace-id some-namespace-id --metadata {"mKey":"mValue"}`
+				);
+				expect(requests.count).toEqual(1);
+				expect(std.out).toMatchInlineSnapshot(
+					`"Writing the value \\"dVal\\" to key \\"dKey\\" on namespace some-namespace-id with metadata \\"{\\"mKey\\":\\"mValue\\"}\\"."`
+				);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
 			it("should error if no key is provided", async () => {
 				await expect(
 					runWrangler("kv:key put")
@@ -517,6 +543,7 @@ describe("wrangler", () => {
                 --preview       Interact with a preview namespace  [boolean]
                 --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
+                --metadata      Arbitrary JSON that is associated with a key  [string]
                 --path          Read value from the file at a given path  [string]"
         `);
 				expect(std.err).toMatchInlineSnapshot(`
@@ -555,6 +582,7 @@ describe("wrangler", () => {
                 --preview       Interact with a preview namespace  [boolean]
                 --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
+                --metadata      Arbitrary JSON that is associated with a key  [string]
                 --path          Read value from the file at a given path  [string]"
         `);
 				expect(std.err).toMatchInlineSnapshot(`
@@ -593,6 +621,7 @@ describe("wrangler", () => {
                 --preview       Interact with a preview namespace  [boolean]
                 --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
+                --metadata      Arbitrary JSON that is associated with a key  [string]
                 --path          Read value from the file at a given path  [string]"
         `);
 				expect(std.err).toMatchInlineSnapshot(`
@@ -631,6 +660,7 @@ describe("wrangler", () => {
                 --preview       Interact with a preview namespace  [boolean]
                 --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
+                --metadata      Arbitrary JSON that is associated with a key  [string]
                 --path          Read value from the file at a given path  [string]"
         `);
 				expect(std.err).toMatchInlineSnapshot(`
@@ -669,6 +699,7 @@ describe("wrangler", () => {
                 --preview       Interact with a preview namespace  [boolean]
                 --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
+                --metadata      Arbitrary JSON that is associated with a key  [string]
                 --path          Read value from the file at a given path  [string]"
         `);
 				expect(std.err).toMatchInlineSnapshot(`

package/src/__tests__/publish.test.ts

@@ -29,7 +29,7 @@ import type { FormData, File } from "undici";
 describe("publish", () => {
 	mockAccountId();
 	mockApiToken();
-	runInTempDir({ homedir: "./home" });
+	runInTempDir();
 	const { setIsTTY } = useMockIsTTY();
 	const std = mockConsoleMethods();
 	const {
@@ -97,33 +97,23 @@ describe("publish", () => {
 				api_token: "some-api-token",
 			});
 
-			const accessTokenRequest = mockGrantAccessToken({ respondWith: "ok" });
-			mockGrantAuthorization({ respondWith: "success" });
-
 			await expect(runWrangler("publish index.js")).resolves.toBeUndefined();
 
-			expect(accessTokenRequest.actual.url).toEqual(
-				accessTokenRequest.expected.url
-			);
-
 			expect(std.out).toMatchInlineSnapshot(`
-			        "Attempting to login via OAuth...
-			        Opening a link in your default browser: https://dash.cloudflare.com/oauth2/auth?response_type=code&client_id=54d11594-84e4-41aa-b438-e81b8fa78ee7&redirect_uri=http%3A%2F%2Flocalhost%3A8976%2Foauth%2Fcallback&scope=account%3Aread%20user%3Aread%20workers%3Awrite%20workers_kv%3Awrite%20workers_routes%3Awrite%20workers_scripts%3Awrite%20workers_tail%3Aread%20pages%3Awrite%20zone%3Aread%20offline_access&state=MOCK_STATE_PARAM&code_challenge=MOCK_CODE_CHALLENGE&code_challenge_method=S256
-			        Successfully logged in.
-			        Total Upload: 0xx KiB / gzip: 0xx KiB
-			        Uploaded test-name (TIMINGS)
-			        Published test-name (TIMINGS)
-			          test-name.test-sub-domain.workers.dev"
-		      `);
+			"Total Upload: 0xx KiB / gzip: 0xx KiB
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  test-name.test-sub-domain.workers.dev"
+		`);
 			expect(std.warn).toMatchInlineSnapshot(`
-			        "▲ [WARNING] It looks like you have used Wrangler 1's \`config\` command to login with an API token.
+			"▲ [WARNING] It looks like you have used Wrangler 1's \`config\` command to login with an API token.
 
-			          This is no longer supported in the current version of Wrangler.
-			          If you wish to authenticate via an API token then please set the \`CLOUDFLARE_API_TOKEN\`
-			          environment variable.
+			  This is no longer supported in the current version of Wrangler.
+			  If you wish to authenticate via an API token then please set the \`CLOUDFLARE_API_TOKEN\`
+			  environment variable.
 
-			        "
-		      `);
+			"
+		`);
 			expect(std.err).toMatchInlineSnapshot(`""`);
 		});