HttpSenderConnection attempts to decode gzip response, even it is already decoded

[codingtim]

We just upgraded apache http client to 5.6 release.
This results in our tests failing.
Trace:

Caused by: java.util.zip.ZipException: Not in GZIP format
	at java.base/java.util.zip.GZIPInputStream.readHeader(GZIPInputStream.java:197)
	at java.base/java.util.zip.GZIPInputStream.<init>(GZIPInputStream.java:81)
	at java.base/java.util.zip.GZIPInputStream.<init>(GZIPInputStream.java:112)
	at org.springframework.ws.transport.http.AbstractHttpSenderConnection.getResponseInputStream(AbstractHttpSenderConnection.java:109)
	at org.springframework.ws.transport.AbstractSenderConnection$ResponseTransportInputStream.createInputStream(AbstractSenderConnection.java:97)
	at org.springframework.ws.transport.TransportInputStream.getInputStream(TransportInputStream.java:44)
	at org.springframework.ws.transport.TransportInputStream.read(TransportInputStream.java:89)
	at java.base/java.io.BufferedInputStream.fill(BufferedInputStream.java:291)
	at java.base/java.io.BufferedInputStream.read1(BufferedInputStream.java:347)
	at java.base/java.io.BufferedInputStream.implRead(BufferedInputStream.java:420)
	at java.base/java.io.BufferedInputStream.read(BufferedInputStream.java:399)
	at java.base/java.io.FilterInputStream.read(FilterInputStream.java:119)
	at java.base/java.io.PushbackInputStream.read(PushbackInputStream.java:197)
	at org.springframework.ws.soap.saaj.SaajSoapMessageFactory.checkForUtf8ByteOrderMark(SaajSoapMessageFactory.java:282)
	at org.springframework.ws.soap.saaj.SaajSoapMessageFactory.createWebServiceMessage(SaajSoapMessageFactory.java:196)
	at org.springframework.ws.soap.saaj.SaajSoapMessageFactory.createWebServiceMessage(SaajSoapMessageFactory.java:66)
	at org.springframework.ws.transport.AbstractWebServiceConnection.receive(AbstractWebServiceConnection.java:89)
	at org.springframework.ws.client.core.WebServiceTemplate.doSendAndReceive(WebServiceTemplate.java:634)
	at org.springframework.ws.client.core.WebServiceTemplate.sendAndReceive(WebServiceTemplate.java:575)

The issue is caused by commit in http client:
apache/httpcomponents-client@56122fd

Http client always decoded gzip and (until 5.6 release) removed the relevant http headers.
Since release 5.6 http client no longer removes the encoding http headers.
The AbstractHttpSenderConnection.getResponseInputStream method now sees the encoding header and creates GZIPInputStream which throws the error as the inputstream was already decoded.
https://github.com/spring-projects/spring-ws/blob/main/spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpSenderConnection.java#L111

Is there any way spring-ws can support this new http client behavior?

Possible workarounds for users:

• do not upgrade to 5.6
• disable http client gzip decoding (https://github.com/apache/httpcomponents-client/blob/master/httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClientBuilder.java#L541)

[snicoll]

Thanks for the report. We won't be able to move to HttpClient 5.6 before the next feature release of Spring WS. 5.0 is based on HttpClient 5.5.

Would you be able to share a small sample that reproduces the issue? This would go a long way for us to reproduce easily and figure out if we can apply some sort of forward compatiblity.

[snicoll]

@codingtim nevermind, I've managed to reproduce the problem, I think.

[snicoll]

Looking at the change, I am actually wondering if the side effect you're facing was intended. At first glance, it looks odd the response is advertizing a gzip content but the inpustream is not. I have asked on the user mailing list.