wrangler 0.0.0-bce731a → 0.0.0-bf2bee9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrangler",
-  "version": "0.0.0-bce731a",
+  "version": "0.0.0-bf2bee9",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
   "bin": {
@@ -36,7 +36,7 @@
     "cli"
   ],
   "dependencies": {
-    "esbuild": "0.14.14",
+    "esbuild": "0.14.23",
     "miniflare": "2.3.0",
     "path-to-regexp": "^6.2.0",
     "semiver": "^1.1.0",
@@ -46,12 +46,12 @@
     "fsevents": "~2.3.2"
   },
   "devDependencies": {
-    "@babel/types": "^7.16.0",
     "@iarna/toml": "^2.2.5",
     "@sentry/cli": "^1.71.0",
     "@sentry/integrations": "^6.17.6",
     "@sentry/node": "^6.17.6",
-    "@types/estree": "^0.0.50",
+    "@types/command-exists": "^1.2.0",
+    "@types/glob-to-regexp": "0.4.1",
     "@types/mime": "^2.0.3",
     "@types/prompts": "^2.0.14",
     "@types/react": "^17.0.37",
@@ -59,8 +59,6 @@
     "@types/signal-exit": "^3.0.1",
     "@types/ws": "^8.2.1",
     "@types/yargs": "^17.0.7",
-    "acorn": "^8.6.0",
-    "acorn-walk": "^8.2.0",
     "chokidar": "^3.5.2",
     "clipboardy": "^3.0.0",
     "cmd-shim": "^4.1.0",
@@ -70,6 +68,8 @@
     "faye-websocket": "^0.11.4",
     "finalhandler": "^1.1.2",
     "find-up": "^6.2.0",
+    "get-port": "^6.1.2",
+    "glob-to-regexp": "0.4.1",
     "ignore": "^5.2.0",
     "ink": "^3.2.0",
     "ink-select-input": "^4.2.1",
@@ -77,6 +77,7 @@
     "ink-testing-library": "^2.1.0",
     "ink-text-input": "^4.0.2",
     "jest-fetch-mock": "^3.0.3",
+    "jest-websocket-mock": "^2.3.0",
     "mime": "^3.0.0",
     "open": "^8.4.0",
     "prompts": "^2.4.2",
@@ -104,6 +105,7 @@
     "check:type": "tsc",
     "bundle": "node -r esbuild-register scripts/bundle.ts",
     "build": "npm run clean && npm run bundle",
+    "prepublishOnly": "npm run build",
     "start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
     "test": "jest --silent=false --verbose=true",
     "test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
@@ -116,7 +118,7 @@
     "testTimeout": 30000,
     "testRegex": ".*.(test|spec)\\.[jt]sx?$",
     "transformIgnorePatterns": [
-      "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)"
+      "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|get-port)"
     ],
     "moduleNameMapper": {
       "clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js"

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

@@ -1,60 +1,117 @@
+import { writeFileSync } from "fs";
+import { runInTempDir } from "../../src/__tests__/helpers/run-in-tmp";
 import { toUrlPath } from "../../src/paths";
-import { compareRoutes } from "./filepath-routing";
+import { compareRoutes, generateConfigFromFileTree } from "./filepath-routing";
+import type { UrlPath } from "../../src/paths";
 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);
-  });
+describe("filepath-routing", () => {
+  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(routeConfig("/foo"), routeConfig("/foo/bar"))
-    ).toBeGreaterThanOrEqual(1);
-    expect(
-      compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar/cat"))
-    ).toBeGreaterThanOrEqual(1);
-  });
+    test("routes with fewer segments come after those with more segments", () => {
+      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(routeConfig("/:foo*"), routeConfig("/foo"))).toBe(1);
-    expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/:foo"))).toBe(1);
-  });
+    test("routes with wildcard segments come after those without", () => {
+      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(routeConfig("/:foo"), routeConfig("/foo"))).toBe(1);
-  });
+    test("routes with dynamic segments come after those without", () => {
+      expect(compareRoutes(routeConfig("/:foo"), routeConfig("/foo"))).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 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(routeConfig("/foo"), routeConfig("/foo", "GET"))).toBe(
-      1
-    );
-  });
+    test("routes with no HTTP method come after those specifying a method", () => {
+      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(routeConfig("/foo", "GET"), routeConfig("/foo", "GET"))
+      ).toBe(0);
+    });
 
-  test("two equal routes are sorted according to their original position in the list", () => {
-    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(routeConfig("/foo", "GET"), routeConfig("/foo"))
+      ).toBe(-1);
+    });
   });
 
-  test("it returns -1 if the first argument should appear first in the list", () => {
-    expect(compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo"))).toBe(
-      -1
-    );
+  describe("generateConfigFromFileTree", () => {
+    runInTempDir();
+
+    it("should generate a route entry for each file in the tree", async () => {
+      writeFileSync(
+        "foo.ts",
+        `
+      export function onRequestGet() {}
+      export function onRequestPost() {}
+      `
+      );
+      writeFileSync(
+        "bar.ts",
+        `
+      export function onRequestPut() {}
+      export function onRequestDelete() {}
+      `
+      );
+
+      const entries = await generateConfigFromFileTree({
+        baseDir: ".",
+        baseURL: "/base" as UrlPath,
+      });
+      expect(entries).toEqual({
+        routes: [
+          {
+            method: "DELETE",
+            module: ["bar.ts:onRequestDelete"],
+            routePath: "/base/bar",
+          },
+          {
+            method: "PUT",
+            module: ["bar.ts:onRequestPut"],
+            routePath: "/base/bar",
+          },
+          {
+            method: "GET",
+            module: ["foo.ts:onRequestGet"],
+            routePath: "/base/foo",
+          },
+          {
+            method: "POST",
+            module: ["foo.ts:onRequestPost"],
+            routePath: "/base/foo",
+          },
+        ],
+      });
+    });
   });
 });
 

package/pages/functions/filepath-routing.ts

@@ -1,12 +1,9 @@
 import fs from "node:fs/promises";
 import path from "node:path";
-import * as acorn from "acorn";
-import * as acornWalk from "acorn-walk";
-import { transform } from "esbuild";
+import { build } 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,
@@ -28,106 +25,68 @@ export async function generateConfigFromFileTree({
   await forEachFile(baseDir, async (filepath) => {
     const ext = path.extname(filepath);
     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",
+      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)[];
 
-      // parse each file into an AST and search for module exports that match "onRequest" and friends
-      const ast = acorn.parse(code, {
-        ecmaVersion: "latest",
-        sourceType: "module",
-      });
-      acornWalk.simple(ast, {
-        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"`
-          const exportNames: string[] = [];
-
-          if (node.declaration) {
-            const declaration = node.declaration;
-
-            // `export async function onRequest() {...}`
-            if (declaration.type === "FunctionDeclaration" && declaration.id) {
-              exportNames.push(declaration.id.name);
-            }
-
-            // `export const onRequestGet = () => {}, onRequestPost = () => {}`
-            if (declaration.type === "VariableDeclaration") {
-              exportNames.push(
-                ...declaration.declarations.map(
-                  (variableDeclarator) =>
-                    (variableDeclarator.id as unknown as Identifier).name
-                )
-              );
-            }
-          }
-
-          // `export {foo, bar}`
-          if (node.specifiers.length) {
-            exportNames.push(
-              ...node.specifiers.map(
-                (exportSpecifier) =>
-                  (exportSpecifier.exported as unknown as Identifier).name
-              )
-            );
-          }
-
-          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);
+        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_";
+          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 routePath = path
+            .relative(baseDir, filepath)
+            .slice(0, -ext.length);
 
-              if (isIndexFile || isMiddlewareFile) {
-                routePath = path.dirname(routePath);
-              }
+          if (isIndexFile || isMiddlewareFile) {
+            routePath = path.dirname(routePath);
+          }
 
-              if (routePath === ".") {
-                routePath = "";
-              }
+          if (routePath === ".") {
+            routePath = "";
+          }
 
-              routePath = `${baseURL}/${routePath}`;
+          routePath = `${baseURL}/${routePath}`;
 
-              routePath = routePath.replace(/\[\[(.+)]]/g, ":$1*"); // transform [[id]] => :id*
-              routePath = routePath.replace(/\[(.+)]/g, ":$1"); // transform [id] => :id
+          routePath = routePath.replace(/\[\[(.+)]]/g, ":$1*"); // transform [[id]] => :id*
+          routePath = routePath.replace(/\[(.+)]/g, ":$1"); // transform [id] => :id
 
-              const routeEntry: RouteConfig = {
-                routePath: toUrlPath(routePath),
-                method: method.toUpperCase() as HTTPMethod,
-                [isMiddlewareFile ? "middleware" : "module"]: [
-                  `${path.relative(baseDir, filepath)}:${exportName}`,
-                ],
-              };
+          const routeEntry: RouteConfig = {
+            routePath: toUrlPath(routePath),
+            method: method.toUpperCase() as HTTPMethod,
+            [isMiddlewareFile ? "middleware" : "module"]: [
+              `${path.relative(baseDir, filepath)}:${exportName}`,
+            ],
+          };
 
-              routeEntries.push(routeEntry);
-            }
-          }
-        },
-      });
+          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) =>
+          routeEntry.routePath === routePath &&
+          routeEntry.method === rest.method
       );
       if (existingRouteEntry !== undefined) {
         Object.assign(existingRouteEntry, rest);