Intent for launching a specific App In CommCare

app/res/values/strings.xml

@@ -452,4 +452,5 @@
     <string name="dependency_missing_dialog_playstore_not_found" cc:translatable="true">No Play Store found on your device</string>
     <string name="fcm_notification">FCM Notification</string>
     <string name="fcm_default_notification_channel">notification-channel-server-communications</string>
+    <string name="app_with_id_not_found">Required CommCare App is not installed on device</string>
 </resources>

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

@@ -1,5 +1,7 @@
 package org.commcare.activities;
 
+import static org.commcare.commcaresupportlibrary.CommCareLauncher.SESSION_ENDPOINT_APP_ID;
+
 import android.content.Intent;
 import android.os.Bundle;
 import android.util.Log;
@@ -24,6 +26,8 @@
 
 import androidx.appcompat.app.AppCompatActivity;
 
+import javax.annotation.Nullable;
+
 /**
  * Dispatches install, login, and home screen activities.
  *
@@ -179,6 +183,9 @@ private void dispatch() {
                     }
                 } else if (!CommCareApplication.instance().getSession().isActive()) {
                     launchLoginScreen();
+                } else if (needAnotherAppLogin()){
+                    CommCareApplication.instance().closeUserSession();
+                    launchLoginScreen();
                 } else if (isExternalLaunch()) {
                     // CommCare was launched from an external app, with a session descriptor
                     handleExternalLaunch();
@@ -195,6 +202,17 @@ private void dispatch() {
         }
     }
 
+    private boolean needAnotherAppLogin() {
+        String sesssionEndpointAppID = getSessionEndpointAppId();
+        if (sesssionEndpointAppID != null) {
+            CommCareApp currentApp = CommCareApplication.instance().getCurrentApp();
+            if (currentApp != null) {
+                return !currentApp.getUniqueId().contentEquals(sesssionEndpointAppID);
+            }
+        }
+        return false;
+    }
+
     private boolean isExternalLaunch() {
         return this.getIntent().hasExtra(SESSION_REQUEST) ||
                 this.getIntent().hasExtra(SESSION_ENDPOINT_ID);
@@ -259,6 +277,10 @@ private void launchLoginScreen() {
             // AMS 06/09/16: This check is needed due to what we believe is a bug in the Android platform
             Intent i = new Intent(this, LoginActivity.class);
             i.putExtra(LoginActivity.USER_TRIGGERED_LOGOUT, userTriggeredLogout);
+            String sesssionEndpointAppID = getSessionEndpointAppId();
+            if (sesssionEndpointAppID != null) {
+                i.putExtra(LoginActivity.EXTRA_APP_ID, sesssionEndpointAppID);
+            }
             startActivityForResult(i, LOGIN_USER);
             waitingForActivityResultFromLogin = true;
         } else {
@@ -269,6 +291,11 @@ private void launchLoginScreen() {
         }
     }
 
+    @Nullable
+    private String getSessionEndpointAppId() {
+        return getIntent().getStringExtra(SESSION_ENDPOINT_APP_ID);
+    }
+
     private void launchHomeScreen() {
         Intent i;
         if (useRootMenuHomeActivity()) {

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

@@ -72,6 +72,7 @@ public class LoginActivity extends CommCareActivity<LoginActivity>
         implements OnItemSelectedListener, DataPullController,
         RuntimePermissionRequester, WithUIController, PullTaskResultReceiver {
 
+    public static final String EXTRA_APP_ID = "extra_app_id";
     private static final String TAG = LoginActivity.class.getSimpleName();
 
     public static final int MENU_DEMO = Menu.FIRST;
@@ -101,6 +102,7 @@ public class LoginActivity extends CommCareActivity<LoginActivity>
 
     private LoginActivityUIController uiController;
     private FormAndDataSyncer formAndDataSyncer;
+    private String presetAppID;
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
@@ -117,6 +119,8 @@ protected void onCreate(Bundle savedInstanceState) {
         uiController.setupUI();
         formAndDataSyncer = new FormAndDataSyncer();
 
+        presetAppID = getIntent().getStringExtra(EXTRA_APP_ID);
+
         if (savedInstanceState == null) {
             // Only restore last user on the initial creation
             uiController.restoreLastUser();
@@ -550,7 +554,10 @@ protected void populateAppSpinner(ArrayList<ApplicationRecord> readyApps) {
     public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
         // Retrieve the app record corresponding to the app selected
         String appId = appIdDropdownList.get(position);
+        seatAppIfNeeded(appId);
+    }
 
+    protected void seatAppIfNeeded(String appId) {
         boolean selectedNewApp = !appId.equals(CommCareApplication.instance().getCurrentApp().getUniqueId());
         if (selectedNewApp) {
             // Set the id of the last selected app
@@ -740,4 +747,8 @@ private void checkManagedConfiguration() {
             initiateLoginAttempt(false);
         }
     }
+
+    protected String getPresetAppID() {
+        return presetAppID;
+    }
 }

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

@@ -2,14 +2,10 @@
 
 import android.content.SharedPreferences;
 import android.content.res.Resources;
-import android.graphics.drawable.ColorDrawable;
 import android.graphics.drawable.Drawable;
-import android.graphics.drawable.StateListDrawable;
-import android.os.Build;
 import android.text.Editable;
 import android.text.InputType;
 import android.text.TextWatcher;
-import android.util.StateSet;
 import android.view.View;
 import android.view.inputmethod.EditorInfo;
 import android.widget.ArrayAdapter;
@@ -21,6 +17,8 @@
 import android.widget.Spinner;
 import android.widget.TextView;
 
+import androidx.preference.PreferenceManager;
+
 import org.commcare.CommCareApplication;
 import org.commcare.CommCareNoficationManager;
 import org.commcare.android.database.app.models.UserKeyRecord;
@@ -43,7 +41,7 @@
 import java.util.ArrayList;
 import java.util.Vector;
 
-import androidx.preference.PreferenceManager;
+import javax.annotation.Nullable;
 
 /**
  * Handles login activity UI
@@ -196,15 +194,15 @@ public void refreshView() {
 
         // Decide whether or not to show the app selection spinner based upon # of usable apps
         ArrayList<ApplicationRecord> readyApps = MultipleAppsUtil.getUsableAppRecords();
-
-        if (readyApps.size() == 1) {
+        ApplicationRecord presetAppRecord = getPresetAppRecord(readyApps);
+        if (readyApps.size() == 1 || presetAppRecord != null) {
             // Set this app as the last selected app, for use in choosing what app to initialize
             // on first startup
-            ApplicationRecord r = readyApps.get(0);
+            ApplicationRecord r = presetAppRecord != null ? presetAppRecord : readyApps.get(0);
             SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(activity);
             prefs.edit().putString(LoginActivity.KEY_LAST_APP, r.getUniqueId()).apply();
-
             setSingleAppUIState();
+            activity.seatAppIfNeeded(r.getUniqueId());
         } else {
             activity.populateAppSpinner(readyApps);
         }
@@ -230,6 +228,23 @@ public void refreshView() {
         }
     }
 
+    @Nullable
+    private ApplicationRecord getPresetAppRecord(ArrayList<ApplicationRecord> readyApps) {
+        String presetAppId = activity.getPresetAppID();
+        if (presetAppId != null) {
+            for (ApplicationRecord readyApp : readyApps) {
+                if (readyApp.getUniqueId().contentEquals(presetAppId)) {
+                    return readyApp;
+                }
+            }
+
+            // if preset App id is supplied but not found show an error
+            String appNotFoundError = activity.getString(R.string.app_with_id_not_found);
+            setErrorMessageUI(appNotFoundError, false);
+        }
+        return null;
+    }
+
     protected void refreshForNewApp() {
         // Remove any error content from trying to log into a different app
         setStyleDefault();

app/unit-tests/src/org/commcare/android/tests/navigation/ExternalLaunchTests.kt

@@ -6,18 +6,21 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import org.commcare.CommCareTestApplication
 import org.commcare.activities.DispatchActivity
 import org.commcare.activities.FormEntryActivity
+import org.commcare.activities.LoginActivity
 import org.commcare.activities.StandardHomeActivity
 import org.commcare.android.util.TestAppInstaller
 import org.commcare.android.util.TestUtils
-import org.junit.Assert
-import org.junit.Assert.assertEquals
+import org.commcare.commcaresupportlibrary.CommCareLauncher
+import org.commcare.commcaresupportlibrary.CommCareLauncher.SESSION_ENDPOINT_APP_ID
+import org.commcare.util.screen.CommCareSessionException
+import org.commcare.utils.SessionUnavailableException
+import org.junit.Assert.*
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.Robolectric
 import org.robolectric.Shadows
 import org.robolectric.annotation.Config
-import java.util.ArrayList
 
 
 @Config(application = CommCareTestApplication::class)
@@ -33,6 +36,39 @@ class ExternalLaunchTests {
         TestUtils.processResourceTransactionIntoAppDb("/commcare-apps/case_list_lookup/restore.xml")
     }
 
+    @Test
+    fun testLaunchWithAppId() {
+        // verify initial state
+        val indexAndCacheTestAppId = "000b3b9ecb0806331fbd1526616eb718"
+        assertEquals(indexAndCacheTestAppId, CommCareTestApplication.instance().currentApp.uniqueId)
+        assertEquals("test", CommCareTestApplication.instance().session.loggedInUser.username)
+
+        // Install another app, this will also seat this app as current app
+        TestAppInstaller.installApp("jr://resource/commcare-apps/archive_form_tests/profile.ccpr")
+        val archiveFormTestsAppId = "6a03772aedd992c9f2c9c2198a248184"
+        assertEquals(archiveFormTestsAppId, CommCareTestApplication.instance().currentApp.uniqueId)
+        assertEquals("test", CommCareTestApplication.instance().session.loggedInUser.username)
+
+        // Request launch for seated app, since user is logged in already we should end up on app home screen
+        launchAndVerifyCCWithAppId(archiveFormTestsAppId, StandardHomeActivity::class.java.name)
+
+        // Request launch for non seated app, this should cause user to log out and show user Login Screen
+        launchAndVerifyCCWithAppId(indexAndCacheTestAppId, LoginActivity::class.java.name)
+        assertThrows(SessionUnavailableException::class.java) {
+            CommCareTestApplication.instance().session.loggedInUser
+        }
+    }
+
+    private fun launchAndVerifyCCWithAppId(appId: String, nextScreen: String) {
+        val intent = Intent("org.commcare.dalvik.action.CommCareSession")
+        intent.putExtra(SESSION_ENDPOINT_APP_ID, appId)
+        var dispathActivity =
+            Robolectric.buildActivity(DispatchActivity::class.java, intent).create().resume().get()
+        var recordedNextIntent = Shadows.shadowOf(dispathActivity).nextStartedActivity
+        var intentActivityName: String = recordedNextIntent.component!!.className
+        assertEquals(nextScreen, intentActivityName)
+    }
+
     @Test
     fun testLaunchUsingSessionEndpoint() {
         // endpoint without arguments
@@ -67,7 +103,7 @@ class ExternalLaunchTests {
 
     private fun verifyNextIntent(nextIntent: Intent, header: String) {
         val intentActivityName: String = nextIntent.component!!.className
-        Assert.assertEquals(FormEntryActivity::class.java.name, intentActivityName)
+        assertEquals(FormEntryActivity::class.java.name, intentActivityName)
         assertEquals(nextIntent.extras!!.getString(FormEntryActivity.KEY_HEADER_STRING), header)
     }
 

app/unit-tests/src/org/commcare/android/util/TestAppInstaller.java

@@ -91,12 +91,15 @@ private void installApp() {
                 new ApplicationRecord(PropertyUtils.genUUID().replace("-", ""),
                         ApplicationRecord.STATUS_UNINITIALIZED);
 
+
         CommCareApp app = new CommCareTestApp(new CommCareApp(newRecord));
+
         ResourceEngineTask<Object> task =
                 new ResourceEngineTask<Object>(app, -1, false, false) {
                     @Override
                     protected void deliverResult(Object receiver,
                                                  AppInstallStatus result) {
+                        app.setMMResourcesValidated();
                     }
 
                     @Override

commcare-support-library/README.md

@@ -58,3 +58,9 @@ Then retrieve the XML for a specific fixture from this list:
 
 `FixtureUtils.getFixtureXml(Context context, String fixtureId`
 
+#### CommCare Launch Helpers
+
+Launch CommCare with a specific CommCare App:
+
+`CommCareLauncher.launchCommCareForAppId(Context context, String appId)`
+

commcare-support-library/src/main/java/org/commcare/commcaresupportlibrary/CommCareLauncher.java

@@ -0,0 +1,23 @@
+package org.commcare.commcaresupportlibrary;
+
+import android.content.Context;
+import android.content.Intent;
+
+/**
+ * Utility class with methods to launch CommCare
+ */
+public class CommCareLauncher {
+    public static final String SESSION_ENDPOINT_APP_ID = "ccodk_session_endpoint_app_id";
+    private static final String CC_LAUNCH_ACTION = "org.commcare.dalvik.action.CommCareSession";
+
+    /**
+     *
+     * @param context Android context to launch the CommCare with
+     * @param appId Unique Id for CommCare App that CommCare should launch with
+     */
+    public static void launchCommCareForAppId(Context context, String appId) {
+        Intent intent = new Intent(CC_LAUNCH_ACTION);
+        intent.putExtra(SESSION_ENDPOINT_APP_ID, appId);
+        context.startActivity(intent);
+    }
+}