Add pretty printed logs for the data

mdb1 · May 28, 2023 · b7fb577 · b7fb577
1 parent a516254
commit b7fb577
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -29,38 +29,37 @@ HTTPClient.shared.networkLogger = .init(
 ```swift
 🛜 ===> Network Request started:
 ▿ 3 key/value pairs
+  ▿ (2 elements)
+    - key: "Request\'s Internal Id"
+    - value: "[CA5C3]"
   ▿ (2 elements)
     - key: "URL"
     - value: "https://catfact.ninja/fact/?"
   ▿ (2 elements)
     - key: "HTTP Method"
     - value: "GET"
-  ▿ (2 elements)
-    - key: "Request\'s Internal Id"
-    - value: "[3E786]"
 🛜 <==== Network Response received:
 ▿ 3 key/value pairs
+  ▿ (2 elements)
+    - key: "Status Code"
+    - value: "200"
   ▿ (2 elements)
     - key: "Request\'s Internal Id"
-    - value: "[3E786]"
+    - value: "[CA5C3]"
   ▿ (2 elements)
     - key: "URL"
     - value: "https://catfact.ninja/fact/?"
-  ▿ (2 elements)
-    - key: "Status Code"
-    - value: "200"
 ✅ ==> JSON Decoding start:
 ▿ CoreNetworkingTests.CatFact
-  - fact: "A cat\'s brain is more similar to a man\'s brain than that of a dog."
-  - length: 66
+  - fact: "Cats are now Britain\'s favourite pet: there are 7.7 million cats as opposed to 6.6 million dogs."
+  - length: 96
 ℹ️ Additional Info:
-▿ 2 key/value pairs
-  ▿ (2 elements)
-    - key: "Expected Model"
-    - value: "CatFact"
-  ▿ (2 elements)
-    - key: "UTF8 - String"
-    - value: "{\"fact\":\"A cat\'s brain is more similar to a man\'s brain than that of a dog.\",\"length\":66}"
+ℹ️ 🔍 Expected Model: CatFact
+ℹ️ 📝 Pretty Printed JSON:
+{
+  "fact" : "Cats are now Britain's favourite pet: there are 7.7 million cats as opposed to 6.6 million dogs.",
+  "length" : 96
+}
 ✅ <== JSON Decoding end.
 🏁 <==== Network Request finished.
 ```
@@ -70,36 +69,45 @@ HTTPClient.shared.networkLogger = .init(
 ```swift
 🛜 ===> Network Request started:
 ▿ 3 key/value pairs
-  ▿ (2 elements)
-    - key: "Request\'s Internal Id"
-    - value: "[1C57E]"
   ▿ (2 elements)
     - key: "HTTP Method"
     - value: "GET"
+  ▿ (2 elements)
+    - key: "Request\'s Internal Id"
+    - value: "[79B5E]"
   ▿ (2 elements)
     - key: "URL"
     - value: "https://catfact.ninja/facts/?"
 🛜 <==== Network Response received:
 ▿ 3 key/value pairs
   ▿ (2 elements)
     - key: "Request\'s Internal Id"
-    - value: "[1C57E]"
-  ▿ (2 elements)
-    - key: "URL"
-    - value: "https://catfact.ninja/facts/?"
+    - value: "[79B5E]"
   ▿ (2 elements)
     - key: "Status Code"
     - value: "200"
+  ▿ (2 elements)
+    - key: "URL"
+    - value: "https://catfact.ninja/facts/?"
 ❌ ==> JSON Decoding issue start:
 Error description: Key 'CodingKeys(stringValue: "fact", intValue: nil)' not found
 ℹ️ Additional Info:
-▿ 3 key/value pairs
-  ▿ (2 elements)
-    - key: "UTF8 - String"
-    - value: "{\"current_page\":1,\"data\":[{\"fact\":\"Unlike dogs, cats do not have a sweet tooth. Scientists believe this is due to a mutation in a key taste receptor.\",\"length\":114},{\"fact\":\"-}"
-  ▿ (2 elements)
-    - key: "Expected Model"
-    - value: "CatFact"
+ℹ️ 🔍 Expected Model: CatFact
+ℹ️ 📝 Pretty Printed JSON:
+{
+  "last_page_url" : "https:\/\/catfact.ninja\/facts?page=34",
+  "prev_page_url" : null,
+  "from" : 1,
+  "total" : 332,
+  "path" : "https:\/\/catfact.ninja\/facts",
+  "first_page_url" : "https:\/\/catfact.ninja\/facts?page=1",
+  "last_page" : 34,
+  "next_page_url" : "https:\/\/catfact.ninja\/facts?page=2",
+  "current_page" : 1,
+  "per_page" : 10,
+  "to" : 10
+}
+▿ 1 key/value pair
   ▿ (2 elements)
     - key: "Context"
     - value: "No value associated with key CodingKeys(stringValue: \"fact\", intValue: nil) (\"fact\")."

diff --git a/Sources/CoreNetworking/Extension/Data+PrettyPrinted.swift b/Sources/CoreNetworking/Extension/Data+PrettyPrinted.swift
@@ -0,0 +1,25 @@
+//
+//  Data+PrettyPrinted.swift
+//  
+//
+//  Created by Manu on 28/05/2023.
+//
+
+import Foundation
+
+extension Data {
+    var prettyPrintedJSONString: NSString {
+        guard let object = try? JSONSerialization.jsonObject(
+            with: self,
+            options: []
+        ), let data = try? JSONSerialization.data(
+            withJSONObject: object,
+            options: [.prettyPrinted]
+        ), let prettyPrintedString = NSString(
+            data: data,
+            encoding: String.Encoding.utf8.rawValue
+        ) else { return "" }
+
+        return prettyPrintedString
+    }
+}
diff --git a/...tworking/HTTPURLResponse+Properties.swift → ...xtension/HTTPURLResponse+Properties.swift b/...tworking/HTTPURLResponse+Properties.swift → ...xtension/HTTPURLResponse+Properties.swift
diff --git a/Sources/CoreNetworking/Extension/Request+Properties.swift b/Sources/CoreNetworking/Extension/Request+Properties.swift
@@ -0,0 +1,26 @@
+//
+//  Request+Properties.swift
+//  
+//
+//  Created by Manu on 28/05/2023.
+//
+
+import Foundation
+
+extension Request {
+    var logProperties: [String: Any] {
+        var logProperties: [String: Any] = [:]
+        logProperties["Request's Internal Id"] = internalId
+        if let url = urlRequest.url {
+            logProperties["URL"] = url.absoluteString
+        }
+        logProperties["HTTP Method"] = urlRequest.httpMethod
+        if let headers = urlRequest.allHTTPHeaderFields, headers.count > 0 {
+            logProperties["HTTP Headers"] = headers
+        }
+        if let body = urlRequest.httpBody {
+            logProperties["HTTP Body"] = String(data: body, encoding: .utf8)
+        }
+        return logProperties
+    }
+}
diff --git a/Sources/CoreNetworking/NetworkLogger.swift b/Sources/CoreNetworking/NetworkLogger.swift
@@ -58,14 +58,13 @@ public struct NetworkLogger {
         switch configuration {
         case let .verbose(_, logResponses):
             guard logResponses else { return }
-            var logProperties: [String: String] = [:]
-            logProperties["UTF8 - String"] = String(data: data, encoding: .utf8)
-            logProperties["Expected Model"] = "\(type)"
 
             print("✅ ==> JSON Decoding start:")
             dump(model)
             print("ℹ️ Additional Info:")
-            dump(logProperties)
+            print("ℹ️ 🔍 Expected Model: \(type)")
+            print("ℹ️ 📝 Pretty Printed JSON:")
+            print(data.prettyPrintedJSONString)
             print("✅ <== JSON Decoding end.")
         case .quiet:
             return
@@ -78,8 +77,6 @@ public struct NetworkLogger {
             guard logResponses else { return }
             var errorDescription: String = ""
             var logProperties: [String: String] = [:]
-            logProperties["UTF8 - String"] = String(data: data, encoding: .utf8)
-            logProperties["Expected Model"] = "\(type)"
 
             if let decodingError = error as? DecodingError {
                 switch decodingError {
@@ -108,6 +105,9 @@ public struct NetworkLogger {
             print("❌ ==> JSON Decoding issue start:")
             print("Error description: \(errorDescription)")
             print("ℹ️ Additional Info:")
+            print("ℹ️ 🔍 Expected Model: \(type)")
+            print("ℹ️ 📝 Pretty Printed JSON:")
+            print(data.prettyPrintedJSONString)
             dump(logProperties)
             print("❌ <== JSON Decoding issue end.")
         case .quiet:

diff --git a/Sources/CoreNetworking/Request.swift b/Sources/CoreNetworking/Request.swift
@@ -43,22 +43,6 @@ public struct Request {
         request.httpMethod = method.name
         return request
     }
-
-    var logProperties: [String: Any] {
-        var logProperties: [String: Any] = [:]
-        logProperties["Request's Internal Id"] = internalId
-        if let url = urlRequest.url {
-            logProperties["URL"] = url.absoluteString
-        }
-        logProperties["HTTP Method"] = urlRequest.httpMethod
-        if let headers = urlRequest.allHTTPHeaderFields, headers.count > 0 {
-            logProperties["HTTP Headers"] = headers
-        }
-        if let body = urlRequest.httpBody {
-            logProperties["HTTP Body"] = String(data: body, encoding: .utf8)
-        }
-        return logProperties
-    }
 }
 
 public extension Request {