refactor: set source as an enum

rollbar-api/src/main/java/com/rollbar/api/payload/data/Source.java

@@ -0,0 +1,19 @@
+package com.rollbar.api.payload.data;
+
+import com.rollbar.api.json.JsonSerializable;
+
+public enum Source implements JsonSerializable {
+  CLIENT("client"),
+  SERVER("server");
+
+  private final String jsonName;
+
+  Source(String jsonName) {
+    this.jsonName = jsonName;
+  }
+
+  @Override
+  public Object asJson() {
+    return jsonName;
+  }
+}

rollbar-api/src/main/java/com/rollbar/api/payload/data/TelemetryEvent.java

@@ -17,14 +17,14 @@ public class TelemetryEvent implements JsonSerializable, StringTruncatable<Telem
   private final Level level;
   private final Long timestamp;
   private final Map<String, String> body;
-  private final String source;
+  private final Source source;
   private static final long serialVersionUID = 2843361810242481727L;
 
   public TelemetryEvent(
       TelemetryType telemetryType,
       Level level,
       Long timestamp,
-      String source,
+      Source source,
       Map<String, String> body
   ) {
     type = telemetryType;
@@ -39,7 +39,7 @@ public Map<String, Object> asJson() {
     Map<String, Object> values = new HashMap<>();
     values.put("type", type.asJson());
     values.put("level", level.asJson());
-    values.put("source", source);
+    values.put("source", source.asJson());
     values.put("timestamp_ms", timestamp);
     values.put("body", body);
     return values;

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

@@ -4,6 +4,7 @@
 import com.rollbar.api.payload.Payload;
 import com.rollbar.api.payload.data.Data;
 import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
 import com.rollbar.api.payload.data.TelemetryEvent;
 import com.rollbar.api.payload.data.TelemetryType;
 import com.rollbar.api.payload.data.body.Body;
@@ -340,12 +341,12 @@ private Body makeBody(ThrowableWrapper error, String description) {
     return bodyFactory.from(error, description, telemetryEvents);
   }
 
-  private String getSource() {
+  private Source getSource() {
     String platform = config.platform();
     if ("android".equals(platform)) {
-      return "client";
+      return Source.CLIENT;
     } else {
-      return "server";
+      return Source.SERVER;
     }
   }
 }

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

@@ -1,6 +1,7 @@
 package com.rollbar.notifier.telemetry;
 
 import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
 import com.rollbar.api.payload.data.TelemetryEvent;
 import com.rollbar.api.payload.data.TelemetryType;
 import com.rollbar.notifier.provider.Provider;
@@ -43,7 +44,7 @@ public List<TelemetryEvent> dump() {
    * @param level   the TelemetryEvent severity (e.g. {@link Level#DEBUG}).
    * @param message the message sent for this event (e.g. "hello world").
    */
-  public void recordLogEventFor(Level level, String source, String message) {
+  public void recordLogEventFor(Level level, Source source, String message) {
     Map<String, String> body = new HashMap<>();
     body.put(LOG_KEY_MESSAGE, message);
     addEvent(new TelemetryEvent(TelemetryType.LOG, level, timestampProvider.provide(), source, body));
@@ -55,7 +56,7 @@ public void recordLogEventFor(Level level, String source, String message) {
    * @param level   the TelemetryEvent severity (e.g. {@link Level#DEBUG}).
    * @param message the message sent for this event (e.g. "hello world").
    */
-  public void recordManualEventFor(Level level, String source, String message) {
+  public void recordManualEventFor(Level level, Source source, String message) {
     Map<String, String> body = new HashMap<>();
     body.put(LOG_KEY_MESSAGE, message);
     addEvent(new TelemetryEvent(TelemetryType.MANUAL, level, timestampProvider.provide(), source, body));
@@ -68,7 +69,7 @@ public void recordManualEventFor(Level level, String source, String message) {
    * @param from  the starting point (e.g. "SettingView").
    * @param to    the destination point (e.g. "HomeView").
    */
-  public void recordNavigationEventFor(Level level, String source, String from, String to) {
+  public void recordNavigationEventFor(Level level, Source source, String from, String to) {
     Map<String, String> body = new HashMap<>();
     body.put(NAVIGATION_KEY_FROM, from);
     body.put(NAVIGATION_KEY_TO, to);
@@ -83,7 +84,7 @@ public void recordNavigationEventFor(Level level, String source, String from, St
    * @param url        the api url (e.g. "<a href="http://rollbar.com/test/api">http://rollbar.com/test/api</a>").
    * @param statusCode the response status code (e.g. "404").
    */
-  public void recordNetworkEventFor(Level level, String source, String method, String url, String statusCode) {
+  public void recordNetworkEventFor(Level level, Source source, String method, String url, String statusCode) {
     Map<String, String> body = new HashMap<>();
     body.put(NETWORK_KEY_METHOD, method);
     body.put(NETWORK_KEY_URL, url);

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

@@ -1,14 +1,15 @@
 package com.rollbar.notifier.telemetry;
 
 import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
 import com.rollbar.api.payload.data.TelemetryEvent;
 
 import java.util.List;
 
 public interface TelemetryEventTracker {
   List<TelemetryEvent> dump();
-  void recordLogEventFor(Level level, String source, String message);
-  void recordManualEventFor(Level level, String source, String message);
-  void recordNavigationEventFor(Level level, String source, String from, String to);
-  void recordNetworkEventFor(Level level, String source, String method, String url, String statusCode);
+  void recordLogEventFor(Level level, Source source, String message);
+  void recordManualEventFor(Level level, Source source, String message);
+  void recordNavigationEventFor(Level level, Source source, String from, String to);
+  void recordNetworkEventFor(Level level, Source source, String method, String url, String statusCode);
 }

rollbar-java/src/test/java/com/rollbar/notifier/RollbarBaseTest.java

@@ -6,6 +6,7 @@
 
 import com.rollbar.api.payload.Payload;
 import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
 import com.rollbar.notifier.config.Config;
 import com.rollbar.notifier.telemetry.TelemetryEventTracker;
 import com.rollbar.notifier.util.BodyFactory;
@@ -35,7 +36,7 @@ public void shouldRecordALogEventWithServerSourceWhenThePlatformIsNotAndroid() {
 
     sut.recordLogEventFor(level, message);
 
-    verify(telemetryEventTracker).recordLogEventFor(level, "server", message);
+    verify(telemetryEventTracker).recordLogEventFor(level, Source.SERVER, message);
   }
 
   @Test
@@ -45,7 +46,7 @@ public void shouldRecordALogEventWithClientSourceWhenThePlatformIsAndroid() {
 
     sut.recordLogEventFor(level, message);
 
-    verify(telemetryEventTracker).recordLogEventFor(level, "client", message);
+    verify(telemetryEventTracker).recordLogEventFor(level, Source.CLIENT, message);
   }
 
   @Test
@@ -55,7 +56,7 @@ public void shouldRecordAManualEventWithServerSourceWhenThePlatformIsNotAndroid(
 
     sut.recordManualEventFor(level, message);
 
-    verify(telemetryEventTracker).recordManualEventFor(level, "server", message);
+    verify(telemetryEventTracker).recordManualEventFor(level, Source.SERVER, message);
   }
 
   @Test
@@ -65,7 +66,7 @@ public void shouldRecordAManualEventWithClientSourceWhenThePlatformIsAndroid() {
 
     sut.recordManualEventFor(level, message);
 
-    verify(telemetryEventTracker).recordManualEventFor(level, "client", message);
+    verify(telemetryEventTracker).recordManualEventFor(level, Source.CLIENT, message);
   }
 
   @Test
@@ -77,7 +78,7 @@ public void shouldRecordANetworkEventWithServerSourceWhenThePlatformIsNotAndroid
 
     sut.recordNetworkEventFor(level, method, url, statusCode);
 
-    verify(telemetryEventTracker).recordNetworkEventFor(level, "server", method, url, statusCode);
+    verify(telemetryEventTracker).recordNetworkEventFor(level, Source.SERVER, method, url, statusCode);
   }
 
   @Test
@@ -89,7 +90,7 @@ public void shouldRecordANetworkEventWithClientSourceWhenThePlatformIsAndroid()
 
     sut.recordNetworkEventFor(level, method, url, statusCode);
 
-    verify(telemetryEventTracker).recordNetworkEventFor(level, "client", method, url, statusCode);
+    verify(telemetryEventTracker).recordNetworkEventFor(level, Source.CLIENT, method, url, statusCode);
   }
 
   @Test
@@ -100,7 +101,7 @@ public void shouldRecordANavigationEventWithServerSourceWhenThePlatformIsNotAndr
 
     sut.recordNavigationEventFor(level, from, to);
 
-    verify(telemetryEventTracker).recordNavigationEventFor(level, "server", from, to);
+    verify(telemetryEventTracker).recordNavigationEventFor(level, Source.SERVER, from, to);
   }
 
   @Test
@@ -111,7 +112,7 @@ public void shouldRecordANavigationEventWithClientSourceWhenThePlatformIsAndroid
 
     sut.recordNavigationEventFor(level, from, to);
 
-    verify(telemetryEventTracker).recordNavigationEventFor(level, "client", from, to);
+    verify(telemetryEventTracker).recordNavigationEventFor(level, Source.CLIENT, from, to);
   }
 
   private Config getConfigWith(String platform) {

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

@@ -4,6 +4,7 @@
 import static org.junit.Assert.*;
 
 import com.rollbar.api.payload.data.Level;
+import com.rollbar.api.payload.data.Source;
 import com.rollbar.api.payload.data.TelemetryEvent;
 import com.rollbar.api.payload.data.TelemetryType;
 import com.rollbar.notifier.provider.timestamp.TimestampProvider;
@@ -16,7 +17,7 @@
 
 public class RollbarTelemetryEventTrackerTest {
 
-  private static final String SOURCE = "Any source";
+  private static final Source SOURCE = Source.SERVER;
   private static final String MESSAGE = "Any message";
   private static final String FROM = "Any origin";
   private static final String TO = "Any destination";
@@ -138,7 +139,7 @@ private Map<String, Object> getExpectedJsonForANetworkTelemetryEvent() {
   private Map<String, Object> commonFields() {
     Map<String, Object> map = new HashMap<>();
     map.put("level", LEVEL.asJson());
-    map.put("source", SOURCE);
+    map.put("source", SOURCE.asJson());
     map.put("timestamp_ms", TIMESTAMP);
     return map;
   }