Merge pull request #41 from GoodRequest/feature/remove-logger

Refactor Logging System and Enhance Session Configuration

Author: matusklasovity

GoodNetworking-Sample/GoodNetworking-Sample.xcodeproj/project.pbxproj

@@ -17,6 +17,7 @@
 		09A9ECA12C48115A0032C359 /* GoodSwiftUI in Frameworks */ = {isa = PBXBuildFile; productRef = 09A9ECA02C48115A0032C359 /* GoodSwiftUI */; };
 		09A9ECA32C4811B00032C359 /* UserListScreen.swift in Sources */ = {isa = PBXBuildFile; fileRef = 09A9ECA22C4811B00032C359 /* UserListScreen.swift */; };
 		09A9ECAE2C4AC9810032C359 /* JobUser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 09A9ECAD2C4AC9810032C359 /* JobUser.swift */; };
+		3F8799A12DF703B000B4286B /* SampleLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F8799A02DF703B000B4286B /* SampleLogger.swift */; };
 		5D4200142CBEE7ED006C4292 /* UserDefaultsExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5D4200132CBEE7ED006C4292 /* UserDefaultsExtensions.swift */; };
 		5D4200192CBF97CC006C4292 /* ServerPickerView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5D4200182CBF97CC006C4292 /* ServerPickerView.swift */; };
 		5D4A967C299C190B00DFAEAE /* GoodNetworking in Frameworks */ = {isa = PBXBuildFile; productRef = 5D4A967B299C190B00DFAEAE /* GoodNetworking */; };
@@ -35,6 +36,7 @@
 		09A9EC992C48015C0032C359 /* SampleEndpoint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SampleEndpoint.swift; sourceTree = "<group>"; };
 		09A9ECA22C4811B00032C359 /* UserListScreen.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserListScreen.swift; sourceTree = "<group>"; };
 		09A9ECAD2C4AC9810032C359 /* JobUser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JobUser.swift; sourceTree = "<group>"; };
+		3F8799A02DF703B000B4286B /* SampleLogger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SampleLogger.swift; sourceTree = "<group>"; };
 		5D4200132CBEE7ED006C4292 /* UserDefaultsExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserDefaultsExtensions.swift; sourceTree = "<group>"; };
 		5D4200182CBF97CC006C4292 /* ServerPickerView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ServerPickerView.swift; sourceTree = "<group>"; };
 		5D4A967A299C18FB00DFAEAE /* GoodNetworking */ = {isa = PBXFileReference; lastKnownFileType = wrapper; name = GoodNetworking; path = ..; sourceTree = "<group>"; };
@@ -92,6 +94,7 @@
 				09A9EC942C4800B90032C359 /* SampleNetworkSessions.swift */,
 				09A9EC992C48015C0032C359 /* SampleEndpoint.swift */,
 				5D7C80642CA2CDB900116E10 /* SampleSelectableBaseUrlProvider.swift */,
+				3F8799A02DF703B000B4286B /* SampleLogger.swift */,
 			);
 			path = Managers;
 			sourceTree = "<group>";
@@ -250,6 +253,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				09A9ECA32C4811B00032C359 /* UserListScreen.swift in Sources */,
+				3F8799A12DF703B000B4286B /* SampleLogger.swift in Sources */,
 				09A9EC9A2C48015C0032C359 /* SampleEndpoint.swift in Sources */,
 				09A9EC8F2C47FF8E0032C359 /* UserScreen.swift in Sources */,
 				EACEC3FA29953DCB008242AA /* AppDelegate.swift in Sources */,

GoodNetworking-Sample/GoodNetworking-Sample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -0,0 +1,26 @@
+//
+//  SampleLogger.swift
+//  GoodNetworking-Sample
+//
+//  Created by Matus Klasovity on 09/06/2025.
+//
+
+import Foundation
+import GoodNetworking
+
+struct SampleLogger: NetworkLogger {
+    
+    func logNetworkEvent(message: Any, level: LogLevel, fileName: String, lineNumber: Int) {
+        switch level {
+        case .debug:
+            print("[DEBUG] \(fileName):\(lineNumber) - \(message)")
+        case .info:
+            print("[INFO] \(fileName):\(lineNumber) - \(message)")
+        case .warning:
+            print("[WARNING] \(fileName):\(lineNumber) - \(message)")
+        case .error:
+            print("[ERROR] \(fileName):\(lineNumber) - \(message)")
+        }
+    }
+    
+}

GoodNetworking-Sample/GoodNetworking-Sample/Managers/SampleLogger.swift

@@ -35,7 +35,11 @@ extension NetworkSession {
         let urlProvider = CustomBaseUrlProvider(serverCollection: prodServerCollection)
         #endif
         baseURLProvider = urlProvider
-        NetworkSession.sampleSession = NetworkSession(baseUrl: urlProvider)
+        NetworkSession.sampleSession = NetworkSession(
+            baseUrl: urlProvider,
+            configuration: .default(logger: SampleLogger()),
+            logger: SampleLogger()
+        )
     }
 
 }

GoodNetworking-Sample/GoodNetworking-Sample/Managers/SampleNetworkSessions.swift

@@ -13,7 +13,11 @@ struct UserListScreen: View {
 
     // MARK: - State
 
-    @State private var users = Resource(session: .sampleSession, remote: RemoteUser.self)
+    @State private var users = Resource(
+        session: .sampleSession,
+        remote: RemoteUser.self,
+        logger: SampleLogger()
+    )
     @State private var didLoadList = false
     @State private var presentServerSettings = false
 

GoodNetworking-Sample/GoodNetworking-Sample/Screens/UserListScreen.swift

@@ -24,7 +24,6 @@ let package = Package(
         .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.10.0")),
         .package(url: "https://github.com/Alamofire/AlamofireImage.git", .upToNextMajor(from: "4.2.0")),
         .package(url: "https://github.com/KittyMac/Sextant.git", .upToNextMinor(from: "0.4.31")),
-        .package(url: "https://github.com/GoodRequest/GoodLogger.git", .upToNextMajor(from: "1.2.4"))
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -35,7 +34,6 @@ let package = Package(
                 .product(name: "Alamofire", package: "Alamofire"),
                 .product(name: "AlamofireImage", package: "AlamofireImage"),
                 .product(name: "Sextant", package: "Sextant"),
-                .product(name: "GoodLogger", package: "GoodLogger")
             ],
             path: "./Sources/GoodNetworking",
             resources: [.copy("PrivacyInfo.xcprivacy")],

Package.resolved

@@ -278,5 +278,31 @@ struct RemoteUser: Readable {
 ```
 And voila, all is setup. You can update the user directly with a state variable. The library also support all the CRUD operations with protocols `Creatable`, `Readable`, `Updatable`, `Deletable` and also more like `Listable` for pagination of lists. 
 
+## Logging
+```swift
+struct SampleLogger: NetworkLogger {
+
+    func logNetworkEvent(message: Any, level: LogLevel, fileName: String, lineNumber: Int) {
+        switch level {
+        case .debug:
+            print("[DEBUG] \(fileName):\(lineNumber) - \(message)")
+        case .info:
+            print("[INFO] \(fileName):\(lineNumber) - \(message)")
+        case .warning:
+            print("[WARNING] \(fileName):\(lineNumber) - \(message)")
+        case .error:
+            print("[ERROR] \(fileName):\(lineNumber) - \(message)")
+        }
+    }
+
+}
+
+NetworkSession.sampleSession = NetworkSession(
+    baseUrl: urlProvider,
+    configuration: .default(logger: SampleLogger()),
+    logger: SampleLogger()
+)
+```
+
 ## License
 GoodNetworking is released under the MIT license. See [LICENSE](LICENSE.md) for details.

Package.swift

@@ -7,7 +7,6 @@
 
 import Alamofire
 import Foundation
-import GoodLogger
 
 /// A request executor that deduplicates concurrent requests and provides caching capabilities.
 ///
@@ -37,27 +36,17 @@ public final actor DeduplicatingRequestExecutor: RequestExecuting, Sendable, Ide
     /// A dictionary storing currently running or cached request tasks
     public static var runningRequestTasks: [String: ExecutorTask] = [:]
 
-    /// A private property that provides the appropriate logger based on the iOS version.
-    ///
-    /// For iOS 14 and later, it uses `OSLogLogger`. For earlier versions, it defaults to `PrintLogger`.
-    private var logger: GoodLogger
+    /// A private property that provides the logger.
+    private var logger: NetworkLogger?
 
     /// Creates a new deduplicating request executor.
     ///
     /// - Parameters:
     ///   - taskId: A unique identifier for deduplicating requests
     ///   - cacheTimeout: The duration in seconds for which successful responses are cached. Defaults to 6 seconds.
     ///                   Set to 0 to disable caching.
-    public init(taskId: String? = nil, cacheTimeout: TimeInterval = 6, logger: GoodLogger? = nil) {
-        if let logger {
-            self.logger = logger
-        } else {
-            if #available(iOS 14, *) {
-                self.logger = OSLogLogger(logMetaData: false)
-            } else {
-                self.logger = PrintLogger(logMetaData: false)
-            }
-        }
+    public init(taskId: String? = nil, cacheTimeout: TimeInterval = 6, logger: NetworkLogger? = nil) {
+        self.logger = logger
         self.taskId = taskId
         self.cacheTimeout = cacheTimeout
     }
@@ -97,7 +86,7 @@ public final actor DeduplicatingRequestExecutor: RequestExecuting, Sendable, Ide
             }
 
             if let runningTask = DeduplicatingRequestExecutor.runningRequestTasks[taskId] {
-                logger.log(message: "🚀 taskId: \(taskId) Cached value used", level: .info)
+                logger?.logNetworkEvent(message: "🚀 taskId: \(taskId) Cached value used", level: .info, fileName: #file, lineNumber: #line)
                 return await runningTask.task.value
             } else {
                 let requestTask = ExecutorTask.TaskType {
@@ -116,7 +105,7 @@ public final actor DeduplicatingRequestExecutor: RequestExecuting, Sendable, Ide
                     }
                 }
 
-                logger.log(message: "🚀 taskId: \(taskId): Task created", level: .info)
+                logger?.logNetworkEvent(message: "🚀 taskId: \(taskId): Task created", level: .info, fileName: #file, lineNumber: #line)
 
                 let executorTask: ExecutorTask = ExecutorTask(
                     taskId: taskId,
@@ -129,7 +118,7 @@ public final actor DeduplicatingRequestExecutor: RequestExecuting, Sendable, Ide
                 let dataResponse = await requestTask.value
                 switch dataResponse.result {
                 case .success:
-                    logger.log(message: "🚀 taskId: \(taskId): Task finished successfully", level: .info)
+                    logger?.logNetworkEvent(message: "🚀 taskId: \(taskId): Task finished successfully", level: .info, fileName: #file, lineNumber: #line)
 
                     if cacheTimeout > 0 {
                         DeduplicatingRequestExecutor.runningRequestTasks[taskId]?.finishDate = Date()
@@ -140,7 +129,7 @@ public final actor DeduplicatingRequestExecutor: RequestExecuting, Sendable, Ide
                     return dataResponse
 
                 case .failure:
-                    logger.log(message: "🚀 taskId: \(taskId): Task finished with error", level: .error)
+                    logger?.logNetworkEvent(message: "🚀 taskId: \(taskId): Task finished with error", level: .error, fileName: #file, lineNumber: #line)
                     DeduplicatingRequestExecutor.runningRequestTasks[taskId] = nil
                     return dataResponse
                 }

README.md

@@ -7,7 +7,6 @@
 
 import Alamofire
 import Foundation
-import GoodLogger
 
 /// A protocol defining the interface for executing network requests.
 ///