Merge 2d80ff5 into 2c1764d

Author: schmidt-sebastian

packages-exp/functions-exp/test/utils.ts

@@ -68,7 +68,8 @@ export function createTestService(
     useFunctionsEmulator(
       functions,
       url.hostname,
-      Number.parseInt(url.port, 10));
+      Number.parseInt(url.port, 10)
+    );
   }
   return functions;
 }

packages/auth/src/auth.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.

packages/firebase/index.d.ts

@@ -1813,7 +1813,7 @@ declare namespace firebase.functions {
     /**
      * Changes this instance to point to a Cloud Functions emulator running
      * locally. See https://firebase.google.com/docs/functions/local-emulator
-     * 
+     *
      * @deprecated Prefer the useEmulator(host, port) method.
      * @param origin The origin of the local emulator, such as
      * "http://localhost:5005".
@@ -3132,10 +3132,10 @@ declare namespace firebase.auth {
      */
     useDeviceLanguage(): void;
     /**
-     * Modify this Auth instance to communicate with the Firebase Auth emulator.  This must be 
+     * Modify this Auth instance to communicate with the Firebase Auth emulator.  This must be
      * called synchronously immediately following the first call to `firebase.auth()`.  Do not use
      * with production credentials as emulator traffic is not encrypted.
-     * 
+     *
      * @param url The URL at which the emulator is running (eg, 'http://localhost:9099')
      */
     useEmulator(url: string): void;

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

@@ -16,7 +16,6 @@
  */
 
 import { FirebaseFirestore } from './database';
-import { PersistenceSettings } from '../../../src/core/firestore_client';
 import {
   MemoryOfflineComponentProvider,
   OfflineComponentProvider,
@@ -55,13 +54,10 @@ const onlineComponentProviders = new Map<
 
 export async function setOfflineComponentProvider(
   firestore: FirebaseFirestore,
-  persistenceSettings: PersistenceSettings,
   offlineComponentProvider: OfflineComponentProvider
 ): Promise<void> {
   logDebug(LOG_TAG, 'Initializing OfflineComponentProvider');
   const configuration = await firestore._getConfiguration();
-  configuration.persistenceSettings = persistenceSettings;
-
   await offlineComponentProvider.initialize(configuration);
   firestore._setCredentialChangeListener(user =>
     // TODO(firestorexp): This should be a retryable IndexedDB operation
@@ -118,7 +114,6 @@ async function getOfflineComponentProvider(
     logDebug(LOG_TAG, 'Using default OfflineComponentProvider');
     await setOfflineComponentProvider(
       firestore,
-      { durable: false },
       new MemoryOfflineComponentProvider()
     );
   }

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

@@ -29,6 +29,7 @@ import {
   ComponentConfiguration,
   IndexedDbOfflineComponentProvider,
   MultiTabOfflineComponentProvider,
+  OfflineComponentProvider,
   OnlineComponentProvider
 } from '../../../src/core/component_provider';
 import {
@@ -66,6 +67,11 @@ import { PersistenceSettings } from '../../../exp-types';
 
 const LOG_TAG = 'Firestore';
 
+/** DOMException error code constants. */
+const DOM_EXCEPTION_INVALID_STATE = 11;
+const DOM_EXCEPTION_ABORTED = 20;
+const DOM_EXCEPTION_QUOTA_EXCEEDED = 22;
+
 export interface Settings extends LiteSettings {
   cacheSizeBytes?: number;
 }
@@ -130,9 +136,7 @@ export class FirebaseFirestore
       clientId: this._clientId,
       credentials: this._credentials,
       initialUser: this._user,
-      maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS,
-      // Note: This will be overwritten if IndexedDB persistence is enabled.
-      persistenceSettings: { durable: false }
+      maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS
     };
   }
 
@@ -259,23 +263,15 @@ export function enableIndexedDbPersistence(
 
   const onlineComponentProvider = new OnlineComponentProvider();
   const offlineComponentProvider = new IndexedDbOfflineComponentProvider(
-    onlineComponentProvider
+    onlineComponentProvider,
+    settings.cacheSizeBytes,
+    persistenceSettings?.forceOwnership
+  );
+  return setPersistenceProviders(
+    firestore,
+    onlineComponentProvider,
+    offlineComponentProvider
   );
-
-  return firestore._queue.enqueue(async () => {
-    await setOfflineComponentProvider(
-      firestore,
-      {
-        durable: true,
-        synchronizeTabs: false,
-        cacheSizeBytes:
-          settings.cacheSizeBytes || LruParams.DEFAULT_CACHE_SIZE_BYTES,
-        forceOwningTab: !!persistenceSettings?.forceOwnership
-      },
-      offlineComponentProvider
-    );
-    await setOnlineComponentProvider(firestore, onlineComponentProvider);
-  });
 }
 
 /**
@@ -313,22 +309,87 @@ export function enableMultiTabIndexedDbPersistence(
 
   const onlineComponentProvider = new OnlineComponentProvider();
   const offlineComponentProvider = new MultiTabOfflineComponentProvider(
-    onlineComponentProvider
+    onlineComponentProvider,
+    settings.cacheSizeBytes
   );
-  return firestore._queue.enqueue(async () => {
-    await setOfflineComponentProvider(
-      firestore,
-      {
-        durable: true,
-        synchronizeTabs: true,
-        cacheSizeBytes:
-          settings.cacheSizeBytes || LruParams.DEFAULT_CACHE_SIZE_BYTES,
-        forceOwningTab: false
-      },
-      offlineComponentProvider
+  return setPersistenceProviders(
+    firestore,
+    onlineComponentProvider,
+    offlineComponentProvider
+  );
+}
+
+/**
+ * Registers both the `OfflineComponentProvider` and `OnlineComponentProvider`.
+ * If the operation fails with a recoverable error (see
+ * `canRecoverFromIndexedDbError()` below), the returned Promise is rejected
+ * but the client remains usable.
+ */
+function setPersistenceProviders(
+  firestore: FirebaseFirestore,
+  onlineComponentProvider: OnlineComponentProvider,
+  offlineComponentProvider: OfflineComponentProvider
+): Promise<void> {
+  const persistenceResult = new Deferred();
+  return firestore._queue
+    .enqueue(async () => {
+      try {
+        await setOfflineComponentProvider(firestore, offlineComponentProvider);
+        await setOnlineComponentProvider(firestore, onlineComponentProvider);
+        persistenceResult.resolve();
+      } catch (e) {
+        if (!canFallbackFromIndexedDbError(e)) {
+          throw e;
+        }
+        console.warn(
+          'Error enabling offline persistence. Falling back to ' +
+            'persistence disabled: ' +
+            e
+        );
+        persistenceResult.reject(e);
+      }
+    })
+    .then(() => persistenceResult.promise);
+}
+
+/**
+ * Decides whether the provided error allows us to gracefully disable
+ * persistence (as opposed to crashing the client).
+ */
+// TODO(schmidt-sebastian): Remove `export` in
+// https://github.com/firebase/firebase-js-sdk/pull/3901
+export function canFallbackFromIndexedDbError(
+  error: FirestoreError | DOMException
+): boolean {
+  if (error.name === 'FirebaseError') {
+    return (
+      error.code === Code.FAILED_PRECONDITION ||
+      error.code === Code.UNIMPLEMENTED
     );
-    await setOnlineComponentProvider(firestore, onlineComponentProvider);
-  });
+  } else if (
+    typeof DOMException !== 'undefined' &&
+    error instanceof DOMException
+  ) {
+    // There are a few known circumstances where we can open IndexedDb but
+    // trying to read/write will fail (e.g. quota exceeded). For
+    // well-understood cases, we attempt to detect these and then gracefully
+    // fall back to memory persistence.
+    // NOTE: Rather than continue to add to this list, we could decide to
+    // always fall back, with the risk that we might accidentally hide errors
+    // representing actual SDK bugs.
+    return (
+      // When the browser is out of quota we could get either quota exceeded
+      // or an aborted error depending on whether the error happened during
+      // schema migration.
+      error.code === DOM_EXCEPTION_QUOTA_EXCEEDED ||
+      error.code === DOM_EXCEPTION_ABORTED ||
+      // Firefox Private Browsing mode disables IndexedDb and returns
+      // INVALID_STATE for any usage.
+      error.code === DOM_EXCEPTION_INVALID_STATE
+    );
+  }
+
+  return true;
 }
 
 /**

packages/firestore/index.memory.ts

@@ -18,11 +18,7 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
-import { Firestore } from './src/api/database';
-import {
-  MemoryOfflineComponentProvider,
-  OnlineComponentProvider
-} from './src/core/component_provider';
+import { Firestore, MemoryPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -35,13 +31,7 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) =>
-      new Firestore(
-        app,
-        auth,
-        new MemoryOfflineComponentProvider(),
-        new OnlineComponentProvider()
-      )
+    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.node.memory.ts

@@ -18,11 +18,7 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
-import { Firestore } from './src/api/database';
-import {
-  MemoryOfflineComponentProvider,
-  OnlineComponentProvider
-} from './src/core/component_provider';
+import { Firestore, MemoryPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 import './register-module';
 
@@ -35,13 +31,7 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) =>
-      new Firestore(
-        app,
-        auth,
-        new MemoryOfflineComponentProvider(),
-        new OnlineComponentProvider()
-      )
+    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
   );
   instance.registerVersion(name, version, 'node');
 }

packages/firestore/index.node.ts

@@ -17,11 +17,7 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
-import { Firestore } from './src/api/database';
-import {
-  MultiTabOfflineComponentProvider,
-  OnlineComponentProvider
-} from './src/core/component_provider';
+import { Firestore, IndexedDbPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -34,16 +30,7 @@ import { name, version } from './package.json';
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(instance, (app, auth) => {
-    const onlineComponentProvider = new OnlineComponentProvider();
-    const offlineComponentProvider = new MultiTabOfflineComponentProvider(
-      onlineComponentProvider
-    );
-    return new Firestore(
-      app,
-      auth,
-      offlineComponentProvider,
-      onlineComponentProvider
-    );
+    return new Firestore(app, auth, new IndexedDbPersistenceProvider());
   });
   instance.registerVersion(name, version, 'node');
 }

packages/firestore/index.rn.memory.ts

@@ -18,11 +18,7 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
-import { Firestore } from './src/api/database';
-import {
-  MemoryOfflineComponentProvider,
-  OnlineComponentProvider
-} from './src/core/component_provider';
+import { Firestore, MemoryPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -36,13 +32,7 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) =>
-      new Firestore(
-        app,
-        auth,
-        new MemoryOfflineComponentProvider(),
-        new OnlineComponentProvider()
-      )
+    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
   );
   instance.registerVersion(name, version, 'rn');
 }

packages/firestore/index.rn.ts

@@ -17,11 +17,7 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
-import { Firestore } from './src/api/database';
-import {
-  MultiTabOfflineComponentProvider,
-  OnlineComponentProvider
-} from './src/core/component_provider';
+import { Firestore, IndexedDbPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -33,16 +29,7 @@ import { name, version } from './package.json';
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(instance, (app, auth) => {
-    const onlineComponentProvider = new OnlineComponentProvider();
-    const offlineComponentProvider = new MultiTabOfflineComponentProvider(
-      onlineComponentProvider
-    );
-    return new Firestore(
-      app,
-      auth,
-      offlineComponentProvider,
-      onlineComponentProvider
-    );
+    return new Firestore(app, auth, new IndexedDbPersistenceProvider());
   });
   instance.registerVersion(name, version, 'rn');
 }