Update SessionParamsEntity primaryKey to include deviceId

CHANGES.md

@@ -10,7 +10,7 @@ Improvements 🙌:
  - Fix autocompletion issues and add support for rooms and groups
 
 Other changes:
- -
+ - Change the way RiotX identifies a session to allow the SDK to support several sessions with the same user (#800)
 
 Bugfix 🐛:
  - Fix crash when opening room creation screen from the room filtering screen

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/SessionId.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 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.auth
+
+import im.vector.matrix.android.internal.util.md5
+
+internal fun createSessionId(userId: String, deviceId: String?): String {
+    return (if (deviceId.isNullOrBlank()) userId else "$userId|$deviceId").md5()
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/AuthRealmMigration.kt

@@ -16,6 +16,9 @@
 
 package im.vector.matrix.android.internal.auth.db
 
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.internal.auth.createSessionId
+import im.vector.matrix.android.internal.di.MoshiProvider
 import io.realm.DynamicRealm
 import io.realm.RealmMigration
 import timber.log.Timber
@@ -23,7 +26,7 @@ import timber.log.Timber
 internal object AuthRealmMigration : RealmMigration {
 
     // Current schema version
-    const val SCHEMA_VERSION = 2L
+    const val SCHEMA_VERSION = 3L
 
     override fun migrate(realm: DynamicRealm, oldVersion: Long, newVersion: Long) {
         Timber.d("Migrating Auth Realm from $oldVersion to $newVersion")
@@ -53,5 +56,26 @@ internal object AuthRealmMigration : RealmMigration {
                     ?.addField(SessionParamsEntityFields.IS_TOKEN_VALID, Boolean::class.java)
                     ?.transform { it.set(SessionParamsEntityFields.IS_TOKEN_VALID, true) }
         }
+
+        if (oldVersion <= 2) {
+            Timber.d("Step 2 -> 3")
+            Timber.d("Update SessionParamsEntity primary key, to allow several sessions with the same userId")
+
+            realm.schema.get("SessionParamsEntity")
+                    ?.removePrimaryKey()
+                    ?.addField(SessionParamsEntityFields.SESSION_ID, String::class.java)
+                    ?.setRequired(SessionParamsEntityFields.SESSION_ID, true)
+                    ?.transform {
+                        val userId = it.getString(SessionParamsEntityFields.USER_ID)
+                        val credentialsJson = it.getString(SessionParamsEntityFields.CREDENTIALS_JSON)
+
+                        val credentials = MoshiProvider.providesMoshi()
+                                .adapter(Credentials::class.java)
+                                .fromJson(credentialsJson)
+
+                        it.set(SessionParamsEntityFields.SESSION_ID, createSessionId(userId, credentials?.deviceId))
+                    }
+                    ?.addPrimaryKey(SessionParamsEntityFields.SESSION_ID)
+        }
     }
 }

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsEntity.kt

@@ -20,7 +20,8 @@ import io.realm.RealmObject
 import io.realm.annotations.PrimaryKey
 
 internal open class SessionParamsEntity(
-        @PrimaryKey var userId: String = "",
+        @PrimaryKey var sessionId: String = "",
+        var userId: String = "",
         var credentialsJson: String = "",
         var homeServerConnectionConfigJson: String = "",
         // Set to false when the token is invalid and the user has been soft logged out

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsMapper.kt

@@ -20,6 +20,7 @@ import com.squareup.moshi.Moshi
 import im.vector.matrix.android.api.auth.data.Credentials
 import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
 import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.internal.auth.createSessionId
 import javax.inject.Inject
 
 internal class SessionParamsMapper @Inject constructor(moshi: Moshi) {
@@ -49,6 +50,7 @@ internal class SessionParamsMapper @Inject constructor(moshi: Moshi) {
             return null
         }
         return SessionParamsEntity(
+                createSessionId(sessionParams.credentials.userId, sessionParams.credentials.deviceId),
                 sessionParams.credentials.userId,
                 credentialsJson,
                 homeServerConnectionConfigJson,