adding more FirebaseMlException handling and logging

Author: annzimmer

firebase-ml-modeldownloader/src/androidTest/java/com/google/firebase/ml/modeldownloader/TestGetModelLocal.java

@@ -41,7 +41,7 @@
  */
 @RunWith(AndroidJUnit4.class)
 public class TestGetModelLocal {
-  private FirebaseModelDownloader firebaseModelDownloader;
+
   private static final String MODEL_NAME_LOCAL = "getLocalModel";
   private static final String MODEL_NAME_LOCAL_2 = "getLocalModel2";
   private static final String MODEL_HASH = "origHash324";
@@ -51,14 +51,13 @@ public class TestGetModelLocal {
   private FirebaseApp app;
   private File firstDeviceModelFile;
   private File firstLoadTempModelFile;
-  private SharedPreferencesUtil sharedPreferencesUtil;
 
   @Before
   public void before() {
     app = FirebaseApp.initializeApp(ApplicationProvider.getApplicationContext());
-    firebaseModelDownloader = FirebaseModelDownloader.getInstance(app);
+    FirebaseModelDownloader firebaseModelDownloader = FirebaseModelDownloader.getInstance(app);
 
-    sharedPreferencesUtil = new SharedPreferencesUtil(app);
+    SharedPreferencesUtil sharedPreferencesUtil = new SharedPreferencesUtil(app);
     // reset shared preferences and downloads for models used by this test.
     firebaseModelDownloader.deleteDownloadedModel(MODEL_NAME_LOCAL);
     firebaseModelDownloader.deleteDownloadedModel(MODEL_NAME_LOCAL_2);

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/CustomModel.java

@@ -129,7 +129,7 @@ public String getName() {
    *     progress, returns null, if file update is in progress returns last fully downloaded model.
    */
   @Nullable
-  public File getFile() throws FirebaseMlException {
+  public File getFile() {
     return getFile(ModelFileDownloadService.getInstance());
   }
 

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/FirebaseModelDownloader.java

@@ -18,7 +18,6 @@
 import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
 import androidx.annotation.VisibleForTesting;
-import com.google.android.datatransport.TransportFactory;
 import com.google.android.gms.common.internal.Preconditions;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
@@ -51,13 +50,11 @@ public class FirebaseModelDownloader {
 
   @RequiresApi(api = VERSION_CODES.KITKAT)
   FirebaseModelDownloader(
-      FirebaseApp firebaseApp,
-      FirebaseInstallationsApi firebaseInstallationsApi,
-      TransportFactory transportFactory) {
+      FirebaseApp firebaseApp, FirebaseInstallationsApi firebaseInstallationsApi) {
     this.firebaseOptions = firebaseApp.getOptions();
     this.sharedPreferencesUtil = new SharedPreferencesUtil(firebaseApp);
     this.eventLogger = FirebaseMlLogger.getInstance();
-    this.fileDownloadService = new ModelFileDownloadService(firebaseApp, transportFactory);
+    this.fileDownloadService = new ModelFileDownloadService(firebaseApp);
     this.modelDownloadService =
         new CustomModelDownloadService(firebaseApp, firebaseInstallationsApi);
 

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/FirebaseModelDownloaderRegistrar.java

@@ -47,14 +47,11 @@ public List<Component<?>> getComponents() {
     return Arrays.asList(
         Component.builder(FirebaseModelDownloader.class)
             .add(Dependency.required(FirebaseApp.class))
-            .add(Dependency.required(TransportFactory.class))
             .add(Dependency.required(FirebaseInstallationsApi.class))
             .factory(
                 c ->
                     new FirebaseModelDownloader(
-                        c.get(FirebaseApp.class),
-                        c.get(FirebaseInstallationsApi.class),
-                        c.get(TransportFactory.class)))
+                        c.get(FirebaseApp.class), c.get(FirebaseInstallationsApi.class)))
             .build(),
         Component.builder(SharedPreferencesUtil.class)
             .add(Dependency.required(FirebaseApp.class))
@@ -77,11 +74,7 @@ public List<Component<?>> getComponents() {
             .build(),
         Component.builder(ModelFileDownloadService.class)
             .add(Dependency.required(FirebaseApp.class))
-            .add(Dependency.required(TransportFactory.class))
-            .factory(
-                c ->
-                    new ModelFileDownloadService(
-                        c.get(FirebaseApp.class), c.get(TransportFactory.class)))
+            .factory(c -> new ModelFileDownloadService(c.get(FirebaseApp.class)))
             .build(),
         Component.builder(CustomModelDownloadService.class)
             .add(Dependency.required(FirebaseApp.class))

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/internal/CustomModelDownloadService.java

@@ -220,7 +220,6 @@ private Task<CustomModel> fetchDownloadDetails(String modelName, HttpURLConnecti
           return setAndLogException(
               modelName,
               httpResponseCode,
-              errorMessage,
               String.format(
                   Locale.getDefault(),
                   "Bad http request for model (%s); error message: %s",
@@ -231,14 +230,12 @@ private Task<CustomModel> fetchDownloadDetails(String modelName, HttpURLConnecti
           return setAndLogException(
               modelName,
               httpResponseCode,
-              errorMessage,
               "Too many requests to server please wait before trying again.",
               FirebaseMlException.INVALID_ARGUMENT);
         case HttpURLConnection.HTTP_SERVER_ERROR:
           return setAndLogException(
               modelName,
               httpResponseCode,
-              errorMessage,
               String.format(
                   Locale.getDefault(),
                   "Server issue while fetching model (%s); error message: %s",
@@ -249,7 +246,6 @@ private Task<CustomModel> fetchDownloadDetails(String modelName, HttpURLConnecti
           return setAndLogException(
               modelName,
               httpResponseCode,
-              errorMessage,
               String.format(
                   Locale.getDefault(),
                   "Failed to connect to Firebase ML download server with HTTP status code: %d"
@@ -272,11 +268,7 @@ private Task<CustomModel> fetchDownloadDetails(String modelName, HttpURLConnecti
   }
 
   private Task<CustomModel> setAndLogException(
-      String modelName,
-      int httpResponseCode,
-      String errorMessage,
-      String s,
-      @Code int invalidArgument) {
+      String modelName, int httpResponseCode, String errorMessage, @Code int invalidArgument) {
     eventLogger.logModelInfoRetrieverFailure(
         new CustomModel(modelName, "", 0, 0),
         ErrorCode.MODEL_INFO_DOWNLOAD_UNSUCCESSFUL_HTTP_STATUS,

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/internal/ModelFileDownloadService.java

@@ -33,7 +33,6 @@
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
 import androidx.annotation.WorkerThread;
-import com.google.android.datatransport.TransportFactory;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
@@ -81,8 +80,7 @@ public class ModelFileDownloadService {
   private CustomModelDownloadConditions downloadConditions =
       new CustomModelDownloadConditions.Builder().build();
 
-  public ModelFileDownloadService(
-      @NonNull FirebaseApp firebaseApp, TransportFactory transportFactory) {
+  public ModelFileDownloadService(@NonNull FirebaseApp firebaseApp) {
     this.context = firebaseApp.getApplicationContext();
     downloadManager = (DownloadManager) context.getSystemService(Context.DOWNLOAD_SERVICE);
     this.fileManager = ModelFileManager.getInstance();

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/CustomModelTest.java

@@ -120,36 +120,36 @@ public void customModel_getDownloadId() {
   }
 
   @Test
-  public void customModel_getFile_noLocalNoDownloadIncomplete() throws FirebaseMlException {
+  public void customModel_getFile_noLocalNoDownloadIncomplete() {
     when(fileDownloadService.loadNewlyDownloadedModelFile(any(CustomModel.class))).thenReturn(null);
     assertNull(CUSTOM_MODEL.getFile(fileDownloadService));
     verify(fileDownloadService, times(1)).loadNewlyDownloadedModelFile(any());
   }
 
   @Test
-  public void customModel_getFile_localModelNoDownload() throws FirebaseMlException {
+  public void customModel_getFile_localModelNoDownload() {
     when(fileDownloadService.loadNewlyDownloadedModelFile(any(CustomModel.class))).thenReturn(null);
     assertEquals(customModelWithFile.getFile(fileDownloadService), testModelFile);
     verify(fileDownloadService, times(1)).loadNewlyDownloadedModelFile(any());
   }
 
   @Test
-  public void customModel_getFile_localModelNoDownload_BadFile() throws FirebaseMlException {
+  public void customModel_getFile_localModelNoDownload_BadFile() {
     when(fileDownloadService.loadNewlyDownloadedModelFile(any(CustomModel.class))).thenReturn(null);
     assertNull(CUSTOM_MODEL_BADFILE.getFile(fileDownloadService));
     verify(fileDownloadService, times(1)).loadNewlyDownloadedModelFile(any());
   }
 
   @Test
-  public void customModel_getFile_localModelDownloadComplete() throws FirebaseMlException {
+  public void customModel_getFile_localModelDownloadComplete() {
     when(fileDownloadService.loadNewlyDownloadedModelFile(any(CustomModel.class)))
         .thenReturn(testModelFile2);
     assertEquals(customModelWithFile.getFile(fileDownloadService), testModelFile2);
     verify(fileDownloadService, times(1)).loadNewlyDownloadedModelFile(any());
   }
 
   @Test
-  public void customModel_getFile_noLocalDownloadComplete() throws FirebaseMlException {
+  public void customModel_getFile_noLocalDownloadComplete() {
     when(fileDownloadService.loadNewlyDownloadedModelFile(any())).thenReturn(testModelFile);
     assertEquals(CUSTOM_MODEL.getFile(fileDownloadService), testModelFile);
     verify(fileDownloadService, times(1)).loadNewlyDownloadedModelFile(any());

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/FirebaseModelDownloaderTest.java

@@ -429,7 +429,7 @@ public void getModel_latestModel_noLocalModel_modelDownloadServiceFails() throws
   }
 
   @Test
-  public void getModel_latestModel_noLocalModel_error() throws Exception {
+  public void getModel_latestModel_noLocalModel_error() {
     when(mockPrefs.getCustomModelDetails(eq(MODEL_NAME)))
         .thenReturn(null)
         .thenReturn(null)