Merge pull request #1127 from vector-im/feature/bma/finishOidc

Enable OIDC support
element-hq · Aug 23, 2023 · 14c568d · 14c568d
2 parents 7eb1f1c + 01bb850
commit 14c568d
Show file tree

Hide file tree

Showing 40 changed files with 488 additions and 109 deletions.
diff --git a/changelog.d/1127.feature b/changelog.d/1127.feature
@@ -0,0 +1 @@
+Enable OIDC support.
diff --git a/docs/oidc.md b/docs/oidc.md
@@ -45,3 +45,7 @@ state: ex6mNJVFZ5jn9wL8
 
 Oidc client example: https://github.com/matrix-org/matrix-rust-sdk/blob/39ad8a46801fb4317a777ebf895822b3675b709c/examples/oidc_cli/src/main.rs
 Oidc sdk doc: https://github.com/matrix-org/matrix-rust-sdk/blob/39ad8a46801fb4317a777ebf895822b3675b709c/crates/matrix-sdk/src/oidc.rs
+
+
+Test server:
+synapse-oidc.lab.element.dev
diff --git a/...oid/features/login/impl/screens/confirmaccountprovider/ConfirmAccountProviderPresenter.kt b/...oid/features/login/impl/screens/confirmaccountprovider/ConfirmAccountProviderPresenter.kt
@@ -17,6 +17,7 @@
 package io.element.android.features.login.impl.screens.confirmaccountprovider
 
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
@@ -26,8 +27,11 @@ import androidx.compose.runtime.rememberCoroutineScope
 import dagger.assisted.Assisted
 import dagger.assisted.AssistedFactory
 import dagger.assisted.AssistedInject
+import io.element.android.features.login.api.oidc.OidcAction
+import io.element.android.features.login.impl.DefaultLoginUserStory
 import io.element.android.features.login.impl.accountprovider.AccountProviderDataSource
 import io.element.android.features.login.impl.error.ChangeServerError
+import io.element.android.features.login.impl.oidc.customtab.DefaultOidcActionFlow
 import io.element.android.libraries.architecture.Async
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.architecture.runCatchingUpdatingState
@@ -40,7 +44,9 @@ import java.net.URL
 class ConfirmAccountProviderPresenter @AssistedInject constructor(
     @Assisted private val params: Params,
     private val accountProviderDataSource: AccountProviderDataSource,
-    private val authenticationService: MatrixAuthenticationService
+    private val authenticationService: MatrixAuthenticationService,
+    private val defaultOidcActionFlow: DefaultOidcActionFlow,
+    private val defaultLoginUserStory: DefaultLoginUserStory,
 ) : Presenter<ConfirmAccountProviderState> {
 
     data class Params(
@@ -61,6 +67,14 @@ class ConfirmAccountProviderPresenter @AssistedInject constructor(
             mutableStateOf(Async.Uninitialized)
         }
 
+        LaunchedEffect(Unit) {
+            launch {
+                defaultOidcActionFlow.collect {
+                    onOidcAction(it, loginFlowAction)
+                }
+            }
+        }
+
         fun handleEvents(event: ConfirmAccountProviderEvents) {
             when (event) {
                 ConfirmAccountProviderEvents.Continue -> {
@@ -97,4 +111,33 @@ class ConfirmAccountProviderPresenter @AssistedInject constructor(
             }.getOrThrow()
         }.runCatchingUpdatingState(loginFlowAction, errorTransform = ChangeServerError::from)
     }
+
+    private suspend fun onOidcAction(
+        oidcAction: OidcAction?,
+        loginFlowAction: MutableState<Async<LoginFlow>>,
+    ) {
+        oidcAction ?: return
+        loginFlowAction.value = Async.Loading()
+        when (oidcAction) {
+            OidcAction.GoBack -> {
+                authenticationService.cancelOidcLogin()
+                    .onSuccess {
+                        loginFlowAction.value = Async.Uninitialized
+                    }
+                    .onFailure { failure ->
+                        loginFlowAction.value = Async.Failure(failure)
+                    }
+            }
+            is OidcAction.Success -> {
+                authenticationService.loginWithOidc(oidcAction.url)
+                    .onSuccess { _ ->
+                        defaultLoginUserStory.setLoginFlowIsDone(true)
+                    }
+                    .onFailure { failure ->
+                        loginFlowAction.value = Async.Failure(failure)
+                    }
+            }
+        }
+        defaultOidcActionFlow.reset()
+    }
 }
diff --git a/.../login/impl/src/main/kotlin/io/element/android/features/login/impl/util/LoginConstants.kt b/.../login/impl/src/main/kotlin/io/element/android/features/login/impl/util/LoginConstants.kt
@@ -21,7 +21,7 @@ import io.element.android.features.login.impl.accountprovider.AccountProvider
 object LoginConstants {
     const val MATRIX_ORG_URL = "matrix.org"
 
-    const val DEFAULT_HOMESERVER_URL = "matrix.org" // TODO Oidc "synapse-oidc.lab.element.dev"
+    const val DEFAULT_HOMESERVER_URL = "matrix.org"
     const val SLIDING_SYNC_READ_MORE_URL = "https://github.com/matrix-org/sliding-sync/blob/main/docs/Landing.md"
 }
 

diff --git a/...features/login/impl/screens/confirmaccountprovider/ConfirmAccountProviderPresenterTest.kt b/...features/login/impl/screens/confirmaccountprovider/ConfirmAccountProviderPresenterTest.kt
@@ -20,24 +20,25 @@ import app.cash.molecule.RecompositionMode
 import app.cash.molecule.moleculeFlow
 import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
+import io.element.android.features.login.api.oidc.OidcAction
+import io.element.android.features.login.impl.DefaultLoginUserStory
 import io.element.android.features.login.impl.accountprovider.AccountProviderDataSource
+import io.element.android.features.login.impl.oidc.customtab.DefaultOidcActionFlow
 import io.element.android.features.login.impl.util.defaultAccountProvider
 import io.element.android.libraries.architecture.Async
+import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService
 import io.element.android.libraries.matrix.test.A_HOMESERVER
 import io.element.android.libraries.matrix.test.A_HOMESERVER_OIDC
 import io.element.android.libraries.matrix.test.A_THROWABLE
 import io.element.android.libraries.matrix.test.auth.FakeAuthenticationService
+import io.element.android.tests.testutils.waitForPredicate
 import kotlinx.coroutines.test.runTest
 import org.junit.Test
 
 class ConfirmAccountProviderPresenterTest {
     @Test
     fun `present - initial test`() = runTest {
-        val presenter = ConfirmAccountProviderPresenter(
-            ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
-            AccountProviderDataSource(),
-            FakeAuthenticationService(),
-        )
+        val presenter = createConfirmAccountProviderPresenter()
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -51,13 +52,11 @@ class ConfirmAccountProviderPresenterTest {
 
     @Test
     fun `present - continue password login`() = runTest {
-        val authServer = FakeAuthenticationService()
-        val presenter = ConfirmAccountProviderPresenter(
-            ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
-            AccountProviderDataSource(),
-            authServer,
+        val authenticationService = FakeAuthenticationService()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
         )
-        authServer.givenHomeserver(A_HOMESERVER)
+        authenticationService.givenHomeserver(A_HOMESERVER)
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -75,13 +74,63 @@ class ConfirmAccountProviderPresenterTest {
 
     @Test
     fun `present - continue oidc`() = runTest {
-        val authServer = FakeAuthenticationService()
-        val presenter = ConfirmAccountProviderPresenter(
-            ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
-            AccountProviderDataSource(),
-            authServer,
+        val authenticationService = FakeAuthenticationService()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
+        )
+        authenticationService.givenHomeserver(A_HOMESERVER_OIDC)
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            val initialState = awaitItem()
+            initialState.eventSink.invoke(ConfirmAccountProviderEvents.Continue)
+            val loadingState = awaitItem()
+            assertThat(loadingState.submitEnabled).isTrue()
+            assertThat(loadingState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            val successState = awaitItem()
+            assertThat(successState.submitEnabled).isFalse()
+            assertThat(successState.loginFlow).isInstanceOf(Async.Success::class.java)
+            assertThat(successState.loginFlow.dataOrNull()).isInstanceOf(LoginFlow.OidcFlow::class.java)
+        }
+    }
+
+    @Test
+    fun `present - oidc - cancel with failure`() = runTest {
+        val authenticationService = FakeAuthenticationService()
+        val defaultOidcActionFlow = DefaultOidcActionFlow()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
+            defaultOidcActionFlow = defaultOidcActionFlow,
+        )
+        authenticationService.givenHomeserver(A_HOMESERVER_OIDC)
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            val initialState = awaitItem()
+            initialState.eventSink.invoke(ConfirmAccountProviderEvents.Continue)
+            val loadingState = awaitItem()
+            assertThat(loadingState.submitEnabled).isTrue()
+            assertThat(loadingState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            val successState = awaitItem()
+            assertThat(successState.submitEnabled).isFalse()
+            assertThat(successState.loginFlow).isInstanceOf(Async.Success::class.java)
+            assertThat(successState.loginFlow.dataOrNull()).isInstanceOf(LoginFlow.OidcFlow::class.java)
+            authenticationService.givenOidcCancelError(A_THROWABLE)
+            defaultOidcActionFlow.post(OidcAction.GoBack)
+            val cancelFailureState = awaitItem()
+            assertThat(cancelFailureState.loginFlow).isInstanceOf(Async.Failure::class.java)
+        }
+    }
+
+    @Test
+    fun `present - oidc - cancel with success`() = runTest {
+        val authenticationService = FakeAuthenticationService()
+        val defaultOidcActionFlow = DefaultOidcActionFlow()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
+            defaultOidcActionFlow = defaultOidcActionFlow,
         )
-        authServer.givenHomeserver(A_HOMESERVER_OIDC)
+        authenticationService.givenHomeserver(A_HOMESERVER_OIDC)
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
@@ -94,22 +143,86 @@ class ConfirmAccountProviderPresenterTest {
             assertThat(successState.submitEnabled).isFalse()
             assertThat(successState.loginFlow).isInstanceOf(Async.Success::class.java)
             assertThat(successState.loginFlow.dataOrNull()).isInstanceOf(LoginFlow.OidcFlow::class.java)
+            defaultOidcActionFlow.post(OidcAction.GoBack)
+            val cancelFinalState = awaitItem()
+            assertThat(cancelFinalState.loginFlow).isInstanceOf(Async.Uninitialized::class.java)
+        }
+    }
+
+    @Test
+    fun `present - oidc - success with failure`() = runTest {
+        val authenticationService = FakeAuthenticationService()
+        val defaultOidcActionFlow = DefaultOidcActionFlow()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
+            defaultOidcActionFlow = defaultOidcActionFlow,
+        )
+        authenticationService.givenHomeserver(A_HOMESERVER_OIDC)
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            val initialState = awaitItem()
+            initialState.eventSink.invoke(ConfirmAccountProviderEvents.Continue)
+            val loadingState = awaitItem()
+            assertThat(loadingState.submitEnabled).isTrue()
+            assertThat(loadingState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            val successState = awaitItem()
+            assertThat(successState.submitEnabled).isFalse()
+            assertThat(successState.loginFlow).isInstanceOf(Async.Success::class.java)
+            assertThat(successState.loginFlow.dataOrNull()).isInstanceOf(LoginFlow.OidcFlow::class.java)
+            authenticationService.givenLoginError(A_THROWABLE)
+            defaultOidcActionFlow.post(OidcAction.Success("aUrl"))
+            val cancelLoadingState = awaitItem()
+            assertThat(cancelLoadingState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            val cancelFailureState = awaitItem()
+            assertThat(cancelFailureState.loginFlow).isInstanceOf(Async.Failure::class.java)
+        }
+    }
+
+    @Test
+    fun `present - oidc - success with success`() = runTest {
+        val authenticationService = FakeAuthenticationService()
+        val defaultOidcActionFlow = DefaultOidcActionFlow()
+        val defaultLoginUserStory = DefaultLoginUserStory().apply {
+            setLoginFlowIsDone(false)
+        }
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
+            defaultOidcActionFlow = defaultOidcActionFlow,
+            defaultLoginUserStory = defaultLoginUserStory,
+        )
+        authenticationService.givenHomeserver(A_HOMESERVER_OIDC)
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            val initialState = awaitItem()
+            initialState.eventSink.invoke(ConfirmAccountProviderEvents.Continue)
+            val loadingState = awaitItem()
+            assertThat(loadingState.submitEnabled).isTrue()
+            assertThat(loadingState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            val successState = awaitItem()
+            assertThat(successState.submitEnabled).isFalse()
+            assertThat(successState.loginFlow).isInstanceOf(Async.Success::class.java)
+            assertThat(successState.loginFlow.dataOrNull()).isInstanceOf(LoginFlow.OidcFlow::class.java)
+            assertThat(defaultLoginUserStory.loginFlowIsDone.value).isFalse()
+            defaultOidcActionFlow.post(OidcAction.Success("aUrl"))
+            val successSuccessState = awaitItem()
+            assertThat(successSuccessState.loginFlow).isInstanceOf(Async.Loading::class.java)
+            waitForPredicate { defaultLoginUserStory.loginFlowIsDone.value }
         }
     }
 
     @Test
     fun `present - submit fails`() = runTest {
-        val authServer = FakeAuthenticationService()
-        val presenter = ConfirmAccountProviderPresenter(
-            ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
-            AccountProviderDataSource(),
-            authServer,
+        val authenticationService = FakeAuthenticationService()
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
         )
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
         }.test {
             val initialState = awaitItem()
-            authServer.givenChangeServerError(Throwable())
+            authenticationService.givenChangeServerError(Throwable())
             initialState.eventSink.invoke(ConfirmAccountProviderEvents.Continue)
             skipItems(1) // Loading
             val failureState = awaitItem()
@@ -121,10 +234,8 @@ class ConfirmAccountProviderPresenterTest {
     @Test
     fun `present - clear error`() = runTest {
         val authenticationService = FakeAuthenticationService()
-        val presenter = ConfirmAccountProviderPresenter(
-            ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
-            AccountProviderDataSource(),
-            authenticationService,
+        val presenter = createConfirmAccountProviderPresenter(
+            matrixAuthenticationService = authenticationService,
         )
         moleculeFlow(RecompositionMode.Immediate) {
             presenter.present()
@@ -147,4 +258,18 @@ class ConfirmAccountProviderPresenterTest {
             assertThat(clearedState.loginFlow).isEqualTo(Async.Uninitialized)
         }
     }
+
+    private fun createConfirmAccountProviderPresenter(
+        params: ConfirmAccountProviderPresenter.Params = ConfirmAccountProviderPresenter.Params(isAccountCreation = false),
+        accountProviderDataSource: AccountProviderDataSource = AccountProviderDataSource(),
+        matrixAuthenticationService: MatrixAuthenticationService = FakeAuthenticationService(),
+        defaultOidcActionFlow: DefaultOidcActionFlow = DefaultOidcActionFlow(),
+        defaultLoginUserStory: DefaultLoginUserStory = DefaultLoginUserStory(),
+    ) = ConfirmAccountProviderPresenter(
+        params = params,
+        accountProviderDataSource = accountProviderDataSource,
+        authenticationService = matrixAuthenticationService,
+        defaultOidcActionFlow = defaultOidcActionFlow,
+        defaultLoginUserStory = defaultLoginUserStory,
+    )
 }
diff --git a/...gout/api/src/main/kotlin/io/element/android/features/logout/api/LogoutPreferenceScreen.kt b/...gout/api/src/main/kotlin/io/element/android/features/logout/api/LogoutPreferenceScreen.kt
@@ -34,12 +34,12 @@ import io.element.android.libraries.designsystem.preview.ElementPreviewLight
 @Composable
 fun LogoutPreferenceView(
     state: LogoutPreferenceState,
-    onSuccessLogout: () -> Unit = {}
+    onSuccessLogout: (String?) -> Unit = {}
 ) {
     val eventSink = state.eventSink
     if (state.logoutAction is Async.Success) {
         LaunchedEffect(state.logoutAction) {
-            onSuccessLogout()
+            onSuccessLogout(state.logoutAction.data)
         }
         return
     }

diff --git a/...ogout/api/src/main/kotlin/io/element/android/features/logout/api/LogoutPreferenceState.kt b/...ogout/api/src/main/kotlin/io/element/android/features/logout/api/LogoutPreferenceState.kt
@@ -19,6 +19,6 @@ package io.element.android.features.logout.api
 import io.element.android.libraries.architecture.Async
 
 data class LogoutPreferenceState(
-    val logoutAction: Async<Unit>,
+    val logoutAction: Async<String?>,
     val eventSink: (LogoutPreferenceEvents) -> Unit,
 )
diff --git a/...c/main/kotlin/io/element/android/features/logout/impl/DefaultLogoutPreferencePresenter.kt b/...c/main/kotlin/io/element/android/features/logout/impl/DefaultLogoutPreferencePresenter.kt
@@ -40,7 +40,7 @@ class DefaultLogoutPreferencePresenter @Inject constructor(private val matrixCli
     @Composable
     override fun present(): LogoutPreferenceState {
         val localCoroutineScope = rememberCoroutineScope()
-        val logoutAction: MutableState<Async<Unit>> = remember {
+        val logoutAction: MutableState<Async<String?>> = remember {
             mutableStateOf(Async.Uninitialized)
         }
 
@@ -56,7 +56,7 @@ class DefaultLogoutPreferencePresenter @Inject constructor(private val matrixCli
         )
     }
 
-    private fun CoroutineScope.logout(logoutAction: MutableState<Async<Unit>>) = launch {
+    private fun CoroutineScope.logout(logoutAction: MutableState<Async<String?>>) = launch {
         suspend {
             matrixClient.logout()
         }.runCatchingUpdatingState(logoutAction)

diff --git a/features/messages/impl/src/main/res/values/localazy.xml b/features/messages/impl/src/main/res/values/localazy.xml
@@ -26,11 +26,13 @@
   <string name="screen_room_notification_settings_default_setting_footnote">"You can change it in your %1$s."</string>
   <string name="screen_room_notification_settings_default_setting_footnote_content_link">"global settings"</string>
   <string name="screen_room_notification_settings_default_setting_title">"Default setting"</string>
+  <string name="screen_room_notification_settings_edit_remove_setting">"Remove custom setting"</string>
   <string name="screen_room_notification_settings_error_loading_settings">"An error occurred while loading notification settings."</string>
   <string name="screen_room_notification_settings_error_restoring_default">"Failed restoring the default mode, please try again."</string>
   <string name="screen_room_notification_settings_error_setting_mode">"Failed setting the mode, please try again."</string>
   <string name="screen_room_notification_settings_mode_all_messages">"All messages"</string>
   <string name="screen_room_notification_settings_mode_mentions_and_keywords">"Mentions and Keywords only"</string>
+  <string name="screen_room_notification_settings_room_custom_settings_title">"In this room, notify me for"</string>
   <string name="screen_room_reactions_show_less">"Show less"</string>
   <string name="screen_room_reactions_show_more">"Show more"</string>
   <string name="screen_room_retry_send_menu_send_again_action">"Send again"</string>