Merge pull request #2750 from npars/W-19307934_include-user-account

@W-19307934 Add UserAccount to Logout Broadcast

Author: brandonpage

libs/SalesforceSDK/src/com/salesforce/androidsdk/app/SalesforceSDKManager.kt

@@ -734,11 +734,9 @@ open class SalesforceSDKManager protected constructor(
      */
     private fun cleanUp(
         frontActivity: Activity?,
-        account: Account?,
+        userAccount: UserAccount?,
         shouldDismissActivity: Boolean
     ) {
-        val userAccount = UserAccountManager.getInstance().buildUserAccount(account)
-
         // Clean up within this process
         cleanUp(userAccount)
 
@@ -1080,14 +1078,15 @@ open class SalesforceSDKManager protected constructor(
         frontActivity: Activity?,
         logoutReason: LogoutReason,
     ) {
+        val userAccount = UserAccountManager.getInstance().buildUserAccount(account)
         cleanUp(
             frontActivity,
-            account,
+            userAccount,
             showLoginPage
         )
         clientMgr.removeAccount(account)
         isLoggingOut = false
-        notifyLogoutComplete(showLoginPage, logoutReason)
+        notifyLogoutComplete(showLoginPage, logoutReason, userAccount)
 
         // Revoke the existing refresh token
         if (shouldLogoutWhenTokenRevoked() && refreshToken != null) {
@@ -1110,9 +1109,9 @@ open class SalesforceSDKManager protected constructor(
      * Sends the logout complete event.
      * @param showLoginPage When true, shows the login page
      */
-    private fun notifyLogoutComplete(showLoginPage: Boolean, logoutReason: LogoutReason) {
+    private fun notifyLogoutComplete(showLoginPage: Boolean, logoutReason: LogoutReason, userAccount: UserAccount?) {
         EventsObservable.get().notifyEvent(LogoutComplete, logoutReason)
-        sendLogoutCompleteIntent(logoutReason)
+        sendLogoutCompleteIntent(logoutReason, userAccount)
         if (showLoginPage) {
             startSwitcherActivityIfRequired()
         }
@@ -1416,12 +1415,15 @@ open class SalesforceSDKManager protected constructor(
     } ?: ""
 
     /** Sends the logout completed intent */
-    private fun sendLogoutCompleteIntent(logoutReason: LogoutReason) =
+    private fun sendLogoutCompleteIntent(logoutReason: LogoutReason, userAccount: UserAccount?) =
         appContext.sendBroadcast(Intent(
             LOGOUT_COMPLETE_INTENT_ACTION
         ).apply {
             setPackage(appContext.packageName)
             putExtra(LOGOUT_REASON_KEY, logoutReason.toString())
+            userAccount?.let { userAccount ->
+                putExtra(USER_ACCOUNT_KEY, userAccount.toBundle())
+            }
         })
 
     /**
@@ -1439,7 +1441,7 @@ open class SalesforceSDKManager protected constructor(
             )
             userAccount?.let { userAccount ->
                 putExtra(
-                    USER_ACCOUNT,
+                    USER_ACCOUNT_KEY,
                     userAccount.toBundle()
                 )
             }
@@ -1452,7 +1454,7 @@ open class SalesforceSDKManager protected constructor(
             intent: Intent
         ) {
             if (intent.action == CLEANUP_INTENT_ACTION && intent.getStringExtra(PROCESS_ID_KEY) != PROCESS_ID) {
-                cleanUp(intent.getBundleExtra(USER_ACCOUNT)?.let { bundle ->
+                cleanUp(intent.getBundleExtra(USER_ACCOUNT_KEY)?.let { bundle ->
                     UserAccount(bundle)
                 })
             }
@@ -1629,7 +1631,7 @@ open class SalesforceSDKManager protected constructor(
         private val PROCESS_ID = randomUUID().toString()
 
         /** The user account key for broadcast intents  */
-        private const val USER_ACCOUNT = "userAccount"
+        internal const val USER_ACCOUNT_KEY = "userAccount"
 
         /** An intent action indicating logout was completed */
         const val LOGOUT_COMPLETE_INTENT_ACTION = "com.salesforce.LOGOUT_COMPLETE"

libs/SalesforceSDK/src/com/salesforce/androidsdk/ui/SalesforceActivityDelegate.java

@@ -33,8 +33,10 @@
 import android.view.KeyEvent;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import androidx.core.content.ContextCompat;
 
+import com.salesforce.androidsdk.accounts.UserAccount;
 import com.salesforce.androidsdk.accounts.UserAccountManager;
 import com.salesforce.androidsdk.app.SalesforceSDKManager;
 import com.salesforce.androidsdk.auth.OAuth2;
@@ -145,7 +147,10 @@ protected void onUserSwitch() {
     private class ActivityLogoutCompleteReceiver extends LogoutCompleteReceiver {
 
         @Override
-        protected void onLogoutComplete(@NonNull OAuth2.LogoutReason reason) {
+        protected void onLogoutComplete(
+                @NonNull OAuth2.LogoutReason reason,
+                @Nullable UserAccount userAccount
+        ) {
             ((SalesforceActivityInterface) activity).onLogoutComplete();
         }
     }

libs/SalesforceSDK/src/com/salesforce/androidsdk/util/LogoutCompleteReceiver.kt

@@ -29,20 +29,45 @@ package com.salesforce.androidsdk.util
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
+import com.salesforce.androidsdk.accounts.UserAccount
 import com.salesforce.androidsdk.app.SalesforceSDKManager
+import com.salesforce.androidsdk.app.SalesforceSDKManager.Companion.USER_ACCOUNT_KEY
 import com.salesforce.androidsdk.auth.OAuth2.LogoutReason
-import java.util.Locale
 
 /**
  * Listens for the logout complete event, and acts on it.
  */
 abstract class LogoutCompleteReceiver : BroadcastReceiver() {
     override fun onReceive(context: Context, intent: Intent) {
         if (intent.action == SalesforceSDKManager.LOGOUT_COMPLETE_INTENT_ACTION) {
-            val reason = intent.getStringExtra(SalesforceSDKManager.LOGOUT_REASON_KEY) ?: LogoutReason.UNKNOWN.toString()
-            onLogoutComplete(LogoutReason.valueOf(reason.uppercase(Locale.ROOT)))
+            val reason = intent.getStringExtra(SalesforceSDKManager.LOGOUT_REASON_KEY)?.let {
+                LogoutReason.valueOf(it.uppercase())
+            } ?: LogoutReason.UNKNOWN
+            val userAccount = intent.getBundleExtra(USER_ACCOUNT_KEY)?.let { bundle ->
+                UserAccount(bundle)
+            }
+            @Suppress("DEPRECATION")
+            onLogoutComplete(reason)
+            onLogoutComplete(reason, userAccount)
         }
     }
 
-    protected abstract fun onLogoutComplete(reason: LogoutReason)
+    /**
+     * Called when logout is complete.
+     *
+     * @param reason The reason for the logout. If no reason is available, [LogoutReason.UNKNOWN] is used.
+     */
+    @Deprecated(
+        message = "To be removed in 14.0. Use onLogoutComplete method that includes the userAccount that was logged out.",
+        replaceWith = ReplaceWith("onLogoutComplete(reason: LogoutReason, userAccount: UserAccount?)")
+    )
+    protected open fun onLogoutComplete(reason: LogoutReason) {}
+
+    /**
+     * Called when logout is complete.
+     *
+     * @param reason The reason for the logout. If no reason is available, [LogoutReason.UNKNOWN] is used.
+     * @param userAccount The user account that was logged out. If no user account is available, null is used.
+     */
+    protected open fun onLogoutComplete(reason: LogoutReason, userAccount: UserAccount?) {}
 }

libs/test/SalesforceSDKTest/src/com/salesforce/androidsdk/accounts/UserAccountManagerTest.java

@@ -26,25 +26,34 @@
  */
 package com.salesforce.androidsdk.accounts;
 
+import static androidx.core.content.ContextCompat.RECEIVER_NOT_EXPORTED;
+import static com.salesforce.androidsdk.accounts.UserAccountTest.TEST_USERNAME;
 import static com.salesforce.androidsdk.accounts.UserAccountTest.checkSameUserAccount;
 
 import android.accounts.Account;
 import android.accounts.AccountManager;
 import android.content.Context;
+import android.content.IntentFilter;
 
+import androidx.core.content.ContextCompat;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.filters.SmallTest;
 import androidx.test.platform.app.InstrumentationRegistry;
 
+import com.salesforce.androidsdk.app.SalesforceSDKManager;
 import com.salesforce.androidsdk.auth.OAuth2;
+import com.salesforce.androidsdk.util.LogoutCompleteReceiver;
 
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 import java.util.List;
+import java.util.concurrent.Semaphore;
 
 /**
  * Tests for UserAccountManager.
@@ -59,20 +68,27 @@ public class UserAccountManagerTest {
 
     private UserAccountManager userAccMgr;
     private AccountManager accMgr;
+    private FakeLogoutCompleteReceiver logoutCompleteReceiver;
 
     @Before
     public void setUp() throws Exception {
         final Context targetContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
         accMgr = AccountManager.get(targetContext);
         userAccMgr = UserAccountManager.getInstance();
         Assert.assertNull("There should be no authenticated users", userAccMgr.getAuthenticatedUsers());
+        logoutCompleteReceiver = new FakeLogoutCompleteReceiver();
+        ContextCompat.registerReceiver(targetContext, logoutCompleteReceiver,
+                new IntentFilter(SalesforceSDKManager.LOGOUT_COMPLETE_INTENT_ACTION), RECEIVER_NOT_EXPORTED);
     }
 
     @After
     public void tearDown() throws Exception {
+        final Context targetContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
+        targetContext.unregisterReceiver(logoutCompleteReceiver);
         cleanupAccounts(accMgr);
         userAccMgr = null;
         accMgr = null;
+        logoutCompleteReceiver = null;
     }
 
     /**
@@ -165,6 +181,9 @@ public void testSignoutCurrentUser() {
         Assert.assertEquals("There should be 1 authenticated user", 1, userAccMgr.getAuthenticatedUsers().size());
         userAccMgr.signoutCurrentUser(null, true, OAuth2.LogoutReason.USER_LOGOUT);
         Assert.assertNull("There should be no authenticated users", userAccMgr.getAuthenticatedUsers());
+        Assert.assertEquals(OAuth2.LogoutReason.USER_LOGOUT, logoutCompleteReceiver.getLastReasonReceived());
+        Assert.assertNotNull(logoutCompleteReceiver.getLastUserAccountReceived());
+        Assert.assertEquals(TEST_USERNAME, logoutCompleteReceiver.getLastUserAccountReceived().getUsername());
     }
 
     /**
@@ -177,6 +196,9 @@ public void testSignoutBackgroundUser() {
         userAccMgr.signoutUser(firstUser, null, false, OAuth2.LogoutReason.USER_LOGOUT);
         Assert.assertEquals("There should be 1 authenticated user", 1, userAccMgr.getAuthenticatedUsers().size());
         checkSameUserAccount(secondUser, userAccMgr.getCurrentUser());
+        Assert.assertEquals(OAuth2.LogoutReason.USER_LOGOUT, logoutCompleteReceiver.getLastReasonReceived());
+        Assert.assertNotNull(logoutCompleteReceiver.getLastUserAccountReceived());
+        Assert.assertEquals(TEST_USERNAME, logoutCompleteReceiver.getLastUserAccountReceived().getUsername());
     }
 
     /**
@@ -210,4 +232,37 @@ private UserAccount createOtherTestAccountInAccountManager() {
         return userAccount;
     }
 
+    private static class FakeLogoutCompleteReceiver extends LogoutCompleteReceiver {
+        private OAuth2.LogoutReason lastReasonReceived;
+        private UserAccount lastUserAccountReceived;
+        // Use a semaphore here to ensure the test doesn't proceed until the logout complete
+        // receiver has been called
+        private final Semaphore completionSemaphore = new Semaphore(0);
+
+        protected void onLogoutComplete(@NotNull OAuth2.LogoutReason reason, @Nullable UserAccount userAccount) {
+            lastReasonReceived = reason;
+            lastUserAccountReceived = userAccount;
+            completionSemaphore.release();
+        }
+
+        public OAuth2.LogoutReason getLastReasonReceived() {
+            try {
+                completionSemaphore.acquire();
+            } catch (InterruptedException e) {
+                Assert.fail("Interrupted while waiting for lastReasonReceived to be set");
+            }
+            completionSemaphore.release();
+            return lastReasonReceived;
+        }
+
+        public UserAccount getLastUserAccountReceived() {
+            try {
+                completionSemaphore.acquire();
+            } catch (InterruptedException e) {
+                Assert.fail("Interrupted while waiting for lastUserAccountReceived to be set");
+            }
+            completionSemaphore.release();
+            return lastUserAccountReceived;
+        }
+    }
 }