wrangler 2.1.6 → 2.1.8

package/src/dev/local.tsx

@@ -2,6 +2,7 @@ import { fork } from "node:child_process";
 import { realpathSync } from "node:fs";
 import { writeFile } from "node:fs/promises";
 import path from "node:path";
+import { npxImport } from "npx-import";
 import { useState, useEffect, useRef } from "react";
 import onExit from "signal-exit";
 import { registerWorker } from "../dev-registry";
@@ -24,10 +25,20 @@ import type {
 	CfKvNamespace,
 	CfR2Bucket,
 	CfVars,
+	CfD1Database,
 } from "../worker";
 import type { EsbuildBundle } from "./use-esbuild";
+import type {
+	Miniflare as Miniflare3Type,
+	MiniflareOptions as Miniflare3Options,
+} from "@miniflare/tre";
 import type { MiniflareOptions } from "miniflare";
 import type { ChildProcess } from "node:child_process";
+
+// caching of the miniflare package
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+let Miniflare: typeof import("@miniflare/tre")["Miniflare"];
+
 export interface LocalProps {
 	name: string | undefined;
 	bundle: EsbuildBundle | undefined;
@@ -49,10 +60,10 @@ export interface LocalProps {
 	localUpstream: string | undefined;
 	inspect: boolean;
 	onReady: ((ip: string, port: number) => void) | undefined;
-	logLevel: "none" | "error" | "log" | "warn" | "debug" | undefined;
 	logPrefix?: string;
 	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
 	testScheduled?: boolean;
+	experimentalLocal?: boolean;
 }
 
 export function Local(props: LocalProps) {
@@ -65,6 +76,10 @@ export function Local(props: LocalProps) {
 	return null;
 }
 
+function arrayToObject(values: string[] = []): Record<string, string> {
+	return Object.fromEntries(values.map((value) => [value, value]));
+}
+
 function useLocalWorker({
 	name: workerName,
 	bundle,
@@ -86,12 +101,13 @@ function useLocalWorker({
 	localUpstream,
 	inspect,
 	onReady,
-	logLevel,
 	logPrefix,
 	enablePagesAssetsServiceBinding,
+	experimentalLocal,
 }: LocalProps) {
 	// TODO: pass vars via command line
 	const local = useRef<ChildProcess>();
+	const experimentalLocalRef = useRef<Miniflare3Type>();
 	const removeSignalExitListener = useRef<() => void>();
 	const [inspectorUrl, setInspectorUrl] = useState<string | undefined>();
 
@@ -171,6 +187,7 @@ function useLocalWorker({
 				usageModel,
 				kv_namespaces: bindings?.kv_namespaces,
 				r2_buckets: bindings?.r2_buckets,
+				d1_databases: bindings?.d1_databases,
 				internalDurableObjects,
 				externalDurableObjects,
 				localPersistencePath,
@@ -182,12 +199,45 @@ function useLocalWorker({
 				dataBlobBindings,
 				crons,
 				upstream,
-				logLevel,
 				logPrefix,
 				workerDefinitions,
 				enablePagesAssetsServiceBinding,
 			});
 
+			if (experimentalLocal) {
+				// TODO: refactor setupMiniflareOptions so we don't need to parse here
+				const miniflare2Options: MiniflareOptions = JSON.parse(forkOptions[0]);
+				const options: Miniflare3Options = {
+					...miniflare2Options,
+					// Miniflare 3 distinguishes between binding name and namespace/bucket
+					// IDs. For now, just use the same value as we did in Miniflare 2.
+					// TODO: use defined KV preview ID if any
+					kvNamespaces: arrayToObject(miniflare2Options.kvNamespaces),
+					r2Buckets: arrayToObject(miniflare2Options.r2Buckets),
+					// TODO: pass-through collected modules instead of getting Miniflare
+					//  to collect them again
+				};
+
+				logger.log("⎔ Starting an experimental local server...");
+
+				if (Miniflare === undefined) {
+					({ Miniflare } = await npxImport<
+						// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+						typeof import("@miniflare/tre")
+					>("@miniflare/tre"));
+				}
+
+				const mf = new Miniflare(options);
+				experimentalLocalRef.current = mf;
+				removeSignalExitListener.current = onExit((_code, _signal) => {
+					logger.log("⎔ Shutting down experimental local server.");
+					mf.dispose();
+					experimentalLocalRef.current = undefined;
+				});
+				await mf.ready;
+				return;
+			}
+
 			const nodeOptions = setupNodeOptions({ inspect, ip, inspectorPort });
 			logger.log("⎔ Starting a local server...");
 
@@ -280,9 +330,16 @@ function useLocalWorker({
 				logger.log("⎔ Shutting down local server.");
 				local.current?.kill();
 				local.current = undefined;
-				removeSignalExitListener.current && removeSignalExitListener.current();
-				removeSignalExitListener.current = undefined;
 			}
+			if (experimentalLocalRef.current) {
+				logger.log("⎔ Shutting down experimental local server.");
+				// Initialisation errors are also thrown asynchronously by dispose().
+				// The catch() above should've caught them though.
+				experimentalLocalRef.current?.dispose().catch(() => {});
+				experimentalLocalRef.current = undefined;
+			}
+			removeSignalExitListener.current?.();
+			removeSignalExitListener.current = undefined;
 		};
 	}, [
 		bundle,
@@ -294,6 +351,7 @@ function useLocalWorker({
 		bindings.durable_objects,
 		bindings.kv_namespaces,
 		bindings.r2_buckets,
+		bindings.d1_databases,
 		bindings.vars,
 		bindings.services,
 		workerDefinitions,
@@ -311,10 +369,10 @@ function useLocalWorker({
 		localProtocol,
 		localUpstream,
 		inspect,
-		logLevel,
 		logPrefix,
 		onReady,
 		enablePagesAssetsServiceBinding,
+		experimentalLocal,
 	]);
 	return { inspectorUrl };
 }
@@ -414,6 +472,7 @@ interface SetupMiniflareOptionsProps {
 	usageModel: "bundled" | "unbound" | undefined;
 	kv_namespaces: CfKvNamespace[] | undefined;
 	r2_buckets: CfR2Bucket[] | undefined;
+	d1_databases: CfD1Database[] | undefined;
 	internalDurableObjects: CfDurableObject[];
 	externalDurableObjects: CfDurableObject[];
 	localPersistencePath: string | null;
@@ -425,7 +484,6 @@ interface SetupMiniflareOptionsProps {
 	dataBlobBindings: Record<string, string>;
 	crons: Config["triggers"]["crons"];
 	upstream: string | undefined;
-	logLevel: "none" | "error" | "log" | "warn" | "debug" | undefined;
 	logPrefix: string | undefined;
 	workerDefinitions: WorkerRegistry | undefined;
 	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
@@ -444,6 +502,7 @@ export function setupMiniflareOptions({
 	usageModel,
 	kv_namespaces,
 	r2_buckets,
+	d1_databases,
 	internalDurableObjects,
 	externalDurableObjects,
 	localPersistencePath,
@@ -455,12 +514,13 @@ export function setupMiniflareOptions({
 	dataBlobBindings,
 	crons,
 	upstream,
-	logLevel,
 	logPrefix,
 	workerDefinitions,
 	enablePagesAssetsServiceBinding,
-}: SetupMiniflareOptionsProps): MiniflareOptions {
-	// TODO: This was already messy with the custom `disableLogs` and `logOptions`.
+}: SetupMiniflareOptionsProps): {
+	miniflareCLIPath: string;
+	forkOptions: string[];
+} {
 	// It's now getting _really_ messy now with Pages ASSETS binding outside and the external Durable Objects inside.
 	const options = {
 		name: workerName,
@@ -511,12 +571,14 @@ export function setupMiniflareOptions({
 				})
 				.filter(([_, details]) => !!details)
 		),
+		d1Databases: d1_databases?.map((db) => db.binding),
 		...(localPersistencePath
 			? {
 					cachePersist: path.join(localPersistencePath, "cache"),
 					durableObjectsPersist: path.join(localPersistencePath, "do"),
 					kvPersist: path.join(localPersistencePath, "kv"),
 					r2Persist: path.join(localPersistencePath, "r2"),
+					d1Persist: path.join(localPersistencePath, "d1"),
 			  }
 			: {
 					// We mark these as true, so that they'll
@@ -548,7 +610,7 @@ export function setupMiniflareOptions({
 		logUnhandledRejections: true,
 		crons,
 		upstream,
-		disableLogs: logLevel === "none",
+		logLevel: logger.loggerLevel,
 		logOptions: logPrefix ? { prefix: logPrefix } : undefined,
 		enablePagesAssetsServiceBinding,
 	};

package/src/dev/start-server.ts

@@ -91,6 +91,7 @@ export async function startDevServer(
 			services: props.bindings.services,
 			firstPartyWorkerDevFacade: props.firstPartyWorker,
 			testScheduled: props.testScheduled,
+			experimentalLocalStubCache: props.experimentalLocal,
 		});
 
 		//run local now
@@ -111,7 +112,6 @@ export async function startDevServer(
 			crons: props.crons,
 			localProtocol: props.localProtocol,
 			localUpstream: props.localUpstream,
-			logLevel: props.logLevel,
 			logPrefix: props.logPrefix,
 			inspect: props.inspect,
 			onReady: props.onReady,
@@ -160,6 +160,7 @@ async function runEsbuild({
 	services,
 	firstPartyWorkerDevFacade,
 	testScheduled,
+	experimentalLocalStubCache,
 }: {
 	entry: Entry;
 	destination: string | undefined;
@@ -177,6 +178,7 @@ async function runEsbuild({
 	workerDefinitions: WorkerRegistry;
 	firstPartyWorkerDevFacade: boolean | undefined;
 	testScheduled?: boolean;
+	experimentalLocalStubCache: boolean | undefined;
 }): Promise<EsbuildBundle | undefined> {
 	if (!destination) return;
 
@@ -212,7 +214,9 @@ async function runEsbuild({
 				services,
 				firstPartyWorkerDevFacade,
 				targetConsumer: "dev", // We are starting a dev server
+				local: false,
 				testScheduled,
+				experimentalLocalStubCache,
 		  });
 
 	return {
@@ -246,7 +250,6 @@ export async function startLocalServer({
 	localUpstream,
 	inspect,
 	onReady,
-	logLevel,
 	logPrefix,
 	enablePagesAssetsServiceBinding,
 }: LocalProps) {
@@ -321,6 +324,7 @@ export async function startLocalServer({
 			usageModel,
 			kv_namespaces: bindings?.kv_namespaces,
 			r2_buckets: bindings?.r2_buckets,
+			d1_databases: bindings?.d1_databases,
 			internalDurableObjects,
 			externalDurableObjects,
 			localPersistencePath,
@@ -332,7 +336,6 @@ export async function startLocalServer({
 			dataBlobBindings,
 			crons,
 			upstream,
-			logLevel,
 			logPrefix,
 			workerDefinitions,
 			enablePagesAssetsServiceBinding,

package/src/dev/use-esbuild.ts

@@ -30,14 +30,17 @@ export function useEsbuild({
 	tsconfig,
 	minify,
 	nodeCompat,
+	betaD1Shims,
 	define,
 	noBundle,
 	workerDefinitions,
 	services,
 	durableObjects,
 	firstPartyWorkerDevFacade,
+	local,
 	targetConsumer,
 	testScheduled,
+	experimentalLocalStubCache,
 }: {
 	entry: Entry;
 	destination: string | undefined;
@@ -51,12 +54,15 @@ export function useEsbuild({
 	tsconfig: string | undefined;
 	minify: boolean | undefined;
 	nodeCompat: boolean | undefined;
+	betaD1Shims?: string[];
 	noBundle: boolean;
 	workerDefinitions: WorkerRegistry;
 	durableObjects: Config["durable_objects"];
 	firstPartyWorkerDevFacade: boolean | undefined;
+	local: boolean;
 	targetConsumer: "dev" | "publish";
 	testScheduled: boolean;
+	experimentalLocalStubCache: boolean | undefined;
 }): EsbuildBundle | undefined {
 	const [bundle, setBundle] = useState<EsbuildBundle>();
 	const { exit } = useApp();
@@ -110,6 +116,7 @@ export function useEsbuild({
 						tsconfig,
 						minify,
 						nodeCompat,
+						betaD1Shims,
 						define,
 						checkFetch: true,
 						assets: assets && {
@@ -120,8 +127,10 @@ export function useEsbuild({
 						workerDefinitions,
 						services,
 						firstPartyWorkerDevFacade,
+						local,
 						targetConsumer,
 						testScheduled,
+						experimentalLocalStubCache,
 				  });
 
 			// Capture the `stop()` method to use as the `useEffect()` destructor.
@@ -140,7 +149,6 @@ export function useEsbuild({
 					watcher.close();
 				};
 			}
-
 			setBundle({
 				id: 0,
 				entry,
@@ -179,8 +187,11 @@ export function useEsbuild({
 		durableObjects,
 		workerDefinitions,
 		firstPartyWorkerDevFacade,
+		betaD1Shims,
+		local,
 		targetConsumer,
 		testScheduled,
+		experimentalLocalStubCache,
 	]);
 	return bundle;
 }

package/src/dev.tsx

@@ -6,6 +6,7 @@ import React from "react";
 import { findWranglerToml, printBindings, readConfig } from "./config";
 import Dev from "./dev/dev";
 import { getVarsForDev } from "./dev/dev-vars";
+import { getLocalPersistencePath } from "./dev/get-local-persistence-path";
 
 import { startDevServer } from "./dev/start-server";
 import { getEntry } from "./entry";
@@ -13,18 +14,19 @@ import { logger } from "./logger";
 import * as metrics from "./metrics";
 import { getAssetPaths, getSiteAssetPaths } from "./sites";
 import { getAccountFromCache } from "./user";
-import { getZoneIdFromHost, getZoneForRoute, getHostFromRoute } from "./zones";
+import { identifyD1BindingsAsBeta } from "./worker";
+import { getHostFromRoute, getZoneForRoute, getZoneIdFromHost } from "./zones";
 import {
-	printWranglerBanner,
-	DEFAULT_LOCAL_PORT,
 	type ConfigPath,
-	getScriptName,
+	DEFAULT_INSPECTOR_PORT,
+	DEFAULT_LOCAL_PORT,
 	getDevCompatibilityDate,
 	getRules,
+	getScriptName,
 	isLegacyEnv,
-	DEFAULT_INSPECTOR_PORT,
+	printWranglerBanner,
 } from "./index";
-import type { Config } from "./config";
+import type { Config, Environment } from "./config";
 import type { Route } from "./config/environment";
 import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli";
 import type { CfWorkerInit } from "./worker";
@@ -60,6 +62,7 @@ interface DevArgs {
 	"jsx-fragment"?: string;
 	tsconfig?: string;
 	local?: boolean;
+	"experimental-local"?: boolean;
 	minify?: boolean;
 	var?: string[];
 	define?: string[];
@@ -69,7 +72,7 @@ interface DevArgs {
 	"persist-to"?: string;
 	"live-reload"?: boolean;
 	onReady?: (ip: string, port: number) => void;
-	logLevel?: "none" | "error" | "log" | "warn" | "debug";
+	logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug";
 	logPrefix?: string;
 	showInteractiveDevSession?: boolean;
 	"test-scheduled"?: boolean;
@@ -232,6 +235,20 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				type: "boolean",
 				default: false, // I bet this will a point of contention. We'll revisit it.
 			})
+			.option("experimental-local", {
+				describe: "Run on my machine using the Cloudflare Workers runtime",
+				type: "boolean",
+				default: false,
+			})
+			.check((argv) => {
+				if (argv.local && argv["experimental-local"]) {
+					throw new Error(
+						"--local and --experimental-local are mutually exclusive. " +
+							"Please select one or the other."
+					);
+				}
+				return true;
+			})
 			.option("minify", {
 				describe: "Minify the script",
 				type: "boolean",
@@ -280,7 +297,6 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				default: false,
 			})
 			.option("log-level", {
-				// "none" will currently default to "error" for Wrangler Logger
 				choices: ["debug", "info", "log", "warn", "error", "none"] as const,
 				describe: "Specify logging level",
 				default: "log",
@@ -320,6 +336,7 @@ export type AdditionalDevProps = {
 		bucket_name: string;
 		preview_bucket_name?: string;
 	}[];
+	d1Databases?: Environment["d1_databases"];
 };
 
 type StartDevOptions = ArgumentsCamelCase<DevArgs> &
@@ -335,8 +352,7 @@ export async function startDev(args: StartDevOptions) {
 	let rerender: (node: React.ReactNode) => void | undefined;
 	try {
 		if (args.logLevel) {
-			// we don't define a "none" logLevel, so "error" will do for now.
-			logger.loggerLevel = args.logLevel === "none" ? "error" : args.logLevel;
+			logger.loggerLevel = args.logLevel;
 		}
 		await printWranglerBanner();
 
@@ -404,7 +420,9 @@ export async function startDev(args: StartDevOptions) {
 					nodeCompat={nodeCompat}
 					build={configParam.build || {}}
 					define={{ ...configParam.define, ...cliDefines }}
-					initialMode={args.local ? "local" : "remote"}
+					initialMode={
+						args.local || args.experimentalLocal ? "local" : "remote"
+					}
 					jsxFactory={args["jsx-factory"] || configParam.jsx_factory}
 					jsxFragment={args["jsx-fragment"] || configParam.jsx_fragment}
 					tsconfig={args.tsconfig ?? configParam.tsconfig}
@@ -434,7 +452,6 @@ export async function startDev(args: StartDevOptions) {
 					usageModel={configParam.usage_model}
 					bindings={bindings}
 					crons={configParam.triggers.crons}
-					logLevel={args.logLevel}
 					logPrefix={args.logPrefix}
 					onReady={args.onReady}
 					inspect={args.inspect ?? true}
@@ -444,6 +461,7 @@ export async function startDev(args: StartDevOptions) {
 					firstPartyWorker={configParam.first_party_worker}
 					sendMetrics={configParam.send_metrics}
 					testScheduled={args["test-scheduled"]}
+					experimentalLocal={args.experimentalLocal}
 				/>
 			);
 		}
@@ -464,8 +482,7 @@ export async function startDev(args: StartDevOptions) {
 
 export async function startApiDev(args: StartDevOptions) {
 	if (args.logLevel) {
-		// we don't define a "none" logLevel, so "error" will do for now.
-		logger.loggerLevel = args.logLevel === "none" ? "error" : args.logLevel;
+		logger.loggerLevel = args.logLevel;
 	}
 	await printWranglerBanner();
 
@@ -501,9 +518,13 @@ export async function startApiDev(args: StartDevOptions) {
 			configParam
 		);
 
+		//if args.bundle is on, don't disable bundling
+		//if there's no args.bundle, and configParam.no_bundle is on, disable bundling
+		//otherwise, enable bundling
+		const enableBundling = args.bundle ?? !configParam.no_bundle;
 		return await startDevServer({
 			name: getScriptName({ name: args.name, env: args.env }, configParam),
-			noBundle: !(args.bundle ?? !configParam.no_bundle),
+			noBundle: !enableBundling,
 			entry: entry,
 			env: args.env,
 			zone: zoneId,
@@ -522,7 +543,7 @@ export async function startApiDev(args: StartDevOptions) {
 			upstreamProtocol: upstreamProtocol,
 			localProtocol: args.localProtocol || configParam.dev.local_protocol,
 			localUpstream: args["local-upstream"] || host,
-			localPersistencePath: localPersistencePath,
+			localPersistencePath,
 			liveReload: args.liveReload || false,
 			accountId: configParam.account_id || getAccountFromCache()?.id,
 			assetPaths: assetPaths,
@@ -547,7 +568,6 @@ export async function startApiDev(args: StartDevOptions) {
 			usageModel: configParam.usage_model,
 			bindings: bindings,
 			crons: configParam.triggers.crons,
-			logLevel: args.logLevel,
 			logPrefix: args.logPrefix,
 			onReady: args.onReady,
 			inspect: args.inspect ?? true,
@@ -558,6 +578,7 @@ export async function startApiDev(args: StartDevOptions) {
 			firstPartyWorker: configParam.first_party_worker,
 			sendMetrics: configParam.send_metrics,
 			testScheduled: args.testScheduled,
+			experimentalLocal: undefined,
 		});
 	}
 
@@ -683,7 +704,6 @@ async function validateDevServerSettings(
 			"The --assets argument is experimental and may change or break at any time"
 		);
 	}
-
 	const upstreamProtocol =
 		args["upstream-protocol"] || config.dev.upstream_protocol;
 	if (upstreamProtocol === "http") {
@@ -708,17 +728,11 @@ async function validateDevServerSettings(
 		);
 	}
 
-	const localPersistencePath = args.persistTo
-		? // If path specified, always treat it as relative to cwd()
-		  path.resolve(process.cwd(), args.persistTo)
-		: args.persist
-		? // If just flagged on, treat it as relative to wrangler.toml,
-		  // if one can be found, otherwise cwd()
-		  path.resolve(
-				config.configPath ? path.dirname(config.configPath) : process.cwd(),
-				".wrangler/state"
-		  )
-		: null;
+	const localPersistencePath = getLocalPersistencePath(
+		args.persistTo,
+		Boolean(args.persist),
+		config.configPath
+	);
 
 	const cliDefines =
 		args.define?.reduce<Record<string, string>>((collectDefines, d) => {
@@ -758,6 +772,7 @@ async function getBindingsAndAssetPaths(
 		vars: { ...args.vars, ...cliVars },
 		durableObjects: args.durableObjects,
 		r2: args.r2,
+		d1Databases: args.d1Databases,
 	});
 
 	const maskedVars = maskVars(bindings, configParam);
@@ -844,6 +859,10 @@ async function getBindings(
 		services: configParam.services,
 		unsafe: configParam.unsafe?.bindings,
 		logfwdr: configParam.logfwdr,
+		d1_databases: identifyD1BindingsAsBeta([
+			...configParam.d1_databases,
+			...(args.d1Databases || []),
+		]),
 	};
 
 	return bindings;

package/src/dialogs.tsx

@@ -138,6 +138,10 @@ export function select(
 	});
 }
 
+export function logDim(msg: string) {
+	console.log(chalk.gray(msg));
+}
+
 export async function fromDashMessagePrompt(
 	deploySource: "dash" | "wrangler" | "api"
 ): Promise<boolean | void> {

package/src/environment-variables.ts

@@ -1,5 +1,20 @@
 import { logger } from "./logger";
 
+type VariableNames =
+	| "CLOUDFLARE_ACCOUNT_ID"
+	| "CLOUDFLARE_API_TOKEN"
+	| "CLOUDFLARE_API_KEY"
+	| "CLOUDFLARE_EMAIL"
+	| "WRANGLER_SEND_METRICS"
+	| "CLOUDFLARE_API_BASE_URL"
+	| "WRANGLER_LOG";
+
+type DeprecatedNames =
+	| "CF_ACCOUNT_ID"
+	| "CF_API_TOKEN"
+	| "CF_API_KEY"
+	| "CF_EMAIL"
+	| "CF_API_BASE_URL";
 /**
  * Create a function used to access an environment variable.
  *
@@ -11,8 +26,8 @@ export function getEnvironmentVariableFactory({
 	deprecatedName,
 	defaultValue,
 }: {
-	variableName: string;
-	deprecatedName?: string;
+	variableName: VariableNames;
+	deprecatedName?: DeprecatedNames;
 	defaultValue?: string;
 }) {
 	let hasWarned = false;