Skip to content

feat(startup): prepare the main app session PR 3 #5160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MohamadJaara wants to merge 1 commit into from
Open

feat(startup): prepare the main app session PR 3 #5160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions app/src/main/kotlin/com/wire/android/di/metro/AppSessionViewModelGraph.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import com.wire.android.ui.home.HomeViewModelGraph
import com.wire.android.ui.home.sync.FeatureFlagNotificationViewModel
import com.wire.android.util.ui.WireSessionImageLoader
import com.wire.kalium.logic.data.user.UserId
import com.wire.kalium.logic.feature.UserSessionScope
import dev.zacsweers.metro.AppScope
import dev.zacsweers.metro.ContributesTo
import dev.zacsweers.metro.GraphExtension
Expand All @@ -48,6 +49,7 @@ interface AppSessionViewModelGraph :
CommonViewModelGraph {
@get:CurrentAccount
val currentAccount: UserId
val userSessionScope: UserSessionScope

override val viewModelScopeKey: String
get() = currentAccount.toString()
Expand All @@ -60,10 +62,23 @@ interface AppSessionViewModelGraph :
@ContributesTo(AppScope::class)
@GraphExtension.Factory
interface Factory {
fun createAppSessionViewModelGraph(@Provides @CurrentAccount currentAccount: UserId): AppSessionViewModelGraph
fun createAppSessionViewModelGraph(
@Provides @CurrentAccount currentAccount: UserId,
@Provides userSessionScope: UserSessionScope,
): AppSessionViewModelGraph
}
}

fun WireApplicationGraph.createSessionViewModelGraph(currentAccount: UserId): AppSessionViewModelGraph {
return asContribution<AppSessionViewModelGraph.Factory>().createAppSessionViewModelGraph(currentAccount)
fun WireApplicationGraph.createSessionViewModelGraph(
currentAccount: UserId,
userSessionScope: UserSessionScope,
): AppSessionViewModelGraph {
return asContribution<AppSessionViewModelGraph.Factory>().createAppSessionViewModelGraph(currentAccount, userSessionScope)
}

/**
* Compatibility path for secondary activities while their preparation entry points are migrated
* in the next stack slice.
*/
fun WireApplicationGraph.createSessionViewModelGraph(currentAccount: UserId): AppSessionViewModelGraph =
createSessionViewModelGraph(currentAccount, coreLogic.getSessionScope(currentAccount))
190 changes: 135 additions & 55 deletions app/src/main/kotlin/com/wire/android/ui/WireActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ package com.wire.android.ui

import android.content.Context
import android.content.Intent
import android.net.Uri
import android.os.Build
import android.os.Bundle
import android.os.SystemClock
Expand Down Expand Up @@ -164,15 +165,20 @@ import com.wire.android.ui.userprofile.self.dialog.LogoutOptionsDialogState
import com.wire.android.util.CurrentScreenManager
import com.wire.android.util.LocalSyncStateObserver
import com.wire.android.util.ShakeDetector
import com.wire.android.util.SupportPage
import com.wire.android.util.SupportUrlResolver
import com.wire.android.util.SwitchAccountObserver
import com.wire.android.util.SyncStateObserver
import com.wire.android.util.debug.FeatureVisibilityFlags
import com.wire.android.util.debug.LocalFeatureVisibilityFlags
import com.wire.android.util.getProviderAuthority
import com.wire.android.util.launchUpdateTheApp
import com.wire.kalium.logic.data.user.UserId
import com.wire.kalium.logic.feature.UserSessionScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.Job
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.collectLatest
import kotlinx.coroutines.flow.combine
Expand Down Expand Up @@ -228,9 +234,15 @@ class WireActivity : BaseActivity() {
private val newIntents = Channel<QueuedIntent>(Channel.UNLIMITED)
private lateinit var shakeDetector: ShakeDetector

// This flag is used to keep the splash screen open until the first screen is drawn.
// The system splash only covers the short handoff to Compose. User-session preparation has
// its own app screen because a SQLDelight migration can take much longer.
private var shouldKeepSplashOpen = true
private var isAppLockActivityLaunching = false
private var startupJob: Job? = null
private var isShowingPreparationContent = false
private val migrationScreenVisibility = MigrationScreenVisibility {
SystemClock.elapsedRealtime()
}

override fun onCreate(savedInstanceState: Bundle?) {
val startupAt = SystemClock.elapsedRealtime()
Expand All @@ -248,55 +260,10 @@ class WireActivity : BaseActivity() {
enableEdgeToEdge()
setupOrientationForDevice()
shakeDetector = ShakeDetector(this)

lifecycleScope.launch {
traceStartup("activity.startupCoroutine.begin", startupAt)

traceStartup("activity.observePersistentConnectionStatus.start", startupAt)
viewModel.observePersistentConnectionStatus()

traceStartup("activity.initialAppState.start", startupAt)
val initialAppState = viewModel.initialAppState()
val startDestination = when (initialAppState) {
InitialAppState.NotLoggedIn -> when (loginTypeSelector.canUseNewLogin()) {
true -> NewWelcomeEmptyStartScreenDestination()
false -> WelcomeScreenDestination()
}

is InitialAppState.EnrollE2EI -> E2EIEnrollmentScreenDestination(
SessionBackedAuthenticationNavArgs.from(initialAppState.userId)
)

InitialAppState.LoggedIn -> HomeScreenDestination()
}
traceStartup("activity.initialAppState.resolved:$startDestination", startupAt)
setComposableContent(startDestination)
traceStartup("activity.setContent.done", startupAt)

// When the app is locked, get the app lock screen up before the splash screen is
// dismissed so that protected content never flashes. Waiting for the current user id
// is finite here because a locked app implies a logged-in session; when not logged in
// there is nothing to protect. Locks that happen after startup are handled by the
// lifecycle observer below.
if (initialAppState != InitialAppState.NotLoggedIn && lockCodeTimeManager.value.isAppLocked()) {
observeAppLockUserId(
isAppLocked = lockCodeTimeManager.value.observeAppLock(),
currentUserId = snapshotFlow { viewModel.globalAppState.currentUserId },
).first().let { currentUserId ->
startAppLockActivity(currentUserId = currentUserId)
}
traceStartup("activity.appLock.launched", startupAt)
}

traceStartup("activity.splash.hide", startupAt)
shouldKeepSplashOpen = false
traceStartup("activity.splash.dismissed", startupAt)
(application as? WireApplication)?.initializeDeferredLoggingAfterSplash()
traceStartup("activity.deferredLogging.triggered", startupAt)

handleNewIntent(initialQueuedIntent)
traceStartup("activity.initialIntent.dispatched", startupAt)
}
setUserSessionPreparationContent(initialQueuedIntent, startupAt)
traceStartup("activity.preparationContent.done", startupAt)
observePreparationScreenReveal()
startForegroundStartup(initialQueuedIntent, startupAt)

lifecycleScope.launch {
lifecycle.repeatOnLifecycle(Lifecycle.State.RESUMED) {
Expand Down Expand Up @@ -370,11 +337,101 @@ class WireActivity : BaseActivity() {
}

private fun setComposableContent(startDestination: Direction) {
isShowingPreparationContent = false
setContent {
WireActivityRoot(startDestination)
}
}

private fun setUserSessionPreparationContent(initialQueuedIntent: QueuedIntent, startupAt: Long) {
isShowingPreparationContent = true
setContent {
WireTheme(accent = viewModel.globalAppState.userAccent) {
UserSessionPreparationScreen(
state = viewModel.userSessionPreparationState,
onRetry = { startForegroundStartup(initialQueuedIntent, startupAt) },
onUpdate = ::updateTheApp,
onContactSupport = ::openSupport,
)
}
}
}

/**
* Reveals the preparation screen only for work that outlives the reveal delay.
*
* [collectLatest] cancels the pending delay as soon as preparation moves on, so a migration that
* finishes quickly never leaves the splash and the screen is skipped altogether.
*/
private fun observePreparationScreenReveal() {
lifecycleScope.launch {
snapshotFlow { viewModel.userSessionPreparationState }
.collectLatest { state ->
val revealDelay = state.preparationScreenRevealDelay() ?: return@collectLatest
delay(revealDelay)
if (isShowingPreparationContent && state == UserSessionPreparationUiState.MigratingDatabase) {
migrationScreenVisibility.onRevealed()
}
releaseSystemSplash()
}
}
}

private fun releaseSystemSplash() {
if (!shouldKeepSplashOpen) return
shouldKeepSplashOpen = false
(application as? WireApplication)?.initializeDeferredLoggingAfterSplash()
}

private fun startForegroundStartup(initialQueuedIntent: QueuedIntent, startupAt: Long) {
if (startupJob?.isActive == true) return
startupJob = lifecycleScope.launch {
traceStartup("activity.startupCoroutine.begin", startupAt)
traceStartup("activity.initialAppState.start", startupAt)
val initialAppState = viewModel.initialAppState()
if (initialAppState == InitialAppState.SessionPreparationFailed) {
traceStartup("activity.initialAppState.preparationFailed", startupAt)
releaseSystemSplash()
return@launch
}
val startDestination = when (initialAppState) {
InitialAppState.NotLoggedIn -> when (loginTypeSelector.canUseNewLogin()) {
true -> NewWelcomeEmptyStartScreenDestination()
false -> WelcomeScreenDestination()
}

is InitialAppState.EnrollE2EI -> E2EIEnrollmentScreenDestination(
SessionBackedAuthenticationNavArgs.from(initialAppState.userId)
)

InitialAppState.LoggedIn -> HomeScreenDestination()
InitialAppState.SessionPreparationFailed -> error("Handled above")
}
traceStartup("activity.initialAppState.resolved:$startDestination", startupAt)
// No-op unless the migration screen was actually revealed, so fast startups pay nothing.
delay(migrationScreenVisibility.remainingVisibility())
setComposableContent(startDestination)
releaseSystemSplash()
traceStartup("activity.setContent.done", startupAt)

traceStartup("activity.observePersistentConnectionStatus.start", startupAt)
viewModel.observePersistentConnectionStatus()

if (initialAppState != InitialAppState.NotLoggedIn && lockCodeTimeManager.value.isAppLocked()) {
observeAppLockUserId(
isAppLocked = lockCodeTimeManager.value.observeAppLock(),
currentUserId = snapshotFlow { viewModel.globalAppState.currentUserId },
).first().let { currentUserId ->
startAppLockActivity(currentUserId = currentUserId)
}
traceStartup("activity.appLock.launched", startupAt)
}

handleNewIntent(initialQueuedIntent)
traceStartup("activity.initialIntent.dispatched", startupAt)
}
}

private fun traceStartup(event: String, startedAt: Long? = null) {
val elapsed = startedAt?.let { " (+${SystemClock.elapsedRealtime() - it}ms)" }.orEmpty()
Log.i(TAG, "startup:$event$elapsed")
Expand Down Expand Up @@ -421,13 +478,23 @@ class WireActivity : BaseActivity() {
}

@Composable
@Suppress("CyclomaticComplexMethod")
private fun WireActivityThemedContent(
startDestination: Direction,
appGraph: WireApplicationGraph,
authenticationViewModelGraph: AppAuthenticationViewModelGraph,
sessionGraphStore: SessionGraphStoreViewModel,
context: Context,
) {
if (viewModel.userSessionPreparationState !is UserSessionPreparationUiState.Ready) {
UserSessionPreparationScreen(
state = viewModel.userSessionPreparationState,
onRetry = viewModel::retryPendingUserSessionPreparation,
onUpdate = ::updateTheApp,
onContactSupport = ::openSupport,
)
return
}
val isUserUiBlocked = viewModel.globalAppState.blockUserUI != null
val navigator = rememberWireActivityNavigator(
isUserUiBlocked = isUserUiBlocked,
Expand Down Expand Up @@ -474,6 +541,8 @@ class WireActivity : BaseActivity() {
startDestinationBaseRoute = navHostStartDestination.baseRoute,
isUserUiBlocked = isUserUiBlocked,
isSessionTransitionInProgress = isSessionTransitionInProgress,
preparedSessionScope = sessionBackedAuthenticationUserId?.let(viewModel::preparedUserSessionScope)
?: currentUserId?.let(viewModel::preparedUserSessionScope),
)
val lastSessionGraphContext = remember { mutableStateOf<WireActivityGraphContext?>(null) }
if (graphContext?.sessionGraph != null) {
Expand Down Expand Up @@ -666,6 +735,7 @@ class WireActivity : BaseActivity() {
startDestinationBaseRoute: String,
isUserUiBlocked: Boolean,
isSessionTransitionInProgress: Boolean,
preparedSessionScope: UserSessionScope?,
): WireActivityGraphContext? {
if (isUserUiBlocked) return null

Expand All @@ -681,13 +751,15 @@ class WireActivity : BaseActivity() {
usesNoSessionAuthenticationGraph,
usesInvalidSessionBackedAuthenticationGraph,
isSessionTransitionInProgress,
preparedSessionScope,
) {
sessionGraphStore.resolveSessionGraph(
currentUserId = currentUserId,
sessionBackedAuthenticationUserId = sessionBackedAuthenticationUserId,
usesNoSessionAuthenticationGraph = usesNoSessionAuthenticationGraph,
usesInvalidSessionBackedAuthenticationGraph = usesInvalidSessionBackedAuthenticationGraph,
isSessionTransitionInProgress = isSessionTransitionInProgress,
preparedSessionScope = preparedSessionScope,
)
}
val sessionGraph = retainedSessionGraph?.graph
Expand Down Expand Up @@ -717,18 +789,21 @@ class WireActivity : BaseActivity() {
}
}

@Suppress("LongParameterList")
private fun SessionGraphStoreViewModel.resolveSessionGraph(
currentUserId: UserId?,
sessionBackedAuthenticationUserId: UserId?,
usesNoSessionAuthenticationGraph: Boolean,
usesInvalidSessionBackedAuthenticationGraph: Boolean,
isSessionTransitionInProgress: Boolean,
preparedSessionScope: UserSessionScope?,
): RetainedSessionGraph? = when {
usesNoSessionAuthenticationGraph -> null
usesInvalidSessionBackedAuthenticationGraph -> null
isSessionTransitionInProgress -> null
sessionBackedAuthenticationUserId != null -> retainedGraphFor(sessionBackedAuthenticationUserId)
currentUserId != null -> retainedGraphFor(currentUserId)
sessionBackedAuthenticationUserId != null && preparedSessionScope != null ->
retainedGraphFor(sessionBackedAuthenticationUserId, preparedSessionScope)
currentUserId != null && preparedSessionScope != null -> retainedGraphFor(currentUserId, preparedSessionScope)
else -> null
}

Expand Down Expand Up @@ -1191,6 +1266,11 @@ class WireActivity : BaseActivity() {

private fun updateTheApp() = this.launchUpdateTheApp()

private fun openSupport() {
val supportUrl = SupportUrlResolver.resolve(resources, SupportPage.SUPPORT)
startActivity(Intent(Intent.ACTION_VIEW, Uri.parse(supportUrl)))
}

override fun onResume() {
super.onResume()
shakeDetector.start()
Expand Down Expand Up @@ -1376,16 +1456,16 @@ private data class WireActivityGraphContext(
)

internal class SessionGraphStoreViewModel(
private val createSessionGraph: (UserId) -> AppSessionViewModelGraph,
private val createSessionGraph: (UserId, UserSessionScope) -> AppSessionViewModelGraph,
) : ViewModel() {
private val sessionGraphs = mutableMapOf<UserId, RetainedSessionGraph>()
private var activeUserId: UserId? = null

fun retainedGraphFor(userId: UserId): RetainedSessionGraph {
fun retainedGraphFor(userId: UserId, userSessionScope: UserSessionScope): RetainedSessionGraph {
activeUserId = userId
return sessionGraphs.getOrPut(userId) {
appLogger.i("WireActivity creating lifecycle-retained session graph for $userId")
RetainedSessionGraph(createSessionGraph(userId))
RetainedSessionGraph(createSessionGraph(userId, userSessionScope))
}
}

Expand Down
Loading
Loading