wrangler 0.0.0-e2f9bb2 → 0.0.0-e322475

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
 
@@ -80,11 +104,12 @@ describe("wrangler", () => {
               name  The name of the new bucket  [string] [required]
 
             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]
-            X [ERROR] Not enough non-option arguments: got 0, need at least 1
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
           `);
@@ -98,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
 
@@ -109,11 +131,12 @@ describe("wrangler", () => {
               name  The name of the new bucket  [string] [required]
 
             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]
-            X [ERROR] Unknown arguments: def, ghi
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Unknown arguments: def, ghi
 
             "
           `);
@@ -153,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,11 +184,12 @@ describe("wrangler", () => {
               name  The name of the bucket to delete  [string] [required]
 
             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]
-            X [ERROR] Not enough non-option arguments: got 0, need at least 1
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]"
+          `);
+          expect(std.err).toMatchInlineSnapshot(`
+            "X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
           `);
@@ -182,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
 
@@ -193,11 +211,12 @@ describe("wrangler", () => {
               name  The name of the bucket to delete  [string] [required]
 
             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]
-            X [ERROR] Unknown arguments: def, ghi
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -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:",
@@ -132,7 +148,7 @@ describe("wrangler secret", () => {
         }
         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 script name
@@ -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.
@@ -169,7 +204,7 @@ describe("wrangler secret", () => {
 
         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.warn).toMatchInlineSnapshot(`""`);
       });
@@ -337,7 +372,7 @@ describe("wrangler secret", () => {
       }
       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 script name
@@ -433,7 +468,7 @@ describe("wrangler secret", () => {
       }
       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 script name

package/src/__tests__/user.test.ts

@@ -46,6 +46,7 @@ describe("User", () => {
 
       expect(std.out).toMatchInlineSnapshot(`
         "Attempting to login via OAuth...
+        Opening a link in your default browser: https://dash.cloudflare.com/oauth2/auth?response_type=code&client_id=54d11594-84e4-41aa-b438-e81b8fa78ee7&redirect_uri=http%3A%2F%2Flocalhost%3A8976%2Foauth%2Fcallback&scope=account%3Aread%20user%3Aread%20workers%3Awrite%20workers_kv%3Awrite%20workers_routes%3Awrite%20workers_scripts%3Awrite%20workers_tail%3Aread%20pages%3Awrite%20zone%3Aread%20offline_access&state=MOCK_STATE_PARAM&code_challenge=MOCK_CODE_CHALLENGE&code_challenge_method=S256
         Successfully logged in."
       `);
 

package/src/__tests__/whoami.test.tsx

@@ -9,6 +9,8 @@ import { runInTempDir } from "./helpers/run-in-tmp";
 import type { UserInfo } from "../whoami";
 
 describe("getUserInfo()", () => {
+  const ENV_COPY = process.env;
+
   runInTempDir({ homedir: "./home" });
   const std = mockConsoleMethods();
   const { setIsTTY } = useMockIsTTY();
@@ -17,6 +19,10 @@ describe("getUserInfo()", () => {
     setIsTTY(true);
   });
 
+  afterEach(() => {
+    process.env = ENV_COPY;
+  });
+
   it("should return undefined if there is no config file", async () => {
     const userInfo = await getUserInfo();
     expect(userInfo).toBeUndefined();
@@ -28,6 +34,34 @@ describe("getUserInfo()", () => {
     expect(userInfo).toBeUndefined();
   });
 
+  it("should say it's using an API token when one is set", async () => {
+    process.env = {
+      CLOUDFLARE_API_TOKEN: "123456789",
+    };
+    setMockResponse("/user", () => {
+      return { email: "user@example.com" };
+    });
+    setMockResponse("/accounts", () => {
+      return [
+        { name: "Account One", id: "account-1" },
+        { name: "Account Two", id: "account-2" },
+        { name: "Account Three", id: "account-3" },
+      ];
+    });
+
+    const userInfo = await getUserInfo();
+    expect(userInfo).toEqual({
+      authType: "API",
+      apiToken: "123456789",
+      email: "user@example.com",
+      accounts: [
+        { name: "Account One", id: "account-1" },
+        { name: "Account Two", id: "account-2" },
+        { name: "Account Three", id: "account-3" },
+      ],
+    });
+  });
+
   it("should return the user's email and accounts if authenticated via config token", async () => {
     writeAuthConfigFile({ oauth_token: "some-oauth-token" });
 

package/src/abort.d.ts

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

package/src/bundle-reporter.tsx

@@ -0,0 +1,29 @@
+import { Blob } from "node:buffer";
+import { gzipSync } from "node:zlib";
+import { logger } from "./logger";
+import type { CfModule } from "./worker";
+
+async function getSize(modules: CfModule[]) {
+  const gzipSize = gzipSync(
+    await new Blob(modules.map((file) => file.content)).arrayBuffer()
+  ).byteLength;
+  const aggregateSize = new Blob(modules.map((file) => file.content)).size;
+
+  return { size: aggregateSize, gzipSize };
+}
+
+export async function printBundleSize(
+  main: {
+    name: string;
+    content: string;
+  },
+  modules: CfModule[]
+) {
+  const { size, gzipSize } = await getSize([...modules, main]);
+
+  const bundleReport = `${(size / 1024).toFixed(2)} KiB / gzip: ${(
+    gzipSize / 1024
+  ).toFixed(2)} KiB`;
+
+  logger.log(`Total Upload: ${bundleReport}`);
+}

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,13 +88,14 @@ export async function bundleWorker(
     format: entry.format,
     rules,
   });
+
   const result = await esbuild.build({
     ...getEntryPoint(entry.file, serveAssetsFromWorker),
     bundle: true,
     absWorkingDir: entry.directory,
     outdir: destination,
     external: ["__STATIC_CONTENT_MANIFEST"],
-    format: "esm",
+    format: entry.format === "modules" ? "esm" : "iife",
     target: "es2020",
     sourcemap: true,
     minify,
@@ -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 }),
@@ -123,9 +154,7 @@ export async function bundleWorker(
   };
 }
 
-type EntryPoint =
-  | { stdin: esbuild.StdinOptions; nodePaths: string[] }
-  | { entryPoints: string[] };
+type EntryPoint = { stdin: esbuild.StdinOptions } | { entryPoints: string[] };
 
 /**
  * Create an object that describes the entry point for esbuild.
@@ -146,11 +175,17 @@ function getEntryPoint(
             path.join(__dirname, "../templates/static-asset-facade.js"),
             "utf8"
           )
-          .replace("__ENTRY_POINT__", entryFile),
+          // on windows, escape backslashes in the path (`\`)
+          .replace("__ENTRY_POINT__", entryFile.replaceAll("\\", "\\\\"))
+          .replace(
+            "__KV_ASSET_HANDLER__",
+            path
+              .join(__dirname, "../kv-asset-handler.js")
+              .replaceAll("\\", "\\\\")
+          ),
         sourcefile: "static-asset-facade.js",
         resolveDir: path.dirname(entryFile),
       },
-      nodePaths: [path.join(__dirname, "../vendor")],
     };
   } else {
     return { entryPoints: [entryFile] };

package/src/cfetch/index.ts

@@ -10,6 +10,7 @@ export { getCloudflareAPIBaseURL as getCloudflareApiBaseUrl } from "./internal";
 export interface FetchError {
   code: number;
   message: string;
+  error_chain?: FetchError[];
 }
 export interface FetchResult<ResponseType = unknown> {
   success: boolean;
@@ -27,12 +28,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;
@@ -83,9 +86,9 @@ function throwFetchError(
   response: FetchResult<unknown>
 ): never {
   const error = new ParseError({
-    text: "Received a bad response from the API",
+    text: `A request to the Cloudflare API (${resource}) failed.`,
     notes: response.errors.map((err) => ({
-      text: err.code ? `${err.message} [code: ${err.code}]` : err.message,
+      text: renderError(err),
     })),
   });
   // add the first error code directly to this error
@@ -102,3 +105,17 @@ function hasCursor(result_info: unknown): result_info is { cursor: string } {
   const cursor = (result_info as { cursor: string } | undefined)?.cursor;
   return cursor !== undefined && cursor !== null && cursor !== "";
 }
+
+function renderError(err: FetchError, level = 0): string {
+  const chainedMessages =
+    err.error_chain
+      ?.map(
+        (chainedError) =>
+          `\n${"  ".repeat(level)}- ${renderError(chainedError, level + 1)}`
+      )
+      .join("\n") ?? "";
+  return (
+    (err.code ? `${err.message} [code: ${err.code}]` : err.message) +
+    chainedMessages
+  );
+}

package/src/cfetch/internal.ts

@@ -1,7 +1,9 @@
+import assert from "node:assert";
 import { fetch, Headers } from "undici";
+import { version as wranglerVersion } from "../../package.json";
 import { getEnvironmentVariableFactory } from "../environment-variables";
 import { ParseError, parseJSON } from "../parse";
-import { getAPIToken, loginOrRefreshIfRequired } from "../user";
+import { loginOrRefreshIfRequired, requireApiToken } from "../user";
 import type { URLSearchParams } from "node:url";
 import type { RequestInit, HeadersInit } from "undici";
 
@@ -26,12 +28,18 @@ export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
 export async function fetchInternal<ResponseType>(
   resource: string,
   init: RequestInit = {},
-  queryParams?: URLSearchParams
+  queryParams?: URLSearchParams,
+  abortSignal?: AbortSignal
 ): Promise<ResponseType> {
+  assert(
+    resource.startsWith("/"),
+    `CF API fetch - resource path must start with a "/" but got "${resource}"`
+  );
   await requireLoggedIn();
   const apiToken = requireApiToken();
   const headers = cloneHeaders(init.headers);
-  addAuthorizationHeader(headers, apiToken);
+  addAuthorizationHeaderIfUnspecified(headers, apiToken);
+  addUserAgent(headers);
 
   const queryString = queryParams ? `?${queryParams.toString()}` : "";
   const method = init.method ?? "GET";
@@ -41,11 +49,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",
@@ -86,24 +95,17 @@ async function requireLoggedIn(): Promise<void> {
   }
 }
 
-function requireApiToken(): string {
-  const authToken = getAPIToken();
-  if (!authToken) {
-    throw new Error("No API token found.");
-  }
-  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}`;
+}
+
+function addUserAgent(headers: Record<string, string>): void {
+  headers["User-Agent"] = `wrangler/${wranglerVersion}`;
 }
 
 /**
@@ -112,13 +114,16 @@ 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(
   accountId: string,
   namespaceId: string,
   key: string
-): Promise<string> {
+): Promise<ArrayBuffer> {
   await requireLoggedIn();
   const apiToken = requireApiToken();
   const headers = { Authorization: `Bearer ${apiToken}` };
@@ -128,7 +133,7 @@ export async function fetchKVGetValue(
     headers,
   });
   if (response.ok) {
-    return await response.text();
+    return await response.arrayBuffer();
   } else {
     throw new Error(
       `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`

package/src/config/config.ts

@@ -114,6 +114,15 @@ export interface ConfigFields<Dev extends RawDevConfig> {
       }
     | undefined;
 
+  /**
+   * Serve a folder of static assets with your Worker, without any additional code.
+   * This can either be a string, or an object with additional config fields.
+   */
+  assets:
+    | string
+    | { bucket: string; include: string[]; exclude: string[] }
+    | undefined;
+
   /**
    * A list of wasm modules that your worker should be bound to. This is
    * the "legacy" way of binding to a wasm module. ES module workers should
@@ -161,7 +170,7 @@ export interface DevConfig {
    *
    * @default `8787`
    */
-  port: number;
+  port: number | undefined;
 
   /**
    * Protocol that local wrangler dev server listens to requests on.
@@ -184,7 +193,7 @@ export interface DevConfig {
   /**
    * Host to forward requests to, defaults to the host of the first route of project
    */
-  host: Config["route"];
+  host: string | undefined;
 }
 
 export type RawDevConfig = Partial<DevConfig>;