chore!: DCMAW-14598 Remove all deprecated components (#120)

* chore: remove deprecated versions

* test: update conformances

* test: conform

* chore: remove unused type aliases

* chore: rename all V2 to original version

* chore: missed title name

* chore: move typealiases

Author: chionia-gds

Sources/GAnalytics/GAnalytics.swift

@@ -3,47 +3,52 @@ import FirebaseAnalytics
 import FirebaseCrashlytics
 import Logging
 
+@available(*, deprecated, renamed: "GAnalytics")
+public typealias GAnalyticsV2 = GAnalytics
+
 /// GAnalytics
 ///
 /// An abstraction class for bringing Google Analytics (Firebase and Crashlytics) into the app from the Firebase package.
 /// To provide user-specific insights for logging app metrics and performance.
-@available(*, deprecated, renamed: "GAnalyticsV2", message: "Please consider moving to GAnalyticsV2, this type will be replaced shortly")
 public struct GAnalytics {
-    private let app: AnalyticsApp.Type
-    private let analytics: AnalyticsLogger.Type
+    static var analyticsApp: AnalyticsApp.Type = FirebaseApp.self
+    public let analyticsPreferenceStore: AnalyticsPreferenceStore
+    private let analyticsLogger: AnalyticsLogger.Type
     private let crashLogger: CrashLogger
-    private let preferenceStore: AnalyticsPreferenceStore
 
     /// Additional parameters for the application
     public var additionalParameters = [String: Any]()
 
-    init(app: AnalyticsApp.Type,
-         analytics: AnalyticsLogger.Type,
-         crashLogger: CrashLogger,
-         preferenceStore: AnalyticsPreferenceStore) {
-        self.app = app
-        self.analytics = analytics
+    init(analyticsPreferenceStore: AnalyticsPreferenceStore,
+         analyticsLogger: AnalyticsLogger.Type,
+         crashLogger: CrashLogger) {
+        self.analyticsPreferenceStore = analyticsPreferenceStore
+        self.analyticsLogger = analyticsLogger
         self.crashLogger = crashLogger
-        self.preferenceStore = preferenceStore
+        
+        crashLogger.setCrashlyticsCollectionEnabled(true)
     }
 
-    public init() {
-        self.init(app: FirebaseApp.self,
-                  analytics: Analytics.self,
-                  crashLogger: Crashlytics.crashlytics(),
-                  preferenceStore: UserDefaultsPreferenceStore())
+    public init(analyticsPreferenceStore: AnalyticsPreferenceStore) {
+        self.init(analyticsPreferenceStore: analyticsPreferenceStore,
+                  analyticsLogger: Analytics.self,
+                  crashLogger: Crashlytics.crashlytics())
     }
 
     /// Initialises the Firebase instance when launching the app.
-    public func configure() {
-        app.configure()
+    public static func configure() {
+        analyticsApp.configure()
+    }
+    
+    /// Activates subscription to preference store events and updates based on existing preference.
+    public func activate() {
         subscribeToPreferenceStore()
-        updateAnalyticsPreference(preferenceStore.hasAcceptedAnalytics)
+        updateAnalyticsPreference(analyticsPreferenceStore.hasAcceptedAnalytics)
     }
 
     private func subscribeToPreferenceStore() {
         Task {
-            for await value in preferenceStore.stream() {
+            for await value in analyticsPreferenceStore.stream() {
                 updateAnalyticsPreference(value)
             }
         }
@@ -75,51 +80,46 @@ extension GAnalytics: AnalyticsService {
         return newCopy
     }
 
-    /// Tracks screens adding screen tracking parameters in Firebase package.
-    public func trackScreen(_ screen: LoggableScreen,
-                            parameters params: [String: Any] = [:]) {
-        var parameters = mergeAdditionalParameters(params)
-        
-        parameters[AnalyticsParameterScreenName] = screen.name
-        parameters[AnalyticsParameterScreenClass] = screen.name
-        
-        analytics.logEvent(AnalyticsEventScreenView,
-                           parameters: parameters)
-    }
-    
-    public func trackScreen(_ screen: any LoggableScreenV2,
+    public func trackScreen(_ screen: any LoggableScreen,
                             parameters params: [String: Any]) {
         var parameters = mergeAdditionalParameters(params)
 
         parameters[AnalyticsParameterScreenName] = screen.name
         parameters[AnalyticsParameterScreenClass] = screen.type.description
 
-        analytics.logEvent(AnalyticsEventScreenView,
-                           parameters: parameters)
+        analyticsLogger.logEvent(AnalyticsEventScreenView,
+                                 parameters: parameters)
     }
 
     /// Logs events accepting the event name and parameters in Firebase package.
     public func logEvent(_ event: LoggableEvent, parameters params: [String: Any]) {
         let parameters = mergeAdditionalParameters(params)
-        analytics.logEvent(event.name, parameters: parameters)
+        analyticsLogger.logEvent(event.name, parameters: parameters)
     }
 
     /// Logs crashes accepting an error in Firebase package.
     public func logCrash(_ error: NSError) {
         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.
-    public func grantAnalyticsPermission() {
-        analytics.setAnalyticsCollectionEnabled(true)
-        crashLogger.setCrashlyticsCollectionEnabled(true)
+    func grantAnalyticsPermission() {
+        analyticsLogger.setAnalyticsCollectionEnabled(true)
     }
 
     /// Denying analytics and crashlytics permissions in Firebase package.
-    public func denyAnalyticsPermission() {
-        analytics.setAnalyticsCollectionEnabled(false)
-        analytics.resetAnalyticsData()
-        
-        crashLogger.setCrashlyticsCollectionEnabled(false)
+    func denyAnalyticsPermission() {
+        analyticsLogger.setAnalyticsCollectionEnabled(false)
+        analyticsLogger.resetAnalyticsData()
     }
 }

Sources/GAnalytics/GAnalyticsV2.swift

@@ -1,6 +1,3 @@
-@available(*, deprecated, renamed: "ScreenType")
-public typealias NamedScreen = ScreenType
-
 public protocol ScreenType: CustomStringConvertible {
     var name: String { get }
 }

Sources/GDSAnalytics/Screens/ScreenType.swift

@@ -1,36 +1,19 @@
 import Foundation
 
+@available(*, deprecated, renamed: "AnalyticsService")
+public typealias AnalyticsServiceV2 = AnalyticsService
+
 /// AnalyticsService
 ///
 /// A protocol for Types to log analytics to a third-party analytics service.
-@available(*, deprecated, renamed: "AnalyticsServiceV2", message: "Please consider moving to AnalyticsServiceV2, this protocol will be replaced shortly")
 public protocol AnalyticsService: LoggingService {
+    var analyticsPreferenceStore: AnalyticsPreferenceStore { get }
+    
     var additionalParameters: [String: Any] { get set }
     func addingAdditionalParameters(_ additionalParameters: [String: Any]) -> Self
-    
-    @available(*, deprecated, renamed: "trackScreen", message: "Please use LoggableScreenV2")
-    func trackScreen(_ screen: LoggableScreen)
-    
-    @available(*, deprecated, renamed: "trackScreen", message: "Please use LoggableScreenV2")
-    func trackScreen(_ screen: LoggableScreen, parameters: [String: Any])
-    
-    func trackScreen(_ screen: any LoggableScreenV2, parameters: [String: Any])
+ 
+    func trackScreen(_ screen: any LoggableScreen, parameters: [String: Any])
 
     func logCrash(_ crash: NSError)
     func logCrash(_ crash: Error)
-    
-    func grantAnalyticsPermission()
-    func denyAnalyticsPermission()
-}
-
-extension AnalyticsService {
-    /// Protocol method for screen tracking, calling the conforming type's method for adding screen tracking parameters.
-    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)
-    }
 }