(chore): Fix Swift-Lint issues and complete SCIDAuthService

Author: N3v1

ScribbleLab/Misc/User.swift

@@ -35,7 +35,8 @@ import FirebaseAuth
 /// A model that represents a user in the ScribbleLab application.
 ///
 /// `SLUser` holds essential user information, such as a unique identifier, username, email, and profile image URL.
-/// Additionally, it offers a computed property to determine if the `SLUser` instance represents the currently logged-in user.
+/// Additionally, it offers a computed property to determine if the `SLUser` instance represents the currently
+/// logged-in user.
 ///
 /// - Note: `SLUser` conforms to `Identifiable`, `Hashable`, and `Codable`, making it suitable for lists, comparison,
 ///         and serialization.
@@ -54,7 +55,7 @@ struct SLUser: Identifiable, Hashable, Codable {
     /// An optional URL string pointing to the user’s profile image.
     ///
     /// This image is displayed as the user’s avatar within the application. If `nil`, a default image can be used.
-    var profileImageUrl: String? = nil
+    var profileImageUrl: String?
 
     /// The user's full name.
     ///

ScribbleLab/Services/SCIDAuthentication/SCIDAuthService.swift

@@ -30,6 +30,7 @@
 //  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import Foundation
+import Firebase
 import FirebaseAuth
 import ScribbleFoundation
 
@@ -46,17 +47,23 @@ class SCIDAuthService: Authenticatable {
     }
 
     /// Attempts to log in with the provided email and password asynchronously.
+    ///
     /// - Parameters:
     ///   - email: The email for login.
     ///   - password: The password for login.
-    ///
-    func logIn(withEmail email: String, password: String) async throws {
+    func logIn(
+        withEmail email: String,
+        password: String
+    ) async throws {
         do {
-            let result = try await Auth.auth().signIn(withEmail: email, password: password)
+            let result = try await Auth.auth().signIn(withEmail: email,
+                                                      password: password)
             self.userSession = result.user
             try await loadUserData()
         } catch {
-            ScribbleLabApp().logger.error("Failed to log in with error \(error.localizedDescription)")
+            ScribbleLabApp().logger.error(
+                "Failed to log in with error \(error.localizedDescription) - AUT-E101"
+            )
         }
     }
 
@@ -72,34 +79,123 @@ class SCIDAuthService: Authenticatable {
     ///   - username: The username for the new user account.
     ///
     /// - Throws: An error if user registration fails.
-    ///
-    func createUser(email: String, password: String, username: String) async throws {
+    func createUser(
+        email: String,
+        password: String,
+        username: String
+    ) async throws {
         do {
-            let result = try await Auth.auth().createUser(withEmail: email, password: password)
+            let result = try await Auth.auth().createUser(withEmail: email,
+                                                          password: password)
             self.userSession = result.user
-            await uploadUserData(uid: result.user.uid, username: username, email: email)
+            await uploadUserData(
+                uid: result.user.uid,
+                username: username,
+                email: email
+            )
         } catch {
-            ScribbleLabApp().logger.error("Failed to create user with error \(error.localizedDescription)")
+            ScribbleLabApp().logger.error(
+                "Failed to create user with error \(error.localizedDescription) - AUT-E102"
+            )
         }
     }
 
+    /// Loads user data for the currently authenticated user.
+    ///
+    /// This function asynchronously loads user data for the currently authenticated user.
+    /// It retrieves user session information and fetches the corresponding user data based on the session UID.
+    /// The loaded user information includes details like username, email, etc.
+    ///
+    /// - Throws: An error if there's an issue while loading user data.
     func loadUserData() async throws {
         self.userSession = Auth.auth().currentUser
         guard let currentUid = userSession?.uid else { return }
-//        self.currentUser = try await
+        self.currentUser = try await SCIDUserService.fetchUser(withUid: currentUid)
     }
 
+    /// Signs the current user out of the application.
+    ///
+    /// This function signs out the current user session from the application.
+    /// It revokes the authentication session and clears any user-related data in the app.
+    ///
+    /// The function sets the user session and current user information to `nil` after sign-out.
+    ///
+    /// - Note: Any unsaved data or changes might be lost after calling this function.
     nonisolated func signOut() {
-        
+        Task {
+            do {
+                try Auth.auth().signOut()
+
+                await MainActor.run {
+                    self.userSession = nil
+                    self.currentUser = nil
+                }
+            } catch {
+                await ScribbleLabApp().logger.error(
+                    "Failed to sign out due to error \(error.localizedDescription) - AUT-E103"
+                )
+            }
+        }
     }
 
-    static func resetPassword(email: String, resetCompletion: @escaping (Result<Bool, any Error>) -> Void) {
-        
+    /// Sends a password reset request for the provided email.
+    ///
+    /// This function initiates a password reset request for the given email address.
+    ///
+    /// - Parameters:
+    ///   - email: The email address for which the password reset is requested.
+    ///   - resetCompletion: A closure indicating the result of the password reset request.
+    ///
+    /// - Note: The result is delivered asynchronously via the provided closure.
+    static func resetPassword(
+        email: String,
+        resetCompletion: @escaping (Result<Bool, any Error>
+    ) -> Void) {
+        Auth.auth().sendPasswordReset(withEmail: email) { (error) in
+            if let error = error {
+                resetCompletion(.failure(error))
+            } else {
+                resetCompletion(.success(true))
+            }
+        }
     }
 
-    func uploadUserData(uid: String, username: String, email: String) async {
+    /// Uploads user data to Firestore.
+    ///
+    /// This private function creates a user object using the provided details, sets it as the current user,
+    /// encodes it, and then uploads it to Firestore.
+    ///
+    /// - Parameters:
+    ///   - uid: The unique identifier for the user.
+    ///   - username: The username associated with the user.
+    ///   - email: The email address associated with the user.
+    ///
+    /// - Note: This function sets the current user with the provided details and uploads it to Firestore.
+    ///         It is a private function and should be called from within the `SLAuthService`.
+    ///
+    /// > WARNING
+    /// > This function is called internally by the `SLAuthService` and should not typically be accessed directly.
+    ///
+    func uploadUserData(
+        uid: String,
+        username: String,
+        email: String
+    ) async {
+        let user = SLUser(id: uid, username: username, email: email)
+        self.currentUser = user
 
+        do {
+            let encodedUser = try JSONEncoder().encode(user)
+            if let userData = try JSONSerialization.jsonObject(
+                with: encodedUser,
+                options: []
+            ) as? [String: Any] {
+                try await Firestore.firestore().collection("users").document(user.id).setData(userData)
+            }
+        } catch {
+            ScribbleLabApp().logger.error(
+                "Failed to upload user data \(error.localizedDescription) - SLUSRS-E204"
+            )
+        }
     }
-    
-    
 }