Added javadocs renamed RequestSequence to RequestSequenceRecorder

Author: Sayaan Saha

AndroidSDKCore/src/main/java/com/leanplum/internal/Request.java

@@ -59,7 +59,7 @@ public class Request {
   private static final long DEVELOPMENT_MIN_DELAY_MS = 100;
   private static final long DEVELOPMENT_MAX_DELAY_MS = 5000;
   private static final long PRODUCTION_DELAY = 60000;
-  private RequestSequence requestSequence;
+  private RequestSequenceRecorder requestSequenceRecorder;
   static final int MAX_EVENTS_PER_API_CALL;
   static final String LEANPLUM = "__leanplum__";
   static final String UUID_KEY = "uuid";
@@ -165,7 +165,7 @@ public static void saveToken() {
     SharedPreferencesUtil.commitChanges(editor);
   }
 
-  private static class NoRequestSequence implements RequestSequence {
+  private static class NoRequestSequenceRecorder implements RequestSequenceRecorder {
     @Override
     public void beforeRead() {
       // No op.
@@ -200,10 +200,10 @@ public static String userId() {
   }
 
   public Request(String httpMethod, String apiMethod, Map<String, Object> params) {
-    this(httpMethod, apiMethod, params, new NoRequestSequence());
+    this(httpMethod, apiMethod, params, new NoRequestSequenceRecorder());
   }
 
-  Request(String httpMethod, String apiMethod, Map<String, Object> params, RequestSequence requestSequence) {
+  Request(String httpMethod, String apiMethod, Map<String, Object> params, RequestSequenceRecorder requestSequenceRecorder) {
     this.httpMethod = httpMethod;
     this.apiMethod = apiMethod;
     this.params = params != null ? params : new HashMap<String, Object>();
@@ -214,7 +214,7 @@ public Request(String httpMethod, String apiMethod, Map<String, Object> params)
     // Make sure the Handler is initialized on the main thread.
     OsHandler.getInstance();
     dataBaseIndex = -1;
-    this.requestSequence = requestSequence;
+    this.requestSequenceRecorder = requestSequenceRecorder;
   }
 
   public static Request get(String apiMethod, Map<String, Object> params) {
@@ -260,7 +260,7 @@ private Map<String, Object> createArgsDictionary() {
 
   private void saveRequestForLater(Map<String, Object> args) {
     try {
-      requestSequence.beforeWrite();
+      requestSequenceRecorder.beforeWrite();
 
       synchronized (Request.class) {
         Context context = Leanplum.getContext();
@@ -286,7 +286,7 @@ private void saveRequestForLater(Map<String, Object> args) {
         }
       }
 
-      requestSequence.afterWrite();
+      requestSequenceRecorder.afterWrite();
     } catch (Throwable t) {
       Util.handleException(t);
     }
@@ -581,11 +581,11 @@ private RequestsWithEncoding getRequestsWithEncodedString() {
   }
 
   private void sendRequests() {
-    requestSequence.beforeRead();
+    requestSequenceRecorder.beforeRead();
 
     RequestsWithEncoding requestsWithEncoding = getRequestsWithEncodedString();
 
-    requestSequence.afterRead();
+    requestSequenceRecorder.afterRead();
 
     List<Map<String, Object>> unsentRequests = requestsWithEncoding.unsentRequests;
     List<Map<String, Object>> requestsToSend = requestsWithEncoding.requestsToSend;

AndroidSDKCore/src/main/java/com/leanplum/internal/RequestSequence.java

@@ -0,0 +1,28 @@
+package com.leanplum.internal;
+
+/**
+ * Records request call sequence of read/write operations to database.
+ *
+ */
+
+public interface RequestSequenceRecorder {
+  /**
+   * Executes before database read in Request.
+   */
+  void beforeRead();
+
+  /**
+   * Executes after database read in Request.
+   */
+  void afterRead();
+
+  /**
+   * Executes before database write in Request.
+   */
+  void beforeWrite();
+
+  /**
+   * Executes after database write in Request.
+   */
+  void afterWrite();
+}

AndroidSDKCore/src/main/java/com/leanplum/internal/RequestSequenceRecorder.java

@@ -80,8 +80,8 @@ public void shouldWriteRequestAndSendInSequence() throws InterruptedException {
     Map<String, Object> params = new HashMap<>();
     params.put("data1", "value1");
     params.put("data2", "value2");
-    final ThreadRequestSequence threadRequestSequence = new ThreadRequestSequence();
-    Request request = new Request(POST, Constants.Methods.START, params, threadRequestSequence);
+    final ThreadRequestSequenceRecorder threadRequestSequenceRecorder = new ThreadRequestSequenceRecorder();
+    Request request = new Request(POST, Constants.Methods.START, params, threadRequestSequenceRecorder);
     request.setAppId("fskadfshdbfa", "wee5w4waer422323");
 
     new Thread(new Runnable() {
@@ -92,17 +92,17 @@ public void run() {
         } catch (InterruptedException e) {
           throw new RuntimeException(e);
         }
-        threadRequestSequence.writeSemaphore.release(1);
+        threadRequestSequenceRecorder.writeSemaphore.release(1);
       }
     }).start();
 
-    // When the request is sent.
+    // Then the request is written to the local db first, and then read and sent.
     request.sendIfConnected();
 
-    threadRequestSequence.testThreadSemaphore.tryAcquire(5000, TimeUnit.MILLISECONDS);
+    threadRequestSequenceRecorder.testThreadSemaphore.tryAcquire(5000, TimeUnit.MILLISECONDS);
 
     // When the request is sent.
-    threadRequestSequence.assertCallSequence();
+    threadRequestSequenceRecorder.assertCallSequence();
   }
   /**
    * Tests the testRemoveIrrelevantBackgroundStartRequests method.
@@ -360,7 +360,7 @@ private List<Map<String, Object>> mockRequests(int requestSize) {
     return requests;
   }
 
-  private static class ThreadRequestSequence implements RequestSequence {
+  private static class ThreadRequestSequenceRecorder implements RequestSequenceRecorder {
     Instant beforeReadTime, afterReadTime, beforeWriteTime, afterWriteTime;
     final Semaphore writeSemaphore = new Semaphore(0);
     final Semaphore readSemaphore = new Semaphore(1);
@@ -369,8 +369,10 @@ private static class ThreadRequestSequence implements RequestSequence {
     @Override
     public void beforeRead() {
       try {
-        readSemaphore.tryAcquire();
+        readSemaphore.tryAcquire(10, TimeUnit.SECONDS);
         beforeReadTime = Instant.now();
+      } catch (InterruptedException e) {
+        throw new RuntimeException(e);
       } finally {
         readSemaphore.release();
       }
@@ -386,7 +388,7 @@ public void afterRead() {
     public void beforeWrite() {
       // since we are blocking on main thread
       try {
-        writeSemaphore.tryAcquire();
+        writeSemaphore.tryAcquire(10, TimeUnit.SECONDS);
         Thread.sleep(2000);
       } catch (InterruptedException e) {
         throw new RuntimeException(e);