Small cleanup, added comments and some TODOs

Author: trasch

README.md

@@ -13,7 +13,7 @@ This package requires Swift 5.7 or higher (at least Xcode 13), and compiles on m
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/Outdooractive/PostgresConnectionPool.git", from: "0.5.1"),
+    .package(url: "https://github.com/Outdooractive/PostgresConnectionPool.git", from: "0.5.4"),
 ],
 targets: [
     .target(name: "MyTarget", dependencies: [
@@ -53,10 +53,10 @@ try await pool.connection(callback: { connection in
     try await connection.query(PostgresQuery(stringLiteral: "SELECT 1"), logger: logger)
 })
 
-// Generic object loading
-func fetchObjects<T: Decodable>(_ sql: String) async throws -> [T] {
+// With PostgresKit
+func fetchObjects<T: Decodable>(_ sql: SQLQueryString) async throws -> [T] {
     try await pool.connection({ connection in
-        return try await connection.sql().raw(SQLQueryString(stringLiteral: sql)).all(decoding: T.self)
+        return try await connection.sql().raw(sql).all(decoding: T.self)
     })
 }
 

Sources/PostgresConnectionPool/PoolConnection.swift

@@ -7,15 +7,20 @@ import PostgresNIO
 
 final class PoolConnection: Identifiable, Equatable {
 
-    private static var connectionId: Int = 0
+    // TODO: Serialize access
+    private(set) static var connectionId = 0
+    private(set) static var globalUsageCounter = 0
 
     private(set) var usageCounter = 0
 
     let id: Int
     var connection: PostgresConnection?
     var state: PoolConnectionState = .connecting {
         didSet {
-            if case .active = state { usageCounter += 1 }
+            if case .active = state {
+                usageCounter += 1
+                PoolConnection.globalUsageCounter += 1
+            }
         }
     }
 

Sources/PostgresConnectionPool/PoolConnectionState.swift

@@ -5,8 +5,14 @@
 import Foundation
 
 public enum PoolConnectionState: Equatable {
+
+    /// The connection is in use.
     case active(Date)
+    /// The connection is open and available.
     case available
+    /// The connection is closed and can't be used.
     case closed
+    /// The connection is currently being established.
     case connecting
+
 }

Sources/PostgresConnectionPool/PoolInfo.swift

@@ -9,19 +9,20 @@ public struct PoolInfo {
 
     /// Information about an open connection.
     public struct ConnectionInfo {
-        public var id: Int
-        public var name: String
-        public var usageCounter: Int
-        public var query: String?
-        public var queryRuntime: TimeInterval?
-        public var state: PoolConnectionState
+        public let id: Int
+        public let name: String
+        public let usageCounter: Int
+        public let query: String?
+        public let queryRuntime: TimeInterval?
+        public let state: PoolConnectionState
     }
 
-    public var name: String
-    public var openConnections: Int
-    public var activeConnections: Int
-    public var availableConnections: Int
+    public let name: String
+    public let openConnections: Int
+    public let activeConnections: Int
+    public let availableConnections: Int
+    public let usageCounter: Int
 
-    public var connections: [ConnectionInfo]
+    public let connections: [ConnectionInfo]
 
 }

Sources/PostgresConnectionPool/PostgresConnectionPool.swift

@@ -76,8 +76,7 @@ public actor PostgresConnectionPool {
     @discardableResult
     public func connection<T>(
         _ callback: (PostgresConnectionWrapper) async throws -> T)
-        async throws
-        -> T
+        async throws -> T
     {
         var poolConnection: PoolConnection?
 
@@ -189,6 +188,7 @@ public actor PostgresConnectionPool {
             openConnections: connections.count,
             activeConnections: connections.count - available.count,
             availableConnections: available.count,
+            usageCounter: PoolConnection.globalUsageCounter,
             connections: connections)
     }
 
@@ -426,6 +426,8 @@ public actor PostgresConnectionPool {
             logger.debug("[\(poolName)] Connection \(poolConnection.id) failed after \(connectionRuntime.rounded(toPlaces: 2))s: \(error)")
             poolConnection.state = .closed
 
+            // TODO: Don't just open a new connection, check first if this is a permanent error like wrong password etc.
+
             Task.detached { [weak self] in
                 await self?.openConnection()
             }

Sources/PostgresConnectionPool/PostgresConnectionWrapper.swift

@@ -89,6 +89,7 @@ public final class PostgresConnectionWrapper {
         decoder: PostgresDataDecoder = PostgresDataDecoder())
         -> SQLDatabase
     {
+        // TODO: Track the current query
         postgresConnection.sql(encoder: encoder, decoder: decoder)
     }