Skip to content

Commit

Permalink
BufferingClientHttpRequestWrapper should not write empty body
Browse files Browse the repository at this point in the history
Prior to this commit, `BufferingClientHttpRequestWrapper` would always
write to the actual client request body, even if the buffered content
was empty (empty byte array).
This would cause issues with specific client request factories,
especially the OkHttp variant, that would consider empty byte arrays as
non-empty body and would reject such cases for GET requests with an
"IllegalArgumentException: method GET must not have a request body".

This commit only writes to the request if the buffered content is not
empty.

Fixes gh-32612
  • Loading branch information
bclozel committed Apr 10, 2024
1 parent a0136a2 commit 019ce44
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,23 @@ public URI getURI() {
protected ClientHttpResponse executeInternal(HttpHeaders headers, byte[] bufferedOutput) throws IOException {
this.request.getHeaders().putAll(headers);

if (this.request instanceof StreamingHttpOutputMessage streamingHttpOutputMessage) {
streamingHttpOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
@Override
public void writeTo(OutputStream outputStream) throws IOException {
StreamUtils.copy(bufferedOutput, outputStream);
}
if (bufferedOutput.length > 0) {
if (this.request instanceof StreamingHttpOutputMessage streamingHttpOutputMessage) {
streamingHttpOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
@Override
public void writeTo(OutputStream outputStream) throws IOException {
StreamUtils.copy(bufferedOutput, outputStream);
}

@Override
public boolean repeatable() {
return true;
}
});
}
else {
StreamUtils.copy(bufferedOutput, this.request.getBody());
@Override
public boolean repeatable() {
return true;
}
});
}
else {
StreamUtils.copy(bufferedOutput, this.request.getBody());
}
}

ClientHttpResponse response = this.request.execute();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.http.client;

/**
* Tests for {@link BufferingClientHttpRequestWrapper} for clients
* not supporting non-null, empty request bodies for GET requests.
*/
class BufferingClientHttpRequestFactoryWithOkHttpTests extends AbstractHttpRequestFactoryTests {

@Override
@SuppressWarnings("removal")
protected ClientHttpRequestFactory createRequestFactory() {
return new BufferingClientHttpRequestFactory(new OkHttp3ClientHttpRequestFactory());
}

}

0 comments on commit 019ce44

Please sign in to comment.