wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

package/src/pages/errors.ts

@@ -0,0 +1,66 @@
+import {
+	MAX_FUNCTIONS_ROUTES_RULES,
+	MAX_FUNCTIONS_ROUTES_RULE_LENGTH,
+	ROUTES_SPEC_VERSION,
+} from "./constants";
+import { RoutesValidationError } from "./functions/routes-validation";
+
+/**
+ * Exit code for `pages functions build` when no routes are found.
+ */
+export const EXIT_CODE_FUNCTIONS_NO_ROUTES_ERROR = 156;
+
+/**
+ * Pages error when no routes are found in the functions directory
+ */
+export class FunctionsNoRoutesError extends Error {
+	constructor(message: string) {
+		super(message);
+	}
+}
+
+/**
+ * Warning message for when buildFunctions throws FunctionsNoRoutesError
+ */
+export function getFunctionsNoRoutesWarning(
+	functionsDirectory: string,
+	suffix?: string
+) {
+	return `No routes found when building Functions directory: ${functionsDirectory}${
+		suffix ? " - " + suffix : ""
+	}`;
+}
+
+export function getRoutesValidationErrorMessage(
+	errorCode: RoutesValidationError,
+	routesPath: string
+): string {
+	switch (errorCode) {
+		case RoutesValidationError.NO_INCLUDE_RULES:
+			return `Invalid _routes.json file found at: ${routesPath}
+Routes must have at least 1 include rule, but no include rules were detected.`;
+		case RoutesValidationError.TOO_MANY_RULES:
+			return `Invalid _routes.json file found at: ${routesPath}
+Detected rules that are over the ${MAX_FUNCTIONS_ROUTES_RULES} rule limit. Please make sure you have a total of ${MAX_FUNCTIONS_ROUTES_RULES} include and exclude rules combined.`;
+		case RoutesValidationError.RULE_TOO_LONG:
+			return `Invalid _routes.json file found at: ${routesPath}
+Detected rules the are over the ${MAX_FUNCTIONS_ROUTES_RULE_LENGTH} character limit. Please make sure that each include and exclude routing rule is at most ${MAX_FUNCTIONS_ROUTES_RULE_LENGTH} characters long.`;
+		case RoutesValidationError.INVALID_RULES:
+			return `Invalid _routes.json file found at: ${routesPath}
+All rules must start with '/'.`;
+		case RoutesValidationError.OVERLAPPING_RULES:
+			return `Invalid _routes.json file found at: ${routesPath}
+Overlapping rules found. Please make sure that rules ending with a splat (eg. "/api/*") don't overlap any other rules (eg. "/api/foo"). This applies to both include and exclude rules individually.`;
+		case RoutesValidationError.INVALID_JSON_SPEC:
+		default:
+			return `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.
+			`;
+	}
+}

package/src/pages/functions/buildPlugin.ts

@@ -1,18 +1,11 @@
 import { access, lstat } from "node:fs/promises";
 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 { bundleWorker } from "../../bundle";
+import { getBasePath } from "../../paths";
+import { D1_BETA_PREFIX } from "../../worker";
+import type { Options as WorkerOptions } from "./buildWorker";
 
-type Options = {
-	routesModule: string;
-	outfile: string;
-	minify?: boolean;
-	sourcemap?: boolean;
-	watch?: boolean;
-	nodeCompat?: boolean;
-	onEnd?: () => void;
-};
+type Options = Omit<WorkerOptions, "fallbackService" | "buildOutputDirectory">;
 
 export function buildPlugin({
 	routesModule,
@@ -20,86 +13,95 @@ export function buildPlugin({
 	minify = false,
 	sourcemap = false,
 	watch = false,
-	nodeCompat,
 	onEnd = () => {},
+	nodeCompat,
+	functionsDirectory,
+	local,
+	betaD1Shims,
 }: Options) {
-	return build({
-		entryPoints: [resolve(__dirname, "../templates/pages-template-plugin.ts")],
-		inject: [routesModule],
-		bundle: true,
-		format: "esm",
-		target: "esnext",
-		outfile,
-		minify,
-		sourcemap,
-		watch,
-		allowOverwrite: true,
-		define: { ...(nodeCompat ? { global: "globalThis" } : {}) },
-		plugins: [
-			{
-				name: "wrangler notifier and monitor",
-				setup(pluginBuild) {
-					pluginBuild.onEnd((result) => {
-						if (result.errors.length > 0) {
-							console.error(
-								`${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
-							);
-						} else if (result.warnings.length > 0) {
-							console.warn(
-								`${result.warnings.length} warning(s) when compiling Worker.`
-							);
-							onEnd();
-						} else {
-							console.log("Compiled Worker successfully.");
-							onEnd();
-						}
-					});
+	return bundleWorker(
+		{
+			file: resolve(getBasePath(), "templates/pages-template-plugin.ts"),
+			directory: functionsDirectory,
+			format: "modules",
+		},
+		resolve(outfile),
+		{
+			inject: [routesModule],
+			minify,
+			sourcemap,
+			watch,
+			nodeCompat,
+			define: {},
+			betaD1Shims: (betaD1Shims || []).map(
+				(binding) => `${D1_BETA_PREFIX}${binding}`
+			),
+			plugins: [
+				{
+					name: "wrangler notifier and monitor",
+					setup(pluginBuild) {
+						pluginBuild.onEnd((result) => {
+							if (result.errors.length > 0) {
+								console.error(
+									`${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
+								);
+							} else if (result.warnings.length > 0) {
+								console.warn(
+									`${result.warnings.length} warning(s) when compiling Worker.`
+								);
+								onEnd();
+							} else {
+								console.log("Compiled Worker successfully.");
+								onEnd();
+							}
+						});
+					},
 				},
-			},
-			{
-				name: "Assets",
-				setup(pluginBuild) {
-					if (pluginBuild.initialOptions.outfile) {
-						const outdir = dirname(pluginBuild.initialOptions.outfile);
+				{
+					name: "Assets",
+					setup(pluginBuild) {
+						if (pluginBuild.initialOptions.outfile) {
+							const outdir = dirname(pluginBuild.initialOptions.outfile);
 
-						pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
-							const directory = resolve(
-								args.resolveDir,
-								args.path.slice("assets:".length)
-							);
+							pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
+								const directory = resolve(
+									args.resolveDir,
+									args.path.slice("assets:".length)
+								);
 
-							const exists = await access(directory)
-								.then(() => true)
-								.catch(() => false);
+								const exists = await access(directory)
+									.then(() => true)
+									.catch(() => false);
 
-							const isDirectory =
-								exists && (await lstat(directory)).isDirectory();
+								const isDirectory =
+									exists && (await lstat(directory)).isDirectory();
 
-							if (!isDirectory) {
-								return {
-									errors: [
-										{
-											text: `'${directory}' does not exist or is not a directory.`,
-										},
-									],
-								};
-							}
+								if (!isDirectory) {
+									return {
+										errors: [
+											{
+												text: `'${directory}' does not exist or is not a directory.`,
+											},
+										],
+									};
+								}
 
-							const path = `assets:./${relative(outdir, directory)}`;
+								const path = `assets:./${relative(outdir, directory)}`;
 
-							return { path, external: true, namespace: "assets" };
-						});
-					}
+								return { path, external: true, namespace: "assets" };
+							});
+						}
+					},
 				},
-			},
-			...(nodeCompat
-				? [
-						NodeGlobalsPolyfills({
-							buffer: true,
-						}),
-						NodeModulesPolyfills(),
-				  ]
-				: []),
-		],
-	});
+			],
+			isOutfile: true,
+			serveAssetsFromWorker: false,
+			disableModuleCollection: true,
+			rules: [],
+			checkFetch: local,
+			targetConsumer: local ? "dev" : "publish",
+			local,
+			experimentalLocal: false,
+		}
+	);
 }

package/src/pages/functions/buildWorker.ts

@@ -1,11 +1,11 @@
 import { access, cp, lstat, rm } from "node:fs/promises";
 import { join, 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 { nanoid } from "nanoid";
+import { bundleWorker } from "../../bundle";
+import { getBasePath } from "../../paths";
+import { D1_BETA_PREFIX } from "../../worker";
 
-type Options = {
+export type Options = {
 	routesModule: string;
 	outfile: string;
 	minify?: boolean;
@@ -15,6 +15,9 @@ type Options = {
 	onEnd?: () => void;
 	buildOutputDirectory?: string;
 	nodeCompat?: boolean;
+	functionsDirectory: string;
+	local: boolean;
+	betaD1Shims?: string[];
 };
 
 export function buildWorker({
@@ -27,125 +30,137 @@ export function buildWorker({
 	onEnd = () => {},
 	buildOutputDirectory,
 	nodeCompat,
+	functionsDirectory,
+	local,
+	betaD1Shims,
 }: Options) {
-	return build({
-		entryPoints: [resolve(__dirname, "../templates/pages-template-worker.ts")],
-		inject: [routesModule],
-		bundle: true,
-		format: "esm",
-		target: "esnext",
-		outfile,
-		minify,
-		sourcemap,
-		watch,
-		allowOverwrite: true,
-		define: {
-			__FALLBACK_SERVICE__: JSON.stringify(fallbackService),
-			...(nodeCompat ? { global: "globalThis" } : {}),
+	return bundleWorker(
+		{
+			file: resolve(getBasePath(), "templates/pages-template-worker.ts"),
+			directory: functionsDirectory,
+			format: "modules",
 		},
-		plugins: [
-			{
-				name: "wrangler notifier and monitor",
-				setup(pluginBuild) {
-					pluginBuild.onEnd((result) => {
-						if (result.errors.length > 0) {
-							console.error(
-								`${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
-							);
-						} else if (result.warnings.length > 0) {
-							console.warn(
-								`${result.warnings.length} warning(s) when compiling Worker.`
-							);
-							onEnd();
-						} else {
-							console.log("Compiled Worker successfully.");
-							onEnd();
-						}
-					});
-				},
+		resolve(outfile),
+		{
+			inject: [routesModule],
+			minify,
+			sourcemap,
+			watch,
+			nodeCompat,
+			loader: {
+				".txt": "text",
+				".html": "text",
 			},
-			{
-				name: "Assets",
-				setup(pluginBuild) {
-					const identifiers = new Map<string, string>();
+			define: {
+				__FALLBACK_SERVICE__: JSON.stringify(fallbackService),
+			},
+			betaD1Shims: (betaD1Shims || []).map(
+				(binding) => `${D1_BETA_PREFIX}${binding}`
+			),
+			plugins: [
+				{
+					name: "wrangler notifier and monitor",
+					setup(pluginBuild) {
+						pluginBuild.onEnd((result) => {
+							if (result.errors.length > 0) {
+								console.error(
+									`${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
+								);
+							} else if (result.warnings.length > 0) {
+								console.warn(
+									`${result.warnings.length} warning(s) when compiling Worker.`
+								);
+								onEnd();
+							} else {
+								console.log("Compiled Worker successfully.");
+								onEnd();
+							}
+						});
+					},
+				},
+				{
+					name: "Assets",
+					setup(pluginBuild) {
+						const identifiers = new Map<string, string>();
 
-					pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
-						const directory = resolve(
-							args.resolveDir,
-							args.path.slice("assets:".length)
-						);
+						pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
+							const directory = resolve(
+								args.resolveDir,
+								args.path.slice("assets:".length)
+							);
 
-						const exists = await access(directory)
-							.then(() => true)
-							.catch(() => false);
+							const exists = await access(directory)
+								.then(() => true)
+								.catch(() => false);
 
-						const isDirectory =
-							exists && (await lstat(directory)).isDirectory();
+							const isDirectory =
+								exists && (await lstat(directory)).isDirectory();
 
-						if (!isDirectory) {
-							return {
-								errors: [
-									{
-										text: `'${directory}' does not exist or is not a directory.`,
-									},
-								],
-							};
-						}
+							if (!isDirectory) {
+								return {
+									errors: [
+										{
+											text: `'${directory}' does not exist or is not a directory.`,
+										},
+									],
+								};
+							}
 
-						// TODO: Consider hashing the contents rather than using a unique identifier every time?
-						identifiers.set(directory, nanoid());
-						if (!buildOutputDirectory) {
-							console.warn(
-								"You're attempting to import static assets as part of your Pages Functions, but have not specified a directory in which to put them. You must use 'wrangler pages dev <directory>' rather than 'wrangler pages dev -- <command>' to import static assets in Functions."
-							);
-						}
-						return { path: directory, namespace: "assets" };
-					});
+							// TODO: Consider hashing the contents rather than using a unique identifier every time?
+							identifiers.set(directory, nanoid());
+							if (!buildOutputDirectory) {
+								console.warn(
+									"You're attempting to import static assets as part of your Pages Functions, but have not specified a directory in which to put them. You must use 'wrangler pages dev <directory>' rather than 'wrangler pages dev -- <command>' to import static assets in Functions."
+								);
+							}
+							return { path: directory, namespace: "assets" };
+						});
 
-					pluginBuild.onLoad(
-						{ filter: /.*/, namespace: "assets" },
-						async (args) => {
-							const identifier = identifiers.get(args.path);
+						pluginBuild.onLoad(
+							{ filter: /.*/, namespace: "assets" },
+							async (args) => {
+								const identifier = identifiers.get(args.path);
 
-							if (buildOutputDirectory) {
-								const staticAssetsOutputDirectory = join(
-									buildOutputDirectory,
-									"cdn-cgi",
-									"pages-plugins",
-									identifier as string
-								);
-								await rm(staticAssetsOutputDirectory, {
-									force: true,
-									recursive: true,
-								});
-								await cp(args.path, staticAssetsOutputDirectory, {
-									force: true,
-									recursive: true,
-								});
+								if (buildOutputDirectory) {
+									const staticAssetsOutputDirectory = join(
+										buildOutputDirectory,
+										"cdn-cgi",
+										"pages-plugins",
+										identifier as string
+									);
+									await rm(staticAssetsOutputDirectory, {
+										force: true,
+										recursive: true,
+									});
+									await cp(args.path, staticAssetsOutputDirectory, {
+										force: true,
+										recursive: true,
+									});
 
-								return {
-									// TODO: Watch args.path for changes and re-copy when updated
-									contents: `export const onRequest = ({ request, env, functionPath }) => {
+									return {
+										// TODO: Watch args.path for changes and re-copy when updated
+										contents: `export const onRequest = ({ request, env, functionPath }) => {
                     const url = new URL(request.url)
                     const relativePathname = \`/\${url.pathname.split(functionPath)[1] || ''}\`.replace(/^\\/\\//, '/');
                     url.pathname = '/cdn-cgi/pages-plugins/${identifier}' + relativePathname
                     request = new Request(url.toString(), request)
                     return env.ASSETS.fetch(request)
                   }`,
-								};
+									};
+								}
 							}
-						}
-					);
+						);
+					},
 				},
-			},
-			...(nodeCompat
-				? [
-						NodeGlobalsPolyfills({
-							buffer: true,
-						}),
-						NodeModulesPolyfills(),
-				  ]
-				: []),
-		],
-	});
+			],
+			isOutfile: true,
+			serveAssetsFromWorker: false,
+			disableModuleCollection: true,
+			rules: [],
+			checkFetch: local,
+			targetConsumer: local ? "dev" : "publish",
+			local,
+			experimentalLocal: false,
+		}
+	);
 }