wrangler 2.0.12 → 2.0.16

package/pages/functions/buildPlugin.ts

@@ -1,105 +0,0 @@
-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";
-
-type Options = {
-  routesModule: string;
-  outfile: string;
-  minify?: boolean;
-  sourcemap?: boolean;
-  watch?: boolean;
-  nodeCompat?: boolean;
-  onEnd?: () => void;
-};
-
-export function buildPlugin({
-  routesModule,
-  outfile = "bundle.js",
-  minify = false,
-  sourcemap = false,
-  watch = false,
-  nodeCompat,
-  onEnd = () => {},
-}: Options) {
-  return build({
-    entryPoints: [resolve(__dirname, "../pages/functions/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();
-            }
-          });
-        },
-      },
-      {
-        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)
-              );
-
-              const exists = await access(directory)
-                .then(() => true)
-                .catch(() => false);
-
-              const isDirectory =
-                exists && (await lstat(directory)).isDirectory();
-
-              if (!isDirectory) {
-                return {
-                  errors: [
-                    {
-                      text: `'${directory}' does not exist or is not a directory.`,
-                    },
-                  ],
-                };
-              }
-
-              const path = `assets:./${relative(outdir, directory)}`;
-
-              return { path, external: true, namespace: "assets" };
-            });
-          }
-        },
-      },
-      ...(nodeCompat
-        ? [
-            NodeGlobalsPolyfills({
-              buffer: true,
-            }),
-            NodeModulesPolyfills(),
-          ]
-        : []),
-    ],
-  });
-}

package/pages/functions/buildWorker.ts

@@ -1,151 +0,0 @@
-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";
-
-type Options = {
-  routesModule: string;
-  outfile: string;
-  minify?: boolean;
-  sourcemap?: boolean;
-  fallbackService?: string;
-  watch?: boolean;
-  onEnd?: () => void;
-  buildOutputDirectory?: string;
-  nodeCompat?: boolean;
-};
-
-export function buildWorker({
-  routesModule,
-  outfile = "bundle.js",
-  minify = false,
-  sourcemap = false,
-  fallbackService = "ASSETS",
-  watch = false,
-  onEnd = () => {},
-  buildOutputDirectory,
-  nodeCompat,
-}: Options) {
-  return build({
-    entryPoints: [resolve(__dirname, "../pages/functions/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" } : {}),
-    },
-    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)
-            );
-
-            const exists = await access(directory)
-              .then(() => true)
-              .catch(() => false);
-
-            const isDirectory =
-              exists && (await lstat(directory)).isDirectory();
-
-            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" };
-          });
-
-          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,
-                });
-
-                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(),
-          ]
-        : []),
-    ],
-  });
-}

package/pages/functions/filepath-routing.ts

@@ -1,189 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { build } from "esbuild";
-import { toUrlPath } from "../../src/paths";
-import type { UrlPath } from "../../src/paths";
-import type { HTTPMethod, RouteConfig } from "./routes";
-
-export async function generateConfigFromFileTree({
-  baseDir,
-  baseURL,
-}: {
-  baseDir: string;
-  baseURL: UrlPath;
-}) {
-  let routeEntries: RouteConfig[] = [];
-
-  if (!baseURL.startsWith("/")) {
-    baseURL = `/${baseURL}` as UrlPath;
-  }
-
-  if (baseURL.endsWith("/")) {
-    baseURL = baseURL.slice(0, -1) as UrlPath;
-  }
-
-  await forEachFile(baseDir, async (filepath) => {
-    const ext = path.extname(filepath);
-    if (/^\.(mjs|js|ts|tsx|jsx)$/.test(ext)) {
-      const { metafile } = await build({
-        metafile: true,
-        write: false,
-        bundle: false,
-        entryPoints: [path.resolve(filepath)],
-      });
-      const exportNames: string[] = [];
-      if (metafile) {
-        for (const output in metafile?.outputs) {
-          exportNames.push(...metafile.outputs[output].exports);
-        }
-      }
-      for (const exportName of exportNames) {
-        const [match, method = ""] = (exportName.match(
-          /^onRequest(Get|Post|Put|Patch|Delete|Options|Head)?$/
-        ) ?? []) as (string | undefined)[];
-
-        if (match) {
-          const basename = path.basename(filepath).slice(0, -ext.length);
-
-          const isIndexFile = basename === "index";
-          // TODO: deprecate _middleware_ in favor of _middleware
-          const isMiddlewareFile =
-            basename === "_middleware" || basename === "_middleware_";
-
-          let routePath = path
-            .relative(baseDir, filepath)
-            .slice(0, -ext.length);
-          let mountPath = path.dirname(routePath);
-
-          if (isIndexFile || isMiddlewareFile) {
-            routePath = path.dirname(routePath);
-          }
-
-          if (routePath === ".") {
-            routePath = "";
-          }
-          if (mountPath === ".") {
-            mountPath = "";
-          }
-
-          routePath = `${baseURL}/${routePath}`;
-          mountPath = `${baseURL}/${mountPath}`;
-
-          routePath = routePath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
-          routePath = routePath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
-          mountPath = mountPath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
-          mountPath = mountPath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
-
-          // These are used as module specifiers so UrlPaths are okay to use even on Windows
-          const modulePath = toUrlPath(path.relative(baseDir, filepath));
-
-          const routeEntry: RouteConfig = {
-            routePath: toUrlPath(routePath),
-            mountPath: toUrlPath(mountPath),
-            method: method.toUpperCase() as HTTPMethod,
-            [isMiddlewareFile ? "middleware" : "module"]: [
-              `${modulePath}:${exportName}`,
-            ],
-          };
-
-          routeEntries.push(routeEntry);
-        }
-      }
-    }
-  });
-  // Combine together any routes (index routes) which contain both a module and a middleware
-  routeEntries = routeEntries.reduce(
-    (acc: typeof routeEntries, { routePath, ...rest }) => {
-      const existingRouteEntry = acc.find(
-        (routeEntry) =>
-          routeEntry.routePath === routePath &&
-          routeEntry.method === rest.method
-      );
-      if (existingRouteEntry !== undefined) {
-        Object.assign(existingRouteEntry, rest);
-      } else {
-        acc.push({ routePath, ...rest });
-      }
-      return acc;
-    },
-    []
-  );
-
-  routeEntries.sort((a, b) => compareRoutes(a, b));
-
-  return {
-    routes: routeEntries,
-  };
-}
-
-// Ensure routes are produced in order of precedence so that
-// more specific routes aren't occluded from matching due to
-// less specific routes appearing first in the route list.
-export function compareRoutes(
-  { routePath: routePathA, method: methodA }: RouteConfig,
-  { routePath: routePathB, method: methodB }: RouteConfig
-) {
-  function parseRoutePath(routePath: UrlPath): string[] {
-    return routePath.slice(1).split("/").filter(Boolean);
-  }
-
-  const segmentsA = parseRoutePath(routePathA);
-  const segmentsB = parseRoutePath(routePathB);
-
-  // sort routes with fewer segments after those with more segments
-  if (segmentsA.length !== segmentsB.length) {
-    return segmentsB.length - segmentsA.length;
-  }
-
-  for (let i = 0; i < segmentsA.length; i++) {
-    const isWildcardA = segmentsA[i].includes("*");
-    const isWildcardB = segmentsB[i].includes("*");
-    const isParamA = segmentsA[i].includes(":");
-    const isParamB = segmentsB[i].includes(":");
-
-    // sort wildcard segments after non-wildcard segments
-    if (isWildcardA && !isWildcardB) return 1;
-    if (!isWildcardA && isWildcardB) return -1;
-
-    // sort dynamic param segments after non-param segments
-    if (isParamA && !isParamB) return 1;
-    if (!isParamA && isParamB) return -1;
-  }
-
-  // sort routes that specify an HTTP before those that don't
-  if (methodA && !methodB) return -1;
-  if (!methodA && methodB) return 1;
-
-  // all else equal, just sort the paths lexicographically
-  return routePathA.localeCompare(routePathB);
-}
-
-async function forEachFile<T>(
-  baseDir: string,
-  fn: (filepath: string) => T | Promise<T>
-) {
-  const searchPaths = [baseDir];
-  const returnValues: T[] = [];
-
-  while (isNotEmpty(searchPaths)) {
-    const cwd = searchPaths.shift();
-    const dir = await fs.readdir(cwd, { withFileTypes: true });
-    for (const entry of dir) {
-      const pathname = path.join(cwd, entry.name);
-      if (entry.isDirectory()) {
-        searchPaths.push(pathname);
-      } else if (entry.isFile()) {
-        returnValues.push(await fn(pathname));
-      }
-    }
-  }
-
-  return returnValues;
-}
-
-interface NonEmptyArray<T> extends Array<T> {
-  shift(): T;
-}
-function isNotEmpty<T>(array: T[]): array is NonEmptyArray<T> {
-  return array.length > 0;
-}

package/pages/functions/identifiers.ts

@@ -1,78 +0,0 @@
-export const RESERVED_KEYWORDS = [
-  "do",
-  "if",
-  "in",
-  "for",
-  "let",
-  "new",
-  "try",
-  "var",
-  "case",
-  "else",
-  "enum",
-  "eval",
-  "null",
-  "this",
-  "true",
-  "void",
-  "with",
-  "await",
-  "break",
-  "catch",
-  "class",
-  "const",
-  "false",
-  "super",
-  "throw",
-  "while",
-  "yield",
-  "delete",
-  "export",
-  "import",
-  "public",
-  "return",
-  "static",
-  "switch",
-  "typeof",
-  "default",
-  "extends",
-  "finally",
-  "package",
-  "private",
-  "continue",
-  "debugger",
-  "function",
-  "arguments",
-  "interface",
-  "protected",
-  "implements",
-  "instanceof",
-  "NaN",
-  "Infinity",
-  "undefined",
-];
-
-export const reservedKeywordRegex = new RegExp(
-  `^${RESERVED_KEYWORDS.join("|")}$`
-);
-
-export const identifierStartRegex = /[$_\p{ID_Start}]/u;
-
-export const identifierPartRegex = /[$_\u200C\u200D\p{ID_Continue}]/u;
-
-export const identifierNameRegex =
-  /^(?:[$_\p{ID_Start}])(?:[$_\u200C\u200D\p{ID_Continue}])*$/u;
-
-export const validIdentifierRegex = new RegExp(
-  `(?!(${reservedKeywordRegex.source})$)${identifierNameRegex.source}`,
-  "u"
-);
-
-export const isValidIdentifier = (identifier: string) =>
-  validIdentifierRegex.test(identifier);
-
-export const normalizeIdentifier = (identifier: string) =>
-  identifier.replace(
-    /(?:^[^$_\p{ID_Start}])|[^$_\u200C\u200D\p{ID_Continue}]/gu,
-    "_"
-  );

package/pages/functions/routes.ts

@@ -1,156 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { isValidIdentifier, normalizeIdentifier } from "./identifiers";
-import type { UrlPath } from "../../src/paths";
-
-export const HTTP_METHODS = [
-  "HEAD",
-  "OPTIONS",
-  "GET",
-  "POST",
-  "PUT",
-  "PATCH",
-  "DELETE",
-] as const;
-export type HTTPMethod = typeof HTTP_METHODS[number];
-export function isHTTPMethod(
-  maybeHTTPMethod: string
-): maybeHTTPMethod is HTTPMethod {
-  return (HTTP_METHODS as readonly string[]).includes(maybeHTTPMethod);
-}
-
-export type RoutesCollection = Array<{
-  routePath: UrlPath;
-  mountPath: UrlPath;
-  method?: HTTPMethod;
-  modules: string[];
-  middlewares: string[];
-}>;
-
-export type Config = {
-  routes?: RouteConfig[];
-  schedules?: unknown;
-};
-
-export type RouteConfig = {
-  routePath: UrlPath;
-  mountPath: UrlPath;
-  method?: HTTPMethod;
-  middleware?: string | string[];
-  module?: string | string[];
-};
-
-type ImportMap = Map<
-  string,
-  {
-    filepath: string;
-    name: string;
-    identifier: string;
-  }
->;
-
-type Arguments = {
-  config: Config;
-  outfile: string;
-  srcDir: string;
-};
-
-export async function writeRoutesModule({
-  config,
-  srcDir,
-  outfile = "_routes.js",
-}: Arguments) {
-  const { importMap, routes } = parseConfig(config, srcDir);
-  const routesModule = generateRoutesModule(importMap, routes);
-
-  await fs.writeFile(outfile, routesModule);
-
-  return outfile;
-}
-
-export function parseConfig(config: Config, baseDir: string) {
-  const routes: RoutesCollection = [];
-  const importMap: ImportMap = new Map();
-  const identifierCount = new Map<string, number>(); // to keep track of identifier collisions
-
-  function parseModuleIdentifiers(paths: string | string[] | undefined) {
-    if (typeof paths === "undefined") {
-      paths = [];
-    }
-
-    if (typeof paths === "string") {
-      paths = [paths];
-    }
-
-    return paths.map((modulePath) => {
-      const [filepath, name = "default"] = modulePath.split(":");
-      let { identifier } = importMap.get(modulePath) ?? {};
-
-      const resolvedPath = path.resolve(baseDir, filepath);
-
-      // ensure the filepath isn't attempting to resolve to anything outside of the project
-      if (path.relative(baseDir, resolvedPath).startsWith("..")) {
-        throw new Error(`Invalid module path "${filepath}"`);
-      }
-
-      // ensure the module name (if provided) is a valid identifier to guard against injection attacks
-      if (name !== "default" && !isValidIdentifier(name)) {
-        throw new Error(`Invalid module identifier "${name}"`);
-      }
-
-      if (!identifier) {
-        identifier = normalizeIdentifier(`__${filepath}_${name}`);
-
-        let count = identifierCount.get(identifier) ?? 0;
-        identifierCount.set(identifier, ++count);
-
-        if (count > 1) {
-          identifier += `_${count}`;
-        }
-
-        importMap.set(modulePath, { filepath: resolvedPath, name, identifier });
-      }
-
-      return identifier;
-    });
-  }
-
-  for (const { routePath, mountPath, method, ...props } of config.routes ??
-    []) {
-    routes.push({
-      routePath,
-      mountPath,
-      method,
-      middlewares: parseModuleIdentifiers(props.middleware),
-      modules: parseModuleIdentifiers(props.module),
-    });
-  }
-
-  return { routes, importMap };
-}
-
-export function generateRoutesModule(
-  importMap: ImportMap,
-  routes: RoutesCollection
-) {
-  return `${[...importMap.values()]
-    .map(
-      ({ filepath, name, identifier }) =>
-        `import { ${name} as ${identifier} } from ${JSON.stringify(filepath)}`
-    )
-    .join("\n")}
-
-export const routes = [
-  ${routes
-    .map(
-      (route) => `  {
-      routePath: "${route.routePath}",
-      mountPath: "${route.mountPath}",
-      method: "${route.method}",
-      middlewares: [${route.middlewares.join(", ")}],
-      modules: [${route.modules.join(", ")}],
-    },`
-    )
-    .join("\n")}
-  ]`;
-}