wrangler 0.0.0-e33294b0 → 0.0.0-e33bea9b

package/src/__tests__/type-generation.test.ts

@@ -76,6 +76,7 @@ const bindingsConfigMock: Partial<Config> = {
 	wasm_modules: { MODULE1: "module1.wasm", MODULE2: "module2.wasm" },
 	unsafe: {
 		bindings: [{ name: "testing_unsafe", type: "plain_text" }],
+		metadata: { some_key: "some_value" },
 	},
 	rules: [
 		{

package/src/__tests__/user.test.ts

@@ -85,7 +85,7 @@ describe("User", () => {
 		await expect(
 			requireAuth({} as Config)
 		).rejects.toThrowErrorMatchingInlineSnapshot(
-			`"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work. Please go to https://developers.cloudflare.com/api/tokens/create/ for instructions on how to create an api token, and assign its value to CLOUDFLARE_API_TOKEN."`
+			`"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work. Please go to https://developers.cloudflare.com/fundamentals/api/get-started/create-token/ for instructions on how to create an api token, and assign its value to CLOUDFLARE_API_TOKEN."`
 		);
 	});
 

package/src/api/dev.ts

@@ -18,7 +18,7 @@ export interface UnstableDevOptions {
 	site?: string; // Root folder of static assets for Workers Sites
 	siteInclude?: string[]; // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
 	siteExclude?: string[]; // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
-	nodeCompat?: boolean; // Enable node.js compatibility
+	nodeCompat?: boolean; // Enable Node.js compatibility
 	compatibilityDate?: string; // Date to use for compatibility checks
 	compatibilityFlags?: string[]; // Flags to use for compatibility checks
 	persist?: boolean; // Enable persistence for local mode, using default path: .wrangler/state
@@ -43,7 +43,6 @@ export interface UnstableDevOptions {
 		preview_bucket_name?: string;
 	}[];
 	logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug"; // Specify logging level  [choices: "debug", "info", "log", "warn", "error", "none"] [default: "log"]
-	logPrefix?: string;
 	inspect?: boolean;
 	local?: boolean;
 	accountId?: string;
@@ -163,7 +162,7 @@ export async function unstable_dev(
 					site: options?.site, // Root folder of static assets for Workers Sites
 					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
 					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
-					nodeCompat: options?.nodeCompat, // Enable node.js compatibility
+					nodeCompat: options?.nodeCompat, // Enable Node.js compatibility
 					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
 					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
 					experimentalJsonConfig: undefined,
@@ -252,7 +251,7 @@ export async function unstable_dev(
 					site: options?.site, // Root folder of static assets for Workers Sites
 					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
 					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
-					nodeCompat: options?.nodeCompat, // Enable node.js compatibility
+					nodeCompat: options?.nodeCompat, // Enable Node.js compatibility
 					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
 					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
 					experimentalJsonConfig: undefined,

package/src/api/pages/publish.tsx

@@ -1,6 +1,6 @@
 import { existsSync, readFileSync } from "node:fs";
 import { tmpdir } from "node:os";
-import { dirname, join, resolve as resolvePath } from "node:path";
+import { join, resolve as resolvePath } from "node:path";
 import { cwd } from "node:process";
 import { File, FormData } from "undici";
 import { fetchResult } from "../../cfetch";
@@ -69,14 +69,6 @@ interface PagesPublishOptions {
 	 */
 	bundle?: boolean;
 
-	/**
-	 * Whether to process non-JS module imports or not, such as
-	 * wasm/text/binary, when we run bundling on `functions` or
-	 * `_worker.js`
-	 * Default: false
-	 */
-	experimentalWorkerBundle?: boolean;
-
 	// TODO: Allow passing in the API key and plumb it through
 	// to the API calls so that the publish function does not
 	// rely on the `CLOUDFLARE_API_KEY` environment variable
@@ -98,7 +90,6 @@ export async function publish({
 	commitDirty,
 	functionsDirectory: customFunctionsDirectory,
 	bundle,
-	experimentalWorkerBundle,
 }: PagesPublishOptions) {
 	let _headers: string | undefined,
 		_redirects: string | undefined,
@@ -137,6 +128,11 @@ export async function publish({
 		isProduction = project.production_branch === branch;
 	}
 
+	const deploymentConfig =
+		project.deployment_configs[isProduction ? "production" : "preview"];
+	const nodejsCompat =
+		deploymentConfig.compatibility_flags?.includes("nodejs_compat");
+
 	/**
 	 * Evaluate if this is an Advanced Mode or Pages Functions project. If Advanced Mode, we'll
 	 * go ahead and upload `_worker.js` as is, but if Pages Functions, we need to attempt to build
@@ -160,7 +156,6 @@ export async function publish({
 	);
 
 	if (!_workerJS && existsSync(functionsDirectory)) {
-		const outfile = join(tmpdir(), `./functionsWorker-${Math.random()}.js`);
 		const outputConfigPath = join(
 			tmpdir(),
 			`functions-filepath-routing-config-${Math.random()}.json`
@@ -168,18 +163,20 @@ export async function publish({
 
 		try {
 			workerBundle = await buildFunctions({
-				outfile,
 				outputConfigPath,
 				functionsDirectory,
 				onEnd: () => {},
-				buildOutputDirectory: dirname(outfile),
+				buildOutputDirectory: directory,
 				routesOutputPath,
 				local: false,
 				d1Databases,
-				experimentalWorkerBundle,
+				nodejsCompat,
 			});
 
-			builtFunctions = readFileSync(outfile, "utf-8");
+			builtFunctions = readFileSync(
+				workerBundle.resolvedEntryPointPath,
+				"utf-8"
+			);
 			filepathRoutingConfig = readFileSync(outputConfigPath, "utf-8");
 		} catch (e) {
 			if (e instanceof FunctionsNoRoutesError) {
@@ -247,10 +244,7 @@ export async function publish({
 	 * – this includes its routing and middleware characteristics.
 	 */
 	if (_workerJS) {
-		let workerFileContents = _workerJS;
-		const enableBundling = bundle || experimentalWorkerBundle;
-
-		if (enableBundling) {
+		if (bundle) {
 			const outfile = join(tmpdir(), `./bundledWorker-${Math.random()}.mjs`);
 			workerBundle = await buildRawWorker({
 				workerScriptPath,
@@ -261,30 +255,29 @@ export async function publish({
 				watch: false,
 				onEnd: () => {},
 				betaD1Shims: d1Databases,
-				experimentalWorkerBundle,
+				nodejsCompat,
 			});
-			workerFileContents = readFileSync(outfile, "utf8");
 		} else {
 			await checkRawWorker(workerScriptPath, () => {});
+			// TODO: Replace this with the cool new no-bundle stuff when that lands: https://github.com/cloudflare/workers-sdk/pull/2769
+			workerBundle = {
+				modules: [],
+				dependencies: {},
+				stop: undefined,
+				resolvedEntryPointPath: workerScriptPath,
+				bundleType: "esm",
+			};
 		}
 
-		if (experimentalWorkerBundle) {
-			const workerBundleContents = await createUploadWorkerBundleContents(
-				workerBundle as BundleResult
-			);
+		const workerBundleContents = await createUploadWorkerBundleContents(
+			workerBundle as BundleResult
+		);
 
-			formData.append(
-				"_worker.bundle",
-				new File([workerBundleContents], "_worker.bundle")
-			);
-			logger.log(`✨ Uploading Worker bundle`);
-		} else {
-			formData.append(
-				"_worker.js",
-				new File([workerFileContents], "_worker.js")
-			);
-			logger.log(`✨ Uploading _worker.js`);
-		}
+		formData.append(
+			"_worker.bundle",
+			new File([workerBundleContents], "_worker.bundle")
+		);
+		logger.log(`✨ Uploading Worker bundle`);
 
 		if (_routesCustom) {
 			// user provided a custom _routes.json file
@@ -310,21 +303,15 @@ export async function publish({
 	 * https://developers.cloudflare.com/pages/platform/functions/
 	 */
 	if (builtFunctions && !_workerJS) {
-		if (experimentalWorkerBundle) {
-			const workerBundleContents = await createUploadWorkerBundleContents(
-				workerBundle as BundleResult
-			);
+		const workerBundleContents = await createUploadWorkerBundleContents(
+			workerBundle as BundleResult
+		);
 
-			formData.append(
-				"_worker.bundle",
-				new File([workerBundleContents], "_worker.bundle")
-			);
-			logger.log(`✨ Uploading Functions bundle`);
-		} else {
-			// if Functions were build successfully, proceed to uploading the build file
-			formData.append("_worker.js", new File([builtFunctions], "_worker.js"));
-			logger.log(`✨ Uploading Functions`);
-		}
+		formData.append(
+			"_worker.bundle",
+			new File([workerBundleContents], "_worker.bundle")
+		);
+		logger.log(`✨ Uploading Functions bundle`);
 
 		if (_routesCustom) {
 			// user provided a custom _routes.json file

package/src/bundle.ts

@@ -85,6 +85,15 @@ Add "node_compat = true" to your wrangler.toml file to enable Node compatibility
 	}
 }
 
+const nodejsCompatPlugin: esbuild.Plugin = {
+	name: "nodejs_compat Plugin",
+	setup(pluginBuild) {
+		pluginBuild.onResolve({ filter: /node:.*/ }, () => {
+			return { external: true };
+		});
+	},
+};
+
 /**
  * Generate a bundle for the worker identified by the arguments passed in.
  */
@@ -98,11 +107,13 @@ export async function bundleWorker(
 		doBindings: DurableObjectBindings;
 		jsxFactory?: string;
 		jsxFragment?: string;
+		entryName?: string;
 		rules: Config["rules"];
 		watch?: esbuild.WatchMode | boolean;
 		tsconfig?: string;
 		minify?: boolean;
-		nodeCompat?: boolean;
+		legacyNodeCompat?: boolean;
+		nodejsCompat?: boolean;
 		define: Config["define"];
 		checkFetch: boolean;
 		services?: Config["services"];
@@ -127,11 +138,13 @@ export async function bundleWorker(
 		doBindings,
 		jsxFactory,
 		jsxFragment,
+		entryName,
 		rules,
 		watch,
 		tsconfig,
 		minify,
-		nodeCompat,
+		legacyNodeCompat,
+		nodejsCompat,
 		checkFetch,
 		local,
 		assets,
@@ -277,7 +290,7 @@ export async function bundleWorker(
 					currentEntry,
 					tmpDir.path,
 					betaD1Shims,
-					local,
+					local && !experimentalLocal,
 					doBindings
 				);
 			}),
@@ -324,16 +337,19 @@ export async function bundleWorker(
 		bundle: true,
 		absWorkingDir: entry.directory,
 		outdir: destination,
+		entryNames: entryName || path.parse(entry.file).name,
 		...(isOutfile
 			? {
 					outdir: undefined,
 					outfile: destination,
+					entryNames: undefined,
 			  }
 			: {}),
 		inject,
 		external: ["__STATIC_CONTENT_MANIFEST"],
 		format: entry.format === "modules" ? "esm" : "iife",
-		target: "es2020",
+		// Our workerd runtime uses the same V8 version as recent Chrome, which is highly ES2022 compliant: https://kangax.github.io/compat-table/es2016plus/
+		target: "es2022",
 		sourcemap: sourcemap ?? true, // this needs to use ?? to accept false
 		// Include a reference to the output folder in the sourcemap.
 		// This is omitted by default, but we need it to properly resolve source paths in error output.
@@ -346,7 +362,7 @@ export async function bundleWorker(
 				// use process.env["NODE_ENV" + ""] so that esbuild doesn't replace it
 				// when we do a build of wrangler. (re: https://github.com/cloudflare/workers-sdk/issues/1477)
 				"process.env.NODE_ENV": `"${process.env["NODE_ENV" + ""]}"`,
-				...(nodeCompat ? { global: "globalThis" } : {}),
+				...(legacyNodeCompat ? { global: "globalThis" } : {}),
 				...(checkFetch ? { fetch: "checkedFetch" } : {}),
 				...options.define,
 			},
@@ -359,9 +375,10 @@ export async function bundleWorker(
 		},
 		plugins: [
 			moduleCollector.plugin,
-			...(nodeCompat
+			...(legacyNodeCompat
 				? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
 				: []),
+			...(nodejsCompat ? [nodejsCompatPlugin] : []),
 			...(plugins || []),
 		],
 		...(jsxFactory && { jsxFactory }),
@@ -377,7 +394,8 @@ export async function bundleWorker(
 	try {
 		result = await esbuild.build(buildOptions);
 	} catch (e) {
-		if (!nodeCompat && isBuildFailure(e)) rewriteNodeCompatBuildFailure(e);
+		if (!legacyNodeCompat && isBuildFailure(e))
+			rewriteNodeCompatBuildFailure(e);
 		throw e;
 	}
 
@@ -802,7 +820,7 @@ async function applyD1BetaFacade(
 	entry: Entry,
 	tmpDirPath: string,
 	betaD1Shims: string[],
-	local: boolean,
+	miniflare2: boolean,
 	doBindings: DurableObjectBindings
 ): Promise<Entry> {
 	let entrypointPath = path.resolve(
@@ -853,7 +871,7 @@ async function applyD1BetaFacade(
 		],
 		define: {
 			__D1_IMPORTS__: JSON.stringify(betaD1Shims),
-			__LOCAL_MODE__: JSON.stringify(local),
+			__LOCAL_MODE__: JSON.stringify(miniflare2),
 		},
 		outfile: targetPath,
 	});

package/src/config/environment.ts

@@ -463,7 +463,6 @@ interface EnvironmentNonInheritable {
 	 * 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: {
@@ -471,14 +470,20 @@ 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: {

package/src/config/index.ts

@@ -255,10 +255,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,
 			})),
@@ -319,6 +319,16 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 		});
 	}
 
+	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;
 	}

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 [];
 	}

package/src/config/validation.ts

@@ -1162,10 +1162,8 @@ function normalizeAndValidateEnvironment(
 			rawEnv,
 			envName,
 			"unsafe",
-			validateBindingsProperty(envName, validateUnsafeBinding),
-			{
-				bindings: [],
-			}
+			validateUnsafeSettings(envName),
+			{}
 		),
 		zone_id: rawEnv.zone_id,
 		no_bundle: inheritable(
@@ -1495,6 +1493,62 @@ const validateBindingsProperty =
 		return isValid;
 	};
 
+const validateUnsafeSettings =
+	(envName: string): ValidatorFn =>
+	(diagnostics, field, value, config) => {
+		const fieldPath =
+			config === undefined ? `${field}` : `env.${envName}.${field}`;
+
+		if (typeof value !== "object" || value === null || Array.isArray(value)) {
+			diagnostics.errors.push(
+				`The field "${fieldPath}" should be an object but got ${JSON.stringify(
+					value
+				)}.`
+			);
+			return false;
+		}
+
+		// At least one of bindings and metadata must exist
+		if (!hasProperty(value, "bindings") && !hasProperty(value, "metadata")) {
+			diagnostics.errors.push(
+				`The field "${fieldPath}" should contain at least one of "bindings" or "metadata" properties but got ${JSON.stringify(
+					value
+				)}.`
+			);
+			return false;
+		}
+
+		// unsafe.bindings
+		if (hasProperty(value, "bindings") && value.bindings !== undefined) {
+			const validateBindingsFn = validateBindingsProperty(
+				envName,
+				validateUnsafeBinding
+			);
+			const valid = validateBindingsFn(diagnostics, field, value, config);
+			if (!valid) {
+				return false;
+			}
+		}
+
+		// unsafe.metadata
+		if (
+			hasProperty(value, "metadata") &&
+			value.metadata !== undefined &&
+			(typeof value.metadata !== "object" ||
+				value.metadata === null ||
+				Array.isArray(value.metadata))
+		) {
+			diagnostics.errors.push(
+				`The field "${fieldPath}.metadata" should be an object but got ${JSON.stringify(
+					value.metadata
+				)}.`
+			);
+			return false;
+		}
+
+		return true;
+	};
+
 /**
  * Check that the given field is a valid "durable_object" binding object.
  */

package/src/create-worker-preview.ts

@@ -109,6 +109,14 @@ function randomId(): string {
 	});
 }
 
+// URLs are often relative to the zone. Sometimes the base zone
+// will be grey-clouded, and so the host must be swapped out for
+// the worker route host, which is more likely to be orange-clouded
+function switchHost(originalUrl: string, host?: string): URL {
+	const url = new URL(originalUrl);
+	url.hostname = host ?? url.hostname;
+	return url;
+}
 /**
  * Generates a preview session token.
  */
@@ -129,9 +137,13 @@ export async function createPreviewSession(
 		abortSignal
 	);
 
-	logger.debug(`-- START EXCHANGE API REQUEST: GET ${exchange_url}`);
+	const switchedExchangeUrl = switchHost(exchange_url, ctx.host).toString();
+
+	logger.debug(`-- START EXCHANGE API REQUEST: GET ${switchedExchangeUrl}`);
 	logger.debug("-- END EXCHANGE API REQUEST");
-	const exchangeResponse = await fetch(exchange_url, { signal: abortSignal });
+	const exchangeResponse = await fetch(switchedExchangeUrl, {
+		signal: abortSignal,
+	});
 	const bodyText = await exchangeResponse.text();
 	logger.debug(
 		"-- START EXCHANGE API RESPONSE:",
@@ -147,16 +159,15 @@ export async function createPreviewSession(
 		token: string;
 		prewarm: string;
 	}>(bodyText);
-
-	const { host } = new URL(inspector_websocket);
-	const query = `cf_workers_preview_token=${token}`;
+	const inspector = new URL(inspector_websocket);
+	inspector.searchParams.append("cf_workers_preview_token", token);
 
 	return {
 		id: randomId(),
 		value: token,
-		host,
-		inspectorUrl: new URL(`${inspector_websocket}?${query}`),
-		prewarmUrl: new URL(prewarm),
+		host: ctx.host ?? inspector.host,
+		inspectorUrl: switchHost(inspector.href, ctx.host),
+		prewarmUrl: switchHost(prewarm, ctx.host),
 	};
 }
 

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

@@ -65,6 +65,8 @@ export interface WorkerMetadata {
 	bindings: WorkerMetadataBinding[];
 	keep_bindings?: WorkerMetadataBinding["type"][];
 	logpush?: boolean;
+	// Allow unsafe.metadata to add arbitary properties at runtime
+	[key: string]: unknown;
 }
 
 /**
@@ -284,9 +286,9 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		}
 	}
 
-	if (bindings.unsafe) {
+	if (bindings.unsafe?.bindings) {
 		// @ts-expect-error unsafe bindings don't need to match a specific type here
-		metadataBindings.push(...bindings.unsafe);
+		metadataBindings.push(...bindings.unsafe.bindings);
 	}
 
 	const metadata: WorkerMetadata = {
@@ -303,6 +305,12 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		...(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) {

package/src/dev/dev.tsx

@@ -138,7 +138,8 @@ export type DevProps = {
 	compatibilityFlags: string[] | undefined;
 	usageModel: "bundled" | "unbound" | undefined;
 	minify: boolean | undefined;
-	nodeCompat: boolean | undefined;
+	legacyNodeCompat: boolean | undefined;
+	nodejsCompat: boolean | undefined;
 	build: Config["build"];
 	env: string | undefined;
 	legacyEnv: boolean;
@@ -146,7 +147,6 @@ export type DevProps = {
 	host: string | undefined;
 	routes: Route[] | undefined;
 	inspect: boolean;
-	logPrefix?: string;
 	onReady: ((ip: string, port: number) => void) | undefined;
 	showInteractiveDevSession: boolean | undefined;
 	forceLocal: boolean | undefined;
@@ -278,7 +278,8 @@ function DevSession(props: DevSessionProps) {
 		),
 		tsconfig: props.tsconfig,
 		minify: props.minify,
-		nodeCompat: props.nodeCompat,
+		legacyNodeCompat: props.legacyNodeCompat,
+		nodejsCompat: props.nodejsCompat,
 		betaD1Shims,
 		define: props.define,
 		noBundle: props.noBundle,
@@ -341,7 +342,6 @@ function DevSession(props: DevSessionProps) {
 			queueConsumers={props.queueConsumers}
 			localProtocol={props.localProtocol}
 			localUpstream={props.localUpstream}
-			logPrefix={props.logPrefix}
 			inspect={props.inspect}
 			onReady={announceAndOnReady}
 			enablePagesAssetsServiceBinding={props.enablePagesAssetsServiceBinding}