migrate Firestore to eslint

Author: Feiyang1

config/.eslintrc.json

@@ -21,7 +21,8 @@
             ],
             "rules": {
                 "no-unused-expressions": "off",
-                "@typescript-eslint/no-explicit-any": "off"
+                "@typescript-eslint/no-explicit-any": "off",
+                "@typescript-eslint/tslint/config": "off"
             }
         }
     ],

packages/firestore/index.node.ts

@@ -17,11 +17,10 @@
 
 import firebase from '@firebase/app';
 import './src/platform_node/node_init';
-import { Firestore } from './src/api/database';
 import { configureForFirebase } from './src/platform/config';
 import * as types from '@firebase/firestore-types';
 
-export function registerFirestore(instance) {
+export function registerFirestore(instance): void {
   configureForFirebase(instance);
 }
 

packages/firestore/index.ts

@@ -22,7 +22,7 @@ import { configureForFirebase } from './src/platform/config';
 
 import * as types from '@firebase/firestore-types';
 
-export function registerFirestore(instance) {
+export function registerFirestore(instance): void {
   configureForFirebase(instance);
 }
 

packages/firestore/package.json

@@ -7,9 +7,8 @@
     "build": "rollup -c",
     "build:console": "node tools/console.build.js",
     "dev": "rollup -c -w",
-    "lint": "tslint -p tsconfig.json -c tslint.json 'src/**/*.ts' 'test/**/*.ts'",
-    "lint:fix": "tslint --fix -p tsconfig.json -c tslint.json 'src/**/*.ts' 'test/**/*.ts'",
-    "lint:eslint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",    
+    "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",    
+    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",    
     "prettier": "prettier --write 'src/**/*.js' 'test/**/*.js' 'src/**/*.ts' 'test/**/*.ts'",
     "test": "run-s lint test:all",
     "test:all": "run-p test:browser test:node",

packages/firestore/src/api/blob.ts

@@ -137,7 +137,7 @@ export class Blob {
 // For our internal TypeScript code PublicBlob doesn't exist as a type, and so
 // we need to use Blob as type and export it too.
 // tslint:disable-next-line:variable-name We're treating this as a class name.
-export let PublicBlob = makeConstructorPrivate(
+export const PublicBlob = makeConstructorPrivate(
   Blob,
   'Use Blob.fromUint8Array() or Blob.fromBase64String() instead.'
 );

packages/firestore/src/api/credentials.ts

@@ -104,8 +104,6 @@ export class EmptyCredentialsProvider implements CredentialsProvider {
    */
   private changeListener: CredentialChangeListener | null = null;
 
-  constructor() {}
-
   getToken(): Promise<Token | null> {
     return Promise.resolve<Token | null>(null);
   }

packages/firestore/src/api/database.ts

@@ -158,7 +158,7 @@ class FirestoreSettings {
   readonly forceLongPolling: boolean;
 
   // Can be a google-auth-library or gapi client.
-  // tslint:disable-next-line:no-any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   credentials?: any;
 
   constructor(settings: PrivateSettings) {
@@ -480,7 +480,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
 
     const databaseInfo = this.makeDatabaseInfo();
 
-    const preConverter = (value: unknown) => {
+    const preConverter = (value: unknown): unknown => {
       if (value instanceof DocumentReference) {
         const thisDb = this._config.databaseId;
         const otherDb = value.firestore._config.databaseId;
@@ -1116,7 +1116,7 @@ export class DocumentReference implements firestore.DocumentReference {
     options: ListenOptions,
     observer: PartialObserver<firestore.DocumentSnapshot>
   ): Unsubscribe {
-    let errHandler = (err: Error) => {
+    let errHandler = (err: Error): void => {
       console.error('Uncaught Error in onSnapshot:', err);
     };
     if (observer.error) {
@@ -1387,15 +1387,6 @@ export class DocumentSnapshot implements firestore.DocumentSnapshot {
 
 export class QueryDocumentSnapshot extends DocumentSnapshot
   implements firestore.QueryDocumentSnapshot {
-  constructor(
-    firestore: Firestore,
-    key: DocumentKey,
-    document: Document,
-    fromCache: boolean,
-    hasPendingWrites: boolean
-  ) {
-    super(firestore, key, document, fromCache, hasPendingWrites);
-  }
 
   data(options?: SnapshotOptions): firestore.DocumentData {
     const data = super.data(options);
@@ -1829,7 +1820,7 @@ export class Query implements firestore.Query {
     options: ListenOptions,
     observer: PartialObserver<firestore.QuerySnapshot>
   ): Unsubscribe {
-    let errHandler = (err: Error) => {
+    let errHandler = (err: Error): void => {
       console.error('Uncaught Error in onSnapshot:', err);
     };
     if (observer.error) {
@@ -1851,7 +1842,7 @@ export class Query implements firestore.Query {
       asyncObserver,
       options
     );
-    return () => {
+    return (): void => {
       asyncObserver.mute();
       firestoreClient.unlisten(internalListener);
     };

packages/firestore/src/api/user_data_converter.ts

@@ -220,7 +220,7 @@ class ParseContext {
     return context;
   }
 
-  childContextForArray(index: number): ParseContext {
+  childContextForArray(_index: number): ParseContext {
     // TODO(b/34871131): We don't support array paths right now; so make path
     // null.
     return new ParseContext(

packages/firestore/src/core/event_manager.ts

@@ -72,7 +72,7 @@ export class EventManager implements SyncEngineListener {
 
     listener.applyOnlineStateChange(this.onlineState);
 
-    if (queryInfo.viewSnap) listener.onViewSnapshot(queryInfo.viewSnap);
+    if (queryInfo.viewSnap) {listener.onViewSnapshot(queryInfo.viewSnap);}
 
     if (firstListen) {
       return this.syncEngine.listen(query).then(targetId => {

packages/firestore/src/core/firestore_client.ts

@@ -429,12 +429,12 @@ export class FirestoreClient {
           serializer
         );
 
-        const remoteStoreOnlineStateChangedHandler = onlineState =>
+        const remoteStoreOnlineStateChangedHandler = (onlineState): void =>
           this.syncEngine.applyOnlineStateChange(
             onlineState,
             OnlineStateSource.RemoteStore
           );
-        const sharedClientStateOnlineStateChangedHandler = onlineState =>
+        const sharedClientStateOnlineStateChangedHandler = (onlineState): void =>
           this.syncEngine.applyOnlineStateChange(
             onlineState,
             OnlineStateSource.SharedClientState

packages/firestore/src/core/query.ts

@@ -310,7 +310,7 @@ export class Query {
     let comparedOnKeyField = false;
     for (const orderBy of this.orderBy) {
       const comp = orderBy.compare(d1, d2);
-      if (comp !== 0) return comp;
+      if (comp !== 0) {return comp;}
       comparedOnKeyField = comparedOnKeyField || orderBy.field.isKeyField();
     }
     // Assert that we actually compared by key

packages/firestore/src/core/sync_engine.ts

@@ -388,7 +388,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
   ): Promise<T> {
     assert(retries >= 0, 'Got negative number of retries for transaction.');
     const transaction = this.remoteStore.createTransaction();
-    const wrappedUpdateFunction = () => {
+    const wrappedUpdateFunction = (): Promise<T> => {
       try {
         const userPromise = updateFunction(transaction);
         if (

packages/firestore/src/core/view.ts

@@ -468,7 +468,7 @@ export class View {
 }
 
 function compareChangeType(c1: ChangeType, c2: ChangeType): number {
-  const order = (change: ChangeType) => {
+  const order = (change: ChangeType): 0 | 1 | 2 => {
     switch (change) {
       case ChangeType.Added:
         return 1;

packages/firestore/src/core/view_snapshot.ts

@@ -50,8 +50,6 @@ export class DocumentChangeSet {
     DocumentKey.comparator
   );
 
-  constructor() {}
-
   track(change: DocumentViewChange): void {
     const key = change.doc.key;
     const oldChange = this.changeMap.get(key);

packages/firestore/src/local/indexeddb_mutation_queue.ts

@@ -165,7 +165,8 @@ export class IndexedDbMutationQueue implements MutationQueue {
     // mutation batch.
     // See: https://bugs.chromium.org/p/chromium/issues/detail?id=701972
 
-    // tslint:disable-next-line:no-any We write an empty object to obtain key
+    // We write an empty object to obtain key
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return mutationStore.add({} as any).next(batchId => {
       assert(typeof batchId === 'number', 'Auto-generated key is not a number');
 
@@ -244,7 +245,7 @@ export class IndexedDbMutationQueue implements MutationQueue {
     transaction: PersistenceTransaction,
     batchId: BatchId
   ): PersistencePromise<MutationBatch | null> {
-    return this.getMutationQueueMetadata(transaction).next(metadata => {
+    return this.getMutationQueueMetadata(transaction).next(_metadata => {
       const nextBatchId = batchId + 1;
 
       const range = IDBKeyRange.lowerBound([this.userId, nextBatchId]);

packages/firestore/src/local/indexeddb_persistence.ts

@@ -168,9 +168,9 @@ export class IndexedDbTransaction extends PersistenceTransaction {
  * TODO(b/114226234): Remove `synchronizeTabs` section when multi-tab is no
  * longer optional.
  */
-export type MultiClientParams = {
+export interface MultiClientParams {
   sequenceNumberSyncer: SequenceNumberSyncer;
-};
+}
 export class IndexedDbPersistence implements Persistence {
   static getStore<Key extends IDBValidKey, Value>(
     txn: PersistenceTransaction,
@@ -1311,7 +1311,7 @@ export class IndexedDbLruDelegate implements ReferenceDelegate, LruDelegate {
         {
           index: DbTargetDocument.documentTargetsIndex
         },
-        ([targetId, docKey], { path, sequenceNumber }) => {
+        ([targetId, _docKey], { path, sequenceNumber }) => {
           if (targetId === 0) {
             // if nextToReport is valid, report it, this is a new key so the
             // last one must not be a member of any targets.

packages/firestore/src/local/indexeddb_query_cache.ts

@@ -330,7 +330,7 @@ export class IndexedDbQueryCache implements QueryCache {
     let result = documentKeySet();
 
     return store
-      .iterate({ range, keysOnly: true }, (key, _, control) => {
+      .iterate({ range, keysOnly: true }, (key, _, _control) => {
         const path = EncodedResourcePath.decode(key[1]);
         const docKey = new DocumentKey(path);
         result = result.add(docKey);
@@ -357,7 +357,7 @@ export class IndexedDbQueryCache implements QueryCache {
           keysOnly: true,
           range
         },
-        ([targetId, path], _, control) => {
+        ([targetId, _path], _, control) => {
           // Having a sentinel row for a document does not count as containing that document;
           // For the query cache, containing the document means the document is part of some
           // target.

packages/firestore/src/local/indexeddb_schema.ts

@@ -213,7 +213,7 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
 
       const promises: Array<PersistencePromise<void>> = [];
       return documentsStore
-        .iterate((key, doc) => {
+        .iterate((key, _doc) => {
           const path = new ResourcePath(key);
           const docSentinelKey = sentinelKey(path);
           promises.push(
@@ -246,7 +246,7 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
 
     // Helper to add an index entry iff we haven't already written it.
     const cache = new MemoryCollectionParentIndex();
-    const addEntry = collectionPath => {
+    const addEntry = (collectionPath): PersistencePromise<void> | undefined => {
       if (cache.add(collectionPath)) {
         const collectionId = collectionPath.lastSegment();
         const parentPath = collectionPath.popLast();
@@ -270,7 +270,7 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
           .store<DbDocumentMutationKey, DbDocumentMutation>(
             DbDocumentMutation.store
           )
-          .iterate({ keysOnly: true }, ([userID, encodedPath, batchId], _) => {
+          .iterate({ keysOnly: true }, ([_userID, encodedPath, _batchId], _) => {
             const path = decode(encodedPath);
             return addEntry(path.popLast());
           });

packages/firestore/src/local/local_store.ts

@@ -458,7 +458,7 @@ export class LocalStore {
           (targetId: TargetId, change: TargetChange) => {
             // Do not ref/unref unassigned targetIds - it may lead to leaks.
             let queryData = this.queryDataByTarget[targetId];
-            if (!queryData) return;
+            if (!queryData) {return;}
 
             // When a global snapshot contains updates (either add or modify) we
             // can completely trust these updates as authoritative and blindly
@@ -514,7 +514,7 @@ export class LocalStore {
 
         let changedDocs = maybeDocumentMap();
         let updatedKeys = documentKeySet();
-        remoteEvent.documentUpdates.forEach((key, doc) => {
+        remoteEvent.documentUpdates.forEach((key, _doc) => {
           updatedKeys = updatedKeys.add(key);
         });
 
@@ -616,10 +616,10 @@ export class LocalStore {
     change: TargetChange
   ): boolean {
     // Avoid clearing any existing value
-    if (newQueryData.resumeToken.length === 0) return false;
+    if (newQueryData.resumeToken.length === 0) {return false;}
 
     // Any resume token is interesting if there isn't one already.
-    if (oldQueryData.resumeToken.length === 0) return true;
+    if (oldQueryData.resumeToken.length === 0) {return true;}
 
     // Don't allow resume token changes to be buffered indefinitely. This
     // allows us to be reasonably up-to-date after a crash and avoids needing
@@ -629,7 +629,7 @@ export class LocalStore {
     const timeDelta =
       newQueryData.snapshotVersion.toMicroseconds() -
       oldQueryData.snapshotVersion.toMicroseconds();
-    if (timeDelta >= this.RESUME_TOKEN_MAX_AGE_MICROS) return true;
+    if (timeDelta >= this.RESUME_TOKEN_MAX_AGE_MICROS) {return true;}
 
     // Otherwise if the only thing that has changed about a target is its resume
     // token it's not worth persisting. Note that the RemoteStore keeps an

packages/firestore/src/local/lru_garbage_collector.ts

@@ -86,9 +86,9 @@ export interface LruDelegate {
  * Describes an object whose keys are active target ids. We do not care about the type of the
  * values.
  */
-export type ActiveTargets = {
+export interface ActiveTargets {
   [id: number]: unknown;
-};
+}
 
 // The type and comparator for the items contained in the SortedSet used in
 // place of a priority queue for the RollingSequenceNumberBuffer.
@@ -154,12 +154,12 @@ class RollingSequenceNumberBuffer {
  * has not hit the threshold). If collection ran, the other fields will be
  * filled in with the details of the results.
  */
-export type LruResults = {
+export interface LruResults {
   readonly didRun: boolean;
   readonly sequenceNumbersCollected: number;
   readonly targetsRemoved: number;
   readonly documentsRemoved: number;
-};
+}
 
 const GC_DID_NOT_RUN: LruResults = {
   didRun: false,
@@ -373,12 +373,11 @@ export class LruGarbageCollector {
     let upperBoundSequenceNumber: number;
     let sequenceNumbersToCollect, targetsRemoved: number;
     // Timestamps for various pieces of the process
-    let startTs: number,
-      countedTargetsTs: number,
+    let countedTargetsTs: number,
       foundUpperBoundTs: number,
       removedTargetsTs: number,
       removedDocumentsTs: number;
-    startTs = Date.now();
+    const startTs = Date.now();
     return this.calculateTargetCount(txn, this.params.percentileToCollect)
       .next(sequenceNumbers => {
         // Cap at the configured max