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>

SampleFiles/Tags/Generated/Analytics+GenAllScript.swift

@@ -6,14 +6,20 @@ import FirebaseAnalytics
 // MARK: - Protocol
 
 protocol AnalyticsManagerProtocol {
+    func logScreen(
+        name: String,
+        path: String,
+        params: [String: Any]?
+    )
 
-    func logScreen(name: String, path: String)
     func logEvent(
         name: String,
         action: String,
         category: String,
         params: [String: Any]?
     )
+
+    func setEnable(_ enable: Bool)
 }
 
 // MARK: - Matomo
@@ -48,8 +54,11 @@ class MatomoAnalyticsManager: AnalyticsManagerProtocol {
 
     // MARK: - Methods
 
-    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")
@@ -65,8 +74,6 @@ class MatomoAnalyticsManager: AnalyticsManagerProtocol {
         category: String,
         params: [String: Any]?
     ) {
-        guard !tracker.isOptedOut else { return }
-
         tracker.track(
             eventWithCategory: category,
             action: action,
@@ -75,16 +82,40 @@ class MatomoAnalyticsManager: AnalyticsManagerProtocol {
             url: nil
         )
     }
+
+    func setEnable(_ enable: Bool) {
+        tracker.isOptedOut = !enable
+    }
 }
 
 // MARK: - Firebase
 
 class FirebaseAnalyticsManager: AnalyticsManagerProtocol {
-    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
@@ -98,10 +129,17 @@ class FirebaseAnalyticsManager: AnalyticsManagerProtocol {
         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
@@ -115,10 +153,21 @@ class FirebaseAnalyticsManager: AnalyticsManagerProtocol {
         }
 
         Analytics.logEvent(
-            name.replacingOccurrences(of: [" "], with: "_"),
+            AnalyticsEventSelectContent,
             parameters: parameters
         )
     }
+    func setEnable(_ enable: Bool) {
+        Analytics.setAnalyticsCollectionEnabled(enable)
+    }
+}
+
+
+// MARK: - Traker Type
+
+enum TrackerType: CaseIterable {
+    case matomo
+    case firebase
 }
 
 // MARK: - Manager
@@ -127,33 +176,61 @@ class AnalyticsManager {
 
     static var shared = AnalyticsManager()
 
+    private init() {}
+
     // MARK: - Properties
 
-    var managers: [AnalyticsManagerProtocol] = []
+    var managers: [TrackerType: AnalyticsManagerProtocol] = [:]
 
-    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)
     }
 
     func configure(siteId: String, url: String) {
-        managers.append(
-            MatomoAnalyticsManager(
-                siteId: siteId,
-                url: url
-            )
+        managers[TrackerType.matomo] = MatomoAnalyticsManager(
+            siteId: siteId,
+            url: url
         )
-        managers.append(FirebaseAnalyticsManager())
+        managers[TrackerType.firebase] = FirebaseAnalyticsManager()
     }
-
-    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
+            )
         }
     }
 
@@ -165,7 +242,7 @@ class AnalyticsManager {
     ) {
         guard isEnabled else { return }
 
-        managers.forEach { manager in
+        managers.values.forEach { manager in
             manager.logEvent(
                 name: name,
                 action: action,
@@ -177,31 +254,39 @@ class AnalyticsManager {
 
     // MARK: - section_one
 
-    func logScreenS1DefOne(title: String) {
-        logScreen(
+    static func logScreenS1DefOne(title: String) {
+        AnalyticsManager.shared.logScreen(
             name: "s1 def one \(title)",
-            path: "s1_def_one/\(title)"
+            path: "s1_def_one/\(title)",
+            params: nil
         )
     }
 
-    func logEventS1DefTwo(title: String, count: String) {
-        logEvent(
+    static func logEventS1DefTwo(
+        title: String,
+		count: String,
+		test2: String = "test"
+    ) {
+        AnalyticsManager.shared.logEvent(
             name: "s1 def two",
             action: "test",
             category: "test",
             params: [
                 "title": title,
-				"count": count
+				"count": count,
+				"test": "test",
+				"test2": test2
             ]
         )
     }
 
     // MARK: - section_two
 
-    func logScreenS2DefOne() {
-        logScreen(
+    static func logScreenS2DefOne() {
+        AnalyticsManager.shared.logScreen(
             name: "s2 def one",
-            path: "s2_def_one/"
+            path: "s2_def_one/",
+            params: nil
         )
     }
 }

SampleFiles/Tags/sampleTags.yml

@@ -22,6 +22,12 @@ categories:
             type: String
           - name: count
             type: String
+          - name: test
+            type: String
+            value: test
+          - name: test2
+            type: String
+            defaultValue: test
             
   - id: section_two
     screens:

SampleFiles/genAllRessources.sh

@@ -50,14 +50,15 @@ swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/sampleTags.txt
  --extension-name "Tags" \
  --extension-suffix "GenAllScript"
 
-#echo "\n-------------------------\n"
+echo "\n-------------------------\n"
 
 # Analytics
 swift run -c release ResgenSwift analytics $FORCE_FLAG "./Tags/sampleTags.yml" \
- --target "matomo firebase" \
+ --target "firebase matomo" \
  --extension-output-path "./Tags/Generated" \
  --extension-name "Analytics" \
- --extension-suffix "GenAllScript"
+ --extension-suffix "GenAllScript" \
+ --static-members true
 
 echo "\n-------------------------\n"