Add notification default trigger to in-app feedback

Author: lfkellogg

firebase-appdistribution-api/api.txt

@@ -16,7 +16,10 @@ package com.google.firebase.appdistribution {
   public interface FirebaseAppDistribution {
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.appdistribution.AppDistributionRelease> checkForNewRelease();
     method @NonNull public static com.google.firebase.appdistribution.FirebaseAppDistribution getInstance();
+    method public void cancelFeedbackNotification();
     method public boolean isTesterSignedIn();
+    method public void showFeedbackNotification(@NonNull int, int);
+    method public void showFeedbackNotification(@NonNull CharSequence, int);
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> signInTester();
     method public void signOutTester();
     method public void startFeedback(int);

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

@@ -14,9 +14,12 @@
 
 package com.google.firebase.appdistribution;
 
+import android.app.Activity;
+import android.app.NotificationChannel;
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.core.app.NotificationCompat;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appdistribution.internal.FirebaseAppDistributionProxy;
@@ -159,7 +162,7 @@ public interface FirebaseAppDistribution {
    * @param screenshot URI to a bitmap containing a screenshot that will be included with the
    *     report, or null to not include a screenshot
    */
-  void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshot);
+  void startFeedback(int infoTextResourceId, @Nullable Uri screenshot);
 
   /**
    * Starts an activity to collect and submit feedback from the tester, along with the given
@@ -179,6 +182,76 @@ public interface FirebaseAppDistribution {
    */
   void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshot);
 
+  /**
+   * Displays a notification that, when tapped, will take a screenshot of the current activity, then
+   * start a new activity to collect and submit feedback from the tester along with the screenshot.
+   *
+   * <p>On Android 13 and above, this method requires the <a
+   * href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime
+   * permission for sending notifications</a>: {@code POST_NOTIFICATIONS}. If your app targets
+   * Android 13 (API level 33) or above, you should <a
+   * href="https://developer.android.com/training/permissions/requesting">request the
+   * permission</a>.
+   *
+   * <p>When the notification is tapped:
+   *
+   * <ol>
+   *   <li>If the app is open, take a screenshot of the current activity
+   *   <li>If tester is not signed in, presents the tester with a Google Sign-in UI
+   *   <li>Starts a full screen activity for the tester to compose and submit the feedback
+   * </ol>
+   *
+   * <p>On Android 8 and above, the notification will be created in its own notification channel.
+   *
+   * @param infoTextResourceId string resource ID of text to display to the tester before collecting
+   *     feedback data (e.g. Terms and Conditions)
+   * @param importance the amount the user should be interrupted by notifications from the feedback
+   *     notification channel. Once the channel's importance is set it cannot be changed except by
+   *     the user. See {@link NotificationChannel#setImportance}. On platforms below Android 8, the
+   *     importance will be translated into a comparable notification priority (see {@link
+   *     NotificationCompat.Builder#setPriority}).
+   */
+  void showFeedbackNotification(int infoTextResourceId, int importance);
+
+  /**
+   * Displays a notification that, when tapped, will take a screenshot of the current activity, then
+   * start a new activity to collect and submit feedback from the tester along with the screenshot.
+   *
+   * <p>On Android 13 and above, this method requires the <a
+   * href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime
+   * permission for sending notifications</a>: {@code POST_NOTIFICATIONS}. If your app targets
+   * Android 13 (API level 33) or above, you should <a
+   * href="https://developer.android.com/training/permissions/requesting">request the
+   * permission</a>.
+   *
+   * <p>When the notification is tapped:
+   *
+   * <ol>
+   *   <li>If the app is open, take a screenshot of the current activity
+   *   <li>If tester is not signed in, presents the tester with a Google Sign-in UI
+   *   <li>Starts a full screen activity for the tester to compose and submit the feedback
+   * </ol>
+   *
+   * <p>On Android 8 and above, the notification will be created in its own notification channel.
+   *
+   * @param infoText text to display to the tester before collecting feedback data (e.g. Terms and
+   *     Conditions)
+   * @param importance the amount the user should be interrupted by notifications from the feedback
+   *     notification channel. Once the channel's importance is set it cannot be changed except by
+   *     the user. See {@link NotificationChannel#setImportance}. On platforms below Android 8, the
+   *     importance will be translated into a comparable notification priority (see {@link
+   *     NotificationCompat.Builder#setPriority}).
+   */
+  void showFeedbackNotification(@NonNull CharSequence infoText, int importance);
+
+  /**
+   * Hides the notification shown with {@link #showFeedbackNotification}.
+   *
+   * <p>This should be called in the {@link Activity#onDestroy} of the activity that showed the
+   * notification.
+   */
+  void cancelFeedbackNotification();
+
   /** Gets the singleton {@link FirebaseAppDistribution} instance. */
   @NonNull
   static FirebaseAppDistribution getInstance() {

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/internal/FirebaseAppDistributionProxy.java

@@ -85,12 +85,27 @@ public void startFeedback(@NonNull CharSequence infoText) {
   }
 
   @Override
-  public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {
+  public void startFeedback(int infoTextResourceId, @Nullable Uri screenshotUri) {
     delegate.startFeedback(infoTextResourceId, screenshotUri);
   }
 
   @Override
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {
     delegate.startFeedback(infoText, screenshotUri);
   }
+
+  @Override
+  public void showFeedbackNotification(int infoTextResourceId, int importance) {
+    delegate.showFeedbackNotification(infoTextResourceId, importance);
+  }
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {
+    delegate.showFeedbackNotification(infoText, importance);
+  }
+
+  @Override
+  public void cancelFeedbackNotification() {
+    delegate.cancelFeedbackNotification();
+  }
 }

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/internal/FirebaseAppDistributionStub.java

@@ -79,11 +79,20 @@ public void startFeedback(int infoTextResourceId) {}
   public void startFeedback(@NonNull CharSequence infoText) {}
 
   @Override
-  public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {}
+  public void startFeedback(int infoTextResourceId, @Nullable Uri screenshotUri) {}
 
   @Override
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {}
 
+  @Override
+  public void showFeedbackNotification(int infoTextResourceId, int importance) {}
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {}
+
+  @Override
+  public void cancelFeedbackNotification() {}
+
   private static <TResult> Task<TResult> getNotImplementedTask() {
     return Tasks.forException(
         new FirebaseAppDistributionException(

firebase-appdistribution/src/main/AndroidManifest.xml

@@ -17,8 +17,9 @@
     package="com.google.firebase.appdistribution.impl">
 
     <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 
     <application>
@@ -51,6 +52,10 @@
             android:exported="false"
             android:theme="@style/Theme.AppCompat.Light.NoActionBar" />
 
+        <activity
+            android:name=".TakeScreenshotAndStartFeedbackActivity"
+            android:exported="false" />
+
         <provider
             android:name="com.google.firebase.appdistribution.impl.FirebaseAppDistributionFileProvider"
             android:authorities="${applicationId}.FirebaseAppDistributionFileProvider"

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/impl/ApkUpdater.java

@@ -307,7 +307,7 @@ private void postUpdateProgress(
               .build());
     }
     if (showNotification) {
-      appDistributionNotificationsManager.updateNotification(
+      appDistributionNotificationsManager.showAppUpdateNotification(
           totalBytes, downloadedBytes, stringResourceId);
     }
   }

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/impl/FirebaseAppDistributionImpl.java

@@ -18,9 +18,6 @@
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.AUTHENTICATION_FAILURE;
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.HOST_ACTIVITY_INTERRUPTED;
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.UPDATE_NOT_AVAILABLE;
-import static com.google.firebase.appdistribution.impl.FeedbackActivity.INFO_TEXT_EXTRA_KEY;
-import static com.google.firebase.appdistribution.impl.FeedbackActivity.RELEASE_NAME_EXTRA_KEY;
-import static com.google.firebase.appdistribution.impl.FeedbackActivity.SCREENSHOT_URI_EXTRA_KEY;
 import static com.google.firebase.appdistribution.impl.TaskUtils.safeSetTaskException;
 import static com.google.firebase.appdistribution.impl.TaskUtils.safeSetTaskResult;
 
@@ -66,6 +63,7 @@ class FirebaseAppDistributionImpl implements FirebaseAppDistribution {
   private final ReleaseIdentifier releaseIdentifier;
   private final ScreenshotTaker screenshotTaker;
   private final Executor taskExecutor;
+  private final FirebaseAppDistributionNotificationsManager notificationsManager;
 
   private final Object updateIfNewReleaseTaskLock = new Object();
 
@@ -81,13 +79,11 @@ class FirebaseAppDistributionImpl implements FirebaseAppDistribution {
   private AlertDialog updateConfirmationDialog;
   private AlertDialog signInConfirmationDialog;
   @Nullable private Activity dialogHostActivity = null;
-
   private boolean remakeSignInConfirmationDialog = false;
   private boolean remakeUpdateConfirmationDialog = false;
-
   private TaskCompletionSource<Void> showSignInDialogTask = null;
   private TaskCompletionSource<Void> showUpdateDialogTask = null;
-  private AtomicBoolean feedbackInProgress = new AtomicBoolean(false);
+  private final AtomicBoolean feedbackInProgress = new AtomicBoolean(false);
 
   @VisibleForTesting
   FirebaseAppDistributionImpl(
@@ -111,6 +107,8 @@ class FirebaseAppDistributionImpl implements FirebaseAppDistribution {
     this.lifecycleNotifier = lifecycleNotifier;
     this.screenshotTaker = screenshotTaker;
     this.taskExecutor = taskExecutor;
+    this.notificationsManager =
+        new FirebaseAppDistributionNotificationsManager(firebaseApp.getApplicationContext());
     lifecycleNotifier.addOnActivityDestroyedListener(this::onActivityDestroyed);
     lifecycleNotifier.addOnActivityPausedListener(this::onActivityPaused);
     lifecycleNotifier.addOnActivityResumedListener(this::onActivityResumed);
@@ -339,8 +337,8 @@ public void startFeedback(@NonNull CharSequence infoText) {
   }
 
   @Override
-  public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {
-    startFeedback(firebaseApp.getApplicationContext().getText(infoTextResourceId), screenshotUri);
+  public void startFeedback(int infoTextResourceId, @Nullable Uri screenshotUri) {
+    startFeedback(getText(infoTextResourceId), screenshotUri);
   }
 
   @Override
@@ -353,6 +351,21 @@ public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screensh
     doStartFeedback(infoText, screenshotUri);
   }
 
+  @Override
+  public void showFeedbackNotification(int infoTextResourceId, int importance) {
+    showFeedbackNotification(getText(infoTextResourceId), importance);
+  }
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {
+    notificationsManager.showFeedbackNotification(infoText, importance);
+  }
+
+  @Override
+  public void cancelFeedbackNotification() {
+    notificationsManager.cancelFeedbackNotification();
+  }
+
   private void doStartFeedback(CharSequence infoText, @Nullable Uri screenshotUri) {
     testerSignInManager
         .signInTester()
@@ -378,10 +391,10 @@ private Task<Void> launchFeedbackActivity(
         activity -> {
           LogWrapper.getInstance().i("Launching feedback activity");
           Intent intent = new Intent(activity, FeedbackActivity.class);
-          intent.putExtra(RELEASE_NAME_EXTRA_KEY, releaseName);
-          intent.putExtra(INFO_TEXT_EXTRA_KEY, infoText);
+          intent.putExtra(FeedbackActivity.RELEASE_NAME_EXTRA_KEY, releaseName);
+          intent.putExtra(FeedbackActivity.INFO_TEXT_EXTRA_KEY, infoText);
           if (screenshotUri != null) {
-            intent.putExtra(SCREENSHOT_URI_EXTRA_KEY, screenshotUri.toString());
+            intent.putExtra(FeedbackActivity.SCREENSHOT_URI_EXTRA_KEY, screenshotUri.toString());
           }
           activity.startActivity(intent);
         });
@@ -569,4 +582,8 @@ private boolean awaitingUpdateDialogConfirmation() {
         && !showUpdateDialogTask.getTask().isComplete()
         && remakeUpdateConfirmationDialog);
   }
+
+  private CharSequence getText(int resourceId) {
+    return firebaseApp.getApplicationContext().getText(resourceId);
+  }
 }