use resolved local config for remote deploy config diffing logic (#10393)

---------

Co-authored-by: Somhairle MacLeòid <[email protected]>

Author: dario-piotrowicz

.changeset/tender-beds-film.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Use resolved local config for remote deploy config diffing logic

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

@@ -13009,16 +13009,16 @@ export default{
 			await runWrangler("deploy --x-remote-diff-check");
 
 			expect(normalizeLogWithConfigDiff(std.warn)).toMatchInlineSnapshot(`
-				"[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mYour local configuration differs from the remote configuration of your Worker set via the Cloudflare Dashboard:[0m
+				"[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
 
-				      \\"name\\": \\"test-name\\",
-				      \\"main\\": \\"./index.js\\",
+				      \\"workers_dev\\": true,
+				      \\"preview_urls\\": true,
 				      \\"vars\\": {
 				  -     \\"MY_VAR\\": \\"abc\\"
 				  +     \\"MY_VAR\\": 123
 				      },
-				      \\"observability\\": {
-				        \\"enabled\\": true
+				      \\"define\\": {},
+				      \\"durable_objects\\": {
 
 				  Deploying the Worker will override the remote configuration with your local one.
 
@@ -13074,16 +13074,16 @@ export default{
 			//       to be able to show toml content/diffs, that combined with the fact that json(c) config files are the
 			//       recommended ones moving forward makes this small shortcoming of the config diffing acceptable
 			expect(normalizeLogWithConfigDiff(std.warn)).toMatchInlineSnapshot(`
-				"[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mYour local configuration differs from the remote configuration of your Worker set via the Cloudflare Dashboard:[0m
+				"[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
 
-				      \\"name\\": \\"test-name\\",
-				      \\"main\\": \\"./index.js\\",
+				      \\"workers_dev\\": true,
+				      \\"preview_urls\\": true,
 				      \\"vars\\": {
 				  -     \\"MY_VAR\\": \\"abc\\"
 				  +     \\"MY_VAR\\": \\"this is a toml file\\"
 				      },
-				      \\"observability\\": {
-				        \\"enabled\\": true
+				      \\"define\\": {},
+				      \\"durable_objects\\": {
 
 				  Deploying the Worker will override the remote configuration with your local one.
 

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

@@ -1,5 +1,5 @@
 import { getRemoteConfigDiff } from "../../deploy/config-diffs";
-import type { RawConfig } from "../../config";
+import type { Config, RawConfig } from "../../config";
 
 describe("getRemoteConfigsDiff", () => {
 	it("should handle a very simple diffing scenario (no diffs, random order)", () => {
@@ -25,7 +25,7 @@ describe("getRemoteConfigsDiff", () => {
 				tail_consumers: undefined,
 				observability: { enabled: true },
 				limits: undefined,
-			} as unknown as RawConfig
+			} as unknown as Config
 		);
 
 		expect(diff.toString()).toEqual("");
@@ -48,23 +48,23 @@ describe("getRemoteConfigsDiff", () => {
 			{
 				compatibility_date: "2025-07-09",
 				main: "/tmp/src/index.js",
-				compatibility_flags: undefined,
+				compatibility_flags: [],
 				name: "silent-firefly-dbe3",
 				workers_dev: true,
 				limits: undefined,
 				placement: undefined,
 				tail_consumers: undefined,
 				observability: { enabled: true, head_sampling_rate: 1 },
-			}
+			} as unknown as Config
 		);
 
 		expect(diff.toString()).toMatchInlineSnapshot(`
 			"  {
 			-   \\"compatibility_date\\": \\"2025-07-08\\",
 			+   \\"compatibility_date\\": \\"2025-07-09\\",
 			    \\"main\\": \\"/tmp/src/index.js\\",
-			    \\"name\\": \\"silent-firefly-dbe3\\",
-			    \\"workers_dev\\": true,"
+			    \\"compatibility_flags\\": [],
+			    \\"name\\": \\"silent-firefly-dbe3\\","
 		`);
 		expect(nonDestructive).toBe(false);
 	});
@@ -80,44 +80,43 @@ describe("getRemoteConfigsDiff", () => {
 				placement: undefined,
 				limits: undefined,
 				tail_consumers: undefined,
-				observability: { enabled: true, head_sampling_rate: 1 },
+				account_id: "account-id-123",
+				kv_namespaces: [{ binding: "MY_KV", id: "my-kv-123" }],
 			},
 			{
-				$schema: "node_modules/wrangler/config-schema.json",
 				name: "silent-firefly-dbe3",
 				main: "src/index.js",
 				compatibility_date: "2025-07-08",
-				observability: {
-					enabled: true,
-					head_sampling_rate: 1,
-					logs: {
-						head_sampling_rate: 0.95,
-						invocation_logs: true,
-					},
-				},
 				account_id: "account-id-123",
-				kv_namespaces: [{ binding: "MY_KV", id: "my-kv-123" }],
-			}
+				kv_namespaces: [
+					{ binding: "MY_KV", id: "my-kv-123" },
+					{ binding: "MY_KV_2", id: "my-kv-456" },
+				],
+			} as unknown as Config
 		);
 		expect(diff.toString()).toMatchInlineSnapshot(`
-			"    \\"compatibility_date\\": \\"2025-07-08\\",
-			    \\"observability\\": {
-			      \\"enabled\\": true,
-			-     \\"head_sampling_rate\\": 1
-			+     \\"head_sampling_rate\\": 1,
-			+     \\"logs\\": {
-			+       \\"head_sampling_rate\\": 0.95,
-			+       \\"invocation_logs\\": true
-			+     }
-			    },
-			-   \\"account_id\\": \\"account-id-123\\"
-			+   \\"account_id\\": \\"account-id-123\\",
-			+   \\"kv_namespaces\\": [
+			"      {
+			        \\"binding\\": \\"MY_KV\\",
+			        \\"id\\": \\"my-kv-123\\"
+			+     },
 			+     {
-			+       \\"binding\\": \\"MY_KV\\",
-			+       \\"id\\": \\"my-kv-123\\"
-			+     }
-			+   ]
+			+       \\"binding\\": \\"MY_KV_2\\",
+			+       \\"id\\": \\"my-kv-456\\"
+			      }
+			    ],
+			-   \\"workers_dev\\": true,
+			    \\"observability\\": {
+			      \\"enabled\\": false,
+			      \\"head_sampling_rate\\": 1,
+
+			  ...
+
+			        \\"head_sampling_rate\\": 1,
+			        \\"invocation_logs\\": true
+			      }
+			-   }
+			+   },
+			+   \\"workers_dev\\": true
 			  }"
 		`);
 		expect(nonDestructive).toBe(true);
@@ -138,28 +137,35 @@ describe("getRemoteConfigsDiff", () => {
 				kv_namespaces: [{ binding: "MY_KV", id: "my-kv-123" }],
 			},
 			{
-				$schema: "node_modules/wrangler/config-schema.json",
 				name: "silent-firefly-dbe3",
 				main: "src/index.js",
 				compatibility_date: "2025-07-09",
 				observability: {
 					enabled: false,
 				},
 				account_id: "account-id-123",
-			}
+			} as unknown as Config
 		);
 		expect(diff.toString()).toMatchInlineSnapshot(`
-			"    \\"$schema\\": \\"node_modules/wrangler/config-schema.json\\",
+			"  {
 			    \\"name\\": \\"silent-firefly-dbe3\\",
 			    \\"main\\": \\"src/index.js\\",
 			-   \\"compatibility_date\\": \\"2025-07-08\\",
 			+   \\"compatibility_date\\": \\"2025-07-09\\",
 			    \\"observability\\": {
-			-     \\"enabled\\": true
-			+     \\"enabled\\": false
+			-     \\"enabled\\": true,
+			+     \\"enabled\\": false,
+			      \\"head_sampling_rate\\": 1,
+			      \\"logs\\": {
+			        \\"enabled\\": false,
+
+			  ...
+
+			      }
 			    },
-			-   \\"account_id\\": \\"account-id-123\\",
-			+   \\"account_id\\": \\"account-id-123\\"
+			    \\"account_id\\": \\"account-id-123\\",
+			-   \\"workers_dev\\": true,
+			+   \\"workers_dev\\": true
 			-   \\"kv_namespaces\\": [
 			-     {
 			-       \\"binding\\": \\"MY_KV\\",
@@ -170,4 +176,108 @@ describe("getRemoteConfigsDiff", () => {
 		`);
 		expect(nonDestructive).toBe(false);
 	});
+
+	// The Observability field in the remote configuration has some specific behaviors, for that we have
+	// the following tests to make double sure to get these various observability cases right
+	// (note: this is however a best effort diffing since we cannot really perform a full one since we loose
+	// some information remotely for example `{ observability: { enabled: false, logs: { enabled: false, invocation_logs: false } }, }`
+	// remotely just becomes `undefined` completely loosing the fact that `logs` and `invocation_logs` were ever set)
+	describe("observability", () => {
+		function getObservabilityDiff(
+			remoteObservability: RawConfig["observability"],
+			localObservability: Config["observability"]
+		) {
+			return getRemoteConfigDiff(
+				{
+					observability: remoteObservability,
+					workers_dev: true,
+				},
+				{
+					observability: localObservability,
+				} as unknown as Config
+			);
+		}
+
+		it("should treat a remote undefined equal to a remote { enabled: false }", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely the observability field is undefined when observability is disabled
+				undefined,
+				{ enabled: false }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+		});
+
+		it("should treat a remote undefined equal to a remote { enabled: false, logs: { enabled: false } }", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely the observability field is undefined when observability is disabled
+				undefined,
+				{ enabled: false, logs: { enabled: false } }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+		});
+
+		it("should correctly show the diff of boolean when the remote is undefined and the local is { enabled: true }", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely the observability field is undefined when observability is disabled
+				undefined,
+				{ enabled: true }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`
+				"  {
+				    \\"observability\\": {
+				-     \\"enabled\\": false,
+				+     \\"enabled\\": true,
+				      \\"head_sampling_rate\\": 1,
+				      \\"logs\\": {
+				        \\"enabled\\": false,"
+			`);
+		});
+
+		it("should correctly show the diff of boolean when the remote is undefined and the local is { logs: { enabled: false } }", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely the observability field is undefined when observability is disabled
+				undefined,
+				{ logs: { enabled: true } }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`
+				"  {
+				    \\"observability\\": {
+				      \\"logs\\": {
+				-       \\"enabled\\": false,
+				+       \\"enabled\\": true,
+				        \\"head_sampling_rate\\": 1,
+				        \\"invocation_logs\\": true
+				      },"
+			`);
+		});
+
+		it("should correctly not show head_sampling_rate being added remotely", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely head_sampling_rate is set to 1 even if enabled is false
+				{ enabled: false, head_sampling_rate: 1, logs: { enabled: true } },
+				{ enabled: false, logs: { enabled: true, invocation_logs: true } }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`""`);
+		});
+
+		it("should correctly not show logs.invocation_logs being added remotely", () => {
+			const { diff } = getObservabilityDiff(
+				// remotely head_sampling_rate is set to 1 even if enabled is false
+				{
+					logs: { enabled: true, head_sampling_rate: 1, invocation_logs: true },
+				},
+				{ logs: { enabled: true, head_sampling_rate: 0.9 } }
+			);
+			expect(diff.toString()).toMatchInlineSnapshot(`
+				"    \\"observability\\": {
+				      \\"logs\\": {
+				        \\"enabled\\": true,
+				-       \\"head_sampling_rate\\": 1,
+				+       \\"head_sampling_rate\\": 0.9,
+				        \\"invocation_logs\\": true
+				      },
+				      \\"enabled\\": false,"
+			`);
+		});
+	});
 });