support IOContext closing in GeneratorBase (#1094)

FasterXML · Aug 31, 2023 · 8093f43 · 8093f43
1 parent 40cd6b7
commit 8093f43
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 27 deletions.
diff --git a/src/main/java/com/fasterxml/jackson/core/base/GeneratorBase.java b/src/main/java/com/fasterxml/jackson/core/base/GeneratorBase.java
@@ -1,6 +1,7 @@
 package com.fasterxml.jackson.core.base;
 
 import com.fasterxml.jackson.core.*;
+import com.fasterxml.jackson.core.io.IOContext;
 import com.fasterxml.jackson.core.json.DupDetector;
 import com.fasterxml.jackson.core.json.JsonWriteContext;
 import com.fasterxml.jackson.core.json.PackageVersion;
@@ -69,6 +70,9 @@ public abstract class GeneratorBase extends JsonGenerator
      */
     protected int _features;
 
+    // since 2.16
+    protected final IOContext _ioContext;
+
     /**
      * Flag set to indicate that implicit conversion from number
      * to JSON String is needed (as per
@@ -101,24 +105,38 @@ public abstract class GeneratorBase extends JsonGenerator
     /**********************************************************
      */
 
-    @SuppressWarnings("deprecation")
+    @Deprecated // since 2.16
     protected GeneratorBase(int features, ObjectCodec codec) {
+        this(features, codec, (IOContext) null);
+    }
+
+    // @since 2.16
+    @SuppressWarnings("deprecation")
+    protected GeneratorBase(int features, ObjectCodec codec, IOContext ioContext) {
         super();
         _features = features;
         _objectCodec = codec;
+        _ioContext = ioContext;
         DupDetector dups = Feature.STRICT_DUPLICATE_DETECTION.enabledIn(features)
                 ? DupDetector.rootDetector(this) : null;
         _writeContext = JsonWriteContext.createRootContext(dups);
         _cfgNumbersAsStrings = Feature.WRITE_NUMBERS_AS_STRINGS.enabledIn(features);
     }
 
     // @since 2.5
-    @SuppressWarnings("deprecation")
+    @Deprecated // since 2.16
     protected GeneratorBase(int features, ObjectCodec codec, JsonWriteContext ctxt) {
+        this(features, codec, null, ctxt);
+    }
+
+    // @since 2.16
+    @SuppressWarnings("deprecation")
+    protected GeneratorBase(int features, ObjectCodec codec, IOContext ioContext, JsonWriteContext jsonWriteContext) {
         super();
         _features = features;
         _objectCodec = codec;
-        _writeContext = ctxt;
+        _ioContext = ioContext;
+        _writeContext = jsonWriteContext;
         _cfgNumbersAsStrings = Feature.WRITE_NUMBERS_AS_STRINGS.enabledIn(features);
     }
 
@@ -413,7 +431,14 @@ public void writeTree(TreeNode rootNode) throws IOException {
      */
 
     @Override public abstract void flush() throws IOException;
-    @Override public void close() throws IOException { _closed = true; }
+    @Override public void close() throws IOException {
+        if (!_closed) {
+            if (_ioContext != null) {
+                _ioContext.close();
+            }
+            _closed = true;
+        }
+    }
     @Override public boolean isClosed() { return _closed; }
 
     /*

diff --git a/src/main/java/com/fasterxml/jackson/core/json/JsonGeneratorImpl.java b/src/main/java/com/fasterxml/jackson/core/json/JsonGeneratorImpl.java
@@ -45,8 +45,6 @@ public abstract class JsonGeneratorImpl extends GeneratorBase
     /**********************************************************
      */
 
-    protected final IOContext _ioContext;
-
     /**
      * @since 2.16
      */
@@ -120,19 +118,10 @@ public abstract class JsonGeneratorImpl extends GeneratorBase
     /**********************************************************
      */
 
-    @Override
-    public void close() throws IOException {
-        if (!isClosed()) {
-            super.close();
-            _ioContext.close();
-        }
-    }
-
     @SuppressWarnings("deprecation")
     public JsonGeneratorImpl(IOContext ctxt, int features, ObjectCodec codec)
     {
-        super(features, codec);
-        _ioContext = ctxt;
+        super(features, codec, ctxt);
         _streamWriteConstraints = ctxt.streamWriteConstraints();
         if (Feature.ESCAPE_NON_ASCII.enabledIn(features)) {
             // inlined `setHighestNonEscapedChar()`

diff --git a/src/test/java/com/fasterxml/jackson/core/io/BufferRecyclerPoolTest.java b/src/test/java/com/fasterxml/jackson/core/io/BufferRecyclerPoolTest.java
@@ -12,28 +12,28 @@
 
 public class BufferRecyclerPoolTest extends BaseTest
 {
-    public void testNoOp() {
+    public void testNoOp() throws Exception {
         // no-op pool doesn't actually pool anything, so avoid checking it
         checkBufferRecyclerPoolImpl(BufferRecyclerPool.NonRecyclingPool.shared(), false);
     }
 
-    public void testThreadLocal() {
+    public void testThreadLocal() throws Exception {
         checkBufferRecyclerPoolImpl(BufferRecyclerPool.ThreadLocalPool.shared(), true);
     }
 
-    public void testLockFree() {
+    public void testLockFree() throws Exception {
         checkBufferRecyclerPoolImpl(BufferRecyclerPool.LockFreePool.nonShared(), true);
     }
 
-    public void testConcurrentDequeue() {
+    public void testConcurrentDequeue() throws Exception {
         checkBufferRecyclerPoolImpl(BufferRecyclerPool.ConcurrentDequePool.nonShared(), true);
     }
 
-    public void testBounded() {
+    public void testBounded() throws Exception {
         checkBufferRecyclerPoolImpl(BufferRecyclerPool.BoundedPool.nonShared(1), true);
     }
 
-    private void checkBufferRecyclerPoolImpl(BufferRecyclerPool pool, boolean checkPooledResource) {
+    private void checkBufferRecyclerPoolImpl(BufferRecyclerPool pool, boolean checkPooledResource) throws Exception {
         JsonFactory jsonFactory = JsonFactory.builder()
                 .bufferRecyclerPool(pool)
                 .build();
@@ -50,23 +50,21 @@ private void checkBufferRecyclerPoolImpl(BufferRecyclerPool pool, boolean checkP
         }
     }
 
-    protected final BufferRecycler write(Object value, JsonFactory jsonFactory, int expectedSize) {
+    private BufferRecycler write(Object value, JsonFactory jsonFactory, int expectedSize) throws Exception {
         BufferRecycler bufferRecycler;
         NopOutputStream out = new NopOutputStream();
         try (JsonGenerator gen = jsonFactory.createGenerator(out)) {
             bufferRecycler = ((JsonGeneratorImpl) gen).ioContext()._bufferRecycler;
             gen.writeObject(value);
-        } catch (IOException e) {
-            throw new RuntimeException(e);
         }
         assertEquals(expectedSize, out.size);
         return bufferRecycler;
     }
 
-    public class NopOutputStream extends OutputStream {
+    private static class NopOutputStream extends OutputStream {
         protected int size = 0;
 
-        public NopOutputStream() { }
+        NopOutputStream() { }
 
         @Override
         public void write(int b) throws IOException { ++size; }