Add CustomModelDownloadService to retrieve download details about… (firebase#2134)

* Add new CustomModelDownloadService to retrieve download details about the CustomModel.

* Add tests for download service calls

* Change to mockwire standalone - now builds locally.
Test still needs work and code seems to actually run and not use mockwire?

* add first working wiremock unit test.

* add more wiremock unit test.

* Update the registrar to use CustomModelDownloadService.

* Update the registrar to use CustomModelDownloadService.

* Update the registrar to use CustomModelDownloadService.

* Update the registrar to use CustomModelDownloadService.

* Fixing returned task values and tests.

* Changing equals asserts.

* Fix errors caused by timestamp issues, hardcoding to UTC as that's the correct solution.

* Reviewer request updates.

* Reviewer request updates.

* Reviewer request updates.

Author: annzimmer

firebase-ml-modeldownloader/firebase-ml-modeldownloader.gradle

@@ -45,16 +45,23 @@ android {
 dependencies {
     implementation project(':firebase-common')
     implementation project(':firebase-components')
+    implementation project(':firebase-installations-interop')
+    runtimeOnly project(':firebase-installations')
 
     implementation 'com.google.android.gms:play-services-tasks:17.2.0'
+    implementation 'com.google.auto.service:auto-service-annotations:1.0-rc6'
     implementation 'javax.inject:javax.inject:1'
 
     compileOnly "com.google.auto.value:auto-value-annotations:1.6.6"
     annotationProcessor "com.google.auto.value:auto-value:1.6.5"
 
     testImplementation 'androidx.test:core:1.3.0'
-    testImplementation 'com.google.truth:truth:1.0.1'
-    testImplementation 'junit:junit:4.13'
+    testImplementation 'com.github.tomakehurst:wiremock-standalone:2.26.3'
+    testImplementation "com.google.truth:truth:$googleTruthVersion"
+    testImplementation 'junit:junit:4.13.1'
+    //Android compatible version of Apache httpclient.
+    testImplementation 'org.apache.httpcomponents:httpclient-android:4.3.5.1'
     testImplementation 'org.mockito:mockito-core:3.3.3'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"
+    testImplementation 'com.google.truth.extensions:truth-proto-extension:1.0'
 }

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

@@ -30,42 +30,89 @@ public class CustomModel {
   private final long fileSize;
   private final String modelHash;
   private final String localFilePath;
+  private final String downloadUrl;
+  private final long downloadUrlExpiry;
 
   /**
    * Use when creating a custom model while the initial download is still in progress.
    *
    * @param name - model name
-   * @param downloadId - Android Download Manger - download id
+   * @param modelHash - model hash
    * @param fileSize - model file size
-   * @param modelHash - model hash size
+   * @param downloadId - Android Download Manger - download id
    * @hide
    */
   public CustomModel(
-      @NonNull String name, long downloadId, long fileSize, @NonNull String modelHash) {
-    this(name, downloadId, fileSize, modelHash, "");
+      @NonNull String name, @NonNull String modelHash, long fileSize, long downloadId) {
+    this(name, modelHash, fileSize, downloadId, "", "", 0);
   }
 
   /**
-   * Use when creating a custom model while the initial download is still in progress.
+   * Use when creating a custom model from a stored model with a new download in the background.
    *
    * @param name - model name
-   * @param downloadId - Android Download Manger - download id
+   * @param modelHash - model hash
    * @param fileSize - model file size
-   * @param modelHash - model hash size
-   * @param localFilePath - location of the current file
+   * @param downloadId - Android Download Manger - download id
    * @hide
    */
   public CustomModel(
       @NonNull String name,
+      @NonNull String modelHash,
+      long fileSize,
       long downloadId,
+      String localFilePath) {
+    this(name, modelHash, fileSize, downloadId, localFilePath, "", 0);
+  }
+
+  /**
+   * Use when creating a custom model from a download service response. Download url and download
+   * url expiry should go together. These will not be stored in user preferences as this is a
+   * temporary step towards setting the actual download id.
+   *
+   * @param name - model name
+   * @param modelHash - model hash
+   * @param fileSize - model file size
+   * @param downloadUrl - download url path
+   * @param downloadUrlExpiry - time download url path expires
+   * @hide
+   */
+  public CustomModel(
+      @NonNull String name,
+      @NonNull String modelHash,
       long fileSize,
+      String downloadUrl,
+      long downloadUrlExpiry) {
+    this(name, modelHash, fileSize, 0, "", downloadUrl, downloadUrlExpiry);
+  }
+
+  /**
+   * Use when creating a custom model while the initial download is still in progress.
+   *
+   * @param name - model name
+   * @param modelHash - model hash
+   * @param fileSize - model file size
+   * @param downloadId - Android Download Manger - download id
+   * @param localFilePath - location of the current file
+   * @param downloadUrl - download url path returned from download service
+   * @param downloadUrlExpiry - expiry time of download url link
+   * @hide
+   */
+  private CustomModel(
+      @NonNull String name,
       @NonNull String modelHash,
-      @NonNull String localFilePath) {
+      long fileSize,
+      long downloadId,
+      @Nullable String localFilePath,
+      @Nullable String downloadUrl,
+      long downloadUrlExpiry) {
     this.modelHash = modelHash;
     this.name = name;
     this.fileSize = fileSize;
     this.downloadId = downloadId;
     this.localFilePath = localFilePath;
+    this.downloadUrl = downloadUrl;
+    this.downloadUrlExpiry = downloadUrlExpiry;
   }
 
   @NonNull
@@ -81,7 +128,7 @@ public String getName() {
    */
   @Nullable
   public File getFile() {
-    if (localFilePath.isEmpty()) {
+    if (localFilePath == null || localFilePath.isEmpty()) {
       return null;
     }
     throw new UnsupportedOperationException("Not implemented, file retrieval coming soon.");
@@ -130,19 +177,43 @@ public boolean equals(Object o) {
         && Objects.equal(modelHash, other.modelHash)
         && Objects.equal(fileSize, other.fileSize)
         && Objects.equal(localFilePath, other.localFilePath)
-        && Objects.equal(downloadId, other.downloadId);
+        && Objects.equal(downloadId, other.downloadId)
+        && Objects.equal(downloadUrl, other.downloadUrl)
+        && Objects.equal(downloadUrlExpiry, other.downloadUrlExpiry);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hashCode(name, modelHash, fileSize, localFilePath, downloadId);
+    return Objects.hashCode(
+        name, modelHash, fileSize, localFilePath, downloadId, downloadUrl, downloadUrlExpiry);
+  }
+
+  /**
+   * The expiry time for the current download url.
+   *
+   * <p>Internal use only.
+   *
+   * @hide
+   */
+  public long getDownloadUrlExpiry() {
+    return downloadUrlExpiry;
+  }
+
+  /**
+   * @return the model download url
+   *     <p>Internal use only
+   * @hide
+   */
+  @Nullable
+  public String getDownloadUrl() {
+    return downloadUrl;
   }
 
   /**
    * @return the model file path
    * @hide
    */
-  @NonNull
+  @Nullable
   public String getLocalFilePath() {
     return localFilePath;
   }

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

@@ -14,11 +14,17 @@
 
 package com.google.firebase.ml.modeldownloader;
 
+import android.os.Build.VERSION_CODES;
 import androidx.annotation.NonNull;
+import androidx.annotation.RequiresApi;
 import com.google.firebase.FirebaseApp;
+import com.google.firebase.FirebaseOptions;
 import com.google.firebase.components.Component;
 import com.google.firebase.components.ComponentRegistrar;
 import com.google.firebase.components.Dependency;
+import com.google.firebase.installations.FirebaseInstallationsApi;
+import com.google.firebase.ml.modeldownloader.internal.CustomModelDownloadService;
+import com.google.firebase.ml.modeldownloader.internal.SharedPreferencesUtil;
 import com.google.firebase.platforminfo.LibraryVersionComponent;
 import java.util.Arrays;
 import java.util.List;
@@ -33,12 +39,25 @@ public class FirebaseModelDownloaderRegistrar implements ComponentRegistrar {
 
   @Override
   @NonNull
+  @RequiresApi(api = VERSION_CODES.KITKAT)
   public List<Component<?>> getComponents() {
     return Arrays.asList(
         Component.builder(FirebaseModelDownloader.class)
             .add(Dependency.required(FirebaseApp.class))
             .factory(c -> new FirebaseModelDownloader(c.get(FirebaseApp.class)))
             .build(),
+        Component.builder(SharedPreferencesUtil.class)
+            .add(Dependency.required(FirebaseApp.class))
+            .factory(c -> new SharedPreferencesUtil(c.get(FirebaseApp.class)))
+            .build(),
+        Component.builder(CustomModelDownloadService.class)
+            .add(Dependency.required(FirebaseOptions.class))
+            .add(Dependency.required(FirebaseInstallationsApi.class))
+            .factory(
+                c ->
+                    new CustomModelDownloadService(
+                        c.get(FirebaseOptions.class), c.get(FirebaseInstallationsApi.class)))
+            .build(),
         LibraryVersionComponent.create("firebase-ml-modeldownloader", BuildConfig.VERSION_NAME));
   }
 }