feat: dcmaw 14345 add default saved doc type (#89)

robinphillips · web-flow · commit f026396f18b4 · 2025-07-18T16:44:27.000+01:00
* feat: added default paramater values for savedDocType

* feat: added new parameter to tests

* feat: updated merging precedence on params, added to V2 and tests

* feat: added v2 test and linting
diff --git a/Sources/GAnalytics/GAnalytics.swift b/Sources/GAnalytics/GAnalytics.swift
@@ -60,7 +60,9 @@ public struct GAnalytics {
     
     /// Merging `parameters` dictionary parameter with `additionalParameters` property
     private func mergeAdditionalParameters(_ parameters: [String: Any]) -> [String: Any] {
-        additionalParameters.merging(parameters) { $1 }
+        additionalParameters.merging(parameters) { lhs, _ in
+            lhs
+        }
     }
 }
 
@@ -69,10 +71,7 @@ extension GAnalytics: AnalyticsService {
         _ additionalParameters: [String: Any]
     ) -> Self {
         var newCopy = self
-        newCopy.additionalParameters = self.additionalParameters
-            .merging(additionalParameters) { lhs, _ in
-                lhs
-            }
+        newCopy.additionalParameters = self.mergeAdditionalParameters(additionalParameters)
         return newCopy
     }
     
diff --git a/Sources/GAnalytics/GAnalyticsV2.swift b/Sources/GAnalytics/GAnalyticsV2.swift
@@ -60,7 +60,9 @@ public struct GAnalyticsV2 {
     
     /// Merging `parameters` dictionary parameter with `additionalParameters` property
     private func mergeAdditionalParameters(_ parameters: [String: Any]) -> [String: Any] {
-        additionalParameters.merging(parameters) { $1 }
+        additionalParameters.merging(parameters) { lhs, _ in
+            lhs
+        }
     }
 }
 
@@ -69,10 +71,7 @@ extension GAnalyticsV2: AnalyticsServiceV2 {
         _ additionalParameters: [String: Any]
     ) -> Self {
         var newCopy = self
-        newCopy.additionalParameters = self.additionalParameters
-            .merging(additionalParameters) { lhs, _ in
-                lhs
-            }
+        newCopy.additionalParameters = self.mergeAdditionalParameters(additionalParameters)
         return newCopy
     }
     
diff --git a/Sources/GDSAnalytics/Screens/ErrorScreenView.swift b/Sources/GDSAnalytics/Screens/ErrorScreenView.swift
@@ -8,6 +8,7 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
     public let endpoint: String?
     public let statusCode: String?
     public let hash: String?
+    public let savedDocType: String
     
     public var parameters: [String: String] {
         [
@@ -16,35 +17,44 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
             ScreenParameter.endpoint.rawValue: endpoint,
             ScreenParameter.hash.rawValue: hash,
             ScreenParameter.status.rawValue: statusCode,
+            ScreenParameter.savedDocType.rawValue: savedDocType,
             ScreenParameter.isError.rawValue: "true"
         ]
         .compactMapValues(\.?.formattedAsParameter)
     }
     
-    public init(id: String? = nil,
-                screen: Screen,
-                titleKey: String,
-                reason: String? = nil,
-                endpoint: String? = nil,
-                statusCode: String? = nil,
-                hash: String? = nil,
-                bundle: Bundle = .main) {
+    public init(
+        id: String? = nil,
+        screen: Screen,
+        titleKey: String,
+        reason: String? = nil,
+        endpoint: String? = nil,
+        statusCode: String? = nil,
+        hash: String? = nil,
+        bundle: Bundle = .main,
+        savedDocType: String = "undefined"
+    ) {
         self.screen = screen
         self.title = titleKey.englishString(bundle: bundle).formattedAsParameter
         self.id = id
         self.reason = reason
         self.endpoint = endpoint
         self.statusCode = statusCode
         self.hash = hash
+        self.savedDocType = savedDocType
     }
     
-    public init(id: String? = nil,
-                screen: Screen,
-                titleKey: String,
-                error: LoggableError,
-                bundle: Bundle = .main) {
+    public init(
+        id: String? = nil,
+        screen: Screen,
+        titleKey: String,
+        error: LoggableError,
+        bundle: Bundle = .main,
+        savedDocType: String = "undefined"
+    ) {
         self.id = id
         self.screen = screen
+        self.savedDocType = savedDocType
         title = titleKey.englishString(bundle: bundle).formattedAsParameter
         reason = error.reason
         endpoint = error.endpoint
diff --git a/Sources/GDSAnalytics/Screens/ScreenParameter.swift b/Sources/GDSAnalytics/Screens/ScreenParameter.swift
@@ -5,4 +5,5 @@ public enum ScreenParameter: String {
     case hash
     case id = "screen_id"
     case isError = "is_error"
+    case savedDocType = "saved_doc_type"
 }
diff --git a/Sources/GDSAnalytics/Screens/ScreenView.swift b/Sources/GDSAnalytics/Screens/ScreenView.swift
@@ -5,29 +5,36 @@ public protocol ScreenViewProtocol: Equatable {
     var id: String? { get }
     var screen: Screen { get }
     var title: String { get }
+    var savedDocType: String { get }
     var parameters: [String: String] { get }
 }
 
 public struct ScreenView<Screen: ScreenType>: ScreenViewProtocol {
     public let id: String?
     public let screen: Screen
     public let title: String
+    public let savedDocType: String
     
     public var parameters: [String: String] {
         [
             ScreenParameter.id.rawValue: id,
+            ScreenParameter.savedDocType.rawValue: savedDocType,
             ScreenParameter.isError.rawValue: "false"
         ].compactMapValues(\.?.formattedAsParameter)
     }
     
-    public init(id: String? = nil,
-                screen: Screen,
-                titleKey: String,
-                variableKeys: [String] = [],
-                bundle: Bundle = .main) {
+    public init(
+        id: String? = nil,
+        screen: Screen,
+        titleKey: String,
+        variableKeys: [String] = [],
+        savedDocType: String = "undefined",
+        bundle: Bundle = .main
+    ) {
         self.id = id
         self.screen = screen
         self.title = titleKey.englishString(variableKeys, bundle: bundle).formattedAsParameter
+        self.savedDocType = savedDocType
     }
 }
 
diff --git a/Tests/GAnalyticsTests/GAnalyticsTests.swift b/Tests/GAnalyticsTests/GAnalyticsTests.swift
@@ -196,6 +196,35 @@ extension GAnalyticsTests {
         )
     }
     
+    func testTrackScreenAdditionalParametersPrecedence() {
+        sut.additionalParameters = [
+            "journey": "id_verification"
+        ]
+        
+        sut.trackScreen(
+            TestScreen.welcome,
+            parameters: [
+                "additional_parameter": "testing",
+                "journey": "something_else"
+            ]
+        )
+        
+        XCTAssertEqual(
+            analyticsLogger.events,
+            [
+                .init(
+                    name: "screen_view",
+                    parameters: [
+                        "screen_name": "WELCOME_SCREEN",
+                        "screen_class": "WELCOME_SCREEN",
+                        "additional_parameter": "testing",
+                        "journey": "id_verification"
+                    ]
+                )
+            ]
+        )
+    }
+    
     func testTrackScreenV2() {
         struct TestScreenV2: LoggableScreenV2 {
             let name: String = "Welcome to GOV.UK One Login"
diff --git a/Tests/GAnalyticsTests/GAnalyticsV2Tests.swift b/Tests/GAnalyticsTests/GAnalyticsV2Tests.swift
@@ -197,6 +197,35 @@ extension GAnalyticsTestsV2 {
         )
     }
     
+    func testTrackScreenAdditionalParametersPrecedence() {
+        sut.additionalParameters = [
+            "journey": "id_verification"
+        ]
+        
+        sut.trackScreen(
+            TestScreen.welcome,
+            parameters: [
+                "additional_parameter": "testing",
+                "journey": "something_else"
+            ]
+        )
+        
+        XCTAssertEqual(
+            analyticsLogger.events,
+            [
+                .init(
+                    name: "screen_view",
+                    parameters: [
+                        "screen_name": "WELCOME_SCREEN",
+                        "screen_class": "WELCOME_SCREEN",
+                        "additional_parameter": "testing",
+                        "journey": "id_verification"
+                    ]
+                )
+            ]
+        )
+    }
+    
     func testTrackScreenV2() {
         struct TestScreenV2: LoggableScreenV2 {
             let name: String = "Welcome to GOV.UK One Login"
diff --git a/Tests/GDSAnalyticsTests/Screens/ErrorScreenViewTests.swift b/Tests/GDSAnalyticsTests/Screens/ErrorScreenViewTests.swift
@@ -21,7 +21,8 @@ final class ErrorScreenViewTests: XCTestCase {
             view.parameters,
             [
                 "screen_id": uuid,
-                "is_error": "true"
+                "is_error": "true",
+                "saved_doc_type": "undefined"
             ]
         )
     }
@@ -51,7 +52,8 @@ final class ErrorScreenViewTests: XCTestCase {
                 "reason": "server",
                 "endpoint": "fetchbiometrictoken",
                 "status": "429",
-                "is_error": "true"
+                "is_error": "true",
+                "saved_doc_type": "undefined"
             ]
         )
     }
@@ -77,7 +79,8 @@ final class ErrorScreenViewTests: XCTestCase {
                 "endpoint": "appinfo",
                 "status": "401",
                 "hash": "83766358f64858b51afb745bbdde91bb",
-                "is_error": "true"
+                "is_error": "true",
+                "saved_doc_type": "undefined"
             ]
         )
     }
diff --git a/Tests/GDSAnalyticsTests/Screens/ScreenViewTests.swift b/Tests/GDSAnalyticsTests/Screens/ScreenViewTests.swift
@@ -20,7 +20,8 @@ final class ScreenViewTests: XCTestCase {
         XCTAssertEqual(
             view.parameters, [
                 "screen_id": uuid,
-                "is_error": "false"
+                "is_error": "false",
+                "saved_doc_type": "undefined"
             ]
         )
     }
@@ -36,7 +37,10 @@ final class ScreenViewTests: XCTestCase {
         
         XCTAssertEqual(
             view.parameters,
-            ["is_error": "false"]
+            [
+                "is_error": "false",
+                "saved_doc_type": "undefined"
+            ]
         )
     }
     

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,9 @@ public struct GAnalytics {`
`60`	`60`
`61`	`61`	/// Merging `parameters` dictionary parameter with `additionalParameters` property
`62`	`62`	`private func mergeAdditionalParameters(_ parameters: [String: Any]) -> [String: Any] {`
`63`		`- additionalParameters.merging(parameters) { $1 }`
	`63`	`+ additionalParameters.merging(parameters) { lhs, _ in`
	`64`	`+ lhs`
	`65`	`+ }`
`64`	`66`	`}`
`65`	`67`	`}`
`66`	`68`
`@@ -69,10 +71,7 @@ extension GAnalytics: AnalyticsService {`
`69`	`71`	`_ additionalParameters: [String: Any]`
`70`	`72`	`) -> Self {`
`71`	`73`	`var newCopy = self`
`72`		`- newCopy.additionalParameters = self.additionalParameters`
`73`		`- .merging(additionalParameters) { lhs, _ in`
`74`		`- lhs`
`75`		`- }`
	`74`	`+ newCopy.additionalParameters = self.mergeAdditionalParameters(additionalParameters)`
`76`	`75`	`return newCopy`
`77`	`76`	`}`
`78`	`77`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@ public enum ScreenParameter: String {`
`5`	`5`	`case hash`
`6`	`6`	`case id = "screen_id"`
`7`	`7`	`case isError = "is_error"`
	`8`	`+ case savedDocType = "saved_doc_type"`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ final class ErrorScreenViewTests: XCTestCase {`
`21`	`21`	`view.parameters,`
`22`	`22`	`[`
`23`	`23`	`"screen_id": uuid,`
`24`		`- "is_error": "true"`
	`24`	`+ "is_error": "true",`
	`25`	`+ "saved_doc_type": "undefined"`
`25`	`26`	`]`
`26`	`27`	`)`
`27`	`28`	`}`
`@@ -51,7 +52,8 @@ final class ErrorScreenViewTests: XCTestCase {`
`51`	`52`	`"reason": "server",`
`52`	`53`	`"endpoint": "fetchbiometrictoken",`
`53`	`54`	`"status": "429",`
`54`		`- "is_error": "true"`
	`55`	`+ "is_error": "true",`
	`56`	`+ "saved_doc_type": "undefined"`
`55`	`57`	`]`
`56`	`58`	`)`
`57`	`59`	`}`
`@@ -77,7 +79,8 @@ final class ErrorScreenViewTests: XCTestCase {`
`77`	`79`	`"endpoint": "appinfo",`
`78`	`80`	`"status": "401",`
`79`	`81`	`"hash": "83766358f64858b51afb745bbdde91bb",`
`80`		`- "is_error": "true"`
	`82`	`+ "is_error": "true",`
	`83`	`+ "saved_doc_type": "undefined"`
`81`	`84`	`]`
`82`	`85`	`)`
`83`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ final class ScreenViewTests: XCTestCase {`
`20`	`20`	`XCTAssertEqual(`
`21`	`21`	`view.parameters, [`
`22`	`22`	`"screen_id": uuid,`
`23`		`- "is_error": "false"`
	`23`	`+ "is_error": "false",`
	`24`	`+ "saved_doc_type": "undefined"`
`24`	`25`	`]`
`25`	`26`	`)`
`26`	`27`	`}`
`@@ -36,7 +37,10 @@ final class ScreenViewTests: XCTestCase {`
`36`	`37`
`37`	`38`	`XCTAssertEqual(`
`38`	`39`	`view.parameters,`
`39`		`- ["is_error": "false"]`
	`40`	`+ [`
	`41`	`+ "is_error": "false",`
	`42`	`+ "saved_doc_type": "undefined"`
	`43`	`+ ]`
`40`	`44`	`)`
`41`	`45`	`}`
`42`	`46`