wrangler 2.0.28 → 2.0.29

package/src/miniflare-cli/assets.ts

@@ -1,5 +1,9 @@
 import { existsSync, lstatSync, readFileSync } from "node:fs";
 import { join } from "node:path";
+import {
+	generateRulesMatcher,
+	replacer,
+} from "@cloudflare/pages-shared/src/asset-server/rulesEngine";
 import { fetch as miniflareFetch } from "@miniflare/core";
 import { watch } from "chokidar";
 import { getType } from "mime";
@@ -54,71 +58,6 @@ export default async function generateASSETSBinding(options: Options) {
 	};
 }
 
-function escapeRegex(str: string) {
-	return str.replace(/[-/\\^$*+?.()|[]{}]/g, "\\$&");
-}
-
-type Replacements = Record<string, string>;
-
-function replacer(str: string, replacements: Replacements) {
-	for (const [replacement, value] of Object.entries(replacements)) {
-		str = str.replace(`:${replacement}`, value);
-	}
-	return str;
-}
-
-function generateRulesMatcher<T>(
-	rules?: Record<string, T>,
-	replacerFn: (match: T, replacements: Replacements) => T = (match) => match
-) {
-	// TODO: How can you test cross-host rules?
-	if (!rules) return () => [];
-
-	const compiledRules = Object.entries(rules)
-		.map(([rule, match]) => {
-			const crossHost = rule.startsWith("https://");
-
-			rule = rule.split("*").map(escapeRegex).join("(?<splat>.*)");
-
-			const host_matches = rule.matchAll(
-				/(?<=^https:\\\/\\\/[^/]*?):([^\\]+)(?=\\)/g
-			);
-			for (const hostMatch of host_matches) {
-				rule = rule.split(hostMatch[0]).join(`(?<${hostMatch[1]}>[^/.]+)`);
-			}
-
-			const path_matches = rule.matchAll(/:(\w+)/g);
-			for (const pathMatch of path_matches) {
-				rule = rule.split(pathMatch[0]).join(`(?<${pathMatch[1]}>[^/]+)`);
-			}
-
-			rule = "^" + rule + "$";
-
-			try {
-				const regExp = new RegExp(rule);
-				return [{ crossHost, regExp }, match];
-			} catch {}
-		})
-		.filter((value) => value !== undefined) as [
-		{ crossHost: boolean; regExp: RegExp },
-		T
-	][];
-
-	return ({ request }: { request: MiniflareRequest }) => {
-		const { pathname, host } = new URL(request.url);
-
-		return compiledRules
-			.map(([{ crossHost, regExp }, match]) => {
-				const test = crossHost ? `https://${host}${pathname}` : pathname;
-				const result = regExp.exec(test);
-				if (result) {
-					return replacerFn(match, result.groups || {});
-				}
-			})
-			.filter((value) => value !== undefined) as T[];
-	};
-}
-
 function generateHeadersMatcher(headersFile: string) {
 	if (existsSync(headersFile)) {
 		const contents = readFileSync(headersFile).toString();

package/src/miniflare-cli/index.ts

@@ -59,41 +59,45 @@ async function main() {
 
 	config.bindings = {
 		...config.bindings,
-		...Object.fromEntries(
-			Object.entries(
-				config.externalDurableObjects as Record<
-					string,
-					{ name: string; host: string; port: number }
-				>
-			).map(([binding, { name, host, port }]) => {
-				const factory = () => {
-					throw new FatalError(
-						"An external Durable Object instance's state has somehow been attempted to be accessed.",
-						1
-					);
-				};
-				const namespace = new DurableObjectNamespace(name as string, factory);
-				namespace.get = (id) => {
-					const stub = new DurableObjectStub(factory, id);
-					stub.fetch = (...reqArgs) => {
-						const requestFromArgs = new MiniflareRequest(...reqArgs);
-						const url = new URL(requestFromArgs.url);
-						url.host = host;
-						if (port !== undefined) url.port = port.toString();
-						const request = new MiniflareRequest(
-							url.toString(),
-							requestFromArgs
+		...(config.externalDurableObjects &&
+			Object.fromEntries(
+				Object.entries(
+					config.externalDurableObjects as Record<
+						string,
+						{ name: string; host: string; port: number }
+					>
+				).map(([binding, { name, host, port }]) => {
+					const factory = () => {
+						throw new FatalError(
+							"An external Durable Object instance's state has somehow been attempted to be accessed.",
+							1
 						);
-						request.headers.set("x-miniflare-durable-object-name", name);
-						request.headers.set("x-miniflare-durable-object-id", id.toString());
+					};
+					const namespace = new DurableObjectNamespace(name as string, factory);
+					namespace.get = (id) => {
+						const stub = new DurableObjectStub(factory, id);
+						stub.fetch = (...reqArgs) => {
+							const requestFromArgs = new MiniflareRequest(...reqArgs);
+							const url = new URL(requestFromArgs.url);
+							url.host = host;
+							if (port !== undefined) url.port = port.toString();
+							const request = new MiniflareRequest(
+								url.toString(),
+								requestFromArgs
+							);
+							request.headers.set("x-miniflare-durable-object-name", name);
+							request.headers.set(
+								"x-miniflare-durable-object-id",
+								id.toString()
+							);
 
-						return fetch(request);
+							return fetch(request);
+						};
+						return stub;
 					};
-					return stub;
-				};
-				return [binding, namespace];
-			})
-		),
+					return [binding, namespace];
+				})
+			)),
 	};
 
 	let mf: Miniflare | undefined;

package/src/pages/constants.ts

@@ -1,3 +1,5 @@
+import { version as wranglerVersion } from "../../package.json";
+
 export const PAGES_CONFIG_CACHE_FILENAME = "pages.json";
 export const MAX_BUCKET_SIZE = 50 * 1024 * 1024;
 export const MAX_BUCKET_FILE_COUNT = 5000;
@@ -10,3 +12,4 @@ export const isInPagesCI = !!process.env.CF_PAGES;
 export const MAX_FUNCTIONS_ROUTES_RULES = 100;
 export const MAX_FUNCTIONS_ROUTES_RULE_LENGTH = 100;
 export const ROUTES_SPEC_VERSION = 1;
+export const ROUTES_SPEC_DESCRIPTION = `Generated by wrangler@${wranglerVersion}`;

package/src/pages/dev.tsx

@@ -8,6 +8,7 @@ import { unstable_dev } from "../api";
 import { FatalError } from "../errors";
 import { logger } from "../logger";
 import * as metrics from "../metrics";
+import { getBasePath } from "../paths";
 import { buildFunctions } from "./build";
 import { SECONDS_TO_WAIT_FOR_PROXY } from "./constants";
 import { FunctionsNoRoutesError, getFunctionsNoRoutesWarning } from "./errors";
@@ -274,7 +275,7 @@ export const Handler = async ({
 
 		if (!existsSync(scriptPath)) {
 			logger.log("No functions. Shimming...");
-			scriptPath = resolve(__dirname, "../templates/pages-shim.ts");
+			scriptPath = resolve(getBasePath(), "templates/pages-shim.ts");
 		} else {
 			const runBuild = async () => {
 				try {
@@ -363,7 +364,7 @@ export const Handler = async ({
 			logLevel: "error",
 			logPrefix: "pages",
 		},
-		true
+		{ testMode: false, disableExperimentalWarning: true }
 	);
 	await metrics.sendMetricsEvent("run pages dev");
 

package/src/pages/functions/buildPlugin.ts

@@ -3,6 +3,7 @@ import { dirname, relative, resolve } from "node:path";
 import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
 import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
 import { build } from "esbuild";
+import { getBasePath } from "../../paths";
 
 type Options = {
 	routesModule: string;
@@ -24,7 +25,7 @@ export function buildPlugin({
 	onEnd = () => {},
 }: Options) {
 	return build({
-		entryPoints: [resolve(__dirname, "../templates/pages-template-plugin.ts")],
+		entryPoints: [resolve(getBasePath(), "templates/pages-template-plugin.ts")],
 		inject: [routesModule],
 		bundle: true,
 		format: "esm",

package/src/pages/functions/buildWorker.ts

@@ -4,6 +4,7 @@ import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
 import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
 import { build } from "esbuild";
 import { nanoid } from "nanoid";
+import { getBasePath } from "../../paths";
 
 type Options = {
 	routesModule: string;
@@ -29,7 +30,7 @@ export function buildWorker({
 	nodeCompat,
 }: Options) {
 	return build({
-		entryPoints: [resolve(__dirname, "../templates/pages-template-worker.ts")],
+		entryPoints: [resolve(getBasePath(), "templates/pages-template-worker.ts")],
 		inject: [routesModule],
 		bundle: true,
 		format: "esm",

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/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;
 }

package/wrangler-dist/cli.d.ts

@@ -33,7 +33,13 @@ declare interface BodyMixin {
     readonly text: () => Promise<string>
 }
 
+declare interface DevApiOptions {
+    testMode?: boolean;
+    disableExperimentalWarning?: boolean;
+}
+
 declare interface DevOptions {
+    config?: string;
     env?: string;
     ip?: string;
     port?: number;
@@ -49,7 +55,7 @@ declare interface DevOptions {
     experimentalEnableLocalPersistence?: boolean;
     liveReload?: boolean;
     watch?: boolean;
-    vars: {
+    vars?: {
         [key: string]: unknown;
     };
     kv?: {
@@ -328,11 +334,15 @@ declare interface SpecIterator<T, TReturn = any, TNext = undefined> {
  *  unstable_dev starts a wrangler dev server, and returns a promise that resolves with utility functions to interact with it.
  *  @param {string} script
  *  @param {DevOptions} options
+ *  @param {DevApiOptions} apiOptions
+ * @returns {Promise<UnstableDev>}
  */
-export declare function unstable_dev(script: string, options: DevOptions, disableExperimentalWarning?: boolean): Promise<{
-    stop: () => void;
-    fetch: (init?: RequestInit | undefined) => Promise<Response | undefined>;
+export declare function unstable_dev(script: string, options?: DevOptions, apiOptions?: DevApiOptions): Promise<UnstableDev>;
+
+declare interface UnstableDev {
+    stop: () => Promise<void>;
+    fetch: (init?: RequestInit) => Promise<Response | undefined>;
     waitUntilExit: () => Promise<void>;
-}>;
+}
 
 export { }