FAD API error handling (firebase#2835)

* Adding API error handling and better error messages * adding tests * adding copyright check * Moving additional error messages to the the constants class * Removing unnecessary tag * changing the visbility of the internal constructor

Author: pranavrajgopal

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

@@ -0,0 +1,37 @@
+// 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;
+
+class Constants {
+ static class ErrorMessages {
+ public static final String NETWORK_ERROR =
+ "Failed to fetch releases due to unknown network error";
+
+ public static final String JSON_PARSING_ERROR = "Error parsing service response";
+
+ public static final String AUTHENTICATION_ERROR = "Failed to authenticate the tester";
+
+ public static final String AUTHORIZATION_ERROR = "Failed to authorize the tester";
+
+ public static final String AUTHENTICATION_CANCELLED =
+ "Tester cancelled the authentication flow";
+
+ public static final String NOT_FOUND_ERROR = "Tester or release not found";
+
+ public static final String TIMEOUT_ERROR = "Failed to fetch releases due to timeout";
+
+ public static final String UNKNOWN_ERROR = "Unknown Error";
+ }
+}

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

@@ -31,6 +31,7 @@
 import android.os.Looper;
 import android.util.Log;
 import androidx.annotation.NonNull;
+import androidx.annotation.VisibleForTesting;
 import androidx.browser.customtabs.CustomTabsIntent;
 import androidx.core.content.pm.PackageInfoCompat;
 import androidx.core.os.HandlerCompat;
@@ -46,7 +47,6 @@
 import com.google.firebase.appdistribution.internal.ReleaseIdentificationUtils;
 import com.google.firebase.installations.FirebaseInstallationsApi;
 import com.google.firebase.installations.InstallationTokenResult;
-import java.net.ProtocolException;
 import java.util.List;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
@@ -70,8 +70,9 @@ public class FirebaseAppDistribution implements Application.ActivityLifecycleCal
  private CancellationTokenSource checkForUpdateCancellationSource;
  private final Executor checkForUpdateExecutor;
 
- /** Constructor for FirebaseAppDistribution */
- public FirebaseAppDistribution(
+ /** Internal Constructor for FirebaseAppDistribution */
+ @VisibleForTesting
+ FirebaseAppDistribution(
  @NonNull FirebaseApp firebaseApp,
  @NonNull FirebaseInstallationsApi firebaseInstallationsApi,
  @NonNull FirebaseAppDistributionTesterApiClient firebaseAppDistributionTesterApiClient) {
@@ -207,7 +208,8 @@ public Task<AppDistributionRelease> checkForUpdate() {
  .addOnFailureListener(
  e ->
  setCheckForUpdateTaskCompletionError(
- new FirebaseAppDistributionException(e.getMessage(), AUTHENTICATION_FAILURE)));
+ new FirebaseAppDistributionException(
+ Constants.ErrorMessages.AUTHENTICATION_ERROR, AUTHENTICATION_FAILURE, e)));
 
  return checkForUpdateTaskCompletionSource.getTask();
  }
@@ -217,16 +219,15 @@ 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 FirebaseAppDistributionException with UPDATE_NOT_AVAIALBLE exception if no new release
- *   is cached from checkForUpdate
+ * <p>cancels task with FirebaseAppDistributionException with UPDATE_NOT_AVAIALBLE exception if no
+ * new release is cached from checkForUpdate
  */
  @NonNull
  public UpdateTask updateApp() {
  return (UpdateTask) Tasks.forResult(new UpdateState(0, 0, UpdateStatus.PENDING));
  }
 
  /** Returns true if the App Distribution tester is signed in */
- @NonNull
  public boolean isTesterSignedIn() {
  // todo: implement when signIn persistence is done
  throw new UnsupportedOperationException("Not yet implemented.");
@@ -266,7 +267,9 @@ public void onActivityResumed(@NonNull Activity activity) {
  // throw error if app reentered during signin
  if (currentlySigningIn) {
  currentlySigningIn = false;
- setSignInTaskCompletionError(new FirebaseAppDistributionException(AUTHENTICATION_CANCELED));
+ setSignInTaskCompletionError(
+ new FirebaseAppDistributionException(
+ Constants.ErrorMessages.AUTHENTICATION_CANCELLED, AUTHENTICATION_CANCELED));
  }
  this.currentActivity = activity;
  }
@@ -350,7 +353,9 @@ public void onClick(DialogInterface dialogInterface, int i) {
  public void onFailure(@NonNull Exception e) {
  setSignInTaskCompletionError(
  new FirebaseAppDistributionException(
- e.getMessage(), AUTHENTICATION_FAILURE));
+ Constants.ErrorMessages.AUTHENTICATION_ERROR,
+ AUTHENTICATION_FAILURE,
+ e));
  }
  });
  }
@@ -362,7 +367,8 @@ public void onFailure(@NonNull Exception e) {
  @Override
  public void onClick(DialogInterface dialogInterface, int i) {
  setSignInTaskCompletionError(
- new FirebaseAppDistributionException(AUTHENTICATION_CANCELED));
+ new FirebaseAppDistributionException(
+ "Tester cancelled authentication flow", AUTHENTICATION_CANCELED));
  dialogInterface.dismiss();
  }
  });
@@ -386,6 +392,7 @@ public void onSuccess(String fid) {
  };
  }
 
+ @VisibleForTesting
  AppDistributionRelease getLatestReleaseFromClient(
  String fid, String appId, String apiKey, String authToken)
  throws FirebaseAppDistributionException {
@@ -403,13 +410,11 @@ AppDistributionRelease getLatestReleaseFromClient(
  // Return null if retrieved latest release is older or currently installed
  return null;
  }
- } catch (FirebaseAppDistributionException | ProtocolException | NumberFormatException e) {
- if (e instanceof FirebaseAppDistributionException) {
- throw (FirebaseAppDistributionException) e;
- } else {
- throw new FirebaseAppDistributionException(
- e.getMessage(), FirebaseAppDistributionException.Status.NETWORK_FAILURE);
- }
+ } catch (NumberFormatException e) {
+ throw new FirebaseAppDistributionException(
+ Constants.ErrorMessages.NETWORK_ERROR,
+ FirebaseAppDistributionException.Status.NETWORK_FAILURE,
+ e);
  }
  }
 
@@ -434,7 +439,9 @@ private long getInstalledAppVersionCode(Context context) {
  } catch (PackageManager.NameNotFoundException e) {
  checkForUpdateTaskCompletionSource.setException(
  new FirebaseAppDistributionException(
- e.getMessage(), FirebaseAppDistributionException.Status.UNKNOWN));
+ Constants.ErrorMessages.UNKNOWN_ERROR,
+ FirebaseAppDistributionException.Status.UNKNOWN,
+ e));
  }
  return PackageInfoCompat.getLongVersionCode(pInfo);
  }

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

@@ -58,17 +58,6 @@ public enum Status {
  @NonNull private final Status status;
  @Nullable private final AppDistributionRelease release;
 
- public FirebaseAppDistributionException(
- @NonNull Status status, @Nullable AppDistributionRelease release) {
- this.status = status;
- this.release = release;
- }
-
- public FirebaseAppDistributionException(@NonNull Status status) {
- this.status = status;
- this.release = null;
- }
-
  public FirebaseAppDistributionException(@NonNull String message, @NonNull Status status) {
  super(message);
  this.status = status;
@@ -82,6 +71,13 @@ public FirebaseAppDistributionException(
  this.release = release;
  }
 
+ public FirebaseAppDistributionException(
+ @NonNull String message, @NonNull Status status, @NonNull Throwable cause) {
+ super(message, cause);
+ this.status = status;
+ this.release = null;
+ }
+
  public FirebaseAppDistributionException(
  @NonNull String message,
  @NonNull Status status,

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

@@ -14,20 +14,22 @@
 
 package com.google.firebase.appdistribution;
 
+import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.AUTHENTICATION_FAILURE;
+import static com.google.firebase.appdistribution.FirebaseAppDistributionException.Status.NETWORK_FAILURE;
+
 import androidx.annotation.NonNull;
 import com.google.firebase.appdistribution.internal.AppDistributionReleaseInternal;
 import java.io.BufferedInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.MalformedURLException;
-import java.net.ProtocolException;
 import java.net.URL;
 import javax.net.ssl.HttpsURLConnection;
 import org.json.JSONException;
 import org.json.JSONObject;
 
-public class FirebaseAppDistributionTesterApiClient {
+class FirebaseAppDistributionTesterApiClient {
 
  private static final String RELEASE_ENDPOINT_URL_FORMAT =
  "https://firebaseapptesters.googleapis.com/v1alpha/devices/-/testerApps/%s/installations/%s/releases";
@@ -45,16 +47,16 @@ public class FirebaseAppDistributionTesterApiClient {
 
  public @NonNull AppDistributionReleaseInternal fetchLatestRelease(
  @NonNull String fid, @NonNull String appId, @NonNull String apiKey, @NonNull String authToken)
- throws FirebaseAppDistributionException, ProtocolException {
+ throws FirebaseAppDistributionException {
 
  AppDistributionReleaseInternal latestRelease;
- HttpsURLConnection conn = openHttpsUrlConnection(appId, fid);
- conn.setRequestMethod(REQUEST_METHOD);
- conn.setRequestProperty(API_KEY_HEADER, apiKey);
- conn.setRequestProperty(INSTALLATION_AUTH_HEADER, authToken);
-
+ HttpsURLConnection connection = openHttpsUrlConnection(appId, fid);
  try {
- JSONObject latestReleaseJson = readFetchReleaseInputStream(conn.getInputStream());
+ connection.setRequestMethod(REQUEST_METHOD);
+ connection.setRequestProperty(API_KEY_HEADER, apiKey);
+ connection.setRequestProperty(INSTALLATION_AUTH_HEADER, authToken);
+
+ JSONObject latestReleaseJson = readFetchReleaseInputStream(connection.getInputStream());
  final String displayVersion = latestReleaseJson.getString(DISPLAY_VERSION_JSON_KEY);
  final String buildVersion = latestReleaseJson.getString(BUILD_VERSION_JSON_KEY);
  String releaseNotes = tryGetValue(latestReleaseJson, RELEASE_NOTES_JSON_KEY);
@@ -79,16 +81,47 @@ public class FirebaseAppDistributionTesterApiClient {
  .build();
 
  } catch (IOException | JSONException e) {
- // todo: change error status based on response code
- throw new FirebaseAppDistributionException(
- FirebaseAppDistributionException.Status.NETWORK_FAILURE);
+ if (e instanceof JSONException) {
+ throw new FirebaseAppDistributionException(
+ Constants.ErrorMessages.JSON_PARSING_ERROR, NETWORK_FAILURE, e);
+ }
+
+ throw getExceptionForHttpResponse(connection);
  } finally {
- conn.disconnect();
+ connection.disconnect();
  }
 
  return latestRelease;
  }
 
+ private FirebaseAppDistributionException getExceptionForHttpResponse(
+ HttpsURLConnection connection) {
+ try {
+ switch (connection.getResponseCode()) {
+ case 401:
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.AUTHENTICATION_ERROR, AUTHENTICATION_FAILURE);
+ case 403:
+ case 400:
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.AUTHORIZATION_ERROR, AUTHENTICATION_FAILURE);
+ case 404:
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.NOT_FOUND_ERROR, AUTHENTICATION_FAILURE);
+ case 408:
+ case 504:
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.TIMEOUT_ERROR, NETWORK_FAILURE);
+ default:
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.NETWORK_ERROR, NETWORK_FAILURE);
+ }
+ } catch (IOException ex) {
+ return new FirebaseAppDistributionException(
+ Constants.ErrorMessages.NETWORK_ERROR, NETWORK_FAILURE, ex);
+ }
+ }
+
  private String tryGetValue(JSONObject jsonObject, String key) {
  try {
  return jsonObject.getString(key);
@@ -107,7 +140,9 @@ private JSONObject readFetchReleaseInputStream(InputStream in)
  latestRelease = json.getJSONArray("releases").getJSONObject(0);
  } catch (JSONException e) {
  throw new FirebaseAppDistributionException(
- e.getMessage(), FirebaseAppDistributionException.Status.UNKNOWN);
+ Constants.ErrorMessages.JSON_PARSING_ERROR,
+ FirebaseAppDistributionException.Status.UNKNOWN,
+ e);
  }
  return latestRelease;
  }
@@ -120,7 +155,7 @@ HttpsURLConnection openHttpsUrlConnection(String appId, String fid)
  httpsURLConnection = (HttpsURLConnection) url.openConnection();
  } catch (IOException e) {
  throw new FirebaseAppDistributionException(
- e.getMessage(), FirebaseAppDistributionException.Status.NETWORK_FAILURE);
+ Constants.ErrorMessages.NETWORK_ERROR, NETWORK_FAILURE, e);
  }
  return httpsURLConnection;
  }
@@ -131,7 +166,9 @@ private URL getReleasesEndpointUrl(String appId, String fid)
  return new URL(String.format(RELEASE_ENDPOINT_URL_FORMAT, appId, fid));
  } catch (MalformedURLException e) {
  throw new FirebaseAppDistributionException(
- e.getMessage(), FirebaseAppDistributionException.Status.UNKNOWN);
+ Constants.ErrorMessages.UNKNOWN_ERROR,
+ FirebaseAppDistributionException.Status.UNKNOWN,
+ e);
  }
  }