Use App Compat

Author: schmidt-sebastian

packages/firestore/exp/test/shim.ts

@@ -15,9 +15,6 @@
  * limitations under the License.
  */
 
-import { FirebaseApp as FirebaseAppLegacy } from '@firebase/app-types';
-import { FirebaseApp as FirebaseAppExp } from '@firebase/app-types-exp';
-import { deleteApp } from '@firebase/app-exp';
 import * as legacy from '@firebase/firestore-types';
 import * as exp from '../index';
 
@@ -68,19 +65,6 @@ export { GeoPoint, Timestamp } from '../index';
 // of the experimental SDK. This shim is used to run integration tests against
 // both SDK versions.
 
-export class FirebaseApp
-  extends Compat<FirebaseAppExp>
-  implements FirebaseAppLegacy {
-  name = this._delegate.name;
-  options = this._delegate.options;
-  automaticDataCollectionEnabled = this._delegate
-    .automaticDataCollectionEnabled;
-
-  delete(): Promise<void> {
-    return deleteApp(this._delegate);
-  }
-}
-
 export class Transaction
   extends Compat<exp.Transaction>
   implements legacy.Transaction {

packages/firestore/index.console.ts

@@ -15,7 +15,14 @@
  * limitations under the License.
  */
 
-export { Firestore } from './src/api/database';
+import { FirebaseFirestore as FirestoreExp } from './exp/src/api/database';
+import {
+  Firestore as FirestoreCompat,
+  MemoryPersistenceProvider
+} from './src/api/database';
+import { FirestoreDatabase } from './lite/src/api/database';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 export {
   CollectionReference,
   DocumentReference,
@@ -27,3 +34,16 @@ export { GeoPoint } from './src/api/geo_point';
 export { FieldPath } from './src/api/field_path';
 export { FieldValue } from './src/compat/field_value';
 export { Timestamp } from './src/api/timestamp';
+
+export class Firestore extends FirestoreCompat {
+  constructor(
+    databaseId: FirestoreDatabase,
+    authProvider: Provider<FirebaseAuthInternalName>
+  ) {
+    super(
+      databaseId,
+      new FirestoreExp(databaseId, authProvider),
+      new MemoryPersistenceProvider()
+    );
+  }
+}

packages/firestore/index.memory.ts

@@ -19,6 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore, MemoryPersistenceProvider } from './src/api/database';
+import { FirebaseFirestore } from './exp/src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -31,7 +32,12 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new MemoryPersistenceProvider()
+      )
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.node.memory.ts

@@ -19,6 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore, MemoryPersistenceProvider } from './src/api/database';
+import { FirebaseFirestore } from './exp/src/api/database';
 import { configureForFirebase } from './src/config';
 import './register-module';
 
@@ -31,7 +32,12 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new MemoryPersistenceProvider()
+      )
   );
   instance.registerVersion(name, version, 'node');
 }

packages/firestore/index.node.ts

@@ -19,19 +19,25 @@ import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore, IndexedDbPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
+import { FirebaseFirestore } from './exp/src/api/database';
 
 import './register-module';
 
 import { name, version } from './package.json';
-
 /**
  * Registers the main Firestore Node build with the components framework.
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(instance, (app, auth) => {
-    return new Firestore(app, auth, new IndexedDbPersistenceProvider());
-  });
+  configureForFirebase(
+    instance,
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new IndexedDbPersistenceProvider()
+      )
+  );
   instance.registerVersion(name, version, 'node');
 }
 

packages/firestore/index.rn.memory.ts

@@ -18,21 +18,26 @@
 import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
+import { FirebaseFirestore } from './exp/src/api/database';
 import { Firestore, MemoryPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
 
 import { name, version } from './package.json';
-
 /**
  * Registers the memory-only Firestore build for ReactNative with the components
  * framework.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new MemoryPersistenceProvider()
+      )
   );
   instance.registerVersion(name, version, 'rn');
 }

packages/firestore/index.rn.ts

@@ -19,6 +19,7 @@ import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore, IndexedDbPersistenceProvider } from './src/api/database';
 import { configureForFirebase } from './src/config';
+import { FirebaseFirestore } from './exp/src/api/database';
 
 import './register-module';
 import { name, version } from './package.json';
@@ -28,9 +29,15 @@ import { name, version } from './package.json';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(instance, (app, auth) => {
-    return new Firestore(app, auth, new IndexedDbPersistenceProvider());
-  });
+  configureForFirebase(
+    instance,
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new IndexedDbPersistenceProvider()
+      )
+  );
   instance.registerVersion(name, version, 'rn');
 }
 

packages/firestore/index.ts

@@ -19,6 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore, IndexedDbPersistenceProvider } from './src/api/database';
+import { FirebaseFirestore } from './exp/src/api/database';
 import { configureForFirebase } from './src/config';
 import { name, version } from './package.json';
 
@@ -29,9 +30,15 @@ import './register-module';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(instance, (app, auth) => {
-    return new Firestore(app, auth, new IndexedDbPersistenceProvider());
-  });
+  configureForFirebase(
+    instance,
+    (app, auth) =>
+      new Firestore(
+        app,
+        new FirebaseFirestore(app, auth),
+        new IndexedDbPersistenceProvider()
+      )
+  );
   instance.registerVersion(name, version);
 }
 

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

@@ -225,8 +225,8 @@ export class FirebaseFirestore implements _FirebaseService {
       throw new FirestoreError(
         Code.FAILED_PRECONDITION,
         'Firestore has already been started and its settings can no longer ' +
-          'be changed. initializeFirestore() cannot be called after calling ' +
-          'getFirestore().'
+          'be changed. You can only modify settings before calling any other ' +
+          'methods on a Firestore object.'
       );
     }
     this._settings = new FirestoreSettings(settings);

packages/firestore/src/api/database.ts

@@ -219,15 +219,20 @@ export class IndexedDbPersistenceProvider implements PersistenceProvider {
 export class Firestore
   extends Compat<exp.FirebaseFirestore>
   implements PublicFirestore, FirebaseService {
+  _appCompat?: FirebaseApp;
   // Note: We are using `MemoryComponentProvider` as a default
   // ComponentProvider to ensure backwards compatibility with the format
   // expected by the console build.
   constructor(
     databaseIdOrApp: FirestoreDatabase | FirebaseApp,
-    authProvider: Provider<FirebaseAuthInternalName>,
-    private _persistenceProvider: PersistenceProvider = new MemoryPersistenceProvider()
+    delegate: exp.FirebaseFirestore,
+    private _persistenceProvider: PersistenceProvider
   ) {
-    super(new exp.FirebaseFirestore(databaseIdOrApp, authProvider));
+    super(delegate);
+
+    if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') {
+      this._appCompat = databaseIdOrApp as FirebaseApp;
+    }
   }
 
   get _databaseId(): DatabaseId {
@@ -313,7 +318,14 @@ export class Firestore
   }
 
   get app(): FirebaseApp {
-    return this._delegate.app as FirebaseApp;
+    if (!this._appCompat) {
+      throw new FirestoreError(
+        Code.FAILED_PRECONDITION,
+        "Firestore was not initialized using the Firebase SDK. 'app' is " +
+          'not available'
+      );
+    }
+    return this._appCompat as FirebaseApp;
   }
 
   INTERNAL = {

packages/firestore/test/integration/util/firebase_export.ts

@@ -28,16 +28,18 @@
 
 import * as firestore from '@firebase/firestore-types';
 
+import firebaseAppCompat from '@firebase/app-compat';
+import '../../../exp/index';
+
 import firebase from '@firebase/app';
 import * as exp from '../../../exp/test/shim';
-import { FirebaseApp as FirebaseAppShim } from '../../../exp/test/shim';
 import { FieldValue } from '../../../src/compat/field_value';
 import { FirebaseApp } from '@firebase/app-types';
 import {
   Firestore,
   IndexedDbPersistenceProvider
 } from '../../../src/api/database';
-import { Provider, ComponentContainer } from '@firebase/component';
+import { getFirestore } from '../../../exp/src/api/database';
 
 /**
  * Detects whether we are running against the functionial (tree-shakeable)
@@ -60,26 +62,46 @@ let appCount = 0;
  */
 export function newTestFirestore(
   projectId: string,
-  nameOrApp?: string | FirebaseApp | FirebaseAppShim,
+  nameOrApp?: string | FirebaseApp,
   settings?: firestore.Settings
 ): firestore.FirebaseFirestore {
   if (nameOrApp === undefined) {
     nameOrApp = 'test-app-' + appCount++;
   }
 
-  const app =
-    typeof nameOrApp === 'string'
-      ? firebase.initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
-      : nameOrApp;
+  let firestore: firestore.FirebaseFirestore;
+  if (usesFunctionalApi()) {
+    const app =
+      typeof nameOrApp === 'string'
+        ? firebaseAppCompat.initializeApp(
+            {
+              apiKey: 'fake-api-key',
+              projectId
+            },
+            nameOrApp
+          )
+        : nameOrApp;
+
+    firestore = new Firestore(
+      app,
+      getFirestore(app),
+      new IndexedDbPersistenceProvider()
+    );
+  } else {
+    const app =
+      typeof nameOrApp === 'string'
+        ? firebase.initializeApp(
+            {
+              apiKey: 'fake-api-key',
+              projectId
+            },
+            nameOrApp
+          )
+        : nameOrApp;
 
-  const firestore = usesFunctionalApi()
-    ? new Firestore(
-        app,
-        new Provider('auth-internal', new ComponentContainer('default')),
-        new IndexedDbPersistenceProvider()
-      )
-    : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (firebase as any).firestore(app);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    firestore = (firebase as any).firestore(app);
+  }
 
   if (settings) {
     firestore.settings(settings);