move auto index flag to runtime

Author: cherylEnkidu

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/IndexingTest.java

@@ -15,6 +15,8 @@
 package com.google.firebase.firestore;
 
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testFirestore;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.android.gms.tasks.Task;
@@ -101,4 +103,21 @@ public void testBadIndexDoesNotCrashClient() {
                     + "  \"fieldOverrides\": []\n"
                     + "}"));
   }
+
+  @Test
+  public void testAutomaticIndexingSetSuccessfully()
+      throws ExecutionException, InterruptedException {
+    // Use persistent disk cache (default)
+    FirebaseFirestore db = testFirestore();
+    FirebaseFirestoreSettings settings =
+        new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
+            // Use persistent disk cache (default)
+            .setLocalCacheSettings(PersistentCacheSettings.newBuilder().build())
+            .build();
+    db.setFirestoreSettings(settings);
+    Tasks.await(db.getPersistentCacheIndexManager().setAutomaticIndexingEnabled(true));
+    assertTrue(db.getClient().getLocalStore().getQueryEngine().getAutomaticIndexingEnabled());
+    Tasks.await(db.getPersistentCacheIndexManager().setAutomaticIndexingEnabled(false));
+    assertFalse(db.getClient().getLocalStore().getQueryEngine().getAutomaticIndexingEnabled());
+  }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

@@ -23,6 +23,7 @@
 import androidx.annotation.Keep;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import androidx.annotation.VisibleForTesting;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
@@ -104,6 +105,8 @@ public interface InstanceRegistry {
   private volatile FirestoreClient client;
   private final GrpcMetadataProvider metadataProvider;
 
+  @Nullable private PersistentCacheManager persistentCacheManager;
+
   @NonNull
   public static FirebaseFirestore getInstance() {
     FirebaseApp app = FirebaseApp.getInstance();
@@ -355,6 +358,19 @@ public Task<Void> setIndexConfiguration(@NonNull String json) {
     return client.configureFieldIndexes(parsedIndexes);
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @Nullable
+  public PersistentCacheManager getPersistentCacheIndexManager() {
+    ensureClientConfigured();
+    if (persistentCacheManager != null) {
+      return persistentCacheManager;
+    }
+    if (settings.getCacheSettings() instanceof PersistentCacheSettings) {
+      persistentCacheManager = new PersistentCacheManager(client);
+    }
+    return persistentCacheManager;
+  }
+
   /**
    * Gets a {@code CollectionReference} instance that refers to the collection at the specified path
    * within the database.

firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheManager.java

@@ -0,0 +1,22 @@
+package com.google.firebase.firestore;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
+import com.google.android.gms.tasks.Task;
+import com.google.firebase.firestore.core.FirestoreClient;
+
+// TODO(csi): Remove the `hide` and scope annotations.
+/** @hide */
+@RestrictTo(RestrictTo.Scope.LIBRARY)
+public class PersistentCacheManager {
+  @NonNull private FirestoreClient client;
+
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  public PersistentCacheManager(FirestoreClient client) {
+    this.client = client;
+  }
+
+  public Task<Void> setAutomaticIndexingEnabled(boolean isEnabled) {
+    return client.setAutomaticIndexingEnabled(isEnabled);
+  }
+}

firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheSettings.java

@@ -14,7 +14,6 @@
 package com.google.firebase.firestore;
 
 import androidx.annotation.NonNull;
-import androidx.annotation.RestrictTo;
 
 /**
  * Configures the SDK to use a persistent cache. Firestore documents and mutations are persisted
@@ -38,11 +37,8 @@ public static PersistentCacheSettings.Builder newBuilder() {
 
   private final long sizeBytes;
 
-  private final boolean autoClientIndexingEnabled;
-
-  private PersistentCacheSettings(long sizeBytes, boolean autoClientIndexingEnabled) {
+  private PersistentCacheSettings(long sizeBytes) {
     this.sizeBytes = sizeBytes;
-    this.autoClientIndexingEnabled = autoClientIndexingEnabled;
   }
 
   @Override
@@ -78,18 +74,11 @@ public long getSizeBytes() {
     return sizeBytes;
   }
 
-  @RestrictTo(RestrictTo.Scope.LIBRARY)
-  public boolean autoClientIndexingEnabled() {
-    return autoClientIndexingEnabled;
-  }
-
   /** A Builder for creating {@code PersistentCacheSettings} instance. */
   public static class Builder {
 
     private long sizeBytes = FirebaseFirestoreSettings.DEFAULT_CACHE_SIZE_BYTES;
 
-    private boolean autoClientIndexingEnabled = false;
-
     private Builder() {}
 
     /**
@@ -109,16 +98,10 @@ public Builder setSizeBytes(long sizeBytes) {
       return this;
     }
 
-    @NonNull
-    public Builder enableAutoClientIndexing(boolean value) {
-      this.autoClientIndexingEnabled = value;
-      return this;
-    }
-
     /** Creates a {@code PersistentCacheSettings} instance from this builder instance. */
     @NonNull
     public PersistentCacheSettings build() {
-      return new PersistentCacheSettings(sizeBytes, autoClientIndexingEnabled);
+      return new PersistentCacheSettings(sizeBytes);
     }
   }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/core/FirestoreClient.java

@@ -19,6 +19,7 @@
 import android.annotation.SuppressLint;
 import android.content.Context;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.android.gms.tasks.Tasks;
@@ -139,6 +140,11 @@ public FirestoreClient(
         });
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  public LocalStore getLocalStore() {
+    return localStore;
+  }
+
   public Task<Void> disableNetwork() {
     this.verifyNotTerminated();
     return asyncQueue.enqueue(() -> remoteStore.disableNetwork());
@@ -353,6 +359,11 @@ public Task<Void> configureFieldIndexes(List<FieldIndex> fieldIndices) {
     return asyncQueue.enqueue(() -> localStore.configureFieldIndexes(fieldIndices));
   }
 
+  public Task<Void> setAutomaticIndexingEnabled(boolean isEnabled) {
+    verifyNotTerminated();
+    return asyncQueue.enqueue(() -> localStore.setAutomaticIndexingEnabled(isEnabled));
+  }
+
   public void removeSnapshotsInSyncListener(EventListener<Void> listener) {
     // Checks for shutdown but does not raise error, allowing remove after shutdown to be a no-op.
     if (isTerminated()) {

firebase-firestore/src/main/java/com/google/firebase/firestore/core/MemoryComponentProvider.java

@@ -19,7 +19,6 @@
 import com.google.firebase.firestore.FirebaseFirestoreSettings;
 import com.google.firebase.firestore.MemoryCacheSettings;
 import com.google.firebase.firestore.MemoryLruGcSettings;
-import com.google.firebase.firestore.PersistentCacheSettings;
 import com.google.firebase.firestore.local.IndexBackfiller;
 import com.google.firebase.firestore.local.LocalSerializer;
 import com.google.firebase.firestore.local.LocalStore;
@@ -61,12 +60,7 @@ protected EventManager createEventManager(Configuration configuration) {
 
   @Override
   protected LocalStore createLocalStore(Configuration configuration) {
-    boolean autoIndexEnabled =
-        configuration.getSettings().getCacheSettings() != null
-            && ((PersistentCacheSettings) configuration.getSettings().getCacheSettings())
-                .autoClientIndexingEnabled();
-    return new LocalStore(
-        getPersistence(), new QueryEngine(), configuration.getInitialUser(), autoIndexEnabled);
+    return new LocalStore(getPersistence(), new QueryEngine(), configuration.getInitialUser());
   }
 
   @Override

firebase-firestore/src/main/java/com/google/firebase/firestore/local/LocalStore.java

@@ -21,6 +21,7 @@
 import android.util.SparseArray;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import androidx.annotation.VisibleForTesting;
 import com.google.firebase.Timestamp;
 import com.google.firebase.database.collection.ImmutableSortedMap;
@@ -147,22 +148,11 @@ public final class LocalStore implements BundleCallback {
   /** Used to generate targetIds for queries tracked locally. */
   private final TargetIdGenerator targetIdGenerator;
 
-  private boolean autoIndexEnabled;
-
   public LocalStore(Persistence persistence, QueryEngine queryEngine, User initialUser) {
-    this(persistence, queryEngine, initialUser, false);
-  }
-
-  public LocalStore(
-      Persistence persistence,
-      QueryEngine queryEngine,
-      User initialUser,
-      boolean autoIndexEnabled) {
     hardAssert(
         persistence.isStarted(), "LocalStore was passed an unstarted persistence implementation");
     this.persistence = persistence;
     this.queryEngine = queryEngine;
-    this.autoIndexEnabled = autoIndexEnabled;
 
     targetCache = persistence.getTargetCache();
     bundleCache = persistence.getBundleCache();
@@ -186,7 +176,7 @@ private void initializeUserComponents(User user) {
         new LocalDocumentsView(remoteDocuments, mutationQueue, documentOverlayCache, indexManager);
 
     remoteDocuments.setIndexManager(indexManager);
-    queryEngine.initialize(localDocuments, indexManager, autoIndexEnabled);
+    queryEngine.initialize(localDocuments, indexManager);
   }
 
   public void start() {
@@ -211,6 +201,11 @@ public LocalDocumentsView getLocalDocumentsForCurrentUser() {
     return localDocuments;
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  public QueryEngine getQueryEngine() {
+    return queryEngine;
+  }
+
   // PORTING NOTE: no shutdown for LocalStore or persistence components on Android.
 
   public ImmutableSortedMap<DocumentKey, Document> handleUserChange(User user) {
@@ -813,6 +808,10 @@ public void configureFieldIndexes(List<FieldIndex> newFieldIndexes) {
         });
   }
 
+  public void setAutomaticIndexingEnabled(boolean isEnabled) {
+    queryEngine.setAutomaticIndexingEnabled(isEnabled);
+  }
+
   /** Mutable state for the transaction in allocateQuery. */
   private static class AllocateQueryHolder {
     TargetData cached;

firebase-firestore/src/main/java/com/google/firebase/firestore/local/QueryEngine.java

@@ -16,6 +16,7 @@
 
 import static com.google.firebase.firestore.util.Assert.hardAssert;
 
+import androidx.annotation.RestrictTo;
 import com.google.firebase.database.collection.ImmutableSortedMap;
 import com.google.firebase.database.collection.ImmutableSortedSet;
 import com.google.firebase.firestore.core.Query;
@@ -65,16 +66,23 @@ public class QueryEngine {
   private IndexManager indexManager;
   private boolean initialized;
 
-  private boolean autoIndexEnabled;
+  private boolean automaticIndexingEnabled = false;
 
-  public void initialize(
-      LocalDocumentsView localDocumentsView, IndexManager indexManager, boolean autoIndexEnabled) {
+  public void initialize(LocalDocumentsView localDocumentsView, IndexManager indexManager) {
     this.localDocumentsView = localDocumentsView;
     this.indexManager = indexManager;
-    this.autoIndexEnabled = autoIndexEnabled;
     this.initialized = true;
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  public boolean getAutomaticIndexingEnabled() {
+    return this.automaticIndexingEnabled;
+  }
+
+  public void setAutomaticIndexingEnabled(boolean isEnabled) {
+    this.automaticIndexingEnabled = isEnabled;
+  }
+
   public ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingQuery(
       Query query,
       SnapshotVersion lastLimboFreeSnapshotVersion,
@@ -93,7 +101,7 @@ public ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingQuery(
 
     QueryContext counter = new QueryContext();
     result = executeFullCollectionScan(query, counter);
-    if (result != null && autoIndexEnabled) {
+    if (result != null && automaticIndexingEnabled) {
       CreateCacheIndices(query, counter, result.size());
     }
     return result;

firebase-firestore/src/test/java/com/google/firebase/firestore/local/CountingQueryEngine.java

@@ -69,15 +69,14 @@ void resetCounts() {
   }
 
   @Override
-  public void initialize(
-      LocalDocumentsView localDocuments, IndexManager indexManager, boolean autoIndexEnabled) {
+  public void initialize(LocalDocumentsView localDocuments, IndexManager indexManager) {
     LocalDocumentsView wrappedView =
         new LocalDocumentsView(
             wrapRemoteDocumentCache(localDocuments.getRemoteDocumentCache()),
             localDocuments.getMutationQueue(),
             wrapOverlayCache(localDocuments.getDocumentOverlayCache()),
             indexManager);
-    queryEngine.initialize(wrappedView, indexManager, autoIndexEnabled);
+    queryEngine.initialize(wrappedView, indexManager);
   }
 
   @Override

firebase-firestore/src/test/java/com/google/firebase/firestore/local/QueryEngineTestCase.java

@@ -125,7 +125,7 @@ public ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingQuery(
             return super.getDocumentsMatchingQuery(query, offset);
           }
         };
-    queryEngine.initialize(localDocuments, indexManager, false);
+    queryEngine.initialize(localDocuments, indexManager);
   }
 
   abstract Persistence getPersistence();