wrangler 2.0.17 → 2.0.21

package/bin/wrangler.js

@@ -3,7 +3,6 @@ const { spawn } = require("child_process");
 const path = require("path");
 const fs = require("fs");
 const os = require("os");
-const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";
 const debug =
@@ -21,8 +20,8 @@ function runWrangler() {
 		// Note Volta and nvm are also recommended in the official docs:
 		// https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
 		console.error(
-			`Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
-You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
+			`Wrangler requires at least node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of node.js.
+
 Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
 		);
 		process.exitCode = 1;
@@ -128,10 +127,42 @@ async function main() {
 }
 
 process.on("SIGINT", () => {
-	wranglerProcess?.kill();
+	wranglerProcess && wranglerProcess.kill();
 });
 process.on("SIGTERM", () => {
-	wranglerProcess?.kill();
+	wranglerProcess && wranglerProcess.kill();
 });
 
+// semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
+
+/**
+MIT License
+
+Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ */
+
+var fn = new Intl.Collator(0, { numeric: 1 }).compare;
+
+function semiver(a, b, bool) {
+	a = a.split(".");
+	b = b.split(".");
+
+	return (
+		fn(a[0], b[0]) ||
+		fn(a[1], b[1]) ||
+		((b[2] = b.slice(2).join(".")),
+		(bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
+		bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
+	);
+}
+
+// end semiver implementation
+
 void main();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.0.17",
+	"version": "2.0.21",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -93,7 +93,6 @@
 		"nanoid": "^3.3.3",
 		"path-to-regexp": "^6.2.0",
 		"selfsigned": "^2.0.1",
-		"semiver": "^1.1.0",
 		"xxhash-wasm": "^1.0.1"
 	},
 	"devDependencies": {
@@ -149,6 +148,7 @@
 		"undici": "^5.5.1",
 		"update-check": "^1.5.4",
 		"ws": "^8.5.0",
+		"xdg-app-paths": "^7.3.0",
 		"yargs": "^17.4.1"
 	},
 	"optionalDependencies": {

package/src/__tests__/configuration.test.ts

@@ -40,6 +40,7 @@ describe("normalizeAndValidateConfig()", () => {
 			tsconfig: undefined,
 			kv_namespaces: [],
 			legacy_env: true,
+			send_metrics: undefined,
 			main: undefined,
 			migrations: [],
 			name: undefined,
@@ -76,6 +77,7 @@ describe("normalizeAndValidateConfig()", () => {
 		it("should override config defaults with provided values", () => {
 			const expectedConfig: Partial<ConfigFields<RawDevConfig>> = {
 				legacy_env: true,
+				send_metrics: false,
 				dev: {
 					ip: "255.255.255.255",
 					port: 9999,
@@ -98,6 +100,7 @@ describe("normalizeAndValidateConfig()", () => {
 		it("should error on invalid top level fields", () => {
 			const expectedConfig = {
 				legacy_env: "FOO",
+				send_metrics: "BAD",
 				dev: {
 					ip: 222,
 					port: "FOO",
@@ -117,13 +120,14 @@ describe("normalizeAndValidateConfig()", () => {
 			);
 			expect(diagnostics.hasWarnings()).toBe(false);
 			expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
-			        "Processing wrangler configuration:
-			          - Expected \\"legacy_env\\" to be of type boolean but got \\"FOO\\".
-			          - Expected \\"dev.ip\\" to be of type string but got 222.
-			          - Expected \\"dev.port\\" to be of type number but got \\"FOO\\".
-			          - Expected \\"dev.local_protocol\\" field to be one of [\\"http\\",\\"https\\"] but got \\"wss\\".
-			          - Expected \\"dev.upstream_protocol\\" field to be one of [\\"http\\",\\"https\\"] but got \\"ws\\"."
-		      `);
+			"Processing wrangler configuration:
+			  - Expected \\"legacy_env\\" to be of type boolean but got \\"FOO\\".
+			  - Expected \\"send_metrics\\" to be of type boolean but got \\"BAD\\".
+			  - Expected \\"dev.ip\\" to be of type string but got 222.
+			  - Expected \\"dev.port\\" to be of type number but got \\"FOO\\".
+			  - Expected \\"dev.local_protocol\\" field to be one of [\\"http\\",\\"https\\"] but got \\"wss\\".
+			  - Expected \\"dev.upstream_protocol\\" field to be one of [\\"http\\",\\"https\\"] but got \\"ws\\"."
+		`);
 		});
 
 		it("should warn on and remove unexpected top level fields", () => {

package/src/__tests__/dev.test.tsx

@@ -1049,6 +1049,50 @@ describe("wrangler dev", () => {
 			        }
 		      `);
 		});
+
+		it("should default to true, without a warning", async () => {
+			fs.writeFileSync("index.js", `export default {};`);
+			await runWrangler("dev index.js");
+			expect((Dev as jest.Mock).mock.calls[0][0].inspect).toEqual(true);
+			expect(std).toMatchInlineSnapshot(`
+			Object {
+			  "debug": "",
+			  "err": "",
+			  "out": "",
+			  "warn": "",
+			}
+		`);
+		});
+
+		it("should pass true, with a warning", async () => {
+			fs.writeFileSync("index.js", `export default {};`);
+			await runWrangler("dev index.js --inspect");
+			expect((Dev as jest.Mock).mock.calls[0][0].inspect).toEqual(true);
+			expect(std).toMatchInlineSnapshot(`
+			Object {
+			  "debug": "",
+			  "err": "",
+			  "out": "",
+			  "warn": "▲ [WARNING] Passing --inspect is unnecessary, now you can always connect to devtools.
+
+			",
+			}
+		`);
+		});
+
+		it("should pass false, without a warning", async () => {
+			fs.writeFileSync("index.js", `export default {};`);
+			await runWrangler("dev index.js --inspect false");
+			expect((Dev as jest.Mock).mock.calls[0][0].inspect).toEqual(false);
+			expect(std).toMatchInlineSnapshot(`
+			Object {
+			  "debug": "",
+			  "err": "",
+			  "out": "",
+			  "warn": "",
+			}
+		`);
+		});
 	});
 
 	describe("service bindings", () => {

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

@@ -5,42 +5,34 @@ import { reinitialiseAuthTokens } from "../../user";
 
 const originalCwd = process.cwd();
 
-export function runInTempDir(
-	{ homedir }: { homedir?: string } = { homedir: "./home" }
-) {
+export function runInTempDir({ homedir } = { homedir: "./home" }) {
 	let tmpDir: string;
 
-	beforeAll(() => {
-		if (tmpDir !== undefined) {
-			process.chdir(originalCwd);
-			fs.rmSync(tmpDir, { recursive: true });
-		}
-	});
-
 	beforeEach(() => {
 		// 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(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(absHomedir);
-			// Now that we have changed the home directory location, we must reinitialize the user auth state
-			reinitialiseAuthTokens();
-		}
+		// 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(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(absHomedir);
+		// Now that we have changed the home directory location, we must reinitialize the user auth state
+		reinitialiseAuthTokens();
 	});
 
 	afterEach(() => {
-		process.chdir(originalCwd);
-		fs.rmSync(tmpDir, { recursive: true });
+		if (fs.existsSync(tmpDir)) {
+			process.chdir(originalCwd);
+			fs.rmSync(tmpDir, { recursive: true });
+		}
 	});
 }

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

@@ -1,6 +1,7 @@
 import fs from "node:fs";
 import os from "node:os";
-import { resolve } from "node:path";
+import path from "node:path";
+import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
 import { getHttpsOptions } from "../https-options";
 import { mockConsoleMethods } from "./helpers/mock-console";
 import { runInTempDir } from "./helpers/run-in-tmp";
@@ -10,15 +11,15 @@ describe("getHttpsOptions()", () => {
 	const std = mockConsoleMethods();
 
 	it("should use cached values if they have not expired", async () => {
-		fs.mkdirSync(resolve(os.homedir(), ".wrangler/local-cert"), {
+		fs.mkdirSync(path.resolve(getGlobalWranglerConfigPath(), "local-cert"), {
 			recursive: true,
 		});
 		fs.writeFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
 			"PRIVATE KEY"
 		);
 		fs.writeFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
 			"PUBLIC KEY"
 		);
 		const result = await getHttpsOptions();
@@ -32,11 +33,11 @@ describe("getHttpsOptions()", () => {
 	it("should generate and cache new keys if none are cached", async () => {
 		const result = await getHttpsOptions();
 		const key = fs.readFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
 			"utf8"
 		);
 		const cert = fs.readFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
 			"utf8"
 		);
 		expect(result.key).toEqual(key);
@@ -49,28 +50,28 @@ describe("getHttpsOptions()", () => {
 	});
 
 	it("should generate and cache new keys if cached files have expired", async () => {
-		fs.mkdirSync(resolve(os.homedir(), ".wrangler/local-cert"), {
+		fs.mkdirSync(path.resolve(getGlobalWranglerConfigPath(), "local-cert"), {
 			recursive: true,
 		});
 		const ORIGINAL_KEY = "EXPIRED PRIVATE KEY";
 		const ORIGINAL_CERT = "EXPIRED PUBLIC KEY";
 		fs.writeFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
 			ORIGINAL_KEY
 		);
 		fs.writeFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
 			ORIGINAL_CERT
 		);
 		mockStatSync(/\.pem$/, { mtimeMs: new Date(2000).valueOf() });
 
 		const result = await getHttpsOptions();
 		const key = fs.readFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem"),
 			"utf8"
 		);
 		const cert = fs.readFileSync(
-			resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+			path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem"),
 			"utf8"
 		);
 		expect(key).not.toEqual(ORIGINAL_KEY);
@@ -84,25 +85,57 @@ describe("getHttpsOptions()", () => {
 		expect(std.err).toMatchInlineSnapshot(`""`);
 	});
 
+	it("should warn if not able to write to the cache (legacy config path)", async () => {
+		fs.mkdirSync(path.join(os.homedir(), ".wrangler"));
+		mockWriteFileSyncThrow(/\.pem$/);
+		await getHttpsOptions();
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem")
+			)
+		).toBe(false);
+		expect(
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem")
+			)
+		).toBe(false);
+		expect(std.out).toMatchInlineSnapshot(
+			`"Generating new self-signed certificate..."`
+		);
+		expect(std.warn).toMatchInlineSnapshot(`
+		      "▲ [WARNING] Unable to cache generated self-signed certificate in home/.wrangler/local-cert.
+
+		        ERROR: Cannot write file
+
+		      "
+	    `);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+		fs.rmSync(path.join(os.homedir(), ".wrangler"), { recursive: true });
+	});
+
 	it("should warn if not able to write to the cache", async () => {
 		mockWriteFileSyncThrow(/\.pem$/);
 		await getHttpsOptions();
 		expect(
-			fs.existsSync(resolve(os.homedir(), ".wrangler/local-cert/key.pem"))
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/key.pem")
+			)
 		).toBe(false);
 		expect(
-			fs.existsSync(resolve(os.homedir(), ".wrangler/local-cert/cert.pem"))
+			fs.existsSync(
+				path.resolve(getGlobalWranglerConfigPath(), "local-cert/cert.pem")
+			)
 		).toBe(false);
 		expect(std.out).toMatchInlineSnapshot(
 			`"Generating new self-signed certificate..."`
 		);
 		expect(std.warn).toMatchInlineSnapshot(`
-      "▲ [WARNING] Unable to cache generated self-signed certificate in home/.wrangler/local-cert.
+		"▲ [WARNING] Unable to cache generated self-signed certificate in test-xdg-config/local-cert.
 
-        ERROR: Cannot write file
+		  ERROR: Cannot write file
 
-      "
-    `);
+		"
+	`);
 		expect(std.err).toMatchInlineSnapshot(`""`);
 	});
 });

package/src/__tests__/jest.setup.ts

@@ -105,3 +105,16 @@ jest.mock("../user/generate-random-state", () => {
 		generateRandomState: jest.fn().mockImplementation(() => "MOCK_STATE_PARAM"),
 	};
 });
+
+jest.mock("xdg-app-paths", () => {
+	return {
+		__esModule: true,
+		default: jest.fn().mockImplementation(() => {
+			return {
+				config() {
+					return jest.requireActual("node:path").resolve("test-xdg-config");
+				},
+			};
+		}),
+	};
+});