Make MemoryLru tree-shakeable (#2767)

Author: schmidt-sebastian

packages/firestore/src/local/memory_persistence.ts

@@ -87,34 +87,17 @@ export class MemoryPersistence implements Persistence {
 
   private _started = false;
 
-  readonly referenceDelegate: MemoryLruDelegate | MemoryEagerDelegate;
-
-  static createLruPersistence(
-    clientId: ClientId,
-    params: LruParams
-  ): MemoryPersistence {
-    const factory = (p: MemoryPersistence): MemoryLruDelegate =>
-      new MemoryLruDelegate(p, params);
-    return new MemoryPersistence(clientId, factory);
-  }
-
-  static createEagerPersistence(clientId: ClientId): MemoryPersistence {
-    const factory = (p: MemoryPersistence): MemoryEagerDelegate =>
-      new MemoryEagerDelegate(p);
-    return new MemoryPersistence(clientId, factory);
-  }
-
+  readonly referenceDelegate: MemoryReferenceDelegate;
+  
   /**
    * The constructor accepts a factory for creating a reference delegate. This
    * allows both the delegate and this instance to have strong references to
    * each other without having nullable fields that would then need to be
    * checked or asserted on every access.
    */
-  private constructor(
+  constructor(
     private readonly clientId: ClientId,
-    referenceDelegateFactory: (
-      p: MemoryPersistence
-    ) => MemoryLruDelegate | MemoryEagerDelegate
+    referenceDelegateFactory: (p: MemoryPersistence) => MemoryReferenceDelegate
   ) {
     this._started = true;
     this.referenceDelegate = referenceDelegateFactory(this);
@@ -226,7 +209,13 @@ export class MemoryTransaction extends PersistenceTransaction {
   }
 }
 
-export class MemoryEagerDelegate implements ReferenceDelegate {
+export interface MemoryReferenceDelegate extends ReferenceDelegate {
+  documentSize(doc: MaybeDocument): number;
+  onTransactionStarted(): void;
+  onTransactionCommitted(txn: PersistenceTransaction): PersistencePromise<void>;
+}
+
+export class MemoryEagerDelegate implements MemoryReferenceDelegate {
   private inMemoryPins: ReferenceSet | null = null;
   private _orphanedDocuments: Set<DocumentKey> | null = null;
 
@@ -545,7 +534,10 @@ export class MemoryPersistenceProvider implements PersistenceProvider {
 
   getPersistence(): Persistence {
     assert(!!this.clientId, 'initialize() not called');
-    return MemoryPersistence.createEagerPersistence(this.clientId);
+    return new MemoryPersistence(
+      this.clientId,
+      p => new MemoryEagerDelegate(p)
+    );
   }
 
   getSharedClientState(): SharedClientState {

packages/firestore/test/unit/generate_spec_json.js

@@ -65,7 +65,7 @@ function main(args) {
     var testName = specName.replace(/^specs\//, '');
     var filename = testName.replace(/[^A-Za-z\d]/g, '_') + '.json';
     var outputFile = outputPath + '/' + filename;
-    console.log("Generating " + outputFile);
+    console.log('Generating ' + outputFile);
     writeToJSON(testFiles[i], outputFile);
   }
 

packages/firestore/test/unit/local/persistence_test_helpers.ts

@@ -29,7 +29,11 @@ import {
 import { IndexedDbPersistence } from '../../../src/local/indexeddb_persistence';
 import { LocalSerializer } from '../../../src/local/local_serializer';
 import { LruParams } from '../../../src/local/lru_garbage_collector';
-import { MemoryPersistence } from '../../../src/local/memory_persistence';
+import {
+  MemoryEagerDelegate,
+  MemoryLruDelegate,
+  MemoryPersistence
+} from '../../../src/local/memory_persistence';
 import {
   ClientId,
   WebStorageSharedClientState
@@ -122,13 +126,16 @@ export async function testIndexedDbPersistence(
 
 /** Creates and starts a MemoryPersistence instance for testing. */
 export async function testMemoryEagerPersistence(): Promise<MemoryPersistence> {
-  return MemoryPersistence.createEagerPersistence(AutoId.newId());
+  return new MemoryPersistence(AutoId.newId(), p => new MemoryEagerDelegate(p));
 }
 
 export async function testMemoryLruPersistence(
   params: LruParams = LruParams.DEFAULT
 ): Promise<MemoryPersistence> {
-  return MemoryPersistence.createLruPersistence(AutoId.newId(), params);
+  return new MemoryPersistence(
+    AutoId.newId(),
+    p => new MemoryLruDelegate(p, params)
+  );
 }
 
 /** Clears the persistence in tests */

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -47,7 +47,11 @@ import {
 } from '../../../src/local/indexeddb_schema';
 import { LocalStore } from '../../../src/local/local_store';
 import { LruParams } from '../../../src/local/lru_garbage_collector';
-import { MemoryPersistence } from '../../../src/local/memory_persistence';
+import {
+  MemoryEagerDelegate,
+  MemoryLruDelegate,
+  MemoryPersistence
+} from '../../../src/local/memory_persistence';
 import { Persistence } from '../../../src/local/persistence';
 import {
   ClientId,
@@ -1151,7 +1155,9 @@ abstract class TestRunner {
       expect(actualTarget.query).to.deep.equal(expectedTarget.query);
       expect(actualTarget.targetId).to.equal(expectedTarget.targetId);
       expect(actualTarget.readTime).to.equal(expectedTarget.readTime);
-      expect(actualTarget.resumeToken || '').to.equal(expectedTarget.resumeToken || '');
+      expect(actualTarget.resumeToken || '').to.equal(
+        expectedTarget.resumeToken || ''
+      );
       delete actualTargets[targetId];
     });
     expect(obj.size(actualTargets)).to.equal(
@@ -1236,12 +1242,11 @@ class MemoryTestRunner extends TestRunner {
     gcEnabled: boolean
   ): Promise<Persistence> {
     return Promise.resolve(
-      gcEnabled
-        ? MemoryPersistence.createEagerPersistence(this.clientId)
-        : MemoryPersistence.createLruPersistence(
-            this.clientId,
-            LruParams.DEFAULT
-          )
+      new MemoryPersistence(this.clientId, p =>
+        gcEnabled
+          ? new MemoryEagerDelegate(p)
+          : new MemoryLruDelegate(p, LruParams.DEFAULT)
+      )
     );
   }
 }

packages/firestore/test/util/test_platform.ts

@@ -265,7 +265,7 @@ export class TestPlatform implements Platform {
 }
 
 /** Returns true if we are running under Node. */
-export function isNode() : boolean {
+export function isNode(): boolean {
   return (
     typeof process !== 'undefined' &&
     process.title !== undefined &&