wrangler 0.0.0-e3cab74 → 0.0.0-e3ce82b

package/src/cfetch/internal.ts

@@ -1,7 +1,9 @@
-import { fetch } from "undici";
+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",
@@ -72,7 +81,11 @@ function truncate(text: string, maxLength: number): string {
 function cloneHeaders(
   headers: HeadersInit | undefined
 ): Record<string, string> {
-  return { ...headers };
+  return headers instanceof Headers
+    ? Object.fromEntries(headers.entries())
+    : Array.isArray(headers)
+    ? Object.fromEntries(headers)
+    : { ...headers };
 }
 
 async function requireLoggedIn(): Promise<void> {
@@ -82,24 +95,17 @@ async function requireLoggedIn(): Promise<void> {
   }
 }
 
-function requireApiToken(): string {
-  const apiToken = getAPIToken();
-  if (!apiToken) {
-    throw new Error("No API token found.");
-  }
-  return apiToken;
-}
-
-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}`;
 }
 
 /**
@@ -108,6 +114,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/cli.ts

@@ -1,19 +1,13 @@
+import "dotenv/config"; // Grab locally specified env params from a `.env` file.
 import process from "process";
 import { hideBin } from "yargs/helpers";
-import { reportError, initReporting } from "./reporting";
+import { FatalError } from "./errors";
 import { main } from ".";
 
-try {
-  initReporting();
-} catch (error) {}
-
-process.on("uncaughtExceptionMonitor", async (err, origin) => {
-  await reportError(err, origin);
-});
-
-main(hideBin(process.argv)).catch(() => {
+main(hideBin(process.argv)).catch((e) => {
   // 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.
   // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
-  process.exit(1);
+  const exitCode = (e instanceof FatalError && e.code) || 1;
+  process.exit(exitCode);
 });

package/src/config/README.md

@@ -25,31 +25,30 @@ This includes the `EnvironmentInheritable` and `EnvironmentNonInheritable` field
 ### Config
 
 The "non-overridable" types are defined in the [`ConfigFields`](./config.ts) type.
-Notably this also contains a property called `env` which is the container for the named environment configuration.
-
 The `Config` type is the overall configuration, which consists of the `ConfigFields` and also an `Environment`.
-In this case the `Environment`, here, corresponds to the top level environment.
+In this case the `Environment`, here, corresponds to the "currently active" environment. This is specified by the `--env` command line argument.
+If there is no argument passed then the currently active environment is the "top-level" environment.
 The fields in `Config` and `Environment` are not generally optional and so you can expect they have been filled with suitable inherited or default values.
 These types should be used when you are working with fields that should be passed to commands.
 
 ### RawConfig
 
 The `RawConfig` type is a version of `Config`, where all the fields are optional.
-The `RawConfig` type also includes `DeprecatedConfigFields` and extends and contains the `RawEnvironment` type,
-which is a version of `Environment` where all the fields are optional.
+The `RawConfig` type includes `DeprecatedConfigFields` and `EnvironmentMap`.
+It also extends the `RawEnvironment` type, which is a version of `Environment` where all the fields are optional.
 These optional fields map to the actual fields found in the `wrangler.toml`.
 These types should be used when you are working with raw configuration that is read or will be written to a `wrangler.toml`.
 
 ## Validation
 
-Validation is triggered by passing a `RawConfig` object to the `normalizeAndValidateConfig()` function.
+Validation is triggered by passing a `RawConfig` object, and the active environment name, to the `normalizeAndValidateConfig()` function.
 This function will return:
 
 - a `Config` object, where all the fields have suitable valid values
 - a `Diagnostics` object, which contains any errors or warnings from the validation process
 
 The field values may have been parsed directly from the `RawConfig`, inherited into a named environment from the top-level environment, or given a default value.
-Generally, if there are any warnings they should be presented to the user via `console.warn()` messages,
+Generally, if there are any warnings they should be presented to the user via `logger.warn()` messages,
 and if there are any errors then an `Error` should be thrown describing these errors.
 
 The `Diagnostics` object is hierarchical: each `Diagnostics` instance can contain a collection of child `Diagnostics` instance.
@@ -62,6 +61,7 @@ The [high level API](./index.ts) for configuration processing consists of the `f
 ### readConfig()
 
 The `readConfig()` function will find the nearest `wrangler.toml` file, load and parse it, then validate and normalize the values into a `Config` object.
+Note that you should pass the current active environment name in as a parameter. The resulting `Config` object will contain only the fields appropriate to that environment.
 If there are validation errors then it will throw a suitable error.
 
 ## Changing configuration

package/src/config/config.ts

@@ -3,7 +3,7 @@ import type { Environment, RawEnvironment } from "./environment";
 /**
  * This is the static type definition for the configuration object.
  *
- * It reflects the configuration that you can write in wrangler.toml,
+ * It reflects a normalized and validated version of the configuration that you can write in wrangler.toml,
  * and optionally augment with arguments passed directly to wrangler.
  *
  * For more information about the configuration object, see the
@@ -20,20 +20,16 @@ import type { Environment, RawEnvironment } from "./environment";
  * - `@breaking`: the deprecation/optionality is a breaking change from wrangler 1.
  * - `@todo`: there's more work to be done (with details attached).
  */
-export type Config = ConfigFields<Environment> & Environment;
+export type Config = ConfigFields<DevConfig> & Environment;
 
-export type RawConfig = Partial<ConfigFields<RawEnvironment>> &
+export type RawConfig = Partial<ConfigFields<RawDevConfig>> &
   RawEnvironment &
-  DeprecatedConfigFields;
+  DeprecatedConfigFields &
+  EnvironmentMap;
 
-export interface ConfigFields<Env extends RawEnvironment> {
+export interface ConfigFields<Dev extends RawDevConfig> {
   configPath: string | undefined;
 
-  /**
-   * The entrypoint/path to the JavaScript file that will be executed.
-   */
-  main: string | undefined;
-
   /**
    * A boolean to enable "legacy" style wrangler environments (from wrangler 1).
    * These have been superseded by Services, but there may be projects that won't
@@ -42,59 +38,10 @@ export interface ConfigFields<Env extends RawEnvironment> {
    */
   legacy_env: boolean;
 
-  /**
-   * The `env` section defines overrides for the configuration for different environments.
-   *
-   * All environment fields can be specified at the top level of the config indicating the default environment settings.
-   *
-   * - Some fields are inherited and overridable in each environment.
-   * - But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.
-   *
-   * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
-   *
-   * @default `{}`
-   */
-  env: {
-    [envName: string]: Env;
-  };
-
   /**
    * Options to configure the development server that your worker will use.
-   *
-   * @default `{}`
    */
-  dev: {
-    /**
-     * IP address for the local dev server to listen on,
-     *
-     * @default `127.0.0.1`
-     * @todo this needs to be implemented
-     */
-    ip?: string;
-
-    /**
-     * Port for the local dev server to listen on
-     *
-     * @default `8787`
-     */
-    port?: number;
-
-    /**
-     * Protocol that local wrangler dev server listens to requests on.
-     *
-     * @default `http`
-     * @todo this needs to be implemented
-     */
-    local_protocol?: string;
-
-    /**
-     * Protocol that wrangler dev forwards requests on
-     *
-     * @default `https`
-     * @todo this needs to be implemented
-     */
-    upstream_protocol?: string;
-  };
+  dev: Dev;
 
   /**
    * A list of migrations that should be uploaded with your Worker.
@@ -190,25 +137,58 @@ export interface ConfigFields<Env extends RawEnvironment> {
     | undefined;
 
   /**
-   * Configures a custom build step to be run by Wrangler when building your Worker.
+   * A list of data files that your worker should be bound to. This is
+   * the "legacy" way of binding to a data file. ES module workers should
+   * do proper module imports.
+   */
+  data_blobs:
+    | {
+        [key: string]: string;
+      }
+    | undefined;
+}
+
+export interface DevConfig {
+  /**
+   * IP address for the local dev server to listen on,
+   *
+   * @default `localhost`
+   */
+  ip: string;
+
+  /**
+   * Port for the local dev server to listen on
    *
-   * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
-   * for more details.
+   * @default `8787`
+   */
+  port: number | undefined;
+
+  /**
+   * Protocol that local wrangler dev server listens to requests on.
    *
-   * @default {}
+   * @default `http`
    */
-  build: {
-    /** The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used. */
-    command?: string;
-    /** The directory in which the command is executed. */
-    cwd?: string;
-    /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
-    watch_dir?: string;
-    /** Deprecated field previously used to configure the build and upload of the script. */
-    upload?: DeprecatedUpload;
-  };
+  local_protocol: "http" | "https";
+
+  /**
+   * Protocol that wrangler dev forwards requests on
+   *
+   * Setting this to `http` is not currently implemented.
+   * See https://github.com/cloudflare/wrangler2/issues/583
+   *
+   * @default `https`
+   * @todo this needs to be implemented https://github.com/cloudflare/wrangler2/issues/583
+   */
+  upstream_protocol: "https" | "http";
+
+  /**
+   * Host to forward requests to, defaults to the host of the first route of project
+   */
+  host: string | undefined;
 }
 
+export type RawDevConfig = Partial<DevConfig>;
+
 export interface DeprecatedConfigFields {
   /**
    * The project "type". A holdover from wrangler 1.x.
@@ -227,39 +207,28 @@ export interface DeprecatedConfigFields {
    * @breaking
    */
   webpack_config?: string;
-}
 
-/**
- * Deprecated upload configuration.
- */
-export interface DeprecatedUpload {
   /**
-   * The format of the Worker script.
-   *
-   * @deprecated We infer the format automatically now.
+   * Configuration only used by a standalone use of the miniflare binary.
+   * @deprecated
    */
-  format?: "modules" | "service-worker";
+  miniflare?: unknown;
+}
 
+interface EnvironmentMap {
   /**
-   * The directory you wish to upload your worker from,
-   * relative to the wrangler.toml file.
+   * The `env` section defines overrides for the configuration for different environments.
    *
-   * Defaults to the directory containing the wrangler.toml file.
+   * All environment fields can be specified at the top level of the config indicating the default environment settings.
    *
-   * @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`.
+   * - Some fields are inherited and overridable in each environment.
+   * - But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.
    *
-   * @deprecated This will be replaced by a command line argument.
-   */
-  main?: string;
-
-  /**
-   * @deprecated This is now defined at the top level `rules` field.
+   * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
+   *
+   * @default `{}`
    */
-  rules?: Environment["rules"];
+  env?: {
+    [envName: string]: RawEnvironment;
+  };
 }

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.
@@ -51,6 +69,11 @@ interface EnvironmentInheritable {
    */
   compatibility_flags: string[];
 
+  /**
+   * The entrypoint/path to the JavaScript file that will be executed.
+   */
+  main: string | undefined;
+
   /**
    * Whether we use <name>.<subdomain>.workers.dev to
    * test and deploy your worker.
@@ -59,7 +82,7 @@ interface EnvironmentInheritable {
    * @breaking
    * @inheritable
    */
-  workers_dev: boolean;
+  workers_dev: boolean | undefined;
 
   /**
    * A list of routes that your worker should be published to.
@@ -69,7 +92,7 @@ interface EnvironmentInheritable {
    *
    * @inheritable
    */
-  routes: string[] | undefined;
+  routes: Route[] | undefined;
 
   /**
    * A route that your worker should be published to. Literally
@@ -80,7 +103,12 @@ interface EnvironmentInheritable {
    *
    * @inheritable
    */
-  route: string | undefined;
+  route: Route | undefined;
+
+  /**
+   * Path to a custom tsconfig
+   */
+  tsconfig: string | undefined;
 
   /**
    * The function to use to replace jsx syntax.
@@ -121,7 +149,7 @@ interface EnvironmentInheritable {
    *
    * @inheritable
    */
-  usage_model: undefined | "bundled" | "unbound";
+  usage_model: "bundled" | "unbound" | undefined;
 
   /**
    * An ordered list of rules that define which modules to import,
@@ -133,6 +161,39 @@ interface EnvironmentInheritable {
    */
   rules: Rule[];
 
+  /**
+   * Configures a custom build step to be run by Wrangler when building your Worker.
+   *
+   * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
+   * for more details.
+   *
+   * @default {}
+   */
+  build: {
+    /** The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used. */
+    command?: string;
+    /** The directory in which the command is executed. */
+    cwd?: string;
+    /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
+    watch_dir?: string | string[];
+    /**
+     * Deprecated field previously used to configure the build and upload of the script.
+     * @deprecated
+     */
+    upload?: DeprecatedUpload;
+  };
+
+  /**
+   * Minify the script before uploading.
+   * @inheritable
+   */
+  minify: boolean | undefined;
+
+  /**
+   * Add polyfills for node builtin modules and globals
+   */
+  node_compat: boolean | undefined;
+
   /**
    * TODO: remove this as it has been deprecated.
    *
@@ -181,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;
     }[];
   };
 
@@ -224,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.
    *
@@ -277,6 +358,40 @@ interface EnvironmentDeprecated {
   }[];
 }
 
+/**
+ * Deprecated upload configuration.
+ */
+export interface DeprecatedUpload {
+  /**
+   * 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
+   */
+  dir?: string;
+
+  /**
+   * The path to the Worker script, relative to `upload.dir`.
+   *
+   * @deprecated This will be replaced by a command line argument.
+   */
+  main?: string;
+
+  /**
+   * @deprecated This is now defined at the top level `rules` field.
+   */
+  rules?: Environment["rules"];
+}
+
 /**
  * The raw environment configuration that we read from the config file.
  *