Skip to content

Commit 0bad69d

Browse files
committed
Fix SSE with indenting serializer in WebMvc.fn
This commit ensures that HTTP headers like "text/event-stream" are correctly forwarded to the converter used in SseServerResponse for proper pretty print handling. Close gh-30302
1 parent 6b19642 commit 0bad69d

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

spring-webmvc/src/main/java/org/springframework/web/servlet/function/SseServerResponse.java

+10-4
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
* <a href="https://www.w3.org/TR/eventsource/">Server-Sent Events</a>.
4949
*
5050
* @author Arjen Poutsma
51+
* @author Sebastien Deleuze
5152
* @since 5.3.2
5253
*/
5354
final class SseServerResponse extends AbstractServerResponse {
@@ -90,7 +91,7 @@ protected ModelAndView writeToInternal(HttpServletRequest request, HttpServletRe
9091
}
9192

9293
DefaultAsyncServerResponse.writeAsync(request, response, result);
93-
this.sseConsumer.accept(new DefaultSseBuilder(response, context, result));
94+
this.sseConsumer.accept(new DefaultSseBuilder(response, context, result, this.headers()));
9495
return null;
9596
}
9697

@@ -113,15 +114,19 @@ private static final class DefaultSseBuilder implements SseBuilder {
113114

114115
private final List<HttpMessageConverter<?>> messageConverters;
115116

117+
private final HttpHeaders httpHeaders;
118+
116119
private final StringBuilder builder = new StringBuilder();
117120

118121
private boolean sendFailed;
119122

120123

121-
public DefaultSseBuilder(HttpServletResponse response, Context context, DeferredResult<?> deferredResult) {
124+
public DefaultSseBuilder(HttpServletResponse response, Context context, DeferredResult<?> deferredResult,
125+
HttpHeaders httpHeaders) {
122126
this.outputMessage = new ServletServerHttpResponse(response);
123127
this.deferredResult = deferredResult;
124128
this.messageConverters = context.messageConverters();
129+
this.httpHeaders = httpHeaders;
125130
}
126131

127132
@Override
@@ -206,7 +211,7 @@ private void writeObject(Object data) throws IOException {
206211
for (HttpMessageConverter<?> converter : this.messageConverters) {
207212
if (converter.canWrite(dataClass, MediaType.APPLICATION_JSON)) {
208213
HttpMessageConverter<Object> objectConverter = (HttpMessageConverter<Object>) converter;
209-
ServerHttpResponse response = new MutableHeadersServerHttpResponse(this.outputMessage);
214+
ServerHttpResponse response = new MutableHeadersServerHttpResponse(this.outputMessage, this.httpHeaders);
210215
objectConverter.write(data, MediaType.APPLICATION_JSON, response);
211216
this.outputMessage.getBody().write(NL_NL);
212217
this.outputMessage.flush();
@@ -276,9 +281,10 @@ private static final class MutableHeadersServerHttpResponse extends DelegatingSe
276281

277282
private final HttpHeaders mutableHeaders = new HttpHeaders();
278283

279-
public MutableHeadersServerHttpResponse(ServerHttpResponse delegate) {
284+
public MutableHeadersServerHttpResponse(ServerHttpResponse delegate, HttpHeaders headers) {
280285
super(delegate);
281286
this.mutableHeaders.putAll(delegate.getHeaders());
287+
this.mutableHeaders.putAll(headers);
282288
}
283289

284290
@Override

spring-webmvc/src/test/java/org/springframework/web/servlet/function/SseServerResponseTests.java

+28
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333

3434
/**
3535
* @author Arjen Poutsma
36+
* @author Sebastien Deleuze
3637
*/
3738
class SseServerResponseTests {
3839

@@ -89,6 +90,33 @@ void sendObject() throws Exception {
8990
assertThat(this.mockResponse.getContentAsString()).isEqualTo(expected);
9091
}
9192

93+
@Test
94+
void sendObjectWithPrettyPrint() throws Exception {
95+
Person person = new Person("John Doe", 42);
96+
ServerResponse response = ServerResponse.sse(sse -> {
97+
try {
98+
sse.send(person);
99+
}
100+
catch (IOException ex) {
101+
throw new UncheckedIOException(ex);
102+
}
103+
});
104+
105+
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
106+
converter.setPrettyPrint(true);
107+
ServerResponse.Context context = () -> Collections.singletonList(converter);
108+
109+
ModelAndView mav = response.writeTo(this.mockRequest, this.mockResponse, context);
110+
assertThat(mav).isNull();
111+
112+
String expected = "data:{\n" +
113+
"data: \"name\" : \"John Doe\",\n" +
114+
"data: \"age\" : 42\n" +
115+
"data:}\n" +
116+
"\n";
117+
assertThat(this.mockResponse.getContentAsString()).isEqualTo(expected);
118+
}
119+
92120
@Test
93121
void builder() throws Exception {
94122
ServerResponse response = ServerResponse.sse(sse -> {

0 commit comments

Comments
 (0)