Return 503 for unavailable downstream service - #4230
Open
king-407 wants to merge 1 commit into
Open
Conversation
Signed-off-by: king-407 <95581750+king-407@users.noreply.github.com>
anshulgoel22
left a comment
There was a problem hiding this comment.
Thanks for tackling #4208 — returning 503 for unreachable downstream services is the right HTTP semantics here.
What looks good
- Mapping
ConnectExceptionandUnknownHostExceptiontoResponseStatusException(SERVICE_UNAVAILABLE)aligns with how clients, proxies, and load balancers distinguish "upstream temporarily unavailable" from an internal gateway error (500). - The recursive
isUnavailable()cause walk is important for Netty, which often wraps connection failures (e.g.AnnotatedConnectExceptionaroundConnectException, as reported in the issue). - The change follows the existing pattern in this filter for timeout handling (
TimeoutException→ 504), so the error-mapping approach is consistent. - The integration test update validates both status code and response body fields, not just the status integer.
Suggestion (non-blocking)
Issue #4208 also mentions DNS resolution failures in Kubernetes (service not yet published). UnknownHostException is covered by the mapper, but a dedicated integration test for an unresolvable host would make that scenario explicit and guard against regressions.
Overall this is a focused, well-scoped fix. Nice work.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #4208.
This updates the WebFlux
NettyRoutingFilterso downstream connection failures are reported as503 Service Unavailableinstead of500 Internal Server Error.Previously, when Gateway could not connect to the downstream service, for example because the target port was closed, Reactor Netty raised a connection exception and the request resulted in a generic 500 response.
The change maps connection-related failures such as
ConnectExceptionandUnknownHostExceptiontoResponseStatusException(HttpStatus.SERVICE_UNAVAILABLE).Validation:
./mvnw -pl spring-cloud-gateway-server-webflux -Dtest=NettyRoutingFilterIntegrationTests#shouldApplyConnectTimeoutPerRoute test./mvnw -pl spring-cloud-gateway-server-webflux -Dtest=NettyRoutingFilterIntegrationTests testgit diff --check