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

Have ReactiveTypeHandler consider +x-ndjson suffix as streaming

Browse Source 
This commit adds `application/*+x-ndjson`, a wildcard media type which
covers all types that can be parsed as nd-json, to the list of media
types the ReactiveTypeHandler considers for a streaming response in
WebMVC.

As a result, a request which for example `Accept` the
`application/vnd.myapp.v1+x-ndjson` media type will generate a response
with the same `Content-Type`, with newline-delimited json objects being
streamed in the response body.

Closes gh-26817
This commit is contained in:
Simon Baslé
2023-05-25 16:00:34 +02:00
parent 5f13b2b35b
commit 9332b3f690
2 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/ReactiveTypeHandlerTests.java
View File

@@ -255,6 +255,32 @@ public class ReactiveTypeHandlerTests {
assertThat(emitterHandler.getValues()).isEqualTo(Arrays.asList(bar1, "\n", bar2, "\n"));
}
@Test
public void writeStreamJsonWithVendorSubtype() throws Exception {
this.servletRequest.addHeader("Accept", "application/vnd.myapp.v1+x-ndjson");
Sinks.Many<Bar> sink = Sinks.many().unicast().onBackpressureBuffer();
ResponseBodyEmitter emitter = handleValue(sink.asFlux(), Flux.class, forClass(Bar.class));
assertThat(emitter).as("emitter").isNotNull();
EmitterHandler emitterHandler = new EmitterHandler();
emitter.initialize(emitterHandler);
ServletServerHttpResponse message = new ServletServerHttpResponse(this.servletResponse);
emitter.extendResponse(message);
Bar bar1 = new Bar("foo");
Bar bar2 = new Bar("bar");
sink.tryEmitNext(bar1);
sink.tryEmitNext(bar2);
sink.tryEmitComplete();
assertThat(message.getHeaders().getContentType().toString()).isEqualTo("application/vnd.myapp.v1+x-ndjson");
assertThat(emitterHandler.getValues()).isEqualTo(Arrays.asList(bar1, "\n", bar2, "\n"));
}
@Test
public void writeText() throws Exception {