WIP: refactor(database): Add migrated test harness [Part 3/3]

.gitignore

@@ -4,6 +4,7 @@
 npm-debug.log
 /coverage
 /.nyc_output
-/tests/integration/config
+/tests/config
 /temp
-/.vscode
+/.vscode
+/.ts-node

.travis.yml

@@ -16,8 +16,6 @@ addons:
       - g++-4.8
 before_script:
   - "export DISPLAY=:99.0"
+  - "mkdir -p tests/config && echo \"$PROJECT_CONFIG\" > tests/config/project.json"
 script:
   - xvfb-run npm test
-branches:
-  only:
-    - master

gulp/config.js

@@ -17,9 +17,13 @@ const path = require('path');
 const cwd = process.cwd();
 const karma = require('karma');
 
-module.exports = {
+const configObj = {
   root: path.resolve(cwd),
   pkg: require(path.resolve(cwd, 'package.json')),
+  testConfig: {
+    timeout: 5000,
+    retries: 5
+  },
   tsconfig:  require(path.resolve(cwd, 'tsconfig.json')),
   tsconfigTest:  require(path.resolve(cwd, 'tsconfig.test.json')),
   paths: {
@@ -30,6 +34,7 @@ module.exports = {
         'tests/**/*.test.ts',
         '!tests/**/browser/**/*.test.ts',
         '!tests/**/binary/**/*.test.ts',
+        '!src/firebase-*.ts',
       ],
       binary: [
         'tests/**/binary/**/*.test.ts',
@@ -102,7 +107,7 @@ module.exports = {
 
     // start these browsers
     // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['Chrome', 'Firefox'],
+    browsers: ['ChromeHeadless', 'Firefox'],
 
     // Continuous Integration mode
     // if true, Karma captures browsers, runs the tests and exits
@@ -115,6 +120,16 @@ module.exports = {
     // karma-typescript config
     karmaTypescriptConfig: {
       tsconfig: `./tsconfig.test.json`
+    },
+
+    // Stub for client config
+    client: {
+      mocha: {}
     }
   }
-};
+};
+
+configObj.karma.client.mocha.timeout = configObj.testConfig.timeout;
+configObj.karma.client.mocha.retries = configObj.testConfig.retries;
+
+module.exports = configObj;

gulp/tasks/dev.js

@@ -17,19 +17,18 @@ const gulp = require('gulp');
 const config = require('../config');
 
 // Ensure that the test tasks get set up
-require('./test');
+const testFxns = require('./test');
 
 function watchDevFiles() {
   const stream = gulp.watch([
     `${config.root}/src/**/*.ts`,
-    config.paths.test.unit
-  ], gulp.parallel('test:unit'));
+    'tests/**/*.test.ts'
+  ], testFxns.runBrowserUnitTests(true));
 
-  stream.on('error', () => {});
+  stream.on('error', err => {});
   return stream;
 }
 
 gulp.task('dev', gulp.parallel([
-  'test:unit',
   watchDevFiles
 ]));

gulp/tasks/test.js

@@ -32,7 +32,9 @@ function runNodeUnitTests() {
     .pipe(envs)
     .pipe(mocha({
       reporter: 'spec',
-      compilers: 'ts:ts-node/register'
+      compilers: 'ts:ts-node/register',
+      timeout: config.testConfig.timeout,
+      retries: config.testConfig.retries
     }));
 }
 
@@ -47,33 +49,41 @@ function runNodeBinaryTests() {
     .pipe(envs)
     .pipe(mocha({
       reporter: 'spec',
-      compilers: 'ts:ts-node/register'
+      compilers: 'ts:ts-node/register',
+      timeout: config.testConfig.timeout,
+      retries: config.testConfig.retries
     }));
 }
 
 /**
  * Runs all of the browser unit tests in karma
  */
-function runBrowserUnitTests(done) {
-  const karmaConfig = Object.assign({}, config.karma, {
-    // list of files / patterns to load in the browser
-    files: [
-      './+(src|tests)/**/*.ts'
-    ],
-
-    // list of files to exclude from the included globs above
-    exclude: [
-      // we don't want this file as it references files that only exist once compiled
-      `./src/firebase.ts`,
+function runBrowserUnitTests(dev) {
+  return (done) => {
+    const karmaConfig = Object.assign({}, config.karma, {
+      // list of files / patterns to load in the browser
+      files: [
+        './+(src|tests)/**/*.ts'
+      ],
+
+      // list of files to exclude from the included globs above
+      exclude: [
+        // we don't want this file as it references files that only exist once compiled
+        `./src/firebase-*.ts`,
 
-      // Don't include node test files
-      './tests/**/node/**/*.test.ts',
+        // We don't want to load the node env
+        `./src/utils/nodePatches.ts`,
 
-      // Don't include binary test files
-      './tests/**/binary/**/*.test.ts',
-    ],
-  });
-  new karma.Server(karmaConfig, done).start();
+        // Don't include node test files
+        './tests/**/node/**/*.test.ts',
+
+        // Don't include binary test files
+        './tests/**/binary/**/*.test.ts',
+      ],
+      browsers: !!dev ? ['ChromeHeadless'] : config.karma.browsers,
+    });
+    new karma.Server(karmaConfig, done).start();
+  };
 }
 
 /**
@@ -111,7 +121,10 @@ function runAllKarmaTests(done) {
     // list of files to exclude from the included globs above
     exclude: [
       // we don't want this file as it references files that only exist once compiled
-      `./src/firebase.ts`,
+      `./src/firebase-*.ts`,
+
+      // We don't want to load the node env      
+      `./src/utils/nodePatches.ts`,
 
       // Don't include node test files
       './tests/**/node/**/*.test.ts',
@@ -121,9 +134,9 @@ function runAllKarmaTests(done) {
 }
 
 gulp.task('test:unit:node', runNodeUnitTests);
-gulp.task('test:unit:browser', runBrowserUnitTests);
+gulp.task('test:unit:browser', runBrowserUnitTests());
 
-const unitTestSuite = gulp.parallel(runNodeUnitTests, runBrowserUnitTests);
+const unitTestSuite = gulp.parallel(runNodeUnitTests, runBrowserUnitTests());
 gulp.task('test:unit', unitTestSuite);
 
 gulp.task('test:binary:browser', runBrowserBinaryTests);
@@ -137,3 +150,6 @@ gulp.task('test', gulp.parallel([
   runNodeBinaryTests,
   runAllKarmaTests
 ]));
+
+exports.runNodeUnitTests = runNodeUnitTests;
+exports.runBrowserUnitTests = runBrowserUnitTests;

package.json

@@ -39,6 +39,7 @@
     "babel-preset-env": "^1.2.1",
     "chai": "^3.5.0",
     "child-process-promise": "^2.2.1",
+    "cross-env": "^5.0.1",
     "cz-customizable": "^5.0.0",
     "filesize": "^3.5.6",
     "git-rev-sync": "^1.9.0",

src/database.ts

@@ -58,7 +58,15 @@ declare module './app/firebase_app' {
 
 declare module './app/firebase_app' {
   interface FirebaseNamespace {
-    database?(app: FirebaseApp): Database
+    database?: {
+      (app?: FirebaseApp): Database,
+      Database,
+      enableLogging,
+      INTERNAL,
+      Query,
+      Reference,
+      ServerValue,
+    }
   }
 }
 

src/database/api/Database.ts

@@ -51,7 +51,7 @@ export class Database {
    * @param {string=} pathString
    * @return {!Firebase} Firebase reference.
    */
-  ref(pathString?): Reference {
+  ref(pathString?: string): Reference {
     this.checkDeleted_('ref');
     validateArgCount('database.ref', 0, 1, arguments.length);
 

src/database/api/Query.ts

@@ -221,8 +221,9 @@ export class Query {
    * @param context
    * @return {!firebase.Promise}
    */
-  once(eventType: string, userCallback: SnapshotCallback,
-       cancelOrContext?, context?: Object) {
+  once(eventType: string, 
+       userCallback?: SnapshotCallback,
+       cancelOrContext?, context?: Object): Promise<DataSnapshot> {
     validateArgCount('Query.once', 1, 4, arguments.length);
     validateEventType('Query.once', 1, eventType, false);
     validateCallback('Query.once', 2, userCallback, true);

src/database/api/onDisconnect.ts

@@ -26,7 +26,7 @@ export class OnDisconnect {
   }
 
   /**
-   * @param {function(?Error)=} opt_onComplete
+   * @param {function(?Error)=} onComplete
    * @return {!firebase.Promise}
    */
   cancel(onComplete?) {
@@ -38,7 +38,7 @@ export class OnDisconnect {
   }
 
   /**
-   * @param {function(?Error)=} opt_onComplete
+   * @param {function(?Error)=} onComplete
    * @return {!firebase.Promise}
    */
   remove(onComplete?) {
@@ -52,7 +52,7 @@ export class OnDisconnect {
 
   /**
    * @param {*} value
-   * @param {function(?Error)=} opt_onComplete
+   * @param {function(?Error)=} onComplete
    * @return {!firebase.Promise}
    */
   set(value, onComplete?) {
@@ -68,7 +68,7 @@ export class OnDisconnect {
   /**
    * @param {*} value
    * @param {number|string|null} priority
-   * @param {function(?Error)=} opt_onComplete
+   * @param {function(?Error)=} onComplete
    * @return {!firebase.Promise}
    */
   setWithPriority(value, priority, onComplete?) {
@@ -86,7 +86,7 @@ export class OnDisconnect {
 
   /**
    * @param {!Object} objectToMerge
-   * @param {function(?Error)=} opt_onComplete
+   * @param {function(?Error)=} onComplete
    * @return {!firebase.Promise}
    */
   update(objectToMerge, onComplete?) {

src/database/core/Repo.ts

@@ -286,8 +286,9 @@ export class Repo {
    * @param {number|string|null} newPriority
    * @param {?function(?Error, *=)} onComplete
    */
-  setWithPriority(path: Path, newVal: any, newPriority: number | string | null,
-                          onComplete: ((status: Error | null, errorReason?: string) => any) | null) {
+  setWithPriority(path: Path, newVal: any, 
+                  newPriority: number | string | null,
+                  onComplete: ((status: Error | null, errorReason?: string) => any) | null) {
     this.log_('set', {path: path.toString(), value: newVal, priority: newPriority});
 
     // TODO: Optimize this behavior to either (a) store flag to skip resolving where possible and / or

src/database/core/util/SortedMap.ts

@@ -714,35 +714,35 @@ export class SortedMap {
    * @param {(function(K, V):T)=} opt_resultGenerator
    * @return {SortedMapIterator.<K, V, T>} The iterator.
    */
-  getIterator(opt_resultGenerator) {
+  getIterator(resultGenerator?) {
     return new SortedMapIterator(this.root_,
                                               null,
                                               this.comparator_,
                                               false,
-                                              opt_resultGenerator);
+                                              resultGenerator);
   }
 
-  getIteratorFrom(key, opt_resultGenerator) {
+  getIteratorFrom(key, resultGenerator?) {
     return new SortedMapIterator(this.root_,
                                               key,
                                               this.comparator_,
                                               false,
-                                              opt_resultGenerator);
+                                              resultGenerator);
   }
 
-  getReverseIteratorFrom(key, opt_resultGenerator) {
+  getReverseIteratorFrom(key, resultGenerator?) {
     return new SortedMapIterator(this.root_,
                                               key,
                                               this.comparator_,
                                               true,
-                                              opt_resultGenerator);
+                                              resultGenerator);
   }
 
-  getReverseIterator(opt_resultGenerator) {
+  getReverseIterator(resultGenerator?) {
     return new SortedMapIterator(this.root_,
                                               null,
                                               this.comparator_,
                                               true,
-                                              opt_resultGenerator);
+                                              resultGenerator);
   }
 }; // end SortedMap

src/database/core/util/util.ts

@@ -114,7 +114,7 @@ export const buildLogMessage_ = function(var_args) {
  * Use this for all debug messages in Firebase.
  * @type {?function(string)}
  */
-export var logger = console.log.bind(console);
+export var logger = null;
 
 
 /**

src/database/core/view/filter/RangedFilter.ts

@@ -1,6 +1,6 @@
 import { IndexedFilter } from "./IndexedFilter";
 import { PRIORITY_INDEX } from "../../../core/snap/indexes/PriorityIndex";
-import { NamedNode } from "../../../core/snap/Node";
+import { Node, NamedNode } from "../../../core/snap/Node";
 import { ChildrenNode } from "../../../core/snap/ChildrenNode";
 /**
  * Filters nodes by range and uses an IndexFilter to track any changes after filtering the node