Merge branch 'master' into mrschmidt-nullability

Author: schmidt-sebastian

.github/CODEOWNERS

@@ -1,34 +1,69 @@
 # Lines starting with '#' are comments.
 # Each line is a file pattern followed by one or more owners.
 
+######################################################################################################
+#
+#  Team structure and memberships
+#
+#######################################################################################################
+
+# ===========================================================
+#  @firebase/jssdk-global-approvers
+# ===========================================================
+#  Used for approving minor changes, large-scale refactorings, and emergency situations.
+#  (secret team to avoid review requests)
+#
+#   - @Feiyang1 
+#   - @hiranya911 
+#   - @mikelehen 
+#   - @bojeil-google
+#   - @depoll
+#   - @hsubox76
+
+
+# ===========================================================
+#  @firebase/firestore-js-team
+# ===========================================================
+#  Used for approving firestore changes.
+#  (secret team to avoid review requests)
+#
+# - @mikelehen 
+# - @schmidt-sebastian 
+# - @wilhuff 
+# - @gsoltis
+# - @var-const
+# - @rsgowman
+# - @zxu123
+
+
 # These owners will be the default owners for everything in the repo.
-*       @jshcrowthe @hiranya911 @mikelehen @bojeil-google @depoll
+*       @Feiyang1 @hiranya911 @hsubox76 @firebase/jssdk-global-approvers
 
 # Database Code
-packages/database  @mikelehen @schmidt-sebastian
-packages/database-types  @mikelehen @schmidt-sebastian
+packages/database  @mikelehen @schmidt-sebastian @jsdt @firebase/jssdk-global-approvers
+packages/database-types  @mikelehen @schmidt-sebastian @jsdt @firebase/jssdk-global-approvers
 
 # Firestore Code
-packages/firestore  @mikelehen @schmidt-sebastian @wilhuff @gsoltis @var-const @rsgowman @zxu123
-packages/webchannel-wrapper  @mikelehen @schmidt-sebastian @wilhuff @gsoltis @var-const @rsgowman @zxu123
-packages/firestore-types  @mikelehen @schmidt-sebastian @wilhuff @gsoltis @var-const @rsgowman @zxu123
-integration/firestore  @mikelehen @schmidt-sebastian @wilhuff @gsoltis @var-const @rsgowman @zxu123
+packages/firestore  @firebase/firestore-js-team @firebase/jssdk-global-approvers
+packages/webchannel-wrapper  @firebase/firestore-js-team @firebase/jssdk-global-approvers
+packages/firestore-types  @firebase/firestore-js-team @firebase/jssdk-global-approvers
+integration/firestore  @firebase/firestore-js-team @firebase/jssdk-global-approvers
 
 # Storage Code
-packages/storage  @sphippen
-packages/storage-types  @sphippen
+packages/storage  @schmidt-sebastian @firebase/jssdk-global-approvers
+packages/storage-types  @schmidt-sebastian @firebase/jssdk-global-approvers
 
 # Messaging Code
-packages/messaging  @gauntface @pinarx @mmermerkaya @dwoffinden
-packages/messaging-types  @gauntface @pinarx @mmermerkaya @dwoffinden
-integration/messaging  @gauntface @pinarx @mmermerkaya @dwoffinden
+packages/messaging  @pinarx @mmermerkaya @dwoffinden @firebase/jssdk-global-approvers
+packages/messaging-types  @pinarx @mmermerkaya @dwoffinden @firebase/jssdk-global-approvers
+integration/messaging  @pinarx @mmermerkaya @dwoffinden @firebase/jssdk-global-approvers
 
 # Auth Code
-packages/auth  @bojeil-google @wti806
-packages/auth-types  @bojeil-google @wti806
+packages/auth  @bojeil-google @wti806 @firebase/jssdk-global-approvers
+packages/auth-types  @bojeil-google @wti806 @firebase/jssdk-global-approvers
 
 # Testing Code
-packages/testing  @tonymeng @ryanpbrewster
+packages/testing  @tonymeng @ryanpbrewster @firebase/jssdk-global-approvers
 
 # RxFire Code
-packages/rxfire @davideast
+packages/rxfire @davideast @jamesdaniels @firebase/jssdk-global-approvers

.gitignore

@@ -3,6 +3,7 @@ node_modules
 dist
 .awcache
 /config/project.json
+scripts/docgen/html
 
 # OS Specific Files
 .DS_Store

.travis.yml

@@ -10,10 +10,12 @@ env:
 before_install:
   # Yarn defaults to an old version, make sure we
   # get an up to date version
-  - npm install -g yarn
+  - npm install -g yarn@1.13.0
   - '[ "${NPM_TOKEN+x}" ] && echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > $HOME/.npmrc || echo "Skipping .npmrc creation";'
+
 before_script:
   - cp config/ci.config.json config/project.json
+  - yarn build
 
 # Misc Addons/Configs
 dist: trusty
@@ -35,17 +37,17 @@ jobs:
     - script: yarn test:saucelabs
     - script: yarn test:saucelabs --database-firestore-only
   include:
-    - stage: test
+    - name: Node.js and Browser (Chrome) Test
+      stage: test
       script: xvfb-run yarn test
       after_success: yarn test:coverage
-      env: '#= chrome headless test'
-    - stage: test
+    - name: Cross Browser Test for SDKs except Database and Firestore
+      stage: test
       script: yarn test:saucelabs
-      env: '#= cross browser test: all packages except database and firestore'
       if: type = push
-    - stage: test
+    - name: Cross Browser Test for Database and Firestore SDK
+      stage: test
       script: yarn test:saucelabs --database-firestore-only
-      env: '#= cross browser test: database and firestore (allow_failures)'
       if: type = push
     - stage: deploy
       script: skip

.vscode/launch.json

@@ -18,7 +18,8 @@
         "--exit"
       ],
       "env": {
-        "TS_NODE_CACHE": "NO"
+        "TS_NODE_CACHE": "NO",
+        "TS_NODE_COMPILER_OPTIONS" : "{\"module\":\"commonjs\"}"
       },
       "sourceMaps": true,
       "protocol": "inspector"
@@ -39,7 +40,8 @@
       ],
       "env": {
         "USE_MOCK_PERSISTENCE": "YES",
-        "TS_NODE_CACHE": "NO"
+        "TS_NODE_CACHE": "NO",
+        "TS_NODE_COMPILER_OPTIONS" : "{\"module\":\"commonjs\"}"
       },
       "sourceMaps": true,
       "protocol": "inspector"
@@ -58,7 +60,9 @@
         "--exit"
       ],
       "env": {
-        "TS_NODE_CACHE": "NO"
+        "TS_NODE_CACHE": "NO",
+        "TS_NODE_COMPILER_OPTIONS" : "{\"module\":\"commonjs\"}"
+
       },
       "sourceMaps": true,
       "protocol": "inspector"
@@ -79,7 +83,9 @@
       ],
       "env": {
         "USE_MOCK_PERSISTENCE": "YES",
-        "TS_NODE_CACHE": "NO"
+        "TS_NODE_CACHE": "NO",
+        "TS_NODE_COMPILER_OPTIONS" : "{\"module\":\"commonjs\"}"
+
       },
       "sourceMaps": true,
       "protocol": "inspector"

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   // Ruler can't be specified via editorconfig
-  "editor.rulers": [80],
+  "editor.rulers": [100],
 
   "search.exclude": {
     // Exclude gulp build outputs from search results

CONTRIBUTING.md

@@ -7,8 +7,7 @@ We'd love for you to contribute to our source code and to help make the Firebase
  - [Issues and Bugs](#issue)
  - [Feature Requests](#feature)
  - [Submission Guidelines](#submit)
- - [Coding Rules](#rules)
- - [Signing the CLA](#cla)
+ - [Updating Documentation](#docs)
 
 ## <a name="coc"></a> Code of Conduct
 
@@ -59,13 +58,13 @@ Also as a great rule of thumb:
 
 ### Submitting a Pull Request
 
-### Before you contribute
+#### Before you contribute
 
 Before we can use your code, you must sign the [Google Individual Contributor License Agreement][google-cla] (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things, for instance, that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase. There is also a nifty CLA bot that will guide you through this process if you are going through it for the first time.
 
 Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on. Some pull requests (large contributions, API additions/changes, etc) may be subject to additional internal review, we appreciate your patience as we fully validate your contribution.
 
-### Pull Request Guidelines
+#### Pull Request Guidelines
 
 * Search [GitHub](https://github.com/firebase/firebase-js-sdk/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
 * Create an issue to discuss a change before submitting a PR. We'd hate to have to turn down your contributions because of something that could have been communicated early on.
@@ -102,6 +101,45 @@ Before you start working on a larger contribution, you should get in touch with
 
 That's it! Thank you for your contribution!
 
+## <a name="docs"></a> Updating Documentation
+
+Reference docs for the Firebase [JS SDK](https://firebase.google.com/docs/reference/js/) and [Node (client) SDK](https://firebase.google.com/docs/reference/node/) are generated by [Typedoc](https://typedoc.org/).
+
+Typedoc generates this documentation from the main [firebase index.d.ts type definition file](packages/firebase/index.d.ts).  Any updates to documentation should be made in that file.
+
+If any pages are added or removed by your change (by adding or removing a class or interface), the [js/toc.yaml](scripts/docgen/content-sources/js/toc.yaml) and/or [node/toc.yaml](scripts/docgen/content-sources/node/toc.yaml) need to be modified to reflect this.
+
+### Generating Documentation HTML Files
+
+In order to generate the HTML documentation files locally, go to the root of this repo, and run:
+
+```
+yarn install
+yarn docgen
+```
+
+This will generate both js and node (client) reference docs. To just generate js
+docs, replace the last line with:
+
+```
+yarn docgen:js
+```
+
+To just generate node docs, replace the last line with:
+
+```
+yarn docgen:node
+```
+
+Files will be written to `scripts/docgen/html` - js docs will go into the `/js`
+subdirectory and node docs into the `/node` subdirectory.
+
+**NOTE:** These files are formatted to be inserted into Google's documentation site, which adds some styling and navigation, so the raw files will be missing navigation elements and may not look polished. However, it should be enough to preview the content.
+
+This process will generate warnings for files that are generated but not listed in the `toc.yaml`, or files that are in the `toc.yaml` but were not generated (which means something is missing in `index.d.ts`).  If this happens during the JS documentation generation, it probably means either the `toc.yaml` or `index.d.ts` is incorrect.  But in the Node process, some generated files not being found in `toc.yaml` are to be expected, since Node documentation is a subset of the full JS documentation.
+
+Follow the [PR submission guidelines](#submit) above to submit any documentation changes.
+
 [archive]: https://github.com/firebase/firebase-js-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue
 [file-an-issue]: https://github.com/firebase/firebase-js-sdk/issues/new
 [firebase-google-group]: https://groups.google.com/forum/#!forum/firebase-talk

README.md

@@ -8,7 +8,7 @@
 The Firebase JavaScript SDK implements the client-side libraries used by
 applications using Firebase services. This SDK is distributed via:
 
-- CDN (`<script src="https://www.gstatic.com/firebasejs/4.0.0/firebase.js"></script>`)
+- CDN (`<script src="https://www.gstatic.com/firebasejs/5.5.3/firebase.js"></script>`)
 - [npm package](https://www.npmjs.com/package/firebase)
 - [Bower package](https://github.com/firebase/firebase-bower)
 
@@ -24,7 +24,8 @@ Current [Release Notes](https://firebase.google.com/support/release-notes/js)
 #### Node.js
 
 Before you can start working on the Firebase JS SDK, you need to have Node.js
-`8.0.0` or greater installed on your machine. 
+installed on your machine. The currently supported versions are `8.0.0` or greater,
+but smaller than `10.0.0`.
 
 To download Node.js visit https://nodejs.org/en/download/.
 
@@ -35,7 +36,7 @@ or [`N`](https://github.com/tj/n) to install and manage multiple node versions_
 
 In addition to Node.js we use `yarn` to facilitate multi package development.
 
-To install `yarn` follow the instructions listed on their website: 
+To install `yarn` follow the instructions listed on their website:
 https://yarnpkg.com/en/docs/install
 
 #### Java
@@ -69,6 +70,13 @@ by running the following at the root of the SDK:
 $ yarn
 ```
 
+Once you have installed all the dependencies, you can build the entire SDK by
+running the following command the root of the SDK:
+
+```bash
+$ yarn build
+```
+
 ## Testing the SDK
 
 ### Test Setup
@@ -84,23 +92,29 @@ them below.
 
 #### Authentication Support
 
-Visit the authentication config in your project and enable the `Anonymous` 
+Visit the authentication config in your project and enable the `Anonymous`
 sign-in provider to complete your project config.
 
 #### Automated Setup
 
-The remainder of the test setup can be done by running the following command at
-the root of the package:
+The remainder of the test setup requires choosing a test project. You can 
+choose the project manually or specify the project directly at the root of 
+the package.
 
 ```bash
-yarn test:setup
+# Select a project manually when running setup
+$ yarn test:setup
+
+# Specify the specific project for setup
+$ yarn test:setup --projectId=<your-test-project>
 ```
 
 ### Running the tests
 
 Each of the directories in the `integration` directory as well as the `packages`
-directory have their own test suites. These can be run altogether by running the
-following command at the root of the package:
+directory have their own test suites. You will need to build the SDK before
+running tests. Test suites can be run all together by running the following 
+command at the root of the package:
 
 ```bash
 $ yarn test
@@ -114,13 +128,13 @@ an individual package directory.
 ### Introduction
 
 The Firebase JS SDK is built with a series of individual packages that are all
-contained in this repository. Development is coordinated via [yarn 
-workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/) and 
+contained in this repository. Development is coordinated via [yarn
+workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/) and
 [Lerna](https://lernajs.io/) (a monorepo management tool).
 
 Each package in the `packages` directory, constitute a piece of our
 implementation. The SDK is built via a combination of all of these packages
-which are published under the [`firebase` 
+which are published under the [`firebase`
 scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM.
 
 ### Helper Scripts
@@ -133,12 +147,12 @@ watch tasks as well as a sandbox server.
 You can run the dev script by running the following at the root of the package:
 
 ```bash
-yarn dev
+$ yarn dev
 ```
 
 ### Prepush Hooks
 
-As part of this repo, we use the NPM package [`husky`](https://npm.im/husky) to 
+As part of this repo, we use the NPM package [`husky`](https://npm.im/husky) to
 implement git hooks. We leverage the prepush hook to do two things:
 
 - Automated code styling (using [`prettier`](https://npm.im/prettier))

config/functions/.ncurc.json

@@ -0,0 +1,5 @@
+{
+    "upgrade": true,
+    "reject": [
+    ]
+}

config/functions/index.js

@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -134,3 +135,10 @@ exports.httpErrorTest = functions.https.onRequest((request, response) => {
     response.status(400).send();
   });
 });
+
+exports.timeoutTest = functions.https.onRequest((request, response) => {
+  cors(request, response, () => {
+    // Wait for longer than 500ms.
+    setTimeout(() => response.send({ data: true }), 500);
+  });
+});