wrangler 0.0.0-fb43821 → 0.0.0-fe5dcfd

package/pages/functions/template-worker.ts

@@ -0,0 +1,136 @@
+import { match } from "path-to-regexp";
+import type { HTTPMethod } from "./routes";
+
+/* TODO: Grab these from @cloudflare/workers-types instead */
+type Params<P extends string = string> = Record<P, string | string[]>;
+
+type EventContext<Env, P extends string, Data> = {
+  request: Request;
+  waitUntil: (promise: Promise<unknown>) => void;
+  next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
+  env: Env & { ASSETS: { fetch: typeof fetch } };
+  params: Params<P>;
+  data: Data;
+};
+
+declare type PagesFunction<
+  Env = unknown,
+  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[];
+  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 FetchEnv = {
+  [name: string]: { fetch: typeof fetch };
+  ASSETS: { fetch: typeof fetch };
+};
+
+type WorkerContext = {
+  waitUntil: (promise: Promise<unknown>) => void;
+};
+
+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
+  for (const route of [...routes].reverse()) {
+    if (
+      route.methods.length &&
+      !route.methods.includes(request.method as HTTPMethod)
+    ) {
+      continue;
+    }
+
+    const routeMatcher = match(route.routePath, { end: false });
+    const matchResult = routeMatcher(requestPath);
+    if (matchResult) {
+      for (const handler of route.middlewares.flat()) {
+        yield {
+          handler,
+          params: matchResult.params as Params,
+        };
+      }
+    }
+  }
+
+  // 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)
+    ) {
+      continue;
+    }
+
+    const routeMatcher = match(route.routePath, { end: true });
+    const matchResult = routeMatcher(requestPath);
+    if (matchResult && route.modules.length) {
+      for (const handler of route.modules.flat()) {
+        yield {
+          handler,
+          params: matchResult.params as Params,
+        };
+      }
+      break;
+    }
+  }
+}
+
+export default {
+  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) => {
+      if (input !== undefined) {
+        request = new Request(input, init);
+      }
+
+      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,
+          data,
+          env,
+          waitUntil: workerContext.waitUntil.bind(workerContext),
+        };
+
+        const response = await handler(context);
+
+        // https://fetch.spec.whatwg.org/#null-body-status
+        return new Response(
+          [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);
+      }
+    };
+
+    try {
+      return next();
+    } catch (err) {
+      return new Response("Internal Error", { status: 500 });
+    }
+  },
+};

package/src/__tests__/dev.test.tsx

@@ -0,0 +1,67 @@
+import { render } from "ink-testing-library";
+import patchConsole from "patch-console";
+import React from "react";
+import Dev from "../dev";
+import type { DevProps } from "../dev";
+
+describe("Dev component", () => {
+  let restoreConsole;
+  beforeEach(() => (restoreConsole = patchConsole(() => {})));
+  afterEach(() => restoreConsole());
+
+  it("should throw if format is service-worker and there is a public directory", () => {
+    const { lastFrame } = renderDev({
+      format: "service-worker",
+      accountId: "some-account-id",
+      public: "some/public/path",
+    });
+    expect(lastFrame()?.split("\n").slice(0, 2).join("\n"))
+      .toMatchInlineSnapshot(`
+      "Something went wrong:
+      Error: You cannot use the service worker format with a \`public\` directory."
+    `);
+  });
+});
+
+/**
+ * Helper function to make it easier to setup and render the `Dev` component.
+ *
+ * All the `Dev` props are optional here, with sensible defaults for testing.
+ */
+function renderDev({
+  name,
+  entry = "some/entry.ts",
+  port,
+  format,
+  accountId,
+  initialMode = "remote",
+  jsxFactory,
+  jsxFragment,
+  bindings = {},
+  public: publicDir,
+  assetPaths,
+  compatibilityDate,
+  compatibilityFlags,
+  usageModel,
+  buildCommand = {},
+}: Partial<DevProps>) {
+  return render(
+    <Dev
+      name={name}
+      entry={entry}
+      port={port}
+      buildCommand={buildCommand}
+      format={format}
+      initialMode={initialMode}
+      jsxFactory={jsxFactory}
+      jsxFragment={jsxFragment}
+      accountId={accountId}
+      assetPaths={assetPaths}
+      public={publicDir}
+      compatibilityDate={compatibilityDate}
+      compatibilityFlags={compatibilityFlags}
+      usageModel={usageModel}
+      bindings={bindings}
+    />
+  );
+}

package/src/__tests__/index.test.ts

@@ -1,73 +1,23 @@
-import * as fs from "node:fs";
 import * as fsp from "node:fs/promises";
-import * as os from "node:os";
-import * as path from "node:path";
 import * as TOML from "@iarna/toml";
-import { main } from "../index";
-import { setMock, unsetAllMocks } from "./mock-cfetch";
-import { confirm } from "../dialogs";
-
-jest.mock("../cfetch", () => jest.requireActual("./mock-cfetch"));
-
-jest.mock("../dialogs", () => {
-  return {
-    ...jest.requireActual<object>("../dialogs"),
-    confirm: jest
-      .fn()
-      .mockName("confirmMock")
-      .mockImplementation(() => {
-        // By default (if not configured by mockConfirm()) calls to `confirm()` should throw.
-        throw new Error("Unexpected call to `confirm()`.");
-      }),
-  };
-});
-
-/**
- * Mock the implementation of `confirm()` that will respond with configured results
- * for configured confirmation text messages.
- *
- * If there is a call to `confirm()` that does not match any of the expectations
- * then an error is thrown.
- */
-function mockConfirm(...expectations: { text: string; result: boolean }[]) {
-  (confirm as jest.Mock).mockImplementation((text: string) => {
-    for (const { text: expectedText, result } of expectations) {
-      if (text === expectedText) {
-        return result;
-      }
-    }
-    throw new Error(`Unexpected confirmation message: ${text}`);
-  });
-}
-
-async function w(cmd?: string) {
-  const logSpy = jest.spyOn(console, "log").mockImplementation();
-  const errorSpy = jest.spyOn(console, "error").mockImplementation();
-  const warnSpy = jest.spyOn(console, "warn").mockImplementation();
-  try {
-    await main(cmd?.split(" ") ?? []);
-    return {
-      stdout: logSpy.mock.calls.flat(2).join("\n"),
-      stderr: errorSpy.mock.calls.flat(2).join("\n"),
-      warnings: warnSpy.mock.calls.flat(2).join("\n"),
-    };
-  } finally {
-    logSpy.mockRestore();
-    errorSpy.mockRestore();
-    warnSpy.mockRestore();
-  }
-}
+import { mockConfirm } from "./mock-dialogs";
+import { runWrangler } from "./run-wrangler";
+import { runInTempDir } from "./run-in-tmp";
+import * as fs from "node:fs";
 
 describe("wrangler", () => {
+  runInTempDir();
+
   describe("no command", () => {
     it("should display a list of available commands", async () => {
-      const { stdout, stderr } = await w();
+      const { stdout, stderr } = await runWrangler();
 
       expect(stdout).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.
@@ -92,13 +42,15 @@ describe("wrangler", () => {
 
   describe("invalid command", () => {
     it("should display an error", async () => {
-      const { stdout, stderr } = await w("invalid-command");
+      const { error, stdout, stderr } = await runWrangler("invalid-command");
 
-      expect(stdout).toMatchInlineSnapshot(`
+      expect(stdout).toMatchInlineSnapshot(`""`);
+      expect(stderr).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.
@@ -114,36 +66,23 @@ describe("wrangler", () => {
           -v, --version  Show version number  [boolean]
 
         Options:
-          -l, --local  Run on my machine  [boolean] [default: false]"
-      `);
+          -l, --local  Run on my machine  [boolean] [default: false]
 
-      expect(stderr).toMatchInlineSnapshot(`
-        "
         Unknown command: invalid-command."
       `);
+      expect(error).toMatchInlineSnapshot(
+        `[Error: Unknown command: invalid-command.]`
+      );
     });
   });
 
   describe("init", () => {
-    const ogcwd = process.cwd();
-    let tmpDir: string;
-
-    beforeEach(async () => {
-      tmpDir = await fsp.mkdtemp(path.join(os.tmpdir(), "init-"));
-      process.chdir(tmpDir);
-    });
-
-    afterEach(async () => {
-      process.chdir(ogcwd);
-      await fsp.rm(tmpDir, { recursive: true });
-    });
-
     it("should create a wrangler.toml", async () => {
       mockConfirm({
         text: "No package.json found. Would you like to create one?",
         result: false,
       });
-      await w("init");
+      await runWrangler("init");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
       expect(typeof parsed.compatibility_date).toBe("string");
       expect(fs.existsSync("./package.json")).toBe(false);
@@ -151,19 +90,19 @@ describe("wrangler", () => {
     });
 
     it("should display warning when wrangler.toml already exists, and exit if user does not want to carry on", async () => {
-      fs.closeSync(fs.openSync("./wrangler.toml", "w"));
+      fs.writeFileSync("./wrangler.toml", "", "utf-8");
       mockConfirm({
         text: "Do you want to continue initializing this project?",
         result: false,
       });
-      const { stderr } = await w("init");
-      expect(stderr).toContain("wrangler.toml file already exists!");
+      const { warnings } = await runWrangler("init");
+      expect(warnings).toContain("wrangler.toml file already exists!");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
       expect(typeof parsed.compatibility_date).toBe("undefined");
     });
 
     it("should display warning when wrangler.toml already exists, but continue if user does want to carry on", async () => {
-      fs.closeSync(fs.openSync("./wrangler.toml", "w"));
+      fs.writeFileSync("./wrangler.toml", "", "utf-8");
       mockConfirm(
         {
           text: "Do you want to continue initializing this project?",
@@ -174,8 +113,8 @@ describe("wrangler", () => {
           result: false,
         }
       );
-      const { stderr } = await w("init");
-      expect(stderr).toContain("wrangler.toml file already exists!");
+      const { warnings } = await runWrangler("init");
+      expect(warnings).toContain("wrangler.toml file already exists!");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
       expect(typeof parsed.compatibility_date).toBe("string");
     });
@@ -191,7 +130,7 @@ describe("wrangler", () => {
           result: false,
         }
       );
-      await w("init");
+      await runWrangler("init");
       expect(fs.existsSync("./package.json")).toBe(true);
       const packageJson = JSON.parse(
         fs.readFileSync("./package.json", "utf-8")
@@ -213,7 +152,7 @@ describe("wrangler", () => {
         "utf-8"
       );
 
-      await w("init");
+      await runWrangler("init");
       const packageJson = JSON.parse(
         fs.readFileSync("./package.json", "utf-8")
       );
@@ -236,7 +175,7 @@ describe("wrangler", () => {
       fs.mkdirSync("./sub-1/sub-2", { recursive: true });
       process.chdir("./sub-1/sub-2");
 
-      await w("init");
+      await runWrangler("init");
       expect(fs.existsSync("./package.json")).toBe(false);
       expect(fs.existsSync("../../package.json")).toBe(true);
 
@@ -258,7 +197,7 @@ describe("wrangler", () => {
           result: true,
         }
       );
-      await w("init");
+      await runWrangler("init");
       expect(fs.existsSync("./tsconfig.json")).toBe(true);
       const tsconfigJson = JSON.parse(
         fs.readFileSync("./tsconfig.json", "utf-8")
@@ -286,7 +225,7 @@ describe("wrangler", () => {
         "utf-8"
       );
 
-      await w("init");
+      await runWrangler("init");
       const tsconfigJson = JSON.parse(
         fs.readFileSync("./tsconfig.json", "utf-8")
       );
@@ -308,7 +247,7 @@ describe("wrangler", () => {
       fs.mkdirSync("./sub-1/sub-2", { recursive: true });
       process.chdir("./sub-1/sub-2");
 
-      await w("init");
+      await runWrangler("init");
       expect(fs.existsSync("./tsconfig.json")).toBe(false);
       expect(fs.existsSync("../../tsconfig.json")).toBe(true);
 
@@ -319,104 +258,32 @@ describe("wrangler", () => {
     });
 
     it("should error if `--type` is used", async () => {
-      const noValue = await w("init --type");
-      expect(noValue.stderr).toMatchInlineSnapshot(
-        `"The --type option is no longer supported."`
+      const { error } = await runWrangler("init --type");
+      expect(error).toMatchInlineSnapshot(
+        `[Error: The --type option is no longer supported.]`
       );
     });
 
     it("should error if `--type javascript` is used", async () => {
-      const javascriptValue = await w("init --type javascript");
-      expect(javascriptValue.stderr).toMatchInlineSnapshot(
-        `"The --type option is no longer supported."`
+      const { error } = await runWrangler("init --type javascript");
+      expect(error).toMatchInlineSnapshot(
+        `[Error: The --type option is no longer supported.]`
       );
     });
 
     it("should error if `--type rust` is used", async () => {
-      const rustValue = await w("init --type rust");
-      expect(rustValue.stderr).toMatchInlineSnapshot(
-        `"The --type option is no longer supported."`
+      const { error } = await runWrangler("init --type rust");
+      expect(error).toMatchInlineSnapshot(
+        `[Error: The --type option is no longer supported.]`
       );
     });
 
     it("should error if `--type webpack` is used", async () => {
-      const webpackValue = await w("init --type webpack");
-      expect(webpackValue.stderr).toMatchInlineSnapshot(`
-        "The --type option is no longer supported.
-        If you wish to use webpack then you will need to create a custom build."
+      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.]
       `);
     });
   });
-
-  describe("kv:namespace", () => {
-    afterEach(() => {
-      unsetAllMocks();
-    });
-
-    it("can create a namespace", async () => {
-      const KVNamespaces: { title: string; id: string }[] = [];
-      setMock("/accounts/:accountId/storage/kv/namespaces", (uri, init) => {
-        expect(init.method === "POST");
-        expect(uri[0]).toEqual(
-          "/accounts/some-account-id/storage/kv/namespaces"
-        );
-        const { title } = JSON.parse(init.body);
-        expect(title).toEqual("worker-UnitTestNamespace");
-        KVNamespaces.push({ title, id: "some-namespace-id" });
-        return { id: "some-namespace-id" };
-      });
-
-      await w("kv:namespace create UnitTestNamespace");
-
-      expect(KVNamespaces).toEqual([
-        {
-          title: "worker-UnitTestNamespace",
-          id: "some-namespace-id",
-        },
-      ]);
-    });
-
-    it("can list namespaces", async () => {
-      const KVNamespaces: { title: string; id: string }[] = [
-        { title: "title-1", id: "id-1" },
-        { title: "title-2", id: "id-2" },
-      ];
-      setMock(
-        "/accounts/:accountId/storage/kv/namespaces\\?:qs",
-        (uri, init) => {
-          expect(uri[0]).toContain(
-            "/accounts/some-account-id/storage/kv/namespaces"
-          );
-          expect(uri[2]).toContain("per_page=100");
-          expect(uri[2]).toContain("order=title");
-          expect(uri[2]).toContain("direction=asc");
-          expect(uri[2]).toContain("page=1");
-          expect(init).toBe(undefined);
-          return KVNamespaces;
-        }
-      );
-      const { stdout } = await w("kv:namespace list");
-      const namespaces = JSON.parse(stdout) as { id: string; title: string }[];
-      expect(namespaces).toEqual(KVNamespaces);
-    });
-
-    it("can delete a namespace", async () => {
-      let accountId = "";
-      let namespaceId = "";
-      setMock(
-        "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
-        (uri, init) => {
-          accountId = uri[1];
-          namespaceId = uri[2];
-          expect(uri[0]).toEqual(
-            "/accounts/some-account-id/storage/kv/namespaces/some-namespace-id"
-          );
-          expect(init.method).toBe("DELETE");
-        }
-      );
-      await w(`kv:namespace delete --namespace-id some-namespace-id`);
-      expect(accountId).toEqual("some-account-id");
-      expect(namespaceId).toEqual("some-namespace-id");
-    });
-  });
 });

package/src/__tests__/jest.setup.ts

@@ -0,0 +1,22 @@
+import { mockFetchInternal } from "./mock-cfetch";
+import { confirm, prompt } from "../dialogs";
+import { fetchInternal } from "../cfetch/internal";
+
+jest.mock("../cfetch/internal");
+(fetchInternal as jest.Mock).mockImplementation(mockFetchInternal);
+
+jest.mock("../dialogs");
+
+// By default (if not configured by mockConfirm()) calls to `confirm()` should throw.
+(confirm as jest.Mock).mockImplementation(() => {
+  throw new Error(
+    "Unexpected call to `confirm()`. You should use `mockConfirm()` to mock calls to `confirm()` with expectations. Search the codebase for `mockConfirm` to learn more."
+  );
+});
+
+// By default (if not configured by mockPrompt()) calls to `prompt()` should throw.
+(prompt as jest.Mock).mockImplementation(() => {
+  throw new Error(
+    "Unexpected call to `prompt()`. You should use `mockPrompt()` to mock calls to `prompt()` with expectations. Search the codebase for `mockPrompt` to learn more."
+  );
+});