Cleanup Token Migration error logging.

Author: brandonpage

libs/SalesforceSDK/src/com/salesforce/androidsdk/accounts/UserAccountManagerExtension.kt

@@ -27,6 +27,7 @@
 package com.salesforce.androidsdk.accounts
 
 import android.content.Intent
+import com.salesforce.androidsdk.accounts.UserAccountManager.getInstance
 import com.salesforce.androidsdk.app.SalesforceSDKManager
 import com.salesforce.androidsdk.config.OAuthConfig
 import com.salesforce.androidsdk.ui.TokenMigrationActivity
@@ -43,36 +44,32 @@ const val TAG = "UserAccountManager"
  * new app. If successful a new set of credentials (refresh token, access token) are obtained
  * and replace the existing credentials for the user.
  */
+@Suppress("UnusedReceiverParameter")
 fun UserAccountManager.migrateRefreshToken(
-    userAccount: UserAccount? = UserAccountManager.getInstance().currentUser,
+    userAccount: UserAccount? = getInstance().currentUser,
     appConfig: OAuthConfig,
     onMigrationSuccess: (userAccount: UserAccount) -> Unit,
     onMigrationError: (error: String, errorDesc: String?, e: Throwable?) -> Unit,
 ) {
     val loggedOnSuccess: (userAccount: UserAccount) -> Unit = { user ->
-        SalesforceSDKLogger.i(TAG, "User ($user) successfully migrated to " +
-                "new OAuthConfig ($appConfig).")
+        SalesforceSDKLogger.i(TAG, "Token Migration Successful \n\nUser ${user.username} " +
+                "(${user.instanceServer}) successfully migrated to: \n$appConfig.")
         onMigrationSuccess.invoke(user)
     }
-    val loggedOnError: (error: String, errorDesc: String?, e: Throwable?) -> Unit = { error, errorDesc, e ->
-        val message = error + errorDesc?.let { "\nDescription: $it" }
-        SalesforceSDKLogger.e(TAG, message, e)
-        onMigrationError.invoke(error, errorDesc, e)
-    }
+    val userId = userAccount?.userId
+    val orgId = userAccount?.orgId
 
-    val userId = userAccount?.userId ?: run {
-        loggedOnError("User account or userId is null.", null, null)
-        return
-    }
-    val orgId = userAccount.orgId ?: run {
-        loggedOnError("OrgId is null.", null, null)
+    if (userId == null || orgId == null) {
+        val message = "User account, userId or orgId is null."
+        SalesforceSDKLogger.e(TAG, message)
+        onMigrationError(message, null, null)
         return
     }
 
     val callbackKey = MigrationCallbackRegistry.register(
         callbacks = MigrationCallbackRegistry.MigrationCallbacks(
             onMigrationSuccess = loggedOnSuccess,
-            onMigrationError = loggedOnError,
+            onMigrationError = onMigrationError,
         )
     )
 

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

@@ -107,28 +107,24 @@ internal class TokenMigrationActivity : ComponentActivity() {
 
         // TODO: Move to non-deprecated getParcelableExtra when min API >= 33
         val oAuthConfig = intent.getParcelableExtra<OAuthConfig>(EXTRA_OAUTH_CONFIG) ?: run {
-            resultCallback.onMigrationError("Unable to parse OAuthConfig.", null, null)
-            finish()
+            logMigrationError(resultCallback, "Unable to parse OAuthConfig.", null, null)
             return
         }
 
         val orgId = intent.getStringExtra(EXTRA_ORG_ID)
         val userId = intent.getStringExtra(EXTRA_USER_ID)
         if ( orgId == null || userId == null) {
-            resultCallback.onMigrationError("Unable to parse OAuthConfig.", null, null)
-            finish()
+            logMigrationError(resultCallback, "Unable to parse OAuthConfig.", null, null)
             return
         }
         val user = UserAccountManager.getInstance().getUserFromOrgAndUserId(orgId, userId) ?: run {
-            resultCallback.onMigrationError("Unable to build user account.", null, null)
-            finish()
+            logMigrationError(resultCallback, "Unable to build user account.", null, null)
             return
         }
         val client = runCatching {
             SalesforceSDKManager.getInstance().clientManager.peekRestClient(user)
         }.getOrElse { e ->
-            resultCallback.onMigrationError("Unable to build RestClient.", null, e as? Exception)
-            finish()
+            logMigrationError(resultCallback, "Unable to build RestClient.", null, e as? Exception)
             return
         }
 
@@ -152,12 +148,12 @@ internal class TokenMigrationActivity : ComponentActivity() {
                         }
                 }.getOrNull()
             } ?: run {
-                resultCallback.onMigrationError(
-                    /* error = */ "Request for single access bridge url failed.",
-                    /* errorDesc = */ "User's existing token may be invalid.",
-                    /* e = */ null,
+                logMigrationError(
+                    resultCallback = resultCallback,
+                    error = "Request for single access bridge url failed",
+                    errorDesc = "User's existing token may be invalid.",
+                    e = null,
                 )
-                finish()
                 return@launch
             }
             viewModel.dynamicBackgroundColor.value = Color.Transparent.copy(alpha = HALF_ALPHA)
@@ -231,12 +227,12 @@ internal class TokenMigrationActivity : ComponentActivity() {
                     // Did we fail?
                     when {
                         error != null -> {
-                            resultCallback.onMigrationError(
-                                error,
-                                params["error_description"],
-                                null,
+                            logMigrationError(
+                                resultCallback = resultCallback,
+                                error = error,
+                                errorDesc = params["error_description"],
+                                e = null,
                             )
-                            finish()
                         }
 
                         else -> {
@@ -248,7 +244,7 @@ internal class TokenMigrationActivity : ComponentActivity() {
                                 when {
                                     viewModel.useWebServerFlow ->
                                         viewModel.onWebServerFlowComplete(
-                                            params["code"],
+                                            code = params["code"],
                                             onAuthFlowError = resultCallback.onMigrationError,
                                             onAuthFlowSuccess = resultCallback.onMigrationSuccess,
                                             loginServer = instanceServer,
@@ -257,7 +253,7 @@ internal class TokenMigrationActivity : ComponentActivity() {
 
                                     else ->
                                         viewModel.onAuthFlowComplete(
-                                            TokenEndpointResponse(params),
+                                            tr = TokenEndpointResponse(params),
                                             onAuthFlowError = resultCallback.onMigrationError,
                                             onAuthFlowSuccess = resultCallback.onMigrationSuccess,
                                             tokenMigration = true,
@@ -300,6 +296,18 @@ internal class TokenMigrationActivity : ComponentActivity() {
         loadUrl(frontDoorUrl)
     }
 
+    private fun logMigrationError(
+        resultCallback: MigrationCallbackRegistry.MigrationCallbacks,
+        error: String,
+        errorDesc: String?,
+        e: Throwable?,
+    ) {
+        val message = error + (errorDesc?.let { ": $it" } ?: "")
+        SalesforceSDKLogger.e(TAG, message, e)
+        resultCallback.onMigrationError(error, errorDesc, e)
+        finish()
+    }
+
     // Ensure Status Bar Icons are readable no matter which OS theme is used.
     private fun makeStatusBarVisible() {
         val usingDarkTheme = viewModel.dynamicBackgroundTheme.value == DARK