Let RootFlowNode manage MatrixClientsHolder save and restoration.

Author: bmarty

app/src/main/kotlin/io/element/android/x/MainActivity.kt

@@ -52,8 +52,7 @@ class MainActivity : NodeComponentActivity() {
         Timber.tag(loggerTag.value).w("onCreate, with savedInstanceState: ${savedInstanceState != null}")
         installSplashScreen()
         super.onCreate(savedInstanceState)
-        appBindings = bindings<AppBindings>()
-        appBindings.matrixClientsHolder().restore(savedInstanceState)
+        appBindings = bindings()
         WindowCompat.setDecorFitsSystemWindows(window, false)
         setContent {
             MainContent(appBindings)
@@ -125,9 +124,4 @@ class MainActivity : NodeComponentActivity() {
         super.onDestroy()
         Timber.tag(loggerTag.value).w("onDestroy")
     }
-
-    override fun onSaveInstanceState(outState: Bundle) {
-        super.onSaveInstanceState(outState)
-        bindings<AppBindings>().matrixClientsHolder().onSaveInstanceState(outState)
-    }
 }

app/src/main/kotlin/io/element/android/x/di/AppBindings.kt

@@ -17,13 +17,11 @@
 package io.element.android.x.di
 
 import com.squareup.anvil.annotations.ContributesTo
-import io.element.android.appnav.di.MatrixClientsHolder
 import io.element.android.libraries.designsystem.utils.SnackbarDispatcher
 import io.element.android.libraries.di.AppScope
 
 @ContributesTo(AppScope::class)
 interface AppBindings {
-    fun matrixClientsHolder(): MatrixClientsHolder
     fun mainDaggerComponentOwner(): MainDaggerComponentsOwner
     fun snackbarDispatcher(): SnackbarDispatcher
 }

appnav/src/main/kotlin/io/element/android/appnav/RootFlowNode.kt

@@ -30,6 +30,7 @@ import com.bumble.appyx.core.node.Node
 import com.bumble.appyx.core.node.node
 import com.bumble.appyx.core.plugin.Plugin
 import com.bumble.appyx.core.plugin.plugins
+import com.bumble.appyx.core.state.MutableSavedStateMap
 import com.bumble.appyx.navmodel.backstack.BackStack
 import com.bumble.appyx.navmodel.backstack.operation.pop
 import com.bumble.appyx.navmodel.backstack.operation.push
@@ -90,10 +91,16 @@ class RootFlowNode @AssistedInject constructor(
     ) {
 
     override fun onBuilt() {
+        matrixClientsHolder.restore(buildContext.savedStateMap)
         super.onBuilt()
         observeLoggedInState()
     }
 
+    override fun onSaveInstanceState(state: MutableSavedStateMap) {
+        super.onSaveInstanceState(state)
+        matrixClientsHolder.save(state)
+    }
+
     private fun observeLoggedInState() {
         combine(
             cacheService.onClearedCacheEventFlow(),

appnav/src/main/kotlin/io/element/android/appnav/di/MatrixClientsHolder.kt

@@ -16,21 +16,18 @@
 
 package io.element.android.appnav.di
 
-import android.os.Bundle
-import io.element.android.libraries.di.AppScope
-import io.element.android.libraries.di.SingleIn
+import com.bumble.appyx.core.state.MutableSavedStateMap
+import com.bumble.appyx.core.state.SavedStateMap
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService
 import io.element.android.libraries.matrix.api.core.SessionId
-import io.element.android.libraries.matrix.api.core.UserId
 import kotlinx.coroutines.runBlocking
 import timber.log.Timber
 import java.util.concurrent.ConcurrentHashMap
 import javax.inject.Inject
 
 private const val SAVE_INSTANCE_KEY = "io.element.android.x.di.MatrixClientsHolder.SaveInstanceKey"
 
-@SingleIn(AppScope::class)
 class MatrixClientsHolder @Inject constructor(private val authenticationService: MatrixAuthenticationService) {
 
     private val sessionIdsToMatrixClient = ConcurrentHashMap<SessionId, MatrixClient>()
@@ -55,16 +52,18 @@ class MatrixClientsHolder @Inject constructor(private val authenticationService:
         return sessionIdsToMatrixClient[sessionId]
     }
 
-    @Suppress("DEPRECATION")
-    fun restore(savedInstanceState: Bundle?) {
-        if (savedInstanceState == null || sessionIdsToMatrixClient.isNotEmpty()) return
-        val userIds = savedInstanceState.getSerializable(SAVE_INSTANCE_KEY) as? Array<UserId>
-        if (userIds.isNullOrEmpty()) return
+    @Suppress("UNCHECKED_CAST")
+    fun restore(state: SavedStateMap?) {
+        if (state == null || sessionIdsToMatrixClient.isNotEmpty()) return Unit.also {
+            Timber.w("Restore with non-empty map")
+        }
+        val sessionIds = state[SAVE_INSTANCE_KEY] as? Array<SessionId>
+        if (sessionIds.isNullOrEmpty()) return
         // Not ideal but should only happens in case of process recreation. This ensure we restore all the active sessions before restoring the node graphs.
         runBlocking {
-            userIds.forEach { userId ->
-                Timber.v("Restore matrix session: $userId")
-                authenticationService.restoreSession(userId)
+            sessionIds.forEach { sessionId ->
+                Timber.d("Restore matrix session: $sessionId")
+                authenticationService.restoreSession(sessionId)
                     .onSuccess { matrixClient ->
                         add(matrixClient)
                     }
@@ -75,9 +74,9 @@ class MatrixClientsHolder @Inject constructor(private val authenticationService:
         }
     }
 
-    fun onSaveInstanceState(outState: Bundle) {
+    fun save(state: MutableSavedStateMap) {
         val sessionKeys = sessionIdsToMatrixClient.keys.toTypedArray()
-        Timber.v("Save matrix session keys = $sessionKeys")
-        outState.putSerializable(SAVE_INSTANCE_KEY, sessionKeys)
+        Timber.d("Save matrix session keys = $sessionKeys")
+        state[SAVE_INSTANCE_KEY] = sessionKeys
     }
 }