wrangler 0.0.8 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrangler",
-  "version": "0.0.8",
+  "version": "0.0.13",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
   "bin": {
@@ -37,9 +37,10 @@
   ],
   "dependencies": {
     "esbuild": "0.14.1",
-    "miniflare": "2.0.0",
+    "miniflare": "2.2.0",
     "path-to-regexp": "^6.2.0",
-    "semiver": "^1.1.0"
+    "semiver": "^1.1.0",
+    "xxhash-addon": "^1.4.0"
   },
   "optionalDependencies": {
     "fsevents": "~2.3.2"
@@ -65,13 +66,14 @@
     "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",
     "mime": "^3.0.0",
-    "node-fetch": "^3.1.0",
+    "node-fetch": "3.1.1",
     "open": "^8.4.0",
     "react": "^17.0.2",
     "react-error-boundary": "^3.1.4",
@@ -97,13 +99,15 @@
     "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": "CF_API_TOKEN=some-api-token CF_ACCOUNT_ID=some-account-id 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)"

package/pages/functions/filepath-routing.ts

@@ -52,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);
             }
 
@@ -155,12 +155,12 @@ export async function generateConfigFromFileTree({
 // 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;
-    }
+  function parseRoutePath(routePath: string): [string | null, string[]] {
+    const parts = routePath.split(" ", 2);
+    // split() will guarantee at least one element.
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const segmentedPath = parts.pop()!;
+    const method = parts.pop() ?? null;
 
     const segments = segmentedPath.slice(1).split("/").filter(Boolean);
     return [method, segments];
@@ -204,7 +204,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) {
@@ -219,3 +219,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/routes.ts

@@ -114,7 +114,7 @@ export function parseConfig(config: Config, baseDir: string) {
     });
   }
 
-  for (const [route, props] of Object.entries(config.routes)) {
+  for (const [route, props] of Object.entries(config.routes ?? {})) {
     let [_methods, routePath] = route.split(" ");
     if (!routePath) {
       routePath = _methods;

package/pages/functions/template-worker.ts

@@ -33,17 +33,16 @@ declare const routes: RouteHandler[];
 declare const __FALLBACK_SERVICE__: string;
 
 // expect an ASSETS fetcher binding pointing to the asset-server stage
-type Env = {
-  [name: string]: unknown;
-  ASSETS: { fetch(url: string, init: RequestInit): Promise<Response> };
+type FetchEnv = {
+  [name: string]: { fetch: typeof fetch };
+  ASSETS: { fetch: typeof fetch };
 };
 
 type WorkerContext = {
   waitUntil: (promise: Promise<unknown>) => void;
 };
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars -- `env` can be used by __FALLBACK_SERVICE_FETCH__
-function* executeRequest(request: Request, env: Env) {
+function* executeRequest(request: Request, _env: FetchEnv) {
   const requestPath = new URL(request.url).pathname;
 
   // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
@@ -88,20 +87,10 @@ function* executeRequest(request: Request, env: Env) {
       break;
     }
   }
-
-  // Finally, yield to the fallback service (`env.ASSETS.fetch` in Pages' case)
-  return {
-    handler: () =>
-      __FALLBACK_SERVICE__
-        ? // @ts-expect-error expecting __FALLBACK_SERVICE__ to be the name of a service binding, so fetch should be defined
-          env[__FALLBACK_SERVICE__].fetch(request)
-        : fetch(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) => {
@@ -109,14 +98,11 @@ export default {
         request = new Request(input, init);
       }
 
-      const { value } = handlerIterator.next();
-      if (value) {
-        const { handler, params } = value;
-        const context: EventContext<
-          unknown,
-          string,
-          Record<string, unknown>
-        > = {
+      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,
@@ -132,6 +118,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);
       }
     };
 

package/src/__tests__/dev.test.tsx

@@ -15,9 +15,10 @@ describe("Dev component", () => {
       accountId: "some-account-id",
       public: "some/public/path",
     });
-    expect(lastFrame()).toMatchInlineSnapshot(`
+    expect(lastFrame()?.split("\n").slice(0, 2).join("\n"))
+      .toMatchInlineSnapshot(`
       "Something went wrong:
-      You cannot use the service worker format with a \`public\` directory."
+      Error: You cannot use the service worker format with a \`public\` directory."
     `);
   });
 });
@@ -38,7 +39,7 @@ function renderDev({
   jsxFragment,
   bindings = {},
   public: publicDir,
-  site,
+  assetPaths,
   compatibilityDate,
   compatibilityFlags,
   usageModel,
@@ -55,7 +56,7 @@ function renderDev({
       jsxFactory={jsxFactory}
       jsxFragment={jsxFragment}
       accountId={accountId}
-      site={site}
+      assetPaths={assetPaths}
       public={publicDir}
       compatibilityDate={compatibilityDate}
       compatibilityFlags={compatibilityFlags}

package/src/__tests__/index.test.ts

@@ -3,20 +3,24 @@ import * as TOML from "@iarna/toml";
 import { mockConfirm } from "./mock-dialogs";
 import { runWrangler } from "./run-wrangler";
 import { runInTempDir } from "./run-in-tmp";
+import { mockConsoleMethods } from "./mock-console";
 import * as fs from "node:fs";
 
 describe("wrangler", () => {
   runInTempDir();
 
+  const std = mockConsoleMethods();
+
   describe("no command", () => {
     it("should display a list of available commands", async () => {
-      const { stdout, stderr } = await runWrangler();
+      await runWrangler();
 
-      expect(stdout).toMatchInlineSnapshot(`
+      expect(std.out).toMatchInlineSnapshot(`
         "wrangler
 
         Commands:
           wrangler init [name]       📥 Create a wrangler.toml configuration file
+          wrangler whoami            🕵️  Retrieve your user info and test your auth config
           wrangler dev <filename>    👂 Start a local server for developing your worker
           wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
           wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
@@ -35,20 +39,28 @@ describe("wrangler", () => {
           -l, --local  Run on my machine  [boolean] [default: false]"
       `);
 
-      expect(stderr).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`""`);
     });
   });
 
   describe("invalid command", () => {
     it("should display an error", async () => {
-      const { error, stdout, stderr } = await runWrangler("invalid-command");
-
-      expect(stdout).toMatchInlineSnapshot(`""`);
-      expect(stderr).toMatchInlineSnapshot(`
+      let err: Error | undefined;
+      try {
+        await runWrangler("invalid-command");
+      } catch (e) {
+        err = e;
+      } finally {
+        expect(err?.message).toBe(`Unknown command: invalid-command.`);
+      }
+
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`
         "wrangler
 
         Commands:
           wrangler init [name]       📥 Create a wrangler.toml configuration file
+          wrangler whoami            🕵️  Retrieve your user info and test your auth config
           wrangler dev <filename>    👂 Start a local server for developing your worker
           wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
           wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
@@ -68,9 +80,6 @@ describe("wrangler", () => {
 
         Unknown command: invalid-command."
       `);
-      expect(error).toMatchInlineSnapshot(
-        `[Error: Unknown command: invalid-command.]`
-      );
     });
   });
 
@@ -88,19 +97,27 @@ describe("wrangler", () => {
     });
 
     it("should display warning when wrangler.toml already exists, and exit if user does not want to carry on", async () => {
-      fs.writeFileSync("./wrangler.toml", "", "utf-8");
+      fs.writeFileSync(
+        "./wrangler.toml",
+        'compatibility_date="something-else"', // use a fake value to make sure the file is not overwritten
+        "utf-8"
+      );
       mockConfirm({
         text: "Do you want to continue initializing this project?",
         result: false,
       });
-      const { warnings } = await runWrangler("init");
-      expect(warnings).toContain("wrangler.toml file already exists!");
+      await runWrangler("init");
+      expect(std.warn).toContain("wrangler.toml file already exists!");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(typeof parsed.compatibility_date).toBe("undefined");
+      expect(parsed.compatibility_date).toBe("something-else");
     });
 
     it("should display warning when wrangler.toml already exists, but continue if user does want to carry on", async () => {
-      fs.writeFileSync("./wrangler.toml", "", "utf-8");
+      fs.writeFileSync(
+        "./wrangler.toml",
+        `compatibility_date="something-else"`,
+        "utf-8"
+      );
       mockConfirm(
         {
           text: "Do you want to continue initializing this project?",
@@ -111,10 +128,10 @@ describe("wrangler", () => {
           result: false,
         }
       );
-      const { warnings } = await runWrangler("init");
-      expect(warnings).toContain("wrangler.toml file already exists!");
+      await runWrangler("init");
+      expect(std.warn).toContain("wrangler.toml file already exists!");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(typeof parsed.compatibility_date).toBe("string");
+      expect(parsed.compatibility_date).toBe("something-else");
     });
 
     it("should create a package.json if none is found and user confirms", async () => {
@@ -135,14 +152,23 @@ describe("wrangler", () => {
       );
       expect(packageJson.name).toEqual("worker"); // TODO: should we infer the name from the directory?
       expect(packageJson.version).toEqual("0.0.1");
+      expect(packageJson.devDependencies).toEqual({
+        wrangler: expect.any(String),
+      });
       expect(fs.existsSync("./tsconfig.json")).toBe(false);
     });
 
     it("should not touch an existing package.json in the same directory", async () => {
-      mockConfirm({
-        text: "Would you like to use typescript?",
-        result: false,
-      });
+      mockConfirm(
+        {
+          text: "Would you like to install wrangler into your package.json?",
+          result: false,
+        },
+        {
+          text: "Would you like to use typescript?",
+          result: false,
+        }
+      );
 
       fs.writeFileSync(
         "./package.json",
@@ -158,11 +184,46 @@ describe("wrangler", () => {
       expect(packageJson.version).toEqual("1.0.0");
     });
 
-    it("should not touch an existing package.json in an ancestor directory", async () => {
-      mockConfirm({
-        text: "Would you like to use typescript?",
-        result: false,
+    it("should offer to install wrangler into an existing package.json", async () => {
+      mockConfirm(
+        {
+          text: "Would you like to install wrangler into your package.json?",
+          result: true,
+        },
+        {
+          text: "Would you like to use typescript?",
+          result: false,
+        }
+      );
+
+      fs.writeFileSync(
+        "./package.json",
+        JSON.stringify({ name: "test", version: "1.0.0" }),
+        "utf-8"
+      );
+
+      await runWrangler("init");
+      const packageJson = JSON.parse(
+        fs.readFileSync("./package.json", "utf-8")
+      );
+      expect(packageJson.name).toEqual("test");
+      expect(packageJson.version).toEqual("1.0.0");
+      expect(packageJson.devDependencies).toEqual({
+        wrangler: expect.any(String),
       });
+    });
+
+    it("should not touch an existing package.json in an ancestor directory", async () => {
+      mockConfirm(
+        {
+          text: "Would you like to install wrangler into your package.json?",
+          result: false,
+        },
+        {
+          text: "Would you like to use typescript?",
+          result: false,
+        }
+      );
 
       fs.writeFileSync(
         "./package.json",
@@ -180,8 +241,12 @@ describe("wrangler", () => {
       const packageJson = JSON.parse(
         fs.readFileSync("../../package.json", "utf-8")
       );
-      expect(packageJson.name).toEqual("test");
-      expect(packageJson.version).toEqual("1.0.0");
+      expect(packageJson).toMatchInlineSnapshot(`
+        Object {
+          "name": "test",
+          "version": "1.0.0",
+        }
+      `);
     });
 
     it("should create a tsconfig.json and install `workers-types` if none is found and user confirms", async () => {
@@ -208,13 +273,21 @@ describe("wrangler", () => {
       );
       expect(packageJson.devDependencies).toEqual({
         "@cloudflare/workers-types": expect.any(String),
+        wrangler: expect.any(String),
       });
     });
 
     it("should not touch an existing tsconfig.json in the same directory", async () => {
       fs.writeFileSync(
         "./package.json",
-        JSON.stringify({ name: "test", version: "1.0.0" }),
+        JSON.stringify({
+          name: "test",
+          version: "1.0.0",
+          devDependencies: {
+            wrangler: "0.0.0",
+            "@cloudflare/workers-types": "0.0.0",
+          },
+        }),
         "utf-8"
       );
       fs.writeFileSync(
@@ -230,10 +303,56 @@ describe("wrangler", () => {
       expect(tsconfigJson.compilerOptions).toEqual({});
     });
 
-    it("should not touch an existing package.json in an ancestor directory", async () => {
+    it("should offer to install type definitions in an existing typescript project", async () => {
+      mockConfirm(
+        {
+          text: "Would you like to install wrangler into your package.json?",
+          result: false,
+        },
+        {
+          text: "Would you like to install the type definitions for Workers into your package.json?",
+          result: true,
+        }
+      );
       fs.writeFileSync(
         "./package.json",
-        JSON.stringify({ name: "test", version: "1.0.0" }),
+        JSON.stringify({
+          name: "test",
+          version: "1.0.0",
+        }),
+        "utf-8"
+      );
+      fs.writeFileSync(
+        "./tsconfig.json",
+        JSON.stringify({ compilerOptions: {} }),
+        "utf-8"
+      );
+
+      await runWrangler("init");
+      const tsconfigJson = JSON.parse(
+        fs.readFileSync("./tsconfig.json", "utf-8")
+      );
+      // unchanged tsconfig
+      expect(tsconfigJson.compilerOptions).toEqual({});
+      const packageJson = JSON.parse(
+        fs.readFileSync("./package.json", "utf-8")
+      );
+      expect(packageJson.devDependencies).toEqual({
+        "@cloudflare/workers-types": expect.any(String),
+      });
+    });
+
+    it("should not touch an existing tsconfig.json in an ancestor directory", async () => {
+      fs.writeFileSync(
+        "./package.json",
+        JSON.stringify({
+          name: "test",
+          version: "1.0.0",
+          devDependencies: {
+            wrangler: "0.0.0",
+            "@cloudflare/workers-types": "0.0.0",
+          },
+        }),
         "utf-8"
       );
       fs.writeFileSync(
@@ -256,32 +375,50 @@ describe("wrangler", () => {
     });
 
     it("should error if `--type` is used", async () => {
-      const { error } = await runWrangler("init --type");
-      expect(error).toMatchInlineSnapshot(
-        `[Error: The --type option is no longer supported.]`
-      );
+      let err: undefined | Error;
+      try {
+        await runWrangler("init --type");
+      } catch (e) {
+        err = e;
+      } finally {
+        expect(err?.message).toBe(`The --type option is no longer supported.`);
+      }
     });
 
     it("should error if `--type javascript` is used", async () => {
-      const { error } = await runWrangler("init --type javascript");
-      expect(error).toMatchInlineSnapshot(
-        `[Error: The --type option is no longer supported.]`
-      );
+      let err: undefined | Error;
+      try {
+        await runWrangler("init --type javascript");
+      } catch (e) {
+        err = e;
+      } finally {
+        expect(err?.message).toBe(`The --type option is no longer supported.`);
+      }
     });
 
     it("should error if `--type rust` is used", async () => {
-      const { error } = await runWrangler("init --type rust");
-      expect(error).toMatchInlineSnapshot(
-        `[Error: The --type option is no longer supported.]`
-      );
+      let err: undefined | Error;
+      try {
+        await runWrangler("init --type rust");
+      } catch (e) {
+        err = e;
+      } finally {
+        expect(err?.message).toBe(`The --type option is no longer supported.`);
+      }
     });
 
     it("should error if `--type webpack` is used", async () => {
-      const { error } = await runWrangler("init --type webpack");
-      expect(error).toMatchInlineSnapshot(`
-        [Error: The --type option is no longer supported.
-        If you wish to use webpack then you will need to create a custom build.]
-      `);
+      let err: undefined | Error;
+      try {
+        await runWrangler("init --type webpack");
+      } catch (e) {
+        err = e;
+      } finally {
+        expect(err?.message).toBe(
+          `The --type option is no longer supported.
+If you wish to use webpack then you will need to create a custom build.`
+        );
+      }
     });
   });
 });