Show dialogs on UI thread (#3464)

* Show dialogs on UI thread

* Fix test names

Author: lfkellogg

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java

@@ -215,34 +215,40 @@ private Task<Void> showSignInConfirmationDialog(Activity hostActivity) {
       showSignInDialogTask = new TaskCompletionSource<>();
     }
 
-    signInConfirmationDialog = new AlertDialog.Builder(hostActivity).create();
     dialogHostActivity = hostActivity;
 
-    Context context = firebaseApp.getApplicationContext();
-    signInConfirmationDialog.setTitle(context.getString(R.string.signin_dialog_title));
-    signInConfirmationDialog.setMessage(context.getString(R.string.singin_dialog_message));
-
-    signInConfirmationDialog.setButton(
-        AlertDialog.BUTTON_POSITIVE,
-        context.getString(R.string.singin_yes_button),
-        (dialogInterface, i) -> showSignInDialogTask.setResult(null));
-
-    signInConfirmationDialog.setButton(
-        AlertDialog.BUTTON_NEGATIVE,
-        context.getString(R.string.singin_no_button),
-        (dialogInterface, i) ->
-            showSignInDialogTask.setException(
-                new FirebaseAppDistributionException(
-                    ErrorMessages.AUTHENTICATION_CANCELED, AUTHENTICATION_CANCELED)));
-
-    signInConfirmationDialog.setOnCancelListener(
-        dialogInterface ->
-            showSignInDialogTask.setException(
-                new FirebaseAppDistributionException(
-                    ErrorMessages.AUTHENTICATION_CANCELED, AUTHENTICATION_CANCELED)));
-
-    signInConfirmationDialog.show();
-
+    // We may not be on the main (UI) thread in some cases, specifically if the developer calls
+    // the basic config from the background. If we are already on the main thread, this will
+    // execute immediately.
+    hostActivity.runOnUiThread(
+        () -> {
+          signInConfirmationDialog = new AlertDialog.Builder(hostActivity).create();
+
+          Context context = firebaseApp.getApplicationContext();
+          signInConfirmationDialog.setTitle(context.getString(R.string.signin_dialog_title));
+          signInConfirmationDialog.setMessage(context.getString(R.string.singin_dialog_message));
+
+          signInConfirmationDialog.setButton(
+              AlertDialog.BUTTON_POSITIVE,
+              context.getString(R.string.singin_yes_button),
+              (dialogInterface, i) -> showSignInDialogTask.setResult(null));
+
+          signInConfirmationDialog.setButton(
+              AlertDialog.BUTTON_NEGATIVE,
+              context.getString(R.string.singin_no_button),
+              (dialogInterface, i) ->
+                  showSignInDialogTask.setException(
+                      new FirebaseAppDistributionException(
+                          ErrorMessages.AUTHENTICATION_CANCELED, AUTHENTICATION_CANCELED)));
+
+          signInConfirmationDialog.setOnCancelListener(
+              dialogInterface ->
+                  showSignInDialogTask.setException(
+                      new FirebaseAppDistributionException(
+                          ErrorMessages.AUTHENTICATION_CANCELED, AUTHENTICATION_CANCELED)));
+
+          signInConfirmationDialog.show();
+        });
     return showSignInDialogTask.getTask();
   }
 
@@ -420,42 +426,47 @@ private Task<Void> showUpdateConfirmationDialog(
     }
 
     Context context = firebaseApp.getApplicationContext();
-
-    updateConfirmationDialog = new AlertDialog.Builder(hostActivity).create();
     dialogHostActivity = hostActivity;
-    updateConfirmationDialog.setTitle(context.getString(R.string.update_dialog_title));
 
-    StringBuilder message =
-        new StringBuilder(
-            String.format(
-                "Version %s (%s) is available.",
-                newRelease.getDisplayVersion(), newRelease.getVersionCode()));
-
-    if (newRelease.getReleaseNotes() != null && !newRelease.getReleaseNotes().isEmpty()) {
-      message.append(String.format("\n\nRelease notes: %s", newRelease.getReleaseNotes()));
-    }
-    updateConfirmationDialog.setMessage(message);
-
-    updateConfirmationDialog.setButton(
-        AlertDialog.BUTTON_POSITIVE,
-        context.getString(R.string.update_yes_button),
-        (dialogInterface, i) -> showUpdateDialogTask.setResult(null));
-
-    updateConfirmationDialog.setButton(
-        AlertDialog.BUTTON_NEGATIVE,
-        context.getString(R.string.update_no_button),
-        (dialogInterface, i) ->
-            showUpdateDialogTask.setException(
-                new FirebaseAppDistributionException(
-                    ErrorMessages.UPDATE_CANCELED, Status.INSTALLATION_CANCELED)));
-
-    updateConfirmationDialog.setOnCancelListener(
-        dialogInterface ->
-            showUpdateDialogTask.setException(
-                new FirebaseAppDistributionException(
-                    ErrorMessages.UPDATE_CANCELED, Status.INSTALLATION_CANCELED)));
-
-    updateConfirmationDialog.show();
+    // We should already be on the main (UI) thread here, but be explicit just to be safe. If we are
+    // already on the main thread, this will execute immediately.
+    hostActivity.runOnUiThread(
+        () -> {
+          updateConfirmationDialog = new AlertDialog.Builder(hostActivity).create();
+          updateConfirmationDialog.setTitle(context.getString(R.string.update_dialog_title));
+
+          StringBuilder message =
+              new StringBuilder(
+                  String.format(
+                      "Version %s (%s) is available.",
+                      newRelease.getDisplayVersion(), newRelease.getVersionCode()));
+
+          if (newRelease.getReleaseNotes() != null && !newRelease.getReleaseNotes().isEmpty()) {
+            message.append(String.format("\n\nRelease notes: %s", newRelease.getReleaseNotes()));
+          }
+          updateConfirmationDialog.setMessage(message);
+
+          updateConfirmationDialog.setButton(
+              AlertDialog.BUTTON_POSITIVE,
+              context.getString(R.string.update_yes_button),
+              (dialogInterface, i) -> showUpdateDialogTask.setResult(null));
+
+          updateConfirmationDialog.setButton(
+              AlertDialog.BUTTON_NEGATIVE,
+              context.getString(R.string.update_no_button),
+              (dialogInterface, i) ->
+                  showUpdateDialogTask.setException(
+                      new FirebaseAppDistributionException(
+                          ErrorMessages.UPDATE_CANCELED, Status.INSTALLATION_CANCELED)));
+
+          updateConfirmationDialog.setOnCancelListener(
+              dialogInterface ->
+                  showUpdateDialogTask.setException(
+                      new FirebaseAppDistributionException(
+                          ErrorMessages.UPDATE_CANCELED, Status.INSTALLATION_CANCELED)));
+
+          updateConfirmationDialog.show();
+        });
 
     return showUpdateDialogTask.getTask();
   }

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionLifecycleNotifier.java

@@ -98,6 +98,10 @@ interface OnActivityDestroyedListener {
   /**
    * Apply a function to a foreground activity, when one is available, returning a {@link Task} that
    * will complete immediately after the function is applied.
+   *
+   * <p>The consumer function will be called immediately once the activity is available. This may be
+   * on the main thread or the calling thread, depending on whether or not there is already a
+   * foreground activity available when this method is called.
    */
   Task<Void> applyToForegroundActivity(ActivityConsumer consumer) {
     return getForegroundActivity()
@@ -117,6 +121,10 @@ Task<Void> applyToForegroundActivity(ActivityConsumer consumer) {
   /**
    * Apply a function to a foreground activity, when one is available, returning a {@link Task} that
    * will complete with the result of the Task returned by that function.
+   *
+   * <p>The continuation function will be called immediately once the activity is available. This
+   * may be on the main thread or the calling thread, depending on whether or not there is already a
+   * foreground activity available when this method is called.
    */
   <T> Task<T> applyToForegroundActivityTask(SuccessContinuation<Activity, T> continuation) {
     return getForegroundActivity()

firebase-appdistribution/src/test/java/com/google/firebase/appdistribution/FirebaseAppDistributionTest.java

@@ -61,6 +61,10 @@
 import com.google.firebase.installations.InstallationTokenResult;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -231,7 +235,7 @@ public void updateApp_whenNotSignedIn_throwsError() {
   }
 
   @Test
-  public void updateToNewRelease_whenNewAabReleaseAvailable_showsUpdateDialog() {
+  public void updateIfNewReleaseAvailable_whenNewAabReleaseAvailable_showsUpdateDialog() {
     when(mockNewReleaseFetcher.checkForNewRelease())
         .thenReturn(Tasks.forResult((TEST_RELEASE_NEWER_AAB_INTERNAL.build())));
 
@@ -248,7 +252,20 @@ public void updateToNewRelease_whenNewAabReleaseAvailable_showsUpdateDialog() {
   }
 
   @Test
-  public void updateToNewRelease_whenReleaseNotesEmpty_doesNotShowReleaseNotes() {
+  public void updateIfNewReleaseAvailable_fromABackgroundThread_showsUpdateDialog()
+      throws InterruptedException {
+    when(mockNewReleaseFetcher.checkForNewRelease())
+        .thenReturn(Tasks.forResult((TEST_RELEASE_NEWER_AAB_INTERNAL.build())));
+
+    ExecutorService executorService = Executors.newSingleThreadExecutor();
+    executorService.submit(() -> firebaseAppDistribution.updateIfNewReleaseAvailable());
+    TestUtils.awaitAsyncOperations(executorService);
+
+    assertAlertDialogShown();
+  }
+
+  @Test
+  public void updateIfNewReleaseAvailable_whenReleaseNotesEmpty_doesNotShowReleaseNotes() {
     when(mockNewReleaseFetcher.checkForNewRelease())
         .thenReturn(Tasks.forResult((TEST_RELEASE_NEWER_AAB_INTERNAL.setReleaseNotes("").build())));
 
@@ -263,7 +280,7 @@ public void updateToNewRelease_whenReleaseNotesEmpty_doesNotShowReleaseNotes() {
   }
 
   @Test
-  public void updateToNewRelease_whenNoReleaseAvailable_updateDialogNotShown() {
+  public void updateIfNewReleaseAvailable_whenNoReleaseAvailable_updateDialogNotShown() {
     when(mockNewReleaseFetcher.checkForNewRelease()).thenReturn(Tasks.forResult(null));
 
     UpdateTask task = firebaseAppDistribution.updateIfNewReleaseAvailable();
@@ -277,7 +294,7 @@ public void updateToNewRelease_whenNoReleaseAvailable_updateDialogNotShown() {
   }
 
   @Test
-  public void updateToNewRelease_whenActivityBackgrounded_updateDialogNotShown() {
+  public void updateIfNewReleaseAvailable_whenActivityBackgrounded_updateDialogNotShown() {
     when(mockNewReleaseFetcher.checkForNewRelease()).thenReturn(Tasks.forResult(null));
 
     UpdateTask task = firebaseAppDistribution.updateIfNewReleaseAvailable();
@@ -291,7 +308,7 @@ public void updateToNewRelease_whenActivityBackgrounded_updateDialogNotShown() {
   }
 
   @Test
-  public void updateToNewRelease_whenSignInCancelled_checkForUpdateNotCalled() {
+  public void updateIfNewReleaseAvailable_whenSignInCancelled_checkForUpdateNotCalled() {
     when(mockSignInStorage.getSignInStatus()).thenReturn(false);
     when(mockTesterSignInManager.signInTester())
         .thenReturn(
@@ -310,7 +327,7 @@ public void updateToNewRelease_whenSignInCancelled_checkForUpdateNotCalled() {
   }
 
   @Test
-  public void updateToNewRelease_whenSignInFailed_checkForUpdateNotCalled() {
+  public void updateIfNewReleaseAvailable_whenSignInFailed_checkForUpdateNotCalled() {
     when(mockSignInStorage.getSignInStatus()).thenReturn(false);
     when(mockTesterSignInManager.signInTester())
         .thenReturn(
@@ -327,7 +344,7 @@ public void updateToNewRelease_whenSignInFailed_checkForUpdateNotCalled() {
   }
 
   @Test
-  public void updateToNewRelease_whenDialogDismissed_taskFails() {
+  public void updateIfNewReleaseAvailable_whenDialogDismissed_taskFails() {
     when(mockNewReleaseFetcher.checkForNewRelease())
         .thenReturn(Tasks.forResult(TEST_RELEASE_NEWER_AAB_INTERNAL.build()));
 
@@ -341,7 +358,7 @@ public void updateToNewRelease_whenDialogDismissed_taskFails() {
   }
 
   @Test
-  public void updateToNewRelease_whenDialogCanceled_taskFails() {
+  public void updateIfNewReleaseAvailable_whenDialogCanceled_taskFails() {
     when(mockNewReleaseFetcher.checkForNewRelease())
         .thenReturn(Tasks.forResult(TEST_RELEASE_NEWER_AAB_INTERNAL.build()));
 
@@ -356,7 +373,7 @@ public void updateToNewRelease_whenDialogCanceled_taskFails() {
   }
 
   @Test
-  public void updateToNewRelease_whenCheckForUpdateFails_updateAppNotCalled() {
+  public void updateIfNewReleaseAvailable_whenCheckForUpdateFails_updateAppNotCalled() {
     when(mockNewReleaseFetcher.checkForNewRelease())
         .thenReturn(
             Tasks.forException(
@@ -376,7 +393,7 @@ public void updateToNewRelease_whenCheckForUpdateFails_updateAppNotCalled() {
   }
 
   @Test
-  public void updateToNewRelease_whenTesterIsSignedIn_doesNotOpenDialog() {
+  public void updateIfNewReleaseAvailable_whenTesterIsSignedIn_doesNotOpenDialog() {
     when(mockSignInStorage.getSignInStatus()).thenReturn(true);
 
     firebaseAppDistribution.updateIfNewReleaseAvailable();
@@ -400,7 +417,7 @@ public void signInTester_whenDialogDismissed_taskFails() {
   }
 
   @Test
-  public void updateToNewRelease_whenSignInDialogCanceled_taskFails() {
+  public void updateIfNewReleaseAvailable_whenSignInDialogCanceled_taskFails() {
     when(mockSignInStorage.getSignInStatus()).thenReturn(false);
     Task signInTask = firebaseAppDistribution.updateIfNewReleaseAvailable();
 
@@ -429,7 +446,7 @@ public void signOutTester_setsSignInStatusFalse() {
   }
 
   @Test
-  public void updateToNewRelease_receiveProgressUpdateFromUpdateApp() {
+  public void updateIfNewReleaseAvailable_receiveProgressUpdateFromUpdateApp() {
     AppDistributionReleaseInternal newRelease = TEST_RELEASE_NEWER_AAB_INTERNAL.build();
     when(mockNewReleaseFetcher.checkForNewRelease()).thenReturn(Tasks.forResult(newRelease));
     UpdateTaskImpl mockTask = new UpdateTaskImpl();
@@ -455,6 +472,20 @@ public void updateToNewRelease_receiveProgressUpdateFromUpdateApp() {
     assertEquals(UpdateStatus.DOWNLOADING, progressEvents.get(0).getUpdateStatus());
   }
 
+  @Test
+  public void updateIfNewReleaseAvailable_fromABackgroundThread_showsSignInDialog()
+      throws InterruptedException, ExecutionException {
+    when(mockSignInStorage.getSignInStatus()).thenReturn(false);
+
+    ExecutorService executorService = Executors.newSingleThreadExecutor();
+    Future<UpdateTask> future =
+        executorService.submit(() -> firebaseAppDistribution.updateIfNewReleaseAvailable());
+    TestUtils.awaitAsyncOperations(executorService);
+
+    assertAlertDialogShown();
+    assertFalse(((UpdateTask) future.get()).isComplete());
+  }
+
   @Test
   public void updateIfNewReleaseAvailable_whenScreenRotates_signInConfirmationDialogReappears() {
     when(mockSignInStorage.getSignInStatus()).thenReturn(false);