wrangler 2.1.2 → 2.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.1.2",
+	"version": "2.1.3",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",

package/src/__tests__/dev.test.tsx

@@ -1025,7 +1025,8 @@ describe("wrangler dev", () => {
 			  -l, --local                                      Run on my machine  [boolean] [default: false]
 			      --minify                                     Minify the script  [boolean]
 			      --node-compat                                Enable node.js compatibility  [boolean]
-			      --experimental-enable-local-persistence      Enable persistence for this session (only for local mode)  [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]
 			      --inspect                                    Enable dev tools  [deprecated] [boolean]",
 			  "warn": "",
 			}

package/src/__tests__/dialogs.test.tsx

@@ -0,0 +1,40 @@
+jest.unmock("../dialogs");
+import { fromDashMessagePrompt } from "../dialogs";
+import { CI } from "../is-ci";
+
+describe("fromDashMessagePrompt", () => {
+	it("should return undefined in CI when last deployed from api", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("api");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return undefined in CI when last deployed from wrangler", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("wrangler");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return true in CI when last deployed from dash", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("dash");
+		expect(result).toBe(true);
+	});
+
+	it("should return undefined when last deployed from api", async () => {
+		//not in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(false);
+		const result = await fromDashMessagePrompt("api");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return undefined when last deployed from wrangler", async () => {
+		//not in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(false);
+		const result = await fromDashMessagePrompt("wrangler");
+		expect(result).toBe(undefined);
+	});
+});

package/src/api/dev.ts

@@ -19,7 +19,8 @@ interface DevOptions {
 	nodeCompat?: boolean;
 	compatibilityDate?: string;
 	compatibilityFlags?: string[];
-	experimentalEnableLocalPersistence?: boolean;
+	persist?: boolean;
+	persistTo?: string;
 	liveReload?: boolean;
 	watch?: boolean;
 	vars?: {

package/src/dev/dev.tsx

@@ -136,7 +136,7 @@ export type DevProps = {
 	upstreamProtocol: "https" | "http";
 	localProtocol: "https" | "http";
 	localUpstream: string | undefined;
-	enableLocalPersistence: boolean;
+	localPersistencePath: string | null;
 	liveReload: boolean;
 	bindings: CfWorkerInit["bindings"];
 	define: Config["define"];
@@ -276,7 +276,7 @@ function DevSession(props: DevSessionProps) {
 			ip={props.ip}
 			rules={props.rules}
 			inspectorPort={props.inspectorPort}
-			enableLocalPersistence={props.enableLocalPersistence}
+			localPersistencePath={props.localPersistencePath}
 			liveReload={props.liveReload}
 			crons={props.crons}
 			localProtocol={props.localProtocol}

package/src/dev/local.tsx

@@ -42,7 +42,7 @@ export interface LocalProps {
 	ip: string;
 	rules: Config["rules"];
 	inspectorPort: number;
-	enableLocalPersistence: boolean;
+	localPersistencePath: string | null;
 	liveReload: boolean;
 	crons: Config["triggers"]["crons"];
 	localProtocol: "http" | "https";
@@ -77,7 +77,7 @@ function useLocalWorker({
 	port,
 	inspectorPort,
 	rules,
-	enableLocalPersistence,
+	localPersistencePath,
 	liveReload,
 	ip,
 	crons,
@@ -93,16 +93,6 @@ function useLocalWorker({
 	const local = useRef<ChildProcess>();
 	const removeSignalExitListener = useRef<() => void>();
 	const [inspectorUrl, setInspectorUrl] = useState<string | undefined>();
-	// if we're using local persistence for data, we should use the cwd
-	// as an explicit path, or else it'll use the temp dir
-	// which disappears when dev ends
-	const localPersistencePath = enableLocalPersistence
-		? // Maybe we could make the path configurable as well?
-		  path.join(process.cwd(), "wrangler-local-state")
-		: // We otherwise choose null, but choose true later
-		  // so that it's persisted in the temp dir across a dev session
-		  // even when we change source and reload
-		  null;
 
 	useEffect(() => {
 		if (bindings.services && bindings.services.length > 0) {

package/src/dev/start-server.ts

@@ -80,7 +80,7 @@ export async function startDevServer(
 			ip: props.ip,
 			rules: props.rules,
 			inspectorPort: props.inspectorPort,
-			enableLocalPersistence: props.enableLocalPersistence,
+			localPersistencePath: props.localPersistencePath,
 			liveReload: props.liveReload,
 			crons: props.crons,
 			localProtocol: props.localProtocol,
@@ -203,7 +203,7 @@ export async function startLocalServer({
 	port,
 	inspectorPort,
 	rules,
-	enableLocalPersistence,
+	localPersistencePath,
 	liveReload,
 	ip,
 	crons,
@@ -222,17 +222,6 @@ export async function startLocalServer({
 		inspectorUrl = url;
 	};
 
-	// if we're using local persistence for data, we should use the cwd
-	// as an explicit path, or else it'll use the temp dir
-	// which disappears when dev ends
-	const localPersistencePath = enableLocalPersistence
-		? // Maybe we could make the path configurable as well?
-		  path.join(process.cwd(), "wrangler-local-state")
-		: // We otherwise choose null, but choose true later
-		  // so that it's persisted in the temp dir across a dev session
-		  // even when we change source and reload
-		  null;
-
 	const abortController = new AbortController();
 	async function startLocalWorker() {
 		if (!bundle || !format) return;

package/src/dev.tsx

@@ -24,7 +24,6 @@ import {
 	isLegacyEnv,
 	DEFAULT_INSPECTOR_PORT,
 } from "./index";
-
 import type { Config } from "./config";
 import type { Route } from "./config/environment";
 import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli";
@@ -66,6 +65,8 @@ interface DevArgs {
 	define?: string[];
 	"node-compat"?: boolean;
 	"experimental-enable-local-persistence"?: boolean;
+	persist?: boolean;
+	"persist-to"?: string;
 	"live-reload"?: boolean;
 	onReady?: (ip: string, port: number) => void;
 	logLevel?: "none" | "error" | "log" | "warn" | "debug";
@@ -239,8 +240,22 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				type: "boolean",
 			})
 			.option("experimental-enable-local-persistence", {
-				describe: "Enable persistence for this session (only for local mode)",
+				describe:
+					"Enable persistence for local mode (deprecated, use --persist)",
 				type: "boolean",
+				deprecated: true,
+				hidden: true,
+			})
+			.option("persist", {
+				describe:
+					"Enable persistence for local mode, using default path: .wrangler/state",
+				type: "boolean",
+			})
+			.option("persist-to", {
+				describe:
+					"Specify directory to use for local persistence (implies --persist)",
+				type: "string",
+				requiresArg: true,
 			})
 			.option("live-reload", {
 				// TODO: Add back in once we have remote `--live-reload`
@@ -342,6 +357,7 @@ export async function startDev(args: StartDevOptions) {
 			getLocalPort,
 			getInspectorPort,
 			cliDefines,
+			localPersistencePath,
 		} = await validateDevServerSettings(args, config);
 
 		await metrics.sendMetricsEvent(
@@ -382,9 +398,7 @@ export async function startDev(args: StartDevOptions) {
 					upstreamProtocol={upstreamProtocol}
 					localProtocol={args.localProtocol || configParam.dev.local_protocol}
 					localUpstream={args["local-upstream"] || host}
-					enableLocalPersistence={
-						args.experimentalEnableLocalPersistence || false
-					}
+					localPersistencePath={localPersistencePath}
 					liveReload={args.liveReload || false}
 					accountId={configParam.account_id || getAccountFromCache()?.id}
 					assetPaths={assetPaths}
@@ -457,6 +471,7 @@ export async function startApiDev(args: StartDevOptions) {
 		getLocalPort,
 		getInspectorPort,
 		cliDefines,
+		localPersistencePath,
 	} = await validateDevServerSettings(args, config);
 
 	await metrics.sendMetricsEvent(
@@ -493,7 +508,7 @@ export async function startApiDev(args: StartDevOptions) {
 			upstreamProtocol: upstreamProtocol,
 			localProtocol: args.localProtocol || configParam.dev.local_protocol,
 			localUpstream: args["local-upstream"] || host,
-			enableLocalPersistence: args.experimentalEnableLocalPersistence || false,
+			localPersistencePath: localPersistencePath,
 			liveReload: args.liveReload || false,
 			accountId: configParam.account_id || getAccountFromCache()?.id,
 			assetPaths: assetPaths,
@@ -670,6 +685,23 @@ async function validateDevServerSettings(
 		);
 	}
 
+	if (args.experimentalEnableLocalPersistence) {
+		logger.warn(
+			`--experimental-enable-local-persistence is deprecated.\n` +
+				`Move any existing data to .wrangler/state and use --persist, or\n` +
+				`use --persist-to=./wrangler-local-state to keep using the old path.`
+		);
+	}
+
+	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 || process.cwd(), ".wrangler/state")
+		: null;
+
 	const cliDefines =
 		args.define?.reduce<Record<string, string>>((collectDefines, d) => {
 			const [key, ...value] = d.split(":");
@@ -687,6 +719,7 @@ async function validateDevServerSettings(
 		host,
 		routes,
 		cliDefines,
+		localPersistencePath,
 	};
 }
 

package/src/dialogs.tsx

@@ -4,7 +4,11 @@ import SelectInput from "ink-select-input";
 import TextInput from "ink-text-input";
 import * as React from "react";
 import { useState } from "react";
+
+import { CI } from "./is-ci";
+import isInteractive from "./is-interactive";
 import { logger } from "./logger";
+
 type ConfirmProps = {
 	text: string;
 	onConfirm: (answer: boolean) => void;
@@ -135,13 +139,16 @@ export function select(
 }
 
 export async function fromDashMessagePrompt(
-	deploySource: string
+	deploySource: "dash" | "wrangler" | "api"
 ): Promise<boolean | void> {
 	if (deploySource === "dash") {
 		logger.warn(
 			`You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.
 		Edits that have been made via the dashboard will be overridden by your local code and config.`
 		);
+
+		if (!isInteractive() || CI.isCI()) return true;
+
 		return await confirm("Would you like to continue?");
 	}
 }

package/src/pages/dev.tsx

@@ -116,9 +116,22 @@ export function Options(yargs: Argv) {
 				choices: ["http", "https"] as const,
 			},
 			"experimental-enable-local-persistence": {
+				describe:
+					"Enable persistence for local mode (deprecated, use --persist)",
 				type: "boolean",
-				default: false,
-				describe: "Enable persistence for this session (only for local mode)",
+				deprecated: true,
+				hidden: true,
+			},
+			persist: {
+				describe:
+					"Enable persistence for local mode, using default path: .wrangler/state",
+				type: "boolean",
+			},
+			"persist-to": {
+				describe:
+					"Specify directory to use for local persistence (implies --persist)",
+				type: "string",
+				requiresArg: true,
 			},
 			"node-compat": {
 				describe: "Enable node.js compatibility",
@@ -151,7 +164,9 @@ export const Handler = async ({
 	r2: r2s = [],
 	"live-reload": liveReload,
 	"local-protocol": localProtocol,
-	"experimental-enable-local-persistence": experimentalEnableLocalPersistence,
+	experimentalEnableLocalPersistence,
+	persist,
+	persistTo,
 	"node-compat": nodeCompat,
 	config: config,
 	_: [_pages, _dev, ...remaining],
@@ -189,6 +204,14 @@ export const Handler = async ({
 		directory = resolve(directory);
 	}
 
+	if (experimentalEnableLocalPersistence) {
+		logger.warn(
+			`--experimental-enable-local-persistence is deprecated.\n` +
+				`Move any existing data to .wrangler/state and use --persist, or\n` +
+				`use --persist-to=./wrangler-local-state to keep using the old path.`
+		);
+	}
+
 	let scriptReadyResolve: () => void;
 	const scriptReadyPromise = new Promise<void>(
 		(promiseResolve) => (scriptReadyResolve = promiseResolve)
@@ -358,7 +381,8 @@ export const Handler = async ({
 				directory,
 			},
 			forceLocal: true,
-			experimentalEnableLocalPersistence,
+			persist,
+			persistTo,
 			showInteractiveDevSession: undefined,
 			inspect: true,
 			logLevel: "error",

package/wrangler-dist/cli.d.ts

@@ -52,7 +52,8 @@ declare interface DevOptions {
     nodeCompat?: boolean;
     compatibilityDate?: string;
     compatibilityFlags?: string[];
-    experimentalEnableLocalPersistence?: boolean;
+    persist?: boolean;
+    persistTo?: string;
     liveReload?: boolean;
     watch?: boolean;
     vars?: {

package/wrangler-dist/cli.js

@@ -138674,7 +138674,7 @@ var import_websocket_server = __toESM(require_websocket_server2(), 1);
 var wrapper_default = import_websocket.default;
 
 // package.json
-var version = "2.1.2";
+var version = "2.1.3";
 var package_default = {
   name: "wrangler",
   version,
@@ -139940,7 +139940,7 @@ function useLocalWorker({
   port,
   inspectorPort,
   rules,
-  enableLocalPersistence,
+  localPersistencePath,
   liveReload,
   ip,
   crons,
@@ -139955,7 +139955,6 @@ function useLocalWorker({
   const local = (0, import_react3.useRef)();
   const removeSignalExitListener = (0, import_react3.useRef)();
   const [inspectorUrl, setInspectorUrl] = (0, import_react3.useState)();
-  const localPersistencePath = enableLocalPersistence ? import_node_path13.default.join(process.cwd(), "wrangler-local-state") : null;
   (0, import_react3.useEffect)(() => {
     if (bindings.services && bindings.services.length > 0) {
       logger.warn(
@@ -143193,7 +143192,7 @@ function DevSession(props) {
     ip: props.ip,
     rules: props.rules,
     inspectorPort: props.inspectorPort,
-    enableLocalPersistence: props.enableLocalPersistence,
+    localPersistencePath: props.localPersistencePath,
     liveReload: props.liveReload,
     crons: props.crons,
     localProtocol: props.localProtocol,
@@ -143476,7 +143475,7 @@ async function startDevServer(props) {
       ip: props.ip,
       rules: props.rules,
       inspectorPort: props.inspectorPort,
-      enableLocalPersistence: props.enableLocalPersistence,
+      localPersistencePath: props.localPersistencePath,
       liveReload: props.liveReload,
       crons: props.crons,
       localProtocol: props.localProtocol,
@@ -143576,7 +143575,7 @@ async function startLocalServer({
   port,
   inspectorPort,
   rules,
-  enableLocalPersistence,
+  localPersistencePath,
   liveReload,
   ip,
   crons,
@@ -143594,7 +143593,6 @@ async function startLocalServer({
   const setInspectorUrl = (url3) => {
     inspectorUrl = url3;
   };
-  const localPersistencePath = enableLocalPersistence ? path20.join(process.cwd(), "wrangler-local-state") : null;
   const abortController = new AbortController();
   async function startLocalWorker() {
     if (!bundle || !format4)
@@ -143850,6 +143848,8 @@ async function fromDashMessagePrompt(deploySource) {
       `You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.
 		Edits that have been made via the dashboard will be overridden by your local code and config.`
     );
+    if (!isInteractive() || CI.isCI())
+      return true;
     return await confirm("Would you like to continue?");
   }
 }
@@ -149726,9 +149726,19 @@ function Options2(yargs) {
       choices: ["http", "https"]
     },
     "experimental-enable-local-persistence": {
+      describe: "Enable persistence for local mode (deprecated, use --persist)",
       type: "boolean",
-      default: false,
-      describe: "Enable persistence for this session (only for local mode)"
+      deprecated: true,
+      hidden: true
+    },
+    persist: {
+      describe: "Enable persistence for local mode, using default path: .wrangler/state",
+      type: "boolean"
+    },
+    "persist-to": {
+      describe: "Specify directory to use for local persistence (implies --persist)",
+      type: "string",
+      requiresArg: true
     },
     "node-compat": {
       describe: "Enable node.js compatibility",
@@ -149759,7 +149769,9 @@ var Handler2 = async ({
   r2: r2s = [],
   "live-reload": liveReload,
   "local-protocol": localProtocol,
-  "experimental-enable-local-persistence": experimentalEnableLocalPersistence,
+  experimentalEnableLocalPersistence,
+  persist,
+  persistTo,
   "node-compat": nodeCompat,
   config,
   _: [_pages, _dev, ...remaining]
@@ -149790,6 +149802,13 @@ var Handler2 = async ({
   } else {
     directory = (0, import_node_path26.resolve)(directory);
   }
+  if (experimentalEnableLocalPersistence) {
+    logger.warn(
+      `--experimental-enable-local-persistence is deprecated.
+Move any existing data to .wrangler/state and use --persist, or
+use --persist-to=./wrangler-local-state to keep using the old path.`
+    );
+  }
   let scriptReadyResolve;
   const scriptReadyPromise = new Promise(
     (promiseResolve) => scriptReadyResolve = promiseResolve
@@ -149928,7 +149947,8 @@ var Handler2 = async ({
         directory
       },
       forceLocal: true,
-      experimentalEnableLocalPersistence,
+      persist,
+      persistTo,
       showInteractiveDevSession: void 0,
       inspect: true,
       logLevel: "error",
@@ -154848,8 +154868,17 @@ function devOptions(yargs) {
     describe: "Enable node.js compatibility",
     type: "boolean"
   }).option("experimental-enable-local-persistence", {
-    describe: "Enable persistence for this session (only for local mode)",
+    describe: "Enable persistence for local mode (deprecated, use --persist)",
+    type: "boolean",
+    deprecated: true,
+    hidden: true
+  }).option("persist", {
+    describe: "Enable persistence for local mode, using default path: .wrangler/state",
     type: "boolean"
+  }).option("persist-to", {
+    describe: "Specify directory to use for local persistence (implies --persist)",
+    type: "string",
+    requiresArg: true
   }).option("live-reload", {
     hidden: true,
     type: "boolean"
@@ -154904,7 +154933,8 @@ async function startDev(args) {
       routes,
       getLocalPort,
       getInspectorPort,
-      cliDefines
+      cliDefines,
+      localPersistencePath
     } = await validateDevServerSettings(args, config);
     await sendMetricsEvent(
       "run dev",
@@ -154940,7 +154970,7 @@ async function startDev(args) {
         upstreamProtocol,
         localProtocol: args.localProtocol || configParam.dev.local_protocol,
         localUpstream: args["local-upstream"] || host,
-        enableLocalPersistence: args.experimentalEnableLocalPersistence || false,
+        localPersistencePath,
         liveReload: args.liveReload || false,
         accountId: configParam.account_id || getAccountFromCache()?.id,
         assetPaths,
@@ -154998,7 +155028,8 @@ async function startApiDev(args) {
     routes,
     getLocalPort,
     getInspectorPort,
-    cliDefines
+    cliDefines,
+    localPersistencePath
   } = await validateDevServerSettings(args, config);
   await sendMetricsEvent(
     "run dev (api)",
@@ -155031,7 +155062,7 @@ async function startApiDev(args) {
       upstreamProtocol,
       localProtocol: args.localProtocol || configParam.dev.local_protocol,
       localUpstream: args["local-upstream"] || host,
-      enableLocalPersistence: args.experimentalEnableLocalPersistence || false,
+      localPersistencePath,
       liveReload: args.liveReload || false,
       accountId: configParam.account_id || getAccountFromCache()?.id,
       assetPaths,
@@ -155161,6 +155192,14 @@ async function validateDevServerSettings(args, config) {
       "Enabling node.js compatibility mode for built-ins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
     );
   }
+  if (args.experimentalEnableLocalPersistence) {
+    logger.warn(
+      `--experimental-enable-local-persistence is deprecated.
+Move any existing data to .wrangler/state and use --persist, or
+use --persist-to=./wrangler-local-state to keep using the old path.`
+    );
+  }
+  const localPersistencePath = args.persistTo ? import_node_path33.default.resolve(process.cwd(), args.persistTo) : args.persist ? import_node_path33.default.resolve(config.configPath || process.cwd(), ".wrangler/state") : null;
   const cliDefines = args.define?.reduce((collectDefines, d) => {
     const [key2, ...value] = d.split(":");
     collectDefines[key2] = value.join("");
@@ -155175,7 +155214,8 @@ async function validateDevServerSettings(args, config) {
     zoneId,
     host,
     routes,
-    cliDefines
+    cliDefines,
+    localPersistencePath
   };
 }
 async function getBindingsAndAssetPaths(args, configParam) {