Make PSQLError public (#342)

Author: fabianfett

Sources/PostgresNIO/Connection/PostgresConnection.swift

@@ -283,7 +283,7 @@ public final class PostgresConnection: @unchecked Sendable {
                 case is PSQLError:
                     throw error
                 default:
-                    throw PSQLError.channel(underlying: error)
+                    throw PSQLError.connectionError(underlying: error)
                 }
             }
         }
@@ -312,7 +312,7 @@ public final class PostgresConnection: @unchecked Sendable {
         var logger = logger
         logger[postgresMetadataKey: .connectionID] = "\(self.id)"
         guard query.binds.count <= Int(UInt16.max) else {
-            return self.channel.eventLoop.makeFailedFuture(PSQLError.tooManyParameters)
+            return self.channel.eventLoop.makeFailedFuture(PSQLError(code: .tooManyParameters, query: query))
         }
 
         let promise = self.channel.eventLoop.makePromise(of: PSQLRowStream.self)
@@ -344,7 +344,7 @@ public final class PostgresConnection: @unchecked Sendable {
 
     func execute(_ executeStatement: PSQLExecuteStatement, logger: Logger) -> EventLoopFuture<PSQLRowStream> {
         guard executeStatement.binds.count <= Int(UInt16.max) else {
-            return self.channel.eventLoop.makeFailedFuture(PSQLError.tooManyParameters)
+            return self.channel.eventLoop.makeFailedFuture(PSQLError(code: .tooManyParameters))
         }
         let promise = self.channel.eventLoop.makePromise(of: PSQLRowStream.self)
         let context = ExtendedQueryContext(
@@ -493,14 +493,14 @@ extension PostgresConnection {
     public func query(
         _ query: PostgresQuery,
         logger: Logger,
-        file: String = #file,
+        file: String = #fileID,
         line: Int = #line
     ) async throws -> PostgresRowSequence {
         var logger = logger
         logger[postgresMetadataKey: .connectionID] = "\(self.id)"
 
         guard query.binds.count <= Int(UInt16.max) else {
-            throw PSQLError.tooManyParameters
+            throw PSQLError(code: .tooManyParameters, query: query, file: file, line: line)
         }
         let promise = self.channel.eventLoop.makePromise(of: PSQLRowStream.self)
         let context = ExtendedQueryContext(
@@ -511,7 +511,14 @@ extension PostgresConnection {
 
         self.channel.write(PSQLTask.extendedQuery(context), promise: nil)
 
-        return try await promise.futureResult.map({ $0.asyncSequence() }).get()
+        do {
+            return try await promise.futureResult.map({ $0.asyncSequence() }).get()
+        } catch var error as PSQLError {
+            error.file = file
+            error.line = line
+            error.query = query
+            throw error // rethrow with more metadata
+        }
     }
 }
 
@@ -530,7 +537,7 @@ extension PostgresConnection {
     public func query(
         _ query: PostgresQuery,
         logger: Logger,
-        file: String = #file,
+        file: String = #fileID,
         line: Int = #line
     ) -> EventLoopFuture<PostgresQueryResult> {
         self.queryStream(query, logger: logger).flatMap { rowStream in
@@ -540,7 +547,7 @@ extension PostgresConnection {
                 }
                 return PostgresQueryResult(metadata: metadata, rows: rows)
             }
-        }
+        }.enrichPSQLError(query: query, file: file, line: line)
     }
 
     /// Run a query on the Postgres server the connection is connected to and iterate the rows in a callback.
@@ -557,7 +564,7 @@ extension PostgresConnection {
     public func query(
         _ query: PostgresQuery,
         logger: Logger,
-        file: String = #file,
+        file: String = #fileID,
         line: Int = #line,
         _ onRow: @escaping (PostgresRow) throws -> ()
     ) -> EventLoopFuture<PostgresQueryMetadata> {
@@ -568,7 +575,7 @@ extension PostgresConnection {
                 }
                 return metadata
             }
-        }
+        }.enrichPSQLError(query: query, file: file, line: line)
     }
 }
 
@@ -785,3 +792,18 @@ extension PostgresConnection.InternalConfiguration {
         self.requireBackendKeyData = config.connection.requireBackendKeyData
     }
 }
+
+extension EventLoopFuture {
+    func enrichPSQLError(query: PostgresQuery, file: String, line: Int) -> EventLoopFuture<Value> {
+        return self.flatMapErrorThrowing { error in
+            if var error = error as? PSQLError {
+                error.file = file
+                error.line = line
+                error.query = query
+                throw error
+            } else {
+                throw error
+            }
+        }
+    }
+}

Sources/PostgresNIO/New/Connection State Machine/AuthenticationStateMachine.swift

@@ -51,7 +51,7 @@ struct AuthenticationStateMachine {
                 return .authenticated
             case .md5(let salt):
                 guard self.authContext.password != nil else {
-                    return self.setAndFireError(.authMechanismRequiresPassword)
+                    return self.setAndFireError(PSQLError(code: .authMechanismRequiresPassword))
                 }
                 self.state = .passwordAuthenticationSent
                 return .sendPassword(.md5(salt: salt), self.authContext)

Sources/PostgresNIO/New/Connection State Machine/ConnectionStateMachine.swift

@@ -1076,15 +1076,15 @@ extension ConnectionStateMachine {
 
 extension ConnectionStateMachine {
     func shouldCloseConnection(reason error: PSQLError) -> Bool {
-        switch error.base {
+        switch error.code.base {
         case .sslUnsupported:
             return true
         case .failedToAddSSLHandler:
             return true
         case .queryCancelled:
             return false
-        case .server(let message):
-            guard let sqlState = message.fields[.sqlState] else {
+        case .server:
+            guard let sqlState = error.serverInfo?[.sqlState] else {
                 // any error message that doesn't have a sql state field, is unexpected by default.
                 return true
             }
@@ -1095,7 +1095,7 @@ extension ConnectionStateMachine {
             }
 
             return false
-        case .decoding:
+        case .messageDecodingFailure:
             return true
         case .unexpectedBackendMessage:
             return true
@@ -1115,8 +1115,6 @@ extension ConnectionStateMachine {
             preconditionFailure("Pure client error, that is thrown directly and should never ")
         case .connectionError:
             return true
-        case .casting(_):
-            preconditionFailure("Pure client error, that is thrown directly in PSQLRows")
         case .uncleanShutdown:
             return true
         }
@@ -1142,7 +1140,7 @@ extension ConnectionStateMachine {
         self.state = .error(error)
 
         var action = ConnectionAction.CleanUpContext.Action.close
-        if case .uncleanShutdown = error.base {
+        if case .uncleanShutdown = error.code.base {
             action = .fireChannelInactive
         }