wrangler 0.0.0-eebdb6c → 0.0.0-ef13735

package/bin/wrangler.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-const { spawn } = require("child_process");
-const { join } = require("path");
+const { spawn } = require("node:child_process");
+const { join } = require("node:path");
 const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrangler",
-  "version": "0.0.0-eebdb6c",
+  "version": "0.0.0-ef13735",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
   "bin": {
@@ -36,10 +36,11 @@
     "cli"
   ],
   "dependencies": {
-    "esbuild": "0.14.1",
-    "miniflare": "2.0.0-rc.5",
+    "esbuild": "0.14.14",
+    "miniflare": "2.3.0",
     "path-to-regexp": "^6.2.0",
-    "semiver": "^1.1.0"
+    "semiver": "^1.1.0",
+    "xxhash-wasm": "^1.0.1"
   },
   "optionalDependencies": {
     "fsevents": "~2.3.2"
@@ -47,8 +48,8 @@
   "devDependencies": {
     "@babel/types": "^7.16.0",
     "@iarna/toml": "^2.2.5",
-    "@types/mime": "^2.0.3",
     "@types/estree": "^0.0.50",
+    "@types/mime": "^2.0.3",
     "@types/react": "^17.0.37",
     "@types/serve-static": "^1.13.10",
     "@types/signal-exit": "^3.0.1",
@@ -58,25 +59,28 @@
     "acorn-walk": "^8.2.0",
     "chokidar": "^3.5.2",
     "clipboardy": "^3.0.0",
+    "cmd-shim": "^4.1.0",
     "command-exists": "^1.2.9",
+    "devtools-protocol": "^0.0.955664",
     "execa": "^6.0.0",
     "faye-websocket": "^0.11.4",
     "finalhandler": "^1.1.2",
     "find-up": "^6.2.0",
-    "formdata-node": "^4.3.1",
+    "ignore": "^5.2.0",
     "ink": "^3.2.0",
     "ink-select-input": "^4.2.1",
     "ink-table": "^3.0.0",
+    "ink-testing-library": "^2.1.0",
     "ink-text-input": "^4.0.2",
+    "jest-fetch-mock": "^3.0.3",
     "mime": "^3.0.0",
-    "node-fetch": "^3.1.0",
     "open": "^8.4.0",
     "react": "^17.0.2",
     "react-error-boundary": "^3.1.4",
     "serve-static": "^1.14.1",
     "signal-exit": "^3.0.6",
     "tmp-promise": "^3.0.3",
-    "undici": "^4.11.1",
+    "undici": "4.13.0",
     "ws": "^8.3.0",
     "yargs": "^17.3.0"
   },
@@ -86,28 +90,31 @@
     "pages",
     "miniflare-config-stubs",
     "wrangler-dist",
-    "static-asset-facade.js",
+    "templates",
     "vendor",
     "import_meta_url.js"
   ],
   "scripts": {
     "clean": "rm -rf wrangler-dist",
+    "check:type": "tsc",
     "bundle": "node -r esbuild-register scripts/bundle.ts",
     "build": "npm run clean && npm run bundle",
     "start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
-    "test": "CF_API_TOKEN=some-api-token CF_ACCOUNT_ID=some-account-id jest --silent=false --verbose=true"
+    "test": "jest --silent=false --verbose=true",
+    "test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
   },
   "engines": {
     "node": ">=16.7.0"
   },
   "jest": {
     "restoreMocks": true,
+    "testTimeout": 30000,
     "testRegex": ".*.(test|spec)\\.[jt]sx?$",
     "transformIgnorePatterns": [
-      "node_modules/(?!node-fetch|fetch-blob|find-up|locate-path|p-locate|p-limit|yocto-queue|path-exists|data-uri-to-buffer|formdata-polyfill|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream)"
+      "node_modules/(?!find-up|locate-path|p-locate|p-limit|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream)"
     ],
     "moduleNameMapper": {
-      "clipboardy": "<rootDir>/src/__tests__/clipboardy-mock.js"
+      "clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js"
     },
     "transform": {
       "^.+\\.c?(t|j)sx?$": [

package/pages/functions/buildWorker.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import { build } from "esbuild";
 
 type Options = {
@@ -6,6 +6,7 @@ type Options = {
   outfile: string;
   minify?: boolean;
   sourcemap?: boolean;
+  fallbackService?: string;
   watch?: boolean;
   onEnd?: () => void;
 };
@@ -15,6 +16,7 @@ export function buildWorker({
   outfile = "bundle.js",
   minify = false,
   sourcemap = false,
+  fallbackService = "ASSETS",
   watch = false,
   onEnd = () => {},
 }: Options) {
@@ -31,6 +33,9 @@ export function buildWorker({
     sourcemap,
     watch,
     allowOverwrite: true,
+    define: {
+      __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
+    },
     plugins: [
       {
         name: "wrangler notifier and monitor",

package/pages/functions/filepath-routing.test.ts

@@ -1,32 +1,66 @@
+import { toUrlPath } from "../../src/paths";
 import { compareRoutes } from "./filepath-routing";
+import type { HTTPMethod, RouteConfig } from "./routes";
 
 describe("compareRoutes()", () => {
+  test("routes / last", () => {
+    expect(
+      compareRoutes(routeConfig("/"), routeConfig("/foo"))
+    ).toBeGreaterThanOrEqual(1);
+    expect(
+      compareRoutes(routeConfig("/"), routeConfig("/:foo"))
+    ).toBeGreaterThanOrEqual(1);
+    expect(
+      compareRoutes(routeConfig("/"), routeConfig("/:foo*"))
+    ).toBeGreaterThanOrEqual(1);
+  });
+
   test("routes with fewer segments come after those with more segments", () => {
-    expect(compareRoutes("/foo", "/foo/bar")).toBe(1);
+    expect(
+      compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar"))
+    ).toBeGreaterThanOrEqual(1);
+    expect(
+      compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar/cat"))
+    ).toBeGreaterThanOrEqual(1);
   });
 
   test("routes with wildcard segments come after those without", () => {
-    expect(compareRoutes("/:foo*", "/foo")).toBe(1);
-    expect(compareRoutes("/:foo*", "/:foo")).toBe(1);
+    expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/foo"))).toBe(1);
+    expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/:foo"))).toBe(1);
   });
 
   test("routes with dynamic segments come after those without", () => {
-    expect(compareRoutes("/:foo", "/foo")).toBe(1);
+    expect(compareRoutes(routeConfig("/:foo"), routeConfig("/foo"))).toBe(1);
   });
 
-  test("routes with dynamic segments occuring earlier come after those with dynamic segments in later positions", () => {
-    expect(compareRoutes("/foo/:id/bar", "/foo/bar/:id")).toBe(1);
+  test("routes with dynamic segments occurring earlier come after those with dynamic segments in later positions", () => {
+    expect(
+      compareRoutes(routeConfig("/foo/:id/bar"), routeConfig("/foo/bar/:id"))
+    ).toBe(1);
   });
 
   test("routes with no HTTP method come after those specifying a method", () => {
-    expect(compareRoutes("/foo", "GET /foo")).toBe(1);
+    expect(compareRoutes(routeConfig("/foo"), routeConfig("/foo", "GET"))).toBe(
+      1
+    );
   });
 
   test("two equal routes are sorted according to their original position in the list", () => {
-    expect(compareRoutes("GET /foo", "GET /foo")).toBe(0);
+    expect(
+      compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo", "GET"))
+    ).toBe(0);
   });
 
   test("it returns -1 if the first argument should appear first in the list", () => {
-    expect(compareRoutes("GET /foo", "/foo")).toBe(-1);
+    expect(compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo"))).toBe(
+      -1
+    );
   });
 });
+
+function routeConfig(routePath: string, method?: string): RouteConfig {
+  return {
+    routePath: toUrlPath(routePath),
+    method: method as HTTPMethod,
+  };
+}

package/pages/functions/filepath-routing.ts

@@ -1,39 +1,33 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import path from "path";
-import fs from "fs/promises";
-import { transform } from "esbuild";
+import fs from "node:fs/promises";
+import path from "node:path";
 import * as acorn from "acorn";
 import * as acornWalk from "acorn-walk";
-import type { Config } from "./routes";
-import type { Identifier } from "estree";
-import type { ExportNamedDeclaration } from "@babel/types";
-
-type Arguments = {
-  baseDir: string;
-  baseURL: string;
-};
+import { transform } from "esbuild";
+import { toUrlPath } from "../../src/paths";
+import type { UrlPath } from "../../src/paths";
+import type { HTTPMethod, RouteConfig } from "./routes";
+import type { ExportNamedDeclaration, Identifier } from "estree";
 
 export async function generateConfigFromFileTree({
   baseDir,
   baseURL,
-}: Arguments) {
-  let routeEntries: [
-    string,
-    { [key in "module" | "middleware"]?: string[] }
-  ][] = [] as any;
+}: {
+  baseDir: string;
+  baseURL: UrlPath;
+}) {
+  let routeEntries: RouteConfig[] = [];
 
   if (!baseURL.startsWith("/")) {
-    baseURL = `/${baseURL}`;
+    baseURL = `/${baseURL}` as UrlPath;
   }
 
   if (baseURL.endsWith("/")) {
-    baseURL = baseURL.slice(0, -1);
+    baseURL = baseURL.slice(0, -1) as UrlPath;
   }
 
   await forEachFile(baseDir, async (filepath) => {
     const ext = path.extname(filepath);
-    if (/\.(mjs|js|ts)/.test(ext)) {
+    if (/^\.(mjs|js|ts|tsx|jsx)$/.test(ext)) {
       // transform the code to ensure we're working with vanilla JS + ESM
       const { code } = await transform(await fs.readFile(filepath, "utf-8"), {
         loader: ext === ".ts" ? "ts" : "js",
@@ -45,8 +39,10 @@ export async function generateConfigFromFileTree({
         sourceType: "module",
       });
       acornWalk.simple(ast, {
-        ExportNamedDeclaration(_node) {
-          const node: ExportNamedDeclaration = _node as any;
+        ExportNamedDeclaration(_node: unknown) {
+          // This dynamic cast assumes that the AST generated by acornWalk will generate nodes that
+          // are compatible with the eslint AST nodes.
+          const node = _node as ExportNamedDeclaration;
 
           // this is an array because multiple things can be exported from a single statement
           // i.e. `export {foo, bar}` or `export const foo = "f", bar = "b"`
@@ -56,7 +52,7 @@ export async function generateConfigFromFileTree({
             const declaration = node.declaration;
 
             // `export async function onRequest() {...}`
-            if (declaration.type === "FunctionDeclaration") {
+            if (declaration.type === "FunctionDeclaration" && declaration.id) {
               exportNames.push(declaration.id.name);
             }
 
@@ -82,10 +78,9 @@ export async function generateConfigFromFileTree({
           }
 
           for (const exportName of exportNames) {
-            const [match, method] =
-              exportName.match(
-                /^onRequest(Get|Post|Put|Patch|Delete|Options|Head)?$/
-              ) ?? [];
+            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);
@@ -112,18 +107,15 @@ export async function generateConfigFromFileTree({
               routePath = routePath.replace(/\[\[(.+)]]/g, ":$1*"); // transform [[id]] => :id*
               routePath = routePath.replace(/\[(.+)]/g, ":$1"); // transform [id] => :id
 
-              if (method) {
-                routePath = `${method.toUpperCase()} ${routePath}`;
-              }
+              const routeEntry: RouteConfig = {
+                routePath: toUrlPath(routePath),
+                method: method.toUpperCase() as HTTPMethod,
+                [isMiddlewareFile ? "middleware" : "module"]: [
+                  `${path.relative(baseDir, filepath)}:${exportName}`,
+                ],
+              };
 
-              routeEntries.push([
-                routePath,
-                {
-                  [isMiddlewareFile ? "middleware" : "module"]: [
-                    `${path.relative(baseDir, filepath)}:${exportName}`,
-                  ],
-                },
-              ]);
+              routeEntries.push(routeEntry);
             }
           }
         },
@@ -133,45 +125,40 @@ export async function generateConfigFromFileTree({
 
   // Combine together any routes (index routes) which contain both a module and a middleware
   routeEntries = routeEntries.reduce(
-    (acc: typeof routeEntries, [routePath, routeHandler]) => {
+    (acc: typeof routeEntries, { routePath, ...rest }) => {
       const existingRouteEntry = acc.find(
-        (routeEntry) => routeEntry[0] === routePath
+        (routeEntry) => routeEntry.routePath === routePath
       );
       if (existingRouteEntry !== undefined) {
-        existingRouteEntry[1] = {
-          ...existingRouteEntry[1],
-          ...routeHandler,
-        };
+        Object.assign(existingRouteEntry, rest);
       } else {
-        acc.push([routePath, routeHandler]);
+        acc.push({ routePath, ...rest });
       }
       return acc;
     },
     []
   );
 
-  routeEntries.sort(([pathA], [pathB]) => compareRoutes(pathA, pathB));
+  routeEntries.sort((a, b) => compareRoutes(a, b));
 
-  return { routes: Object.fromEntries(routeEntries) } as Config;
+  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(a: string, b: string) {
-  function parseRoutePath(routePath: string) {
-    let [method, segmentedPath] = routePath.split(" ");
-    if (!segmentedPath) {
-      segmentedPath = method;
-      method = null;
-    }
-
-    const segments = segmentedPath.slice(1).split("/");
-    return [method, segments];
+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 [methodA, segmentsA] = parseRoutePath(a);
-  const [methodB, segmentsB] = parseRoutePath(b);
+  const segmentsA = parseRoutePath(routePathA);
+  const segmentsB = parseRoutePath(routePathB);
 
   // sort routes with fewer segments after those with more segments
   if (segmentsA.length !== segmentsB.length) {
@@ -197,8 +184,8 @@ export function compareRoutes(a: string, b: string) {
   if (methodA && !methodB) return -1;
   if (!methodA && methodB) return 1;
 
-  // all else equal, just sort them lexicographically
-  return a.localeCompare(b);
+  // all else equal, just sort the paths lexicographically
+  return routePathA.localeCompare(routePathB);
 }
 
 async function forEachFile<T>(
@@ -208,7 +195,7 @@ async function forEachFile<T>(
   const searchPaths = [baseDir];
   const returnValues: T[] = [];
 
-  while (searchPaths.length) {
+  while (isNotEmpty(searchPaths)) {
     const cwd = searchPaths.shift();
     const dir = await fs.readdir(cwd, { withFileTypes: true });
     for (const entry of dir) {
@@ -223,3 +210,10 @@ async function forEachFile<T>(
 
   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

@@ -68,7 +68,7 @@ export const validIdentifierRegex = new RegExp(
   "u"
 );
 
-export const isValidIdentifer = (identifier: string) =>
+export const isValidIdentifier = (identifier: string) =>
   validIdentifierRegex.test(identifier);
 
 export const normalizeIdentifier = (identifier: string) =>

package/pages/functions/routes.ts

@@ -1,8 +1,7 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import path from "path";
-import fs from "fs/promises";
-import { isValidIdentifer, normalizeIdentifier } from "./identifiers";
+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",
@@ -17,26 +16,26 @@ export type HTTPMethod = typeof HTTP_METHODS[number];
 export function isHTTPMethod(
   maybeHTTPMethod: string
 ): maybeHTTPMethod is HTTPMethod {
-  return HTTP_METHODS.includes(maybeHTTPMethod as any);
+  return (HTTP_METHODS as readonly string[]).includes(maybeHTTPMethod);
 }
 
 export type RoutesCollection = Array<{
-  routePath: string;
-  methods: HTTPMethod[];
+  routePath: UrlPath;
+  method?: HTTPMethod;
   modules: string[];
   middlewares: string[];
 }>;
 
 export type Config = {
-  routes?: RoutesConfig;
-  schedules?: any;
+  routes?: RouteConfig[];
+  schedules?: unknown;
 };
 
-export type RoutesConfig = {
-  [route: string]: {
-    middleware?: string | string[];
-    module?: string | string[];
-  };
+export type RouteConfig = {
+  routePath: UrlPath;
+  method?: HTTPMethod;
+  middleware?: string | string[];
+  module?: string | string[];
 };
 
 type ImportMap = Map<
@@ -93,7 +92,7 @@ export function parseConfig(config: Config, baseDir: string) {
       }
 
       // ensure the module name (if provided) is a valid identifier to guard against injection attacks
-      if (name !== "default" && !isValidIdentifer(name)) {
+      if (name !== "default" && !isValidIdentifier(name)) {
         throw new Error(`Invalid module identifier "${name}"`);
       }
 
@@ -114,16 +113,10 @@ export function parseConfig(config: Config, baseDir: string) {
     });
   }
 
-  for (const [route, props] of Object.entries(config.routes)) {
-    let [_methods, routePath] = route.split(" ");
-    if (!routePath) {
-      routePath = _methods;
-      _methods = "";
-    }
-
+  for (const { routePath, method, ...props } of config.routes ?? []) {
     routes.push({
       routePath,
-      methods: _methods.split("|").filter(isHTTPMethod),
+      method,
       middlewares: parseModuleIdentifiers(props.middleware),
       modules: parseModuleIdentifiers(props.module),
     });
@@ -148,7 +141,7 @@ export const routes = [
     .map(
       (route) => `  {
       routePath: "${route.routePath}",
-      methods: ${JSON.stringify(route.methods)},
+      method: "${route.method}",
       middlewares: [${route.middlewares.join(", ")}],
       modules: [${route.modules.join(", ")}],
     },`

package/pages/functions/template-worker.ts

@@ -1,14 +1,12 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import { match } from "path-to-regexp";
 import type { HTTPMethod } from "./routes";
 
 /* TODO: Grab these from @cloudflare/workers-types instead */
-type Params<P extends string = any> = Record<P, string | string[]>;
+type Params<P extends string = string> = Record<P, string | string[]>;
 
 type EventContext<Env, P extends string, Data> = {
   request: Request;
-  waitUntil: (promise: Promise<any>) => void;
+  waitUntil: (promise: Promise<unknown>) => void;
   next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
   env: Env & { ASSETS: { fetch: typeof fetch } };
   params: Params<P>;
@@ -17,40 +15,39 @@ type EventContext<Env, P extends string, Data> = {
 
 declare type PagesFunction<
   Env = unknown,
-  P extends string = any,
+  P extends string = string,
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
 /* end @cloudflare/workers-types */
 
 type RouteHandler = {
   routePath: string;
-  methods: HTTPMethod[];
+  method?: HTTPMethod;
   modules: PagesFunction[];
   middlewares: PagesFunction[];
 };
 
 // inject `routes` via ESBuild
 declare const routes: RouteHandler[];
+// define `__FALLBACK_SERVICE__` via ESBuild
+declare const __FALLBACK_SERVICE__: string;
 
 // expect an ASSETS fetcher binding pointing to the asset-server stage
-type Env = {
-  [name: string]: any;
-  ASSETS: { fetch(url: string, init: RequestInit): Promise<Response> };
+type FetchEnv = {
+  [name: string]: { fetch: typeof fetch };
+  ASSETS: { fetch: typeof fetch };
 };
 
 type WorkerContext = {
-  waitUntil: (promise: Promise<any>) => void;
+  waitUntil: (promise: Promise<unknown>) => void;
 };
 
-function* executeRequest(request: Request, env: Env) {
+function* executeRequest(request: Request, _env: FetchEnv) {
   const requestPath = new URL(request.url).pathname;
 
-  // First, iterate through the routes and execute "middlewares" on partial route matches
-  for (const route of routes) {
-    if (
-      route.methods.length &&
-      !route.methods.includes(request.method as HTTPMethod)
-    ) {
+  // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
+  for (const route of [...routes].reverse()) {
+    if (route.method && route.method !== request.method) {
       continue;
     }
 
@@ -68,10 +65,7 @@ function* executeRequest(request: Request, env: Env) {
 
   // Then look for the first exact route match and execute its "modules"
   for (const route of routes) {
-    if (
-      route.methods.length &&
-      !route.methods.includes(request.method as HTTPMethod)
-    ) {
+    if (route.method && route.method !== request.method) {
       continue;
     }
 
@@ -87,16 +81,10 @@ function* executeRequest(request: Request, env: Env) {
       break;
     }
   }
-
-  // Finally, yield to the asset-server
-  return {
-    handler: () => env.ASSETS.fetch(request.url, request),
-    params: {} as Params,
-  };
 }
 
 export default {
-  async fetch(request: Request, env: Env, workerContext: WorkerContext) {
+  async fetch(request: Request, env: FetchEnv, workerContext: WorkerContext) {
     const handlerIterator = executeRequest(request, env);
     const data = {}; // arbitrary data the user can set between functions
     const next = async (input?: RequestInfo, init?: RequestInit) => {
@@ -104,10 +92,11 @@ export default {
         request = new Request(input, init);
       }
 
-      const { value } = handlerIterator.next();
-      if (value) {
-        const { handler, params } = value;
-        const context: EventContext<unknown, any, any> = {
+      const result = handlerIterator.next();
+      // Note we can't use `!result.done` because this doesn't narrow to the correct type
+      if (result.done == false) {
+        const { handler, params } = result.value;
+        const context = {
           request: new Request(request.clone()),
           next,
           params,
@@ -123,6 +112,12 @@ export default {
           [101, 204, 205, 304].includes(response.status) ? null : response.body,
           response
         );
+      } else if (__FALLBACK_SERVICE__) {
+        // There are no more handlers so finish with the fallback service (`env.ASSETS.fetch` in Pages' case)
+        return env[__FALLBACK_SERVICE__].fetch(request);
+      } else {
+        // There was not fallback service so actually make the request to the origin.
+        return fetch(request);
       }
     };