Release Overlay

Author: wu-hui

firebase-firestore/CHANGELOG.md

@@ -2,7 +2,10 @@ Android changes are not released automatically. Ensure that changes are released
 by opting into a release at 
 [go/firebase-android-release](http:go/firebase-android-release) (Googlers only).
 
-# Unreleased
+# 24.1.0
+- [feature] Performance optimization for offline usage.
+
+# 24.0.0
 - [feature] Added support for Firebase AppCheck.
 
 # 23.0.4

firebase-firestore/firebase-firestore.gradle

@@ -112,13 +112,6 @@ android.libraryVariants.all { variant ->
     } else {
         variant.buildConfigField("boolean", "ENABLE_INDEXING", "false")
     }
-
-    // TODO(Overlay): Delete below once overlay is shipped.
-    if (localProps['firestoreEnableOverlay']) {
-        variant.buildConfigField("boolean", "ENABLE_OVERLAY", "true")
-    } else {
-        variant.buildConfigField("boolean", "ENABLE_OVERLAY", "false")
-    }
 }
 
 configurations.all {

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java

@@ -255,8 +255,6 @@ public static FirebaseFirestore testFirestore(
     // This unfortunately is a global setting that affects existing Firestore clients.
     Logger.setLogLevel(logLevel);
 
-    // TODO(Overlay): Remove below once this is ready to ship.
-    Persistence.OVERLAY_SUPPORT_ENABLED = true;
     Persistence.INDEXING_SUPPORT_ENABLED = true;
 
     Context context = ApplicationProvider.getApplicationContext();

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

@@ -52,7 +52,7 @@ public abstract class Persistence {
 
   /** Temporary setting for enabling document overlays. */
   // TODO(Overlay): Remove this.
-  public static boolean OVERLAY_SUPPORT_ENABLED = BuildConfig.ENABLE_OVERLAY;
+  public static boolean OVERLAY_SUPPORT_ENABLED = true;
   /** Constant string to indicate a data migration is required to support overlays. */
   public static String DATA_MIGRATION_BUILD_OVERLAYS = "BUILD_OVERLAYS";
 

firebase-firestore/src/test/java/com/google/firebase/firestore/local/DocumentOverlayCacheTestCase.java

@@ -30,7 +30,6 @@
 import java.util.Map;
 import org.junit.After;
 import org.junit.Before;
-import org.junit.BeforeClass;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TestName;
@@ -52,17 +51,6 @@ public abstract class DocumentOverlayCacheTestCase {
   private DocumentOverlayCache overlays;
   private static boolean overlayEnabled = false;
 
-  @BeforeClass
-  public static void beforeClass() {
-    overlayEnabled = Persistence.OVERLAY_SUPPORT_ENABLED;
-    Persistence.OVERLAY_SUPPORT_ENABLED = true;
-  }
-
-  @BeforeClass
-  public static void afterClass() {
-    Persistence.OVERLAY_SUPPORT_ENABLED = overlayEnabled;
-  }
-
   @Before
   public void setUp() {
     persistence = getPersistence();

firebase-firestore/src/test/java/com/google/firebase/firestore/local/LocalStoreTestCase.java

@@ -74,10 +74,12 @@
 import com.google.firebase.firestore.testutil.TestUtil;
 import com.google.firebase.firestore.util.AsyncQueue;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map.Entry;
 import java.util.Set;
+import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 import org.junit.After;
 import org.junit.Assert;
@@ -152,23 +154,22 @@ private void udpateViews(int targetId, boolean fromCache) {
     notifyLocalViewChanges(viewChanges(targetId, fromCache, asList(), asList()));
   }
 
-  private void acknowledgeMutation(long documentVersion, @Nullable Object transformResult) {
+  private void acknowledgeMutationWithTransform(long documentVersion, Object... transformResult) {
     MutationBatch batch = batches.remove(0);
     SnapshotVersion version = version(documentVersion);
-    MutationResult mutationResult =
-        new MutationResult(
-            version,
-            transformResult != null
-                ? Collections.singletonList(TestUtil.wrap(transformResult))
-                : Collections.emptyList());
+    List<MutationResult> mutationResults =
+        transformResult == null
+            ? singletonList(new MutationResult(version, emptyList()))
+            : Arrays.stream(transformResult)
+                .map(o -> new MutationResult(version, Collections.singletonList(TestUtil.wrap(o))))
+                .collect(Collectors.toList());
     MutationBatchResult result =
-        MutationBatchResult.create(
-            batch, version, singletonList(mutationResult), WriteStream.EMPTY_STREAM_TOKEN);
+        MutationBatchResult.create(batch, version, mutationResults, WriteStream.EMPTY_STREAM_TOKEN);
     lastChanges = localStore.acknowledgeBatch(result);
   }
 
   private void acknowledgeMutation(long documentVersion) {
-    acknowledgeMutation(documentVersion, null);
+    acknowledgeMutationWithTransform(documentVersion, null);
   }
 
   private void rejectMutation() {
@@ -963,9 +964,8 @@ public void testReadsAllDocumentsForInitialCollectionQueries() {
     localStore.executeQuery(query, /* usePreviousResults= */ true);
 
     assertRemoteDocumentsRead(/* byKey= */ 0, /* byQuery= */ 2);
-    if (!Persistence.OVERLAY_SUPPORT_ENABLED) {
-      assertMutationsRead(/* byKey= */ 0, /* byQuery= */ 1);
-    }
+    // No mutations are read because only overlay is needed.
+    assertMutationsRead(/* byKey= */ 0, /* byQuery= */ 0);
   }
 
   @Test
@@ -1059,7 +1059,7 @@ public void testHandlesSetMutationThenAckThenTransformThenAckThenTransform() {
     assertContains(doc("foo/bar", 1, map("sum", 1)).setHasLocalMutations());
     assertChanged(doc("foo/bar", 1, map("sum", 1)).setHasLocalMutations());
 
-    acknowledgeMutation(2, 1);
+    acknowledgeMutationWithTransform(2, 1);
     assertChanged(doc("foo/bar", 2, map("sum", 1)).setHasCommittedMutations());
     assertContains(doc("foo/bar", 2, map("sum", 1)).setHasCommittedMutations());
 
@@ -1273,17 +1273,17 @@ public void testHandlesSetMutationThenTransformThenRemoteEventThenTransform() {
     assertChanged(doc("foo/bar", 2, map("sum", 3)).setHasLocalMutations());
     assertContains(doc("foo/bar", 2, map("sum", 3)).setHasLocalMutations());
 
-    acknowledgeMutation(3, 1);
+    acknowledgeMutationWithTransform(3, 1);
     assertChanged(doc("foo/bar", 3, map("sum", 3)).setHasLocalMutations());
     assertContains(doc("foo/bar", 3, map("sum", 3)).setHasLocalMutations());
 
-    acknowledgeMutation(4, 1339);
+    acknowledgeMutationWithTransform(4, 1339);
     assertChanged(doc("foo/bar", 4, map("sum", 1339)).setHasCommittedMutations());
     assertContains(doc("foo/bar", 4, map("sum", 1339)).setHasCommittedMutations());
   }
 
   @Test
-  public void testHoldsBackOnlyNonIdempotentTransforms() {
+  public void testHoldsBackTransforms() {
     Query query = Query.atPath(ResourcePath.fromString("foo"));
     allocateQuery(query);
     assertTargetId(2);
@@ -1320,8 +1320,13 @@ public void testHoldsBackOnlyNonIdempotentTransforms() {
             asList(2),
             emptyList()));
     assertChanged(
-        doc("foo/bar", 2, map("sum", 1, "array_union", asList("bar", "foo")))
-            .setHasLocalMutations());
+        doc("foo/bar", 2, map("sum", 1, "array_union", asList("foo"))).setHasLocalMutations());
+
+    acknowledgeMutationWithTransform(3, 1338, asList("bar", "foo"));
+    assertChanged(
+        doc("foo/bar", 3, map("sum", 1338, "array_union", asList("bar", "foo")))
+            .withReadTime(new SnapshotVersion(new Timestamp(0, 3000)))
+            .setHasCommittedMutations());
   }
 
   @Test

firebase-firestore/src/test/java/com/google/firebase/firestore/local/MemoryLocalStoreTest.java

@@ -14,8 +14,6 @@
 
 package com.google.firebase.firestore.local;
 
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
 import org.robolectric.annotation.Config;
@@ -25,17 +23,6 @@
 public class MemoryLocalStoreTest extends LocalStoreTestCase {
   private static boolean enabled = false;
 
-  @BeforeClass
-  public static void beforeClass() {
-    enabled = Persistence.OVERLAY_SUPPORT_ENABLED;
-    Persistence.OVERLAY_SUPPORT_ENABLED = false;
-  }
-
-  @AfterClass
-  public static void afterClass() {
-    Persistence.OVERLAY_SUPPORT_ENABLED = enabled;
-  }
-
   @Override
   Persistence getPersistence() {
     return PersistenceTestHelpers.createEagerGCMemoryPersistence();

firebase-firestore/src/test/java/com/google/firebase/firestore/local/OverlayEnabledMemoryLocalStoreTest.java

@@ -408,16 +408,4 @@ public void doesNotIncludeDocumentsDeletedByMutation() throws Exception {
                     targetCache.getMatchingKeysForTargetId(TEST_TARGET_ID)));
     assertEquals(emptyMutableDocumentMap().insert(MATCHING_DOC_A.getKey(), MATCHING_DOC_A), docs);
   }
-
-  @Test
-  public void doesNotIncludeDocumentsDeletedByMutation_OverlayEnabled() throws Exception {
-    boolean saved = Persistence.OVERLAY_SUPPORT_ENABLED;
-    Persistence.OVERLAY_SUPPORT_ENABLED = true;
-
-    try {
-      doesNotIncludeDocumentsDeletedByMutation();
-    } finally {
-      Persistence.OVERLAY_SUPPORT_ENABLED = saved;
-    }
-  }
 }

firebase-firestore/src/test/java/com/google/firebase/firestore/local/OverlayEnabledSQLiteLocalStoreTest.java

@@ -14,8 +14,6 @@
 
 package com.google.firebase.firestore.local;
 
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
 import org.robolectric.annotation.Config;
@@ -25,17 +23,6 @@
 public class SQLiteLocalStoreTest extends LocalStoreTestCase {
   private static boolean enabled = false;
 
-  @BeforeClass
-  public static void beforeClass() {
-    enabled = Persistence.OVERLAY_SUPPORT_ENABLED;
-    Persistence.OVERLAY_SUPPORT_ENABLED = false;
-  }
-
-  @AfterClass
-  public static void afterClass() {
-    Persistence.OVERLAY_SUPPORT_ENABLED = enabled;
-  }
-
   @Override
   Persistence getPersistence() {
     return PersistenceTestHelpers.createSQLitePersistence();

firebase-firestore/src/test/java/com/google/firebase/firestore/local/QueryEngineTest.java

@@ -35,9 +35,7 @@
 import java.util.Collections;
 import java.util.List;
 import org.junit.After;
-import org.junit.AfterClass;
 import org.junit.Before;
-import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
@@ -51,17 +49,6 @@ public class SQLiteOverlayMigrationManagerTest {
   private Persistence persistence;
   private LocalStore localStore;
 
-  @BeforeClass
-  public static void beforeClass() {
-    overlayEnabled = Persistence.OVERLAY_SUPPORT_ENABLED;
-    Persistence.OVERLAY_SUPPORT_ENABLED = true;
-  }
-
-  @AfterClass
-  public static void afterClass() {
-    Persistence.OVERLAY_SUPPORT_ENABLED = overlayEnabled;
-  }
-
   @Before
   public void setUp() {
     persistence =