fix(cloudslog): don't over-redact fields

Due to a bug, messages with redacted fields were having all string fields redacted.
einride · Oct 21, 2024 · b7449a7 · b7449a7
1 parent 9dfb23e
commit b7449a7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/cloudslog/redact.go b/cloudslog/redact.go
@@ -40,7 +40,6 @@ func redact(input proto.Message) {
 			values.Index(-2).Value.Message().Set(last.Step.FieldDescriptor(), protoreflect.ValueOfString("<redacted>"))
 			return nil
 		}
-		values.Index(-2).Value.Message().Set(last.Step.FieldDescriptor(), protoreflect.ValueOfString("<redacted>"))
 		return nil
 	})
 }
diff --git a/cloudslog/redact_test.go b/cloudslog/redact_test.go
@@ -10,10 +10,23 @@ import (
 )
 
 func TestHandler_redact(t *testing.T) {
-	var b strings.Builder
-	logger := slog.New(newHandler(&b, LoggerConfig{}))
-	logger.Info("test", "example", &examplev1.ExampleMessage{
-		DebugRedactedField: "foobar",
+	t.Run("redacted field", func(t *testing.T) {
+		var b strings.Builder
+		logger := slog.New(newHandler(&b, LoggerConfig{}))
+		logger.Info("test", "example", &examplev1.ExampleMessage{
+			DebugRedactedField: "foobar",
+		})
+		assert.Assert(t, strings.Contains(b.String(), `"debugRedactedField":"<redacted>"`), b.String())
+	})
+
+	t.Run("redacted and non-redacted field", func(t *testing.T) {
+		var b strings.Builder
+		logger := slog.New(newHandler(&b, LoggerConfig{}))
+		logger.Info("test", "example", &examplev1.ExampleMessage{
+			DebugRedactedField: "foobar",
+			NonSensitiveField:  "baz",
+		})
+		assert.Assert(t, strings.Contains(b.String(), `"debugRedactedField":"<redacted>"`), b.String())
+		assert.Assert(t, strings.Contains(b.String(), `"nonSensitiveField":"baz"`), b.String())
 	})
-	assert.Assert(t, strings.Contains(b.String(), `"debugRedactedField":"<redacted>"`), b.String())
 }