wrangler 0.0.0-e043479 → 0.0.0-e09abbc

package/src/cfetch/internal.ts

@@ -1,7 +1,10 @@
-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 { ApiCredentials } from "../user";
 import type { URLSearchParams } from "node:url";
 import type { RequestInit, HeadersInit } from "undici";
 
@@ -9,9 +12,9 @@ import type { RequestInit, HeadersInit } from "undici";
  * Get the URL to use to access the Cloudflare API.
  */
 export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
-  variableName: "CLOUDFLARE_API_BASE_URL",
-  deprecatedName: "CF_API_BASE_URL",
-  defaultValue: "https://api.cloudflare.com/client/v4",
+	variableName: "CLOUDFLARE_API_BASE_URL",
+	deprecatedName: "CF_API_BASE_URL",
+	defaultValue: "https://api.cloudflare.com/client/v4",
 });
 
 /**
@@ -24,82 +27,91 @@ export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
  * This function should not be used directly, instead use the functions in `cfetch/index.ts`.
  */
 export async function fetchInternal<ResponseType>(
-  resource: string,
-  init: RequestInit = {},
-  queryParams?: URLSearchParams
+	resource: string,
+	init: RequestInit = {},
+	queryParams?: URLSearchParams,
+	abortSignal?: AbortSignal
 ): Promise<ResponseType> {
-  await requireLoggedIn();
-  const apiToken = requireApiToken();
-  const headers = cloneHeaders(init.headers);
-  addAuthorizationHeader(headers, apiToken);
+	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);
+	addAuthorizationHeaderIfUnspecified(headers, apiToken);
+	addUserAgent(headers);
 
-  const queryString = queryParams ? `?${queryParams.toString()}` : "";
-  const method = init.method ?? "GET";
-  const response = await fetch(
-    `${getCloudflareAPIBaseURL()}${resource}${queryString}`,
-    {
-      method,
-      ...init,
-      headers,
-    }
-  );
-  const jsonText = await response.text();
-  try {
-    return parseJSON(jsonText) as ResponseType;
-  } catch (err) {
-    throw new ParseError({
-      text: "Received a malformed response from the API",
-      notes: [
-        {
-          text: truncate(jsonText, 100),
-        },
-        {
-          text: `${method} ${resource} -> ${response.status} ${response.statusText}`,
-        },
-      ],
-    });
-  }
+	const queryString = queryParams ? `?${queryParams.toString()}` : "";
+	const method = init.method ?? "GET";
+	const response = await fetch(
+		`${getCloudflareAPIBaseURL()}${resource}${queryString}`,
+		{
+			method,
+			...init,
+			headers,
+			signal: abortSignal,
+		}
+	);
+	const jsonText = await response.text();
+	try {
+		return parseJSON<ResponseType>(jsonText);
+	} catch (err) {
+		throw new ParseError({
+			text: "Received a malformed response from the API",
+			notes: [
+				{
+					text: truncate(jsonText, 100),
+				},
+				{
+					text: `${method} ${resource} -> ${response.status} ${response.statusText}`,
+				},
+			],
+		});
+	}
 }
 
 function truncate(text: string, maxLength: number): string {
-  const { length } = text;
-  if (length <= maxLength) {
-    return text;
-  }
-  return `${text.substring(0, maxLength)}... (length = ${length})`;
+	const { length } = text;
+	if (length <= maxLength) {
+		return text;
+	}
+	return `${text.substring(0, maxLength)}... (length = ${length})`;
 }
 
 function cloneHeaders(
-  headers: HeadersInit | undefined
+	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> {
-  const loggedIn = await loginOrRefreshIfRequired();
-  if (!loggedIn) {
-    throw new Error("Not logged in.");
-  }
+	const loggedIn = await loginOrRefreshIfRequired();
+	if (!loggedIn) {
+		throw new Error("Not logged in.");
+	}
 }
 
-function requireApiToken(): string {
-  const apiToken = getAPIToken();
-  if (!apiToken) {
-    throw new Error("No API token found.");
-  }
-  return apiToken;
+function addAuthorizationHeaderIfUnspecified(
+	headers: Record<string, string>,
+	auth: ApiCredentials
+): void {
+	if (!("Authorization" in headers)) {
+		if ("apiToken" in auth) {
+			headers["Authorization"] = `Bearer ${auth.apiToken}`;
+		} else {
+			headers["X-Auth-Key"] = auth.authKey;
+			headers["X-Auth-Email"] = auth.authEmail;
+		}
+	}
 }
 
-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}`;
+function addUserAgent(headers: Record<string, string>): void {
+	headers["User-Agent"] = `wrangler/${wranglerVersion}`;
 }
 
 /**
@@ -108,26 +120,30 @@ 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> {
-  await requireLoggedIn();
-  const apiToken = requireApiToken();
-  const headers = { Authorization: `Bearer ${apiToken}` };
-  const resource = `${getCloudflareAPIBaseURL()}/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});`
-    );
-  }
+	accountId: string,
+	namespaceId: string,
+	key: string
+): Promise<ArrayBuffer> {
+	await requireLoggedIn();
+	const auth = requireApiToken();
+	const headers: Record<string, string> = {};
+	addAuthorizationHeaderIfUnspecified(headers, auth);
+	const resource = `${getCloudflareAPIBaseURL()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
+	const response = await fetch(resource, {
+		method: "GET",
+		headers,
+	});
+	if (response.ok) {
+		return await response.arrayBuffer();
+	} else {
+		throw new Error(
+			`Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
+		);
+	}
 }

package/src/cli.ts

@@ -1,19 +1,27 @@
+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 { unstable_dev } from "./api";
+import { FatalError } from "./errors";
 import { main } from ".";
 
-try {
-  initReporting();
-} catch (error) {}
+/**
+ * The main entrypoint for the CLI.
+ * main only gets called when the script is run directly, not when it's imported as a module.
+ */
+if (typeof jest === "undefined" && require.main) {
+	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.
+		const exitCode = (e instanceof FatalError && e.code) || 1;
+		process.exit(exitCode);
+	});
+}
 
-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.
-  // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
-  process.exit(1);
-});
+/**
+ * This is how we're exporting the API.
+ * It makes it possible to import wrangler from 'wrangler',
+ * and call wrangler.unstable_dev().
+ */
+export default { unstable_dev };

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