Skip to content

Make logger shared state concurrency-safe #86

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

Open
kieran-osgood-shopify wants to merge 1 commit into
base: kieran-osgood/swift6/configure-only-checkoutkit-state
Choose a base branch
from
Open

Make logger shared state concurrency-safe #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions platforms/swift/Sources/ShopifyAcceleratedCheckouts/ShopifyAcceleratedCheckouts.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ public enum ShopifyAcceleratedCheckouts {

/// The logging level for Accelerated Checkouts operations
/// Default: .error - which will emit "error" and "fault" logs
public static var logLevel: LogLevel = .error {
didSet {
logger.logLevel = logLevel
public static var logLevel: LogLevel {
get {
logger.logLevel
}
set {
logger.logLevel = newValue
}
}

/// Shared logger for ShopifyAcceleratedCheckouts
/// To modify the logLevel
internal static var logger = OSLogger(prefix: name, logLevel: logLevel)
internal static let logger = OSLogger(prefix: name, logLevel: .error)
}
36 changes: 28 additions & 8 deletions platforms/swift/Sources/ShopifyCheckoutKit/Logger.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,39 @@ public enum LogLevel: String, CaseIterable {
case none
}

public class OSLogger {
public class OSLogger: @unchecked Sendable {
private let logger = OSLog(subsystem: subsystem, category: OSLog.Category.pointsOfInterest)
private var prefix: String
package var logLevel: LogLevel
private let prefix: String
private let logLevelStorage: LockedValue<LogLevel>

public static var shared = OSLogger()
package var logLevel: LogLevel {
get {
logLevelStorage.get()
}
set {
logLevelStorage.set(newValue)
}
}

private static let sharedLogger = LockedValue(OSLogger())

public static var shared: OSLogger {
get {
sharedLogger.get()
}
set {
sharedLogger.set(newValue)
}
}

public init() {
prefix = "ShopifyCheckoutKit"
logLevel = ShopifyCheckoutKit.configuration.logLevel
logLevelStorage = LockedValue(ShopifyCheckoutKit.configuration.logLevel)
}

public init(prefix: String, logLevel: LogLevel) {
self.prefix = prefix
self.logLevel = logLevel
logLevelStorage = LockedValue(logLevel)
}

public func debug(_ message: String) {
Expand Down Expand Up @@ -58,11 +76,13 @@ public class OSLogger {
}

private func shouldEmit(_ choice: LogLevel) -> Bool {
if logLevel == .none {
let currentLogLevel = logLevel

if currentLogLevel == .none {
return false
}

return logLevel == .all || logLevel == choice
return currentLogLevel == .all || currentLogLevel == choice
}
}

Expand Down
18 changes: 16 additions & 2 deletions platforms/swift/Tests/ShopifyCheckoutKitTests/LoggerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,23 @@ final class OSLoggerTests: XCTestCase {
XCTAssertNotNil(OSLogger.shared)
}

func test_defaultInitializer_withNoParameters_shouldMaintainBackwardsCompatibility() {
func test_defaultInitializer_withNoParameters_shouldUseConfigurationLogLevel() {
ShopifyCheckoutKit.configure { $0.logLevel = .debug }

let logger = OSLogger()
XCTAssertNotNil(logger)

XCTAssertEqual(logger.logLevel, .debug)
}

func test_sharedLogger_canBeReplaced() {
let originalLogger = OSLogger.shared
defer { OSLogger.shared = originalLogger }

let replacementLogger = OSLogger(prefix: "Replacement", logLevel: .debug)

OSLogger.shared = replacementLogger

XCTAssertTrue(OSLogger.shared === replacementLogger)
}

func test_logLevelNone_withAllLogCalls_shouldBlockAllLogging() {
Expand Down
7 changes: 0 additions & 7 deletions platforms/swift/api/ShopifyAcceleratedCheckouts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,6 @@
"mangledName": "$s27ShopifyAcceleratedCheckoutsAAO8logLevel0A11CheckoutKit03LogE0OvpZ",
"moduleName": "ShopifyAcceleratedCheckouts",
"static": true,
"declAttributes": [
"HasInitialValue",
"HasStorage"
],
"hasStorage": true,
"accessors": [
{
"kind": "Accessor",
Expand All @@ -154,7 +149,6 @@
"mangledName": "$s27ShopifyAcceleratedCheckoutsAAO8logLevel0A11CheckoutKit03LogE0OvgZ",
"moduleName": "ShopifyAcceleratedCheckouts",
"static": true,
"implicit": true,
"accessorKind": "get"
},
{
Expand All @@ -179,7 +173,6 @@
"mangledName": "$s27ShopifyAcceleratedCheckoutsAAO8logLevel0A11CheckoutKit03LogE0OvsZ",
"moduleName": "ShopifyAcceleratedCheckouts",
"static": true,
"implicit": true,
"accessorKind": "set"
}
]
Expand Down
39 changes: 17 additions & 22 deletions platforms/swift/api/ShopifyCheckoutKit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4521,10 +4521,6 @@
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC8logLevelAA03LogF0Ovp",
"moduleName": "ShopifyCheckoutKit",
"isInternal": true,
"declAttributes": [
"HasStorage"
],
"hasStorage": true,
"accessors": [
{
"kind": "Accessor",
Expand All @@ -4542,11 +4538,7 @@
"usr": "s:18ShopifyCheckoutKit8OSLoggerC8logLevelAA03LogF0Ovg",
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC8logLevelAA03LogF0Ovg",
"moduleName": "ShopifyCheckoutKit",
"implicit": true,
"isInternal": true,
"declAttributes": [
"Transparent"
],
"accessorKind": "get"
},
{
Expand All @@ -4570,11 +4562,7 @@
"usr": "s:18ShopifyCheckoutKit8OSLoggerC8logLevelAA03LogF0Ovs",
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC8logLevelAA03LogF0Ovs",
"moduleName": "ShopifyCheckoutKit",
"implicit": true,
"isInternal": true,
"declAttributes": [
"Transparent"
],
"accessorKind": "set"
}
]
Expand All @@ -4597,11 +4585,8 @@
"moduleName": "ShopifyCheckoutKit",
"static": true,
"declAttributes": [
"HasInitialValue",
"Final",
"HasStorage"
"Final"
],
"hasStorage": true,
"accessors": [
{
"kind": "Accessor",
Expand All @@ -4620,10 +4605,8 @@
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC6sharedACvgZ",
"moduleName": "ShopifyCheckoutKit",
"static": true,
"implicit": true,
"declAttributes": [
"Final",
"Transparent"
"Final"
],
"accessorKind": "get"
},
Expand All @@ -4649,10 +4632,8 @@
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC6sharedACvsZ",
"moduleName": "ShopifyCheckoutKit",
"static": true,
"implicit": true,
"declAttributes": [
"Final",
"Transparent"
"Final"
],
"accessorKind": "set"
}
Expand Down Expand Up @@ -4804,6 +4785,20 @@
"mangledName": "$s18ShopifyCheckoutKit8OSLoggerC",
"moduleName": "ShopifyCheckoutKit",
"conformances": [
{
"kind": "Conformance",
"name": "Sendable",
"printedName": "Sendable",
"usr": "s:s8SendableP",
"mangledName": "$ss8SendableP"
},
{
"kind": "Conformance",
"name": "SendableMetatype",
"printedName": "SendableMetatype",
"usr": "s:s16SendableMetatypeP",
"mangledName": "$ss16SendableMetatypeP"
},
{
"kind": "Conformance",
"name": "Copyable",
Expand Down
Loading