[FEAT/#386] 믹스패널 붙였어요

.github/workflows/pr_builder.yml

@@ -47,6 +47,7 @@ jobs:
           RELEASE_KEY_PASSWORD: ${{ secrets.RELEASE_KEY_PASSWORD }}
           RELEASE_STORE_PASSWORD: ${{ secrets.RELEASE_STORE_PASSWORD }}
           NATIVE_APP_KEY: ${{ secrets.NATIVE_APP_KEY }}
+          MIXPANEL_KEY: ${{ secrets.MIXPANEL_KEY }}
         run: |
           echo prod.base.url=\"$PROD_BASE_URL\" >> local.properties
           echo dev.base.url=\"$DEV_BASE_URL\" >> local.properties
@@ -57,6 +58,8 @@ jobs:
           echo storePassword=$RELEASE_STORE_PASSWORD >> local.properties
           echo native.app.key=\"$NATIVE_APP_KEY\" >> local.properties
           echo nativeAppKey=$NATIVE_APP_KEY >> local.properties
+          echo mixpanelDevKey=\"$MIXPANEL_KEY\" >> local.properties
+          echo mixpanelProdKey=\"$MIXPANEL_KEY\" >> local.properties
 
       - name: Create Google Services JSON
         env:

app/build.gradle.kts

@@ -56,6 +56,12 @@ android {
                 "BASE_URL",
                 properties.getProperty("dev.base.url")
             )
+
+            buildConfigField(
+                "String",
+                "MIXPANEL_KEY",
+                properties["mixpanelDevKey"] as? String ?: ""
+            )
         }
 
         release {
@@ -65,6 +71,12 @@ android {
                 properties.getProperty("prod.base.url")
             )
 
+            buildConfigField(
+                "String",
+                "MIXPANEL_KEY",
+                properties["mixpanelProdKey"] as? String ?: ""
+            )
+
             isMinifyEnabled = true
             isShrinkResources = true
             proguardFiles(
@@ -146,6 +158,8 @@ dependencies {
     implementation(libs.pebble)
     implementation(libs.jakewharton.process.phoenix)
     implementation(libs.play.services.oss.licenses)
+
+    implementation(libs.mixpanel)
 }
 
 ktlint {

app/src/main/java/com/spoony/spoony/core/analytics/MixPanelTracker.kt

@@ -0,0 +1,40 @@
+package com.spoony.spoony.core.analytics
+
+import android.content.Context
+import com.mixpanel.android.mpmetrics.MixpanelAPI
+import com.spoony.spoony.BuildConfig.MIXPANEL_KEY
+import dagger.hilt.android.qualifiers.ApplicationContext
+import jakarta.inject.Inject
+import org.json.JSONObject
+import timber.log.Timber
+
+class MixPanelTracker @Inject constructor(
+    @ApplicationContext private val context: Context
+) {
+    private val mixpanel = MixpanelAPI.getInstance(
+        context,
+        MIXPANEL_KEY,
+        false
+    )
+
+    fun setUserProfile(userId: String, properties: Map<String, Any>) {
+        mixpanel.identify(userId)
+        properties.forEach { (key, value) ->
+            mixpanel.people.set(key, value)
+        }
+    }
+
+    fun resetUserProfile() {
+        mixpanel.reset()
+    }
+
+    fun track(eventName: String) {
+        Timber.tag("mixpanel").d(eventName)
+        mixpanel.track(eventName)
+    }
+
+    fun track(eventName: String, properties: JSONObject) {
+        Timber.tag("mixpanel").d("$eventName $properties")
+        mixpanel.track(eventName, properties)
+    }
+}

app/src/main/java/com/spoony/spoony/core/analytics/events/AnalyticsEvents.kt

@@ -0,0 +1,26 @@
+package com.spoony.spoony.core.analytics.events
+
+import com.spoony.spoony.core.analytics.MixPanelTracker
+import jakarta.inject.Inject
+import org.json.JSONObject
+
+class AnalyticsEvents @Inject constructor(
+    private val tracker: MixPanelTracker
+) {
+    fun appOpen() {
+        tracker.track("app_open")
+    }
+
+    fun signupCompleted(signupMethod: String) {
+        tracker.track(
+            eventName = "signup_completed",
+            properties = JSONObject().apply {
+                put("signup_method", signupMethod)
+            }
+        )
+    }
+
+    fun loginSuccess() {
+        tracker.track("login_success")
+    }
+}

app/src/main/java/com/spoony/spoony/core/analytics/events/CommonEvents.kt

@@ -0,0 +1,169 @@
+package com.spoony.spoony.core.analytics.events
+
+import com.spoony.spoony.core.analytics.MixPanelTracker
+import com.spoony.spoony.core.analytics.model.ReviewTrackingModel
+import jakarta.inject.Inject
+import org.json.JSONArray
+import org.json.JSONObject
+
+class CommonEvents @Inject constructor(
+    private val tracker: MixPanelTracker
+) {
+    fun tabEntered(tabName: String) {
+        tracker.track(
+            eventName = "tab_entered",
+            properties = JSONObject().apply {
+                put("tab_name", tabName)
+            }
+        )
+    }
+
+    fun reviewViewed(
+        reviewTrackingModel: ReviewTrackingModel,
+        isSelfReview: Boolean,
+        isFollowedUserReview: Boolean,
+        isSavedReview: Boolean
+    ) {
+        tracker.track(
+            eventName = "review_viewed",
+            properties = JSONObject().apply {
+                put("review_id", reviewTrackingModel.reviewId)
+                put("author_user_id", reviewTrackingModel.authorUserId)
+                put("place_name", reviewTrackingModel.placeName)
+                put("category", reviewTrackingModel.category)
+                put("menu_count", reviewTrackingModel.menuCount)
+                put("satisfaction_score", reviewTrackingModel.satisfactionScore)
+                put("review_length", reviewTrackingModel.reviewLength)
+                put("photo_count", reviewTrackingModel.photoCount)
+                put("has_disappointment", reviewTrackingModel.hasDisappointment)
+                put("saved_count", reviewTrackingModel.savedCount)
+                put("is_self_review", isSelfReview)
+                put("is_followed_user_review", isFollowedUserReview)
+                put("is_saved_review", isSavedReview)
+            }
+        )
+    }
+
+    fun reviewEdited(
+        reviewTrackingModel: ReviewTrackingModel
+    ) {
+        tracker.track(
+            eventName = "review_edited",
+            properties = JSONObject().apply {
+                put("review_id", reviewTrackingModel.reviewId)
+                put("author_user_id", reviewTrackingModel.authorUserId)
+                put("place_name", reviewTrackingModel.placeName)
+                put("category", reviewTrackingModel.category)
+                put("menu_count", reviewTrackingModel.menuCount)
+                put("satisfaction_score", reviewTrackingModel.satisfactionScore)
+                put("review_length", reviewTrackingModel.reviewLength)
+                put("photo_count", reviewTrackingModel.photoCount)
+                put("has_disappointment", reviewTrackingModel.hasDisappointment)
+                put("saved_count", reviewTrackingModel.savedCount)
+            }
+        )
+    }
+
+    fun profileViewed(
+        profileUserId: Int,
+        isSelfProfile: Boolean,
+        isFollowingProfileUser: Boolean
+//        entryPoint: String
+    ) {
+        tracker.track(
+            eventName = "profile_viewed",
+            properties = JSONObject().apply {
+                put("profile_user_id", profileUserId)
+                put("is_self_profile", isSelfProfile)
+                put("is_following_profile_user", isFollowingProfileUser)
+            }
+        )
+    }
+
+    fun followUser(
+        followedUserId: Int,
+        entryPoint: String
+    ) {
+        tracker.track(
+            eventName = "follow_user",
+            properties = JSONObject().apply {
+                put("followed_user_id", followedUserId)
+                put("entry_point", entryPoint)
+            }
+        )
+    }
+
+    fun unfollowUser(
+        unfollowedUserId: Int,
+        entryPoint: String
+    ) {
+        tracker.track(
+            eventName = "unfollow_user",
+            properties = JSONObject().apply {
+                put("unfollowed_user_id", unfollowedUserId)
+                put("entry_point", entryPoint)
+            }
+        )
+    }
+
+    fun followUserFromReview(
+        reviewTrackingModel: ReviewTrackingModel
+    ) {
+        tracker.track(
+            eventName = "follow_user_from_review",
+            properties = JSONObject().apply {
+                put("review_id", reviewTrackingModel.reviewId)
+                put("author_user_id", reviewTrackingModel.authorUserId)
+                put("place_name", reviewTrackingModel.placeName)
+                put("category", reviewTrackingModel.category)
+                put("menu_count", reviewTrackingModel.menuCount)
+                put("satisfaction_score", reviewTrackingModel.satisfactionScore)
+                put("review_length", reviewTrackingModel.reviewLength)
+                put("photo_count", reviewTrackingModel.photoCount)
+                put("has_disappointment", reviewTrackingModel.hasDisappointment)
+                put("saved_count", reviewTrackingModel.savedCount)
+                put("entry_point", "review")
+            }
+        )
+    }
+
+    fun unfollowUserFromReview(
+        reviewTrackingModel: ReviewTrackingModel
+    ) {
+        tracker.track(
+            eventName = "unfollow_user_from_review",
+            properties = JSONObject().apply {
+                put("review_id", reviewTrackingModel.reviewId)
+                put("author_user_id", reviewTrackingModel.authorUserId)
+                put("place_name", reviewTrackingModel.placeName)
+                put("category", reviewTrackingModel.category)
+                put("menu_count", reviewTrackingModel.menuCount)
+                put("satisfaction_score", reviewTrackingModel.satisfactionScore)
+                put("review_length", reviewTrackingModel.reviewLength)
+                put("photo_count", reviewTrackingModel.photoCount)
+                put("has_disappointment", reviewTrackingModel.hasDisappointment)
+                put("saved_count", reviewTrackingModel.savedCount)
+                put("entry_point", "review")
+            }
+        )
+    }
+
+    fun filterApplied(
+        pageApplied: String,
+        localReviewFilter: Boolean? = null,
+        regionFilters: List<String> = listOf(),
+        categoryFilters: List<String> = listOf(),
+        ageGroupFilters: List<String> = listOf()
+    ) {
+        tracker.track(
+            eventName = "filter_applied",
+            properties = JSONObject().apply {
+                put("page_applied", pageApplied)
+                put("local_review_filter", localReviewFilter)
+                put("region_filters", JSONArray(regionFilters))
+                put("category_filters", JSONArray(categoryFilters))
+                put("age_group_filters", JSONArray(ageGroupFilters))
+            }
+        )
+    }
+}

app/src/main/java/com/spoony/spoony/core/analytics/events/ExploreEvents.kt

@@ -0,0 +1,31 @@
+package com.spoony.spoony.core.analytics.events
+
+import com.spoony.spoony.core.analytics.MixPanelTracker
+import jakarta.inject.Inject
+import org.json.JSONObject
+
+class ExploreEvents @Inject constructor(
+    private val tracker: MixPanelTracker
+) {
+    fun sortSelected(sortType: String) {
+        tracker.track(
+            eventName = "sort_selected",
+            properties = JSONObject().apply {
+                put("sort_type", sortType)
+            }
+        )
+    }
+
+    fun exploreSearched(
+        searchTargetType: String,
+        searchTerm: String
+    ) {
+        tracker.track(
+            eventName = "explore_searched",
+            properties = JSONObject().apply {
+                put("search_target_type", searchTargetType)
+                put("search_term", searchTerm)
+            }
+        )
+    }
+}

app/src/main/java/com/spoony/spoony/core/analytics/events/MapEvents.kt

@@ -0,0 +1,22 @@
+package com.spoony.spoony.core.analytics.events
+
+import com.spoony.spoony.core.analytics.MixPanelTracker
+import jakarta.inject.Inject
+import org.json.JSONObject
+
+class MapEvents @Inject constructor(
+    private val tracker: MixPanelTracker
+) {
+    fun mapSearched(
+        locationType: String,
+        searchTerm: String
+    ) {
+        tracker.track(
+            eventName = "map_searched",
+            properties = JSONObject().apply {
+                put("location_type", locationType)
+                put("search_term", searchTerm)
+            }
+        )
+    }
+}

app/src/main/java/com/spoony/spoony/core/analytics/events/MixPanelEvents.kt

@@ -0,0 +1,21 @@
+package com.spoony.spoony.core.analytics.events
+
+import androidx.compose.runtime.staticCompositionLocalOf
+import jakarta.inject.Inject
+
+val LocalTracker = staticCompositionLocalOf<MixPanelEvents> {
+    error("No MixPanelEvents provided")
+}
+
+class MixPanelEvents @Inject constructor(
+    val userProperties: MixPanelUserProperties,
+    val analyticsEvents: AnalyticsEvents,
+    val commonEvents: CommonEvents,
+    val onboardingEvents: OnboardingEvents,
+    val spoonDrawEvents: SpoonDrawEvents,
+    val mapEvents: MapEvents,
+    val exploreEvents: ExploreEvents,
+    val registerEvents: RegisterEvents,
+    val mypageEvents: MypageEvents,
+    val reviewDetailEvents: ReviewDetailEvents
+)

app/src/main/java/com/spoony/spoony/core/analytics/events/MixPanelUserProperties.kt

@@ -0,0 +1,16 @@
+package com.spoony.spoony.core.analytics.events
+
+import com.spoony.spoony.core.analytics.MixPanelTracker
+import jakarta.inject.Inject
+
+class MixPanelUserProperties @Inject constructor(
+    private val tracker: MixPanelTracker
+) {
+    fun setUserProfile(userId: String, properties: Map<String, Any>) {
+        tracker.setUserProfile(userId = userId, properties = properties)
+    }
+
+    fun resetUserProfile() {
+        tracker.resetUserProfile()
+    }
+}