wrangler 0.0.13 → 0.0.17

package/src/cfetch/index.ts

@@ -1,6 +1,6 @@
-import type { RequestInit } from "node-fetch";
-import { URLSearchParams } from "url";
+import { URLSearchParams } from "node:url";
 import { fetchInternal } from "./internal";
+import type { RequestInit } from "undici";
 
 // Check out https://api.cloudflare.com/ for API docs.
 
@@ -18,16 +18,7 @@ export interface FetchResult<ResponseType = unknown> {
   result_info?: unknown;
 }
 
-/**
- * Make a fetch request for a raw JSON value.
- */
-export async function fetchRaw<ResponseType>(
-  resource: string,
-  init: RequestInit = {},
-  queryParams?: URLSearchParams
-): Promise<ResponseType> {
-  return fetchInternal<ResponseType>(resource, init, queryParams);
-}
+export { fetchKVGetValue } from "./internal";
 
 /**
  * Make a fetch request, and extract the `result` from the JSON response.
@@ -92,9 +83,9 @@ function throwFetchError(
 ): never {
   response.messages.forEach((message) => console.warn(message));
   const errors = response.errors
-    .map((error) => `${error.code}: ${error.message}`)
+    .map((error) => `- ${error.code}: ${error.message}`)
     .join("\n");
-  const error = new Error(`Failed to fetch ${resource} - \n${errors}`);
+  const error = new Error(`Failed to fetch ${resource}:\n${errors}`);
   // add the first error code directly to this error
   // so consumers can use it for specific behaviour
   const code = response.errors[0]?.code;
@@ -106,5 +97,6 @@ function throwFetchError(
 }
 
 function hasCursor(result_info: unknown): result_info is { cursor: string } {
-  return (result_info as { cursor: string } | undefined)?.cursor !== undefined;
+  const cursor = (result_info as { cursor: string } | undefined)?.cursor;
+  return cursor !== undefined && cursor !== null && cursor !== "";
 }

package/src/cfetch/internal.ts

@@ -1,6 +1,7 @@
-import fetch from "node-fetch";
-import type { RequestInit, HeadersInit } from "node-fetch";
+import { fetch } from "undici";
 import { getAPIToken, loginOrRefreshIfRequired } from "../user";
+import type { URLSearchParams } from "node:url";
+import type { RequestInit, HeadersInit } from "undici";
 
 export const CF_API_BASE_URL =
   process.env.CF_API_BASE_URL || "https://api.cloudflare.com/client/v4";
@@ -30,7 +31,6 @@ export async function fetchInternal<ResponseType>(
     ...init,
     headers,
   });
-
   const jsonText = await response.text();
   try {
     const json = JSON.parse(jsonText);
@@ -42,7 +42,9 @@ export async function fetchInternal<ResponseType>(
   }
 }
 
-function cloneHeaders(headers: HeadersInit | undefined): HeadersInit {
+function cloneHeaders(
+  headers: HeadersInit | undefined
+): Record<string, string> {
   return { ...headers };
 }
 
@@ -61,11 +63,44 @@ function requireApiToken(): string {
   return apiToken;
 }
 
-function addAuthorizationHeader(headers: HeadersInit, apiToken: string): void {
-  if (headers["Authorization"]) {
+function addAuthorizationHeader(
+  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."
     );
   }
   headers["Authorization"] = `Bearer ${apiToken}`;
 }
+
+/**
+ * The implementation for fetching a kv value from the cloudflare API.
+ * We special-case this one call, because it's the only API call that
+ * 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.
+ */
+
+export async function fetchKVGetValue(
+  accountId: string,
+  namespaceId: string,
+  key: string
+): Promise<string> {
+  await requireLoggedIn();
+  const apiToken = requireApiToken();
+  const headers = { Authorization: `Bearer ${apiToken}` };
+  const resource = `${CF_API_BASE_URL}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
+  const response = await fetch(resource, {
+    method: "GET",
+    headers,
+  });
+  if (response.ok) {
+    return await response.text();
+  } else {
+    throw new Error(
+      `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
+    );
+  }
+}

package/src/cli.ts

@@ -1,6 +1,16 @@
+import process from "process";
 import { hideBin } from "yargs/helpers";
+import { reportError, initReporting } from "./reporting";
 import { main } from ".";
 
+try {
+  initReporting();
+} catch (error) {}
+
+process.on("uncaughtExceptionMonitor", async (err, origin) => {
+  await reportError(err, origin);
+});
+
 main(hideBin(process.argv)).catch(() => {
   // The logging of any error that was thrown from `main()` is handled in the `yargs.fail()` handler.
   // Here we just want to ensure that the process exits with a non-zero code.

package/src/config.ts

@@ -39,7 +39,7 @@ export type Config = {
    * @inherited
    * @todo this needs to be implemented!
    */
-  entry?: string;
+  main?: string;
 
   /**
    * This is the ID of the account associated with your zone.
@@ -154,15 +154,14 @@ export type Config = {
 
   /**
    * A map of environment variables to set when deploying your worker.
-   * Of note, they can only be strings. Which is unfortunate, really.
-   * (TODO: verify that they can only be strings?)
+   *
    * NB: these are not inherited, and HAVE to  be duplicated across all environments.
    *
    * @default `{}`
    * @optional
    * @inherited false
    */
-  vars?: { [key: string]: string };
+  vars?: { [key: string]: unknown };
 
   /**
    * A list of durable objects that your worker should be bound to.
@@ -204,12 +203,22 @@ export type Config = {
     preview_id?: string;
   }[];
 
+  r2_buckets?: {
+    /** The binding name used to refer to the R2 bucket in the worker. */
+    binding: string;
+    /** The name of this R2 bucket at the edge. */
+    bucket_name: string;
+    /** The preview name of this R2 bucket at the edge. */
+    preview_bucket_name?: string;
+  }[];
+
   /**
    * A list of services that your worker should be bound to.
    * NB: these are not inherited, and HAVE to be duplicated across all environments.
    *
    * @default `[]`
    * @optional
+   * @deprecated DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.
    * @inherited false
    */
   experimental_services?: {
@@ -221,11 +230,43 @@ export type Config = {
     environment: string;
   }[];
 
+  /**
+   * 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
+   * do proper module imports.
+   * NB: these ARE NOT inherited, and SHOULD NOT be duplicated across all environments.
+   */
+  wasm_modules?: {
+    [key: string]: string;
+  };
+
+  /**
+   * "Unsafe" tables for features that aren't directly supported by wrangler.
+   * NB: these are not inherited, and HAVE to be duplicated across all environments.
+   *
+   * @default `[]`
+   * @optional
+   * @inherited false
+   */
+  unsafe?: {
+    /**
+     * A set of bindings that should be put into a Worker's upload metadata without changes. These
+     * can be used to implement bindings for features that haven't released and aren't supported
+     * directly by wrangler or miniflare.
+     */
+    bindings?: {
+      name: string;
+      type: string;
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      [key: string]: any;
+    }[];
+  };
+
   /**
    * A list of migrations that should be uploaded with your Worker.
    * These define changes in your Durable Object declarations.
    * More details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations
-   * NB: these ARE inherited, and SHOULD NOT be duplicated across all environments.
+   * NB: these ARE NOT inherited, and SHOULD NOT be duplicated across all environments.
    *
    * @default `[]`
    * @optional
@@ -249,7 +290,7 @@ export type Config = {
    * The definition of a Worker Site, a feature that lets you upload
    * static assets with your Worker.
    * More details at https://developers.cloudflare.com/workers/platform/sites
-   * NB: This IS inherited, and SHOULD NOT be duplicated across all environments.
+   * NB: This IS NOT inherited, and SHOULD NOT be duplicated across all environments.
    *
    * @default `undefined`
    * @optional
@@ -268,7 +309,7 @@ export type Config = {
     /**
      * The location of your Worker script.
      *
-     * @deprecated DO NOT use this (it's a holdover from wrangler 1.x). Either use the top level `entry` field, or pass the path to your entry file as a command line argument.
+     * @deprecated DO NOT use this (it's a holdover from wrangler 1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.
      * @breaking
      */
     "entry-point"?: string;
@@ -377,75 +418,57 @@ export type Config = {
    * Much of the rest of this configuration isn't necessary anymore
    * in wrangler2. We infer the format automatically, and we can pass
    * the path to the script either in the CLI (or, @todo, as the top level
-   * `entry` property).
-   */ (
-    | {
-        upload?: {
-          /**
-           * The format of the Worker script, must be "service-worker".
-           *
-           * @deprecated We infer the format automatically now.
-           */
-          format?: "service-worker";
-
-          /**
-           * The path to the Worker script. This should be replaced
-           * by the top level `entry' property.
-           *
-           * @deprecated This will be replaced by the top level `entry' property.
-           */
-          main: string;
-        };
-      }
-    | {
-        /**
-         * When we use the module format, we only really
-         * need to specify the entry point. The format is deduced
-         * automatically in wrangler2.
-         */
-        upload?: {
-          /**
-           * The format of the Worker script, must be "modules".
-           *
-           * @deprecated We infer the format automatically now.
-           */
-          format?: "modules";
-
-          /**
-           * The directory you wish to upload your modules from,
-           * defaults to the dist relative to the project root directory.
-           *
-           * @deprecated
-           * @breaking
-           */
-          dir?: string;
-
-          /**
-           * The path to the Worker script. This should be replaced
-           * by the top level `entry' property.
-           *
-           * @deprecated This will be replaced by the top level `entry' property.
-           */
-          main?: string;
-
-          /**
-           * An ordered list of rules that define which modules to import,
-           * and what type to import them as. You will need to specify rules
-           * to use Text, Data, and CompiledWasm modules, or when you wish to
-           * have a .js file be treated as an ESModule instead of CommonJS.
-           *
-           * @deprecated These are now inferred automatically for major file types, but you can still specify them manually.
-           * @todo this needs to be implemented!
-           * @breaking
-           */
-          rules?: {
-            type: "ESModule" | "CommonJS" | "Text" | "Data" | "CompiledWasm";
-            globs: string[];
-            fallthrough?: boolean;
-          };
-        };
-      }
-  );
+   * `main` property).
+   */ {
+    /**
+     * We only really need to specify the entry point.
+     * The format is deduced automatically in wrangler2.
+     *
+     * @deprecated Instead use top level main
+     */
+    upload?: {
+      /**
+       * The format of the Worker script.
+       *
+       * @deprecated We infer the format automatically now.
+       */
+      format?: "modules" | "service-worker";
+
+      /**
+       * The directory you wish to upload your worker from,
+       * relative to the wrangler.toml file.
+       *
+       * Defaults to the directory containing the wrangler.toml file.
+       *
+       * @deprecated
+       * @breaking In wrangler 1, this defaults to ./dist, whereas in wrangler 2 it defaults to ./
+       */
+      dir?: string;
+
+      /**
+       * The path to the Worker script, relative to `upload.dir`.
+       *
+       * @deprecated This will be replaced by a command line argument.
+       */
+      main?: string;
+
+      /**
+       * An ordered list of rules that define which modules to import,
+       * and what type to import them as. You will need to specify rules
+       * to use Text, Data, and CompiledWasm modules, or when you wish to
+       * have a .js file be treated as an ESModule instead of CommonJS.
+       *
+       * @deprecated These are now inferred automatically for major file types, but you can still specify them manually.
+       * @todo this needs to be implemented!
+       * @breaking
+       */
+      rules?: {
+        type: "ESModule" | "CommonJS" | "Text" | "Data" | "CompiledWasm";
+        globs: string[];
+        fallthrough?: boolean;
+      };
+    };
+  };
 
   /**
    * The `env` section defines overrides for the configuration for
@@ -456,7 +479,7 @@ export type Config = {
   env?: {
     [envName: string]:
       | undefined
-      | Omit<Config, "env" | "migrations" | "site" | "dev">;
+      | Omit<Config, "env" | "wasm_modules" | "migrations" | "site" | "dev">;
   };
 };
 
@@ -512,7 +535,13 @@ export function normaliseAndValidateEnvironmentsConfig(config: Config) {
     );
 
     // Fall back on "inherited fields" from the config, if not specified in the environment.
-    const inheritedFields = [
+
+    type InheritedField = keyof Omit<
+      Config,
+      "env" | "migrations" | "wasm_modules" | "site" | "dev"
+    >;
+
+    const inheritedFields: InheritedField[] = [
       "name",
       "account_id",
       "workers_dev",
@@ -523,20 +552,21 @@ export function normaliseAndValidateEnvironmentsConfig(config: Config) {
       "route",
       "jsx_factory",
       "jsx_fragment",
-      "site",
       "triggers",
       "usage_model",
     ];
+
     for (const inheritedField of inheritedFields) {
       if (config[inheritedField] !== undefined) {
         if (environment[inheritedField] === undefined) {
-          environment[inheritedField] = config[inheritedField]; // TODO: - shallow or deep copy?
+          (environment[inheritedField] as typeof environment[InheritedField]) =
+            config[inheritedField]; // TODO: - shallow or deep copy?
         }
       }
     }
 
     // Warn if there is a "required" field in the top level config that has not been specified specified in the environment.
-    // These required fields are `vars`, `durable_objects`, `kv_namespaces` and `experimental_services`.
+    // These required fields are `vars`, `durable_objects`, `kv_namespaces`, and "r2_buckets".
     // Each of them has different characteristics that need to be checked.
 
     // `vars` is just an object
@@ -612,26 +642,26 @@ export function normaliseAndValidateEnvironmentsConfig(config: Config) {
       }
     }
 
-    // `experimental_services` contains an array of namespace bindings
-    if (config.experimental_services !== undefined) {
-      if (environment.experimental_services === undefined) {
+    // `r2_buckets` contains an array of bucket bindings
+    if (config.r2_buckets !== undefined) {
+      if (environment.r2_buckets === undefined) {
         console.warn(
-          `In your configuration, "experimental_services" exists at the top level, but not on "env.${envKey}".\n` +
-            `This is not what you probably want, since "experimental_services" is not inherited by environments.\n` +
-            `Please add "experimental_services" to "env.${envKey}".`
+          `In your configuration, "r2_buckets" exists at the top level, but not on "env.${envKey}".\n` +
+            `This is not what you probably want, since "r2_buckets" is not inherited by environments.\n` +
+            `Please add "r2_buckets" to "env.${envKey}".`
         );
       } else {
-        const envBindingNames = new Set(
-          environment.experimental_services.map((service) => service.name)
+        const envBindings = new Set(
+          environment.r2_buckets.map((r2Bucket) => r2Bucket.binding)
         );
-        for (const bindingName of config.experimental_services.map(
-          (service) => service.name
+        for (const bindingName of config.r2_buckets.map(
+          (r2Bucket) => r2Bucket.binding
         )) {
-          if (!envBindingNames.has(bindingName)) {
+          if (!envBindings.has(bindingName)) {
             console.warn(
-              `In your configuration, there is a experimental_services with binding name "${bindingName}" at the top level, but not on "env.${envKey}".\n` +
-                `This is not what you probably want, since "experimental_services" is not inherited by environments.\n` +
-                `Please add a service for "${bindingName}" to "env.${envKey}.experimental_services".`
+              `In your configuration, there is a r2_buckets with binding "${bindingName}" at the top level, but not on "env.${envKey}".\n` +
+                `This is not what you probably want, since "r2_buckets" is not inherited by environments.\n` +
+                `Please add a binding for "${bindingName}" to "env.${envKey}.r2_buckets".`
             );
           }
         }