Implemented a default request info collector

pc9795 · pc9795 · commit 443176aa83d0 · 2021-03-28T14:10:19.000+01:00
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/models/Event.java b/src/main/java/com/prashantchaubey/exceptionlessclient/models/Event.java
@@ -15,7 +15,7 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
-import static com.prashantchaubey.exceptionlessclient.utils.EventUtils.safeGetAs;
+import static com.prashantchaubey.exceptionlessclient.utils.Utils.safeGetAs;
 
 // Warning `SuperBuilder` will not work for any class extending this. This class breaks the chain
 // for customization
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/models/services/RequestInfo.java b/src/main/java/com/prashantchaubey/exceptionlessclient/models/services/RequestInfo.java
@@ -6,20 +6,23 @@
 import lombok.experimental.NonFinal;
 import lombok.experimental.SuperBuilder;
 
+import java.util.List;
+import java.util.Map;
+
 @SuperBuilder
 @Value
 @NonFinal
 @EqualsAndHashCode(callSuper = true)
 public class RequestInfo extends Model {
-    private String userAgent;
-    private String httpMethod;
-    private boolean isSecure;
-    private String host;
-    private int port;
-    private String path;
-    private String referrer;
-    private String clientIpAddress;
-    private Object cookies;
-    private Object postData;
-    private String queryString;
+  private String userAgent;
+  private String httpMethod;
+  private boolean isSecure;
+  private String host;
+  private int port;
+  private String path;
+  private String referrer;
+  private String clientIpAddress;
+  private Map<String, String> cookies;
+  private Object postData;
+  private Map<String, List<String>> queryString;
 }
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/models/settings/ServerSettings.java b/src/main/java/com/prashantchaubey/exceptionlessclient/models/settings/ServerSettings.java
@@ -1,6 +1,7 @@
 package com.prashantchaubey.exceptionlessclient.models.settings;
 
 import com.prashantchaubey.exceptionlessclient.models.enums.ServerSettingKey;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
 import lombok.Builder;
 import lombok.Value;
 import lombok.experimental.NonFinal;
@@ -30,8 +31,7 @@ public Optional<String> getTypeAndSourceSetting(String type, String source) {
       if (!key.startsWith(prefix) || key.length() <= prefix.length()) {
         continue;
       }
-      // todo check that wildcard match work with this or not
-      if (source.matches(key.substring(prefix.length()))) {
+      if (Utils.match(source, key.substring(prefix.length()))) {
         return Optional.of(settings.get(key));
       }
     }
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/plugins/preconfigured/EnvironmentInfoPlugin.java b/src/main/java/com/prashantchaubey/exceptionlessclient/plugins/preconfigured/EnvironmentInfoPlugin.java
@@ -3,7 +3,7 @@
 import com.prashantchaubey.exceptionlessclient.configuration.ConfigurationManager;
 import com.prashantchaubey.exceptionlessclient.models.Event;
 import com.prashantchaubey.exceptionlessclient.models.EventPluginContext;
-import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfoGetArgs;
+import com.prashantchaubey.exceptionlessclient.services.EnvironmentInfoGetArgs;
 import com.prashantchaubey.exceptionlessclient.plugins.EventPluginIF;
 import lombok.Builder;
 
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/queue/EventDataFilter.java b/src/main/java/com/prashantchaubey/exceptionlessclient/queue/EventDataFilter.java
@@ -1,6 +1,6 @@
 package com.prashantchaubey.exceptionlessclient.queue;
 
-import com.prashantchaubey.exceptionlessclient.utils.JsonUtils;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
 import lombok.Builder;
 
 import java.util.*;
@@ -30,24 +30,23 @@ private Object filter(Object data, int currDepth) {
     }
 
     if (!(data instanceof Map || data instanceof List)) {
-      data = JsonUtils.JSON_MAPPER.convertValue(data, Map.class);
+      data = Utils.JSON_MAPPER.convertValue(data, Map.class);
     }
 
     if (data instanceof List) {
       List<Object> dataList = (List<Object>) data;
       return dataList.stream().map(val -> filter(val, currDepth + 1)).collect(Collectors.toList());
     }
 
-    Map<String, Object> dataMap = (Map<String, Object>) data;
-    Map<String, Object> result = new HashMap<>();
-    for (String key : dataMap.keySet()) {
-      // todo check that wildcard match work with this or not
-      if (exclusions.stream().anyMatch(key::matches)) {
-        continue;
-      }
-      result.put(key, filter(dataMap.get(key), currDepth + 1));
-    }
-
-    return result;
+    return ((Map<String, Object>) data)
+        .entrySet().stream()
+            .filter(
+                entry ->
+                    exclusions.stream()
+                        .anyMatch(
+                            exclusion -> Utils.match(entry.getKey(), exclusion)))
+            .collect(
+                Collectors.toMap(
+                    Map.Entry::getKey, entry -> filter(entry.getValue(), currDepth + 1)));
   }
 }
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/DefaultEnvironmentInfoCollector.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/DefaultEnvironmentInfoCollector.java
@@ -2,7 +2,6 @@
 
 import com.prashantchaubey.exceptionlessclient.logging.LogIF;
 import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfo;
-import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfoGetArgs;
 import com.sun.management.OperatingSystemMXBean;
 import lombok.Builder;
 
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/DefaultRequestInfoCollector.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/DefaultRequestInfoCollector.java
@@ -0,0 +1,70 @@
+package com.prashantchaubey.exceptionlessclient.services;
+
+import com.prashantchaubey.exceptionlessclient.logging.LogIF;
+import com.prashantchaubey.exceptionlessclient.models.services.RequestInfo;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
+import lombok.Builder;
+
+import java.net.InetAddress;
+import java.net.URI;
+import java.net.UnknownHostException;
+import java.net.http.HttpRequest;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public class DefaultRequestInfoCollector implements RequestInfoCollectorIF {
+  private LogIF log;
+
+  @Builder
+  public DefaultRequestInfoCollector(LogIF log) {
+    this.log = log;
+  }
+
+  @Override
+  public RequestInfo getRequestInfo(HttpRequest request, RequestInfoGetArgs args) {
+    RequestInfo.RequestInfoBuilder builder =
+        RequestInfo.builder()
+            .userAgent(request.headers().firstValue("user-agent").orElse(null))
+            .isSecure(isSecure(request.uri()))
+            .httpMethod(request.method())
+            .host(request.uri().getHost())
+            .path(request.uri().getPath())
+            .port(request.uri().getPort());
+
+    if (args.isIncludeIpAddress()) {
+      try {
+        InetAddress address = InetAddress.getByName(request.uri().getHost());
+        builder.clientIpAddress(address.getHostAddress());
+      } catch (UnknownHostException e) {
+        log.error(
+            String.format("Error while getting ip-address for host: %s", request.uri().getHost()));
+      }
+    }
+
+    if (args.isIncludeCookies()) {
+      builder.cookies(filterExclusions(Utils.getCookies(request), args.getExclusions()));
+    }
+
+    if (args.isIncludeQueryString()) {
+      builder.queryString(
+          filterExclusions(Utils.getQueryParams(request.uri()), args.getExclusions()));
+    }
+
+    // todo get post data from request.
+
+    return builder.build();
+  }
+
+  private <X> Map<String, X> filterExclusions(Map<String, X> map, Set<String> exclusions) {
+    return map.entrySet().stream()
+        .filter(
+            entry ->
+                exclusions.stream().anyMatch(exclusion -> Utils.match(entry.getKey(), exclusion)))
+        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+  }
+
+  private boolean isSecure(URI uri) {
+    return uri.getScheme().contains("https");
+  }
+}
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/EnvironmentInfoCollectorIF.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/EnvironmentInfoCollectorIF.java
@@ -1,7 +1,6 @@
 package com.prashantchaubey.exceptionlessclient.services;
 
 import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfo;
-import com.prashantchaubey.exceptionlessclient.models.services.EnvironmentInfoGetArgs;
 
 public interface EnvironmentInfoCollectorIF {
   EnvironmentInfo getEnvironmentInfo(EnvironmentInfoGetArgs args);
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/EnvironmentInfoGetArgs.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/EnvironmentInfoGetArgs.java
@@ -1,4 +1,4 @@
-package com.prashantchaubey.exceptionlessclient.models.services;
+package com.prashantchaubey.exceptionlessclient.services;
 
 import lombok.Builder;
 import lombok.Value;
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/RequestInfoCollectorIF.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/RequestInfoCollectorIF.java
@@ -0,0 +1,9 @@
+package com.prashantchaubey.exceptionlessclient.services;
+
+import com.prashantchaubey.exceptionlessclient.models.services.RequestInfo;
+
+import java.net.http.HttpRequest;
+
+public interface RequestInfoCollectorIF {
+  RequestInfo getRequestInfo(HttpRequest request, RequestInfoGetArgs args);
+}
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/services/RequestInfoGetArgs.java b/src/main/java/com/prashantchaubey/exceptionlessclient/services/RequestInfoGetArgs.java
@@ -0,0 +1,18 @@
+package com.prashantchaubey.exceptionlessclient.services;
+
+import lombok.Builder;
+import lombok.Value;
+import lombok.experimental.NonFinal;
+
+import java.util.Set;
+
+@Builder
+@Value
+@NonFinal
+public class RequestInfoGetArgs {
+  private boolean includeIpAddress;
+  private boolean includeCookies;
+  private boolean includeQueryString;
+  private boolean includePostData;
+  private Set<String> exclusions;
+}
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/settings/DefaultSettingsClient.java b/src/main/java/com/prashantchaubey/exceptionlessclient/settings/DefaultSettingsClient.java
@@ -4,7 +4,7 @@
 import com.prashantchaubey.exceptionlessclient.configuration.Configuration;
 import com.prashantchaubey.exceptionlessclient.models.settings.ServerSettings;
 import com.prashantchaubey.exceptionlessclient.models.submission.SettingsResponse;
-import com.prashantchaubey.exceptionlessclient.utils.JsonUtils;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
 import lombok.Builder;
 
 import java.io.IOException;
@@ -52,7 +52,7 @@ public SettingsResponse getSettings(long version) {
       }
 
       ServerSettings serverSettings =
-          JsonUtils.JSON_MAPPER.readValue(response.body(), new TypeReference<ServerSettings>() {});
+          Utils.JSON_MAPPER.readValue(response.body(), new TypeReference<ServerSettings>() {});
 
       return SettingsResponse.builder().success(true).settings(serverSettings).build();
     } catch (URISyntaxException | InterruptedException | IOException e) {
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/submission/DefaultSubmissionClient.java b/src/main/java/com/prashantchaubey/exceptionlessclient/submission/DefaultSubmissionClient.java
@@ -7,7 +7,7 @@
 import com.prashantchaubey.exceptionlessclient.models.UserDescription;
 import com.prashantchaubey.exceptionlessclient.models.submission.SubmissionResponse;
 import com.prashantchaubey.exceptionlessclient.settings.SettingsManager;
-import com.prashantchaubey.exceptionlessclient.utils.JsonUtils;
+import com.prashantchaubey.exceptionlessclient.utils.Utils;
 import lombok.Builder;
 
 import java.io.IOException;
@@ -61,7 +61,7 @@ public SubmissionResponse postUserDescription(String referenceId, UserDescriptio
   private SubmissionResponse postSubmission(String url, Object data) {
     try {
       URI uri = new URI(url);
-      String requestJSON = JsonUtils.JSON_MAPPER.writeValueAsString(data);
+      String requestJSON = Utils.JSON_MAPPER.writeValueAsString(data);
 
       HttpRequest request =
           HttpRequest.newBuilder()
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/utils/EventUtils.java b/src/main/java/com/prashantchaubey/exceptionlessclient/utils/EventUtils.java
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/utils/JsonUtils.java b/src/main/java/com/prashantchaubey/exceptionlessclient/utils/JsonUtils.java
diff --git a/src/main/java/com/prashantchaubey/exceptionlessclient/utils/Utils.java b/src/main/java/com/prashantchaubey/exceptionlessclient/utils/Utils.java
@@ -0,0 +1,62 @@
+package com.prashantchaubey.exceptionlessclient.utils;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.net.URI;
+import java.net.http.HttpRequest;
+import java.util.*;
+
+public final class Utils {
+  public static final ObjectMapper JSON_MAPPER = new ObjectMapper();
+
+  private Utils() {}
+
+  public static <T> T safeGetAs(Object value, Class<T> cls) {
+    if (value == null) {
+      return null;
+    }
+
+    try {
+      return cls.cast(value);
+    } catch (ClassCastException ignored) {
+      return null;
+    }
+  }
+
+  public static Map<String, String> getCookies(HttpRequest request) {
+    Optional<String> maybeRawCookie = request.headers().firstValue("Cookie");
+    if (!maybeRawCookie.isPresent()) {
+      return new HashMap<>();
+    }
+
+    Map<String, String> cookies = new HashMap<>();
+    String[] rawCookieParams = maybeRawCookie.get().split(";");
+    for (String rawCookieNameAndValue : rawCookieParams) {
+      String[] rawCookieNameAndValuePair = rawCookieNameAndValue.split("=");
+      cookies.put(rawCookieNameAndValuePair[0], rawCookieNameAndValuePair[1]);
+    }
+
+    return cookies;
+  }
+
+  public static Map<String, List<String>> getQueryParams(URI uri) {
+    Map<String, List<String>> queryParams = new HashMap<>();
+
+    String[] rawQueryParams = uri.getQuery().split("&");
+    for (String queryParamsNameAndValue : rawQueryParams) {
+      String[] queryParamsNameAndValuePair = queryParamsNameAndValue.split("=");
+      if (!queryParams.containsKey(queryParamsNameAndValuePair[0])) {
+        queryParams.put(queryParamsNameAndValuePair[0], new ArrayList<>());
+      }
+
+      queryParams.get(queryParamsNameAndValuePair[0]).add(queryParamsNameAndValuePair[1]);
+    }
+
+    return queryParams;
+  }
+
+  public static boolean match(String value, String pattern) {
+    // todo check this works or not;
+    return pattern.matches(value);
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package com.prashantchaubey.exceptionlessclient.models.settings;`
`2`	`2`
`3`	`3`	`import com.prashantchaubey.exceptionlessclient.models.enums.ServerSettingKey;`
	`4`	`+import com.prashantchaubey.exceptionlessclient.utils.Utils;`
`4`	`5`	`import lombok.Builder;`
`5`	`6`	`import lombok.Value;`
`6`	`7`	`import lombok.experimental.NonFinal;`
`@@ -30,8 +31,7 @@ public Optional<String> getTypeAndSourceSetting(String type, String source) {`
`30`	`31`	`if (!key.startsWith(prefix) \|\| key.length() <= prefix.length()) {`
`31`	`32`	`continue;`
`32`	`33`	`}`
`33`		`- // todo check that wildcard match work with this or not`
`34`		`- if (source.matches(key.substring(prefix.length()))) {`
	`34`	`+ if (Utils.match(source, key.substring(prefix.length()))) {`
`35`	`35`	`return Optional.of(settings.get(key));`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.prashantchaubey.exceptionlessclient.models.services;`
	`1`	`+package com.prashantchaubey.exceptionlessclient.services;`
`2`	`2`
`3`	`3`	`import lombok.Builder;`
`4`	`4`	`import lombok.Value;`