Merge pull request #1838 from vector-im/feature/session_store_migration

Feature/session store migration

CHANGES.md

@@ -5,7 +5,7 @@ Features ✨:
  -
 
 Improvements 🙌:
- -
+ - Added Session Database migration to avoid unneeded initial syncs
 
 Bugfix 🐛:
  -

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/database/RealmSessionStoreMigration.kt

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2020 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 im.vector.matrix.android.internal.database
+
+import im.vector.matrix.android.internal.database.model.RoomSummaryEntityFields
+import io.realm.DynamicRealm
+import io.realm.RealmMigration
+import timber.log.Timber
+import javax.inject.Inject
+
+class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
+
+    override fun migrate(realm: DynamicRealm, oldVersion: Long, newVersion: Long) {
+        Timber.v("Migrating Realm Session from $oldVersion to $newVersion")
+
+        if (oldVersion <= 0) migrateTo1(realm)
+    }
+
+    private fun migrateTo1(realm: DynamicRealm) {
+        Timber.d("Step 0 -> 1")
+        // Add hasFailedSending in RoomSummary and a small warning icon on room list
+
+        realm.schema.get("RoomSummaryEntity")
+                ?.addField(RoomSummaryEntityFields.HAS_FAILED_SENDING, Boolean::class.java)
+                ?.transform { obj ->
+                    obj.setBoolean(RoomSummaryEntityFields.HAS_FAILED_SENDING, false)
+                }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/database/SessionRealmConfigurationFactory.kt

@@ -42,8 +42,13 @@ internal class SessionRealmConfigurationFactory @Inject constructor(
         @SessionFilesDirectory val directory: File,
         @SessionId val sessionId: String,
         @UserMd5 val userMd5: String,
+        val migration: RealmSessionStoreMigration,
         context: Context) {
 
+    companion object {
+        const val SESSION_STORE_SCHEMA_VERSION = 1L
+    }
+
     private val sharedPreferences = context.getSharedPreferences("im.vector.matrix.android.realm", Context.MODE_PRIVATE)
 
     fun create(): RealmConfiguration {
@@ -67,7 +72,8 @@ internal class SessionRealmConfigurationFactory @Inject constructor(
                     realmKeysUtils.configureEncryption(this, SessionModule.getKeyAlias(userMd5))
                 }
                 .modules(SessionRealmModule())
-                .deleteRealmIfMigrationNeeded()
+                .schemaVersion(SESSION_STORE_SCHEMA_VERSION)
+                .migration(migration)
                 .build()
 
         // Try creating a realm instance and if it succeeds we can clear the flag

vector/src/main/res/values/strings.xml

@@ -994,7 +994,7 @@
     <!-- Room settings: banned users -->
     <string name="room_settings_banned_users_title">Banned users</string>
     <plurals name="room_settings_banned_users_count">
-        <item quantity="one">1 banned user</item>
+        <item quantity="one">%d banned user</item>
         <item quantity="other">%d banned users</item>
     </plurals>