wrangler 0.0.0-e3a458e → 0.0.0-e3c036d7

package/src/create-worker-upload-form.ts

@@ -1,217 +1,342 @@
 import { readFileSync } from "node:fs";
 import { FormData, File } from "undici";
 import type {
-  CfWorkerInit,
-  CfModuleType,
-  CfDurableObjectMigrations,
+	CfWorkerInit,
+	CfModuleType,
+	CfDurableObjectMigrations,
 } from "./worker.js";
 
 export function toMimeType(type: CfModuleType): string {
-  switch (type) {
-    case "esm":
-      return "application/javascript+module";
-    case "commonjs":
-      return "application/javascript";
-    case "compiled-wasm":
-      return "application/wasm";
-    case "buffer":
-      return "application/octet-stream";
-    case "text":
-      return "text/plain";
-    default:
-      throw new TypeError("Unsupported module: " + type);
-  }
+	switch (type) {
+		case "esm":
+			return "application/javascript+module";
+		case "commonjs":
+			return "application/javascript";
+		case "compiled-wasm":
+			return "application/wasm";
+		case "buffer":
+			return "application/octet-stream";
+		case "text":
+			return "text/plain";
+		default:
+			throw new TypeError("Unsupported module: " + type);
+	}
 }
 
+type WorkerMetadataBinding =
+	// If you add any new binding types here, also add it to safeBindings
+	// under validateUnsafeBinding in config/validation.ts
+	| { type: "plain_text"; name: string; text: string }
+	| { type: "json"; name: string; json: unknown }
+	| { type: "wasm_module"; name: string; part: string }
+	| { type: "text_blob"; name: string; part: string }
+	| { type: "data_blob"; name: string; part: string }
+	| { type: "kv_namespace"; name: string; namespace_id: string }
+	| {
+			type: "durable_object_namespace";
+			name: string;
+			class_name: string;
+			script_name?: string;
+			environment?: string;
+	  }
+	| { type: "queue"; name: string; queue_name: string }
+	| { type: "r2_bucket"; name: string; bucket_name: string }
+	| { type: "d1"; name: string; id: string; internalEnv?: string }
+	| { type: "service"; name: string; service: string; environment?: string }
+	| { type: "analytics_engine"; name: string; dataset?: string }
+	| { type: "dispatch_namespace"; name: string; namespace: string }
+	| { type: "mtls_certificate"; name: string; certificate_id: string }
+	| {
+			type: "logfwdr";
+			name: string;
+			destination: string;
+	  };
+
 export interface WorkerMetadata {
-  /** The name of the entry point module. Only exists when the worker is in the ES module format */
-  main_module?: string;
-  /** The name of the entry point module. Only exists when the worker is in the Service Worker format */
-  body_part?: string;
-  compatibility_date?: string;
-  compatibility_flags?: string[];
-  usage_model?: "bundled" | "unbound";
-  migrations?: CfDurableObjectMigrations;
-  bindings: (
-    | { type: "kv_namespace"; name: string; namespace_id: string }
-    | { type: "plain_text"; name: string; text: string }
-    | { type: "json"; name: string; json: unknown }
-    | { type: "wasm_module"; name: string; part: string }
-    | { type: "text_blob"; name: string; part: string }
-    | {
-        type: "durable_object_namespace";
-        name: string;
-        class_name: string;
-        script_name?: string;
-      }
-    | { type: "r2_bucket"; name: string; bucket_name: string }
-  )[];
+	/** The name of the entry point module. Only exists when the worker is in the ES module format */
+	main_module?: string;
+	/** The name of the entry point module. Only exists when the worker is in the service-worker format */
+	body_part?: string;
+	compatibility_date?: string;
+	compatibility_flags?: string[];
+	usage_model?: "bundled" | "unbound";
+	migrations?: CfDurableObjectMigrations;
+	capnp_schema?: string;
+	bindings: WorkerMetadataBinding[];
+	keep_bindings?: WorkerMetadataBinding["type"][];
+	logpush?: boolean;
+	// Allow unsafe.metadata to add arbitary properties at runtime
+	[key: string]: unknown;
 }
 
 /**
  * Creates a `FormData` upload from a `CfWorkerInit`.
  */
 export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
-  const formData = new FormData();
-  const {
-    main,
-    bindings,
-    migrations,
-    usage_model,
-    compatibility_date,
-    compatibility_flags,
-  } = worker;
-
-  let { modules } = worker;
-
-  const metadataBindings: WorkerMetadata["bindings"] = [];
-
-  bindings.kv_namespaces?.forEach(({ id, binding }) => {
-    metadataBindings.push({
-      name: binding,
-      type: "kv_namespace",
-      namespace_id: id,
-    });
-  });
-
-  bindings.durable_objects?.bindings.forEach(
-    ({ name, class_name, script_name }) => {
-      metadataBindings.push({
-        name,
-        type: "durable_object_namespace",
-        class_name: class_name,
-        ...(script_name && { script_name }),
-      });
-    }
-  );
-
-  bindings.r2_buckets?.forEach(({ binding, bucket_name }) => {
-    metadataBindings.push({
-      name: binding,
-      type: "r2_bucket",
-      bucket_name,
-    });
-  });
-
-  Object.entries(bindings.vars || {})?.forEach(([key, value]) => {
-    if (typeof value === "string") {
-      metadataBindings.push({ name: key, type: "plain_text", text: value });
-    } else {
-      metadataBindings.push({ name: key, type: "json", json: value });
-    }
-  });
-
-  for (const [name, filePath] of Object.entries(bindings.wasm_modules || {})) {
-    metadataBindings.push({
-      name,
-      type: "wasm_module",
-      part: name,
-    });
-
-    formData.set(
-      name,
-      new File([readFileSync(filePath)], filePath, {
-        type: "application/wasm",
-      })
-    );
-  }
-
-  for (const [name, filePath] of Object.entries(bindings.text_blobs || {})) {
-    metadataBindings.push({
-      name,
-      type: "text_blob",
-      part: name,
-    });
-
-    if (name !== "__STATIC_CONTENT_MANIFEST") {
-      formData.set(
-        name,
-        new File([readFileSync(filePath)], filePath, {
-          type: "text/plain",
-        })
-      );
-    }
-  }
-
-  if (main.type === "commonjs") {
-    // This is a service-worker format worker.
-    for (const module of Object.values([...(modules || [])])) {
-      if (module.name === "__STATIC_CONTENT_MANIFEST") {
-        // Add the manifest to the form data.
-        formData.set(
-          module.name,
-          new File([module.content], module.name, {
-            type: "text/plain",
-          })
-        );
-        // And then remove it from the modules collection
-        modules = modules?.filter((m) => m !== module);
-      } else if (module.type === "compiled-wasm" || module.type === "text") {
-        // Convert all wasm/text modules into `wasm_module`/`text_blob` bindings.
-        // The "name" of the module is a file path. We use it
-        // to instead be a "part" of the body, and a reference
-        // that we can use inside our source. This identifier has to be a valid
-        // JS identifier, so we replace all non alphanumeric characters
-        // with an underscore.
-        const name = module.name.replace(/[^a-zA-Z0-9_$]/g, "_");
-        metadataBindings.push({
-          name,
-          type: module.type === "compiled-wasm" ? "wasm_module" : "text_blob",
-          part: name,
-        });
-
-        // Add the module to the form data.
-        formData.set(
-          name,
-          new File([module.content], module.name, {
-            type:
-              module.type === "compiled-wasm"
-                ? "application/wasm"
-                : "text/plain",
-          })
-        );
-        // And then remove it from the modules collection
-        modules = modules?.filter((m) => m !== module);
-      } else if (module.type === "buffer") {
-        throw new Error(
-          'The "buffer" module type is not yet supported in service worker format workers'
-        );
-      }
-    }
-  }
-
-  if (bindings.unsafe) {
-    // @ts-expect-error unsafe bindings don't need to match a specific type here
-    metadataBindings.push(...bindings.unsafe);
-  }
-
-  const metadata: WorkerMetadata = {
-    ...(main.type !== "commonjs"
-      ? { main_module: main.name }
-      : { body_part: main.name }),
-    bindings: metadataBindings,
-    ...(compatibility_date && { compatibility_date }),
-    ...(compatibility_flags && { compatibility_flags }),
-    ...(usage_model && { usage_model }),
-    ...(migrations && { migrations }),
-  };
-
-  formData.set("metadata", JSON.stringify(metadata));
-
-  if (main.type === "commonjs" && modules && modules.length > 0) {
-    throw new TypeError(
-      "More than one module can only be specified when type = 'esm'"
-    );
-  }
-
-  for (const module of [main].concat(modules || [])) {
-    formData.set(
-      module.name,
-      new File([module.content], module.name, {
-        type: toMimeType(module.type ?? main.type ?? "esm"),
-      })
-    );
-  }
-
-  return formData;
+	const formData = new FormData();
+	const {
+		main,
+		bindings,
+		migrations,
+		usage_model,
+		compatibility_date,
+		compatibility_flags,
+		keepVars,
+		logpush,
+	} = worker;
+
+	let { modules } = worker;
+
+	const metadataBindings: WorkerMetadata["bindings"] = [];
+
+	Object.entries(bindings.vars || {})?.forEach(([key, value]) => {
+		if (typeof value === "string") {
+			metadataBindings.push({ name: key, type: "plain_text", text: value });
+		} else {
+			metadataBindings.push({ name: key, type: "json", json: value });
+		}
+	});
+
+	bindings.kv_namespaces?.forEach(({ id, binding }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "kv_namespace",
+			namespace_id: id,
+		});
+	});
+
+	bindings.durable_objects?.bindings.forEach(
+		({ name, class_name, script_name, environment }) => {
+			metadataBindings.push({
+				name,
+				type: "durable_object_namespace",
+				class_name: class_name,
+				...(script_name && { script_name }),
+				...(environment && { environment }),
+			});
+		}
+	);
+
+	bindings.queues?.forEach(({ binding, queue_name }) => {
+		metadataBindings.push({
+			type: "queue",
+			name: binding,
+			queue_name,
+		});
+	});
+
+	bindings.r2_buckets?.forEach(({ binding, bucket_name }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "r2_bucket",
+			bucket_name,
+		});
+	});
+
+	bindings.d1_databases?.forEach(
+		({ binding, database_id, database_internal_env }) => {
+			metadataBindings.push({
+				name: binding,
+				type: "d1",
+				id: database_id,
+				internalEnv: database_internal_env,
+			});
+		}
+	);
+
+	bindings.services?.forEach(({ binding, service, environment }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "service",
+			service,
+			...(environment && { environment }),
+		});
+	});
+
+	bindings.analytics_engine_datasets?.forEach(({ binding, dataset }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "analytics_engine",
+			dataset,
+		});
+	});
+
+	bindings.dispatch_namespaces?.forEach(({ binding, namespace }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "dispatch_namespace",
+			namespace,
+		});
+	});
+
+	bindings.mtls_certificates?.forEach(({ binding, certificate_id }) => {
+		metadataBindings.push({
+			name: binding,
+			type: "mtls_certificate",
+			certificate_id,
+		});
+	});
+
+	bindings.logfwdr?.bindings.forEach(({ name, destination }) => {
+		metadataBindings.push({
+			name: name,
+			type: "logfwdr",
+			destination,
+		});
+	});
+
+	for (const [name, filePath] of Object.entries(bindings.wasm_modules || {})) {
+		metadataBindings.push({
+			name,
+			type: "wasm_module",
+			part: name,
+		});
+
+		formData.set(
+			name,
+			new File([readFileSync(filePath)], filePath, {
+				type: "application/wasm",
+			})
+		);
+	}
+
+	for (const [name, filePath] of Object.entries(bindings.text_blobs || {})) {
+		metadataBindings.push({
+			name,
+			type: "text_blob",
+			part: name,
+		});
+
+		if (name !== "__STATIC_CONTENT_MANIFEST") {
+			formData.set(
+				name,
+				new File([readFileSync(filePath)], filePath, {
+					type: "text/plain",
+				})
+			);
+		}
+	}
+
+	for (const [name, filePath] of Object.entries(bindings.data_blobs || {})) {
+		metadataBindings.push({
+			name,
+			type: "data_blob",
+			part: name,
+		});
+
+		formData.set(
+			name,
+			new File([readFileSync(filePath)], filePath, {
+				type: "application/octet-stream",
+			})
+		);
+	}
+
+	if (main.type === "commonjs") {
+		// This is a service-worker format worker.
+		for (const module of Object.values([...(modules || [])])) {
+			if (module.name === "__STATIC_CONTENT_MANIFEST") {
+				// Add the manifest to the form data.
+				formData.set(
+					module.name,
+					new File([module.content], module.name, {
+						type: "text/plain",
+					})
+				);
+				// And then remove it from the modules collection
+				modules = modules?.filter((m) => m !== module);
+			} else if (
+				module.type === "compiled-wasm" ||
+				module.type === "text" ||
+				module.type === "buffer"
+			) {
+				// Convert all wasm/text/data modules into `wasm_module`/`text_blob`/`data_blob` bindings.
+				// The "name" of the module is a file path. We use it
+				// to instead be a "part" of the body, and a reference
+				// that we can use inside our source. This identifier has to be a valid
+				// JS identifier, so we replace all non alphanumeric characters
+				// with an underscore.
+				const name = module.name.replace(/[^a-zA-Z0-9_$]/g, "_");
+				metadataBindings.push({
+					name,
+					type:
+						module.type === "compiled-wasm"
+							? "wasm_module"
+							: module.type === "text"
+							? "text_blob"
+							: "data_blob",
+					part: name,
+				});
+
+				// Add the module to the form data.
+				formData.set(
+					name,
+					new File([module.content], module.name, {
+						type:
+							module.type === "compiled-wasm"
+								? "application/wasm"
+								: module.type === "text"
+								? "text/plain"
+								: "application/octet-stream",
+					})
+				);
+				// And then remove it from the modules collection
+				modules = modules?.filter((m) => m !== module);
+			}
+		}
+	}
+
+	if (bindings.unsafe?.bindings) {
+		// @ts-expect-error unsafe bindings don't need to match a specific type here
+		metadataBindings.push(...bindings.unsafe.bindings);
+	}
+
+	const metadata: WorkerMetadata = {
+		...(main.type !== "commonjs"
+			? { main_module: main.name }
+			: { body_part: main.name }),
+		bindings: metadataBindings,
+		...(compatibility_date && { compatibility_date }),
+		...(compatibility_flags && { compatibility_flags }),
+		...(usage_model && { usage_model }),
+		...(migrations && { migrations }),
+		capnp_schema: bindings.logfwdr?.schema,
+		...(keepVars && { keep_bindings: ["plain_text", "json"] }),
+		...(logpush !== undefined && { logpush }),
+	};
+
+	if (bindings.unsafe?.metadata !== undefined) {
+		for (const key of Object.keys(bindings.unsafe.metadata)) {
+			metadata[key] = bindings.unsafe.metadata[key];
+		}
+	}
+
+	formData.set("metadata", JSON.stringify(metadata));
+
+	if (main.type === "commonjs" && modules && modules.length > 0) {
+		throw new TypeError(
+			"More than one module can only be specified when type = 'esm'"
+		);
+	}
+
+	for (const module of [main].concat(modules || [])) {
+		formData.set(
+			module.name,
+			new File([module.content], module.name, {
+				type: toMimeType(module.type ?? main.type ?? "esm"),
+			})
+		);
+	}
+
+	if (bindings.logfwdr && bindings.logfwdr.schema) {
+		const filePath = bindings.logfwdr.schema;
+		formData.set(
+			filePath,
+			new File([readFileSync(filePath)], filePath, {
+				type: "application/octet-stream",
+			})
+		);
+	}
+
+	return formData;
 }