WIP: work on adding more tests

Author: jshcrowthe

.gitignore

@@ -6,4 +6,5 @@ npm-debug.log
 /.nyc_output
 /tests/integration/config
 /temp
-/.vscode
+/.vscode
+/tests/config

gulp/tasks/test.js

@@ -60,7 +60,7 @@ function runBrowserUnitTests(dev = false) {
         './tests/**/binary/**/*.test.ts',
       ],
 
-      browsers: dev ? [ 'ChromeHeadless' ] : globalKarmaConf.browsers
+      browsers: dev ? [ 'Chrome' ] : globalKarmaConf.browsers
     });
     new karma.Server(karmaConfig, exitCode => {
       if (dev) return done();

package.json

@@ -72,6 +72,7 @@
     "karma-spec-reporter": "^0.0.30",
     "karma-typescript": "^3.0.1",
     "karma-webpack": "^2.0.3",
+    "lodash": "^4.17.4",
     "merge2": "^1.0.3",
     "mkdirp": "^0.5.1",
     "require-dir": "^0.3.1",

src/database/api/Query.ts

@@ -13,6 +13,8 @@ import {
 import { errorPrefix, validateArgCount, validateCallback, validateContextObject } from "../../utils/validation";
 import { ValueEventRegistration, ChildEventRegistration } from "../core/view/EventRegistration";
 import { Deferred, attachDummyErrorHandler } from "../../utils/promise";
+import { Reference } from "./Reference";
+import { Repo } from "../core/Repo";
 
 /**
  * A Query represents a filter to be applied to a firebase location.  This object purely represents the
@@ -21,7 +23,7 @@ import { Deferred, attachDummyErrorHandler } from "../../utils/promise";
  * Since every Firebase reference is a query, Firebase inherits from this object.
  */
 export class Query {
-  repo;
+  repo: Repo;
   path;
   queryParams_;
   orderByCalled_;
@@ -124,6 +126,17 @@ export class Query {
     return this.queryParams_;
   }
 
+  /**
+   * @return {!Firebase}
+   */
+  getRef() {
+    validateArgCount('Query.ref', 0, 0, arguments.length);
+    // This is a slight hack. We cannot goog.require('fb.api.Firebase'), since Firebase requires fb.api.Query.
+    // However, we will always export 'Firebase' to the global namespace, so it's guaranteed to exist by the time this
+    // method gets called.
+    return new Reference(this.repo, this.path);
+  }
+
   /**
    * @param {!string} eventType
    * @param {!function(DataSnapshot, string=)} callback
@@ -201,12 +214,12 @@ export class Query {
    * @param {!function(!DataSnapshot, string=)} userCallback
    * @return {!firebase.Promise}
    */
-  once(eventType, userCallback) {
+  once(eventType, userCallback?, cancelOrContext?, context?) {
     validateArgCount('Query.once', 1, 4, arguments.length);
     validateEventType('Query.once', 1, eventType, false);
     validateCallback('Query.once', 2, userCallback, true);
 
-    var ret = this.getCancelAndContextArgs_('Query.once', arguments[2], arguments[3]);
+    var ret = this.getCancelAndContextArgs_('Query.once', cancelOrContext, context);
 
     // TODO: Implement this more efficiently (in particular, use 'get' wire protocol for 'value' event)
     // TODO: consider actually wiring the callbacks into the promise. We cannot do this without a breaking change
@@ -245,7 +258,7 @@ export class Query {
    * @param {!number} limit
    * @return {!Query}
    */
-  limitToFirst(limit) {
+  limitToFirst(limit): Query {
     validateArgCount('Query.limitToFirst', 1, 1, arguments.length);
     if (typeof limit !== 'number' || Math.floor(limit) !== limit || limit <= 0) {
       throw new Error('Query.limitToFirst: First argument must be a positive integer.');
@@ -263,7 +276,7 @@ export class Query {
    * @param {!number} limit
    * @return {!Query}
    */
-  limitToLast(limit) {
+  limitToLast(limit?): Query {
     validateArgCount('Query.limitToLast', 1, 1, arguments.length);
     if (typeof limit !== 'number' || Math.floor(limit) !== limit || limit <= 0) {
       throw new Error('Query.limitToLast: First argument must be a positive integer.');
@@ -345,12 +358,12 @@ export class Query {
    * @param {?string=} opt_name
    * @return {!Query}
    */
-  startAt(value, opt_name) {
+  startAt(value = null, name?) {
     validateArgCount('Query.startAt', 0, 2, arguments.length);
     validateFirebaseDataArg('Query.startAt', 1, value, this.path, true);
-    validateKey('Query.startAt', 2, opt_name, true);
+    validateKey('Query.startAt', 2, name, true);
 
-    var newParams = this.queryParams_.startAt(value, opt_name);
+    var newParams = this.queryParams_.startAt(value, name);
     this.validateLimit_(newParams);
     this.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasStart()) {
@@ -361,7 +374,7 @@ export class Query {
     // Calling with no params tells us to start at the beginning.
     if (value == null) {
       value = null;
-      opt_name = null;
+      name = null;
     }
     return new Query(this.repo, this.path, newParams, this.orderByCalled_);
   }
@@ -371,12 +384,12 @@ export class Query {
    * @param {?string=} opt_name
    * @return {!Query}
    */
-  endAt(value, opt_name) {
+  endAt(value = null, name?) {
     validateArgCount('Query.endAt', 0, 2, arguments.length);
     validateFirebaseDataArg('Query.endAt', 1, value, this.path, true);
-    validateKey('Query.endAt', 2, opt_name, true);
+    validateKey('Query.endAt', 2, name, true);
 
-    var newParams = this.queryParams_.endAt(value, opt_name);
+    var newParams = this.queryParams_.endAt(value, name);
     this.validateLimit_(newParams);
     this.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasEnd()) {
@@ -394,10 +407,10 @@ export class Query {
    * @param {string=} opt_name
    * @return {!Query}
    */
-  equalTo(value, opt_name) {
+  equalTo(value, name?) {
     validateArgCount('Query.equalTo', 1, 2, arguments.length);
     validateFirebaseDataArg('Query.equalTo', 1, value, this.path, false);
-    validateKey('Query.equalTo', 2, opt_name, true);
+    validateKey('Query.equalTo', 2, name, true);
     if (this.queryParams_.hasStart()) {
       throw new Error('Query.equalTo: Starting point was already set (by another call to startAt or ' +
           'equalTo).');
@@ -406,7 +419,7 @@ export class Query {
       throw new Error('Query.equalTo: Ending point was already set (by another call to endAt or ' +
           'equalTo).');
     }
-    return this.startAt(value, opt_name).endAt(value, opt_name);
+    return this.startAt(value, name).endAt(value, name);
   }
 
   /**
@@ -448,7 +461,7 @@ export class Query {
    * @param {Query} other
    * @return {boolean}
    */
-  isEqual(other) {
+  isEqual(other?) {
     validateArgCount('Query.isEqual', 1, 1, arguments.length);
     if (!(other instanceof Query)) {
       var error = 'Query.isEqual failed: First argument must be an instance of firebase.database.Query.';
@@ -490,4 +503,8 @@ export class Query {
     }
     return ret;
   }
+
+  get ref() {
+    return this.getRef();
+  }
 }; // end Query

src/database/api/Reference.ts

@@ -126,7 +126,7 @@ export class Reference extends Query {
    * @param {function(?Error)=} opt_onComplete
    * @return {!firebase.Promise}
    */
-  update(objectToMerge, opt_onComplete) {
+  update(objectToMerge, onComplete?) {
     validateArgCount('Firebase.update', 1, 2, arguments.length);
     validateWritablePath('Firebase.update', this.path);
 
@@ -143,9 +143,9 @@ export class Reference extends Query {
       );
     }
     validateFirebaseMergeDataArg('Firebase.update', 1, objectToMerge, this.path, false);
-    validateCallback('Firebase.update', 2, opt_onComplete, true);
+    validateCallback('Firebase.update', 2, onComplete, true);
     var deferred = new Deferred();
-    this.repo.update(this.path, objectToMerge, deferred.wrapCallback(opt_onComplete));
+    this.repo.update(this.path, objectToMerge, deferred.wrapCallback(onComplete));
     return deferred.promise;
   }
 
@@ -155,31 +155,31 @@ export class Reference extends Query {
    * @param {function(?Error)=} opt_onComplete
    * @return {!firebase.Promise}
    */
-  setWithPriority(newVal, newPriority, opt_onComplete) {
+  setWithPriority(newVal, newPriority, onComplete?) {
     validateArgCount('Firebase.setWithPriority', 2, 3, arguments.length);
     validateWritablePath('Firebase.setWithPriority', this.path);
     validateFirebaseDataArg('Firebase.setWithPriority', 1, newVal, this.path, false);
     validatePriority('Firebase.setWithPriority', 2, newPriority, false);
-    validateCallback('Firebase.setWithPriority', 3, opt_onComplete, true);
+    validateCallback('Firebase.setWithPriority', 3, onComplete, true);
 
     if (this.getKey() === '.length' || this.getKey() === '.keys')
       throw 'Firebase.setWithPriority failed: ' + this.getKey() + ' is a read-only object.';
 
     var deferred = new Deferred();
-    this.repo.setWithPriority(this.path, newVal, newPriority, deferred.wrapCallback(opt_onComplete));
+    this.repo.setWithPriority(this.path, newVal, newPriority, deferred.wrapCallback(onComplete));
     return deferred.promise;
   }
 
   /**
    * @param {function(?Error)=} opt_onComplete
    * @return {!firebase.Promise}
    */
-  remove(opt_onComplete) {
+  remove(onComplete?) {
     validateArgCount('Firebase.remove', 0, 1, arguments.length);
     validateWritablePath('Firebase.remove', this.path);
-    validateCallback('Firebase.remove', 1, opt_onComplete, true);
+    validateCallback('Firebase.remove', 1, onComplete, true);
 
-    return this.set(null, opt_onComplete);
+    return this.set(null, onComplete);
   }
 
   /**
@@ -228,14 +228,14 @@ export class Reference extends Query {
    * @param {function(?Error)=} opt_onComplete
    * @return {!firebase.Promise}
    */
-  setPriority(priority, opt_onComplete) {
+  setPriority(priority, onComplete?) {
     validateArgCount('Firebase.setPriority', 1, 2, arguments.length);
     validateWritablePath('Firebase.setPriority', this.path);
     validatePriority('Firebase.setPriority', 1, priority, false);
-    validateCallback('Firebase.setPriority', 2, opt_onComplete, true);
+    validateCallback('Firebase.setPriority', 2, onComplete, true);
 
     var deferred = new Deferred();
-    this.repo.setWithPriority(this.path.child('.priority'), priority, null, deferred.wrapCallback(opt_onComplete));
+    this.repo.setWithPriority(this.path.child('.priority'), priority, null, deferred.wrapCallback(onComplete));
     return deferred.promise;
   }
 
@@ -244,11 +244,11 @@ export class Reference extends Query {
    * @param {function(?Error)=} opt_onComplete
    * @return {!Firebase}
    */
-  push(opt_value, opt_onComplete) {
+  push(value?, onComplete?) {
     validateArgCount('Firebase.push', 0, 2, arguments.length);
     validateWritablePath('Firebase.push', this.path);
-    validateFirebaseDataArg('Firebase.push', 1, opt_value, this.path, true);
-    validateCallback('Firebase.push', 2, opt_onComplete, true);
+    validateFirebaseDataArg('Firebase.push', 1, value, this.path, true);
+    validateCallback('Firebase.push', 2, onComplete, true);
 
     var now = this.repo.serverTime();
     var name = nextPushId(now);
@@ -262,16 +262,16 @@ export class Reference extends Query {
     var pushRef = this.child(name);
 
     var promise;
-    if (opt_value != null) {
-      promise = thennablePushRef.set(opt_value, opt_onComplete).then(function () { return pushRef; });
+    if (value != null) {
+      promise = thennablePushRef.set(value, onComplete).then(function () { return pushRef; });
     } else {
       promise = PromiseImpl.resolve(pushRef);
     }
 
     thennablePushRef.then = promise.then.bind(promise);
     /** @type {letMeUseMapAccessors} */ (thennablePushRef)["catch"] = promise.then.bind(promise, undefined);
 
-    if (typeof opt_onComplete === 'function') {
+    if (typeof onComplete === 'function') {
       attachDummyErrorHandler(promise);
     }
 
@@ -285,6 +285,22 @@ export class Reference extends Query {
     validateWritablePath('Firebase.onDisconnect', this.path);
     return new OnDisconnect(this.repo, this.path);
   }
+
+  get database() {
+    return this.databaseProp();
+  }
+
+  get key() {
+    return this.getKey();
+  }
+
+  get parent() {
+    return this.getParent();
+  }
+
+  get root() {
+    return this.getRoot();
+  }
 }
 
 Object.defineProperty(Query.prototype, 'getRef', {
@@ -295,12 +311,4 @@ Object.defineProperty(Query.prototype, 'getRef', {
     // method gets called.
     return new Reference(this.repo, this.path);
   }
-})
-
-// Internal code should NOT use these exported properties - because when they are
-// minified, they will refernce the minified name.  We could fix this by including
-// our our externs file for all our exposed symbols.
-exportPropGetter(Reference.prototype, 'database', Reference.prototype.databaseProp);
-exportPropGetter(Reference.prototype, 'key', Reference.prototype.getKey);
-exportPropGetter(Reference.prototype, 'parent', Reference.prototype.getParent);
-exportPropGetter(Reference.prototype, 'root', Reference.prototype.getRoot);
+});

src/database/core/Repo.ts

@@ -32,7 +32,7 @@ export class Repo {
   statsListener_;
   eventQueue_;
   nextWriteId_;
-  persistentConnection_;
+  persistentConnection_ : PersistentConnection | null;
   server_;
   statsReporter_;
   transactions_init_;

src/database/core/Repo_transaction.ts

@@ -88,6 +88,12 @@ export const TransactionStatus = {
   this.transactionQueueTree_ = new Tree();
 };
 
+declare module './Repo' {
+  interface Repo {
+    startTransaction(path: Path, transactionUpdate, onComplete, applyLocally): void
+  }
+}
+
 /**
  * Creates a new transaction, adds it to the transactions we're tracking, and sends it to the server if possible.
  *

src/database/core/SyncPoint.ts

@@ -55,7 +55,7 @@ export class SyncPoint {
     } else {
       var events = [];
 
-      forEach(this.views_, function(view) {
+      forEach(this.views_, function(key, view) {
         events = events.concat(view.applyOperation(operation, writesCache, optCompleteServerCache));
       });
 
@@ -122,7 +122,7 @@ export class SyncPoint {
     if (queryId === 'default') {
       // When you do ref.off(...), we search all views for the registration to remove.
       var self = this;
-      forEach(this.views_, function(view, viewQueryId) {
+      forEach(this.views_, function(viewQueryId, view) {
         cancelEvents = cancelEvents.concat(view.removeEventRegistration(eventRegistration, cancelError));
         if (view.isEmpty()) {
           delete self.views_[viewQueryId];
@@ -175,7 +175,7 @@ export class SyncPoint {
    */
   getCompleteServerCache(path) {
     var serverCache = null;
-    forEach(this.views_, function(view) {
+    forEach(this.views_, (key, view) => {
       serverCache = serverCache || view.getCompleteServerCache(path);
     });
     return serverCache;