Merge branch 'master' of https://github.com/firebase/firebase-js-sdk into ch-strict

Author: hsubox76

.travis.yml

@@ -42,20 +42,15 @@ matrix:
 jobs:
   allow_failures:
     - script: yarn test:saucelabs
-    - script: yarn test:saucelabs --database-firestore-only
   include:
     - name: Node.js and Browser (Chrome) Test
       stage: test
       script: xvfb-run yarn test
       after_success: yarn test:coverage
-    - name: Cross Browser Test for SDKs except Database and Firestore
+    - name: Cross Browser Test for SDKs
       stage: test
       script: yarn test:saucelabs
       if: type = push
-    - name: Cross Browser Test for Database and Firestore SDK
-      stage: test
-      script: yarn test:saucelabs --database-firestore-only
-      if: type = push
     - stage: deploy
       script: skip
       # NPM Canary Build Config

ENVIRONMENTS.md

@@ -18,6 +18,9 @@ To get started using Firebase, see
 
 [![Release Notes](https://img.shields.io/npm/v/firebase.svg?style=flat-square&label=Release%20Notes%20for&labelColor=039be5&color=666)](https://firebase.google.com/support/release-notes/js)
 
+## Supported Environments
+Please see [Environment Support](https://firebase.google.com/support/guides/environments_js-sdk).
+
 ## SDK Dev Workflow
 
 ### Prerequisites

README.md

@@ -16,42 +16,98 @@
  */
 
 const argv = require('yargs').argv;
-const glob = require('glob');
-const karma = require('karma');
 const path = require('path');
 const karmaBase = require('./karma.base');
 
+// karma.conf.js test configuration file to run.
+const testConfigFile = argv['testConfigFile'];
+if (!testConfigFile) {
+  console.error('No test file path provided.');
+  process.exit(1);
+}
+
+/**
+ * Custom SauceLabs Launchers
+ */
+const browserMap = {
+  // Desktop
+  Chrome_Windows: seleniumLauncher('chrome', 'Windows 10', 'latest'),
+  Firefox_Windows: seleniumLauncher('firefox', 'Windows 10', 'latest'),
+  Safari_macOS: seleniumLauncher('safari', 'macOS 10.13', 'latest'),
+  Edge_Windows: seleniumLauncher('MicrosoftEdge', 'Windows 10', 'latest'),
+  IE_Windows: seleniumLauncher('internet explorer', 'Windows 10', 'latest')
+
+  // Mobile
+  // Safari_iOS: appiumLauncher('Safari', 'iPhone Simulator', 'iOS', '11.2'),
+  // Chrome_Android: appiumLauncher('Chrome', 'Android Emulator', 'Android', '6.0')
+};
+
+/**
+ * Any special options per package.
+ */
+const packageConfigs = {
+  messaging: {
+    // Messaging currently only supports these browsers.
+    browsers: ['Chrome_Windows', 'Firefox_Windows', 'Edge_Windows']
+  }
+};
+
+/**
+ * Gets the browser/launcher map for this package.
+ *
+ * @param {string} packageName Name of package being tested (e.g., "firestore")
+ */
+function getSauceLabsBrowsers(packageName) {
+  if (packageConfigs[packageName]) {
+    const filteredBrowserMap = {};
+    for (const browserKey in browserMap) {
+      if (packageConfigs[packageName].browsers.includes(browserKey)) {
+        filteredBrowserMap[browserKey] = browserMap[browserKey];
+      }
+    }
+    return filteredBrowserMap;
+  } else {
+    return browserMap;
+  }
+}
+
+/**
+ * Get package name from package path command line arg.
+ */
+function getPackageLabels() {
+  const match = testConfigFile.match(
+    /([a-zA-Z]+)\/([a-zA-Z]+)\/karma\.conf\.js/
+  );
+  return {
+    type: match[1],
+    name: match[2]
+  };
+}
+
 /**
  * Gets a list of file patterns for test, defined individually
  * in karma.conf.js in each package under worksapce packages or
  * integration.
  */
 function getTestFiles() {
   let root = path.resolve(__dirname, '..');
-  configs = argv['database-firestore-only']
-    ? glob.sync('packages/{database,firestore}/karma.conf.js')
-    : glob.sync('{packages,integration}/*/karma.conf.js', {
-        // Excluded due to flakiness or long run time.
-        ignore: [
-          'packages/database/*',
-          'packages/firestore/*',
-          'integration/firestore/*',
-          'integration/messaging/*'
-        ]
-      });
-  files = configs.map(x => {
-    let patterns = require(path.join(root, x)).files;
-    let dirname = path.dirname(x);
-    return patterns.map(p => path.join(dirname, p));
-  });
-  return [].concat(...files);
+  const { name: packageName } = getPackageLabels();
+  let patterns = require(path.join(root, testConfigFile)).files;
+  let dirname = path.dirname(testConfigFile);
+  return { packageName, files: patterns.map(p => path.join(dirname, p)) };
 }
 
 function seleniumLauncher(browserName, platform, version) {
+  const { name, type } = getPackageLabels();
+  const testName =
+    type === 'integration'
+      ? `${type}-${name}-${browserName}`
+      : `${name}-${browserName}`;
   return {
     base: 'SauceLabs',
     browserName: browserName,
     extendedDebugging: 'true',
+    name: testName,
     recordLogs: 'true',
     recordVideo: 'true',
     recordScreenshots: 'true',
@@ -81,27 +137,32 @@ function appiumLauncher(
   };
 }
 
-/**
- * Custom SauceLabs Launchers
- */
-const sauceLabsBrowsers = {
-  // Desktop
-  Chrome_Windows: seleniumLauncher('chrome', 'Windows 10', 'latest'),
-  Firefox_Windows: seleniumLauncher('firefox', 'Windows 10', 'latest'),
-  Safari_macOS: seleniumLauncher('safari', 'macOS 10.13', 'latest'),
-  Edge_Windows: seleniumLauncher('MicrosoftEdge', 'Windows 10', 'latest'),
-  IE_Windows: seleniumLauncher('internet explorer', 'Windows 10', 'latest')
-
-  // Mobile
-  // Safari_iOS: appiumLauncher('Safari', 'iPhone Simulator', 'iOS', '11.2'),
-  // Chrome_Android: appiumLauncher('Chrome', 'Android Emulator', 'Android', '6.0')
-};
-
 module.exports = function(config) {
+  const { packageName, files: testFiles } = getTestFiles();
+  const sauceLabsBrowsers = getSauceLabsBrowsers(packageName);
+
+  const sauceLabsConfig = {
+    tunnelIdentifier: process.env.TRAVIS_JOB_NUMBER + '-' + packageName,
+    build: process.env.TRAVIS_BUILD_NUMBER || argv['buildNumber'],
+    username: process.env.SAUCE_USERNAME,
+    accessKey: process.env.SAUCE_ACCESS_KEY,
+    startConnect: true,
+    connectOptions: {
+      // Realtime Database uses WebSockets to connect to firebaseio.com
+      // so we have to set noSslBumpDomains. Theoretically SSL Bumping
+      // only needs to be disabled for 'firebaseio.com'. However, we are
+      // seeing much longer test time with that configuration, so leave
+      // it as 'all' for now.
+      // See https://wiki.saucelabs.com/display/DOCS/Troubleshooting+Sauce+Connect
+      // for more details.
+      noSslBumpDomains: 'all'
+    }
+  };
+
   const karmaConfig = Object.assign({}, karmaBase, {
     basePath: '../',
 
-    files: ['packages/polyfill/index.ts', ...getTestFiles()],
+    files: ['packages/polyfill/index.ts', ...testFiles],
 
     logLevel: config.LOG_INFO,
 
@@ -151,22 +212,7 @@ module.exports = function(config) {
       overviewColumn: false
     },
 
-    sauceLabs: {
-      tunnelIdentifier: process.env.TRAVIS_JOB_NUMBER,
-      username: process.env.SAUCE_USERNAME,
-      accessKey: process.env.SAUCE_ACCESS_KEY,
-      startConnect: true,
-      connectOptions: {
-        // Realtime Database uses WebSockets to connect to firebaseio.com
-        // so we have to set noSslBumpDomains. Theoretically SSL Bumping
-        // only needs to be disabled for 'firebaseio.com'. However, we are
-        // seeing much longer test time with that configuration, so leave
-        // it as 'all' for now.
-        // See https://wiki.saucelabs.com/display/DOCS/Troubleshooting+Sauce+Connect
-        // for more details.
-        noSslBumpDomains: 'all'
-      }
-    }
+    sauceLabs: sauceLabsConfig
   });
 
   config.set(karmaConfig);

config/karma.saucelabs.js

@@ -30,7 +30,8 @@ module.exports = {
           loader: 'ts-loader',
           options: {
             compilerOptions: {
-              module: 'commonjs'
+              module: 'commonjs',
+              downlevelIteration: true
             }
           }
         }

config/webpack.test.js

@@ -29,8 +29,8 @@
     "pretest:coverage": "mkdirp coverage",
     "test:coverage": "lcov-result-merger 'packages/**/lcov.info' | coveralls",
     "test:setup": "node tools/config.js",
-    "pretest:saucelabs": "lerna run --parallel pretest",
-    "test:saucelabs": "karma start config/karma.saucelabs.js --single-run",
+    "test:saucelabs": "node scripts/run_saucelabs.js",
+    "test:saucelabs:single": "karma start config/karma.saucelabs.js --single-run",
     "docgen:js": "node scripts/docgen/generate-docs.js --api js",
     "docgen:node": "node scripts/docgen/generate-docs.js --api node",
     "docgen": "yarn docgen:js; yarn docgen:node",

package.json

@@ -52,6 +52,7 @@
     "rollup": "1.11.0",
     "rollup-plugin-replace": "2.2.0",
     "rollup-plugin-typescript2": "0.21.0",
+    "rollup-plugin-json": "4.0.0",
     "sinon": "7.3.2",
     "source-map-loader": "0.2.4",
     "ts-loader": "5.4.5",
@@ -67,7 +68,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/app/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages/app/package.json

@@ -16,12 +16,10 @@
  */
 
 import typescriptPlugin from 'rollup-plugin-typescript2';
-import replace from 'rollup-plugin-replace';
+import json from 'rollup-plugin-json';
 import typescript from 'typescript';
 import pkg from './package.json';
 
-import firebasePkg from '../firebase/package.json';
-
 const deps = Object.keys(
   Object.assign({}, pkg.peerDependencies, pkg.dependencies)
 );
@@ -33,12 +31,7 @@ const es5BuildPlugins = [
   typescriptPlugin({
     typescript
   }),
-  replace({
-    delimiters: ['${', '}'],
-    values: {
-      JSCORE_VERSION: firebasePkg.version
-    }
-  })
+  json()
 ];
 
 const es5Builds = [
@@ -98,11 +91,8 @@ const es2017BuildPlugins = [
       }
     }
   }),
-  replace({
-    delimiters: ['${', '}'],
-    values: {
-      JSCORE_VERSION: firebasePkg.version
-    }
+  json({
+    preferConst: true
   })
 ];
 

packages/app/rollup.config.js

@@ -34,6 +34,7 @@ import { FirebaseAppImpl } from './firebaseApp';
 import { error, AppError } from './errors';
 import { FirebaseAppLiteImpl } from './lite/firebaseAppLite';
 import { DEFAULT_ENTRY_NAME } from './constants';
+import { version } from '../../firebase/package.json';
 
 function contains(obj: object, key: string) {
   return Object.prototype.hasOwnProperty.call(obj, key);
@@ -62,7 +63,7 @@ export function createFirebaseNamespaceCore(
     initializeApp: initializeApp,
     app: app as any,
     apps: null as any,
-    SDK_VERSION: '${JSCORE_VERSION}',
+    SDK_VERSION: version,
     INTERNAL: {
       registerService,
       removeApp,

packages/app/src/firebaseNamespaceCore.ts

@@ -28,7 +28,7 @@ import { createFirebaseNamespaceCore } from '../firebaseNamespaceCore';
 export function createFirebaseNamespaceLite(): FirebaseNamespace {
   const namespace = createFirebaseNamespaceCore(FirebaseAppLiteImpl);
 
-  namespace.SDK_VERSION = '${JSCORE_VERSION}_LITE';
+  namespace.SDK_VERSION = `${namespace.SDK_VERSION}_LITE`;
 
   const registerService = (namespace as _FirebaseNamespace).INTERNAL
     .registerService;

packages/app/src/lite/firebaseNamespaceLite.ts

@@ -1,7 +1,8 @@
 {
   "extends": "../../config/tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "dist"
+    "outDir": "dist",
+    "resolveJsonModule": true
   },
   "exclude": [
     "dist/**/*"

packages/app/tsconfig.json

@@ -26,24 +26,6 @@ import { terser } from 'rollup-plugin-terser';
 import pkg from './package.json';
 
 import appPkg from './app/package.json';
-import authPkg from './auth/package.json';
-import databasePkg from './database/package.json';
-import firestorePkg from './firestore/package.json';
-import functionsPkg from './functions/package.json';
-import messagingPkg from './messaging/package.json';
-import storagePkg from './storage/package.json';
-import performancePkg from './performance/package.json';
-
-const pkgsByName = {
-  app: appPkg,
-  auth: authPkg,
-  database: databasePkg,
-  firestore: firestorePkg,
-  functions: functionsPkg,
-  messaging: messagingPkg,
-  storage: storagePkg,
-  performance: performancePkg
-};
 
 const plugins = [
   sourcemaps(),