prepare 1.3.0 release (#10)

## [1.3.0] - 2024-03-13
### Changed:
- Redact anonymous attributes within feature events
- Always inline contexts for feature events

---------

Co-authored-by: Eli Bishop <[email protected]>
Co-authored-by: LaunchDarklyReleaseBot <[email protected]>
Co-authored-by: Todd Anderson <[email protected]>
Co-authored-by: tanderson-ld <[email protected]>
Co-authored-by: ld-repository-standards[bot] <113625520+ld-repository-standards[bot]@users.noreply.github.com>
Co-authored-by: Kane Parkinson <[email protected]>
Co-authored-by: Ryan Lamb <[email protected]>
Co-authored-by: Matthew M. Keeler <[email protected]>

Author: 8 people

src/main/java/com/launchdarkly/sdk/internal/events/DefaultEventSender.java

@@ -34,7 +34,7 @@ public final class DefaultEventSender implements EventSender {
    * Default value for {@code retryDelayMillis} parameter.
    */
   public static final long DEFAULT_RETRY_DELAY_MILLIS = 1000;
-  
+
   /**
    * Default value for {@code analyticsRequestPath} parameter, for the server-side SDK.
    * The Android SDK should modify this value.
@@ -46,7 +46,7 @@ public final class DefaultEventSender implements EventSender {
    * The Android SDK should modify this value.
    */
   public static final String DEFAULT_DIAGNOSTIC_REQUEST_PATH = "/diagnostic";
-  
+
   private static final String EVENT_SCHEMA_HEADER = "X-LaunchDarkly-Event-Schema";
   private static final String EVENT_SCHEMA_VERSION = "4";
   private static final String EVENT_PAYLOAD_ID_HEADER = "X-LaunchDarkly-Payload-ID";
@@ -65,7 +65,7 @@ public final class DefaultEventSender implements EventSender {
 
   /**
    * Creates an instance.
-   * 
+   *
    * @param httpProperties the HTTP configuration
    * @param analyticsRequestPath the request path for posting analytics events
    * @param diagnosticRequestPath the request path for posting diagnostic events
@@ -91,20 +91,20 @@ public DefaultEventSender(
     this.baseHeaders = httpProperties.toHeadersBuilder()
         .add("Content-Type", "application/json")
         .build();
-    
+
     this.analyticsRequestPath = analyticsRequestPath == null ? DEFAULT_ANALYTICS_REQUEST_PATH : analyticsRequestPath;
     this.diagnosticRequestPath = diagnosticRequestPath == null ? DEFAULT_DIAGNOSTIC_REQUEST_PATH : diagnosticRequestPath;
-    
+
     this.retryDelayMillis = retryDelayMillis <= 0 ? DEFAULT_RETRY_DELAY_MILLIS : retryDelayMillis;
   }
-  
+
   @Override
   public void close() throws IOException {
     if (shouldCloseHttpClient) {
       HttpProperties.shutdownHttpClient(httpClient);
     }
   }
-  
+
   @Override
   public Result sendAnalyticsEvents(byte[] data, int eventCount, URI eventsBaseUri) {
     return sendEventData(false, data, eventCount, eventsBaseUri);
@@ -114,33 +114,33 @@ public Result sendAnalyticsEvents(byte[] data, int eventCount, URI eventsBaseUri
   public Result sendDiagnosticEvent(byte[] data, URI eventsBaseUri) {
     return sendEventData(true, data, 1, eventsBaseUri);
   }
-  
+
   private Result sendEventData(boolean isDiagnostic, byte[] data, int eventCount, URI eventsBaseUri) {
     if (data == null || data.length == 0) {
       // DefaultEventProcessor won't normally pass us an empty payload, but if it does, don't bother sending
       return new Result(true, false, null);
     }
-    
+
     Headers.Builder headersBuilder = baseHeaders.newBuilder();
     String path;
     String description;
-    
+
     if (isDiagnostic) {
       path = diagnosticRequestPath;
-      description = "diagnostic event";    
+      description = "diagnostic event";
     } else {
       path = analyticsRequestPath;
       String eventPayloadId = UUID.randomUUID().toString();
       headersBuilder.add(EVENT_PAYLOAD_ID_HEADER, eventPayloadId);
       headersBuilder.add(EVENT_SCHEMA_HEADER, EVENT_SCHEMA_VERSION);
       description = String.format("%d event(s)", eventCount);
     }
-    
+
     URI uri = HttpHelpers.concatenateUriPath(eventsBaseUri, path);
     Headers headers = headersBuilder.build();
     RequestBody body = RequestBody.create(data, JSON_CONTENT_TYPE);
     boolean mustShutDown = false;
-    
+
     logger.debug("Posting {} to {} with payload: {}", description, uri,
         LogValues.defer(new LazilyPrintedUtf8Data(data)));
 
@@ -162,15 +162,15 @@ private Result sendEventData(boolean isDiagnostic, byte[] data, int eventCount,
       long startTime = System.currentTimeMillis();
       String nextActionMessage = attempt == 0 ? "will retry" : "some events were dropped";
       String errorContext = "posting " + description;
-      
+
       try (Response response = httpClient.newCall(request).execute()) {
         long endTime = System.currentTimeMillis();
         logger.debug("{} delivery took {} ms, response status {}", description, endTime - startTime, response.code());
-        
+
         if (response.isSuccessful()) {
           return new Result(true, false, parseResponseDate(response));
         }
-        
+
         String errorDesc = httpErrorDescription(response.code());
         boolean recoverable = checkIfErrorIsRecoverableAndLog(
             logger,
@@ -187,10 +187,10 @@ private Result sendEventData(boolean isDiagnostic, byte[] data, int eventCount,
         checkIfErrorIsRecoverableAndLog(logger, e.toString(), errorContext, 0, nextActionMessage);
       }
     }
-    
+
     return new Result(false, mustShutDown, null);
   }
-  
+
   private final Date parseResponseDate(Response response) {
     String dateStr = response.header("Date");
     if (dateStr != null) {
@@ -205,10 +205,10 @@ private final Date parseResponseDate(Response response) {
     }
     return null;
   }
-  
+
   private final class LazilyPrintedUtf8Data implements LogValues.StringProvider {
     private final byte[] data;
-    
+
     LazilyPrintedUtf8Data(byte[] data) {
       this.data = data;
     }

src/main/java/com/launchdarkly/sdk/internal/events/EventContextFormatter.java

@@ -30,25 +30,25 @@ class EventContextFormatter {
     this.allAttributesPrivate = allAttributesPrivate;
     this.globalPrivateAttributes = globalPrivateAttributes == null ? new AttributeRef[0] : globalPrivateAttributes;
   }
-  
-  public void write(LDContext c, JsonWriter w) throws IOException {
+
+  public void write(LDContext c, JsonWriter w, boolean redactAnonymous) throws IOException {
     if (c.isMultiple()) {
       w.beginObject();
       w.name("kind").value("multi");
       for (int i = 0; i < c.getIndividualContextCount(); i++) {
         LDContext c1 = c.getIndividualContext(i);
         w.name(c1.getKind().toString());
-        writeSingleKind(c1, w, false);
+        writeSingleKind(c1, w, false, redactAnonymous);
       }
       w.endObject();
     } else {
-      writeSingleKind(c, w, true);
+      writeSingleKind(c, w, true, redactAnonymous);
     }
   }
-  
-  private void writeSingleKind(LDContext c, JsonWriter w, boolean includeKind) throws IOException {
+
+  private void writeSingleKind(LDContext c, JsonWriter w, boolean includeKind, boolean redactAnonymous) throws IOException {
     w.beginObject();
-    
+
     // kind, key, and anonymous are never redacted
     if (includeKind) {
       w.name("kind").value(c.getKind().toString());
@@ -57,21 +57,20 @@ private void writeSingleKind(LDContext c, JsonWriter w, boolean includeKind) thr
     if (c.isAnonymous()) {
       w.name("anonymous").value(true);
     }
-    
+
     List<String> redacted = null;
-    
     if (c.getName() != null) {
-      if (isAttributeEntirelyPrivate(c, "name")) {
+      if (isAttributeEntirelyPrivate(c, "name", redactAnonymous)) {
         redacted = addOrCreate(redacted, "name");
       } else {
         w.name("name").value(c.getName());
       }
     }
-    
+
     for (String attrName: c.getCustomAttributeNames()) {
-      redacted = writeOrRedactAttribute(w, c, attrName, c.getValue(attrName), redacted);
+      redacted = writeOrRedactAttribute(w, c, attrName, c.getValue(attrName), redacted, redactAnonymous);
     }
-    
+
     boolean haveRedacted = redacted != null && !redacted.isEmpty();
     if (haveRedacted) {
       w.name("_meta").beginObject();
@@ -82,31 +81,36 @@ private void writeSingleKind(LDContext c, JsonWriter w, boolean includeKind) thr
       w.endArray();
       w.endObject();
     }
-    
+
     w.endObject();
   }
-  
-  private boolean isAttributeEntirelyPrivate(LDContext c, String attrName) {
+
+  private boolean isAttributeEntirelyPrivate(LDContext c, String attrName, boolean redactAnonymous) {
     if (allAttributesPrivate) {
       return true;
+    } else if (redactAnonymous && c.isAnonymous()) {
+        return true;
     }
     AttributeRef privateRef = findPrivateRef(c, 1, attrName, null);
     return privateRef != null && privateRef.getDepth() == 1;
   }
-  
+
   private List<String> writeOrRedactAttribute(
       JsonWriter w,
       LDContext c,
       String attrName,
       LDValue value,
-      List<String> redacted
+      List<String> redacted,
+      boolean redactAnonymous
       ) throws IOException {
     if (allAttributesPrivate) {
       return addOrCreate(redacted, attrName);
+    } else if (redactAnonymous && c.isAnonymous()) {
+      return addOrCreate(redacted, attrName);
     }
     return writeRedactedValue(w, c, 0, attrName, value, null, redacted);
   }
-  
+
   // This method implements the context-aware attribute redaction logic, in which an attribute
   // can be 1. written as-is, 2. fully redacted, or 3. (for a JSON object) partially redacted.
   // It returns the updated redacted attribute list.