Merge pull request #2834 from wmathurin/dev

New feature flag for welcome discovery (WD)

Author: wmathurin

libs/SalesforceSDK/src/com/salesforce/androidsdk/app/Features.java

@@ -44,4 +44,5 @@ public class Features {
     public static final String FEATURE_BIOMETRIC_AUTH = "BA";
     public static final String FEATURE_NATIVE_LOGIN = "NL";
     public static final String FEATURE_QR_CODE_LOGIN = "QR";
+    public static final String FEATURE_WELCOME_DISCOVERY_LOGIN = "WD";
 }

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

@@ -125,6 +125,7 @@ import com.salesforce.androidsdk.R.string.sf__ssl_unknown_error
 import com.salesforce.androidsdk.R.string.sf__ssl_untrusted
 import com.salesforce.androidsdk.accounts.UserAccount
 import com.salesforce.androidsdk.app.Features.FEATURE_QR_CODE_LOGIN
+import com.salesforce.androidsdk.app.Features.FEATURE_WELCOME_DISCOVERY_LOGIN
 import com.salesforce.androidsdk.app.SalesforceSDKManager
 import com.salesforce.androidsdk.app.SalesforceSDKManager.Theme.DARK
 import com.salesforce.androidsdk.auth.HttpAccess
@@ -198,20 +199,22 @@ open class LoginActivity : FragmentActivity() {
             webViewClient = this@LoginActivity.webViewClient
             webChromeClient = this@LoginActivity.webChromeClient
             setBackgroundColor(Color.Transparent.toArgb())
+            this@LoginActivity.baseUserAgentString = settings.userAgentString ?: ""
             settings.apply {
                 domStorageEnabled = true /* Salesforce Welcome Discovery requires this */
                 @SuppressLint("SetJavaScriptEnabled")
                 javaScriptEnabled = true
                 userAgentString = format(
                     "%s %s",
                     SalesforceSDKManager.getInstance().userAgent,
-                    userAgentString ?: "",
+                    this@LoginActivity.baseUserAgentString
                 )
             }
         }
     }
 
     // Private variables
+    private var baseUserAgentString = "";
     private var wasBackgrounded = false
     private var accountAuthenticatorResponse: AccountAuthenticatorResponse? = null
     private var accountAuthenticatorResult: Bundle? = null
@@ -901,6 +904,24 @@ open class LoginActivity : FragmentActivity() {
      */
     private fun applySalesforceWelcomeDiscoveryIntent(intent: Intent) {
 
+        // Set welcome discovery feature flag if applicable
+        if (isLoginWithWelcomeDiscovery(intent)) {
+            SalesforceSDKManager.getInstance()
+                .registerUsedAppFeature(FEATURE_WELCOME_DISCOVERY_LOGIN);
+        }
+        else {
+            SalesforceSDKManager.getInstance().unregisterUsedAppFeature(
+                FEATURE_WELCOME_DISCOVERY_LOGIN
+            );
+        }
+
+        // Re-apply user agent to WebView
+        webView.settings.userAgentString = format(
+            "%s %s",
+            SalesforceSDKManager.getInstance().userAgent,
+            baseUserAgentString
+        )
+
         // Apply the intent extras' Salesforce Welcome Login hint and host for use in the OAuth authorize URL, if applicable.
         applySalesforceWelcomeLoginHintAndHost(intent)
 
@@ -929,6 +950,19 @@ open class LoginActivity : FragmentActivity() {
         }
     }
 
+    /**
+     * Returns true if intent is for a login with Welcome discovery
+     * - either because the the login url is Welcome discovery (part 1 of the flow)
+     * - there is a login hint (part 2 of the flow)
+     *
+     * @return true when the intent is for a login with Welcome discovery
+     */
+    private fun isLoginWithWelcomeDiscovery(intent: Intent): Boolean {
+        val isWelcomeDiscoveryUrl = intent.data?.let { isSalesforceWelcomeDiscoveryMobileUrl(it) } == true
+        val hasLoginHint = intent.getStringExtra(EXTRA_KEY_LOGIN_HOST) != null
+        return isWelcomeDiscoveryUrl || hasLoginHint
+    }
+
     /**
      * Creates a Salesforce Welcome Discovery mobile URL using the provided
      * Salesforce Welcome Discovery host and path URL.

libs/test/SalesforceSDKTest/src/com/salesforce/androidsdk/ui/LoginActivityScenarioTest.kt

@@ -36,6 +36,7 @@ import androidx.lifecycle.Lifecycle.State.STARTED
 import androidx.test.core.app.ActivityScenario.launch
 import androidx.test.core.app.ApplicationProvider.getApplicationContext
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.salesforce.androidsdk.app.Features
 import com.salesforce.androidsdk.app.SalesforceSDKManager
 import com.salesforce.androidsdk.config.LoginServerManager.PRODUCTION_LOGIN_URL
 import com.salesforce.androidsdk.config.LoginServerManager.WELCOME_LOGIN_URL
@@ -46,6 +47,7 @@ import io.mockk.mockk
 import io.mockk.verify
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertFalse
+import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertTrue
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -375,4 +377,78 @@ class LoginActivityScenarioTest {
             assertTrue(activity.switchDefaultOrSalesforceWelcomeDiscoveryLogin(PRODUCTION_LOGIN_URL.toUri()))
         }
     }
+
+    @Test
+    fun userAgent_hasWelcomeDiscoveryFlag_withWelcomeDiscoveryLoginServer() {
+        val uri = "https://welcome.salesforce.com/discovery?client_id=aaa&callback_url=bbb&client_version=ccc".toUri()
+
+        launch<LoginActivity>(
+            Intent(
+                getApplicationContext(),
+                LoginActivity::class.java
+            ).apply {
+                data = uri
+            }).use { activityScenario ->
+
+            activityScenario.onActivity { activity ->
+                val userAgentString = activity.webView.settings.userAgentString
+                val featureFlags = extractFeatureFlags(userAgentString)
+                assertTrue(
+                    "WD (Welcome Discovery) should be present in $userAgentString",
+                    featureFlags.contains(Features.FEATURE_WELCOME_DISCOVERY_LOGIN)
+                )
+            }
+        }
+    }
+
+    @Test
+    fun userAgent_hasWelcomeDiscoveryFlag_withLoginHostHint() {
+        launch<LoginActivity>(
+            Intent(
+                getApplicationContext(),
+                LoginActivity::class.java
+            ).apply {
+                putExtra(EXTRA_KEY_LOGIN_HOST, "mobilesdk.my.salesforce.com")
+            }).use { activityScenario ->
+
+            activityScenario.onActivity { activity ->
+                val userAgentString = activity.webView.settings.userAgentString
+                val featureFlags = extractFeatureFlags(userAgentString)
+                assertTrue(
+                    "WD (Welcome Discovery) should be present in $userAgentString",
+                    featureFlags.contains(Features.FEATURE_WELCOME_DISCOVERY_LOGIN)
+                )
+            }
+        }
+    }
+
+    @Test
+    fun userAgent_doesNotHaveWelcomeDiscoveryFlag_withMyDomainLoginServer() {
+        val uri = "https://mobilesdk.my.salesforce.com".toUri()
+
+        launch<LoginActivity>(
+            Intent(
+                getApplicationContext(),
+                LoginActivity::class.java
+            ).apply {
+                data = uri
+            }).use { activityScenario ->
+
+            activityScenario.onActivity { activity ->
+                val userAgentString = activity.webView.settings.userAgentString
+                val featureFlags = extractFeatureFlags(userAgentString)
+                assertFalse(
+                    "WD (Welcome Discovery) should NOT be present in $userAgentString",
+                    featureFlags.contains(Features.FEATURE_WELCOME_DISCOVERY_LOGIN)
+                )
+            }
+        }
+    }
+
+    fun extractFeatureFlags(userAgentString: String): List<String> {
+        val ftrMatch = Regex("ftr_([^\\s]*)").find(userAgentString)
+        assertNotNull("User agent should contain ftr_ field: $userAgentString", ftrMatch)
+        val ftrValue = ftrMatch!!.groupValues[1]
+        return ftrValue.split(".")
+    }
 }