[feat] #192 Firebase Analytics(GA4) 이벤트 로깅 추가

app/build.gradle.kts

@@ -71,6 +71,7 @@ dependencies {
     implementation(projects.core.model)
     implementation(projects.core.navigation)
     implementation(projects.core.ui)
+    implementation(projects.core.analytics)
     implementation(projects.feature.auth.api)
     implementation(projects.feature.auth.impl)
     implementation(projects.feature.pose.api)
@@ -89,7 +90,6 @@ dependencies {
     implementation(libs.timber)
 
     implementation(platform(libs.firebase.bom))
-    implementation(libs.firebase.analytics)
     implementation(libs.firebase.crashlytics)
 
     implementation(libs.androidx.activity.compose)

build-logic/src/main/java/com/neki/android/buildlogic/plugins/AndroidFeatureImplConventionPlugin.kt

@@ -18,6 +18,7 @@ class AndroidFeatureImplConventionPlugin : Plugin<Project> {
                 "implementation"(project(":core:common"))
                 "implementation"(project(":core:domain"))
                 "implementation"(project(":core:ui"))
+                "implementation"(project(":core:analytics"))
 
                 "implementation"(libs.findLibrary("androidx.hilt.lifecycle.viewModel.compose").get())
             }

core/analytics/build.gradle.kts

@@ -0,0 +1,13 @@
+plugins {
+    alias(libs.plugins.neki.android.library)
+    alias(libs.plugins.neki.hilt)
+}
+
+android {
+    namespace = "com.neki.android.core.analytics"
+}
+
+dependencies {
+    implementation(platform(libs.firebase.bom))
+    implementation(libs.firebase.analytics)
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/AnalyticsEvent.kt

@@ -0,0 +1,8 @@
+package com.neki.android.core.analytics.event
+
+sealed interface AnalyticsEvent {
+
+    val name: String
+    val params: Map<String, Any>
+        get() = emptyMap()
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/ArchiveAnalyticsEvent.kt

@@ -0,0 +1,49 @@
+package com.neki.android.core.analytics.event
+
+sealed interface ArchiveAnalyticsEvent : AnalyticsEvent {
+
+    data object ArchivingView : ArchiveAnalyticsEvent {
+        override val name = "archiving_view"
+    }
+
+    data class PhotoUpload(val method: String, val count: Int) : ArchiveAnalyticsEvent {
+        override val name = "photo_upload"
+        override val params = mapOf(
+            "method" to method,
+            "count" to count,
+        )
+    }
+
+    data object AlbumCreate : ArchiveAnalyticsEvent {
+        override val name = "album_create"
+    }
+
+    data class AlbumAddFromDetail(val albumCount: Int) : ArchiveAnalyticsEvent {
+        override val name = "album_add_from_detail"
+        override val params = mapOf("album_count" to albumCount)
+    }
+
+    data class AlbumAddFromMulti(val photoCount: Int, val albumCount: Int) : ArchiveAnalyticsEvent {
+        override val name = "album_add_from_multi"
+        override val params = mapOf(
+            "photo_count" to photoCount,
+            "album_count" to albumCount,
+        )
+    }
+
+    data object PhotoMove : ArchiveAnalyticsEvent {
+        override val name = "photo_move"
+    }
+
+    data object PhotoCopy : ArchiveAnalyticsEvent {
+        override val name = "photo_copy"
+    }
+
+    data object PhotoDetailView : ArchiveAnalyticsEvent {
+        override val name = "photo_detail_view"
+    }
+
+    data object PhotoMemoCreate : ArchiveAnalyticsEvent {
+        override val name = "photo_memo_create"
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/GlobalAnalyticsEvent.kt

@@ -0,0 +1,8 @@
+package com.neki.android.core.analytics.event
+
+sealed interface GlobalAnalyticsEvent : AnalyticsEvent {
+
+    data object AppOpen : GlobalAnalyticsEvent {
+        override val name = "app_open"
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/MapAnalyticsEvent.kt

@@ -0,0 +1,42 @@
+package com.neki.android.core.analytics.event
+
+sealed interface MapAnalyticsEvent : AnalyticsEvent {
+
+    data object MapView : MapAnalyticsEvent {
+        override val name = "map_view"
+    }
+
+    data class MapReSearch(val hasFilter: Boolean, val regionChanged: Boolean) : MapAnalyticsEvent {
+        override val name = "map_re_search"
+        override val params = mapOf(
+            "has_filter" to hasFilter,
+            "region_changed" to regionChanged,
+        )
+    }
+
+    data class MapBrandFilterToggle(
+        val action: String,
+        val selectedCount: Int,
+        val brandName: String,
+    ) : MapAnalyticsEvent {
+        override val name = "map_brand_filter_toggle"
+        override val params = mapOf(
+            "action" to action,
+            "selected_count" to selectedCount,
+            "brand_name" to brandName,
+        )
+    }
+
+    data class BoothSelect(val entryPoint: String, val brandName: String) : MapAnalyticsEvent {
+        override val name = "booth_select"
+        override val params = mapOf(
+            "entry_point" to entryPoint,
+            "brand_name" to brandName,
+        )
+    }
+
+    data class MapRouteClick(val mapType: String) : MapAnalyticsEvent {
+        override val name = "map_route_click"
+        override val params = mapOf("map_type" to mapType)
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/MypageAnalyticsEvent.kt

@@ -0,0 +1,12 @@
+package com.neki.android.core.analytics.event
+
+sealed interface MypageAnalyticsEvent : AnalyticsEvent {
+
+    data object Logout : MypageAnalyticsEvent {
+        override val name = "mypage_logout"
+    }
+
+    data object Withdraw : MypageAnalyticsEvent {
+        override val name = "mypage_withdraw"
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/event/PoseAnalyticsEvent.kt

@@ -0,0 +1,30 @@
+package com.neki.android.core.analytics.event
+
+sealed interface PoseAnalyticsEvent : AnalyticsEvent {
+
+    data object PoseView : PoseAnalyticsEvent {
+        override val name = "pose_view"
+    }
+
+    data object PoseRandomStart : PoseAnalyticsEvent {
+        override val name = "pose_random_start"
+    }
+
+    data class PoseRandomSessionEnd(val totalSwipeCount: Int) : PoseAnalyticsEvent {
+        override val name = "pose_random_session_end"
+        override val params = mapOf("total_swipe_count" to totalSwipeCount)
+    }
+
+    data class PoseFilterToggle(val peopleCount: Int) : PoseAnalyticsEvent {
+        override val name = "pose_filter_toggle"
+        override val params = mapOf("people_count" to peopleCount)
+    }
+
+    data object PoseBookmarkFilter : PoseAnalyticsEvent {
+        override val name = "pose_bookmark_filter"
+    }
+
+    data object PoseBookmark : PoseAnalyticsEvent {
+        override val name = "pose_bookmark"
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/logger/AnalyticsLogger.kt

@@ -0,0 +1,9 @@
+package com.neki.android.core.analytics.logger
+
+import com.neki.android.core.analytics.event.AnalyticsEvent
+
+interface AnalyticsLogger {
+    fun log(event: AnalyticsEvent)
+    fun setUserId(userId: String)
+    fun setUserProperty(key: String, value: String)
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/logger/AnalyticsModule.kt

@@ -0,0 +1,28 @@
+package com.neki.android.core.analytics.logger
+
+import android.content.Context
+import com.google.firebase.analytics.FirebaseAnalytics
+import dagger.Binds
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.android.qualifiers.ApplicationContext
+import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+internal abstract class AnalyticsModule {
+
+    @Binds
+    @Singleton
+    abstract fun bindAnalyticsLogger(impl: FirebaseAnalyticsLogger): AnalyticsLogger
+
+    companion object {
+        @Provides
+        @Singleton
+        fun provideFirebaseAnalytics(
+            @ApplicationContext context: Context,
+        ): FirebaseAnalytics = FirebaseAnalytics.getInstance(context)
+    }
+}

core/analytics/src/main/kotlin/com/neki/android/core/analytics/logger/FirebaseAnalyticsLogger.kt

@@ -0,0 +1,35 @@
+package com.neki.android.core.analytics.logger
+
+import android.os.Bundle
+import com.google.firebase.analytics.FirebaseAnalytics
+import com.neki.android.core.analytics.event.AnalyticsEvent
+import javax.inject.Inject
+
+internal class FirebaseAnalyticsLogger @Inject constructor(
+    private val firebaseAnalytics: FirebaseAnalytics,
+) : AnalyticsLogger {
+
+    override fun log(event: AnalyticsEvent) {
+        val bundle = Bundle().apply {
+            event.params.forEach { (key, value) ->
+                when (value) {
+                    is String -> putString(key, value)
+                    is Int -> putInt(key, value)
+                    is Long -> putLong(key, value)
+                    is Double -> putDouble(key, value)
+                    is Boolean -> putBoolean(key, value)
+                    else -> putString(key, value.toString())
+                }
+            }
+        }
+        firebaseAnalytics.logEvent(event.name, bundle)
+    }
+
+    override fun setUserId(userId: String) {
+        firebaseAnalytics.setUserId(userId)
+    }
+
+    override fun setUserProperty(key: String, value: String) {
+        firebaseAnalytics.setUserProperty(key, value)
+    }
+}

feature/archive/impl/src/main/kotlin/com/neki/android/feature/archive/impl/album/AllAlbumViewModel.kt

@@ -2,6 +2,8 @@ package com.neki.android.feature.archive.impl.album
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
+import com.neki.android.core.analytics.event.ArchiveAnalyticsEvent
+import com.neki.android.core.analytics.logger.AnalyticsLogger
 import com.neki.android.core.dataapi.repository.FolderRepository
 import com.neki.android.core.dataapi.repository.PhotoRepository
 import com.neki.android.core.model.AlbumPreview
@@ -22,6 +24,7 @@ import javax.inject.Inject
 class AllAlbumViewModel @Inject constructor(
     private val photoRepository: PhotoRepository,
     private val folderRepository: FolderRepository,
+    private val analyticsLogger: AnalyticsLogger,
 ) : ViewModel() {
 
     val store: MviIntentStore<AllAlbumState, AllAlbumIntent, AllAlbumSideEffect> =
@@ -182,6 +185,7 @@ class AllAlbumViewModel @Inject constructor(
         viewModelScope.launch {
             folderRepository.createFolder(name = albumName)
                 .onSuccess {
+                    analyticsLogger.log(ArchiveAnalyticsEvent.AlbumCreate)
                     fetchFolders(reduce)
                     postSideEffect(AllAlbumSideEffect.ShowToastMessage("새로운 앨범을 추가했어요"))
                     postSideEffect(AllAlbumSideEffect.NotifyResult)

feature/archive/impl/src/main/kotlin/com/neki/android/feature/archive/impl/album_detail/AlbumDetailViewModel.kt

@@ -8,6 +8,8 @@ import androidx.paging.PagingData
 import androidx.paging.cachedIn
 import androidx.paging.filter
 import androidx.paging.map
+import com.neki.android.core.analytics.event.ArchiveAnalyticsEvent
+import com.neki.android.core.analytics.logger.AnalyticsLogger
 import com.neki.android.core.dataapi.repository.FolderRepository
 import com.neki.android.core.dataapi.repository.PhotoRepository
 import com.neki.android.core.domain.usecase.UploadMultiplePhotoUseCase
@@ -41,6 +43,7 @@ class AlbumDetailViewModel @AssistedInject constructor(
     private val photoRepository: PhotoRepository,
     private val folderRepository: FolderRepository,
     private val uploadMultiplePhotoUseCase: UploadMultiplePhotoUseCase,
+    private val analyticsLogger: AnalyticsLogger,
 ) : ViewModel() {
 
     @AssistedFactory
@@ -245,7 +248,7 @@ class AlbumDetailViewModel @AssistedInject constructor(
         }
         postSideEffect(
             AlbumDetailSideEffect.NavigateToSelectAlbum(
-                SelectAlbumAction.CopyPhotos(photoIds = photoIds),
+                SelectAlbumAction.CopyPhotos(photoIds = photoIds, fromPhotoDetail = false),
             ),
         )
     }
@@ -310,6 +313,7 @@ class AlbumDetailViewModel @AssistedInject constructor(
                 photoIds = state.importPhotoState.selectedPhotoIds.toList(),
                 targetFolderIds = listOf(albumId),
             ).onSuccess {
+                analyticsLogger.log(ArchiveAnalyticsEvent.PhotoCopy)
                 reduce { copy(isShowImportPhotoBottomSheet = false, importPhotoState = ImportPhotoState()) }
                 _importAlbumFilter.value = null
                 postSideEffect(AlbumDetailSideEffect.ShowToastMessage("사진을 앨범에 추가했어요"))

feature/archive/impl/src/main/kotlin/com/neki/android/feature/archive/impl/main/ArchiveMainScreen.kt

@@ -14,6 +14,7 @@ import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridCells
 import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridItemSpan
 import androidx.compose.foundation.lazy.staggeredgrid.rememberLazyStaggeredGridState
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
@@ -60,6 +61,10 @@ internal fun ArchiveMainRoute(
     val lazyState = rememberLazyStaggeredGridState()
     val nekiToast = remember { NekiToast(context) }
 
+    LaunchedEffect(Unit) {
+        viewModel.logArchivingView()
+    }
+
     viewModel.store.sideEffects.collectWithLifecycle { sideEffect ->
         when (sideEffect) {
             ArchiveMainSideEffect.NavigateToQRScan -> navigateToQRScan()

feature/archive/impl/src/main/kotlin/com/neki/android/feature/archive/impl/main/ArchiveMainViewModel.kt

@@ -3,6 +3,8 @@ package com.neki.android.feature.archive.impl.main
 import androidx.compose.foundation.text.input.TextFieldState
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
+import com.neki.android.core.analytics.event.ArchiveAnalyticsEvent
+import com.neki.android.core.analytics.logger.AnalyticsLogger
 import com.neki.android.core.dataapi.repository.FolderRepository
 import com.neki.android.core.dataapi.repository.PhotoRepository
 import com.neki.android.core.dataapi.repository.UserRepository
@@ -26,6 +28,7 @@ class ArchiveMainViewModel @Inject constructor(
     private val photoRepository: PhotoRepository,
     private val folderRepository: FolderRepository,
     private val userRepository: UserRepository,
+    private val analyticsLogger: AnalyticsLogger,
 ) : ViewModel() {
 
     val store: MviIntentStore<ArchiveMainState, ArchiveMainIntent, ArchiveMainSideEffect> =
@@ -39,6 +42,10 @@ class ArchiveMainViewModel @Inject constructor(
         store.onIntent(ArchiveMainIntent.EnterArchiveMainScreen)
     }
 
+    fun logArchivingView() {
+        analyticsLogger.log(ArchiveAnalyticsEvent.ArchivingView)
+    }
+
     private fun onIntent(
         intent: ArchiveMainIntent,
         state: ArchiveMainState,
@@ -173,6 +180,7 @@ class ArchiveMainViewModel @Inject constructor(
         viewModelScope.launch {
             folderRepository.createFolder(name = albumName)
                 .onSuccess {
+                    analyticsLogger.log(ArchiveAnalyticsEvent.AlbumCreate)
                     fetchFolders(reduce)
                     postSideEffect(ArchiveMainSideEffect.ShowToastMessage("새로운 앨범을 추가했어요"))
                 }

feature/archive/impl/src/main/kotlin/com/neki/android/feature/archive/impl/navigation/ArchiveEntryProvider.kt

@@ -109,7 +109,7 @@ private fun EntryProviderScope<NavKey>.archiveEntry(navigator: MainNavigator) {
             navigateToPhotoDetail = navigator::navigateToPhotoDetail,
             navigateToSelectAlbum = { photoIds ->
                 navigator.navigateToSelectAlbum(
-                    action = SelectAlbumAction.CopyPhotos(photoIds = photoIds),
+                    action = SelectAlbumAction.CopyPhotos(photoIds = photoIds, fromPhotoDetail = false),
                     title = "앨범에 추가",
                     multiSelect = true,
                 )
@@ -189,7 +189,7 @@ private fun EntryProviderScope<NavKey>.archiveEntry(navigator: MainNavigator) {
             navigateBack = navigator::goBack,
             navigateToSelectAlbum = { photoId ->
                 navigator.navigateToSelectAlbum(
-                    action = SelectAlbumAction.CopyPhotos(listOf(photoId), false),
+                    action = SelectAlbumAction.CopyPhotos(photoIds = listOf(photoId), fromPhotoDetail = true),
                     title = "모든 앨범",
                     multiSelect = false,
                 )