Merge pull request #26 from exceptionless/testing

Nits

Author: pc9795

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+1. Use `google-java-format` for code formatting.
+2. Use wrapper classes instead of primitives. For example, use `Integer` in place of `int`. It helps us in distinguishing, when a value is not set.
+3. Use `@Builder` based object construction instead of `new`.
+4. Using `lombok` annotations for any new classes.
+5. All hardcoded constants appear as a `private static final` variables at the top of the class.

src/main/java/com/exceptionless/exceptionlessclient/configuration/Configuration.java

@@ -7,7 +7,24 @@
 import java.beans.PropertyChangeSupport;
 
 public class Configuration {
-  public static final String USER_AGENT = "exceptionless-java";
+  private static final String DEFAULT_SERVER_URL = "https://collector.exceptionless.io";
+  private static final String DEFAULT_HEARTBEAT_SERVER_URL = "https://heartbeat.exceptionless.io";
+  private static final Long DEFAULT_UPDATE_SETTINGS_WHEN_IDLE_INTERVAL = 12000L;
+  private static final Integer DEFAULT_SUBMISSION_BATCH_SIZE = 50;
+  private static final Integer DEFAULT_SUBMISSION_CLIENT_TIMEOUT_IN_MILLIS = 500;
+  private static final Integer DEFAULT_SETTINGS_CLIENT_TIMEOUT_IN_MILLIS = 500;
+
+  public static class Property {
+    public static final String API_KEY = "apiKey";
+    public static final String SERVER_URL = "serverUrl";
+    public static final String HEART_BEAT_SERVER_URL = "heartbeatServerUrl";
+    public static final String UPDATE_SETTINGS_WHEN_IDLE_INTERVAL =
+        "updateSettingsWhenIdleInterval";
+    public static final String SUBMISSION_BATCH_SIZE = "submissionBatchSize";
+    public static final String SUBMISSION_CLIENT_TIMEOUT_IN_MILLIS =
+        "submissionClientTimeoutInMillis";
+    public static final String SETTINGS_CLIENT_TIMEOUT_IN_MILLIS = "settingsClientTimeoutInMillis";
+  }
 
   @Getter private String apiKey;
   @Getter private String serverUrl;
@@ -29,18 +46,25 @@ public Configuration(
       Integer submissionClientTimeoutInMillis,
       Integer settingsClientTimeoutInMillis) {
     this.apiKey = apiKey;
-    this.serverUrl = serverUrl == null ? "https://collector.exceptionless.io" : serverUrl;
+    this.serverUrl = serverUrl == null ? DEFAULT_SERVER_URL : serverUrl;
     this.heartbeatServerUrl =
         heartbeatServerUrl == null
-            ? (serverUrl == null ? "https://heartbeat.exceptionless.io" : serverUrl)
+            ? (serverUrl == null ? DEFAULT_HEARTBEAT_SERVER_URL : serverUrl)
             : heartbeatServerUrl;
     this.updateSettingsWhenIdleInterval =
-        updateSettingsWhenIdleInterval == null ? 12000L : updateSettingsWhenIdleInterval;
-    this.submissionBatchSize = submissionBatchSize == null ? 50 : submissionBatchSize;
+        updateSettingsWhenIdleInterval == null
+            ? DEFAULT_UPDATE_SETTINGS_WHEN_IDLE_INTERVAL
+            : updateSettingsWhenIdleInterval;
+    this.submissionBatchSize =
+        submissionBatchSize == null ? DEFAULT_SUBMISSION_BATCH_SIZE : submissionBatchSize;
     this.submissionClientTimeoutInMillis =
-        submissionClientTimeoutInMillis == null ? 500 : submissionClientTimeoutInMillis;
+        submissionClientTimeoutInMillis == null
+            ? DEFAULT_SUBMISSION_CLIENT_TIMEOUT_IN_MILLIS
+            : submissionClientTimeoutInMillis;
     this.settingsClientTimeoutInMillis =
-        settingsClientTimeoutInMillis == null ? 500 : settingsClientTimeoutInMillis;
+        settingsClientTimeoutInMillis == null
+            ? DEFAULT_SETTINGS_CLIENT_TIMEOUT_IN_MILLIS
+            : settingsClientTimeoutInMillis;
     this.propertyChangeSupport = new PropertyChangeSupport(this);
   }
 
@@ -55,46 +79,47 @@ public static Configuration defaultConfiguration() {
   public void setApiKey(String apiKey) {
     String prevValue = this.apiKey;
     this.apiKey = apiKey;
-    propertyChangeSupport.firePropertyChange("apiKey", prevValue, apiKey);
+    propertyChangeSupport.firePropertyChange(Property.API_KEY, prevValue, apiKey);
   }
 
   public void setServerUrl(String serverUrl) {
     String prevValue = this.serverUrl;
     this.serverUrl = serverUrl;
-    propertyChangeSupport.firePropertyChange("serverUrl", prevValue, serverUrl);
+    propertyChangeSupport.firePropertyChange(Property.SERVER_URL, prevValue, serverUrl);
   }
 
-
   public void setHeartbeatServerUrl(String heartbeatServerUrl) {
     String prevValue = this.heartbeatServerUrl;
     this.heartbeatServerUrl = heartbeatServerUrl;
-    propertyChangeSupport.firePropertyChange("heartbeatServerUrl", prevValue, heartbeatServerUrl);
+    propertyChangeSupport.firePropertyChange(
+        Property.HEART_BEAT_SERVER_URL, prevValue, heartbeatServerUrl);
   }
 
   public void setUpdateSettingsWhenIdleInterval(Long updateSettingsWhenIdleInterval) {
     Long prevValue = this.updateSettingsWhenIdleInterval;
     this.updateSettingsWhenIdleInterval = updateSettingsWhenIdleInterval;
     propertyChangeSupport.firePropertyChange(
-        "updateSettingsWhenIdleInterval", prevValue, updateSettingsWhenIdleInterval);
+        Property.UPDATE_SETTINGS_WHEN_IDLE_INTERVAL, prevValue, updateSettingsWhenIdleInterval);
   }
 
   public void setSubmissionBatchSize(Integer submissionBatchSize) {
     Integer prevValue = this.submissionBatchSize;
     this.submissionBatchSize = submissionBatchSize;
-    propertyChangeSupport.firePropertyChange("submissionBatchSize", prevValue, submissionBatchSize);
+    propertyChangeSupport.firePropertyChange(
+        Property.SUBMISSION_BATCH_SIZE, prevValue, submissionBatchSize);
   }
 
   public void setSubmissionClientTimeoutInMillis(Integer submissionClientTimeoutInMillis) {
     Integer prevValue = this.submissionClientTimeoutInMillis;
     this.submissionClientTimeoutInMillis = submissionClientTimeoutInMillis;
     propertyChangeSupport.firePropertyChange(
-        "submissionClientTimeoutInMillis", prevValue, submissionClientTimeoutInMillis);
+        Property.SUBMISSION_CLIENT_TIMEOUT_IN_MILLIS, prevValue, submissionClientTimeoutInMillis);
   }
 
   public void setSettingsClientTimeoutInMillis(Integer settingsClientTimeoutInMillis) {
     Integer prevValue = this.settingsClientTimeoutInMillis;
     this.settingsClientTimeoutInMillis = settingsClientTimeoutInMillis;
     propertyChangeSupport.firePropertyChange(
-        "settingsClientTimeoutInMillis", prevValue, settingsClientTimeoutInMillis);
+        Property.SETTINGS_CLIENT_TIMEOUT_IN_MILLIS, prevValue, settingsClientTimeoutInMillis);
   }
 }

src/main/java/com/exceptionless/exceptionlessclient/configuration/ConfigurationManager.java

@@ -2,8 +2,6 @@
 
 import ch.qos.logback.core.Context;
 import com.exceptionless.exceptionlessclient.exceptions.InvalidApiKeyException;
-import com.exceptionless.exceptionlessclient.services.DefaultLastReferenceIdManager;
-import com.exceptionless.exceptionlessclient.services.LastReferenceIdManagerIF;
 import com.exceptionless.exceptionlessclient.logging.LogCapturerAppender;
 import com.exceptionless.exceptionlessclient.logging.LogCapturerIF;
 import com.exceptionless.exceptionlessclient.logging.NullLogCapturer;
@@ -33,6 +31,8 @@
 
 public class ConfigurationManager {
   private static final Logger LOG = LoggerFactory.getLogger(ConfigurationManager.class);
+  private static final Integer API_KEY_MIN_LENGTH = 11;
+  private static final Integer DEFAULT_HEART_BEAT_INTERVAL_IN_SECS = 30;
 
   @Getter private final EnvironmentInfoCollectorIF environmentInfoCollector;
   @Getter private final ErrorParserIF errorParser;
@@ -131,7 +131,8 @@ private void addPropertyChangeListeners() {
   }
 
   private void checkApiKeyIsValid() {
-    if (configuration.getApiKey() != null && configuration.getApiKey().length() > 10) {
+    if (configuration.getApiKey() != null
+        && configuration.getApiKey().length() >= API_KEY_MIN_LENGTH) {
       return;
     }
 
@@ -185,31 +186,14 @@ public void addPlugin(EventPluginIF eventPlugin) {
   }
 
   public void addPlugin(BiConsumer<EventPluginContext, ConfigurationManager> pluginAction) {
-    addPlugin(UUID.randomUUID().toString(), 0, pluginAction);
+    pluginManager.addPlugin(pluginAction);
   }
 
   public void addPlugin(
       String name,
       int priority,
       BiConsumer<EventPluginContext, ConfigurationManager> pluginAction) {
-    addPlugin(
-        new EventPluginIF() {
-          @Override
-          public int getPriority() {
-            return priority;
-          }
-
-          @Override
-          public String getName() {
-            return name;
-          }
-
-          @Override
-          public void run(
-              EventPluginContext eventPluginContext, ConfigurationManager configurationManager) {
-            pluginAction.accept(eventPluginContext, configurationManager);
-          }
-        });
+    pluginManager.addPlugin(name, priority, pluginAction);
   }
 
   public void removePlugin(String name) {
@@ -237,7 +221,7 @@ public void setUserIdentity(UserInfo userInfo) {
   }
 
   public void useSessions() {
-    useSessions(30);
+    useSessions(DEFAULT_HEART_BEAT_INTERVAL_IN_SECS);
   }
 
   public void useSessions(int heartbeatIntervalInSecs) {

src/main/java/com/exceptionless/exceptionlessclient/configuration/PluginManager.java

@@ -16,6 +16,7 @@
 
 public class PluginManager {
   private static final Logger LOG = LoggerFactory.getLogger(PluginManager.class);
+  private static final Integer DEFAULT_PLUGIN_PRIORITY = 0;
 
   @Getter private List<EventPluginIF> plugins;
 
@@ -54,7 +55,7 @@ private void sortPlugins() {
   }
 
   public void addPlugin(BiConsumer<EventPluginContext, ConfigurationManager> pluginAction) {
-    addPlugin(UUID.randomUUID().toString(), 0, pluginAction);
+    addPlugin(UUID.randomUUID().toString(), DEFAULT_PLUGIN_PRIORITY, pluginAction);
   }
 
   public void addPlugin(

src/main/java/com/exceptionless/exceptionlessclient/configuration/PrivateInformationInclusions.java

@@ -7,6 +7,16 @@
 import java.beans.PropertyChangeSupport;
 
 public class PrivateInformationInclusions {
+  public static class Property {
+    public static final String ALL = "all";
+    public static final String QUERY_STRING = "queryString";
+    public static final String POST_DATA = "postData";
+    public static final String COOKIES = "cookies";
+    public static final String IP_ADDRESS = "ipAddress";
+    public static final String MACHINE_NAME = "machineName";
+    public static final String USER_NAME = "userName";
+  }
+
   @Getter private Boolean queryString;
   @Getter private Boolean postData;
   @Getter private Boolean cookies;
@@ -43,42 +53,42 @@ public Boolean isAllIncluded() {
   public void applyToAll(Boolean include) {
     Boolean prevValue = isAllIncluded();
     queryString = postData = cookies = ipAddress = machineName = userName = include;
-    propertyChangeSupport.firePropertyChange("all", prevValue, include);
+    propertyChangeSupport.firePropertyChange(Property.ALL, prevValue, include);
   }
 
   public void setQueryString(Boolean queryString) {
     Boolean prevValue = this.queryString;
     this.queryString = queryString;
-    propertyChangeSupport.firePropertyChange("queryString", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.QUERY_STRING, prevValue, queryString);
   }
 
   public void setPostData(Boolean postData) {
     Boolean prevValue = this.postData;
     this.postData = postData;
-    propertyChangeSupport.firePropertyChange("postData", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.POST_DATA, prevValue, queryString);
   }
 
   public void setCookies(Boolean cookies) {
     Boolean prevValue = this.cookies;
     this.cookies = cookies;
-    propertyChangeSupport.firePropertyChange("cookies", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.COOKIES, prevValue, queryString);
   }
 
   public void setIpAddress(Boolean ipAddress) {
     Boolean prevValue = this.ipAddress;
     this.ipAddress = ipAddress;
-    propertyChangeSupport.firePropertyChange("ipAddress", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.IP_ADDRESS, prevValue, queryString);
   }
 
   public void setMachineName(Boolean machineName) {
     Boolean prevValue = this.machineName;
     this.machineName = machineName;
-    propertyChangeSupport.firePropertyChange("machineName", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.MACHINE_NAME, prevValue, queryString);
   }
 
   public void setUserName(Boolean userName) {
     Boolean prevValue = this.userName;
     this.userName = userName;
-    propertyChangeSupport.firePropertyChange("userName", prevValue, queryString);
+    propertyChangeSupport.firePropertyChange(Property.USER_NAME, prevValue, queryString);
   }
 }

src/main/java/com/exceptionless/exceptionlessclient/models/Event.java

@@ -17,11 +17,13 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
-// Warning `SuperBuilder` will not work for any class extending this. This class breaks the chain
+// WARNING: `SuperBuilder` will not work for any class extending this. This class breaks the chain
 // for customization
 @Data
 @EqualsAndHashCode(callSuper = true)
 public class Event extends Model {
+  private static final Integer DEFAULT_COUNT = 1;
+
   private String type;
   private String source;
   private LocalDate date;
@@ -52,14 +54,15 @@ public Event(
     this.message = message;
     this.geo = geo;
     this.value = value;
-    this.referenceId =
-        referenceId == null
-            ? String.format("%s-%s", Thread.currentThread().getId(), UUID.randomUUID())
-            : referenceId;
-    this.count = count == null ? 1 : count;
+    this.referenceId = referenceId == null ? getDefaultReferenceId() : referenceId;
+    this.count = count == null ? DEFAULT_COUNT : count;
     initData(data == null ? new HashMap<>() : data, dataExclusions);
   }
 
+  private String getDefaultReferenceId() {
+    return String.format("%s-%s", Thread.currentThread().getId(), UUID.randomUUID());
+  }
+
   private void initData(Map<String, Object> data, Set<String> dataExclusions) {
     EventDataFilter eventDataFilter = EventDataFilter.builder().exclusions(dataExclusions).build();
     this.data =

src/main/java/com/exceptionless/exceptionlessclient/models/PluginContext.java

@@ -7,7 +7,7 @@
 
 import java.net.http.HttpRequest;
 
-// Warning `SuperBuilder` will not work for any class extending this. This class breaks the chain
+// WARNING: `SuperBuilder` will not work for any class extending this. This class breaks the chain
 // for customization
 @Data
 @EqualsAndHashCode(callSuper = true)

src/main/java/com/exceptionless/exceptionlessclient/models/enums/EnvironmentInfoPropertyKey.java

@@ -0,0 +1,18 @@
+package com.exceptionless.exceptionlessclient.models.enums;
+
+public enum EnvironmentInfoPropertyKey {
+  LOAD_AVG("loadavg"),
+  TMP_DIR("tmpdir"),
+  UP_TIME("uptime"),
+  ENDIANESS("endianess");
+
+  private final String value;
+
+  EnvironmentInfoPropertyKey(String value) {
+    this.value = value;
+  }
+
+  public String value() {
+    return value;
+  }
+}

src/main/java/com/exceptionless/exceptionlessclient/plugins/preconfigured/ConfigurationDefaultsPlugin.java

@@ -7,17 +7,19 @@
 import lombok.Builder;
 
 public class ConfigurationDefaultsPlugin implements EventPluginIF {
+  private static final Integer DEFAULT_PRIORITY = 10;
+
   @Builder
   public ConfigurationDefaultsPlugin() {}
 
   @Override
   public int getPriority() {
-    return 10;
+    return DEFAULT_PRIORITY;
   }
 
   @Override
   public void run(
-          EventPluginContext eventPluginContext, ConfigurationManager configurationManager) {
+      EventPluginContext eventPluginContext, ConfigurationManager configurationManager) {
     Event event = eventPluginContext.getEvent();
     for (String tag : configurationManager.getDefaultTags()) {
       event.addTags(tag);