wrangler 2.4.4 → 2.6.0

package/src/__tests__/user.test.ts

@@ -1,18 +1,19 @@
-import fs from "node:fs";
-import path from "node:path";
-import fetchMock from "jest-fetch-mock";
-import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
+import { rest } from "msw";
 import { CI } from "../is-ci";
 import {
 	loginOrRefreshIfRequired,
 	readAuthConfigFile,
 	requireAuth,
-	USER_AUTH_CONFIG_FILE,
 	writeAuthConfigFile,
 } from "../user";
 import { mockConsoleMethods } from "./helpers/mock-console";
 import { useMockIsTTY } from "./helpers/mock-istty";
 import { mockOAuthFlow } from "./helpers/mock-oauth-flow";
+import {
+	msw,
+	mswSuccessOauthHandlers,
+	mswSuccessUserHandlers,
+} from "./helpers/msw";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import { runWrangler } from "./helpers/run-wrangler";
 import type { Config } from "../config";
@@ -22,41 +23,44 @@ describe("User", () => {
 	let isCISpy: jest.SpyInstance;
 	runInTempDir();
 	const std = mockConsoleMethods();
-	const {
-		mockOAuthServerCallback,
-		mockGrantAccessToken,
-		mockGrantAuthorization,
-		mockRevokeAuthorization,
-		mockExchangeRefreshTokenForAccessToken,
-	} = mockOAuthFlow();
-
+	// TODO: Implement these two mocks with MSW
+	const { mockOAuthServerCallback } = mockOAuthFlow();
 	const { setIsTTY } = useMockIsTTY();
 
 	beforeEach(() => {
+		msw.use(...mswSuccessOauthHandlers, ...mswSuccessUserHandlers);
 		isCISpy = jest.spyOn(CI, "isCI").mockReturnValue(false);
 	});
 
 	describe("login", () => {
 		it("should login a user when `wrangler login` is run", async () => {
-			mockOAuthServerCallback();
-			const accessTokenRequest = mockGrantAccessToken({ respondWith: "ok" });
-			mockGrantAuthorization({ respondWith: "success" });
+			mockOAuthServerCallback("success");
+
+			let counter = 0;
+			msw.use(
+				rest.post("*/oauth2/token", async (_, response, context) => {
+					counter += 1;
+
+					return response.once(
+						context.status(200),
+						context.json({
+							access_token: "test-access-token",
+							expires_in: 100000,
+							refresh_token: "test-refresh-token",
+							scope: "account:read",
+						})
+					);
+				})
+			);
 
 			await runWrangler("login");
 
-			expect(accessTokenRequest.actual.url).toEqual(
-				accessTokenRequest.expected.url
-			);
-			expect(accessTokenRequest.actual.method).toEqual(
-				accessTokenRequest.expected.method
-			);
-
+			expect(counter).toBe(1);
 			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%20d1%3Awrite%20pages%3Awrite%20zone%3Aread%20offline_access&state=MOCK_STATE_PARAM&code_challenge=MOCK_CODE_CHALLENGE&code_challenge_method=S256
 			Successfully logged in."
 		`);
-
 			expect(readAuthConfigFile()).toEqual<UserAuthConfig>({
 				api_token: undefined,
 				oauth_token: "test-access-token",
@@ -67,50 +71,25 @@ describe("User", () => {
 		});
 	});
 
-	describe("logout", () => {
-		it("should exit with a message stating the user is not logged in", async () => {
-			await runWrangler("logout");
-			expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
-		});
-
-		it("should logout user that has been properly logged in", async () => {
-			writeAuthConfigFile({
-				oauth_token: "some-oauth-tok",
-				refresh_token: "some-refresh-tok",
-			});
-			const outcome = mockRevokeAuthorization();
-
-			await runWrangler("logout");
-
-			expect(outcome.actual.url).toEqual(
-				"https://dash.cloudflare.com/oauth2/revoke"
-			);
-			expect(outcome.actual.method).toEqual("POST");
-
-			expect(std.out).toMatchInlineSnapshot(`"Successfully logged out."`);
-
-			// Make sure that we made the request to logout.
-			expect(fetchMock).toHaveBeenCalledTimes(1);
-
-			// Make sure that logout removed the config file containing the auth tokens.
-			const config = path.join(
-				getGlobalWranglerConfigPath(),
-				USER_AUTH_CONFIG_FILE
-			);
-			expect(fs.existsSync(config)).toBeFalsy();
-		});
-	});
-
-	// TODO: Improve OAuth mocking to handle `/token` endpoints from different calls
-	it("should handle errors for failed token refresh", async () => {
+	it("should handle errors for failed token refresh in a non-interactive environment", async () => {
 		setIsTTY(false);
 		writeAuthConfigFile({
 			oauth_token: "hunter2",
 			refresh_token: "Order 66",
 		});
-		mockExchangeRefreshTokenForAccessToken({
-			respondWith: "badResponse",
-		});
+		// TODO: Use MSW to handle `/token` endpoints from different calls
+		let counter = 0;
+		msw.use(
+			rest.post("*/oauth2/token", async (request, response, context) => {
+				counter += 1;
+				return response.once(
+					context.status(400),
+					context.body(
+						`<html> <body> This shouldn't be sent, but should be handled </body> </html>`
+					)
+				);
+			})
+		);
 
 		// Handles the requireAuth error throw from failed login that is unhandled due to directly calling it here
 		await expect(
@@ -118,20 +97,15 @@ describe("User", () => {
 		).rejects.toThrowErrorMatchingInlineSnapshot(
 			`"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."`
 		);
+		expect(counter).toBe(0);
 	});
 
 	it("should confirm no error message when refresh is successful", async () => {
 		setIsTTY(false);
-		mockOAuthServerCallback();
 		writeAuthConfigFile({
 			oauth_token: "hunter2",
 			refresh_token: "Order 66",
 		});
-		mockGrantAuthorization({ respondWith: "success" });
-
-		mockExchangeRefreshTokenForAccessToken({
-			respondWith: "refreshSuccess",
-		});
 
 		// Handles the requireAuth error throw from failed login that is unhandled due to directly calling it here
 		await expect(requireAuth({} as Config)).rejects.toThrowError();

package/src/config/environment.ts

@@ -439,6 +439,22 @@ interface EnvironmentNonInheritable {
 		  }[]
 		| undefined;
 
+	/**
+	 * Specifies analytics engine datasets that are bound to this Worker environment.
+	 *
+	 * NOTE: This field is not automatically inherited from the top level environment,
+	 * and so must be specified in every named environment.
+	 *
+	 * @default `[]`
+	 * @nonInheritable
+	 */
+	analytics_engine_datasets: {
+		/** The binding name used to refer to the dataset in the worker. */
+		binding: string;
+		/** The name of this dataset to write to. */
+		dataset?: string;
+	}[];
+
 	/**
 	 * "Unsafe" tables for features that aren't directly supported by wrangler.
 	 *

package/src/config/index.ts

@@ -93,6 +93,7 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		r2_buckets,
 		logfwdr,
 		services,
+		analytics_engine_datasets,
 		text_blobs,
 		unsafe,
 		vars,
@@ -159,14 +160,21 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 	if (d1_databases !== undefined && d1_databases.length > 0) {
 		output.push({
 			type: "D1 Databases",
-			entries: d1_databases.map(({ binding, database_name, database_id }) => {
-				return {
-					key: removeD1BetaPrefix(binding),
-					value: database_name
-						? `${database_name} (${database_id})`
-						: database_id,
-				};
-			}),
+			entries: d1_databases.map(
+				({ binding, database_name, database_id, preview_database_id }) => {
+					let databaseValue = `${database_id}`;
+					if (database_name) {
+						databaseValue = `${database_name} (${database_id})`;
+					}
+					if (preview_database_id) {
+						databaseValue += `, Preview: (${preview_database_id})`;
+					}
+					return {
+						key: removeD1BetaPrefix(binding),
+						value: databaseValue,
+					};
+				}
+			),
 		});
 	}
 
@@ -211,6 +219,21 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
+	if (
+		analytics_engine_datasets !== undefined &&
+		analytics_engine_datasets.length > 0
+	) {
+		output.push({
+			type: "Analytics Engine Datasets",
+			entries: analytics_engine_datasets.map(({ binding, dataset }) => {
+				return {
+					key: binding,
+					value: dataset ?? binding,
+				};
+			}),
+		});
+	}
+
 	if (text_blobs !== undefined && Object.keys(text_blobs).length > 0) {
 		output.push({
 			type: "Text Blobs",

package/src/config/validation.ts

@@ -1115,6 +1115,16 @@ function normalizeAndValidateEnvironment(
 			validateBindingArray(envName, validateServiceBinding),
 			[]
 		),
+		analytics_engine_datasets: notInheritable(
+			diagnostics,
+			topLevelEnv,
+			rawConfig,
+			rawEnv,
+			envName,
+			"analytics_engine_datasets",
+			validateBindingArray(envName, validateAnalyticsEngineBinding),
+			[]
+		),
 		dispatch_namespaces: notInheritable(
 			diagnostics,
 			topLevelEnv,
@@ -1834,6 +1844,7 @@ const validateBindingsHaveUniqueNames = (
 		durable_objects,
 		kv_namespaces,
 		r2_buckets,
+		analytics_engine_datasets,
 		text_blobs,
 		unsafe,
 		vars,
@@ -1848,6 +1859,7 @@ const validateBindingsHaveUniqueNames = (
 		"Durable Object": getBindingNames(durable_objects),
 		"KV Namespace": getBindingNames(kv_namespaces),
 		"R2 Bucket": getBindingNames(r2_buckets),
+		"Analytics Engine Dataset": getBindingNames(analytics_engine_datasets),
 		"Text Blob": getBindingNames(text_blobs),
 		Unsafe: getBindingNames(unsafe),
 		"Environment Variable": getBindingNames(vars),
@@ -1956,6 +1968,43 @@ const validateServiceBinding: ValidatorFn = (diagnostics, field, value) => {
 	return isValid;
 };
 
+const validateAnalyticsEngineBinding: ValidatorFn = (
+	diagnostics,
+	field,
+	value
+) => {
+	if (typeof value !== "object" || value === null) {
+		diagnostics.errors.push(
+			`"analytics_engine" bindings should be objects, but got ${JSON.stringify(
+				value
+			)}`
+		);
+		return false;
+	}
+	let isValid = true;
+	// Service bindings must have a binding and optional dataset.
+	if (!isRequiredProperty(value, "binding", "string")) {
+		diagnostics.errors.push(
+			`"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
+				value
+			)}.`
+		);
+		isValid = false;
+	}
+	if (
+		!isOptionalProperty(value, "dataset", "string") ||
+		(value as { dataset: string }).dataset?.length === 0
+	) {
+		diagnostics.errors.push(
+			`"${field}" bindings should, optionally, have a string "dataset" field but got ${JSON.stringify(
+				value
+			)}.`
+		);
+		isValid = false;
+	}
+	return isValid;
+};
+
 const validateWorkerNamespaceBinding: ValidatorFn = (
 	diagnostics,
 	field,

package/src/create-worker-upload-form.ts

@@ -43,6 +43,7 @@ type WorkerMetadataBinding =
 	| { type: "r2_bucket"; name: string; bucket_name: string }
 	| { type: "d1"; name: string; id: string; internalEnv?: string }
 	| { type: "service"; name: string; service: string; environment?: string }
+	| { type: "analytics_engine"; name: string; dataset?: string }
 	| { type: "namespace"; name: string; namespace: string }
 	| {
 			type: "logfwdr";
@@ -149,6 +150,14 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		});
 	});
 
+	bindings.analytics_engine_datasets?.forEach(({ binding, dataset }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "analytics_engine",
+			dataset,
+		});
+	});
+
 	bindings.dispatch_namespaces?.forEach(({ binding, namespace }) => {
 		metadataBindings.push({
 			name: binding,

package/src/d1/backups.tsx

@@ -141,9 +141,9 @@ export const RestoreHandler = withConfig<BackupRestoreArgs>(
 			name
 		);
 
-		console.log(`Restoring ${name} from backup ${backupId}....`);
+		logger.log(`Restoring ${name} from backup ${backupId}....`);
 		await restoreBackup(accountId, db.uuid, backupId);
-		console.log(`Done!`);
+		logger.log(`Done!`);
 	}
 );
 
@@ -199,6 +199,11 @@ export const DownloadHandler = withConfig<BackupDownloadArgs>(
 
 		logger.log(`🌀 Downloading backup ${backupId} from '${name}'`);
 		const response = await getBackupResponse(accountId, db.uuid, backupId);
+		if (!response.ok) {
+			throw new Error(
+				`Failed to download backup ${backupId} from '${name}' - got ${response.status} from the API`
+			);
+		}
 		logger.log(`🌀 Saving to ${filename}`);
 		// TODO: stream this once we upgrade to Node18 and can use Writable.fromWeb
 		const buffer = await response.arrayBuffer();

package/src/d1/delete.tsx

@@ -36,21 +36,21 @@ export const Handler = withConfig<CreateArgs>(
 			name
 		);
 
-		console.log(`About to delete DB '${name}' (${db.uuid}).`);
+		logger.log(`About to delete DB '${name}' (${db.uuid}).`);
 		if (!skipConfirmation) {
 			const response = await confirm(`Ok to proceed?`);
 			if (!response) {
-				console.log(`Not deleting.`);
+				logger.log(`Not deleting.`);
 				return;
 			}
 		}
 
-		console.log("Deleting...");
+		logger.log("Deleting...");
 
 		await fetchResult(`/accounts/${accountId}/d1/database/${db.uuid}`, {
 			method: "DELETE",
 		});
 
-		console.log(`Deleted '${name}' successfully.`);
+		logger.log(`Deleted '${name}' successfully.`);
 	}
 );

package/src/d1/index.ts

@@ -26,6 +26,7 @@ export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 			)
 			.command("backup", "Interact with D1 Backups", (yargs2) =>
 				yargs2
+					.demandCommand()
 					.command(
 						"list <name>",
 						"List your D1 backups",
@@ -74,6 +75,7 @@ export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 			)
 			.command("migrations", "Interact with D1 Migrations", (yargs2) =>
 				yargs2
+					.demandCommand()
 					.command(
 						"list <database>",
 						"List your D1 migrations",

package/src/d1/migrations/apply.tsx

@@ -5,23 +5,25 @@ import Table from "ink-table";
 import React from "react";
 import { withConfig } from "../../config";
 import { confirm } from "../../dialogs";
+import { CI } from "../../is-ci";
+import isInteractive from "../../is-interactive";
 import { logger } from "../../logger";
 import { requireAuth } from "../../user";
 import { createBackup } from "../backups";
 import { executeSql } from "../execute";
-import { Database } from "../options";
 import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
 import {
 	getMigrationsPath,
 	getUnappliedMigrations,
 	initMigrationsTable,
 } from "./helpers";
+import { DatabaseWithLocal } from "./options";
 import type { ParseError } from "../../parse";
 import type { BaseSqlExecuteArgs } from "../execute";
 import type { Argv } from "yargs";
 
 export function ApplyOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
-	return Database(yargs);
+	return DatabaseWithLocal(yargs);
 }
 
 export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
@@ -88,8 +90,7 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
 			return;
 		}
 
-		const isInteractive = process.stdout.isTTY;
-		if (isInteractive) {
+		if (isInteractive() && !CI.isCI()) {
 			const ok = await confirm(
 				`About to apply ${unappliedMigrations.length} migration(s)\n` +
 					"Your database may not be available to serve requests during the migration, continue?",
@@ -121,7 +122,7 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
 					local,
 					config,
 					database,
-					undefined,
+					isInteractive() && !CI.isCI(),
 					persistTo,
 					undefined,
 					query

package/src/d1/migrations/helpers.ts

@@ -1,6 +1,8 @@
 import fs from "node:fs";
 import path from "path";
 import { confirm } from "../../dialogs";
+import { CI } from "../../is-ci";
+import isInteractive from "../../is-interactive";
 import { logger } from "../../logger";
 import { DEFAULT_MIGRATION_PATH } from "../constants";
 import { executeSql } from "../execute";
@@ -79,7 +81,7 @@ const listAppliedMigrations = async (
 		local,
 		config,
 		name,
-		undefined,
+		isInteractive() && !CI.isCI(),
 		persistTo,
 		undefined,
 		Query
@@ -130,7 +132,7 @@ export const initMigrationsTable = async (
 		local,
 		config,
 		name,
-		undefined,
+		isInteractive() && !CI.isCI(),
 		persistTo,
 		undefined,
 		`

package/src/d1/migrations/list.tsx

@@ -5,18 +5,18 @@ import React from "react";
 import { withConfig } from "../../config";
 import { logger } from "../../logger";
 import { requireAuth } from "../../user";
-import { Database } from "../options";
 import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
 import {
 	getMigrationsPath,
 	getUnappliedMigrations,
 	initMigrationsTable,
 } from "./helpers";
+import { DatabaseWithLocal } from "./options";
 import type { BaseSqlExecuteArgs } from "../execute";
 import type { Argv } from "yargs";
 
 export function ListOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
-	return Database(yargs);
+	return DatabaseWithLocal(yargs);
 }
 
 export const ListHandler = withConfig<BaseSqlExecuteArgs>(

package/src/d1/migrations/options.ts

@@ -0,0 +1,18 @@
+import { Database } from "../options";
+import type { Argv } from "yargs";
+
+export function DatabaseWithLocal(yargs: Argv) {
+	return Database(yargs)
+		.option("local", {
+			describe:
+				"Execute commands/files against a local DB for use with wrangler dev --local",
+			type: "boolean",
+		})
+		.option("persist-to", {
+			describe:
+				"Specify directory to use for local persistence (you must use --local with this flag)",
+			type: "string",
+			requiresArg: true,
+		})
+		.implies("persist-to", "local");
+}

package/src/dev/dev.tsx

@@ -113,8 +113,8 @@ export type DevProps = {
 	name: string | undefined;
 	noBundle: boolean;
 	entry: Entry;
-	port: number;
-	ip: string;
+	initialPort: number;
+	initialIp: string;
 	inspectorPort: number;
 	rules: Config["rules"];
 	accountId: string | undefined;
@@ -171,25 +171,42 @@ export function DevImplementation(props: DevProps): JSX.Element {
 	);
 }
 
+// This is a nasty hack to allow `useHotkeys` and its "[b] open a browser" feature to read these values
+// without triggering a re-render loop when `onReady()` updates them.
+// The initially requested port can be different than what's actually used, if, for example, you request port 0.
+let ip: string;
+let port: number;
+
 function InteractiveDevSession(props: DevProps) {
 	const toggles = useHotkeys({
 		initial: {
 			local: props.initialMode === "local",
 			tunnel: false,
 		},
-		port: props.port,
-		ip: props.ip,
 		inspectorPort: props.inspectorPort,
 		inspect: props.inspect,
 		localProtocol: props.localProtocol,
 		forceLocal: props.forceLocal,
 	});
 
+	ip = props.initialIp;
+	port = props.initialPort;
+
 	useTunnel(toggles.tunnel);
 
+	const onReady = (newIp: string, newPort: number) => {
+		if (newIp !== props.initialIp || newPort !== props.initialPort) {
+			ip = newIp;
+			port = newPort;
+			if (props.onReady) {
+				props.onReady(newIp, newPort);
+			}
+		}
+	};
+
 	return (
 		<>
-			<DevSession {...props} local={toggles.local} />
+			<DevSession {...props} local={toggles.local} onReady={onReady} />
 			<Box borderStyle="round" paddingLeft={1} paddingRight={1}>
 				<Text bold={true}>[b]</Text>
 				<Text> open a browser, </Text>
@@ -301,6 +318,22 @@ function DevSession(props: DevSessionProps) {
 		);
 	}
 
+	const announceAndOnReady: typeof props.onReady = (finalIp, finalPort) => {
+		if (process.send) {
+			process.send(
+				JSON.stringify({
+					event: "DEV_SERVER_READY",
+					ip: finalIp,
+					port: finalPort,
+				})
+			);
+		}
+
+		if (props.onReady) {
+			props.onReady(finalIp, finalPort);
+		}
+	};
+
 	return props.local ? (
 		<Local
 			name={props.name}
@@ -312,8 +345,8 @@ function DevSession(props: DevSessionProps) {
 			bindings={props.bindings}
 			workerDefinitions={workerDefinitions}
 			assetPaths={props.assetPaths}
-			port={props.port}
-			ip={props.ip}
+			initialPort={props.initialPort}
+			initialIp={props.initialIp}
 			rules={props.rules}
 			inspectorPort={props.inspectorPort}
 			localPersistencePath={props.localPersistencePath}
@@ -324,7 +357,7 @@ function DevSession(props: DevSessionProps) {
 			localUpstream={props.localUpstream}
 			logPrefix={props.logPrefix}
 			inspect={props.inspect}
-			onReady={props.onReady}
+			onReady={announceAndOnReady}
 			enablePagesAssetsServiceBinding={props.enablePagesAssetsServiceBinding}
 			experimentalLocal={props.experimentalLocal}
 			accountId={props.accountId}
@@ -339,8 +372,8 @@ function DevSession(props: DevSessionProps) {
 			bindings={props.bindings}
 			assetPaths={props.assetPaths}
 			isWorkersSite={props.isWorkersSite}
-			port={props.port}
-			ip={props.ip}
+			port={props.initialPort}
+			ip={props.initialIp}
 			localProtocol={props.localProtocol}
 			inspectorPort={props.inspectorPort}
 			// TODO: @threepointone #1167
@@ -354,7 +387,7 @@ function DevSession(props: DevSessionProps) {
 			zone={props.zone}
 			host={props.host}
 			routes={props.routes}
-			onReady={props.onReady}
+			onReady={announceAndOnReady}
 			sourceMapPath={bundle?.sourceMapPath}
 			sendMetrics={props.sendMetrics}
 		/>
@@ -503,25 +536,16 @@ type useHotkeysInitialState = {
 };
 function useHotkeys(props: {
 	initial: useHotkeysInitialState;
-	port: number;
-	ip: string;
 	inspectorPort: number;
 	inspect: boolean;
 	localProtocol: "http" | "https";
 	forceLocal: boolean | undefined;
 }) {
-	const {
-		initial,
-		port,
-		ip,
-		inspectorPort,
-		inspect,
-		localProtocol,
-		forceLocal,
-	} = props;
+	const { initial, inspectorPort, inspect, localProtocol, forceLocal } = props;
 	// UGH, we should put port in context instead
 	const [toggles, setToggles] = useState(initial);
 	const { exit } = useApp();
+
 	useInput(
 		async (
 			input,