Cleanup

Author: schmidt-sebastian

packages/firestore/src/api/user_data_reader.ts

@@ -660,7 +660,9 @@ function parseScalarValue(
     return { stringValue: value };
   } else if (value instanceof Date) {
     const timestamp = Timestamp.fromDate(value);
-    return { timestampValue: toTimestamp(context.serializer, timestamp) };
+    return {
+      timestampValue: toTimestamp(context.serializer, timestamp)
+    };
   } else if (value instanceof Timestamp) {
     // Firestore backend truncates precision down to microseconds. To ensure
     // offline mode works the same with regards to truncation, perform the
@@ -669,7 +671,9 @@ function parseScalarValue(
       value.seconds,
       Math.floor(value.nanoseconds / 1000) * 1000
     );
-    return { timestampValue: toTimestamp(context.serializer, timestamp) };
+    return {
+      timestampValue: toTimestamp(context.serializer, timestamp)
+    };
   } else if (value instanceof GeoPoint) {
     return {
       geoPointValue: {
@@ -691,8 +695,8 @@ function parseScalarValue(
     }
     return {
       referenceValue: toResourceName(
-        value._key.path,
-        value._databaseId || context.serializer.databaseId
+        value._databaseId || context.databaseId,
+        value._key.path
       )
     };
   } else if (value === undefined && context.ignoreUndefinedProperties) {

packages/firestore/src/local/indexeddb_schema.ts

@@ -483,7 +483,7 @@ export class DbMutationBatch {
     /**
      * A list of mutations to apply. All mutations will be applied atomically.
      *
-     * Mutations are serialized via JsonProtoSerializer.toMutation().
+     * Mutations are serialized via toMutation().
      */
     public mutations: api.Write[]
   ) {}

packages/firestore/src/platform_browser/browser_platform.ts

@@ -57,7 +57,7 @@ export class BrowserPlatform implements Platform {
   }
 
   newSerializer(databaseId: DatabaseId): JsonProtoSerializer {
-    return new JsonProtoSerializer(databaseId, { useProto3Json: true });
+    return new JsonProtoSerializer(databaseId, /* useProto3Json= */ true);
   }
 
   formatJSON(value: unknown): string {

packages/firestore/src/platform_node/node_platform.ts

@@ -53,8 +53,8 @@ export class NodePlatform implements Platform {
     return new NoopConnectivityMonitor();
   }
 
-  newSerializer(partitionId: DatabaseId): JsonProtoSerializer {
-    return new JsonProtoSerializer(partitionId, { useProto3Json: false });
+  newSerializer(databaseId: DatabaseId): JsonProtoSerializer {
+    return new JsonProtoSerializer(databaseId, /* useProto3Json= */ false);
   }
 
   formatJSON(value: unknown): string {

packages/firestore/src/remote/serializer.ts

@@ -103,27 +103,24 @@ function assertPresent(value: unknown, description: string): asserts value {
   debugAssert(!isNullOrUndefined(value), description + ' is missing');
 }
 
-export interface SerializerOptions {
-  /**
-   * The serializer supports both Protobuf.js and Proto3 JSON formats. By
-   * setting serializer.flag to true, the serializer will use the Proto3 JSON format.
-   *
-   * For a description of the Proto3 JSON format check
-   * https://developers.google.com/protocol-buffers/docs/proto3#json
-   */
-  useProto3Json: boolean;
-}
-
 /**
- * Generates JsonObject values for the Datastore API suitable for sending to
- * either GRPC stub methods or via the JSON/HTTP REST API.
+ * This class generates JsonObject values for the Datastore API suitable for
+ * sending to either GRPC stub methods or via the JSON/HTTP REST API.
+ *
+ * The serializer supports both Protobuf.js and Proto3 JSON formats. By
+ * setting `useProto3Json` to true, the serializer will use the Proto3 JSON
+ * format.
+ *
+ * For a description of the Proto3 JSON format check
+ * https://developers.google.com/protocol-buffers/docs/proto3#json
+ *
  * TODO(klimt): We can remove the databaseId argument if we keep the full
  * resource name in documents.
  */
 export class JsonProtoSerializer {
   constructor(
     readonly databaseId: DatabaseId,
-    readonly options: SerializerOptions
+    readonly useProto3Json: boolean
   ) {}
 }
 
@@ -145,7 +142,7 @@ function toInt32Proto(
   serializer: JsonProtoSerializer,
   val: number | null
 ): number | { value: number } | null {
-  if (serializer.options.useProto3Json || isNullOrUndefined(val)) {
+  if (serializer.useProto3Json || isNullOrUndefined(val)) {
     return val;
   } else {
     return { value: val };
@@ -183,7 +180,7 @@ export function toDouble(
   serializer: JsonProtoSerializer,
   value: number
 ): api.Value {
-  if (serializer.options.useProto3Json) {
+  if (serializer.useProto3Json) {
     if (isNaN(value)) {
       return { doubleValue: 'NaN' };
     } else if (value === Infinity) {
@@ -214,7 +211,7 @@ export function toTimestamp(
   serializer: JsonProtoSerializer,
   timestamp: Timestamp
 ): api.Timestamp {
-  if (serializer.options.useProto3Json) {
+  if (serializer.useProto3Json) {
     // Serialize to ISO-8601 date format, but with full nano resolution.
     // Since JS Date has only millis, let's only use it for the seconds and
     // then manually add the fractions to the end.
@@ -248,7 +245,7 @@ export function toBytes(
   serializer: JsonProtoSerializer,
   bytes: Blob | ByteString
 ): string | Uint8Array {
-  if (serializer.options.useProto3Json) {
+  if (serializer.useProto3Json) {
     return bytes.toBase64();
   } else {
     return bytes.toUint8Array();
@@ -262,7 +259,7 @@ export function fromBytes(
   serializer: JsonProtoSerializer,
   value: string | Uint8Array | undefined
 ): ByteString {
-  if (serializer.options.useProto3Json) {
+  if (serializer.useProto3Json) {
     hardAssert(
       value === undefined || typeof value === 'string',
       'value must be undefined or a string when using proto3 Json'
@@ -290,8 +287,8 @@ export function fromVersion(version: api.Timestamp): SnapshotVersion {
 }
 
 export function toResourceName(
-  path: ResourcePath,
-  databaseId: DatabaseId
+  databaseId: DatabaseId,
+  path: ResourcePath
 ): string {
   return fullyQualifiedPrefixPath(databaseId)
     .child('documents')
@@ -312,7 +309,7 @@ export function toName(
   serializer: JsonProtoSerializer,
   key: DocumentKey
 ): string {
-  return toResourceName(key.path, serializer.databaseId);
+  return toResourceName(serializer.databaseId, key.path);
 }
 
 export function fromName(
@@ -342,7 +339,7 @@ function toQueryPath(
   serializer: JsonProtoSerializer,
   path: ResourcePath
 ): string {
-  return toResourceName(path, serializer.databaseId);
+  return toResourceName(serializer.databaseId, path);
 }
 
 function fromQueryPath(name: string): ResourcePath {
@@ -711,7 +708,7 @@ function fromWriteResult(
     // deletes of non-existing documents (rather than null). This breaks the
     // test "get deleted doc while offline with source=cache" as NoDocuments
     // with version 0 are filtered by IndexedDb's RemoteDocumentCache.
-    // TODO(#2149): Remove serializer.when Emulator is fixed
+    // TODO(#2149): Remove this when Emulator is fixed
     version = fromVersion(commitTime);
   }
 

packages/firestore/test/unit/local/indexeddb_persistence.test.ts

@@ -122,9 +122,10 @@ async function withUnstartedCustomPersistence(
     queue: AsyncQueue
   ) => Promise<void>
 ): Promise<void> {
-  const serializer = new JsonProtoSerializer(TEST_DATABASE_ID, {
-    useProto3Json: true
-  });
+  const serializer = new JsonProtoSerializer(
+    TEST_DATABASE_ID,
+    /* useProto3Json= */ true
+  );
 
   const queue = new AsyncQueue();
   const platform = new TestPlatform(

packages/firestore/test/unit/local/persistence_test_helpers.ts

@@ -86,9 +86,10 @@ export const INDEXEDDB_TEST_DATABASE_NAME =
   IndexedDbPersistence.buildStoragePrefix(TEST_DATABASE_INFO) +
   IndexedDbPersistence.MAIN_DATABASE;
 
-const JSON_SERIALIZER = new JsonProtoSerializer(TEST_DATABASE_ID, {
-  useProto3Json: true
-});
+const JSON_SERIALIZER = new JsonProtoSerializer(
+  TEST_DATABASE_ID,
+  /* useProto3Json= */ true
+);
 
 /**
  * IndexedDb serializer that uses `TEST_DATABASE_ID` as its database

packages/firestore/test/unit/remote/serializer.helper.ts

@@ -124,7 +124,7 @@ export function serializerTest(
 ): void {
   describe('Serializer', () => {
     const partition = new DatabaseId('p', 'd');
-    const s = new JsonProtoSerializer(partition, { useProto3Json: false });
+    const s = new JsonProtoSerializer(partition, /* useProto3Json= */ false);
 
     /**
      * Wraps the given target in TargetData. This is useful because the APIs we're

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -210,9 +210,10 @@ abstract class TestRunner {
     this.queue = new AsyncQueue();
     this.queue.skipDelaysForTimerId(TimerId.ListenStreamConnectionBackoff);
 
-    this.serializer = new JsonProtoSerializer(this.databaseInfo.databaseId, {
-      useProto3Json: true
-    });
+    this.serializer = new JsonProtoSerializer(
+      this.databaseInfo.databaseId,
+      /* useProto3Json= */ true
+    );
 
     this.useGarbageCollection = config.useGarbageCollection;
     this.numClients = config.numClients;

packages/firestore/test/util/helpers.ts

@@ -112,7 +112,7 @@ export function testUserDataReader(useProto3Json?: boolean): UserDataReader {
     databaseId,
     /* ignoreUndefinedProperties= */ false,
     useProto3Json !== undefined
-      ? new JsonProtoSerializer(databaseId, { useProto3Json })
+      ? new JsonProtoSerializer(databaseId, useProto3Json)
       : undefined
   );
 }

packages/firestore/test/util/spec_test_helpers.ts

@@ -34,9 +34,10 @@ import {
 } from '../../src/remote/serializer';
 import { TEST_DATABASE_ID } from '../unit/local/persistence_test_helpers';
 
-const serializer = new JsonProtoSerializer(TEST_DATABASE_ID, {
-  useProto3Json: true
-});
+const serializer = new JsonProtoSerializer(
+  TEST_DATABASE_ID,
+  /* useProto3Json= */ true
+);
 
 export function encodeWatchChange(
   watchChange: WatchChange