Improve logging by displaying more relevant details and additional arguments

Source/Logging.swift

@@ -1,17 +1,12 @@
 import Foundation
 
 /// Simple function to help in debugging, a noop in Release builds
-func debugLog(_ item: Any, _ method: String = #function) {
+func debugLog(_ text: String, _ arguments: [String: Any] = [:]) {
     #if DEBUG
     let timestamp = Date()
 
-    if let message = item as? String {
-        print("\(timestamp) - \(message)")
-    } else {
-        // Support passing object directly instead of string to print class and function
-        let component = String(describing: type(of: item))
-        print("\(timestamp) - [\(component)] \(method)")
-    }
+    print("\(timestamp) \(text) \(arguments)")
+
     #endif
 }
 

Source/Session/Session.swift

@@ -64,6 +64,8 @@ public class Session: NSObject {
         let visit = makeVisit(for: visitable, options: options ?? VisitOptions())
         currentVisit?.cancel()
         currentVisit = visit
+
+        log("visit", ["location": visit.location, "options": visit.options, "reload": reload])
 
         visit.delegate = self
         visit.start()
@@ -296,11 +298,12 @@ extension Session: WKNavigationDelegate {
     }
 
     public func webViewWebContentProcessDidTerminate(_ webView: WKWebView) {
-        debugLog("[Session] webViewWebContentProcessDidTerminate")
+        log("webViewWebContentProcessDidTerminate")
         delegate?.sessionWebViewProcessDidTerminate(self)
     }
 
     private func openExternalURL(_ url: URL) {
+        log("openExternalURL", ["url": url])
         delegate?.session(self, openExternalURL: url)
     }
 
@@ -334,3 +337,7 @@ extension Session: WKNavigationDelegate {
         }
     }
 }
+
+private func log(_ name: String, _ arguments: [String: Any] = [:]) {
+    debugLog("[Session] \(name)", arguments)
+}

Source/Visit/ColdBootVisit.swift

@@ -7,7 +7,7 @@ final class ColdBootVisit: Visit {
     private(set) var navigation: WKNavigation?
 
     override func startVisit() {
-        debugLog(self)
+        log("startVisit")
 
         webView.navigationDelegate = self
         bridge.pageLoadDelegate = self
@@ -23,17 +23,23 @@ final class ColdBootVisit: Visit {
     }
 
     override func cancelVisit() {
+        log("cancelVisit")
+
         removeNavigationDelegate()
         webView.stopLoading()
         finishRequest()
     }
 
     override func completeVisit() {
+        log("completeVisit")
+
         removeNavigationDelegate()
         delegate?.visitDidInitializeWebView(self)
     }
 
     override func failVisit() {
+        log("failVisit")
+
         removeNavigationDelegate()
         finishRequest()
     }
@@ -42,6 +48,10 @@ final class ColdBootVisit: Visit {
         guard webView.navigationDelegate === self else { return }
         webView.navigationDelegate = nil
     }
+
+    private func log(_ name: String) {
+        debugLog("[ColdBootVisit] \(name) \(location.absoluteString)")
+    }
 }
 
 extension ColdBootVisit: WKNavigationDelegate {

Source/Visit/JavaScriptVisit.swift

@@ -16,26 +16,26 @@ final class JavaScriptVisit: Visit {
     }
 
     override func startVisit() {
-        debugLog(self)
+        log("startVisit")
         bridge.visitDelegate = self
         bridge.visitLocation(location, options: options, restorationIdentifier: restorationIdentifier)
     }
 
     override func cancelVisit() {
-        debugLog(self)
+        log("cancelVisit")
         bridge.cancelVisit(withIdentifier: identifier)
         finishRequest()
     }
 
     override func failVisit() {
-        debugLog(self)
+        log("failVisit")
         finishRequest()
     }
 }
 
 extension JavaScriptVisit: WebViewVisitDelegate {
     func webView(_ webView: WebViewBridge, didStartVisitWithIdentifier identifier: String, hasCachedSnapshot: Bool) {
-        debugLog(self)
+        log("didStartVisitWithIdentifier", ["identifier": identifier, "hasCachedSnapshot": hasCachedSnapshot])
         self.identifier = identifier
         self.hasCachedSnapshot = hasCachedSnapshot
 
@@ -44,13 +44,13 @@ extension JavaScriptVisit: WebViewVisitDelegate {
 
     func webView(_ webView: WebViewBridge, didStartRequestForVisitWithIdentifier identifier: String, date: Date) {
         guard identifier == self.identifier else { return }
-        debugLog(self)
+        log("didFinishRequestForVisitWithIdentifier", ["identifier": identifier, "date": date])
         startRequest()
     }
 
     func webView(_ webView: WebViewBridge, didCompleteRequestForVisitWithIdentifier identifier: String) {
         guard identifier == self.identifier else { return }
-        debugLog(self)
+        log("didCompleteRequestForVisitWithIdentifier", ["identifier": identifier])
 
         if hasCachedSnapshot {
             delegate?.visitWillLoadResponse(self)
@@ -60,28 +60,33 @@ extension JavaScriptVisit: WebViewVisitDelegate {
     func webView(_ webView: WebViewBridge, didFailRequestForVisitWithIdentifier identifier: String, statusCode: Int) {
         guard identifier == self.identifier else { return }
 
+        log("didFailRequestForVisitWithIdentifier", ["identifier": identifier, "statusCode": statusCode])
         fail(with: TurboError(statusCode: statusCode))
     }
 
     func webView(_ webView: WebViewBridge, didFinishRequestForVisitWithIdentifier identifier: String, date: Date) {
         guard identifier == self.identifier else { return }
 
-        debugLog(self)
+        log("didFinishRequestForVisitWithIdentifier", ["identifier": identifier, "date": date])
         finishRequest()
     }
 
     func webView(_ webView: WebViewBridge, didRenderForVisitWithIdentifier identifier: String) {
         guard identifier == self.identifier else { return }
 
-        debugLog(self)
+        log("didRenderForVisitWithIdentifier", ["identifier": identifier])
         delegate?.visitDidRender(self)
     }
 
     func webView(_ webView: WebViewBridge, didCompleteVisitWithIdentifier identifier: String, restorationIdentifier: String) {
         guard identifier == self.identifier else { return }
 
-        debugLog(self)
+        log("didCompleteVisitWithIdentifier", ["identifier": identifier, "restorationIdentifier": restorationIdentifier])
         self.restorationIdentifier = restorationIdentifier
         complete()
     }
+
+    private func log(_ name: String, _ arguments: [String: Any] = [:]) {
+        debugLog("[JavascriptVisit] \(name) \(location.absoluteString)", arguments)
+    }
 }

Source/WebView/WebViewBridge.swift

@@ -84,7 +84,7 @@ final class WebViewBridge {
             return
         }
 
-        debugLog("[Bridge] → \(function)")
+        debugLog("[Bridge] → \(function) \(arguments)")
 
         webView.evaluateJavaScript(script) { result, error in
             debugLog("[Bridge] = \(function) evaluation complete")
@@ -103,7 +103,7 @@ extension WebViewBridge: ScriptMessageHandlerDelegate {
         guard let message = ScriptMessage(message: scriptMessage) else { return }
 
         if message.name != .log {
-            debugLog("[Bridge] ← \(message.name)")
+            debugLog("[Bridge] ← \(message.name) \(message.data)")
         }
 
         switch message.name {