Actually support query logging (#326)

* Query logging now works as it's supposed to. Also update dependency minimums. * Use logging metadata for logging queries
vapor · May 29, 2024 · ac03d7c · ac03d7c
1 parent dd21809
commit ac03d7c
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 10 deletions.
diff --git a/Package.swift b/Package.swift
@@ -13,11 +13,11 @@ let package = Package(
         .library(name: "MySQLKit", targets: ["MySQLKit"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/vapor/mysql-nio.git", from: "1.7.1"),
-        .package(url: "https://github.com/vapor/sql-kit.git", from: "3.28.0"),
+        .package(url: "https://github.com/vapor/mysql-nio.git", from: "1.7.2"),
+        .package(url: "https://github.com/vapor/sql-kit.git", from: "3.29.3"),
         .package(url: "https://github.com/vapor/async-kit.git", from: "1.19.0"),
         .package(url: "https://github.com/apple/swift-crypto.git", "2.0.0" ..< "4.0.0"),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.64.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.65.0"),
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.26.0"),
     ],
     targets: [
@@ -47,6 +47,4 @@ let package = Package(
 var swiftSettings: [SwiftSetting] { [
     .enableUpcomingFeature("ConciseMagicFile"),
     .enableUpcomingFeature("ForwardTrailingClosures"),
-    .enableUpcomingFeature("DisableOutwardActorInference"),
-    .enableExperimentalFeature("StrictConcurrency=complete"),
 ] }
diff --git a/[email protected] b/[email protected]
@@ -13,11 +13,11 @@ let package = Package(
         .library(name: "MySQLKit", targets: ["MySQLKit"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/vapor/mysql-nio.git", from: "1.7.1"),
-        .package(url: "https://github.com/vapor/sql-kit.git", from: "3.29.2"),
+        .package(url: "https://github.com/vapor/mysql-nio.git", from: "1.7.2"),
+        .package(url: "https://github.com/vapor/sql-kit.git", from: "3.29.3"),
         .package(url: "https://github.com/vapor/async-kit.git", from: "1.19.0"),
         .package(url: "https://github.com/apple/swift-crypto.git", "2.0.0" ..< "4.0.0"),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.64.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.65.0"),
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.26.0"),
     ],
     targets: [

diff --git a/Sources/MySQLKit/MySQLDatabase+SQL.swift b/Sources/MySQLKit/MySQLDatabase+SQL.swift
@@ -10,9 +10,10 @@ extension MySQLDatabase {
     /// - Returns: An instance of `SQLDatabase` which accesses the same database as `self`.
     public func sql(
         encoder: MySQLDataEncoder = .init(),
-        decoder: MySQLDataDecoder = .init()
+        decoder: MySQLDataDecoder = .init(),
+        queryLogLevel: Logger.Level? = .debug
     ) -> any SQLDatabase {
-        MySQLSQLDatabase(database: .init(value: self), encoder: encoder, decoder: decoder)
+        MySQLSQLDatabase(database: .init(value: self), encoder: encoder, decoder: decoder, queryLogLevel: queryLogLevel)
     }
 }
 
@@ -40,10 +41,17 @@ private struct MySQLSQLDatabase<D: MySQLDatabase>: SQLDatabase {
     // See `SQLDatabase.dialect`.
     var dialect: any SQLDialect { MySQLDialect() }
 
+    // See `SQLDatabase.queryLogLevel`.
+    let queryLogLevel: Logger.Level?
+
     // See `SQLDatabase.execute(sql:_:)`.
     func execute(sql query: any SQLExpression, _ onRow: @escaping @Sendable (any SQLRow) -> ()) -> EventLoopFuture<Void> {
         let (sql, binds) = self.serialize(query)
 
+        if let queryLogLevel = self.queryLogLevel {
+            self.logger.log(level: queryLogLevel, "Executing query", metadata: ["sql": .string(sql), "binds": .array(binds.map { .string("\($0)") })])
+        }
+
         do {
             return try self.database.value.query(
                 sql,
@@ -59,6 +67,10 @@ private struct MySQLSQLDatabase<D: MySQLDatabase>: SQLDatabase {
     func execute(sql query: any SQLExpression, _ onRow: @escaping @Sendable (any SQLRow) -> ()) async throws {
         let (sql, binds) = self.serialize(query)
 
+        if let queryLogLevel = self.queryLogLevel {
+            self.logger.log(level: queryLogLevel, "Executing query", metadata: ["sql": .string(sql), "binds": .array(binds.map { .string("\($0)") })])
+        }
+
         return try await self.database.value.query(
             sql,
             binds.map { try self.encoder.encode($0) },