Bug 1291821 - Add onBatchComplete to a FetchRecordsDelegate r=rnewman

Intended to signal that a group of records have been fetched, and more are
to come after a pause.

MozReview-Commit-ID: 8ozZTc6aNdA

--HG--
extra : rebase_source : e2fdf70d6db6e242e65b788dcb6a09f975b5124b

mobile/android/services/src/main/java/org/mozilla/gecko/sync/middleware/Crypto5MiddlewareRepositorySession.java

@@ -114,6 +114,11 @@ public class Crypto5MiddlewareRepositorySession extends MiddlewareRepositorySess
       next.onFetchCompleted(fetchEnd);
     }
 
+    @Override
+    public void onBatchCompleted() {
+      next.onBatchCompleted();
+    }
+
     @Override
     public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
       // Synchronously perform *our* work, passing through appropriately.

mobile/android/services/src/main/java/org/mozilla/gecko/sync/repositories/delegates/DeferredRepositorySessionFetchRecordsDelegate.java

@@ -46,6 +46,16 @@ public class DeferredRepositorySessionFetchRecordsDelegate implements Repository
     });
   }
 
+  @Override
+  public void onBatchCompleted() {
+    executor.execute(new Runnable() {
+      @Override
+      public void run() {
+        inner.onBatchCompleted();
+      }
+    });
+  }
+
   @Override
   public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService newExecutor) {
     if (newExecutor == executor) {

mobile/android/services/src/main/java/org/mozilla/gecko/sync/repositories/delegates/RepositorySessionFetchRecordsDelegate.java

@@ -23,5 +23,11 @@ public interface RepositorySessionFetchRecordsDelegate {
    */
   public void onFetchCompleted(final long fetchEnd);
 
-  public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor);
+  /**
+   * Called when a number of records have been returned but more are still expected to come,
+   * possibly after a certain pause.
+   */
+  void onBatchCompleted();
+
+  RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor);
 }

mobile/android/services/src/main/java/org/mozilla/gecko/sync/synchronizer/RecordsChannel.java

@@ -216,6 +216,10 @@ public class RecordsChannel implements
     this.consumer.queueFilled();
   }
 
+  @Override
+  public void onBatchCompleted() {
+  }
+
   @Override
   public void onRecordStoreFailed(Exception ex, String recordGuid) {
     Logger.trace(LOG_TAG, "Failed to store record with guid " + recordGuid);

mobile/android/tests/background/junit3/src/org/mozilla/gecko/background/db/TestBookmarks.java

@@ -665,6 +665,11 @@ public class TestBookmarks extends AndroidSyncTestCase {
         public void onFetchCompleted(long end) {
           finishAndNotify(session);
         }
+
+        @Override
+        public void onBatchCompleted() {
+
+        }
       };
       session.fetchSince(0, fetchDelegate);
     }
@@ -695,6 +700,11 @@ public class TestBookmarks extends AndroidSyncTestCase {
         public void onFetchCompleted(long end) {
           finishAndNotify(session);
         }
+
+        @Override
+        public void onBatchCompleted() {
+
+        }
       };
       try {
         session.fetch(new String[] { guid }, fetchDelegate);

mobile/android/tests/background/junit3/src/org/mozilla/gecko/background/sync/TestStoreTracking.java

@@ -104,8 +104,18 @@ public class TestStoreTracking extends AndroidSyncTestCase {
                     performNotify(e);
                   }
                 }
+
+                @Override
+                public void onBatchCompleted() {
+
+                }
               });
             }
+
+            @Override
+            public void onBatchCompleted() {
+
+            }
           });
         } catch (InactiveSessionException e) {
           performNotify(e);
@@ -156,6 +166,11 @@ public class TestStoreTracking extends AndroidSyncTestCase {
                     performNotify(e);
                   }
                 }
+
+                @Override
+                public void onBatchCompleted() {
+
+                }
               });
             }
           });

mobile/android/tests/background/junit3/src/org/mozilla/gecko/background/sync/helpers/DefaultFetchDelegate.java

@@ -99,6 +99,11 @@ public class DefaultFetchDelegate extends DefaultDelegate implements RepositoryS
     Logger.debug(LOG_TAG, "onFetchCompleted. Doing nothing.");
   }
 
+  @Override
+  public void onBatchCompleted() {
+    Logger.debug(LOG_TAG, "onBatchCompleted. Doing nothing.");
+  }
+
   @Override
   public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(final ExecutorService executor) {
     return new DeferredRepositorySessionFetchRecordsDelegate(this, executor);

mobile/android/tests/background/junit4/src/org/mozilla/android/sync/test/SynchronizerHelpers.java

@@ -54,6 +54,11 @@ public class SynchronizerHelpers {
               delegate.onFetchCompleted(fetchEnd);
             }
 
+            @Override
+            public void onBatchCompleted() {
+
+            }
+
             @Override
             public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
               return this;

mobile/android/tests/background/junit4/src/org/mozilla/android/sync/test/helpers/ExpectSuccessRepositorySessionFetchRecordsDelegate.java

@@ -37,6 +37,11 @@ public class ExpectSuccessRepositorySessionFetchRecordsDelegate extends
     performNotify();
   }
 
+  @Override
+  public void onBatchCompleted() {
+    log("Batch completed.");
+  }
+
   @Override
   public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
     return this;

mobile/android/tests/background/junit4/src/org/mozilla/gecko/sync/repositories/downloaders/BatchingDownloaderDelegateTest.java

@@ -86,6 +86,11 @@ public class BatchingDownloaderDelegateTest {
 
         }
 
+        @Override
+        public void onBatchCompleted() {
+
+        }
+
         @Override
         public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
             return null;

mobile/android/tests/background/junit4/src/org/mozilla/gecko/sync/repositories/downloaders/BatchingDownloaderTest.java

@@ -52,6 +52,7 @@ public class BatchingDownloaderTest {
         public boolean isFailure;
         public boolean isFetched;
         public boolean isSuccess;
+        public int batchesCompleted;
         public Exception ex;
         public Record record;
 
@@ -73,6 +74,11 @@ public class BatchingDownloaderTest {
             this.isSuccess = true;
         }
 
+        @Override
+        public void onBatchCompleted() {
+            this.batchesCompleted += 1;
+        }
+
         @Override
         public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
             return null;