Tests and fixes

MarkDuckworth · MarkDuckworth · commit a974933f0f86 · 2024-05-03T13:40:10.000-06:00
diff --git a/common/api-review/firestore-lite.api.md b/common/api-review/firestore-lite.api.md
@@ -460,6 +460,16 @@ export function updateDoc<AppModelType, DbModelType extends DocumentData>(refere
 // @public
 export function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
 
+// @public
+export function vector(values?: number[]): VectorValue;
+
+// @public
+export class VectorValue {
+    /* Excluded from this release type: __constructor */
+    isEqual(other: VectorValue): boolean;
+    toArray(): number[];
+}
+
 // @public
 export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;
 
diff --git a/common/api-review/firestore.api.md b/common/api-review/firestore.api.md
@@ -745,6 +745,16 @@ export function updateDoc<AppModelType, DbModelType extends DocumentData>(refere
 // @public
 export function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
 
+// @public
+export function vector(values?: number[]): VectorValue;
+
+// @public
+export class VectorValue {
+    /* Excluded from this release type: __constructor */
+    isEqual(other: VectorValue): boolean;
+    toArray(): number[];
+}
+
 // @public
 export function waitForPendingWrites(firestore: Firestore): Promise<void>;
 
diff --git a/packages/firestore/lite/index.ts b/packages/firestore/lite/index.ts
@@ -127,7 +127,8 @@ export {
   arrayRemove,
   arrayUnion,
   serverTimestamp,
-  deleteField
+  deleteField,
+  vector
 } from '../src/lite-api/field_value_impl';
 
 export {
@@ -138,6 +139,8 @@ export {
   snapshotEqual
 } from '../src/lite-api/snapshot';
 
+export { VectorValue } from '../src/lite-api/vector_value';
+
 export { WriteBatch, writeBatch } from '../src/lite-api/write_batch';
 
 export { TransactionOptions } from '../src/lite-api/transaction_options';
diff --git a/packages/firestore/src/api.ts b/packages/firestore/src/api.ts
@@ -172,9 +172,12 @@ export {
   arrayUnion,
   deleteField,
   increment,
-  serverTimestamp
+  serverTimestamp,
+  vector
 } from './api/field_value_impl';
 
+export { VectorValue } from './lite-api/vector_value';
+
 export { LogLevelString as LogLevel, setLogLevel } from './util/log';
 
 export { Bytes } from './api/bytes';
diff --git a/packages/firestore/src/api/field_value_impl.ts b/packages/firestore/src/api/field_value_impl.ts
@@ -20,5 +20,6 @@ export {
   arrayRemove,
   arrayUnion,
   serverTimestamp,
-  deleteField
+  deleteField,
+  vector
 } from '../lite-api/field_value_impl';
diff --git a/packages/firestore/src/index/firestore_index_value_writer.ts b/packages/firestore/src/index/firestore_index_value_writer.ts
@@ -16,13 +16,16 @@
  */
 
 import { DocumentKey } from '../model/document_key';
-import { isVectorValue, VECTOR_MAP_VECTORS_KEY } from '../model/map_type';
 import {
   normalizeByteString,
   normalizeNumber,
   normalizeTimestamp
 } from '../model/normalize';
-import { isMaxValue } from '../model/values';
+import {
+  isVectorValue,
+  VECTOR_MAP_VECTORS_KEY,
+  isMaxValue
+} from '../model/values';
 import { ArrayValue, MapValue, Value } from '../protos/firestore_proto_api';
 import { fail } from '../util/assert';
 import { isNegativeZero } from '../util/types';
diff --git a/packages/firestore/src/lite-api/user_data_reader.ts b/packages/firestore/src/lite-api/user_data_reader.ts
@@ -26,7 +26,6 @@ import { ParseContext } from '../api/parse_context';
 import { DatabaseId } from '../core/database_info';
 import { DocumentKey } from '../model/document_key';
 import { FieldMask } from '../model/field_mask';
-import { vectorValue } from '../model/map_type';
 import {
   FieldTransform,
   Mutation,
@@ -42,6 +41,11 @@ import {
   NumericIncrementTransformOperation,
   ServerTimestampTransform
 } from '../model/transform_operation';
+import {
+  TYPE_KEY,
+  VECTOR_MAP_VECTORS_KEY,
+  VECTOR_VALUE_SENTINEL
+} from '../model/values';
 import { newSerializer } from '../platform/serializer';
 import {
   MapValue as ProtoMapValue,
@@ -903,16 +907,39 @@ function parseScalarValue(
         value._key.path
       )
     };
-  }
-  if (value instanceof VectorValue) {
-    return vectorValue(value);
+  } else if (value instanceof VectorValue) {
+    return parseVectorValue(value);
   } else {
     throw context.createError(
       `Unsupported field value: ${valueDescription(value)}`
     );
   }
 }
 
+/**
+ * Creates a new VectorValue proto value (using the internal format).
+ */
+export function parseVectorValue(value: VectorValue): ProtoValue {
+  const mapValue: ProtoMapValue = {
+    fields: {
+      [TYPE_KEY]: {
+        stringValue: VECTOR_VALUE_SENTINEL
+      },
+      [VECTOR_MAP_VECTORS_KEY]: {
+        arrayValue: {
+          values: value.toArray().map(value => {
+            return {
+              doubleValue: value
+            };
+          })
+        }
+      }
+    }
+  };
+
+  return { mapValue };
+}
+
 /**
  * Checks whether an object looks like a JSON object that should be converted
  * into a struct. Normal class/prototype instances are considered to look like
diff --git a/packages/firestore/src/lite-api/user_data_writer.ts b/packages/firestore/src/lite-api/user_data_writer.ts
@@ -19,7 +19,6 @@ import { DocumentData } from '@firebase/firestore-types';
 
 import { DatabaseId } from '../core/database_info';
 import { DocumentKey } from '../model/document_key';
-import { VECTOR_MAP_VECTORS_KEY } from '../model/map_type';
 import {
   normalizeByteString,
   normalizeNumber,
@@ -31,7 +30,7 @@ import {
   getPreviousValue
 } from '../model/server_timestamps';
 import { TypeOrder } from '../model/type_order';
-import { typeOrder } from '../model/values';
+import { VECTOR_MAP_VECTORS_KEY, typeOrder } from '../model/values';
 import {
   ApiClientObjectMap,
   ArrayValue as ProtoArrayValue,
diff --git a/packages/firestore/src/model/map_type.ts b/packages/firestore/src/model/map_type.ts
diff --git a/packages/firestore/src/model/values.ts b/packages/firestore/src/model/values.ts
@@ -21,6 +21,7 @@ import {
   LatLng,
   MapValue,
   Timestamp,
+  Value as ProtoValue,
   Value
 } from '../protos/firestore_proto_api';
 import { fail } from '../util/assert';
@@ -29,7 +30,6 @@ import { forEach, objectSize } from '../util/obj';
 import { isNegativeZero } from '../util/types';
 
 import { DocumentKey } from './document_key';
-import { isVectorValue, VECTOR_MAP_VECTORS_KEY } from './map_type';
 import {
   normalizeByteString,
   normalizeNumber,
@@ -42,6 +42,7 @@ import {
 } from './server_timestamps';
 import { TypeOrder } from './type_order';
 
+export const TYPE_KEY = '__type__';
 const MAX_VALUE_TYPE = '__max__';
 export const MAX_VALUE: Value = {
   mapValue: {
@@ -51,6 +52,9 @@ export const MAX_VALUE: Value = {
   }
 };
 
+export const VECTOR_VALUE_SENTINEL = '__vector__';
+export const VECTOR_MAP_VECTORS_KEY = 'value';
+
 export const MIN_VALUE: Value = {
   nullValue: 'NULL_VALUE'
 };
@@ -615,6 +619,12 @@ export function isMapValue(
   return !!value && 'mapValue' in value;
 }
 
+/** Returns true if `value` is a VetorValue. */
+export function isVectorValue(value: ProtoValue | null): boolean {
+  const type = (value?.mapValue?.fields || {})[TYPE_KEY]?.stringValue;
+  return type === VECTOR_VALUE_SENTINEL;
+}
+
 /** Creates a deep copy of `source`. */
 export function deepClone(source: Value): Value {
   if (source.geoPointValue) {
@@ -650,6 +660,17 @@ export function isMaxValue(value: Value): boolean {
   );
 }
 
+export const MIN_VECTOR_VALUE = {
+  mapValue: {
+    fields: {
+      [TYPE_KEY]: { stringValue: VECTOR_VALUE_SENTINEL },
+      [VECTOR_MAP_VECTORS_KEY]: {
+        arrayValue: {}
+      }
+    }
+  }
+};
+
 /** Returns the lowest value for the given value type (inclusive). */
 export function valuesGetLowerBound(value: Value): Value {
   if ('nullValue' in value) {
@@ -671,6 +692,9 @@ export function valuesGetLowerBound(value: Value): Value {
   } else if ('arrayValue' in value) {
     return { arrayValue: {} };
   } else if ('mapValue' in value) {
+    if (isVectorValue(value)) {
+      return MIN_VECTOR_VALUE;
+    }
     return { mapValue: {} };
   } else {
     return fail('Invalid value type: ' + JSON.stringify(value));
@@ -696,8 +720,11 @@ export function valuesGetUpperBound(value: Value): Value {
   } else if ('geoPointValue' in value) {
     return { arrayValue: {} };
   } else if ('arrayValue' in value) {
-    return { mapValue: {} };
+    return MIN_VECTOR_VALUE;
   } else if ('mapValue' in value) {
+    if (isVectorValue(value)) {
+      return { mapValue: {} };
+    }
     return MAX_VALUE;
   } else {
     return fail('Invalid value type: ' + JSON.stringify(value));
diff --git a/packages/firestore/test/lite/integration.test.ts b/packages/firestore/test/lite/integration.test.ts
@@ -42,7 +42,8 @@ import {
   arrayUnion,
   deleteField,
   increment,
-  serverTimestamp
+  serverTimestamp,
+  vector
 } from '../../src/lite-api/field_value_impl';
 import {
   endAt,
@@ -2934,3 +2935,28 @@ describe('Aggregate queries - sum / average', () => {
     }
   );
 });
+
+describe('Vectors', () => {
+  it('can be read and written using the lite SDK', async () => {
+    return withTestCollection(async coll => {
+      const ref = await addDoc(coll, {
+        vector0: vector([0.0]),
+        vector1: vector([1, 2, 3.99])
+      });
+      await setDoc(ref, {
+        vector0: vector([0.0]),
+        vector1: vector([1, 2, 3.99]),
+        vector2: vector([0, 0, 0])
+      });
+      await updateDoc(ref, {
+        vector3: vector([-1, -200, -999])
+      });
+
+      const snap1 = await getDoc(ref);
+      expect(snap1.get('vector0').isEqual(vector([0.0]))).to.be.true;
+      expect(snap1.get('vector1').isEqual(vector([1, 2, 3.99]))).to.be.true;
+      expect(snap1.get('vector2').isEqual(vector([0, 0, 0]))).to.be.true;
+      expect(snap1.get('vector3').isEqual(vector([-1, -200, -999]))).to.be.true;
+    });
+  });
+});
diff --git a/packages/firestore/test/unit/local/index_manager.test.ts b/packages/firestore/test/unit/local/index_manager.test.ts
@@ -1124,13 +1124,13 @@ describe('IndexedDbIndexManager', async () => {
       query('coll'),
       filter('embedding', '>', vector([4, 5, 6]))
     );
-    await verifyResults(q, 'coll/map2');
+    await verifyResults(q);
 
     q = queryWithAddedFilter(
       query('coll'),
       filter('embedding', '>=', vector([4]))
     );
-    await verifyResults(q, 'coll/doc4', 'coll/doc3', 'coll/map2');
+    await verifyResults(q, 'coll/doc4', 'coll/doc3');
   });
 
   it('support advances queries', async () => {
diff --git a/packages/firestore/test/unit/model/object_value.test.ts b/packages/firestore/test/unit/model/object_value.test.ts
diff --git a/packages/firestore/test/unit/model/values.test.ts b/packages/firestore/test/unit/model/values.test.ts
diff --git a/packages/firestore/test/unit/remote/serializer.helper.ts b/packages/firestore/test/unit/remote/serializer.helper.ts
