Skip to content

✨[FEAT] #135: Firebase Remote Config 연동#138

Open
HwangJaemin49 wants to merge 5 commits intodevelopfrom
feature/#135-firebase
Open

✨[FEAT] #135: Firebase Remote Config 연동#138
HwangJaemin49 wants to merge 5 commits intodevelopfrom
feature/#135-firebase

Conversation

@HwangJaemin49
Copy link
Contributor

#⃣ 연관된 이슈

close #135

📝 작업 내용

Remote Config에 default(prod), release, qa 분기로 나누어 서버 호스트 등록

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @HwangJaemin49, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 PR은 Firebase Remote Config, Analytics, Crashlytics를 애플리케이션에 통합하여 전반적인 안정성과 유연성을 향상시키는 데 중점을 둡니다. 주요 변경 사항으로는 동적 API 기본 URL 구성을 위한 Remote Config 설정, 새로운 'qa' 빌드 타입 도입, 그리고 Crashlytics와 연동되는 커스텀 로깅 및 사용자 컨텍스트 관리 시스템이 포함됩니다. 또한, 토큰 갱신 메커니즘을 강화하여 다양한 인증 실패 시나리오를 보다 견고하게 처리할 수 있도록 개선되었습니다.

Highlights

  • Firebase 통합: Firebase Remote Config, Analytics, Crashlytics를 애플리케이션에 통합하여 동적 구성, 향상된 로깅 및 충돌 보고 기능을 제공합니다.
  • 빌드 타입 및 환경 설정: 'qa' 빌드 타입을 새로 추가하고, 디버그 및 QA 빌드 타입에 대해 applicationIdSuffix, versionNameSuffix, BASE_URL을 구성했습니다.
  • 원격 구성 초기화: 애플리케이션 시작 시 Firebase Remote Config를 초기화하고 활성화하는 로직을 구현하여 기본값을 설정하고 DomainProvider를 통해 API 기본 URL을 업데이트합니다.
  • 커스텀 로깅 및 사용자 컨텍스트: Firebase Crashlytics와 통합되는 AppLogger 유틸리티 클래스와 설치 ID 및 빌드 정보를 관리하여 Crashlytics에 사용자 컨텍스트를 제공하는 UserContext 클래스를 추가했습니다.
  • 토큰 갱신 로직 개선: DefaultTokenRetryHandler를 개선하여 ApiException 외에 HttpException (401 Unauthorized)도 처리하도록 하고, NoRefreshTokenExceptionRefreshFailedException과 같은 커스텀 예외를 도입했습니다.
  • 동적 기본 URL: API 기본 URL을 동적으로 선택할 수 있도록 DomainProviderHostSelectionInterceptor를 구현했습니다.
  • 사용자 ID Crashlytics 연동: Google 로그인 성공 시 사용자 ID를 Crashlytics에 설정하도록 로그인 흐름을 수정했습니다.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • app/build.gradle.kts
    • Firebase 플러그인 및 종속성을 추가했습니다.
    • 'qa' 빌드 타입을 정의하고 디버그 빌드 타입의 속성을 업데이트했습니다.
    • Compose 컴파일러 옵션 설정을 제거했습니다.
  • app/src/main/java/com/umc/edison/EdisonApplication.kt
    • Firebase 관련 임포트를 추가했습니다.
    • Crashlytics 컨텍스트 및 Remote Config 초기화 로직을 추가했습니다.
    • Remote Config에서 기본 URL을 가져와 DomainProvider에 설정하는 기능을 구현했습니다.
  • app/src/main/java/com/umc/edison/common/logging/AppLogger.kt
    • Firebase Crashlytics와 통합된 새로운 로깅 유틸리티 클래스를 추가했습니다.
  • app/src/main/java/com/umc/edison/common/logging/UserContext.kt
    • 설치 ID를 관리하고 Crashlytics에 빌드 및 사용자 정보를 설정하는 새로운 클래스를 추가했습니다.
  • app/src/main/java/com/umc/edison/data/model/user/UserEntity.kt
    • UserEntity 데이터 클래스에 id 필드를 추가했습니다.
  • app/src/main/java/com/umc/edison/data/repository/BubbleRepositoryImpl.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
  • app/src/main/java/com/umc/edison/data/repository/SyncRepositoryImpl.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
  • app/src/main/java/com/umc/edison/data/token/DefaultTokenRetryHandler.kt
    • HttpException 임포트를 추가했습니다.
    • 토큰 갱신 로직에서 ApiException 외에 HttpException (401)도 처리하도록 개선했습니다.
    • 토큰 갱신 실패 시 NoRefreshTokenException을 던지도록 변경했습니다.
  • app/src/main/java/com/umc/edison/data/token/TokenExceptions.kt
    • NoRefreshTokenExceptionRefreshFailedException이라는 새로운 커스텀 예외 클래스를 추가했습니다.
  • app/src/main/java/com/umc/edison/data/token/TokenManager.kt
    • 토큰 로딩 및 캐싱에 Mutex를 사용하여 스레드 안전성을 확보했습니다.
    • 토큰을 미리 로드하는 preloadTokens 함수와 로드 여부를 확인하는 ensureLoaded 함수를 추가했습니다.
    • 로깅을 위해 AppLogger를 사용하도록 변경했습니다.
  • app/src/main/java/com/umc/edison/domain/model/user/User.kt
    • User 도메인 모델에 id 필드를 추가했습니다.
  • app/src/main/java/com/umc/edison/presentation/base/BaseViewModel.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
  • app/src/main/java/com/umc/edison/presentation/login/GoogleLoginHelper.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
    • UserContext를 주입받아 Google 로그인 성공 시 사용자 ID를 Crashlytics에 설정하도록 변경했습니다.
  • app/src/main/java/com/umc/edison/presentation/model/UserModel.kt
    • toDomain 매핑 시 User 모델에 id 필드를 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/api/RefreshTokenApiService.kt
    • refreshToken 메서드를 suspend 함수로 변경했습니다.
  • app/src/main/java/com/umc/edison/remote/config/DomainProvider.kt
    • API 도메인을 동적으로 제공하고 설정하는 새로운 클래스를 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/config/RemoteConfigKeys.kt
    • Firebase Remote Config 키를 정의하는 새로운 객체를 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/datasources/UserRemoteDataSourceImpl.kt
    • 토큰 갱신 실패 시 RefreshFailedException을 던지도록 오류 처리를 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/di/NetworkModule.kt
    • HostSelectionInterceptor 임포트를 추가하고 OkHttpClient에 인터셉터를 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/model/login/LoginResponse.kt
    • toUserEntity 매핑 시 memberIdid 필드에 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/model/login/SignUpResponse.kt
    • toUserEntity 매핑 시 memberIdid 필드에 추가했습니다.
  • app/src/main/java/com/umc/edison/remote/token/AccessTokenInterceptor.kt
    • 액세스 토큰이 없을 때 AppLogger를 사용하여 경고를 로깅하도록 변경했습니다.
  • app/src/main/java/com/umc/edison/ui/artboard/ArtLetterDetailScreen.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
  • app/src/main/java/com/umc/edison/ui/components/ImageGallery.kt
    • 기존 android.util.Log 호출을 AppLogger로 대체했습니다.
  • app/src/main/java/com/umc/edison/ui/navigation/NavRoute.kt
    • BubbleEditcreateRoute 함수에서 bubbleId 파라미터를 nullable로 변경했습니다.
  • build.gradle.kts
    • Firebase google-servicesfirebase-crashlytics 플러그인을 적용했습니다.
  • gradle/libs.versions.toml
    • Firebase BOM, Remote Config, Analytics, Crashlytics 관련 종속성을 추가했습니다.
    • Hilt 버전을 업데이트했습니다.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@SuHyeon00
Copy link
Contributor

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

이번 PR은 Firebase Remote Config를 연동하여 서버의 기본 URL을 동적으로 관리하도록 구현한 점이 인상적입니다. 또한, 중앙화된 로깅 시스템(AppLogger) 도입, UserContext를 통한 크래시 리포팅 개선, TokenManager의 스레드 안전성 강화를 위한 리팩토링 등 많은 개선이 이루어졌습니다. 전반적인 변경 사항은 구조가 잘 잡혀 있으며 애플리케이션의 안정성과 관찰 가능성을 크게 향상시킵니다. 의존성 관리 및 잠재적인 성능 문제와 관련하여 몇 가지 개선 제안 사항이 있습니다.

Comment on lines 150 to 152
// Import the Firebase BoM
implementation(platform("com.google.firebase:firebase-bom:34.9.0"))
implementation("com.google.firebase:firebase-analytics")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Firebase 의존성이 중복으로 선언되었습니다. libs.firebase.bom을 사용하는 Firebase 의존성들이 이미 136-139 라인에서 버전 카탈로그를 통해 선언되어 있습니다. 여기에 추가된 하드코딩된 의존성들은 불필요하며, 다른 BOM 버전(34.9.0 vs libs.versions.toml33.1.0)을 사용하고 있어 예기치 않은 의존성 문제나 빌드 오류를 유발할 수 있습니다. 이 라인들을 제거하는 것이 좋습니다.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인했습니다. 수정해주셔서 감사합니다.

Comment on lines 36 to 52
override fun clearCachedTokens() {
cachedAccessToken = null
cachedRefreshToken = null
runBlocking {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}
}

override fun setCachedTokens(accessToken: String, refreshToken: String?) {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
runBlocking {
mutex.withLock {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

clearCachedTokenssetCachedTokens 메서드에서 runBlocking을 사용하면 호출 스레드를 블로킹할 수 있습니다. 만약 이 메서드들이 메인 스레드에서 호출될 경우, UI가 멈추고 ANR(Application Not Responding) 오류로 이어질 수 있습니다. 이 메서드들이 메인 스레드에서 호출되지 않도록 주의가 필요합니다. 장기적으로는 AccessTokenProvider 인터페이스의 해당 함수들을 suspend로 변경하여 runBlocking 없이 비동기적으로 처리하는 것을 고려해보는 것이 좋습니다.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수정해주셔서 감사합니다. AccessTokenProvider 인터페이스의 clearCachedTokenssetCachedTokens 함수를 suspend로 변경하신 것은 좋은 방향입니다. 하지만 TokenManager 구현체에서 여전히 runBlocking을 사용하고 있어, 이 함수들이 호출될 때 여전히 호출 스레드를 블로킹할 수 있습니다. suspend 함수 내에서 runBlocking을 사용하는 것은 비동기 처리의 이점을 상쇄하고 잠재적인 UI 블로킹을 유발할 수 있으므로, runBlocking을 제거하고 mutex.withLock을 직접 사용하도록 수정하는 것이 좋습니다.

clearCachedTokens:

Suggested change
override fun clearCachedTokens() {
cachedAccessToken = null
cachedRefreshToken = null
runBlocking {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}
}
override fun setCachedTokens(accessToken: String, refreshToken: String?) {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
runBlocking {
mutex.withLock {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
}
}
}
override suspend fun clearCachedTokens() {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}

setCachedTokens:

Suggested change
override fun clearCachedTokens() {
cachedAccessToken = null
cachedRefreshToken = null
runBlocking {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}
}
override fun setCachedTokens(accessToken: String, refreshToken: String?) {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
runBlocking {
mutex.withLock {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
}
}
}
override suspend fun setCachedTokens(accessToken: String, refreshToken: String?) {
mutex.withLock {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
}
}
Suggested change
override fun clearCachedTokens() {
cachedAccessToken = null
cachedRefreshToken = null
runBlocking {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}
}
override fun setCachedTokens(accessToken: String, refreshToken: String?) {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
runBlocking {
mutex.withLock {
cachedAccessToken = accessToken
cachedRefreshToken = refreshToken
}
}
}
override suspend fun clearCachedTokens() {
mutex.withLock {
cachedAccessToken = null
cachedRefreshToken = null
}
}

applicationIdSuffix = ".qa"
versionNameSuffix = "-qa"
matchingFallbacks += listOf("debug")
buildConfigField("String", "BASE_URL", "\"${localProperties["base_url"] ?: ""}\"")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

qa 빌드 타입은 initWith(getByName("debug"))를 통해 debug 빌드 타입의 모든 설정을 상속받습니다. 여기에는 BASE_URL에 대한 buildConfigField 설정도 포함됩니다. 따라서 이 라인에서 다시 설정하는 것은 중복입니다. 코드를 더 깔끔하게 유지하기 위해 이 라인을 제거할 수 있습니다.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수정해주셔서 감사합니다. 해당 변경사항이 적용된 것을 확인했습니다.


private fun initRemoteConfig() {

val settings = com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings.Builder()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

코드 가독성과 일관성을 위해 com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings를 import하고 클래스 이름을 직접 사용하는 것을 권장합니다.

Suggested change
val settings = com.google.firebase.remoteconfig.FirebaseRemoteConfigSettings.Builder()
val settings = FirebaseRemoteConfigSettings.Builder()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수정해주셔서 감사합니다!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ [FEAT] Firebase 연동

3 participants

Comments