CCCT-2438 Extract Post-Login Routing And Inline App Seating

app/src/org/commcare/activities/DispatchActivity.java

@@ -1,20 +1,12 @@
 package org.commcare.activities;
 
-import static org.commcare.activities.LoginActivity.EXTRA_APP_ID;
-import static org.commcare.activities.LoginActivity.EXTRA_FORCE_SINGLE_APP_MODE;
-import static org.commcare.commcaresupportlibrary.CommCareLauncher.SESSION_ENDPOINT_APP_ID;
-import static org.commcare.connect.ConnectAppUtils.IS_LAUNCH_FROM_CONNECT;
-import static org.commcare.connect.ConnectConstants.CONNECT_MANAGED_LOGIN;
-import static org.commcare.connect.ConnectConstants.NOTIFICATION_ID;
-import static org.commcare.connect.ConnectConstants.PERSONALID_MANAGED_LOGIN;
-import static org.commcare.utils.FirebaseMessagingUtil.getNotificationActionFromIntent;
-
 import android.content.Intent;
 import android.os.Bundle;
-
 import android.util.Log;
 import android.widget.Toast;
 
+import androidx.appcompat.app.AppCompatActivity;
+
 import org.commcare.AppUtils;
 import org.commcare.CommCareApp;
 import org.commcare.CommCareApplication;
@@ -26,6 +18,11 @@
 import org.commcare.dalvik.R;
 import org.commcare.google.services.analytics.AnalyticsParamValue;
 import org.commcare.google.services.analytics.FirebaseAnalyticsUtil;
+import org.commcare.login.LaunchContext;
+import org.commcare.login.LoginResult;
+import org.commcare.login.PostLoginDestination;
+import org.commcare.login.PostLoginOutcome;
+import org.commcare.login.PostLoginRouter;
 import org.commcare.preferences.DeveloperPreferences;
 import org.commcare.recovery.measures.ExecuteRecoveryMeasuresActivity;
 import org.commcare.recovery.measures.RecoveryMeasuresHelper;
@@ -38,10 +35,17 @@
 
 import java.util.ArrayList;
 
-import androidx.appcompat.app.AppCompatActivity;
-
 import javax.annotation.Nullable;
 
+import static org.commcare.activities.LoginActivity.EXTRA_APP_ID;
+import static org.commcare.activities.LoginActivity.EXTRA_FORCE_SINGLE_APP_MODE;
+import static org.commcare.commcaresupportlibrary.CommCareLauncher.SESSION_ENDPOINT_APP_ID;
+import static org.commcare.connect.ConnectAppUtils.IS_LAUNCH_FROM_CONNECT;
+import static org.commcare.connect.ConnectConstants.CONNECT_MANAGED_LOGIN;
+import static org.commcare.connect.ConnectConstants.NOTIFICATION_ID;
+import static org.commcare.connect.ConnectConstants.PERSONALID_MANAGED_LOGIN;
+import static org.commcare.utils.FirebaseMessagingUtil.getNotificationActionFromIntent;
+
 /**
  * Dispatches install, login, and home screen activities.
  *
@@ -515,12 +519,8 @@ protected void onActivityResult(int requestCode, int resultCode, Intent intent)
                 if (resultCode == RESULT_CANCELED) {
                     shouldFinish = true;
                 } else if (intent != null) {
-                    lastLoginMode = (LoginMode)intent.getSerializableExtra(LoginActivity.LOGIN_MODE);
-                    userManuallyEnteredPasswordMode =
-                            intent.getBooleanExtra(LoginActivity.MANUAL_SWITCH_TO_PW_MODE, false);
-                    personalIdManagedLogin = intent.getBooleanExtra(PERSONALID_MANAGED_LOGIN, false);
                     connectManagedLogin = intent.getBooleanExtra(CONNECT_MANAGED_LOGIN, false);
-                    startFromLogin = true;
+                    applyPostLoginDestination(routeLoginResult(intent));
                 }
                 return;
             case HOME_SCREEN:
@@ -540,4 +540,32 @@ protected void onActivityResult(int requestCode, int resultCode, Intent intent)
         }
         super.onActivityResult(requestCode, resultCode, intent);
     }
+
+    private PostLoginDestination routeLoginResult(Intent intent) {
+        LoginMode loginMode = (LoginMode) intent.getSerializableExtra(LoginActivity.LOGIN_MODE);
+        boolean manualSwitchToPwMode =
+                intent.getBooleanExtra(LoginActivity.MANUAL_SWITCH_TO_PW_MODE, false);
+        boolean personalIdManaged = intent.getBooleanExtra(PERSONALID_MANAGED_LOGIN, false);
+        boolean restoreSession = false;
+        LoginResult.Success success = new LoginResult.Success(
+                loginMode,
+                restoreSession,
+                personalIdManaged,
+                connectManagedLogin,
+                new PostLoginOutcome(redirectToConnectOpportunityInfo)
+        );
+
+        return PostLoginRouter.route(success, new LaunchContext(true, manualSwitchToPwMode));
+    }
+
+    private void applyPostLoginDestination(PostLoginDestination destination) {
+        if (destination instanceof PostLoginDestination.Home home) {
+            lastLoginMode = home.getLoginMode();
+            userManuallyEnteredPasswordMode = home.getManualSwitchToPwMode();
+            personalIdManagedLogin = home.getPersonalIdManagedLogin();
+            startFromLogin = home.getStartFromLogin();
+        } else {
+            shouldFinish = true;
+        }
+    }
 }

app/src/org/commcare/activities/SeatAppActivity.java

@@ -2,15 +2,12 @@
 
 import android.content.Intent;
 import android.os.Bundle;
-import android.os.Handler;
-import android.os.Message;
 import android.widget.TextView;
 
-import org.commcare.CommCareApp;
-import org.commcare.CommCareApplication;
 import org.commcare.dalvik.R;
-import org.commcare.android.database.global.models.ApplicationRecord;
-import org.commcare.utils.MultipleAppsUtil;
+import org.commcare.login.AppSeater;
+import org.commcare.login.SeatFailure;
+import org.commcare.login.SeatResult;
 import org.javarosa.core.services.locale.Localization;
 
 /**
@@ -20,86 +17,31 @@
  */
 public class SeatAppActivity extends CommonBaseActivity {
 
-    private static final String KEY_IN_PROGRESS = "initialization_in_progress";
     public final static String KEY_APP_TO_SEAT = "app_to_seat";
 
-    private boolean inProgress;
-
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.screen_seat_app);
         TextView tv = findViewById(R.id.text);
         tv.setText(Localization.get("seating.app"));
 
-        inProgress = savedInstanceState != null &&
-                savedInstanceState.getBoolean(KEY_IN_PROGRESS, false);
-
-        if (!inProgress) {
-
-            String idOfAppToSeat = getIntent().getStringExtra(KEY_APP_TO_SEAT);
-            ApplicationRecord record = MultipleAppsUtil.getAppById(idOfAppToSeat);
-
-            if (record == null) {
-                // No record was found for the given id
-                Intent i = new Intent(getIntent());
-                setResult(RESULT_CANCELED, i);
-                finish();
-            }
-
-            ThreadHandler handler = new ThreadHandler(this);
-            Thread t = new Thread(new SeatAppProcess(record, handler));
-            setInProgress(true);
-            t.start();
-        }
+        String appId = getIntent().getStringExtra(KEY_APP_TO_SEAT);
+        new AppSeater().start(this, appId, progress -> {}, this::finishWithResult);
     }
 
-    @Override
-    protected void onSaveInstanceState(Bundle outState) {
-        super.onSaveInstanceState(outState);
-        outState.putBoolean(KEY_IN_PROGRESS, inProgress);
+    private void finishWithResult(SeatResult result) {
+        // A corrupted seat still returns RESULT_OK; DispatchActivity detects
+        // STATE_CORRUPTED and routes to recovery.
+        boolean treatAsSeated = result instanceof SeatResult.Success
+                || (result instanceof SeatResult.Failed
+                && ((SeatResult.Failed)result).getReason() == SeatFailure.CORRUPTED);
+        setResult(treatAsSeated ? RESULT_OK : RESULT_CANCELED, new Intent(getIntent()));
+        finish();
     }
 
     @Override
     public void onBackPressed() {
         // Make it impossible to quit in the middle of this activity
     }
-
-    private void setInProgress(boolean b) {
-        this.inProgress = b;
-    }
-
-    private static class ThreadHandler extends Handler {
-
-        private final SeatAppActivity activity;
-
-        public ThreadHandler(SeatAppActivity a) {
-            this.activity = a;
-        }
-
-        @Override
-        public void handleMessage(Message msg) {
-            activity.setInProgress(false);
-            Intent i = new Intent(activity.getIntent());
-            activity.setResult(RESULT_OK, i);
-            activity.finish();
-        }
-    }
-
-    private static class SeatAppProcess implements Runnable {
-
-        private final ApplicationRecord record;
-        private final ThreadHandler handler;
-
-        public SeatAppProcess(ApplicationRecord record, ThreadHandler handler) {
-            this.record = record;
-            this.handler = handler;
-        }
-
-        @Override
-        public void run() {
-            CommCareApplication.instance().initializeAppResources(new CommCareApp(this.record));
-            handler.sendEmptyMessage(0);
-        }
-    }
 }

app/src/org/commcare/login/AppSeater.kt

@@ -0,0 +1,76 @@
+package org.commcare.login
+
+import androidx.lifecycle.LifecycleOwner
+import androidx.lifecycle.lifecycleScope
+import kotlinx.coroutines.CancellationException
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import org.commcare.CommCareApp
+import org.commcare.CommCareApplication
+import org.commcare.android.database.global.models.ApplicationRecord
+import org.commcare.utils.MultipleAppsUtil
+import org.javarosa.core.services.Logger
+
+sealed class SeatResult {
+    object Success : SeatResult()
+
+    data class Failed(
+        val reason: SeatFailure,
+    ) : SeatResult()
+}
+
+enum class SeatFailure {
+    APP_NOT_FOUND,
+    CORRUPTED,
+    SEAT_ERROR,
+}
+
+class AppSeater
+    @JvmOverloads
+    constructor(
+        private val recordLookup: (String) -> ApplicationRecord? = { MultipleAppsUtil.getAppById(it) },
+        private val seatApp: (ApplicationRecord) -> Int = { record ->
+            val app = CommCareApp(record)
+            CommCareApplication.instance().initializeAppResources(app)
+            app.appResourceState
+        },
+        private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO,
+    ) {
+        fun interface SeatResultCallback {
+            fun onResult(result: SeatResult)
+        }
+
+        fun start(
+            lifecycleOwner: LifecycleOwner,
+            appId: String,
+            sink: LoginProgressSink,
+            callback: SeatResultCallback,
+        ): Job =
+            lifecycleOwner.lifecycleScope.launch {
+                callback.onResult(seatIfNeeded(appId, sink))
+            }
+
+        suspend fun seatIfNeeded(
+            appId: String,
+            sink: LoginProgressSink,
+        ): SeatResult {
+            sink.onProgress(LoginProgress(LoginPhase.Seating))
+            return try {
+                val record = recordLookup(appId) ?: return SeatResult.Failed(SeatFailure.APP_NOT_FOUND)
+                val resourceState = withContext(ioDispatcher) { seatApp(record) }
+                if (resourceState == CommCareApplication.STATE_CORRUPTED) {
+                    SeatResult.Failed(SeatFailure.CORRUPTED)
+                } else {
+                    SeatResult.Success
+                }
+            } catch (e: CancellationException) {
+                throw e
+            } catch (e: Exception) {
+                Logger.exception("Unexpected error while seating app $appId", e)
+                SeatResult.Failed(SeatFailure.SEAT_ERROR)
+            }
+        }
+    }

app/src/org/commcare/login/PostLoginDestination.kt

@@ -0,0 +1,16 @@
+package org.commcare.login
+
+import org.commcare.activities.LoginMode
+
+sealed class PostLoginDestination {
+    data class Home(
+        val loginMode: LoginMode,
+        val startFromLogin: Boolean,
+        val manualSwitchToPwMode: Boolean,
+        val personalIdManagedLogin: Boolean,
+    ) : PostLoginDestination()
+
+    data class TerminalFailure(
+        val error: LoginError,
+    ) : PostLoginDestination()
+}

app/src/org/commcare/login/PostLoginRouter.kt

@@ -0,0 +1,26 @@
+package org.commcare.login
+
+data class LaunchContext(
+    val startFromLogin: Boolean,
+    val manualSwitchToPwMode: Boolean,
+)
+
+object PostLoginRouter {
+    @JvmStatic
+    fun route(
+        result: LoginResult,
+        launchContext: LaunchContext,
+    ): PostLoginDestination =
+        when (result) {
+            is LoginResult.Success ->
+                PostLoginDestination.Home(
+                    loginMode = result.loginMode,
+                    startFromLogin = launchContext.startFromLogin,
+                    manualSwitchToPwMode = launchContext.manualSwitchToPwMode,
+                    personalIdManagedLogin = result.personalIdManagedLogin,
+                )
+
+            is LoginResult.Failed ->
+                PostLoginDestination.TerminalFailure(result.error)
+        }
+}