Enabling TSLint for our test cases

Enabling TSLint for our test cases

Author: schmidt-sebastian

packages/firestore/package.json

@@ -6,8 +6,8 @@
   "scripts": {
     "build": "rollup -c",
     "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": "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'",
     "test": "run-s lint test:all",
     "test:all": "run-p test:browser test:node",
     "test:browser": "karma start --single-run",

packages/firestore/test/integration/api/database.test.ts

@@ -25,6 +25,7 @@ import {
   withTestDb,
   withTestDoc
 } from '../util/helpers';
+import { query } from '../../util/api_helpers';
 
 const Timestamp = firebase.firestore.Timestamp;
 
@@ -419,7 +420,7 @@ apiDescribe('Database', persistence => {
   // client-side validation but fail remotely.  May need to wait until we
   // have security rules support or something?
   xdescribe('Listens are rejected remotely:', () => {
-    let queryForRejection: firestore.Query;
+    const queryForRejection = query('foo');
 
     it('will reject listens', () => {
       const deferred = new Deferred();

packages/firestore/test/integration/api/fields.test.ts

@@ -20,7 +20,6 @@ import {
   apiDescribe,
   DEFAULT_SETTINGS,
   toDataArray,
-  toIds,
   withTestCollection,
   withTestCollectionSettings,
   withTestDoc
@@ -29,8 +28,11 @@ import {
 const FieldPath = firebase.firestore.FieldPath;
 const Timestamp = firebase.firestore.Timestamp;
 
+// tslint:disable-next-line:no-any Allow custom types for testing.
+type AnyTestData = any;
+
 apiDescribe('Nested Fields', persistence => {
-  const testData = (n?: number): any => {
+  const testData = (n?: number): AnyTestData => {
     n = n || 1;
     return {
       name: 'room ' + n,
@@ -235,7 +237,7 @@ apiDescribe('Nested Fields', persistence => {
 // Datastore currently prohibits having nested fields and fields with dots in
 // the same entity, so I'm separating them.
 apiDescribe('Fields with special characters', persistence => {
-  const testData = (n?: number): any => {
+  const testData = (n?: number): AnyTestData => {
     n = n || 1;
     return {
       field: 'field ' + n,
@@ -341,7 +343,8 @@ apiDescribe('Fields with special characters', persistence => {
 });
 
 apiDescribe('Timestamp Fields in snapshots', persistence => {
-  const testDataWithTimestamps = (ts: any): any => {
+  // tslint:disable-next-line:no-any Figure out how to pass in the Timestamp type
+  const testDataWithTimestamps = (ts: any): AnyTestData => {
     return { timestamp: ts, nested: { timestamp2: ts } };
   };
 

packages/firestore/test/integration/api/query.test.ts

@@ -20,12 +20,7 @@ import * as firestore from '@firebase/firestore-types';
 import { addEqualityMatcher } from '../../util/equality_matcher';
 import { EventsAccumulator } from '../util/events_accumulator';
 import firebase from '../util/firebase_export';
-import {
-  apiDescribe,
-  toDataArray,
-  withTestCollection,
-  withTestDbs
-} from '../util/helpers';
+import { apiDescribe, toDataArray, withTestCollection } from '../util/helpers';
 import { Deferred } from '../../util/promise';
 
 const Timestamp = firebase.firestore.Timestamp;

packages/firestore/test/integration/api/server_timestamp.test.ts

@@ -18,9 +18,12 @@ import { expect } from 'chai';
 import * as firestore from '@firebase/firestore-types';
 
 import firebase from '../util/firebase_export';
-import { apiDescribe, DEFAULT_SETTINGS, withTestDoc } from '../util/helpers';
+import { apiDescribe, withTestDoc } from '../util/helpers';
 import { EventsAccumulator } from '../util/events_accumulator';
 
+// tslint:disable-next-line:no-any Allow custom types for testing.
+type AnyTestData = any;
+
 const Timestamp = firebase.firestore.Timestamp;
 
 apiDescribe('Server Timestamps', persistence => {
@@ -49,7 +52,7 @@ apiDescribe('Server Timestamps', persistence => {
   let listenerRegistration: () => void;
 
   // Returns the expected data, with an arbitrary timestamp substituted in.
-  function expectedDataWithTimestamp(timestamp: object | null) {
+  function expectedDataWithTimestamp(timestamp: object | null): AnyTestData {
     return { a: 42, when: timestamp, deep: { when: timestamp } };
   }
 

packages/firestore/test/integration/api/transactions.test.ts

@@ -375,15 +375,16 @@ apiDescribe('Database transactions', persistence => {
     return integrationHelpers.withTestDb(persistence, db => {
       const doc1 = db.collection('counters').doc();
       const doc2 = db.collection('counters').doc();
-      let tries = 0;
+      // let tries = 0;
       return (
         doc1
           .set({
             count: 15
           })
           .then(() => {
             return db.runTransaction(transaction => {
-              tries++;
+              // ++tries;
+
               // Get the first doc.
               return (
                 transaction

packages/firestore/test/integration/api/validation.test.ts

@@ -66,18 +66,20 @@ const validationIt: ValidationIt = Object.assign(
     });
   },
   {
-    skip: function(
+    skip(
       persistence: boolean,
       message: string,
       _: (db: firestore.FirebaseFirestore) => void | Promise<any>
-    ) {
+    ): void {
+      // tslint:disable-next-line:ban
       it.skip(message, () => {});
     },
-    only: function(
+    only(
       persistence: boolean,
       message: string,
       testFunction: (db: firestore.FirebaseFirestore) => void | Promise<any>
-    ) {
+    ): void {
+      // tslint:disable-next-line:ban
       it.only(message, () => {
         return withTestDb(persistence, async db => {
           const maybePromise = testFunction(db);
@@ -305,7 +307,7 @@ apiDescribe('Validation:', persistence => {
   describe('Writes', () => {
     /** Class used to verify custom classes can't be used in writes. */
     class TestClass {
-      constructor(public readonly property: string) {}
+      constructor(readonly property: string) {}
     }
 
     validationIt(persistence, 'must be objects.', db => {

packages/firestore/test/integration/remote/stream.test.ts

@@ -30,7 +30,6 @@ import {
 } from '../../../src/remote/watch_change';
 import { AsyncQueue, TimerId } from '../../../src/util/async_queue';
 import { Deferred } from '../../../src/util/promise';
-import { Datastore } from '../../../src/remote/datastore';
 import { setMutation } from '../../util/helpers';
 import { withTestDatastore } from '../util/internal_helpers';
 import { FirestoreError } from '@firebase/firestore-types';
@@ -50,7 +49,7 @@ const SINGLE_MUTATION = [setMutation('docs/1', { foo: 'bar' })];
 
 class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
   private pendingCallbacks: StreamEventType[] = [];
-  private pendingPromises: Deferred<StreamEventType>[] = [];
+  private pendingPromises: Array<Deferred<StreamEventType>> = [];
 
   /**
    * Returns a Promise that resolves when the next callback fires. Resolves the
@@ -63,7 +62,7 @@ class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
     let promise: Promise<StreamEventType>;
 
     if (this.pendingCallbacks.length > 0) {
-      let pendingCallback = this.pendingCallbacks.shift();
+      const pendingCallback = this.pendingCallbacks.shift();
       promise = Promise.resolve(pendingCallback);
     } else {
       const deferred = new Deferred<StreamEventType>();
@@ -114,7 +113,7 @@ class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
 
   private async resolvePending(actualCallback: StreamEventType): Promise<void> {
     if (this.pendingPromises.length > 0) {
-      let pendingPromise = this.pendingPromises.shift();
+      const pendingPromise = this.pendingPromises.shift();
       pendingPromise.resolve(actualCallback);
     } else {
       this.pendingCallbacks.push(actualCallback);
@@ -154,11 +153,9 @@ describe('Watch Stream', () => {
 });
 
 describe('Write Stream', () => {
-  let queue: AsyncQueue;
   let streamListener: StreamStatusListener;
 
   beforeEach(() => {
-    queue = new AsyncQueue();
     streamListener = new StreamStatusListener();
   });
 
@@ -213,10 +210,10 @@ describe('Write Stream', () => {
   });
 
   it('closes when idle', () => {
-    let queue = new AsyncQueue();
+    const queue = new AsyncQueue();
 
     return withTestDatastore(ds => {
-      let writeStream = ds.newPersistentWriteStream();
+      const writeStream = ds.newPersistentWriteStream();
       writeStream.start(streamListener);
       return streamListener
         .awaitCallback('open')
@@ -240,10 +237,10 @@ describe('Write Stream', () => {
   });
 
   it('cancels idle on write', () => {
-    let queue = new AsyncQueue();
+    const queue = new AsyncQueue();
 
     return withTestDatastore(ds => {
-      let writeStream = ds.newPersistentWriteStream();
+      const writeStream = ds.newPersistentWriteStream();
       writeStream.start(streamListener);
       return streamListener
         .awaitCallback('open')

packages/firestore/test/integration/util/events_accumulator.ts

@@ -61,7 +61,7 @@ export class EventsAccumulator<T> {
     });
   }
 
-  private checkFulfilled() {
+  private checkFulfilled(): void {
     if (this.deferred !== null && this.events.length >= this.waitingFor) {
       const events = this.events.splice(0, this.waitingFor);
       this.deferred.resolve(events);

packages/firestore/test/integration/util/firebase_export.ts

@@ -20,4 +20,6 @@
 // instead.
 
 import firebase from '@firebase/app';
+
+// tslint:disable-next-line:no-default-export
 export default firebase;

packages/firestore/test/integration/util/helpers.ts

@@ -88,7 +88,7 @@ export function toDataArray(
 }
 
 /** Converts a DocumentSet to an array with the id of each document */
-export function toIds(docSet: firestore.QuerySnapshot): String[] {
+export function toIds(docSet: firestore.QuerySnapshot): string[] {
   return docSet.docs.map(d => d.id);
 }
 

packages/firestore/test/integration/util/internal_helpers.ts

@@ -21,7 +21,7 @@ import { Datastore } from '../../../src/remote/datastore';
 
 import { EmptyCredentialsProvider } from '../../../src/api/credentials';
 import { PlatformSupport } from '../../../src/platform/platform';
-import { AsyncQueue, TimerId } from '../../../src/util/async_queue';
+import { AsyncQueue } from '../../../src/util/async_queue';
 import { DEFAULT_SETTINGS, DEFAULT_PROJECT_ID } from './helpers';
 import { Firestore } from '../../../src/api/database';
 

packages/firestore/test/unit/api/database.test.ts

@@ -14,14 +14,6 @@
  * limitations under the License.
  */
 
-import { expect } from 'chai';
-import {
-  CollectionReference,
-  DocumentReference,
-  DocumentSnapshot,
-  Query,
-  QuerySnapshot
-} from '../../../src/api/database';
 import {
   collectionReference,
   documentReference,

packages/firestore/test/unit/api/document_change.test.ts

@@ -39,7 +39,7 @@ describe('DocumentChange:', () => {
     query: Query,
     initialDocs: Document[],
     updates: Array<Document | DocumentKey>
-  ) {
+  ): void {
     const view = new View(query, documentKeySet());
     const initialSnapshot = applyDocChanges(view, ...initialDocs).snapshot!;
     const updatedSnapshot = applyDocChanges(view, ...updates).snapshot;

packages/firestore/test/unit/api/field_path.test.ts

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-import { expect } from 'chai';
-import { FieldPath } from '../../../src/api/field_path';
 import { field, expectEqual, expectNotEqual } from '../../util/helpers';
 
 describe('FieldPath', () => {

packages/firestore/test/unit/api/field_value.test.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { expect } from 'chai';
 import { PublicFieldValue as FieldValue } from '../../../src/api/field_value';
 import { expectEqual, expectNotEqual } from '../../util/helpers';
 

packages/firestore/test/unit/core/query.test.ts

@@ -20,7 +20,6 @@ import { DOCUMENT_KEY_NAME, ResourcePath } from '../../../src/model/path';
 import { addEqualityMatcher } from '../../util/equality_matcher';
 import {
   bound,
-  dbId,
   doc,
   expectCorrectComparisons,
   expectEqualitySets,

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

@@ -16,20 +16,15 @@
 
 import { expect } from 'chai';
 import * as EncodedResourcePath from '../../../src/local/encoded_resource_path';
-import { PersistenceTransaction } from '../../../src/local/persistence';
-import { Persistence } from '../../../src/local/persistence';
 import { PersistencePromise } from '../../../src/local/persistence_promise';
 import {
   SimpleDb,
   SimpleDbStore,
   SimpleDbTransaction
 } from '../../../src/local/simple_db';
 import { ResourcePath } from '../../../src/model/path';
-import { fail } from '../../../src/util/assert';
 import { path } from '../../util/helpers';
 
-import * as persistenceHelpers from './persistence_test_helpers';
-
 let db: SimpleDb;
 const sep = '\u0001\u0001';
 
@@ -202,8 +197,8 @@ function runTransaction<T>(
     store: SimpleDbStore<string, boolean>,
     transaction: SimpleDbTransaction
   ) => PersistencePromise<T>
-) {
-  return db.runTransaction('readwrite', ['test'], txn => {
+): Promise<T> {
+  return db.runTransaction<T>('readwrite', ['test'], txn => {
     return fn(txn.store<string, boolean>('test'), txn);
   });
 }

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

@@ -59,8 +59,8 @@ function withDb(
     });
 }
 
-function getAllObjectStores(db: IDBDatabase): String[] {
-  const objectStores: String[] = [];
+function getAllObjectStores(db: IDBDatabase): string[] {
+  const objectStores: string[] = [];
   for (let i = 0; i < db.objectStoreNames.length; ++i) {
     objectStores.push(db.objectStoreNames.item(i));
   }

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

@@ -270,7 +270,9 @@ describe('LocalStore w/ IndexedDB Persistence', () => {
   genericLocalStoreTests(persistenceHelpers.testIndexedDbPersistence);
 });
 
-function genericLocalStoreTests(getPersistence: () => Promise<Persistence>) {
+function genericLocalStoreTests(
+  getPersistence: () => Promise<Persistence>
+): void {
   let persistence: Persistence;
   let localStore: LocalStore;
 

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

@@ -120,7 +120,7 @@ describe('IndexedDbMutationQueue', () => {
  * Defines the set of tests to run against both mutation queue
  * implementations.
  */
-function genericMutationQueueTests() {
+function genericMutationQueueTests(): void {
   addEqualityMatcher();
 
   beforeEach(() => {