From 5f9a827a4065215a5537df78ba5745288cb699aa Mon Sep 17 00:00:00 2001 From: Olga Maciaszek-Sharma Date: Tue, 11 May 2021 15:45:00 +0200 Subject: [PATCH] Upgrade feign to 11 (#540) --- .../main/asciidoc/spring-cloud-openfeign.adoc | 8 -- .../openfeign/FeignAutoConfiguration.java | 2 - .../openfeign/support/DefaultGzipDecoder.java | 80 ------------------- .../DefaultGzipDecoderConfiguration.java | 58 -------------- ...coderTests.java => GzipDecodingTests.java} | 9 ++- .../FeignBlockingLoadBalancerClientTests.java | 16 +++- spring-cloud-openfeign-dependencies/pom.xml | 2 +- 7 files changed, 20 insertions(+), 155 deletions(-) delete mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java delete mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java rename spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/{DefaultGzipDecoderTests.java => GzipDecodingTests.java} (94%) diff --git a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc index b59ecfff..de867deb 100644 --- a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc +++ b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc @@ -498,14 +498,6 @@ feign.compression.request.min-request-size=2048 These properties allow you to be selective about the compressed media types and minimum request threshold length. -For http clients except OkHttpClient, default gzip decoder can be enabled to decode gzip response in UTF-8 encoding: - -[source,java] ----- -feign.compression.response.enabled=true -feign.compression.response.useGzipDecoder=true ----- - === Feign logging A logger is created for each Feign client created. By default the name of the logger is the full class name of the interface used to create the Feign client. Feign logging only responds to the `DEBUG` level. diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java index fd2dd7be..3c4de289 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java @@ -56,7 +56,6 @@ import org.springframework.cloud.commons.httpclient.ApacheHttpClientFactory; import org.springframework.cloud.commons.httpclient.OkHttpClientConnectionPoolFactory; import org.springframework.cloud.commons.httpclient.OkHttpClientFactory; import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptor; -import org.springframework.cloud.openfeign.support.DefaultGzipDecoderConfiguration; import org.springframework.cloud.openfeign.support.FeignEncoderProperties; import org.springframework.cloud.openfeign.support.FeignHttpClientProperties; import org.springframework.cloud.openfeign.support.PageJacksonModule; @@ -84,7 +83,6 @@ import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResour @ConditionalOnClass(Feign.class) @EnableConfigurationProperties({ FeignClientProperties.class, FeignHttpClientProperties.class, FeignEncoderProperties.class }) -@Import(DefaultGzipDecoderConfiguration.class) public class FeignAutoConfiguration { private static final Log LOG = LogFactory.getLog(FeignAutoConfiguration.class); diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java deleted file mode 100644 index 896e8272..00000000 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Copyright 2013-2020 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.cloud.openfeign.support; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStreamReader; -import java.lang.reflect.Type; -import java.nio.charset.StandardCharsets; -import java.util.Collection; -import java.util.zip.GZIPInputStream; - -import feign.FeignException; -import feign.Response; -import feign.codec.Decoder; - -import org.springframework.cloud.openfeign.encoding.HttpEncoding; - -/** - * When response is compressed as gzip, this decompresses and uses {@link SpringDecoder} - * to decode. - * - * @author Jaesik Kim - */ -public class DefaultGzipDecoder implements Decoder { - - private Decoder decoder; - - public DefaultGzipDecoder(Decoder decoder) { - this.decoder = decoder; - } - - @Override - public Object decode(final Response response, Type type) throws IOException, FeignException { - Collection encoding = response.headers().containsKey(HttpEncoding.CONTENT_ENCODING_HEADER) - ? response.headers().get(HttpEncoding.CONTENT_ENCODING_HEADER) : null; - - if (encoding != null) { - if (encoding.contains(HttpEncoding.GZIP_ENCODING)) { - String decompressedBody = decompress(response); - if (decompressedBody != null) { - Response decompressedResponse = response.toBuilder().body(decompressedBody.getBytes()).build(); - return decoder.decode(decompressedResponse, type); - } - } - } - return decoder.decode(response, type); - } - - private String decompress(Response response) throws IOException { - if (response.body() == null) { - return null; - } - try (GZIPInputStream gzipInputStream = new GZIPInputStream(response.body().asInputStream()); - BufferedReader reader = new BufferedReader( - new InputStreamReader(gzipInputStream, StandardCharsets.UTF_8))) { - String outputString = ""; - String line; - while ((line = reader.readLine()) != null) { - outputString += line; - } - return outputString; - } - } - -} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java deleted file mode 100644 index 2d476060..00000000 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright 2013-2020 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.cloud.openfeign.support; - -import feign.codec.Decoder; -import feign.optionals.OptionalDecoder; - -import org.springframework.beans.factory.ObjectFactory; -import org.springframework.boot.autoconfigure.AutoConfigureAfter; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.autoconfigure.http.HttpMessageConverters; -import org.springframework.cloud.openfeign.FeignAutoConfiguration; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -/** - * Configures Default Gzip Decoder. - * - * @author Jaesik Kim - */ -@Configuration(proxyBeanMethods = false) -@ConditionalOnProperty("feign.compression.response.enabled") -// The OK HTTP client uses "transparent" compression. -// If the accept-encoding header is present, it disables transparent compression -@ConditionalOnMissingBean(type = "okhttp3.OkHttpClient") -@AutoConfigureAfter(FeignAutoConfiguration.class) -public class DefaultGzipDecoderConfiguration { - - private ObjectFactory messageConverters; - - public DefaultGzipDecoderConfiguration(ObjectFactory messageConverters) { - this.messageConverters = messageConverters; - } - - @Bean - @ConditionalOnMissingBean - @ConditionalOnProperty("feign.compression.response.useGzipDecoder") - public Decoder defaultGzipDecoder() { - return new OptionalDecoder( - new ResponseEntityDecoder(new DefaultGzipDecoder(new SpringDecoder(messageConverters)))); - } - -} diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java similarity index 94% rename from spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java rename to spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java index 356412be..e5accdba 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java @@ -39,15 +39,16 @@ import static org.assertj.core.api.Assertions.assertThat; /** * @author Jaesik Kim + * @author Olga Maciaszek-Sharma */ @RunWith(SpringJUnit4ClassRunner.class) -@SpringBootTest(classes = DefaultGzipDecoderTests.Application.class, +@SpringBootTest(classes = GzipDecodingTests.Application.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, value = { "spring.application.name=defaultGzipDecoderTests", "feign.compression.response.enabled=true", - "feign.compression.response.useGzipDecoder=true", "feign.client.config.default.loggerLevel=full", + "feign.client.config.default.loggerLevel=none", "feign.metrics.enabled=false", "logging.level.org.springframework.cloud.openfeign=DEBUG" }) @DirtiesContext -public class DefaultGzipDecoderTests extends FeignClientFactoryBean { +public class GzipDecodingTests extends FeignClientFactoryBean { @Autowired FeignContext context; @@ -55,7 +56,7 @@ public class DefaultGzipDecoderTests extends FeignClientFactoryBean { @Value("${local.server.port}") private int port = 0; - public DefaultGzipDecoderTests() { + public GzipDecodingTests() { setName("tests"); setContextId("test"); } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java index daf22e7c..468df6a1 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java @@ -16,7 +16,9 @@ package org.springframework.cloud.openfeign.loadbalancer; +import java.io.BufferedReader; import java.io.IOException; +import java.io.InputStreamReader; import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.Collection; @@ -105,8 +107,7 @@ class FeignBlockingLoadBalancerClientTests { Response response = feignBlockingLoadBalancerClient.execute(request, new Request.Options()); assertThat(response.status()).isEqualTo(HttpStatus.SERVICE_UNAVAILABLE.value()); - assertThat(response.body().toString()) - .isEqualTo("Load balancer does not contain an instance for the service test"); + assertThat(read(response)).isEqualTo("Load balancer does not contain an instance for the service test"); } @Test @@ -167,6 +168,17 @@ class FeignBlockingLoadBalancerClientTests { .contains(HttpStatus.OK); } + private String read(Response response) throws IOException { + BufferedReader reader = new BufferedReader( + new InputStreamReader(response.body().asInputStream(), StandardCharsets.UTF_8)); + String outputString = ""; + String line; + while ((line = reader.readLine()) != null) { + outputString += line; + } + return outputString; + } + private Request testRequest() { return testRequest("test"); } diff --git a/spring-cloud-openfeign-dependencies/pom.xml b/spring-cloud-openfeign-dependencies/pom.xml index ed285e51..55d19709 100644 --- a/spring-cloud-openfeign-dependencies/pom.xml +++ b/spring-cloud-openfeign-dependencies/pom.xml @@ -15,7 +15,7 @@ spring-cloud-openfeign-dependencies Spring Cloud OpenFeign Dependencies - 10.12 + 11.2 3.8.0 2.1.2.RELEASE