Fix #662: remove throws IOException from AvroMapper.schemaFrom() method signatures (#671)

cowtowncoder · web-flow · commit 63f9a0fc1de4 · 2026-03-01T18:39:05.000-08:00
diff --git a/avro/src/main/java/tools/jackson/dataformat/avro/AvroMapper.java b/avro/src/main/java/tools/jackson/dataformat/avro/AvroMapper.java
@@ -9,7 +9,7 @@
 import tools.jackson.core.JacksonException;
 import tools.jackson.core.JsonGenerator;
 import tools.jackson.core.Version;
-
+import tools.jackson.core.exc.JacksonIOException;
 import tools.jackson.databind.*;
 import tools.jackson.databind.cfg.MapperBuilder;
 import tools.jackson.databind.cfg.MapperBuilderState;
@@ -277,13 +277,16 @@ protected JacksonException _invalidSchemaDefinition(JavaType type,
      * and once done (successfully or not), closing the stream.
      *<p>
      * Resulting schema object does not use separate reader/writer schemas.
+     *<p>
+     * NOTE: up until 3.1, was declared to throw {@link IOException}; removed
+     * in 3.2
      */
-    public AvroSchema schemaFrom(InputStream in) throws IOException
+    public AvroSchema schemaFrom(InputStream in0)
     {
-        try {
+        try (InputStream in = in0) {
             return new AvroSchema(new Schema.Parser().parse(in));
-        } finally {
-            in.close();
+        } catch (IOException e) {
+            throw JacksonIOException.construct(e);
         }
     }
 
@@ -292,8 +295,11 @@ public AvroSchema schemaFrom(InputStream in) throws IOException
      * encoded JSON representation.
      *<p>
      * Resulting schema object does not use separate reader/writer schemas.
+     *<p>
+     * NOTE: up until 3.1, was declared to throw {@link IOException}; removed
+     * in 3.2
      */
-    public AvroSchema schemaFrom(String schemaAsString) throws IOException
+    public AvroSchema schemaFrom(String schemaAsString)
     {
         return new AvroSchema(new Schema.Parser().parse(schemaAsString));
     }
@@ -303,10 +309,17 @@ public AvroSchema schemaFrom(String schemaAsString) throws IOException
      * encoded JSON representation.
      *<p>
      * Resulting schema object does not use separate reader/writer schemas.
+     *<p>
+     * NOTE: up until 3.1, was declared to throw {@link IOException}; removed
+     * in 3.2
      */
-    public AvroSchema schemaFrom(File schemaFile) throws IOException
+    public AvroSchema schemaFrom(File schemaFile)
     {
-        return new AvroSchema(new Schema.Parser().parse(schemaFile));
+        try {
+            return new AvroSchema(new Schema.Parser().parse(schemaFile));
+        } catch (IOException e) {
+            throw JacksonIOException.construct(e);
+        }
     }
 
     /*
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/AmbiguousUnionWriteTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/AmbiguousUnionWriteTest.java
@@ -9,7 +9,7 @@
 //   it should not be.
 public class AmbiguousUnionWriteTest extends AvroTestBase
 {
-    protected final String SCHEMA_WITH_AMBIGUITY = aposToQuotes("{\n"
+    protected final String SCHEMA_WITH_AMBIGUITY = a2q("{\n"
             +"'type': 'record',\n"
             +"'name': 'WithUnion',\n"
             +"'fields': [\n"
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/AnyProperties75Test.java b/avro/src/test/java/tools/jackson/dataformat/avro/AnyProperties75Test.java
@@ -38,7 +38,7 @@ public Object get(String name) {
     @Test
     public void testReadWriteIntSequence() throws Exception
     {
-        final String SCHEMA_JSON = aposToQuotes("{\n"
+        final String SCHEMA_JSON = a2q("{\n"
                 + "    'type': 'record',\n"
                 + "    'name': 'Pojo75',\n"
                 + "    'fields': [\n"
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/AvroTestBase.java b/avro/src/test/java/tools/jackson/dataformat/avro/AvroTestBase.java
@@ -40,7 +40,7 @@ public abstract class AvroTestBase
             +" {\"name\": \"boss\", \"type\": [\"Employee\",\"null\"]}\n"
             +"]}";
 
-    protected final String EMPLOYEE_ARRAY_SCHEMA_JSON = aposToQuotes(
+    protected final String EMPLOYEE_ARRAY_SCHEMA_JSON = a2q(
             "{"
             +"'name': 'EmployeeArray',\n"
             +"'type': 'array',\n"
@@ -288,8 +288,8 @@ protected AvroSchema parseSchema(String schemaAsJson) {
 
     protected AvroSchema parseSchema(AvroMapper mapper, String schemaAsJson) {
         try {
-            return getMapper().schemaFrom(aposToQuotes(schemaAsJson));
-        } catch (IOException e) {
+            return getMapper().schemaFrom(a2q(schemaAsJson));
+        } catch (Exception e) {
             fail("Could not parse Avro Schema from: "+schemaAsJson+", problem: "+e);
             return null;
         }
@@ -346,12 +346,22 @@ public static void verifyException(Throwable e, String... matches)
         fail("Expected an exception with one of substrings ("+Arrays.asList(matches)+"): got one with message \""+msg+"\"");
     }
 
-    protected static String quote(String str) {
+    protected static String a2q(String json) {
+        return json.replace("'", "\"");
+    }
+
+    protected static String q(String str) {
         return "\""+str+"\"";
     }
+    
+    @Deprecated // @since 3.2
+    protected static String quote(String str) {
+        return q(str);
+    }
 
+    @Deprecated // @since 3.2
     protected static String aposToQuotes(String json) {
-        return json.replace("'", "\"");
+        return a2q(json);
     }
 
     protected static String asJSON(AvroSchema sch) {
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/MapWithUnionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/MapWithUnionTest.java
@@ -1,7 +1,6 @@
 package tools.jackson.dataformat.avro;
 
 import java.io.ByteArrayOutputStream;
-import java.io.IOException;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
@@ -14,7 +13,7 @@
 
 public class MapWithUnionTest extends AvroTestBase
 {
-    protected final String MAP_WITH_UNION_SCHEMA_JSON = aposToQuotes(
+    protected final String MAP_WITH_UNION_SCHEMA_JSON = a2q(
             "{"
             +"'name': 'Map',\n"
             +"'type': 'map',\n"
@@ -25,7 +24,7 @@ public class MapWithUnionTest extends AvroTestBase
             +"}\n");
 
     // for [dataformats-binary#39]
-    final static String MAP_CONTAINER_SCHEMA_JSON = aposToQuotes("{\n"
+    final static String MAP_CONTAINER_SCHEMA_JSON = a2q("{\n"
             +" 'namespace': 'com.salesforce.conduit.avro',\n"
             +" 'type': 'record',\n"
             +" 'name': 'MapContainer',\n"
@@ -105,7 +104,7 @@ public void testRootMapWithUnionSequence() throws Exception
     }
 
     @Test
-    public void testMapContainerWithNested() throws IOException
+    public void testMapContainerWithNested() throws Exception
     {
         Map<String,Object> map = new LinkedHashMap<>();
         map.put("hello", "world");
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/RootSequenceTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/RootSequenceTest.java
@@ -22,7 +22,7 @@ public class RootSequenceTest extends AvroTestBase
     @Test
     public void testReadWriteIntSequence() throws Exception
     {
-        AvroSchema schema = MAPPER.schemaFrom(quote("int"));
+        AvroSchema schema = MAPPER.schemaFrom(q("int"));
         ByteArrayOutputStream b = new ByteArrayOutputStream(1000);
 
         // First: write a sequence of 3 root-level ints
@@ -50,7 +50,7 @@ public void testReadWriteIntSequence() throws Exception
     @Test
     public void testReadWriteStringSequence() throws Exception
     {
-        AvroSchema schema = MAPPER.schemaFrom(quote("string"));
+        AvroSchema schema = MAPPER.schemaFrom(q("string"));
         ByteArrayOutputStream b = new ByteArrayOutputStream(1000);
 
         // First: write a sequence of 3 root-level Strings
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/RoundtripTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/RoundtripTest.java
@@ -12,7 +12,7 @@
 
 public class RoundtripTest extends MapTest
 {
-    static String SCHEMA_ISSUE_16 = aposToQuotes("{\n"+
+    static String SCHEMA_ISSUE_16 = a2q("{\n"+
         " 'namespace':'org.example.testsnippets',\n"+
         " 'type':'record',\n"+
         " 'name':'TestDto',\n"+
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/ScalarTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/ScalarTest.java
@@ -17,7 +17,7 @@ public class ScalarTest extends AvroTestBase
     public void testRootString() throws Exception
     {
         final String INPUT = "Something or other";
-        AvroSchema schema = MAPPER.schemaFrom(quote("string"));
+        AvroSchema schema = MAPPER.schemaFrom(q("string"));
         byte[] avro = MAPPER.writerFor(String.class)
                 .with(schema)
                 .writeValueAsBytes(INPUT);
@@ -41,7 +41,7 @@ public void _testRootString(int chunkSize, ObjectReader r, byte[] encoded,
     public void testRootInt() throws Exception
     {
         Integer inputValue = Integer.valueOf(0xE134567);
-        AvroSchema schema = MAPPER.schemaFrom(quote("int"));
+        AvroSchema schema = MAPPER.schemaFrom(q("int"));
         byte[] avro = MAPPER.writer(schema)
                 .writeValueAsBytes(inputValue);
         ObjectReader r = MAPPER.readerFor(Integer.class)
@@ -164,7 +164,7 @@ public void _testRootFloat(int chunkSize, ObjectReader r, byte[] encoded,
     @Test
     public void testRootBoolean() throws Exception
     {
-        AvroSchema schema = MAPPER.schemaFrom(quote("boolean"));
+        AvroSchema schema = MAPPER.schemaFrom(q("boolean"));
         byte[] avro = MAPPER.writer(schema)
                 .writeValueAsBytes(Boolean.TRUE);
         Boolean result = MAPPER.readerFor(Boolean.class)
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/constraints/DeeplyNestedAvroReadTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/constraints/DeeplyNestedAvroReadTest.java
@@ -56,14 +56,7 @@ public Node(int id, Node next) {
         MAPPER_400 = new AvroMapper(f);
     }
 
-    private final AvroSchema NODE_SCHEMA;
-    {
-        try {
-            NODE_SCHEMA = DEFAULT_MAPPER.schemaFrom(NODE_SCHEMA_JSON);
-        } catch (IOException e) {
-            throw new RuntimeException(e);
-        }
-    }
+    private final AvroSchema NODE_SCHEMA = DEFAULT_MAPPER.schemaFrom(NODE_SCHEMA_JSON);
 
     @Test
     public void testDeeplyNestedObjectsHighLimits() throws Exception
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/ArrayEvolutionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/ArrayEvolutionTest.java
@@ -13,7 +13,7 @@ public class ArrayEvolutionTest extends AvroTestBase
     // NOTE! Avro requires names of record types to match; this is why type names
     //   are identical despite differences in field composition...
 
-    static String SCHEMA_X_ARRAY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_X_ARRAY_JSON = a2q("{\n"+
             "'name': 'XArray',\n"+
             "'type': 'array',\n"+
             "'items': {\n"+
@@ -23,7 +23,7 @@ public class ArrayEvolutionTest extends AvroTestBase
             "    { 'name':'x', 'type':'int' }\n"+
             " ]}}");
 
-    static String SCHEMA_XY_ARRAY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XY_ARRAY_JSON = a2q("{\n"+
             "'name': 'XYArray',\n"+
             "'type': 'array',\n"+
             "'items': {\n"+
@@ -34,7 +34,7 @@ public class ArrayEvolutionTest extends AvroTestBase
             "    { 'name':'y', 'type':'int' }\n"+
             " ]}}");
 
-    static String SCHEMA_XYZ_ARRAY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XYZ_ARRAY_JSON = a2q("{\n"+
             "'name': 'XYZArray',\n"+
             "'type': 'array',\n"+
             "'items': {\n"+
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/ComplexDefaultsTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/ComplexDefaultsTest.java
@@ -13,7 +13,7 @@
 
 public class ComplexDefaultsTest extends AvroTestBase
 {
-    static String SCHEMA_V1_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_V1_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'RootType',\n"+
             " 'fields':[\n"+
@@ -22,7 +22,7 @@ public class ComplexDefaultsTest extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_V2_JSON_RECORD = aposToQuotes("{\n"+
+    static String SCHEMA_V2_JSON_RECORD = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'RootType',\n"+
             " 'fields':[\n"+
@@ -42,7 +42,7 @@ public class ComplexDefaultsTest extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_V2_JSON_MAP = aposToQuotes("{\n"+
+    static String SCHEMA_V2_JSON_MAP = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'RootType',\n"+
             " 'fields':[\n"+
@@ -59,7 +59,7 @@ public class ComplexDefaultsTest extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_V2_JSON_LIST = aposToQuotes("{\n"+
+    static String SCHEMA_V2_JSON_LIST = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'RootType',\n"+
             " 'fields':[\n"+
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/Evolution275Test.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/Evolution275Test.java
@@ -42,7 +42,7 @@
 public class Evolution275Test extends AvroTestBase
 {
     // Original schema with 8 fields (simulating the issue scenario)
-    static String SCHEMA_V1_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_V1_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'Employee',\n"+
             " 'fields':[\n"+
@@ -58,7 +58,7 @@ public class Evolution275Test extends AvroTestBase
             "}\n");
 
     // Updated schema adding a 9th field with null default at the end
-    static String SCHEMA_V2_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_V2_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'Employee',\n"+
             " 'fields':[\n"+
@@ -75,7 +75,7 @@ public class Evolution275Test extends AvroTestBase
             "}\n");
 
     // Simpler test with just 2 fields + new field with null default
-    static String SCHEMA_SIMPLE_V1_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_SIMPLE_V1_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'SimpleRecord',\n"+
             " 'fields':[\n"+
@@ -84,7 +84,7 @@ public class Evolution275Test extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_SIMPLE_V2_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_SIMPLE_V2_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'SimpleRecord',\n"+
             " 'fields':[\n"+
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/SimpleEvolutionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/SimpleEvolutionTest.java
@@ -18,15 +18,15 @@ public class SimpleEvolutionTest extends AvroTestBase
     // NOTE! Avro requires named types to match; this is why type names
     //   are identical despite differences in field composition...
 
-    static String SCHEMA_X_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_X_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint',\n"+
             " 'fields':[\n"+
             "    { 'name':'x', 'type':'int' }\n"+
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_XY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XY_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint',\n"+
             " 'fields':[\n"+
@@ -35,7 +35,7 @@ public class SimpleEvolutionTest extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_XYZ_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XYZ_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint',\n"+
             " 'fields':[\n"+
@@ -45,7 +45,7 @@ public class SimpleEvolutionTest extends AvroTestBase
             " ]\n"+
             "}\n");
 
-    static String SCHEMA_XYZ_RENAMED_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XYZ_RENAMED_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint2',\n"+
             " 'fields':[\n"+
@@ -56,7 +56,7 @@ public class SimpleEvolutionTest extends AvroTestBase
             "}\n");
 
     // and one with X + T and an Array
-    static String SCHEMA_XAY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XAY_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint',\n"+
             " 'fields':[\n"+
@@ -70,7 +70,7 @@ public class SimpleEvolutionTest extends AvroTestBase
             "}\n");
 
     // then one with X + T and an Array
-    static String SCHEMA_XBY_JSON = aposToQuotes("{\n"+
+    static String SCHEMA_XBY_JSON = a2q("{\n"+
             " 'type':'record',\n"+
             " 'name':'EvolvingPoint',\n"+
             " 'fields':[\n"+
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionArrayEvolutionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionArrayEvolutionTest.java
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionMapEvolutionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionMapEvolutionTest.java
diff --git a/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionRecordEvolutionTest.java b/avro/src/test/java/tools/jackson/dataformat/avro/schemaev/UnionRecordEvolutionTest.java
diff --git a/release-notes/VERSION b/release-notes/VERSION

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`// it should not be.`
`10`	`10`	`public class AmbiguousUnionWriteTest extends AvroTestBase`
`11`	`11`	`{`
`12`		`- protected final String SCHEMA_WITH_AMBIGUITY = aposToQuotes("{\n"`
	`12`	`+ protected final String SCHEMA_WITH_AMBIGUITY = a2q("{\n"`
`13`	`13`	`+"'type': 'record',\n"`
`14`	`14`	`+"'name': 'WithUnion',\n"`
`15`	`15`	`+"'fields': [\n"`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public Object get(String name) {`
`38`	`38`	`@Test`
`39`	`39`	`public void testReadWriteIntSequence() throws Exception`
`40`	`40`	`{`
`41`		`- final String SCHEMA_JSON = aposToQuotes("{\n"`
	`41`	`+ final String SCHEMA_JSON = a2q("{\n"`
`42`	`42`	`+ " 'type': 'record',\n"`
`43`	`43`	`+ " 'name': 'Pojo75',\n"`
`44`	`44`	`+ " 'fields': [\n"`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`
`13`	`13`	`public class RoundtripTest extends MapTest`
`14`	`14`	`{`
`15`		`- static String SCHEMA_ISSUE_16 = aposToQuotes("{\n"+`
	`15`	`+ static String SCHEMA_ISSUE_16 = a2q("{\n"+`
`16`	`16`	`" 'namespace':'org.example.testsnippets',\n"+`
`17`	`17`	`" 'type':'record',\n"+`
`18`	`18`	`" 'name':'TestDto',\n"+`