wrangler 0.0.0-e2f9bb2 → 0.0.0-e3278fa

package/src/__tests__/dev.test.tsx

@@ -1,8 +1,8 @@
 import * as fs from "node:fs";
+import getPort from "get-port";
 import patchConsole from "patch-console";
 import dedent from "ts-dedent";
 import Dev from "../dev/dev";
-import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
 import { mockConsoleMethods } from "./helpers/mock-console";
 import { runInTempDir } from "./helpers/run-in-tmp";
@@ -10,8 +10,6 @@ import { runWrangler } from "./helpers/run-wrangler";
 import writeWranglerToml from "./helpers/write-wrangler-toml";
 
 describe("wrangler dev", () => {
-  mockAccountId();
-  mockApiToken();
   runInTempDir();
   const std = mockConsoleMethods();
   afterEach(() => {
@@ -82,7 +80,7 @@ describe("wrangler dev", () => {
 
       expect(std.out).toMatchInlineSnapshot(`
         "
-        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
+        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
       `);
       expect(std.err).toMatchInlineSnapshot(`
         "X [ERROR] Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler dev path/to/script\`) or the \`main\` config field.
@@ -151,10 +149,12 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev --host some-host.com");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "some-host.com",
-        id: "some-zone-id",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "some-host.com",
+          zone: "some-zone-id",
+        })
+      );
     });
 
     it("should read wrangler.toml's dev.host", async () => {
@@ -167,9 +167,7 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone.host).toEqual(
-        "some-host.com"
-      );
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
     });
 
     it("should read --route", async () => {
@@ -179,9 +177,7 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev --route http://some-host.com/some/path/*");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone.host).toEqual(
-        "some-host.com"
-      );
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
     });
 
     it("should read wrangler.toml's routes", async () => {
@@ -195,9 +191,7 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone.host).toEqual(
-        "some-host.com"
-      );
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
     });
 
     it("should read wrangler.toml's environment specific routes", async () => {
@@ -219,9 +213,29 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev --env staging");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone.host).toEqual(
-        "some-host.com"
-      );
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
+    });
+
+    it("should strip leading `*` from given host when deducing a zone id", async () => {
+      writeWranglerToml({
+        main: "index.js",
+        route: "*some-host.com/some/path/*",
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
+      await runWrangler("dev");
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
+    });
+
+    it("should strip leading `*.` from given host when deducing a zone id", async () => {
+      writeWranglerToml({
+        main: "index.js",
+        route: "*.some-host.com/some/path/*",
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      mockGetZones("some-host.com", [{ id: "some-zone-id" }]);
+      await runWrangler("dev");
+      expect((Dev as jest.Mock).mock.calls[0][0].host).toEqual("some-host.com");
     });
 
     it("should, when provided, use a configured zone_id", async () => {
@@ -233,10 +247,12 @@ describe("wrangler dev", () => {
       });
       fs.writeFileSync("index.js", `export default {};`);
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "some-domain.com",
-        id: "some-zone-id",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "some-domain.com",
+          zone: "some-zone-id",
+        })
+      );
     });
 
     it("should, when provided, use a zone_name to get a zone_id", async () => {
@@ -249,11 +265,13 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       mockGetZones("some-zone.com", [{ id: "a-zone-id" }]);
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        // note that it uses the provided zone_name as a host too
-        host: "some-zone.com",
-        id: "a-zone-id",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          // note that it uses the provided zone_name as a host too
+          host: "some-zone.com",
+          zone: "a-zone-id",
+        })
+      );
     });
 
     it("given a long host, it should use the longest subdomain that resolves to a zone", async () => {
@@ -265,10 +283,12 @@ describe("wrangler dev", () => {
       mockGetZones("222.333.some-host.com", []);
       mockGetZones("333.some-host.com", [{ id: "some-zone-id" }]);
       await runWrangler("dev --host 111.222.333.some-host.com");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "111.222.333.some-host.com",
-        id: "some-zone-id",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "111.222.333.some-host.com",
+          zone: "some-zone-id",
+        })
+      );
     });
 
     it("should, in order, use args.host/config.dev.host/args.routes/(config.route|config.routes)", async () => {
@@ -283,10 +303,12 @@ describe("wrangler dev", () => {
         routes: ["http://5.some-host.com/some/path/*"],
       });
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "5.some-host.com",
-        id: "some-zone-id-5",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "5.some-host.com",
+          zone: "some-zone-id-5",
+        })
+      );
       (Dev as jest.Mock).mockClear();
 
       // config.route
@@ -296,10 +318,12 @@ describe("wrangler dev", () => {
         route: "https://4.some-host.com/some/path/*",
       });
       await runWrangler("dev");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "4.some-host.com",
-        id: "some-zone-id-4",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "4.some-host.com",
+          zone: "some-zone-id-4",
+        })
+      );
       (Dev as jest.Mock).mockClear();
 
       // --routes
@@ -309,10 +333,12 @@ describe("wrangler dev", () => {
         route: "https://4.some-host.com/some/path/*",
       });
       await runWrangler("dev --routes http://3.some-host.com/some/path/*");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "3.some-host.com",
-        id: "some-zone-id-3",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "3.some-host.com",
+          zone: "some-zone-id-3",
+        })
+      );
       (Dev as jest.Mock).mockClear();
 
       // config.dev.host
@@ -325,10 +351,12 @@ describe("wrangler dev", () => {
         route: "4.some-host.com/some/path/*",
       });
       await runWrangler("dev --routes http://3.some-host.com/some/path/*");
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "2.some-host.com",
-        id: "some-zone-id-2",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "2.some-host.com",
+          zone: "some-zone-id-2",
+        })
+      );
       (Dev as jest.Mock).mockClear();
 
       // --host
@@ -343,10 +371,12 @@ describe("wrangler dev", () => {
       await runWrangler(
         "dev --routes http://3.some-host.com/some/path/* --host 1.some-host.com"
       );
-      expect((Dev as jest.Mock).mock.calls[0][0].zone).toEqual({
-        host: "1.some-host.com",
-        id: "some-zone-id-1",
-      });
+      expect((Dev as jest.Mock).mock.calls[0][0]).toEqual(
+        expect.objectContaining({
+          host: "1.some-host.com",
+          zone: "some-zone-id-1",
+        })
+      );
       (Dev as jest.Mock).mockClear();
     });
 
@@ -432,18 +462,20 @@ describe("wrangler dev", () => {
         },
       });
 
-      await expect(
-        runWrangler("dev")
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"Could not resolve \\"index.js\\" after running custom build: node -e \\"console.log('custom build');\\""`
-      );
+      await expect(runWrangler("dev")).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+              "The expected output file at \\"index.js\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+              The \`main\` property in wrangler.toml should point to the file generated by the custom build."
+            `);
       expect(std.out).toMatchInlineSnapshot(`
         "Running custom build: node -e \\"console.log('custom build');\\"
 
-        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
+        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
       `);
       expect(std.err).toMatchInlineSnapshot(`
-        "X [ERROR] Could not resolve \\"index.js\\" after running custom build: node -e \\"console.log('custom build');\\"
+        "X [ERROR] The expected output file at \\"index.js\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+
+          The \`main\` property in wrangler.toml should point to the file generated by the custom build.
 
         "
       `);
@@ -580,8 +612,73 @@ describe("wrangler dev", () => {
     });
   });
 
+  describe("port", () => {
+    it("should default port to 8787 if it is not in use", async () => {
+      writeWranglerToml({
+        main: "index.js",
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      await runWrangler("dev");
+      expect((Dev as jest.Mock).mock.calls[0][0].port).toEqual(8787);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+
+    it("should use to `port` from `wrangler.toml`, if available", async () => {
+      writeWranglerToml({
+        main: "index.js",
+        dev: {
+          port: 8888,
+        },
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      // Mock `getPort()` to resolve to a completely different port.
+      (getPort as jest.Mock).mockResolvedValue(98765);
+
+      await runWrangler("dev");
+      expect((Dev as jest.Mock).mock.calls[0][0].port).toEqual(8888);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+
+    it("should use --port command line arg, if provided", async () => {
+      writeWranglerToml({
+        main: "index.js",
+        dev: {
+          port: 8888,
+        },
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      // Mock `getPort()` to resolve to a completely different port.
+      (getPort as jest.Mock).mockResolvedValue(98765);
+
+      await runWrangler("dev --port=9999");
+      expect((Dev as jest.Mock).mock.calls[0][0].port).toEqual(9999);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+
+    it("should use a different port to the default if it is in use", async () => {
+      writeWranglerToml({
+        main: "index.js",
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      // Mock `getPort()` to resolve to a completely different port.
+      (getPort as jest.Mock).mockResolvedValue(98765);
+
+      await runWrangler("dev");
+      expect((Dev as jest.Mock).mock.calls[0][0].port).toEqual(98765);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+  });
+
   describe("durable_objects", () => {
-    it("should warn if there is one or more remote Durable Object", async () => {
+    it("should warn if there are remote Durable Objects, or missing migrations for local Durable Objects", async () => {
       writeWranglerToml({
         main: "index.js",
         durable_objects: {
@@ -604,9 +701,33 @@ describe("wrangler dev", () => {
       fs.writeFileSync("index.js", `export default {};`);
       await runWrangler("dev");
       expect((Dev as jest.Mock).mock.calls[0][0].ip).toEqual("localhost");
-      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.out).toMatchInlineSnapshot(`
+        "Your worker has access to the following bindings:
+        - Durable Objects:
+          - NAME_1: CLASS_1
+          - NAME_2: CLASS_2 (defined in SCRIPT_A)
+          - NAME_3: CLASS_3
+          - NAME_4: CLASS_4 (defined in SCRIPT_B)"
+      `);
       expect(std.warn).toMatchInlineSnapshot(`
-        "▲ [WARNING] WARNING: You have Durable Object bindings that are not defined locally in the worker being developed.
+        "▲ [WARNING] Processing wrangler.toml configuration:
+
+            - In wrangler.toml, you have configured [durable_objects] exported by this Worker (CLASS_1,
+          CLASS_3), but no [migrations] for them. This may not work as expected until you add a [migrations]
+          section to your wrangler.toml. Add this configuration to your wrangler.toml:
+
+                \`\`\`
+                [[migrations]]
+                tag = \\"v1\\" # Should be unique for each entry
+                new_classes = [\\"CLASS_1\\", \\"CLASS_3\\"]
+                \`\`\`
+
+              Refer to
+          https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml
+          for more details.
+
+
+        ▲ [WARNING] WARNING: You have Durable Object bindings that are not defined locally in the worker being developed.
 
           Be aware that changes to the data stored in these Durable Objects will be permanent and affect the
           live instances.
@@ -661,9 +782,18 @@ describe("wrangler dev", () => {
         EMPTY: "",
         UNQUOTED: "unquoted value", // Note that whitespace is trimmed
       });
-      expect(std.out).toMatchInlineSnapshot(
-        `"Using vars defined in .dev.vars"`
-      );
+      expect(std.out).toMatchInlineSnapshot(`
+        "Using vars defined in .dev.vars
+        Your worker has access to the following bindings:
+        - Vars:
+          - VAR_1: \\"(hidden)\\"
+          - VAR_2: \\"original value 2\\"
+          - VAR_3: \\"(hidden)\\"
+          - VAR_MULTI_LINE_1: \\"(hidden)\\"
+          - VAR_MULTI_LINE_2: \\"(hidden)\\"
+          - EMPTY: \\"(hidden)\\"
+          - UNQUOTED: \\"(hidden)\\""
+      `);
       expect(std.warn).toMatchInlineSnapshot(`""`);
       expect(std.err).toMatchInlineSnapshot(`""`);
     });
@@ -680,7 +810,11 @@ describe("wrangler dev", () => {
       expect(std).toMatchInlineSnapshot(`
         Object {
           "debug": "",
-          "err": "wrangler dev [script]
+          "err": "X [ERROR] Not enough arguments following: site
+
+        ",
+          "out": "
+        wrangler dev [script]
 
         👂 Start a local server for developing your worker
 
@@ -688,10 +822,9 @@ describe("wrangler dev", () => {
           script  The path to an entry point for your worker  [string]
 
         Flags:
-          -c, --config      Path to .toml configuration file  [string]
-          -h, --help        Show help  [boolean]
-          -v, --version     Show version number  [boolean]
-              --legacy-env  Use legacy environments  [boolean]
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]
 
         Options:
               --name                                       Name of the worker  [string]
@@ -718,12 +851,7 @@ describe("wrangler dev", () => {
               --minify                                     Minify the script  [boolean]
               --node-compat                                Enable node.js compatibility  [boolean]
               --experimental-enable-local-persistence      Enable persistence for this session (only for local mode)  [boolean]
-              --inspect                                    Enable dev tools  [deprecated] [boolean]
-        X [ERROR] Not enough arguments following: site
-
-        ",
-          "out": "
-        ",
+              --inspect                                    Enable dev tools  [deprecated] [boolean]",
           "warn": "",
         }
       `);
@@ -746,6 +874,99 @@ describe("wrangler dev", () => {
       `);
     });
   });
+
+  describe("service bindings", () => {
+    it("should warn when using service bindings", async () => {
+      writeWranglerToml({
+        services: [
+          { binding: "WorkerA", service: "A" },
+          { binding: "WorkerB", service: "B", environment: "staging" },
+        ],
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      await runWrangler("dev index.js");
+      expect(std).toMatchInlineSnapshot(`
+        Object {
+          "debug": "",
+          "err": "",
+          "out": "Your worker has access to the following bindings:
+        - Services:
+          - WorkerA: A
+          - WorkerB: B - staging",
+          "warn": "▲ [WARNING] Processing wrangler.toml configuration:
+
+            - \\"services\\" fields are experimental and may change or break at any time.
+
+
+        ▲ [WARNING] This worker is bound to live services: WorkerA (A), WorkerB (B@staging)
+
+        ",
+        }
+      `);
+    });
+  });
+
+  describe("print bindings", () => {
+    it("should print bindings", async () => {
+      writeWranglerToml({
+        services: [
+          { binding: "WorkerA", service: "A" },
+          { binding: "WorkerB", service: "B", environment: "staging" },
+        ],
+      });
+      fs.writeFileSync("index.js", `export default {};`);
+      await runWrangler("dev index.js");
+      expect(std).toMatchInlineSnapshot(`
+        Object {
+          "debug": "",
+          "err": "",
+          "out": "Your worker has access to the following bindings:
+        - Services:
+          - WorkerA: A
+          - WorkerB: B - staging",
+          "warn": "▲ [WARNING] Processing wrangler.toml configuration:
+
+            - \\"services\\" fields are experimental and may change or break at any time.
+
+
+        ▲ [WARNING] This worker is bound to live services: WorkerA (A), WorkerB (B@staging)
+
+        ",
+        }
+      `);
+    });
+
+    it("should mask vars that were overriden in .dev.vars", async () => {
+      writeWranglerToml({
+        vars: {
+          variable: 123,
+          overriden: "original values",
+        },
+      });
+      fs.writeFileSync(
+        ".dev.vars",
+        `
+        SECRET = "A secret"
+        overriden = "overriden value"
+      `
+      );
+      fs.writeFileSync("index.js", `export default {};`);
+      await runWrangler("dev index.js");
+      expect(std).toMatchInlineSnapshot(`
+        Object {
+          "debug": "",
+          "err": "",
+          "out": "Using vars defined in .dev.vars
+        Your worker has access to the following bindings:
+        - Vars:
+          - variable: \\"123\\"
+          - overriden: \\"(hidden)\\"
+          - SECRET: \\"(hidden)\\"",
+          "warn": "",
+        }
+      `);
+    });
+  });
 });
 
 function mockGetZones(domain: string, zones: { id: string }[] = []) {

package/src/__tests__/helpers/mock-dialogs.ts

@@ -1,4 +1,5 @@
-import { confirm, prompt } from "../../dialogs";
+import { confirm, prompt, select } from "../../dialogs";
+import { normalizeSlashes } from "./mock-console";
 
 /**
  * The expected values for a confirmation request.
@@ -20,7 +21,7 @@ export interface ConfirmExpectation {
 export function mockConfirm(...expectations: ConfirmExpectation[]) {
   (confirm as jest.Mock).mockImplementation((text: string) => {
     for (const { text: expectedText, result } of expectations) {
-      if (text === expectedText) {
+      if (normalizeSlashes(text) === normalizeSlashes(expectedText)) {
         return Promise.resolve(result);
       }
     }
@@ -87,3 +88,43 @@ export function clearPromptMocks() {
     );
   });
 }
+
+/**
+ * The expected values for a select request.
+ */
+export interface SelectExpectation {
+  /** The text expected to be seen in the select dialog. */
+  text: string;
+  /** The mock response send back from the select dialog. */
+  result: string;
+}
+
+/**
+ * Mock the implementation of `select()` that will respond with configured results
+ * for configured select text messages.
+ *
+ * If there is a call to `select()` that does not match any of the expectations
+ * then an error is thrown.
+ */
+export function mockSelect(...expectations: SelectExpectation[]) {
+  (select as jest.Mock).mockImplementation((text: string) => {
+    for (const { text: expectedText, result } of expectations) {
+      if (normalizeSlashes(text) === normalizeSlashes(expectedText)) {
+        return Promise.resolve(result);
+      }
+    }
+    throw new Error(`Unexpected select message: ${text}`);
+  });
+}
+
+export function clearSelectMocks() {
+  (select as jest.Mock).mockReset();
+  // Because select was originally a spy, calling mockReset will simply reset
+  // it as a function with no return value (!), so we need to additionally reset
+  // the mock implementation to the one that throws (from jest.setup.js).
+  (select as jest.Mock).mockImplementation((text: string) => {
+    throw new Error(
+      `Unexpected call to \`select("${text}")\`.\nYou should use \`mockSelect()\` to mock calls to \`select()\` with expectations. Search the codebase for \`mockSelect\` to learn more.`
+    );
+  });
+}