Merge branch 'master' into rl.changelogup0089

Author: rlazo

build.gradle

@@ -41,6 +41,7 @@ buildscript {
         classpath 'gradle.plugin.com.github.sherter.google-java-format:google-java-format-gradle-plugin:0.9'
         classpath 'com.google.gms:google-services:4.3.15'
         classpath "com.ncorti.ktfmt.gradle:plugin:0.11.0"
+        classpath 'com.google.firebase:firebase-appdistribution-gradle:3.0.2'
     }
 }
 

firebase-appdistribution-api/CHANGELOG.md

@@ -1,4 +1,8 @@
 # Unreleased
+* [feature] Adds support for in-app tester feedback. To learn more, see
+  [Collect feedback from testers](/docs/app-distribution/collect-feedback-from-testers?platform=android).
+* [fixed] Fixed a bug where only the last listener added to an `UpdateTask` using
+  `addOnProgressListener()` would receive updates.
 
 # 16.0.0-beta05
 * [unchanged] Updated to accommodate the release of the updated

firebase-appdistribution-api/api.txt

@@ -14,11 +14,18 @@ package com.google.firebase.appdistribution {
   }
 
   public interface FirebaseAppDistribution {
+    method public void cancelFeedbackNotification();
     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 public void showFeedbackNotification(@StringRes int, @NonNull com.google.firebase.appdistribution.InterruptionLevel);
+    method public void showFeedbackNotification(@NonNull CharSequence, @NonNull com.google.firebase.appdistribution.InterruptionLevel);
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> signInTester();
     method public void signOutTester();
+    method public void startFeedback(@StringRes int);
+    method public void startFeedback(@NonNull CharSequence);
+    method public void startFeedback(@StringRes int, @Nullable android.net.Uri);
+    method public void startFeedback(@NonNull CharSequence, @Nullable android.net.Uri);
     method @NonNull public com.google.firebase.appdistribution.UpdateTask updateApp();
     method @NonNull public com.google.firebase.appdistribution.UpdateTask updateIfNewReleaseAvailable();
   }
@@ -42,6 +49,14 @@ package com.google.firebase.appdistribution {
     enum_constant public static final com.google.firebase.appdistribution.FirebaseAppDistributionException.Status UPDATE_NOT_AVAILABLE;
   }
 
+  public enum InterruptionLevel {
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel DEFAULT;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel HIGH;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel LOW;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel MAX;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel MIN;
+  }
+
   public interface OnProgressListener {
     method public void onProgressUpdate(@NonNull com.google.firebase.appdistribution.UpdateProgress);
   }

firebase-appdistribution-api/firebase-appdistribution-api.gradle

@@ -38,7 +38,6 @@ android {
 }
 
 dependencies {
-    implementation 'org.jetbrains:annotations:15.0'
     implementation project(':firebase-components')
     implementation project(':firebase-common')
     implementation 'com.google.android.gms:play-services-tasks:18.0.1'

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

@@ -14,7 +14,10 @@
 
 package com.google.firebase.appdistribution;
 
+import android.net.Uri;
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appdistribution.internal.FirebaseAppDistributionProxy;
@@ -32,6 +35,7 @@
  * <p>Call {@link #getInstance()} to get the singleton instance of {@link FirebaseAppDistribution}.
  */
 public interface FirebaseAppDistribution {
+
   /**
    * Updates the app to the newest release, if one is available.
    *
@@ -109,6 +113,142 @@ public interface FirebaseAppDistribution {
   @NonNull
   UpdateTask updateApp();
 
+  /**
+   * Takes a screenshot, and starts an activity to collect and submit feedback from the tester.
+   *
+   * <p>Performs the following actions:
+   *
+   * <ol>
+   *   <li>Takes 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>
+   *
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
+   *     they submit feedback. If you’re a customer who would like to provide notice to your testers
+   *     about collection and processing of their feedback data, you can use this text to provide
+   *     such notice.
+   */
+  void startFeedback(@StringRes int additionalFormText);
+
+  /**
+   * Takes a screenshot, and starts an activity to collect and submit feedback from the tester.
+   *
+   * <p>Performs the following actions:
+   *
+   * <ol>
+   *   <li>Takes 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>
+   *
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
+   */
+  void startFeedback(@NonNull CharSequence additionalFormText);
+
+  /**
+   * Starts an activity to collect and submit feedback from the tester, along with the given
+   * screenshot.
+   *
+   * <p>Performs the following actions:
+   *
+   * <ol>
+   *   <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>
+   *
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
+   *     they submit feedback. If you’re a customer who would like to provide notice to your testers
+   *     about collection and processing of their feedback data, you can use this text to provide
+   *     such notice.
+   * @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(@StringRes int additionalFormText, @Nullable Uri screenshot);
+
+  /**
+   * Starts an activity to collect and submit feedback from the tester, along with the given
+   * screenshot.
+   *
+   * <p>Performs the following actions:
+   *
+   * <ol>
+   *   <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>
+   *
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
+   * @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 CharSequence additionalFormText, @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>
+   *
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
+   *     they submit feedback. If you’re a customer who would like to provide notice to your testers
+   *     about collection and processing of their feedback data, you can use this text to provide
+   *     such notice.
+   * @param interruptionLevel the level of interruption for the feedback notification. On platforms
+   *     below Android 8, this corresponds to a notification channel importance and once set cannot
+   *     be changed except by the user.
+   */
+  void showFeedbackNotification(
+      @StringRes int additionalFormText, @NonNull InterruptionLevel interruptionLevel);
+
+  /**
+   * 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>
+   *
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
+   * @param interruptionLevel the level of interruption for the feedback notification. On platforms
+   *     below Android 8, this corresponds to a notification channel importance and once set cannot
+   *     be changed except by the user.
+   */
+  void showFeedbackNotification(
+      @NonNull CharSequence additionalFormText, @NonNull InterruptionLevel interruptionLevel);
+
+  /** Hides the notification shown with {@link #showFeedbackNotification}. */
+  void cancelFeedbackNotification();
+
   /** Gets the singleton {@link FirebaseAppDistribution} instance. */
   @NonNull
   static FirebaseAppDistribution getInstance() {

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

@@ -0,0 +1,81 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.appdistribution;
+
+import android.app.NotificationManager;
+import androidx.core.app.NotificationCompat;
+
+/** An enum specifying the level of interruption of a notification when it is created. */
+public enum InterruptionLevel {
+
+  /**
+   * Minimum interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_MIN} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_MIN} on older platforms.
+   */
+  MIN(NotificationManager.IMPORTANCE_MIN, NotificationCompat.PRIORITY_MIN),
+
+  /**
+   * Low interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_LOW} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_LOW} on older platforms.
+   */
+  LOW(NotificationManager.IMPORTANCE_LOW, NotificationCompat.PRIORITY_LOW),
+
+  /**
+   * Default interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_DEFAULT} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_DEFAULT} on older platforms.
+   */
+  DEFAULT(NotificationManager.IMPORTANCE_DEFAULT, NotificationCompat.PRIORITY_DEFAULT),
+
+  /**
+   * High interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_HIGH} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_HIGH} on older platforms.
+   */
+  HIGH(NotificationManager.IMPORTANCE_HIGH, NotificationCompat.PRIORITY_HIGH),
+
+  /**
+   * Maximum interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_HIGH} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_MAX} on older platforms.
+   */
+  MAX(NotificationManager.IMPORTANCE_HIGH, NotificationCompat.PRIORITY_MAX);
+
+  /**
+   * The notification channel importance corresponding to this interruption level on Android O+.
+   *
+   * @hide
+   */
+  public final int channelImportance;
+
+  /**
+   * The notification priority corresponding to this interruption level on older platforms.
+   *
+   * @hide
+   */
+  public final int notificationPriority;
+
+  InterruptionLevel(int channelImportance, int notificationPriority) {
+    this.channelImportance = channelImportance;
+    this.notificationPriority = notificationPriority;
+  }
+}

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

@@ -14,11 +14,15 @@
 
 package com.google.firebase.appdistribution.internal;
 
+import android.net.Uri;
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.appdistribution.AppDistributionRelease;
 import com.google.firebase.appdistribution.FirebaseAppDistribution;
 import com.google.firebase.appdistribution.FirebaseAppDistributionException;
+import com.google.firebase.appdistribution.InterruptionLevel;
 import com.google.firebase.appdistribution.UpdateTask;
 import com.google.firebase.inject.Provider;
 
@@ -71,4 +75,41 @@ public synchronized Task<AppDistributionRelease> checkForNewRelease() {
   public UpdateTask updateApp() {
     return delegate.updateApp();
   }
+
+  @Override
+  public void startFeedback(@StringRes int additionalFormText) {
+    delegate.startFeedback(additionalFormText);
+  }
+
+  @Override
+  public void startFeedback(@NonNull CharSequence additionalFormText) {
+    delegate.startFeedback(additionalFormText);
+  }
+
+  @Override
+  public void startFeedback(@StringRes int additionalFormText, @Nullable Uri screenshotUri) {
+    delegate.startFeedback(additionalFormText, screenshotUri);
+  }
+
+  @Override
+  public void startFeedback(@NonNull CharSequence additionalFormText, @Nullable Uri screenshotUri) {
+    delegate.startFeedback(additionalFormText, screenshotUri);
+  }
+
+  @Override
+  public void showFeedbackNotification(
+      @StringRes int additionalFormText, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(additionalFormText, interruptionLevel);
+  }
+
+  @Override
+  public void showFeedbackNotification(
+      @NonNull CharSequence additionalFormText, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(additionalFormText, interruptionLevel);
+  }
+
+  @Override
+  public void cancelFeedbackNotification() {
+    delegate.cancelFeedbackNotification();
+  }
 }