No longer close OutputStream that is passed into JsonSerializer (#2029)

* Do not close stream that is passed into JsonSerializer

* Add changelog

* Add JavaDoc to ISerializer

* Wrap writer.flush with finally

Author: adinauer

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- No longer close OutputStream that is passed into JsonSerializer (#2029)
+
 ### Features
 
 - Allow setting SDK info (name & version) in manifest ([#2016](https://github.com/getsentry/sentry-java/pull/2016))

sentry/src/main/java/io/sentry/ISerializer.java

@@ -17,6 +17,13 @@ public interface ISerializer {
 
   <T> void serialize(@NotNull T entity, @NotNull Writer writer) throws IOException;
 
+  /**
+   * Serializes an envelope
+   *
+   * @param envelope an envelope
+   * @param outputStream which will not be closed automatically
+   * @throws Exception an exception
+   */
   void serialize(@NotNull SentryEnvelope envelope, @NotNull OutputStream outputStream)
       throws Exception;
 

sentry/src/main/java/io/sentry/JsonSerializer.java

@@ -149,16 +149,24 @@ public <T> void serialize(@NotNull T entity, @NotNull Writer writer) throws IOEx
     writer.flush();
   }
 
+  /**
+   * Serializes an envelope to an OutputStream
+   *
+   * @param envelope the envelope
+   * @param outputStream will not be closed automatically
+   * @throws Exception an exception
+   */
   @Override
   public void serialize(@NotNull SentryEnvelope envelope, @NotNull OutputStream outputStream)
       throws Exception {
     Objects.requireNonNull(envelope, "The SentryEnvelope object is required.");
     Objects.requireNonNull(outputStream, "The Stream object is required.");
 
-    try (final BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(outputStream);
-        final Writer writer =
-            new BufferedWriter(new OutputStreamWriter(bufferedOutputStream, UTF_8))) {
+    // we do not want to close these as we would also close the stream that was passed in
+    final BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(outputStream);
+    final Writer writer = new BufferedWriter(new OutputStreamWriter(bufferedOutputStream, UTF_8));
 
+    try {
       envelope
           .getHeader()
           .serialize(new JsonObjectWriter(writer, options.getMaxDepth()), options.getLogger());
@@ -183,6 +191,7 @@ public void serialize(@NotNull SentryEnvelope envelope, @NotNull OutputStream ou
               .log(SentryLevel.ERROR, "Failed to create envelope item. Dropping it.", exception);
         }
       }
+    } finally {
       writer.flush();
     }
   }

sentry/src/test/java/io/sentry/JsonSerializerTest.kt

@@ -4,6 +4,7 @@ import com.nhaarman.mockitokotlin2.any
 import com.nhaarman.mockitokotlin2.check
 import com.nhaarman.mockitokotlin2.eq
 import com.nhaarman.mockitokotlin2.mock
+import com.nhaarman.mockitokotlin2.never
 import com.nhaarman.mockitokotlin2.verify
 import com.nhaarman.mockitokotlin2.whenever
 import io.sentry.exception.SentryEnvelopeException
@@ -18,6 +19,7 @@ import java.io.ByteArrayOutputStream
 import java.io.IOException
 import java.io.InputStream
 import java.io.InputStreamReader
+import java.io.OutputStream
 import java.io.OutputStreamWriter
 import java.io.StringReader
 import java.io.StringWriter
@@ -862,6 +864,14 @@ class JsonSerializerTest {
         )
     }
 
+    @Test
+    fun `json serializer does not close the stream that is passed in`() {
+        val stream = mock<OutputStream>()
+        JsonSerializer(SentryOptions()).serialize(SentryEnvelope.from(fixture.serializer, SentryEvent(), null), stream)
+
+        verify(stream, never()).close()
+    }
+
     private fun assertSessionData(expectedSession: Session?) {
         assertNotNull(expectedSession)
         assertEquals(UUID.fromString("c81d4e2e-bcf2-11e6-869b-7df92533d2db"), expectedSession.sessionId)