Update errors to capture source

Author: Joannis

Sources/MySQL/Connection/PacketParser.swift

@@ -194,7 +194,7 @@ extension Packet {
         let length = try parser.parseUInt32()
 
         guard let fieldType = Field.FieldType(rawValue: try parser.byte()) else {
-            throw MySQLError(.invalidPacket)
+            throw MySQLError(.invalidPacket, source: .capture())
         }
 
         let flags = Field.Flags(rawValue: try parser.parseUInt16())

Sources/MySQL/Errors/Error.swift

@@ -1,6 +1,6 @@
 import Debugging
 
-public struct MySQLError : Swift.Error, Debuggable, Traceable, Helpable {
+public struct MySQLError : Swift.Error, Debuggable {
     public var possibleCauses: [String] {
         switch problem {
         case .invalidCredentials:
@@ -75,32 +75,21 @@ public struct MySQLError : Swift.Error, Debuggable, Traceable, Helpable {
     }
 
     /// Creates a new problem
-    init(_ problem: Problem,
-         file: String = #file,
-         function: String = #function,
-         line: UInt = #line,
-         column: UInt = #column
+    init(
+        _ problem: Problem,
+        source: SourceLocation
     ) {
         self.stackTrace = MySQLError.makeStackTrace()
-        self.file = file
-        self.function = function
-        self.line = line
-        self.column = column
+        self.sourceLocation = source
         self.problem = problem
     }
 
     init(
         packet: Packet,
-        file: String = #file,
-        function: String = #function,
-        line: UInt = #line,
-        column: UInt = #column
+        source: SourceLocation
     ) {
         self.stackTrace = MySQLError.makeStackTrace()
-        self.file = file
-        self.function = function
-        self.line = line
-        self.column = column
+        self.sourceLocation = source
 
         var parser = Parser(packet: packet, position: 1)
 
@@ -133,30 +122,15 @@ public struct MySQLError : Swift.Error, Debuggable, Traceable, Helpable {
     init(
         identifier: String,
         reason: String,
-        file: String = #file,
-        function: String = #function,
-        line: UInt = #line,
-        column: UInt = #column
+        sourceLocation: SourceLocation
     ) {
         self.problem = .other(identifier: identifier, reason: reason)
         self.stackTrace = MySQLError.makeStackTrace()
-        self.file = file
-        self.function = function
-        self.line = line
-        self.column = column
+        self.sourceLocation = sourceLocation
     }
 
-    /// The file this occurred in
-    public let file: String
-    
-    /// The function this occurred from
-    public let function: String
-    
-    /// The line this occurred at
-    public let line: UInt
-    
-    /// The column this occurred at
-    public let column: UInt
+    /// The location in Swift code this error originated from
+    public let sourceLocation: SourceLocation?
 
     /// Which problem
     internal let problem: Problem

Sources/MySQL/Internals/Connection+Handshake.swift

@@ -128,7 +128,7 @@ extension MySQLStateMachine {
             packet.sequenceId = self.sequenceId
             return packet
         } else {
-            throw MySQLError(.invalidHandshake)
+            throw MySQLError(.invalidHandshake, source: .capture())
         }
     }
 
@@ -151,7 +151,7 @@ extension MySQLStateMachine {
         switch packet.payload.first {
         case 0xfe:
             if packet.payload.count == 0 {
-                throw MySQLError(.invalidHandshake)
+                throw MySQLError(.invalidHandshake, source: .capture())
             } else {
                 var offset = 1
 
@@ -164,13 +164,13 @@ extension MySQLStateMachine {
                     let password = self.password,
                     let mechanism = String(bytes: packet.payload[1..<offset], encoding: .utf8)
                     else {
-                        throw MySQLError(.invalidHandshake)
+                        throw MySQLError(.invalidHandshake, source: .capture())
                 }
 
                 switch mechanism {
                 case "mysql_native_password":
                     guard offset &+ 2 < packet.payload.count else {
-                        throw MySQLError(.invalidHandshake)
+                        throw MySQLError(.invalidHandshake, source: .capture())
                     }
 
                     let hash = sha1Encrypted(from: password, seed: Array(packet.payload[(offset &+ 1)...]))
@@ -183,11 +183,11 @@ extension MySQLStateMachine {
                     packet.sequenceId = self.sequenceId
                     return packet
                 default:
-                    throw MySQLError(.invalidHandshake)
+                    throw MySQLError(.invalidHandshake, source: .capture())
                 }
             }
         case 0xff:
-            throw MySQLError(packet: packet)
+            throw MySQLError(packet: packet, source: .capture())
         default:
             // auth is finished, have the parser stream to the packet stream now
             return nil

Sources/MySQL/Internals/Handshake.swift

@@ -46,7 +46,7 @@ extension Packet {
 
         // Require decimal `10` to be the protocol version
         guard try parser.byte() == 10 else {
-            throw MySQLError(.invalidHandshake)
+            throw MySQLError(.invalidHandshake, source: .capture())
         }
 
         // UTF-8
@@ -58,11 +58,11 @@ extension Packet {
         }
 
         guard try parser.byte() == 0 else {
-            throw MySQLError(.invalidHandshake)
+            throw MySQLError(.invalidHandshake, source: .capture())
         }
 
         guard let serverVersion = String(bytes: serverVersionBuffer, encoding: .utf8) else {
-            throw MySQLError(.invalidHandshake)
+            throw MySQLError(.invalidHandshake, source: .capture())
         }
 
         // ID of the MySQL internal thread handling this connection
@@ -73,7 +73,7 @@ extension Packet {
 
         // null terminator of the random seed
         guard try parser.byte() == 0 else {
-            throw MySQLError(.invalidHandshake)
+            throw MySQLError(.invalidHandshake, source: .capture())
         }
 
         // capabilities + default collation
@@ -97,7 +97,7 @@ extension Packet {
             randomSeed.append(contentsOf: try parser.buffer(length: 12))
 
             guard try parser.byte() == 0 else {
-                throw MySQLError(.invalidHandshake)
+                throw MySQLError(.invalidHandshake, source: .capture())
             }
 
             if parser.position < payload.count &- 1 {

Sources/MySQL/Internals/MySQLStream.swift

@@ -98,7 +98,7 @@ struct EOF {
         var parser = Parser(packet: packet)
 
         guard try parser.byte() == 0xfe, packet.payload.count == 5 else {
-            throw MySQLError(.invalidPacket)
+            throw MySQLError(.invalidPacket, source: .capture())
         }
 
         self.flags = try parser.parseUInt16()

Sources/MySQL/Internals/Task.swift

@@ -20,7 +20,7 @@ struct StartHandshake: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet:packet, source: .capture())
         }
 
         let handshake = try context.doHandshake(from: packet)
@@ -46,7 +46,7 @@ struct SendHandshake: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet:packet, source: .capture())
         }
 
         guard let packet = try context.finishAuthentication(for: packet) else {
@@ -74,7 +74,7 @@ struct SendAuthentication: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet:packet, source: .capture())
         }
 
         _ = try packet.parseBinaryOK()
@@ -107,7 +107,7 @@ final class ParseResults: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet:packet, source: .capture())
         }
 
         guard let columnCount = columnCount else {
@@ -180,7 +180,7 @@ final class ParseResults: Task {
         let length = try parser.parseLenEnc()
 
         guard length < Int.max else {
-            throw MySQLError(.unexpectedResponse)
+            throw MySQLError(.unexpectedResponse, source: .capture())
         }
 
         self.columnCount = numericCast(length)
@@ -227,7 +227,7 @@ struct TextQuery: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet: packet, source: .capture())
         }
 
         return try parse.update(with: packet)
@@ -277,7 +277,7 @@ final class PrepareQuery: Task {
             // We cannot just throw an MySQLError here, because the supplied closure must fail,
             // otherways we are endup with hanging Future.
             // So we are bubble up the error to the supplied closure and end the Task
-            callback(nil, MySQLError(packet: packet))
+            callback(nil, MySQLError(packet: packet, source: .capture()))
             return true
         }
 
@@ -394,7 +394,7 @@ struct ResetPreparation: Task {
         /// Do not silence the error!
         /// FIXME: invalidate statement id if error.
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet: packet, source: .capture())
         }
         return true
     }
@@ -428,7 +428,7 @@ struct GetMore: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error!
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet: packet, source: .capture())
         }
         // FIXME: Implement binary resultset row parsing and pass it up!
         // The protocol is good, only need to implement it properly
@@ -464,7 +464,7 @@ struct ExecutePreparation: Task {
         // Incoming packet can be an error packet so fail fast
         // Do not silence the error
         guard packet.payload.first != 0xff else {
-            throw MySQLError(packet:packet)
+            throw MySQLError(packet: packet, source: .capture())
         }
         return try parse.update(with: packet)
     }

Sources/MySQL/Parsing/Packet+Response.swift

@@ -19,7 +19,7 @@ extension Packet {
         } else if byte == 0xfe {
             return (try parser.parseLenEnc(), try parser.parseLenEnc())
         } else if byte == 0xff {
-            throw MySQLError(packet: self)
+            throw MySQLError(packet: self, source: .capture())
         }
 
         return nil

Sources/MySQL/Parsing/ParsingHelpers.swift

@@ -23,7 +23,7 @@ struct Parser {
     /// Requires `n` amount of bytes or throws an error
     mutating func require(_ n: Int) throws {
         guard position &+ n <= packet.payload.count else {
-            throw MySQLError(.invalidPacket)
+            throw MySQLError(.invalidPacket, source: .capture())
         }
     }
 
@@ -75,7 +75,7 @@ struct Parser {
     /// Parses the length encoded integer
     mutating func parseLenEnc() throws -> UInt64 {
         guard position < self.payload.count else {
-            throw MySQLError(.invalidResponse)
+            throw MySQLError(.invalidResponse, source: .capture())
         }
 
         switch self.payload[position] {
@@ -92,7 +92,7 @@ struct Parser {
 
             return try parseUInt64()
         case 0xff:
-            throw MySQLError(packet: packet)
+            throw MySQLError(packet: packet, source: .capture())
         default:
             defer { position = position &+ 1 }
             return numericCast(self.payload[position])
@@ -119,7 +119,7 @@ struct Parser {
         let length = Int(try parseLenEnc())
 
         guard position &+ length <= self.payload.count else {
-            throw MySQLError(.invalidResponse)
+            throw MySQLError(.invalidResponse, source: .capture())
         }
 
         defer { position = position &+ length }