Unify the internal pinunlock.SignOut and the new LogoutUseCase classes

features/logout/api/src/main/kotlin/io/element/android/features/logout/api/LogoutUseCase.kt

@@ -23,6 +23,11 @@ interface LogoutUseCase {
     /**
      * Log out the current user and then perform any needed cleanup tasks.
      * @param ignoreSdkError if true, the SDK error will be ignored and the user will be logged out anyway.
+     * @return the session id of the logged out user.
      */
-    suspend fun logout(ignoreSdkError: Boolean)
+    suspend fun logout(ignoreSdkError: Boolean): String
+
+    interface Factory {
+        fun create(sessionId: String): LogoutUseCase
+    }
 }

features/logout/impl/src/main/kotlin/io/element/android/features/logout/impl/DefaultLogoutUseCase.kt

@@ -17,16 +17,27 @@
 package io.element.android.features.logout.impl
 
 import com.squareup.anvil.annotations.ContributesBinding
+import dagger.assisted.Assisted
+import dagger.assisted.AssistedFactory
+import dagger.assisted.AssistedInject
 import io.element.android.features.logout.api.LogoutUseCase
-import io.element.android.libraries.di.SessionScope
-import io.element.android.libraries.matrix.api.MatrixClient
-import javax.inject.Inject
+import io.element.android.libraries.di.AppScope
+import io.element.android.libraries.matrix.api.MatrixClientProvider
+import io.element.android.libraries.matrix.api.core.SessionId
 
-@ContributesBinding(SessionScope::class)
-class DefaultLogoutUseCase @Inject constructor(
-    private val matrixClient: MatrixClient
+class DefaultLogoutUseCase @AssistedInject constructor(
+    @Assisted private val sessionId: String,
+    private val matrixClientProvider: MatrixClientProvider,
 ) : LogoutUseCase {
-    override suspend fun logout(ignoreSdkError: Boolean) {
+    @ContributesBinding(AppScope::class)
+    @AssistedFactory
+    interface Factory : LogoutUseCase.Factory {
+        override fun create(sessionId: String): DefaultLogoutUseCase
+    }
+
+    override suspend fun logout(ignoreSdkError: Boolean): String {
+        val matrixClient = matrixClientProvider.getOrRestore(SessionId(sessionId)).getOrThrow()
         matrixClient.logout(ignoreSdkError = ignoreSdkError)
+        return sessionId
     }
 }

features/logout/impl/src/main/kotlin/io/element/android/features/logout/impl/SessionLogoutModule.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.features.logout.impl
+
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Module
+import dagger.Provides
+import io.element.android.features.logout.api.LogoutUseCase
+import io.element.android.libraries.di.SessionScope
+import io.element.android.libraries.matrix.api.user.CurrentSessionIdHolder
+
+@Module
+@ContributesTo(SessionScope::class)
+object SessionLogoutModule {
+     @Provides
+     fun provideLogoutUseCase(
+         currentSessionIdHolder: CurrentSessionIdHolder,
+         factory: DefaultLogoutUseCase.Factory,
+     ): LogoutUseCase {
+         return factory.create(currentSessionIdHolder.current.value)
+     }
+}

features/logout/test/build.gradle.kts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.features.logout.test"
+}
+
+dependencies {
+    implementation(libs.coroutines.core)
+    implementation(projects.tests.testutils)
+    api(projects.features.logout.api)
+}

features/logout/test/src/main/kotlin/io/element/android/features/logout/test/FakeLogoutUseCase.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.features.logout.test
+
+import io.element.android.features.logout.api.LogoutUseCase
+import io.element.android.tests.testutils.lambda.lambdaError
+
+class FakeLogoutUseCase(
+    var logoutLambda: (Boolean) -> String = lambdaError()
+) : LogoutUseCase {
+    override suspend fun logout(ignoreSdkError: Boolean): String {
+        return logoutLambda(ignoreSdkError)
+    }
+}