Skip to content

feat: Enable gzip option for sending events #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2025
Merged

feat: Enable gzip option for sending events #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions ...hared/internal/src/main/java/com/launchdarkly/sdk/internal/events/DefaultEventSender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import com.launchdarkly.sdk.internal.http.HttpHelpers;
import com.launchdarkly.sdk.internal.http.HttpProperties;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.net.URI;
import java.nio.charset.Charset;
Expand All @@ -13,6 +14,7 @@
import java.util.Date;
import java.util.Locale;
import java.util.UUID;
import java.util.zip.GZIPOutputStream;

import static com.launchdarkly.sdk.internal.http.HttpErrors.checkIfErrorIsRecoverableAndLog;
import static com.launchdarkly.sdk.internal.http.HttpErrors.httpErrorDescription;
Expand Down Expand Up @@ -55,13 +57,24 @@ public final class DefaultEventSender implements EventSender {
Locale.US); // server dates as defined by RFC-822/RFC-1123 use English day/month names
private static final Object HTTP_DATE_FORMAT_LOCK = new Object(); // synchronize on this because DateFormat isn't thread-safe

private static class CompressionResult<T> {
final T data;
final boolean wasCompressed;

CompressionResult(T data, boolean wasCompressed) {
this.data = data;
this.wasCompressed = wasCompressed;
}
}

private final OkHttpClient httpClient;
private final boolean shouldCloseHttpClient;
private final Headers baseHeaders;
private final String analyticsRequestPath;
private final String diagnosticRequestPath;
final long retryDelayMillis; // visible for testing
private final LDLogger logger;
private final boolean enableGzipCompression;

/**
* Creates an instance.
Expand All @@ -70,13 +83,15 @@ public final class DefaultEventSender implements EventSender {
* @param analyticsRequestPath the request path for posting analytics events
* @param diagnosticRequestPath the request path for posting diagnostic events
* @param retryDelayMillis retry delay, or zero to use the default
* @param enableGzipCompression whether to enable gzip compression
* @param logger the logger
*/
public DefaultEventSender(
HttpProperties httpProperties,
String analyticsRequestPath,
String diagnosticRequestPath,
long retryDelayMillis,
boolean enableGzipCompression,
LDLogger logger
) {
if (httpProperties.getSharedHttpClient() == null) {
Expand All @@ -87,6 +102,7 @@ public DefaultEventSender(
shouldCloseHttpClient = false;
}
this.logger = logger;
this.enableGzipCompression = enableGzipCompression;

this.baseHeaders = httpProperties.toHeadersBuilder()
.add("Content-Type", "application/json")
Expand Down Expand Up @@ -115,6 +131,24 @@ public Result sendDiagnosticEvent(byte[] data, URI eventsBaseUri) {
return sendEventData(true, data, 1, eventsBaseUri);
}

private CompressionResult<byte[]> compressData(byte[] data) {
if (!enableGzipCompression) {
return new CompressionResult<>(data, false);
}

try {
ByteArrayOutputStream byteStream = new ByteArrayOutputStream();
try (GZIPOutputStream gzipStream = new GZIPOutputStream(byteStream)) {
gzipStream.write(data);
}
byte[] compressedData = byteStream.toByteArray();
return new CompressionResult<>(compressedData, true);
} catch (IOException e) {
logger.warn("Failed to compress event data, falling back to uncompressed: {}", e.toString());
return new CompressionResult<>(data, false);
}
}

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
Expand All @@ -137,10 +171,15 @@ private Result sendEventData(boolean isDiagnostic, byte[] data, int eventCount,
}

URI uri = HttpHelpers.concatenateUriPath(eventsBaseUri, path);
Headers headers = headersBuilder.build();
RequestBody body = RequestBody.create(data, JSON_CONTENT_TYPE);
CompressionResult<byte[]> compressionResult = compressData(data);
RequestBody body = RequestBody.create(compressionResult.data, JSON_CONTENT_TYPE);
boolean mustShutDown = false;

if (compressionResult.wasCompressed) {
headersBuilder.add("Content-Encoding", "gzip");
}

Headers headers = headersBuilder.build();
logger.debug("Posting {} to {} with payload: {}", description, uri,
LogValues.defer(new LazilyPrintedUtf8Data(data)));

Expand Down
36 changes: 34 additions & 2 deletions ...d/internal/src/test/java/com/launchdarkly/sdk/internal/events/DefaultEventSenderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ private EventSender makeEventSender() {
}

private EventSender makeEventSender(HttpProperties httpProperties) {
return new DefaultEventSender(httpProperties, null, null, BRIEF_RETRY_DELAY_MILLIS, testLogger);
return new DefaultEventSender(httpProperties, null, null, BRIEF_RETRY_DELAY_MILLIS, false, testLogger);
}

@Test
Expand Down Expand Up @@ -92,7 +92,7 @@ public void diagnosticDataIsDelivered() throws Exception {
public void customRequestPaths() throws Exception {
try (HttpServer server = HttpServer.start(eventsSuccessResponse())) {
try (EventSender es = new DefaultEventSender(HttpProperties.defaults(),
"/custom/path/a", "/custom/path/d", BRIEF_RETRY_DELAY_MILLIS, testLogger)) {
"/custom/path/a", "/custom/path/d", BRIEF_RETRY_DELAY_MILLIS, false, testLogger)) {
EventSender.Result result = es.sendAnalyticsEvents(FAKE_DATA_BYTES, 1, server.getUri());
assertTrue(result.isSuccess());
result = es.sendDiagnosticEvent(FAKE_DATA_BYTES, server.getUri());
Expand Down Expand Up @@ -356,6 +356,38 @@ public void nothingIsSentForEmptyData() throws Exception {
}
}

@Test
public void gzipCompressionIsEnabledWhenConfigured() throws Exception {
try (HttpServer server = HttpServer.start(eventsSuccessResponse())) {
try (EventSender es = new DefaultEventSender(HttpProperties.defaults(), null, null, BRIEF_RETRY_DELAY_MILLIS, true, testLogger)) {
EventSender.Result result = es.sendAnalyticsEvents(FAKE_DATA_BYTES, 1, server.getUri());

assertTrue(result.isSuccess());
assertFalse(result.isMustShutDown());
}

RequestInfo req = server.getRecorder().requireRequest();
assertThat(req.getHeader("content-type"), equalToIgnoringCase("application/json; charset=utf-8"));
assertThat(req.getHeader("content-encoding"), equalToIgnoringCase("gzip"));
}
}

@Test
public void gzipCompressionIsDisabledByDefault() throws Exception {
try (HttpServer server = HttpServer.start(eventsSuccessResponse())) {
try (EventSender es = makeEventSender()) {
EventSender.Result result = es.sendAnalyticsEvents(FAKE_DATA_BYTES, 1, server.getUri());

assertTrue(result.isSuccess());
assertFalse(result.isMustShutDown());
}

RequestInfo req = server.getRecorder().requireRequest();
assertThat(req.getHeader("content-type"), equalToIgnoringCase("application/json; charset=utf-8"));
assertThat(req.getHeader("content-encoding"), not(equalToIgnoringCase("gzip")));
}
}

private void testUnrecoverableHttpError(int status) throws Exception {
Handler errorResponse = Handlers.status(status);

Expand Down