Analytics improvement (#9)

Co-authored-by: Quentin Bandera <q.bandera@openium.fr>
Reviewed-on: #9
Co-authored-by: Loris Perret <l.perret@openium.fr>
Co-committed-by: Loris Perret <l.perret@openium.fr>

Sources/ResgenSwift/Analytics/Generator/AnalyticsGenerator.swift

@@ -89,36 +89,76 @@ enum AnalyticsGenerator {
     ) -> String {
         """
         // Generated by ResgenSwift.\(Analytics.toolName) \(ResgenSwiftVersion)
-
-        \(getImport(targets: targets))
-
-        \(getAnalyticsProtocol(targets: targets))
+        
+        \(Self.getImport(targets: targets))
+        
+        \(Self.getAnalyticsProtocol(targets: targets))
+        
+        \(Self.getTrackerTypeEnum())
+        
         // MARK: - Manager
 
         class AnalyticsManager {
-
+        
             static var shared = AnalyticsManager()
+        
+            private init() {}
 
             // MARK: - Properties
-
-            var managers: [AnalyticsManagerProtocol] = []
-
-            \(getEnabledContent())
-
-            \(getAnalyticsProperties(targets: targets))
-
-            \(getPrivateLogFunction())
+        
+            var managers: [TrackerType: AnalyticsManagerProtocol] = [:]
+        
+            \(Self.getEnabledContent())
+        
+            \(Self.getAnalyticsProperties(targets: targets))
+                
+            \(Self.getPrivateLogFunction())
         """
     }
-
+    
+    private static func getTrackerTypeEnum() -> String {
+        var result: [String] = []
+        TrackerType.allCases.forEach { type in
+            result.append("    case \(type)")
+        }
+        
+        return """
+        // MARK: - Traker Type
+        
+        enum TrackerType: CaseIterable {
+        \(result.joined(separator: "\n"))
+        }
+        """
+    }
+    
     private static func getEnabledContent() -> String {
         """
-        private var isEnabled: Bool = true
-
+        private var isEnabled: Bool {
+                if ProcessInfo.processInfo.environment["XCODE_RUNNING_FOR_PREVIEWS"] == "1" {
+                    false
+                } else {
+                    true
+                }
+            }
+        
             // MARK: - Methods
-
-            func setAnalyticsEnabled(_ enable: Bool) {
-                isEnabled = enable
+        
+            private func setAnalytics(enable: Bool, _ analytics: [TrackerType]) {
+                managers.forEach { (key, value) in
+                    if analytics.contains(where: { type in
+                        type == key
+                    }) {
+                        value.setEnable(enable)
+                    }
+                }
+            }
+        
+            func enableAnalytics(_ analytics: [TrackerType] = TrackerType.allCases) {
+                setAnalytics(enable: true, analytics)
+            }
+        
+            func disableAnalytics(_ analytics: [TrackerType] = TrackerType.allCases) {
+                setAnalytics(enable: false, analytics)
             }
         """
     }
@@ -126,6 +166,8 @@ enum AnalyticsGenerator {
     private static func getImport(targets: [TrackerType]) -> String {
         var result: [String] = []
 
+        result.append("import Foundation")
+
         if targets.contains(TrackerType.matomo) {
             result.append("import MatomoTracker")
         }
@@ -138,11 +180,19 @@ enum AnalyticsGenerator {
 
     private static func getPrivateLogFunction() -> String {
         """
-        private func logScreen(name: String, path: String) {
+        private func logScreen(
+                name: String,
+                path: String,
+                params: [String: Any]?
+            ) {
                 guard isEnabled else { return }
-
-                managers.forEach { manager in
-                    manager.logScreen(name: name, path: path)
+        
+                managers.values.forEach { manager in
+                    manager.logScreen(
+                        name: name,
+                        path: path,
+                        params: params
+                    )
                 }
             }
 
@@ -153,8 +203,8 @@ enum AnalyticsGenerator {
                 params: [String: Any]?
             ) {
                 guard isEnabled else { return }
-
-                managers.forEach { manager in
+        
+                managers.values.forEach { manager in
                     manager.logEvent(
                         name: name,
                         action: action,
@@ -179,16 +229,14 @@ enum AnalyticsGenerator {
 
         if targets.contains(TrackerType.matomo) {
             content.append("""
-                    managers.append(
-                        MatomoAnalyticsManager(
-                            siteId: siteId,
-                            url: url
-                        )
+                    managers[TrackerType.matomo] = MatomoAnalyticsManager(
+                        siteId: siteId,
+                        url: url
                     )
             """)
         }
         if targets.contains(TrackerType.firebase) {
-            content.append("        managers.append(FirebaseAnalyticsManager())")
+            content.append("        managers[TrackerType.firebase] = FirebaseAnalyticsManager()")
         }
 
         return [
@@ -204,14 +252,20 @@ enum AnalyticsGenerator {
         // MARK: - Protocol
 
         protocol AnalyticsManagerProtocol {
-
-            func logScreen(name: String, path: String)
+            func logScreen(
+                name: String,
+                path: String,
+                params: [String: Any]?
+            )
+        
             func logEvent(
                 name: String,
                 action: String,
                 category: String,
                 params: [String: Any]?
             )
+        
+            func setEnable(_ enable: Bool)
         }
 
         """

Sources/ResgenSwift/Analytics/Generator/FirebaseGenerator.swift

@@ -13,10 +13,11 @@ enum FirebaseGenerator {
 
     static var service: String {
         [
-            Self.header,
-            Self.logScreen,
-            Self.logEvent,
-            Self.footer
+            FirebaseGenerator.header,
+            FirebaseGenerator.logScreen,
+            FirebaseGenerator.logEvent,
+            FirebaseGenerator.enable,
+            FirebaseGenerator.footer
         ]
             .joined(separator: "\n")
     }
@@ -33,11 +34,31 @@ enum FirebaseGenerator {
 
     private static var logScreen: String {
         """
-            func logScreen(name: String, path: String) {
+            func logScreen(
+                name: String,
+                path: String,
+                params: [String: Any]?
+            ) {
                 var parameters = [
                     AnalyticsParameterScreenName: name as NSObject
                 ]
-
+        
+                if path.isEmpty == false {
+                    parameters["path"] = path + "/iOS" as NSObject
+                }
+        
+                if let supplementaryParameters = params {
+                    for (newKey, newValue) in supplementaryParameters {
+                        if parameters.contains(where: { (key: String, value: NSObject) in
+                            key == newKey
+                        }) {
+                            continue
+                        }
+                        
+                        parameters[newKey] = newValue as? NSObject
+                    }
+                }
+        
                 Analytics.logEvent(
                     AnalyticsEventScreenView,
                     parameters: parameters
@@ -56,10 +77,17 @@ enum FirebaseGenerator {
                 params: [String: Any]?
             ) {
                 var parameters: [String:NSObject] = [
-                    "action": action as NSObject,
-                    "category": category as NSObject,
+                    AnalyticsParameterItemName: name.replacingOccurrences(of: " ", with: "_") as NSObject
                 ]
-
+        
+                if category.isEmpty == false {
+                    parameters["AnalyticsParameterItemCategory"] = category as NSObject
+                }
+                
+                if action.isEmpty == false {
+                    parameters["action"] = action as NSObject
+                }
+                
                 if let supplementaryParameters = params {
                     for (newKey, newValue) in supplementaryParameters {
                         if parameters.contains(where: { (key: String, value: NSObject) in
@@ -73,13 +101,21 @@ enum FirebaseGenerator {
                 }
 
                 Analytics.logEvent(
-                    name.replacingOccurrences(of: [" "], with: "_"),
+                    AnalyticsEventSelectContent,
                     parameters: parameters
                 )
             }
         """
     }
-
+    
+    private static var enable: String {
+        """
+            func setEnable(_ enable: Bool) {
+                Analytics.setAnalyticsCollectionEnabled(enable)
+            }
+        """
+    }
+    
     private static var footer: String {
         """
         }

Sources/ResgenSwift/Analytics/Generator/MatomoGenerator.swift

@@ -11,11 +11,12 @@ enum MatomoGenerator {
 
     static var service: String {
         [
-            Self.header,
-            Self.setup,
-            Self.logScreen,
-            Self.logEvent,
-            Self.footer
+            MatomoGenerator.header,
+            MatomoGenerator.setup,
+            MatomoGenerator.logScreen,
+            MatomoGenerator.logEvent,
+            MatomoGenerator.enable,
+            MatomoGenerator.footer
         ]
             .joined(separator: "\n")
     }
@@ -66,8 +67,11 @@ enum MatomoGenerator {
 
     private static var logScreen: String {
         """
-            func logScreen(name: String, path: String) {
-                guard !tracker.isOptedOut else { return }
+            func logScreen(
+                name: String,
+                path: String,
+                params: [String: Any]?
+            ) {
                 guard let trackerUrl = tracker.contentBase?.absoluteString else { return }
 
                 let urlString = URL(string: "\\(trackerUrl)" + "/" + "\\(path)" + "iOS")
@@ -88,8 +92,6 @@ enum MatomoGenerator {
                 category: String,
                 params: [String: Any]?
             ) {
-                guard !tracker.isOptedOut else { return }
-
                 tracker.track(
                     eventWithCategory: category,
                     action: action,
@@ -98,6 +100,15 @@ enum MatomoGenerator {
                     url: nil
                 )
             }
+        
+        """
+    }
+    
+    private static var enable: String {
+        """
+            func setEnable(_ enable: Bool) {
+                tracker.isOptedOut = !enable
+            }
         """
     }
 

Sources/ResgenSwift/Analytics/Model/AnalyticsDefinition.swift

@@ -51,17 +51,23 @@ class AnalyticsDefinition {
     }
 
     private func getParameters() -> String {
-        var params = parameters
         var result: String
-
-        if type == .screen {
-            params = params.filter { param in
-                !param.replaceIn.isEmpty
+        
+        let paramsString = parameters.compactMap { parameter -> String? in
+            guard parameter.value.isEmpty else { return nil }
+            
+            let defaultValue: String
+            switch parameter.type {
+            case .bool:
+                defaultValue = "\(parameter.defaultValue.lowercased())"
+            case .int, .double:
+                defaultValue = "\(parameter.defaultValue)"
+            case .string:
+                defaultValue = "\"\(parameter.defaultValue)\""
             }
-        }
-
-        let paramsString = params.map { parameter in
-            "\(parameter.name): \(parameter.type)"
+            
+            let defaultValueString = parameter.defaultValue.isEmpty ? "" : " = \(defaultValue)"
+            return "\(parameter.name): \(parameter.type.rawValue)\(defaultValueString)"
         }
 
         if paramsString.count > 2 {
@@ -87,7 +93,10 @@ class AnalyticsDefinition {
                 case "path": path = path.replacingFirstOccurrence(of: "_\(parameter.name.uppercased())_", with: "\\(\(parameter.name))")
                 case "category": category = category.replacingFirstOccurrence(of: "_\(parameter.name.uppercased())_", with: "\\(\(parameter.name))")
                 case "action": action = action.replacingFirstOccurrence(of: "_\(parameter.name.uppercased())_", with: "\\(\(parameter.name))")
-                default: break
+                default:
+                    if let param = parameters.first(where: { $0.name == rep }), param.value.isEmpty == false {
+                        param.value = param.value.replacingFirstOccurrence(of: "_\(parameter.name.uppercased())_", with: "\\(\(parameter.name))")
+                    }
                 }
             }
         }
@@ -102,7 +111,18 @@ class AnalyticsDefinition {
         }
 
         supplementaryParams.forEach { param in
-            params.append("\"\(param.name)\": \(param.name)")
+            if param.value.isEmpty {
+                params.append("\"\(param.name)\": \(param.name)")
+            } else {
+                switch param.type {
+                case .bool:
+                    params.append("\"\(param.name)\": \(param.value.lowercased())")
+                case .int, .double:
+                    params.append("\"\(param.name)\": \(param.value)")
+                case .string:
+                    params.append("\"\(param.name)\": \"\(param.value)\"")
+                }
+            }
         }
 
         if params.count > 1 {
@@ -116,14 +136,15 @@ class AnalyticsDefinition {
             [\(params.joined(separator: ", "))]
             """
         } else {
-            result = "[:]"
+            result = "nil"
         }
 
         if type == .screen {
             return """
             logScreen(
                         name: "\(name)",
-                        path: "\(path)"
+                        path: "\(path)",
+                        params: \(result)
                     )
             """
         } else {
@@ -153,7 +174,7 @@ class AnalyticsDefinition {
         replaceIn()
         return """
             static func \(getFuncName())\(getParameters()) {
-                \(getlogFunction())
+                AnalyticsManager.shared.\(getlogFunction())
             }
         """
     }

Sources/ResgenSwift/Analytics/Model/AnalyticsFile.swift

@@ -46,5 +46,7 @@ struct AnalyticsParameterDTO: Codable {
 
     var name: String
     var type: String
+    var value: String?
+    var defaultValue: String?
     var replaceIn: String?
 }

Sources/ResgenSwift/Analytics/Model/AnalyticsParameter.swift

@@ -12,13 +12,17 @@ class AnalyticsParameter {
     // MARK: - Properties
 
     var name: String
-    var type: String
+    var type: ParameterType
+    var value: String
+    var defaultValue: String
     var replaceIn: [String] = []
 
     // MARK: - Init
-
-    init(name: String, type: String) {
+    
+    init(name: String, type: ParameterType, value: String, defaultValue: String) {
         self.name = name
         self.type = type
+        self.value = value
+        self.defaultValue = defaultValue
     }
 }

Sources/ResgenSwift/Analytics/Model/ParameterType.swift

@@ -0,0 +1,15 @@
+//
+//  File.swift
+//  
+//
+//  Created by Loris Perret on 17/07/2024.
+//
+
+import Foundation
+
+enum ParameterType: String {
+    case string = "String"
+    case int = "Int"
+    case double = "Double"
+    case bool = "Bool"
+}

Sources/ResgenSwift/Analytics/Parser/AnalyticsFileParser.swift

@@ -67,25 +67,58 @@ class AnalyticsFileParser {
         }
     }
 
-    private func getParameters(from parameters: [AnalyticsParameterDTO]) -> [AnalyticsParameter] {
-        parameters.map { dtoParameter in
+    private static func getParameters(from parameters: [AnalyticsParameterDTO]) -> [AnalyticsParameter] {
+        func verify(value: String?, for type: ParameterType) {
+            guard let value, value.isEmpty == false else { return }
+            
+            switch type {
+            case .int:
+                if Int(value) == nil {
+                    let error = AnalyticsError.invalidParameter("type of \(value) is not \(type)")
+                    print(error.description)
+                    Analytics.exit(withError: error)
+                }
+            case .bool:
+                if Bool(value.lowercased()) == nil {
+                    let error = AnalyticsError.invalidParameter("type of \(value) is not \(type)")
+                    print(error.description)
+                    Analytics.exit(withError: error)
+                }
+            case .double:
+                if Double(value) == nil {
+                    let error = AnalyticsError.invalidParameter("type of \(value) is not \(type)")
+                    print(error.description)
+                    Analytics.exit(withError: error)
+                }
+            case .string:
+                break
+            }
+        }
+        
+        return parameters.map { dtoParameter in
             // Type
             let type = dtoParameter.type.uppercasedFirst()
 
-            guard
-                type == "String" ||
-                type == "Int" ||
-                type == "Double" ||
-                type == "Bool"
-            else {
+            guard let typeEnum = ParameterType(rawValue: type) else {
                 let error = AnalyticsError.invalidParameter("type of \(dtoParameter.name)")
                 print(error.description)
                 Analytics.exit(withError: error)
             }
+            
+            if dtoParameter.value != nil, dtoParameter.replaceIn != nil {
+                let error = AnalyticsError.invalidParameter("you can't set 'value' and 'replaceIn' for \(dtoParameter.name)")
+                print(error.description)
+                Analytics.exit(withError: error)
+            }
+            
+            verify(value: dtoParameter.value, for: typeEnum)
+            verify(value: dtoParameter.defaultValue, for: typeEnum)
 
             let parameter = AnalyticsParameter(
                 name: dtoParameter.name,
-                type: type
+                type: typeEnum,
+                value: dtoParameter.value ?? "",
+                defaultValue: dtoParameter.defaultValue ?? ""
             )
 
             if let replaceIn = dtoParameter.replaceIn {
@@ -114,7 +147,7 @@ class AnalyticsFileParser {
         }
 
         if let parameters {
-            definition.parameters = getParameters(from: parameters)
+            definition.parameters = AnalyticsFileParser.getParameters(from: parameters)
         }
 
         return definition
@@ -140,6 +173,8 @@ class AnalyticsFileParser {
                     Analytics.exit(withError: error)
                 }
 
+                definition.path = path
+            } else if let path = screen.path {
                 definition.path = path
             }
 
@@ -176,6 +211,14 @@ class AnalyticsFileParser {
                 }
 
                 definition.action = action
+            } else {
+                if let category = event.category {
+                    definition.category = category
+                }
+                
+                if let action = event.action {
+                    definition.action = action
+                }
             }
 
             return definition