Feat/authentication/view model : View Model for Supabase Authentication #47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added class `com.android.periodpals.model.AuthViewModel`. It takes an AuthModel (to be implemented) and has a single function for now: `signUpWithEmail`. The View can call this function to register a new user using an email and password.
Added a data class `com.android.periodpals.model.user.User`. For now, this class has attributes `uid`, `userName` and `displayName` but can be augmented later.
Code was used to test the connection to the Supabase database by having a screen display a `countries` list present on Supabase. Deleted the countries list in Supabase as well.
This `SupabaseClient` object can be called from anywhere to access the Supabase client configured with the correct url and anon key. For now, it install only the `Auth` plugin.
…d's shared preferences The file used by `SharedPreferenceHelper` to store and fetch the preferences is called `period_pals_prefs`. It saves preferences in a (key, value) structure.
Added a `UserState` class that defines a user state: either `Loading`, `Success` or `Error`. Added an observable user state `userState` to the class. Improved `signUpWithEmail` function to take a context as argument (used to save the access token in Android's shared preferences). Added `onSuccess` and `onFailure` in the call to the Model's `login` method.
Added public functions to manage the authentication in the View Model: + `logInWithEmail` to log a user that already has a registered + `logOut` to log a user out + `isUserLoggedIn` to check whether or not the user is logged in
Renamed class `UserState` to `UserAuthState`, as well as `userState` variables to `userAuthState` for consistency.
…hViewModel` Set the `_userAuthState` to `Loading` at the beginning of the `signUpWithEmail`, `logInWithEmail` and `logOut` functions in `AuthViewModel` so that the state behaves as expected.
Created a `clearPreferences` function in `SharedPreferencesHelper` and called it in the `onSuccess` lambda of the `logOut` function of the `AuthViewModel`. The signature of the `logOut` function changed and now takes a `Context` as parameter.
…hentication/view-model # Conflicts: # app/build.gradle.kts # app/src/main/AndroidManifest.xml # app/src/main/java/com/android/periodpals/MainActivity.kt # gradle/libs.versions.toml # gradle/wrapper/gradle-wrapper.properties
…hentication/view-model # Conflicts: # app/src/main/java/com/android/periodpals/MainActivity.kt # gradle/libs.versions.toml
francelu
requested changes
Oct 17, 2024
app/src/main/java/com/android/periodpals/model/auth/AuthViewModel.kt
Outdated
Show resolved
Hide resolved
app/src/main/java/com/android/periodpals/utils/SharedPreferenceHelper.kt
Outdated
Show resolved
Hide resolved
…omments to MainCoroutineRule.kt and remove commented out code from AuthViewModel.kt
…iew-model # Conflicts: # app/build.gradle.kts # app/src/main/java/com/android/periodpals/MainActivity.kt
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
View Model for Supabase Authentication
Description
This PR introduces the View Model for the Supabase Authentication. It adds multiple new utilities classes. For now it only accepts user account creation through email. Add Also a rule for the
MainCoroutineto be able to run test on functions that have theviewModelScope. It closes issue #11.Changes
AuthModelSupabasefunctionisLoggedInrefactored for readibility.MainCoroutineRule.ktcreated to test functions that haveviewModelScope.Files
Added
AuthViewModel.ktinapp.src.main,java,com.android.periodpals.model.authAuthViewModelTest.ktinapp.src.test,java,com.android.periodpals.model.authMainCoroutineRule.ktinapp.src.test,java,com.android.periodpalsSupabaseClient.ktinapp.src.test,java,com.android.periodpals.modelSharedPreferenceHelper.ktinapp/src/main/java/com/android/periodpals/utilsUser.ktinapp/src/main/java/com/android/periodpals/model/userUserAuthState.ktinapp/src/main/java/com/android/periodpals/model/userModified
app/build.gradle.ktsAuthModelSupabase.ktinapp.src.main,java,com.android.periodpals.model.authAuthModelSupabaseTest.ktinapp.src.test,java,com.android.periodpals.model.authDependencies Added
org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.1forMainCoroutineRule.ktTesting
AuthViewModel.kt. It tests wether it correctly handled successful and erroneous calls to the authentication model.AuthModel.ktto adapt correctly to the changes to the class.