Support custom loggers with GRDB pool

Author: simolus3

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.13.0 (unreleased)
+
+* Add optional `logger` parameter on `openPowerSyncWithGRDB` to enable custom loggers.
+
 ## 1.12.0
 
 * Make raw tables easier to use:

Sources/PowerSyncGRDB/GRDBPowerSyncDatabase.swift

@@ -38,17 +38,20 @@ import PowerSync
 ///   - pool: The GRDB DatabasePool instance to use for storage
 ///   - schema: The PowerSync schema describing your sync views
 ///   - identifier: A unique identifier for this database instance
+///   - logger: An optional logger used for the PowerSync database.
 /// - Returns: A PowerSync database that works with the provided GRDB pool
 public func openPowerSyncWithGRDB(
     pool: DatabasePool,
     schema: Schema,
-    identifier: String
+    identifier: String,
+    logger: (any LoggerProtocol) = DefaultLogger()
 ) -> PowerSyncDatabaseProtocol {
     return OpenedPowerSyncDatabase(
         schema: schema,
         pool: GRDBConnectionPool(
             pool: pool
         ),
-        identifier: identifier
+        identifier: identifier,
+        logger: logger
     )
 }

Tests/PowerSyncGRDBTests/BasicTest.swift

@@ -44,6 +44,7 @@ final class GRDBTests: XCTestCase {
     private var database: PowerSyncDatabaseProtocol!
     private var schema: Schema!
     private var pool: DatabasePool!
+    private var logs: TestLogWriterAdapter!
 
     override func setUp() async throws {
         try await super.setUp()
@@ -83,10 +84,13 @@ final class GRDBTests: XCTestCase {
             configuration: config
         )
 
+        logs = TestLogWriterAdapter()
+        let logger = DefaultLogger(minSeverity: LogSeverity.debug, writers: [logs])
         database = openPowerSyncWithGRDB(
             pool: pool,
             schema: schema,
-            identifier: dbIdentifier
+            identifier: dbIdentifier,
+            logger: DatabaseLogger(logger)
         )
 
         try await database.disconnectAndClear()
@@ -417,4 +421,37 @@ final class GRDBTests: XCTestCase {
         await fulfillment(of: [expectation], timeout: 5)
         watchTask.cancel()
     }
+    
+    func testCustomLogger() async throws {
+        try await database.get("SELECT 1", mapper: { row in })
+
+        let warningIndex = logs.getLogs().firstIndex(
+            where: { value in
+                value.contains("debug: PowerSyncVersion")
+            }
+        )
+
+        XCTAssert(warningIndex! >= 0)
+    }
+}
+
+final class TestLogWriterAdapter: LogWriterProtocol,
+    // The shared state is guarded by the DispatchQueue
+    @unchecked Sendable
+{
+    private let queue = DispatchQueue(label: "TestLogWriterAdapter")
+
+    private var logs = [String]()
+
+    func getLogs() -> [String] {
+        queue.sync {
+            logs
+        }
+    }
+
+    func log(severity: LogSeverity, message: String, tag: String?) {
+        queue.sync {
+            logs.append("\(severity): \(message) \(tag != nil ? "\(tag!)" : "")")
+        }
+    }
 }