Spec tests

Author: wu-hui

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/FirestoreTest.java

@@ -1243,7 +1243,7 @@ public void testPendingWriteTaskResolveWhenOfflineIfThereIsNoPending() {
   }
 
   @Test
-  public void testGetDocumentWithMemoryLruGCEnabled() {
+  public void testCanGetDocumentWithMemoryLruGCEnabled() {
     FirebaseFirestore db = testFirestore();
     db.setFirestoreSettings(
         new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
@@ -1261,7 +1261,7 @@ public void testGetDocumentWithMemoryLruGCEnabled() {
   }
 
   @Test
-  public void testGetDocumentWithMemoryEagerGcEnabled() {
+  public void testCannotGetDocumentWithMemoryEagerGcEnabled() {
     FirebaseFirestore db = testFirestore();
     db.setFirestoreSettings(
         new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())

firebase-firestore/src/main/java/com/google/firebase/firestore/local/LruGarbageCollector.java

@@ -61,8 +61,10 @@ public static Params WithCacheSizeBytes(long cacheSizeBytes) {
       return new Params(cacheSizeBytes, 10, 1000);
     }
 
-    final long minBytesThreshold;
-    final int percentileToCollect;
+    // Not final for testing purposes.
+    long minBytesThreshold;
+    // Not final for testing purposes.
+    int percentileToCollect;
     final int maximumSequenceNumbersToCollect;
 
     Params(long minBytesThreshold, int percentileToCollect, int maximumSequenceNumbersToCollect) {
@@ -163,6 +165,13 @@ public GCScheduler newScheduler(AsyncQueue asyncQueue, LocalStore localStore) {
     return new GCScheduler(asyncQueue, localStore);
   }
 
+  // Visible for testing purposes only.
+  public LruGarbageCollector withNewThreshold(long cacheThreshold) {
+    this.params.minBytesThreshold = cacheThreshold;
+    this.params.percentileToCollect = 100;
+    return this;
+  }
+
   /** Given a percentile of target to collect, returns the number of targets to collect. */
   int calculateQueryCount(int percentile) {
     long targetCount = delegate.getSequenceNumberCount();

firebase-firestore/src/main/java/com/google/firebase/firestore/local/MemoryLruReferenceDelegate.java

@@ -27,7 +27,7 @@
 import java.util.Map;
 
 /** Provides LRU garbage collection functionality for MemoryPersistence. */
-class MemoryLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
+public class MemoryLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
   private final MemoryPersistence persistence;
   private final LocalSerializer serializer;
   private final Map<DocumentKey, Long> orphanedSequenceNumbers;

firebase-firestore/src/main/java/com/google/firebase/firestore/local/MemoryPersistence.java

@@ -85,7 +85,7 @@ public boolean isStarted() {
   }
 
   @Override
-  ReferenceDelegate getReferenceDelegate() {
+  public ReferenceDelegate getReferenceDelegate() {
     return referenceDelegate;
   }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/local/Persistence.java

@@ -67,7 +67,8 @@ public abstract class Persistence {
 
   public abstract boolean isStarted();
 
-  abstract ReferenceDelegate getReferenceDelegate();
+  // Visible for testing purposes.
+  public abstract ReferenceDelegate getReferenceDelegate();
 
   /**
    * Returns a MutationQueue representing the persisted mutations for the given user.

firebase-firestore/src/main/java/com/google/firebase/firestore/local/SQLiteLruReferenceDelegate.java

@@ -25,7 +25,7 @@
 import java.util.List;
 
 /** Provides LRU functionality for SQLite persistence. */
-class SQLiteLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
+public class SQLiteLruReferenceDelegate implements ReferenceDelegate, LruDelegate {
   /**
    * The batch size for orphaned document GC in `removeOrphanedDocuments()`.
    *

firebase-firestore/src/test/java/com/google/firebase/firestore/spec/MemorySpecTest.java

@@ -40,12 +40,12 @@ protected boolean isExcluded(Set<String> tags) {
 
   @Override
   protected MemoryComponentProvider initializeComponentProvider(
-      ComponentProvider.Configuration configuration, boolean garbageCollectionEnabled) {
+      ComponentProvider.Configuration configuration, boolean useEagerGc) {
     MemoryComponentProvider provider =
         new MemoryComponentProvider() {
           @Override
           protected Persistence createPersistence(Configuration configuration) {
-            if (garbageCollectionEnabled) {
+            if (useEagerGc) {
               return MemoryPersistence.createEagerGcMemoryPersistence();
             } else {
               DatabaseId databaseId = DatabaseId.forProject("projectId");

firebase-firestore/src/test/java/com/google/firebase/firestore/spec/SpecTestCase.java

@@ -38,6 +38,7 @@
 import com.google.common.collect.Sets;
 import com.google.firebase.database.collection.ImmutableSortedSet;
 import com.google.firebase.firestore.EventListener;
+import com.google.firebase.firestore.FirebaseFirestore;
 import com.google.firebase.firestore.FirebaseFirestoreException;
 import com.google.firebase.firestore.FirebaseFirestoreSettings;
 import com.google.firebase.firestore.LoadBundleTask;
@@ -54,9 +55,13 @@
 import com.google.firebase.firestore.core.Query;
 import com.google.firebase.firestore.core.QueryListener;
 import com.google.firebase.firestore.core.SyncEngine;
+import com.google.firebase.firestore.local.LocalStore;
+import com.google.firebase.firestore.local.LruGarbageCollector;
+import com.google.firebase.firestore.local.MemoryLruReferenceDelegate;
 import com.google.firebase.firestore.local.Persistence;
 import com.google.firebase.firestore.local.PersistenceTestHelpers;
 import com.google.firebase.firestore.local.QueryPurpose;
+import com.google.firebase.firestore.local.SQLiteLruReferenceDelegate;
 import com.google.firebase.firestore.local.TargetData;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.MutableDocument;
@@ -158,7 +163,7 @@ public abstract class SpecTestCase implements RemoteStoreCallback {
           ? Sets.newHashSet("no-android", "multi-client")
           : Sets.newHashSet("no-android", BENCHMARK_TAG, "multi-client");
 
-  private boolean garbageCollectionEnabled;
+  private boolean useEagerGcForMemory;
   private int maxConcurrentLimboResolutions;
   private boolean networkEnabled = true;
 
@@ -170,7 +175,9 @@ public abstract class SpecTestCase implements RemoteStoreCallback {
   private AsyncQueue queue;
   private MockDatastore datastore;
   private RemoteStore remoteStore;
+  private LocalStore localStore;
   private SyncEngine syncEngine;
+  private LruGarbageCollector lruGarbageCollector;
   private EventManager eventManager;
   private DatabaseInfo databaseInfo;
 
@@ -268,7 +275,7 @@ protected void specSetUp(JSONObject config) {
 
     outstandingWrites = new HashMap<>();
 
-    this.garbageCollectionEnabled = config.optBoolean("useGarbageCollection", false);
+    this.useEagerGcForMemory = config.optBoolean("useEagerGCForMemory", true);
     this.maxConcurrentLimboResolutions =
         config.optInt("maxConcurrentLimboResolutions", Integer.MAX_VALUE);
 
@@ -317,10 +324,19 @@ private void initClient() {
             maxConcurrentLimboResolutions,
             new FirebaseFirestoreSettings.Builder().build());
 
-    ComponentProvider provider =
-        initializeComponentProvider(configuration, garbageCollectionEnabled);
+    ComponentProvider provider = initializeComponentProvider(configuration, useEagerGcForMemory);
     localPersistence = provider.getPersistence();
+    if (localPersistence.getReferenceDelegate() instanceof SQLiteLruReferenceDelegate) {
+      lruGarbageCollector =
+          ((SQLiteLruReferenceDelegate) localPersistence.getReferenceDelegate())
+              .getGarbageCollector();
+    } else if (localPersistence.getReferenceDelegate() instanceof MemoryLruReferenceDelegate) {
+      lruGarbageCollector =
+          ((MemoryLruReferenceDelegate) localPersistence.getReferenceDelegate())
+              .getGarbageCollector();
+    }
     remoteStore = provider.getRemoteStore();
+    localStore = provider.getLocalStore();
     syncEngine = provider.getSyncEngine();
     eventManager = provider.getEventManager();
   }
@@ -473,6 +489,7 @@ private List<Integer> parseIntList(@Nullable JSONArray arr) throws JSONException
   //
 
   private void doListen(JSONObject listenSpec) throws Exception {
+    FirebaseFirestore.setLoggingEnabled(true);
     int expectedId = listenSpec.getInt("targetId");
     Query query = parseQuery(listenSpec.getJSONObject("query"));
     // TODO: Allow customizing listen options in spec tests
@@ -789,6 +806,15 @@ private void doChangeUser(@Nullable String uid) throws Exception {
     queue.runSync(() -> syncEngine.handleCredentialChange(currentUser));
   }
 
+  private void doTriggerLruGc(long cacheThreshold) throws Exception {
+    queue.runSync(
+        () -> {
+          if (lruGarbageCollector != null) {
+            localStore.collectGarbage(lruGarbageCollector.withNewThreshold(cacheThreshold));
+          }
+        });
+  }
+
   private void doRestart() throws Exception {
     queue.runSync(
         () -> {
@@ -861,6 +887,9 @@ private void doStep(JSONObject step) throws Exception {
       // "changeUser".
       String uid = step.isNull("changeUser") ? null : step.getString("changeUser");
       doChangeUser(uid);
+    } else if (step.has("triggerLruGC")) {
+      long cacheThreshold = step.getLong("triggerLruGC");
+      doTriggerLruGc(cacheThreshold);
     } else if (step.has("restart")) {
       doRestart();
     } else if (step.has("applyClientState")) {