feat: adding is_error parameter to screen view events (#87)

* feat: adding is_error parameter to screen view events

* fix: remove trailing comma

Author: robinphillips

Sources/GDSAnalytics/Screens/ErrorScreenView.swift

@@ -15,7 +15,8 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
             ScreenParameter.reason.rawValue: reason,
             ScreenParameter.endpoint.rawValue: endpoint,
             ScreenParameter.hash.rawValue: hash,
-            ScreenParameter.status.rawValue: statusCode
+            ScreenParameter.status.rawValue: statusCode,
+            ScreenParameter.isError.rawValue: "true"
         ]
         .compactMapValues(\.?.formattedAsParameter)
     }

Sources/GDSAnalytics/Screens/ScreenParameter.swift

@@ -4,4 +4,5 @@ public enum ScreenParameter: String {
     case status
     case hash
     case id = "screen_id"
+    case isError = "is_error"
 }

Sources/GDSAnalytics/Screens/ScreenView.swift

@@ -15,7 +15,8 @@ public struct ScreenView<Screen: ScreenType>: ScreenViewProtocol {
 
     public var parameters: [String: String] {
         [
-            ScreenParameter.id.rawValue: id
+            ScreenParameter.id.rawValue: id,
+            ScreenParameter.isError.rawValue: "false"
         ].compactMapValues(\.?.formattedAsParameter)
     }
 

Tests/GDSAnalyticsTests/Screens/ErrorScreenViewTests.swift

@@ -12,14 +12,18 @@ final class ErrorScreenViewTests: XCTestCase {
 
     func testEmptyParametersAreRemoved() {
         let uuid = UUID().uuidString.lowercased()
-
+        
         let view = ErrorScreenView(id: uuid,
                                    screen: MockScreen.error,
                                    titleKey: "Something went wrong")
 
-        XCTAssertEqual(view.parameters, [
-            "screen_id": uuid
-        ])
+        XCTAssertEqual(
+            view.parameters,
+            [
+                "screen_id": uuid,
+                "is_error": "true"
+            ]
+        )
     }
 
     struct MockError: LoggableError {
@@ -31,38 +35,50 @@ final class ErrorScreenViewTests: XCTestCase {
 
     func testParametersForError() {
         let uuid = UUID().uuidString.lowercased()
-        let view = ErrorScreenView(id: uuid,
-                                   screen: MockScreen.error,
-                                   titleKey: "Something went wrong",
-                                   error: MockError())
+        let view = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Something went wrong",
+            error: MockError()
+        )
 
         XCTAssertEqual(view.title, "something went wrong")
-        XCTAssertEqual(view.parameters, [
-            "screen_id": uuid,
-            "hash": "83766358f64858b51afb745bbdde91bb",
-            "reason": "server",
-            "endpoint": "fetchbiometrictoken",
-            "status": "429"])
+        XCTAssertEqual(
+            view.parameters,
+            [
+                "screen_id": uuid,
+                "hash": "83766358f64858b51afb745bbdde91bb",
+                "reason": "server",
+                "endpoint": "fetchbiometrictoken",
+                "status": "429",
+                "is_error": "true"
+            ]
+        )
     }
 
     func testParametersForValues() {
         let uuid = UUID().uuidString.lowercased()
-
-        let view = ErrorScreenView(id: uuid,
-                                   screen: MockScreen.error,
-                                   titleKey: "Something went wrong",
-                                   reason: "network",
-                                   endpoint: "appInfo",
-                                   statusCode: "401",
-                                   hash: "83766358f64858b51afb745bbdde91bb"
+        
+        let view = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Something went wrong",
+            reason: "network",
+            endpoint: "appInfo",
+            statusCode: "401",
+            hash: "83766358f64858b51afb745bbdde91bb"
         )
 
-        XCTAssertEqual(view.parameters, [
-            "screen_id": uuid,
-            "reason": "network",
-            "endpoint": "appinfo",
-            "status": "401",
-            "hash": "83766358f64858b51afb745bbdde91bb"
-        ])
+        XCTAssertEqual(
+            view.parameters,
+            [
+                "screen_id": uuid,
+                "reason": "network",
+                "endpoint": "appinfo",
+                "status": "401",
+                "hash": "83766358f64858b51afb745bbdde91bb",
+                "is_error": "true"
+            ]
+        )
     }
 }

Tests/GDSAnalyticsTests/Screens/ScreenViewTests.swift

@@ -17,18 +17,26 @@ final class ScreenViewTests: XCTestCase {
                               screen: MockScreen.welcome,
                               titleKey: "welcome to this app")
 
-        XCTAssertEqual(view.parameters, [
-            "screen_id": uuid
-        ])
+        XCTAssertEqual(
+            view.parameters, [
+                "screen_id": uuid,
+                "is_error": "false"
+            ]
+        )
     }
 
 
     func testParameterTruncation() {
-        let view = ScreenView(screen: MockScreen.welcome,
-                              titleKey: "Welcome to this app with a really really really really really really really really really really long name")
+        let view = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
 
         XCTAssertEqual(view.title, "welcome to this app with a really really really really really really really really really really lon")
 
-        XCTAssertEqual(view.parameters, [:])
+        XCTAssertEqual(
+            view.parameters,
+            ["is_error": "false"]
+        )
     }
 }