[#313] Firestore 경로를 enum으로 정리한다 (#316)

opficdev · web-flow · commit acdb5fd7853b · 2026-03-26T10:01:40.000+09:00
* style: Firestore 관리를 enum으로 처리

* fix: 기존 경로와 다른 값이 들어가는 현상 해결
diff --git a/DevLog/Infra/Common/FirestorePath.swift b/DevLog/Infra/Common/FirestorePath.swift
@@ -0,0 +1,61 @@
+//
+//  FirestorePath.swift
+//  DevLog
+//
+//  Created by opfic on 3/26/26.
+//
+
+enum FirestorePath {
+    private enum Collection: String {
+        case users
+        case userData
+        case counters
+        case todoLists
+        case notifications
+        case webPages
+    }
+
+    enum UserData: String {
+        case info
+        case tokens
+        case settings
+    }
+
+    enum Counter: String {
+        case todo
+    }
+
+    static func user(_ uid: String) -> String {
+        "\(Collection.users.rawValue)/\(uid)"
+    }
+
+    static func userData(_ uid: String, document: UserData? = nil) -> String {
+        let path = "\(user(uid))/\(Collection.userData.rawValue)"
+        guard let document else { return path }
+        return "\(path)/\(document.rawValue)"
+    }
+
+    static func counter(_ uid: String, document: Counter) -> String {
+        "\(user(uid))/\(Collection.counters.rawValue)/\(document.rawValue)"
+    }
+
+    static func todos(_ uid: String) -> String {
+        "\(user(uid))/\(Collection.todoLists.rawValue)"
+    }
+
+    static func todo(_ uid: String, todoId: String) -> String {
+        "\(todos(uid))/\(todoId)"
+    }
+
+    static func notifications(_ uid: String) -> String {
+        "\(user(uid))/\(Collection.notifications.rawValue)"
+    }
+
+    static func webPages(_ uid: String) -> String {
+        "\(user(uid))/\(Collection.webPages.rawValue)"
+    }
+
+    static func webPage(_ uid: String, documentId: String) -> String {
+        "\(webPages(uid))/\(documentId)"
+    }
+}
diff --git a/DevLog/Infra/Service/AuthService.swift b/DevLog/Infra/Service/AuthService.swift
@@ -52,8 +52,7 @@ final class AuthService {
 
         do {
             let document = try await store
-                .collection("users/\(uid)/userData")
-                .document("info")
+                .document(FirestorePath.userData(uid, document: .info))
                 .getDocument()
 
             let providerID = document.data()?["currentProvider"] as? String
diff --git a/DevLog/Infra/Service/PushNotificationService.swift b/DevLog/Infra/Service/PushNotificationService.swift
@@ -30,7 +30,7 @@ final class PushNotificationService {
         }
 
         do {
-            let settingsRef = store.document("users/\(uid)/userData/settings")
+            let settingsRef = store.document(FirestorePath.userData(uid, document: .settings))
             let doc = try await settingsRef.getDocument()
 
             if let allowPush = doc.data()?["allowPushNotification"] as? Bool {
@@ -56,7 +56,7 @@ final class PushNotificationService {
         }
 
         do {
-            let settingsRef = store.document("users/\(uid)/userData/settings")
+            let settingsRef = store.document(FirestorePath.userData(uid, document: .settings))
             let doc = try await settingsRef.getDocument()
 
             guard let hour = doc.data()?["pushNotificationHour"] as? Int else {
@@ -84,7 +84,7 @@ final class PushNotificationService {
         }
 
         do {
-            let settingsRef = store.document("users/\(uid)/userData/settings")
+            let settingsRef = store.document(FirestorePath.userData(uid, document: .settings))
 
             var dict: [String: Any] = ["allowPushNotification": isEnabled]
 
@@ -182,7 +182,7 @@ final class PushNotificationService {
         guard let uid = Auth.auth().currentUser?.uid else { throw AuthError.notAuthenticated }
 
         let subject = PassthroughSubject<Int, Error>()
-        let listener = store.collection("users/\(uid)/notifications")
+        let listener = store.collection(FirestorePath.notifications(uid))
             .whereField("isRead", isEqualTo: false)
             .addSnapshotListener { snapshot, error in
                 if let error {
@@ -237,7 +237,7 @@ final class PushNotificationService {
                 throw AuthError.notAuthenticated
             }
 
-            let collection = store.collection("users/\(uid)/notifications")
+            let collection = store.collection(FirestorePath.notifications(uid))
             let snapshot = try await collection.whereField("todoId", isEqualTo: todoId).getDocuments()
 
             guard let document = snapshot.documents.first else {
@@ -264,7 +264,7 @@ private extension PushNotificationService {
         uid: String,
         query: PushNotificationQuery
     ) -> Query {
-        var firestoreQuery: Query = store.collection("users/\(uid)/notifications")
+        var firestoreQuery: Query = store.collection(FirestorePath.notifications(uid))
 
         if let thresholdDate = query.timeFilter.thresholdDate {
             firestoreQuery = firestoreQuery.whereField(
diff --git a/DevLog/Infra/Service/SocialLogin/AppleAuthenticationService.swift b/DevLog/Infra/Service/SocialLogin/AppleAuthenticationService.swift
@@ -66,7 +66,9 @@ final class AppleAuthenticationService: AuthenticationService {
 
             // 이미 가입된 사용자일 경우 Firestore에서 사용자 이름 가져오기
             if displayName == nil {
-                let doc = try await store.document("users/\(result.user.uid)/userData/info").getDocument()
+                let doc = try await store
+                    .document(FirestorePath.userData(result.user.uid, document: .info))
+                    .getDocument()
                 displayName = doc.data()?["appleName"] as? String
             }
 
@@ -97,7 +99,7 @@ final class AppleAuthenticationService: AuthenticationService {
 
     func signOut(_ uid: String) async throws {
         do {
-            let infoRef = store.document("users/\(uid)/userData/tokens")
+            let infoRef = store.document(FirestorePath.userData(uid, document: .tokens))
             let doc = try await infoRef.getDocument()
 
             if doc.exists {
@@ -166,7 +168,7 @@ final class AppleAuthenticationService: AuthenticationService {
             logger.info("Starting Apple access token revocation for unlink. uid: \(uid)")
             try await revokeAppleAccessToken(token: accessToken)
 
-            let tokensRef = store.document("users/\(uid)/userData/tokens")
+            let tokensRef = store.document(FirestorePath.userData(uid, document: .tokens))
 
             logger.info("Starting Apple token document fetch for unlink. uid: \(uid)")
             let doc = try await tokensRef.getDocument()
diff --git a/DevLog/Infra/Service/SocialLogin/GithubAuthenticationService.swift b/DevLog/Infra/Service/SocialLogin/GithubAuthenticationService.swift
@@ -74,7 +74,7 @@ final class GithubAuthenticationService: NSObject, AuthenticationService {
 
     func signOut(_ uid: String) async throws {
         do {
-            let infoRef = store.document("users/\(uid)/userData/tokens")
+            let infoRef = store.document(FirestorePath.userData(uid, document: .tokens))
             let doc = try await infoRef.getDocument()
 
             if doc.exists {
@@ -103,7 +103,7 @@ final class GithubAuthenticationService: NSObject, AuthenticationService {
         logger.info("Linking GitHub account for user: \(uid)")
         
         do {
-            let tokensRef = store.document("users/\(uid)/userData/tokens")
+            let tokensRef = store.document(FirestorePath.userData(uid, document: .tokens))
             let authorizationCode = try await requestAuthorizationCode()
             let (accessToken, _) = try await requestTokens(authorizationCode: authorizationCode)
 
@@ -138,7 +138,7 @@ final class GithubAuthenticationService: NSObject, AuthenticationService {
             logger.info("Starting GitHub access token revocation for unlink. uid: \(uid)")
             try await revokeAccessToken()
 
-            let tokensRef = store.document("users/\(uid)/userData/tokens")
+            let tokensRef = store.document(FirestorePath.userData(uid, document: .tokens))
 
             logger.info("Starting GitHub access token deletion from Firestore for unlink. uid: \(uid)")
             try await tokensRef.updateData(["githubAccessToken": FieldValue.delete()])
diff --git a/DevLog/Infra/Service/SocialLogin/GoogleAuthenticationService.swift b/DevLog/Infra/Service/SocialLogin/GoogleAuthenticationService.swift
@@ -61,7 +61,7 @@ final class GoogleAuthenticationService: AuthenticationService {
 
     func signOut(_ uid: String) async throws {
         do {
-            let infoRef = store.document("users/\(uid)/userData/tokens")
+            let infoRef = store.document(FirestorePath.userData(uid, document: .tokens))
             let doc = try await infoRef.getDocument()
 
             if doc.exists {
diff --git a/DevLog/Infra/Service/TodoService.swift b/DevLog/Infra/Service/TodoService.swift
@@ -158,7 +158,7 @@ final class TodoService {
         logger.info("Upserting todo")
         
         do {
-            let collection = store.collection("users/\(uid)/todoLists/")
+            let collection = store.collection(FirestorePath.todos(uid))
             let docRef = collection.document(request.id)
             var data = try encoder.encode(request)
             data.removeValue(forKey: TodoFieldKey.id.rawValue)
@@ -174,7 +174,9 @@ final class TodoService {
             try await upsertTodoWithNumberOnCreate(
                 data,
                 for: docRef,
-                counterRef: store.collection("users/\(uid)/counters/").document("todo")
+                counterRef: store.document(
+                    FirestorePath.counter(uid, document: .todo)
+                )
             )
             
             logger.info("Successfully upserted todo")
@@ -222,7 +224,7 @@ final class TodoService {
         logger.info("Fetching todo")
 
         do {
-            let docRef = store.collection("users/\(uid)/todoLists/").document(todoId)
+            let docRef = store.document(FirestorePath.todo(uid, todoId: todoId))
             let snapshot = try await docRef.getDocument()
             guard snapshot.exists, let todo = makeResponse(from: snapshot) else {
                 throw FirestoreError.dataNotFound("Todo")
@@ -242,7 +244,7 @@ final class TodoService {
         let uniqueNumbers = Array(Set(numbers)).sorted()
         if uniqueNumbers.isEmpty { return [:] }
 
-        let collection = store.collection("users/\(uid)/todoLists/")
+        let collection = store.collection(FirestorePath.todos(uid))
         let snapshots = try await withThrowingTaskGroup(of: [QueryDocumentSnapshot].self) { group in
             for chunk in uniqueNumbers.chunked(maxCount: 10) {
                 group.addTask {
@@ -349,7 +351,7 @@ private extension TodoService {
     }
 
     func makeQuery(uid: String, query: TodoQuery) -> Query {
-        let collection = store.collection("users/\(uid)/todoLists/")
+        let collection = store.collection(FirestorePath.todos(uid))
 
         switch query.sortTarget {
         case .dueDate:
diff --git a/DevLog/Infra/Service/UserService.swift b/DevLog/Infra/Service/UserService.swift
@@ -22,11 +22,11 @@ final class UserService {
         }
 
         do {
-            let userRef = store.document("users/\(user.uid)")
-            let infoRef = store.document("users/\(user.uid)/userData/info")
-            let tokensRef = store.document("users/\(user.uid)/userData/tokens")
-            let settingsRef = store.document("users/\(user.uid)/userData/settings")
-            let todoCounterRef = store.document("users/\(user.uid)/counters/todo")
+            let userRef = store.document(FirestorePath.user(user.uid))
+            let infoRef = store.document(FirestorePath.userData(user.uid, document: .info))
+            let tokensRef = store.document(FirestorePath.userData(user.uid, document: .tokens))
+            let settingsRef = store.document(FirestorePath.userData(user.uid, document: .settings))
+            let todoCounterRef = store.document(FirestorePath.counter(user.uid, document: .todo))
 
             // 사용자 기본 정보
             var userField: [String: Any] = [
@@ -115,7 +115,7 @@ final class UserService {
         }
 
         do {
-            let infoRef = store.document("users/\(uid)/userData/info")
+            let infoRef = store.document(FirestorePath.userData(uid, document: .info))
             let data = try await infoRef.getDocument().data()
 
             guard let provider = data?["currentProvider"] as? String,
@@ -149,7 +149,7 @@ final class UserService {
         }
 
         do {
-            let infoRef = store.document("users/\(uid)/userData/info")
+            let infoRef = store.document(FirestorePath.userData(uid, document: .info))
             try await infoRef.setData(["statusMsg": message], merge: true)
             logger.info("Successfully upserted status message")
         } catch {
@@ -167,7 +167,7 @@ final class UserService {
         logger.info("Updating FCM token for user: \(userId)")
         
         do {
-            let tokensRef = store.document("users/\(userId)/userData/tokens")
+            let tokensRef = store.document(FirestorePath.userData(userId, document: .tokens))
             try await tokensRef.setData(["fcmToken": fcmToken], merge: true)
             logger.info("Successfully updated FCM token")
         } catch {
@@ -185,7 +185,7 @@ final class UserService {
         logger.info("Updating timeZone for user: \(userId)")
 
         do {
-            let settingsRef = store.document("users/\(userId)/userData/settings")
+            let settingsRef = store.document(FirestorePath.userData(userId, document: .settings))
             try await settingsRef.setData(
                 ["timeZone": TimeZone.autoupdatingCurrent.identifier],
                 merge: true
diff --git a/DevLog/Infra/Service/WebPageService.swift b/DevLog/Infra/Service/WebPageService.swift
@@ -30,7 +30,7 @@ final class WebPageService {
         }
 
         do {
-            let collectionRef = store.collection("users/\(uid)/webPages")
+            let collectionRef = store.collection(FirestorePath.webPages(uid))
             let snapshot = try await collectionRef.getDocuments()
             let items: [WebPageResponse] = snapshot.documents.compactMap { makeResponse(from: $0) }
 
@@ -63,7 +63,7 @@ final class WebPageService {
 
         do {
             let documentID = documentID(for: request.url)
-            let docRef = store.document("users/\(uid)/webPages/\(documentID)")
+            let docRef = store.document(FirestorePath.webPage(uid, documentId: documentID))
             let data = try encoder.encode(request)
             try await docRef.setData(data, merge: true)
             logger.info("Successfully upserted web page")
