Index Evaluation

Author: schmidt-sebastian

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

@@ -20,6 +20,7 @@
 import com.google.firebase.firestore.model.FieldIndex;
 import com.google.firebase.firestore.model.ResourcePath;
 import com.google.firebase.firestore.model.Values;
+import com.google.firestore.v1.ArrayValue;
 import com.google.firestore.v1.Value;
 import java.util.ArrayList;
 import java.util.List;
@@ -130,11 +131,16 @@ public Bound getLowerBound(FieldIndex fieldIndex) {
           FieldFilter fieldFilter = (FieldFilter) filter;
           switch (fieldFilter.getOperator()) {
             case LESS_THAN:
-            case NOT_IN:
             case NOT_EQUAL:
             case LESS_THAN_OR_EQUAL:
               // These filters cannot be used as a lower bound. Skip.
               break;
+            case NOT_IN:
+              lowestValue =
+                  Value.newBuilder()
+                      .setArrayValue(ArrayValue.newBuilder().addValues(Values.NULL_VALUE))
+                      .build();
+              break;
             case EQUAL:
             case IN:
             case ARRAY_CONTAINS_ANY:

firebase-firestore/src/main/java/com/google/firebase/firestore/index/IndexByteEncoder.java

@@ -0,0 +1,63 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore.index;
+
+import com.google.protobuf.ByteString;
+
+/**
+ * Implements {@link DirectionalIndexByteEncoder} using {@link OrderedCodeWriter} for the actual
+ * encoding.
+ */
+public class IndexByteEncoder extends DirectionalIndexByteEncoder {
+  // Note: This code is copied from the backend.
+
+  private final OrderedCodeWriter orderedCode;
+
+  public IndexByteEncoder() {
+    this.orderedCode = new OrderedCodeWriter();
+  }
+
+  public void seed(byte[] encodedBytes) {
+    orderedCode.seed(encodedBytes);
+  }
+
+  @Override
+  public void writeBytes(ByteString val) {
+    orderedCode.writeBytesAscending(val);
+  }
+
+  @Override
+  public void writeString(String val) {
+    orderedCode.writeUtf8Ascending(val);
+  }
+
+  @Override
+  public void writeLong(long val) {
+    orderedCode.writeSignedLongAscending(val);
+  }
+
+  @Override
+  public void writeDouble(double val) {
+    orderedCode.writeDoubleAscending(val);
+  }
+
+  public byte[] getEncodedBytes() {
+    return orderedCode.encodedBytes();
+  }
+
+  public void reset() {
+    orderedCode.reset();
+  }
+}

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

@@ -14,9 +14,14 @@
 
 package com.google.firebase.firestore.local;
 
+import androidx.annotation.Nullable;
+import com.google.firebase.firestore.core.Target;
+import com.google.firebase.firestore.model.Document;
+import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.FieldIndex;
 import com.google.firebase.firestore.model.ResourcePath;
 import java.util.List;
+import java.util.Set;
 
 /**
  * Represents a set of indexes that are used to execute queries efficiently.
@@ -41,11 +46,21 @@ public interface IndexManager {
    */
   List<ResourcePath> getCollectionParents(String collectionId);
 
+  /** Adds index entries for all indexed fields in the given document. */
+  void addIndexEntries(Document document);
+
   /**
    * Adds a field path index.
    *
    * <p>Values for this index are persisted asynchronously. The index will only be used for query
    * execution once values are persisted.
    */
   void addFieldIndex(FieldIndex index);
+
+  /**
+   * Returns the documents that match the given target based on the configured indices. Returns
+   * {@code null} if there is no active index to serve this target.
+   */
+  @Nullable
+  Set<DocumentKey> getDocumentsMatchingTarget(Target target);
 }

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

@@ -23,6 +23,7 @@
 import com.google.firebase.firestore.core.Target;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.FieldIndex;
+import com.google.firebase.firestore.model.FieldPath;
 import com.google.firebase.firestore.model.MutableDocument;
 import com.google.firebase.firestore.model.ObjectValue;
 import com.google.firebase.firestore.model.SnapshotVersion;
@@ -309,4 +310,18 @@ public Index encodeFieldIndex(FieldIndex fieldIndex) {
 
     return index.build();
   }
+
+  public FieldIndex decodeFieldIndex(String collection_group, int indexId, Index index) {
+    FieldIndex fieldIndex = new FieldIndex(collection_group, indexId);
+    for (Index.IndexField field : index.getFieldsList()) {
+      fieldIndex =
+          fieldIndex.withAddedField(
+              FieldPath.fromServerFormat(field.getFieldPath()),
+              field.getValueModeCase().equals(Index.IndexField.ValueModeCase.ARRAY_CONFIG)
+                  ? FieldIndex.Segment.Kind.CONTAINS
+                  : FieldIndex.Segment.Kind.ORDERED);
+    }
+
+    return fieldIndex;
+  }
 }

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

@@ -15,13 +15,18 @@
 
 import static com.google.firebase.firestore.util.Assert.hardAssert;
 
+import androidx.annotation.Nullable;
+import com.google.firebase.firestore.core.Target;
+import com.google.firebase.firestore.model.Document;
+import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.FieldIndex;
 import com.google.firebase.firestore.model.ResourcePath;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 /** An in-memory implementation of IndexManager. */
 class MemoryIndexManager implements IndexManager {
@@ -38,11 +43,23 @@ public List<ResourcePath> getCollectionParents(String collectionId) {
     return collectionParentsIndex.getEntries(collectionId);
   }
 
+  @Override
+  public void addIndexEntries(Document document) {
+    // Field indices are not supported with memory persistence.
+  }
+
   @Override
   public void addFieldIndex(FieldIndex index) {
     // Field indices are not supported with memory persistence.
   }
 
+  @Override
+  @Nullable
+  public Set<DocumentKey> getDocumentsMatchingTarget(Target target) {
+    // Field indices are not supported with memory persistence.
+    return null;
+  }
+
   /**
    * Internal implementation of the collection-parent index. Also used for in-memory caching by
    * SQLiteIndexManager and initial index population in SQLiteSchema.