wrangler 2.0.16 → 2.0.17

package/src/index.tsx

@@ -64,6 +64,7 @@ import { whoami } from "./whoami";
 
 import { workerNamespaceCommands } from "./worker-namespace";
 import type { Config } from "./config";
+import type { KeyValue } from "./kv";
 import type { TailCLIFilters } from "./tail";
 import type { RawData } from "ws";
 import type { CommandModule } from "yargs";
@@ -382,7 +383,7 @@ function createCLIParser(argv: string[]) {
 						hidden: true,
 					})
 					.option("no-bundle", {
-						describe: "Skip internal build steps and directly publish script",
+						describe: "Skip internal build steps and directly publish Worker",
 						type: "boolean",
 						default: false,
 					})
@@ -474,7 +475,7 @@ function createCLIParser(argv: string[]) {
 						requiresArg: true,
 					})
 					.option("minify", {
-						describe: "Minify the script",
+						describe: "Minify the Worker",
 						type: "boolean",
 					})
 					.option("node-compat", {
@@ -643,7 +644,9 @@ function createCLIParser(argv: string[]) {
 			const scriptName = getLegacyScriptName(args, config);
 
 			if (!scriptName) {
-				throw new Error("Missing script name");
+				throw new Error(
+					"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `wrangler tail <worker-name>`"
+				);
 			}
 
 			const accountId = await requireAuth(config);
@@ -820,7 +823,7 @@ function createCLIParser(argv: string[]) {
 	// secret
 	wrangler.command(
 		"secret",
-		"🤫 Generate a secret that can be referenced in the worker script",
+		"🤫 Generate a secret that can be referenced in a Worker",
 		(secretYargs) => {
 			return secretYargs
 				.command(subHelp)
@@ -831,15 +834,15 @@ function createCLIParser(argv: string[]) {
 				})
 				.command(
 					"put <key>",
-					"Create or update a secret variable for a script",
+					"Create or update a secret variable for a Worker",
 					(yargs) => {
 						return yargs
 							.positional("key", {
-								describe: "The variable name to be accessible in the script",
+								describe: "The variable name to be accessible in the Worker",
 								type: "string",
 							})
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -857,7 +860,9 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
@@ -870,7 +875,7 @@ function createCLIParser(argv: string[]) {
 						);
 
 						logger.log(
-							`🌀 Creating the secret for script ${scriptName} ${
+							`🌀 Creating the secret for the Worker "${scriptName}" ${
 								args.env && !isLegacyEnv(config) ? `(${args.env})` : ""
 							}`
 						);
@@ -955,16 +960,16 @@ function createCLIParser(argv: string[]) {
 				)
 				.command(
 					"delete <key>",
-					"Delete a secret variable from a script",
+					"Delete a secret variable from a Worker",
 					async (yargs) => {
 						await printWranglerBanner();
 						return yargs
 							.positional("key", {
-								describe: "The variable name to be accessible in the script",
+								describe: "The variable name to be accessible in the Worker",
 								type: "string",
 							})
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -981,22 +986,26 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
 
 						if (
 							await confirm(
-								`Are you sure you want to permanently delete the variable ${
+								`Are you sure you want to permanently delete the secret ${
 									args.key
-								} on the script ${scriptName}${
+								} on the Worker ${scriptName}${
 									args.env && !isLegacyEnv(config) ? ` (${args.env})` : ""
 								}?`
 							)
 						) {
 							logger.log(
-								`🌀 Deleting the secret ${args.key} on script ${scriptName}${
+								`🌀 Deleting the secret ${
+									args.key
+								} on the Worker ${scriptName}${
 									args.env && !isLegacyEnv(config) ? ` (${args.env})` : ""
 								}`
 							);
@@ -1013,11 +1022,11 @@ function createCLIParser(argv: string[]) {
 				)
 				.command(
 					"list",
-					"List all secrets for a script",
+					"List all secrets for a Worker",
 					(yargs) => {
 						return yargs
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -1034,7 +1043,9 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
@@ -1253,6 +1264,15 @@ function createCLIParser(argv: string[]) {
 								describe:
 									"Time since the UNIX epoch after which the entry expires",
 							})
+							.option("metadata", {
+								type: "string",
+								describe: "Arbitrary JSON that is associated with a key",
+								coerce: (jsonStr: string): KeyValue["metadata"] => {
+									try {
+										return JSON.parse(jsonStr);
+									} catch (_) {}
+								},
+							})
 							.option("path", {
 								type: "string",
 								requiresArg: true,
@@ -1260,7 +1280,7 @@ function createCLIParser(argv: string[]) {
 							})
 							.check(demandOneOfOption("value", "path"));
 					},
-					async ({ key, ttl, expiration, ...args }) => {
+					async ({ key, ttl, expiration, metadata, ...args }) => {
 						await printWranglerBanner();
 						const config = readConfig(args.config as ConfigPath, args);
 						const namespaceId = getKVNamespaceId(args, config);
@@ -1270,13 +1290,17 @@ function createCLIParser(argv: string[]) {
 							: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 							  args.value!;
 
+						const metadataLog = metadata
+							? ` with metadata "${JSON.stringify(metadata)}"`
+							: "";
+
 						if (args.path) {
 							logger.log(
-								`Writing the contents of ${args.path} to the key "${key}" on namespace ${namespaceId}.`
+								`Writing the contents of ${args.path} to the key "${key}" on namespace ${namespaceId}${metadataLog}.`
 							);
 						} else {
 							logger.log(
-								`Writing the value "${value}" to key "${key}" on namespace ${namespaceId}.`
+								`Writing the value "${value}" to key "${key}" on namespace ${namespaceId}${metadataLog}.`
 							);
 						}
 
@@ -1287,6 +1311,7 @@ function createCLIParser(argv: string[]) {
 							value,
 							expiration,
 							expiration_ttl: ttl,
+							metadata: metadata as KeyValue["metadata"],
 						});
 					}
 				)

package/src/kv.ts

@@ -1,4 +1,5 @@
 import { URLSearchParams } from "node:url";
+import { FormData } from "undici";
 import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
 import { logger } from "./logger";
 import type { Config } from "./config";
@@ -186,6 +187,19 @@ export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
 	return props.filter((prop) => !KeyValueKeys.has(prop));
 }
 
+/**
+ * Turn object with fields into FormData
+ */
+function asFormData(fields: Record<string, unknown>): FormData {
+	const formData = new FormData();
+
+	for (const [name, value] of Object.entries(fields)) {
+		formData.append(name, value);
+	}
+
+	return formData;
+}
+
 export async function putKVKeyValue(
 	accountId: string,
 	namespaceId: string,
@@ -205,7 +219,15 @@ export async function putKVKeyValue(
 		`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
 			keyValue.key
 		)}`,
-		{ method: "PUT", body: keyValue.value },
+		{
+			method: "PUT",
+			body: keyValue.metadata
+				? asFormData({
+						value: keyValue.value,
+						metadata: JSON.stringify(keyValue.metadata),
+				  })
+				: keyValue.value,
+		},
 		searchParams
 	);
 }

package/src/miniflare-cli/index.ts

@@ -41,6 +41,7 @@ async function main() {
 		// Start Miniflare development server
 		await mf.startServer();
 		await mf.startScheduler();
+		process.send && process.send("ready");
 	} catch (e) {
 		mf.log.error(e as Error);
 		process.exitCode = 1;

package/src/package-manager.ts

@@ -1,5 +1,6 @@
 import { existsSync } from "node:fs";
 import { join } from "node:path";
+import { env } from "node:process";
 import { execa, execaCommandSync } from "execa";
 import { logger } from "./logger";
 
@@ -19,7 +20,9 @@ export async function getPackageManager(cwd: string): Promise<PackageManager> {
 	const hasYarnLock = existsSync(join(cwd, "yarn.lock"));
 	const hasNpmLock = existsSync(join(cwd, "package-lock.json"));
 	const hasPnpmLock = existsSync(join(cwd, "pnpm-lock.yaml"));
+	const userAgent = sniffUserAgent();
 
+	// check for lockfiles
 	if (hasNpmLock) {
 		if (hasNpm) {
 			logger.log(
@@ -60,6 +63,19 @@ export async function getPackageManager(cwd: string): Promise<PackageManager> {
 		}
 	}
 
+	// check the user agent
+	if (userAgent === "npm" && hasNpm) {
+		logger.log("Using npm as package manager.");
+		return { ...NpmPackageManager, cwd };
+	} else if (userAgent === "pnpm" && hasPnpm) {
+		logger.log("Using pnpm as package manager.");
+		return { ...PnpmPackageManager, cwd };
+	} else if (userAgent === "yarn" && hasYarn) {
+		logger.log("Using yarn as package manager.");
+		return { ...YarnPackageManager, cwd };
+	}
+
+	// lastly, check what's installed
 	if (hasNpm) {
 		logger.log("Using npm as package manager.");
 		return { ...NpmPackageManager, cwd };
@@ -172,3 +188,32 @@ function supportsNpm(): Promise<boolean> {
 function supportsPnpm(): Promise<boolean> {
 	return supports("pnpm");
 }
+
+/**
+ * The environment variable `npm_config_user_agent` can be used to
+ * guess the package manager that was used to execute wrangler.
+ * It's imperfect (just like regular user agent sniffing!)
+ * but the package managers we support all set this property:
+ *
+ * - [npm](https://github.com/npm/cli/blob/1415b4bdeeaabb6e0ba12b6b1b0cc56502bd64ab/lib/utils/config/definitions.js#L1945-L1979)
+ * - [pnpm](https://github.com/pnpm/pnpm/blob/cd4f9341e966eb8b411462b48ff0c0612e0a51a7/packages/plugin-commands-script-runners/src/makeEnv.ts#L14)
+ * - [yarn](https://yarnpkg.com/advanced/lifecycle-scripts#environment-variables)
+ */
+function sniffUserAgent(): "npm" | "pnpm" | "yarn" | undefined {
+	const userAgent = env.npm_config_user_agent;
+	if (userAgent === undefined) {
+		return undefined;
+	}
+
+	if (userAgent.includes("yarn")) {
+		return "yarn";
+	}
+
+	if (userAgent.includes("pnpm")) {
+		return "pnpm";
+	}
+
+	if (userAgent.includes("npm")) {
+		return "npm";
+	}
+}

package/src/user/user.tsx

@@ -368,6 +368,11 @@ function getAuthTokens(config?: UserAuthConfig): AuthTokens | undefined {
 				refreshToken: { value: refresh_token ?? "" },
 			};
 		} else if (api_token) {
+			logger.warn(
+				"It looks like you have used Wrangler 1's `config` command to login with an API token.\n" +
+					"This is no longer supported in the current version of Wrangler.\n" +
+					"If you wish to authenticate via an API token then please set the `CLOUDFLARE_API_TOKEN` environment variable."
+			);
 			return { apiToken: api_token };
 		}
 	} catch {
@@ -396,12 +401,8 @@ export function reinitialiseAuthTokens(config?: UserAuthConfig): void {
 }
 
 export function getAPIToken(): ApiCredentials | undefined {
-	if ("apiToken" in LocalState) {
-		logger.warn(
-			"It looks like you have used Wrangler 1's `config` command to login with an API token.\n" +
-				"This is no longer supported in the current version of Wrangler.\n" +
-				"If you wish to authenticate via an API token then please set the `CLOUDFLARE_API_TOKEN` environment variable."
-		);
+	if (LocalState.apiToken) {
+		return { apiToken: LocalState.apiToken };
 	}
 
 	const localAPIToken = getAuthFromEnv();
@@ -410,11 +411,7 @@ export function getAPIToken(): ApiCredentials | undefined {
 	const storedAccessToken = LocalState.accessToken?.value;
 	if (storedAccessToken) return { apiToken: storedAccessToken };
 
-	if (!process.stdout.isTTY) {
-		throw new Error(
-			"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work. Please go to https://developers.cloudflare.com/api/tokens/create/ for instructions on how to create an api token, and assign its value to CLOUDFLARE_API_TOKEN."
-		);
-	}
+	return undefined;
 }
 
 interface AccessContext {
@@ -846,11 +843,12 @@ async function generatePKCECodes(): Promise<PKCECodes> {
  * and updates the user auth state with the new credentials.
  */
 export function writeAuthConfigFile(config: UserAuthConfig) {
-	mkdirSync(path.join(os.homedir(), ".wrangler/config/"), {
+	const authConfigFilePath = path.join(os.homedir(), USER_AUTH_CONFIG_FILE);
+	mkdirSync(path.dirname(authConfigFilePath), {
 		recursive: true,
 	});
 	writeFileSync(
-		path.join(os.homedir(), USER_AUTH_CONFIG_FILE),
+		path.join(authConfigFilePath),
 		TOML.stringify(config as TOML.JsonMap),
 		{ encoding: "utf-8" }
 	);
@@ -859,9 +857,8 @@ export function writeAuthConfigFile(config: UserAuthConfig) {
 }
 
 export function readAuthConfigFile(): UserAuthConfig {
-	const toml = parseTOML(
-		readFileSync(path.join(os.homedir(), USER_AUTH_CONFIG_FILE))
-	);
+	const authConfigFilePath = path.join(os.homedir(), USER_AUTH_CONFIG_FILE);
+	const toml = parseTOML(readFileSync(authConfigFilePath));
 	return toml;
 }
 
@@ -1114,8 +1111,14 @@ export async function requireAuth(config: {
 }): Promise<string> {
 	const loggedIn = await loginOrRefreshIfRequired();
 	if (!loggedIn) {
-		// didn't login, let's just quit
-		throw new Error("Did not login, quitting...");
+		if (!isInteractive()) {
+			throw new Error(
+				"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work. Please go to https://developers.cloudflare.com/api/tokens/create/ for instructions on how to create an api token, and assign its value to CLOUDFLARE_API_TOKEN."
+			);
+		} else {
+			// didn't login, let's just quit
+			throw new Error("Did not login, quitting...");
+		}
 	}
 	const accountId = config.account_id || (await getAccountId());
 	if (!accountId) {

package/templates/static-asset-facade.js

@@ -1,6 +1,10 @@
 // DO NOT IMPORT THIS DIRECTLY
 import worker from "__ENTRY_POINT__";
-import { getAssetFromKV } from "__KV_ASSET_HANDLER__";
+import {
+	getAssetFromKV,
+	NotFoundError,
+	MethodNotAllowedError,
+} from "__KV_ASSET_HANDLER__";
 import manifest from "__STATIC_CONTENT_MANIFEST";
 const ASSET_MANIFEST = JSON.parse(manifest);
 
@@ -33,11 +37,13 @@ export default {
 
 			return response;
 		} catch (e) {
+			if (e instanceof NotFoundError || e instanceof MethodNotAllowedError) {
+				// if a known error is thrown then serve from actual worker
+				return worker.fetch(request, env, ctx);
+			}
+			// otherwise it's a real error, so throw it
 			console.error(e);
-			// if an error is thrown then serve from actual worker
-			return worker.fetch(request, env, ctx);
-			// TODO: throw here if worker is not available
-			// (which implies it may be a service-worker)
+			return new Response(e.message, { status: 500 });
 		}
 	},
 };

package/templates/tsconfig.json

@@ -15,7 +15,7 @@
 		"lib": [
 			"es2021"
 		] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
-		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
+		"jsx": "react" /* Specify what JSX code is generated. */,
 		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
 		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
 		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
@@ -42,7 +42,7 @@
 
 		/* JavaScript Support */
 		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
-		"checkJs": true /* Enable error reporting in type-checked JavaScript files. */,
+		"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
 		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
 
 		/* Emit */