improve the diffing representation for wrangler deploy (run under --x-remote-diff-check)

Author: dario-piotrowicz

.changeset/silver-pears-wait.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+improve the diffing representation for `wrangler deploy` (run under `--x-remote-diff-check`)

packages/wrangler/package.json

@@ -95,6 +95,7 @@
 		"@types/glob-to-regexp": "^0.4.1",
 		"@types/is-ci": "^3.0.0",
 		"@types/javascript-time-ago": "^2.0.3",
+		"@types/json-diff": "^1.0.3",
 		"@types/mime": "^3.0.4",
 		"@types/minimatch": "^5.1.2",
 		"@types/node": "catalog:default",
@@ -128,6 +129,7 @@
 		"is-ci": "^3.0.1",
 		"itty-time": "^1.0.6",
 		"javascript-time-ago": "^2.5.4",
+		"json-diff": "^1.0.6",
 		"md5-file": "5.0.0",
 		"mime": "^3.0.0",
 		"minimatch": "^5.1.0",

packages/wrangler/src/__tests__/deploy.test.ts

@@ -14762,14 +14762,13 @@ export default{
 			expect(normalizeLogWithConfigDiff(std.warn)).toMatchInlineSnapshot(`
 				"▲ [WARNING] The local configuration being used (generated from your local configuration file) differs from the remote configuration of your Worker set via the Cloudflare Dashboard:
 
-				      \\"workers_dev\\": true,
-				      \\"preview_urls\\": false,
-				      \\"vars\\": {
-				  -     \\"MY_VAR\\": \\"abc\\"
-				  +     \\"MY_VAR\\": 123
-				      },
-				      \\"define\\": {},
-				      \\"durable_objects\\": {
+				   {
+				     vars: {
+				  -    MY_VAR: \\"abc\\"
+				  +    MY_VAR: 123
+				     }
+				   }
+
 
 				  Deploying the Worker will override the remote configuration with your local one.
 
@@ -14830,14 +14829,13 @@ export default{
 			expect(normalizeLogWithConfigDiff(std.warn)).toMatchInlineSnapshot(`
 				"▲ [WARNING] The local configuration being used (generated from your local configuration file) differs from the remote configuration of your Worker set via the Cloudflare Dashboard:
 
-				      \\"workers_dev\\": true,
-				      \\"preview_urls\\": false,
-				      \\"vars\\": {
-				  -     \\"MY_VAR\\": \\"abc\\"
-				  +     \\"MY_VAR\\": \\"this is a toml file\\"
-				      },
-				      \\"define\\": {},
-				      \\"durable_objects\\": {
+				   {
+				     vars: {
+				  -    MY_VAR: \\"abc\\"
+				  +    MY_VAR: \\"this is a toml file\\"
+				     }
+				   }
+
 
 				  Deploying the Worker will override the remote configuration with your local one.
 
@@ -14907,14 +14905,13 @@ export default{
 			expect(std.warn).toMatchInlineSnapshot(`
 				"▲ [WARNING] The local configuration being used (generated from your local configuration file) differs from the remote configuration of your Worker set via the Cloudflare Dashboard:
 
-				        \\"bindings\\": []
-				      },
-				      \\"observability\\": {
-				  -     \\"enabled\\": true,
-				  +     \\"enabled\\": false,
-				        \\"head_sampling_rate\\": 1,
-				        \\"logs\\": {
-				          \\"enabled\\": false,
+				   {
+				     observability: {
+				  -    enabled: true
+				  +    enabled: false
+				     }
+				   }
+
 
 				  Deploying the Worker will override the remote configuration with your local one.
 

packages/wrangler/src/__tests__/deploy/config-diffs.test.ts

@@ -29,7 +29,7 @@ describe("getRemoteConfigsDiff", () => {
 			} as unknown as Config
 		);
 
-		expect(diff.toString()).toEqual("");
+		expect(diff).toBe(null);
 		expect(nonDestructive).toBe(true);
 	});
 
@@ -60,13 +60,13 @@ describe("getRemoteConfigsDiff", () => {
 			} as unknown as Config
 		);
 
+		assert(diff);
 		expect(diff.toString()).toMatchInlineSnapshot(`
-			"  {
-			-   \\"compatibility_date\\": \\"2025-07-08\\",
-			+   \\"compatibility_date\\": \\"2025-07-09\\",
-			    \\"main\\": \\"/tmp/src/index.js\\",
-			    \\"compatibility_flags\\": [],
-			    \\"name\\": \\"silent-firefly-dbe3\\","
+			" {
+			-  compatibility_date: \\"2025-07-08\\"
+			+  compatibility_date: \\"2025-07-09\\"
+			 }
+			"
 		`);
 		expect(nonDestructive).toBe(false);
 	});
@@ -97,21 +97,65 @@ describe("getRemoteConfigsDiff", () => {
 				],
 			} as unknown as Config
 		);
+		assert(diff);
 		expect(diff.toString()).toMatchInlineSnapshot(`
-			"      {
-			        \\"binding\\": \\"MY_KV\\",
-			        \\"id\\": \\"my-kv-123\\"
-			+     },
-			+     {
-			+       \\"binding\\": \\"MY_KV_2\\",
-			+       \\"id\\": \\"my-kv-456\\"
-			      }
-			    ],
-			    \\"workers_dev\\": true,"
+			" {
+			   kv_namespaces: [
+			     ...
+			[32m+    {[39m
+			[32m+      binding: \\"MY_KV_2\\"[39m
+			[32m+      id: \\"my-kv-456\\"[39m
+			[32m+    }[39m
+			   ]
+			 }
+			"
 		`);
 		expect(nonDestructive).toBe(true);
 	});
 
+	it("should handle a diffing scenario with only deletions", () => {
+		const { diff, nonDestructive } = getRemoteConfigDiff(
+			{
+				name: "silent-firefly-dbe3",
+				main: "/tmp/src/index.js",
+				workers_dev: true,
+				preview_urls: false,
+				compatibility_date: "2025-07-08",
+				compatibility_flags: undefined,
+				placement: undefined,
+				limits: undefined,
+				tail_consumers: undefined,
+				account_id: "account-id-123",
+				kv_namespaces: [{ binding: "MY_KV", id: "my-kv-123" }],
+			},
+			{
+				name: "silent-firefly-dbe3",
+				main: "/tmp/src/index.js",
+				workers_dev: true,
+				preview_urls: false,
+				compatibility_date: "2025-07-08",
+				compatibility_flags: undefined,
+				placement: undefined,
+				limits: undefined,
+				tail_consumers: undefined,
+				account_id: "account-id-123",
+			} as unknown as Config
+		);
+		assert(diff);
+		expect(diff.toString()).toMatchInlineSnapshot(`
+			" {
+			-  kv_namespaces: [
+			-    {
+			-      binding: \\"MY_KV\\"
+			-      id: \\"my-kv-123\\"
+			-    }
+			-  ]
+			 }
+			"
+		`);
+		expect(nonDestructive).toBe(false);
+	});
+
 	it("should handle a diffing scenario with modifications and removals", () => {
 		const { diff, nonDestructive } = getRemoteConfigDiff(
 			{
@@ -137,33 +181,23 @@ describe("getRemoteConfigsDiff", () => {
 				account_id: "account-id-123",
 			} as unknown as Config
 		);
+		assert(diff);
 		expect(diff.toString()).toMatchInlineSnapshot(`
-			"  {
-			    \\"name\\": \\"silent-firefly-dbe3\\",
-			    \\"main\\": \\"src/index.js\\",
-			-   \\"compatibility_date\\": \\"2025-07-08\\",
-			+   \\"compatibility_date\\": \\"2025-07-09\\",
-			    \\"observability\\": {
-			-     \\"enabled\\": true,
-			+     \\"enabled\\": false,
-			      \\"head_sampling_rate\\": 1,
-			      \\"logs\\": {
-			        \\"enabled\\": false,
-
-			  ...
-
-			    },
-			    \\"account_id\\": \\"account-id-123\\",
-			    \\"workers_dev\\": true,
-			+   \\"preview_urls\\": false
-			-   \\"preview_urls\\": false,
-			-   \\"kv_namespaces\\": [
-			-     {
-			-       \\"binding\\": \\"MY_KV\\",
-			-       \\"id\\": \\"my-kv-123\\"
-			-     }
-			-   ]
-			  }"
+			" {
+			-  kv_namespaces: [
+			-    {
+			-      binding: \\"MY_KV\\"
+			-      id: \\"my-kv-123\\"
+			-    }
+			-  ]
+			-  compatibility_date: \\"2025-07-08\\"
+			+  compatibility_date: \\"2025-07-09\\"
+			   observability: {
+			-    enabled: true
+			+    enabled: false
+			   }
+			 }
+			"
 		`);
 		expect(nonDestructive).toBe(false);
 	});
@@ -196,7 +230,7 @@ describe("getRemoteConfigsDiff", () => {
 				undefined,
 				{ enabled: false }
 			);
-			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+			expect(diff).toBe(null);
 		});
 
 		it("should treat a remote undefined equal to a remote { enabled: false, logs: { enabled: false } }", () => {
@@ -205,7 +239,7 @@ describe("getRemoteConfigsDiff", () => {
 				undefined,
 				{ enabled: false, logs: { enabled: false } }
 			);
-			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+			expect(diff).toBe(null);
 		});
 
 		it("should correctly show the diff of boolean when the remote is undefined and the local is { enabled: true }", () => {
@@ -214,14 +248,15 @@ describe("getRemoteConfigsDiff", () => {
 				undefined,
 				{ enabled: true }
 			);
+			assert(diff);
 			expect(diff.toString()).toMatchInlineSnapshot(`
-				"  {
-				    \\"observability\\": {
-				-     \\"enabled\\": false,
-				+     \\"enabled\\": true,
-				      \\"head_sampling_rate\\": 1,
-				      \\"logs\\": {
-				        \\"enabled\\": false,"
+				" {
+				   observability: {
+				[31m-    enabled: false[39m
+				[32m+    enabled: true[39m
+				   }
+				 }
+				"
 			`);
 		});
 
@@ -231,15 +266,17 @@ describe("getRemoteConfigsDiff", () => {
 				undefined,
 				{ logs: { enabled: true } }
 			);
+			assert(diff);
 			expect(diff.toString()).toMatchInlineSnapshot(`
-				"  {
-				    \\"observability\\": {
-				      \\"logs\\": {
-				-       \\"enabled\\": false,
-				+       \\"enabled\\": true,
-				        \\"head_sampling_rate\\": 1,
-				        \\"invocation_logs\\": true
-				      },"
+				" {
+				   observability: {
+				     logs: {
+				-      enabled: false
+				+      enabled: true
+				     }
+				   }
+				 }
+				"
 			`);
 		});
 
@@ -249,7 +286,7 @@ describe("getRemoteConfigsDiff", () => {
 				{ enabled: false, head_sampling_rate: 1, logs: { enabled: true } },
 				{ enabled: false, logs: { enabled: true, invocation_logs: true } }
 			);
-			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+			expect(diff).toBe(null);
 		});
 
 		it("should correctly not show logs.invocation_logs being added remotely", () => {
@@ -260,15 +297,17 @@ describe("getRemoteConfigsDiff", () => {
 				},
 				{ logs: { enabled: true, head_sampling_rate: 0.9 } }
 			);
+			assert(diff);
 			expect(diff.toString()).toMatchInlineSnapshot(`
-				"    \\"observability\\": {
-				      \\"logs\\": {
-				        \\"enabled\\": true,
-				-       \\"head_sampling_rate\\": 1,
-				+       \\"head_sampling_rate\\": 0.9,
-				        \\"invocation_logs\\": true
-				      },
-				      \\"enabled\\": false,"
+				" {
+				   observability: {
+				     logs: {
+				-      head_sampling_rate: 1
+				+      head_sampling_rate: 0.9
+				     }
+				   }
+				 }
+				"
 			`);
 		});
 	});