Implement Android Executors for Storage

firebase-storage/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Unreleased
+# 20.2.0
+* [changed] Replaced custom Thread implementation with Firebase Core executors.
 
 # 20.1.0
 * [fixed] Fixed an issue that caused an infinite number of retries with no

firebase-storage/firebase-storage.gradle

@@ -75,7 +75,7 @@ android {
 }
 
 dependencies {
-    implementation 'com.google.firebase:firebase-common:20.3.1'
+    implementation 'com.google.firebase:firebase-common:20.3.2'
     implementation 'com.google.firebase:firebase-components:17.1.0'
     implementation 'com.google.firebase:firebase-appcheck-interop:16.1.1'
 

firebase-storage/src/main/java/com/google/firebase/storage/FirebaseStorageComponent.java

@@ -18,11 +18,13 @@
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
 import com.google.firebase.FirebaseApp;
+import com.google.firebase.annotations.concurrent.Blocking;
 import com.google.firebase.appcheck.interop.InternalAppCheckTokenProvider;
 import com.google.firebase.auth.internal.InternalAuthProvider;
 import com.google.firebase.inject.Provider;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.Executor;
 
 class FirebaseStorageComponent {
   /** A map from storage buckets to Firebase Storage instances. */
@@ -35,10 +37,12 @@ class FirebaseStorageComponent {
   FirebaseStorageComponent(
       @NonNull FirebaseApp app,
       @Nullable Provider<InternalAuthProvider> authProvider,
-      @Nullable Provider<InternalAppCheckTokenProvider> appCheckProvider) {
+      @Nullable Provider<InternalAppCheckTokenProvider> appCheckProvider,
+      @NonNull @Blocking Executor executor) {
     this.app = app;
     this.authProvider = authProvider;
     this.appCheckProvider = appCheckProvider;
+    StorageTaskScheduler.initializeExecutors(executor);
   }
 
   /** Provides instances of Firebase Storage for given bucket names. */

firebase-storage/src/main/java/com/google/firebase/storage/StorageRegistrar.java

@@ -17,35 +17,41 @@
 import androidx.annotation.Keep;
 import androidx.annotation.RestrictTo;
 import com.google.firebase.FirebaseApp;
+import com.google.firebase.annotations.concurrent.Blocking;
 import com.google.firebase.appcheck.interop.InternalAppCheckTokenProvider;
 import com.google.firebase.auth.internal.InternalAuthProvider;
 import com.google.firebase.components.Component;
 import com.google.firebase.components.ComponentRegistrar;
 import com.google.firebase.components.Dependency;
+import com.google.firebase.components.Qualified;
 import com.google.firebase.platforminfo.LibraryVersionComponent;
 import java.util.Arrays;
 import java.util.List;
+import java.util.concurrent.Executor;
 
 /** @hide */
 @Keep
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 public class StorageRegistrar implements ComponentRegistrar {
   private static final String LIBRARY_NAME = "fire-gcs";
+  Qualified<Executor> blockingExecutor = Qualified.qualified(Blocking.class, Executor.class);
 
   @Override
   public List<Component<?>> getComponents() {
     return Arrays.asList(
         Component.builder(FirebaseStorageComponent.class)
             .name(LIBRARY_NAME)
             .add(Dependency.required(FirebaseApp.class))
+            .add(Dependency.required(blockingExecutor))
             .add(Dependency.optionalProvider(InternalAuthProvider.class))
             .add(Dependency.optionalProvider(InternalAppCheckTokenProvider.class))
             .factory(
                 c ->
                     new FirebaseStorageComponent(
                         c.get(FirebaseApp.class),
                         c.getProvider(InternalAuthProvider.class),
-                        c.getProvider(InternalAppCheckTokenProvider.class)))
+                        c.getProvider(InternalAppCheckTokenProvider.class),
+                        c.get(blockingExecutor)))
             .build(),
         LibraryVersionComponent.create(LIBRARY_NAME, BuildConfig.VERSION_NAME));
   }

firebase-storage/src/main/java/com/google/firebase/storage/StorageTaskScheduler.java

@@ -14,16 +14,10 @@
 
 package com.google.firebase.storage;
 
-import android.annotation.SuppressLint;
 import androidx.annotation.NonNull;
 import androidx.annotation.RestrictTo;
-import java.util.concurrent.BlockingQueue;
+import com.google.firebase.concurrent.FirebaseExecutors;
 import java.util.concurrent.Executor;
-import java.util.concurrent.LinkedBlockingQueue;
-import java.util.concurrent.ThreadFactory;
-import java.util.concurrent.ThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * A class used to schedule long running operations (upload/download) and operations that are
@@ -36,48 +30,24 @@
 public class StorageTaskScheduler {
   public static StorageTaskScheduler sInstance = new StorageTaskScheduler();
 
-  private static BlockingQueue<Runnable> mCommandQueue = new LinkedBlockingQueue<>();
-
-  // TODO(b/258426744): Migrate to go/firebase-android-executors
-  @SuppressLint("ThreadPoolCreation")
-  private static final ThreadPoolExecutor COMMAND_POOL_EXECUTOR =
-      new ThreadPoolExecutor(
-          5, 5, 5, TimeUnit.SECONDS, mCommandQueue, new StorageThreadFactory("Command-"));
-
-  private static BlockingQueue<Runnable> mUploadQueue = new LinkedBlockingQueue<>();
-
-  // TODO(b/258426744): Migrate to go/firebase-android-executors
-  @SuppressLint("ThreadPoolCreation")
-  private static final ThreadPoolExecutor UPLOAD_QUEUE_EXECUTOR =
-      new ThreadPoolExecutor(
-          2, 2, 5, TimeUnit.SECONDS, mUploadQueue, new StorageThreadFactory("Upload-"));
-
-  private static BlockingQueue<Runnable> mDownloadQueue = new LinkedBlockingQueue<>();
-
-  // TODO(b/258426744): Migrate to go/firebase-android-executors
-  @SuppressLint("ThreadPoolCreation")
-  private static final ThreadPoolExecutor DOWNLOAD_QUEUE_EXECUTOR =
-      new ThreadPoolExecutor(
-          3, 3, 5, TimeUnit.SECONDS, mDownloadQueue, new StorageThreadFactory("Download-"));
-
-  private static BlockingQueue<Runnable> mCallbackQueue = new LinkedBlockingQueue<>();
-
-  // TODO(b/258426744): Migrate to go/firebase-android-executors
-  @SuppressLint("ThreadPoolCreation")
-  private static final ThreadPoolExecutor CALLBACK_QUEUE_EXECUTOR =
-      new ThreadPoolExecutor(
-          1, 1, 5, TimeUnit.SECONDS, mCallbackQueue, new StorageThreadFactory("Callbacks-"));
-
-  static {
-    COMMAND_POOL_EXECUTOR.allowCoreThreadTimeOut(true);
-    UPLOAD_QUEUE_EXECUTOR.allowCoreThreadTimeOut(true);
-    DOWNLOAD_QUEUE_EXECUTOR.allowCoreThreadTimeOut(true);
-    CALLBACK_QUEUE_EXECUTOR.allowCoreThreadTimeOut(true);
+  private static final int COMMAND_POOL_SIZE = 5;
+  private static final int DOWNLOAD_POOL_SIZE = 3;
+  private static final int UPLOAD_POOL_SIZE = 2;
+
+  public static void initializeExecutors(@NonNull Executor firebaseExecutor) {
+    COMMAND_POOL_EXECUTOR =
+        FirebaseExecutors.newLimitedConcurrencyExecutor(firebaseExecutor, COMMAND_POOL_SIZE);
+    DOWNLOAD_QUEUE_EXECUTOR =
+        FirebaseExecutors.newLimitedConcurrencyExecutor(firebaseExecutor, DOWNLOAD_POOL_SIZE);
+    UPLOAD_QUEUE_EXECUTOR =
+        FirebaseExecutors.newLimitedConcurrencyExecutor(firebaseExecutor, UPLOAD_POOL_SIZE);
+    CALLBACK_QUEUE_EXECUTOR = FirebaseExecutors.newSequentialExecutor(firebaseExecutor);
   }
 
-  public static void setCallbackQueueKeepAlive(long keepAliveTime, TimeUnit timeUnit) {
-    CALLBACK_QUEUE_EXECUTOR.setKeepAliveTime(keepAliveTime, timeUnit);
-  }
+  private static Executor COMMAND_POOL_EXECUTOR;
+  private static Executor UPLOAD_QUEUE_EXECUTOR;
+  private static Executor DOWNLOAD_QUEUE_EXECUTOR;
+  private static Executor CALLBACK_QUEUE_EXECUTOR;
 
   public static StorageTaskScheduler getInstance() {
     return sInstance;
@@ -102,27 +72,4 @@ public void scheduleCallback(Runnable task) {
   public Executor getCommandPoolExecutor() {
     return COMMAND_POOL_EXECUTOR;
   }
-
-  /** The thread factory for Storage threads. */
-  static class StorageThreadFactory implements ThreadFactory {
-    private final AtomicInteger threadNumber = new AtomicInteger(1);
-    private final String mNameSuffix;
-
-    StorageThreadFactory(@NonNull String suffix) {
-      mNameSuffix = suffix;
-    }
-
-    @Override
-    @SuppressWarnings("ThreadPriorityCheck")
-    // TODO(b/258426744): Migrate to go/firebase-android-executors
-    @SuppressLint("ThreadPoolCreation")
-    public Thread newThread(@NonNull Runnable r) {
-      Thread t = new Thread(r, "FirebaseStorage-" + mNameSuffix + threadNumber.getAndIncrement());
-      t.setDaemon(false);
-      t.setPriority(
-          android.os.Process.THREAD_PRIORITY_BACKGROUND
-              + android.os.Process.THREAD_PRIORITY_MORE_FAVORABLE);
-      return t;
-    }
-  }
 }

firebase-storage/src/test/java/com/google/firebase/storage/TestUtil.java

@@ -32,12 +32,6 @@
 public class TestUtil {
 
   static FirebaseApp createApp() {
-    /**
-     * Many tests require you to call the callback on the same thread that was initially
-     * instantiated. With the 5 second keepalive, after 5 seconds, the thread will get killed and
-     * eventually a new one will be created. Therefore causing many of the tests to fail.
-     */
-    StorageTaskScheduler.setCallbackQueueKeepAlive(90, TimeUnit.SECONDS);
     return FirebaseApp.initializeApp(
         ApplicationProvider.getApplicationContext(),
         new FirebaseOptions.Builder()