WIP - Add notification default trigger to SDK

Author: lfkellogg

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,10 +14,16 @@
 
 package com.google.firebase.appdistribution;
 
+import android.app.Activity;
 import android.app.NotificationChannel;
+import android.content.Context;
 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;
@@ -181,6 +187,21 @@ public interface FirebaseAppDistribution {
    */
   void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshot);
 
+  /**
+   * Requests dynamic {@code POST_NOTIFICATIONS} permissions, if they are not already granted.
+   *
+   * <p>This *must* be called unconditionally, as part of initialization path, typically as a field
+   * initializer of an Activity or Fragment.This should only be called as an from {@link Activity#onCreate}.
+   *
+   * <p>This is only required if you want to use {@link showFeedbackNotification}, the device is
+   * running Android 13 or above, and the app does not already manage this permission separately.
+   *
+   * @param activity the activity being initialized
+   * @param <T>
+   */
+  @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.
@@ -204,6 +225,29 @@ public interface FirebaseAppDistribution {
    */
   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>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 platforms O 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. See {@link NotificationChannel#setImportance}. On platforms below O,
+   *     the importance will be translated into a comparable notification priority (see {@link
+   *     NotificationCompat.Builder#setPriority}).
+   */
+  void showFeedbackNotification(@NonNull CharSequence infoText, int importance);
+
   /** 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,11 @@
 
 package com.google.firebase.appdistribution.internal;
 
+import android.app.Activity;
+import android.content.Context;
 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 +97,19 @@ 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);
+  }
 }

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

@@ -15,7 +15,10 @@
 package com.google.firebase.appdistribution.internal;
 
 import android.app.Activity;
+import android.content.Context;
 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 +87,15 @@ 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) {}
+
   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

@@ -51,6 +51,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/FirebaseAppDistributionImpl.java

@@ -14,6 +14,7 @@
 
 package com.google.firebase.appdistribution.impl;
 
+import static android.content.pm.PackageManager.PERMISSION_GRANTED;
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.AUTHENTICATION_CANCELED;
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.AUTHENTICATION_FAILURE;
 import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.HOST_ACTIVITY_INTERRUPTED;
@@ -24,15 +25,32 @@
 import static com.google.firebase.appdistribution.impl.TaskUtils.safeSetTaskException;
 import static com.google.firebase.appdistribution.impl.TaskUtils.safeSetTaskResult;
 
+import android.Manifest;
 import android.app.Activity;
 import android.app.AlertDialog;
+import android.app.NotificationChannel;
+import android.app.NotificationChannelGroup;
+import android.app.NotificationManager;
+import android.app.PendingIntent;
 import android.content.Context;
 import android.content.Intent;
+import android.content.pm.ApplicationInfo;
+import android.content.pm.PackageManager;
 import android.net.Uri;
+import android.os.Build;
+import androidx.activity.result.ActivityResultCaller;
+import androidx.activity.result.ActivityResultLauncher;
+import androidx.activity.result.contract.ActivityResultContracts;
 import androidx.annotation.GuardedBy;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
+import androidx.annotation.RequiresPermission;
 import androidx.annotation.VisibleForTesting;
+import androidx.core.app.ActivityCompat;
+import androidx.core.app.NotificationCompat;
+import androidx.core.app.NotificationManagerCompat;
+import androidx.core.content.ContextCompat;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
@@ -55,6 +73,8 @@
 class FirebaseAppDistributionImpl implements FirebaseAppDistribution {
 
   private static final int UNKNOWN_RELEASE_FILE_SIZE = -1;
+  private static final String FEEDBACK_NOTIFICATION_CHANNEL_ID = "InAppFeedbackNotification";
+  private static final int FEEDBACK_NOTIFICATION_ID = 1;
 
   private final FirebaseApp firebaseApp;
   private final TesterSignInManager testerSignInManager;
@@ -340,7 +360,7 @@ public void startFeedback(@NonNull CharSequence infoText) {
 
   @Override
   public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {
-    startFeedback(firebaseApp.getApplicationContext().getText(infoTextResourceId), screenshotUri);
+    startFeedback(getText(infoTextResourceId), screenshotUri);
   }
 
   @Override
@@ -353,6 +373,120 @@ public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screensh
     doStartFeedback(infoText, screenshotUri);
   }
 
+  @Override
+  public void showFeedbackNotification(@NonNull int infoTextResourceId, int importance) {
+    showFeedbackNotification(getText(infoTextResourceId), importance);
+  }
+
+  @Override
+  public void showFeedbackNotification(@NonNull CharSequence infoText, int importance) {
+    Context context = firebaseApp.getApplicationContext();
+
+    // Create the NotificationChannel, but only on API 26+ because
+    // the NotificationChannel class is new and not in the support library
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+      NotificationChannel channel =
+          new NotificationChannel(
+              FEEDBACK_NOTIFICATION_CHANNEL_ID,
+              context.getString(R.string.feedback_notification_channel_name),
+              importance
+          );
+      channel.setDescription(context.getString(R.string.feedback_notification_channel_description));
+      context.getSystemService(NotificationManager.class).createNotificationChannel(channel);
+    }
+
+    if (ContextCompat.checkSelfPermission(context, Manifest.permission.POST_NOTIFICATIONS)
+        == PERMISSION_GRANTED) {
+      showNotification(importance);
+    } else {
+      LogWrapper.getInstance()
+          .w("Not showing notification because permission has not been granted.");
+    }
+  }
+
+  @RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)
+  private void showNotification(int importance) {
+    Context context = firebaseApp.getApplicationContext();
+    Intent intent = new Intent(context, TakeScreenshotAndStartFeedbackActivity.class);
+    intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
+    PendingIntent pendingIntent =
+        PendingIntent.getActivity(
+            context,
+            /* requestCode = */ 0,
+            intent,
+            PendingIntent.FLAG_IMMUTABLE);
+    ApplicationInfo applicationInfo = context.getApplicationInfo();
+    PackageManager packageManager = context.getPackageManager();
+    CharSequence appLabel = packageManager.getApplicationLabel(applicationInfo);
+    NotificationCompat.Builder builder =
+        new NotificationCompat.Builder(context, FEEDBACK_NOTIFICATION_CHANNEL_ID)
+            .setSmallIcon(R.mipmap.test_adaptive_icon) // TODO: update to an appropriate icon
+            .setContentTitle(context.getString(R.string.feedback_notification_title))
+            .setContentText(context.getString(R.string.feedback_notification_text, appLabel))
+            .setPriority(convertImportanceToPriority(importance))
+            .setContentIntent(pendingIntent);
+    NotificationManagerCompat notificationManager = NotificationManagerCompat.from(context);
+    LogWrapper.getInstance().i("Showing feedback notification.");
+    notificationManager.notify(FEEDBACK_NOTIFICATION_ID, builder.build());
+  }
+
+  private int convertImportanceToPriority(int importance) {
+    switch (importance) {
+      case NotificationManagerCompat.IMPORTANCE_MIN:
+        return NotificationCompat.PRIORITY_MIN;
+      case NotificationManagerCompat.IMPORTANCE_LOW:
+        return NotificationCompat.PRIORITY_LOW;
+      case NotificationManagerCompat.IMPORTANCE_HIGH:
+        return NotificationCompat.PRIORITY_HIGH;
+      case NotificationManagerCompat.IMPORTANCE_MAX:
+        return NotificationCompat.PRIORITY_MAX;
+      case NotificationManagerCompat.IMPORTANCE_UNSPECIFIED:
+      case NotificationManagerCompat.IMPORTANCE_NONE:
+      case NotificationManagerCompat.IMPORTANCE_DEFAULT:
+      default:
+        return NotificationCompat.PRIORITY_DEFAULT;
+    }
+  }
+
+  @Override
+  @RequiresApi(Build.VERSION_CODES.TIRAMISU)
+  public <T extends Activity & ActivityResultCaller> void requestNotificationPermissions(
+      @NonNull T activity) {
+    if (ContextCompat.checkSelfPermission(activity, Manifest.permission.POST_NOTIFICATIONS)
+        == PERMISSION_GRANTED) {
+      LogWrapper.getInstance().i("Already has permission to show notifications.");
+      return;
+    }
+
+    ActivityResultLauncher<String> launcher = activity.registerForActivityResult(
+        new ActivityResultContracts.RequestPermission(), isGranted -> {
+          if (!isGranted) {
+            LogWrapper.getInstance().w("Permission to show notifications was denied.");
+            // Ideally we would show a message indicating the impact of not enabling the permission,
+            // but there's no way to know if they've permanently denied the permission, and we don't
+            // want to show them a message after each time we try to post a notification.
+          }
+        });
+
+    // TODO: should we bother showing permission rationale?
+    if (ActivityCompat.shouldShowRequestPermissionRationale(activity,
+        Manifest.permission.POST_NOTIFICATIONS)) {
+      LogWrapper.getInstance().i("Showing customer rationale for requesting permission.");
+      new AlertDialog.Builder(activity)
+          .setMessage(R.string.notification_permission_rationale)
+          .setPositiveButton(R.string.notification_permission_yes_button, (a, b) -> {
+            LogWrapper.getInstance().i("Launching request for permission.");
+            launcher.launch(Manifest.permission.POST_NOTIFICATIONS);
+          })
+          .setNegativeButton(R.string.notification_permission_no_button,
+              (a, b) -> LogWrapper.getInstance().i("Tester declined to enable notifications."))
+          .show();
+    } else {
+      LogWrapper.getInstance().i("Launching request for permission without rationale.");
+      launcher.launch(Manifest.permission.POST_NOTIFICATIONS);
+    }
+  }
+
   private void doStartFeedback(CharSequence infoText, @Nullable Uri screenshotUri) {
     testerSignInManager
         .signInTester()
@@ -569,4 +703,8 @@ private boolean awaitingUpdateDialogConfirmation() {
         && !showUpdateDialogTask.getTask().isComplete()
         && remakeUpdateConfirmationDialog);
   }
+
+  private CharSequence getText(int resourceId) {
+    return firebaseApp.getApplicationContext().getText(resourceId);
+  }
 }