wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

package/src/dialogs.tsx

@@ -4,7 +4,11 @@ import SelectInput from "ink-select-input";
 import TextInput from "ink-text-input";
 import * as React from "react";
 import { useState } from "react";
+
+import { CI } from "./is-ci";
+import isInteractive from "./is-interactive";
 import { logger } from "./logger";
+
 type ConfirmProps = {
 	text: string;
 	onConfirm: (answer: boolean) => void;
@@ -28,16 +32,22 @@ function Confirm(props: ConfirmProps) {
 	);
 }
 
-export function confirm(text: string): Promise<boolean> {
+export function confirm(
+	text: string,
+	beforeConfirm?: JSX.Element
+): Promise<boolean> {
 	return new Promise((resolve) => {
 		const { unmount } = render(
-			<Confirm
-				text={text}
-				onConfirm={(answer: boolean) => {
-					unmount();
-					resolve(answer);
-				}}
-			/>
+			<Box flexDirection="column">
+				{beforeConfirm}
+				<Confirm
+					text={text}
+					onConfirm={(answer: boolean) => {
+						unmount();
+						resolve(answer);
+					}}
+				/>
+			</Box>
 		);
 	});
 }
@@ -133,3 +143,26 @@ export function select(
 		);
 	});
 }
+
+export function logDim(msg: string) {
+	console.log(chalk.gray(msg));
+}
+
+export async function fromDashMessagePrompt(
+	deploySource: "dash" | "wrangler" | "api"
+): Promise<boolean | void> {
+	if (deploySource === "dash") {
+		logger.warn(
+			`You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.\nEdits that have been made via the dashboard will be overridden by your local code and config.`
+		);
+
+		if (!isInteractive() || CI.isCI()) return true;
+
+		return await confirm("Would you like to continue?");
+	}
+}
+export async function tailDOLogPrompt(): Promise<boolean | void> {
+	if (!isInteractive() || CI.isCI()) return true;
+
+	return await confirm("Would you like to continue?");
+}

package/src/{worker-namespace.ts → dispatch-namespace.ts}

@@ -5,6 +5,7 @@ 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";
 
 type Namespace = {
@@ -34,7 +35,7 @@ async function createWorkerNamespace(accountId: string, name: string) {
 		}
 	);
 	logger.log(
-		`Created Worker namespace "${name}" with ID "${namespace.namespace_id}"`
+		`Created dispatch namespace "${name}" with ID "${namespace.namespace_id}"`
 	);
 }
 
@@ -46,7 +47,7 @@ async function deleteWorkerNamespace(accountId: string, name: string) {
 		`/accounts/${accountId}/workers/dispatch/namespaces/${name}`,
 		{ method: "DELETE" }
 	);
-	logger.log(`Deleted Worker namespace "${name}"`);
+	logger.log(`Deleted dispatch namespace "${name}"`);
 }
 
 /**
@@ -89,7 +90,7 @@ async function renameWorkerNamespace(
 	oldName: string,
 	newName: string
 ) {
-	printWranglerBanner();
+	void printWranglerBanner();
 
 	await fetchResult(
 		`/accounts/${accountId}/workers/dispatch/namespaces/${oldName}`,
@@ -101,29 +102,29 @@ async function renameWorkerNamespace(
 			body: JSON.stringify({ name: newName }),
 		}
 	);
-	logger.log(`Renamed Worker namespace "${oldName}" to "${newName}"`);
+	logger.log(`Renamed dispatch namespace "${oldName}" to "${newName}"`);
 }
 
 export function workerNamespaceCommands(
-	workerNamespaceYargs: Argv,
-	subHelp: CommandModule
-): Argv {
+	workerNamespaceYargs: Argv<CommonYargsOptions>,
+	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
+) {
 	return workerNamespaceYargs
 		.command(subHelp)
-		.command("list", "List all Worker namespaces", {}, async (args) => {
+		.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 worker namespaces", {
+			await metrics.sendMetricsEvent("list dispatch namespaces", {
 				sendMetrics: config.send_metrics,
 			});
 		})
 		.command(
 			"get <name>",
-			"Get information about a Worker namespace",
+			"Get information about a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -132,17 +133,17 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await getWorkerNamespaceInfo(accountId, args.name);
-				await metrics.sendMetricsEvent("view worker namespace", {
+				await metrics.sendMetricsEvent("view dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"create <name>",
-			"Create a Worker namespace",
+			"Create a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -152,17 +153,17 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await createWorkerNamespace(accountId, args.name);
-				await metrics.sendMetricsEvent("create worker namespace", {
+				await metrics.sendMetricsEvent("create dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"delete <name>",
-			"Delete a Worker namespace",
+			"Delete a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -172,23 +173,23 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await deleteWorkerNamespace(accountId, args.name);
-				await metrics.sendMetricsEvent("delete worker namespace", {
+				await metrics.sendMetricsEvent("delete dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"rename <old-name> <new-name>",
-			"Rename a Worker namespace",
+			"Rename a dispatch namespace",
 			(yargs) => {
 				return yargs
 					.positional("old-name", {
-						describe: "Name of the Worker namespace",
+						describe: "Name of the dispatch namespace",
 						type: "string",
 						demandOption: true,
 					})
 					.positional("new-name", {
-						describe: "New name of the Worker namespace",
+						describe: "New name of the dispatch namespace",
 						type: "string",
 						demandOption: true,
 					});
@@ -198,7 +199,7 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await renameWorkerNamespace(accountId, args.oldName, args.newName);
-				await metrics.sendMetricsEvent("rename worker namespace", {
+				await metrics.sendMetricsEvent("rename dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}

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 {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "../yargs-types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+const argToUrlHash = {
+	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: Argv<CommonYargsOptions>) {
+	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", //TODO: Undocumented
+			// "pubsub", //TODO: Undocumented
+			"login",
+			"logout",
+			"whoami",
+			"types",
+			"deployments",
+			"api",
+		],
+	});
+}
+
+type DocsArgs = YargsOptionsToInterface<typeof docsOptions>;
+
+function isValidParam(k: string): k is keyof typeof argToUrlHash {
+	return k in argToUrlHash;
+}
+
+export async function docsHandler(args: ArgumentsCamelCase<DocsArgs>) {
+	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, {});
+	await metrics.sendMetricsEvent("view docs", {
+		sendMetrics: config.send_metrics,
+	});
+}

package/src/entry.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import * as esbuild from "esbuild";
 import { execaCommand } from "execa";
 import { logger } from "./logger";
+import { getBasePath } from "./paths";
 import type { Config } from "./config";
 import type { CfScriptFormat } from "./worker";
 import type { Metafile } from "esbuild";
@@ -25,7 +26,7 @@ export async function getEntry(
 		assets?: string | undefined;
 	},
 	config: Config,
-	command: "dev" | "publish"
+	command: "dev" | "publish" | "types"
 ): Promise<Entry> {
 	let file: string;
 	let directory = process.cwd();
@@ -40,7 +41,7 @@ export async function getEntry(
 				: // site.entry-point could be a directory
 				  path.resolve(config.site?.["entry-point"], "index.js");
 		} else if (args.assets || config.assets) {
-			file = path.resolve(__dirname, "../templates/no-op-worker.js");
+			file = path.resolve(getBasePath(), "templates/no-op-worker.js");
 		} else {
 			throw new Error(
 				`Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler ${command} path/to/script\`) or the \`main\` config field.`

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",
+});