Rename getDocumentOverlay to getDocumentOverlayCache. (#3600)

Author: ehsannas

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

@@ -178,7 +178,7 @@ private void initializeUserComponents(User user) {
     // TODO(indexing): Add spec tests that test these components change after a user change
     indexManager = persistence.getIndexManager(user);
     mutationQueue = persistence.getMutationQueue(user, indexManager);
-    documentOverlayCache = persistence.getDocumentOverlay(user);
+    documentOverlayCache = persistence.getDocumentOverlayCache(user);
     localDocuments =
         new LocalDocumentsView(remoteDocuments, mutationQueue, documentOverlayCache, indexManager);
 

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

@@ -130,7 +130,7 @@ BundleCache getBundleCache() {
   }
 
   @Override
-  DocumentOverlayCache getDocumentOverlay(User user) {
+  DocumentOverlayCache getDocumentOverlayCache(User user) {
     MemoryDocumentOverlayCache overlay = overlays.get(user);
     if (overlay == null) {
       overlay = new MemoryDocumentOverlayCache();

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

@@ -92,7 +92,7 @@ public abstract class Persistence {
   abstract BundleCache getBundleCache();
 
   /** Returns a DocumentOverlayCache representing the documents that are mutated locally. */
-  abstract DocumentOverlayCache getDocumentOverlay(User user);
+  abstract DocumentOverlayCache getDocumentOverlayCache(User user);
 
   /** Returns a OverlayMigrationManager that runs any pending data migration required by SDK. */
   abstract OverlayMigrationManager getOverlayMigrationManager();

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

@@ -60,7 +60,7 @@ private void buildOverlays() {
             }
 
             // Recalculate and save overlays
-            DocumentOverlayCache documentOverlayCache = db.getDocumentOverlay(user);
+            DocumentOverlayCache documentOverlayCache = db.getDocumentOverlayCache(user);
             LocalDocumentsView localView =
                 new LocalDocumentsView(
                     remoteDocumentCache,

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

@@ -191,7 +191,7 @@ BundleCache getBundleCache() {
   }
 
   @Override
-  DocumentOverlayCache getDocumentOverlay(User user) {
+  DocumentOverlayCache getDocumentOverlayCache(User user) {
     return new SQLiteDocumentOverlayCache(this, this.serializer, user);
   }
 

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

@@ -61,7 +61,7 @@ public abstract class DocumentOverlayCacheTestCase {
   @Before
   public void setUp() {
     persistence = getPersistence();
-    cache = persistence.getDocumentOverlay(User.UNAUTHENTICATED);
+    cache = persistence.getDocumentOverlayCache(User.UNAUTHENTICATED);
   }
 
   @After

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

@@ -71,7 +71,7 @@ public class IndexBackfillerTest {
   public void setUp() {
     persistence = PersistenceTestHelpers.createSQLitePersistence();
     remoteDocumentCache = persistence.getRemoteDocumentCache();
-    documentOverlayCache = persistence.getDocumentOverlay(User.UNAUTHENTICATED);
+    documentOverlayCache = persistence.getDocumentOverlayCache(User.UNAUTHENTICATED);
     indexManager = persistence.getIndexManager(User.UNAUTHENTICATED);
     indexManager.start();
 

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

@@ -95,7 +95,7 @@ public void setUp() {
 
     indexManager = persistence.getIndexManager(User.UNAUTHENTICATED);
     mutationQueue = persistence.getMutationQueue(User.UNAUTHENTICATED, indexManager);
-    documentOverlayCache = persistence.getDocumentOverlay(User.UNAUTHENTICATED);
+    documentOverlayCache = persistence.getDocumentOverlayCache(User.UNAUTHENTICATED);
     remoteDocumentCache = persistence.getRemoteDocumentCache();
     targetCache = persistence.getTargetCache();
     queryEngine = new QueryEngine();

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

@@ -99,7 +99,7 @@ public void testCreateOverlayFromSet() {
     assertEquals(
         setMutation("foo/bar", map("foo", "bar")),
         persistence
-            .getDocumentOverlay(User.UNAUTHENTICATED)
+            .getDocumentOverlayCache(User.UNAUTHENTICATED)
             .getOverlay(key("foo/bar"))
             .getMutation());
     // Version is 0 because of remote document elision.
@@ -126,7 +126,7 @@ public void testCreateOverlayFromDelete() {
     assertEquals(
         deleteMutation("foo/bar"),
         persistence
-            .getDocumentOverlay(User.UNAUTHENTICATED)
+            .getDocumentOverlayCache(User.UNAUTHENTICATED)
             .getOverlay(key("foo/bar"))
             .getMutation());
     // Version is 0 because of remote document elision.
@@ -155,7 +155,7 @@ public void testCreateOverlayFromPatches() {
         new LocalStore(persistence, indexBackfiller, new QueryEngine(), User.UNAUTHENTICATED);
     localStore.start();
 
-    DocumentOverlayCache overlay = persistence.getDocumentOverlay(User.UNAUTHENTICATED);
+    DocumentOverlayCache overlay = persistence.getDocumentOverlayCache(User.UNAUTHENTICATED);
     assertEquals(
         mergeMutation("foo/bar", map("it", 2), Collections.emptyList()),
         overlay.getOverlay(key("foo/bar")).getMutation());
@@ -194,13 +194,13 @@ public void testCreateOverlayForDifferentUsers() {
     assertEquals(
         setMutation("foo/bar", map("foo", "set-by-unauthenticated")),
         persistence
-            .getDocumentOverlay(User.UNAUTHENTICATED)
+            .getDocumentOverlayCache(User.UNAUTHENTICATED)
             .getOverlay(key("foo/bar"))
             .getMutation());
     assertEquals(
         setMutation("foo/bar", map("foo", "set-by-another_user")),
         persistence
-            .getDocumentOverlay(new User("another_user"))
+            .getDocumentOverlayCache(new User("another_user"))
             .getOverlay(key("foo/bar"))
             .getMutation());