Java impl

Author: wu-hui

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

@@ -24,8 +24,7 @@
 /** Settings used to configure a {@link FirebaseFirestore} instance. */
 public final class FirebaseFirestoreSettings {
   /**
-   * Constant to use with
-   * {@link FirebaseFirestoreSettings.Builder#setCacheSizeBytes(long)} to
+   * Constant to use with {@link FirebaseFirestoreSettings.Builder#setCacheSizeBytes(long)} to
    * disable garbage collection.
    */
   public static final long CACHE_SIZE_UNLIMITED = -1;
@@ -42,7 +41,6 @@ public static final class Builder {
     private boolean sslEnabled;
     private boolean persistenceEnabled;
 
-    private boolean memoryLruGcEnabled;
     private long cacheSizeBytes;
     private LocalCacheSettings cacheSettings;
 
@@ -53,13 +51,11 @@ public Builder() {
       host = DEFAULT_HOST;
       sslEnabled = true;
       persistenceEnabled = true;
-      memoryLruGcEnabled = false;
       cacheSizeBytes = DEFAULT_CACHE_SIZE_BYTES;
     }
 
     /**
-     * Constructs a new {@code FirebaseFirestoreSettings} Builder based on an
-     * existing {@code
+     * Constructs a new {@code FirebaseFirestoreSettings} Builder based on an existing {@code
      * FirebaseFirestoreSettings} object.
      */
     public Builder(@NonNull FirebaseFirestoreSettings settings) {
@@ -105,16 +101,13 @@ public Builder setSslEnabled(boolean value) {
     }
 
     /**
-     * Enables or disables local persistent storage. The default is to use local
-     * persistent storage.
+     * Enables or disables local persistent storage. The default is to use local persistent storage.
      *
-     * @return A settings object that uses local persistent storage as specified by
-     *         the given
-     *         <tt>value</tt>.
+     * @return A settings object that uses local persistent storage as specified by the given
+     *     <tt>value</tt>.
      * @deprecated Use {@link
-     *             FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)}
-     *             to configure
-     *             SDK cache instead.
+     *     FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)} to configure
+     *     SDK cache instead.
      */
     @NonNull
     @Deprecated
@@ -128,32 +121,19 @@ public Builder setPersistenceEnabled(boolean value) {
       return this;
     }
 
-    @NonNull
-    public Builder setMemoryLruGcEnabled(boolean value) {
-      this.memoryLruGcEnabled = value;
-      return this;
-    }
-
     /**
-     * Sets an approximate cache size threshold for the on-disk data. If the cache
-     * grows beyond this
-     * size, Cloud Firestore will start removing data that hasn't been recently
-     * used. The size is
-     * not a guarantee that the cache will stay below that size, only that if the
-     * cache exceeds the
+     * Sets an approximate cache size threshold for the on-disk data. If the cache grows beyond this
+     * size, Cloud Firestore will start removing data that hasn't been recently used. The size is
+     * not a guarantee that the cache will stay below that size, only that if the cache exceeds the
      * given size, cleanup will be attempted.
      *
-     * <p>
-     * By default, collection is enabled with a cache size of 100 MB. The minimum
-     * value is 1 MB.
+     * <p>By default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.
      *
-     * @return A settings object on which the cache size is configured as specified
-     *         by the given
-     *         {@code value}.
+     * @return A settings object on which the cache size is configured as specified by the given
+     *     {@code value}.
      * @deprecated Use {@link
-     *             FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)}
-     *             to configure
-     *             SDK cache instead.
+     *     FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)} to configure
+     *     SDK cache instead.
      */
     @NonNull
     @Deprecated
@@ -172,24 +152,18 @@ public Builder setCacheSizeBytes(long value) {
     }
 
     /**
-     * Specifies the cache used by the SDK. Available options are
-     * {@link PersistentCacheSettings}
+     * Specifies the cache used by the SDK. Available options are {@link PersistentCacheSettings}
      * and {@link MemoryCacheSettings}, each with different configuration options.
      *
-     * <p>
-     * When unspecified, {@link PersistentCacheSettings} will be used by default.
+     * <p>When unspecified, {@link PersistentCacheSettings} will be used by default.
      *
-     * <p>
-     * NOTE: Calling this setter and {@code setPersistenceEnabled()} or @{code
-     * setCacheSizeBytes()} at the same time will throw an exception during SDK
-     * initialization.
-     * Instead, use the configuration in the {@link PersistentCacheSettings} object
-     * to specify the
+     * <p>NOTE: Calling this setter and {@code setPersistenceEnabled()} or @{code
+     * setCacheSizeBytes()} at the same time will throw an exception during SDK initialization.
+     * Instead, use the configuration in the {@link PersistentCacheSettings} object to specify the
      * cache size.
      *
-     * @return A settings object on which the cache settings is configured as
-     *         specified by the given
-     *         {@code settings}.
+     * @return A settings object on which the cache settings is configured as specified by the given
+     *     {@code settings}.
      */
     @NonNull
     public Builder setLocalCacheSettings(@NonNull LocalCacheSettings settings) {
@@ -221,11 +195,9 @@ public boolean isSslEnabled() {
     }
 
     /**
-     * @return boolean indicating whether local persistent storage is enabled or
-     *         not.
-     * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check
-     *             cache
-     *             configurations.
+     * @return boolean indicating whether local persistent storage is enabled or not.
+     * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check cache
+     *     configurations.
      */
     @Deprecated
     public boolean isPersistenceEnabled() {
@@ -234,9 +206,8 @@ public boolean isPersistenceEnabled() {
 
     /**
      * @return cache size for on-disk data.
-     * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check
-     *             cache
-     *             configurations.
+     * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check cache
+     *     configurations.
      */
     @Deprecated
     public long getCacheSizeBytes() {
@@ -256,15 +227,11 @@ public FirebaseFirestoreSettings build() {
   private final String host;
   private final boolean sslEnabled;
   private final boolean persistenceEnabled;
-  private final boolean memoryLruGcEnabled;
   private final long cacheSizeBytes;
 
   private LocalCacheSettings cacheSettings;
 
-  /**
-   * Constructs a {@code FirebaseFirestoreSettings} object based on the values in
-   * the Builder.
-   */
+  /** Constructs a {@code FirebaseFirestoreSettings} object based on the values in the Builder. */
   private FirebaseFirestoreSettings(Builder builder) {
     host = builder.host;
     sslEnabled = builder.sslEnabled;
@@ -275,21 +242,15 @@ private FirebaseFirestoreSettings(Builder builder) {
 
   @Override
   public boolean equals(Object o) {
-    if (this == o)
-      return true;
-    if (o == null || getClass() != o.getClass())
-      return false;
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
 
     FirebaseFirestoreSettings that = (FirebaseFirestoreSettings) o;
 
-    if (sslEnabled != that.sslEnabled)
-      return false;
-    if (persistenceEnabled != that.persistenceEnabled)
-      return false;
-    if (cacheSizeBytes != that.cacheSizeBytes)
-      return false;
-    if (!host.equals(that.host))
-      return false;
+    if (sslEnabled != that.sslEnabled) return false;
+    if (persistenceEnabled != that.persistenceEnabled) return false;
+    if (cacheSizeBytes != that.cacheSizeBytes) return false;
+    if (!host.equals(that.host)) return false;
     return Objects.equals(cacheSettings, that.cacheSettings);
   }
 
@@ -307,18 +268,19 @@ public int hashCode() {
   @NonNull
   public String toString() {
     return "FirebaseFirestoreSettings{"
-        + "host="
-        + host
-        + ", sslEnabled="
-        + sslEnabled
-        + ", persistenceEnabled="
-        + persistenceEnabled
-        + ", cacheSizeBytes="
-        + cacheSizeBytes
-        + ", cacheSettings="
-        + cacheSettings == null
-            ? "null"
-            : cacheSettings.toString() + "}";
+                + "host="
+                + host
+                + ", sslEnabled="
+                + sslEnabled
+                + ", persistenceEnabled="
+                + persistenceEnabled
+                + ", cacheSizeBytes="
+                + cacheSizeBytes
+                + ", cacheSettings="
+                + cacheSettings
+            == null
+        ? "null"
+        : cacheSettings.toString() + "}";
   }
 
   /** Returns the host of the Cloud Firestore backend. */
@@ -346,13 +308,8 @@ public boolean isPersistenceEnabled() {
     return persistenceEnabled;
   }
 
-  public boolean isMemoryLruGcEnabled() {
-    return memoryLruGcEnabled;
-  }
-
   /**
-   * Returns the threshold for the cache size above which the SDK will attempt to
-   * collect the least
+   * Returns the threshold for the cache size above which the SDK will attempt to collect the least
    * recently used documents.
    *
    * @deprecated Use {@link FirebaseFirestoreSettings#getCacheSettings()} instead.
@@ -363,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;
       }
     }
@@ -371,8 +334,7 @@ public long getCacheSizeBytes() {
   }
 
   /**
-   * Returns the cache settings configured for the SDK. Returns null if it is not
-   * configured, in
+   * Returns the cache settings configured for the SDK. Returns null if it is not configured, in
    * which case a default {@link PersistentCacheSettings} instance is used.
    */
   @Nullable

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();
+  }
+}