wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

package/src/cfetch/index.ts

@@ -1,12 +1,11 @@
 import { URLSearchParams } from "node:url";
+import { logger } from "../logger";
 import { ParseError } from "../parse";
-import { fetchInternal } from "./internal";
+import { fetchInternal, performApiFetch } from "./internal";
 import type { RequestInit } from "undici";
 
 // Check out https://api.cloudflare.com/ for API docs.
 
-export { getCloudflareAPIBaseURL as getCloudflareApiBaseUrl } from "./internal";
-
 export interface FetchError {
 	code: number;
 	message: string;
@@ -119,3 +118,41 @@ function renderError(err: FetchError, level = 0): string {
 		chainedMessages
 	);
 }
+
+/**
+ * Fetch the raw script content of a Worker
+ * Note, this will concatenate the files of multi-module workers
+ */
+export async function fetchScriptContent(
+	resource: string,
+	init: RequestInit = {},
+	queryParams?: URLSearchParams,
+	abortSignal?: AbortSignal
+): Promise<string> {
+	const response = await performApiFetch(
+		resource,
+		init,
+		queryParams,
+		abortSignal
+	);
+
+	logger.debug(
+		"-- START CF API RESPONSE:",
+		response.statusText,
+		response.status
+	);
+
+	logger.debug("HEADERS:", { ...response.headers });
+	// logger.debug("RESPONSE:", text);
+	logger.debug("-- END CF API RESPONSE");
+	const contentType = response.headers.get("content-type");
+
+	const usesModules = contentType?.startsWith("multipart");
+	if (usesModules && contentType) {
+		const form = await response.formData();
+		const entries = Array.from(form.entries());
+		return entries.map((e) => e[1]).join("\n");
+	} else {
+		return await response.text();
+	}
+}

package/src/cfetch/internal.ts

@@ -1,21 +1,55 @@
 import assert from "node:assert";
-import { fetch, Headers } from "undici";
+import { fetch, File, Headers } from "undici";
 import { version as wranglerVersion } from "../../package.json";
-import { getEnvironmentVariableFactory } from "../environment-variables";
+import { getCloudflareApiBaseUrl } from "../environment-variables/misc-variables";
+import { logger } from "../logger";
 import { ParseError, parseJSON } from "../parse";
 import { loginOrRefreshIfRequired, requireApiToken } from "../user";
 import type { ApiCredentials } from "../user";
 import type { URLSearchParams } from "node:url";
-import type { RequestInit, HeadersInit } from "undici";
+import type { RequestInit, HeadersInit, Response } 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",
-});
+/*
+ * performApiFetch does everything required to make a CF API request,
+ * but doesn't parse the response as JSON. For normal V4 API responses,
+ * use `fetchInternal`
+ * */
+export async function performApiFetch(
+	resource: string,
+	init: RequestInit = {},
+	queryParams?: URLSearchParams,
+	abortSignal?: AbortSignal
+) {
+	const method = init.method ?? "GET";
+	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()}` : "";
+	logger.debug(
+		`-- START CF API REQUEST: ${method} ${getCloudflareApiBaseUrl()}${resource}${queryString}`
+	);
+	const logHeaders = cloneHeaders(headers);
+	delete logHeaders["Authorization"];
+	logger.debug("HEADERS:", JSON.stringify(logHeaders, null, 2));
+	logger.debug(
+		"INIT:",
+		JSON.stringify({ ...init, headers: logHeaders }, null, 2)
+	);
+	logger.debug("-- END CF API REQUEST");
+	return await fetch(`${getCloudflareApiBaseUrl()}${resource}${queryString}`, {
+		method,
+		...init,
+		headers,
+		signal: abortSignal,
+	});
+}
 
 /**
  * Make a fetch request to the Cloudflare API.
@@ -32,28 +66,25 @@ export async function fetchInternal<ResponseType>(
 	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);
-	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,
-			signal: abortSignal,
-		}
+	const response = await performApiFetch(
+		resource,
+		init,
+		queryParams,
+		abortSignal
 	);
 	const jsonText = await response.text();
+	logger.debug(
+		"-- START CF API RESPONSE:",
+		response.statusText,
+		response.status
+	);
+	const logHeaders = cloneHeaders(response.headers);
+	delete logHeaders["Authorization"];
+	logger.debug("HEADERS:", JSON.stringify(logHeaders, null, 2));
+	logger.debug("RESPONSE:", jsonText);
+	logger.debug("-- END CF API RESPONSE");
+
 	try {
 		return parseJSON<ResponseType>(jsonText);
 	} catch (err) {
@@ -124,7 +155,6 @@ function addUserAgent(headers: Record<string, string>): void {
  * Note: any calls to fetchKVGetValue must call encodeURIComponent on key
  * before passing it
  */
-
 export async function fetchKVGetValue(
 	accountId: string,
 	namespaceId: string,
@@ -134,7 +164,7 @@ export async function fetchKVGetValue(
 	const auth = requireApiToken();
 	const headers: Record<string, string> = {};
 	addAuthorizationHeaderIfUnspecified(headers, auth);
-	const resource = `${getCloudflareAPIBaseURL()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
+	const resource = `${getCloudflareApiBaseUrl()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
 	const response = await fetch(resource, {
 		method: "GET",
 		headers,
@@ -147,3 +177,85 @@ export async function fetchKVGetValue(
 		);
 	}
 }
+
+/**
+ * The implementation for fetching a R2 object from Cloudflare API.
+ * We have a special implementation to handle the non-standard API response
+ * that doesn't return JSON, likely due to the streaming nature.
+ *
+ * note: The implementation should be called from light wrappers for
+ * different methods (GET, PUT)
+ */
+type ResponseWithBody = Response & { body: NonNullable<Response["body"]> };
+export async function fetchR2Objects(
+	resource: string,
+	bodyInit: RequestInit = {}
+): Promise<ResponseWithBody> {
+	await requireLoggedIn();
+	const auth = requireApiToken();
+	const headers = cloneHeaders(bodyInit.headers);
+	addAuthorizationHeaderIfUnspecified(headers, auth);
+	addUserAgent(headers);
+
+	const response = await fetch(`${getCloudflareApiBaseUrl()}${resource}`, {
+		...bodyInit,
+		headers,
+	});
+
+	if (response.ok && response.body) {
+		return response as ResponseWithBody;
+	} else {
+		throw new Error(
+			`Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
+		);
+	}
+}
+
+/**
+ * This is a wrapper STOPGAP for getting the script which returns a raw text response.
+ */
+export async function fetchDashboardScript(
+	resource: string,
+	bodyInit: RequestInit = {}
+): Promise<string> {
+	await requireLoggedIn();
+	const auth = requireApiToken();
+	const headers = cloneHeaders(bodyInit.headers);
+	addAuthorizationHeaderIfUnspecified(headers, auth);
+	addUserAgent(headers);
+
+	const response = await fetch(`${getCloudflareApiBaseUrl()}${resource}`, {
+		...bodyInit,
+		headers,
+	});
+
+	if (!response.ok || !response.body) {
+		throw new Error(
+			`Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
+		);
+	}
+
+	const usesModules = response.headers
+		.get("content-type")
+		?.startsWith("multipart");
+
+	if (usesModules) {
+		// Response from edge contains generic "name = worker.js" for dashboard created scripts
+		const form = await response.formData();
+		const entries = Array.from(form.entries());
+		if (entries.length > 1)
+			throw new RangeError("Expected only one entry in multipart response");
+		const [_, file] = entries[0];
+
+		if (file instanceof File) {
+			return await file.text();
+		}
+
+		return file ?? "";
+
+		// Follow up on issue in Undici about multipart/form-data support & replace the workaround: https://github.com/nodejs/undici/issues/974
+		// This should be using a builtin formData() parser pattern.
+	} else {
+		return response.text();
+	}
+}

package/src/cli.ts

@@ -1,15 +1,15 @@
-import "dotenv/config"; // Grab locally specified env params from a `.env` file.
 import process from "process";
 import { hideBin } from "yargs/helpers";
 import { unstable_dev } from "./api";
 import { FatalError } from "./errors";
 import { main } from ".";
 
+import type { UnstableDevWorker, UnstableDevOptions } from "./api";
 /**
  * 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) {
+if (typeof jest === "undefined" && require.main === module) {
 	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.
@@ -24,4 +24,5 @@ if (typeof jest === "undefined" && require.main) {
  * It makes it possible to import wrangler from 'wrangler',
  * and call wrangler.unstable_dev().
  */
-export default { unstable_dev };
+export { unstable_dev };
+export type { UnstableDevWorker, UnstableDevOptions };

package/src/config/config.ts

@@ -127,8 +127,13 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 	 * This can either be a string, or an object with additional config fields.
 	 */
 	assets:
-		| string
-		| { bucket: string; include: string[]; exclude: string[] }
+		| {
+				bucket: string;
+				include: string[];
+				exclude: string[];
+				browser_TTL: number | undefined;
+				serve_single_page_app: boolean;
+		  }
 		| undefined;
 
 	/**
@@ -163,13 +168,25 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 				[key: string]: string;
 		  }
 		| undefined;
+
+	/**
+	 * By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.
+	 *
+	 * If you change your vars in the dashboard, wrangler *will* override/delete them on its next publish.
+	 *
+	 * If you want to keep your dashboard vars when wrangler deploys, set this field to true.
+	 *
+	 * @default false
+	 * @nonInheritable
+	 */
+	keep_vars?: boolean;
 }
 
 export interface DevConfig {
 	/**
 	 * IP address for the local dev server to listen on,
 	 *
-	 * @default `localhost`
+	 * @default `0.0.0.0`
 	 */
 	ip: string;
 
@@ -180,6 +197,13 @@ export interface DevConfig {
 	 */
 	port: number | undefined;
 
+	/**
+	 * Port for the local dev server's inspector to listen on
+	 *
+	 * @default `9229`
+	 */
+	inspector_port: number | undefined;
+
 	/**
 	 * Protocol that local wrangler dev server listens to requests on.
 	 *

package/src/config/environment.ts

@@ -210,13 +210,18 @@ interface EnvironmentInheritable {
 	 * @default `[]`
 	 * @nonInheritable
 	 */
-	worker_namespaces: {
+	dispatch_namespaces: {
 		/** The binding name used to refer to the bound service. */
 		binding: string;
 		/** The namespace to bind to. */
 		namespace: string;
 	}[];
 
+	/**
+	 *	Designates this worker as an internal-only "first-party" worker.
+	 */
+	first_party_worker: boolean | undefined;
+
 	/**
 	 * TODO: remove this as it has been deprecated.
 	 *
@@ -224,6 +229,36 @@ interface EnvironmentInheritable {
 	 * So we need to include it in this type so it is available.
 	 */
 	zone_id?: string;
+
+	/**
+	 * Specify a compiled capnp schema to use
+	 * Then add a binding per field in the top level message that you will send to logfwdr
+	 *
+	 * @default `{schema:undefined,bindings:[]}`
+	 * @inheritable
+	 */
+	logfwdr: {
+		/** capnp schema filename */
+		schema: string | undefined;
+		bindings: {
+			/** The binding name used to refer to logfwdr */
+			name: string;
+			/** The destination for this logged message */
+			destination: string;
+		}[];
+	};
+
+	/**
+	 * Send Trace Events from this worker to Workers Logpush.
+	 *
+	 * This will not configure a corresponding Logpush job automatically.
+	 *
+	 * For more information about Workers Logpush, see:
+	 * https://blog.cloudflare.com/logpush-for-workers/
+	 *
+	 * @inheritable
+	 */
+	logpush: boolean | undefined;
 }
 
 /**
@@ -302,6 +337,44 @@ interface EnvironmentNonInheritable {
 		preview_id?: string;
 	}[];
 
+	/**
+	 * Specifies Queues 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
+	 */
+	queues: {
+		/** Producer bindings */
+		producers?: {
+			/** The binding name used to refer to the Queue in the worker. */
+			binding: string;
+
+			/** The name of this Queue. */
+			queue: string;
+		}[];
+
+		/** Consumer configuration */
+		consumers?: {
+			/** The name of the queue from which this script should consume. */
+			queue: string;
+
+			/** The maximum number of messages per batch */
+			max_batch_size?: number;
+
+			/** The maximum number of seconds to wait to fill a batch with messages. */
+			max_batch_timeout?: number;
+
+			/** The maximum number of retries for each message. */
+			max_retries?: number;
+
+			/** The queue to send messages that failed to be consumed. */
+			dead_letter_queue?: string;
+		}[];
+	};
+
 	/**
 	 * Specifies R2 buckets that are bound to this Worker environment.
 	 *
@@ -320,6 +393,32 @@ interface EnvironmentNonInheritable {
 		preview_bucket_name?: string;
 	}[];
 
+	/**
+	 * Specifies D1 databases 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
+	 */
+	d1_databases: {
+		/** The binding name used to refer to the D1 database in the worker. */
+		binding: string;
+		/** The name of this D1 database. */
+		database_name: string;
+		/** The UUID of this D1 database (not required). */
+		database_id: string;
+		/** The UUID of this D1 database for Wrangler Dev (if specified). */
+		preview_database_id?: string;
+		/** The name of the migrations table for this D1 database (defaults to 'd1_migrations'). */
+		migrations_table?: string;
+		/** The path to the directory of migrations for this D1 database (defaults to './migrations'). */
+		migrations_dir?: string;
+		/** Internal use only. */
+		database_internal_env?: string;
+	}[];
+
 	/**
 	 * Specifies service bindings (worker-to-worker) that are bound to this Worker environment.
 	 *
@@ -329,13 +428,31 @@ interface EnvironmentNonInheritable {
 	 * @default `[]`
 	 * @nonInheritable
 	 */
-	services: {
-		/** The binding name used to refer to the bound service. */
+	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;
+		  }[]
+		| undefined;
+
+	/**
+	 * Specifies analytics engine datasets 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
+	 */
+	analytics_engine_datasets: {
+		/** The binding name used to refer to the dataset in the worker. */
 		binding: string;
-		/** The name of the service. */
-		service: string;
-		/** The environment of the service (e.g. production, staging, etc). */
-		environment?: string;
+		/** The name of this dataset to write to. */
+		dataset?: string;
 	}[];
 
 	/**
@@ -375,6 +492,13 @@ interface EnvironmentDeprecated {
 	 */
 	zone_id?: string;
 
+	/**
+	 * Legacy way of defining KVNamespaces that is no longer supported.
+	 *
+	 * @deprecated DO NOT USE. This was a legacy bug from wrangler 1, that we do not want to support.
+	 */
+	"kv-namespaces"?: string;
+
 	/**
 	 * A list of services that your worker should be bound to.
 	 *