Merge branch 'main' into clean-services

Author: pc9795

.github/workflows/greetings.yml

@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: 'Thanks for reporting this issue. We will get back to you in a while'
+        pr-message: 'Great Job for your first PR in this repository'

.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v3
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale'
+        stale-pr-message: 'This PR is stale'
+        stale-issue-label: 'stale'
+        stale-pr-label: 'stale'

Readme.md renamed to README.md

@@ -32,6 +32,31 @@ class ExampleApp{
 }
 ```
 
+**Builder Pattern**
+
+We love our builders!!! This project heavily utilized the use of builders instead of traditional object creation
+using `new`. We do this with the help of Project Lombok's `@Builder` annotation. Read more about the
+project [here](https://projectlombok.org/features/all). Read more about the
+annotation [here](https://projectlombok.org/features/Builder). Read more about the builder
+pattern [here](https://refactoring.guru/design-patterns/builder).
+
+_Example: Customizing your Event Queue implementation_
+
+```
+EventQueueIF queue = //get your implementation
+Configuration configuration =
+    Configuration.builder().serverUrl("http://your-server-url").apiKey("your-api-key").build();
+ConfigurationManager configurationManager =
+    ConfigurationManager.builder().queue(queue).configuration(configuration).build();
+ExceptionlessClient client =
+    ExceptionlessClient.builder().configurationManager(configurationManager).build();
+```
+
+In this library we have made sure that all the values which are not set by builders fallback to reasonable defaults. So
+don't feel the pressure to supply values for all the fields. **Note:** Whenever customizing the client
+using `ConfigurationManager` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
+shown above.
+
 ## Spring Boot Users
 
 You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-boot uses v3 of `OkHttpClient` while this client uses v4. In that case you have to explicitly declare v4 of the library in you `pom.xml/build.gradle`.

src/main/java/com/exceptionless/exceptionlessclient/ExceptionlessClient.java

@@ -2,14 +2,14 @@
 
 import com.exceptionless.exceptionlessclient.configuration.Configuration;
 import com.exceptionless.exceptionlessclient.configuration.ConfigurationManager;
+import com.exceptionless.exceptionlessclient.enums.EventPropertyKey;
+import com.exceptionless.exceptionlessclient.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
 import com.exceptionless.exceptionlessclient.models.PluginContext;
 import com.exceptionless.exceptionlessclient.models.UserDescription;
-import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
-import com.exceptionless.exceptionlessclient.models.enums.EventType;
-import com.exceptionless.exceptionlessclient.models.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginRunner;
+import com.exceptionless.exceptionlessclient.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.utils.VisibleForTesting;
 import lombok.Builder;
 import lombok.Getter;
@@ -269,9 +269,16 @@ public SubmissionResponse updateEmailAndDescription(
             .postUserDescription(
                 referenceId,
                 UserDescription.builder().description(description).emailAddress(email).build());
+    if (response.hasException()) {
+      log.error(
+          String.format("Failed to submit user email and description for event: %s", referenceId),
+          response.getException());
+    }
     if (!response.isSuccess()) {
       log.error(
-          String.format("Failed to submit user email and description for event: %s", referenceId));
+          String.format(
+              "Failed to submit user email and description for event: %s, code: %s",
+              referenceId, response.getCode()));
     }
 
     return response;

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

@@ -9,6 +9,7 @@
 public class Configuration {
   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 String DEFAULT_CONFIG_SERVER_URL = "https://config.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;
@@ -17,6 +18,7 @@ public class Configuration {
   public static class Property {
     public static final String API_KEY = "apiKey";
     public static final String SERVER_URL = "serverUrl";
+    public static final String CONFIG_SERVER_URL = "configServerUrl";
     public static final String HEART_BEAT_SERVER_URL = "heartbeatServerUrl";
     public static final String UPDATE_SETTINGS_WHEN_IDLE_INTERVAL =
         "updateSettingsWhenIdleInterval";
@@ -29,6 +31,7 @@ public static class Property {
   @Getter private String apiKey;
   @Getter private String serverUrl;
   @Getter private String heartbeatServerUrl;
+  @Getter private String configServerUrl;
   @Getter private Long updateSettingsWhenIdleInterval;
   @Getter private Integer submissionBatchSize;
   @Getter private Integer submissionClientTimeoutInMillis;
@@ -51,6 +54,10 @@ public Configuration(
         heartbeatServerUrl == null
             ? (serverUrl == null ? DEFAULT_HEARTBEAT_SERVER_URL : serverUrl)
             : heartbeatServerUrl;
+    this.configServerUrl =
+        configServerUrl == null
+            ? (serverUrl == null ? DEFAULT_CONFIG_SERVER_URL : serverUrl)
+            : configServerUrl;
     this.updateSettingsWhenIdleInterval =
         updateSettingsWhenIdleInterval == null
             ? DEFAULT_UPDATE_SETTINGS_WHEN_IDLE_INTERVAL
@@ -88,6 +95,13 @@ public void setServerUrl(String serverUrl) {
     propertyChangeSupport.firePropertyChange(Property.SERVER_URL, prevValue, serverUrl);
   }
 
+  public void setConfigServerUrl(String configServerUrl) {
+    String prevValue = this.configServerUrl;
+    this.configServerUrl = configServerUrl;
+    propertyChangeSupport.firePropertyChange(
+        Property.CONFIG_SERVER_URL, prevValue, configServerUrl);
+  }
+
   public void setHeartbeatServerUrl(String heartbeatServerUrl) {
     String prevValue = this.heartbeatServerUrl;
     this.heartbeatServerUrl = heartbeatServerUrl;

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

@@ -7,7 +7,7 @@
 import com.exceptionless.exceptionlessclient.logging.NullLogCapturer;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
 import com.exceptionless.exceptionlessclient.models.UserInfo;
-import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
+import com.exceptionless.exceptionlessclient.enums.EventPropertyKey;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginIF;
 import com.exceptionless.exceptionlessclient.plugins.preconfigured.HeartbeatPlugin;
 import com.exceptionless.exceptionlessclient.queue.DefaultEventQueue;

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

@@ -1,4 +1,4 @@
-package com.exceptionless.exceptionlessclient.models.enums;
+package com.exceptionless.exceptionlessclient.enums;
 
 public enum EnvironmentInfoPropertyKey {
   LOAD_AVG("loadavg"),

src/main/java/com/exceptionless/exceptionlessclient/models/enums/EventPropertyKey.java renamed to src/main/java/com/exceptionless/exceptionlessclient/enums/EventPropertyKey.java

@@ -1,4 +1,4 @@
-package com.exceptionless.exceptionlessclient.models.enums;
+package com.exceptionless.exceptionlessclient.enums;
 
 public enum EventPropertyKey {
   REF("@ref"),

src/main/java/com/exceptionless/exceptionlessclient/models/enums/EventTag.java renamed to src/main/java/com/exceptionless/exceptionlessclient/enums/EventTag.java

@@ -1,4 +1,4 @@
-package com.exceptionless.exceptionlessclient.models.enums;
+package com.exceptionless.exceptionlessclient.enums;
 
 public enum EventTag {
   CRITICAL("Critical");

src/main/java/com/exceptionless/exceptionlessclient/models/enums/EventType.java renamed to src/main/java/com/exceptionless/exceptionlessclient/enums/EventType.java

@@ -1,4 +1,4 @@
-package com.exceptionless.exceptionlessclient.models.enums;
+package com.exceptionless.exceptionlessclient.enums;
 
 public enum EventType {
   ERROR("error"),

src/main/java/com/exceptionless/exceptionlessclient/models/enums/ServerSettingKey.java renamed to src/main/java/com/exceptionless/exceptionlessclient/enums/ServerSettingKey.java

@@ -1,4 +1,4 @@
-package com.exceptionless.exceptionlessclient.models.enums;
+package com.exceptionless.exceptionlessclient.enums;
 
 public enum ServerSettingKey {
   DATA_EXCLUSIONS("@@DataExclusions"),

src/main/java/com/exceptionless/exceptionlessclient/exceptions/SettingsClientException.java

@@ -1,8 +1,8 @@
 package com.exceptionless.exceptionlessclient.models;
 
+import com.exceptionless.exceptionlessclient.enums.EventPropertyKey;
+import com.exceptionless.exceptionlessclient.enums.EventTag;
 import com.exceptionless.exceptionlessclient.models.base.Model;
-import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
-import com.exceptionless.exceptionlessclient.models.enums.EventTag;
 import com.exceptionless.exceptionlessclient.models.error.Error;
 import com.exceptionless.exceptionlessclient.queue.EventDataFilter;
 import com.exceptionless.exceptionlessclient.queue.EventValidator;

src/main/java/com/exceptionless/exceptionlessclient/exceptions/SubmissionClientException.java

@@ -1,10 +1,10 @@
 package com.exceptionless.exceptionlessclient.plugins.preconfigured;
 
 import com.exceptionless.exceptionlessclient.configuration.ConfigurationManager;
+import com.exceptionless.exceptionlessclient.enums.EnvironmentInfoPropertyKey;
+import com.exceptionless.exceptionlessclient.models.EnvironmentInfo;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
-import com.exceptionless.exceptionlessclient.models.enums.EnvironmentInfoPropertyKey;
-import com.exceptionless.exceptionlessclient.models.EnvironmentInfo;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginIF;
 import com.exceptionless.exceptionlessclient.plugins.preconfigured.args.EnvironmentInfoGetArgs;
 import com.sun.management.OperatingSystemMXBean;

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

@@ -1,10 +1,10 @@
 package com.exceptionless.exceptionlessclient.plugins.preconfigured;
 
 import com.exceptionless.exceptionlessclient.configuration.ConfigurationManager;
+import com.exceptionless.exceptionlessclient.enums.EventPropertyKey;
+import com.exceptionless.exceptionlessclient.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
-import com.exceptionless.exceptionlessclient.models.enums.EventPropertyKey;
-import com.exceptionless.exceptionlessclient.models.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.error.Error;
 import com.exceptionless.exceptionlessclient.models.error.StackFrame;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginIF;

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

@@ -1,9 +1,9 @@
 package com.exceptionless.exceptionlessclient.plugins.preconfigured;
 
 import com.exceptionless.exceptionlessclient.configuration.ConfigurationManager;
+import com.exceptionless.exceptionlessclient.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.EventPluginContext;
-import com.exceptionless.exceptionlessclient.models.enums.EventType;
 import com.exceptionless.exceptionlessclient.models.error.Error;
 import com.exceptionless.exceptionlessclient.plugins.EventPluginIF;
 import com.exceptionless.exceptionlessclient.settings.ServerSettings;

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

@@ -1,12 +1,11 @@
 package com.exceptionless.exceptionlessclient.queue;
 
 import com.exceptionless.exceptionlessclient.configuration.Configuration;
-import com.exceptionless.exceptionlessclient.exceptions.SubmissionClientException;
 import com.exceptionless.exceptionlessclient.models.Event;
 import com.exceptionless.exceptionlessclient.models.storage.StorageItem;
-import com.exceptionless.exceptionlessclient.models.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.storage.StorageProviderIF;
 import com.exceptionless.exceptionlessclient.submission.SubmissionClientIF;
+import com.exceptionless.exceptionlessclient.submission.SubmissionResponse;
 import com.exceptionless.exceptionlessclient.utils.VisibleForTesting;
 import lombok.Builder;
 import lombok.extern.slf4j.Slf4j;
@@ -137,11 +136,13 @@ public void process() {
       log.info(
           String.format("Sending %s events to %s", events.size(), configuration.getServerUrl()));
       SubmissionResponse response = submissionClient.postEvents(events);
+      if (response.hasException()) {
+        log.error("Error submitting events from queue", response.getException());
+        suspendProcessing();
+        return;
+      }
       processSubmissionResponse(response, storedEvents);
       eventPosted(response, events);
-    } catch (SubmissionClientException e) {
-      log.error("Error submitting events from queue", e);
-      suspendProcessing();
     } finally {
       synchronized (this) {
         processingQueue = false;
@@ -158,6 +159,13 @@ private void processSubmissionResponse(
       return;
     }
 
+    if (response.isRateLimited()) {
+      log.error(
+          "Service is rate limited because of either you have exceeded your rate limit or server is under stress.");
+      suspendProcessing();
+      return;
+    }
+
     if (response.isServiceUnavailable()) {
       log.error("Service returns service unavailable");
       suspendProcessing();

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

@@ -1,7 +1,7 @@
 package com.exceptionless.exceptionlessclient.queue;
 
 import com.exceptionless.exceptionlessclient.models.Event;
-import com.exceptionless.exceptionlessclient.models.submission.SubmissionResponse;
+import com.exceptionless.exceptionlessclient.submission.SubmissionResponse;
 
 import java.time.Duration;
 import java.util.List;

src/main/java/com/exceptionless/exceptionlessclient/queue/DefaultEventQueue.java

@@ -1,8 +1,6 @@
 package com.exceptionless.exceptionlessclient.settings;
 
 import com.exceptionless.exceptionlessclient.configuration.Configuration;
-import com.exceptionless.exceptionlessclient.exceptions.SettingsClientException;
-import com.exceptionless.exceptionlessclient.models.submission.SettingsResponse;
 import com.exceptionless.exceptionlessclient.utils.Utils;
 import com.exceptionless.exceptionlessclient.utils.VisibleForTesting;
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -42,7 +40,7 @@ public SettingsResponse getSettings(long version) {
               .url(
                   String.format(
                       "%s/api/v2/projects/config?v=%s&access_token=%s",
-                      configuration.getServerUrl(), version, configuration.getApiKey()))
+                      configuration.getConfigServerUrl(), version, configuration.getApiKey()))
               .get()
               .build();
 
@@ -53,7 +51,7 @@ public SettingsResponse getSettings(long version) {
       if (bodyStr == null) {
         return SettingsResponse.builder().code(response.code()).body("").build();
       }
-      if (response.code() / 100 != 2) {
+      if (!response.isSuccessful()) {
         return SettingsResponse.builder().code(response.code()).body(bodyStr).build();
       }
 
@@ -65,7 +63,7 @@ public SettingsResponse getSettings(long version) {
           .settings(serverSettings)
           .build();
     } catch (Exception e) {
-      throw new SettingsClientException(e);
+      return SettingsResponse.builder().exception(e).build();
     }
   }
 }

src/main/java/com/exceptionless/exceptionlessclient/queue/EventQueueIF.java

@@ -1,6 +1,6 @@
 package com.exceptionless.exceptionlessclient.settings;
 
-import com.exceptionless.exceptionlessclient.models.enums.ServerSettingKey;
+import com.exceptionless.exceptionlessclient.enums.ServerSettingKey;
 import com.exceptionless.exceptionlessclient.utils.Utils;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;

src/main/java/com/exceptionless/exceptionlessclient/settings/DefaultSettingsClient.java

@@ -1,8 +1,6 @@
 package com.exceptionless.exceptionlessclient.settings;
 
 
-import com.exceptionless.exceptionlessclient.models.submission.SettingsResponse;
-
 public interface SettingsClientIF {
     SettingsResponse getSettings(long version);
 }

src/main/java/com/exceptionless/exceptionlessclient/settings/ServerSettings.java

@@ -1,8 +1,6 @@
 package com.exceptionless.exceptionlessclient.settings;
 
-import com.exceptionless.exceptionlessclient.exceptions.SettingsClientException;
 import com.exceptionless.exceptionlessclient.models.storage.StorageItem;
-import com.exceptionless.exceptionlessclient.models.submission.SettingsResponse;
 import com.exceptionless.exceptionlessclient.storage.StorageProviderIF;
 import lombok.Builder;
 import lombok.extern.slf4j.Slf4j;
@@ -81,8 +79,6 @@ public void updateSettings() {
       storageProvider.getSettings().save(response.getSettings());
       propertyChangeSupport.firePropertyChange(
           Property.SETTINGS, prevValue, response.getSettings());
-    } catch (SettingsClientException e) {
-      log.error(String.format("Error retrieving settings for v%s", getVersion()), e);
     } finally {
       synchronized (this) {
         updatingSettings = false;
@@ -91,6 +87,12 @@ public void updateSettings() {
   }
 
   private boolean shouldNotUpdate(SettingsResponse response) {
+    if (response.hasException()) {
+      log.error(
+          String.format("Error retrieving settings for v%s", getVersion()),
+          response.getException());
+      return true;
+    }
     if (response.isNotModified()) {
       log.debug("No need to update, settings are not modified");
       return true;