Skip to content

fix: improve media type comparison for streaming responses #3948 #3969

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: 4.3.x
Choose a base branch
from
Open

fix: improve media type comparison for streaming responses #3948 #3969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion .../main/java/org/springframework/cloud/gateway/server/mvc/common/AbstractProxyExchange.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;

import org.springframework.cloud.gateway.server.mvc.config.GatewayMvcProperties;
import org.springframework.cloud.gateway.server.mvc.handler.ProxyExchange;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.util.Assert;
import org.springframework.util.StreamUtils;
Expand All @@ -42,7 +44,7 @@ protected int copyResponseBody(ClientHttpResponse clientResponse, InputStream in

int transferredBytes;

if (properties.getStreamingMediaTypes().contains(clientResponse.getHeaders().getContentType())) {
if (isStreamingMediaType(properties.getStreamingMediaTypes(), clientResponse.getHeaders().getContentType())) {
transferredBytes = copyResponseBodyWithFlushing(inputStream, outputStream);
}
else {
Expand All @@ -52,6 +54,15 @@ protected int copyResponseBody(ClientHttpResponse clientResponse, InputStream in
return transferredBytes;
}

private static boolean isStreamingMediaType(List<MediaType> streamingMediaTypes, MediaType mediaType) {
for (var streamingMediaType : streamingMediaTypes) {
if (streamingMediaType.equalsTypeAndSubtype(mediaType)) {
return true;
}
}
return false;
}

private int copyResponseBodyWithFlushing(InputStream inputStream, OutputStream outputStream) throws IOException {
int readBytes;
var totalReadBytes = 0;
Expand Down
16 changes: 16 additions & 0 deletions .../java/org/springframework/cloud/gateway/server/mvc/common/AbstractProxyExchangeTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ public void copyResponseBodyForTextEventStream() throws IOException {
verify(outputStream, times(4)).flush();
}

@Test
public void copyResponseBodyForTextEventStreamWithParameter() throws IOException {
MockClientHttpResponse mockResponse = new MockClientHttpResponse(new byte[0], 200);
MediaType mediaType = MediaType.parseMediaType(MediaType.TEXT_EVENT_STREAM_VALUE + ";charset=UTF-8");
mockResponse.getHeaders().setContentType(mediaType);

InputStream inputStream = mock(InputStream.class);
when(inputStream.read(any())).thenReturn(1).thenReturn(1).thenReturn(1).thenReturn(-1);
OutputStream outputStream = mock(OutputStream.class);

int result = new TestProxyExchange().copyResponseBody(mockResponse, inputStream, outputStream);

assertThat(result).isEqualTo(3);
verify(outputStream, times(4)).flush();
}

@Test
public void copyResponseBodyWithoutContentType() throws IOException {
MockClientHttpResponse mockResponse = new MockClientHttpResponse(new byte[0], 200);
Expand Down