release: 1.9.9 (#218)

Author: hyesungoh

.github/workflows/deploy.yml

@@ -89,6 +89,7 @@ jobs:
             "INTERNAL_AUTH_SECRET=${{ secrets.INTERNAL_AUTH_SECRET }}"
             "LOGIN_SECRET=${{ secrets.LOGIN_SECRET }}"
             "GITANIMALS_ADMIN_TOKEN=${{ secrets.GITANIMALS_ADMIN_TOKEN }}"
+            "MIXPANEL_PROJECT_TOKEN=${{ secrets.MIXPANEL_PROJECT_TOKEN }}"
 
       - name: build and push filebeat
         uses: docker/build-push-action@v4

build.gradle

@@ -35,6 +35,7 @@ apply from: "gradle/spring.gradle"
 apply from: "gradle/logging.gradle"
 apply from: "gradle/monitor.gradle"
 apply from: "gradle/jetbrains.gradle"
+apply from: "gradle/analytics.gradle"
 
 sentry {
     includeSourceContext = true

deploy/api/Dockerfile

@@ -24,6 +24,7 @@ ARG RELAY_APPROVE_TOKEN
 ARG INTERNAL_AUTH_SECRET
 ARG LOGIN_SECRET
 ARG GITANIMALS_ADMIN_TOKEN
+ARG MIXPANEL_PROJECT_TOKEN
 
 ARG JAR_FILE=./*.jar
 COPY ${JAR_FILE} gitanimals-api.jar
@@ -51,7 +52,8 @@ ENV db_url=${DB_URL} \
   relay_approve_token=${RELAY_APPROVE_TOKEN} \
   internal_auth_secret=${INTERNAL_AUTH_SECRET} \
   login_secret=${LOGIN_SECRET} \
-  gitanimals_admin_token=${GITANIMALS_ADMIN_TOKEN}
+  gitanimals_admin_token=${GITANIMALS_ADMIN_TOKEN} \
+  mixpanel_project_token=${MIXPANEL_PROJECT_TOKEN}
 
 ENTRYPOINT java -Djava.net.preferIPv4Stack=true -jar gitanimals-api.jar \
   --spring.datasource.url=${db_url} \

gradle/analytics.gradle

@@ -0,0 +1,3 @@
+dependencies {
+    implementation "com.mixpanel:mixpanel-java:1.5.4"
+}

src/main/kotlin/org/gitanimals/core/event/EventLogger.kt

@@ -0,0 +1,9 @@
+package org.gitanimals.core.event
+
+interface EventLogger {
+
+    /**
+     * 분석 이벤트를 트래킹한다. 절대 예외를 throw 하지 않으며, 실패는 구현체 내부에서 로깅으로 처리된다.
+     */
+    fun track(eventName: String, distinctId: String, properties: Map<String, Any?> = emptyMap())
+}

src/main/kotlin/org/gitanimals/core/event/MixpanelConfiguration.kt

@@ -0,0 +1,31 @@
+package org.gitanimals.core.event
+
+import com.mixpanel.mixpanelapi.MessageBuilder
+import com.mixpanel.mixpanelapi.MixpanelAPI
+import org.slf4j.LoggerFactory
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.context.annotation.Profile
+
+@Configuration
+class MixpanelConfiguration(
+    @Value("\${mixpanel.project.token:}") private val token: String,
+) {
+
+    private val logger = LoggerFactory.getLogger(this::class.java)
+
+    @Bean
+    @Profile("!test")
+    fun mixpanelEventLogger(): EventLogger {
+        if (token.isBlank()) {
+            logger.warn("MIXPANEL_PROJECT_TOKEN is blank — falling back to NoOpEventLogger")
+            return NoOpEventLogger()
+        }
+        return MixpanelEventLogger(MixpanelAPI(), MessageBuilder(token))
+    }
+
+    @Bean
+    @Profile("test")
+    fun noOpEventLogger(): EventLogger = NoOpEventLogger()
+}

src/main/kotlin/org/gitanimals/core/event/MixpanelEventLogger.kt

@@ -0,0 +1,31 @@
+package org.gitanimals.core.event
+
+import com.mixpanel.mixpanelapi.ClientDelivery
+import com.mixpanel.mixpanelapi.MessageBuilder
+import com.mixpanel.mixpanelapi.MixpanelAPI
+import org.gitanimals.core.GracefulShutdownDispatcher.gracefulLaunch
+import org.json.JSONObject
+import org.slf4j.LoggerFactory
+
+class MixpanelEventLogger(
+    private val mixpanelAPI: MixpanelAPI,
+    private val messageBuilder: MessageBuilder,
+) : EventLogger {
+
+    private val logger = LoggerFactory.getLogger(this::class.java)
+
+    override fun track(eventName: String, distinctId: String, properties: Map<String, Any?>) {
+        gracefulLaunch {
+            runCatching {
+                val props = JSONObject()
+                properties.forEach { (k, v) -> if (v != null) props.put(k, v) }
+                val message = messageBuilder.event(distinctId, eventName, props)
+                val delivery = ClientDelivery()
+                delivery.addMessage(message)
+                mixpanelAPI.deliver(delivery)
+            }.onFailure {
+                logger.warn("Failed to track Mixpanel event '{}': {}", eventName, it.message)
+            }
+        }
+    }
+}

src/main/kotlin/org/gitanimals/core/event/NoOpEventLogger.kt

@@ -0,0 +1,12 @@
+package org.gitanimals.core.event
+
+import org.slf4j.LoggerFactory
+
+class NoOpEventLogger : EventLogger {
+
+    private val logger = LoggerFactory.getLogger(this::class.java)
+
+    override fun track(eventName: String, distinctId: String, properties: Map<String, Any?>) {
+        logger.debug("NoOpEventLogger.track: event={}, distinctId={}", eventName, distinctId)
+    }
+}

src/main/kotlin/org/gitanimals/gotcha/controller/GotchaController.kt

@@ -1,7 +1,9 @@
 package org.gitanimals.gotcha.controller
 
+import org.gitanimals.core.auth.InternalAuth
 import org.gitanimals.core.auth.RequiredUserEntryPoints
 import org.gitanimals.core.auth.UserEntryPoint
+import org.gitanimals.core.event.EventLogger
 import org.gitanimals.gotcha.app.GotchaFacadeV3
 import org.gitanimals.gotcha.app.response.GotchaResponseV3
 import org.gitanimals.gotcha.controller.response.ErrorResponse
@@ -13,6 +15,8 @@ import org.springframework.web.bind.annotation.*
 @RestController
 class GotchaController(
     private val gotchaFacadeV3: GotchaFacadeV3,
+    private val eventLogger: EventLogger,
+    private val internalAuth: InternalAuth,
 ) {
 
     @RequiredUserEntryPoints([UserEntryPoint.GITHUB])
@@ -26,6 +30,20 @@ class GotchaController(
 
         val gotchaResponses = gotchaFacadeV3.gotcha(token, gotchaType, count)
 
+        internalAuth.findUserId()?.let { userId ->
+            gotchaResponses.forEach { response ->
+                eventLogger.track(
+                    eventName = "complete_gotcha",
+                    distinctId = userId.toString(),
+                    properties = mapOf(
+                        "pet_persona" to response.name,
+                        "cost_point" to gotchaType.point,
+                        "user_id" to userId,
+                    ),
+                )
+            }
+        }
+
         return mapOf("gotchaResults" to gotchaResponses)
     }
 

src/main/kotlin/org/gitanimals/identity/app/AppleLoginFacade.kt

@@ -4,6 +4,7 @@ import com.fasterxml.jackson.core.type.TypeReference
 import com.fasterxml.jackson.databind.ObjectMapper
 import io.jsonwebtoken.Jwts
 import org.gitanimals.core.AUTHORIZATION_EXCEPTION
+import org.gitanimals.core.event.EventLogger
 import org.gitanimals.identity.app.AppleOauth2Api.AppleAuthKeyResponse
 import org.gitanimals.identity.domain.EntryPoint
 import org.gitanimals.identity.domain.UserService
@@ -23,6 +24,7 @@ class AppleLoginFacade(
     private val appleOauth2Api: AppleOauth2Api,
     private val objectMapper: ObjectMapper,
     @Value("\${login.secret}") private val loginSecret: String,
+    private val eventLogger: EventLogger,
 ) {
 
     private val logger = LoggerFactory.getLogger(this::class.simpleName)
@@ -49,6 +51,16 @@ class AppleLoginFacade(
             }
         }
 
+        eventLogger.track(
+            eventName = "complete_login",
+            distinctId = user.id.toString(),
+            properties = mapOf(
+                "provider" to "apple",
+                "user_id" to user.id,
+                "is_new_user" to !isExistsUser,
+            ),
+        )
+
         return tokenManager.createToken(user).withType()
     }