Enforce mandatory session verification only for new logins (#2811)

* Enforce mandatory session verification only for new logins

- Creates `AppMigration` base interface as a way to isolate migration logic, app migrations must implement this interface.
- Creates `AppMigration01` with the existing logs removal migration and `AppMigration02` with the logic to allow existing sessions to skip verification.
- Add `DefaultSessionPreferencesStoreFactory.remove(sessionId)` to allow a ephemeral session store access to exist outside the `SessionScope` for this new migration.

* Fix tests

* Add more tests.

This also includes creating several abstractions.

* Review changes.

- Make `orderedMigrations` a class property, `migrations` just a constructor parameter to avoid incorrect usages.
- Create `lastMigration` property too, use it instead of `MIGRATION_VERSION`.

libraries/preferences/api/build.gradle.kts

@@ -24,4 +24,5 @@ android {
 
 dependencies {
     implementation(libs.coroutines.core)
+    implementation(projects.libraries.matrix.api)
 }

libraries/preferences/api/src/main/kotlin/io/element/android/features/preferences/api/store/SessionPreferencesStoreFactory.kt

@@ -0,0 +1,25 @@
+/*
+ * 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
+ *
+ *     http://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.preferences.api.store
+
+import io.element.android.libraries.matrix.api.core.SessionId
+import kotlinx.coroutines.CoroutineScope
+
+interface SessionPreferencesStoreFactory {
+    fun get(sessionId: SessionId, sessionCoroutineScope: CoroutineScope): SessionPreferencesStore
+    fun remove(sessionId: SessionId)
+}

libraries/preferences/impl/src/main/kotlin/io/element/android/libraries/preferences/impl/store/DefaultSessionPreferencesStoreFactory.kt

@@ -17,6 +17,9 @@
 package io.element.android.libraries.preferences.impl.store
 
 import android.content.Context
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.features.preferences.api.store.SessionPreferencesStore
+import io.element.android.features.preferences.api.store.SessionPreferencesStoreFactory
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.di.SingleIn
@@ -28,10 +31,11 @@ import java.util.concurrent.ConcurrentHashMap
 import javax.inject.Inject
 
 @SingleIn(AppScope::class)
+@ContributesBinding(AppScope::class)
 class DefaultSessionPreferencesStoreFactory @Inject constructor(
     @ApplicationContext private val context: Context,
     sessionObserver: SessionObserver,
-) {
+) : SessionPreferencesStoreFactory {
     private val cache = ConcurrentHashMap<SessionId, DefaultSessionPreferencesStore>()
 
     init {
@@ -44,7 +48,11 @@ class DefaultSessionPreferencesStoreFactory @Inject constructor(
         })
     }
 
-    fun get(sessionId: SessionId, sessionCoroutineScope: CoroutineScope): DefaultSessionPreferencesStore = cache.getOrPut(sessionId) {
+    override fun get(sessionId: SessionId, sessionCoroutineScope: CoroutineScope): SessionPreferencesStore = cache.getOrPut(sessionId) {
         DefaultSessionPreferencesStore(context, sessionId, sessionCoroutineScope)
     }
+
+    override fun remove(sessionId: SessionId) {
+        cache.remove(sessionId)
+    }
 }

libraries/preferences/test/build.gradle.kts

@@ -24,5 +24,7 @@ android {
     dependencies {
         api(projects.libraries.preferences.api)
         implementation(libs.coroutines.core)
+        implementation(projects.libraries.matrix.api)
+        implementation(projects.tests.testutils)
     }
 }

libraries/preferences/test/src/main/kotlin/io/element/android/libraries/preferences/test/FakeSessionPreferenceStoreFactory.kt

@@ -0,0 +1,38 @@
+/*
+ * 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
+ *
+ *     http://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.libraries.preferences.test
+
+import io.element.android.features.preferences.api.store.SessionPreferencesStore
+import io.element.android.features.preferences.api.store.SessionPreferencesStoreFactory
+import io.element.android.libraries.matrix.api.core.SessionId
+import io.element.android.tests.testutils.lambda.LambdaOneParamRecorder
+import io.element.android.tests.testutils.lambda.LambdaTwoParamsRecorder
+import io.element.android.tests.testutils.lambda.lambdaRecorder
+import kotlinx.coroutines.CoroutineScope
+
+class FakeSessionPreferenceStoreFactory(
+    var getLambda: LambdaTwoParamsRecorder<SessionId, CoroutineScope, SessionPreferencesStore> = lambdaRecorder { _, _ -> throw NotImplementedError() },
+    var removeLambda: LambdaOneParamRecorder<SessionId, Unit> = lambdaRecorder { _ -> },
+) : SessionPreferencesStoreFactory {
+    override fun get(sessionId: SessionId, sessionCoroutineScope: CoroutineScope): SessionPreferencesStore {
+        return getLambda(sessionId, sessionCoroutineScope)
+    }
+
+    override fun remove(sessionId: SessionId) {
+        removeLambda(sessionId)
+    }
+}

libraries/preferences/test/src/main/kotlin/io/element/android/libraries/preferences/test/InMemoryAppPreferencesStore.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.featureflag.test
+package io.element.android.libraries.preferences.test
 
 import io.element.android.features.preferences.api.store.AppPreferencesStore
 import kotlinx.coroutines.flow.Flow

libraries/preferences/test/src/main/kotlin/io/element/android/libraries/preferences/test/InMemorySessionPreferencesStore.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.featureflag.test
+package io.element.android.libraries.preferences.test
 
 import io.element.android.features.preferences.api.store.SessionPreferencesStore
 import kotlinx.coroutines.flow.Flow

libraries/session-storage/test/build.gradle.kts

@@ -22,5 +22,6 @@ android {
 }
 
 dependencies {
+    implementation(projects.libraries.matrix.api)
     implementation(projects.libraries.sessionStorage.api)
 }

libraries/session-storage/test/src/main/kotlin/io/element/android/libraries/sessionstorage/test/SessionData.kt

@@ -0,0 +1,40 @@
+/*
+ * 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
+ *
+ *     http://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.libraries.sessionstorage.test
+
+import io.element.android.libraries.matrix.api.core.SessionId
+import io.element.android.libraries.sessionstorage.api.LoginType
+import io.element.android.libraries.sessionstorage.api.SessionData
+
+fun aSessionData(
+    sessionId: SessionId = SessionId("@alice:server.org"),
+    isTokenValid: Boolean = false,
+): SessionData {
+    return SessionData(
+        userId = sessionId.value,
+        deviceId = "aDeviceId",
+        accessToken = "anAccessToken",
+        refreshToken = "aRefreshToken",
+        homeserverUrl = "aHomeserverUrl",
+        oidcData = null,
+        slidingSyncProxy = null,
+        loginTimestamp = null,
+        isTokenValid = isTokenValid,
+        loginType = LoginType.UNKNOWN,
+        passphrase = null,
+    )
+}