wrangler 2.0.7 → 2.0.8

package/README.md

@@ -24,7 +24,7 @@ npx wrangler init my-worker
 # try it out
 cd my-worker && npm run start
 # and then publish it
-npm run publish
+npm run deploy
 ```
 
 ## Installation:

package/bin/wrangler.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 const { spawn } = require("child_process");
-const { join } = require("path");
+const path = require("path");
+const fs = require("fs");
+const os = require("os");
 const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";
@@ -25,13 +27,23 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
     // TODO:
     // - should we log a warning here?
     // - maybe we can generate a certificate that concatenates with ours?
-    // - is there a security concern/should we cleanup after we exit?
     //
     //  I do think it'll be rare that someone wants to add a cert AND
     //  use cloudflare WARP, but let's wait till the situation actually
     //  arises before we do anything about it
   } else {
-    pathToCACerts = join(__dirname, "../Cloudflare_CA.pem");
+    const osTempDir = os.tmpdir();
+    const certDir = path.join(osTempDir, "wrangler-cert");
+    const certPath = path.join(certDir, "Cloudflare_CA.pem");
+    // copy cert to the system temp dir if needed
+    if (!fs.existsSync(certPath)) {
+      fs.mkdirSync(certDir, { recursive: true });
+      fs.writeFileSync(
+        certPath,
+        fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
+      );
+    }
+    pathToCACerts = certPath;
   }
 
   wranglerProcess = spawn(
@@ -43,7 +55,7 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
       "--no-warnings",
       "--experimental-vm-modules",
       ...process.execArgv,
-      join(__dirname, "../wrangler-dist/cli.js"),
+      path.join(__dirname, "../wrangler-dist/cli.js"),
       ...process.argv.slice(2),
     ],
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrangler",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
   "bin": {
@@ -40,7 +40,7 @@
     "@esbuild-plugins/node-modules-polyfill": "^0.1.4",
     "blake3-wasm": "^2.1.5",
     "esbuild": "0.14.34",
-    "miniflare": "2.4.0",
+    "miniflare": "^2.5.0",
     "nanoid": "^3.3.3",
     "path-to-regexp": "^6.2.0",
     "selfsigned": "^2.0.1",

package/src/__tests__/configuration.test.ts

@@ -61,6 +61,8 @@ describe("normalizeAndValidateConfig()", () => {
       data_blobs: undefined,
       workers_dev: undefined,
       zone_id: undefined,
+      minify: undefined,
+      node_compat: undefined,
     });
     expect(diagnostics.hasErrors()).toBe(false);
     expect(diagnostics.hasWarnings()).toBe(false);
@@ -163,68 +165,110 @@ describe("normalizeAndValidateConfig()", () => {
       `);
     });
 
-    it("should override `migrations` config defaults with provided values", () => {
-      const expectedConfig: RawConfig = {
-        migrations: [
-          {
-            tag: "TAG",
-            new_classes: ["CLASS_1", "CLASS_2"],
-            renamed_classes: [
-              {
-                from: "FROM_CLASS",
-                to: "TO_CLASS",
-              },
-            ],
-            deleted_classes: ["CLASS_3", "CLASS_4"],
-          },
-        ],
-      };
+    describe("migrations", () => {
+      it("should override `migrations` config defaults with provided values", () => {
+        const expectedConfig: RawConfig = {
+          migrations: [
+            {
+              tag: "TAG",
+              new_classes: ["CLASS_1", "CLASS_2"],
+              renamed_classes: [
+                {
+                  from: "FROM_CLASS",
+                  to: "TO_CLASS",
+                },
+              ],
+              deleted_classes: ["CLASS_3", "CLASS_4"],
+            },
+          ],
+        };
 
-      const { config, diagnostics } = normalizeAndValidateConfig(
-        expectedConfig,
-        undefined,
-        { env: undefined }
-      );
+        const { config, diagnostics } = normalizeAndValidateConfig(
+          expectedConfig,
+          undefined,
+          { env: undefined }
+        );
 
-      expect(config).toEqual(expect.objectContaining(expectedConfig));
-      expect(diagnostics.hasErrors()).toBe(false);
-      expect(diagnostics.hasWarnings()).toBe(false);
-    });
+        expect(config).toEqual(expect.objectContaining(expectedConfig));
+        expect(diagnostics.hasErrors()).toBe(false);
+        expect(diagnostics.hasWarnings()).toBe(false);
+      });
 
-    it("should error on invalid `migrations` values", () => {
-      const expectedConfig = {
-        migrations: [
-          {
-            tag: 111,
-            new_classes: [222, 333],
-            renamed_classes: [
-              {
-                from: 444,
-                to: 555,
-              },
-            ],
-            deleted_classes: [666, 777],
-          },
-        ],
-      };
+      it("should error on invalid `migrations` values", () => {
+        const expectedConfig = {
+          migrations: [
+            {
+              tag: 111,
+              new_classes: [222, 333],
+              renamed_classes: [
+                {
+                  from: 444,
+                  to: 555,
+                },
+              ],
+              deleted_classes: [666, 777],
+            },
+          ],
+        };
 
-      const { config, diagnostics } = normalizeAndValidateConfig(
-        expectedConfig as unknown as RawConfig,
-        undefined,
-        { env: undefined }
-      );
+        const { config, diagnostics } = normalizeAndValidateConfig(
+          expectedConfig as unknown as RawConfig,
+          undefined,
+          { env: undefined }
+        );
 
-      expect(config).toEqual(expect.objectContaining(expectedConfig));
-      expect(diagnostics.hasWarnings()).toBe(false);
-      expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
-        "Processing wrangler configuration:
-          - Expected \\"migrations[0].tag\\" to be of type string but got 111.
-          - Expected \\"migrations[0].new_classes.[0]\\" to be of type string but got 222.
-          - Expected \\"migrations[0].new_classes.[1]\\" to be of type string but got 333.
-          - Expected \\"migrations[0].renamed_classes\\" to be an array of \\"{from: string, to: string}\\" objects but got [{\\"from\\":444,\\"to\\":555}].
-          - Expected \\"migrations[0].deleted_classes.[0]\\" to be of type string but got 666.
-          - Expected \\"migrations[0].deleted_classes.[1]\\" to be of type string but got 777."
-      `);
+        expect(config).toEqual(expect.objectContaining(expectedConfig));
+        expect(diagnostics.hasWarnings()).toBe(false);
+        expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
+          "Processing wrangler configuration:
+            - Expected \\"migrations[0].tag\\" to be of type string but got 111.
+            - Expected \\"migrations[0].new_classes.[0]\\" to be of type string but got 222.
+            - Expected \\"migrations[0].new_classes.[1]\\" to be of type string but got 333.
+            - Expected \\"migrations[0].renamed_classes\\" to be an array of \\"{from: string, to: string}\\" objects but got [{\\"from\\":444,\\"to\\":555}].
+            - Expected \\"migrations[0].deleted_classes.[0]\\" to be of type string but got 666.
+            - Expected \\"migrations[0].deleted_classes.[1]\\" to be of type string but got 777."
+        `);
+      });
+
+      it("should warn/error on unexpected fields on `migrations`", async () => {
+        const expectedConfig = {
+          migrations: [
+            {
+              tag: "TAG",
+              new_classes: ["CLASS_1", "CLASS_2"],
+              renamed_classes: [
+                {
+                  from: "FROM_CLASS",
+                  to: "TO_CLASS",
+                },
+                {
+                  a: "something",
+                  b: "someone",
+                },
+              ],
+              deleted_classes: ["CLASS_3", "CLASS_4"],
+              unrecognized_field: "FOO",
+            },
+          ],
+        };
+
+        const { config, diagnostics } = normalizeAndValidateConfig(
+          expectedConfig as unknown as RawConfig,
+          undefined,
+          { env: undefined }
+        );
+
+        expect(config).toEqual(expect.objectContaining(expectedConfig));
+        expect(diagnostics.hasErrors()).toBe(true);
+        expect(diagnostics.renderWarnings()).toMatchInlineSnapshot(`
+          "Processing wrangler configuration:
+            - Unexpected fields found in migrations field: \\"unrecognized_field\\""
+        `);
+        expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
+          "Processing wrangler configuration:
+            - Expected \\"migrations[0].renamed_classes\\" to be an array of \\"{from: string, to: string}\\" objects but got [{\\"from\\":\\"FROM_CLASS\\",\\"to\\":\\"TO_CLASS\\"},{\\"a\\":\\"something\\",\\"b\\":\\"someone\\"}]."
+        `);
+      });
     });
 
     describe("site", () => {
@@ -662,6 +706,8 @@ describe("normalizeAndValidateConfig()", () => {
             },
           ],
         },
+        minify: true,
+        node_compat: true,
       };
 
       const { config, diagnostics } = normalizeAndValidateConfig(
@@ -678,7 +724,15 @@ describe("normalizeAndValidateConfig()", () => {
         "Processing wrangler configuration:
           - \\"unsafe\\" fields are experimental and may change or break at any time.
           - \\"services\\" fields are experimental and may change or break at any time.
-          - In wrangler.toml, you have configured [durable_objects] exported by this Worker (CLASS1), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details."
+          - In wrangler.toml, you have configured [durable_objects] exported by this Worker (CLASS1), 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 = [\\"CLASS1\\"]
+              \`\`\`
+
+            Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details."
       `);
     });
 
@@ -721,6 +775,8 @@ describe("normalizeAndValidateConfig()", () => {
           cwd: 1555,
           watch_dir: 1666,
         },
+        minify: "INVALID",
+        node_compat: "INVALID",
       } as unknown as RawEnvironment;
 
       const { config, diagnostics } = normalizeAndValidateConfig(
@@ -783,7 +839,9 @@ describe("normalizeAndValidateConfig()", () => {
           - Expected \\"tsconfig\\" to be of type string but got true.
           - Expected \\"name\\" to be of type string, alphanumeric and lowercase with dashes only but got 111.
           - Expected \\"main\\" to be of type string but got 1333.
-          - Expected \\"usage_model\\" field to be one of [\\"bundled\\",\\"unbound\\"] but got \\"INVALID\\"."
+          - Expected \\"usage_model\\" field to be one of [\\"bundled\\",\\"unbound\\"] but got \\"INVALID\\".
+          - Expected \\"minify\\" to be of type boolean but got \\"INVALID\\".
+          - Expected \\"node_compat\\" to be of type boolean but got \\"INVALID\\"."
       `);
     });
 
@@ -1157,12 +1215,9 @@ describe("normalizeAndValidateConfig()", () => {
             durable_objects: { bindings: expect.anything },
           })
         );
-        expect(diagnostics.hasWarnings()).toBe(true);
+        expect(diagnostics.hasWarnings()).toBe(false);
+
         expect(diagnostics.hasErrors()).toBe(true);
-        expect(diagnostics.renderWarnings()).toMatchInlineSnapshot(`
-          "Processing wrangler configuration:
-            - In wrangler.toml, you have configured [durable_objects] exported by this Worker ((unnamed), (unnamed), 1666, SomeClass, 1883), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details."
-        `);
         expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
           "Processing wrangler configuration:
 
@@ -1912,6 +1967,8 @@ describe("normalizeAndValidateConfig()", () => {
           cwd: "CWD",
           watch_dir: "WATCH_DIR",
         },
+        minify: true,
+        node_compat: true,
       };
 
       const { config, diagnostics } = normalizeAndValidateConfig(
@@ -1952,6 +2009,8 @@ describe("normalizeAndValidateConfig()", () => {
           cwd: "ENV_CWD",
           watch_dir: "ENV_WATCH_DIR",
         },
+        minify: false,
+        node_compat: false,
       };
       const rawConfig: RawConfig = {
         name: "mock-name",
@@ -1971,6 +2030,8 @@ describe("normalizeAndValidateConfig()", () => {
           cwd: "CWD",
           watch_dir: "WATCH_DIR",
         },
+        minify: true,
+        node_compat: true,
         env: {
           ENV1: rawEnv,
         },
@@ -2221,6 +2282,8 @@ describe("normalizeAndValidateConfig()", () => {
           cwd: 1555,
           watch_dir: 1666,
         },
+        minify: "INVALID",
+        node_compat: "INVALID",
       } as unknown as RawEnvironment;
 
       const { config, diagnostics } = normalizeAndValidateConfig(
@@ -2253,7 +2316,9 @@ describe("normalizeAndValidateConfig()", () => {
             - Expected \\"tsconfig\\" to be of type string but got 123.
             - Expected \\"name\\" to be of type string, alphanumeric and lowercase with dashes only but got 111.
             - Expected \\"main\\" to be of type string but got 1333.
-            - Expected \\"usage_model\\" field to be one of [\\"bundled\\",\\"unbound\\"] but got \\"INVALID\\"."
+            - Expected \\"usage_model\\" field to be one of [\\"bundled\\",\\"unbound\\"] but got \\"INVALID\\".
+            - Expected \\"minify\\" to be of type boolean but got \\"INVALID\\".
+            - Expected \\"node_compat\\" to be of type boolean but got \\"INVALID\\"."
       `);
     });
 
@@ -2474,12 +2539,8 @@ describe("normalizeAndValidateConfig()", () => {
             durable_objects: { bindings: expect.anything },
           })
         );
-        expect(diagnostics.hasWarnings()).toBe(true);
+        expect(diagnostics.hasWarnings()).toBe(false);
         expect(diagnostics.hasErrors()).toBe(true);
-        expect(diagnostics.renderWarnings()).toMatchInlineSnapshot(`
-          "Processing wrangler configuration:
-            - In wrangler.toml, you have configured [durable_objects] exported by this Worker ((unnamed), (unnamed), 1666), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details."
-        `);
         expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
           "Processing wrangler configuration:
 

package/src/__tests__/dev.test.tsx

@@ -83,7 +83,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.
@@ -467,7 +467,7 @@ describe("wrangler dev", () => {
       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] The expected output file at \\"index.js\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
@@ -698,13 +698,28 @@ 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] 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. Refer to
+          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.
 
@@ -764,9 +779,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(`""`);
     });
@@ -862,7 +886,10 @@ describe("wrangler dev", () => {
         Object {
           "debug": "",
           "err": "",
-          "out": "",
+          "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.
@@ -875,6 +902,68 @@ describe("wrangler dev", () => {
       `);
     });
   });
+
+  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,4 @@
-import { confirm, prompt } from "../../dialogs";
+import { confirm, prompt, select } from "../../dialogs";
 import { normalizeSlashes } from "./mock-console";
 
 /**
@@ -88,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.`
+    );
+  });
+}