address mike's comments

Author: Feiyang1

packages/firestore/src/api/database.ts

@@ -105,10 +105,6 @@ import {
   UserDataConverter
 } from './user_data_converter';
 
-// The objects that are a part of this API are exposed to third-parties as
-// compiled javascript so we want to flag our private members with a leading
-// underscore to discourage their use.
-
 // settings() defaults:
 const DEFAULT_HOST = 'firestore.googleapis.com';
 const DEFAULT_SSL = true;
@@ -299,6 +295,9 @@ class FirestoreConfig {
  * The root reference to the database.
  */
 export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
+  // The objects that are a part of this API are exposed to third-parties as
+  // compiled javascript so we want to flag our private members with a leading
+  // underscore to discourage their use.
   private readonly _config: FirestoreConfig;
   readonly _databaseId: DatabaseId;
 

packages/firestore/src/api/field_value.ts

@@ -29,7 +29,6 @@ import {
  * An opaque base class for FieldValue sentinel objects in our public API,
  * with public static methods for creating said sentinel objects.
  */
-// We use this as a base class.
 export abstract class FieldValueImpl implements firestore.FieldValue {
   protected constructor(readonly _methodName: string) {}
 

packages/firestore/src/core/sync_engine.ts

@@ -248,7 +248,6 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
         .then(remoteKeys => {
           const view = new View(query, remoteKeys);
           const viewDocChanges = view.computeDocChanges(docs);
-          // Prettier formats this exceed 100 characters.
           const synthesizedTargetChange = TargetChange.createSynthesizedTargetChangeForCurrentChange(
             queryData.targetId,
             current && this.onlineState !== OnlineState.Offline
@@ -976,7 +975,6 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
         case 'not-current': {
           return this.localStore.getNewDocumentChanges().then(
             async changes => {
-              // tslint and prettier disagree about their preferred line length.
               const synthesizedRemoteEvent = RemoteEvent.createSynthesizedRemoteEventForCurrentChange(
                 targetId,
                 state === 'current'

packages/firestore/src/local/indexeddb_mutation_queue.ts

@@ -165,8 +165,7 @@ export class IndexedDbMutationQueue implements MutationQueue {
     // mutation batch.
     // See: https://bugs.chromium.org/p/chromium/issues/detail?id=701972
 
-    // We write an empty object to obtain key
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, We write an empty object to obtain key
     return mutationStore.add({} as any).next(batchId => {
       assert(typeof batchId === 'number', 'Auto-generated key is not a number');
 

packages/firestore/src/local/persistence_promise.ts

@@ -42,9 +42,7 @@ export type Rejector = (error: Error) => void;
 export class PersistencePromise<T> {
   // NOTE: next/catchCallback will always point to our own wrapper functions,
   // not the user's raw next() or catch() callbacks.
-  // Accept any result type for the next call in the Promise chain.
   private nextCallback: FulfilledHandler<T, unknown> = null;
-  // Accept any result type for the error handler.
   private catchCallback: RejectedHandler<unknown> = null;
 
   // When the operation resolves, we'll set result or error and mark isDone.
@@ -168,8 +166,7 @@ export class PersistencePromise<T> {
   }
 
   static waitFor(
-    // Accept all Promise types in waitFor().
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, Accept all Promise types in waitFor().
     all: { forEach: (cb: (el: PersistencePromise<any>) => void) => void }
   ): PersistencePromise<void> {
     return new PersistencePromise<void>((resolve, reject) => {

packages/firestore/src/local/simple_db.ts

@@ -485,8 +485,7 @@ export class SimpleDbStore<
    */
   get(key: KeyType): PersistencePromise<ValueType | null> {
     const request = this.store.get(key);
-    // We're doing an unsafe cast to ValueType.
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, We're doing an unsafe cast to ValueType.
     return wrapRequest<any>(request).next(result => {
       // Normalize nonexistence to null.
       if (result === undefined) {

packages/firestore/src/platform/config/goog_module_config.ts

@@ -17,7 +17,6 @@
 
 import { configureForStandalone } from '../config';
 
-/* eslint-disable camelcase */
 
 /**
  * Magic variable that is used to export the Firestore namespace.
@@ -30,8 +29,9 @@ import { configureForStandalone } from '../config';
  * Note that name was chosen arbitrarily but was intended to not conflict with
  * any other variable in scope.
  */
+// eslint-disable-next-line camelcase
 declare let __firestore_exports__: { [key: string]: {} };
-
+// eslint-disable-next-line camelcase
 if (typeof __firestore_exports__ !== 'undefined') {
   configureForStandalone(__firestore_exports__);
 } else {

packages/firestore/src/platform_browser/webchannel_connection.ts

@@ -97,8 +97,7 @@ export class WebChannelConnection implements Connection {
     const url = this.makeUrl(rpcName);
 
     return new Promise((resolve: Resolver<Resp>, reject: Rejecter) => {
-      // XhrIo doesn't have TS typings.
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any, XhrIo doesn't have TS typings.
       const xhr: any = new XhrIo();
       xhr.listenOnce(EventType.COMPLETE, () => {
         try {

packages/firestore/src/util/error.ts

@@ -24,7 +24,6 @@ import * as firestore from '@firebase/firestore-types';
 export type Code = firestore.FirestoreErrorCode;
 
 // TODO(mcg): Change to a string enum once we've upgraded to typescript 2.4.
-// Intended to look like a TS 2.4 enum
 export const Code = {
   // Causes are copied from:
   // https://github.com/grpc/grpc/blob/bceec94ea4fc5f0085d81235d8e1c06798dc341a/include/grpc%2B%2B/impl/codegen/status_code_enum.h

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

@@ -1126,19 +1126,18 @@ function genericLocalStoreTests(
     );
   });
 
-  /* eslint-disable camelcase */
   it('holds back only non-idempotent transforms', () => {
     const query = Query.atPath(path('foo'));
     return (
       expectLocalStore()
         .afterAllocatingQuery(query)
         .toReturnTargetId(2)
-        .after(setMutation('foo/bar', { sum: 0, array_union: [] }))
+        .after(setMutation('foo/bar', { sum: 0, arrayUnion: [] }))
         .toReturnChanged(
           doc(
             'foo/bar',
             0,
-            { sum: 0, array_union: [] },
+            { sum: 0, arrayUnion: [] },
             { hasLocalMutations: true }
           )
         )
@@ -1147,27 +1146,27 @@ function genericLocalStoreTests(
           doc(
             'foo/bar',
             1,
-            { sum: 0, array_union: [] },
+            { sum: 0, arrayUnion: [] },
             { hasCommittedMutations: true }
           )
         )
         .afterRemoteEvent(
-          docAddedRemoteEvent(doc('foo/bar', 1, { sum: 0, array_union: [] }), [
+          docAddedRemoteEvent(doc('foo/bar', 1, { sum: 0, arrayUnion: [] }), [
             2
           ])
         )
-        .toReturnChanged(doc('foo/bar', 1, { sum: 0, array_union: [] }))
+        .toReturnChanged(doc('foo/bar', 1, { sum: 0, arrayUnion: [] }))
         .afterMutations([
           transformMutation('foo/bar', { sum: PublicFieldValue.increment(1) }),
           transformMutation('foo/bar', {
-            array_union: PublicFieldValue.arrayUnion('foo')
+            arrayUnion: PublicFieldValue.arrayUnion('foo')
           })
         ])
         .toReturnChanged(
           doc(
             'foo/bar',
             1,
-            { sum: 1, array_union: ['foo'] },
+            { sum: 1, arrayUnion: ['foo'] },
             { hasLocalMutations: true }
           )
         )
@@ -1176,22 +1175,21 @@ function genericLocalStoreTests(
         // backend value.
         .afterRemoteEvent(
           docUpdateRemoteEvent(
-            doc('foo/bar', 2, { sum: 1337, array_union: ['bar'] }),
+            doc('foo/bar', 2, { sum: 1337, arrayUnion: ['bar'] }),
             [2]
           )
         )
         .toReturnChanged(
           doc(
             'foo/bar',
             2,
-            { sum: 1, array_union: ['bar', 'foo'] },
+            { sum: 1, arrayUnion: ['bar', 'foo'] },
             { hasLocalMutations: true }
           )
         )
         .finish()
     );
   });
-  /* eslint-enable camelcase */
 
   it('handles MergeMutation with Transform -> RemoteEvent', () => {
     const query = Query.atPath(path('foo'));

packages/firestore/test/unit/remote/remote_event.test.ts

@@ -45,11 +45,11 @@ import {
 } from '../../util/helpers';
 
 /* eslint-disable  @typescript-eslint/prefer-interface */
-type TargetMap = {
+interface TargetMap {
   [targetId: number]: QueryData;
 };
-type PendingTargetResponses = {
-  [targetId: number]: number;
+interface PendingTargetResponses {
+  [targetId: string]: number;
 };
 /* eslint-enable  @typescript-eslint/prefer-interface */
 
@@ -58,6 +58,7 @@ function listens(...targetIds: TargetId[]): TargetMap {
   for (const target of targetIds) {
     targets[target] = queryData(target, QueryPurpose.Listen, 'coll');
   }
+
   return targets;
 }