wrangler 0.0.0-e7a0cd5b → 0.0.0-e7cf0caa

package/src/dialogs.ts

@@ -0,0 +1,136 @@
+import chalk from "chalk";
+import prompts from "prompts";
+import { CI } from "./is-ci";
+import isInteractive from "./is-interactive";
+import { logger } from "./logger";
+
+// TODO: Use this function across the codebase.
+function isNonInteractiveOrCI(): boolean {
+	return !isInteractive() || CI.isCI();
+}
+
+export class NoDefaultValueProvided extends Error {
+	constructor() {
+		// This is user-facing, so make the message something understandable
+		// It _should_ always be caught and replaced with a more descriptive error
+		// but this is fine as a fallback.
+		super("This command cannot be run in a non-interactive context");
+		Object.setPrototypeOf(this, new.target.prototype);
+	}
+}
+
+interface ConfirmOptions {
+	defaultValue?: boolean;
+}
+
+export async function confirm(
+	text: string,
+	{ defaultValue = true }: ConfirmOptions = {}
+): Promise<boolean> {
+	if (isNonInteractiveOrCI()) {
+		logger.log(`? ${text}`);
+		logger.log(
+			`🤖 ${chalk.dim(
+				"Using default value in non-interactive context:"
+			)} ${chalk.white.bold(defaultValue ? "yes" : "no")}`
+		);
+		return defaultValue;
+	}
+	const { value } = await prompts({
+		type: "confirm",
+		name: "value",
+		message: text,
+		initial: defaultValue,
+		onState: (state) => {
+			if (state.aborted) {
+				process.nextTick(() => {
+					process.exit(1);
+				});
+			}
+		},
+	});
+	return value;
+}
+
+interface PromptOptions {
+	defaultValue?: string;
+	isSecret?: boolean;
+}
+
+export async function prompt(
+	text: string,
+	options: PromptOptions = {}
+): Promise<string> {
+	if (isNonInteractiveOrCI()) {
+		if (options?.defaultValue === undefined) {
+			throw new NoDefaultValueProvided();
+		}
+		logger.log(`? ${text}`);
+		logger.log(
+			`🤖 ${chalk.dim(
+				"Using default value in non-interactive context:"
+			)} ${chalk.white.bold(options.defaultValue)}`
+		);
+		return options.defaultValue;
+	}
+	const { value } = await prompts({
+		type: "text",
+		name: "value",
+		message: text,
+		initial: options?.defaultValue,
+		style: options?.isSecret ? "password" : "default",
+		onState: (state) => {
+			if (state.aborted) {
+				process.nextTick(() => {
+					process.exit(1);
+				});
+			}
+		},
+	});
+	return value;
+}
+
+interface SelectOptions<Values> {
+	choices: SelectOption<Values>[];
+	defaultOption?: number;
+}
+
+interface SelectOption<Values> {
+	title: string;
+	description?: string;
+	value: Values;
+}
+
+export async function select<Values extends string>(
+	text: string,
+	options: SelectOptions<Values>
+): Promise<Values> {
+	if (isNonInteractiveOrCI()) {
+		if (options?.defaultOption === undefined) {
+			throw new NoDefaultValueProvided();
+		}
+		logger.log(`? ${text}`);
+		logger.log(
+			`🤖 ${chalk.dim(
+				"Using default value in non-interactive context:"
+			)} ${chalk.white.bold(options.choices[options.defaultOption].title)}`
+		);
+		return options.choices[options.defaultOption].value;
+	}
+
+	const { value } = await prompts({
+		type: "select",
+		name: "value",
+		message: text,
+		choices: options.choices,
+		initial: options.defaultOption,
+		onState: (state) => {
+			if (state.aborted) {
+				process.nextTick(() => {
+					process.exit(1);
+				});
+			}
+		},
+	});
+	return value;
+}

package/src/dispatch-namespace.ts

@@ -4,9 +4,8 @@ import { logger } from "./logger";
 import * as metrics from "./metrics";
 import { requireAuth } from "./user";
 import { printWranglerBanner } from ".";
-import type { ConfigPath } from ".";
-import type { CommonYargsOptions } from "./yargs-types";
-import type { Argv, CommandModule } from "yargs";
+import type { CommonYargsArgv, CommonYargsOptions } from "./yargs-types";
+import type { CommandModule } from "yargs";
 
 type Namespace = {
 	namespace_id: string;
@@ -90,7 +89,7 @@ async function renameWorkerNamespace(
 	oldName: string,
 	newName: string
 ) {
-	printWranglerBanner();
+	void printWranglerBanner();
 
 	await fetchResult(
 		`/accounts/${accountId}/workers/dispatch/namespaces/${oldName}`,
@@ -106,19 +105,24 @@ async function renameWorkerNamespace(
 }
 
 export function workerNamespaceCommands(
-	workerNamespaceYargs: Argv<CommonYargsOptions>,
+	workerNamespaceYargs: CommonYargsArgv,
 	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
 ) {
 	return workerNamespaceYargs
 		.command(subHelp)
-		.command("list", "List all dispatch namespaces", {}, async (args) => {
-			const config = readConfig(args.config as ConfigPath, args);
-			const accountId = await requireAuth(config);
-			await listWorkerNamespaces(accountId);
-			await metrics.sendMetricsEvent("list dispatch namespaces", {
-				sendMetrics: config.send_metrics,
-			});
-		})
+		.command(
+			"list",
+			"List all dispatch namespaces",
+			(args) => args,
+			async (args) => {
+				const config = readConfig(args.config, args);
+				const accountId = await requireAuth(config);
+				await listWorkerNamespaces(accountId);
+				await metrics.sendMetricsEvent("list dispatch namespaces", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		)
 		.command(
 			"get <name>",
 			"Get information about a dispatch namespace",
@@ -130,7 +134,7 @@ export function workerNamespaceCommands(
 				});
 			},
 			async (args) => {
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await getWorkerNamespaceInfo(accountId, args.name);
 				await metrics.sendMetricsEvent("view dispatch namespace", {
@@ -150,7 +154,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await createWorkerNamespace(accountId, args.name);
 				await metrics.sendMetricsEvent("create dispatch namespace", {
@@ -170,7 +174,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await deleteWorkerNamespace(accountId, args.name);
 				await metrics.sendMetricsEvent("delete dispatch namespace", {
@@ -196,7 +200,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await renameWorkerNamespace(accountId, args.oldName, args.newName);
 				await metrics.sendMetricsEvent("rename dispatch namespace", {

package/src/docs/index.ts

@@ -0,0 +1,97 @@
+import { printWranglerBanner } from "..";
+import { readConfig } from "../config";
+import { logger } from "../logger";
+import * as metrics from "../metrics";
+import openInBrowser from "../open-in-browser";
+
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
+
+const argToUrlHash = {
+	d1: "d1",
+	docs: "docs",
+	init: "init",
+	generate: "generate",
+	dev: "dev",
+	publish: "publish",
+	delete: "delete",
+	"kv:namespace": "kvnamespace",
+	"kv:key": "kvkey",
+	"kv:bulk": "kvbulk",
+	"r2 bucket": "r2-bucket",
+	"r2 object": "r2-object",
+	secret: "secret",
+	"secret:bulk": "secretbulk",
+	tail: "tail",
+	pages: "pages",
+	login: "login",
+	logout: "logout",
+	whoami: "whoami",
+	types: "types",
+	deployments: "deployments",
+};
+
+export function docsOptions(yargs: CommonYargsArgv) {
+	return yargs.positional("command", {
+		describe: "Enter the wrangler command you want to know more about",
+		type: "string",
+		// requiresArg: true,
+		choices: [
+			"docs",
+			"init",
+			"generate",
+			"dev",
+			"publish",
+			"delete",
+			"tail",
+			"secret",
+			"secret:bulk",
+			"kv:namespace",
+			"kv:key",
+			"kv:bulk",
+			"pages",
+			// "queues", //TODO: Undocumented
+			"r2 object",
+			"r2 bucket",
+			// "dispatch-namespace", // TODO: Undocumented - Workers for Platforms
+			"d1",
+			// "pubsub", //TODO: Undocumented
+			"login",
+			"logout",
+			"whoami",
+			"types",
+			"deployments",
+			"api",
+		],
+	});
+}
+
+function isValidParam(k: string): k is keyof typeof argToUrlHash {
+	return k in argToUrlHash;
+}
+
+export async function docsHandler(
+	args: StrictYargsOptionsToInterface<typeof docsOptions>
+) {
+	let urlToOpen =
+		"https://developers.cloudflare.com/workers/wrangler/commands/";
+
+	if (args.command === "api") {
+		//if api, take them to the API docs
+		urlToOpen = "https://developers.cloudflare.com/workers/wrangler/api/";
+	} else if (args.command && isValidParam(args.command)) {
+		//otherwise, they get the wrangler commands page
+		urlToOpen += `#${argToUrlHash[args.command]}`;
+	}
+
+	await printWranglerBanner();
+
+	logger.log(`Opening a link in your default browser: ${urlToOpen}`);
+	await openInBrowser(urlToOpen);
+	const config = readConfig(undefined, args);
+	await metrics.sendMetricsEvent("view docs", {
+		sendMetrics: config.send_metrics,
+	});
+}

package/src/entry.ts

@@ -3,9 +3,11 @@ import { existsSync, statSync } from "node:fs";
 import path from "node:path";
 import * as esbuild from "esbuild";
 import { execaCommand } from "execa";
+import { COMMON_ESBUILD_OPTIONS } from "./bundle";
 import { logger } from "./logger";
 import { getBasePath } from "./paths";
 import type { Config } from "./config";
+import type { DurableObjectBindings } from "./config/environment";
 import type { CfScriptFormat } from "./worker";
 import type { Metafile } from "esbuild";
 
@@ -14,7 +16,16 @@ import type { Metafile } from "esbuild";
  *
  * It consists not just of a `file`, but also of a `directory` that is used to resolve relative paths.
  */
-export type Entry = { file: string; directory: string; format: CfScriptFormat };
+export type Entry = {
+	/** A worker's entrypoint */
+	file: string;
+	/** A worker's directory. Usually where the wrangler.toml file is located */
+	directory: string;
+	/** Is this a module worker or a service worker? */
+	format: CfScriptFormat;
+	/** The directory that contains all of a `--no-bundle` worker's modules. Usually `${directory}/src`. Defaults to path.dirname(file) */
+	moduleRoot: string;
+};
 
 /**
  * Compute the entry-point for the Worker.
@@ -98,7 +109,12 @@ export async function getEntry(
 		);
 	}
 
-	return { file, directory, format };
+	return {
+		file,
+		directory,
+		format,
+		moduleRoot: config.base_dir ?? path.dirname(file),
+	};
 }
 
 export async function runCustomBuild(
@@ -146,18 +162,12 @@ export default async function guessWorkerFormat(
 	tsconfig?: string | undefined
 ): Promise<CfScriptFormat> {
 	const result = await esbuild.build({
+		...COMMON_ESBUILD_OPTIONS,
 		entryPoints: [entryFile],
 		absWorkingDir: entryWorkingDirectory,
 		metafile: true,
 		bundle: false,
-		format: "esm",
-		target: "es2020",
 		write: false,
-		loader: {
-			".js": "jsx",
-			".mjs": "jsx",
-			".cjs": "jsx",
-		},
 		...(tsconfig && { tsconfig }),
 	});
 	// result.metafile is defined because of the `metafile: true` option above.
@@ -236,8 +246,6 @@ export function fileExists(filePath: string): boolean {
 	return false;
 }
 
-type DurableObjectBindings = Config["durable_objects"]["bindings"];
-
 /**
  * Groups the durable object bindings into two lists:
  * those that are defined locally and those that refer to a durable object defined in another script.

package/src/environment-variables/factory.ts

@@ -0,0 +1,88 @@
+import { logger } from "../logger";
+
+type VariableNames =
+	| "CLOUDFLARE_ACCOUNT_ID"
+	| "CLOUDFLARE_API_TOKEN"
+	| "CLOUDFLARE_API_KEY"
+	| "CLOUDFLARE_EMAIL"
+	| "WRANGLER_SEND_METRICS"
+	| "CLOUDFLARE_API_BASE_URL"
+	| "WRANGLER_LOG"
+	| "WRANGLER_API_ENVIRONMENT"
+	| "WRANGLER_CLIENT_ID"
+	| "WRANGLER_AUTH_DOMAIN"
+	| "WRANGLER_AUTH_URL"
+	| "WRANGLER_TOKEN_URL"
+	| "WRANGLER_REVOKE_URL"
+	| "WRANGLER_CF_AUTHORIZATION_TOKEN";
+
+type DeprecatedNames =
+	| "CF_ACCOUNT_ID"
+	| "CF_API_TOKEN"
+	| "CF_API_KEY"
+	| "CF_EMAIL"
+	| "CF_API_BASE_URL";
+
+/**
+ * Create a function used to access an environment variable.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ * A warning is shown if the client is using a deprecated version - but only once.
+ */
+export function getEnvironmentVariableFactory({
+	variableName,
+	deprecatedName,
+}: {
+	variableName: VariableNames;
+	deprecatedName?: DeprecatedNames;
+}): () => string | undefined;
+
+/**
+ * Create a function used to access an environment variable, with a default value.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ * A warning is shown if the client is using a deprecated version - but only once.
+ */
+export function getEnvironmentVariableFactory({
+	variableName,
+	deprecatedName,
+	defaultValue,
+}: {
+	variableName: VariableNames;
+	deprecatedName?: DeprecatedNames;
+	defaultValue: () => string;
+}): () => string;
+
+/**
+ * Create a function used to access an environment variable.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ * A warning is shown if the client is using a deprecated version - but only once.
+ */
+export function getEnvironmentVariableFactory({
+	variableName,
+	deprecatedName,
+	defaultValue,
+}: {
+	variableName: VariableNames;
+	deprecatedName?: DeprecatedNames;
+	defaultValue?: () => string;
+}): () => string | undefined {
+	let hasWarned = false;
+	return () => {
+		if (process.env[variableName]) {
+			return process.env[variableName];
+		} else if (deprecatedName && process.env[deprecatedName]) {
+			if (!hasWarned) {
+				// Only show the warning once.
+				hasWarned = true;
+				logger.warn(
+					`Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
+				);
+			}
+			return process.env[deprecatedName];
+		} else {
+			return defaultValue?.();
+		}
+	};
+}

package/src/environment-variables/misc-variables.ts

@@ -0,0 +1,30 @@
+import { getEnvironmentVariableFactory } from "./factory";
+
+/**
+ * `WRANGLER_SEND_METRICS` can override whether we attempt to send metrics information to Sparrow.
+ */
+export const getWranglerSendMetricsFromEnv = getEnvironmentVariableFactory({
+	variableName: "WRANGLER_SEND_METRICS",
+});
+
+/**
+ * Set `WRANGLER_API_ENVIRONMENT` environment variable to "staging" to tell Wrangler to hit the staging APIs rather than production.
+ */
+export const getCloudflareApiEnvironmentFromEnv = getEnvironmentVariableFactory(
+	{
+		variableName: "WRANGLER_API_ENVIRONMENT",
+		defaultValue: () => "production",
+	}
+);
+
+/**
+ * `CLOUDFLARE_API_BASE_URL` specifies the URL to the Cloudflare API.
+ */
+export const getCloudflareApiBaseUrl = getEnvironmentVariableFactory({
+	variableName: "CLOUDFLARE_API_BASE_URL",
+	deprecatedName: "CF_API_BASE_URL",
+	defaultValue: () =>
+		getCloudflareApiEnvironmentFromEnv() === "staging"
+			? "https://api.staging.cloudflare.com/client/v4"
+			: "https://api.cloudflare.com/client/v4",
+});