VectorValue type support for Firestore.

Author: MarkDuckworth

firebase-firestore/README.md

@@ -113,7 +113,7 @@ it on behalf.
 
 Run below to format Java code:
 ```bash
-./gradlew :firebase-firestore:googleJavaFormat
+./gradlew :firebase-firestore:spotlessApply
 ```
 
 See [here](../README.md#code-formatting) if you want to be able to format code

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

@@ -34,7 +34,7 @@
 
 @RunWith(AndroidJUnit4.class)
 public class NumericTransformsTest {
-  private static final double DOUBLE_EPSILON = 0.000001;
+  public static final double DOUBLE_EPSILON = 0.000001;
 
   // A document reference to read and write to.
   private DocumentReference docRef;

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

@@ -484,6 +484,18 @@ public DocumentReference getReference() {
     return new DocumentReference(key, firestore);
   }
 
+  /**
+   * Returns the value of the field as a VectorValue.
+   *
+   * @param field The path to the field.
+   * @throws RuntimeException if the value is not a VectorValue.
+   * @return The value of the field.
+   */
+  @Nullable
+  public VectorValue getVectorValue(@NonNull String field) {
+    return (VectorValue) get(field);
+  }
+
   @Nullable
   private <T> T getTypedValue(String field, Class<T> clazz) {
     checkNotNull(field, "Provided field must not be null.");

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

@@ -182,4 +182,15 @@ public static FieldValue increment(long l) {
   public static FieldValue increment(double l) {
     return new NumericIncrementFieldValue(l);
   }
+
+  /**
+   * Creates a new {@link VectorValue} constructed with a copy of the given array of doubles.
+   *
+   * @param values Create a {@link VectorValue} instance with a copy of this array of doubles.
+   * @return A new {@link VectorValue} constructed with a copy of the given array of doubles.
+   */
+  @NonNull
+  public static VectorValue vector(@NonNull double[] values) {
+    return new VectorValue(values);
+  }
 }

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

@@ -32,6 +32,7 @@
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.model.FieldPath;
 import com.google.firebase.firestore.model.ObjectValue;
+import com.google.firebase.firestore.model.Values;
 import com.google.firebase.firestore.model.mutation.ArrayTransformOperation;
 import com.google.firebase.firestore.model.mutation.FieldMask;
 import com.google.firebase.firestore.model.mutation.NumericIncrementTransformOperation;
@@ -45,11 +46,13 @@
 import com.google.protobuf.NullValue;
 import com.google.type.LatLng;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Date;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.stream.Collectors;
 
 /**
  * Helper for parsing raw user input (provided via the API) into internal model classes.
@@ -440,13 +443,26 @@ private Value parseScalarValue(Object input, ParseContext context) {
                   databaseId.getDatabaseId(),
                   ((DocumentReference) input).getPath()))
           .build();
+    } else if (input instanceof VectorValue) {
+      return parseVectorValue(((VectorValue) input), context);
     } else if (input.getClass().isArray()) {
       throw context.createError("Arrays are not supported; use a List instead");
     } else {
       throw context.createError("Unsupported type: " + Util.typeName(input));
     }
   }
 
+  private Value parseVectorValue(VectorValue vector, ParseContext context) {
+    MapValue.Builder mapBuilder = MapValue.newBuilder();
+
+    mapBuilder.putFields(Values.TYPE_KEY, Values.VECTOR_VALUE_TYPE);
+    mapBuilder.putFields(
+        Values.VECTOR_MAP_VECTORS_KEY,
+        parseData(Arrays.stream(vector.toArray()).boxed().collect(Collectors.toList()), context));
+
+    return Value.newBuilder().setMapValue(mapBuilder).build();
+  }
+
   private Value parseTimestamp(Timestamp timestamp) {
     // Firestore backend truncates precision down to microseconds. To ensure offline mode works
     // the same with regards to truncation, perform the truncation immediately without waiting for

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

@@ -27,13 +27,15 @@
 import static com.google.firebase.firestore.model.Values.TYPE_ORDER_SERVER_TIMESTAMP;
 import static com.google.firebase.firestore.model.Values.TYPE_ORDER_STRING;
 import static com.google.firebase.firestore.model.Values.TYPE_ORDER_TIMESTAMP;
+import static com.google.firebase.firestore.model.Values.TYPE_ORDER_VECTOR;
 import static com.google.firebase.firestore.model.Values.typeOrder;
 import static com.google.firebase.firestore.util.Assert.fail;
 
 import androidx.annotation.RestrictTo;
 import com.google.firebase.Timestamp;
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.model.DocumentKey;
+import com.google.firebase.firestore.model.Values;
 import com.google.firebase.firestore.util.Logger;
 import com.google.firestore.v1.ArrayValue;
 import com.google.firestore.v1.Value;
@@ -86,6 +88,8 @@ public Object convertValue(Value value) {
       case TYPE_ORDER_GEOPOINT:
         return new GeoPoint(
             value.getGeoPointValue().getLatitude(), value.getGeoPointValue().getLongitude());
+      case TYPE_ORDER_VECTOR:
+        return convertVectorValue(value.getMapValue().getFieldsMap());
       default:
         throw fail("Unknown value type: " + value.getValueTypeCase());
     }
@@ -99,6 +103,14 @@ Map<String, Object> convertObject(Map<String, Value> mapValue) {
     return result;
   }
 
+  VectorValue convertVectorValue(Map<String, Value> mapValue) {
+    double[] values =
+        mapValue.get(Values.VECTOR_MAP_VECTORS_KEY).getArrayValue().getValuesList().stream()
+            .mapToDouble(val -> val.getDoubleValue())
+            .toArray();
+    return new VectorValue(values);
+  }
+
   private Object convertServerTimestamp(Value serverTimestampValue) {
     switch (serverTimestampBehavior) {
       case PREVIOUS:

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

@@ -0,0 +1,48 @@
+package com.google.firebase.firestore;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import java.io.Serializable;
+import java.util.Arrays;
+
+public class VectorValue implements Serializable {
+  private final double[] values;
+
+  VectorValue(@Nullable double[] values) {
+    if (values == null) this.values = new double[] {};
+    else this.values = values.clone();
+  }
+
+  /**
+   * Returns a representation of the vector as an array of doubles.
+   *
+   * @return A representation of the vector as an array of doubles
+   */
+  @NonNull
+  public double[] toArray() {
+    return this.values.clone();
+  }
+
+  /**
+   * Returns true if this VectorValue is equal to the provided object.
+   *
+   * @param obj The object to compare against.
+   * @return Whether this VectorValue is equal to the provided object.
+   */
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj) {
+      return true;
+    }
+    if (obj == null || getClass() != obj.getClass()) {
+      return false;
+    }
+    VectorValue otherArray = (VectorValue) obj;
+    return Arrays.equals(this.values, otherArray.values);
+  }
+
+  @Override
+  public int hashCode() {
+    return Arrays.hashCode(values);
+  }
+}

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

@@ -246,7 +246,7 @@ private Pair<Value, Boolean> getAscendingBound(
       switch (fieldFilter.getOperator()) {
         case LESS_THAN:
         case LESS_THAN_OR_EQUAL:
-          filterValue = Values.getLowerBound(fieldFilter.getValue().getValueTypeCase());
+          filterValue = Values.getLowerBound(fieldFilter.getValue());
           break;
         case EQUAL:
         case IN:
@@ -311,7 +311,7 @@ private Pair<Value, Boolean> getDescendingBound(
       switch (fieldFilter.getOperator()) {
         case GREATER_THAN_OR_EQUAL:
         case GREATER_THAN:
-          filterValue = Values.getUpperBound(fieldFilter.getValue().getValueTypeCase());
+          filterValue = Values.getUpperBound(fieldFilter.getValue());
           filterInclusive = false;
           break;
         case EQUAL:

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

@@ -41,6 +41,7 @@ public class FirestoreIndexValueWriter {
   public static final int INDEX_TYPE_REFERENCE = 37;
   public static final int INDEX_TYPE_GEOPOINT = 45;
   public static final int INDEX_TYPE_ARRAY = 50;
+  public static final int INDEX_TYPE_VECTOR = 53;
   public static final int INDEX_TYPE_MAP = 55;
   public static final int INDEX_TYPE_REFERENCE_SEGMENT = 60;
 
@@ -114,6 +115,9 @@ private void writeIndexValueAux(Value indexValue, DirectionalIndexByteEncoder en
         if (Values.isMaxValue(indexValue)) {
           writeValueTypeLabel(encoder, Integer.MAX_VALUE);
           break;
+        } else if (Values.isVectorValue(indexValue)) {
+          writeIndexVector(indexValue.getMapValue(), encoder);
+          break;
         }
         writeIndexMap(indexValue.getMapValue(), encoder);
         writeTruncationMarker(encoder);
@@ -139,6 +143,22 @@ private void writeUnlabeledIndexString(
   }
 
   private void writeIndexMap(MapValue mapIndexValue, DirectionalIndexByteEncoder encoder) {
+    writeValueTypeLabel(encoder, INDEX_TYPE_VECTOR);
+
+    Map<String, Value> map = mapIndexValue.getFieldsMap();
+
+    // Vectors sort first by length
+    String key = Values.VECTOR_MAP_VECTORS_KEY;
+    int length = map.get(key).getArrayValue().getValuesCount();
+    this.writeValueTypeLabel(encoder, INDEX_TYPE_VECTOR);
+    encoder.writeLong(length);
+
+    // Vectors then sort by position value
+    this.writeIndexString(key, encoder);
+    this.writeIndexValueAux(map.get(key), encoder);
+  }
+
+  private void writeIndexVector(MapValue mapIndexValue, DirectionalIndexByteEncoder encoder) {
     writeValueTypeLabel(encoder, INDEX_TYPE_MAP);
     for (Map.Entry<String, Value> entry : mapIndexValue.getFieldsMap().entrySet()) {
       String key = entry.getKey();