CCCT-2439 Launch Connect Apps Without Showing The Login Screen #3753
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package org.commcare.connect | ||
|
|
||
| import android.content.Context | ||
| import androidx.lifecycle.LifecycleOwner | ||
| import androidx.lifecycle.lifecycleScope | ||
| import kotlinx.coroutines.Job | ||
| import kotlinx.coroutines.launch | ||
| import org.commcare.CommCareApplication | ||
| import org.commcare.activities.DataPullController.DataPullMode | ||
| import org.commcare.activities.LoginMode | ||
| import org.commcare.android.database.app.models.UserKeyRecord | ||
| import org.commcare.connect.database.ConnectUserDatabaseUtil | ||
| import org.commcare.google.services.analytics.FirebaseAnalyticsUtil | ||
| import org.commcare.login.AppSeater | ||
| import org.commcare.login.AuthSource | ||
| import org.commcare.login.LoginController | ||
| import org.commcare.login.LoginError | ||
| import org.commcare.login.LoginProgressListener | ||
| import org.commcare.login.LoginRequest | ||
| import org.commcare.login.LoginResult | ||
| import org.commcare.login.SeatResult | ||
| import java.util.Locale | ||
|
|
||
| /** | ||
| * Terminal result of a Connect launch. All non-token, non-seat errors fold into [Retryable]; | ||
| * since this path only does PersonalID password logins, there is no SyncFailed or Demo outcome. | ||
| */ | ||
| sealed class LaunchOutcome { | ||
| object Launched : LaunchOutcome() | ||
|
|
||
| object TokenDenied : LaunchOutcome() | ||
|
|
||
| object AppSeatFailed : LaunchOutcome() | ||
|
|
||
| object CredentialResolutionFailed : LaunchOutcome() | ||
|
|
||
| data class Retryable( | ||
| val error: LoginError, | ||
| ) : LaunchOutcome() | ||
| } | ||
|
|
||
| /** | ||
| * Seats and signs into a Connect app with the worker's PersonalID credentials without showing | ||
| * [org.commcare.activities.LoginActivity]. | ||
| */ | ||
| class ConnectAppLauncher internal constructor( | ||
| private val seatApp: suspend (String, LoginProgressListener) -> SeatResult, | ||
| private val performLogin: suspend (Context, LoginRequest, LoginProgressListener) -> LoginResult, | ||
| private val connectUsername: (Context) -> String?, | ||
| ) { | ||
| constructor() : this( | ||
| seatApp = { appId, listener -> AppSeater().seatIfNeeded(appId, listener) }, | ||
| performLogin = { context, request, listener -> LoginController(context).performLogin(request, listener) }, | ||
| connectUsername = { context -> ConnectUserDatabaseUtil.getUser(context)?.userId }, | ||
| ) | ||
|
|
||
| fun interface OutcomeCallback { | ||
| fun onOutcome(outcome: LaunchOutcome) | ||
| } | ||
|
|
||
| /** Fire-and-forget [awaitOutcome], scoped to [lifecycleOwner] so it cancels with the view. */ | ||
| fun start( | ||
| lifecycleOwner: LifecycleOwner, | ||
| context: Context, | ||
| appId: String, | ||
| isLearning: Boolean, | ||
| listener: LoginProgressListener, | ||
| callback: OutcomeCallback, | ||
| ): Job = | ||
| lifecycleOwner.lifecycleScope.launch { | ||
| callback.onOutcome(awaitOutcome(context, appId, isLearning, listener)) | ||
| } | ||
|
|
||
| suspend fun awaitOutcome( | ||
| context: Context, | ||
| appId: String, | ||
| isLearning: Boolean, | ||
| listener: LoginProgressListener, | ||
| ): LaunchOutcome { | ||
| CommCareApplication.instance().closeUserSession() | ||
| FirebaseAnalyticsUtil.reportCccAppLaunch( | ||
| if (isLearning) "Learn" else "Deliver", | ||
| appId, | ||
| ) | ||
|
|
||
| if (seatApp(appId, listener) is SeatResult.Failed) { | ||
| return LaunchOutcome.AppSeatFailed | ||
| } | ||
|
|
||
| val username = | ||
| connectUsername(context)?.trim()?.lowercase(Locale.ROOT) | ||
| if (username.isNullOrEmpty()) { | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| return LaunchOutcome.CredentialResolutionFailed | ||
| } | ||
|
|
||
| val request = | ||
| LoginRequest( | ||
| appId = appId, | ||
| username = username, | ||
| passwordOrPin = "", | ||
| credentialType = LoginMode.PASSWORD, | ||
| authSource = AuthSource.PersonalId, | ||
| restoreSession = false, | ||
| triggerMultipleUsersWarning = hasMultipleMatchingUsers(username), | ||
| blockRemoteKeyManagement = false, | ||
| dataPullMode = DataPullMode.NORMAL, | ||
| ) | ||
|
|
||
| return when (val result = performLogin(context, request, listener)) { | ||
| is LoginResult.Success -> LaunchOutcome.Launched | ||
| is LoginResult.Failed -> | ||
| when (result.error) { | ||
| is LoginError.TokenDenied -> LaunchOutcome.TokenDenied | ||
| else -> LaunchOutcome.Retryable(result.error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun hasMultipleMatchingUsers(username: String): Boolean { | ||
| var count = 0 | ||
| for (record in CommCareApplication.instance().getAppStorage(UserKeyRecord::class.java)) { | ||
| if (record.username == username && ++count > 1) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| package org.commcare.connect | ||
|
|
||
| /** Actions a caller runs for a [LaunchOutcome]; a seam so the mapping is testable without a fragment. */ | ||
| interface LaunchActions { | ||
| fun dismissProgress() | ||
|
|
||
| fun launchHome() | ||
|
|
||
| fun handleTokenDenied() | ||
|
|
||
| fun recoverFromSeatFailure() | ||
|
|
||
| fun fallBackToLegacyLaunch() | ||
|
|
||
| fun reportFailure(reason: String) | ||
| } | ||
|
|
||
| /** Maps each [LaunchOutcome] to its [LaunchActions] calls, always dismissing progress first. */ | ||
| object LaunchOutcomeRouter { | ||
| fun dispatch( | ||
| outcome: LaunchOutcome, | ||
| actions: LaunchActions, | ||
| ) { | ||
| actions.dismissProgress() | ||
| when (outcome) { | ||
| LaunchOutcome.Launched -> actions.launchHome() | ||
| LaunchOutcome.TokenDenied -> actions.handleTokenDenied() | ||
| LaunchOutcome.AppSeatFailed -> actions.recoverFromSeatFailure() | ||
| LaunchOutcome.CredentialResolutionFailed -> { | ||
| actions.reportFailure("CredentialResolutionFailed") | ||
| actions.fallBackToLegacyLaunch() | ||
| } | ||
| is LaunchOutcome.Retryable -> { | ||
| actions.reportFailure(outcome.error::class.java.simpleName) | ||
| actions.fallBackToLegacyLaunch() | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.