Add small Proto helpers

packages/firestore/src/api/user_data_writer.ts

@@ -78,7 +78,9 @@ export class UserDataWriter<T> {
   private convertServerTimestamp(value: ServerTimestampValue): unknown {
     switch (this.serverTimestampBehavior) {
       case 'previous':
-        return value.previousValue ? this.convertValue(value.previousValue) : null;
+        return value.previousValue
+          ? this.convertValue(value.previousValue)
+          : null;
       case 'estimate':
         return this.convertTimestamp(value.localWriteTime);
       default:

packages/firestore/src/model/document_key.ts

@@ -28,6 +28,10 @@ export class DocumentKey {
     );
   }
 
+  static fromName(name: string): DocumentKey {
+    return new DocumentKey(ResourcePath.fromString(name).popFirst(5));
+  }
+
   /** Returns true if the document is in the specified collectionId. */
   hasCollectionId(collectionId: string): boolean {
     return (

packages/firestore/src/model/proto_field_value.ts

@@ -33,7 +33,7 @@ import {
   normalizeByteString,
   normalizeTimestamp,
   typeOrder
-} from './proto_values';
+} from './values';
 import { Blob } from '../api/blob';
 import { GeoPoint } from '../api/geo_point';
 import { Timestamp } from '../api/timestamp';

packages/firestore/src/model/proto_values.ts → packages/firestore/src/model/values.ts

@@ -21,6 +21,7 @@ import { TypeOrder } from './field_value';
 import { assert, fail } from '../util/assert';
 import { forEach, keys, size } from '../util/obj';
 import { ByteString } from '../util/byte_string';
+import { DocumentKey } from './document_key';
 import {
   numericComparator,
   numericEquals,
@@ -359,8 +360,7 @@ function canonifyValue(value: api.Value): string {
   } else if ('bytesValue' in value) {
     return canonifyByteString(value.bytesValue!);
   } else if ('referenceValue' in value) {
-    // TODO(mrschmidt): Use document key only
-    return value.referenceValue!;
+    return canonifyReference(value.referenceValue!);
   } else if ('geoPointValue' in value) {
     return canonifyGeoPoint(value.geoPointValue!);
   } else if ('arrayValue' in value) {
@@ -385,6 +385,10 @@ function canonifyGeoPoint(geoPoint: api.LatLng): string {
   return `geo(${geoPoint.latitude},${geoPoint.longitude})`;
 }
 
+function canonifyReference(referenceValue: string): string {
+  return DocumentKey.fromName(referenceValue).toString();
+}
+
 function canonifyMap(mapValue: api.MapValue): string {
   // Iteration order in JavaScript is not guaranteed. To ensure that we generate
   // matching canonical IDs for identical maps, we need to sort the keys.
@@ -535,3 +539,57 @@ export function normalizeByteString(blob: string | Uint8Array): ByteString {
     return ByteString.fromUint8Array(blob);
   }
 }
+
+/** Returns true if `value` is an IntegerValue. */
+export function isInteger(
+  value?: api.Value | null
+): value is { integerValue: string | number } {
+  return !!value && 'integerValue' in value;
+}
+
+/** Returns true if `value` is a DoubleValue. */
+export function isDouble(
+  value?: api.Value | null
+): value is { doubleValue: string | number } {
+  return !!value && 'doubleValue' in value;
+}
+
+/** Returns true if `value` is either an IntegerValue or a DoubleValue. */
+export function isNumber(value?: api.Value | null): boolean {
+  return isInteger(value) || isDouble(value);
+}
+
+/** Returns true if `value` is an ArrayValue. */
+export function isArray(
+  value?: api.Value | null
+): value is { arrayValue: api.ArrayValue } {
+  return !!value && 'arrayValue' in value;
+}
+
+/** Returns true if `value` is a ReferenceValue. */
+export function isReferenceValue(
+  value?: api.Value | null
+): value is { referenceValue: string } {
+  return !!value && 'referenceValue' in value;
+}
+
+/** Returns true if `value` is a NullValue. */
+export function isNullValue(
+  value?: api.Value | null
+): value is { nullValue: 'NULL_VALUE' } {
+  return !!value && 'nullValue' in value;
+}
+
+/** Returns true if `value` is NaN. */
+export function isNanValue(
+  value?: api.Value | null
+): value is { doubleValue: 'NaN' | number } {
+  return !!value && isDouble(value) && isNaN(Number(value.doubleValue));
+}
+
+/** Returns true if `value` is a MapValue. */
+export function isMapValue(
+  value?: api.Value | null
+): value is { mapValue: api.MapValue } {
+  return !!value && 'mapValue' in value;
+}

packages/firestore/src/remote/serializer.ts

@@ -76,7 +76,7 @@ import {
   normalizeByteString,
   normalizeNumber,
   normalizeTimestamp
-} from '../model/proto_values';
+} from '../model/values';
 
 const DIRECTIONS = (() => {
   const dirs: { [dir: string]: api.OrderDirection } = {};

packages/firestore/src/util/types.ts

@@ -28,7 +28,7 @@ export function isNullOrUndefined(value: unknown): boolean {
 }
 
 /** Returns whether the value represents -0. */
-export function isNegativeZero(value: number) : boolean {
+export function isNegativeZero(value: number): boolean {
   // Detect if the value is -0.0. Based on polyfill from
   // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
   return value === -0 && 1 / value === 1 / -0;