wrangler 2.0.26 → 2.0.29

package/src/pages/functions/routes-transformation.test.ts

@@ -1,5 +1,9 @@
 import { toUrlPath } from "../../paths";
-import { MAX_FUNCTIONS_ROUTES_RULES, ROUTES_SPEC_VERSION } from "../constants";
+import {
+	MAX_FUNCTIONS_ROUTES_RULES,
+	ROUTES_SPEC_VERSION,
+	ROUTES_SPEC_DESCRIPTION,
+} from "../constants";
 import {
 	compareRoutes,
 	convertRoutesToGlobPatterns,
@@ -164,6 +168,7 @@ describe("route-paths-to-glob-patterns", () => {
 				])
 			).toEqual({
 				version: ROUTES_SPEC_VERSION,
+				description: ROUTES_SPEC_DESCRIPTION,
 				include: ["/middleware/*", "/foo/*", "/api/foo/bar"],
 				exclude: [],
 			});
@@ -176,6 +181,7 @@ describe("route-paths-to-glob-patterns", () => {
 			}
 			expect(convertRoutesToRoutesJSONSpec(routes)).toEqual({
 				version: ROUTES_SPEC_VERSION,
+				description: ROUTES_SPEC_DESCRIPTION,
 				include: ["/*"],
 				exclude: [],
 			});
@@ -197,6 +203,7 @@ describe("route-paths-to-glob-patterns", () => {
 			expect(
 				optimizeRoutesJSONSpec({
 					version: ROUTES_SPEC_VERSION,
+					description: ROUTES_SPEC_DESCRIPTION,
 					exclude: [],
 					include: [
 						"/api/foo/bar",
@@ -208,6 +215,7 @@ describe("route-paths-to-glob-patterns", () => {
 				})
 			).toEqual({
 				version: ROUTES_SPEC_VERSION,
+				description: ROUTES_SPEC_DESCRIPTION,
 				include: ["/middleware/*", "/foo/*", "/api/foo/bar"],
 				exclude: [],
 			});
@@ -221,11 +229,13 @@ describe("route-paths-to-glob-patterns", () => {
 			expect(
 				optimizeRoutesJSONSpec({
 					version: ROUTES_SPEC_VERSION,
+					description: ROUTES_SPEC_DESCRIPTION,
 					include,
 					exclude: [],
 				})
 			).toEqual({
 				version: ROUTES_SPEC_VERSION,
+				description: ROUTES_SPEC_DESCRIPTION,
 				include: ["/*"],
 				exclude: [],
 			});
@@ -239,6 +249,7 @@ describe("route-paths-to-glob-patterns", () => {
 			expect(
 				optimizeRoutesJSONSpec({
 					version: ROUTES_SPEC_VERSION,
+					description: ROUTES_SPEC_DESCRIPTION,
 					include,
 					exclude: [],
 				}).include.length

package/src/pages/functions/routes-transformation.ts

@@ -1,12 +1,17 @@
 import { join as pathJoin } from "node:path";
 import { toUrlPath } from "../../paths";
-import { MAX_FUNCTIONS_ROUTES_RULES, ROUTES_SPEC_VERSION } from "../constants";
+import {
+	MAX_FUNCTIONS_ROUTES_RULES,
+	ROUTES_SPEC_DESCRIPTION,
+	ROUTES_SPEC_VERSION,
+} from "../constants";
 import { consolidateRoutes } from "./routes-consolidation";
 import type { RouteConfig } from "./routes";
 
 /** Interface for _routes.json */
 interface RoutesJSONSpec {
 	version: typeof ROUTES_SPEC_VERSION;
+	description?: string;
 	include: string[];
 	exclude: string[];
 }
@@ -53,6 +58,7 @@ export function convertRoutesToRoutesJSONSpec(
 	const include = convertRoutesToGlobPatterns(reversedRoutes);
 	return optimizeRoutesJSONSpec({
 		version: ROUTES_SPEC_VERSION,
+		description: ROUTES_SPEC_DESCRIPTION,
 		include,
 		exclude: [],
 	});

package/src/pages/publish.tsx

@@ -15,12 +15,9 @@ import { logger } from "../logger";
 import * as metrics from "../metrics";
 import { requireAuth } from "../user";
 import { buildFunctions } from "./build";
-import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
+import { PAGES_CONFIG_CACHE_FILENAME, ROUTES_SPEC_VERSION } from "./constants";
 import { FunctionsNoRoutesError, getFunctionsNoRoutesWarning } from "./errors";
-import {
-	isRoutesJSONSpec,
-	optimizeRoutesJSONSpec,
-} from "./functions/routes-transformation";
+import { isRoutesJSONSpec } from "./functions/routes-transformation";
 import { listProjects } from "./projects";
 import { upload } from "./upload";
 import { pagesBetaWarning } from "./utils";
@@ -254,7 +251,10 @@ export const Handler = async ({
 
 	let builtFunctions: string | undefined = undefined;
 	const functionsDirectory = join(cwd(), "functions");
-	const routesOutputPath = join(tmpdir(), `_routes-${Math.random()}.json`);
+	const routesOutputPath = !existsSync(join(directory, "_routes.json"))
+		? join(tmpdir(), `_routes-${Math.random()}.json`)
+		: undefined;
+
 	if (existsSync(functionsDirectory)) {
 		const outfile = join(tmpdir(), `./functionsWorker-${Math.random()}.js`);
 		try {
@@ -265,6 +265,7 @@ export const Handler = async ({
 				buildOutputDirectory: dirname(outfile),
 				routesOutputPath,
 			});
+
 			builtFunctions = readFileSync(outfile, "utf-8");
 		} catch (e) {
 			if (e instanceof FunctionsNoRoutesError) {
@@ -301,7 +302,8 @@ export const Handler = async ({
 
 	let _headers: string | undefined,
 		_redirects: string | undefined,
-		_routes: string | undefined,
+		_routesGenerated: string | undefined,
+		_routesCustom: string | undefined,
 		_workerJS: string | undefined;
 
 	try {
@@ -312,6 +314,12 @@ export const Handler = async ({
 		_redirects = readFileSync(join(directory, "_redirects"), "utf-8");
 	} catch {}
 
+	try {
+		// Developers can specify a custom _routes.json file, for projects with Pages
+		// Functions or projects in Advanced Mode
+		_routesCustom = readFileSync(join(directory, "_routes.json"), "utf-8");
+	} catch {}
+
 	try {
 		_workerJS = readFileSync(join(directory, "_worker.js"), "utf-8");
 	} catch {}
@@ -327,47 +335,65 @@ export const Handler = async ({
 	}
 
 	if (builtFunctions) {
+		// with Pages Functions
+		// https://developers.cloudflare.com/pages/platform/functions/
 		formData.append("_worker.js", new File([builtFunctions], "_worker.js"));
 		logger.log(`✨ Uploading Functions`);
-		try {
-			_routes = readFileSync(routesOutputPath, "utf-8");
-			if (_routes) {
-				formData.append("_routes.json", new File([_routes], "_routes.json"));
+
+		if (_routesCustom) {
+			// user provided a custom _routes.json file
+			try {
+				validateRoutesFile(_routesCustom, join(directory, "_routes.json"));
+
+				formData.append(
+					"_routes.json",
+					new File([_routesCustom], "_routes.json")
+				);
+				logger.log(`✨ Uploading _routes.json`);
+				logger.warn(
+					`_routes.json is an experimental feature and is subject to change. Please use with care.`
+				);
+			} catch (err) {
+				if (err instanceof FatalError) {
+					throw err;
+				}
 			}
-		} catch {}
+		} else if (routesOutputPath) {
+			// no custom _routes.json file found, so fallback to the generated one
+			try {
+				_routesGenerated = readFileSync(routesOutputPath, "utf-8");
+
+				if (_routesGenerated) {
+					formData.append(
+						"_routes.json",
+						new File([_routesGenerated], "_routes.json")
+					);
+				}
+			} catch {}
+		}
 	} else if (_workerJS) {
 		// Advanced Mode
 		// https://developers.cloudflare.com/pages/platform/functions/#advanced-mode
 		formData.append("_worker.js", new File([_workerJS], "_worker.js"));
 		logger.log(`✨ Uploading _worker.js`);
 
-		try {
-			// In advanced mode, developers can specify a custom _routes.json
-			// file. In which case, we need to run it through optimization
-			// to potentially reduce the overall worker pipeline size
-			const routesPath = join(directory, "_routes.json");
-			const advancedModeRoutesString = readFileSync(routesPath, "utf-8");
-			const advancedModeRoutes = JSON.parse(advancedModeRoutesString);
-
-			if (!isRoutesJSONSpec(advancedModeRoutes)) {
-				throw new FatalError(
-					"Invalid _routes.json file found at:" + routesPath,
-					1
-				);
-			}
+		if (_routesCustom) {
+			// user provided a custom _routes.json file
+			try {
+				validateRoutesFile(_routesCustom, join(directory, "_routes.json"));
 
-			_routes = JSON.stringify(optimizeRoutesJSONSpec(advancedModeRoutes));
-			formData.append("_routes.json", new File([_routes], "_routes.json"));
-			logger.log(`✨ Uploading _routes.json`);
-
-			logger.warn(
-				`🚨 _routes.json is an experimental feature and is subject to change. Don't use unless you really must!`
-			);
-		} catch (e) {
-			// Ignore file not existing errors for _routes.json but forward the potential
-			// FatalError from an invalid spec
-			if (e instanceof FatalError) {
-				throw e;
+				formData.append(
+					"_routes.json",
+					new File([_routesCustom], "_routes.json")
+				);
+				logger.log(`✨ Uploading _routes.json`);
+				logger.warn(
+					`_routes.json is an experimental feature and is subject to change. Please use with care.`
+				);
+			} catch (err) {
+				if (err instanceof FatalError) {
+					throw err;
+				}
 			}
 		}
 	}
@@ -389,3 +415,21 @@ export const Handler = async ({
 	);
 	await metrics.sendMetricsEvent("create pages deployment");
 };
+
+function validateRoutesFile(_routes: string, routesPath: string) {
+	const routes = JSON.parse(_routes);
+
+	if (!isRoutesJSONSpec(routes)) {
+		throw new FatalError(
+			`Invalid _routes.json file found at: ${routesPath}. Please make sure the JSON object has the following format:
+      {
+        version: ${ROUTES_SPEC_VERSION};
+        include: string[];
+        exclude: string[];
+      }
+and that at least one include rule is provided.
+      `,
+			1
+		);
+	}
+}

package/src/paths.ts

@@ -1,4 +1,5 @@
-import { assert } from "console";
+import { assert } from "node:console";
+import { resolve } from "node:path";
 
 type DiscriminatedPath<Discriminator extends string> = string & {
 	_discriminator: Discriminator;
@@ -24,3 +25,21 @@ export function toUrlPath(path: string): UrlPath {
 	);
 	return path.replace(/\\/g, "/") as UrlPath;
 }
+
+/**
+ * The __RELATIVE_PACKAGE_PATH__ is defined either in the esbuild config (for production)
+ * or the jest.setup.ts (for unit testing).
+ */
+declare const __RELATIVE_PACKAGE_PATH__: string;
+
+/**
+ * Use this function (rather than node.js constants like `__dirname`) to specify
+ * paths that are relative to the base path of the Wrangler package.
+ *
+ * It is important to use this function because it reliably maps to the root of the package
+ * no matter whether the code has been bundled or not.
+ */
+export function getBasePath(): string {
+	// eslint-disable-next-line no-restricted-globals
+	return resolve(__dirname, __RELATIVE_PACKAGE_PATH__);
+}

package/src/proxy.ts

@@ -177,6 +177,7 @@ export function usePreviewServer({
 		const cleanupListeners: (() => void)[] = [];
 
 		// create a ClientHttp2Session
+		logger.debug("PREVIEW URL:", `https://${previewToken.host}`);
 		const remote = connect(`https://${previewToken.host}`);
 		cleanupListeners.push(() => remote.destroy());
 
@@ -221,6 +222,15 @@ export function usePreviewServer({
 				}
 			}
 			const request = message.pipe(remote.request(headers));
+			logger.debug(
+				"WORKER REQUEST",
+				new Date().toLocaleTimeString(),
+				method,
+				url
+			);
+			logger.debug("HEADERS", JSON.stringify(headers, null, 2));
+			logger.debug("PREVIEW TOKEN", previewToken);
+
 			request.on("response", (responseHeaders) => {
 				const status = responseHeaders[":status"] ?? 500;
 

package/src/publish.ts

@@ -36,6 +36,8 @@ type Props = {
 	compatibilityDate: string | undefined;
 	compatibilityFlags: string[] | undefined;
 	assetPaths: AssetPaths | undefined;
+	vars: Record<string, string> | undefined;
+	defines: Record<string, string> | undefined;
 	triggers: string[] | undefined;
 	routes: string[] | undefined;
 	legacyEnv: boolean | undefined;
@@ -382,7 +384,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 						tsconfig: props.tsconfig ?? config.tsconfig,
 						minify,
 						nodeCompat,
-						define: config.define,
+						define: { ...config.define, ...props.defines },
 						checkFetch: false,
 						assets: config.assets && {
 							...config.assets,
@@ -430,7 +432,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 					? { binding: "__STATIC_CONTENT", id: assets.namespace }
 					: []
 			),
-			vars: config.vars,
+			vars: { ...config.vars, ...props.vars },
 			wasm_modules: config.wasm_modules,
 			text_blobs: {
 				...config.text_blobs,
@@ -443,7 +445,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			durable_objects: config.durable_objects,
 			r2_buckets: config.r2_buckets,
 			services: config.services,
-			worker_namespaces: config.worker_namespaces,
+			dispatch_namespaces: config.dispatch_namespaces,
 			logfwdr: config.logfwdr,
 			unsafe: config.unsafe?.bindings,
 		};
@@ -470,6 +472,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			compatibility_flags:
 				props.compatibilityFlags ?? config.compatibility_flags,
 			usage_model: config.usage_model,
+			keep_bindings: true,
 		};
 
 		void printBundleSize(
@@ -482,7 +485,19 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			kv_namespaces: config.kv_namespaces,
 			text_blobs: config.text_blobs,
 		};
-		printBindings(withoutStaticAssets);
+
+		// mask anything that was overridden in cli args
+		// so that we don't log potential secrets into the terminal
+		const maskedVars = { ...withoutStaticAssets.vars };
+		for (const key of Object.keys(maskedVars)) {
+			if (maskedVars[key] !== config.vars[key]) {
+				// This means it was overridden in cli args
+				// so let's mask it
+				maskedVars[key] = "(hidden)";
+			}
+		}
+
+		printBindings({ ...withoutStaticAssets, vars: maskedVars });
 
 		if (!props.dryRun) {
 			// Upload the script so it has time to propagate.

package/src/r2.ts

@@ -33,10 +33,10 @@ export async function createR2Bucket(
 	accountId: string,
 	bucketName: string
 ): Promise<void> {
-	return await fetchResult<void>(
-		`/accounts/${accountId}/r2/buckets/${bucketName}`,
-		{ method: "PUT" }
-	);
+	return await fetchResult<void>(`/accounts/${accountId}/r2/buckets`, {
+		method: "POST",
+		body: JSON.stringify({ name: bucketName }),
+	});
 }
 
 /**

package/src/user/user.tsx

@@ -224,6 +224,7 @@ import {
 	saveToConfigCache,
 } from "../config-cache";
 import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
+import { CI } from "../is-ci";
 import isInteractive from "../is-interactive";
 import { logger } from "../logger";
 import openInBrowser from "../open-in-browser";
@@ -878,10 +879,11 @@ type LoginProps = {
 export async function loginOrRefreshIfRequired(): Promise<boolean> {
 	// TODO: if there already is a token, then try refreshing
 	// TODO: ask permission before opening browser
+	const { isCI } = CI;
 	if (!getAPIToken()) {
 		// Not logged in.
 		// If we are not interactive, we cannot ask the user to login
-		return isInteractive() && (await login());
+		return isInteractive() && !isCI() && (await login());
 	} else if (isAccessTokenExpired()) {
 		// We're logged in, but the refresh token seems to have expired,
 		// so let's try to refresh it
@@ -891,7 +893,7 @@ export async function loginOrRefreshIfRequired(): Promise<boolean> {
 			return true;
 		} else {
 			// If the refresh token isn't valid, then we ask the user to login again
-			return isInteractive() && (await login());
+			return isInteractive() && !isCI() && (await login());
 		}
 	} else {
 		return true;
@@ -1088,7 +1090,7 @@ export async function getAccountId(): Promise<string | undefined> {
 		return accounts[0].id;
 	}
 
-	if (isInteractive()) {
+	if (isInteractive() && !CI.isCI()) {
 		const account = await new Promise<{ id: string; name: string }>(
 			(resolve, reject) => {
 				const { unmount } = render(
@@ -1128,7 +1130,7 @@ export async function requireAuth(config: {
 }): Promise<string> {
 	const loggedIn = await loginOrRefreshIfRequired();
 	if (!loggedIn) {
-		if (!isInteractive()) {
+		if (!isInteractive() || CI.isCI()) {
 			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."
 			);

package/src/whoami.tsx

@@ -1,6 +1,6 @@
 import { Text, render } from "ink";
 import Table from "ink-table";
-import React from "react";
+import React, { Fragment } from "react";
 import { fetchListResult, fetchResult } from "./cfetch";
 import { logger } from "./logger";
 import { getAPIToken, getAuthFromEnv, getScopes } from "./user";
@@ -64,12 +64,12 @@ function Permissions(props: {
 					and re-login.
 				</Text>
 				<Text>Scope (Access)</Text>
-				{permissions.map(([type, name]) => (
-					<>
+				{permissions.map(([scope, access], index) => (
+					<Fragment key={`${scope}${index}`}>
 						<Text>
-							- {type} {name && `(${name})`}
+							- {scope} {access && `(${access})`}
 						</Text>
-					</>
+					</Fragment>
 				))}
 			</>
 		) : null

package/src/worker.ts

@@ -65,14 +65,14 @@ export interface CfModule {
 /**
  * A map of variable names to values.
  */
-interface CfVars {
+export interface CfVars {
 	[key: string]: unknown;
 }
 
 /**
  * A KV namespace.
  */
-interface CfKvNamespace {
+export interface CfKvNamespace {
 	binding: string;
 	id: string;
 }
@@ -81,7 +81,7 @@ interface CfKvNamespace {
  * A binding to a wasm module (in service-worker format)
  */
 
-interface CfWasmModuleBindings {
+export interface CfWasmModuleBindings {
 	[key: string]: string;
 }
 
@@ -89,7 +89,7 @@ interface CfWasmModuleBindings {
  * A binding to a text blob (in service-worker format)
  */
 
-interface CfTextBlobBindings {
+export interface CfTextBlobBindings {
 	[key: string]: string;
 }
 
@@ -97,21 +97,21 @@ interface CfTextBlobBindings {
  * A binding to a data blob (in service-worker format)
  */
 
-interface CfDataBlobBindings {
+export interface CfDataBlobBindings {
 	[key: string]: string;
 }
 
 /**
  * A Durable Object.
  */
-interface CfDurableObject {
+export interface CfDurableObject {
 	name: string;
 	class_name: string;
 	script_name?: string;
 	environment?: string;
 }
 
-interface CfR2Bucket {
+export interface CfR2Bucket {
 	binding: string;
 	bucket_name: string;
 }
@@ -122,7 +122,7 @@ interface CfService {
 	environment?: string;
 }
 
-interface CfWorkerNamespace {
+interface CfDispatchNamespace {
 	binding: string;
 	namespace: string;
 }
@@ -183,7 +183,7 @@ export interface CfWorkerInit {
 		durable_objects: { bindings: CfDurableObject[] } | undefined;
 		r2_buckets: CfR2Bucket[] | undefined;
 		services: CfService[] | undefined;
-		worker_namespaces: CfWorkerNamespace[] | undefined;
+		dispatch_namespaces: CfDispatchNamespace[] | undefined;
 		logfwdr: CfLogfwdr | undefined;
 		unsafe: CfUnsafeBinding[] | undefined;
 	};
@@ -191,6 +191,7 @@ export interface CfWorkerInit {
 	compatibility_date: string | undefined;
 	compatibility_flags: string[] | undefined;
 	usage_model: "bundled" | "unbound" | undefined;
+	keep_bindings: boolean | undefined;
 }
 
 export interface CfWorkerContext {

package/src/zones.ts

@@ -74,3 +74,94 @@ export async function getZoneIdFromHost(host: string): Promise<string> {
 
 	throw new Error(`Could not find zone for ${host}`);
 }
+
+/**
+ * An object holding information about an assigned worker route, returned from the API
+ */
+interface WorkerRoute {
+	id: string;
+	pattern: string;
+	script: string;
+}
+
+/**
+ * Given a zone within the user's account, return a list of all assigned worker routes
+ */
+export async function getRoutesForZone(zone: string): Promise<WorkerRoute[]> {
+	const routes = await fetchListResult<WorkerRoute>(
+		`/zones/${zone}/workers/routes`
+	);
+	return routes;
+}
+
+/**
+ * Given two strings, return the levenshtein distance between them as a simple text match heuristic
+ */
+function distanceBetween(a: string, b: string, cache = new Map()): number {
+	if (cache.has(`${a}|${b}`)) {
+		return cache.get(`${a}|${b}`);
+	}
+	let result;
+	if (b == "") {
+		result = a.length;
+	} else if (a == "") {
+		result = b.length;
+	} else if (a[0] === b[0]) {
+		result = distanceBetween(a.slice(1), b.slice(1), cache);
+	} else {
+		result =
+			1 +
+			Math.min(
+				distanceBetween(a.slice(1), b, cache),
+				distanceBetween(a, b.slice(1), cache),
+				distanceBetween(a.slice(1), b.slice(1), cache)
+			);
+	}
+	cache.set(`${a}|${b}`, result);
+	return result;
+}
+
+/**
+ * Given an invalid route, sort the valid routes by closeness to the invalid route (levenstein distance)
+ */
+export function findClosestRoute(
+	providedRoute: string,
+	assignedRoutes: WorkerRoute[]
+): WorkerRoute[] {
+	return assignedRoutes.sort((a, b) => {
+		const distanceA = distanceBetween(providedRoute, a.pattern);
+		const distanceB = distanceBetween(providedRoute, b.pattern);
+		return distanceA - distanceB;
+	});
+}
+
+/**
+ * Given a route (must be assigned and within the correct zone), return the name of the worker assigned to it
+ */
+export async function getWorkerForZone(worker: string) {
+	const zone = await getZoneForRoute(worker);
+	if (!zone) {
+		throw new Error(
+			`The route '${worker}' is not part of one of your zones. Either add this zone from the Cloudflare dashboard, or try using a route within one of your existing zones.`
+		);
+	}
+	const routes = await getRoutesForZone(zone.id);
+
+	const scriptName = routes.find((route) => route.pattern === worker)?.script;
+
+	if (!scriptName) {
+		const closestRoute = findClosestRoute(worker, routes)?.[0];
+
+		if (!closestRoute) {
+			throw new Error(
+				`The route '${worker}' has no workers assigned. You can assign a worker to it from wrangler.toml or the Cloudflare dashboard`
+			);
+		} else {
+			throw new Error(
+				`The route '${worker}' has no workers assigned. Did you mean to tail the route '${closestRoute.pattern}'?`
+			);
+		}
+	}
+
+	return scriptName;
+}