|
| 1 | +#if canImport(OSLog) |
| 2 | +import OSLog |
| 3 | + |
| 4 | +extension Logger { |
| 5 | + /// Logs a debug message with complete error chain description |
| 6 | + /// |
| 7 | + /// ```swift |
| 8 | + /// Logger().debug("Operation failed", error: error) |
| 9 | + /// ``` |
| 10 | + /// |
| 11 | + /// - Parameters: |
| 12 | + /// - message: The main log message |
| 13 | + /// - error: The error to include using its complete chain description for debugging |
| 14 | + public func debug(_ message: String, error: some Error) { |
| 15 | + let normalizedMessage = self.normalizeMessage(message) |
| 16 | + self.debug("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 17 | + } |
| 18 | + |
| 19 | + /// Logs an info message with complete error chain description |
| 20 | + /// |
| 21 | + /// ```swift |
| 22 | + /// Logger().info("User action failed", error: error) |
| 23 | + /// ``` |
| 24 | + /// |
| 25 | + /// - Parameters: |
| 26 | + /// - message: The main log message |
| 27 | + /// - error: The error to include using its complete chain description for debugging |
| 28 | + public func info(_ message: String, error: some Error) { |
| 29 | + let normalizedMessage = self.normalizeMessage(message) |
| 30 | + self.info("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 31 | + } |
| 32 | + |
| 33 | + /// Logs a notice with complete error chain description |
| 34 | + /// |
| 35 | + /// ```swift |
| 36 | + /// Logger().notice("Important operation failed", error: error) |
| 37 | + /// ``` |
| 38 | + /// |
| 39 | + /// - Parameters: |
| 40 | + /// - message: The main log message |
| 41 | + /// - error: The error to include using its complete chain description for debugging |
| 42 | + public func notice(_ message: String, error: some Error) { |
| 43 | + let normalizedMessage = self.normalizeMessage(message) |
| 44 | + self.notice("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 45 | + } |
| 46 | + |
| 47 | + /// Logs a warning with complete error chain description |
| 48 | + /// |
| 49 | + /// ```swift |
| 50 | + /// Logger().warning("Recoverable error occurred", error: error) |
| 51 | + /// ``` |
| 52 | + /// |
| 53 | + /// - Parameters: |
| 54 | + /// - message: The main log message |
| 55 | + /// - error: The error to include using its complete chain description for debugging |
| 56 | + public func warning(_ message: String, error: some Error) { |
| 57 | + let normalizedMessage = self.normalizeMessage(message) |
| 58 | + self.warning("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 59 | + } |
| 60 | + |
| 61 | + /// Logs an error message with complete error chain description |
| 62 | + /// |
| 63 | + /// ```swift |
| 64 | + /// Logger().error("Upload failed", error: error) |
| 65 | + /// ``` |
| 66 | + /// |
| 67 | + /// - Parameters: |
| 68 | + /// - message: The main log message |
| 69 | + /// - error: The error to include using its complete chain description for debugging |
| 70 | + public func error(_ message: String, error: some Error) { |
| 71 | + let normalizedMessage = self.normalizeMessage(message) |
| 72 | + self.error("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 73 | + } |
| 74 | + |
| 75 | + /// Logs a fault with complete error chain description |
| 76 | + /// |
| 77 | + /// ```swift |
| 78 | + /// Logger().fault("Critical system error", error: error) |
| 79 | + /// ``` |
| 80 | + /// |
| 81 | + /// - Parameters: |
| 82 | + /// - message: The main log message |
| 83 | + /// - error: The error to include using its complete chain description for debugging |
| 84 | + public func fault(_ message: String, error: some Error) { |
| 85 | + let normalizedMessage = self.normalizeMessage(message) |
| 86 | + self.fault("\(normalizedMessage):\n\(ErrorKit.errorChainDescription(for: error))") |
| 87 | + } |
| 88 | + |
| 89 | + /// Normalizes a log message by removing trailing punctuation and whitespace |
| 90 | + /// |
| 91 | + /// This ensures consistent formatting regardless of how the user writes the message: |
| 92 | + /// - "Upload failed" → "Upload failed" |
| 93 | + /// - "Upload failed:" → "Upload failed" |
| 94 | + /// - "Upload failed: " → "Upload failed" |
| 95 | + /// - "Upload failed." → "Upload failed" |
| 96 | + /// |
| 97 | + /// - Parameter message: The original message to normalize |
| 98 | + /// - Returns: The normalized message without trailing punctuation or whitespace |
| 99 | + private func normalizeMessage(_ message: String) -> String { |
| 100 | + return message.trimmingCharacters(in: .whitespacesAndNewlines) |
| 101 | + .trimmingCharacters(in: CharacterSet(charactersIn: ":")) |
| 102 | + } |
| 103 | +} |
| 104 | +#endif |
0 commit comments