Addressing lint errors after master merge

Author: schmidt-sebastian

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

@@ -28,7 +28,7 @@ import {
 const FieldPath = firebase.firestore.FieldPath;
 const Timestamp = firebase.firestore.Timestamp;
 
-// tslint:disable-next-line:no-any Allow custom type for testing.
+// tslint:disable-next-line:no-any Allow custom types for testing.
 type AnyTestData = any;
 
 apiDescribe('Nested Fields', persistence => {

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

@@ -21,6 +21,9 @@ import firebase from '../util/firebase_export';
 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/validation.test.ts

@@ -70,15 +70,15 @@ const validationIt: ValidationIt = Object.assign(
       persistence: boolean,
       message: string,
       _: (db: firestore.FirebaseFirestore) => void | Promise<any>
-    ) {
+    ) : void {
       // tslint:disable-next-line:ban
       it.skip(message, () => {});
     },
     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 => {

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/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/local/encoded_resource_path.test.ts

@@ -197,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/local_store.test.ts

@@ -270,7 +270,7 @@ 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(() => {

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

@@ -70,7 +70,7 @@ describe('IndexedDbQueryCache', () => {
 /**
  * Defines the set of tests to run against both query cache implementations.
  */
-function genericQueryCacheTests() {
+function genericQueryCacheTests() : void {
   addEqualityMatcher();
 
   const QUERY_ROOMS = Query.atPath(path('rooms'));
@@ -81,7 +81,7 @@ function genericQueryCacheTests() {
    * Creates a new QueryData object from the the given parameters, synthesizing
    * a resume token from the snapshot version.
    */
-  function testQueryData(query: Query, targetId: TargetId, version?: number) {
+  function testQueryData(query: Query, targetId: TargetId, version?: number) : QueryData {
     if (version === undefined) {
       version = 0;
     }

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

@@ -60,7 +60,7 @@ describe('IndexedDbRemoteDocumentCache', () => {
  * Defines the set of tests to run against both remote document cache
  * implementations.
  */
-function genericRemoteDocumentCacheTests() {
+function genericRemoteDocumentCacheTests() : void {
   // Helpers for use throughout tests.
   const DOC_PATH = 'a/b';
   const LONG_DOC_PATH = 'a/b/c/d/e/f';

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

@@ -55,13 +55,13 @@ describe('SimpleDb', () => {
   let db: SimpleDb;
 
   // helper to reduce test boilerplate.
-  function runTransaction<T>(
+  function runTransaction<T> (
     fn: (
       store: SimpleDbStore<number, User>,
       transaction: SimpleDbTransaction
     ) => PersistencePromise<T>
-  ) {
-    return db.runTransaction('readwrite', ['users'], txn => {
+  ) : Promise<T> {
+    return db.runTransaction<T>('readwrite', ['users'], txn => {
       return fn(txn.store<number, User>('users'), txn);
     });
   }

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

@@ -119,7 +119,7 @@ export class TestQueryCache {
     });
   }
 
-  setLastRemoteSnapshotVersion(version: SnapshotVersion) {
+  setLastRemoteSnapshotVersion(version: SnapshotVersion) : Promise<void> {
     return this.persistence.runTransaction(
       'setLastRemoteSnapshotVersion',
       txn => this.cache.setLastRemoteSnapshotVersion(txn, version)

packages/firestore/test/unit/model/mutation.test.ts

@@ -260,7 +260,7 @@ describe('Mutation', () => {
     base: MaybeDocument | null,
     mutationResult: MutationResult,
     expected: MaybeDocument | null
-  ) {
+  ) : void {
     const actual = mutation.applyToRemoteDocument(base, mutationResult);
     expect(actual).to.deep.equal(expected);
   }

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

@@ -638,7 +638,7 @@ describe('Serializer', () => {
   describe('toMutation / fromMutation', () => {
     addEqualityMatcher();
 
-    function verifyMutation(mutation: Mutation, proto: AnyJs) {
+    function verifyMutation(mutation: Mutation, proto: AnyJs) : void {
       const serialized = s.toMutation(mutation);
       expect(serialized).to.deep.equal(proto);
       expect(s.fromMutation(serialized)).to.deep.equal(mutation);

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

@@ -65,7 +65,7 @@ let writeJSONFile: ((json: string) => void) | null = null;
  * If you call this function before your describeSpec, then the spec test will
  * be written using the given function instead of running as a normal test.
  */
-export function setSpecJSONHandler(writer: (json: string) => void) {
+export function setSpecJSONHandler(writer: (json: string) => void) : void {
   writeJSONFile = writer;
 }
 
@@ -82,7 +82,7 @@ export function specTest(
   name: string,
   tags: string[],
   builder: () => SpecBuilder
-) {
+) :void {
   // Union in the tags for the describeSpec().
   tags = tags.concat(describeTags);
   for (const tag of tags) {
@@ -146,18 +146,19 @@ export function describeSpec(
   name: string,
   tags: string[],
   builder: () => void
-) {
+) : void {
   describeTags = tags;
   describeName = name;
 
   if (!writeJSONFile) {
-    return describe(name, () => {
+    describe(name, () => {
       addEqualityMatcher();
       return builder();
     });
+  } else {
+    specsInThisTest = {};
+    builder();
+    const output = JSON.stringify(specsInThisTest, null, 2);
+    writeJSONFile(output);
   }
-  specsInThisTest = {};
-  builder();
-  const output = JSON.stringify(specsInThisTest, null, 2);
-  writeJSONFile(output);
 }

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

@@ -194,7 +194,7 @@ export class SpecBuilder {
     return this;
   }
 
-  runTimer(timerId: TimerId) {
+  runTimer(timerId: TimerId) : SpecBuilder {
     this.nextStep();
     this.currentStep = { runTimer: timerId };
     return this;
@@ -660,6 +660,6 @@ export class SpecBuilder {
   }
 }
 
-export function spec() {
+export function spec() : SpecBuilder {
   return new SpecBuilder();
 }

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

@@ -167,18 +167,18 @@ class MockConnection implements Connection {
     this.resetAndCloseWriteStream(err);
   }
 
-  private resetAndCloseWriteStream(err?: FirestoreError) {
+  private resetAndCloseWriteStream(err?: FirestoreError) : void {
     this.writeSendBarriers = [];
     this.earlyWrites = [];
     this.writeStream!.callOnClose(err);
     this.writeStream = null;
   }
 
-  failWatchStream(err?: FirestoreError) {
+  failWatchStream(err?: FirestoreError) : void {
     this.resetAndCloseWatchStream(err);
   }
 
-  private resetAndCloseWatchStream(err?: FirestoreError) {
+  private resetAndCloseWatchStream(err?: FirestoreError)  : void{
     this.activeTargets = {};
     this.watchOpen = new Deferred<void>();
     this.watchStream!.callOnClose(err);
@@ -860,7 +860,7 @@ abstract class TestRunner {
     this.validateActiveTargets();
   }
 
-  private validateLimboDocs() {
+  private validateLimboDocs() : void {
     let actualLimboDocs = this.syncEngine.currentLimboDocs();
     // Validate that each limbo doc has an expected active target
     actualLimboDocs.forEach((key, targetId) => {
@@ -883,7 +883,7 @@ abstract class TestRunner {
     );
   }
 
-  private validateActiveTargets() {
+  private validateActiveTargets() : void {
     const actualTargets = obj.shallowCopy(this.connection.activeTargets);
     obj.forEachNumber(this.expectedActiveTargets, (targetId, expected) => {
       expect(obj.contains(actualTargets, targetId)).to.equal(

packages/firestore/test/unit/util/sorted_map.test.ts

@@ -19,7 +19,7 @@ import { primitiveComparator } from '../../../src/util/misc';
 import * as obj from '../../../src/util/obj';
 import { LLRBNode, SortedMap } from '../../../src/util/sorted_map';
 
-function shuffle(arr: number[]) {
+function shuffle(arr: number[]) : void {
   for (let i = arr.length - 1; i > 0; i--) {
     // Choose a random array index in [0, i] (inclusive with i).
     const j = Math.floor(Math.random() * (i + 1));