Spring/spring-graphql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Consistent Publisher error handling with SSE

Browse Source 
Closes gh-1080
This commit is contained in:
rstoyanchev
2024-10-18 16:36:36 +01:00
parent cb9afd0928
commit 58cce019ed
4 changed files with 43 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spring-graphql/src/main/java/org/springframework/graphql/server/webflux/GraphQlSseHandler.java
View File

@@ -24,6 +24,7 @@ import java.util.Map;
import graphql.ErrorType;
import graphql.ExecutionResult;
import graphql.GraphQLError;
import graphql.GraphqlErrorBuilder;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@@ -86,7 +87,7 @@ public class GraphQlSseHandler extends AbstractGraphQlHttpHandler {
if (response.getData() instanceof Publisher) {
resultFlux = Flux.from((Publisher<ExecutionResult>) response.getData())
.map(ExecutionResult::toSpecification)
.onErrorResume(SubscriptionPublisherException.class, (ex) -> Mono.just(ex.toMap()));
.onErrorResume(this::exceptionToResultMap);
}
else {
if (this.logger.isDebugEnabled()) {
@@ -102,14 +103,25 @@ public class GraphQlSseHandler extends AbstractGraphQlHttpHandler {
}
Flux<ServerSentEvent<Map<String, Object>>> sseFlux =
resultFlux.map((event) -> ServerSentEvent.builder(event).event("next").build());
resultFlux.map((event) -> ServerSentEvent.builder(event).event("next").build())
.concatWith(COMPLETE_EVENT);
Mono<ServerResponse> responseMono = ServerResponse.ok()
.contentType(MediaType.TEXT_EVENT_STREAM)
.body(BodyInserters.fromServerSentEvents(sseFlux.concatWith(COMPLETE_EVENT)))
.body(BodyInserters.fromServerSentEvents(sseFlux))
.onErrorResume(Throwable.class, (ex) -> ServerResponse.badRequest().build());
return ((this.timeout != null) ? responseMono.timeout(this.timeout) : responseMono);
}
private Mono<Map<String, Object>> exceptionToResultMap(Throwable ex) {
return Mono.just((ex instanceof SubscriptionPublisherException spe) ?
spe.toMap() :
GraphqlErrorBuilder.newError()
.message("Subscription error")
.errorType(org.springframework.graphql.execution.ErrorType.INTERNAL_ERROR)
.build()
.toSpecification());
}
}

33
spring-graphql/src/main/java/org/springframework/graphql/server/webmvc/GraphQlSseHandler.java
View File

@@ -24,6 +24,7 @@ import java.util.function.Consumer;
import graphql.ErrorType;
import graphql.ExecutionResult;
import graphql.GraphQLError;
import graphql.GraphqlErrorBuilder;
import org.reactivestreams.Publisher;
import reactor.core.publisher.BaseSubscriber;
import reactor.core.publisher.Flux;
@@ -119,10 +120,10 @@ public class GraphQlSseHandler extends AbstractGraphQlHttpHandler {
@Override
protected void hookOnNext(Map<String, Object> value) {
writeResult(value);
sendNext(value);
}
private void writeResult(Map<String, Object> value) {
private void sendNext(Map<String, Object> value) {
try {
this.sseBuilder.event("next");
this.sseBuilder.data(value);
@@ -139,18 +140,21 @@ public class GraphQlSseHandler extends AbstractGraphQlHttpHandler {
@Override
protected void hookOnError(Throwable ex) {
if (ex instanceof SubscriptionPublisherException spe) {
ExecutionResult result = ExecutionResult.newExecutionResult().errors(spe.getErrors()).build();
writeResult(result.toSpecification());
hookOnComplete();
}
else {
this.sseBuilder.error(ex);
}
sendNext(exceptionToResultMap(ex));
sendComplete();
}
@Override
protected void hookOnComplete() {
private static Map<String, Object> exceptionToResultMap(Throwable ex) {
return ((ex instanceof SubscriptionPublisherException spe) ?
spe.toMap() :
GraphqlErrorBuilder.newError()
.message("Subscription error")
.errorType(org.springframework.graphql.execution.ErrorType.INTERNAL_ERROR)
.build()
.toSpecification());
}
private void sendComplete() {
try {
this.sseBuilder.event("complete").data("");
}
@@ -160,6 +164,11 @@ public class GraphQlSseHandler extends AbstractGraphQlHttpHandler {
this.sseBuilder.complete();
}
@Override
protected void hookOnComplete() {
sendComplete();
}
static Consumer<ServerResponse.SseBuilder> connect(Flux<Map<String, Object>> resultFlux) {
return (sseBuilder) -> {
SseSubscriber subscriber = new SseSubscriber(sseBuilder);

3
spring-graphql/src/test/java/org/springframework/graphql/server/webflux/GraphQlSseHandlerTests.java
View File

@@ -55,7 +55,8 @@ class GraphQlSseHandlerTests {
private static final DataFetcher<?> SEARCH_DATA_FETCHER = env -> {
String author = env.getArgument("author");
return Flux.fromIterable(BookSource.books()).filter((book) -> book.getAuthor().getFullName().contains(author));
return Flux.fromIterable(BookSource.books())
.filter((book) -> book.getAuthor().getFullName().contains(author));
};
private final MockServerHttpRequest httpRequest = MockServerHttpRequest.post("/graphql")

9
spring-graphql/src/test/java/org/springframework/graphql/server/webmvc/GraphQlSseHandlerTests.java
View File

@@ -56,6 +56,7 @@ import static org.mockito.Mockito.mock;
*
* @author Brian Clozel
*/
@SuppressWarnings("ReactiveStreamsUnusedPublisher")
class GraphQlSseHandlerTests {
private static final List<HttpMessageConverter<?>> MESSAGE_READERS =
@@ -92,7 +93,7 @@ class GraphQlSseHandlerTests {
void shouldWriteMultipleEventsForSubscription() throws Exception {
GraphQlSseHandler handler = createSseHandler(SEARCH_DATA_FETCHER);
MockHttpServletRequest request = createServletRequest("""
{ "query": "subscription TestSubscription { bookSearch(author:\\\"Orwell\\\") { id name } }" }
{ "query": "subscription TestSubscription { bookSearch(author:\\"Orwell\\") { id name } }" }
""");
MockHttpServletResponse response = handleAndAwait(request, handler);
@@ -118,7 +119,7 @@ class GraphQlSseHandlerTests {
GraphQlSseHandler handler = createSseHandler(errorDataFetcher);
MockHttpServletRequest request = createServletRequest("""
{ "query": "subscription TestSubscription { bookSearch(author:\\\"Orwell\\\") { id name } }" }
{ "query": "subscription TestSubscription { bookSearch(author:\\"Orwell\\") { id name } }" }
""");
MockHttpServletResponse response = handleAndAwait(request, handler);
@@ -140,7 +141,7 @@ class GraphQlSseHandlerTests {
void shouldCancelDataFetcherPublisherWhenWritingFails() throws Exception {
GraphQlSseHandler handler = createSseHandler(SEARCH_DATA_FETCHER);
MockHttpServletRequest servletRequest = createServletRequest("""
{ "query": "subscription TestSubscription { bookSearch(author:\\\"Orwell\\\") { id name } }" }
{ "query": "subscription TestSubscription { bookSearch(author:\\"Orwell\\") { id name } }" }
""");
HttpServletResponse servletResponse = mock(HttpServletResponse.class);
ServletOutputStream outputStream = mock(ServletOutputStream.class);
@@ -165,7 +166,7 @@ class GraphQlSseHandlerTests {
GraphQlSseHandler handler = createSseHandler(errorDataFetcher);
MockHttpServletRequest servletRequest = createServletRequest("""
{ "query": "subscription TestSubscription { bookSearch(author:\\\"Orwell\\\") { id name } }" }
{ "query": "subscription TestSubscription { bookSearch(author:\\"Orwell\\") { id name } }" }
""");
MockHttpServletResponse servletResponse = handleRequest(servletRequest, handler);