refactor(database): Add 'noImplicitAny' support

Adds support for the 'noImplicitAny' Typescript compiler option to the database implementation.

Author: jsayol

src/database.ts

@@ -25,7 +25,7 @@ import * as INTERNAL from './database/api/internal';
 import * as TEST_ACCESS from './database/api/test_access';
 import { isNodeSdk } from "./utils/environment";
 
-export function registerDatabase(instance) {
+export function registerDatabase(instance: FirebaseNamespace) {
   // Register the Database Service with the 'firebase' namespace.
   const namespace = instance.INTERNAL.registerService(
     'database',

src/database/api/Query.ts

@@ -13,7 +13,7 @@ import {
   validateKey,
 } from '../core/util/validation';
 import { errorPrefix, validateArgCount, validateCallback, validateContextObject } from '../../utils/validation';
-import { ValueEventRegistration, ChildEventRegistration } from '../core/view/EventRegistration';
+import { ValueEventRegistration, ChildEventRegistration, EventRegistration } from '../core/view/EventRegistration';
 import { Deferred, attachDummyErrorHandler } from '../../utils/promise';
 import { Repo } from '../core/Repo';
 import { QueryParams } from '../core/view/QueryParams';
@@ -154,7 +154,7 @@ export class Query {
     if (eventType === 'value') {
       this.onValueEvent(callback, ret.cancel, ret.context);
     } else {
-      const callbacks = {};
+      const callbacks: { [k: string]: typeof callback } = {};
       callbacks[eventType] = callback;
       this.onChildEvent(callbacks, ret.cancel, ret.context);
     }
@@ -179,7 +179,7 @@ export class Query {
    * @protected
    */
   protected onChildEvent(callbacks: { [k: string]: (a: DataSnapshot, b: string | null) => void },
-               cancelCallback: ((a: Error) => void) | null, context: Object | null) {
+                         cancelCallback: ((a: Error) => void) | null, context: Object | null) {
     const container = new ChildEventRegistration(callbacks, cancelCallback, context);
     this.repo.addEventCallbackForQuery(this, container);
   }
@@ -195,10 +195,10 @@ export class Query {
     validateCallback('Query.off', 2, callback, true);
     validateContextObject('Query.off', 3, context, true);
 
-    let container = null;
-    let callbacks = null;
+    let container: EventRegistration | null = null;
+    let callbacks: { [k: string]: typeof callback } | null = null;
     if (eventType === 'value') {
-      const valueCallback = /** @type {function(!DataSnapshot)} */ (callback) || null;
+      const valueCallback = callback || null;
       container = new ValueEventRegistration(valueCallback, null, context || null);
     } else if (eventType) {
       if (callback) {
@@ -219,7 +219,7 @@ export class Query {
    * @return {!firebase.Promise}
    */
   once(eventType: string, userCallback: (a: DataSnapshot, b?: string) => void,
-       cancelOrContext?, context?: Object) {
+       cancelOrContext?: ((a: Error) => void) | Object, context?: Object): Promise<DataSnapshot> {
     validateArgCount('Query.once', 1, 4, arguments.length);
     validateEventType('Query.once', 1, eventType, false);
     validateCallback('Query.once', 2, userCallback, true);
@@ -234,7 +234,7 @@ export class Query {
     const deferred = new Deferred();
     attachDummyErrorHandler(deferred.promise);
 
-    const onceCallback = (snapshot) => {
+    const onceCallback = (snapshot: DataSnapshot) => {
       // NOTE: Even though we unsubscribe, we may get called multiple times if a single action (e.g. set() with JSON)
       // triggers multiple events (e.g. child_added or child_changed).
       if (firstCall) {
@@ -489,10 +489,10 @@ export class Query {
    * @private
    */
   private static getCancelAndContextArgs_(fnName: string, cancelOrContext?: ((a: Error) => void) | Object,
-                                   context?: Object): { cancel: ((a: Error) => void) | null, context: Object | null } {
-    const ret = {cancel: null, context: null};
+                                          context?: Object): { cancel: ((a: Error) => void) | null, context: Object | null } {
+    const ret: { cancel: ((a: Error) => void) | null, context: Object | null } = {cancel: null, context: null};
     if (cancelOrContext && context) {
-      ret.cancel = /** @type {function(Error)} */ (cancelOrContext);
+      ret.cancel = <(a: Error) => void>(cancelOrContext);
       validateCallback(fnName, 3, ret.cancel, true);
 
       ret.context = context;

src/database/api/Reference.ts

@@ -24,9 +24,13 @@ import { SyncPoint } from '../core/SyncPoint';
 import { Database } from './Database';
 import { DataSnapshot } from './DataSnapshot';
 
+export interface ReferenceConstructor {
+  new(repo: Repo, path: Path): Reference;
+}
+
 export class Reference extends Query {
-  public then;
-  public catch;
+  public then: (a?: any) => Promise<any>;
+  public catch: (a?: Error) => Promise<any>;
 
   /**
    * Call options:
@@ -126,7 +130,7 @@ export class Reference extends Query {
     validateWritablePath('Reference.update', this.path);
 
     if (Array.isArray(objectToMerge)) {
-      const newObjectToMerge = {};
+      const newObjectToMerge: { [k: string]: any } = {};
       for (let i = 0; i < objectToMerge.length; ++i) {
         newObjectToMerge['' + i] = objectToMerge[i];
       }
@@ -206,7 +210,7 @@ export class Reference extends Query {
       attachDummyErrorHandler(deferred.promise);
     }
 
-    const promiseComplete = function (error, committed, snapshot) {
+    const promiseComplete = function (error: Error, committed: boolean, snapshot: DataSnapshot) {
       if (error) {
         deferred.reject(error);
       } else {

src/database/api/internal.ts

@@ -24,7 +24,7 @@ export const isWebSocketsAvailable = function(): boolean {
   return WebSocketConnection['isAvailable']();
 };
 
-export const setSecurityDebugCallback = function(ref: Reference, callback) {
+export const setSecurityDebugCallback = function(ref: Reference, callback: (a: Object) => void) {
   (ref.repo.persistentConnection_ as any).securityDebugCallback_ = callback;
 };
 

src/database/api/onDisconnect.ts

@@ -93,7 +93,7 @@ export class OnDisconnect {
     validateArgCount('OnDisconnect.update', 1, 2, arguments.length);
     validateWritablePath('OnDisconnect.update', this.path_);
     if (Array.isArray(objectToMerge)) {
-      const newObjectToMerge = {};
+      const newObjectToMerge: { [k: string]: any } = {};
       for (let i = 0; i < objectToMerge.length; ++i) {
         newObjectToMerge['' + i] = objectToMerge[i];
       }

src/database/core/CompoundWrite.ts

@@ -53,7 +53,7 @@ export class CompoundWrite {
    */
   addWrites(path: Path, updates: { [name: string]: Node }): CompoundWrite {
     let newWrite = <CompoundWrite>this;
-    forEach(updates, function(childKey, node) {
+    forEach(updates, function(childKey: string, node: Node) {
       newWrite = newWrite.addWrite(path.child(childKey), node);
     });
     return newWrite;
@@ -108,7 +108,7 @@ export class CompoundWrite {
    * @return {!Array.<NamedNode>} A list of all complete children.
    */
   getCompleteChildren(): Array<NamedNode> {
-    const children = [];
+    const children: NamedNode[] = [];
     let node = this.writeTree_.value;
     if (node != null) {
       // If it's a leaf node, it has no children; so nothing to do.

src/database/core/PersistentConnection.ts

@@ -30,8 +30,10 @@ const SERVER_KILL_INTERRUPT_REASON = 'server_kill';
 const INVALID_AUTH_TOKEN_THRESHOLD = 3;
 
 interface ListenSpec {
-  onComplete(s: string, p?: any);
+  onComplete(s: string, p?: any): void;
+
   hashFn(): string;
+
   query: Query;
   tag: number | null;
 }
@@ -87,7 +89,7 @@ export class PersistentConnection extends ServerActions {
    *   sendRequest(Object),
    *   close()
    * }} */
-  private realtime_: { sendRequest(a: Object), close() } | null = null;
+  private realtime_: { sendRequest(a: Object): void, close(): void } | null = null;
 
   /** @private {string|null} */
   private authToken_: string | null = null;
@@ -123,7 +125,7 @@ export class PersistentConnection extends ServerActions {
   constructor(private repoInfo_: RepoInfo,
               private onDataUpdate_: (a: string, b: any, c: boolean, d: number | null) => void,
               private onConnectStatus_: (a: boolean) => void,
-              private onServerInfoUpdate_,
+              private onServerInfoUpdate_: (a: any) => void,
               private authTokenProvider_: AuthTokenProvider,
               private authOverride_?: Object | null) {
     super();
@@ -194,7 +196,7 @@ export class PersistentConnection extends ServerActions {
     const pathString = query.path.toString();
     const queryId = query.queryIdentifier();
     this.log_('Listen on ' + pathString + ' for ' + queryId);
-    const req = {/*path*/ 'p': pathString};
+    const req: { [k: string]: any } = {/*path*/ 'p': pathString};
 
     const action = 'q';
 
@@ -206,9 +208,9 @@ export class PersistentConnection extends ServerActions {
 
     req[/*hash*/'h'] = listenSpec.hashFn();
 
-    this.sendRequest(action, req, (message: Object) => {
-      const payload = message[/*data*/ 'd'];
-      const status = message[/*status*/ 's'];
+    this.sendRequest(action, req, (message: { [k: string]: any }) => {
+      const payload: any = message[/*data*/ 'd'];
+      const status: string = message[/*status*/ 's'];
 
       // print warnings in any case...
       PersistentConnection.warnOnListenWarnings_(payload, query);
@@ -287,13 +289,13 @@ export class PersistentConnection extends ServerActions {
     if (this.connected_ && this.authToken_) {
       const token = this.authToken_;
       const authMethod = isValidFormat(token) ? 'auth' : 'gauth';
-      const requestData = {'cred': token};
+      const requestData: { [k: string]: any } = {'cred': token};
       if (this.authOverride_ === null) {
         requestData['noauth'] = true;
       } else if (typeof this.authOverride_ === 'object') {
         requestData['authvar'] = this.authOverride_;
       }
-      this.sendRequest(authMethod, requestData, (res: Object) => {
+      this.sendRequest(authMethod, requestData, (res: { [k: string]: any }) => {
         const status: string = res[/*status*/ 's'];
         const data: string = res[/*data*/ 'd'] || 'error';
 
@@ -329,7 +331,7 @@ export class PersistentConnection extends ServerActions {
   private sendUnlisten_(pathString: string, queryId: string, queryObj: Object, tag: number | null) {
     this.log_('Unlisten on ' + pathString + ' for ' + queryId);
 
-    const req = {/*path*/ 'p': pathString};
+    const req: { [k: string]: any } = {/*path*/ 'p': pathString};
     const action = 'n';
     // Only bother sending queryId if it's non-default.
     if (tag) {
@@ -391,7 +393,7 @@ export class PersistentConnection extends ServerActions {
   private sendOnDisconnect_(action: string, pathString: string, data: any, onComplete: (a: string, b: string) => void) {
     const request = {/*path*/ 'p': pathString, /*data*/ 'd': data};
     this.log_('onDisconnect ' + action, request);
-    this.sendRequest(action, request, (response: Object) => {
+    this.sendRequest(action, request, (response: { [k: string]: any }) => {
       if (onComplete) {
         setTimeout(function () {
           onComplete(response[/*status*/ 's'], response[/* data */'d']);
@@ -416,7 +418,7 @@ export class PersistentConnection extends ServerActions {
 
   putInternal(action: string, pathString: string, data: any,
               onComplete: (a: string, b: string | null) => void, hash?: string) {
-    const request = {/*path*/ 'p': pathString, /*data*/ 'd': data};
+    const request: { [k: string]: any } = {/*path*/ 'p': pathString, /*data*/ 'd': data};
 
     if (hash !== undefined)
       request[/*hash*/ 'h'] = hash;
@@ -444,7 +446,7 @@ export class PersistentConnection extends ServerActions {
     const onComplete = this.outstandingPuts_[index].onComplete;
     this.outstandingPuts_[index].queued = this.connected_;
 
-    this.sendRequest(action, request, (message: Object) => {
+    this.sendRequest(action, request, (message: { [k: string]: any }) => {
       this.log_(action + ' response', message);
 
       delete this.outstandingPuts_[index];
@@ -483,7 +485,7 @@ export class PersistentConnection extends ServerActions {
    * @param {*} message
    * @private
    */
-  private onDataMessage_(message: Object) {
+  private onDataMessage_(message: { [k: string]: any }) {
     if ('r' in message) {
       // this is a response
       this.log_('from server: ' + stringify(message));
@@ -501,7 +503,7 @@ export class PersistentConnection extends ServerActions {
     }
   }
 
-  private onDataPush_(action: string, body: Object) {
+  private onDataPush_(action: string, body: { [k: string]: any }) {
     this.log_('handleServerMessage', action, body);
     if (action === 'd')
       this.onDataUpdate_(body[/*path*/ 'p'], body[/*data*/ 'd'], /*isMerge*/false, body['t']);
@@ -629,7 +631,7 @@ export class PersistentConnection extends ServerActions {
       const self = this;
       const lastSessionId = this.lastSessionId;
       let canceled = false;
-      let connection = null;
+      let connection: Connection | null = null;
       const closeFn = function () {
         if (connection) {
           connection.close();
@@ -638,7 +640,7 @@ export class PersistentConnection extends ServerActions {
           onDisconnect();
         }
       };
-      const sendRequestFn = function (msg) {
+      const sendRequestFn = function (msg: Object) {
         assert(connection, 'sendRequest call when we\'re not connected not allowed.');
         connection.sendRequest(msg);
       };
@@ -761,7 +763,7 @@ export class PersistentConnection extends ServerActions {
    * @return {{queries:Array.<Query>, onComplete:function(string)}}
    * @private
    */
-  private removeListen_(pathString, queryId): ListenSpec {
+  private removeListen_(pathString: string, queryId: string): ListenSpec {
     const normalizedPathString = new Path(pathString).toString(); // normalize path.
     let listen;
     if (this.listens_[normalizedPathString] !== undefined) {
@@ -798,7 +800,7 @@ export class PersistentConnection extends ServerActions {
     }
   }
 
-  private onSecurityDebugPacket_(body: Object) {
+  private onSecurityDebugPacket_(body: { [k: string]: any }) {
     if (this.securityDebugCallback_) {
       this.securityDebugCallback_(body);
     } else {
@@ -836,7 +838,7 @@ export class PersistentConnection extends ServerActions {
    * @private
    */
   private sendConnectStats_() {
-    const stats = {};
+    const stats: { [k: string]: number } = {};
 
     let clientName = 'js';
     if (CONSTANTS.NODE_ADMIN) {