update

Author: VinayGuthal

firebase-common/src/main/java/com/google/firebase/heartbeatinfo/DefaultHeartBeatController.java

@@ -150,7 +150,8 @@ private DefaultHeartBeatController(
   }
 
   @Override
-  @NonNull public HeartBeat getHeartBeatCode(@NonNull String heartBeatTag) {
+  @NonNull
+  public HeartBeat getHeartBeatCode(@NonNull String heartBeatTag) {
     long presentTime = System.currentTimeMillis();
     HeartBeatInfoStorage storage = storageProvider.get();
     boolean shouldSendGlobalHB = storage.shouldSendGlobalHeartBeat(presentTime);

firebase-common/src/main/java/com/google/firebase/heartbeatinfo/HeartBeatInfoStorage.java

@@ -101,7 +101,7 @@ synchronized void removeStoredDate(String dateString) {
     // Find stored heartbeat and clear it.
     String userAgentString = null;
     for (Map.Entry<String, ?> entry : firebaseSharedPreferences.getAll().entrySet()) {
-      if(userAgentString != null) {
+      if (userAgentString != null) {
         break;
       }
       if (entry.getValue() instanceof Set) {
@@ -114,12 +114,12 @@ synchronized void removeStoredDate(String dateString) {
         }
       }
     }
-    if(userAgentString == null) {
+    if (userAgentString == null) {
       return;
     }
     Set<String> userAgentDateSet =
-            new HashSet<String>(
-                    firebaseSharedPreferences.getStringSet(userAgentString, new HashSet<String>()));
+        new HashSet<String>(
+            firebaseSharedPreferences.getStringSet(userAgentString, new HashSet<String>()));
     userAgentDateSet.remove(dateString);
     if (userAgentDateSet.isEmpty()) {
       firebaseSharedPreferences.edit().remove(userAgentString).commit();

firebase-common/src/test/java/com/google/firebase/heartbeatinfo/DefaultHeartBeatControllerTest.java

@@ -23,9 +23,9 @@
 import static org.mockito.Mockito.when;
 
 import android.content.Context;
-
+import android.content.SharedPreferences;
 import androidx.test.core.app.ApplicationProvider;
-
+import androidx.test.runner.AndroidJUnit4;
 import com.google.firebase.platforminfo.UserAgentPublisher;
 import java.util.ArrayList;
 import java.util.Base64;
@@ -37,21 +37,22 @@
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
+import org.json.JSONArray;
 import org.json.JSONException;
+import org.json.JSONObject;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
 
-@RunWith(JUnit4.class)
+@RunWith(AndroidJUnit4.class)
 public class DefaultHeartBeatControllerTest {
   private ExecutorService executor;
   private TestOnCompleteListener<Void> storeOnCompleteListener;
   private TestOnCompleteListener<String> getOnCompleteListener;
   private final String DEFAULT_USER_AGENT = "agent1";
   private HeartBeatInfoStorage storage = mock(HeartBeatInfoStorage.class);
   private UserAgentPublisher publisher = mock(UserAgentPublisher.class);
-  private static Context applicationContext = mock(Context.class);
+  private static Context applicationContext = ApplicationProvider.getApplicationContext();
   private final Set<HeartBeatConsumer> logSources =
       new HashSet<HeartBeatConsumer>() {
         {
@@ -67,13 +68,15 @@ public void setUp() {
     storeOnCompleteListener = new TestOnCompleteListener<>();
     getOnCompleteListener = new TestOnCompleteListener<>();
     heartBeatController =
-        new DefaultHeartBeatController(() -> storage, logSources, executor, () -> publisher, applicationContext);
+        new DefaultHeartBeatController(
+            () -> storage, logSources, executor, () -> publisher, applicationContext);
   }
 
   @Test
   public void whenNoSource_dontStoreHeartBeat() throws ExecutionException, InterruptedException {
     DefaultHeartBeatController controller =
-        new DefaultHeartBeatController(() -> storage, new HashSet<>(), executor, () -> publisher, applicationContext);
+        new DefaultHeartBeatController(
+            () -> storage, new HashSet<>(), executor, () -> publisher, applicationContext);
     controller.registerHeartBeat().addOnCompleteListener(executor, storeOnCompleteListener);
     storeOnCompleteListener.await();
     verify(storage, times(0)).storeHeartBeat(anyLong(), anyString());
@@ -110,9 +113,58 @@ public void generateHeartBeat_oneHeartBeat()
     String expected =
         Base64.getEncoder()
             .encodeToString(
-                "{\"heartbeats\":[{\"date\":[\"2015-02-03\"],\"agent\":\"test-agent\"}],\"version\":\"2\"}"
+                "{\"heartbeats\":[{\"agent\":\"test-agent\",\"date\":\"[2015-02-03]\"}],\"version\":\"2\"}"
                     .getBytes());
-    assertThat(getOnCompleteListener.await()).isEqualTo(expected);
+    assertThat(getOnCompleteListener.await().replace("\n", "")).isEqualTo(expected);
+  }
+
+  @Test
+  public void firstNewThenOld_synchronizedCorrectly()
+      throws ExecutionException, InterruptedException {
+    Context context = ApplicationProvider.getApplicationContext();
+    SharedPreferences heartBeatSharedPreferences =
+        context.getSharedPreferences("testHeartBeat", Context.MODE_PRIVATE);
+    HeartBeatInfoStorage heartBeatInfoStorage =
+        new HeartBeatInfoStorage(heartBeatSharedPreferences);
+    DefaultHeartBeatController controller =
+        new DefaultHeartBeatController(
+            () -> heartBeatInfoStorage, logSources, executor, () -> publisher, context);
+    String emptyString =
+        Base64.getEncoder().encodeToString("{\"heartbeats\":[],\"version\":\"2\"}".getBytes());
+    controller.registerHeartBeat().addOnCompleteListener(executor, storeOnCompleteListener);
+    storeOnCompleteListener.await();
+    controller.getHeartBeatsHeader().addOnCompleteListener(executor, getOnCompleteListener);
+    String output = getOnCompleteListener.await();
+    assertThat(output.replace("\n", "")).isNotEqualTo(emptyString);
+    int heartBeatCode = controller.getHeartBeatCode("test").getCode();
+    assertThat(heartBeatCode).isEqualTo(0);
+  }
+
+  @Test
+  public void firstOldThenNew_synchronizedCorrectly()
+      throws ExecutionException, InterruptedException {
+    Context context = ApplicationProvider.getApplicationContext();
+    SharedPreferences heartBeatSharedPreferences =
+        context.getSharedPreferences("testHeartBeat", Context.MODE_PRIVATE);
+    HeartBeatInfoStorage heartBeatInfoStorage =
+        new HeartBeatInfoStorage(heartBeatSharedPreferences);
+    DefaultHeartBeatController controller =
+        new DefaultHeartBeatController(
+            () -> heartBeatInfoStorage, logSources, executor, () -> publisher, context);
+    String emptyString =
+        Base64.getEncoder().encodeToString("{\"heartbeats\":[],\"version\":\"2\"}".getBytes());
+    controller.registerHeartBeat().addOnCompleteListener(executor, storeOnCompleteListener);
+    storeOnCompleteListener.await();
+    int heartBeatCode = controller.getHeartBeatCode("test").getCode();
+    assertThat(heartBeatCode).isEqualTo(2);
+    controller.getHeartBeatsHeader().addOnCompleteListener(executor, getOnCompleteListener);
+    String output = getOnCompleteListener.await();
+    assertThat(output.replace("\n", "")).isEqualTo(emptyString);
+    controller.registerHeartBeat().addOnCompleteListener(executor, storeOnCompleteListener);
+    storeOnCompleteListener.await();
+    controller.getHeartBeatsHeader().addOnCompleteListener(executor, getOnCompleteListener);
+    output = getOnCompleteListener.await();
+    assertThat(output.replace("\n", "")).isEqualTo(emptyString);
   }
 
   @Test
@@ -136,12 +188,17 @@ public void generateHeartBeat_twoHeartBeatsSameUserAgent()
     heartBeatController
         .getHeartBeatsHeader()
         .addOnCompleteListener(executor, getOnCompleteListener);
-    String expected =
-        Base64.getEncoder()
-            .encodeToString(
-                "{\"heartbeats\":[{\"date\":[\"2015-03-02\",\"2015-03-01\"],\"agent\":\"test-agent\"}],\"version\":\"2\"}"
-                    .getBytes());
-    assertThat(getOnCompleteListener.await()).isEqualTo(expected);
+    JSONObject output = new JSONObject();
+    JSONArray array = new JSONArray();
+    JSONObject obj = new JSONObject();
+    ;
+    obj.put("agent", "test-agent");
+    obj.put("date", dateList);
+    array.put(obj);
+    output.put("heartbeats", array);
+    output.put("version", "2");
+    String expected = Base64.getEncoder().encodeToString(output.toString().getBytes());
+    assertThat(getOnCompleteListener.await().replace("\n", "")).isEqualTo(expected);
   }
 
   @Test
@@ -170,8 +227,8 @@ public void generateHeartBeat_twoHeartBeatstwoUserAgents()
     String expected =
         Base64.getEncoder()
             .encodeToString(
-                "{\"heartbeats\":[{\"date\":[\"2015-03-02\"],\"agent\":\"test-agent\"},{\"date\":[\"2015-03-03\"],\"agent\":\"test-agent-1\"}],\"version\":\"2\"}"
+                "{\"heartbeats\":[{\"agent\":\"test-agent\",\"date\":\"[2015-03-02]\"},{\"agent\":\"test-agent-1\",\"date\":\"[2015-03-03]\"}],\"version\":\"2\"}"
                     .getBytes());
-    assertThat(getOnCompleteListener.await()).isEqualTo(expected);
+    assertThat(getOnCompleteListener.await().replace("\n", "")).isEqualTo(expected);
   }
 }