Merge

Author: schmidt-sebastian

.github/workflows/test-all.yml

@@ -25,6 +25,8 @@ jobs:
       run: yarn build
     - name: Run unit tests
       run: xvfb-run yarn test:ci
+      env:
+        FCM_TEST_PROJECT_SERVER_KEY: $${{secrets.FCM_TEST_PROJECT_SERVER_KEY}}
     - name: Generate coverage file
       run: yarn ci:coverage
     - name: Run coverage

.github/workflows/test-changed.yml

@@ -28,3 +28,5 @@ jobs:
       run: yarn build
     - name: Run tests on changed packages
       run: xvfb-run yarn test:changed
+      env:
+        FCM_TEST_PROJECT_SERVER_KEY: $${{secrets.FCM_TEST_PROJECT_SERVER_KEY}}  

common/api-review/app-types-exp.api.md

@@ -53,6 +53,13 @@ export interface FirebaseOptions {
   storageBucket?: string;
 }
 
+// @internal (undocumented)
+export interface _FirebaseService {
+  // (undocumented)
+  app: FirebaseApp;
+   delete(): Promise<void>;
+}
+
 // @public (undocumented)
 export interface PlatformLoggerService {
   // (undocumented)

config/karma.saucelabs.js

@@ -49,6 +49,14 @@ const packageConfigs = {
   messaging: {
     // Messaging currently only supports these browsers.
     browsers: ['Chrome_Windows', 'Firefox_Windows', 'Edge_Windows']
+  },
+  firestore: {
+    browsers: [
+      'Chrome_Windows',
+      'Firefox_Windows',
+      'Edge_Windows',
+      'Safari_macOS'
+    ]
   }
 };
 
@@ -170,7 +178,8 @@ module.exports = function(config) {
       'packages/polyfill/index.ts': ['webpack', 'sourcemap'],
       '**/test/**/*.ts': ['webpack', 'sourcemap'],
       '**/*.test.ts': ['webpack', 'sourcemap'],
-      'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
+      // Restore when ready to run Firestore unit tests in IE.
+      // 'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
       'integration/**/namespace.*': ['webpack', 'babel', 'sourcemap']
     },
 

integration/browserify/package.json

@@ -8,7 +8,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

integration/firebase-typings/package.json

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "typescript": "3.8.3"

integration/messaging/package.json

@@ -8,7 +8,7 @@
     "test:manual": "mocha --exit"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "chai": "4.2.0",

integration/typescript/package.json

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

integration/webpack/package.json

@@ -8,7 +8,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

package.json

@@ -40,7 +40,6 @@
     "test:changed": "node scripts/run_changed.js",
     "test:setup": "node tools/config.js",
     "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",

packages-exp/app-types-exp/index.d.ts

@@ -104,6 +104,18 @@ export interface PlatformLoggerService {
   getPlatformInfoString(): string;
 }
 
+/**
+ * @internal
+ */
+export interface _FirebaseService {
+  app: FirebaseApp;
+  /**
+   * Delete the service and free it's resources - called from
+   * {@link @firebase/app-exp#deleteApp | deleteApp()}
+   */
+  delete(): Promise<void>;
+}
+
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'app-exp': FirebaseApp;

packages/firebase/index.d.ts

@@ -7760,7 +7760,7 @@ declare namespace firebase.firestore {
   export interface PersistenceSettings {
     /**
      * Whether to synchronize the in-memory state of multiple tabs. Setting this
-     * to 'true' in all open tabs enables shared access to local persistence,
+     * to `true` in all open tabs enables shared access to local persistence,
      * shared execution of queries and latency-compensated local document updates
      * across all connected instances.
      *
@@ -7772,14 +7772,27 @@ declare namespace firebase.firestore {
 
     /**
      * Whether to synchronize the in-memory state of multiple tabs. Setting this
-     * to 'true' in all open tabs enables shared access to local persistence,
+     * to `true` in all open tabs enables shared access to local persistence,
      * shared execution of queries and latency-compensated local document updates
      * across all connected instances.
      *
-     * @deprecated This setting is deprecated. To enabled synchronization between
+     * @deprecated This setting is deprecated. To enable synchronization between
      * multiple tabs, please use `synchronizeTabs: true` instead.
      */
     experimentalTabSynchronization?: boolean;
+
+    /**
+     * Whether to force enable persistence for the client. This cannot be used
+     * with `synchronizeTabs:true` and is primarily intended for use with Web
+     * Workers. Setting this to `true` will enable persistence, but cause other
+     * tabs using persistence to fail.
+     *
+     * This setting may be removed in a future release. If you find yourself
+     * using it for a specific use case or run into any issues, please tell us
+     * about it in
+     * https://github.com/firebase/firebase-js-sdk/issues/983.
+     */
+    experimentalForceOwningTab?: boolean;
   }
 
   export type LogLevel = 'debug' | 'error' | 'silent';

packages/firebase/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase",
-  "version": "7.14.5",
+  "version": "7.14.6",
   "description": "Firebase JavaScript library for web and Node.js",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -49,13 +49,13 @@
     "@firebase/app-types": "0.6.1",
     "@firebase/auth": "0.14.6",
     "@firebase/database": "0.6.3",
-    "@firebase/firestore": "1.14.5",
+    "@firebase/firestore": "1.14.6",
     "@firebase/functions": "0.4.44",
     "@firebase/installations": "0.4.10",
     "@firebase/messaging": "0.6.16",
     "@firebase/polyfill": "0.3.36",
     "@firebase/storage": "0.3.34",
-    "@firebase/performance": "0.3.4",
+    "@firebase/performance": "0.3.5",
     "@firebase/remote-config": "0.1.21",
     "@firebase/analytics": "0.3.5",
     "@firebase/util": "0.2.47"

packages/firestore-types/index.d.ts

@@ -35,9 +35,16 @@ export interface Settings {
 export interface PersistenceSettings {
   synchronizeTabs?: boolean;
   experimentalTabSynchronization?: boolean;
+  experimentalForceOwningTab?: boolean;
 }
 
-export type LogLevel = 'debug' | 'error' | 'silent';
+export type LogLevel =
+  | 'debug'
+  | 'error'
+  | 'silent'
+  | 'warn'
+  | 'info'
+  | 'verbose';
 
 export function setLogLevel(logLevel: LogLevel): void;
 

packages/firestore-types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore-types",
-  "version": "1.10.2",
+  "version": "1.10.3",
   "description": "@firebase/firestore Types",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "license": "Apache-2.0",

packages/firestore/CHANGELOG.md

@@ -1,11 +1,21 @@
 # Unreleased
+- [changed] All known failure cases for Indexed-related crashes have now been
+  addressed. Instead of crashing the client, IndexedDB failures will result
+  in rejected operations (e.g. rejected Writes or errored Query listeners). 
+  If these rejections surface in your app, you can retry these operations 
+  when IndexedDB access is restored. 
+  IndexedDB failures that occur due to background work are automatically 
+  retried. 
+  
+  If you continue to see Indexed-related crashes, we appreciate feedback 
+  (https://github.com/firebase/firebase-js-sdk/issues/2755).
+
+# Released
 - [fixed] Fixed an issue that could cause Firestore to temporarily go 
   offline when a Window visibility event occurred.
 - [feature] Added support for calling  `FirebaseFiresore.settings` with 
   `{ ignoreUndefinedProperties: true }`. When set, Firestore ignores 
   undefined properties inside objects rather than rejecting the API call.
-
-# Released
 - [fixed] Fixed a regression introduced in v7.14.2 that incorrectly applied
   a `FieldValue.increment` in combination with `set({...}, {merge: true})`.
 - [fixed] Firestore now rejects `onSnapshot()` listeners if they cannot be
@@ -14,6 +24,9 @@
   in IndexedDB. Previously, these errors crashed the client.
 - [fixed] Fixed a source of IndexedDB-related crashes for tabs that receive 
   multi-tab notifications while the file system is locked.
+- [feature] Added an `experimentalForceOwningTab` setting that can be used to
+  enable persistence in environments without LocalStorage, which allows
+  persistence to be used in Web Workers (#983).
 
 # 1.10.2
 - [fixed] Temporarily reverted the use of window.crypto to generate document

packages/firestore/exp/index.d.ts

@@ -169,10 +169,11 @@ export class Transaction {
 
   get<T>(documentRef: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
 
+  set<T>(documentRef: DocumentReference<T>, data: T): Transaction;
   set<T>(
     documentRef: DocumentReference<T>,
-    data: T,
-    options?: SetOptions
+    data: Partial<T>,
+    options: SetOptions
   ): Transaction;
 
   update(documentRef: DocumentReference<any>, data: UpdateData): Transaction;
@@ -189,10 +190,11 @@ export class Transaction {
 export class WriteBatch {
   private constructor();
 
+  set<T>(documentRef: DocumentReference<T>, data: T): WriteBatch;
   set<T>(
     documentRef: DocumentReference<T>,
-    data: T,
-    options?: SetOptions
+    data: Partial<T>,
+    options: SetOptions
   ): WriteBatch;
 
   update(documentRef: DocumentReference<any>, data: UpdateData): WriteBatch;
@@ -327,7 +329,7 @@ export function getQueryFromServer<T>(
 export function addDoc<T>(
   reference: CollectionReference<T>,
   data: T
-): Promise<DocumentSnapshot<T>>;
+): Promise<DocumentReference<T>>;
 export function setDoc<T>(
   reference: DocumentReference<T>,
   data: T
@@ -338,15 +340,16 @@ export function setDoc<T>(
   options: SetOptions
 ): Promise<void>;
 export function updateDoc(
-  reference: DocumentReference,
+  reference: DocumentReference<unknown>,
   data: UpdateData
 ): Promise<void>;
 export function updateDoc(
+  reference: DocumentReference<unknown>,
   field: string | FieldPath,
   value: any,
   ...moreFieldsAndValues: any[]
 ): Promise<void>;
-export function deleteDoc(reference: DocumentReference): Promise<void>;
+export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;
 
 export function onSnapshot<T>(
   reference: DocumentReference<T>,

packages/firestore/karma.conf.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-const karma = require('karma');
-const path = require('path');
 const karmaBase = require('../../config/karma.base');
 const { argv } = require('yargs');
 

packages/firestore/lite/index.node.ts

@@ -20,6 +20,8 @@ import { Firestore } from './src/api/database';
 import { version } from '../package.json';
 import { Component, ComponentType } from '@firebase/component';
 
+import '../src/platform_node/node_init';
+
 export {
   Firestore,
   initializeFirestore,
@@ -28,6 +30,16 @@ export {
 
 export { DocumentReference } from './src/api/reference';
 
+// TOOD(firestorelite): Add tests when setDoc() is available
+export {
+  FieldValue,
+  deleteField,
+  increment,
+  arrayRemove,
+  arrayUnion,
+  serverTimestamp
+} from './src/api/field_value';
+
 export function registerFirestore(): void {
   _registerComponent(
     new Component(