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

Author: JohnsonEricAtSalesforce

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

@@ -147,9 +147,9 @@ import com.salesforce.androidsdk.util.SalesforceSDKLogger.e
 import com.salesforce.androidsdk.util.SalesforceSDKLogger.w
 import com.salesforce.androidsdk.util.UriFragmentParser
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Dispatchers.Default
 import kotlinx.coroutines.Dispatchers.IO
+import kotlinx.coroutines.Dispatchers.Main
 import kotlinx.coroutines.launch
 import org.json.JSONObject
 import java.lang.String.format
@@ -175,6 +175,8 @@ import java.security.cert.X509Certificate
  * them.
  */
 open class LoginActivity : FragmentActivity() {
+    private var customTabLauncher: ActivityResultLauncher<Intent>? = null
+
     // View Model
     @VisibleForTesting(otherwise = PROTECTED)
     open val viewModel: LoginViewModel
@@ -226,7 +228,7 @@ open class LoginActivity : FragmentActivity() {
             SalesforceSDKManager.getInstance().setViewNavigationVisibility(this)
         }
 
-        applyIntent(intent)
+        applyIntent()
 
         // Don't let sharedBrowserSession org setting stop a new user from logging in.
         if (intent.extras?.getBoolean(NEW_USER) == true) {
@@ -272,7 +274,7 @@ open class LoginActivity : FragmentActivity() {
             onBackPressedDispatcher.addCallback { handleBackBehavior() }
         }
 
-        val customTabLauncher: ActivityResultLauncher<Intent> = registerForActivityResult(
+        customTabLauncher = registerForActivityResult(
             ActivityResultContracts.StartActivityForResult()
         ) { result: ActivityResult ->
             // Check if the user backed out of the custom tab.
@@ -287,48 +289,6 @@ open class LoginActivity : FragmentActivity() {
             }
         }
 
-        // Take action on selected server change.
-        viewModel.selectedServer.observe(this) { selectedServer ->
-
-            // Guard against observing a selected server already provided by the intent data, such as a Salesforce Welcome Discovery mobile URL.
-            val selectedServerUri = selectedServer.toUri()
-            if (intent.data?.host == selectedServerUri.host) {
-                return@observe
-            }
-
-            // Use the URL to switch between default or Salesforce Welcome Discovery log in, if applicable.
-            if (switchDefaultOrSalesforceWelcomeDiscoveryLogin(selectedServerUri)) {
-                return@observe
-            }
-
-            if (viewModel.singleServerCustomTabActivity) {
-                // Skip fetching authorization and show custom tab immediately.
-                viewModel.reloadWebView()
-                viewModel.loginUrl.value?.let { url ->
-                    loadLoginPageInCustomTab(url, customTabLauncher)
-                }
-            } else {
-                with(SalesforceSDKManager.getInstance()) {
-                    // Fetch well known config and load in custom tab if required.
-                    fetchAuthenticationConfiguration {
-                        /* Browser-based authentication is applicable when not authenticating with a front-door bridge URL */
-                        if (isBrowserLoginEnabled && !viewModel.isUsingFrontDoorBridge) {
-                            if (useWebServerAuthentication) {
-                                viewModel.loginUrl.value?.let { url -> loadLoginPageInCustomTab(url, customTabLauncher) }
-                            } else {
-                                /* Reload the webview now that isBrowserLoginEnabled has been set
-                                   to true so that we generate an authorization URL with PKCE values.  */
-                                lifecycleScope.launch(Dispatchers.Main) {
-                                    viewModel.reloadWebView()
-                                    viewModel.loginUrl.value?.let { url -> loadLoginPageInCustomTab(url, customTabLauncher) }
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-
         // Support magic links
         if (viewModel.jwt != null) {
             swapJWTForAccessToken()
@@ -359,7 +319,9 @@ open class LoginActivity : FragmentActivity() {
             return
         }
 
-        applyIntent(intent)
+        // Store the new intent and apply it to the activity.
+        setIntent(intent)
+        applyIntent()
     }
 
     private fun clearWebView(showServerPicker: Boolean = true) {
@@ -925,6 +887,9 @@ open class LoginActivity : FragmentActivity() {
     // endregion
     // region Salesforce Welcome Login Private Implementation
 
+    /** The previously observed pending login server for use in switching between default and Salesforce Welcome Discovery log in */
+    private var previousPendingLoginServer: String? = null
+
     /**
      * If the intent is for Salesforce Welcome Discovery, apply it to the activity.
      * @param intent The intent
@@ -985,51 +950,51 @@ open class LoginActivity : FragmentActivity() {
         .build()
 
     /**
-     * Determines if the provided proposed selected server URL is a switch from
+     * Determines if the provided pending login server URL is a switch from
      * Salesforce Welcome Discovery back to default log in.
-     * @param proposedSelectedServerUrl The proposed selected server URL
-     * @return Boolean true if the provided proposed selected server URL is a
+     * @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(
-        proposedSelectedServerUrl: Uri
-    ) = viewModel.loginUrl.value?.toUri()?.let { loginUrl ->
-        isSalesforceWelcomeDiscoveryMobileUrl(this, loginUrl) && !(isSalesforceWelcomeDiscoveryMobileUrl(this, proposedSelectedServerUrl))
+        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 proposed selected server URL.
-     * @param uri The proposed selected server URL
+     * using the provided pending login server URL.
+     * @param pendingLoginServerUri The pending login server URL
      * @return Boolean true if a switch between default or Salesforce Welcome
      * Discovery log is made, false otherwise.
      */
-    private fun switchDefaultOrSalesforceWelcomeDiscoveryLogin(uri: Uri) =
+    private fun switchDefaultOrSalesforceWelcomeDiscoveryLogin(pendingLoginServerUri: Uri) =
 
-        // If the selected server has changed to a new Salesforce Welcome Discovery URL and host.
-        if (isSalesforceWelcomeDiscoveryUrlPath(uri)) {
+        // If the pending login server is a change to a new Salesforce Welcome Discovery URL and host.
+        if (isSalesforceWelcomeDiscoveryUrlPath(pendingLoginServerUri)) {
 
             // Navigate to Salesforce Welcome Discovery.
             startActivity(
                 Intent(
                     this,
-                    LoginActivity::class.java
+                    SalesforceSDKManager.getInstance().loginActivityClass
                 ).apply {
-                    data = generateSalesforceWelcomeDiscoveryMobileUrl(uri)
+                    data = generateSalesforceWelcomeDiscoveryMobileUrl(pendingLoginServerUri)
                     flags = FLAG_ACTIVITY_SINGLE_TOP
                 })
             true
         }
 
-        // If the new selected server isn't a Salesforce Welcome Discovery URL but the previous was...
-        else if (isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(uri)) {
+        // If the pending login server isn't a Salesforce Welcome Discovery URL but the previous was...
+        else if (isSwitchFromSalesforceWelcomeDiscoveryToDefaultLogin(pendingLoginServerUri)) {
 
-            // Navigate to login.
+            // Navigate to default login.
             startActivity(
                 Intent(
                     this,
-                    LoginActivity::class.java
+                    SalesforceSDKManager.getInstance().loginActivityClass
                 ).apply {
                     flags = FLAG_ACTIVITY_SINGLE_TOP
                 })
@@ -1051,6 +1016,8 @@ open class LoginActivity : FragmentActivity() {
         uri: Uri
     ): Boolean {
         return if (isSalesforceWelcomeDiscoveryMobileCallbackUrl(uri)) {
+            // Stop observing the pending login server since the newly started default login will do so.
+            viewModel.pendingServer.removeObservers(this)
             startDefaultLoginWithHintAndHost(
                 context = this,
                 loginHint = uri.getQueryParameter(SALESFORCE_WELCOME_DISCOVERY_MOBILE_CALLBACK_URL_QUERY_PARAMETER_KEY_LOGIN_HINT) ?: return false,
@@ -1075,17 +1042,81 @@ open class LoginActivity : FragmentActivity() {
     // endregion
 
     /**
-     * Applies a new intent to the activity, for instance when the activity is
-     * created or receives a new intent.
-     * @param intent The new intent
+     * (Re-)applies the intent to the activity, for instance when the activity
+     * is created or receives a new intent.
      */
-    private fun applyIntent(intent: Intent) {
+    private fun applyIntent() {
 
         // If the intent is for Salesforce Welcome Discovery, apply it to the activity.
         applySalesforceWelcomeDiscoveryIntent(intent)
 
         // If the intent is for log in using a UI Bridge API front door URL, apply it to the activity.
         applyUiBridgeApiFrontDoorUrl(intent)
+
+        // Apply the pending login server, if applicable.
+        applyPendingServer()
+    }
+
+    /**
+     * Applies the pending login server.  The authentication configuration will
+     * be fetched for the pending server and any applicable tasks will be
+     * performed such as browser based authentication.  The pending login
+     * server will be set as the selected login server once the authentication
+     * configuration has been fetched.
+     */
+    private fun applyPendingServer() {
+
+        // Reset the observer to consume the current and future values.
+        viewModel.pendingServer.removeObservers(this)
+        viewModel.pendingServer.observe(this) { pendingServer ->
+
+            // Guard against observing a pending login server already provided by the intent data, such as a Salesforce Welcome Discovery mobile URL.
+            val pendingServerUri = pendingServer.toUri()
+            if (intent.data?.host == pendingServerUri.host) {
+                previousPendingLoginServer = pendingServer
+                return@observe
+            }
+
+            // Use the URL to switch between default or Salesforce Welcome Discovery log in, if applicable.
+            if (switchDefaultOrSalesforceWelcomeDiscoveryLogin(pendingServerUri)) {
+                previousPendingLoginServer = pendingServer
+                return@observe
+            }
+
+            // Recall this pending login server for reference by future updates.
+            previousPendingLoginServer = pendingServer
+
+            if (viewModel.singleServerCustomTabActivity) {
+                // Skip fetching authorization and show custom tab immediately.
+                viewModel.selectedServer.value = pendingServer
+                viewModel.reloadWebView()
+                viewModel.loginUrl.value?.let { url ->
+                    customTabLauncher?.let { loadLoginPageInCustomTab(url, it) }
+                }
+            } else {
+                with(SalesforceSDKManager.getInstance()) {
+                    // Fetch the authentication configuration and load the login page in a custom tab if required.
+                    fetchAuthenticationConfiguration {
+                        lifecycleScope.launch(Main) {
+                            viewModel.selectedServer.value = pendingServer
+                            /* Browser-based authentication is applicable when not authenticating with a front-door bridge URL */
+                            if (isBrowserLoginEnabled && !viewModel.isUsingFrontDoorBridge) {
+                                if (useWebServerAuthentication) {
+                                    viewModel.loginUrl.value?.let { url ->
+                                        customTabLauncher?.let { loadLoginPageInCustomTab(url, it) }
+                                    }
+                                } else {
+                                    /* Reload the webview now that isBrowserLoginEnabled has been set
+                                       to true so that we generate an authorization URL with PKCE values.  */
+                                    viewModel.reloadWebView()
+                                    viewModel.loginUrl.value?.let { url -> customTabLauncher?.let { loadLoginPageInCustomTab(url, it) } }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
     }
 
     /**
@@ -1511,7 +1542,7 @@ open class LoginActivity : FragmentActivity() {
             loginHint: String,
             loginHost: String,
         ) {
-            Intent(context, LoginActivity::class.java).apply {
+            Intent(context, SalesforceSDKManager.getInstance().loginActivityClass).apply {
                 putExtra(EXTRA_KEY_LOGIN_HINT, loginHint)
                 putExtra(EXTRA_KEY_LOGIN_HOST, loginHost)
                 flags = FLAG_ACTIVITY_SINGLE_TOP

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

@@ -107,12 +107,15 @@ open class LoginViewModel(val bootConfig: BootConfig) : ViewModel() {
     // endregion
 
     // Public LiveData
+    /** The login server that has been selected by the login server manager, has an authentication configuration and is ready for use */
     val selectedServer = MediatorLiveData<String>()
     val loginUrl = MediatorLiveData<String>()
     var showServerPicker = mutableStateOf(false)
     var loading = mutableStateOf(false)
 
     // Internal LiveData
+    /** The login server that is pending authentication configuration before becoming the selected login server */
+    internal val pendingServer = MediatorLiveData<String>()
     internal val authFinished = mutableStateOf(false)
     internal val isIDPLoginFlowEnabled = derivedStateOf {
         SalesforceSDKManager.getInstance().isIDPLoginFlowEnabled
@@ -207,20 +210,21 @@ open class LoginViewModel(val bootConfig: BootConfig) : ViewModel() {
 
 
     init {
-        // Update selectedServer when the LoginServerManager value changes
-        selectedServer.addSource(SalesforceSDKManager.getInstance().loginServerManager.selectedServer) { newServer ->
+        // When the login server manager selects a login server, first fetch its authentication configuration by setting the pending login server. Second, the selected login server will be set afterwards.
+        pendingServer.addSource(SalesforceSDKManager.getInstance().loginServerManager.selectedServer) { newServer ->
             val trimmedServer = newServer.url.run { trim { it <= ' ' } }
-            if (selectedServer.value == trimmedServer) {
+            if (pendingServer.value == trimmedServer) {
                 reloadWebView()
             } else {
-                selectedServer.value = trimmedServer
+                pendingServer.value = trimmedServer
             }
         }
 
         // Update loginUrl when selectedServer updates so webview automatically reloads
         loginUrl.addSource(selectedServer) { newServer ->
             val isNewServer = loginUrl.value?.startsWith(newServer) != true
-            if (isNewServer && !isUsingFrontDoorBridge) {
+            // Note the web view does not reload when browser-based authentication or a UI Bridge API front door bridge URL are active.
+            if (isNewServer && !SalesforceSDKManager.getInstance().isBrowserLoginEnabled && !isUsingFrontDoorBridge) {
                 loginUrl.value = getAuthorizationUrl(newServer)
             }
         }