Update database to be able to sort accounts by creation date.

Author: bmarty

features/home/impl/src/main/kotlin/io/element/android/features/home/impl/HomePresenter.kt

@@ -116,8 +116,8 @@ class HomePresenter(
 }
 
 private fun List<SessionData>.takeCurrentUserWithNeighbors(matrixUser: MatrixUser): List<MatrixUser> {
-    // Sort by userId to always have the same order (not depending on last account usage)
-    return sortedBy { it.userId }
+    // Sort by position to always have the same order (not depending on last account usage)
+    return sortedBy { it.position }
         .map {
             if (it.userId == matrixUser.userId.value) {
                 // Always use the freshest profile for the current user

features/signedout/impl/src/main/kotlin/io/element/android/features/signedout/impl/SignedOutStateProvider.kt

@@ -44,8 +44,8 @@ private fun aSessionData(
         passphrase = null,
         sessionPath = "/a/path/to/a/session",
         cachePath = "/a/path/to/a/cache",
+        position = 0,
         lastUsageIndex = 0,
-        lastUsageDate = Date(),
         userDisplayName = null,
         userAvatarUrl = null,
     )

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/mapper/Session.kt

@@ -34,8 +34,9 @@ internal fun Session.toSessionData(
     passphrase = passphrase,
     sessionPath = sessionPaths.fileDirectory.absolutePath,
     cachePath = sessionPaths.cacheDirectory.absolutePath,
+    // Note: position and lastUsageIndex will be set by the SessionStore when adding the session
+    position = 0,
     lastUsageIndex = 0,
-    lastUsageDate = Date(),
     userDisplayName = null,
     userAvatarUrl = null,
 )
@@ -59,8 +60,8 @@ internal fun ExternalSession.toSessionData(
     passphrase = passphrase,
     sessionPath = sessionPaths.fileDirectory.absolutePath,
     cachePath = sessionPaths.cacheDirectory.absolutePath,
+    position = 0,
     lastUsageIndex = 0,
-    lastUsageDate = Date(),
     userDisplayName = null,
     userAvatarUrl = null,
 )

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

@@ -39,10 +39,10 @@ data class SessionData(
     val sessionPath: String,
     /** The path to the cache data stored for the session in the filesystem. */
     val cachePath: String,
+    /** The position, to be able to order account */
+    val position: Long,
     /** The index of the last date of session usage. */
     val lastUsageIndex: Long,
-    /** The last date of session usage. */
-    val lastUsageDate: Date,
     /** The optional display name of the user. */
     val userDisplayName: String?,
     /** The optional avatar URL of the user. */

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

@@ -21,7 +21,6 @@ dependencies {
     implementation(projects.libraries.androidutils)
     implementation(projects.libraries.core)
     implementation(projects.libraries.encryptedDb)
-    implementation(projects.services.toolbox.api)
     api(projects.libraries.sessionStorage.api)
     implementation(libs.sqldelight.driver.android)
     implementation(libs.sqlcipher)
@@ -40,7 +39,7 @@ dependencies {
 sqldelight {
     databases {
         create("SessionDatabase") {
-            // https://cashapp.github.io/sqldelight/2.0.0/android_sqlite/migrations/
+            // https://sqldelight.github.io/sqldelight/2.1.0/android_sqlite/migrations/
             // To generate a .db file from your latest schema, run this task
             // ./gradlew generateDebugSessionDatabaseSchema
             // Test migration by running

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

@@ -18,21 +18,18 @@ import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.sessionstorage.api.LoggedInState
 import io.element.android.libraries.sessionstorage.api.SessionData
 import io.element.android.libraries.sessionstorage.api.SessionStore
-import io.element.android.services.toolbox.api.systemclock.SystemClock
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import timber.log.Timber
-import java.util.Date
 
 @SingleIn(AppScope::class)
 @ContributesBinding(AppScope::class)
 @Inject
 class DatabaseSessionStore(
     private val database: SessionDatabase,
     private val dispatchers: CoroutineDispatchers,
-    private val systemClock: SystemClock,
 ) : SessionStore {
     private val sessionDataMutex = Mutex()
 
@@ -58,8 +55,10 @@ class DatabaseSessionStore(
             database.sessionDataQueries.insertSessionData(
                 sessionData
                     .copy(
+                        // position value does not really matter, so just use lastUsageIndex + 1 to ensure that
+                        // the value is always greater than value of any existing account
+                        position = lastUsageIndex + 1,
                         lastUsageIndex = lastUsageIndex + 1,
-                        lastUsageDate = Date(systemClock.epochMillis()),
                     )
                     .toDbModel()
             )
@@ -80,8 +79,8 @@ class DatabaseSessionStore(
             database.sessionDataQueries.updateSession(
                 sessionData.copy(
                     loginTimestamp = result.loginTimestamp,
+                    position = result.position,
                     lastUsageIndex = result.lastUsageIndex,
-                    lastUsageDate = result.lastUsageDate,
                     userDisplayName = result.userDisplayName,
                     userAvatarUrl = result.userAvatarUrl,
                 ).toDbModel()
@@ -122,11 +121,10 @@ class DatabaseSessionStore(
             return
         }
         sessionDataMutex.withLock {
-            // Update lastUsageDate and lastSessionIndex of the session
+            // Update lastUsageIndex of the session
             database.sessionDataQueries.updateSession(
                 result.copy(
                     lastUsageIndex = lastUsageIndex + 1,
-                    lastUsageDate = Date(systemClock.epochMillis()),
                 ).toDbModel()
             )
         }

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

@@ -27,8 +27,8 @@ internal fun SessionData.toDbModel(): DbSessionData {
         passphrase = passphrase,
         sessionPath = sessionPath,
         cachePath = cachePath,
+        position = position,
         lastUsageIndex = lastUsageIndex,
-        lastUsageDate = lastUsageDate.time,
         userDisplayName = userDisplayName,
         userAvatarUrl = userAvatarUrl,
     )
@@ -49,8 +49,8 @@ internal fun DbSessionData.toApiModel(): SessionData {
         passphrase = passphrase,
         sessionPath = sessionPath,
         cachePath = cachePath,
+        position = position,
         lastUsageIndex = lastUsageIndex,
-        lastUsageDate = Date(lastUsageDate),
         userDisplayName = userDisplayName,
         userAvatarUrl = userAvatarUrl,
     )

libraries/session-storage/impl/src/main/sqldelight/databases/10.db

@@ -28,11 +28,12 @@ CREATE TABLE SessionData (
     sessionPath TEXT NOT NULL DEFAULT "",
     -- added in version 9
     cachePath TEXT NOT NULL DEFAULT "",
+    -- added in version 10
+    -- position, to be able to sort account by session creation date
+    position INTEGER NOT NULL DEFAULT 0,
     -- index of the last usage session. Each time the current session change, the index of the current
-    -- session is incremented to the max value + 1 so it become the current session
+    -- session is incremented to the max value + 1 so it becomes the current session
     lastUsageIndex INTEGER NOT NULL DEFAULT 0,
-    -- informative last usage date
-    lastUsageDate INTEGER NOT NULL DEFAULT 0,
     -- user display name
     userDisplayName TEXT,
     -- user avatar url

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

@@ -1,8 +1,9 @@
 -- Migrate DB from version 9
--- Add lastUsageDate and lastUsageIndex so we can restore the last session and switch to another one
+-- Add position to be able to sort account by session creation date
+-- Add lastUsageIndex so we can restore the last session and switch to another one
 -- Add display name and avatar url of the user so that we can display a list of accounts.
 
-ALTER TABLE SessionData ADD COLUMN lastUsageDate INTEGER NOT NULL DEFAULT 0;
+ALTER TABLE SessionData ADD COLUMN position INTEGER NOT NULL DEFAULT 0;
 ALTER TABLE SessionData ADD COLUMN lastUsageIndex INTEGER NOT NULL DEFAULT 0;
 ALTER TABLE SessionData ADD COLUMN userDisplayName TEXT;
 ALTER TABLE SessionData ADD COLUMN userAvatarUrl TEXT;