feat(MyKSuite): Stop fetching myKSuite data if user doesn't have a my kSuite offer (#2227)

Author: FabianDevel

app/src/main/java/com/infomaniak/mail/MainApplication.kt

@@ -105,6 +105,9 @@ open class MainApplication : Application(), ImageLoaderFactory, DefaultLifecycle
     @Inject
     lateinit var appUpdateWorkerScheduler: AppUpdateScheduler
 
+    @Inject
+    lateinit var myKSuiteDataUtils: MyKSuiteDataUtils
+
     @Inject
     @IoDispatcher
     lateinit var ioDispatcher: CoroutineDispatcher
@@ -209,7 +212,7 @@ open class MainApplication : Application(), ImageLoaderFactory, DefaultLifecycle
 
     private fun configureRoomDatabases() {
         AccountUtils.init(this)
-        MyKSuiteDataUtils.initDatabase(this)
+        myKSuiteDataUtils.initDatabase(this)
     }
 
     private fun configureAppReloading() {

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

@@ -90,6 +90,10 @@ class MailboxController @Inject constructor(
         return getLockedMailboxesQuery(userId, mailboxInfoRealm).toMailboxesFlow()
     }
 
+    fun getMyKSuiteMailboxCount(userId: Int): Long {
+        return getMyKSuiteMailboxesQuery(userId, mailboxInfoRealm).count().find()
+    }
+
     private fun RealmQuery<Mailbox>.toMailboxesFlow() = asFlow().map { it.list }
     //endregion
 
@@ -155,6 +159,7 @@ class MailboxController @Inject constructor(
         private val isValidInLdap = "${Mailbox.isValidInLdapPropertyName} == true"
         private val isLocked = "${Mailbox.isLockedPropertyName} == true"
         private val hasValidPassword = "${Mailbox::hasValidPassword.name} == true"
+        private val isMyKSuite = "${Mailbox::isFree.name} == true"
 
         private fun getMailboxesQuery(
             userId: Int? = null,
@@ -203,6 +208,10 @@ class MailboxController @Inject constructor(
         private fun getLockedMailboxesQuery(userId: Int, realm: TypedRealm): RealmQuery<Mailbox> {
             return realm.query("${checkHasUserId(userId)} AND ($isLocked OR NOT $isValidInLdap)")
         }
+
+        private fun getMyKSuiteMailboxesQuery(userId: Int, realm: TypedRealm): RealmQuery<Mailbox> {
+            return realm.query<Mailbox>("${checkHasUserId(userId)} AND $isMyKSuite")
+        }
         //endregion
 
         //region Get data

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

@@ -92,6 +92,7 @@ class MainViewModel @Inject constructor(
     private val mailboxController: MailboxController,
     private val mergedContactController: MergedContactController,
     private val messageController: MessageController,
+    private val myKSuiteDataUtils: MyKSuiteDataUtils,
     private val notificationUtils: NotificationUtils,
     private val permissionsController: PermissionsController,
     private val quotasController: QuotasController,
@@ -317,7 +318,7 @@ class MainViewModel @Inject constructor(
             AccountUtils.updateCurrentUser()
 
             // Refresh My kSuite asynchronously, because it's not required for the threads list display
-            launch { MyKSuiteDataUtils.fetchData() }
+            launch { myKSuiteDataUtils.fetchData() }
 
             // Refresh Mailboxes
             SentryLog.d(TAG, "Refresh mailboxes from remote")

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

@@ -24,20 +24,19 @@ import com.infomaniak.lib.core.utils.SingleLiveEvent
 import com.infomaniak.mail.data.cache.mailboxInfo.MailboxController
 import com.infomaniak.mail.data.models.mailbox.Mailbox
 import com.infomaniak.mail.di.IoDispatcher
-import com.infomaniak.mail.di.MailboxInfoRealm
 import com.infomaniak.mail.utils.AccountUtils
 import com.infomaniak.mail.utils.MyKSuiteDataUtils
 import com.infomaniak.mail.utils.coroutineContext
 import dagger.hilt.android.lifecycle.HiltViewModel
-import io.realm.kotlin.Realm
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 class MykSuiteViewModel @Inject constructor(
-    @MailboxInfoRealm private val mailboxInfoRealm: Realm,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
+    private val mailboxController: MailboxController,
+    private val myKSuiteDataUtils: MyKSuiteDataUtils,
 ) : ViewModel() {
 
     private val ioCoroutineContext = viewModelScope.coroutineContext(ioDispatcher)
@@ -46,16 +45,10 @@ class MykSuiteViewModel @Inject constructor(
     val myKSuiteDataResult = SingleLiveEvent<MyKSuiteData?>()
 
     fun getMyKSuiteMailbox(mailboxId: Int) = viewModelScope.launch {
-        myKSuiteMailboxResult.postValue(
-            MailboxController.getMailbox(
-                userId = AccountUtils.currentUserId,
-                mailboxId = mailboxId,
-                realm = mailboxInfoRealm,
-            )
-        )
+        myKSuiteMailboxResult.postValue(mailboxController.getMailbox(userId = AccountUtils.currentUserId, mailboxId = mailboxId))
     }
 
     fun refreshMyKSuite() = viewModelScope.launch(ioCoroutineContext) {
-        myKSuiteDataResult.postValue(MyKSuiteDataUtils.fetchData())
+        myKSuiteDataResult.postValue(myKSuiteDataUtils.fetchData())
     }
 }

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

@@ -64,6 +64,9 @@ class SettingsFragment : Fragment() {
     @Inject
     lateinit var localSettings: LocalSettings
 
+    @Inject
+    lateinit var myKSuiteDataUtils: MyKSuiteDataUtils
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         saveFocusWhenNavigatingBack(getLayout = { binding.linearLayoutContainer }, lifecycle)
@@ -87,8 +90,8 @@ class SettingsFragment : Fragment() {
     }
 
     private fun setupMyKSuite() {
-        binding.myKSuiteLayout.isGone = MyKSuiteDataUtils.myKSuite == null
-        MyKSuiteDataUtils.myKSuite?.let { setupMyKSuiteLayout(it) } ?: myKSuiteViewModel.refreshMyKSuite()
+        binding.myKSuiteLayout.isGone = myKSuiteDataUtils.myKSuite == null
+        myKSuiteDataUtils.myKSuite?.let { setupMyKSuiteLayout(it) } ?: myKSuiteViewModel.refreshMyKSuite()
     }
 
     private fun setupMyKSuiteLayout(myKSuiteData: MyKSuiteData) = with(binding) {
@@ -149,7 +152,7 @@ class SettingsFragment : Fragment() {
 
         binding.mailboxesList.adapter = mailboxesAdapter
         mainViewModel.mailboxesLive.observe(viewLifecycleOwner) { mailboxes ->
-            mailboxesAdapter.setMailboxes(mailboxes.filterNot { it.mailboxId == MyKSuiteDataUtils.myKSuite?.mail?.mailboxId })
+            mailboxesAdapter.setMailboxes(mailboxes.filterNot { it.mailboxId == myKSuiteDataUtils.myKSuite?.mail?.mailboxId })
         }
     }
 

app/src/main/java/com/infomaniak/mail/ui/main/user/SwitchUserViewModel.kt

@@ -28,6 +28,7 @@ import com.infomaniak.mail.data.cache.mailboxInfo.MailboxController
 import com.infomaniak.mail.data.models.AppSettings
 import com.infomaniak.mail.di.IoDispatcher
 import com.infomaniak.mail.utils.AccountUtils
+import com.infomaniak.mail.utils.MyKSuiteDataUtils
 import com.infomaniak.mail.utils.extensions.appContext
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.CoroutineDispatcher
@@ -38,6 +39,7 @@ import javax.inject.Inject
 class SwitchUserViewModel @Inject constructor(
     application: Application,
     private val mailboxController: MailboxController,
+    private val myKSuiteDataUtils: MyKSuiteDataUtils,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
 ) : AndroidViewModel(application) {
 
@@ -51,6 +53,7 @@ class SwitchUserViewModel @Inject constructor(
         if (user.id != AccountUtils.currentUserId) {
             appContext.trackAccountEvent("switch")
             RealmDatabase.backupPreviousRealms()
+            myKSuiteDataUtils.myKSuite = null
             AccountUtils.currentUser = user
             AccountUtils.currentMailboxId = mailboxController.getFirstValidMailbox(user.id)?.mailboxId ?: AppSettings.DEFAULT_ID
             AccountUtils.reloadApp?.invoke()

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

@@ -43,6 +43,7 @@ class LogoutUser @Inject constructor(
     private val globalCoroutineScope: CoroutineScope,
     private val localSettings: LocalSettings,
     private val mailboxController: MailboxController,
+    private val myKSuiteDataUtils: MyKSuiteDataUtils,
     private val playServicesUtils: PlayServicesUtils,
     private val storesSettingsRepository: StoresSettingsRepository,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
@@ -52,7 +53,7 @@ class LogoutUser @Inject constructor(
 
         user.logoutToken()
         AccountUtils.removeUser(user)
-        MyKSuiteDataUtils.deleteData(user.id)
+        myKSuiteDataUtils.deleteData(user.id)
         RealmDatabase.removeUserData(appContext, user.id)
         mailboxController.deleteUserMailboxes(user.id)
         localSettings.removeRegisteredFirebaseUser(userId = user.id)

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

@@ -22,23 +22,28 @@ import com.infomaniak.core.myksuite.ui.data.MyKSuiteDataManager
 import com.infomaniak.lib.core.networking.HttpClient
 import com.infomaniak.lib.core.utils.SentryLog
 import com.infomaniak.mail.data.api.ApiRepository
+import com.infomaniak.mail.data.cache.mailboxInfo.MailboxController
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.MissingFieldException
+import javax.inject.Inject
+import javax.inject.Singleton
 import kotlin.coroutines.cancellation.CancellationException
 
-object MyKSuiteDataUtils : MyKSuiteDataManager() {
-
-    private val TAG = MyKSuiteDataUtils::class.simpleName.toString()
+@Singleton
+class MyKSuiteDataUtils @Inject constructor(private val mailboxController: MailboxController) : MyKSuiteDataManager() {
 
     override val currentUserId get() = AccountUtils.currentUserId
 
     override var myKSuite: MyKSuiteData? = null
 
     override suspend fun fetchData(): MyKSuiteData? = runCatching {
-        MyKSuiteDataUtils.requestKSuiteData()
+        requestKSuiteData()
+        // Only fetch the Data if the current user has a my kSuite mailbox
+        if (mailboxController.getMyKSuiteMailboxCount(userId = AccountUtils.currentUserId) == 0L) return@runCatching null
+
         val apiResponse = ApiRepository.getMyKSuiteData(HttpClient.okHttpClient)
         if (apiResponse.data != null) {
-            MyKSuiteDataUtils.upsertKSuiteData(apiResponse.data!!)
+            upsertKSuiteData(apiResponse.data!!)
         } else {
             @OptIn(ExperimentalSerializationApi::class)
             apiResponse.error?.exception?.let {
@@ -52,4 +57,9 @@ object MyKSuiteDataUtils : MyKSuiteDataManager() {
         SentryLog.d(TAG, "Exception during myKSuite data fetch", exception)
         null
     }
+
+    companion object {
+
+        private val TAG = MyKSuiteDataUtils::class.simpleName.toString()
+    }
 }