fix: remove title from parameter list (#79)

* feat: initial implementation

* test: correcting test and trackScreen with LoggableScreen

* chore: removing title screen parameter

* fix: removing title from parameters

Author: dylanjames-dd

Sources/GAnalytics/GAnalytics.swift

@@ -73,7 +73,6 @@ extension GAnalytics: AnalyticsService {
                 lhs
             }
         return newCopy
-        
     }
 
     /// Tracks screens adding screen tracking parameters in Firebase package.
@@ -92,8 +91,8 @@ extension GAnalytics: AnalyticsService {
                             parameters params: [String: Any]) {
         var parameters = mergeAdditionalParameters(params)
 
-        parameters[AnalyticsParameterScreenClass] = screen.type.description
         parameters[AnalyticsParameterScreenName] = screen.name
+        parameters[AnalyticsParameterScreenClass] = screen.type.description
 
         analytics.logEvent(AnalyticsEventScreenView,
                            parameters: parameters)

Sources/GDSAnalytics/Screens/ErrorScreenView.swift

@@ -11,7 +11,6 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
 
     public var parameters: [String: String] {
         [
-            ScreenParameter.title.rawValue: title,
             ScreenParameter.id.rawValue: id,
             ScreenParameter.reason.rawValue: reason,
             ScreenParameter.endpoint.rawValue: endpoint,
@@ -43,7 +42,6 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
                 titleKey: String,
                 error: LoggableError,
                 bundle: Bundle = .main) {
-       
         self.id = id
         self.screen = screen
         title = titleKey.englishString(bundle: bundle).formattedAsParameter

Sources/GDSAnalytics/Screens/ScreenParameter.swift

@@ -3,6 +3,5 @@ public enum ScreenParameter: String {
     case endpoint
     case status
     case hash
-    case title
     case id = "screen_id"
 }

Sources/GDSAnalytics/Screens/ScreenType.swift

@@ -13,7 +13,6 @@ extension ScreenType {
 
 extension ScreenType where Self: RawRepresentable,
                            Self.RawValue == String {
-    
     /// Protocol method returning the string value from a Type's `name` property which conforms to this protocol.
     public var name: String {
         rawValue

Sources/GDSAnalytics/Screens/ScreenView.swift

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

Sources/Logging/LoggableEvent.swift

@@ -6,7 +6,7 @@ public protocol LoggableEvent {
 }
 
 extension LoggableEvent where Self: RawRepresentable,
-                                Self.RawValue == String {
+                              Self.RawValue == String {
 
     /// Protocol method returning the string value from a Type's `name` property which conforms to this protocol.
     public var name: String {

Tests/GAnalyticsTests/GAnalyticsTests.swift

@@ -170,8 +170,8 @@ extension GAnalyticsTests {
         XCTAssertEqual(
             analyticsLogger.events,
             [.init(name: "screen_view", parameters: [
-                "screen_class": "WELCOME_SCREEN",
                 "screen_name": "WELCOME_SCREEN",
+                "screen_class": "WELCOME_SCREEN",
                 "additional_parameter": "testing"
             ])]
         )
@@ -188,8 +188,8 @@ extension GAnalyticsTests {
         XCTAssertEqual(
             analyticsLogger.events,
             [.init(name: "screen_view", parameters: [
-                "screen_class": "WELCOME_SCREEN",
                 "screen_name": "WELCOME_SCREEN",
+                "screen_class": "WELCOME_SCREEN",
                 "additional_parameter": "testing",
                 "journey": "id_verification"
             ])]
@@ -208,8 +208,8 @@ extension GAnalyticsTests {
         XCTAssertEqual(
             analyticsLogger.events,
             [.init(name: "screen_view", parameters: [
-                "screen_class": "WELCOME_SCREEN",
                 "screen_name": "Welcome to GOV.UK One Login",
+                "screen_class": "WELCOME_SCREEN",
                 "additional_parameter": "testing"
             ])]
         )

Tests/GDSAnalyticsTests/Screens/ErrorScreenViewTests.swift

@@ -18,7 +18,6 @@ final class ErrorScreenViewTests: XCTestCase {
                                    titleKey: "Something went wrong")
 
         XCTAssertEqual(view.parameters, [
-            "title": "something went wrong",
             "screen_id": uuid
         ])
     }
@@ -39,7 +38,6 @@ final class ErrorScreenViewTests: XCTestCase {
 
         XCTAssertEqual(view.title, "something went wrong")
         XCTAssertEqual(view.parameters, [
-            "title": "something went wrong",
             "screen_id": uuid,
             "hash": "83766358f64858b51afb745bbdde91bb",
             "reason": "server",
@@ -60,7 +58,6 @@ final class ErrorScreenViewTests: XCTestCase {
         )
 
         XCTAssertEqual(view.parameters, [
-            "title": "something went wrong",
             "screen_id": uuid,
             "reason": "network",
             "endpoint": "appinfo",

Tests/GDSAnalyticsTests/Screens/ScreenViewTests.swift

@@ -18,7 +18,6 @@ final class ScreenViewTests: XCTestCase {
                               titleKey: "welcome to this app")
 
         XCTAssertEqual(view.parameters, [
-            "title": "welcome to this app",
             "screen_id": uuid
         ])
     }
@@ -30,6 +29,6 @@ final class ScreenViewTests: XCTestCase {
 
         XCTAssertEqual(view.title, "welcome to this app with a really really really really really really really really really really lon")
 
-        XCTAssertEqual(view.parameters, [ "title": "welcome to this app with a really really really really really really really really really really lon"])
+        XCTAssertEqual(view.parameters, [:])
     }
 }