Fix error and polishing.

Author: wu-hui

packages/firestore/src/api/database.ts

@@ -287,7 +287,7 @@ export function configureFirestore(firestore: Firestore): void {
 }
 
 /**
- * Attempts to enable the LRU garbage collector for memory persistence.
+ * Attempts to enable LRU garbage collection for memory persistence.
  *
  * Must be called before any other functions (other than
  * {@link initializeFirestore}, {@link (getFirestore:1)} or
@@ -300,8 +300,8 @@ export function configureFirestore(firestore: Firestore): void {
  * garbage collector. Documents will be collected when their total size exceeds
  * `Settings.cacheSizeBytes`, with least recently used documents get removed first.
  *
- * @param firestore - The {@link Firestore} instance to enable persistence for.
- * @returns A `Promise` that represents successfully enabling persistent storage.
+ * @param firestore - The {@link Firestore} instance to enable LRU garbage collection for.
+ * @returns A `Promise` that represents successfully enabling LRU garbage collection.
  */
 export function enableMemoryLRUGarbageCollection(
   firestore: Firestore

packages/firestore/test/integration/api/database.test.ts

@@ -20,7 +20,6 @@ import { Deferred } from '@firebase/util';
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 
-import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector_impl';
 import { EventsAccumulator } from '../util/events_accumulator';
 import {
   addDoc,
@@ -68,7 +67,7 @@ import {
 } from '../util/firebase_export';
 import {
   apiDescribe,
-  withEnsuredGcTestDb,
+  withEnsuredLruGcTestDb,
   withTestCollection,
   withTestDbsSettings,
   withTestDb,
@@ -1756,19 +1755,15 @@ apiDescribe('Database', (persistence: boolean) => {
 
   it('Can get document from cache with GC enabled.', () => {
     const initialData = { key: 'value' };
-    return withEnsuredGcTestDb(
-      persistence,
-      LRU_MINIMUM_CACHE_SIZE_BYTES,
-      async db => {
-        const docRef = doc(collection(db, 'test-collection'));
-        await setDoc(docRef, initialData);
-        return getDoc(docRef).then(doc => {
-          expect(doc.exists()).to.be.true;
-          expect(doc.metadata.fromCache).to.be.false;
-          expect(doc.metadata.hasPendingWrites).to.be.false;
-          expect(doc.data()).to.deep.equal(initialData);
-        });
-      }
-    );
+    return withEnsuredLruGcTestDb(persistence, async db => {
+      const docRef = doc(collection(db, 'test-collection'));
+      await setDoc(docRef, initialData);
+      return getDoc(docRef).then(doc => {
+        expect(doc.exists()).to.be.true;
+        expect(doc.metadata.fromCache).to.be.false;
+        expect(doc.metadata.hasPendingWrites).to.be.false;
+        expect(doc.data()).to.deep.equal(initialData);
+      });
+    });
   });
 });

packages/firestore/test/integration/api/get_options.test.ts

@@ -17,7 +17,6 @@
 
 import { expect } from 'chai';
 
-import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector_impl';
 import {
   collection,
   deleteDoc,
@@ -37,7 +36,7 @@ import {
   apiDescribe,
   withTestCollection,
   withTestDocAndInitialData,
-  withEnsuredGcTestDb
+  withEnsuredLruGcTestDb
 } from '../util/helpers';
 
 apiDescribe('GetOptions', (persistence: boolean) => {
@@ -72,23 +71,19 @@ apiDescribe('GetOptions', (persistence: boolean) => {
   it('get document while offline with default get options', () => {
     const initialData = { key: 'value' };
     // Use an instance with Gc turned on.
-    return withEnsuredGcTestDb(
-      persistence,
-      LRU_MINIMUM_CACHE_SIZE_BYTES,
-      async db => {
-        const docRef = doc(collection(db, 'test-collection'));
-        await setDoc(docRef, initialData);
-        return getDoc(docRef)
-          .then(() => disableNetwork(db))
-          .then(() => getDoc(docRef))
-          .then(doc => {
-            expect(doc.exists()).to.be.true;
-            expect(doc.metadata.fromCache).to.be.true;
-            expect(doc.metadata.hasPendingWrites).to.be.false;
-            expect(doc.data()).to.deep.equal(initialData);
-          });
-      }
-    );
+    return withEnsuredLruGcTestDb(persistence, async db => {
+      const docRef = doc(collection(db, 'test-collection'));
+      await setDoc(docRef, initialData);
+      return getDoc(docRef)
+        .then(() => disableNetwork(db))
+        .then(() => getDoc(docRef))
+        .then(doc => {
+          expect(doc.exists()).to.be.true;
+          expect(doc.metadata.fromCache).to.be.true;
+          expect(doc.metadata.hasPendingWrites).to.be.false;
+          expect(doc.data()).to.deep.equal(initialData);
+        });
+    });
   });
 
   it('get collection while offline with default get options', () => {

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

@@ -142,15 +142,14 @@ export function withTestDb(
   });
 }
 
-export function withEnsuredGcTestDb(
+export function withEnsuredLruGcTestDb(
   persistence: boolean,
-  sizeBytes: number,
   fn: (db: Firestore) => Promise<void>
 ): Promise<void> {
   return withTestDbsSettings(
     persistence,
     DEFAULT_PROJECT_ID,
-    { ...DEFAULT_SETTINGS, cacheSizeBytes: sizeBytes },
+    { ...DEFAULT_SETTINGS, cacheSizeBytes: 1 * 1024 * 1024 },
     1,
     async ([db]) => {
       if (!persistence) {