Skip to content

Commit 08abc7e

Browse files
kinyoklionkinyoklion
committed
chore: Pipe headers through data sources.
1 parent 3042ad4 commit 08abc7e

12 files changed

Lines changed: 785 additions & 119 deletions

‎lib/sdk/server/build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ ext.versions = [
7474
"launchdarklyJavaSdkInternal": "1.6.1",
7575
"launchdarklyLogging": "1.1.0",
7676
"okhttp": "4.12.0", // specify this for the SDK build instead of relying on the transitive dependency from okhttp-eventsource
77-
"okhttpEventsource": "4.1.0",
77+
"okhttpEventsource": "4.2.0",
7878
"reactorCore":"3.3.22.RELEASE",
7979
"slf4j": "1.7.36",
8080
"snakeyaml": "2.4",

‎lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/DefaultFDv2Requestor.java‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
import com.launchdarkly.logging.LDLogger;
44
import com.launchdarkly.sdk.internal.fdv2.payloads.FDv2Event;
55
import com.launchdarkly.sdk.internal.fdv2.sources.Selector;
6-
import com.launchdarkly.sdk.internal.http.HttpErrors;
76
import com.launchdarkly.sdk.internal.http.HttpHelpers;
87
import com.launchdarkly.sdk.internal.http.HttpProperties;
9-
import com.launchdarkly.sdk.json.SerializationException;
108

119
import okhttp3.Call;
1210
import okhttp3.Callback;
@@ -104,17 +102,15 @@ public void onFailure(@Nonnull Call call, @Nonnull IOException e) {
104102
@Override
105103
public void onResponse(@Nonnull Call call, @Nonnull Response response) {
106104
try {
107-
// Handle 304 Not Modified - no new data
105+
// Handle 304 Not Modified - no new data, but return response with headers
108106
if (response.code() == 304) {
109107
logger.debug("FDv2 polling request returned 304: not modified");
110-
future.complete(null);
108+
future.complete(FDv2PayloadResponse.none(response.code()));
111109
return;
112110
}
113111

114112
if (!response.isSuccessful()) {
115-
future.completeExceptionally(
116-
new HttpErrors.HttpErrorException(response.code())
117-
);
113+
future.complete(FDv2PayloadResponse.failure(response.code(), response.headers()));
118114
return;
119115
}
120116

@@ -136,7 +132,7 @@ public void onResponse(@Nonnull Call call, @Nonnull Response response) {
136132
List<FDv2Event> events = FDv2Event.parseEventsArray(responseBody);
137133

138134
// Create and return the response
139-
FDv2PayloadResponse pollingResponse = new FDv2PayloadResponse(events, response.headers());
135+
FDv2PayloadResponse pollingResponse = FDv2PayloadResponse.success(events, response.headers(), response.code());
140136
future.complete(pollingResponse);
141137

142138
} catch (Exception e) {

‎lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/FDv2Requestor.java‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,31 @@ interface FDv2Requestor {
1818
* to get from one payload version to another.
1919
* This isn't intended for use for implementations which may require multiple executions to get an entire payload.
2020
*/
21-
public static class FDv2PayloadResponse {
21+
public static class FDv2PayloadResponse {
2222
private final List<FDv2Event> events;
2323
private final Headers headers;
2424

25-
public FDv2PayloadResponse(List<FDv2Event> events, Headers headers) {
25+
private final boolean successful;
26+
27+
private final int statusCode;
28+
29+
private FDv2PayloadResponse(List<FDv2Event> events, Headers headers, boolean success, int statusCode) {
2630
this.events = events;
2731
this.headers = headers;
32+
this.successful = success;
33+
this.statusCode = statusCode;
34+
}
35+
36+
public static FDv2PayloadResponse failure(int statusCode, Headers headers) {
37+
return new FDv2PayloadResponse(null, headers, false, statusCode);
38+
}
39+
40+
public static FDv2PayloadResponse success(List<FDv2Event> events, Headers headers, int statusCode) {
41+
return new FDv2PayloadResponse(events, headers, true, statusCode);
42+
}
43+
44+
public static FDv2PayloadResponse none(int statusCode) {
45+
return new FDv2PayloadResponse(null, null, true, statusCode);
2846
}
2947

3048
public List<FDv2Event> getEvents() {
@@ -34,6 +52,14 @@ public List<FDv2Event> getEvents() {
3452
public Headers getHeaders() {
3553
return headers;
3654
}
55+
56+
public boolean isSuccess() {
57+
return successful;
58+
}
59+
60+
public int getStatusCode() {
61+
return statusCode;
62+
}
3763
}
3864
CompletableFuture<FDv2PayloadResponse> Poll(Selector selector);
3965

‎lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/HeaderConstants.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package com.launchdarkly.sdk.server;
2+
3+
enum HeaderConstants {
4+
ENVIRONMENT_ID("x-ld-envid"),
5+
FDV1_FALLBACK("x-ld-fd-fallback");
6+
7+
private final String headerName;
8+
9+
HeaderConstants(String headerName) {
10+
this.headerName = headerName;
11+
}
12+
13+
public String getHeaderName() {
14+
return headerName;
15+
}
16+
}

‎lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/PollingBase.java‎

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,33 @@ protected void internalShutdown() {
2929
requestor.close();
3030
}
3131

32+
private static boolean getFallback(FDv2Requestor.FDv2PayloadResponse response) {
33+
if (response != null && response.getHeaders() != null) {
34+
String headerValue = response.getHeaders().get(HeaderConstants.FDV1_FALLBACK.getHeaderName());
35+
return headerValue != null && headerValue.equalsIgnoreCase("true");
36+
}
37+
// if(ex != null) {
38+
// if(ex instanceof HttpErrorException) {
39+
// ((HttpErrors.HttpErrorException) ex).
40+
// }
41+
// }
42+
43+
return false;
44+
}
45+
46+
private static String getEnvironmentId(FDv2Requestor.FDv2PayloadResponse response) {
47+
if (response != null && response.getHeaders() != null) {
48+
return response.getHeaders().get(HeaderConstants.ENVIRONMENT_ID.getHeaderName());
49+
}
50+
return null;
51+
}
52+
3253
protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean oneShot) {
3354
return requestor.Poll(selector).handle(((pollingResponse, ex) -> {
55+
boolean fdv1Fallback = getFallback(pollingResponse);
56+
String environmentId = getEnvironmentId(pollingResponse);
3457
if (ex != null) {
35-
if (ex instanceof HttpErrors.HttpErrorException) {
36-
HttpErrors.HttpErrorException e = (HttpErrors.HttpErrorException) ex;
37-
DataSourceStatusProvider.ErrorInfo errorInfo = DataSourceStatusProvider.ErrorInfo.fromHttpError(e.getStatus());
38-
// Errors without an HTTP status are recoverable. If there is a status, then we check if the error
39-
// is recoverable.
40-
boolean recoverable = e.getStatus() <= 0 || isHttpErrorRecoverable(e.getStatus());
41-
logger.error("Polling request failed with HTTP error: {}", e.getStatus());
42-
// For a one-shot request all errors are terminal.
43-
if (oneShot) {
44-
return FDv2SourceResult.terminalError(errorInfo);
45-
} else {
46-
return recoverable ? FDv2SourceResult.interrupted(errorInfo) : FDv2SourceResult.terminalError(errorInfo);
47-
}
48-
} else if (ex instanceof IOException) {
58+
if (ex instanceof IOException) {
4959
IOException e = (IOException) ex;
5060
logger.error("Polling request failed with network error: {}", e.toString());
5161
DataSourceStatusProvider.ErrorInfo info = new DataSourceStatusProvider.ErrorInfo(
@@ -54,7 +64,7 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
5464
e.toString(),
5565
new Date().toInstant()
5666
);
57-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
67+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
5868
} else if (ex instanceof SerializationException) {
5969
SerializationException e = (SerializationException) ex;
6070
logger.error("Polling request received malformed data: {}", e.toString());
@@ -64,7 +74,7 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
6474
e.toString(),
6575
new Date().toInstant()
6676
);
67-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
77+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
6878
}
6979
String msg = ex.toString();
7080
logger.error("Polling request failed with an unknown error: {}", msg);
@@ -74,17 +84,30 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
7484
msg,
7585
new Date().toInstant()
7686
);
77-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
87+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
7888
}
79-
// A null polling response indicates that we received a 304, which means nothing has changed.
80-
if (pollingResponse == null) {
89+
// If we get a 304, then that means nothing has changed.
90+
if (pollingResponse.getStatusCode() == 304) {
8191
return FDv2SourceResult.changeSet(
8292
new DataStoreTypes.ChangeSet<>(DataStoreTypes.ChangeSetType.None,
8393
Selector.EMPTY,
8494
null,
85-
// TODO: Implement environment ID support.
86-
null
87-
));
95+
null // Header derived values will have been handled on initial response.
96+
),
97+
// Headers would have been processed from the initial response.
98+
false);
99+
}
100+
if(!pollingResponse.isSuccess()) {
101+
int statusCode = pollingResponse.getStatusCode();
102+
boolean recoverable = statusCode <= 0 || isHttpErrorRecoverable(statusCode);
103+
DataSourceStatusProvider.ErrorInfo errorInfo = DataSourceStatusProvider.ErrorInfo.fromHttpError(statusCode);
104+
logger.error("Polling request failed with HTTP error: {}", statusCode);
105+
// For a one-shot request all errors are terminal.
106+
if (oneShot) {
107+
return FDv2SourceResult.terminalError(errorInfo, fdv1Fallback);
108+
} else {
109+
return recoverable ? FDv2SourceResult.interrupted(errorInfo, fdv1Fallback) : FDv2SourceResult.terminalError(errorInfo, fdv1Fallback);
110+
}
88111
}
89112
FDv2ProtocolHandler handler = new FDv2ProtocolHandler();
90113
for (FDv2Event event : pollingResponse.getEvents()) {
@@ -96,10 +119,9 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
96119
DataStoreTypes.ChangeSet<DataStoreTypes.ItemDescriptor> converted = FDv2ChangeSetTranslator.toChangeSet(
97120
((FDv2ProtocolHandler.FDv2ActionChangeset) res).getChangeset(),
98121
logger,
99-
// TODO: Implement environment ID support.
100-
null
122+
environmentId
101123
);
102-
return FDv2SourceResult.changeSet(converted);
124+
return FDv2SourceResult.changeSet(converted, fdv1Fallback);
103125
} catch (Exception e) {
104126
// TODO: Do we need to be more specific about the exception type here?
105127
DataSourceStatusProvider.ErrorInfo info = new DataSourceStatusProvider.ErrorInfo(
@@ -108,7 +130,7 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
108130
e.toString(),
109131
new Date().toInstant()
110132
);
111-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
133+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
112134
}
113135
case ERROR: {
114136
FDv2ProtocolHandler.FDv2ActionError error = ((FDv2ProtocolHandler.FDv2ActionError) res);
@@ -117,10 +139,10 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
117139
0,
118140
error.getReason(),
119141
new Date().toInstant());
120-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
142+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
121143
}
122144
case GOODBYE:
123-
return FDv2SourceResult.goodbye(((FDv2ProtocolHandler.FDv2ActionGoodbye) res).getReason());
145+
return FDv2SourceResult.goodbye(((FDv2ProtocolHandler.FDv2ActionGoodbye) res).getReason(), fdv1Fallback);
124146
case NONE:
125147
break;
126148
case INTERNAL_ERROR: {
@@ -141,7 +163,7 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
141163
0,
142164
"Internal error occurred during polling",
143165
new Date().toInstant());
144-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
166+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
145167
}
146168
}
147169
}
@@ -152,7 +174,7 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
152174
"Unexpected end of polling response",
153175
new Date().toInstant()
154176
);
155-
return oneShot ? FDv2SourceResult.terminalError(info) : FDv2SourceResult.interrupted(info);
177+
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
156178
}));
157179
}
158180
}

‎lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/PollingInitializerImpl.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package com.launchdarkly.sdk.server;
22

33
import com.launchdarkly.logging.LDLogger;
4-
import com.launchdarkly.sdk.internal.fdv2.sources.Selector;
54
import com.launchdarkly.sdk.server.datasources.FDv2SourceResult;
65
import com.launchdarkly.sdk.server.datasources.Initializer;
76
import com.launchdarkly.sdk.server.datasources.SelectorSource;

0 commit comments

Comments
 (0)