From 196423b09bad4fda05212ab2992cf325988c8548 Mon Sep 17 00:00:00 2001 From: Darren Foong Date: Wed, 10 Jun 2020 15:07:42 +0800 Subject: [PATCH 1/5] Reproduce issue --- .../cloud/openfeign/valid/ValidFeignClientTests.java | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java index 0cf667d83..941149a91 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java @@ -23,6 +23,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Locale; @@ -349,6 +350,16 @@ public void testRequestPartWithListOfMultipartFiles() { assertThat(fileNames).contains("hello1.bin", "hello2.bin"); } + @Test + public void testRequestPartWithEmptyListOfMultipartFiles() { + String partNames = this.multipartClient + .requestPartListOfMultipartFilesReturnsPartNames(Collections.emptyList()); +// assertThat(partNames).isEqualTo("files,files"); + String fileNames = this.multipartClient + .requestPartListOfMultipartFilesReturnsFileNames(Collections.emptyList()); +// assertThat(fileNames).contains("hello1.bin", "hello2.bin"); + } + @Test public void testRequestPartWithListOfPojosAndListOfMultipartFiles() { Hello pojo1 = new Hello(HELLO_WORLD_1); From b954468046a159692d0f47651e64ec83e929fc28 Mon Sep 17 00:00:00 2001 From: Darren Foong Date: Wed, 10 Jun 2020 21:15:18 +0800 Subject: [PATCH 2/5] Add Writer for empty Collection and initial (no-op) test --- .../openfeign/FeignClientsConfiguration.java | 15 +++++++++++++++ .../openfeign/valid/ValidFeignClientTests.java | 18 ++++++++---------- 2 files changed, 23 insertions(+), 10 deletions(-) diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java index b934e9d9b..ebbf6a6b9 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java @@ -17,6 +17,7 @@ package org.springframework.cloud.openfeign; import java.util.ArrayList; +import java.util.Collection; import java.util.List; import com.fasterxml.jackson.databind.Module; @@ -25,8 +26,11 @@ import feign.Logger; import feign.Retryer; import feign.codec.Decoder; +import feign.codec.EncodeException; import feign.codec.Encoder; import feign.form.MultipartFormContentProcessor; +import feign.form.multipart.Output; +import feign.form.multipart.Writer; import feign.form.spring.SpringFormEncoder; import feign.optionals.OptionalDecoder; @@ -184,6 +188,17 @@ private class SpringPojoFormEncoder extends SpringFormEncoder { MultipartFormContentProcessor processor = (MultipartFormContentProcessor) getContentProcessor( MULTIPART); + processor.addFirstWriter(new Writer() { + @Override + public boolean isApplicable(Object value) { + return value instanceof Collection && ((Collection) value).isEmpty(); + } + + @Override + public void write(Output output, String boundary, String key, + Object value) throws EncodeException { + } + }); processor.addFirstWriter(formWriter); } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java index 941149a91..c1a58d2f0 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java @@ -23,7 +23,6 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; -import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Locale; @@ -351,13 +350,11 @@ public void testRequestPartWithListOfMultipartFiles() { } @Test - public void testRequestPartWithEmptyListOfMultipartFiles() { - String partNames = this.multipartClient - .requestPartListOfMultipartFilesReturnsPartNames(Collections.emptyList()); -// assertThat(partNames).isEqualTo("files,files"); - String fileNames = this.multipartClient - .requestPartListOfMultipartFilesReturnsFileNames(Collections.emptyList()); -// assertThat(fileNames).contains("hello1.bin", "hello2.bin"); + public void testRequestPartWithEmptyListOfPojosAndEmptyListOfMultipartFiles() { + // String response = this.multipartClient + // .requestPartListOfPojosAndListOfMultipartFiles(Collections.emptyList(), + // Collections.emptyList()); + // assertThat(response).isNull(); } @Test @@ -829,8 +826,9 @@ String multipartFilenames(HttpServletRequest request) throws Exception { consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.TEXT_PLAIN_VALUE) String requestPartListOfPojosAndListOfMultipartFiles( - @RequestPart("pojos") List pojos, - @RequestPart("files") List files) { + @RequestPart(value = "pojos", required = false) List pojos, + @RequestPart(value = "files", + required = false) List files) { StringBuilder result = new StringBuilder(); for (Hello pojo : pojos) { From 13e3274c69c7ccd4e7a55aa7469f1549e9fb2c66 Mon Sep 17 00:00:00 2001 From: Darren Foong Date: Fri, 12 Jun 2020 13:30:02 +0800 Subject: [PATCH 3/5] Update test and undo required = false --- .../openfeign/valid/ValidFeignClientTests.java | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java index c1a58d2f0..4dafe4123 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java @@ -23,6 +23,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Locale; @@ -350,11 +351,13 @@ public void testRequestPartWithListOfMultipartFiles() { } @Test - public void testRequestPartWithEmptyListOfPojosAndEmptyListOfMultipartFiles() { - // String response = this.multipartClient - // .requestPartListOfPojosAndListOfMultipartFiles(Collections.emptyList(), - // Collections.emptyList()); - // assertThat(response).isNull(); + public void testRequestPartWithListOfPojosAndEmptyListOfMultipartFiles() { + Hello pojo1 = new Hello(HELLO_WORLD_1); + Hello pojo2 = new Hello(OI_TERRA_2); + String response = this.multipartClient + .requestPartListOfPojosAndListOfMultipartFiles( + Arrays.asList(pojo1, pojo2), Collections.emptyList()); + assertThat(response).isEqualTo("hello world 1oi terra 2"); } @Test @@ -826,9 +829,8 @@ String multipartFilenames(HttpServletRequest request) throws Exception { consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.TEXT_PLAIN_VALUE) String requestPartListOfPojosAndListOfMultipartFiles( - @RequestPart(value = "pojos", required = false) List pojos, - @RequestPart(value = "files", - required = false) List files) { + @RequestPart("pojos") List pojos, + @RequestPart("files") List files) { StringBuilder result = new StringBuilder(); for (Hello pojo : pojos) { From aaa402623f8dcc50442372f1dfb6c16ef1771ef0 Mon Sep 17 00:00:00 2001 From: Darren Foong Date: Fri, 12 Jun 2020 14:22:03 +0800 Subject: [PATCH 4/5] Extract EmptyCollectionWriter --- .../openfeign/FeignClientsConfiguration.java | 15 ------- .../support/EmptyCollectionWriter.java | 40 +++++++++++++++++++ .../openfeign/support/SpringEncoder.java | 10 +++++ 3 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyCollectionWriter.java diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java index ebbf6a6b9..b934e9d9b 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java @@ -17,7 +17,6 @@ package org.springframework.cloud.openfeign; import java.util.ArrayList; -import java.util.Collection; import java.util.List; import com.fasterxml.jackson.databind.Module; @@ -26,11 +25,8 @@ import feign.Logger; import feign.Retryer; import feign.codec.Decoder; -import feign.codec.EncodeException; import feign.codec.Encoder; import feign.form.MultipartFormContentProcessor; -import feign.form.multipart.Output; -import feign.form.multipart.Writer; import feign.form.spring.SpringFormEncoder; import feign.optionals.OptionalDecoder; @@ -188,17 +184,6 @@ private class SpringPojoFormEncoder extends SpringFormEncoder { MultipartFormContentProcessor processor = (MultipartFormContentProcessor) getContentProcessor( MULTIPART); - processor.addFirstWriter(new Writer() { - @Override - public boolean isApplicable(Object value) { - return value instanceof Collection && ((Collection) value).isEmpty(); - } - - @Override - public void write(Output output, String boundary, String key, - Object value) throws EncodeException { - } - }); processor.addFirstWriter(formWriter); } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyCollectionWriter.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyCollectionWriter.java new file mode 100644 index 000000000..5c44a993c --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyCollectionWriter.java @@ -0,0 +1,40 @@ +/* + * 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.util.Collection; + +import feign.codec.EncodeException; +import feign.form.multipart.Output; +import feign.form.multipart.Writer; + +/** + * @author Darren Foong + */ +public class EmptyCollectionWriter implements Writer { + + @Override + public boolean isApplicable(Object value) { + return value instanceof Collection && ((Collection) value).isEmpty(); + } + + @Override + public void write(Output output, String boundary, String key, Object value) + throws EncodeException { + } + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java index ed99a2b9b..8766ba7b3 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java @@ -29,6 +29,7 @@ import feign.RequestTemplate; import feign.codec.EncodeException; import feign.codec.Encoder; +import feign.form.MultipartFormContentProcessor; import feign.form.spring.SpringFormEncoder; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -46,6 +47,7 @@ import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter; import org.springframework.web.multipart.MultipartFile; +import static feign.form.ContentType.MULTIPART; import static org.springframework.cloud.openfeign.support.FeignUtils.getHeaders; import static org.springframework.cloud.openfeign.support.FeignUtils.getHttpHeaders; @@ -67,12 +69,20 @@ public class SpringEncoder implements Encoder { public SpringEncoder(ObjectFactory messageConverters) { this.springFormEncoder = new SpringFormEncoder(); this.messageConverters = messageConverters; + + MultipartFormContentProcessor processor = (MultipartFormContentProcessor) springFormEncoder + .getContentProcessor(MULTIPART); + processor.addFirstWriter(new EmptyCollectionWriter()); } public SpringEncoder(SpringFormEncoder springFormEncoder, ObjectFactory messageConverters) { this.springFormEncoder = springFormEncoder; this.messageConverters = messageConverters; + + MultipartFormContentProcessor processor = (MultipartFormContentProcessor) springFormEncoder + .getContentProcessor(MULTIPART); + processor.addFirstWriter(new EmptyCollectionWriter()); } @Override From e4067d2a173beaf58d059b87f5455d3e29cc73d6 Mon Sep 17 00:00:00 2001 From: Darren Foong Date: Fri, 12 Jun 2020 18:30:31 +0800 Subject: [PATCH 5/5] Add new test for counting number of files --- .../valid/ValidFeignClientTests.java | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java index 4dafe4123..e4efa90e6 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/ValidFeignClientTests.java @@ -337,6 +337,19 @@ public void testMultiplePojoRequestParts() { assertThat(response).isEqualTo("abc123hello world 1oi terra 2hello.bin"); } + @Test + public void testRequestPartWithEmptyListOfMultipartFiles() { + String partNames = this.multipartClient + .requestPartListOfMultipartFilesReturnsPartNames(Collections.emptyList()); + assertThat(partNames).isNull(); + String fileNames = this.multipartClient + .requestPartListOfMultipartFilesReturnsFileNames(Collections.emptyList()); + assertThat(fileNames).isNull(); + String count = this.multipartClient + .requestPartListOfMultipartFilesReturnsCount(Collections.emptyList()); + assertThat(count).isEqualTo("0"); + } + @Test public void testRequestPartWithListOfMultipartFiles() { List multipartFiles = Arrays.asList( @@ -348,6 +361,9 @@ public void testRequestPartWithListOfMultipartFiles() { String fileNames = this.multipartClient .requestPartListOfMultipartFilesReturnsFileNames(multipartFiles); assertThat(fileNames).contains("hello1.bin", "hello2.bin"); + String count = this.multipartClient + .requestPartListOfMultipartFilesReturnsCount(multipartFiles); + assertThat(count).isEqualTo(Integer.toString(multipartFiles.size())); } @Test @@ -455,6 +471,12 @@ String multipartPojo(@RequestPart("hello") String hello, @RequestPart("pojo2") Hello pojo2, @RequestPart("file") MultipartFile file); + @RequestMapping(method = RequestMethod.POST, path = "/multipartCount", + consumes = MediaType.MULTIPART_FORM_DATA_VALUE, + produces = MediaType.TEXT_PLAIN_VALUE) + String requestPartListOfMultipartFilesReturnsCount( + @RequestPart("files") List files); + @RequestMapping(method = RequestMethod.POST, path = "/multipartNames", consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.TEXT_PLAIN_VALUE) @@ -809,6 +831,14 @@ String multipartPojo(@RequestPart("hello") String hello, + file.getOriginalFilename(); } + @RequestMapping(method = RequestMethod.POST, path = "/multipartCount", + consumes = MediaType.MULTIPART_FORM_DATA_VALUE, + produces = MediaType.TEXT_PLAIN_VALUE) + String requestPartListOfMultipartFilesReturnsCount( + @RequestPart("files") List files) { + return Integer.toString(files.size()); + } + @RequestMapping(method = RequestMethod.POST, path = "/multipartNames", consumes = MediaType.MULTIPART_FORM_DATA_VALUE, produces = MediaType.TEXT_PLAIN_VALUE)