Improve error logging (#2201)

* include request details in logger.report

* Abort support in Logger+report

* rename file

Sources/Development/routes.swift

@@ -163,9 +163,41 @@ public func routes(_ app: Application) throws {
         req.view.render("hello.txt", ["name": "world"])
     }
 
+    app.get("error") { req -> String in
+        throw TestError()
+    }
+
     app.get("secret") { (req) -> EventLoopFuture<String> in
         return Environment
             .secret(key: "PASSWORD_SECRET", fileIO: req.application.fileio, on: req.eventLoop)
             .unwrap(or: Abort(.badRequest))
     }
 }
+
+struct TestError: AbortError {
+    var status: HTTPResponseStatus {
+        .internalServerError
+    }
+
+    var reason: String {
+        "This is a test."
+    }
+
+    let file: String
+    let function: String
+    let line: Int
+
+    var source: ErrorSource? {
+        ErrorSource(file: self.file, function: self.function, line: self.line)
+    }
+
+    init(
+        file: String = #file,
+        function: String = #function,
+        line: Int = #line
+    ) {
+        self.file = file
+        self.function = function
+        self.line = line
+    }
+}

Sources/Vapor/Error/Abort.swift

@@ -35,19 +35,12 @@ public struct Abort: AbortError {
     public var function: String
 
     /// The line where the error is thrown
-    public var line: UInt
-
-    /// The column where the errror is thrown
-    public var column: UInt
+    public var line: Int
 
     /// Wrap this error's source location into a usable struct for
     /// the `AbortError` protocol.
     public var source: ErrorSource? {
-        return .init(file: self.file, line: self.line, function: self.function)
-    }
-
-    public var description: String {
-        return "Abort \(self.status.code): \(self.reason)"
+        ErrorSource(file: self.file, function: self.function, line: self.line)
     }
 
     /// Create a new `Abort`, capturing current source location info.
@@ -59,8 +52,7 @@ public struct Abort: AbortError {
         suggestedFixes: [String] = [],
         file: String = #file,
         function: String = #function,
-        line: UInt = #line,
-        column: UInt = #column
+        line: Int = #line
     ) {
         self.identifier = status.code.description
         self.headers = headers
@@ -69,6 +61,5 @@ public struct Abort: AbortError {
         self.file = file
         self.function = function
         self.line = line
-        self.column = column
     }
 }

Sources/Vapor/Error/AbortError.swift

@@ -23,10 +23,10 @@ public protocol AbortError: LocalizedError, CustomStringConvertible {
 
 public struct ErrorSource {
     public let file: String
-    public let line: UInt
     public let function: String
+    public let line: Int
 
-    public init(file: String = #file, line: UInt = #line, function: String = #function) {
+    public init(file: String = #file, function: String = #function, line: Int = #line) {
         self.file = file
         self.line = line
         self.function = function
@@ -39,6 +39,10 @@ extension AbortError {
         return [:]
     }
 
+    public var description: String {
+        return "\(Self.self) \(self.status.code): \(self.reason)"
+    }
+
     public var errorDescription: String? {
         return self.description
     }

Sources/Vapor/Logging/Logger+LogError.swift → Sources/Vapor/Logging/Logger+Report.swift

@@ -1,19 +1,22 @@
 extension Logger {
-    /// Reports an `Error` to this `Logger`, first checking if it is `Debuggable`
-    /// for improved debug info.
+    /// Reports an `Error` to this `Logger`.
     ///
     /// - parameters:
     ///     - error: `Error` to log.
-    ///     - verbose: If `true`, extra lines of debug information will be printed containing
-    ///                things like suggested fixes, possible causes, or other info.
-    ///                Defaults to `true`.
+    ///     - request: Optional `Request` associated with this error.
     public func report(
         error: Error,
-        verbose: Bool = true,
         file: String = #file,
         function: String = #function,
-        line: UInt = #line
+        line: Int = #line
     ) {
+        let source: ErrorSource?
+        if let abort = error as? AbortError {
+            source = abort.source
+        } else {
+            source = nil
+        }
+
         let reason: String
         switch error {
         case let localized as LocalizedError:
@@ -26,9 +29,9 @@ extension Logger {
         self.log(
             level: .error,
             .init(stringLiteral: reason),
-            file: file,
-            function: function,
-            line: line
+            file: source?.file ?? file,
+            function: source?.function ?? function,
+            line: numericCast(source?.line ?? line)
         )
     }
 }

Sources/Vapor/Middleware/ErrorMiddleware.swift

@@ -21,7 +21,6 @@ public final class ErrorMiddleware: Middleware {
             let status: HTTPResponseStatus
             let reason: String
             let headers: HTTPHeaders
-            let source: ErrorSource?
 
             // inspect the error type
             switch error {
@@ -30,29 +29,22 @@ public final class ErrorMiddleware: Middleware {
                 reason = abort.reason
                 status = abort.status
                 headers = abort.headers
-                source = abort.source
             case let error as LocalizedError where !environment.isRelease:
                 // if not release mode, and error is debuggable, provide debug
                 // info directly to the developer
                 reason = error.localizedDescription
                 status = .internalServerError
                 headers = [:]
-                source = nil
             default:
                 // not an abort error, and not debuggable or in dev mode
                 // just deliver a generic 500 to avoid exposing any sensitive error info
                 reason = "Something went wrong."
                 status = .internalServerError
                 headers = [:]
-                source = nil
             }
 
-            // Report with the values from the error
-            if let source = source {
-                req.logger.report(error: error, verbose: !environment.isRelease, file: source.file, function: source.function, line: source.line)
-            } else {
-                req.logger.report(error: error, verbose: !environment.isRelease)
-            }
+            // Report the error to logger.
+            req.logger.report(error: error)
 
             // create a Response with appropriate status
             let response = Response(status: status, headers: headers)