@W-20161958: [MSDK 13.1][Android] Cannot login GUS using Welcome endpoint (loginViewModel_applyPendingLoginServer Tests)

Author: JohnsonEricAtSalesforce

libs/SalesforceSDK/src/com/salesforce/androidsdk/ui/LoginActivity.kt

@@ -148,7 +148,6 @@ import com.salesforce.androidsdk.util.UriFragmentParser
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers.Default
 import kotlinx.coroutines.Dispatchers.IO
-import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import org.json.JSONObject
 import java.lang.String.format
@@ -185,6 +184,7 @@ open class LoginActivity : FragmentActivity() {
     // Webview and Clients
     @VisibleForTesting(otherwise = PROTECTED)
     open val webViewClient = AuthWebViewClient()
+
     @VisibleForTesting(otherwise = PROTECTED)
     open val webChromeClient = WebChromeClient()
     open val webView: WebView by lazy {
@@ -337,7 +337,7 @@ open class LoginActivity : FragmentActivity() {
         // Store the new intent and apply it to the activity.
         setIntent(intent)
         applyIntent()
-        viewModel.pendingServer.value?.let { applyPendingServer(it) }
+        viewModel.applyPendingServer(pendingLoginServer = viewModel.pendingServer.value)
     }
 
     private fun clearWebView(showServerPicker: Boolean = true) {
@@ -905,13 +905,6 @@ open class LoginActivity : FragmentActivity() {
     // endregion
     // region Salesforce Welcome Login Private Implementation
 
-    /** The Kotlin Coroutine Job fetching the pending login server's authentication configuration */
-    private var authenticationConfigurationFetchJob: Job? = null
-
-    /** The previously observed pending login server for use in switching between default and Salesforce Welcome Discovery log in */
-    @VisibleForTesting
-    internal var previousPendingLoginServer: String? = null
-
     /**
      * If the intent is for Salesforce Welcome Discovery, apply it to the activity.
      * @param intent The intent
@@ -971,20 +964,6 @@ open class LoginActivity : FragmentActivity() {
         )
         .build()
 
-    /**
-     * Determines if the provided pending login server URL is a switch from
-     * Salesforce Welcome Discovery back to default log in.
-     * @param pendingLoginServerUri The pending login server URL
-     * @return Boolean true if the provided pending login server URL is a
-     * switch from Salesforce Welcome Discovery back to the default log in,
-     * false otherwise.
-     * */
-    private fun isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(
-        pendingLoginServerUri: Uri
-    ) = previousPendingLoginServer?.toUri()?.let { previousPendingLoginServerUri ->
-        isSalesforceWelcomeDiscoveryUrlPath(previousPendingLoginServerUri) && !(isSalesforceWelcomeDiscoveryMobileUrl(this, pendingLoginServerUri))
-    } ?: false
-
     /**
      * Switches between default or Salesforce Welcome Discovery log in as needed
      * using the provided pending login server URL.
@@ -1011,7 +990,7 @@ open class LoginActivity : FragmentActivity() {
         }
 
         // If the pending login server isn't a Salesforce Welcome Discovery URL but the previous was...
-        else if (isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(pendingLoginServerUri)) {
+        else if (viewModel.isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(pendingLoginServerUri)) {
 
             // Navigate to default login.
             startActivity(
@@ -1087,33 +1066,6 @@ open class LoginActivity : FragmentActivity() {
         applyUiBridgeApiFrontDoorUrl(intent)
     }
 
-    /**
-     * Applies a new pending login server.  The decision to authenticate in a
-     * web browser-custom tab will be made, which may require fetching the
-     * authentication configuration.  The selected server and login URL (OAuth
-     * authorization URL) will set to continue the flow.
-     */
-    @VisibleForTesting
-    internal fun applyPendingServer(pendingLoginServer: String) {
-        val sdkManager = SalesforceSDKManager.getInstance()
-
-        // Recall this pending login server for reference by future updates.
-        previousPendingLoginServer = pendingLoginServer
-
-        // When authorization via a single-server, custom tab activity is requested skip fetching the authorization configuration and immediately set the selected login server to generate the OAuth authorization URL.
-        if (viewModel.singleServerCustomTabActivity) {
-            viewModel.selectedServer.postValue(pendingLoginServer)
-        }
-        // Fetch the pending login server's authentication configuration to set the selected login server and OAuth authorization URL.
-        else {
-            authenticationConfigurationFetchJob?.cancel()
-            authenticationConfigurationFetchJob = sdkManager.fetchAuthenticationConfiguration {
-                viewModel.selectedServer.postValue(pendingLoginServer)
-                authenticationConfigurationFetchJob = null
-            }
-        }
-    }
-
     /**
      * Starts a browser custom tab for the OAuth authorization URL according to
      * the authentication configuration. The activity only takes action when
@@ -1636,17 +1588,17 @@ open class LoginActivity : FragmentActivity() {
             // Guard against observing a pending login server already provided by the intent data, such as a Salesforce Welcome Discovery mobile URL.
             val pendingServerUri = value.toUri()
             if (activity.intent.data?.host == pendingServerUri.host) {
-                activity.previousPendingLoginServer = value
+                activity.viewModel.previousPendingLoginServer = value
                 return
             }
 
             // Use the URL to switch between default or Salesforce Welcome Discovery log in, if applicable.
             if (activity.switchDefaultOrSalesforceWelcomeDiscoveryLogin(pendingServerUri)) {
-                activity.previousPendingLoginServer = value
+                activity.viewModel.previousPendingLoginServer = value
                 return
             }
 
-            activity.applyPendingServer(value)
+            activity.viewModel.applyPendingServer(pendingLoginServer = value)
         }
     }
 

libs/SalesforceSDK/src/com/salesforce/androidsdk/ui/LoginViewModel.kt

@@ -27,6 +27,7 @@
 package com.salesforce.androidsdk.ui
 
 import android.annotation.SuppressLint
+import android.net.Uri
 import android.webkit.CookieManager
 import android.webkit.URLUtil
 import android.webkit.WebView
@@ -39,6 +40,7 @@ import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.Color.Companion.Black
 import androidx.compose.ui.graphics.Color.Companion.White
 import androidx.compose.ui.graphics.luminance
+import androidx.core.net.toUri
 import androidx.lifecycle.MediatorLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
@@ -63,9 +65,12 @@ import com.salesforce.androidsdk.config.OAuthConfig
 import com.salesforce.androidsdk.security.SalesforceKeyGenerator.getRandom128ByteKey
 import com.salesforce.androidsdk.security.SalesforceKeyGenerator.getSHA256Hash
 import com.salesforce.androidsdk.ui.LoginActivity.Companion.ABOUT_BLANK
+import com.salesforce.androidsdk.ui.LoginActivity.Companion.isSalesforceWelcomeDiscoveryMobileUrl
+import com.salesforce.androidsdk.ui.LoginActivity.Companion.isSalesforceWelcomeDiscoveryUrlPath
 import com.salesforce.androidsdk.util.SalesforceSDKLogger.e
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers.IO
+import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import okhttp3.HttpUrl.Companion.toHttpUrlOrNull
@@ -122,8 +127,18 @@ open class LoginViewModel(val bootConfig: BootConfig) : ViewModel() {
     var loading = mutableStateOf(false)
 
     // Internal LiveData
+
+    /** The Kotlin Coroutine Job fetching the pending login server's authentication configuration */
+    @VisibleForTesting
+    internal var authenticationConfigurationFetchJob: Job? = null
+
     /** The login server that is pending authentication configuration before becoming the selected login server */
     internal val pendingServer = MediatorLiveData<String>()
+
+    /** The previously observed pending login server for use in switching between default and Salesforce Welcome Discovery log in */
+    @VisibleForTesting
+    internal var previousPendingLoginServer: String? = null
+
     internal val authFinished = mutableStateOf(false)
     internal val isIDPLoginFlowEnabled = derivedStateOf {
         SalesforceSDKManager.getInstance().isIDPLoginFlowEnabled
@@ -312,6 +327,40 @@ open class LoginViewModel(val bootConfig: BootConfig) : ViewModel() {
         instanceServer: String?,
     ) = defaultBuildAccountName(username, instanceServer)
 
+    /**
+     * Applies a new pending login server.  The decision to authenticate in a
+     * web browser-custom tab will be made, which may require fetching the
+     * authentication configuration.  The selected server and login URL (OAuth
+     * authorization URL) will set to continue the flow.
+     * @param sdkManager The Salesforce SDK manager.  This parameter is intended
+     * for testing purposes only. Defaults to the shared instance.
+     * @param pendingLoginServer The new pending login server value
+     */
+    internal fun applyPendingServer(
+        sdkManager: SalesforceSDKManager = SalesforceSDKManager.getInstance(),
+        pendingLoginServer: String?
+    ) {
+        if (pendingLoginServer == null) {
+            return
+        }
+
+        // Recall this pending login server for reference by future updates.
+        previousPendingLoginServer = pendingLoginServer
+
+        // When authorization via a single-server, custom tab activity is requested skip fetching the authorization configuration and immediately set the selected login server to generate the OAuth authorization URL.
+        if (singleServerCustomTabActivity) {
+            selectedServer.postValue(pendingLoginServer)
+        }
+        // Fetch the pending login server's authentication configuration to set the selected login server and OAuth authorization URL.
+        else {
+            authenticationConfigurationFetchJob?.cancel()
+            authenticationConfigurationFetchJob = sdkManager.fetchAuthenticationConfiguration {
+                selectedServer.postValue(pendingLoginServer)
+                authenticationConfigurationFetchJob = null
+            }
+        }
+    }
+
     /**
      * Called when the webview portion of the Web Server flow is finished.  Code exchange
      * passes the result to [onAuthFlowComplete] on success, which handles user creation.
@@ -453,6 +502,24 @@ open class LoginViewModel(val bootConfig: BootConfig) : ViewModel() {
         }
     }
 
+    // region Salesforce Welcome Discovery
+
+    /**
+     * Determines if the provided pending login server URL is a switch from
+     * Salesforce Welcome Discovery back to default log in.
+     * @param pendingLoginServerUri The pending login server URL
+     * @return Boolean true if the provided pending login server URL is a
+     * switch from Salesforce Welcome Discovery back to the default log in,
+     * false otherwise.
+     * */
+    internal fun isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(
+        pendingLoginServerUri: Uri
+    ) = previousPendingLoginServer?.toUri()?.let { previousPendingLoginServerUri ->
+        isSalesforceWelcomeDiscoveryUrlPath(previousPendingLoginServerUri) && !(isSalesforceWelcomeDiscoveryMobileUrl(pendingLoginServerUri))
+    } ?: false
+
+    // endregion
+
     companion object {
 
         val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {