Skip to content

Commit

Permalink
convert to struct Logger.Message from String
Browse files Browse the repository at this point in the history
  • Loading branch information
@weissi
weissi committed Feb 26, 2019
1 parent c693fb6 commit 306f432
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 17 deletions.
40 changes: 28 additions & 12 deletions Sources/Logging/Logging.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public protocol LogHandler {
// `Logger`'s `info`, `error`, or `warning` functions.
//
// An implementation does not need to check the log level because that has been done before by `Logger` itself.
func log(level: Logger.Level, message: String, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt)
func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt)

// This adds metadata to a place the concrete logger considers appropriate. Some loggers
// might not support this feature at all.
Expand Down Expand Up @@ -51,7 +51,7 @@ public struct Logger {

extension Logger {
@inlinable
public func log(level: Logger.Level, _ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func log(level: Logger.Level, _ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
if self.logLevel >= level {
self.handler.log(level: level, message: message(), metadata: metadata(), file: file, function: function, line: line)
}
Expand Down Expand Up @@ -91,42 +91,42 @@ extension Logger {

extension Logger {
@inlinable
public func debug(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func debug(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .debug, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func info(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func info(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .info, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func notice(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func notice(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .notice, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func warning(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func warning(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .warning, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func error(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func error(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .error, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func critical(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func critical(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .critical, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func alert(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func alert(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .alert, message(), metadata: metadata(), file: file, function: function, line: line)
}

@inlinable
public func emergency(_ message: @autoclosure () -> String, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
public func emergency(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.log(level: .emergency, message(), metadata: metadata(), file: file, function: function, line: line)
}
}
Expand Down Expand Up @@ -213,6 +213,22 @@ extension Logger.MetadataValue: Equatable {
}
}

extension Logger {
public struct Message: ExpressibleByStringLiteral, Equatable, CustomStringConvertible {
public typealias StringLiteralType = String

private var value: String

public init(stringLiteral value: String) {
self.value = value
}

public var description: String {
return self.value
}
}
}

/// Ships with the logging module, used to multiplex to multiple logging handlers
public class MultiplexLogHandler: LogHandler {
private let lock = Lock()
Expand All @@ -232,7 +248,7 @@ public class MultiplexLogHandler: LogHandler {
}
}

public func log(level: Logger.Level, message: String, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
public func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
self.handlers.forEach { handler in
handler.log(level: level, message: message, metadata: metadata, file: file, function: function, line: line)
}
Expand Down Expand Up @@ -292,7 +308,7 @@ internal struct StdoutLogHandler: LogHandler {
}
}

public func log(level: Logger.Level, message: String, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
public func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
let prettyMetadata = metadata?.isEmpty ?? true ? self.prettyMetadata : self.prettify(self.metadata.merging(metadata!, uniquingKeysWith: { _, new in new }))
print("\(self.timestamp()) \(level)\(prettyMetadata.map { " \($0)" } ?? "") \(message)")
}
Expand Down
4 changes: 2 additions & 2 deletions Tests/LoggingTests/LoggingTest.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class LoggingTest: XCTestCase {
"lazy": .stringConvertible(LazyMetadataBox({ "rendered-at-first-use" }))])
}

private func dontEvaluateThisString(file: StaticString = #file, line: UInt = #line) -> String {
private func dontEvaluateThisString(file: StaticString = #file, line: UInt = #line) -> Logger.Message {
XCTFail("should not have been evaluated", file: file, line: line)
return "should not have been evaluated"
}
Expand Down Expand Up @@ -182,7 +182,7 @@ class LoggingTest: XCTestCase {

func testCustomFactory() {
struct CustomHandler: LogHandler {
func log(level: Logger.Level, message: String, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {}
func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {}

subscript(metadataKey _: String) -> Logger.Metadata.Value? {
get { return nil }
Expand Down
6 changes: 3 additions & 3 deletions Tests/LoggingTests/TestLogger.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ internal struct TestLogHandler: LogHandler {
self.logger.logLevel = .debug
}

func log(level: Logger.Level, message: String, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata?, file: StaticString, function: StaticString, line: UInt) {
let metadata = (self._metadataSet ? self.metadata : MDC.global.metadata).merging(metadata ?? [:], uniquingKeysWith: { _, new in new })
var l = logger // local copy since we gonna override its metadata
l.metadata = metadata
Expand Down Expand Up @@ -125,9 +125,9 @@ internal class Recorder: History {
private let lock = NSLock()
private var _entries = [LogEntry]()

func record(level: Logger.Level, metadata: Logger.Metadata?, message: String) {
func record(level: Logger.Level, metadata: Logger.Metadata?, message: Logger.Message) {
return self.lock.withLock {
self._entries.append(LogEntry(level: level, metadata: metadata, message: message))
self._entries.append(LogEntry(level: level, metadata: metadata, message: message.description))
}
}

Expand Down

0 comments on commit 306f432

Please sign in to comment.