-
Notifications
You must be signed in to change notification settings - Fork 38
Propagate server response to exception #37
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.
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
Open
uvsmtid
wants to merge
3
commits into
launchdarkly:main
Choose a base branch
from
uvsmtid:propagate-server-response-to-exception
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 41 additions & 4 deletions
45
src/main/java/com/launchdarkly/eventsource/UnsuccessfulResponseException.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,64 @@ | ||
| package com.launchdarkly.eventsource; | ||
|
|
||
| import okhttp3.Protocol; | ||
| import okhttp3.Request; | ||
| import okhttp3.Response; | ||
|
|
||
| /** | ||
| * Exception class that means the remote server returned an HTTP error. | ||
| */ | ||
| @SuppressWarnings("serial") | ||
| public class UnsuccessfulResponseException extends Exception { | ||
|
|
||
| private final int code; | ||
| private final Response response; | ||
|
|
||
| /** | ||
| * Constructs an exception instance. | ||
| * @param code the HTTP status | ||
| */ | ||
| @Deprecated | ||
| public UnsuccessfulResponseException(int code) { | ||
| super("Unsuccessful response code received from stream: " + code); | ||
| this.code = code; | ||
| this(buildSurrogateResponse(code)); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs an exception instance. | ||
| * @param response {@link Response} provided by server | ||
| */ | ||
| public UnsuccessfulResponseException(Response response) { | ||
| super("Unsuccessful response code received from stream: " + response.code()); | ||
| this.response = response; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the HTTP status code. | ||
| * @return the HTTP status | ||
| */ | ||
| public int getCode() { | ||
| return code; | ||
| return response.code(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the HTTP {@link Response}. | ||
| * @return the HTTP {@link Response} | ||
| */ | ||
| public Response getResponse() { | ||
| return response; | ||
| } | ||
|
|
||
| /** | ||
| * Used for backward compatibility only: provide surrogate response for a given code | ||
| */ | ||
| @Deprecated | ||
| private static Response buildSurrogateResponse(int code) { | ||
| return new Response.Builder() | ||
| .request(new Request.Builder() | ||
| .url("http://example.com") | ||
| .build() | ||
| ) | ||
| .protocol(Protocol.HTTP_1_1) | ||
| .message("") | ||
| .code(code) | ||
| .build(); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not do this; it'd be preferable to just let getResponse() return null in this case. The rationale can't be backward compatibility, since old code that uses this deprecated constructor couldn't be looking for a Response.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I also realized that the whole PR didn't work.
I think due to the async fact that the whole response is not available yet when
UnsuccessfulResponseExceptionis created within the library's code (unlike the error code).In other words, there are more changes needed (even if this constructor change is reverted).
So far, we happily used the library without this change anyway - @eli-darkly , I'm OK if it is rejected (when I need it badly, I'll propose proper change).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm. Can you say more about what specifically was not working? I would expect that trying to read the body would not work, since other code might already have read the body - that's just an expected issue whenever you share a Response around. But I would have expected the headers to be available.