Feature/#49 kakao login sdk

.gitignore

@@ -46,3 +46,4 @@ build/
 app/.idea/
 /composeApp/google-services.json
 /iosApp/iosApp/GoogleService-Info.plist
+/iosApp/Configuration/Config.xcconfig

README.md

@@ -1,88 +1,85 @@
-### 🚧 Suwiki는 현재 리팩토링 작업 중입니다.
+# ChukChukHaksa (척척학사)
 
-# Suwiki
+수원대학교 재학생을 위한 시간표 & 강의평가 서비스입니다.
+Kotlin Multiplatform (Android + iOS) 기반으로 개발되고 있습니다.
 
-# Introduce
+## Tech Stack
 
-**Suwiki(수위키)** 는 수원대학교 재학생들의 불편함을 해결하기 위해 만들어진 시간표 & 강의평가 서비스입니다. 대략 **43**개의 모듈로 이루어져 있으며 Clean Architecture, Mvi, Hilt, Coroutine, Flow, Jetpack
-Compose 등의 기술이 적용되어 있습니다.
+| Category | Stack |
+|----------|-------|
+| Language | Kotlin 2.2, Swift |
+| UI | Compose Multiplatform 1.10 |
+| Architecture | MVI + Clean Architecture |
+| DI | Koin 4.1 |
+| Database | Room 2.7 (KMP) |
+| Remote | Firebase (GitLive KMP) |
+| Widget | Glance (Android), WidgetKit (iOS) |
 
-2023년 12월 13일 기준 **2039**명의 유저가 사용 중입니다.
+## Project Structure
 
-# Architecture
+단일 `composeApp` 모듈 구조:
 
-Suwiki는 Mvi 기반의 Clean Architecture 구조로 설계되어 있으며 크게 core, data, domain, feature 모듈로 구성되어 있습니다.
-presentation layer에서는 UDF(단방향 데이터 흐름) 패턴을 사용합니다.
+```
+com.chukchukhaksa.mobile/
+├── common/          # 디자인시스템, 확장함수, KMP 플랫폼 코드
+├── data/            # Repository 구현
+├── di/              # Koin DI 모듈
+├── domain/          # UseCase, Repository 인터페이스
+├── local/           # Room DB, DataStore
+├── presentation/    # 화면 (MVI 패턴)
+├── remote/          # Firebase 데이터소스
+└── widget/          # 위젯 (Android Glance / iOS WidgetKit)
+```
 
-> 유지 보수를 해가며 모듈이 과하게 나누어져 있다면 통합을, 추가로 나눠야한다면 분리할 생각입니다. Suwiki Architecture는 계속 변경될 예정이며 피드백이나 질문이 있다면 koownij@kakao.com으로 언제든지 연락 주세요 :)
+## Setup
 
-## Module
+### 1. 프로젝트 클론
 
-### 40개가 넘는 모듈로 나눈 이유
+```bash
+git clone https://github.com/your-org/cchaksa-kmp.git
+cd cchaksa-kmp
+```
 
-#### 1. Suwiki는 최소 5년 이상의 서비스를 목표로 하고 있습니다.
+### 2. API Key 설정
 
-오랜 시간이 지난 후 코드를 다시 보았을 때, 관심사별로 모듈이 분리되어 있다면 유지 보수가 쉬울거라 판단했기 때문입니다.
+키 값은 [Notion](https://www.notion.so/30a1a2480da180408962e123dc1482ca?source=copy_link)에서 확인할 수 있습니다.
 
-#### 2. 인원이 계속 변경됩니다.
+#### Android
 
-고정된 인원이 개발을 하는 것이 아니며 수원대학교 후배들에게 프로젝트를 넘겨주며 이어나갈 생각입니다. 모듈 분리가 명확하다면 새로운 인원이 코드를 변경해도 안전하기 때문입니다.
+`local.properties`에 추가 (gitignore 됨):
 
-#### 3. 새로운 Feature가 추가될 가능성이 큽니다.
+```properties
+KAKAO_NATIVE_APP_KEY=노션에서_확인한_키_값
+```
 
-새로운 기능이 추가되더라도 모듈 분리가 되어있기 때문에 기존 코드에 영향을 주기 어렵습니다.
+#### iOS
 
-#### 4. 멀티 모듈 단점 극복
+`iosApp/Configuration/Config.xcconfig`에 추가 (gitignore 됨):
 
-40개의 모듈로 분리했기 때문에 오히려 복잡해보일 수 있습니다. 하지만 문서화를 통해 모듈간의 의존성과 모듈이 어떤 역할을 하는지 자세히 적어놓는다면 해결할 수 있다 생각했습니다.
+```
+KAKAO_NATIVE_APP_KEY=노션에서_확인한_키_값
+```
 
-### 모듈화 기준
+### 3. Build
 
-#### 1. Clean Architecture의 Layer와 앱의 Feature 단위로 분리
+```bash
+# Android
+./gradlew assembleDebug
 
-ex) 시간표, 강의평가
+# iOS (Simulator)
+./gradlew linkDebugFrameworkIosSimulatorArm64
+# 이후 Xcode에서 iosApp.xcworkspace 열고 빌드
+```
 
-`domain:timetable`, `data:timetable`, `feature:timetable`
-`domain:lectureevaluation`, `data:lectureevaluation`, `feature:lectureevaluatioin`
+## Architecture
 
-#### 2. 모듈의 특정 부분이 여러 곳에서 사용된다면 분리
+MVI + Clean Architecture 패턴을 사용합니다.
 
-ex) 강의평가 Create/Read/Update/Delete 기능 중 Create/Update/Delete 부분이 `feature:myinfo`, `feature:lectureevaluation`에서 사용되는 경우
+```
+Presentation (MVI)  →  Domain (UseCase)  →  Data (Repository)
+     ↓                                          ↓
+  ViewModel + State/SideEffect          Local (Room/DataStore)
+                                        Remote (Firebase)
+```
 
-강의평가 Read 기능과 Create/Update/Delete 기능을 분리합니다. -> `feature:lectureevaluation:viewer`, `feature:lectureevaluation:editor`
-
-### 모듈 설명
-
-feature, data, domain, local, remote 모듈이 가지는 의존성은 아래와 같습니다. (core 모듈 등 일부 모듈의 의존성은 사진에서 제외함)
-![entire_module_graph.png](docs/entire_module_graph.png)
-
-#### core
-
-이름에서 유추할 수 있듯 많은 모듈에서 재사용하는 핵심 코드입니다. core 모듈간의 의존성은 가질 수 있으나 core 모듈이 다른 모듈(feature, data, domain, local, remote)의 의존성을 가지면 안됩니다.
-
-![core_module.png](docs/core_module.png)
-
-|        이름         |                          역할                           |
-|:-----------------:|:-----------------------------------------------------:|
-|   core:android    |     안드로이드 의존성을 가지는 모듈들이 공통적으로 사용할 수 있는 코드가 존재합니다.     |
-|    core:common    |           모든 모듈에서 공통적으로 사용할 수 있는 코드가 존재합니다.           |
-|   core:database   |       Local Database(Room), Jetpack - DataStore       |
-| core:designsystem |          Component, Theme, Color, Typography          |
-|   core:network    |                Retrofit2 관련 코드가 존재합니다.                |
-|      core:ui      | ui에서 공통으로 사용하는 코드가 존재합니다. 예를 들면 Modifier의 확장함수가 있습니다. |
-|   core:security   |           특정 값을 암호화해주는 모듈입니다. Jwt를 암호화합니다.            |
-|    core:model     |             공통적으로 사용하는 Model이 정의되어 있습니다.              |
-
-#### feature
-
-모든 feature 모듈은 `feature:navigation` 모듈에 의존하고 있습니다.
-
-#### 그 외
-
-|         이름          |                    역할                    |
-|:-------------------:|:----------------------------------------:|
-|         app         |                레거시 코드입니다.                |
-|     app:compose     |            새롭게 리팩토링 중인 모듈입니다.            |
-| data, local, remote |     Clean Architecture에서의 data Layer     |
-|       domain        |    Clean Architecture에서의 domain Layer    |
-|       feature       | Clean Architecture에서의 presentation Layer |
+각 화면은 `[Feature]State`, `[Feature]SideEffect`, `[Feature]ViewModel` 구조를 따릅니다.

composeApp/build.gradle.kts

@@ -1,4 +1,12 @@
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import java.util.Properties
+
+val localProperties = Properties().apply {
+  val localPropertiesFile = rootProject.file("local.properties")
+  if (localPropertiesFile.exists()) {
+    load(localPropertiesFile.inputStream())
+  }
+}
 
 plugins {
   alias(libs.plugins.kotlinMultiplatform)
@@ -49,6 +57,7 @@ kotlin {
       implementation(libs.glance.appwidget)
       implementation(libs.glance.material3)
       implementation(libs.compose.runtime)
+      implementation(libs.kakao.sdk.v2.user)
     }
     iosMain.dependencies {
     }
@@ -82,6 +91,7 @@ kotlin {
       implementation(libs.kmp.firebase.crashlytics)
       implementation(libs.kmp.firebase.analytics)
       implementation(libs.napier)
+      implementation(libs.kinappbrowser)
     }
     commonTest.dependencies {
       implementation(libs.kotlin.test)
@@ -104,6 +114,9 @@ android {
     targetSdk = libs.versions.android.targetSdk.get().toInt()
     versionCode = 51
     versionName = "3.0.1"
+
+    buildConfigField("String", "KAKAO_NATIVE_APP_KEY", "\"${localProperties["KAKAO_NATIVE_APP_KEY"] ?: ""}\"")
+    manifestPlaceholders["KAKAO_NATIVE_APP_KEY"] = localProperties["KAKAO_NATIVE_APP_KEY"] ?: ""
   }
   packaging {
     resources {

composeApp/src/androidMain/AndroidManifest.xml

@@ -19,6 +19,18 @@
         <category android:name="android.intent.category.LAUNCHER" />
       </intent-filter>
     </activity>
+    <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" />
+        <data
+          android:host="oauth"
+          android:scheme="kakao${KAKAO_NATIVE_APP_KEY}" />
+      </intent-filter>
+    </activity>
     <receiver android:name=".widget.TimetableWidgetReceiver" android:exported="true">
       <intent-filter>
         <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />

composeApp/src/androidMain/kotlin/com/chukchukhaksa/mobile/ChukChukHaksaApplication.kt

@@ -3,6 +3,7 @@ package com.chukchukhaksa.mobile
 import android.app.Application
 import com.chukchukhaksa.mobile.common.kmp.isDebug
 import com.chukchukhaksa.mobile.di.initKoin
+import com.kakao.sdk.common.KakaoSdk
 import com.google.firebase.Firebase
 import com.google.firebase.initialize
 import io.github.aakira.napier.DebugAntilog
@@ -22,5 +23,6 @@ class ChukChukHaksaApplication : Application() {
         }
 
         Firebase.initialize(this)
+        KakaoSdk.init(this, BuildConfig.KAKAO_NATIVE_APP_KEY)
     }
 }

composeApp/src/androidMain/kotlin/com/chukchukhaksa/mobile/common/kmp/KakaoSignInClient.android.kt

@@ -0,0 +1,65 @@
+package com.chukchukhaksa.mobile.common.kmp
+
+import android.content.Context
+import com.kakao.sdk.auth.model.OAuthToken
+import com.kakao.sdk.common.model.ClientError
+import com.kakao.sdk.common.model.ClientErrorCause
+import com.kakao.sdk.user.UserApiClient
+import kotlinx.coroutines.suspendCancellableCoroutine
+import java.util.UUID
+import kotlin.coroutines.resume
+import kotlin.coroutines.resumeWithException
+
+actual class KakaoSignInClient {
+
+    actual suspend fun signIn(context: Any?): KakaoSignInResult {
+        val androidContext = context as? Context
+            ?: throw IllegalStateException("Android Context is required for Kakao Login")
+
+        val nonce = UUID.randomUUID().toString()
+
+        return suspendCancellableCoroutine { continuation ->
+            val callback: (OAuthToken?, Throwable?) -> Unit = callback@{ token, error ->
+                if (error != null) {
+                    continuation.resumeWithException(error)
+                    return@callback
+                }
+                val idToken = token?.idToken
+                if (idToken == null) {
+                    continuation.resumeWithException(
+                        IllegalStateException("id_token이 null입니다. 카카오 콘솔에서 OpenID Connect를 활성화하세요.")
+                    )
+                    return@callback
+                }
+                continuation.resume(KakaoSignInResult(idToken = idToken, nonce = nonce))
+            }
+
+            if (UserApiClient.instance.isKakaoTalkLoginAvailable(androidContext)) {
+                UserApiClient.instance.loginWithKakaoTalk(
+                    context = androidContext,
+                    nonce = nonce,
+                ) { token, error ->
+                    if (error != null) {
+                        if (error is ClientError && error.reason == ClientErrorCause.Cancelled) {
+                            UserApiClient.instance.loginWithKakaoAccount(
+                                context = androidContext,
+                                nonce = nonce,
+                                callback = callback,
+                            )
+                            return@loginWithKakaoTalk
+                        }
+                        callback(null, error)
+                        return@loginWithKakaoTalk
+                    }
+                    callback(token, null)
+                }
+            } else {
+                UserApiClient.instance.loginWithKakaoAccount(
+                    context = androidContext,
+                    nonce = nonce,
+                    callback = callback,
+                )
+            }
+        }
+    }
+}

composeApp/src/androidMain/kotlin/com/chukchukhaksa/mobile/di/AndroidModule.kt

@@ -1,5 +1,6 @@
 package com.chukchukhaksa.mobile.di
 
+import com.chukchukhaksa.mobile.common.kmp.KakaoSignInClient
 import com.chukchukhaksa.mobile.local.database.openlecture.database.OpenLectureDatabaseFactory
 import com.chukchukhaksa.mobile.local.database.openmajor.database.OpenMajorDatabaseFactory
 import com.chukchukhaksa.mobile.local.database.timetable.database.TimetableDatabaseFactory
@@ -12,4 +13,5 @@ actual val platformModule = module {
     single { OpenMajorDatabaseFactory(androidApplication()) }
     single { OpenLectureDatabaseFactory(androidApplication()) }
     single { ChukChukHaksaDataStoreFactory(androidApplication()) }
+    factory { KakaoSignInClient() }
 }

composeApp/src/commonMain/kotlin/com/chukchukhaksa/mobile/common/kmp/KakaoSignInClient.kt

@@ -0,0 +1,10 @@
+package com.chukchukhaksa.mobile.common.kmp
+
+data class KakaoSignInResult(
+    val idToken: String,
+    val nonce: String,
+)
+
+expect class KakaoSignInClient {
+    suspend fun signIn(context: Any? = null): KakaoSignInResult
+}

composeApp/src/commonMain/kotlin/com/chukchukhaksa/mobile/di/DomainModules.kt

@@ -1,6 +1,7 @@
 package com.chukchukhaksa.mobile.di
 
 import com.chukchukhaksa.mobile.domain.auth.usecase.AppleLoginUseCase
+import com.chukchukhaksa.mobile.domain.auth.usecase.KakaoLoginUseCase
 import com.chukchukhaksa.mobile.domain.config.usecase.CheckNeedForceUpdateUseCase
 import com.chukchukhaksa.mobile.domain.timetable.usecase.DeleteTimetableCellUseCase
 import com.chukchukhaksa.mobile.domain.timetable.usecase.DeleteTimetableUseCase
@@ -44,4 +45,5 @@ val domainModule = module {
 
     // Auth use cases
     factory { AppleLoginUseCase(get()) }
+    factory { KakaoLoginUseCase(get()) }
 }

composeApp/src/commonMain/kotlin/com/chukchukhaksa/mobile/domain/auth/usecase/KakaoLoginUseCase.kt

@@ -0,0 +1,14 @@
+package com.chukchukhaksa.mobile.domain.auth.usecase
+
+import com.chukchukhaksa.mobile.common.kmp.KakaoSignInClient
+import com.chukchukhaksa.mobile.common.kmp.KakaoSignInResult
+import com.chukchukhaksa.mobile.domain.common.runCatchingIgnoreCancelled
+
+class KakaoLoginUseCase(
+    private val kakaoSignInClient: KakaoSignInClient,
+) {
+    suspend operator fun invoke(context: Any? = null): Result<KakaoSignInResult> =
+        runCatchingIgnoreCancelled {
+            kakaoSignInClient.signIn(context)
+        }
+}