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

* refactor(database): add typescript implementation

* refactor(database): update build process to include database.ts

All integration tests pass at this point

* refactor(*): refactor environment builds to be based on separate .ts files

* WIP: patch database code in nodeJS

* refactor(database): classes for typescript database implementation (#55)

* refactor(database): classes for typescript database implementation

* refactor(database): requested changes & other improvements

* WIP: add the /tests/config dir to the .gitignore

* WIP: add test harness

* WIP: add query tests

There are some tests that have weird timing issues, and because of the polling nature of the
original implementation, we never caught the issue. These should be resolved when able

* WIP: add database.test.ts

* WIP: add node.test.ts

* WIP: add sortedmap.test.ts

* WIP: add datasnapshot.test.ts

* WIP: add sparsesnapshottree.test.ts

* refactor(database): refactor query.test.ts to better preserve original test meaning

* WIP: add crawler_support.test.ts

* WIP: refactor EventAccumulator.ts for data.test.ts

* WIP: fix issue with query.test.ts

* WIP: add connection.test.ts

* WIP: add info.test.ts

* WIP: add order_by.test.ts

I only migrated some of these tests as there was a dependency on the server for several tests

* WIP: fix several code signature problems, add test files

* WIP: add transaction.test.ts

* WIP: working on the broken npm test command

* WIP: working on fixes

* WIP: remove logging

* WIP: fix node tests

* fix(*): fixing test files and CI integration

* WIP: tEMP: Allow branch builds

* WIP: escape string

* refactor(CI): use ChromeHeadless launcher

* WIP: fixes from review.

* WIP: skip flakey test

* WIP: remove unneeded debugger statement

* WIP: fixing nits

Author: jshcrowthe

.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?) {