Skip to content

Make Logger thread-safe #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 26, 2025
Merged

Make Logger thread-safe #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1123bb3
Make Logger thread-safe
laevandus Sep 24, 2025
71fb463
Fix file header and add template
laevandus Sep 24, 2025
d585478
Fix linter errors
laevandus Sep 24, 2025
09b2cdc
Reduce to one lock
laevandus Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
295 changes: 206 additions & 89 deletions Sources/StreamCore/Logger/Logger.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,173 +130,290 @@ public struct LogSubsystem: OptionSet, CustomStringConvertible, Sendable {
}

public enum LogConfig {
private struct State {
var identifier: String = ""
var level: LogLevel = .error
var dateFormatter: DateFormatter = {
let df = DateFormatter()
df.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS"
return df
}()

var formatters: [LogFormatter] = []
var showDate: Bool = true
var showLevel: Bool = true
var showIdentifier: Bool = false
var showThreadName: Bool = true
var showFileName: Bool = true
var showLineNumber: Bool = true
var showFunctionName: Bool = true
var subsystems: LogSubsystem = .all

var destinationTypes: [LogDestination.Type] = if #available(iOS 14.0, *) {
[OSLogDestination.self]
} else {
[ConsoleLogDestination.self]
}

private var _destinations: [LogDestination]?

var destinations: [LogDestination] {
mutating get {
if let _destinations {
return _destinations
}
let newDestinations = destinationTypes.map {
$0.init(
identifier: identifier,
level: level,
subsystems: subsystems,
showDate: showDate,
dateFormatter: dateFormatter,
formatters: formatters,
showLevel: showLevel,
showIdentifier: showIdentifier,
showThreadName: showThreadName,
showFileName: showFileName,
showLineNumber: showLineNumber,
showFunctionName: showFunctionName
)
}
_destinations = newDestinations
return newDestinations
}
set {
_destinations = newValue
}
}

private var _logger: Logger?

var logger: Logger {
mutating get {
if let _logger {
return _logger
}
let logger = Logger(identifier: identifier, destinations: destinations)
_logger = logger
return logger
}
set {
_logger = newValue
}
}

mutating func invalidateLogger() {
_destinations = nil
_logger = nil
}
}

private static let _state = AllocatedUnfairLock<State>(State())

/// Identifier for the logger. Defaults to empty.
public nonisolated(unsafe) static var identifier = "" {
didSet {
invalidateLogger()
public static var identifier: String {
get {
_state.withLock { $0.identifier }
}
set {
_state.withLock {
$0.identifier = newValue
$0.invalidateLogger()
}
}
}

/// Output level for the logger.
public nonisolated(unsafe) static var level: LogLevel = .error {
didSet {
invalidateLogger()
public static var level: LogLevel {
get {
_state.withLock { $0.level }
}
set {
_state.withLock {
$0.level = newValue
$0.invalidateLogger()
}
}
}

/// Date formatter for the logger. Defaults to ISO8601
public nonisolated(unsafe) static var dateFormatter: DateFormatter = {
let df = DateFormatter()
df.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS"
return df
}() {
didSet {
invalidateLogger()
public static var dateFormatter: DateFormatter {
get {
_state.withLock { $0.dateFormatter }
}
set {
_state.withLock {
$0.dateFormatter = newValue
$0.invalidateLogger()
}
}
}

/// Log formatters to be applied in order before logs are outputted. Defaults to empty (no formatters).
/// Please see `LogFormatter` for more info.
public nonisolated(unsafe) static var formatters = [LogFormatter]() {
didSet {
invalidateLogger()
public static var formatters: [LogFormatter] {
get {
_state.withLock { $0.formatters }
}
set {
_state.withLock {
$0.formatters = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing date in logs
public nonisolated(unsafe) static var showDate = true {
didSet {
invalidateLogger()
public static var showDate: Bool {
get {
_state.withLock { $0.showDate }
}
set {
_state.withLock {
$0.showDate = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing log level in logs
public nonisolated(unsafe) static var showLevel = true {
didSet {
invalidateLogger()
public static var showLevel: Bool {
get {
_state.withLock { $0.showLevel }
}
set {
_state.withLock {
$0.showLevel = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing identifier in logs
public nonisolated(unsafe) static var showIdentifier = false {
didSet {
invalidateLogger()
public static var showIdentifier: Bool {
get {
_state.withLock { $0.showIdentifier }
}
set {
_state.withLock {
$0.showIdentifier = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing thread name in logs
public nonisolated(unsafe) static var showThreadName = true {
didSet {
invalidateLogger()
public static var showThreadName: Bool {
get {
_state.withLock { $0.showThreadName }
}
set {
_state.withLock {
$0.showThreadName = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing file name in logs
public nonisolated(unsafe) static var showFileName = true {
didSet {
invalidateLogger()
public static var showFileName: Bool {
get {
_state.withLock { $0.showFileName }
}
set {
_state.withLock {
$0.showFileName = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing line number in logs
public nonisolated(unsafe) static var showLineNumber = true {
didSet {
invalidateLogger()
public static var showLineNumber: Bool {
get {
_state.withLock { $0.showLineNumber }
}
set {
_state.withLock {
$0.showLineNumber = newValue
$0.invalidateLogger()
}
}
}

/// Toggle for showing function name in logs
public nonisolated(unsafe) static var showFunctionName = true {
didSet {
invalidateLogger()
public static var showFunctionName: Bool {
get {
_state.withLock { $0.showFunctionName }
}
set {
_state.withLock {
$0.showFunctionName = newValue
$0.invalidateLogger()
}
}
}

/// Subsystems for the logger
public nonisolated(unsafe) static var subsystems: LogSubsystem = .all {
didSet {
invalidateLogger()
public static var subsystems: LogSubsystem {
get {
_state.withLock { $0.subsystems }
}
set {
_state.withLock {
$0.subsystems = newValue
$0.invalidateLogger()
}
}
}

/// Destination types this logger will use.
///
/// Logger will initialize the destinations with its own parameters. If you want full control on the parameters, use `destinations` directly,
/// where you can pass parameters to destination initializers yourself.
public nonisolated(unsafe) static var destinationTypes: [LogDestination.Type] = Self.defaultDestinations {
didSet {
invalidateLogger()
public static var destinationTypes: [LogDestination.Type] {
get {
_state.withLock { $0.destinationTypes }
}
}

static var defaultDestinations: [LogDestination.Type] {
if #available(iOS 14.0, *) {
[OSLogDestination.self]
} else {
[ConsoleLogDestination.self]
set {
_state.withLock {
$0.destinationTypes = newValue
$0.invalidateLogger()
}
}
}

private nonisolated(unsafe) static var _destinations: [LogDestination]?

/// Destinations for the default logger. Please see `LogDestination`.
/// Defaults to only `ConsoleLogDestination`, which only prints the messages.
///
/// - Important: Other options in `ChatClientConfig.Logging` will not take affect if this is changed.
public static var destinations: [LogDestination] {
get {
if let destinations = _destinations {
return destinations
} else {
_destinations = destinationTypes.map {
$0.init(
identifier: identifier,
level: level,
subsystems: subsystems,
showDate: showDate,
dateFormatter: dateFormatter,
formatters: formatters,
showLevel: showLevel,
showIdentifier: showIdentifier,
showThreadName: showThreadName,
showFileName: showFileName,
showLineNumber: showLineNumber,
showFunctionName: showFunctionName
)
}
return _destinations!
}
_state.withLock { $0.destinations }
}
set {
invalidateLogger()
_destinations = newValue
_state.withLock {
// Order is important
$0.invalidateLogger()
$0.destinations = newValue
}
}
}

/// Underlying logger instance to control singleton.
private nonisolated(unsafe) static var _logger: Logger?

/// Logger instance to be used by StreamChat.
///
/// - Important: Other options in `LogConfig` will not take affect if this is changed.
public static var logger: Logger {
get {
if let logger = _logger {
return logger
} else {
_logger = Logger(identifier: identifier, destinations: destinations)
return _logger!
}
_state.withLock { $0.logger }
}
set {
_logger = newValue
_state.withLock { $0.logger = newValue }
}
}

/// Invalidates the current logger instance so it can be recreated.
private static func invalidateLogger() {
_logger = nil
_destinations = nil
static func reset() {
_state.withLock { $0 = State() }
}
}

Expand Down
10 changes: 10 additions & 0 deletions StreamCore.xcodeproj/xcshareddata/IDETemplateMacros.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>FILEHEADER</key>
<string>
// Copyright © ___YEAR___ Stream.io Inc. All rights reserved.
//</string>
</dict>
</plist>
Loading