implement autoClientIndexing

Author: cherylEnkidu

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

@@ -37,8 +37,11 @@ public static PersistentCacheSettings.Builder newBuilder() {
 
   private final long sizeBytes;
 
-  private PersistentCacheSettings(long sizeBytes) {
+  private final boolean autoClientIndexingEnabled;
+
+  private PersistentCacheSettings(long sizeBytes, boolean autoClientIndexingEnabled) {
     this.sizeBytes = sizeBytes;
+    this.autoClientIndexingEnabled = autoClientIndexingEnabled;
   }
 
   @Override
@@ -74,11 +77,17 @@ public long getSizeBytes() {
     return sizeBytes;
   }
 
+  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() {}
 
     /**
@@ -98,10 +107,16 @@ 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);
+      return new PersistentCacheSettings(sizeBytes, autoClientIndexingEnabled);
     }
   }
 }

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

@@ -14,6 +14,7 @@
 
 package com.google.firebase.firestore.core;
 
+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.LruDelegate;
@@ -50,6 +51,9 @@ protected Persistence createPersistence(Configuration configuration) {
         configuration.getDatabaseInfo().getPersistenceKey(),
         configuration.getDatabaseInfo().getDatabaseId(),
         serializer,
-        params);
+        params,
+        configuration.getSettings().getCacheSettings() != null
+            && ((PersistentCacheSettings) configuration.getSettings().getCacheSettings())
+                .autoClientIndexingEnabled());
   }
 }

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

@@ -78,6 +78,8 @@ enum IndexType {
   /** Removes the given field index and deletes all index values. */
   void deleteFieldIndex(FieldIndex index);
 
+  void createTargetIndices(Target target);
+
   /**
    * Returns a list of field indexes that correspond to the specified collection group.
    *

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

@@ -60,6 +60,9 @@ public void deleteFieldIndex(FieldIndex index) {
     // Field indices are not supported with memory persistence.
   }
 
+  @Override
+  public void createTargetIndices(Target target) {}
+
   @Override
   @Nullable
   public List<DocumentKey> getDocumentsMatchingTarget(Target target) {

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

@@ -85,10 +85,17 @@ public ImmutableSortedMap<DocumentKey, Document> getDocumentsMatchingQuery(
     QueryContext counter = new QueryContext();
     result = performQueryUsingRemoteKeys(query, remoteKeys, lastLimboFreeSnapshotVersion, counter);
     if (result != null) {
+      if (counter.fullScanCount > 2 * result.size()) {
+        indexManager.createTargetIndices(query.toTarget());
+      }
       return result;
     }
     counter = new QueryContext();
-    return executeFullCollectionScan(query, counter);
+    result = executeFullCollectionScan(query, counter);
+    if (counter.fullScanCount > 2 * result.size()) {
+      indexManager.createTargetIndices(query.toTarget());
+    }
+    return result;
   }
 
   /**

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

@@ -107,11 +107,17 @@ final class SQLiteIndexManager implements IndexManager {
   private boolean started = false;
   private int memoizedMaxIndexId = -1;
   private long memoizedMaxSequenceNumber = -1;
+  private boolean autoClientIndexingEnabled;
 
-  SQLiteIndexManager(SQLitePersistence persistence, LocalSerializer serializer, User user) {
+  SQLiteIndexManager(
+      SQLitePersistence persistence,
+      LocalSerializer serializer,
+      User user,
+      boolean autoClientIndexingEnabled) {
     this.db = persistence;
     this.serializer = serializer;
     this.uid = user.isAuthenticated() ? user.getUid() : "";
+    this.autoClientIndexingEnabled = autoClientIndexingEnabled;
   }
 
   @Override
@@ -233,6 +239,21 @@ public void deleteFieldIndex(FieldIndex index) {
     }
   }
 
+  @Override
+  public void createTargetIndices(Target target) {
+    hardAssert(started, "IndexManager not started");
+
+    if (!autoClientIndexingEnabled) return;
+
+    for (Target subTarget : getSubTargets(target)) {
+      IndexType type = getIndexType(subTarget);
+      if (type == IndexType.NONE) {
+        TargetIndexMatcher targetIndexMatcher = new TargetIndexMatcher(subTarget);
+        addFieldIndex(targetIndexMatcher.BuildTargetIndex());
+      }
+    }
+  }
+
   @Override
   public @Nullable String getNextCollectionGroupToUpdate() {
     hardAssert(started, "IndexManager not started");

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

@@ -85,6 +85,7 @@ public static String databaseName(String persistenceKey, DatabaseId databaseId)
 
   private final OpenHelper opener;
   private final LocalSerializer serializer;
+  private final boolean autoClientIndexingEnabled;
   private final SQLiteTargetCache targetCache;
   private final SQLiteBundleCache bundleCache;
   private final SQLiteRemoteDocumentCache remoteDocumentCache;
@@ -113,17 +114,23 @@ public SQLitePersistence(
       String persistenceKey,
       DatabaseId databaseId,
       LocalSerializer serializer,
-      LruGarbageCollector.Params params) {
+      LruGarbageCollector.Params params,
+      Boolean autoClientIndexingEnabled) {
     this(
         serializer,
         params,
-        new OpenHelper(context, serializer, databaseName(persistenceKey, databaseId)));
+        new OpenHelper(context, serializer, databaseName(persistenceKey, databaseId)),
+        autoClientIndexingEnabled);
   }
 
   public SQLitePersistence(
-      LocalSerializer serializer, LruGarbageCollector.Params params, OpenHelper openHelper) {
+      LocalSerializer serializer,
+      LruGarbageCollector.Params params,
+      OpenHelper openHelper,
+      Boolean autoClientIndexingEnabled) {
     this.opener = openHelper;
     this.serializer = serializer;
+    this.autoClientIndexingEnabled = autoClientIndexingEnabled;
     this.targetCache = new SQLiteTargetCache(this, this.serializer);
     this.bundleCache = new SQLiteBundleCache(this, this.serializer);
     this.remoteDocumentCache = new SQLiteRemoteDocumentCache(this, this.serializer);
@@ -182,7 +189,7 @@ SQLiteTargetCache getTargetCache() {
 
   @Override
   IndexManager getIndexManager(User user) {
-    return new SQLiteIndexManager(this, serializer, user);
+    return new SQLiteIndexManager(this, serializer, user, autoClientIndexingEnabled);
   }
 
   @Override

firebase-firestore/src/main/java/com/google/firebase/firestore/model/TargetIndexMatcher.java

@@ -186,6 +186,34 @@ public boolean servedByIndex(FieldIndex index) {
     return true;
   }
 
+  public FieldIndex BuildTargetIndex() {
+    List<FieldIndex.Segment> segments = new ArrayList<>();
+
+    for (FieldFilter filter : equalityFilters) {
+      boolean isArrayOperator =
+          filter.getOperator().equals(FieldFilter.Operator.ARRAY_CONTAINS)
+              || filter.getOperator().equals(FieldFilter.Operator.ARRAY_CONTAINS_ANY);
+      segments.add(
+          FieldIndex.Segment.create(
+              filter.getField(),
+              isArrayOperator
+                  ? FieldIndex.Segment.Kind.CONTAINS
+                  : FieldIndex.Segment.Kind.ASCENDING));
+    }
+
+    for (OrderBy orderBy : orderBys) {
+      segments.add(
+          FieldIndex.Segment.create(
+              orderBy.getField(),
+              orderBy.getDirection() == OrderBy.Direction.ASCENDING
+                  ? FieldIndex.Segment.Kind.ASCENDING
+                  : FieldIndex.Segment.Kind.DESCENDING));
+    }
+
+    return FieldIndex.create(
+        FieldIndex.UNKNOWN_ID, collectionId, segments, FieldIndex.INITIAL_STATE);
+  }
+
   private boolean hasMatchingEqualityFilter(FieldIndex.Segment segment) {
     for (FieldFilter filter : equalityFilters) {
       if (matchesFilter(filter, segment)) {

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

@@ -85,7 +85,7 @@ private static SQLitePersistence openSQLitePersistence(
     LocalSerializer serializer = new LocalSerializer(new RemoteSerializer(databaseId));
     Context context = ApplicationProvider.getApplicationContext();
     SQLitePersistence persistence =
-        new SQLitePersistence(context, name, databaseId, serializer, params);
+        new SQLitePersistence(context, name, databaseId, serializer, params, false);
     persistence.start();
     return persistence;
   }
@@ -100,7 +100,8 @@ private static SQLitePersistence openSQLitePersistence(
             serializer,
             params,
             new SQLitePersistence.OpenHelper(
-                context, serializer, databaseName(name, databaseId), version));
+                context, serializer, databaseName(name, databaseId), version),
+            false);
     persistence.start();
     return persistence;
   }

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

@@ -698,7 +698,7 @@ public void createsOverlaysAndMigrationTable() {
 
   private SQLiteRemoteDocumentCache createRemoteDocumentCache() {
     SQLitePersistence persistence =
-        new SQLitePersistence(serializer, LruGarbageCollector.Params.Default(), opener);
+        new SQLitePersistence(serializer, LruGarbageCollector.Params.Default(), opener, false);
     persistence.start();
     return new SQLiteRemoteDocumentCache(persistence, serializer);
   }