[Fix][SDK-575] Keep telemetry events during session (#362)

* fix: keep telemetry events during session,

dump method is replaced by getAll
this shouldn't be a problem for a user since this functions are new and expected to be used internally only

* fix: lint

* fix: revapi file

* fix: revapi file

Author: buongarzoni

.palantir/revapi.yml

@@ -50,3 +50,17 @@ acceptedBreaks:
         justification: "This is a binary compatible change, which could only break custom\
       \ implementations of our config interfaces, but those interfaces are not meant\
       \ to be implemented by users"
+  "2.2.0":
+    com.rollbar:rollbar-java:
+      - code: "java.method.removed"
+        old: "method java.util.List<com.rollbar.api.payload.data.TelemetryEvent> com.rollbar.notifier.telemetry.RollbarTelemetryEventTracker::dump()"
+        justification: "This method is replaced by getAll(), the interface is not meant to be\
+          \ implemented by users"
+      - code: "java.method.removed"
+        old: "method java.util.List<com.rollbar.api.payload.data.TelemetryEvent> com.rollbar.notifier.telemetry.TelemetryEventTracker::dump()"
+        justification: "This method is replaced by getAll(), the interface is not meant to be\
+          \ implemented by users"
+      - code: "java.method.addedToInterface"
+        new: "method java.util.List<com.rollbar.api.payload.data.TelemetryEvent> com.rollbar.notifier.telemetry.TelemetryEventTracker::getAll()"
+        justification: "This method replaces dump(), the interface is not meant to be implemented\
+          \ by users"

rollbar-java/src/main/java/com/rollbar/notifier/RollbarBase.java

@@ -353,7 +353,7 @@ protected RollbarThrowableWrapper wrapThrowable(Throwable error) {
   protected abstract RESULT sendPayload(C config, Payload payload);
 
   private Body makeBody(ThrowableWrapper error, String description) {
-    List<TelemetryEvent> telemetryEvents = telemetryEventTracker.dump();
+    List<TelemetryEvent> telemetryEvents = telemetryEventTracker.getAll();
     if (telemetryEvents.isEmpty()) {
       return bodyFactory.from(error, description);
     }

rollbar-java/src/main/java/com/rollbar/notifier/telemetry/RollbarTelemetryEventTracker.java

@@ -57,10 +57,8 @@ public RollbarTelemetryEventTracker(
   }
 
   @Override
-  public List<TelemetryEvent> dump() {
-    List<TelemetryEvent> events = new ArrayList<>(telemetryEvents);
-    telemetryEvents.clear();
-    return events;
+  public List<TelemetryEvent> getAll() {
+    return new ArrayList<>(telemetryEvents);
   }
 
   @Override

rollbar-java/src/main/java/com/rollbar/notifier/telemetry/TelemetryEventTracker.java

@@ -16,9 +16,9 @@
 public interface TelemetryEventTracker {
 
   /**
-   * Dump all the events recorded.
+   * Get all the events recorded.
    */
-  List<TelemetryEvent> dump();
+  List<TelemetryEvent> getAll();
 
   /**
    * Record log telemetry event. ({@link TelemetryType#LOG}).

rollbar-java/src/test/java/com/rollbar/notifier/telemetry/RollbarTelemetryEventTrackerTest.java

@@ -32,13 +32,23 @@ public class RollbarTelemetryEventTrackerTest {
   private static final int MINIMUM_CAPACITY_FOR_TELEMETRY_EVENTS = 0;
   private static final int MAXIMUM_CAPACITY_FOR_TELEMETRY_EVENTS = 100;
 
+  @Test
+  public void shouldKeepAllTheEventsDuringSessionIfGetAllIsInvoked() {
+    telemetryEventTracker.recordManualEventFor(LEVEL, SOURCE, MESSAGE);
+
+    List<TelemetryEvent> telemetryEventsFirstCall = telemetryEventTracker.getAll();
+    List<TelemetryEvent> telemetryEventsSecondCall = telemetryEventTracker.getAll();
+
+    assertThat(telemetryEventsFirstCall, is(telemetryEventsSecondCall));
+  }
+
   @Test
   public void shouldDiscardOldestEventsWhenMaxCapacityIsReached() {
     telemetryEventTracker.recordManualEventFor(LEVEL, SOURCE, MESSAGE);
     telemetryEventTracker.recordLogEventFor(LEVEL, SOURCE, MESSAGE);
     telemetryEventTracker.recordLogEventFor(LEVEL, SOURCE, MESSAGE);
 
-    List<TelemetryEvent> telemetryEvents = telemetryEventTracker.dump();
+    List<TelemetryEvent> telemetryEvents = telemetryEventTracker.getAll();
 
     assertThat(telemetryEvents.size(), is(MAXIMUM_TELEMETRY_DATA));
     verifyContainsOnlyLogEvents(telemetryEvents);
@@ -84,7 +94,7 @@ public void shouldTrackANetworkEvent() {
   public void shouldSetTheMaximumTelemetryDataLimitedToItsLowerLimit() {
     TelemetryEventTracker telemetryEventTracker = newEventTracker(MINIMUM_CAPACITY_FOR_TELEMETRY_EVENTS - 1);
 
-    List<TelemetryEvent> telemetryEvents = record70EventsAndDump(telemetryEventTracker);
+    List<TelemetryEvent> telemetryEvents = record101EventsAndDump(telemetryEventTracker);
 
     assertThat(telemetryEvents.size(), is(MINIMUM_CAPACITY_FOR_TELEMETRY_EVENTS));
   }
@@ -93,7 +103,7 @@ public void shouldSetTheMaximumTelemetryDataLimitedToItsLowerLimit() {
   public void shouldSetTheMaximumTelemetryDataLimitedToItsUpperLimit() {
     TelemetryEventTracker telemetryEventTracker = newEventTracker(MAXIMUM_CAPACITY_FOR_TELEMETRY_EVENTS + 1);
 
-    List<TelemetryEvent> telemetryEvents = record70EventsAndDump(telemetryEventTracker);
+    List<TelemetryEvent> telemetryEvents = record101EventsAndDump(telemetryEventTracker);
 
     assertThat(telemetryEvents.size(), is(MAXIMUM_CAPACITY_FOR_TELEMETRY_EVENTS));
   }
@@ -103,7 +113,7 @@ public void shouldSetTheMaximumTelemetryDataLimitedToAValueBetweenBounds() {
     int maximumTelemetryEvents = 20;
     TelemetryEventTracker telemetryEventTracker = newEventTracker(maximumTelemetryEvents);
 
-    List<TelemetryEvent> telemetryEvents = record70EventsAndDump(telemetryEventTracker);
+    List<TelemetryEvent> telemetryEvents = record101EventsAndDump(telemetryEventTracker);
 
     assertThat(telemetryEvents.size(), is(maximumTelemetryEvents));
   }
@@ -115,19 +125,19 @@ private TelemetryEventTracker newEventTracker(int maximumTelemetryData) {
     );
   }
 
-  private List<TelemetryEvent> record70EventsAndDump(TelemetryEventTracker telemetryEventTracker) {
-    for (int i = 0; i < 120; i++) {
+  private List<TelemetryEvent> record101EventsAndDump(TelemetryEventTracker telemetryEventTracker) {
+    for (int i = 0; i < 101; i++) {
       telemetryEventTracker.recordManualEventFor(LEVEL, SOURCE, MESSAGE);
     }
-    return telemetryEventTracker.dump();
+    return telemetryEventTracker.getAll();
   }
 
   private Map<String, Object> getTrackedEventAsJson() {
     return getFirstEvent().asJson();
   }
 
   private TelemetryEvent getFirstEvent() {
-    return telemetryEventTracker.dump().get(0);
+    return telemetryEventTracker.getAll().get(0);
   }
 
   private Map<String, Object> getExpectedJsonForALogTelemetryEvent() {