wrangler 2.0.5 → 2.0.6

package/src/__tests__/publish.test.ts

@@ -12,6 +12,7 @@ import {
   unsetMockFetchKVGetValues,
 } from "./helpers/mock-cfetch";
 import { mockConsoleMethods, normalizeSlashes } from "./helpers/mock-console";
+import { mockConfirm } from "./helpers/mock-dialogs";
 import { useMockIsTTY } from "./helpers/mock-istty";
 import { mockKeyListRequest } from "./helpers/mock-kv";
 import { mockOAuthFlow } from "./helpers/mock-oauth-flow";
@@ -645,6 +646,136 @@ describe("publish", () => {
       await runWrangler("publish ./index --env dev --legacy-env false");
     });
 
+    describe("custom domains", () => {
+      it("should publish routes marked with 'custom_domain' as seperate custom domains", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "api.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        mockUpdateWorkerRequest({ enabled: false });
+        mockUploadWorkerRequest({ expectedType: "esm" });
+        mockPublishCustomDomainsRequest({
+          publishFlags: {
+            override_scope: true,
+            override_existing_origin: false,
+            override_existing_dns_record: false,
+          },
+          domains: [{ hostname: "api.example.com" }],
+        });
+        await runWrangler("publish ./index");
+        expect(std.out).toContain("api.example.com (custom domain)");
+      });
+
+      it("should allow retrying if publish fails with a conflicting custom domain error", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "api.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        mockUpdateWorkerRequest({ enabled: false });
+        mockUploadWorkerRequest({ expectedType: "esm" });
+        mockPublishCustomDomainsRequestConflictWithoutOverride({
+          originConflicts: true,
+          domains: [{ hostname: "api.example.com" }],
+        });
+        mockConfirm({
+          text: `Custom Domains already exist for these domains: "api.example.com"\nUpdate them to point to this script instead?`,
+          result: true,
+        });
+        await runWrangler("publish ./index");
+        expect(std.out).toContain("api.example.com (custom domain)");
+      });
+
+      it("should allow retrying if publish fails with a conflicting DNS record error", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "api.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        mockUpdateWorkerRequest({ enabled: false });
+        mockUploadWorkerRequest({ expectedType: "esm" });
+        mockPublishCustomDomainsRequestConflictWithoutOverride({
+          dnsRecordConflicts: true,
+          domains: [{ hostname: "api.example.com" }],
+        });
+        mockConfirm({
+          text: `You already have conflicting DNS records for these domains: "api.example.com"\nUpdate them to point to this script instead?`,
+          result: true,
+        });
+        await runWrangler("publish ./index");
+        expect(std.out).toContain("api.example.com (custom domain)");
+      });
+
+      it("should allow retrying for conflicting custom domains and then again for conflicting dns", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "api.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        mockUpdateWorkerRequest({ enabled: false });
+        mockUploadWorkerRequest({ expectedType: "esm" });
+        mockPublishCustomDomainsRequestConflictWithoutOverride({
+          originConflicts: true,
+          dnsRecordConflicts: true,
+          domains: [{ hostname: "api.example.com" }],
+        });
+        mockConfirm(
+          {
+            text: `Custom Domains already exist for these domains: "api.example.com"\nUpdate them to point to this script instead?`,
+            result: true,
+          },
+          {
+            text: `You already have conflicting DNS records for these domains: "api.example.com"\nUpdate them to point to this script instead?`,
+            result: true,
+          }
+        );
+        await runWrangler("publish ./index");
+        expect(std.out).toContain("api.example.com (custom domain)");
+      });
+
+      it("should throw if an invalid custom domain is requested", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "*.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        await expect(
+          runWrangler("publish ./index")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Cannot use \\"*.example.com\\" as a Custom Domain; wildcard operators (*) are not allowed"`
+        );
+
+        writeWranglerToml({
+          routes: [
+            { pattern: "api.example.com/at/a/path", custom_domain: true },
+          ],
+        });
+        writeWorkerSource();
+        await expect(
+          runWrangler("publish ./index")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Cannot use \\"api.example.com/at/a/path\\" as a Custom Domain; paths are not allowed"`
+        );
+      });
+
+      it("should not retry publish on error if user does not confirm", async () => {
+        writeWranglerToml({
+          routes: [{ pattern: "api.example.com", custom_domain: true }],
+        });
+        writeWorkerSource();
+        mockUpdateWorkerRequest({ enabled: false });
+        mockUploadWorkerRequest({ expectedType: "esm" });
+        mockPublishCustomDomainsRequestConflictWithoutOverride({
+          dnsRecordConflicts: true,
+          domains: [{ hostname: "api.example.com" }],
+        });
+        mockConfirm({
+          text: `You already have conflicting DNS records for these domains: "api.example.com"\nUpdate them to point to this script instead?`,
+          result: false,
+        });
+        await runWrangler("publish ./index");
+        expect(std.out).toContain(
+          'Publishing to Custom Domain "api.example.com" was skipped, fix conflict and try again'
+        );
+      });
+    });
+
     it.todo("should error if it's a workers.dev route");
   });
 
@@ -3106,6 +3237,7 @@ addEventListener('fetch', event => {});`
               name: "DURABLE_OBJECT_TWO",
               class_name: "AnotherDurableObject",
               script_name: "another-durable-object-worker",
+              environment: "staging",
             },
           ],
         },
@@ -3164,6 +3296,12 @@ addEventListener('fetch', event => {});`
       mockUploadWorkerRequest({
         expectedType: "sw",
         expectedBindings: [
+          { json: 123, name: "ENV_VAR_ONE", type: "json" },
+          {
+            name: "ENV_VAR_TWO",
+            text: "Hello, I'm an environment variable",
+            type: "plain_text",
+          },
           {
             name: "KV_NAMESPACE_ONE",
             namespace_id: "kv-ns-one-id",
@@ -3182,6 +3320,7 @@ addEventListener('fetch', event => {});`
           },
           {
             class_name: "AnotherDurableObject",
+            environment: "staging",
             name: "DURABLE_OBJECT_TWO",
             script_name: "another-durable-object-worker",
             type: "durable_object_namespace",
@@ -3196,12 +3335,6 @@ addEventListener('fetch', event => {});`
             name: "R2_BUCKET_TWO",
             type: "r2_bucket",
           },
-          { json: 123, name: "ENV_VAR_ONE", type: "json" },
-          {
-            name: "ENV_VAR_TWO",
-            text: "Hello, I'm an environment variable",
-            type: "plain_text",
-          },
           {
             name: "WASM_MODULE_ONE",
             part: "WASM_MODULE_ONE",
@@ -4123,6 +4256,47 @@ addEventListener('fetch', event => {});`
       });
     });
 
+    describe("[services]", () => {
+      it("should support service bindings", async () => {
+        writeWranglerToml({
+          services: [
+            {
+              binding: "FOO",
+              service: "foo-service",
+              environment: "production",
+            },
+          ],
+        });
+        writeWorkerSource();
+        mockSubDomainRequest();
+        mockUploadWorkerRequest({
+          expectedBindings: [
+            {
+              type: "service",
+              name: "FOO",
+              service: "foo-service",
+              environment: "production",
+            },
+          ],
+        });
+
+        await runWrangler("publish index.js");
+        expect(std.out).toMatchInlineSnapshot(`
+                  "Uploaded test-name (TIMINGS)
+                  Published test-name (TIMINGS)
+                    test-name.test-sub-domain.workers.dev"
+              `);
+        expect(std.err).toMatchInlineSnapshot(`""`);
+        expect(std.warn).toMatchInlineSnapshot(`
+          "▲ [WARNING] Processing wrangler.toml configuration:
+
+              - \\"services\\" fields are experimental and may change or break at any time.
+
+          "
+        `);
+      });
+    });
+
     describe("[unsafe]", () => {
       it("should warn if using unsafe bindings", async () => {
         writeWranglerToml({
@@ -4625,8 +4799,16 @@ addEventListener('fetch', event => {});`
 
   describe("--dry-run", () => {
     it("should not publish the worker if --dry-run is specified", async () => {
-      writeWranglerToml();
+      writeWranglerToml({
+        // add a durable object with migrations
+        // to make sure we _don't_ fetch migration status
+        durable_objects: {
+          bindings: [{ name: "NAME", class_name: "SomeClass" }],
+        },
+        migrations: [{ tag: "v1", new_classes: ["SomeClass"] }],
+      });
       writeWorkerSource();
+      process.env.CLOUDFLARE_ACCOUNT_ID = "";
       await runWrangler("publish index.js --dry-run");
       expect(std).toMatchInlineSnapshot(`
         Object {
@@ -4656,6 +4838,27 @@ addEventListener('fetch', event => {});`
       `);
     });
 
+    it("should recommend node compatibility mode when using node builtins and node-compat isn't enabled", async () => {
+      writeWranglerToml();
+      fs.writeFileSync(
+        "index.js",
+        `
+      import path from 'path';
+      console.log(path.join("some/path/to", "a/file.txt"));
+      export default {}
+      `
+      );
+      let err: Error | undefined;
+      try {
+        await runWrangler("publish index.js --dry-run"); // expecting this to throw, as node compatibility isn't enabled
+      } catch (e) {
+        err = e as Error;
+      }
+      expect(err?.message).toMatch(
+        `Detected a Node builtin module import while Node compatibility is disabled.\nAdd node_compat = true to your wrangler.toml file to enable Node compatibility.`
+      );
+    });
+
     it("should polyfill node builtins when enabled", async () => {
       writeWranglerToml();
       fs.writeFileSync(
@@ -4850,6 +5053,102 @@ function mockPublishRoutesRequest({
   );
 }
 
+function mockPublishCustomDomainsRequest({
+  publishFlags,
+  domains = [],
+  env = undefined,
+  legacyEnv = false,
+}: {
+  publishFlags: {
+    override_scope: boolean;
+    override_existing_origin: boolean;
+    override_existing_dns_record: boolean;
+  };
+  domains: Array<
+    { hostname: string } & ({ zone_id?: string } | { zone_name?: string })
+  >;
+  env?: string | undefined;
+  legacyEnv?: boolean | undefined;
+}) {
+  const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
+  const environment = env && !legacyEnv ? "/environments/:envName" : "";
+
+  setMockResponse(
+    `/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/domains`,
+    "PUT",
+    ([_url, accountId, scriptName, envName], { body }) => {
+      expect(accountId).toEqual("some-account-id");
+      expect(scriptName).toEqual(
+        legacyEnv && env ? `test-name-${env}` : "test-name"
+      );
+      if (!legacyEnv) {
+        expect(envName).toEqual(env);
+      }
+
+      expect(JSON.parse(body as string)).toEqual({
+        ...publishFlags,
+        origins: domains,
+      });
+
+      return null;
+    }
+  );
+}
+
+function mockPublishCustomDomainsRequestConflictWithoutOverride({
+  domains = [],
+  originConflicts = false,
+  dnsRecordConflicts = false,
+  env = undefined,
+  legacyEnv = false,
+}: {
+  originConflicts?: boolean;
+  dnsRecordConflicts?: boolean;
+  domains: Array<
+    { hostname: string } & ({ zone_id?: string } | { zone_name?: string })
+  >;
+  env?: string | undefined;
+  legacyEnv?: boolean | undefined;
+}) {
+  const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
+  const environment = env && !legacyEnv ? "/environments/:envName" : "";
+
+  setMockRawResponse(
+    `/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/domains`,
+    "PUT",
+    ([_url, accountId, scriptName, envName], { body }) => {
+      expect(accountId).toEqual("some-account-id");
+      expect(scriptName).toEqual(
+        legacyEnv && env ? `test-name-${env}` : "test-name"
+      );
+      if (!legacyEnv) {
+        expect(envName).toEqual(env);
+      }
+
+      const parsed = JSON.parse(body as string);
+      expect(parsed.origins).toEqual(domains);
+
+      if (originConflicts && !parsed.override_existing_origin) {
+        return createFetchResult(null, false, [
+          {
+            code: 100116,
+            message: `Cannot create Custom Domain "${domains[0].hostname}": Custom Domain already exists and points to a different script; retry and use option "override_existing_origin" to override`,
+          },
+        ]);
+      }
+      if (dnsRecordConflicts && !parsed.override_existing_dns_record) {
+        return createFetchResult(null, false, [
+          {
+            code: 100117,
+            message: `Cannot create Custom Domain "${domains[0].hostname}": a DNS record already exists for this origin; retry and use option "override_existing_dns_record" to override`,
+          },
+        ]);
+      }
+      return createFetchResult(null, true);
+    }
+  );
+}
+
 /** Create a mock handler for the request to get a list of all KV namespaces. */
 function mockListKVNamespacesRequest(...namespaces: KVNamespaceInfo[]) {
   setMockResponse(

package/src/__tests__/r2.test.ts

@@ -17,6 +17,33 @@ describe("wrangler", () => {
 
   describe("r2", () => {
     describe("bucket", () => {
+      it("should show the correct help when an invalid command is passed", async () => {
+        await expect(() =>
+          runWrangler("r2 bucket foo")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(`"Unknown argument: foo"`);
+        expect(std.err).toMatchInlineSnapshot(`
+          "X [ERROR] Unknown argument: foo
+
+          "
+        `);
+        expect(std.out).toMatchInlineSnapshot(`
+          "
+          wrangler r2 bucket
+
+          Manage R2 buckets
+
+          Commands:
+            wrangler r2 bucket create <name>  Create a new R2 bucket
+            wrangler r2 bucket list           List R2 buckets
+            wrangler r2 bucket delete <name>  Delete an R2 bucket
+
+          Flags:
+            -c, --config   Path to .toml configuration file  [string]
+            -h, --help     Show help  [boolean]
+            -v, --version  Show version number  [boolean]"
+        `);
+      });
+
       describe("list", () => {
         function mockListRequest(buckets: R2BucketInfo[]) {
           const requests = { count: 0 };
@@ -69,10 +96,7 @@ describe("wrangler", () => {
           );
           expect(std.out).toMatchInlineSnapshot(`
             "
-            "
-          `);
-          expect(std.err).toMatchInlineSnapshot(`
-            "wrangler r2 bucket create <name>
+            wrangler r2 bucket create <name>
 
             Create a new R2 bucket
 
@@ -82,8 +106,10 @@ describe("wrangler", () => {
             Flags:
               -c, --config   Path to .toml configuration file  [string]
               -h, --help     Show help  [boolean]
-              -v, --version  Show version number  [boolean]
-            X [ERROR] Not enough non-option arguments: got 0, need at least 1
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
           `);
@@ -97,10 +123,7 @@ describe("wrangler", () => {
           );
           expect(std.out).toMatchInlineSnapshot(`
             "
-            "
-          `);
-          expect(std.err).toMatchInlineSnapshot(`
-            "wrangler r2 bucket create <name>
+            wrangler r2 bucket create <name>
 
             Create a new R2 bucket
 
@@ -110,8 +133,10 @@ describe("wrangler", () => {
             Flags:
               -c, --config   Path to .toml configuration file  [string]
               -h, --help     Show help  [boolean]
-              -v, --version  Show version number  [boolean]
-            X [ERROR] Unknown arguments: def, ghi
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Unknown arguments: def, ghi
 
             "
           `);
@@ -151,10 +176,7 @@ describe("wrangler", () => {
           );
           expect(std.out).toMatchInlineSnapshot(`
             "
-            "
-          `);
-          expect(std.err).toMatchInlineSnapshot(`
-            "wrangler r2 bucket delete <name>
+            wrangler r2 bucket delete <name>
 
             Delete an R2 bucket
 
@@ -164,8 +186,10 @@ describe("wrangler", () => {
             Flags:
               -c, --config   Path to .toml configuration file  [string]
               -h, --help     Show help  [boolean]
-              -v, --version  Show version number  [boolean]
-            X [ERROR] Not enough non-option arguments: got 0, need at least 1
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
           `);
@@ -179,10 +203,7 @@ describe("wrangler", () => {
           );
           expect(std.out).toMatchInlineSnapshot(`
             "
-            "
-          `);
-          expect(std.err).toMatchInlineSnapshot(`
-            "wrangler r2 bucket delete <name>
+            wrangler r2 bucket delete <name>
 
             Delete an R2 bucket
 
@@ -192,8 +213,10 @@ describe("wrangler", () => {
             Flags:
               -c, --config   Path to .toml configuration file  [string]
               -h, --help     Show help  [boolean]
-              -v, --version  Show version number  [boolean]
-            X [ERROR] Unknown arguments: def, ghi
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Unknown arguments: def, ghi
 
             "
           `);

package/src/__tests__/secret.test.ts

@@ -60,6 +60,22 @@ describe("wrangler secret", () => {
     describe("interactive", () => {
       useMockStdin({ isTTY: true });
 
+      it("should trim stdin secret value", async () => {
+        mockPrompt({
+          text: "Enter a secret value:",
+          type: "password",
+          result: `hunter2
+          `,
+        });
+
+        mockPutRequest({ name: `secret-name`, text: `hunter2` });
+        await runWrangler("secret put secret-name --name script-name");
+        expect(std.out).toMatchInlineSnapshot(`
+          "🌀 Creating the secret for script script-name
+          ✨ Success! Uploaded secret secret-name"
+        `);
+      });
+
       it("should create a secret", async () => {
         mockPrompt({
           text: "Enter a secret value:",
@@ -146,6 +162,25 @@ describe("wrangler secret", () => {
     describe("non-interactive", () => {
       const mockStdIn = useMockStdin({ isTTY: false });
 
+      it("should trim stdin secret value, from piped input", async () => {
+        mockPutRequest({ name: "the-key", text: "the-secret" });
+        // Pipe the secret in as three chunks to test that we reconstitute it correctly.
+        mockStdIn.send(
+          `the`,
+          `-`,
+          `secret
+          ` // whitespace & newline being removed
+        );
+        await runWrangler("secret put the-key --name script-name");
+
+        expect(std.out).toMatchInlineSnapshot(`
+          "🌀 Creating the secret for script script-name
+          ✨ Success! Uploaded secret the-key"
+        `);
+        expect(std.warn).toMatchInlineSnapshot(`""`);
+        expect(std.err).toMatchInlineSnapshot(`""`);
+      });
+
       it("should create a secret, from piped input", async () => {
         mockPutRequest({ name: "the-key", text: "the-secret" });
         // Pipe the secret in as three chunks to test that we reconstitute it correctly.

package/src/bundle.ts

@@ -1,5 +1,6 @@
 import assert from "node:assert";
 import * as fs from "node:fs";
+import { builtinModules } from "node:module";
 import * as path from "node:path";
 import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
 import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
@@ -16,6 +17,33 @@ type BundleResult = {
   stop: (() => void) | undefined;
 };
 
+/**
+ * Searches for any uses of node's builtin modules, and throws an error if it
+ * finds anything. This plugin is only used when nodeCompat is not enabled.
+ * Supports both regular node builtins, and the new "node:<MODULE>" format.
+ */
+const checkForNodeBuiltinsPlugin = {
+  name: "checkForNodeBuiltins",
+  setup(build: esbuild.PluginBuild) {
+    build.onResolve(
+      {
+        filter: new RegExp(
+          "^(" +
+            builtinModules.join("|") +
+            "|" +
+            builtinModules.map((module) => "node:" + module).join("|") +
+            ")$"
+        ),
+      },
+      () => {
+        throw new Error(
+          `Detected a Node builtin module import while Node compatibility is disabled.\nAdd node_compat = true to your wrangler.toml file to enable Node compatibility.`
+        );
+      }
+    );
+  },
+};
+
 /**
  * Generate a bundle for the worker identified by the arguments passed in.
  */
@@ -60,6 +88,7 @@ export async function bundleWorker(
     format: entry.format,
     rules,
   });
+
   const result = await esbuild.build({
     ...getEntryPoint(entry.file, serveAssetsFromWorker),
     bundle: true,
@@ -87,7 +116,9 @@ export async function bundleWorker(
       moduleCollector.plugin,
       ...(nodeCompat
         ? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
-        : []),
+        : // we use checkForNodeBuiltinsPlugin to throw a nicer error
+          // if we find node builtins when nodeCompat isn't turned on
+          [checkForNodeBuiltinsPlugin]),
     ],
     ...(jsxFactory && { jsxFactory }),
     ...(jsxFragment && { jsxFragment }),