Merge 9bc62af into 734adc0

Author: wu-hui

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

@@ -1298,4 +1298,39 @@ public void testNewCacheConfigForPersistentCache() {
     DocumentSnapshot snap = waitFor(instance.document("coll/doc").get(Source.CACHE));
     assertEquals(map("foo", "bar"), snap.getData());
   }
+
+  @Test
+  public void testCanGetDocumentWithMemoryLruGCEnabled() {
+    FirebaseFirestore db = testFirestore();
+    db.setFirestoreSettings(
+        new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
+            .setPersistenceEnabled(false)
+            .setMemoryLruGcEnabled(true)
+            .build());
+
+    DocumentReference doc = db.collection("abc").document("123");
+    waitFor(doc.set(map("key", "value")));
+
+    DocumentSnapshot snapshot = waitFor(doc.get(Source.CACHE));
+    assertTrue(snapshot.exists());
+    assertTrue(snapshot.getMetadata().isFromCache());
+    assertEquals(snapshot.getData(), map("key", "value"));
+  }
+
+  @Test
+  public void testCannotGetDocumentWithMemoryEagerGcEnabled() {
+    FirebaseFirestore db = testFirestore();
+    db.setFirestoreSettings(
+        new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
+            .setPersistenceEnabled(false)
+            .setMemoryLruGcEnabled(false)
+            .build());
+
+    DocumentReference doc = db.collection("abc").document("123");
+    waitFor(doc.set(map("key", "value")));
+
+    Exception e = waitForException(doc.get(Source.CACHE));
+    assertTrue(e instanceof FirebaseFirestoreException);
+    assertEquals(((FirebaseFirestoreException) e).getCode(), Code.UNAVAILABLE);
+  }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java

@@ -40,6 +40,7 @@ public static final class Builder {
     private String host;
     private boolean sslEnabled;
     private boolean persistenceEnabled;
+
     private long cacheSizeBytes;
     private LocalCacheSettings cacheSettings;
 
@@ -319,6 +320,12 @@ public long getCacheSizeBytes() {
       if (cacheSettings instanceof PersistentCacheSettings) {
         return ((PersistentCacheSettings) cacheSettings).getSizeBytes();
       } else {
+        MemoryCacheSettings memorySettings = (MemoryCacheSettings) cacheSettings;
+        if (memorySettings.getGarbageCollectorSettings() instanceof MemoryLruGcSettings) {
+          return ((MemoryLruGcSettings) memorySettings.getGarbageCollectorSettings())
+              .getSizeBytes();
+        }
+
         return CACHE_SIZE_UNLIMITED;
       }
     }

firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryCacheSettings.java

@@ -27,42 +27,58 @@
  * `FirebaseFirestoreSettings` instance to configure Firestore SDK.
  */
 public final class MemoryCacheSettings implements LocalCacheSettings {
+  private MemoryGarbageCollectorSettings gcSettings;
 
   /** Returns a new instance of {@link MemoryCacheSettings.Builder} with default configurations. */
   @NonNull
   public static MemoryCacheSettings.Builder newBuilder() {
     return new MemoryCacheSettings.Builder();
   }
 
-  private MemoryCacheSettings() {}
+  private MemoryCacheSettings(MemoryGarbageCollectorSettings settings) {
+    gcSettings = settings;
+  }
 
   @Override
   public int hashCode() {
-    return super.hashCode();
+    return gcSettings.hashCode();
   }
 
   @Override
   public boolean equals(@Nullable Object obj) {
     if (this == obj) return true;
     if (obj == null || getClass() != obj.getClass()) return false;
 
-    return true;
+    return getGarbageCollectorSettings()
+        .equals(((MemoryCacheSettings) obj).getGarbageCollectorSettings());
   }
 
   @Override
   public String toString() {
-    return "MemoryCacheSettings{}";
+    return "MemoryCacheSettings{gcSettings " + getGarbageCollectorSettings() + "}";
+  }
+
+  @NonNull
+  public MemoryGarbageCollectorSettings getGarbageCollectorSettings() {
+    return gcSettings;
   }
 
   /** A Builder for creating {@code MemoryCacheSettings} instance. */
   public static class Builder {
+    private MemoryGarbageCollectorSettings gcSettings = MemoryEagerGcSettings.newBuilder().build();
 
     private Builder() {}
 
     /** Creates a {@code MemoryCacheSettings} instance. */
     @NonNull
     public MemoryCacheSettings build() {
-      return new MemoryCacheSettings();
+      return new MemoryCacheSettings(gcSettings);
+    }
+
+    @NonNull
+    public Builder setGcSettings(@NonNull MemoryGarbageCollectorSettings gcSettings) {
+      this.gcSettings = gcSettings;
+      return this;
     }
   }
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryEagerGcSettings.java

@@ -0,0 +1,55 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public final class MemoryEagerGcSettings implements MemoryGarbageCollectorSettings {
+  private MemoryEagerGcSettings() {}
+
+  public static class Builder {
+    private Builder() {}
+
+    @NonNull
+    public MemoryEagerGcSettings build() {
+      return new MemoryEagerGcSettings();
+    }
+  }
+
+  @Override
+  public int hashCode() {
+    return super.hashCode();
+  }
+
+  @Override
+  public boolean equals(@Nullable Object obj) {
+    if (this == obj) return true;
+    if (obj == null || getClass() != obj.getClass()) return false;
+
+    return true;
+  }
+
+  @NonNull
+  @Override
+  public String toString() {
+    return "MemoryEagerGcSettings{}";
+  }
+
+  @NonNull
+  public static MemoryEagerGcSettings.Builder newBuilder() {
+    return new Builder();
+  }
+}

firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryGarbageCollectorSettings.java

@@ -0,0 +1,17 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore;
+
+public interface MemoryGarbageCollectorSettings {}

firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryLruGcSettings.java

@@ -0,0 +1,56 @@
+package com.google.firebase.firestore;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public final class MemoryLruGcSettings implements MemoryGarbageCollectorSettings {
+
+  private long sizeBytes;
+
+  public static class Builder {
+    private long sizeBytes = FirebaseFirestoreSettings.DEFAULT_CACHE_SIZE_BYTES;
+
+    private Builder() {}
+
+    @NonNull
+    public MemoryLruGcSettings build() {
+      return new MemoryLruGcSettings(sizeBytes);
+    }
+
+    public void setSizeBytes(long size) {
+      sizeBytes = size;
+    }
+  }
+
+  private MemoryLruGcSettings(long size) {
+    sizeBytes = size;
+  }
+
+  @NonNull
+  public static MemoryLruGcSettings.Builder newBuilder() {
+    return new Builder();
+  }
+
+  public long getSizeBytes() {
+    return sizeBytes;
+  }
+
+  @Override
+  public int hashCode() {
+    return super.hashCode();
+  }
+
+  @Override
+  public boolean equals(@Nullable Object obj) {
+    if (this == obj) return true;
+    if (obj == null || getClass() != obj.getClass()) return false;
+
+    return true;
+  }
+
+  @NonNull
+  @Override
+  public String toString() {
+    return "MemoryLruGcSettings{cacheSize= " + getSizeBytes() + "}";
+  }
+}

firebase-firestore/src/main/java/com/google/firebase/firestore/core/MemoryComponentProvider.java

@@ -16,8 +16,13 @@
 
 import androidx.annotation.Nullable;
 import com.google.firebase.database.collection.ImmutableSortedSet;
+import com.google.firebase.firestore.FirebaseFirestoreSettings;
+import com.google.firebase.firestore.MemoryCacheSettings;
+import com.google.firebase.firestore.MemoryLruGcSettings;
 import com.google.firebase.firestore.local.IndexBackfiller;
+import com.google.firebase.firestore.local.LocalSerializer;
 import com.google.firebase.firestore.local.LocalStore;
+import com.google.firebase.firestore.local.LruGarbageCollector;
 import com.google.firebase.firestore.local.MemoryPersistence;
 import com.google.firebase.firestore.local.Persistence;
 import com.google.firebase.firestore.local.QueryEngine;
@@ -26,6 +31,7 @@
 import com.google.firebase.firestore.model.mutation.MutationBatchResult;
 import com.google.firebase.firestore.remote.AndroidConnectivityMonitor;
 import com.google.firebase.firestore.remote.RemoteEvent;
+import com.google.firebase.firestore.remote.RemoteSerializer;
 import com.google.firebase.firestore.remote.RemoteStore;
 import io.grpc.Status;
 
@@ -62,8 +68,28 @@ protected AndroidConnectivityMonitor createConnectivityMonitor(Configuration con
     return new AndroidConnectivityMonitor(configuration.getContext());
   }
 
+  private boolean isMemoryLruGcEnabled(FirebaseFirestoreSettings settings) {
+    if (settings.getCacheSettings() != null
+        && settings.getCacheSettings() instanceof MemoryCacheSettings) {
+      MemoryCacheSettings memorySettings = (MemoryCacheSettings) settings.getCacheSettings();
+      return memorySettings.getGarbageCollectorSettings() instanceof MemoryLruGcSettings;
+    }
+
+    return false;
+  }
+
   @Override
   protected Persistence createPersistence(Configuration configuration) {
+    if (isMemoryLruGcEnabled(configuration.getSettings())) {
+      LocalSerializer serializer =
+          new LocalSerializer(
+              new RemoteSerializer(configuration.getDatabaseInfo().getDatabaseId()));
+      LruGarbageCollector.Params params =
+          LruGarbageCollector.Params.WithCacheSizeBytes(
+              configuration.getSettings().getCacheSizeBytes());
+      return MemoryPersistence.createLruGcMemoryPersistence(params, serializer);
+    }
+
     return MemoryPersistence.createEagerGcMemoryPersistence();
   }
 

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");