feat: add additional params to errors (#96)

* feat: adding parameters to error logging

* fix: linting, tidying up and unit test

* fix: additional unit test

* feat: resetting parameters after logging crash

* chore: setting custom keys and values to empty before setting with specific

* feat: using error record with userInfo

* chore: tidying up

* chore: linting

* chore: adjusted as per PR comment request

* chore: adjusted unit test

* chore: adjusted unit test

Author: robinphillips

Sources/GAnalytics/CrashLogger.swift

@@ -1,8 +1,8 @@
 import FirebaseCrashlytics
 
 protocol CrashLogger {
-    func record(error: Error)
+    func record(error: Error, userInfo: [String: Any]?)
     func setCrashlyticsCollectionEnabled(_ value: Bool)
 }
 
-extension Crashlytics: CrashLogger { }
+extension Crashlytics: CrashLogger {}

Sources/GAnalytics/GAnalytics.swift

@@ -106,7 +106,7 @@ extension GAnalytics: AnalyticsService {
 
     /// Logs crashes accepting an error in Firebase package.
     public func logCrash(_ error: NSError) {
-        crashLogger.record(error: error)
+        crashLogger.record(error: error, userInfo: nil)
     }
 
     /// Granting analytics and crashlytics permissions in Firebase package.

Sources/GAnalytics/GAnalyticsV2.swift

@@ -106,7 +106,17 @@ extension GAnalyticsV2: AnalyticsServiceV2 {
 
     /// Logs crashes accepting an error in Firebase package.
     public func logCrash(_ error: NSError) {
-        crashLogger.record(error: error)
+        crashLogger.record(error: error, userInfo: nil)
+    }
+    
+    public func logCrash(_ crash: Error) {
+        let errorUserInfo = (crash as? CustomNSError)?.errorUserInfo ?? [:]
+        
+        let paramsToLog = additionalParameters.merging(errorUserInfo) { lhs, _ in
+            lhs
+        }
+
+        crashLogger.record(error: crash, userInfo: paramsToLog)
     }
 
     /// Granting analytics and crashlytics permissions in Firebase package.

Sources/Logging/AnalyticsServiceV2.swift

@@ -26,9 +26,4 @@ extension AnalyticsServiceV2 {
     public func trackScreen(_ screen: LoggableScreen) {
         trackScreen(screen, parameters: [:])
     }
-    
-    /// Protocol method for crash logging, calling the conforming type's method for passing errors as `NSError`s.
-    public func logCrash(_ crash: Error) {
-        logCrash(crash as NSError)
-    }
 }

Tests/GAnalyticsTests/GAnalyticsV2Tests.swift

@@ -272,6 +272,34 @@ extension GAnalyticsTestsV2 {
         )
     }
 
+    func testLogCrashCustomNSError() {
+        let error = MockCustomNSError(kind: "testError1")
+        
+        sut.additionalParameters = ["additionalParameter": "param"]
+        sut.logCrash(error)
+        
+        XCTAssertEqual(crashLogger.errors.count, 1)
+        XCTAssertEqual(crashLogger.loggedParams?["kind"] as? String, "testError1")
+        XCTAssertEqual(crashLogger.loggedParams?["testString"] as? String, "stringValue")
+        XCTAssertEqual(crashLogger.loggedParams?["testInt"] as? Int, 123)
+        
+        XCTAssertEqual(crashLogger.loggedParams?["additionalParameter"] as? String, "param")
+    }
+    
+    func testLogCrashCustomNSErrorNotOverwritingParam() {
+        let error = MockCustomNSError(kind: "testError1")
+        
+        sut.additionalParameters = ["testString": "CorrectStringValue"]
+        sut.logCrash(error)
+        
+        XCTAssertEqual(crashLogger.errors.count, 1)
+        XCTAssertEqual(crashLogger.loggedParams?["kind"] as? String, "testError1")
+        XCTAssertEqual(crashLogger.loggedParams?["testString"] as? String, "CorrectStringValue")
+        XCTAssertEqual(crashLogger.loggedParams?["testInt"] as? Int, 123)
+        
+        XCTAssertNotEqual(crashLogger.loggedParams?["testString"] as? String, "stringValue")
+    }
+    
     func testGrantAnalyticsPermission() {
         sut.grantAnalyticsPermission()
 

Tests/GAnalyticsTests/Mocks/MockCrashLogger.swift

@@ -3,9 +3,12 @@
 final class MockCrashLogger: CrashLogger {
     private(set) var errors: [Error] = []
     private(set) var isCollectionEnabled: Bool?
+
+    var loggedParams: [AnyHashable: Any]? = [:]
 
-    func record(error: Error) {
+    func record(error: Error, userInfo: [String: Any]?) {
         errors.append(error)
+        loggedParams = userInfo
     }
 
     func setCrashlyticsCollectionEnabled(_ value: Bool) {

Tests/GAnalyticsTests/Mocks/MockCustomNSError.swift

@@ -0,0 +1,13 @@
+import Foundation
+
+struct MockCustomNSError: CustomNSError {
+    let kind: String
+    
+    var errorUserInfo: [String: Any] {
+        [
+            "kind": kind,
+            "testString": "stringValue",
+            "testInt": 123
+        ]
+    }
+}