Adding Firestore minified int tests (#199)

* Fixing firestore integration tests

* Regen yarn.lock

* [AUTOMATED]: Prettier Code Styling

* [AUTOMATED]: License Headers

* Refactor timeout/retry logic to be globally applied

* Documenting changes to firestore int tests

* Fixing tests to properly build the firestore int tests

* Trim dist directory for consistent rebuilds

* [AUTOMATED]: Prettier Code Styling

* Fixing some whitespace issues

Author: jshcrowthe

config/karma.base.js

@@ -102,7 +102,14 @@ const config = {
     startConnect: false
   },
 
-  singleRun: false
+  singleRun: false,
+
+  client: {
+    mocha: {
+      timeout: 20000,
+      retries: 3
+    }
+  }
 };
 
 // In CI environment, use saucelabs to test

integration/firestore/.gitignore

@@ -0,0 +1 @@
+temp

integration/firestore/README.md

@@ -2,5 +2,13 @@ These tests are intended to be run against the minified compiled version of the
 firebase binary (i.e. `firebase.js` and `firebase-firestore.js` of the `firebase` 
 package).
 
-They are currently just rerunning tests against the uncompiled version and we
-need to address that.
+The integration test files are modified to replace references to the
+`firebase_export` entrypoint with the following `declare` statement:
+
+```typescript
+declare var firebase;
+```
+
+This will help the test files pass the compile step, and will allow us to, at
+test time, inject the firebase variable into global scope (from the compiled)
+files, which will be used by the tests.

integration/firestore/firebase_export.ts

@@ -0,0 +1,79 @@
+/**
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const gulp = require('gulp');
+const replace = require('gulp-replace');
+const { resolve } = require('path');
+const webpackStream = require('webpack-stream');
+const webpack = require('webpack');
+const filter = require('gulp-filter');
+
+function reworkFirebasePaths() {
+  return gulp
+    .src(
+      [
+        resolve(__dirname, '../../packages/firestore/**/*.ts'),
+        `!${resolve(__dirname, '../../packages/firestore/node_modules/**/*')}`,
+        `!${resolve(__dirname, '../../packages/firestore/dist/**/*')}`
+      ],
+      { base: '../../packages/firestore' }
+    )
+    .pipe(
+      replace(
+        /**
+         * This regex is designed to match the following statement used in our
+         * firestore integratino test suites:
+         * 
+         * import firebase from '../../util/firebase_export';
+         *  
+         * It will handle variations in whitespace, single/double quote
+         * differences, as well as different paths to a valid firebase_export
+         */
+        /import\s+firebase\s+from\s+('|")[^\1]+firebase_export\1;?/,
+        'declare var firebase;'
+      )
+    )
+    .pipe(
+      /**
+       * Fixing the project.json require to properly reference the file
+       */
+      replace(
+        '../../../../../config/project.json',
+        '../../../../../../config/project.json'
+      )
+    )
+    .pipe(gulp.dest('temp'));
+}
+
+function compileWebpack() {
+  const config = require('../../config/webpack.test');
+  return gulp
+    .src('./temp/test/integration/**/*.ts')
+    .pipe(
+      webpackStream(
+        Object.assign({}, config, {
+          output: {
+            filename: 'test-harness.js'
+          }
+        }),
+        webpack
+      )
+    )
+    .pipe(filter(['**', '!**/*.d.ts']))
+    .pipe(gulp.dest('dist'));
+}
+
+gulp.task('compile-tests', gulp.series(reworkFirebasePaths, compileWebpack));

integration/firestore/gulpfile.js

@@ -14,57 +14,22 @@
  * limitations under the License.
  */
 
-const webpackConfig = require('./webpack.config');
+const karma = require('karma');
+const path = require('path');
+const karmaBase = require('../../config/karma.base');
 
-// Karma configuration
 module.exports = function(config) {
-  config.set({
+  const karmaConfig = Object.assign({}, karmaBase, {
+    // files to load into karma
+    files: [
+      `${path.dirname(require.resolve('firebase'))}/firebase.js`,
+      `${path.dirname(require.resolve('firebase'))}/firebase-firestore.js`,
+      './dist/test-harness.js'
+    ],
     // frameworks to use
     // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
-    frameworks: ['mocha'],
-
-    // list of files / patterns to load in the browser
-    files: [{ pattern: 'tests/**/*.test.ts' }],
-
-    client: {
-      mocha: {
-        // Set timeout / retries to match what's configured in /gulp/config.js
-        timeout: 5000,
-        retries: 5
-      }
-    },
-
-    preprocessors: {
-      '**/*.ts': ['webpack']
-    },
-
-    mime: {
-      'text/x-typescript': ['ts', 'tsx']
-    },
-
-    // test results reporter to use
-    // possible values: 'dots', 'progress'
-    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ['spec'],
-
-    // enable / disable colors in the output (reporters and logs)
-    colors: true,
-
-    // level of logging
-    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
-    logLevel: config.LOG_INFO,
-
-    // enable / disable watching file and executing tests whenever any file changes
-    autoWatch: false,
-
-    // start these browsers
-    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['ChromeHeadless'],
-
-    // Continuous Integration mode
-    // if true, Karma captures browsers, runs the tests and exits
-    singleRun: true,
-
-    webpack: webpackConfig
+    frameworks: ['mocha']
   });
+
+  config.set(karmaConfig);
 };

integration/firestore/hijack-promise.test.ts

@@ -1,21 +1,24 @@
 {
   "name": "firebase-firestore-integration-test",
   "version": "1.0.0",
-  "main": "runner.sh",
+  "scripts": {
+    "pretest": "gulp compile-tests",
+    "test": "karma start --single-run"
+  },
   "devDependencies": {
-    "@types/chai": "^3.4.35",
     "@types/mocha": "^2.2.39",
     "@types/node": "^7.0.8",
-    "chai": "^3.5.0",
+    "gulp": "gulpjs/gulp#4.0",
+    "gulp-filter": "^5.0.1",
+    "gulp-replace": "^0.6.1",
     "karma": "^1.7.0",
     "karma-chrome-launcher": "^2.2.0",
     "karma-mocha": "^1.3.0",
     "karma-spec-reporter": "0.0.31",
-    "karma-typescript": "^3.0.6",
-    "karma-webpack": "^2.0.4",
     "mocha": "^3.5.0",
     "ts-loader": "^2.3.6",
     "typescript": "^2.4.2",
-    "webpack": "^3.5.6"
+    "webpack": "^3.6.0",
+    "webpack-stream": "^4.0.0"
   }
 }

integration/firestore/karma.conf.js

@@ -1,23 +1,3 @@
 {
-  "compileOnSave": false,
-  "compilerOptions": {
-    "allowJs": true,
-    "lib": [
-      "es5",
-      "es2015",
-      "es2015.promise",
-      "dom"
-    ],
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "outDir": "tmp",
-    "target": "ES5",
-    "sourceMap": true,
-    "typeRoots" : [
-      "node_modules/@types"
-    ]
-  },
-  "exclude": [
-    "node_modules"
-  ]
+  "extends": "../../config/tsconfig.base.json"
 }