Add strict mode for the wrangler deploy command

dario-piotrowicz · dario-piotrowicz · commit df3ba2312f60 · 2025-09-25T11:52:37.000+01:00
diff --git a/.changeset/calm-camels-return.md b/.changeset/calm-camels-return.md
@@ -0,0 +1,7 @@
+---
+"wrangler": minor
+---
+
+Add strict mode for the `wrangler deploy` command
+
+Add a new flag: `--strict` that makes the `wrangler deploy` command be more strict/prudent and not deploy workers when such deployments can be potentially problematic. This "strict mode" currently only effects non-interactive sessions where conflicts with the remote settings for the worker (for example when the worker has been re-deployed via the dashboard) will cause the deployment to fail instead of automatically overriding the remote settings.
diff --git a/packages/wrangler/src/__tests__/deploy.test.ts b/packages/wrangler/src/__tests__/deploy.test.ts
@@ -14021,6 +14021,96 @@ export default{
 			return normalizedLog;
 		}
 	});
+
+	describe("with strict mode enabled", () => {
+		it("should error if there are remote config difference (with --x-remote-diff-check) in non-interactive mode", async () => {
+			setIsTTY(false);
+
+			writeWorkerSource();
+			mockGetServiceByName("test-name", "production", "dash");
+			writeWranglerConfig(
+				{
+					compatibility_date: "2024-04-24",
+					main: "./index.js",
+				},
+				"./wrangler.json"
+			);
+			mockSubDomainRequest();
+			mockUploadWorkerRequest();
+			mockGetServiceBindings("test-name", []);
+			mockGetServiceRoutes("test-name", []);
+			mockGetServiceCustomDomainRecords([]);
+			mockGetServiceSubDomainData("test-name", { enabled: true });
+			mockGetServiceSchedules("test-name", { schedules: [] });
+			mockGetServiceMetadata("test-name", {
+				created_on: "2025-08-07T09:34:47.846308Z",
+				modified_on: "2025-08-08T10:48:12.688997Z",
+				script: {
+					created_on: "2025-08-07T09:34:47.846308Z",
+					modified_on: "2025-08-08T10:48:12.688997Z",
+					id: "silent-firefly-dbe3",
+					observability: { enabled: true, head_sampling_rate: 1 },
+					compatibility_date: "2024-04-24",
+				},
+			} as unknown as ServiceMetadataRes["default_environment"]);
+
+			await runWrangler("deploy --x-remote-diff-check --strict");
+
+			expect(std.warn).toMatchInlineSnapshot(`
+				"[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mThe local configuration being used (generated from your local configuration file) differs from the remote configuration of your Worker set via the Cloudflare Dashboard:[0m
+
+				        \\"bindings\\": []
+				      },
+				      \\"observability\\": {
+				  -     \\"enabled\\": true,
+				  +     \\"enabled\\": false,
+				        \\"head_sampling_rate\\": 1,
+				        \\"logs\\": {
+				          \\"enabled\\": false,
+
+				  Deploying the Worker will override the remote configuration with your local one.
+
+				"
+			`);
+
+			expect(std.err).toMatchInlineSnapshot(`
+				"[31mX [41;31m[[41;97mERROR[41;31m][0m [1mAborting the deployment operation (due to strict mode, to prevent this failure either remove the \`--strict\` flag or add the \`--force\` one)[0m
+
+				"
+			`);
+			// note: the test and the wrangler run share the same process, and we expect the deploy command (which fails)
+			//       to set a non-zero exit code
+			expect(process.exitCode).not.toBe(0);
+		});
+
+		it("should error when worker was last deployed from api", async () => {
+			setIsTTY(false);
+
+			msw.use(...mswSuccessDeploymentScriptAPI);
+			writeWranglerConfig();
+			writeWorkerSource();
+			mockSubDomainRequest();
+			mockUploadWorkerRequest();
+
+			await runWrangler("deploy ./index --strict");
+
+			expect(std.warn).toMatchInlineSnapshot(`
+			"[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mYou are about to publish a Workers Service that was last updated via the script API.[0m
+
+			  Edits that have been made via the script API will be overridden by your local code and config.
+
+			"
+			`);
+			expect(std.err).toMatchInlineSnapshot(`
+				"[31mX [41;31m[[41;97mERROR[41;31m][0m [1mAborting the deployment operation (due to strict mode, to prevent this failure either remove the \`--strict\` flag or add the \`--force\` one)[0m
+
+				"
+			`);
+			// note: the test and the wrangler run share the same process, and we expect the deploy command (which fails)
+			//       to set a non-zero exit code
+			expect(process.exitCode).not.toBe(0);
+		});
+	});
 });
 
 /** Write mock assets to the file system so they can be uploaded. */
diff --git a/packages/wrangler/src/deploy/deploy.ts b/packages/wrangler/src/deploy/deploy.ts
@@ -23,7 +23,7 @@ import {
 import { noBundleWorker } from "../deployment-bundle/no-bundle-worker";
 import { validateNodeCompatMode } from "../deployment-bundle/node-compat";
 import { loadSourceMaps } from "../deployment-bundle/source-maps";
-import { confirm } from "../dialogs";
+import { confirm as genericConfirm } from "../dialogs";
 import { getMigrationsToUpload } from "../durable";
 import { getDockerPath } from "../environment-variables/misc-variables";
 import {
@@ -33,6 +33,7 @@ import {
 } from "../environments";
 import { UserError } from "../errors";
 import { getFlag } from "../experimental-flags";
+import { isNonInteractiveOrCI } from "../is-interactive";
 import { logger } from "../logger";
 import { getMetricsUsageHeaders } from "../metrics";
 import { isNavigatorDefined } from "../navigator-user-agent";
@@ -120,6 +121,8 @@ type Props = {
 	experimentalAutoCreate: boolean;
 	metafile: string | boolean | undefined;
 	containersRollout: "immediate" | "gradual" | undefined;
+	strict: boolean | undefined;
+	force: boolean | undefined;
 };
 
 export type RouteObject = ZoneIdRoute | ZoneNameRoute | CustomDomainRoute;
@@ -319,7 +322,7 @@ export async function publishCustomDomains(
 			const message = `Custom Domains already exist for these domains:
 ${existingRendered}
 Update them to point to this script instead?`;
-			if (!(await confirm(message))) {
+			if (!(await genericConfirm(message))) {
 				return fail();
 			}
 			options.override_existing_origin = true;
@@ -332,7 +335,7 @@ Update them to point to this script instead?`;
 			const message = `You already have DNS records that conflict for these Custom Domains:
 ${conflicitingRendered}
 Update them to point to this script instead?`;
-			if (!(await confirm(message))) {
+			if (!(await genericConfirm(message))) {
 				return fail();
 			}
 			options.override_existing_dns_record = true;
@@ -357,6 +360,8 @@ export default async function deploy(props: Props): Promise<{
 	workerTag: string | null;
 	targets?: string[];
 }> {
+	const deployConfirm = getDeployConfirmFunction(props.strict && !props.force);
+
 	// TODO: warn if git/hg has uncommitted changes
 	const { config, accountId, name, entry } = props;
 	let workerTag: string | null = null;
@@ -417,23 +422,23 @@ export default async function deploy(props: Props): Promise<{
 								`\n${configDiff.diff}\n\n` +
 								"Deploying the Worker will override the remote configuration with your local one."
 						);
-						if (!(await confirm("Would you like to continue?"))) {
+						if (!(await deployConfirm("Would you like to continue?"))) {
 							return { versionId, workerTag };
 						}
 					}
 				} else {
 					logger.warn(
 						`You are about to publish a Workers Service that was last published via the Cloudflare Dashboard.\nEdits that have been made via the dashboard will be overridden by your local code and config.`
 					);
-					if (!(await confirm("Would you like to continue?"))) {
+					if (!(await deployConfirm("Would you like to continue?"))) {
 						return { versionId, workerTag };
 					}
 				}
 			} else if (script.last_deployed_from === "api") {
 				logger.warn(
 					`You are about to publish a Workers Service that was last updated via the script API.\nEdits that have been made via the script API will be overridden by your local code and config.`
 				);
-				if (!(await confirm("Would you like to continue?"))) {
+				if (!(await deployConfirm("Would you like to continue?"))) {
 					return { versionId, workerTag };
 				}
 			}
@@ -1430,3 +1435,21 @@ export async function updateQueueConsumers(
 
 	return updateConsumers;
 }
+
+function getDeployConfirmFunction(
+	strictMode = false
+): (text: string) => Promise<boolean> {
+	const nonInteractive = isNonInteractiveOrCI();
+
+	if (nonInteractive && strictMode) {
+		return () => {
+			logger.error(
+				"Aborting the deployment operation (due to strict mode, to prevent this failure either remove the `--strict` flag or add the `--force` one)"
+			);
+			process.exitCode = 1;
+			return Promise.resolve(false);
+		};
+	}
+
+	return genericConfirm;
+}
diff --git a/packages/wrangler/src/deploy/index.ts b/packages/wrangler/src/deploy/index.ts
@@ -232,11 +232,24 @@ export const deployCommand = createCommand({
 			choices: ["immediate", "gradual"] as const,
 		},
 		"experimental-deploy-remote-diff-check": {
-			describe: `Experimental: Enable The Deployment Remote Diff check`,
+			describe: "Experimental: Enable The Deployment Remote Diff check",
 			type: "boolean",
 			hidden: true,
 			alias: ["x-remote-diff-check"],
 		},
+		strict: {
+			describe:
+				"Enables strict mode for the deploy command, this prevents deployments to occur when there are even small potential risks.",
+			type: "boolean",
+			default: false,
+		},
+		// TODO: check, if `--force` really necessary? users can just provide or not `--strict`, no?
+		force: {
+			describe:
+				"This flag can be used to disable strict mode (if set via `--strict`).",
+			type: "boolean",
+			default: false,
+		},
 	},
 	behaviour: {
 		useConfigRedirectIfAvailable: true,
@@ -251,7 +264,7 @@ export const deployCommand = createCommand({
 	validateArgs(args) {
 		if (args.nodeCompat) {
 			throw new UserError(
-				`The --node-compat flag is no longer supported as of Wrangler v4. Instead, use the \`nodejs_compat\` compatibility flag. This includes the functionality from legacy \`node_compat\` polyfills and natively implemented Node.js APIs. See https://developers.cloudflare.com/workers/runtime-apis/nodejs for more information.`,
+				"The --node-compat flag is no longer supported as of Wrangler v4. Instead, use the `nodejs_compat` compatibility flag. This includes the functionality from legacy `node_compat` polyfills and natively implemented Node.js APIs. See https://developers.cloudflare.com/workers/runtime-apis/nodejs for more information.",
 				{ telemetryMessage: true }
 			);
 		}
@@ -382,6 +395,8 @@ export const deployCommand = createCommand({
 			dispatchNamespace: args.dispatchNamespace,
 			experimentalAutoCreate: args.experimentalAutoCreate,
 			containersRollout: args.containersRollout,
+			strict: args.strict,
+			force: args.force,
 		});
 
 		writeOutput({
