Add swift-log

Author: Fernando Fernandes

Package.swift

@@ -15,13 +15,15 @@ let package = Package(
     ],
     dependencies: [
         // [Server-side Support] SwiftCrypto is a Linux-compatible port of Apple's CryptoKit library.
-        .package(url: "https://github.com/apple/swift-crypto.git", from: "2.0.0")
+        .package(url: "https://github.com/apple/swift-crypto.git", from: "2.0.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0")
     ],
     targets: [
         .target(
             name: "SwiftTrader",
             dependencies: [
-                .product(name: "Crypto", package: "swift-crypto")
+                .product(name: "Crypto", package: "swift-crypto"),
+                .product(name: "Logging", package: "swift-log")
             ]
         ),
         .testTarget(

Sources/SwiftTrader/Common/SwiftTraderLogger.swift

@@ -0,0 +1,46 @@
+//
+//  SwiftTraderLogger.swift
+//  
+//
+//  Created by Fernando Fernandes on 03.02.22.
+//
+
+import Foundation
+import Logging
+
+/// Logs information via Apple's `swift-log` package.
+public struct SwiftTraderLogger {
+    
+    // MARK: Properties
+    
+    var isLoggingEnabled: Bool
+    
+    // MARK: - Private Properties
+    
+    private let logger: Logger
+    
+    // MARK: - Lifecycle
+    
+    public init(label: String, isLoggingEnabled: Bool) {
+        self.logger = Logger(label: label)
+        self.isLoggingEnabled = isLoggingEnabled
+    }
+}
+
+// MARK: - Interface
+
+public extension SwiftTraderLogger {
+    
+    func log(level: Logger.Level = .info, message: @autoclosure () -> Logger.Message, isFlush: Bool) {
+        guard isLoggingEnabled else {
+            return
+        }
+        logger.log(level: level, message())
+        
+        // [Server-side support] (Vapor)
+        // Refer to https://github.com/vapor/vapor/issues/796
+        if isFlush {
+            fflush(stdout)
+        }
+    }
+}

Sources/SwiftTrader/Config/SwiftTraderSettingsProtocol.swift

@@ -0,0 +1,27 @@
+//
+//  SwiftTraderSettingsProtocol.swift
+//  
+//
+//  Created by Fernando Fernandes on 03.02.22.
+//
+
+import Foundation
+
+/// Conform to this protocol to provide/tweak default package settings.
+public protocol SwiftTraderSettings {
+    var networkRequestSettings: NetworkRequestSettings { get }
+}
+
+/// The default conformance/values of the `SwiftTraderSettings` protocol.
+public struct DefaultSwiftTraderSettings: SwiftTraderSettings {
+    
+    // MARK: - Properties
+    
+    public var networkRequestSettings: NetworkRequestSettings
+    
+    // MARK: - Lifecycle
+    
+    public init(networkRequestSettings: NetworkRequestSettings = DefaultNetworkRequestSettings()) {
+        self.networkRequestSettings = networkRequestSettings
+    }
+}

Sources/SwiftTrader/Network/Kucoin/AccountOverview/KucoinFuturesAccountOverviewRequest.swift

@@ -14,11 +14,18 @@ import FoundationNetworking
 ///
 /// https://docs.kucoin.com/futures/#account
 public struct KucoinFuturesAccountOverviewRequest: NetworkRequest {
-    
+
     // MARK: - Properties
 
     public typealias DecodableModel = KucoinFuturesAccountOverview
 
+    public var logger: SwiftTraderLogger {
+        SwiftTraderLogger(
+            label: "swift-trader.account-overview",
+            isLoggingEnabled: settings.isLoggingEnable
+        )
+    }
+    
     public var session: URLSession
 
     public var request: URLRequest {
@@ -31,8 +38,7 @@ public struct KucoinFuturesAccountOverviewRequest: NetworkRequest {
         }
     }
 
-    #warning("TODO: [CONFIG] number of retries")
-    public var numberOfRetries: Int { 3 }
+    public var settings: NetworkRequestSettings
 
     // MARK: Private
 
@@ -45,10 +51,14 @@ public struct KucoinFuturesAccountOverviewRequest: NetworkRequest {
     /// Creates a new `KucoinFuturesAccountOverviewRequest` instance.
     ///
     /// - Parameter session: `URLSession` instance, the default is `.shared`.
-    public init(session: URLSession = .shared, currencySymbol: CurrencySymbol = .USDT, kucoinAuth: KucoinAuth) {
+    public init(session: URLSession = .shared,
+                currencySymbol: CurrencySymbol = .USDT,
+                kucoinAuth: KucoinAuth,
+                settings: NetworkRequestSettings) {
         self.session = session
         self.currencySymbol = currencySymbol
         self.kucoinAuth = kucoinAuth
+        self.settings = settings
     }
 }
 

Sources/SwiftTrader/Network/NetworkRequest/NetworkRequestProtocol+Execution.swift

@@ -28,19 +28,17 @@ public extension NetworkRequest {
         } catch {
             return .failure(.invalidRequest(error: error))
         }
+        logger.log(message: "req... \(req)", isFlush: false)
+        logger.log(message: "FLUUUUSH", isFlush: true)
 #if os(macOS) || os(iOS)
         let result = await runOnApplePlatforms(request: req)
         switch result {
         case .success:
             return result
         case .failure:
-            if attemptNumber <= numberOfRetries {
-#warning("TODO: [CONFIG] Wait time between attempts")
-                // Delay the task by 2 seconds:
-                try? await Task.sleep(nanoseconds: 2_000_000_000)
-#warning("TODO: logger / enable, disable via config, default is ON")
-                print("Retrying... \(attemptNumber) of \(numberOfRetries)")
-                fflush(stdout)
+            if attemptNumber <= settings.numberOfRetries {
+                logger.log(message: "Retrying... \(attemptNumber) of \(settings.numberOfRetries)", isFlush: false)
+                try? await Task.sleep(nanoseconds: 1_000_000_000 * settings.delayBetweenRetries)
                 return await execute(attemptNumber: attemptNumber + 1)
             } else {
                 return result

Sources/SwiftTrader/Network/NetworkRequest/NetworkRequestProtocol.swift

@@ -9,15 +9,17 @@ import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking
 #endif
+import Logging
 
 public typealias NetworkRequestResult = Result<Decodable, NetworkRequestError>
 
 /// Represents a generic network request composed by basic functions that make a network request possible.
 public protocol NetworkRequest {
     associatedtype DecodableModel: Decodable
+    var logger: SwiftTraderLogger { get }
     var session: URLSession { get }
     var request: URLRequest { get throws }
-    var numberOfRetries: Int { get }
+    var settings: NetworkRequestSettings { get }
     func execute(attemptNumber: Int) async -> NetworkRequestResult
     func decode(_ data: Data) throws -> DecodableModel
 }

Sources/SwiftTrader/Network/NetworkRequest/NetworkRequestSettingsProtocol.swift

@@ -0,0 +1,35 @@
+//
+//  NetworkRequestSettings.swift
+//  
+//
+//  Created by Fernando Fernandes on 04.02.22.
+//
+
+import Foundation
+
+/// Conform to this protocol to provide/tweak default `NetworkRequest` settings.
+public protocol NetworkRequestSettings {
+    
+    /// `true` to enable logging of network requests.
+    var isLoggingEnable: Bool { get }
+    
+    /// The number of retries of failed `NetworkRequest`s.
+    var numberOfRetries: Int { get }
+
+    /// How many seconds to wait between each `NetworkRequestSettings.getter:numberOfRetries`.
+    var delayBetweenRetries: UInt64 { get }
+}
+
+/// The default conformance/values of the `NetworkRequestSettings` protocol.
+public struct DefaultNetworkRequestSettings: NetworkRequestSettings {
+    
+    // MARK: - Properties
+    
+    public var isLoggingEnable: Bool = true
+    public var numberOfRetries: Int = 3
+    public var delayBetweenRetries: UInt64 = 2
+    
+    // MARK: - Lifecycle
+    
+    public init() {}
+}

Sources/SwiftTrader/SwiftTrader.swift

@@ -12,12 +12,17 @@ public struct SwiftTrader {
 
     // MARK: - Properties
 
-    public let kucoinAuth: KucoinAuth
+    private let settings: SwiftTraderSettings
+    
+    // MARK: Private
+    
+    private let kucoinAuth: KucoinAuth
 
     // MARK: - Lifecycle
 
-    public init(kucoinAuth: KucoinAuth) {
+    public init(kucoinAuth: KucoinAuth, settings: SwiftTraderSettings = DefaultSwiftTraderSettings()) {
         self.kucoinAuth = kucoinAuth
+        self.settings = settings
     }
 }
 
@@ -26,7 +31,11 @@ public struct SwiftTrader {
 public extension SwiftTrader {
 
     func kucoinFuturesAccountOverview(currencySymbol: CurrencySymbol = .USDT) async throws -> Result<KucoinFuturesAccountOverview, SwiftTraderError> {
-        let request = KucoinFuturesAccountOverviewRequest(currencySymbol: currencySymbol, kucoinAuth: kucoinAuth)
+        let request = KucoinFuturesAccountOverviewRequest(
+            currencySymbol: currencySymbol,
+            kucoinAuth: kucoinAuth,
+            settings: settings.networkRequestSettings
+        )
         switch await request.execute() {
         case .success(let model):
             guard let futuresAccountOverview = model as? KucoinFuturesAccountOverview else {