fix: Fixed Java SDK bugs after QA testing (#1249)

- Fixed bugs due to description of:
#1248
- Reimplemented allowList/denyList logic
- Updated tests

Author: serhii-vydiuk-kevychsolutions

packages/java/examples/SpringMetricsExample/pom.xml

@@ -24,7 +24,7 @@
 			<groupId>com.readme</groupId>
 			<artifactId>metrics-spring</artifactId>
 <!--			<artifactId>metrics-spring2</artifactId>-->
-			<version>0.1.0</version>
+			<version>0.1.1</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

packages/java/examples/SpringMetricsExample/src/main/java/com/owl/example/CustomUserDataCollectorConfig.java

@@ -42,8 +42,9 @@ public UserDataCollector<ServletDataPayloadAdapter> customUserDataCollector() {
     @Bean
     public LogOptions logOptions() {
         return LogOptions.builder()
-                .baseLogUrl("http://baseurl.abcd")
+                .baseLogUrl("http://base.log.url")
                 .bufferLength(1)
+                .denylist(List.of("denied-param"))
                 .build();
     }
 }

packages/java/examples/SpringMetricsExample/src/main/java/com/owl/example/OwlController.java

@@ -41,18 +41,17 @@ public ResponseEntity<String> createOwl(@PathVariable String owlName, @RequestBo
         UUID birdId = UUID.randomUUID();
         owlStorage.put(birdId.toString(), owlName);
 
-        String responseBody = "Bird " + owlName + " created a bird with id: " + birdId + "\n" +
-                "Creation request body: \n" + body;
-
         HttpHeaders headers = new HttpHeaders();
         headers.add("bird-id", birdId.toString());
         headers.add("bird-token", Base64.getEncoder()
                 .encodeToString(birdId.toString()
                         .getBytes()));
+        headers.add("denied-param", "test");
 
         return ResponseEntity.status(HttpStatus.CREATED.getCode())
                 .headers(headers)
-                .body(responseBody);
+                .contentType(MediaType.APPLICATION_JSON)
+                .body(body);
     }
 
     @PutMapping(value = "/owl/urlencoded/{owlName}", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)

packages/java/metrics-core/pom.xml

@@ -27,7 +27,7 @@
     <groupId>com.readme</groupId>
     <name>metrics-core</name>
     <artifactId>metrics-core</artifactId>
-    <version>0.1.0</version>
+    <version>0.1.1</version>
     <description>Core library for Readme.io JVM related SDKs</description>
 
     <properties>

packages/java/metrics-core/src/main/java/com/readme/core/dataextraction/LogOptions.java

@@ -1,13 +1,17 @@
 package com.readme.core.dataextraction;
 
-
-import lombok.Builder;
-import lombok.Value;
+import lombok.Getter;
+import lombok.ToString;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.List;
+import java.util.Locale;
+import java.util.Objects;
+import java.util.Set;
+import java.util.stream.Collectors;
 
-@Value
-@Builder
+@Getter
+@ToString
 public class LogOptions {
 
     /**
@@ -17,33 +21,95 @@ public class LogOptions {
      * If set, the denylist will be ignored.
      */
 
-    List<String> allowlist;
+    private Set<String> allowlist;
 
     /**
      * An array of values to redact from the incoming and outgoing headers, parameters and body.
      */
-    List<String> denylist;
+    private Set<String> denylist;
 
     /**
      * If true, the logs will be marked as development logs.
      */
-    boolean development;
+    private boolean development;
 
     /**
      * If true, this will return the log details without waiting for a response from the Metrics
      * servers.
      */
-    boolean fireAndForget;
+    private boolean fireAndForget;
 
     /**
      * URL for your documentation site
      */
-    String baseLogUrl;
+    private String baseLogUrl;
 
     /**
      * Buffer size
      */
-    @Builder.Default
-    int bufferLength = 1;
+    int bufferLength;
+
+    private LogOptions(Builder builder) {
+        this.allowlist = builder.allowlist;
+        this.denylist = builder.denylist;
+        this.development = builder.development;
+        this.fireAndForget = builder.fireAndForget;
+        this.baseLogUrl = builder.baseLogUrl;
+        this.bufferLength = builder.bufferLength;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static class Builder {
+        private Set<String> allowlist;
+        private Set<String> denylist;
+        private boolean development;
+        private boolean fireAndForget;
+        private String baseLogUrl;
+        private int bufferLength = 1; // default
+
+        @NotNull
+        private static Set<String> castToSetWithLowercase(List<String> allowlist) {
+            return allowlist.stream()
+                    .filter(Objects::nonNull)
+                    .map(a -> a.toLowerCase(Locale.ROOT))
+                    .collect(Collectors.toSet());
+        }
+
+        public Builder allowlist(List<String> allowlist) {
+            this.allowlist = castToSetWithLowercase(allowlist);
+            return this;
+        }
+
+        public Builder denylist(List<String> denylist) {
+            this.denylist = castToSetWithLowercase(denylist);;
+            return this;
+        }
+
+        public Builder development(boolean development) {
+            this.development = development;
+            return this;
+        }
+
+        public Builder fireAndForget(boolean fireAndForget) {
+            this.fireAndForget = fireAndForget;
+            return this;
+        }
+
+        public Builder baseLogUrl(String baseLogUrl) {
+            this.baseLogUrl = baseLogUrl;
+            return this;
+        }
+
+        public Builder bufferLength(int bufferLength) {
+            this.bufferLength = bufferLength;
+            return this;
+        }
 
+        public LogOptions build() {
+            return new LogOptions(this);
+        }
+    }
 }

packages/java/metrics-core/src/main/java/com/readme/core/dataextraction/payload/PayloadData.java

@@ -6,6 +6,7 @@
 import lombok.Value;
 
 import java.util.Date;
+import java.util.UUID;
 
 /**
  * Represents the complete payload for logging an API interaction, combining user-specific data, detailed API request
@@ -35,4 +36,9 @@ public class PayloadData {
      */
     Date responseEndDateTime;
 
+    /**
+     * Log ID - randomly generated during collecting request/response data
+     */
+    UUID logId;
+
 }

packages/java/metrics-core/src/main/java/com/readme/core/dataextraction/payload/requestresponse/BaseRequestResponseData.java

@@ -0,0 +1,22 @@
+package com.readme.core.dataextraction.payload.requestresponse;
+
+import lombok.Data;
+import lombok.experimental.SuperBuilder;
+
+import java.util.Map;
+
+@Data
+@SuperBuilder
+public abstract class BaseRequestResponseData {
+
+    /**
+     * Request body prepared for logging
+     */
+    String body;
+
+    /**
+     * A map of HTTP headers included in the request.
+     */
+    Map<String, String> headers;
+
+}

packages/java/metrics-core/src/main/java/com/readme/core/dataextraction/payload/requestresponse/RequestData.java

@@ -1,9 +1,7 @@
 package com.readme.core.dataextraction.payload.requestresponse;
 
-import lombok.Builder;
-import lombok.Data;
-import lombok.Setter;
-import lombok.Value;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
 
 import java.util.Map;
 
@@ -13,13 +11,9 @@
  * request body, and metadata related to the request.
  */
 @Data
-@Builder
-public class RequestData {
-
-    /**
-     * Request body prepared for logging
-     */
-    private String body;
+@SuperBuilder
+@EqualsAndHashCode
+public class RequestData extends BaseRequestResponseData {
 
     /**
      * The route path associated with the request (e.g., "/api/v1/resource").
@@ -46,15 +40,9 @@ public class RequestData {
      */
     private String method;
 
-    /**
-     * A map of HTTP headers included in the request.
-     */
-    private Map<String, String> headers;
-
     /**
      * A map of query parameters extracted from the request URL.
      */
     private Map<String, String> requestParameters;
 
-
 }

packages/java/metrics-core/src/main/java/com/readme/core/dataextraction/payload/requestresponse/ResponseData.java

@@ -1,7 +1,7 @@
 package com.readme.core.dataextraction.payload.requestresponse;
 
-import lombok.Builder;
-import lombok.Value;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
 
 import java.util.Map;
 
@@ -10,20 +10,10 @@
  * This class encapsulates key response attributes such as status code, headers,
  * response body, and status message.
  */
-@Value
-@Builder
-public class ResponseData {
-
-    /**
-     * The response body sent back to the client.
-     */
-    String body;
-
-    /**
-     * A map of HTTP headers included in the response.
-     */
-    Map<String, String> headers;
-
+@Data
+@SuperBuilder
+@EqualsAndHashCode
+public class ResponseData extends BaseRequestResponseData {
     /**
      * The HTTP status code of the response (e.g., 200 for OK, 404 for Not Found).
      */

packages/java/metrics-core/src/main/java/com/readme/core/datatransfer/HttpDataSender.java

@@ -11,7 +11,6 @@
 import java.util.List;
 
 import static com.readme.core.config.ReadmeApiConfig.README_METRICS_URL;
-import static com.readme.core.datatransfer.BaseLogUrlFetcher.fetchBaseLogUrl;
 import static com.readme.core.datatransfer.ReadmeApiKeyEncoder.encode;
 
 /**
@@ -84,15 +83,11 @@ private static Request createRequest(List<OutgoingLogBody> payloadData, LogOptio
         RequestBody body = RequestBody
                 .create(outgoingLogBody, MediaType.get(APPLICATION_JSON_TYPE));
 
-        String baseLogUrl = logOptions.getBaseLogUrl() != null ? logOptions.getBaseLogUrl() : fetchBaseLogUrl(encodedReadmeApiKey);
-
-
         return new Request.Builder()
                 .url(README_METRICS_URL)
                 .header("Accept", APPLICATION_JSON_TYPE)
                 .header("Content-Type", APPLICATION_JSON_TYPE)
                 .header("Authorization", encodedReadmeApiKey)
-                .header("x-documentation-url", baseLogUrl)
                 .method("POST", body)
                 .build();
     }