Slightly improve the way database queries are represented in logging metadata (#635)

Slightly improve the way database queries are represented in logging metadata. This has no visible impact when using the "default" StreamLogHandler, but it's quite visible with smarter log handlers.

Author: gwynne

Sources/FluentKit/Query/Database/DatabaseQuery+Range.swift

@@ -31,6 +31,15 @@ extension DatabaseQuery.Limit: CustomStringConvertible {
     }
 }
 
+extension DatabaseQuery.Limit {
+    var describedByLoggingMetadata: Logger.MetadataValue {
+        switch self {
+        case .count(let count): .stringConvertible(count)
+        default: "custom"
+        }
+    }
+}
+
 extension DatabaseQuery.Offset: CustomStringConvertible {
     public var description: String {
         switch self {
@@ -41,3 +50,12 @@ extension DatabaseQuery.Offset: CustomStringConvertible {
         }
     }
 }
+
+extension DatabaseQuery.Offset {
+    var describedByLoggingMetadata: Logger.MetadataValue {
+        switch self {
+        case .count(let count): .stringConvertible(count)
+        default: "custom"
+        }
+    }
+}

Sources/FluentKit/Query/Database/DatabaseQuery+Value.swift

@@ -36,10 +36,23 @@ extension DatabaseQuery.Value: CustomStringConvertible {
 
     var describedByLoggingMetadata: Logger.MetadataValue {
         switch self {
+        case .bind(let encodable):
+            // N.B.: `is` is used instead of `as?` here because the latter irreversibly loses the `Sendable`-ness of the value.
+            if encodable is any CustomStringConvertible {
+                .stringConvertible(encodable as! any CustomStringConvertible & Sendable)
+            } else {
+                .string(String(describing: encodable))
+            }
         case .dictionary(let d):
             .dictionary(.init(uniqueKeysWithValues: d.map { ($0.description, $1.describedByLoggingMetadata) }))
         case .array(let a):
             .array(a.map(\.describedByLoggingMetadata))
+        case .enumCase(let string):
+            .string(string)
+        case .null:
+            "nil"
+        case .default:
+            "<default>"
         default:
             .stringConvertible(self)
         }

Sources/FluentKit/Query/Database/DatabaseQuery.swift

@@ -72,15 +72,15 @@ extension DatabaseQuery: CustomStringConvertible {
         }
         switch self.action {
         case .read, .aggregate, .custom:
-            result["unique"] = "\(self.isUnique)"
+            result["unique"] = .stringConvertible(self.isUnique)
             result["fields"] = .array(self.fields.map(\.describedByLoggingMetadata))
             result["joins"] = .array(self.joins.map(\.describedByLoggingMetadata))
             fallthrough
         case .update, .delete:
             result["filters"] = .array(self.filters.map(\.describedByLoggingMetadata))
             result["sorts"] = .array(self.sorts.map(\.describedByLoggingMetadata))
-            result["limits"] = .array(self.limits.map { .stringConvertible($0) })
-            result["offsets"] = .array(self.offsets.map { .stringConvertible($0) })
+            result["limits"] = .array(self.limits.map(\.describedByLoggingMetadata))
+            result["offsets"] = .array(self.offsets.map(\.describedByLoggingMetadata))
         default: break
         }
         return result

Tests/FluentKitTests/TestUtilities.swift

@@ -39,7 +39,7 @@ func assertLastQuery(
 }
 
 func env(_ name: String) -> String? {
-    return ProcessInfo.processInfo.environment[name]
+    ProcessInfo.processInfo.environment[name]
 }
 
 let isLoggingConfigured: Bool = {