Address API feedback

Change data classes to public final classes
Add UpdateTask class
Update FirebaseAppDistributionException to use an enum instead of an IntDef

Author: Rachel Prince

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/AppDistributionRelease.java

@@ -17,23 +17,44 @@
 import androidx.annotation.NonNull;
 
 /**
- * Interface for AppDistributonRelease object returned by checkForUpdate() and
+ * Data class for AppDistributionRelease object returned by checkForUpdate() and
  * updateToLatestRelease()
  */
-public interface AppDistributionRelease {
+public final class AppDistributionRelease {
+  private final String displayVersion;
+  private final String buildVersion;
+  private final String releaseNotes;
+  private final BinaryType binaryType;
+
+  AppDistributionRelease(
+      String displayVersion, String buildVersion, String releaseNotes, BinaryType binaryType) {
+    this.displayVersion = displayVersion;
+    this.buildVersion = buildVersion;
+    this.releaseNotes = releaseNotes;
+    this.binaryType = binaryType;
+  }
+
   /** The short bundle version of this build (example 1.0.0) */
   @NonNull
-  public String getDisplayVersion();
+  public String getDisplayVersion() {
+    return displayVersion;
+  }
 
   /** The bundle version of this build (example: 123) */
   @NonNull
-  public String getBuildVersion();
+  public String getBuildVersion() {
+    return buildVersion;
+  }
 
   /** The release notes for this build */
   @NonNull
-  public String getReleaseNotes();
+  public String getReleaseNotes() {
+    return releaseNotes;
+  }
 
   /** The binary type for this build */
   @NonNull
-  public BinaryType getBinaryType();
+  public BinaryType getBinaryType() {
+    return binaryType;
+  }
 }

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

@@ -18,14 +18,13 @@
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
-import org.jetbrains.annotations.Nullable;
 
 public class FirebaseAppDistribution {
 
   private final FirebaseApp firebaseApp;
 
   /** Constructor for FirebaseAppDistribution */
-  public FirebaseAppDistribution(@NonNull FirebaseApp firebaseApp) {
+  FirebaseAppDistribution(@NonNull FirebaseApp firebaseApp) {
     this.firebaseApp = firebaseApp;
   }
 
@@ -63,12 +62,12 @@ public Task<AppDistributionRelease> checkForUpdate() {
    * starts an installation If the latest release is an AAB, directs the tester to the Play app to
    * complete the download and installation.
    *
-   * @throws an UPDATE_NOT_AVAIALBLE exception if no new release is cached from checkForUpdate
-   * @param updateProgressListener a callback function invoked as the update progresses
+   * @throws an {@link Status.UPDATE_NOT_AVAILABLE_ERROR} exception if no new release is cached from
+   *     checkForUpdate
    */
   @NonNull
-  public Task<Void> updateApp(@Nullable UpdateProgressListener updateProgressListener) {
-    return Tasks.forResult(null);
+  public UpdateTask updateApp() {
+    return (UpdateTask) Tasks.forResult(new UpdateState(0, 0, UpdateStatus.PENDING));
   }
 
   /** Signs in the App Distribution tester. Presents the tester with a Google sign in UI */

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionException.java

@@ -14,69 +14,63 @@
 
 package com.google.firebase.appdistribution;
 
-import androidx.annotation.IntDef;
 import androidx.annotation.NonNull;
 import com.google.firebase.FirebaseException;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 
 /** Possible exceptions thrown in FirebaseAppDistribution */
-public abstract class FirebaseAppDistributionException extends FirebaseException {
-  /** Unknown error. */
-  public static final int UNKNOWN_ERROR = 1;
+public class FirebaseAppDistributionException extends FirebaseException {
+  public enum Status {
+    /** Unknown error. */
+    UNKNOWN,
 
-  /** Authentication failed */
-  public static final int AUTHENTICATION_FAILURE_ERROR = 2;
+    /** Authentication failed */
+    AUTHENTICATION_FAILURE,
 
-  /** Authentication canceled */
-  public static final int AUTHENTICATION_CANCELED_ERROR = 3;
+    /** Authentication canceled */
+    AUTHENTICATION_CANCELED,
 
-  /** No Network available to make requests or the request timed out */
-  public static final int NETWORK_FAILURE_ERROR = 4;
+    /** No Network available to make requests or the request timed out */
+    NETWORK_FAILURE,
 
-  /** Download failed */
-  public static final int DOWNLOAD_FAILURE_ERROR = 5;
+    /** Download failed */
+    DOWNLOAD_FAILURE,
 
-  /** Installation failed */
-  public static final int INSTALLATION_FAILURE_ERROR = 6;
+    /** Installation failed */
+    INSTALLATION_FAILURE,
 
-  /** Installation canceled */
-  public static final int INSTALLATION_CANCELED_ERROR = 7;
+    /** Installation canceled */
+    INSTALLATION_CANCELED,
 
-  /** Update not available for the current tester and app */
-  public static final int UPDATE_NOT_AVAILABLE_ERROR = 8;
+    /** Update not available for the current tester and app */
+    UPDATE_NOT_AVAILABLE,
 
-  /** Installation failed due to signature mismatch */
-  public static final int INSTALLATION_FAILURE_SIGNATURE_MISMATCH_ERROR = 9;
+    /** Installation failed due to signature mismatch */
+    INSTALLATION_FAILURE_SIGNATURE_MISMATCH,
 
-  /** App is in production */
-  public static final int APP_RUNNING_IN_PRODUCTION_ERROR = 10;
+    /** App is in production */
+    APP_RUNNING_IN_PRODUCTION,
 
-  /** Download URL for release expired */
-  public static final int RELEASE_URL_EXPIRED_ERROR = 11;
+    /** Download URL for release expired */
+    RELEASE_URL_EXPIRED,
+  }
 
-  /** Get error code */
-  public abstract int getCode();
+  @NonNull private final Status status;
+  @NonNull private final AppDistributionRelease release;
+
+  FirebaseAppDistributionException(
+      @NonNull Status status, @NonNull AppDistributionRelease release) {
+    this.status = status;
+    this.release = release;
+  }
 
   /** Get cached release when error was thrown */
   @NonNull
-  public abstract AppDistributionRelease getRelease();
-
-  /** The set of FirebaseAppDistribution status codes. */
-  @IntDef({
-    FirebaseAppDistributionException.UNKNOWN_ERROR,
-    FirebaseAppDistributionException.AUTHENTICATION_FAILURE_ERROR,
-    FirebaseAppDistributionException.AUTHENTICATION_CANCELED_ERROR,
-    FirebaseAppDistributionException.NETWORK_FAILURE_ERROR,
-    FirebaseAppDistributionException.DOWNLOAD_FAILURE_ERROR,
-    FirebaseAppDistributionException.INSTALLATION_FAILURE_ERROR,
-    FirebaseAppDistributionException.INSTALLATION_CANCELED_ERROR,
-    FirebaseAppDistributionException.UPDATE_NOT_AVAILABLE_ERROR,
-    FirebaseAppDistributionException.INSTALLATION_FAILURE_SIGNATURE_MISMATCH_ERROR,
-    FirebaseAppDistributionException.APP_RUNNING_IN_PRODUCTION_ERROR,
-    FirebaseAppDistributionException.RELEASE_URL_EXPIRED_ERROR,
-  })
-  @Retention(RetentionPolicy.CLASS)
-  /** Interface for converting int to error code */
-  public @interface Code {}
+  public AppDistributionRelease getRelease() {
+    return release;
+  }
+
+  @NonNull
+  public Status getErrorCode() {
+    return status;
+  }
 }

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/UpdateProgress.java renamed to firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/OnProgressListener.java

@@ -16,17 +16,7 @@
 
 import androidx.annotation.NonNull;
 
-/** Interface to get download progress for APKs and the status of the update. Used in updateApp. */
-public interface UpdateProgress {
-  /** The number of bytes downloaded so far for the APK. Returns -1 if called on an AAB. */
-  @NonNull
-  public long getApkBytesDownloaded();
-
-  /** The total number of bytes to download for the APK. Returns -1 if called on an AAB. */
-  @NonNull
-  public long getApkTotalBytesToDownload();
-
-  @NonNull
-  /** returns the current state of the update */
-  public UpdateStatus getUpdateStatus();
+/** A listener that is called periodically during execution of the {@link UpdateTask}. */
+public interface OnProgressListener {
+  void onProgressUpdate(@NonNull UpdateState updateState);
 }

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/UpdateState.java

@@ -0,0 +1,48 @@
+// Copyright 2021 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 androidx.annotation.NonNull;
+
+/** Data class to get download progress for APKs and the status of the update. Used in updateApp. */
+public final class UpdateState {
+  private final long apkBytesDownloaded;
+  private final long apkTotalBytesToDownload;
+  private final UpdateStatus updateStatus;
+
+  UpdateState(long apkBytesDownloaded, long apkTotalBytesToDownload, UpdateStatus updateStatus) {
+    this.apkBytesDownloaded = apkBytesDownloaded;
+    this.apkTotalBytesToDownload = apkTotalBytesToDownload;
+    this.updateStatus = updateStatus;
+  }
+
+  /** The number of bytes downloaded so far for the APK. Returns -1 if called on an AAB. */
+  @NonNull
+  public long getApkBytesDownloaded() {
+    return apkBytesDownloaded;
+  }
+
+  /** The total number of bytes to download for the APK. Returns -1 if called on an AAB. */
+  @NonNull
+  public long getApkTotalBytesToDownload() {
+    return apkTotalBytesToDownload;
+  }
+
+  @NonNull
+  /** returns the current state of the update */
+  public UpdateStatus getUpdateStatus() {
+    return updateStatus;
+  }
+}

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/UpdateProgressListener.java renamed to firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/UpdateTask.java

@@ -15,13 +15,15 @@
 package com.google.firebase.appdistribution;
 
 import androidx.annotation.NonNull;
+import com.google.android.gms.tasks.Task;
+
+public abstract class UpdateTask extends Task<UpdateState> {
 
-/** Interface to subscribe to status updates on the release update process. Called by updateApp. */
-public interface UpdateProgressListener {
   /**
-   * Method invoked during updating to track progress by modifying UpdateProgress object
+   * Adds a listener that is called periodically while the UpdateTask executes.
    *
-   * @param UpdateProgress object to be modified
+   * @return this Task
    */
-  public void onProgressUpdate(@NonNull UpdateProgress updateProgress);
+  @NonNull
+  public abstract UpdateTask addOnProgressListener(@NonNull OnProgressListener listener);
 }