Merge branch 'master' into varconst/geo-point-to-json

Author: var-const

.changeset/cold-bats-hammer.md

@@ -0,0 +1,9 @@
+---
+'@firebase/rules-unit-testing': major
+---
+
+Release `@firebase/rules-unit-testing` to replace the `@firebase/testing` package. The new
+package is API compatible but has the following breaking behavior changes:
+
+  * `assertFails()` will now only fail on `PERMISSION DENIED` errors, not any error.
+  * `initializeAdminApp()` now relies on `firebase-admin` rather than imitating the Admin SDK.

.changeset/config.json

@@ -17,6 +17,7 @@
     "@firebase/app-types-exp",
     "@firebase/functions-exp",
     "@firebase/functions-types-exp",
+    "@firebase/testing",
     "firebase-exp",
     "@firebase/changelog-generator",
     "firebase-size-analysis"
@@ -25,4 +26,4 @@
     "onlyUpdatePeerDependentsWhenOutOfRange": true,
     "useCalculatedVersionForSnapshots": true
   }
-}
+}

.changeset/neat-gorillas-behave.md

@@ -0,0 +1,5 @@
+---
+"@firebase/firestore": patch
+---
+
+`terminate()` can now be retried if it fails with an IndexedDB exception.

.github/CODEOWNERS

@@ -60,13 +60,14 @@ packages/auth-types  @bojeil-google @avolkovi @samhorlbeck @scottcrossen @fireba
 
 # Testing Code
 packages/testing  @avolkovi @samhorlbeck @scottcrossen @yuchenshi @firebase/jssdk-global-approvers
+packages/rules-unit-testing  @avolkovi @samhorlbeck @scottcrossen @yuchenshi @firebase/jssdk-global-approvers
 
 # RxFire Code
 packages/rxfire @davideast @jamesdaniels @firebase/jssdk-global-approvers
 
 # Installations
-packages/installations @andirayo @firebase/jssdk-global-approvers
-packages/installations-types @andirayo @firebase/jssdk-global-approvers
+packages/installations @andirayo @ChaoqunCHEN @firebase/jssdk-global-approvers
+packages/installations-types @andirayo @ChaoqunCHEN @firebase/jssdk-global-approvers
 
 # Performance Code
 packages/performance  @alikn @zijianjoy @firebase/jssdk-global-approvers

.github/workflows/check-changeset.yml

@@ -0,0 +1,63 @@
+name: Check Changeset
+
+on: pull_request
+
+jobs:
+  check_changeset:
+    name: Check changeset vs changed files
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@master
+      with:
+        # This makes Actions fetch all Git history so check_changeset script can diff properly.
+    - name: Set up Node (10)
+      uses: actions/setup-node@v1
+      with:
+        node-version: 10.x
+    - name: Yarn install
+      run: yarn
+    - name: Run changeset script
+      run: yarn ts-node-script scripts/check_changeset.ts
+      id: check-changeset
+    - name: Read output
+      run: echo "${{steps.check-changeset.outputs.MISSING_PACKAGES}}"
+    - name: Find Comment
+      uses: peter-evans/find-comment@v1
+      id: fc
+      with:
+        issue-number: ${{github.event.number}}
+        body-includes: Changeset File Check
+    - name: Create comment (missing packages)
+      if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.MISSING_PACKAGES}}
+      uses: peter-evans/create-or-update-comment@v1
+      with:
+        issue-number: ${{github.event.number}}
+        body: |
+          ### Changeset File Check :warning:
+          Warning: This PR modifies files in the following packages but they have not been included in the changeset file:
+          ${{steps.check-changeset.outputs.MISSING_PACKAGES}}
+          
+          Make sure this was intentional.
+    - name: Update comment (missing packages)
+      if: ${{steps.fc.outputs.comment-id}}
+      uses: peter-evans/create-or-update-comment@v1
+      with:
+        comment-id: ${{steps.fc.outputs.comment-id}} && steps.check-changeset.outputs.MISSING_PACKAGES}}
+        edit-mode: replace
+        body: |
+          ### Changeset File Check :warning:
+          Warning: This PR modifies files in the following packages but they have not been included in the changeset file:
+          ${{steps.check-changeset.outputs.MISSING_PACKAGES}}
+
+          Make sure this was intentional.
+    - name: Update comment (no missing packages)
+      if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.MISSING_PACKAGES}}
+      uses: peter-evans/create-or-update-comment@v1
+      with:
+        comment-id: ${{steps.fc.outputs.comment-id}}
+        edit-mode: replace
+        body: |
+          ### Changeset File Check :white_check_mark:
+          No modified packages are missing from the changeset file.

package.json

@@ -67,19 +67,21 @@
     "@changesets/cli": "2.9.2",
     "@microsoft/api-documenter": "7.8.21",
     "@microsoft/api-extractor": "7.9.2",
+    "@types/mz": "2.7.1",
     "@types/chai": "4.2.12",
     "@types/chai-as-promised": "7.1.3",
     "@types/child-process-promise": "2.2.1",
     "@types/clone": "0.1.30",
     "@types/inquirer": "7.3.0",
+    "@types/listr": "0.14.2",
     "@types/long": "4.0.1",
     "@types/mocha": "7.0.2",
+    "@types/mz": "2.7.1",
     "@types/node": "12.12.53",
     "@types/sinon": "9.0.4",
     "@types/sinon-chai": "3.2.4",
     "@types/tmp": "0.2.0",
     "@types/yargs": "15.0.5",
-    "@types/listr": "0.14.2",
     "@typescript-eslint/eslint-plugin": "2.34.0",
     "@typescript-eslint/eslint-plugin-tslint": "2.34.0",
     "@typescript-eslint/parser": "2.34.0",
@@ -112,11 +114,11 @@
     "karma-coverage-istanbul-reporter": "2.1.1",
     "karma-firefox-launcher": "1.3.0",
     "karma-mocha": "2.0.1",
+    "karma-mocha-reporter": "2.2.5",
     "karma-safari-launcher": "1.0.0",
     "karma-sauce-launcher": "1.2.0",
     "karma-sourcemap-loader": "0.3.7",
     "karma-spec-reporter": "0.0.32",
-    "karma-mocha-reporter": "2.2.5",
     "karma-summary-reporter": "1.8.0",
     "karma-webpack": "4.0.2",
     "lcov-result-merger": "3.1.0",

packages/component/README.md

@@ -3,14 +3,6 @@
 _NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a
 member of the Firebase team, please avoid using this package_
 
-## Installation
-
-You can install this wrapper by running the following in your project:
-
-```bash
-$ npm install @firebase/component
-```
-
 ## Usage
 
 **ES Modules**

packages/firebase/README.md

@@ -14,7 +14,7 @@ For more information, visit:
   The Firebase Realtime Database lets you store and query user data, and makes
   it available between users in realtime.
 - [Cloud Firestore](https://firebase.google.com/docs/firestore/quickstart) -
-  Cloud Firestore is a flexible, scalable database for mobile, web, and server 
+  Cloud Firestore is a flexible, scalable database for mobile, web, and server
   development from Firebase and Google Cloud Platform.
 - [Firebase Storage](https://firebase.google.com/docs/storage/web/start) -
   Firebase Storage lets you upload and store user generated content, such as
@@ -37,6 +37,10 @@ you should use the
 ## Get the code (browser)
 
 ### Script include
+>This brings in all Firebase features. See
+>["Include only the features you need"](#include-only-the-features-you-need)
+>below for
+>how to minimize download size by only including the scripts you need.
 
 Include Firebase in your web application via a `<script>` tag:
 
@@ -56,12 +60,17 @@ Include Firebase in your web application via a `<script>` tag:
 </script>
 ```
 
-*Note: To get a filled in version of the above code snippet, go to the
+_Note: To get a filled in version of the above code snippet, go to the
 [Firebase console](https://console.firebase.google.com/) for your app and click on "Add
-Firebase to your web app".*
+Firebase to your web app"._
 
 ### npm bundler (Browserify, Webpack, etc.)
 
+>This brings in all Firebase features. See
+>["Include only the features you need"](#include-only-the-features-you-need)
+>below for
+>how to minimize bundle size by only importing the features you need.
+
 The Firebase JavaScript npm package contains code that can be run in the browser
 after combining the modules you use with a package bundler (e.g.,
 [Browserify](http://browserify.org/), [Webpack](https://webpack.github.io/)).
@@ -173,11 +182,12 @@ var app = firebase.initializeApp({ ... });
 // ...
 ```
 
-If you are using native ES6 module with --experimental-modules flag, you should do:
+If you are using native ES6 module with --experimental-modules flag (or Node 12+)
+you should do:
 
 ```js
 // This import loads the firebase namespace.
-import firebase from 'firebase/app';
+import * as firebase from 'firebase/app';
 
 // These imports load individual services into the firebase namespace.
 import 'firebase/auth';
@@ -186,7 +196,6 @@ import 'firebase/database';
 
 _Known issue for typescript users with --experimental-modules: you have to set allowSyntheticDefaultImports to true in tsconfig.json to pass the type check. Use it with caution since it makes the assumption that all modules have a default export, which might not be the case for the other dependencies you have. And Your code will break if you try to import the default export from a module that doesn't have default export._
 
-
 Firebase Storage is not included in the server side Firebase npm module.
 Instead, you can use the
 [`google-cloud` Node.js client](https://github.com/GoogleCloudPlatform/google-cloud-node).
@@ -231,4 +240,5 @@ The Firebase changelog can be found at
 [firebase.google.com](https://firebase.google.com/support/release-notes/js).
 
 ## Browser/environment compatibility
+
 Please see [Environment Support](https://firebase.google.com/support/guides/environments_js-sdk).

packages/firestore/README.md

@@ -10,29 +10,6 @@ If you are developing a Node.js application that requires administrative access
 use the [`@google-cloud/firestore`](https://www.npmjs.com/package/@google-cloud/firestore) Server
 SDK with your developer credentials.
 
-## Usage
-
-You can then use the firebase namespace exposed by this package as illustrated
-below:
-
-**ES Modules**
-
-```javascript
-import firebase from '@firebase/app';
-import '@firebase/firestore'
-
-// Do stuff w/ `firebase` and `firebase.firestore`
-```
-
-**CommonJS Modules**
-
-```javascript
-const firebase = require('@firebase/app').default;
-require('@firebase/firestore');
-
-// Do stuff with `firebase` and `firebase.firestore`
-```
-
 ## Documentation
 
 For comprehensive documentation please see the [Firebase Reference

packages/firestore/exp/src/api/database.ts

@@ -27,7 +27,10 @@ import {
   enqueueWaitForPendingWrites,
   MAX_CONCURRENT_LIMBO_RESOLUTIONS
 } from '../../../src/core/firestore_client';
-import { AsyncQueue } from '../../../src/util/async_queue';
+import {
+  AsyncQueue,
+  wrapInUserErrorIfRecoverable
+} from '../../../src/util/async_queue';
 import {
   ComponentConfiguration,
   IndexedDbOfflineComponentProvider,
@@ -59,7 +62,6 @@ import { AutoId } from '../../../src/util/misc';
 import { User } from '../../../src/auth/user';
 import { CredentialChangeListener } from '../../../src/api/credentials';
 import { logDebug } from '../../../src/util/log';
-import { debugAssert } from '../../../src/util/assert';
 
 const LOG_TAG = 'Firestore';
 
@@ -131,16 +133,28 @@ export class Firestore extends LiteFirestore
   }
 
   _terminate(): Promise<void> {
-    debugAssert(!this._terminated, 'Cannot invoke _terminate() more than once');
-    return this._queue.enqueueAndInitiateShutdown(async () => {
-      await super._terminate();
-      await removeComponents(this);
-
-      // `removeChangeListener` must be called after shutting down the
-      // RemoteStore as it will prevent the RemoteStore from retrieving
-      // auth tokens.
-      this._credentials.removeChangeListener();
+    this._queue.enterRestrictedMode();
+    const deferred = new Deferred();
+    this._queue.enqueueAndForgetEvenWhileRestricted(async () => {
+      try {
+        await super._terminate();
+        await removeComponents(this);
+
+        // `removeChangeListener` must be called after shutting down the
+        // RemoteStore as it will prevent the RemoteStore from retrieving
+        // auth tokens.
+        this._credentials.removeChangeListener();
+
+        deferred.resolve();
+      } catch (e) {
+        const firestoreError = wrapInUserErrorIfRecoverable(
+          e,
+          `Failed to shutdown persistence`
+        );
+        deferred.reject(firestoreError);
+      }
     });
+    return deferred.promise;
   }
 }
 
@@ -242,7 +256,7 @@ export function clearIndexedDbPersistence(
   }
 
   const deferred = new Deferred<void>();
-  firestoreImpl._queue.enqueueAndForgetEvenAfterShutdown(async () => {
+  firestoreImpl._queue.enqueueAndForgetEvenWhileRestricted(async () => {
     try {
       await indexedDbClearPersistence(
         indexedDbStoragePrefix(

packages/firestore/scripts/run-tests.js

@@ -14,4 +14,4 @@
  * 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.
- */exports.__esModule=true;var yargs=require("yargs");var path_1=require("path");var child_process_promise_1=require("child-process-promise");var argv=yargs.options({main:{type:"string",demandOption:true},platform:{type:"string",default:"node"},emulator:{type:"boolean"},persistence:{type:"boolean"}}).argv;var nyc=path_1.resolve(__dirname,"../../../node_modules/.bin/nyc");var mocha=path_1.resolve(__dirname,"../../../node_modules/.bin/mocha");process.env.TS_NODE_CACHE="NO";process.env.TS_NODE_COMPILER_OPTIONS='{"module":"commonjs"}';process.env.TEST_PLATFORM=argv.platform;var args=[mocha,"--require","ts-node/register","--require",argv.main,"--config","../../config/mocharc.node.js"];if(argv.emulator){process.env.FIRESTORE_EMULATOR_PORT="8080";process.env.FIRESTORE_EMULATOR_PROJECT_ID="test-emulator"}if(argv.persistence){process.env.USE_MOCK_PERSISTENCE="YES";args.push("--require","test/util/node_persistence.ts")}args=args.concat(argv._);var childProcess=child_process_promise_1.spawn(nyc,args,{stdio:"inherit",cwd:process.cwd()}).childProcess;process.once("exit",(function(){return childProcess.kill()}));process.once("SIGINT",(function(){return childProcess.kill("SIGINT")}));process.once("SIGTERM",(function(){return childProcess.kill("SIGTERM")}));
+ */exports.__esModule=true;var yargs=require("yargs");var path_1=require("path");var child_process_promise_1=require("child-process-promise");var argv=yargs.options({main:{type:"string",demandOption:true},platform:{type:"string",default:"node"},emulator:{type:"boolean"},persistence:{type:"boolean"}}).argv;var nyc=path_1.resolve(__dirname,"../../../node_modules/.bin/nyc");var mocha=path_1.resolve(__dirname,"../../../node_modules/.bin/mocha");process.env.TS_NODE_CACHE="NO";process.env.TS_NODE_COMPILER_OPTIONS='{"module":"commonjs"}';process.env.TEST_PLATFORM=argv.platform;var args=["--reporter","lcovonly",mocha,"--require","ts-node/register","--require",argv.main,"--config","../../config/mocharc.node.js"];if(argv.emulator){process.env.FIRESTORE_EMULATOR_PORT="8080";process.env.FIRESTORE_EMULATOR_PROJECT_ID="test-emulator"}if(argv.persistence){process.env.USE_MOCK_PERSISTENCE="YES";args.push("--require","test/util/node_persistence.ts")}args=args.concat(argv._);var childProcess=child_process_promise_1.spawn(nyc,args,{stdio:"inherit",cwd:process.cwd()}).childProcess;process.once("exit",(function(){return childProcess.kill()}));process.once("SIGINT",(function(){return childProcess.kill("SIGINT")}));process.once("SIGTERM",(function(){return childProcess.kill("SIGTERM")}));

packages/firestore/scripts/run-tests.ts

@@ -44,6 +44,8 @@ process.env.TS_NODE_COMPILER_OPTIONS = '{"module":"commonjs"}';
 process.env.TEST_PLATFORM = argv.platform;
 
 let args = [
+  '--reporter',
+  'lcovonly',
   mocha,
   '--require',
   'ts-node/register',

packages/firestore/src/api/credentials.ts

@@ -127,10 +127,6 @@ export class EmptyCredentialsProvider implements CredentialsProvider {
   }
 
   removeChangeListener(): void {
-    debugAssert(
-      this.changeListener !== null,
-      'removeChangeListener() when no listener registered'
-    );
     this.changeListener = null;
   }
 }
@@ -252,15 +248,6 @@ export class FirebaseCredentialsProvider implements CredentialsProvider {
   }
 
   removeChangeListener(): void {
-    debugAssert(
-      this.tokenListener != null,
-      'removeChangeListener() called twice'
-    );
-    debugAssert(
-      this.changeListener !== null,
-      'removeChangeListener() called when no listener registered'
-    );
-
     if (this.auth) {
       this.auth.removeAuthTokenListener(this.tokenListener!);
     }

packages/firestore/src/api/database.ts

@@ -448,7 +448,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     }
 
     const deferred = new Deferred<void>();
-    this._queue.enqueueAndForgetEvenAfterShutdown(async () => {
+    this._queue.enqueueAndForgetEvenWhileRestricted(async () => {
       try {
         await this._offlineComponentProvider.clearPersistence(
           this._databaseId,