Add notification default trigger to in-app feedback

Author: lfkellogg

firebase-appdistribution-api/api.txt

@@ -17,6 +17,9 @@ package com.google.firebase.appdistribution {
     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 boolean isTesterSignedIn();
+    method @RequiresApi(android.os.Build.VERSION_CODES.TIRAMISU) public <T extends android.app.Activity & androidx.activity.result.ActivityResultCaller> void requestNotificationPermissions(@NonNull T);
+    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/firebase-appdistribution-api.gradle

@@ -17,11 +17,11 @@ plugins {
 }
 
 android {
-    compileSdkVersion project.targetSdkVersion
+    compileSdkVersion 33
 
     defaultConfig {
         minSdkVersion 16
-        targetSdkVersion project.targetSdkVersion
+        targetSdkVersion 33
         multiDexEnabled true
         versionName version
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -41,6 +41,7 @@ dependencies {
     implementation 'org.jetbrains:annotations:15.0'
     implementation project(':firebase-components')
     implementation project(':firebase-common')
+    implementation 'androidx.activity:activity:1.5.1'
     implementation 'com.google.android.gms:play-services-tasks:18.0.1'
     testImplementation 'junit:junit:4.13.2'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"

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

@@ -14,9 +14,15 @@
 
 package com.google.firebase.appdistribution;
 
+import android.app.Activity;
+import android.app.NotificationChannel;
 import android.net.Uri;
+import android.os.Build;
+import androidx.activity.result.ActivityResultCaller;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
+import androidx.core.app.NotificationCompat;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appdistribution.internal.FirebaseAppDistributionProxy;
@@ -179,6 +185,94 @@ public interface FirebaseAppDistribution {
    */
   void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshot);
 
+  /**
+   * Requests the {@code POST_NOTIFICATIONS} permission, if it is not already granted.
+   *
+   * <p>This <b>must</b> be called from {@link Activity#onCreate}.
+   *
+   * <p>Android 13 (API level 33) and above support a <a
+   * href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime
+   * permission for sending notifications</a>: {@code POST_NOTIFICATIONS}. If you target Android 13
+   * or higher and do not want to <a
+   * href="https://developer.android.com/training/permissions/requesting">request the permission</a>
+   * on your own, call this method to request the permission. This is helpful if you use the {@link
+   * #updateIfNewReleaseAvailable} method, which shows notifications.
+   *
+   * @param activity the activity being initialized (this method <b>must</b> be called from this
+   *     activity's {@link Activity#onCreate})
+   */
+  @RequiresApi(Build.VERSION_CODES.TIRAMISU)
+  <T extends Activity & ActivityResultCaller> void requestNotificationPermissions(
+      @NonNull T activity);
+
+  /**
+   * 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, his method requires the <a
+   * href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime
+   * permission for sending notifications</a>: {@code POST_NOTIFICATIONS}. Either <a
+   * href="https://developer.android.com/training/permissions/requesting">request the permission</a>
+   * on your own or call {@link #requestNotificationPermissions}.
+   *
+   * <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(@NonNull 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, his method requires the <a
+   * href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime
+   * permission for sending notifications</a>: {@code POST_NOTIFICATIONS}. Either <a
+   * href="https://developer.android.com/training/permissions/requesting">request the permission</a>
+   * on your own or call {@link #requestNotificationPermissions}.
+   *
+   * <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 hideFeedbackNotification();
+
   /** Gets the singleton {@link FirebaseAppDistribution} instance. */
   @NonNull
   static FirebaseAppDistribution getInstance() {

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

@@ -14,7 +14,9 @@
 
 package com.google.firebase.appdistribution.internal;
 
+import android.app.Activity;
 import android.net.Uri;
+import androidx.activity.result.ActivityResultCaller;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.android.gms.tasks.Task;
@@ -93,4 +95,25 @@ public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screens
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {
     delegate.startFeedback(infoText, screenshotUri);
   }
+
+  @Override
+  public void showFeedbackNotification(@NonNull int infoTextResourceId, int importance) {
+    delegate.showFeedbackNotification(infoTextResourceId, importance);
+  }
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {
+    delegate.showFeedbackNotification(infoText, importance);
+  }
+
+  @Override
+  public <T extends Activity & ActivityResultCaller> void requestNotificationPermissions(
+      @NonNull T activity) {
+    delegate.requestNotificationPermissions(activity);
+  }
+
+  @Override
+  public void hideFeedbackNotification() {
+    delegate.hideFeedbackNotification();
+  }
 }

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

@@ -16,6 +16,7 @@
 
 import android.app.Activity;
 import android.net.Uri;
+import androidx.activity.result.ActivityResultCaller;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.android.gms.tasks.Continuation;
@@ -84,6 +85,19 @@ public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screens
   @Override
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {}
 
+  @Override
+  public void showFeedbackNotification(@NonNull int infoTextResourceId, int importance) {}
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {}
+
+  @Override
+  public <T extends Activity & ActivityResultCaller> void requestNotificationPermissions(
+      @NonNull T activity) {}
+
+  @Override
+  public void hideFeedbackNotification() {}
+
   private static <TResult> Task<TResult> getNotImplementedTask() {
     return Tasks.forException(
         new FirebaseAppDistributionException(

firebase-appdistribution/firebase-appdistribution.gradle

@@ -21,11 +21,11 @@ firebaseLibrary {
 }
 
 android {
-    compileSdkVersion project.targetSdkVersion
+    compileSdkVersion 33
 
     defaultConfig {
         minSdkVersion 16
-        targetSdkVersion project.targetSdkVersion
+        targetSdkVersion 33
         multiDexEnabled true
         versionName version
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

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"