wrangler 2.4.0 → 2.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.4.0",
+	"version": "2.4.1",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -119,7 +119,7 @@
 		"@databases/sql": "^3.2.0",
 		"@iarna/toml": "^3.0.0",
 		"@microsoft/api-extractor": "^7.28.3",
-		"@miniflare/tre": "^3.0.0-next.6",
+		"@miniflare/tre": "^3.0.0-next.7",
 		"@types/better-sqlite3": "^7.6.0",
 		"@types/busboy": "^1.5.0",
 		"@types/command-exists": "^1.2.0",

package/src/__tests__/dev.test.tsx

@@ -1208,6 +1208,7 @@ describe("wrangler dev", () => {
 			      --node-compat                                Enable node.js compatibility  [boolean]
 			      --persist                                    Enable persistence for local mode, using default path: .wrangler/state  [boolean]
 			      --persist-to                                 Specify directory to use for local persistence (implies --persist)  [string]
+			      --live-reload                                Auto reload HTML pages when change is detected in local mode  [boolean]
 			      --test-scheduled                             Test scheduled events by visiting /__scheduled in browser  [boolean] [default: false]
 			      --log-level                                  Specify logging level  [choices: \\"debug\\", \\"info\\", \\"log\\", \\"warn\\", \\"error\\", \\"none\\"] [default: \\"log\\"]",
 			  "warn": "",

package/src/__tests__/metrics.test.ts

@@ -364,7 +364,7 @@ describe("metrics", () => {
 
 				expect(std.out).toMatchInlineSnapshot(`
 			"Usage metrics tracking has changed since you last granted permission.
-			Your choice has been saved in the following file: home/.wrangler/config/metrics.json.
+			Your choice has been saved in the following file: test-xdg-config/metrics.json.
 
 			  You can override the user level setting for a project in \`wrangler.toml\`:
 

package/src/bundle.ts

@@ -97,7 +97,6 @@ export async function bundleWorker(
 		targetConsumer: "dev" | "publish";
 		local: boolean;
 		testScheduled?: boolean;
-		experimentalLocalStubCache?: boolean;
 		inject?: string[];
 		loader?: Record<string, string>;
 		sourcemap?: esbuild.CommonOptions["sourcemap"];
@@ -125,7 +124,6 @@ export async function bundleWorker(
 		firstPartyWorkerDevFacade,
 		targetConsumer,
 		testScheduled,
-		experimentalLocalStubCache,
 		inject: injectOption,
 		loader,
 		sourcemap,
@@ -277,11 +275,6 @@ export async function bundleWorker(
 
 	const inject: string[] = injectOption ?? [];
 	if (checkFetch) inject.push(checkedFetchFileToInject);
-	if (experimentalLocalStubCache) {
-		inject.push(
-			path.resolve(getBasePath(), "templates/experimental-local-cache-stubs.js")
-		);
-	}
 
 	const buildOptions: esbuild.BuildOptions & { metafile: true } = {
 		entryPoints: [inputEntry.file],

package/src/dev/dev.tsx

@@ -288,7 +288,6 @@ function DevSession(props: DevSessionProps) {
 		// Enable the bundling to know whether we are using dev or publish
 		targetConsumer: "dev",
 		testScheduled: props.testScheduled ?? false,
-		experimentalLocalStubCache: props.local && props.experimentalLocal,
 	});
 
 	// TODO(queues) support remote wrangler dev

package/src/dev/local.tsx

@@ -20,6 +20,7 @@ import { waitForPortToBeAvailable } from "../proxy";
 import { requireAuth } from "../user";
 import type { Config } from "../config";
 import type { WorkerRegistry } from "../dev-registry";
+import type { LoggerLevel } from "../logger";
 import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli";
 import type { AssetPaths } from "../sites";
 import type {
@@ -39,6 +40,7 @@ import type { EsbuildBundle } from "./use-esbuild";
 import type {
 	Miniflare as Miniflare3Type,
 	MiniflareOptions as Miniflare3Options,
+	Log as Miniflare3LogType,
 	CloudflareFetch,
 } from "@miniflare/tre";
 import type { MiniflareOptions } from "miniflare";
@@ -228,10 +230,12 @@ function useLocalWorker({
 			});
 
 			if (experimentalLocal) {
-				const mf3Options = await transformLocalOptions({
+				const log = await buildMiniflare3Logger(logPrefix);
+				const mf3Options = await transformMf2OptionsToMf3Options({
 					miniflare2Options: options,
 					format,
 					bundle,
+					log,
 					kvNamespaces: bindings?.kv_namespaces,
 					r2Buckets: bindings?.r2_buckets,
 					authenticatedAccountId: accountId,
@@ -243,7 +247,7 @@ function useLocalWorker({
 
 				if (current === undefined) {
 					// If we don't have an active Miniflare instance, create a new one
-					const Miniflare = await getMiniflare3Constructor();
+					const { Miniflare } = await getMiniflare3();
 					if (abortController.signal.aborted) return;
 					const mf = new Miniflare(mf3Options);
 					experimentalLocalRef.current = mf;
@@ -750,6 +754,9 @@ export interface SetupMiniflare3Options {
 	format: CfScriptFormat;
 	bundle: EsbuildBundle;
 
+	// Miniflare's logger
+	log: Miniflare3LogType;
+
 	// Miniflare 3 accepts namespace/bucket names in addition to binding names.
 	// This means multiple workers persisting to the same location can have
 	// different binding names for the same namespace/bucket. Therefore, we need
@@ -763,13 +770,30 @@ export interface SetupMiniflare3Options {
 	authenticatedAccountId: string | true | undefined;
 	// Whether to read/write from/to real KV namespaces
 	kvRemote: boolean | undefined;
+
+	// Port to start DevTools inspector server on
 	inspectorPort: number;
 }
 
-export async function transformLocalOptions({
+export async function buildMiniflare3Logger(
+	logPrefix?: string
+): Promise<Miniflare3LogType> {
+	const { Log, NoOpLog, LogLevel } = await getMiniflare3();
+
+	let level = logger.loggerLevel.toUpperCase() as Uppercase<LoggerLevel>;
+	if (level === "LOG") level = "INFO";
+	const logLevel = LogLevel[level];
+
+	return logLevel === LogLevel.NONE
+		? new NoOpLog()
+		: new Log(logLevel, { prefix: logPrefix });
+}
+
+export async function transformMf2OptionsToMf3Options({
 	miniflare2Options,
 	format,
 	bundle,
+	log,
 	kvNamespaces,
 	r2Buckets,
 	authenticatedAccountId,
@@ -802,6 +826,7 @@ export async function transformLocalOptions({
 		inspectorPort,
 		verbose: true,
 		cloudflareFetch,
+		log,
 	};
 
 	if (format === "modules") {
@@ -850,13 +875,10 @@ export async function transformLocalOptions({
 
 // Caching of the `npx-import`ed `@miniflare/tre` package
 // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-let Miniflare: typeof import("@miniflare/tre").Miniflare;
-export async function getMiniflare3Constructor(): Promise<typeof Miniflare> {
-	if (Miniflare === undefined) {
-		({ Miniflare } = await npxImport<
-			// eslint-disable-next-line @typescript-eslint/consistent-type-imports
-			typeof import("@miniflare/tre")
-		>("@miniflare/tre@3.0.0-next.6"));
-	}
-	return Miniflare;
+let miniflare3Module: typeof import("@miniflare/tre");
+export async function getMiniflare3(): Promise<
+	// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+	typeof import("@miniflare/tre")
+> {
+	return (miniflare3Module ??= await npxImport("@miniflare/tre@3.0.0-next.7"));
 }

package/src/dev/start-server.ts

@@ -17,10 +17,11 @@ import { logger } from "../logger";
 import { waitForPortToBeAvailable } from "../proxy";
 import {
 	setupBindings,
-	getMiniflare3Constructor,
+	getMiniflare3,
+	buildMiniflare3Logger,
 	setupMiniflareOptions,
 	setupNodeOptions,
-	transformLocalOptions,
+	transformMf2OptionsToMf3Options,
 } from "./local";
 import { startRemoteServer } from "./remote";
 import { validateDevProps } from "./validate-dev-props";
@@ -98,7 +99,6 @@ export async function startDevServer(
 			services: props.bindings.services,
 			firstPartyWorkerDevFacade: props.firstPartyWorker,
 			testScheduled: props.testScheduled,
-			experimentalLocalStubCache: props.experimentalLocal,
 		});
 
 		if (props.local) {
@@ -206,7 +206,6 @@ async function runEsbuild({
 	services,
 	firstPartyWorkerDevFacade,
 	testScheduled,
-	experimentalLocalStubCache,
 }: {
 	entry: Entry;
 	destination: string | undefined;
@@ -225,7 +224,6 @@ async function runEsbuild({
 	workerDefinitions: WorkerRegistry;
 	firstPartyWorkerDevFacade: boolean | undefined;
 	testScheduled?: boolean;
-	experimentalLocalStubCache: boolean | undefined;
 }): Promise<EsbuildBundle | undefined> {
 	if (!destination) return;
 
@@ -266,7 +264,6 @@ async function runEsbuild({
 				targetConsumer: "dev", // We are starting a dev server
 				local: true,
 				testScheduled,
-				experimentalLocalStubCache,
 		  });
 
 	return {
@@ -400,17 +397,19 @@ export async function startLocalServer({
 		});
 
 		if (experimentalLocal) {
-			const mf3Options = await transformLocalOptions({
+			const log = await buildMiniflare3Logger(logPrefix);
+			const mf3Options = await transformMf2OptionsToMf3Options({
 				miniflare2Options: options,
 				format,
 				bundle,
+				log,
 				kvNamespaces: bindings?.kv_namespaces,
 				r2Buckets: bindings?.r2_buckets,
 				authenticatedAccountId: accountId,
 				kvRemote: experimentalLocalRemoteKv,
 				inspectorPort,
 			});
-			const Miniflare = await getMiniflare3Constructor();
+			const { Miniflare } = await getMiniflare3();
 			const mf = new Miniflare(mf3Options);
 			const runtimeURL = await mf.ready;
 			experimentalLocalRef = mf;

package/src/dev/use-esbuild.ts

@@ -41,7 +41,6 @@ export function useEsbuild({
 	local,
 	targetConsumer,
 	testScheduled,
-	experimentalLocalStubCache,
 }: {
 	entry: Entry;
 	destination: string | undefined;
@@ -63,7 +62,6 @@ export function useEsbuild({
 	local: boolean;
 	targetConsumer: "dev" | "publish";
 	testScheduled: boolean;
-	experimentalLocalStubCache: boolean | undefined;
 }): EsbuildBundle | undefined {
 	const [bundle, setBundle] = useState<EsbuildBundle>();
 	const { exit } = useApp();
@@ -136,7 +134,6 @@ export function useEsbuild({
 						local,
 						targetConsumer,
 						testScheduled,
-						experimentalLocalStubCache,
 				  });
 
 			// Capture the `stop()` method to use as the `useEffect()` destructor.
@@ -198,7 +195,6 @@ export function useEsbuild({
 		local,
 		targetConsumer,
 		testScheduled,
-		experimentalLocalStubCache,
 	]);
 	return bundle;
 }

package/src/dev.tsx

@@ -1,4 +1,5 @@
 import path from "node:path";
+import chalk from "chalk";
 import { watch } from "chokidar";
 import getPort from "get-port";
 import { render } from "ink";
@@ -288,11 +289,20 @@ export function devOptions(yargs: Argv<CommonYargsOptions>): Argv<DevArgs> {
 				requiresArg: true,
 			})
 			.option("live-reload", {
-				// TODO: Add back in once we have remote `--live-reload`
-				hidden: true,
-				// describe: "Auto reload HTML pages when change is detected",
+				describe:
+					"Auto reload HTML pages when change is detected in local mode",
 				type: "boolean",
 			})
+			.check((argv) => {
+				const local = argv["local"] || argv["experimental-local"];
+				if (argv["live-reload"] && !local) {
+					throw new Error(
+						"--live-reload is only supported in local mode. " +
+							"Please enable either --local or --experimental-local."
+					);
+				}
+				return true;
+			})
 			.option("inspect", {
 				describe: "Enable dev tools",
 				type: "boolean",
@@ -369,6 +379,16 @@ export async function startDev(args: StartDevOptions) {
 		}
 		await printWranglerBanner();
 
+		if (args.local && process.platform !== "win32") {
+			logger.info(
+				chalk.magenta(
+					`Want to try out the next version of local mode using the open-source Workers runtime?\nSwitch out --local for ${chalk.bold(
+						"--experimental-local"
+					)} and let us know what you think at https://discord.gg/cloudflaredev !`
+				)
+			);
+		}
+
 		const configPath =
 			(args.config as ConfigPath) ||
 			((args.script &&

package/src/metrics/metrics-config.ts

@@ -1,11 +1,11 @@
 import { randomUUID } from "node:crypto";
 import { readFileSync, mkdirSync, writeFileSync } from "node:fs";
-import os from "node:os";
 import path from "node:path";
 import { fetchResult } from "../cfetch";
 import { getConfigCache, saveToConfigCache } from "../config-cache";
 import { confirm } from "../dialogs";
 import { getEnvironmentVariableFactory } from "../environment-variables";
+import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
 import { CI } from "../is-ci";
 import isInteractive from "../is-interactive";
 import { logger } from "../logger";
@@ -167,7 +167,7 @@ export function readMetricsConfig(): MetricsConfigFile {
  * Get the path to the metrics config file.
  */
 function getMetricsConfigPath(): string {
-	return path.resolve(os.homedir(), ".wrangler/config/metrics.json");
+	return path.resolve(getGlobalWranglerConfigPath(), "metrics.json");
 }
 
 /**

package/src/publish/publish.ts

@@ -487,7 +487,6 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 						// This could potentially cause issues as we no longer have identical behaviour between dev and publish?
 						targetConsumer: "publish",
 						local: false,
-						experimentalLocalStubCache: false,
 					}
 			  );