wrangler 0.0.0-e30d1013 → 0.0.0-e311bbbf

package/src/config/config.ts

@@ -1,4 +1,5 @@
 import type { Environment, RawEnvironment } from "./environment";
+import type { CamelCaseKey } from "yargs";
 
 /**
  * This is the static type definition for the configuration object.
@@ -17,7 +18,7 @@ import type { Environment, RawEnvironment } from "./environment";
  *
  * Legend for the annotations:
  *
- * - `@breaking`: the deprecation/optionality is a breaking change from wrangler 1.
+ * - `@breaking`: the deprecation/optionality is a breaking change from Wrangler v1.
  * - `@todo`: there's more work to be done (with details attached).
  */
 export type Config = ConfigFields<DevConfig> & Environment;
@@ -31,7 +32,7 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 	configPath: string | undefined;
 
 	/**
-	 * A boolean to enable "legacy" style wrangler environments (from wrangler 1).
+	 * A boolean to enable "legacy" style wrangler environments (from Wrangler v1).
 	 * These have been superseded by Services, but there may be projects that won't
 	 * (or can't) use them. If you're using a legacy environment, you can set this
 	 * to `true` to enable it.
@@ -95,7 +96,7 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 				/**
 				 * The location of your Worker script.
 				 *
-				 * @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.
+				 * @deprecated DO NOT use this (it's a holdover from Wrangler v1.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;
@@ -215,10 +216,10 @@ export interface DevConfig {
 	 * Protocol that wrangler dev forwards requests on
 	 *
 	 * Setting this to `http` is not currently implemented.
-	 * See https://github.com/cloudflare/wrangler2/issues/583
+	 * See https://github.com/cloudflare/workers-sdk/issues/583
 	 *
 	 * @default `https`
-	 * @todo this needs to be implemented https://github.com/cloudflare/wrangler2/issues/583
+	 * @todo this needs to be implemented https://github.com/cloudflare/workers-sdk/issues/583
 	 */
 	upstream_protocol: "https" | "http";
 
@@ -232,7 +233,7 @@ export type RawDevConfig = Partial<DevConfig>;
 
 export interface DeprecatedConfigFields {
 	/**
-	 * The project "type". A holdover from wrangler 1.x.
+	 * The project "type". A holdover from Wrangler v1.x.
 	 * Valid values were "webpack", "javascript", and "rust".
 	 *
 	 * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
@@ -242,7 +243,7 @@ export interface DeprecatedConfigFields {
 
 	/**
 	 * Path to the webpack config to use when building your worker.
-	 * A holdover from wrangler 1.x, used with `type: "webpack"`.
+	 * A holdover from Wrangler v1.x, used with `type: "webpack"`.
 	 *
 	 * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
 	 * @breaking
@@ -273,3 +274,9 @@ interface EnvironmentMap {
 		[envName: string]: RawEnvironment;
 	};
 }
+
+// API dev only passes in camel-cased versions of keys, so ensure
+// only camel-cased keys are used
+export type OnlyCamelCase<T = Record<string, never>> = {
+	[key in keyof T as CamelCaseKey<key>]: T[key];
+};

package/src/config/environment.ts

@@ -74,11 +74,17 @@ interface EnvironmentInheritable {
 	 */
 	main: string | undefined;
 
+	/**
+	 * The directory in which module rules should be evaluated in a `--no-bundle` worker
+	 * This defaults to dirname(main) when left undefined
+	 */
+	base_dir: string | undefined;
+
 	/**
 	 * Whether we use <name>.<subdomain>.workers.dev to
 	 * test and deploy your worker.
 	 *
-	 * @default `true` (This is a breaking change from wrangler 1)
+	 * @default `true` (This is a breaking change from Wrangler v1)
 	 * @breaking
 	 * @inheritable
 	 */
@@ -261,6 +267,17 @@ interface EnvironmentInheritable {
 	logpush: boolean | undefined;
 }
 
+export type DurableObjectBindings = {
+	/** The name of the binding used to refer to the Durable Object */
+	name: string;
+	/** The exported class name of the Durable Object */
+	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;
+}[];
+
 /**
  * The `EnvironmentNonInheritable` interface declares all the configuration fields for an environment
  * that cannot be inherited from the top-level environment, and must be defined specifically.
@@ -303,16 +320,7 @@ interface EnvironmentNonInheritable {
 	 * @nonInheritable
 	 */
 	durable_objects: {
-		bindings: {
-			/** The name of the binding used to refer to the Durable Object */
-			name: string;
-			/** The exported class name of the Durable Object */
-			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;
-		}[];
+		bindings: DurableObjectBindings;
 	};
 
 	/**
@@ -337,6 +345,24 @@ interface EnvironmentNonInheritable {
 		preview_id?: string;
 	}[];
 
+	/**
+	 * These specify bindings to send email from inside your Worker.
+	 *
+	 * NOTE: This field is not automatically inherited from the top level environment,
+	 * and so must be specified in every named environment.
+	 *
+	 * @default `[]`
+	 * @nonInheritable
+	 */
+	send_email: {
+		/** The binding name used to refer to the this binding */
+		name: string;
+		/** If this binding should be restricted to a specific verified address */
+		destination_address?: string;
+		/** If this binding should be restricted to a set of verified addresses */
+		allowed_destination_addresses?: string[];
+	}[];
+
 	/**
 	 * Specifies Queues that are bound to this Worker environment.
 	 *
@@ -372,6 +398,9 @@ interface EnvironmentNonInheritable {
 
 			/** The queue to send messages that failed to be consumed. */
 			dead_letter_queue?: string;
+
+			/** The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog. */
+			max_concurrency?: number | null;
 		}[];
 	};
 
@@ -439,13 +468,28 @@ interface EnvironmentNonInheritable {
 		  }[]
 		| 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 this dataset to write to. */
+		dataset?: string;
+	}[];
+
 	/**
 	 * "Unsafe" tables for features that aren't directly supported by wrangler.
 	 *
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
-	 * @default `{ bindings: [] }`
 	 * @nonInheritable
 	 */
 	unsafe: {
@@ -453,15 +497,28 @@ interface EnvironmentNonInheritable {
 		 * 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.
-		 *
-		 * @default []
 		 */
-		bindings: {
+		bindings?: {
 			name: string;
 			type: string;
 			[key: string]: unknown;
 		}[];
+
+		/**
+		 * Arbitrary key/value pairs that will be included in the uploaded metadata.  Values specified
+		 * here will always be applied to metadata last, so can add new or override existing fields.
+		 */
+		metadata?: {
+			[key: string]: string;
+		};
 	};
+
+	mtls_certificates: {
+		/** The binding name used to refer to the certificate in the worker */
+		binding: string;
+		/** The uuid of the uploaded mTLS certificate */
+		certificate_id: string;
+	}[];
 }
 
 /**
@@ -479,7 +536,7 @@ interface EnvironmentDeprecated {
 	/**
 	 * 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.
+	 * @deprecated DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.
 	 */
 	"kv-namespaces"?: string;
 

package/src/config/index.ts

@@ -2,12 +2,12 @@ import fs from "node:fs";
 import dotenv from "dotenv";
 import { findUpSync } from "find-up";
 import { logger } from "../logger";
-import { parseTOML, readFileSync } from "../parse";
+import { parseJSONC, parseTOML, readFileSync } from "../parse";
 import { removeD1BetaPrefix } from "../worker";
 import { normalizeAndValidateConfig } from "./validation";
 import type { CfWorkerInit } from "../worker";
-import type { Config, RawConfig } from "./config";
-import type { CamelCaseKey } from "yargs";
+import type { CommonYargsOptions } from "../yargs-types";
+import type { Config, OnlyCamelCase, RawConfig } from "./config";
 
 export type {
 	Config,
@@ -25,18 +25,21 @@ export type {
 /**
  * Get the Wrangler configuration; read it from the give `configPath` if available.
  */
-export function readConfig(
+
+export function readConfig<CommandArgs>(
 	configPath: string | undefined,
-	args: unknown
+	// Include command specific args as well as the wrangler global flags
+	args: CommandArgs & OnlyCamelCase<CommonYargsOptions>
 ): Config {
 	let rawConfig: RawConfig = {};
 	if (!configPath) {
-		configPath = findWranglerToml();
+		configPath = findWranglerToml(process.cwd(), args.experimentalJsonConfig);
 	}
-
 	// Load the configuration from disk if available
-	if (configPath) {
+	if (configPath?.endsWith("toml")) {
 		rawConfig = parseTOML(readFileSync(configPath), configPath);
+	} else if (configPath?.endsWith("json")) {
+		rawConfig = parseJSONC(readFileSync(configPath), configPath);
 	}
 
 	// Process the top-level configuration.
@@ -61,10 +64,16 @@ export function readConfig(
  * from the current working directory.
  */
 export function findWranglerToml(
-	referencePath: string = process.cwd()
+	referencePath: string = process.cwd(),
+	preferJson = false
 ): string | undefined {
-	const configPath = findUpSync("wrangler.toml", { cwd: referencePath });
-	return configPath;
+	if (preferJson) {
+		return (
+			findUpSync(`wrangler.json`, { cwd: referencePath }) ??
+			findUpSync(`wrangler.toml`, { cwd: referencePath })
+		);
+	}
+	return findUpSync(`wrangler.toml`, { cwd: referencePath });
 }
 
 /**
@@ -88,16 +97,19 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		data_blobs,
 		durable_objects,
 		kv_namespaces,
+		send_email,
 		queues,
 		d1_databases,
 		r2_buckets,
 		logfwdr,
 		services,
+		analytics_engine_datasets,
 		text_blobs,
 		unsafe,
 		vars,
 		wasm_modules,
 		dispatch_namespaces,
+		mtls_certificates,
 	} = bindings;
 
 	if (data_blobs !== undefined && Object.keys(data_blobs).length > 0) {
@@ -144,6 +156,23 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
+	if (send_email !== undefined && send_email.length > 0) {
+		output.push({
+			type: "Send Email",
+			entries: send_email.map(
+				({ name, destination_address, allowed_destination_addresses }) => {
+					return {
+						key: name,
+						value:
+							destination_address ||
+							allowed_destination_addresses?.join(", ") ||
+							"unrestricted",
+					};
+				}
+			),
+		});
+	}
+
 	if (queues !== undefined && queues.length > 0) {
 		output.push({
 			type: "Queues",
@@ -159,14 +188,22 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 	if (d1_databases !== undefined && d1_databases.length > 0) {
 		output.push({
 			type: "D1 Databases",
-			entries: d1_databases.map(({ binding, database_name, database_id }) => {
-				return {
-					key: removeD1BetaPrefix(binding),
-					value: database_name
-						? `${database_name} (${database_id})`
-						: database_id,
-				};
-			}),
+			entries: d1_databases.map(
+				({ binding, database_name, database_id, preview_database_id }) => {
+					let databaseValue = `${database_id}`;
+					if (database_name) {
+						databaseValue = `${database_name} (${database_id})`;
+					}
+					//database_id is local when running `wrangler dev --local`
+					if (preview_database_id && database_id !== "local") {
+						databaseValue += `, Preview: (${preview_database_id})`;
+					}
+					return {
+						key: removeD1BetaPrefix(binding),
+						value: databaseValue,
+					};
+				}
+			),
 		});
 	}
 
@@ -211,6 +248,21 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
+	if (
+		analytics_engine_datasets !== undefined &&
+		analytics_engine_datasets.length > 0
+	) {
+		output.push({
+			type: "Analytics Engine Datasets",
+			entries: analytics_engine_datasets.map(({ binding, dataset }) => {
+				return {
+					key: binding,
+					value: dataset ?? binding,
+				};
+			}),
+		});
+	}
+
 	if (text_blobs !== undefined && Object.keys(text_blobs).length > 0) {
 		output.push({
 			type: "Text Blobs",
@@ -221,10 +273,10 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
-	if (unsafe !== undefined && unsafe.length > 0) {
+	if (unsafe?.bindings !== undefined && unsafe.bindings.length > 0) {
 		output.push({
 			type: "Unsafe",
-			entries: unsafe.map(({ name, type }) => ({
+			entries: unsafe.bindings.map(({ name, type }) => ({
 				key: type,
 				value: name,
 			})),
@@ -273,6 +325,28 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
+	if (mtls_certificates !== undefined && mtls_certificates.length > 0) {
+		output.push({
+			type: "mTLS Certificates",
+			entries: mtls_certificates.map(({ binding, certificate_id }) => {
+				return {
+					key: binding,
+					value: certificate_id,
+				};
+			}),
+		});
+	}
+
+	if (unsafe?.metadata !== undefined) {
+		output.push({
+			type: "Unsafe Metadata",
+			entries: Object.entries(unsafe.metadata).map(([key, value]) => ({
+				key,
+				value: `${value}`,
+			})),
+		});
+	}
+
 	if (output.length === 0) {
 		return;
 	}
@@ -292,18 +366,13 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 	logger.log(message);
 }
 
-type CamelCase<T> = {
-	[key in keyof T as key | CamelCaseKey<key>]: T[key];
-};
-
-export function withConfig<T extends { config?: string }>(
+export function withConfig<T>(
 	handler: (
-		t: Omit<CamelCase<T>, "config"> & { config: Config }
+		t: OnlyCamelCase<T & CommonYargsOptions> & { config: Config }
 	) => Promise<void>
 ) {
-	return (t: CamelCase<T>) => {
-		const { config: configPath, ...rest } = t;
-		return handler({ ...rest, config: readConfig(configPath, rest) });
+	return (t: OnlyCamelCase<T & CommonYargsOptions>) => {
+		return handler({ ...t, config: readConfig(t.config, t) });
 	};
 }
 

package/src/config/validation-helpers.ts

@@ -550,7 +550,7 @@ export const getBindingNames = (value: unknown): string[] => {
 	} else if (isNamespaceList(value)) {
 		return value.map(({ binding }) => binding);
 	} else if (isRecord(value)) {
-		return Object.keys(value);
+		return Object.keys(value).filter((k) => value[k] !== undefined);
 	} else {
 		return [];
 	}