Conform to CustomDebugStringConvertible for Debug only

Sources/SwiftProtobuf/ExtensionFields.swift

@@ -24,7 +24,7 @@
 // equality with some other extension field; but it's type-sealed
 // so you can't actually access the contained value itself.
 //
-public protocol AnyExtensionField: CustomDebugStringConvertible {
+public protocol AnyExtensionField {
   func hash(into hasher: inout Hasher)
   var protobufExtension: AnyMessageExtension { get }
   func isEqual(other: AnyExtensionField) -> Bool
@@ -74,12 +74,6 @@ public struct OptionalExtensionField<T: FieldType>: ExtensionField {
     self.value = value
   }
 
-  public var debugDescription: String {
-    get {
-      return String(reflecting: value)
-    }
-  }
-
   public func hash(into hasher: inout Hasher) {
     hasher.combine(value)
   }
@@ -112,6 +106,16 @@ public struct OptionalExtensionField<T: FieldType>: ExtensionField {
   }
 }
 
+#if DEBUG
+extension OptionalExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    get {
+      return String(reflecting: value)
+    }
+  }
+}
+#endif
+
 ///
 /// Repeated fields
 ///
@@ -140,10 +144,6 @@ public struct RepeatedExtensionField<T: FieldType>: ExtensionField {
     return self == o
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
-  }
-
   public mutating func decodeExtensionField<D: Decoder>(decoder: inout D) throws {
     try T.decodeRepeated(value: &value, from: &decoder)
   }
@@ -161,6 +161,14 @@ public struct RepeatedExtensionField<T: FieldType>: ExtensionField {
   }
 }
 
+#if DEBUG
+extension RepeatedExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
+  }
+}
+#endif
+
 ///
 /// Packed Repeated fields
 ///
@@ -192,10 +200,6 @@ public struct PackedExtensionField<T: FieldType>: ExtensionField {
     return self == o
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
-  }
-
   public mutating func decodeExtensionField<D: Decoder>(decoder: inout D) throws {
     try T.decodeRepeated(value: &value, from: &decoder)
   }
@@ -213,6 +217,14 @@ public struct PackedExtensionField<T: FieldType>: ExtensionField {
   }
 }
 
+#if DEBUG
+extension PackedExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
+  }
+}
+#endif
+
 ///
 /// Enum extensions
 ///
@@ -232,12 +244,6 @@ public struct OptionalEnumExtensionField<E: Enum>: ExtensionField where E.RawVal
     self.value = value
   }
 
-  public var debugDescription: String {
-    get {
-      return String(reflecting: value)
-    }
-  }
-
   public func hash(into hasher: inout Hasher) {
     hasher.combine(value)
   }
@@ -272,6 +278,16 @@ public struct OptionalEnumExtensionField<E: Enum>: ExtensionField where E.RawVal
   }
 }
 
+#if DEBUG
+extension OptionalEnumExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    get {
+      return String(reflecting: value)
+    }
+  }
+}
+#endif
+
 ///
 /// Repeated Enum fields
 ///
@@ -300,10 +316,6 @@ public struct RepeatedEnumExtensionField<E: Enum>: ExtensionField where E.RawVal
     return self == o
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
-  }
-
   public mutating func decodeExtensionField<D: Decoder>(decoder: inout D) throws {
     try decoder.decodeRepeatedEnumField(value: &value)
   }
@@ -323,6 +335,14 @@ public struct RepeatedEnumExtensionField<E: Enum>: ExtensionField where E.RawVal
   }
 }
 
+#if DEBUG
+extension RepeatedEnumExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
+  }
+}
+#endif
+
 ///
 /// Packed Repeated Enum fields
 ///
@@ -354,10 +374,6 @@ public struct PackedEnumExtensionField<E: Enum>: ExtensionField where E.RawValue
     return self == o
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
-  }
-
   public mutating func decodeExtensionField<D: Decoder>(decoder: inout D) throws {
     try decoder.decodeRepeatedEnumField(value: &value)
   }
@@ -377,6 +393,14 @@ public struct PackedEnumExtensionField<E: Enum>: ExtensionField where E.RawValue
   }
 }
 
+#if DEBUG
+extension PackedEnumExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
+  }
+}
+#endif
+
 //
 // ========== Message ==========
 //
@@ -397,12 +421,6 @@ public struct OptionalMessageExtensionField<M: Message & Equatable>:
     self.value = value
   }
 
-  public var debugDescription: String {
-    get {
-      return String(reflecting: value)
-    }
-  }
-
   public func hash(into hasher: inout Hasher) {
     value.hash(into: &hasher)
   }
@@ -440,6 +458,16 @@ public struct OptionalMessageExtensionField<M: Message & Equatable>:
   }
 }
 
+#if DEBUG
+extension OptionalMessageExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    get {
+      return String(reflecting: value)
+    }
+  }
+}
+#endif
+
 public struct RepeatedMessageExtensionField<M: Message & Equatable>:
   ExtensionField {
   public typealias BaseType = M
@@ -468,10 +496,6 @@ public struct RepeatedMessageExtensionField<M: Message & Equatable>:
     return self == o
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
-  }
-
   public mutating func decodeExtensionField<D: Decoder>(decoder: inout D) throws {
     try decoder.decodeRepeatedMessageField(value: &value)
   }
@@ -494,6 +518,14 @@ public struct RepeatedMessageExtensionField<M: Message & Equatable>:
   }
 }
 
+#if DEBUG
+extension RepeatedMessageExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{String(reflecting: $0)}.joined(separator: ",") + "]"
+  }
+}
+#endif
+
 //
 // ======== Groups within Messages ========
 //
@@ -521,8 +553,6 @@ public struct OptionalGroupExtensionField<G: Message & Hashable>:
     hasher.combine(value)
   }
 
-  public var debugDescription: String { get {return value.debugDescription} }
-
   public func isEqual(other: AnyExtensionField) -> Bool {
     let o = other as! OptionalGroupExtensionField<G>
     return self == o
@@ -556,6 +586,16 @@ public struct OptionalGroupExtensionField<G: Message & Hashable>:
   }
 }
 
+#if DEBUG
+extension OptionalGroupExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    get {
+      return value.debugDescription
+    }
+  }
+}
+#endif
+
 public struct RepeatedGroupExtensionField<G: Message & Hashable>:
   ExtensionField {
   public typealias BaseType = G
@@ -577,10 +617,6 @@ public struct RepeatedGroupExtensionField<G: Message & Hashable>:
     hasher.combine(value)
   }
 
-  public var debugDescription: String {
-    return "[" + value.map{$0.debugDescription}.joined(separator: ",") + "]"
-  }
-
   public func isEqual(other: AnyExtensionField) -> Bool {
     let o = other as! RepeatedGroupExtensionField<G>
     return self == o
@@ -607,3 +643,11 @@ public struct RepeatedGroupExtensionField<G: Message & Hashable>:
     return Internal.areAllInitialized(value)
   }
 }
+
+#if DEBUG
+extension RepeatedGroupExtensionField: CustomDebugStringConvertible {
+  public var debugDescription: String {
+    return "[" + value.map{$0.debugDescription}.joined(separator: ",") + "]"
+  }
+}
+#endif

Sources/SwiftProtobuf/Message.swift

@@ -31,7 +31,7 @@
 ///
 /// The actual functionality is implemented either in the generated code or in
 /// default implementations of the below methods and properties.
-public protocol Message: CustomDebugStringConvertible, _ProtoSendable {
+public protocol Message: _MessageBase {
   /// Creates a new message with all of its fields initialized to their default
   /// values.
   init()
@@ -112,6 +112,12 @@ public protocol Message: CustomDebugStringConvertible, _ProtoSendable {
   func isEqualTo(message: Message) -> Bool
 }
 
+#if DEBUG
+public protocol _MessageBase: _ProtoSendable, CustomDebugStringConvertible {}
+#else
+public protocol _MessageBase: _ProtoSendable {}
+#endif
+
 extension Message {
   /// Generated proto2 messages that contain required fields, nested messages
   /// that contain required fields, and/or extensions will provide their own
@@ -129,6 +135,7 @@ extension Message {
     hasher = visitor.hasher
   }
 
+  #if DEBUG
   /// A description generated by recursively visiting all fields in the message,
   /// including messages.
   public var debugDescription: String {
@@ -141,6 +148,7 @@ extension Message {
     let header = "\(className):\n"
     return header + textFormatString()
   }
+  #endif
 
   /// Creates an instance of the message type on which this method is called,
   /// executes the given block passing the message in as its sole `inout`

Sources/SwiftProtobuf/SimpleExtensionMap.swift

@@ -14,7 +14,7 @@
 
 
 // Note: The generated code only relies on ExpressibleByArrayLiteral
-public struct SimpleExtensionMap: ExtensionMap, ExpressibleByArrayLiteral, CustomDebugStringConvertible {
+public struct SimpleExtensionMap: ExtensionMap, ExpressibleByArrayLiteral {
     public typealias Element = AnyMessageExtension
 
     // Since type objects aren't Hashable, we can't do much better than this...
@@ -98,6 +98,10 @@ public struct SimpleExtensionMap: ExtensionMap, ExpressibleByArrayLiteral, Custo
         return out
     }
 
+}
+
+#if DEBUG
+extension SimpleExtensionMap: CustomDebugStringConvertible {
     public var debugDescription: String {
         var names = [String]()
         for (_, list) in fields {
@@ -108,5 +112,5 @@ public struct SimpleExtensionMap: ExtensionMap, ExpressibleByArrayLiteral, Custo
         let d = names.joined(separator: ",")
         return "SimpleExtensionMap(\(d))"
     }
-
 }
+#endif

Tests/SwiftProtobufTests/TestHelpers.swift

@@ -368,6 +368,26 @@ extension PBTestHelpers where MessageTestType: SwiftProtobuf.Message & Equatable
             // Yay! It failed!
         }
     }
+
+    func assertDebugDescription(_ expected: String, file: XCTestFileArgType = #file, line: UInt = #line, configure: (inout MessageTestType) -> ()) {
+        // `assertDebugDescription` is a no-op in release as `debugDescription` is unavailable.
+        #if DEBUG
+        var m = MessageTestType()
+        configure(&m)
+        let actual = m.debugDescription
+        XCTAssertEqual(actual, expected, file: file, line: line)
+        #endif
+    }
+}
+
+extension XCTestCase {
+    func assertDebugDescription(_ expected: String, _ m: SwiftProtobuf.Message, fmt: String? = nil, file: XCTestFileArgType = #file, line: UInt = #line) {
+        // `assertDebugDescription` is a no-op in release as `debugDescription` is unavailable.
+        #if DEBUG
+        let actual = m.debugDescription
+        XCTAssertEqual(actual, expected, fmt ?? "debugDescription did not match", file: file, line: line)
+        #endif
+    }
 }
 
 /// Protocol to help write visitor for testing.  It provides default implementaions