wrangler 2.0.3 → 2.0.7

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/abort.d.ts

@@ -0,0 +1,3 @@
+declare interface AbortSignal {
+  addEventListener(event: "abort", handler: () => void);
+}

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 }),

package/src/cfetch/index.ts

@@ -27,12 +27,14 @@ export { fetchKVGetValue } from "./internal";
 export async function fetchResult<ResponseType>(
   resource: string,
   init: RequestInit = {},
-  queryParams?: URLSearchParams
+  queryParams?: URLSearchParams,
+  abortSignal?: AbortSignal
 ): Promise<ResponseType> {
   const json = await fetchInternal<FetchResult<ResponseType>>(
     resource,
     init,
-    queryParams
+    queryParams,
+    abortSignal
   );
   if (json.success) {
     return json.result;

package/src/cfetch/internal.ts

@@ -26,12 +26,13 @@ export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
 export async function fetchInternal<ResponseType>(
   resource: string,
   init: RequestInit = {},
-  queryParams?: URLSearchParams
+  queryParams?: URLSearchParams,
+  abortSignal?: AbortSignal
 ): Promise<ResponseType> {
   await requireLoggedIn();
   const apiToken = requireApiToken();
   const headers = cloneHeaders(init.headers);
-  addAuthorizationHeader(headers, apiToken);
+  addAuthorizationHeaderIfUnspecified(headers, apiToken);
 
   const queryString = queryParams ? `?${queryParams.toString()}` : "";
   const method = init.method ?? "GET";
@@ -41,11 +42,12 @@ export async function fetchInternal<ResponseType>(
       method,
       ...init,
       headers,
+      signal: abortSignal,
     }
   );
   const jsonText = await response.text();
   try {
-    return parseJSON(jsonText) as ResponseType;
+    return parseJSON<ResponseType>(jsonText);
   } catch (err) {
     throw new ParseError({
       text: "Received a malformed response from the API",
@@ -94,16 +96,13 @@ function requireApiToken(): string {
   return authToken;
 }
 
-function addAuthorizationHeader(
+function addAuthorizationHeaderIfUnspecified(
   headers: Record<string, string>,
   apiToken: string
 ): void {
-  if ("Authorization" in headers) {
-    throw new Error(
-      "The request already specifies an authorisation header - cannot add a new one."
-    );
+  if (!("Authorization" in headers)) {
+    headers["Authorization"] = `Bearer ${apiToken}`;
   }
-  headers["Authorization"] = `Bearer ${apiToken}`;
 }
 
 /**
@@ -112,6 +111,9 @@ function addAuthorizationHeader(
  * doesn't return json. We inline the implementation and try not to share
  * any code with the other calls. We should push back on any new APIs that
  * try to introduce non-"standard" response structures.
+ *
+ * Note: any calls to fetchKVGetValue must call encodeURIComponent on key
+ * before passing it
  */
 
 export async function fetchKVGetValue(

package/src/config/environment.ts

@@ -8,6 +8,24 @@ export interface Environment
   extends EnvironmentInheritable,
     EnvironmentNonInheritable {}
 
+export type SimpleRoute = string;
+export type ZoneIdRoute = {
+  pattern: string;
+  zone_id: string;
+  custom_domain?: boolean;
+};
+export type ZoneNameRoute = {
+  pattern: string;
+  zone_name: string;
+  custom_domain?: boolean;
+};
+export type CustomDomainRoute = { pattern: string; custom_domain: boolean };
+export type Route =
+  | SimpleRoute
+  | ZoneIdRoute
+  | ZoneNameRoute
+  | CustomDomainRoute;
+
 /**
  * The `EnvironmentInheritable` interface declares all the configuration fields for an environment
  * that can be inherited (and overridden) from the top-level environment.
@@ -74,13 +92,7 @@ interface EnvironmentInheritable {
    *
    * @inheritable
    */
-  routes:
-    | (
-        | string
-        | { pattern: string; zone_id: string }
-        | { pattern: string; zone_name: string }
-      )[]
-    | undefined;
+  routes: Route[] | undefined;
 
   /**
    * A route that your worker should be published to. Literally
@@ -91,13 +103,7 @@ interface EnvironmentInheritable {
    *
    * @inheritable
    */
-  route:
-    | (
-        | string
-        | { pattern: string; zone_id: string }
-        | { pattern: string; zone_name: string }
-      )
-    | undefined;
+  route: Route | undefined;
 
   /**
    * Path to a custom tsconfig
@@ -236,6 +242,8 @@ interface EnvironmentNonInheritable {
       class_name: string;
       /** The script where the Durable Object is defined (if it's external to this worker) */
       script_name?: string;
+      /** The service environment of the script_name to bind to */
+      environment?: string;
     }[];
   };
 
@@ -279,6 +287,24 @@ interface EnvironmentNonInheritable {
     preview_bucket_name?: string;
   }[];
 
+  /**
+   * Specifies service bindings (worker-to-worker) that are bound to this Worker environment.
+   *
+   * NOTE: This field is not automatically inherited from the top level environment,
+   * and so must be specified in every named environment.
+   *
+   * @default `[]`
+   * @nonInheritable
+   */
+  services: {
+    /** The binding name used to refer to the bound service. */
+    binding: string;
+    /** The name of the service. */
+    service: string;
+    /** The environment of the service (e.g. production, staging, etc). */
+    environment?: string;
+  }[];
+
   /**
    * "Unsafe" tables for features that aren't directly supported by wrangler.
    *

package/src/config/index.ts

@@ -2,6 +2,7 @@ import { findUpSync } from "find-up";
 import { logger } from "../logger";
 import { parseTOML, readFileSync } from "../parse";
 import { normalizeAndValidateConfig } from "./validation";
+import type { CfWorkerInit } from "../worker";
 import type { Config, RawConfig } from "./config";
 
 export type {
@@ -61,3 +62,164 @@ export function findWranglerToml(
   const configPath = findUpSync("wrangler.toml", { cwd: referencePath });
   return configPath;
 }
+
+/**
+ * Print all the bindings a worker using a given config would have access to
+ */
+export function printBindings(bindings: CfWorkerInit["bindings"]) {
+  const truncate = (item: string | Record<string, unknown>) => {
+    const s = typeof item === "string" ? item : JSON.stringify(item);
+    const maxLength = 40;
+    if (s.length < maxLength) {
+      return s;
+    }
+
+    return `${s.substring(0, maxLength - 3)}...`;
+  };
+
+  const output: { type: string; entries: { key: string; value: string }[] }[] =
+    [];
+
+  const {
+    data_blobs,
+    durable_objects,
+    kv_namespaces,
+    r2_buckets,
+    services,
+    text_blobs,
+    unsafe,
+    vars,
+    wasm_modules,
+  } = bindings;
+
+  if (data_blobs !== undefined && Object.keys(data_blobs).length > 0) {
+    output.push({
+      type: "Data Blobs",
+      entries: Object.entries(data_blobs).map(([key, value]) => ({
+        key,
+        value: truncate(value),
+      })),
+    });
+  }
+
+  if (durable_objects !== undefined && durable_objects.bindings.length > 0) {
+    output.push({
+      type: "Durable Objects",
+      entries: durable_objects.bindings.map(
+        ({ name, class_name, script_name, environment }) => {
+          let value = class_name;
+          if (script_name) {
+            value += ` (defined in ${script_name})`;
+          }
+          if (environment) {
+            value += ` - ${environment}`;
+          }
+
+          return {
+            key: name,
+            value,
+          };
+        }
+      ),
+    });
+  }
+
+  if (kv_namespaces !== undefined && kv_namespaces.length > 0) {
+    output.push({
+      type: "KV Namespaces",
+      entries: kv_namespaces.map(({ binding, id }) => {
+        return {
+          key: binding,
+          value: id,
+        };
+      }),
+    });
+  }
+
+  if (r2_buckets !== undefined && r2_buckets.length > 0) {
+    output.push({
+      type: "R2 Buckets",
+      entries: r2_buckets.map(({ binding, bucket_name }) => {
+        return {
+          key: binding,
+          value: bucket_name,
+        };
+      }),
+    });
+  }
+
+  if (services !== undefined && services.length > 0) {
+    output.push({
+      type: "Services",
+      entries: services.map(({ binding, service, environment }) => {
+        let value = service;
+        if (environment) {
+          value += ` - ${environment}`;
+        }
+
+        return {
+          key: binding,
+          value,
+        };
+      }),
+    });
+  }
+
+  if (text_blobs !== undefined && Object.keys(text_blobs).length > 0) {
+    output.push({
+      type: "Text Blobs",
+      entries: Object.entries(text_blobs).map(([key, value]) => ({
+        key,
+        value: truncate(value),
+      })),
+    });
+  }
+
+  if (unsafe !== undefined && unsafe.length > 0) {
+    output.push({
+      type: "Unsafe",
+      entries: unsafe.map(({ name, type }) => ({
+        key: type,
+        value: name,
+      })),
+    });
+  }
+
+  if (vars !== undefined && Object.keys(vars).length > 0) {
+    output.push({
+      type: "Vars",
+      entries: Object.entries(vars).map(([key, value]) => ({
+        key,
+        value: `"${truncate(`${value}`)}"`,
+      })),
+    });
+  }
+
+  if (wasm_modules !== undefined && Object.keys(wasm_modules).length > 0) {
+    output.push({
+      type: "Wasm Modules",
+      entries: Object.entries(wasm_modules).map(([key, value]) => ({
+        key,
+        value: truncate(value),
+      })),
+    });
+  }
+
+  if (output.length === 0) {
+    return;
+  }
+
+  const message = [
+    `Your worker has access to the following bindings:`,
+    ...output
+      .map((bindingGroup) => {
+        return [
+          `- ${bindingGroup.type}:`,
+          bindingGroup.entries.map(({ key, value }) => `  - ${key}: ${value}`),
+        ];
+      })
+      .flat(2),
+  ].join("\n");
+
+  logger.log(message);
+}