Added request info plugin

Author: pc9795

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

@@ -34,13 +34,15 @@ public class ConfigurationManager {
   @Getter private LastReferenceIdManagerIF lastReferenceIdManager;
   @Getter private LogIF log;
   @Getter private ModuleCollectorIF moduleCollector;
+  @Getter private RequestInfoCollectorIF requestInfoCollector;
   @Getter private SubmissionClientIF submissionClient;
   @Getter private EventQueueIF queue;
   @Getter private Configuration configuration;
   @Getter private Set<String> defaultTags;
   @Getter private Map<String, Object> defaultData;
   private List<Consumer<ConfigurationManager>> onChangedHandlers;
   @Getter private SettingsManager settingsManager;
+  @Getter private Set<String> userAgentBotPatterns;
   @Getter private PrivateInformationInclusions privateInformationInclusions;
   private Set<String> dataExclusions;
   private PluginManager pluginManager;
@@ -52,6 +54,7 @@ public ConfigurationManager(
       LastReferenceIdManagerIF lastReferenceIdManager,
       LogIF log,
       ModuleCollectorIF moduleCollector,
+      RequestInfoCollectorIF requestInfoCollector,
       SubmissionClientIF submissionClient,
       SettingsClientIF settingsClient,
       StorageProviderIF storageProvider,
@@ -71,6 +74,10 @@ public ConfigurationManager(
             : lastReferenceIdManager;
     this.moduleCollector =
         moduleCollector == null ? DefaultModuleCollector.builder().build() : moduleCollector;
+    this.requestInfoCollector =
+        requestInfoCollector == null
+            ? DefaultRequestInfoCollector.builder().log(this.log).build()
+            : requestInfoCollector;
     this.settingsManager =
         SettingsManager.builder()
             .settingsClient(
@@ -79,6 +86,7 @@ public ConfigurationManager(
                     : settingsClient)
             .log(log)
             .build();
+    this.userAgentBotPatterns = new HashSet<>();
     this.configuration =
         configuration == null ? Configuration.defaultConfiguration() : configuration;
     this.submissionClient =
@@ -131,6 +139,10 @@ public void addDataExclusions(String... exclusions) {
     dataExclusions.addAll(Arrays.asList(exclusions));
   }
 
+  public void addUserAgentBotPatterns(String... userAgentBotPatterns) {
+    this.userAgentBotPatterns.addAll(Arrays.asList(userAgentBotPatterns));
+  }
+
   public Set<String> getDataExclusions() {
     Set<String> combinedExclusions = settingsManager.getSavedServerSettings().getDataExclusions();
     combinedExclusions.addAll(dataExclusions);

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

@@ -18,16 +18,18 @@ public class PluginManager {
 
   @Builder
   public PluginManager(LogIF log) {
+    this.log = log;
     configureDefaultPlugins();
     sortPlugins();
   }
 
   private void configureDefaultPlugins() {
     addPlugin(ConfigurationDefaultsPlugin.builder().build());
     addPlugin(ErrorPlugin.builder().build());
-    addPlugin(DuplicateErrorCheckerPlugin.builder().build());
-    addPlugin(EventExclusionPlugin.builder().build());
+    addPlugin(DuplicateErrorCheckerPlugin.builder().log(this.log).build());
+    addPlugin(EventExclusionPlugin.builder().log(this.log).build());
     addPlugin(ModuleInfoPlugin.builder().build());
+    addPlugin(RequestInfoPlugin.builder().log(this.log).build());
     addPlugin(EnvironmentInfoPlugin.builder().build());
     addPlugin(SubmissionMethodPlugin.builder().build());
   }

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

@@ -4,6 +4,7 @@
 import com.prashantchaubey.exceptionlessclient.models.enums.EventPropertyKey;
 import com.prashantchaubey.exceptionlessclient.models.enums.EventTag;
 import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfo;
+import com.prashantchaubey.exceptionlessclient.models.services.RequestInfo;
 import com.prashantchaubey.exceptionlessclient.models.services.error.Error;
 import com.prashantchaubey.exceptionlessclient.queue.EventDataFilter;
 import com.prashantchaubey.exceptionlessclient.queue.EventValidator;
@@ -66,10 +67,6 @@ private void initData(Map<String, Object> data, Set<String> dataExclusions) {
                     Map.Entry::getKey, entry -> eventDataFilter.filter(entry.getValue())));
   }
 
-  public void addData(Map<String, Object> data) {
-    addData(data, new HashSet<>());
-  }
-
   public void addData(Map<String, Object> data, Set<String> dataExclusions) {
     EventDataFilter filter = EventDataFilter.builder().exclusions(dataExclusions).build();
     data =
@@ -94,6 +91,10 @@ public void addSubmissionMethod(String submissionMethod) {
     data.put(EventPropertyKey.SUBMISSION_METHOD.value(), submissionMethod);
   }
 
+  public void addRequestInfo(RequestInfo requestInfo) {
+    data.put(EventPropertyKey.REQUEST_INFO.value(), requestInfo);
+  }
+
   public Optional<Error> getError() {
     return Optional.ofNullable(safeGetAs(data.get(EventPropertyKey.ERROR.value()), Error.class));
   }
@@ -112,6 +113,11 @@ public Optional<UserInfo> getUserInfo() {
     return Optional.ofNullable(safeGetAs(data.get(EventPropertyKey.USER.value()), UserInfo.class));
   }
 
+  public Optional<RequestInfo> getRequestInfo() {
+    return Optional.ofNullable(
+        safeGetAs(data.get(EventPropertyKey.REQUEST_INFO.value()), RequestInfo.class));
+  }
+
   public static EventBuilder builder() {
     return new EventBuilder();
   }

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

@@ -16,18 +16,18 @@ public class PluginContext extends Model {
   private Exception exception;
   private Boolean unhandledError;
   private String submissionMethod;
-  private HttpRequest requestInfo;
+  private HttpRequest request;
 
   @Builder
   public PluginContext(
       Exception exception,
       Boolean unhandledError,
       String submissionMethod,
-      HttpRequest requestInfo) {
+      HttpRequest request) {
     this.exception = exception;
     this.unhandledError = unhandledError;
     this.submissionMethod = submissionMethod;
-    this.requestInfo = requestInfo;
+    this.request = request;
   }
 
   public boolean isUnhandledError() {

src/main/java/com/prashantchaubey/exceptionlessclient/models/enums/EventPropertyKey.java

@@ -10,7 +10,8 @@ public enum EventPropertyKey {
   ENVIRONMENT("@environment"),
   EXTRA("@ext"),
   SUBMISSION_METHOD("@submission_method"),
-  VERSION("@version");
+  VERSION("@version"),
+  REQUEST_INFO("@request");
 
   private String value;
 

src/main/java/com/prashantchaubey/exceptionlessclient/plugins/preconfigured/RequestInfoPlugin.java

@@ -0,0 +1,65 @@
+package com.prashantchaubey.exceptionlessclient.plugins.preconfigured;
+
+import com.prashantchaubey.exceptionlessclient.configuration.ConfigurationManager;
+import com.prashantchaubey.exceptionlessclient.logging.LogIF;
+import com.prashantchaubey.exceptionlessclient.models.Event;
+import com.prashantchaubey.exceptionlessclient.models.EventPluginContext;
+import com.prashantchaubey.exceptionlessclient.models.services.RequestInfo;
+import com.prashantchaubey.exceptionlessclient.plugins.EventPluginIF;
+import com.prashantchaubey.exceptionlessclient.services.RequestInfoGetArgs;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
+import lombok.Builder;
+
+import java.net.http.HttpRequest;
+
+public class RequestInfoPlugin implements EventPluginIF {
+  private LogIF log;
+
+  @Builder
+  public RequestInfoPlugin(LogIF log) {
+    this.log = log;
+  }
+
+  @Override
+  public int getPriority() {
+    return 70;
+  }
+
+  @Override
+  public void run(
+      EventPluginContext eventPluginContext, ConfigurationManager configurationManager) {
+    Event event = eventPluginContext.getEvent();
+    if (event.getRequestInfo().isPresent()) {
+      return;
+    }
+    HttpRequest request = eventPluginContext.getContext().getRequest();
+    if (request == null) {
+      return;
+    }
+    RequestInfo requestInfo =
+        configurationManager
+            .getRequestInfoCollector()
+            .getRequestInfo(
+                request,
+                RequestInfoGetArgs.builder()
+                    .exclusions(configurationManager.getDataExclusions())
+                    .includeCookies(
+                        configurationManager.getPrivateInformationInclusions().getCookies())
+                    .includeIpAddress(
+                        configurationManager.getPrivateInformationInclusions().getIpAddress())
+                    .includePostData(
+                        configurationManager.getPrivateInformationInclusions().getPostData())
+                    .includeQueryString(
+                        configurationManager.getPrivateInformationInclusions().getQueryString())
+                    .build());
+
+    if (configurationManager.getUserAgentBotPatterns().stream()
+        .anyMatch(pattern -> Utils.match(requestInfo.getUserAgent(), pattern))) {
+      log.info("Cancelling event as the request user agent matches a known bot pattern");
+      eventPluginContext.getContext().setEventCancelled(true);
+      return;
+    }
+
+    event.addRequestInfo(requestInfo);
+  }
+}