Skip to content

chore: Finish goodbye handling. #130

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
kinyoklion merged 2 commits into from
Feb 4, 2026
Merged

chore: Finish goodbye handling. #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93638fe
chore: Finish goodbye handling.
kinyoklion Feb 4, 2026
b20c3c4
Merge branch 'main' into rlamb/connect-goodbye-reason
tanderson-ld Feb 4, 2026
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
4 changes: 3 additions & 1 deletion lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/PollingBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,9 @@ protected CompletableFuture<FDv2SourceResult> poll(Selector selector, boolean on
return oneShot ? FDv2SourceResult.terminalError(info, fdv1Fallback) : FDv2SourceResult.interrupted(info, fdv1Fallback);
}
case GOODBYE:
return FDv2SourceResult.goodbye(((FDv2ProtocolHandler.FDv2ActionGoodbye) res).getReason(), fdv1Fallback);
String reason = ((FDv2ProtocolHandler.FDv2ActionGoodbye) res).getReason();
logger.info("Goodbye was received from the LaunchDarkly connection with reason: '{}'.", reason);
Copy link
Member Author

@kinyoklion kinyoklion Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 


### Requirement 3.3.5
> The SDK **MUST** log the following message at the `info` level when a `goodbye` event is encountered. The message **MUST** include the reason.
>
> `Goodbye was received from the LaunchDarkly connection with reason: '{reason}'.`

return FDv2SourceResult.goodbye(reason, fdv1Fallback);
case NONE:
break;
case INTERNAL_ERROR: {
Expand Down
5 changes: 3 additions & 2 deletions lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/StreamingSynchronizerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,9 @@ private void handleMessage(MessageEvent event) {
break;

case GOODBYE:
FDv2ProtocolHandler.FDv2ActionGoodbye goodbye = (FDv2ProtocolHandler.FDv2ActionGoodbye) action;
result = FDv2SourceResult.goodbye(goodbye.getReason(), getFallback(event));
String reason = ((FDv2ProtocolHandler.FDv2ActionGoodbye) action).getReason();
logger.info("Goodbye was received from the LaunchDarkly connection with reason: '{}'.", reason);
result = FDv2SourceResult.goodbye(reason, getFallback(event));
// We drop this current connection and attempt to restart the stream.
restartStream();
break;
Expand Down
38 changes: 32 additions & 6 deletions lib/sdk/server/src/main/java/com/launchdarkly/sdk/server/datasources/FDv2SourceResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ public static class Status {
private final State state;
private final DataSourceStatusProvider.ErrorInfo errorInfo;

private final String reason;

public State getState() {
return state;
}
Expand All @@ -62,9 +64,34 @@ public DataSourceStatusProvider.ErrorInfo getErrorInfo() {
return errorInfo;
}

public Status(State state, DataSourceStatusProvider.ErrorInfo errorInfo) {
Status(State state, DataSourceStatusProvider.ErrorInfo errorInfo, String reason) {
this.state = state;
this.errorInfo = errorInfo;
this.reason = reason;
}

public static Status goodbye(String reason) {
Copy link
Member Author

@kinyoklion kinyoklion Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added these factories to make it a bit tidier in usage.

return new Status(State.GOODBYE, null, reason);
}

public static Status interrupted(DataSourceStatusProvider.ErrorInfo errorInfo) {
return new Status(State.INTERRUPTED, errorInfo, null);
}

public static Status terminalError(DataSourceStatusProvider.ErrorInfo errorInfo) {
return new Status(State.TERMINAL_ERROR, errorInfo, null);
}

public static Status shutdown() {
return new Status(State.SHUTDOWN, null, null);
}

/**
* If the state is GOODBYE, then this will be the reason. Otherwise, it will be null.
* @return the reason, or null
*/
public String getReason() {
return reason;
}
}

Expand Down Expand Up @@ -97,7 +124,7 @@ public static FDv2SourceResult interrupted(DataSourceStatusProvider.ErrorInfo er
public static FDv2SourceResult interrupted(DataSourceStatusProvider.ErrorInfo errorInfo, boolean fdv1Fallback, Function<Void, Void> completionCallback) {
return new FDv2SourceResult(
null,
new Status(State.INTERRUPTED, errorInfo),
Status.interrupted(errorInfo),
ResultType.STATUS,
fdv1Fallback,
completionCallback);
Expand All @@ -109,7 +136,7 @@ public static FDv2SourceResult shutdown() {

public static FDv2SourceResult shutdown(Function<Void, Void> completionCallback) {
return new FDv2SourceResult(null,
new Status(State.SHUTDOWN, null),
Status.shutdown(),
ResultType.STATUS,
false,
completionCallback);
Expand All @@ -121,7 +148,7 @@ public static FDv2SourceResult terminalError(DataSourceStatusProvider.ErrorInfo

public static FDv2SourceResult terminalError(DataSourceStatusProvider.ErrorInfo errorInfo, boolean fdv1Fallback, Function<Void, Void> completionCallback) {
return new FDv2SourceResult(null,
new Status(State.TERMINAL_ERROR, errorInfo),
Status.terminalError(errorInfo),
ResultType.STATUS,
fdv1Fallback,
completionCallback);
Expand All @@ -145,10 +172,9 @@ public static FDv2SourceResult goodbye(String reason, boolean fdv1Fallback) {
}

public static FDv2SourceResult goodbye(String reason, boolean fdv1Fallback, Function<Void, Void> completionCallback) {
// TODO: Goodbye reason.
return new FDv2SourceResult(
null,
new Status(State.GOODBYE, null),
Status.goodbye(reason),
ResultType.STATUS,
fdv1Fallback,
completionCallback);
Expand Down
3 changes: 3 additions & 0 deletions lib/sdk/server/src/test/java/com/launchdarkly/sdk/server/StreamingSynchronizerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ public void httpRecoverableError() throws Exception {
assertEquals(FDv2SourceResult.ResultType.STATUS, result.getResultType());
assertEquals(FDv2SourceResult.State.INTERRUPTED, result.getStatus().getState());
assertEquals(DataSourceStatusProvider.ErrorKind.ERROR_RESPONSE, result.getStatus().getErrorInfo().getKind());
assertNull(result.getStatus().getReason());

synchronizer.close();
}
Expand Down Expand Up @@ -238,6 +239,7 @@ public void shutdownBeforeEventReceived() throws Exception {
assertEquals(FDv2SourceResult.ResultType.STATUS, result.getResultType());
assertEquals(FDv2SourceResult.State.SHUTDOWN, result.getStatus().getState());
assertNull(result.getStatus().getErrorInfo());
assertNull(result.getStatus().getReason());
}
}

Expand Down Expand Up @@ -314,6 +316,7 @@ public void goodbyeEventInResponse() throws Exception {
assertNotNull(result1);
assertEquals(FDv2SourceResult.ResultType.STATUS, result1.getResultType());
assertEquals(FDv2SourceResult.State.GOODBYE, result1.getStatus().getState());
assertEquals("service-unavailable", result1.getStatus().getReason());

// Second result should be a changeset from the restarted stream
CompletableFuture<FDv2SourceResult> result2Future = synchronizer.next();
Expand Down