Merge pull request #1036 from nykolaslima/avoid-flush-on-serializers

letting web server commit the response naturally
caelum · Dec 11, 2015 · fb6646a · fb6646a
2 parents 27afc6b + 9068875
commit fb6646a
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 28 deletions.
diff --git a/...r-core/src/main/java/br/com/caelum/vraptor/serialization/gson/GsonJSONPSerialization.java b/...r-core/src/main/java/br/com/caelum/vraptor/serialization/gson/GsonJSONPSerialization.java
@@ -74,7 +74,6 @@ public void serialize() {
 								response.getWriter().append(callbackName).append("(");
 								super.serialize();
 								response.getWriter().append(")");
-								response.getWriter().flush();
 							} catch (IOException e) {
 								throw new ResultException("Unable to serialize data", e);
 							}

diff --git a/vraptor-core/src/main/java/br/com/caelum/vraptor/serialization/gson/GsonSerializer.java b/vraptor-core/src/main/java/br/com/caelum/vraptor/serialization/gson/GsonSerializer.java
@@ -15,7 +15,6 @@
  */
 package br.com.caelum.vraptor.serialization.gson;
 
-import static com.google.common.io.Flushables.flushQuietly;
 import static java.util.Collections.singletonMap;
 import static java.util.Objects.requireNonNull;
 
@@ -29,13 +28,13 @@
 
 import javax.enterprise.inject.Vetoed;
 
+import com.google.gson.Gson;
+
 import br.com.caelum.vraptor.core.ReflectionProvider;
 import br.com.caelum.vraptor.interceptor.TypeNameExtractor;
 import br.com.caelum.vraptor.serialization.Serializer;
 import br.com.caelum.vraptor.serialization.SerializerBuilder;
 
-import com.google.gson.Gson;
-
 /**
  * A SerializerBuilder based on Gson.
  *
@@ -144,8 +143,6 @@ public void serialize() {
 		} else {
 			gson.toJson(singletonMap(alias, root), writer);
 		}
-
-		flushQuietly(writer);
 	}
 
 	@Override

diff --git a/vraptor-core/src/main/java/br/com/caelum/vraptor/util/test/MockHttpServletResponse.java b/vraptor-core/src/main/java/br/com/caelum/vraptor/util/test/MockHttpServletResponse.java
@@ -54,6 +54,7 @@ public PrintWriter getWriter() {
 	}
 
 	public String getContentAsString() {
+		writer.flush();
 		return this.content.toString();
 	}
 

diff --git a/vraptor-core/src/main/java/br/com/caelum/vraptor/util/test/MockSerializationResult.java b/vraptor-core/src/main/java/br/com/caelum/vraptor/util/test/MockSerializationResult.java
@@ -22,6 +22,9 @@
 
 import javax.enterprise.inject.Vetoed;
 
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonSerializer;
+
 import br.com.caelum.vraptor.View;
 import br.com.caelum.vraptor.core.DefaultReflectionProvider;
 import br.com.caelum.vraptor.core.ReflectionProvider;
@@ -45,9 +48,6 @@
 import br.com.caelum.vraptor.serialization.xstream.XStreamXMLSerialization;
 import br.com.caelum.vraptor.view.EmptyResult;
 
-import com.google.gson.JsonDeserializer;
-import com.google.gson.JsonSerializer;
-
 /**
  *
  * A mocked Result for testing your serialized objects returns.

diff --git a/...-core/src/test/java/br/com/caelum/vraptor/serialization/I18nMessageSerializationTest.java b/...-core/src/test/java/br/com/caelum/vraptor/serialization/I18nMessageSerializationTest.java
@@ -34,6 +34,9 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonSerializer;
+
 import br.com.caelum.vraptor.core.DefaultReflectionProvider;
 import br.com.caelum.vraptor.environment.Environment;
 import br.com.caelum.vraptor.interceptor.DefaultTypeNameExtractor;
@@ -50,12 +53,11 @@
 import br.com.caelum.vraptor.util.test.MockInstanceImpl;
 import br.com.caelum.vraptor.validator.SingletonResourceBundle;
 
-import com.google.gson.JsonDeserializer;
-import com.google.gson.JsonSerializer;
-
 public class I18nMessageSerializationTest {
+
 	private I18nMessageSerialization serialization;
 	private ByteArrayOutputStream stream;
+	private PrintWriter writer;
 
 	@Before
 	public void setup() throws Exception {
@@ -64,7 +66,8 @@ public void setup() throws Exception {
 		Environment environment = mock(Environment.class);
 
 		HttpServletResponse response = mock(HttpServletResponse.class);
-		when(response.getWriter()).thenReturn(new PrintWriter(stream));
+		writer = new PrintWriter(stream);
+		when(response.getWriter()).thenReturn(writer);
 		DefaultTypeNameExtractor extractor = new DefaultTypeNameExtractor();
 		XStreamBuilder builder = XStreamBuilderImpl.cleanInstance(new MessageConverter());
 		XStreamXMLSerialization xmlSerialization = new XStreamXMLSerialization(response, builder, environment);
@@ -91,6 +94,8 @@ public void setup() throws Exception {
 	public void shouldCallJsonSerialization() {
 		String expectedResult = "{\"message\":{\"category\":\"success\",\"message\":\"Just another {0} in {1}\"}}";
 		serialization.from("success", "message.cat").as(json());
+		writer.flush();
+
 		assertThat(result(), is(equalTo(expectedResult)));
 	}
 

diff --git a/...ore/src/test/java/br/com/caelum/vraptor/serialization/gson/GsonJSONSerializationTest.java b/...ore/src/test/java/br/com/caelum/vraptor/serialization/gson/GsonJSONSerializationTest.java
@@ -25,6 +25,8 @@
 import static org.mockito.Mockito.when;
 
 import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
 import java.io.PrintWriter;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -40,15 +42,6 @@
 import org.junit.Before;
 import org.junit.Test;
 
-import br.com.caelum.vraptor.core.DefaultReflectionProvider;
-import br.com.caelum.vraptor.environment.Environment;
-import br.com.caelum.vraptor.interceptor.DefaultTypeNameExtractor;
-import br.com.caelum.vraptor.serialization.JSONPSerialization;
-import br.com.caelum.vraptor.serialization.JSONSerialization;
-import br.com.caelum.vraptor.serialization.Serializee;
-import br.com.caelum.vraptor.serialization.SkipSerialization;
-import br.com.caelum.vraptor.util.test.MockInstanceImpl;
-
 import com.google.common.collect.ForwardingCollection;
 import com.google.gson.ExclusionStrategy;
 import com.google.gson.FieldAttributes;
@@ -60,14 +53,22 @@
 import com.google.gson.JsonSerializer;
 import com.google.gson.annotations.Since;
 
+import br.com.caelum.vraptor.core.DefaultReflectionProvider;
+import br.com.caelum.vraptor.environment.Environment;
+import br.com.caelum.vraptor.interceptor.DefaultTypeNameExtractor;
+import br.com.caelum.vraptor.serialization.JSONPSerialization;
+import br.com.caelum.vraptor.serialization.JSONSerialization;
+import br.com.caelum.vraptor.serialization.Serializee;
+import br.com.caelum.vraptor.serialization.SkipSerialization;
+import br.com.caelum.vraptor.util.test.MockInstanceImpl;
+
 public class GsonJSONSerializationTest {
 
 	private GsonJSONSerialization serialization;
 	private ByteArrayOutputStream stream;
 	private HttpServletResponse response;
 	private DefaultTypeNameExtractor extractor;
 	private Environment environment;
-
 	private GsonSerializerBuilder builder;
 
 	@Before
@@ -77,7 +78,7 @@ public void setup() throws Exception {
 		stream = new ByteArrayOutputStream();
 
 		response = mock(HttpServletResponse.class);
-		when(response.getWriter()).thenReturn(new PrintWriter(stream));
+		when(response.getWriter()).thenReturn(new AlwaysFlushWriter(stream));
 		extractor = new DefaultTypeNameExtractor();
 		environment = mock(Environment.class);
 
@@ -93,6 +94,20 @@ public void setup() throws Exception {
 		serialization = new GsonJSONSerialization(response, extractor, builder, environment, new DefaultReflectionProvider());
 	}
 
+	private static class AlwaysFlushWriter extends PrintWriter {
+
+		public AlwaysFlushWriter(OutputStream out) {
+			super(out);
+		}
+
+		@Override
+		public void write(String s) {
+			super.write(s);
+			super.flush();
+		}
+
+	}
+
 	@SkipSerialization
 	public static class UserPrivateInfo {
 		String cpf;
@@ -237,7 +252,6 @@ public void shouldSerializeGenericClass() {
 
 		GenericWrapper<Client> wrapper = new GenericWrapper<>(entityList, entityList.size());
 
-		// serialization.from(wrapper).include("entityList").include("entityList.name").serialize();
 		serialization.from(wrapper).include("entityList").serialize();
 
 		assertThat(result(), is(equalTo(expectedResult)));
@@ -491,13 +505,17 @@ public void shouldOptionallyRemoveRootIndented() {
 		String expected = "{\n  \"price\": 15.0,\n  \"comments\": \"pack it nicely, please\",\n  \"items\": [\n    {\n      \"name\": \"any item\"\n    }\n  ]\n}";
 		Order order = new Order(new Client("guilherme silveira"), 15.0, "pack it nicely, please", new Item(
 				"any item", 12.99));
-		serialization.indented().withoutRoot().from(order).include("items").exclude("items.price")
-				.serialize();
+		serialization.indented().withoutRoot().from(order).include("items").exclude("items.price").serialize();
 		assertThat(result(), equalTo(expected));
 	}
 
 	private String result() {
-		return new String(stream.toByteArray());
+		try {
+			stream.flush();
+			return new String(stream.toByteArray());
+		} catch (IOException e) {
+			throw new RuntimeException("Error flushing stream", e);
+		}
 	}
 
 	static class MyCollection extends ForwardingCollection<Order> {
@@ -628,4 +646,5 @@ public void shouldNotSerializeNullFieldsByDefault(){
 		String expectedResult = "{\"address\":{\"street\":\"Alameda street\"}}";
 		assertThat(result(), is(equalTo(expectedResult)));
 	}
+
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -54,6 +54,7 @@ public PrintWriter getWriter() { @@
     	}
     	public String getContentAsString() {
+    		writer.flush();
     		return this.content.toString();
     	}
@@ Expand Down @@