Add ComponentProvider (#2828)

Author: schmidt-sebastian

packages/firestore/index.memory.ts

@@ -19,7 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MemoryPersistenceProvider } from './src/local/memory_persistence';
+import { MemoryComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
@@ -33,7 +33,7 @@ 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, auth, new MemoryComponentProvider())
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.node.memory.ts

@@ -19,7 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MemoryPersistenceProvider } from './src/local/memory_persistence';
+import { MemoryComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 import './register-module';
 import './src/platform_node/node_init';
@@ -33,7 +33,7 @@ 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, auth, new MemoryComponentProvider())
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.node.ts

@@ -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.
@@ -18,7 +18,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { IndexedDbPersistenceProvider } from './src/local/indexeddb_persistence';
+import { IndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 
 import './register-module';
@@ -33,7 +33,7 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new IndexedDbPersistenceProvider())
+    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
   );
   instance.registerVersion(name, version, 'node');
 }

packages/firestore/index.ts

@@ -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.
@@ -19,7 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { IndexedDbPersistenceProvider } from './src/local/indexeddb_persistence';
+import { IndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/platform/config';
 import { name, version } from './package.json';
 
@@ -33,7 +33,7 @@ import './src/platform_browser/browser_init';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new IndexedDbPersistenceProvider())
+    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
   );
   instance.registerVersion(name, version);
 }

packages/firestore/src/api/database.ts

@@ -23,6 +23,10 @@ import { FirebaseApp } from '@firebase/app-types';
 import { _FirebaseApp, FirebaseService } from '@firebase/app-types/private';
 import { DatabaseId, DatabaseInfo } from '../core/database_info';
 import { ListenOptions } from '../core/event_manager';
+import {
+  ComponentProvider,
+  MemoryComponentProvider
+} from '../core/component_provider';
 import { FirestoreClient, PersistenceSettings } from '../core/firestore_client';
 import {
   Bound,
@@ -36,8 +40,6 @@ import {
 import { Transaction as InternalTransaction } from '../core/transaction';
 import { ChangeType, ViewSnapshot } from '../core/view_snapshot';
 import { LruParams } from '../local/lru_garbage_collector';
-import { MemoryPersistenceProvider } from '../local/memory_persistence';
-import { PersistenceProvider } from '../local/persistence';
 import { Document, MaybeDocument, NoDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { DeleteMutation, Mutation, Precondition } from '../model/mutation';
@@ -262,7 +264,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   // underscore to discourage their use.
   readonly _databaseId: DatabaseId;
   private readonly _persistenceKey: string;
-  private readonly _persistenceProvider: PersistenceProvider;
+  private readonly _componentProvider: ComponentProvider;
   private _credentials: CredentialsProvider;
   private readonly _firebaseApp: FirebaseApp | null = null;
   private _settings: FirestoreSettings;
@@ -281,13 +283,13 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
 
   readonly _dataReader: UserDataReader;
 
-  // Note: We are using `MemoryPersistenceProvider` as a default
-  // PersistenceProvider to ensure backwards compatibility with the format
+  // 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>,
-    persistenceProvider: PersistenceProvider = new MemoryPersistenceProvider()
+    persistenceProvider: ComponentProvider = new MemoryComponentProvider()
   ) {
     if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') {
       // This is very likely a Firebase app object
@@ -312,7 +314,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
       this._credentials = new EmptyCredentialsProvider();
     }
 
-    this._persistenceProvider = persistenceProvider;
+    this._componentProvider = persistenceProvider;
     this._settings = new FirestoreSettings({});
     this._dataReader = this.createDataReader(this._databaseId);
   }
@@ -371,7 +373,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
         DEFAULT_SYNCHRONIZE_TABS;
     }
 
-    return this.configureClient(this._persistenceProvider, {
+    return this.configureClient(this._componentProvider, {
       durable: true,
       cacheSizeBytes: this._settings.cacheSizeBytes,
       synchronizeTabs
@@ -393,7 +395,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     this._queue.enqueueAndForgetEvenAfterShutdown(async () => {
       try {
         const databaseInfo = this.makeDatabaseInfo();
-        await this._persistenceProvider.clearPersistence(databaseInfo);
+        await this._componentProvider.clearPersistence(databaseInfo);
         deferred.resolve();
       } catch (e) {
         deferred.reject(e);
@@ -458,7 +460,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     if (!this._firestoreClient) {
       // Kick off starting the client but don't actually wait for it.
       // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      this.configureClient(new MemoryPersistenceProvider(), {
+      this.configureClient(new MemoryComponentProvider(), {
         durable: false
       });
     }
@@ -476,7 +478,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   }
 
   private configureClient(
-    persistenceProvider: PersistenceProvider,
+    componentProvider: ComponentProvider,
     persistenceSettings: PersistenceSettings
   ): Promise<void> {
     assert(!!this._settings.host, 'FirestoreSettings.host is not set');
@@ -492,10 +494,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
       this._queue
     );
 
-    return this._firestoreClient.start(
-      persistenceProvider,
-      persistenceSettings
-    );
+    return this._firestoreClient.start(componentProvider, persistenceSettings);
   }
 
   private createDataReader(databaseId: DatabaseId): UserDataReader {