WC-6046 simplify preview onboarding

.changeset/calm-previews-onboard.md

@@ -0,0 +1,7 @@
+---
+"wrangler": minor
+---
+
+Improve beta Preview configuration onboarding
+
+Wrangler now builds suggested Preview configuration from shared binding metadata, retains safe settings, and recursively redacts production string values that need Preview-specific replacements.

packages/deploy-helpers/src/deploy/helpers/create-worker-upload-form.ts

@@ -338,7 +338,7 @@ export function createWorkerUploadForm(
 				metadataBindings.push({
 					name: binding,
 					type: "d1",
-					id: database_id,
+					database_id,
 					internalEnv: database_internal_env,
 					raw,
 				});

packages/deploy-helpers/src/deploy/helpers/provision-bindings.ts

@@ -653,10 +653,17 @@ class D1Handler extends ProvisionResourceHandler<
 
 			// ...and the user HAS specified a name in their config, so we need to check if the database_name they provided
 			// matches the database_name of the existing binding (which isn't present in settings, so we'll need to make an API call to check).
+			let databaseId: string;
+			if ("database_id" in maybeInherited) {
+				databaseId = maybeInherited.database_id;
+			} else {
+				// oxlint-disable-next-line typescript/no-deprecated -- intentional support of deprecated binding style
+				databaseId = maybeInherited.id;
+			}
 			const dbFromId = await getDatabaseInfoFromIdOrName(
 				this.complianceConfig,
 				this.accountId,
-				maybeInherited.id
+				databaseId
 			);
 			if (this.binding.database_name === dbFromId.name) {
 				return true;

packages/deploy-helpers/src/preview/api.ts

@@ -6,62 +6,17 @@ import type {
 	CfPlacement,
 	CfUserLimits,
 	Config,
-	Json,
 	Observability,
+	WorkerMetadataBinding,
 } from "@cloudflare/workers-utils";
 
-export interface Binding {
-	type: string;
-	text?: string;
-	json?: Json;
-	namespace_id?: string;
-	workflow_name?: string;
-	destination_address?: string;
-	allowed_destination_addresses?: string[];
-	allowed_sender_addresses?: string[];
-	queue_name?: string;
-	delivery_delay?: number;
-	database_id?: string;
-	database_name?: string;
-	bucket_name?: string;
-	jurisdiction?: string;
-	index_name?: string;
-	instance_name?: string;
-	id?: string;
-	service?: string;
-	environment?: string;
-	// Props supplied to a Worker service binding.
-	props?: Record<string, unknown>;
-	cross_account_grant?: string;
-	dataset?: string;
-	namespace?: string;
-	outbound?: {
-		worker: {
-			service: string;
-			environment?: string;
-		};
-		params?: Array<{ name: string }>;
-	};
-	certificate_id?: string;
-	pipeline?: string;
-	stream?: string;
-	store_id?: string;
-	secret_name?: string;
-	simple?: {
-		limit: number;
-		period: 10 | 60;
-	};
-	service_id?: string;
-	tunnel_id?: string;
-	network_id?: string;
-	destination?: string;
-	staging?: boolean;
-	enable_timer?: boolean;
-	app_id?: string;
-	entrypoint?: string;
-	class_name?: string;
-	script_name?: string;
-}
+type PreviewBinding<Metadata extends WorkerMetadataBinding> =
+	Metadata extends WorkerMetadataBinding
+		? { type: Metadata["type"] } & Partial<Omit<Metadata, "type" | "name">>
+		: never;
+
+/** A canonical Preview binding, before its record key becomes `name`. */
+export type Binding = PreviewBinding<WorkerMetadataBinding>;
 
 export type EnvBindings = Record<string, Binding>;
 

packages/deploy-helpers/src/preview/shared.ts

@@ -377,7 +377,13 @@ export function getBindingValue(binding: Binding): string {
 		case "kv_namespace":
 			return String(binding.namespace_id ?? "");
 		case "d1":
-			return binding.database_name ?? String(binding.database_id ?? "");
+			return (
+				binding.database_name ??
+				String(
+					// oxlint-disable-next-line typescript/no-deprecated -- intentional support of deprecated binding style
+					"database_id" in binding ? binding.database_id : (binding.id ?? "")
+				)
+			);
 		case "r2_bucket":
 			return String(binding.bucket_name ?? "");
 		case "service":

packages/deploy-helpers/src/startup-profile.ts

@@ -413,7 +413,11 @@ async function convertWorkerBundleBindings(
 				kvNamespaces[binding.name] = { id: binding.namespace_id };
 				break;
 			case "d1":
-				d1Databases[binding.name] = { id: binding.id };
+				d1Databases[binding.name] = {
+					id:
+						// oxlint-disable-next-line typescript/no-deprecated -- intentional support of deprecated binding style
+						"database_id" in binding ? binding.database_id : binding.id,
+				};
 				break;
 			case "r2_bucket":
 				r2Buckets[binding.name] = { id: binding.bucket_name };

packages/workers-utils/src/map-worker-metadata-bindings.ts

@@ -63,11 +63,14 @@ export function mapWorkerMetadataBindings(
 						break;
 					case "d1":
 						{
+							const databaseId =
+								// oxlint-disable-next-line typescript/no-deprecated -- intentional support of deprecated binding style
+								"database_id" in binding ? binding.database_id : binding.id;
 							configObj.d1_databases = [
 								...(configObj.d1_databases ?? []),
 								{
 									binding: binding.name,
-									database_id: binding.id,
+									database_id: databaseId,
 								},
 							];
 						}
@@ -83,6 +86,9 @@ export function mapWorkerMetadataBindings(
 						{
 							configObj.ai = {
 								binding: binding.name,
+								...(binding.staging !== undefined && {
+									staging: binding.staging,
+								}),
 							};
 						}
 						break;

packages/workers-utils/src/types.ts

@@ -128,6 +128,18 @@ export type WorkerMetadataBinding =
 	| {
 			type: "d1";
 			name: string;
+			database_id: string;
+			database_name?: string;
+			/** @deprecated The API may return this for legacy D1 bindings. Use `database_id` instead. */
+			id?: string;
+			internalEnv?: string;
+			raw?: boolean;
+	  }
+	| {
+			type: "d1";
+			name: string;
+			database_name?: string;
+			/** @deprecated The API may return this for legacy D1 bindings. Use `database_id` instead. */
 			id: string;
 			internalEnv?: string;
 			raw?: boolean;
@@ -146,6 +158,7 @@ export type WorkerMetadataBinding =
 			service: string;
 			environment?: string;
 			entrypoint?: string;
+			props?: Record<string, unknown>;
 			cross_account_grant?: string;
 	  }
 	| { type: "analytics_engine"; name: string; dataset?: string }

packages/workers-utils/tests/map-worker-metadata-bindings.test.ts

@@ -117,14 +117,17 @@ describe("mapWorkerMetadataBindings", () => {
 	});
 
 	describe("d1_databases", () => {
-		it("maps d1 binding", ({ expect }) => {
-			const bindings: WorkerMetadataBinding[] = [
+		it("maps canonical and legacy d1 bindings", ({ expect }) => {
+			const bindings = [
+				{ type: "d1", name: "MY_DB", database_id: "db-456" },
 				{ type: "d1", name: "MY_DB", id: "db-456" },
-			];
-			const result = mapWorkerMetadataBindings(bindings);
-			expect(result.d1_databases).toEqual([
-				{ binding: "MY_DB", database_id: "db-456" },
-			]);
+			] satisfies WorkerMetadataBinding[];
+			for (const binding of bindings) {
+				const result = mapWorkerMetadataBindings([binding]);
+				expect(result.d1_databases).toEqual([
+					{ binding: "MY_DB", database_id: "db-456" },
+				]);
+			}
 		});
 	});
 
@@ -159,8 +162,15 @@ describe("mapWorkerMetadataBindings", () => {
 		});
 
 		it("maps ai binding", ({ expect }) => {
-			const bindings: WorkerMetadataBinding[] = [{ type: "ai", name: "AI" }];
+			const bindings: WorkerMetadataBinding[] = [
+				{ type: "ai", name: "AI", staging: true },
+			];
 			const result = mapWorkerMetadataBindings(bindings);
+			expect(result.ai).toEqual({ binding: "AI", staging: true });
+		});
+
+		it("omits absent ai staging", ({ expect }) => {
+			const result = mapWorkerMetadataBindings([{ type: "ai", name: "AI" }]);
 			expect(result.ai).toEqual({ binding: "AI" });
 		});
 

packages/wrangler/src/__tests__/create-worker-upload-form/bindings.test.ts

@@ -145,7 +145,7 @@ describe("createWorkerUploadForm — bindings", () => {
 			expect(getBindings(form)).toContainEqual({
 				name: "MY_DB",
 				type: "d1",
-				id: "db-123",
+				database_id: "db-123",
 			});
 		});
 

packages/wrangler/src/__tests__/pages/functions-build.test.ts

@@ -806,7 +806,7 @@ export default {
 			"------formdata-undici-0.test
 			Content-Disposition: form-data; name="metadata"
 
-			{"main_module":"functionsWorker-0.test.js","bindings":[{"name":"TEST_JSON_PREVIEW","type":"plain_text","text":"{\\njson: \\"value\\"\\n}"},{"name":"TEST_PLAINTEXT_PREVIEW","type":"plain_text","text":"PLAINTEXT"},{"name":"KV_PREVIEW","type":"kv_namespace","namespace_id":"kv-id"},{"name":"KV_PREVIEW2","type":"kv_namespace","namespace_id":"kv-id"},{"name":"DO_PREVIEW","type":"durable_object_namespace","class_name":"some-class-do-id","script_name":"some-script-do-id","environment":"some-environment-do-id"},{"name":"DO_PREVIEW2","type":"durable_object_namespace","class_name":"some-class-do-id","script_name":"some-script-do-id","environment":"some-environment-do-id"},{"name":"DO_PREVIEW3","type":"durable_object_namespace","class_name":"do-class","script_name":"do-s","environment":"do-e"},{"type":"queue","name":"QUEUE_PREVIEW","queue_name":"q-id"},{"type":"queue","name":"QUEUE_PREVIEW2","queue_name":"q-id"},{"name":"R2_PREVIEW","type":"r2_bucket","bucket_name":"r2-name"},{"name":"R2_PREVIEW2","type":"r2_bucket","bucket_name":"r2-name"},{"name":"D1_PREVIEW","type":"d1","id":"d1-id"},{"name":"D1_PREVIEW2","type":"d1","id":"d1-id"},{"name":"SERVICE_PREVIEW","type":"service","service":"service","environment":"production"},{"name":"SERVICE_PREVIEW2","type":"service","service":"service","environment":"production"},{"name":"AE_PREVIEW","type":"analytics_engine","dataset":"data"},{"name":"AE_PREVIEW2","type":"analytics_engine","dataset":"data"},{"name":"AI_PREVIEW","type":"ai"}],"compatibility_date":"2023-02-14","compatibility_flags":[],"placement":{"mode":"smart"},"limits":{"cpu_ms":50}}
+			{"main_module":"functionsWorker-0.test.js","bindings":[{"name":"TEST_JSON_PREVIEW","type":"plain_text","text":"{\\njson: \\"value\\"\\n}"},{"name":"TEST_PLAINTEXT_PREVIEW","type":"plain_text","text":"PLAINTEXT"},{"name":"KV_PREVIEW","type":"kv_namespace","namespace_id":"kv-id"},{"name":"KV_PREVIEW2","type":"kv_namespace","namespace_id":"kv-id"},{"name":"DO_PREVIEW","type":"durable_object_namespace","class_name":"some-class-do-id","script_name":"some-script-do-id","environment":"some-environment-do-id"},{"name":"DO_PREVIEW2","type":"durable_object_namespace","class_name":"some-class-do-id","script_name":"some-script-do-id","environment":"some-environment-do-id"},{"name":"DO_PREVIEW3","type":"durable_object_namespace","class_name":"do-class","script_name":"do-s","environment":"do-e"},{"type":"queue","name":"QUEUE_PREVIEW","queue_name":"q-id"},{"type":"queue","name":"QUEUE_PREVIEW2","queue_name":"q-id"},{"name":"R2_PREVIEW","type":"r2_bucket","bucket_name":"r2-name"},{"name":"R2_PREVIEW2","type":"r2_bucket","bucket_name":"r2-name"},{"name":"D1_PREVIEW","type":"d1","database_id":"d1-id"},{"name":"D1_PREVIEW2","type":"d1","database_id":"d1-id"},{"name":"SERVICE_PREVIEW","type":"service","service":"service","environment":"production"},{"name":"SERVICE_PREVIEW2","type":"service","service":"service","environment":"production"},{"name":"AE_PREVIEW","type":"analytics_engine","dataset":"data"},{"name":"AE_PREVIEW2","type":"analytics_engine","dataset":"data"},{"name":"AI_PREVIEW","type":"ai"}],"compatibility_date":"2023-02-14","compatibility_flags":[],"placement":{"mode":"smart"},"limits":{"cpu_ms":50}}
 			------formdata-undici-0.test
 			Content-Disposition: form-data; name="functionsWorker-0.test.js"; filename="functionsWorker-0.test.js"
 			Content-Type: application/javascript+module