Fix validation of the persist field of observability logs and traces (#11118)

Author: zebp

.changeset/violet-carrots-press.md

@@ -0,0 +1,6 @@
+---
+"@cloudflare/workers-utils": patch
+"wrangler": patch
+---
+
+Fix validation of the `persist` field of observability `logs` and `traces` configuration

packages/workers-utils/src/config/validation.ts

@@ -4373,6 +4373,15 @@ const validateObservability: ValidatorFn = (diagnostics, field, value) => {
 				"string"
 			) && isValid;
 
+		isValid =
+			validateOptionalProperty(
+				diagnostics,
+				field,
+				"logs.persist",
+				val.logs.persist,
+				"boolean"
+			) && isValid;
+
 		isValid =
 			validateAdditionalProperties(diagnostics, field, Object.keys(val.logs), [
 				"enabled",
@@ -4413,12 +4422,21 @@ const validateObservability: ValidatorFn = (diagnostics, field, value) => {
 				"string"
 			) && isValid;
 
+		isValid =
+			validateOptionalProperty(
+				diagnostics,
+				field,
+				"traces.persist",
+				val.traces.persist,
+				"boolean"
+			) && isValid;
+
 		isValid =
 			validateAdditionalProperties(
 				diagnostics,
 				field,
 				Object.keys(val.traces),
-				["enabled", "head_sampling_rate", "destinations"]
+				["enabled", "head_sampling_rate", "destinations", "persist"]
 			) && isValid;
 	}
 

packages/wrangler/src/__tests__/config/configuration.test.ts

@@ -1049,6 +1049,19 @@ describe("normalizeAndValidateConfig()", () => {
 				observability: {
 					enabled: true,
 					head_sampling_rate: 1,
+					logs: {
+						enabled: true,
+						head_sampling_rate: 1,
+						invocation_logs: true,
+						destinations: ["test"],
+						persist: true,
+					},
+					traces: {
+						enabled: true,
+						head_sampling_rate: 1,
+						destinations: ["test"],
+						persist: true,
+					},
 				},
 			};
 
@@ -1136,6 +1149,19 @@ describe("normalizeAndValidateConfig()", () => {
 				observability: {
 					enabled: "INVALID",
 					head_sampling_rate: "INVALID",
+					logs: {
+						enabled: "INVALID",
+						head_sampling_rate: "INVALID",
+						destinations: "INVALID",
+						persist: "INVALID",
+						invocation_logs: "INVALID",
+					},
+					traces: {
+						enabled: "INVALID",
+						head_sampling_rate: "INVALID",
+						destinations: "INVALID",
+						persist: "INVALID",
+					},
 				},
 			} as unknown as RawEnvironment;
 
@@ -1208,9 +1234,18 @@ describe("normalizeAndValidateConfig()", () => {
 				  - Expected \\"logpush\\" to be of type boolean but got \\"INVALID\\".
 				  - Expected \\"upload_source_maps\\" to be of type boolean but got \\"INVALID\\".
 				  - Expected \\"observability.enabled\\" to be of type boolean but got \\"INVALID\\".
-				  - Expected \\"observability.logs.enabled\\" to be of type boolean but got undefined.
-				  - Expected \\"observability.traces.enabled\\" to be of type boolean but got undefined.
-				  - Expected \\"observability.head_sampling_rate\\" to be of type number but got \\"INVALID\\"."
+				  - Expected \\"observability.logs.enabled\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"observability.traces.enabled\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"observability.head_sampling_rate\\" to be of type number but got \\"INVALID\\".
+				  - Expected \\"observability.logs.enabled\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"observability.logs.head_sampling_rate\\" to be of type number but got \\"INVALID\\".
+				  - Expected \\"observability.logs.invocation_logs\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"logs.destinations\\" to be an array of strings but got \\"INVALID\\"
+				  - Expected \\"observability.logs.persist\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"observability.traces.enabled\\" to be of type boolean but got \\"INVALID\\".
+				  - Expected \\"observability.traces.head_sampling_rate\\" to be of type number but got \\"INVALID\\".
+				  - Expected \\"traces.destinations\\" to be an array of strings but got \\"INVALID\\"
+				  - Expected \\"observability.traces.persist\\" to be of type boolean but got \\"INVALID\\"."
 			`);
 		});
 
@@ -6682,6 +6717,36 @@ describe("normalizeAndValidateConfig()", () => {
 				`);
 			});
 
+			it("should not warn on full observability config", () => {
+				const { diagnostics } = normalizeAndValidateConfig(
+					{
+						observability: {
+							enabled: true,
+							head_sampling_rate: 1,
+							logs: {
+								enabled: true,
+								head_sampling_rate: 1,
+								invocation_logs: true,
+								destinations: ["test"],
+								persist: true,
+							},
+							traces: {
+								enabled: true,
+								head_sampling_rate: 1,
+								destinations: ["test"],
+								persist: true,
+							},
+						},
+					} as unknown as RawConfig,
+					undefined,
+					undefined,
+					{ env: undefined }
+				);
+
+				expect(diagnostics.hasWarnings()).toBe(false);
+				expect(diagnostics.hasErrors()).toBe(false);
+			});
+
 			it("should error on invalid observability.logs", () => {
 				const { diagnostics } = normalizeAndValidateConfig(
 					{

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

@@ -14096,7 +14096,7 @@ export default{
 			`);
 		});
 
-		it("should allow uploading workers with nested observability logs setting", async () => {
+		it("should allow uploading workers with nested observability traces setting", async () => {
 			writeWranglerConfig({
 				observability: {
 					enabled: true,