Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Metadata's description for prettier printing #2185

Merged
merged 9 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion Sources/GRPCCore/Metadata.swift
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,13 @@ extension Metadata.Value: ExpressibleByArrayLiteral {

extension Metadata: CustomStringConvertible {
public var description: String {
String(describing: self.map({ ($0.key, $0.value) }))
if self.isEmpty {
return "[:]"
} else {
let elements = self.map { "\(String(reflecting: $0.key)): \(String(reflecting: $0.value))" }
.joined(separator: ", ")
return "[\(elements)]"
}
}
}

Expand All @@ -508,3 +514,14 @@ extension Metadata.Value: CustomStringConvertible {
}
}
}

extension Metadata.Value: CustomDebugStringConvertible {
public var debugDescription: String {
switch self {
case .string(let stringValue):
return String(reflecting: stringValue)
case .binary(let binaryValue):
return String(reflecting: binaryValue)
}
}
}
30 changes: 30 additions & 0 deletions Tests/GRPCCoreTests/MetadataTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -314,4 +314,34 @@ struct MetadataTests {
)
}
}

@Suite("Description")
struct Description {
let metadata = Metadata([
"key1": "value1",
"key2": "value2",
"key-bin": .binary([1, 2, 3]),
])
gjcairo marked this conversation as resolved.
Show resolved Hide resolved

@Test("Metadata")
func describeMetadata() async throws {
#expect("\(self.metadata)" == #"["key1": "value1", "key2": "value2", "key-bin": [1, 2, 3]]"#)
}

@Test("Metadata.Value")
func describeMetadataValue() async throws {
for (key, value) in self.metadata {
switch key {
case "key1":
#expect("\(value)" == "value1")
case "key2":
#expect("\(value)" == "value2")
case "key-bin":
#expect("\(value)" == "[1, 2, 3]")
default:
Issue.record("Should not have reached this point")
}
}
}
}
}
Loading