Review

Author: schmidt-sebastian

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

@@ -74,7 +74,7 @@ interface RemoteDocumentCache {
    * @param collectionGroup The collection group to scan.
    * @param offset The offset to start the scan at.
    * @param count The number of results to return.
-   * @return A map with next set of documents.
+   * @return A newly created map with next set of documents.
    */
   Map<DocumentKey, MutableDocument> getAll(String collectionGroup, IndexOffset offset, int count);
 
@@ -83,7 +83,7 @@ interface RemoteDocumentCache {
    *
    * @param collection The collection to read.
    * @param offset The read time and document key to start scanning at (exclusive).
-   * @return The set of matching documents.
+   * @return A newly created map with the set of documents in the collection.
    */
   Map<DocumentKey, MutableDocument> getAll(ResourcePath collection, IndexOffset offset);
 

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

@@ -226,8 +226,7 @@ private Map<DocumentKey, MutableDocument> getAll(
   }
 
   @Override
-  public Map<DocumentKey, MutableDocument> getAll(
-      final ResourcePath collection, IndexOffset offset) {
+  public Map<DocumentKey, MutableDocument> getAll(ResourcePath collection, IndexOffset offset) {
     return getAll(Collections.singletonList(collection), offset, Integer.MAX_VALUE);
   }
 

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

@@ -38,19 +38,19 @@
 class CountingQueryEngine implements QueryEngine {
   private final QueryEngine queryEngine;
 
-  private final int[] mutationsReadByQuery = new int[] {0};
+  private final int[] mutationsReadByCollection = new int[] {0};
   private final int[] mutationsReadByKey = new int[] {0};
-  private final int[] documentsReadByQuery = new int[] {0};
+  private final int[] documentsReadByCollection = new int[] {0};
   private final int[] documentsReadByKey = new int[] {0};
 
   CountingQueryEngine(QueryEngine queryEngine) {
     this.queryEngine = queryEngine;
   }
 
   void resetCounts() {
-    mutationsReadByQuery[0] = 0;
+    mutationsReadByCollection[0] = 0;
     mutationsReadByKey[0] = 0;
-    documentsReadByQuery[0] = 0;
+    documentsReadByCollection[0] = 0;
     documentsReadByKey[0] = 0;
   }
 
@@ -84,11 +84,11 @@ QueryEngine getSubject() {
   }
 
   /**
-   * Returns the number of documents returned by the RemoteDocumentCache's
-   * `getAll()` API (since the last call to `resetCounts()`)
+   * Returns the number of documents returned by the RemoteDocumentCache's `getAll()` API (since the
+   * last call to `resetCounts()`)
    */
-  int getDocumentsReadByColllection() {
-    return documentsReadByQuery[0];
+  int getDocumentsReadByCollection() {
+    return documentsReadByCollection[0];
   }
 
   /**
@@ -104,7 +104,7 @@ int getDocumentsReadByKey() {
    * `getAllMutationBatchesAffectingQuery()` API (since the last call to `resetCounts()`)
    */
   int getMutationsReadByCollection() {
-    return mutationsReadByQuery[0];
+    return mutationsReadByCollection[0];
   }
 
   /**
@@ -154,14 +154,14 @@ public Map<DocumentKey, MutableDocument> getAll(Iterable<DocumentKey> documentKe
       public Map<DocumentKey, MutableDocument> getAll(
           String collectionGroup, IndexOffset offset, int count) {
         Map<DocumentKey, MutableDocument> result = subject.getAll(collectionGroup, offset, count);
-        documentsReadByQuery[0] += result.size();
+        documentsReadByCollection[0] += result.size();
         return result;
       }
 
       @Override
       public Map<DocumentKey, MutableDocument> getAll(ResourcePath collection, IndexOffset offset) {
         Map<DocumentKey, MutableDocument> result = subject.getAll(collection, offset);
-        documentsReadByQuery[0] += result.size();
+        documentsReadByCollection[0] += result.size();
         return result;
       }
 
@@ -249,7 +249,7 @@ public List<MutationBatch> getAllMutationBatchesAffectingDocumentKeys(
       @Override
       public List<MutationBatch> getAllMutationBatchesAffectingQuery(Query query) {
         List<MutationBatch> result = subject.getAllMutationBatchesAffectingQuery(query);
-        mutationsReadByQuery[0] += result.size();
+        mutationsReadByCollection[0] += result.size();
         return result;
       }
 

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

@@ -331,7 +331,7 @@ private void assertRemoteDocumentsRead(int byKey, int byCollection) {
     assertEquals(
         "Remote documents read (by collection)",
         byCollection,
-        queryEngine.getDocumentsReadByColllection());
+        queryEngine.getDocumentsReadByCollection());
     assertEquals("Remote documents read (by key)", byKey, queryEngine.getDocumentsReadByKey());
   }