DEP-420 feat: sentry 도입 (#215)

app/build.gradle

@@ -42,21 +42,25 @@ android {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
             manifestPlaceholders = [
-                    KAKAO_APP_KEY: properties.getProperty('release.kakao.app-key')
+                    KAKAO_APP_KEY: properties.getProperty('release.kakao.app-key'),
+                    SENTRY_DSN: properties.getProperty('release.sentry.dsn')
             ]
             buildConfigField 'String', 'BASE_URL', "\"${properties.getProperty('release.three-days.base-url')}\""
             buildConfigField 'String', 'KAKAO_APP_KEY', "\"${properties.getProperty('release.kakao.app-key')}\""
             buildConfigField 'String', 'MIXPANEL_PROJECT_TOKEN', "\"${properties.getProperty('release.mixpanel.project-token')}\""
+            buildConfigField 'String', 'SENTRY_DSN', "\"${properties.getProperty('release.sentry.dsn')}\""
         }
         debug {
             debuggable true
             applicationIdSuffix '.debug'
             manifestPlaceholders = [
-                    KAKAO_APP_KEY: properties.getProperty('debug.kakao.app-key')
+                    KAKAO_APP_KEY: properties.getProperty('debug.kakao.app-key'),
+                    SENTRY_DSN: properties.getProperty('debug.sentry.dsn')
             ]
             buildConfigField 'String', 'BASE_URL', "\"${properties.getProperty('debug.three-days.base-url')}\""
             buildConfigField 'String', 'KAKAO_APP_KEY', "\"${properties.getProperty('debug.kakao.app-key')}\""
             buildConfigField 'String', 'MIXPANEL_PROJECT_TOKEN', "\"${properties.getProperty('debug.mixpanel.project-token')}\""
+            buildConfigField 'String', 'SENTRY_DSN', "\"${properties.getProperty('debug.sentry.dsn')}\""
         }
         alpha {
             initWith debug

app/src/main/AndroidManifest.xml

@@ -62,35 +62,42 @@
             android:name="com.depromeet.threedays.mypage.archived_habit.ArchivedHabitActivity"
             android:exported="false" />
 
-        <activity android:name=".mate.create.step1.ConnectHabitActivity"
+        <activity
+            android:name=".mate.create.step1.ConnectHabitActivity"
             android:exported="false"
             android:taskAffinity="com.depromeet.threedays.mate"
             android:theme="@style/WhiteStatusTheme" />
 
-        <activity android:name=".mate.create.step2.ChooseMateTypeActivity"
+        <activity
+            android:name=".mate.create.step2.ChooseMateTypeActivity"
             android:exported="false"
             android:taskAffinity="com.depromeet.threedays.mate"
             android:theme="@style/WhiteStatusTheme" />
 
-        <activity android:name=".mate.create.step3.SetMateNicknameActivity"
+        <activity
+            android:name=".mate.create.step3.SetMateNicknameActivity"
             android:exported="false"
             android:taskAffinity="com.depromeet.threedays.mate"
             android:theme="@style/WhiteStatusTheme" />
 
-        <activity android:name="com.depromeet.threedays.policy.PolicyActivity"
+        <activity
+            android:name="com.depromeet.threedays.policy.PolicyActivity"
             android:exported="false" />
 
-        <activity android:name=".signup.SignupActivity"
-            android:exported="true"/>
+        <activity
+            android:name=".signup.SignupActivity"
+            android:exported="true" />
 
-        <activity android:name=".signup.complete.SignupCompleteActivity"
-            android:exported="false"/>
+        <activity
+            android:name=".signup.complete.SignupCompleteActivity"
+            android:exported="false" />
 
         <activity
             android:name="com.kakao.sdk.auth.AuthCodeHandlerActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.VIEW" />
+
                 <category android:name="android.intent.category.DEFAULT" />
                 <category android:name="android.intent.category.BROWSABLE" />
 
@@ -109,6 +116,31 @@
             </intent-filter>
         </service>
 
+        <!-- Required: set your sentry.io project identifier (DSN) -->
+        <meta-data
+            android:name="io.sentry.dsn"
+            android:value="${SENTRY_DSN}" />
+        <!-- enable automatic breadcrumbs for user interactions (clicks, swipes, scrolls) -->
+        <meta-data
+            android:name="io.sentry.traces.user-interaction.enable"
+            android:value="true" />
+        <!-- enable screenshot for crashes -->
+        <meta-data
+            android:name="io.sentry.attach-screenshot"
+            android:value="true" />
+        <!-- enable view hierarchy for crashes -->
+        <meta-data
+            android:name="io.sentry.attach-view-hierarchy"
+            android:value="true" />
+        <!-- enable the performance API by setting a sample-rate, adjust in production env -->
+        <meta-data
+            android:name="io.sentry.traces.sample-rate"
+            android:value="1.0" />
+        <!-- enable profiling when starting transactions, adjust in production env -->
+        <meta-data
+            android:name="io.sentry.traces.profiling.sample-rate"
+            android:value="1.0" />
+
     </application>
 
 </manifest>

build.gradle

@@ -23,6 +23,7 @@ plugins {
     id 'org.jetbrains.kotlin.android' version '1.6.10' apply false
     id "org.sonarqube" version "3.4.0.2513"
     id 'org.jetbrains.kotlin.jvm' version '1.6.10' apply false
+    id 'io.sentry.android.gradle' version "3.12.0"
 }
 
 task clean(type: Delete) {

core/build.gradle

@@ -43,6 +43,7 @@ android {
 dependencies {
     implementation(project(":core-design-system"))
     implementation(project(":build-property"))
+    implementation(project(":domain"))
 
     implementation(jetpackDeps)
     implementation(coroutines)
@@ -55,6 +56,8 @@ dependencies {
 
     implementation deps.mixpanel
 
+    implementation deps.sentry
+
     testImplementation(testDeps)
     androidTestImplementation(androidTestDeps)
 }

core/src/main/java/com/depromeet/threedays/core/BaseViewModel.kt

@@ -2,6 +2,7 @@ package com.depromeet.threedays.core
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
+import com.depromeet.threedays.domain.exception.ThreeDaysException
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharedFlow
@@ -14,8 +15,8 @@ abstract class BaseViewModel : ViewModel() {
     val loading: StateFlow<Boolean>
         get() = _loading
 
-    private val _error = MutableSharedFlow<String>()
-    val error: SharedFlow<String>
+    private val _error = MutableSharedFlow<ThreeDaysException>()
+    val error: SharedFlow<ThreeDaysException>
         get() = _error
 
     protected fun startLoading() {
@@ -26,13 +27,13 @@ abstract class BaseViewModel : ViewModel() {
         _loading.value = false
     }
 
-    protected fun sendErrorMessage(throwable: Throwable) {
-        sendErrorMessage(throwable.message)
-    }
+    protected fun sendError(throwable: ThreeDaysException) {
+        if (throwable.message.equals(ThreeDaysException.UNKNOWN_EXCEPTION)) {
+            throwable.message = throwable.defaultMessage
+        }
 
-    protected fun sendErrorMessage(message: String?) {
         viewModelScope.launch {
-            _error.emit(message ?: "알 수 없는 오류가 발생했어요.")
+            _error.emit(throwable)
         }
     }
 }

core/src/main/java/com/depromeet/threedays/core/util/ThreeDaysToast.kt

@@ -26,19 +26,17 @@ class ThreeDaysToast {
 
     fun error(
         context: Context,
-        title: String?,
+        title: String,
         duration: Int = Toast.LENGTH_SHORT
     ) {
-        if(title != null) {
-            val inflater = LayoutInflater.from(context)
-            val toast = Toast(context)
-            val view = inflater.inflate(R.layout.error_toast_three_days, null)
-            val textView: TextView = view.findViewById(R.id.tv_toast)
-            textView.text = title
-            toast.setGravity(Gravity.BOTTOM or Gravity.FILL_HORIZONTAL, 0, 0)
-            toast.view = view
-            toast.duration = duration
-            toast.show()
-        }
+        val inflater = LayoutInflater.from(context)
+        val toast = Toast(context)
+        val view = inflater.inflate(R.layout.error_toast_three_days, null)
+        val textView: TextView = view.findViewById(R.id.tv_toast)
+        textView.text = title
+        toast.setGravity(Gravity.BOTTOM or Gravity.FILL_HORIZONTAL, 0, 0)
+        toast.view = view
+        toast.duration = duration
+        toast.show()
     }
 }

data/src/main/java/com/depromeet/threedays/data/api/exception/ResultCall.kt

@@ -18,7 +18,7 @@ class ResultCall<T>(private val call: Call<T>, private val retrofit: Retrofit) :
                     if(response.body() == null) {
                         callback.onResponse(
                             this@ResultCall,
-                            Response.success(Result.failure(ThreeDaysException("body가 비었습니다.", HttpException(response))))
+                            Response.success(Result.failure(ThreeDaysException(ThreeDaysException.NO_BODY_RESPONSE, HttpException(response))))
                         )
                     }
                     else {
@@ -32,7 +32,7 @@ class ResultCall<T>(private val call: Call<T>, private val retrofit: Retrofit) :
 
                     if(response.errorBody() == null) {
                         callback.onResponse( this@ResultCall,
-                            Response.success(Result.failure(ThreeDaysException("errorBody가 비었습니다.", HttpException(response))))
+                            Response.success(Result.failure(ThreeDaysException(ThreeDaysException.NO_ERROR_BODY_RESPONSE, HttpException(response))))
                         )
                     }
                     else {
@@ -41,7 +41,7 @@ class ResultCall<T>(private val call: Call<T>, private val retrofit: Retrofit) :
                             ErrorResponse::class.java.annotations
                         ).convert(response.errorBody()!!)
 
-                        val message: String = errorBody?.message ?: "errorBody가 비었습니다"
+                        val message: String = errorBody?.message ?: ThreeDaysException.NO_ERROR_MESSAGE_RESPONSE
 
                         callback.onResponse(this@ResultCall,
                             Response.success(Result.failure(ThreeDaysException(message, HttpException(response))))
@@ -55,8 +55,8 @@ class ResultCall<T>(private val call: Call<T>, private val retrofit: Retrofit) :
 
             override fun onFailure(call: Call<T>, t: Throwable) {
                 val message = when (t) {
-                    is IOException -> "인터넷 연결이 끊겼습니다."
-                    is HttpException -> "알 수 없는 오류가 발생했어요."
+                    is IOException -> ThreeDaysException.INTERNET_CONNECTION_WAS_LOST
+                    is HttpException -> ThreeDaysException.UNKNOWN_EXCEPTION
                     else -> t.localizedMessage
                 }
                 callback.onResponse(

data/src/main/java/com/depromeet/threedays/data/entity/base/ApiResponse.kt

@@ -1,5 +1,7 @@
 package com.depromeet.threedays.data.entity.base
 
+import com.depromeet.threedays.domain.exception.ThreeDaysException
+
 data class ApiResponse<T>(
     val data: T?,
     val message: String,
@@ -13,5 +15,5 @@ fun <T>Result<ApiResponse<T>>.getResult(): Result<T>? {
     }.onFailure { throwable ->
         return Result.failure(throwable)
     }
-    return Result.failure(IllegalStateException("알 수 없는 오류가 발생했습니다."))
+    return Result.failure(IllegalStateException(ThreeDaysException.UNKNOWN_EXCEPTION))
 }

dependencies.gradle

@@ -30,7 +30,8 @@ ext {
             "lottie"                : "5.2.0",
             "datastore"             : "1.0.0",
             "ossLicenses"           : "17.0.0",
-            "mixpanel"             : "7.+",
+            "mixpanel"              : "7.+",
+            "sentry"                : "6.28.0",
     ]
     deps = [
             "kotlin"          : [
@@ -113,6 +114,7 @@ ext {
             "splash"                       : "androidx.core:core-splashscreen:1.0.0",
             "ossLicenses"                  : "com.google.android.gms:play-services-oss-licenses:${versions.ossLicenses}",
             "mixpanel"                     : "com.mixpanel.android:mixpanel-android:${versions.mixpanel}",
+            "sentry"                       : "io.sentry:sentry-android:${versions.sentry}"
     ]
 
     coroutines = [

domain/src/main/java/com/depromeet/threedays/domain/exception/ThreeDaysException.kt

@@ -1,17 +1,15 @@
 package com.depromeet.threedays.domain.exception
 
-class ThreeDaysException(override val message: String, throwable: Throwable) : Exception(message, throwable) {
-//    override val message: String? = when(code) {
-//        HABIT_CONSTRAINTS_INSUFFICIENT_DAY_OF_WEEKS -> "실천 요일을 3개 이상 선택해 주세요."
-//        HABIT_ACHIEVEMENT_CONSTRAINTS_DATE_IS_IN_THE_PAST -> "이전의 기록을 변경할 수 없어요."
-//        HABIT_ACHIEVEMENT_CONSTRAINTS_INVALID_ACHIEVEMENT_DATE -> "습관 취소는 오늘만 할 수 있어요"
-//        HABIT_CONSTRAINTS_INSUFFICIENT_NOTIFICATION -> "Push 알림을 마저 설정해 주세요."
-//        MEMBER_CONSTRAINTS_INVALID_MEMBER -> "가입된 기록이 없어요."
-//        MEMBER_NOT_FOUND -> "가입된 기록이 없어요."
-//        SOCIAL_LOGIN_ERROR -> "로그인에 실패했어요."
-//        MATE_CONSTRAINTS_ALREADY_EXIST_MATE -> "이미 함께하고 있는 짝꿍이 있어요."
-//        METHOD_ARGUMENT_NOT_VALID_EXCEPTION_BIND_EXCEPTION, BAD_REQUEST, UNKNOWN_ERROR -> "알 수 없는 오류가 발생했어요."
-//        NO_INTERNET_CONNECTION -> "인터넷 연결이 끊겼습니다."
-//        else -> null
-//    }
-}
+class ThreeDaysException(override var message: String?, throwable: Throwable) : Exception(message, throwable) {
+    var defaultMessage = UNKNOWN_EXCEPTION
+    companion object {
+        const val UNKNOWN_EXCEPTION = "알 수 없는 오류가 발생했어요."
+        const val INTERNET_CONNECTION_WAS_LOST = "인터넷 연결이 끊겼습니다."
+        const val NO_BODY_RESPONSE = "응답이 비었습니다."
+        const val NO_ERROR_BODY_RESPONSE = "에러 응답이 비었습니다."
+        const val NO_ERROR_MESSAGE_RESPONSE = "에러 메세지가 비었습니다."
+        const val LOGIN_FAIL = "로그인에 실패하였습니다. 잠시 후 다시 시도해주세요."
+        const val LOGOUT_FAIL = "로그아웃에 실패했습니다. 잠시 후 다시 시도해주세요."
+        const val MEMBERSHIP_WITHDRAWAL_FAIL = "회원탈퇴를 실패했습니다. 잠시 후 다시 시도해주세요."
+    }
+}

presentation/create/build.gradle

@@ -53,6 +53,8 @@ dependencies {
 
     implementation deps.timber
 
+    implementation deps.sentry
+
     testImplementation(testDeps)
     androidTestImplementation(androidTestDeps)
 }

presentation/create/src/main/java/com/depromeet/threedays/create/create/HabitCreateActivity.kt

@@ -20,8 +20,10 @@ import com.depromeet.threedays.create.create.HabitCreateViewModel.Action
 import com.depromeet.threedays.create.databinding.ActivityHabitCreateBinding
 import com.depromeet.threedays.create.emoji.EmojiBottomSheetDialogFragment
 import com.depromeet.threedays.domain.entity.Color
+import com.depromeet.threedays.domain.exception.ThreeDaysException
 import com.depromeet.threedays.domain.key.RESULT_CREATE
 import dagger.hilt.android.AndroidEntryPoint
+import io.sentry.Sentry
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import java.time.DayOfWeek
@@ -133,9 +135,9 @@ class HabitCreateActivity :
             viewModel.onCreateHabitClick()
         }
 
-        binding.groupColor.setOnCheckedChangeListener { _ , id ->
+        binding.groupColor.setOnCheckedChangeListener { _, id ->
             viewModel.setColor(
-                when(id) {
+                when (id) {
                     R.id.rb_green -> Color.GREEN
                     R.id.rb_blue -> Color.BLUE
                     R.id.rb_pink -> Color.PINK
@@ -155,26 +157,32 @@ class HabitCreateActivity :
     }
 
     private fun observe() {
-       viewModel.isSaveHabitEnable
-           .onEach {
-               binding.tvHabitCreate.isEnabled = it
-           }.launchIn(lifecycleScope)
+        viewModel.isSaveHabitEnable
+            .onEach {
+                binding.tvHabitCreate.isEnabled = it
+            }.launchIn(lifecycleScope)
 
         viewModel.action
             .onEach { action ->
-                when(action) {
+                when (action) {
                     is Action.SaveClick -> {
                         setResult(RESULT_CREATE)
                         finish()
                     }
+
                     is Action.NotificationTimeClick -> {
                         showTimePicker(action.currentTime)
                     }
                 }
             }.launchIn(lifecycleScope)
 
         viewModel.error
-            .onEach { errorMessage -> ThreeDaysToast().error(this, errorMessage) }
+            .onEach { error ->
+                ThreeDaysToast().error(this, error.message ?: error.defaultMessage)
+                if (error.message != ThreeDaysException.INTERNET_CONNECTION_WAS_LOST) {
+                    Sentry.captureException(error)
+                }
+            }
             .launchIn(lifecycleScope)
     }
 
@@ -189,7 +197,7 @@ class HabitCreateActivity :
     }
 
     fun setBackBtnClickEvent() {
-        if(viewModel.isInformationEntered.value) {
+        if (viewModel.isInformationEntered.value) {
             ThreeDaysDialogFragment.newInstance(
                 data = DialogInfo.EMPTY.copy(
                     onPositiveAction = { finish() },
@@ -199,8 +207,7 @@ class HabitCreateActivity :
                     confirmText = getString(com.depromeet.threedays.core.R.string.reply_go_out)
                 )
             ).show(supportFragmentManager, ThreeDaysDialogFragment.TAG)
-        }
-        else {
+        } else {
             finish()
         }
     }