Merge pull request #2104 from Infomaniak/mailbox-validity

fix: Handle `is_valid` API field for Mailboxes

Author: KevinBoulongne

app/src/main/java/com/infomaniak/mail/data/cache/RealmDatabase.kt

@@ -160,7 +160,7 @@ object RealmDatabase {
 
         //region Configurations versions
         const val USER_INFO_SCHEMA_VERSION = 2L
-        const val MAILBOX_INFO_SCHEMA_VERSION = 6L
+        const val MAILBOX_INFO_SCHEMA_VERSION = 7L
         const val MAILBOX_CONTENT_SCHEMA_VERSION = 19L
         //endregion
 

app/src/main/java/com/infomaniak/mail/data/cache/RealmMigrations.kt

@@ -18,6 +18,9 @@
 package com.infomaniak.mail.data.cache
 
 import com.infomaniak.mail.utils.SentryDebug
+import io.realm.kotlin.dynamic.DynamicMutableRealmObject
+import io.realm.kotlin.dynamic.DynamicRealmObject
+import io.realm.kotlin.dynamic.getValue
 import io.realm.kotlin.migration.AutomaticSchemaMigration
 import io.realm.kotlin.migration.AutomaticSchemaMigration.MigrationContext
 
@@ -29,6 +32,7 @@ val USER_INFO_MIGRATION = AutomaticSchemaMigration { migrationContext ->
 val MAILBOX_INFO_MIGRATION = AutomaticSchemaMigration { migrationContext ->
     SentryDebug.addMigrationBreadcrumb(migrationContext)
     migrationContext.deleteRealmFromFirstMigration()
+    migrationContext.keepDefaultValuesAfterSixthMigration()
 }
 
 val MAILBOX_CONTENT_MIGRATION = AutomaticSchemaMigration { migrationContext ->
@@ -40,3 +44,32 @@ val MAILBOX_CONTENT_MIGRATION = AutomaticSchemaMigration { migrationContext ->
 private fun MigrationContext.deleteRealmFromFirstMigration() {
     if (oldRealm.schemaVersion() < 1L) newRealm.deleteAll()
 }
+
+/**
+ * Migrate from version #6
+ *
+ * This whole migration needs to be done because of this issue :
+ * https://github.com/realm/realm-swift/issues/1793
+ *
+ * Yes the issue is on the Realm-Swift repository, but all Realm projects are impacted.
+ *
+ * Documentation to handle manual migrations :
+ * https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/change-an-object-model/
+ */
+private fun MigrationContext.keepDefaultValuesAfterSixthMigration() {
+    if (oldRealm.schemaVersion() <= 6L) {
+        enumerate(className = "Mailbox") { oldObject: DynamicRealmObject, newObject: DynamicMutableRealmObject? ->
+            newObject?.apply {
+
+                // Add property with default value
+                set(propertyName = "_isValidInLdap", value = true)
+
+                // Rename property without losing its previous value
+                set(propertyName = "_isLocked", value = oldObject.getValue<Boolean>(fieldName = "isLocked"))
+
+                // Rename property without losing its previous value
+                set(propertyName = "hasValidPassword", value = oldObject.getValue<Boolean>(fieldName = "isPasswordValid"))
+            }
+        }
+    }
+}

app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/RefreshController.kt

@@ -98,10 +98,10 @@ class RefreshController @Inject constructor(
 
         val folder = FolderController.getFolder(folderId, realm)!!
 
-        // If the Mailbox is invalid (i.e. the mailbox is locked or its password is wrong),
+        // If the Mailbox is not available (i.e. the mailbox is locked or its password is wrong),
         // we'll be denied permission to fetch it by the API, so we don't even try to do it.
         // We can leave safely.
-        if (!mailbox.isValid) {
+        if (!mailbox.isAvailable) {
             SentryLog.w("API", "Refresh threads: We left early because of a predictable denied access.")
             return emptySet<Thread>() to null
         }

app/src/main/java/com/infomaniak/mail/data/cache/mailboxInfo/MailboxController.kt

@@ -152,8 +152,9 @@ class MailboxController @Inject constructor(
         //region Queries
         private fun checkHasUserId(userId: Int) = "${Mailbox::userId.name} == '$userId'"
 
-        private val isMailboxLocked = "${Mailbox::isLocked.name} == true"
-        private val hasValidPassword = "${Mailbox::isPasswordValid.name} == true"
+        private val isValidInLdap = "${Mailbox.isValidInLdapPropertyName} == true"
+        private val isLocked = "${Mailbox.isLockedPropertyName} == true"
+        private val hasValidPassword = "${Mailbox::hasValidPassword.name} == true"
 
         private fun getMailboxesQuery(
             userId: Int? = null,
@@ -179,7 +180,7 @@ class MailboxController @Inject constructor(
         }
 
         private fun getValidMailboxesQuery(userId: Int, realm: TypedRealm): RealmQuery<Mailbox> {
-            return realm.query("${checkHasUserId(userId)} AND $hasValidPassword AND (NOT $isMailboxLocked)")
+            return realm.query("${checkHasUserId(userId)} AND $isValidInLdap AND NOT $isLocked AND $hasValidPassword")
         }
 
         private fun getMailboxesCountQuery(userId: Int, realm: TypedRealm): RealmScalarQuery<Long> {
@@ -196,11 +197,11 @@ class MailboxController @Inject constructor(
         }
 
         private fun getInvalidPasswordMailboxesQuery(userId: Int, realm: TypedRealm): RealmQuery<Mailbox> {
-            return realm.query("${checkHasUserId(userId)} AND NOT ($hasValidPassword OR $isMailboxLocked)")
+            return realm.query("${checkHasUserId(userId)} AND NOT $hasValidPassword AND NOT $isLocked AND $isValidInLdap")
         }
 
         private fun getLockedMailboxesQuery(userId: Int, realm: TypedRealm): RealmQuery<Mailbox> {
-            return realm.query("${checkHasUserId(userId)} AND $isMailboxLocked")
+            return realm.query("${checkHasUserId(userId)} AND ($isLocked OR NOT $isValidInLdap)")
         }
         //endregion
 

app/src/main/java/com/infomaniak/mail/data/models/mailbox/Mailbox.kt

@@ -54,12 +54,14 @@ class Mailbox : RealmObject {
     var linkId: Int = 0
     @SerialName("is_limited")
     var isLimited: Boolean = false
-    @SerialName("is_password_valid")
-    var isPasswordValid: Boolean = true
     @SerialName("is_primary")
     var isPrimary: Boolean = false
+    @SerialName("is_valid")
+    private var _isValidInLdap: Boolean = true
     @SerialName("is_locked")
-    var isLocked: Boolean = false
+    private var _isLocked: Boolean = false
+    @SerialName("is_password_valid")
+    var hasValidPassword: Boolean = true
     @SerialName("unseen_messages")
     var unreadCountRemote: Int = 0
     var aliases = realmListOf<String>()
@@ -99,7 +101,8 @@ class Mailbox : RealmObject {
     inline val notificationGroupId get() = uuid.hashCode()
     inline val notificationGroupKey get() = uuid
 
-    inline val isValid get() = isPasswordValid && !isLocked
+    val isLocked get() = _isLocked || !_isValidInLdap
+    inline val isAvailable get() = !isLocked && hasValidPassword
 
     val unreadCountDisplay: UnreadDisplay
         get() = UnreadDisplay(
@@ -150,4 +153,9 @@ class Mailbox : RealmObject {
             addAll(featureFlags)
         }
     }
+
+    companion object {
+        val isValidInLdapPropertyName get() = Mailbox::_isValidInLdap.name
+        val isLockedPropertyName get() = Mailbox::_isLocked.name
+    }
 }

app/src/main/java/com/infomaniak/mail/ui/MainViewModel.kt

@@ -251,7 +251,7 @@ class MainViewModel @Inject constructor(
             mailboxId = AccountUtils.currentMailboxId,
         ) ?: return null
 
-        if (mailbox.isLocked || !mailbox.isPasswordValid) {
+        if (!mailbox.isAvailable) {
             switchToValidMailbox()
             return null
         }

app/src/main/java/com/infomaniak/mail/ui/login/LoginActivity.kt

@@ -121,7 +121,7 @@ class LoginActivity : AppCompatActivity() {
                         context.trackUserInfo("nbMailboxes", mailboxes.count())
                         AccountUtils.addUser(user)
                         mailboxController.updateMailboxes(mailboxes)
-                        return@let if (mailboxes.none { it.isValid }) MailboxErrorCode.NO_VALID_MAILBOX else user
+                        return@let if (mailboxes.none { it.isAvailable }) MailboxErrorCode.NO_VALID_MAILBOX else user
                     } ?: run {
                         getErrorResponse(RCore.string.serverError)
                     }

app/src/main/java/com/infomaniak/mail/ui/main/InvalidPasswordViewModel.kt

@@ -53,7 +53,7 @@ class InvalidPasswordViewModel @Inject constructor(
     fun updatePassword(password: String) = viewModelScope.launch(ioCoroutineContext) {
         val apiResponse = ApiRepository.updateMailboxPassword(mailbox.mailboxId, password)
         if (apiResponse.isSuccess()) {
-            mailboxController.updateMailbox(mailboxObjectId) { it.isPasswordValid = true }
+            mailboxController.updateMailbox(mailboxObjectId) { it.hasValidPassword = true }
             AccountUtils.switchToMailbox(mailbox.mailboxId)
         } else {
             updatePasswordResult.postValue(apiResponse.translateError())

app/src/main/java/com/infomaniak/mail/ui/main/menuDrawer/MailboxesAdapter.kt

@@ -76,7 +76,7 @@ class MailboxesAdapter(
 
     override fun getItemViewType(position: Int): Int = runCatchingRealm {
         return when {
-            !mailboxes[position].isValid -> DisplayType.INVALID_MAILBOX.layout
+            !mailboxes[position].isAvailable -> DisplayType.INVALID_MAILBOX.layout
             isInMenuDrawer -> DisplayType.MENU_DRAWER_MAILBOX.layout
             else -> DisplayType.SIMPLE_MAILBOX.layout
         }
@@ -127,7 +127,7 @@ class MailboxesAdapter(
 
         itemStyle = if (isInMenuDrawer) SelectionStyle.MENU_DRAWER else SelectionStyle.OTHER
 
-        isPasswordOutdated = !mailbox.isPasswordValid
+        isPasswordOutdated = !mailbox.hasValidPassword
         isMailboxLocked = mailbox.isLocked
         hasNoValidMailboxes = !hasValidMailboxes
 

app/src/main/java/com/infomaniak/mail/ui/main/menuDrawer/MenuDrawerAdapter.kt

@@ -168,7 +168,7 @@ class MenuDrawerAdapter @Inject constructor() : ListAdapter<Any, MenuDrawerViewH
         return@runCatchingRealm when (val item = currentList[position]) {
             ItemType.DIVIDER -> ItemType.DIVIDER.ordinal
             is MailboxesHeader -> ItemType.MAILBOXES_HEADER.ordinal
-            is Mailbox -> if (item.isValid) ItemType.MAILBOX.ordinal else ItemType.INVALID_MAILBOX.ordinal
+            is Mailbox -> if (item.isAvailable) ItemType.MAILBOX.ordinal else ItemType.INVALID_MAILBOX.ordinal
             ItemType.FOLDERS_HEADER -> ItemType.FOLDERS_HEADER.ordinal
             is Folder -> ItemType.FOLDER.ordinal
             ItemType.EMPTY_FOLDERS -> ItemType.EMPTY_FOLDERS.ordinal

app/src/main/java/com/infomaniak/mail/ui/main/menuDrawer/items/InvalidMailboxViewHolder.kt

@@ -41,7 +41,7 @@ class InvalidMailboxViewHolder(
 
         text = mailbox.email
         itemStyle = DecoratedItemView.SelectionStyle.MENU_DRAWER
-        isPasswordOutdated = !mailbox.isPasswordValid
+        isPasswordOutdated = !mailbox.hasValidPassword
         isMailboxLocked = mailbox.isLocked
         hasNoValidMailboxes = false
 

app/src/main/java/com/infomaniak/mail/ui/main/settings/SettingsFragment.kt

@@ -81,7 +81,7 @@ class SettingsFragment : Fragment() {
     private fun setupMailboxesAdapter() {
         val mailboxesAdapter = SettingsMailboxesAdapter { selectedMailbox ->
             with(selectedMailbox) {
-                if (isValid) {
+                if (isAvailable) {
                     animatedNavigation(SettingsFragmentDirections.actionSettingsToMailboxSettings(objectId, email))
                 } else {
                     context?.showToast(R.string.errorMailboxLocked)

app/src/main/java/com/infomaniak/mail/ui/main/settings/SettingsMailboxesAdapter.kt

@@ -41,7 +41,7 @@ class SettingsMailboxesAdapter(
         setTitle(mailbox.email)
 
         setOnClickListener { onMailboxSelected(mailbox) }
-        toggleMailboxBlockedState(!mailbox.isValid)
+        toggleMailboxBlockedState(!mailbox.isAvailable)
     }
 
     override fun getItemCount(): Int = mailboxes.count()

app/src/main/java/com/infomaniak/mail/utils/AccountUtils.kt

@@ -93,7 +93,7 @@ object AccountUtils : CredentialManager() {
                 Dispatchers.Main { context.launchNoMailboxActivity(currentUserId, shouldStartLoginActivity = true) }
                 true
             }
-            mailboxes.none { it.isValid } -> {
+            mailboxes.none { it.isAvailable } -> {
                 Dispatchers.Main { context.launchNoValidMailboxesActivity() }
                 true
             }