query.test.ts: use LRUGC in bloom filter tests so they can run even when persistence=false

Author: dconeybe

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

@@ -36,6 +36,8 @@ import {
   enableNetwork,
   endAt,
   endBefore,
+  memoryLocalCache,
+  memoryLruGarbageCollector,
   Firestore,
   GeoPoint,
   getDocs,
@@ -46,6 +48,7 @@ import {
   onSnapshot,
   or,
   orderBy,
+  persistentLocalCache,
   Query,
   query,
   QuerySnapshot,
@@ -2128,16 +2131,6 @@ apiDescribe('Queries', (persistence: boolean) => {
         );
       }
 
-      // Skip the verification of the existence filter mismatch when persistence
-      // is disabled because without persistence there is no resume token
-      // specified in the subsequent call to getDocs(), and, therefore, Watch
-      // will _not_ send an existence filter.
-      // TODO(b/272754156) Re-write this test using a snapshot listener instead
-      // of calls to getDocs() and remove this check for disabled persistence.
-      if (!persistence) {
-        return 'passed';
-      }
-
       // Skip the verification of the existence filter mismatch when testing
       // against the Firestore emulator because the Firestore emulator fails to
       // to send an existence filter at all.
@@ -2193,12 +2186,18 @@ apiDescribe('Queries', (persistence: boolean) => {
       return 'passed';
     };
 
+    // Use LRU memory cache so that the resume token will not be deleted between
+    // calls to `getDocs()`.
+    const localCache = persistence
+      ? persistentLocalCache()
+      : memoryLocalCache({ garbageCollector: memoryLruGarbageCollector() });
+
     // Run the test
     let attemptNumber = 0;
     while (true) {
       attemptNumber++;
       const iterationResult = await withTestCollection(
-        persistence,
+        localCache,
         testDocs,
         runTestIteration
       );

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

@@ -25,10 +25,12 @@ import {
   DocumentData,
   DocumentReference,
   Firestore,
+  MemoryLocalCache,
   memoryLocalCache,
   memoryLruGarbageCollector,
   newTestApp,
   newTestFirestore,
+  PersistentLocalCache,
   persistentLocalCache,
   PrivateSettings,
   QuerySnapshot,
@@ -137,7 +139,7 @@ export function toIds(docSet: QuerySnapshot): string[] {
 }
 
 export function withTestDb(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   fn: (db: Firestore) => Promise<void>
 ): Promise<void> {
   return withTestDbs(persistence, 1, ([db]) => {
@@ -160,7 +162,7 @@ export function withEnsuredEagerGcTestDb(
 }
 
 export function withEnsuredLruGcTestDb(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   fn: (db: Firestore) => Promise<void>
 ): Promise<void> {
   const newSettings = { ...DEFAULT_SETTINGS };
@@ -188,7 +190,7 @@ export function withEnsuredLruGcTestDb(
 
 /** Runs provided fn with a db for an alternate project id. */
 export function withAlternateTestDb(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   fn: (db: Firestore) => Promise<void>
 ): Promise<void> {
   return withTestDbsSettings(
@@ -203,7 +205,7 @@ export function withAlternateTestDb(
 }
 
 export function withTestDbs(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   numDbs: number,
   fn: (db: Firestore[]) => Promise<void>
 ): Promise<void> {
@@ -216,7 +218,7 @@ export function withTestDbs(
   );
 }
 export async function withTestDbsSettings<T>(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   projectId: string,
   settings: PrivateSettings,
   numDbs: number,
@@ -250,7 +252,7 @@ export async function withTestDbsSettings<T>(
 }
 
 export async function withNamedTestDbsOrSkipUnlessUsingEmulator(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   dbNames: string[],
   fn: (db: Firestore[]) => Promise<void>
 ): Promise<void> {
@@ -265,8 +267,12 @@ export async function withNamedTestDbsOrSkipUnlessUsingEmulator(
   const dbs: Firestore[] = [];
   for (const dbName of dbNames) {
     const newSettings = { ...DEFAULT_SETTINGS };
-    if (persistence) {
-      newSettings.localCache = persistentLocalCache();
+    if (typeof persistence === 'boolean') {
+      if (persistence) {
+        newSettings.localCache = persistentLocalCache();
+      }
+    } else {
+      newSettings.localCache = persistence;
     }
     const db = newTestFirestore(app, newSettings, dbName);
     dbs.push(db);
@@ -285,7 +291,7 @@ export async function withNamedTestDbsOrSkipUnlessUsingEmulator(
 }
 
 export function withTestDoc(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   fn: (doc: DocumentReference, db: Firestore) => Promise<void>
 ): Promise<void> {
   return withTestDb(persistence, db => {
@@ -294,7 +300,7 @@ export function withTestDoc(
 }
 
 export function withTestDocAndSettings(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   settings: PrivateSettings,
   fn: (doc: DocumentReference) => Promise<void>
 ): Promise<void> {
@@ -315,7 +321,7 @@ export function withTestDocAndSettings(
 // `withTestDoc(..., docRef => { setDoc(docRef, initialData) ...});` that
 // otherwise is quite common.
 export function withTestDocAndInitialData(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   initialData: DocumentData | null,
   fn: (doc: DocumentReference, db: Firestore) => Promise<void>
 ): Promise<void> {
@@ -330,15 +336,15 @@ export function withTestDocAndInitialData(
 }
 
 export function withTestCollection<T>(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   docs: { [key: string]: DocumentData },
   fn: (collection: CollectionReference, db: Firestore) => Promise<T>
 ): Promise<T> {
   return withTestCollectionSettings(persistence, DEFAULT_SETTINGS, docs, fn);
 }
 
 export function withEmptyTestCollection(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   fn: (collection: CollectionReference, db: Firestore) => Promise<void>
 ): Promise<void> {
   return withTestCollection(persistence, {}, fn);
@@ -347,7 +353,7 @@ export function withEmptyTestCollection(
 // TODO(mikelehen): Once we wipe the database between tests, we can probably
 // return the same collection every time.
 export function withTestCollectionSettings<T>(
-  persistence: boolean,
+  persistence: boolean | PersistentLocalCache | MemoryLocalCache,
   settings: PrivateSettings,
   docs: { [key: string]: DocumentData },
   fn: (collection: CollectionReference, db: Firestore) => Promise<T>