From 74a5ca29c47f8f0a5c10c8d9ae852b4db18235c4 Mon Sep 17 00:00:00 2001
From: Mikaela Caron <mikaelacaron@gmail.com>
Date: Sun, 12 Nov 2023 01:04:13 -0500
Subject: [PATCH] Firebase Analytics (#262)

---
 .../project.pbxproj                           |  4 ++
 .../xcschemes/Basic-Car-Maintenance.xcscheme  |  6 +++
 .../ViewModels/DashboardViewModel.swift       |  7 ++++
 .../ViewModels/OdometerViewModel.swift        |  4 ++
 .../ViewModels/AuthenticationViewModel.swift  |  1 +
 .../ViewModels/SettingsViewModel.swift        |  4 ++
 .../Shared/Utilities/AnalyticsService.swift   | 41 +++++++++++++++++++
 7 files changed, 67 insertions(+)
 create mode 100644 Basic-Car-Maintenance/Shared/Utilities/AnalyticsService.swift

diff --git a/Basic-Car-Maintenance.xcodeproj/project.pbxproj b/Basic-Car-Maintenance.xcodeproj/project.pbxproj
index f3a57b92..2bcd6003 100644
--- a/Basic-Car-Maintenance.xcodeproj/project.pbxproj
+++ b/Basic-Car-Maintenance.xcodeproj/project.pbxproj
@@ -27,6 +27,7 @@
 		E58499682ACDDA9A00634660 /* ContributorsProfileView.swift in Sources */ = {isa = PBXBuildFile; fileRef = E58499672ACDDA9A00634660 /* ContributorsProfileView.swift */; };
 		E584996A2ACDDAFF00634660 /* Contributor.swift in Sources */ = {isa = PBXBuildFile; fileRef = E58499692ACDDAFF00634660 /* Contributor.swift */; };
 		FF09FC912AB6FF44006BE61A /* AuthenticationView.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF09FC902AB6FF44006BE61A /* AuthenticationView.swift */; };
+		FF218EF62B00865F0025A533 /* AnalyticsService.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF218EF52B00865F0025A533 /* AnalyticsService.swift */; };
 		FF3DDF522AA4D28F009D91C4 /* DashboardViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF3DDF512AA4D28F009D91C4 /* DashboardViewModel.swift */; };
 		FF4E82BE2AD39863004949AF /* FirebaseRemoteConfig in Frameworks */ = {isa = PBXBuildFile; productRef = FF4E82BD2AD39863004949AF /* FirebaseRemoteConfig */; };
 		FF4E82C02AD39863004949AF /* FirebaseRemoteConfigSwift in Frameworks */ = {isa = PBXBuildFile; productRef = FF4E82BF2AD39863004949AF /* FirebaseRemoteConfigSwift */; };
@@ -126,6 +127,7 @@
 		FF0813572AD0A92700910EFA /* Widget.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Widget.xcconfig; sourceTree = "<group>"; };
 		FF098EFA2AB3424E003EC0FE /* Basic-Car-Maintenance.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Basic-Car-Maintenance.xcconfig"; sourceTree = SOURCE_ROOT; };
 		FF09FC902AB6FF44006BE61A /* AuthenticationView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AuthenticationView.swift; sourceTree = "<group>"; };
+		FF218EF52B00865F0025A533 /* AnalyticsService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnalyticsService.swift; sourceTree = "<group>"; };
 		FF3DDF512AA4D28F009D91C4 /* DashboardViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DashboardViewModel.swift; sourceTree = "<group>"; };
 		FF5D13A32A86C2D600BC9BD6 /* Basic-Car-Maintenance.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "Basic-Car-Maintenance.app"; sourceTree = BUILT_PRODUCTS_DIR; };
 		FF5D13A62A86C2D600BC9BD6 /* BasicCarMaintenanceApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BasicCarMaintenanceApp.swift; sourceTree = "<group>"; };
@@ -392,6 +394,7 @@
 				FF755B452A90969D00F49A13 /* Bundle+extension.swift */,
 				154984A92AD9CAEE0015594C /* Constants.swift */,
 				637505472AEFFBAC00AA5D0B /* FirebaseAnalytics+Extension.swift */,
+				FF218EF52B00865F0025A533 /* AnalyticsService.swift */,
 			);
 			path = Utilities;
 			sourceTree = "<group>";
@@ -713,6 +716,7 @@
 				FFBFE0932A98F212000A9BEB /* Vehicle.swift in Sources */,
 				FF5D13A72A86C2D600BC9BD6 /* BasicCarMaintenanceApp.swift in Sources */,
 				8014A4D12AD76034005B51F6 /* ChooseAppIconView.swift in Sources */,
+				FF218EF62B00865F0025A533 /* AnalyticsService.swift in Sources */,
 				FF748B5E2AB3589C004748A5 /* AuthenticationViewModel.swift in Sources */,
 				FF755B462A90969D00F49A13 /* Bundle+extension.swift in Sources */,
 				FFAA56ED2AC8905C000120EE /* Documentation.docc in Sources */,
diff --git a/Basic-Car-Maintenance.xcodeproj/xcshareddata/xcschemes/Basic-Car-Maintenance.xcscheme b/Basic-Car-Maintenance.xcodeproj/xcshareddata/xcschemes/Basic-Car-Maintenance.xcscheme
index 4161357f..dd1ab8c9 100644
--- a/Basic-Car-Maintenance.xcodeproj/xcshareddata/xcschemes/Basic-Car-Maintenance.xcscheme
+++ b/Basic-Car-Maintenance.xcodeproj/xcshareddata/xcschemes/Basic-Car-Maintenance.xcscheme
@@ -73,6 +73,12 @@
             ReferencedContainer = "container:Basic-Car-Maintenance.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
+      <CommandLineArguments>
+         <CommandLineArgument
+            argument = "-FIRDebugEnabled"
+            isEnabled = "NO">
+         </CommandLineArgument>
+      </CommandLineArguments>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"
diff --git a/Basic-Car-Maintenance/Shared/Dashboard/ViewModels/DashboardViewModel.swift b/Basic-Car-Maintenance/Shared/Dashboard/ViewModels/DashboardViewModel.swift
index 5cdb807a..30636e52 100644
--- a/Basic-Car-Maintenance/Shared/Dashboard/ViewModels/DashboardViewModel.swift
+++ b/Basic-Car-Maintenance/Shared/Dashboard/ViewModels/DashboardViewModel.swift
@@ -63,6 +63,8 @@ class DashboardViewModel {
                 showAddErrorAlert.toggle()
                 errorMessage = error.localizedDescription
             }
+            
+            AnalyticsService.shared.logEvent(.maintenanceCreate)
         }
     }
     
@@ -107,6 +109,9 @@ class DashboardViewModel {
                 errorMessage = error.localizedDescription
             }
         }
+        
+        AnalyticsService.shared.logEvent(.maintenanceUpdate)
+        
         await self.getMaintenanceEvents()
     }
     
@@ -130,6 +135,8 @@ class DashboardViewModel {
             showErrorAlert.toggle()
             errorMessage = error.localizedDescription
         }
+        
+        AnalyticsService.shared.logEvent(.maintenanceDelete)
     }
     
     /// Fetches the user's vehicles from Firestore based on their unique user ID.
diff --git a/Basic-Car-Maintenance/Shared/Odometer/ViewModels/OdometerViewModel.swift b/Basic-Car-Maintenance/Shared/Odometer/ViewModels/OdometerViewModel.swift
index 154d6832..95a4440d 100644
--- a/Basic-Car-Maintenance/Shared/Odometer/ViewModels/OdometerViewModel.swift
+++ b/Basic-Car-Maintenance/Shared/Odometer/ViewModels/OdometerViewModel.swift
@@ -33,6 +33,8 @@ class OdometerViewModel {
                 .firestore()
                 .collection("odometer_readings")
                 .addDocument(from: readingToAdd)
+            
+            AnalyticsService.shared.logEvent(.odometerCreate)
         }
     }
     
@@ -50,6 +52,8 @@ class OdometerViewModel {
         if let eventIndex = readings.firstIndex(of: reading) {
             readings.remove(at: eventIndex)
         }
+        
+        AnalyticsService.shared.logEvent(.odometerDelete)
     }
         
     func getOdometerReadings() async {
diff --git a/Basic-Car-Maintenance/Shared/Settings/ViewModels/AuthenticationViewModel.swift b/Basic-Car-Maintenance/Shared/Settings/ViewModels/AuthenticationViewModel.swift
index 15a5443f..49af0040 100644
--- a/Basic-Car-Maintenance/Shared/Settings/ViewModels/AuthenticationViewModel.swift
+++ b/Basic-Car-Maintenance/Shared/Settings/ViewModels/AuthenticationViewModel.swift
@@ -65,6 +65,7 @@ final class AuthenticationViewModel {
             print("User is signed in")
             if let user = Auth.auth().currentUser {
                 self.user = user
+                AnalyticsService.shared.setUserID(user.uid)
             }
         }
     }
diff --git a/Basic-Car-Maintenance/Shared/Settings/ViewModels/SettingsViewModel.swift b/Basic-Car-Maintenance/Shared/Settings/ViewModels/SettingsViewModel.swift
index d05a3a03..46ed2ae5 100644
--- a/Basic-Car-Maintenance/Shared/Settings/ViewModels/SettingsViewModel.swift
+++ b/Basic-Car-Maintenance/Shared/Settings/ViewModels/SettingsViewModel.swift
@@ -83,6 +83,8 @@ final class SettingsViewModel {
             } catch {
                 throw error
             }
+            
+            AnalyticsService.shared.logEvent(.vehicleCreate)
         }
     }
     
@@ -129,5 +131,7 @@ final class SettingsViewModel {
         } catch {
             throw error
         }
+        
+        AnalyticsService.shared.logEvent(.vehicleDelete)
     }
 }
diff --git a/Basic-Car-Maintenance/Shared/Utilities/AnalyticsService.swift b/Basic-Car-Maintenance/Shared/Utilities/AnalyticsService.swift
new file mode 100644
index 00000000..3f1400f7
--- /dev/null
+++ b/Basic-Car-Maintenance/Shared/Utilities/AnalyticsService.swift
@@ -0,0 +1,41 @@
+//
+//  AnalyticsService.swift
+//  Basic-Car-Maintenance
+//
+//  Created by Mikaela Caron on 11/11/23.
+//
+
+import Foundation
+import FirebaseAnalytics
+
+class AnalyticsService {
+    private init() { }
+    
+    static let shared = AnalyticsService()
+    
+    /// Log an `AnalyticEvent` that happened
+    /// - Parameter event: The event that happened
+    /// - Parameter parameters: Extra parameters for more information about this event, if needed
+    func logEvent(_ event: AnalyticEvent, with parameters: [String: String] = [:]) {
+        Analytics.logEvent(event.rawValue, parameters: parameters)
+    }
+    
+    func setUserID(_ id: String) {
+        Analytics.setUserID(id)
+    }
+}
+
+enum AnalyticEvent: String {
+    
+    case maintenanceCreate = "maintenance_create"
+    case maintenanceUpdate = "maintenance_update"
+    case maintenanceDelete = "maintenance_delete"
+    
+    case odometerCreate = "odometer_create"
+    case odometerUpdate = "odometer_update"
+    case odometerDelete = "odometer_delete"
+    
+    case vehicleCreate = "vehicle_create"
+    case vehicleUpdate = "vehicle_update"
+    case vehicleDelete = "vehicle_delete"
+}