Add SessionData.needsVerification field (#2672)

* Add `SessionData.needsVerification`:
  - Allows us to add a skip button for debug builds.
  - We can have the verification state almost instantly.
  - It doesn't depend on network availability to know the verification state and display the UI.
* Add DB migration.
- Make the skip button in the verification flow skip the whole flow including the completed screen.
- Save the session as verified in `RustEncryptionService.recover(recoveryKey)`.
* Enforce session verification for existing users too.
* Fix verification confirmed screen subtitle (typo in id, was using the wrong string)
* Update screenshots

---------

Co-authored-by: ElementBot <benoitm+elementbot@element.io>

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

@@ -18,16 +18,32 @@ package io.element.android.libraries.sessionstorage.api
 
 import java.util.Date
 
+/**
+ * Data class representing the session data to store locally.
+ */
 data class SessionData(
+    /** The user ID of the logged in user. */
     val userId: String,
+    /** The device ID of the session. */
     val deviceId: String,
+    /** The current access token of the session. */
     val accessToken: String,
+    /** The optional current refresh token of the session. */
     val refreshToken: String?,
+    /** The homeserver URL of the session. */
     val homeserverUrl: String,
+    /** The Open ID Connect info for this session, if any. */
     val oidcData: String?,
+    /** The Sliding Sync Proxy URL for this session, if any. */
     val slidingSyncProxy: String?,
+    /** The timestamp of the last login. May be `null` in very old sessions. */
     val loginTimestamp: Date?,
+    /** Whether the [accessToken] is valid or not. */
     val isTokenValid: Boolean,
+    /** The login type used to authenticate the session. */
     val loginType: LoginType,
+    /** The optional passphrase used to encrypt data in the SDK local store. */
     val passphrase: String?,
+    /** Whether the session needs verification. */
+    val needsVerification: Boolean,
 )

libraries/session-storage/impl/src/main/kotlin/io/element/android/libraries/sessionstorage/impl/SessionDataMapper.kt

@@ -34,6 +34,7 @@ internal fun SessionData.toDbModel(): DbSessionData {
         isTokenValid = if (isTokenValid) 1L else 0L,
         loginType = loginType.name,
         passphrase = passphrase,
+        needsVerification = if (needsVerification) 1L else 0L,
     )
 }
 
@@ -50,5 +51,6 @@ internal fun DbSessionData.toApiModel(): SessionData {
         isTokenValid = isTokenValid == 1L,
         loginType = LoginType.fromName(loginType ?: LoginType.UNKNOWN.name),
         passphrase = passphrase,
+        needsVerification = needsVerification == 1L,
     )
 }

libraries/session-storage/impl/src/main/sqldelight/io/element/android/libraries/matrix/session/SessionData.sq

@@ -23,7 +23,9 @@ CREATE TABLE SessionData (
     isTokenValid INTEGER NOT NULL DEFAULT 1,
     loginType TEXT,
     -- added in version 5
-    passphrase TEXT
+    passphrase TEXT,
+    -- added in version 6
+    needsVerification INTEGER NOT NULL DEFAULT 0
 );
 
 

libraries/session-storage/impl/src/main/sqldelight/migrations/5.sqm

@@ -0,0 +1,4 @@
+-- Migrate DB from version 5
+-- For users migrating previously logged in sessions, we force them to verify them too
+
+ALTER TABLE SessionData ADD COLUMN needsVerification INTEGER NOT NULL DEFAULT 1;

libraries/session-storage/impl/src/test/kotlin/io/element/android/libraries/sessionstorage/impl/DatabaseSessionStoreTests.kt

@@ -144,6 +144,7 @@ class DatabaseSessionStoreTests {
             isTokenValid = 1,
             loginType = null,
             passphrase = "aPassphrase",
+            needsVerification = 1L,
         )
         val secondSessionData = SessionData(
             userId = "userId",
@@ -157,6 +158,7 @@ class DatabaseSessionStoreTests {
             isTokenValid = 1,
             loginType = null,
             passphrase = "aPassphraseAltered",
+            needsVerification = 0L,
         )
         assertThat(firstSessionData.userId).isEqualTo(secondSessionData.userId)
         assertThat(firstSessionData.loginTimestamp).isNotEqualTo(secondSessionData.loginTimestamp)
@@ -177,6 +179,7 @@ class DatabaseSessionStoreTests {
         assertThat(alteredSession.loginTimestamp).isEqualTo(firstSessionData.loginTimestamp)
         assertThat(alteredSession.oidcData).isEqualTo(secondSessionData.oidcData)
         assertThat(alteredSession.passphrase).isEqualTo(secondSessionData.passphrase)
+        assertThat(alteredSession.needsVerification).isEqualTo(secondSessionData.needsVerification)
     }
 
     @Test
@@ -193,6 +196,7 @@ class DatabaseSessionStoreTests {
             isTokenValid = 1,
             loginType = null,
             passphrase = "aPassphrase",
+            needsVerification = 1L,
         )
         val secondSessionData = SessionData(
             userId = "userIdUnknown",
@@ -206,6 +210,7 @@ class DatabaseSessionStoreTests {
             isTokenValid = 1,
             loginType = null,
             passphrase = "aPassphraseAltered",
+            needsVerification = 0L,
         )
         assertThat(firstSessionData.userId).isNotEqualTo(secondSessionData.userId)
 
@@ -224,5 +229,6 @@ class DatabaseSessionStoreTests {
         assertThat(notAlteredSession.loginTimestamp).isEqualTo(firstSessionData.loginTimestamp)
         assertThat(notAlteredSession.oidcData).isEqualTo(firstSessionData.oidcData)
         assertThat(notAlteredSession.passphrase).isEqualTo(firstSessionData.passphrase)
+        assertThat(notAlteredSession.needsVerification).isEqualTo(firstSessionData.needsVerification)
     }
 }

libraries/session-storage/impl/src/test/kotlin/io/element/android/libraries/sessionstorage/impl/Fixtures.kt

@@ -31,4 +31,5 @@ internal fun aSessionData() = SessionData(
     isTokenValid = 1,
     loginType = LoginType.UNKNOWN.name,
     passphrase = null,
+    needsVerification = 0L,
 )