Merge pull request #13 from hieuwu/feature/email-confirmation

Handle account creation with email confirmation - sign out - auth state logging

Author: hieuwu

.idea/inspectionProfiles/Project_Default.xml

@@ -1,23 +1,39 @@
-<h1 align="center"> 🚀 Product Sample Supabase</h1>
+# 🚀 Product Sample Supabase
 
 [![Made with Supabase](https://supabase.com/badge-made-with-supabase-dark.svg)](https://supabase.com)
 
-<!-- <img width="964" alt="Screen Shot 2023-06-02 at 21 33 16" src="https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/288eef97-d8fe-422f-8bb3-1c8424bab08e">
+![Product Sample Cover](https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/1bed0c84-208a-4266-a2ec-2bac50ddf80c)
 
-<img width="1092" alt="Screen Shot 2023-06-05 at 21 39 24" src="https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/3f154fda-aa9e-4baa-81f2-5b744c7ad2fe"> -->
+## 📖 Overview
 
-![manage-product-cover](https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/1bed0c84-208a-4266-a2ec-2bac50ddf80c)
-[![Android CI](https://github.com/hieuwu/product-sample-supabase-kt/actions/workflows/app-build.yml/badge.svg)](https://github.com/hieuwu/product-sample-supabase-kt/actions/workflows/app-build.yml)
+This project is a modern Android application built with **Jetpack Compose**, showcasing **best practices** for integrating **Supabase** for **authentication**, **OAuth**, **storage**, and **real-time CRUD operations**. It serves as a reference for developers aiming to build scalable, maintainable Android apps with a robust backend.
 
-### About
-Demonstration and best practices of how to use Supabase database for CRUD operation
+### 🎯 Features
+- **Supabase Integration**: Email/password authentication, OAuth (e.g., Google), file storage, and real-time database operations.
+- **Jetpack Compose**: Declarative UI for a responsive and modern user experience.
+- **Hilt Dependency Injection**: Clean architecture for modularity and testability.
+- **Real-time Data**: Leverages Supabase's real-time subscriptions for live updates.
+- **CI/CD**: Automated builds and testing via GitHub Actions.
+- **Image Loading**: Efficient image handling with Coil.
 
-### Setup
-Android Studio with SDK 30 or above
-Open `local.properties` file, add these
-```kotlin
-API_KEY=YOUR_SUPABASE_API_KEY
-SECRET=YOUR_SUPABASE_SECRET
-SUPABASE_URL=YOUR_SUPABASE_URL
+## 🛠️ Setup
 
-```
+### Prerequisites
+- **Android Studio**: SDK 30 (Android 11) or higher.
+- **Supabase Account**: Obtain API key, secret, and project URL from [Supabase](https://supabase.com).
+- **Kotlin**: Version 1.9.0 or higher recommended.
+
+### Installation
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/hieuwu/product-sample-supabase-kt.git
+   ```
+2. Open the project in Android Studio.
+3. Create or update the `local.properties` file in the project root:
+   ```kotlin
+   API_KEY=YOUR_SUPABASE_API_KEY
+   SECRET=YOUR_SUPABASE_SECRET
+   SUPABASE_URL=YOUR_SUPABASE_URL
+   ```
+   Replace `YOUR_SUPABASE_API_KEY`, `YOUR_SUPABASE_SECRET`, and `YOUR_SUPABASE_URL` with values from your Supabase project dashboard.
+4. Sync the project with Gradle and build the app.

README.md

@@ -14,7 +14,7 @@
         android:theme="@style/Theme.ManageProducts"
         tools:targetApi="31">
         <activity
-            android:name=".DeepLinkHandlerActivity"
+            android:name=".presentation.feature.deeplink.DeepLinkHandlerActivity"
             android:exported="true"
             android:theme="@style/Theme.ManageProducts" >
             <intent-filter android:autoVerify="true">
@@ -24,6 +24,10 @@
                 <data
                     android:host="supabase.com"
                     android:scheme="app" />
+                <data
+                    android:host="supabase.com"
+                    android:pathPrefix="/confirm"
+                    android:scheme="app" />
             </intent-filter>
         </activity>
         <activity

app/src/main/AndroidManifest.xml

@@ -23,7 +23,6 @@ class MainActivity : ComponentActivity() {
     @Inject
     lateinit var supabaseClient: SupabaseClient
 
-    @OptIn(ExperimentalMaterial3Api::class)
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContent {

app/src/main/java/com/example/manageproducts/MainActivity.kt

@@ -16,5 +16,5 @@ data class ProductDto(
     val image: String? = "",
 
     @SerialName("id")
-    val id: String? = "",
+    val id: String? = null,
 )

app/src/main/java/com/example/manageproducts/data/network/dto/ProductDto.kt

@@ -1,7 +1,14 @@
 package com.example.manageproducts.data.repository
 
+import com.example.manageproducts.domain.model.AuthState
+import kotlinx.coroutines.flow.StateFlow
+
 interface AuthenticationRepository {
+    val authState: StateFlow<AuthState>
     suspend fun signIn(email: String, password: String): Boolean
     suspend fun signUp(email: String, password: String): Boolean
     suspend fun signInWithGoogle(): Boolean
+    suspend fun exchangeCodeForSession(code: String): Result<Unit>
+    suspend fun verifyEmail(tokenHash: String): Result<Unit>
+    suspend fun signOut()
 }

app/src/main/java/com/example/manageproducts/data/repository/AuthenticationRepository.kt

@@ -1,14 +1,43 @@
 package com.example.manageproducts.data.repository.impl
 
+import android.util.Log
 import com.example.manageproducts.data.repository.AuthenticationRepository
+import com.example.manageproducts.domain.model.AuthState
 import io.github.jan.supabase.auth.Auth
+import io.github.jan.supabase.auth.OtpType
 import io.github.jan.supabase.auth.providers.Google
 import io.github.jan.supabase.auth.providers.builtin.Email
+import io.github.jan.supabase.auth.status.SessionStatus
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.launch
+import kotlinx.datetime.TimeZone
+import kotlinx.datetime.toLocalDateTime
 import javax.inject.Inject
+import kotlin.time.ExperimentalTime
+
+private const val logTag = "AuthenticationRepository"
 
 class AuthenticationRepositoryImpl @Inject constructor(
     private val auth: Auth,
 ) : AuthenticationRepository {
+
+    private val _authState: MutableStateFlow<AuthState> = MutableStateFlow(AuthState.Initializing)
+    override val authState: StateFlow<AuthState> = _authState
+
+    private val scope = CoroutineScope(Dispatchers.IO + SupervisorJob())
+
+    init {
+        scope.launch {
+            auth.sessionStatus.collect { status ->
+                logSessionStatus(status)
+            }
+        }
+    }
+
     override suspend fun signIn(email: String, password: String): Boolean {
         return try {
             auth.signInWith(Email) {
@@ -23,7 +52,7 @@ class AuthenticationRepositoryImpl @Inject constructor(
 
     override suspend fun signUp(email: String, password: String): Boolean {
         return try {
-            auth.signUpWith(Email) {
+            auth.signUpWith(Email, "app://supabase.com/confirm") {
                 this.email = email
                 this.password = password
             }
@@ -41,4 +70,67 @@ class AuthenticationRepositoryImpl @Inject constructor(
             false
         }
     }
+
+
+    @OptIn(ExperimentalTime::class)
+    private fun logSessionStatus(sessionStatus: SessionStatus) {
+        when (sessionStatus) {
+            is SessionStatus.Authenticated -> {
+                Log.d(
+                    logTag, """
+                           Session source:${sessionStatus.source}
+                           SessionStatus: Authenticated
+                           Session expiry:${sessionStatus.session.expiresAt.toLocalDateTime(TimeZone.UTC)}
+                    """
+                )
+                _authState.value = AuthState.Authenticated
+            }
+
+
+            SessionStatus.Initializing -> {
+                Log.d(logTag, "SessionStatus: Initializing")
+                _authState.value = AuthState.Initializing
+
+            }
+
+
+            is SessionStatus.RefreshFailure -> {
+                Log.d(logTag, "SessionStatus: RefreshFailure")
+            }
+
+            is SessionStatus.NotAuthenticated -> {
+                Log.d(
+                    logTag,
+                    """
+                           SessionStatus: NotAuthenticated
+                           IsSignOut: ${sessionStatus.isSignOut}
+                    """.trimIndent()
+                )
+                _authState.value = AuthState.Unauthenticated
+            }
+
+        }
+    }
+
+    override suspend fun exchangeCodeForSession(code: String): Result<Unit> =
+        runCatching {
+            auth.exchangeCodeForSession(code = code, saveSession = true)
+            return Result.success(Unit)
+        }.onFailure {
+            return Result.failure(it)
+        }
+
+    override suspend fun verifyEmail(tokenHash: String): Result<Unit> = runCatching {
+        auth.verifyEmailOtp(
+            type = OtpType.Email.EMAIL,
+            tokenHash = tokenHash
+        )
+        return Result.success(Unit)
+    }.onFailure { e ->
+        return Result.failure(e)
+    }
+
+    override suspend fun signOut() {
+        auth.signOut()
+    }
 }

app/src/main/java/com/example/manageproducts/data/repository/impl/AuthenticationRepositoryImpl.kt

@@ -8,6 +8,7 @@ import dagger.Binds
 import dagger.Module
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
 
 @InstallIn(SingletonComponent::class)
 @Module
@@ -17,6 +18,7 @@ abstract class RepositoryModule {
     abstract fun bindProductRepository(impl: ProductRepositoryImpl): ProductRepository
 
     @Binds
+    @Singleton
     abstract fun bindAuthenticateRepository(impl: AuthenticationRepositoryImpl): AuthenticationRepository
 
 }

app/src/main/java/com/example/manageproducts/di/RepositoryModule.kt

@@ -0,0 +1,7 @@
+package com.example.manageproducts.domain.model
+
+sealed interface AuthState {
+    data object Initializing : AuthState
+    data object Authenticated : AuthState
+    data object Unauthenticated: AuthState
+}

app/src/main/java/com/example/manageproducts/domain/model/AuthState.kt

@@ -1,10 +1,12 @@
-package com.example.manageproducts
+package com.example.manageproducts.presentation.feature.deeplink
 
 import android.content.Intent
+import android.net.Uri
 import android.os.Bundle
 import android.util.Log
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
+import androidx.activity.viewModels
 import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.layout.padding
 import androidx.compose.material3.MaterialTheme
@@ -14,7 +16,10 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import androidx.navigation.compose.rememberNavController
+import com.example.manageproducts.MainActivity
+import com.example.manageproducts.presentation.feature.deeplink.state.RedirectDestination
 import com.example.manageproducts.presentation.feature.signin.SignInSuccessScreen
 import com.example.manageproducts.ui.theme.ManageProductsTheme
 import dagger.hilt.android.AndroidEntryPoint
@@ -29,6 +34,8 @@ class DeepLinkHandlerActivity : ComponentActivity() {
     @Inject
     lateinit var supabaseClient: SupabaseClient
 
+    private val viewModel: DeepLinkHandlerViewModel by viewModels()
+
     private lateinit var callback: (String, String) -> Unit
 
     @OptIn(ExperimentalTime::class)
@@ -45,6 +52,20 @@ class DeepLinkHandlerActivity : ComponentActivity() {
             val navController = rememberNavController()
             val emailState = remember { mutableStateOf("") }
             val createdAtState = remember { mutableStateOf("") }
+            val state = viewModel.state.collectAsStateWithLifecycle().value
+            LaunchedEffect(Unit) {
+                handleDeepLink(intent)
+            }
+            LaunchedEffect(state.redirectDestination) {
+                when (state.redirectDestination) {
+                    is RedirectDestination.EmailConfirmation -> {
+                        // Success
+                        navigateToMainApp()
+                    }
+
+                    else -> Unit
+                }
+            }
             LaunchedEffect(Unit) {
                 callback = { email, created ->
                     emailState.value = email
@@ -74,5 +95,30 @@ class DeepLinkHandlerActivity : ComponentActivity() {
         }
         startActivity(intent)
     }
+
+    private fun handleDeepLink(intent: Intent) {
+        if (intent.action == Intent.ACTION_VIEW) {
+            val uri: Uri? = intent.data
+            uri?.let {
+                val tokenHash = it.getQueryParameter("token_hash")
+                val code = it.getQueryParameter("code") ?: ""
+                val actionPath = it.pathSegments.last()
+                if (tokenHash != null) {
+                    when (actionPath) {
+                        "confirm" -> {
+                            viewModel.verifyEmailConfirmation(tokenHash)
+                        }
+                    }
+                } else {
+                    when (actionPath) {
+                        "oauth" -> {
+                            viewModel.verifyGoogleAuth(code = code)
+                        }
+                    }
+                    println("Invalid deep link parameters")
+                }
+            }
+        }
+    }
 }