Migrate from Jackson 2 to Jackson 3 (#1980)

Summary of changes:
- Migrate documentation generation logic to Jackson 3.
- Drop explicit exception handling in documentation generation logic.
- Replace `JacksonRules` Refaster collection with Jackson 2 and Jackson
  3 equivalents.

Author: Stephan202

documentation-support/pom.xml

@@ -28,18 +28,6 @@
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
         </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.datatype</groupId>
-            <artifactId>jackson-datatype-guava</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.module</groupId>
-            <artifactId>jackson-module-parameter-names</artifactId>
-        </dependency>
         <dependency>
             <groupId>com.google.auto</groupId>
             <artifactId>auto-common</artifactId>
@@ -91,5 +79,13 @@
             <artifactId>junit-jupiter-params</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>tools.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>tools.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-guava</artifactId>
+        </dependency>
     </dependencies>
 </project>

documentation-support/src/main/java/tech/picnic/errorprone/documentation/Json.java

@@ -1,45 +1,24 @@
 package tech.picnic.errorprone.documentation;
 
-import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
-import com.fasterxml.jackson.annotation.PropertyAccessor;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.datatype.guava.GuavaModule;
-import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
-import com.google.errorprone.annotations.FormatMethod;
-import java.io.IOException;
-import java.io.UncheckedIOException;
 import java.nio.file.Path;
+import tools.jackson.databind.json.JsonMapper;
+import tools.jackson.datatype.guava.GuavaModule;
 
 /**
  * Utility class that offers mutually consistent JSON serialization and deserialization operations,
  * without further specifying the exact schema used.
  */
 final class Json {
-  private static final ObjectMapper OBJECT_MAPPER =
-      new ObjectMapper()
-          .setVisibility(PropertyAccessor.FIELD, Visibility.ANY)
-          .registerModules(new GuavaModule(), new ParameterNamesModule());
+  private static final JsonMapper JSON_MAPPER =
+      JsonMapper.builder().addModule(new GuavaModule()).build();
 
   private Json() {}
 
   static <T> T read(Path path, Class<T> clazz) {
-    try {
-      return OBJECT_MAPPER.readValue(path.toFile(), clazz);
-    } catch (IOException e) {
-      throw failure(e, "Failure reading from '%s'", path);
-    }
+    return JSON_MAPPER.readValue(path.toFile(), clazz);
   }
 
   static <T> void write(Path path, T object) {
-    try {
-      OBJECT_MAPPER.writeValue(path.toFile(), object);
-    } catch (IOException e) {
-      throw failure(e, "Failure writing to '%s'", path);
-    }
-  }
-
-  @FormatMethod
-  private static UncheckedIOException failure(IOException cause, String format, Object... args) {
-    return new UncheckedIOException(format.formatted(args), cause);
+    JSON_MAPPER.writeValue(path.toFile(), object);
   }
 }

documentation-support/src/test/java/tech/picnic/errorprone/documentation/JsonTest.java

@@ -2,11 +2,8 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
-import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import org.junit.jupiter.api.Test;
@@ -25,14 +22,6 @@ void write(@TempDir Path directory) {
     assertThat(file).content(UTF_8).isEqualTo(TEST_JSON);
   }
 
-  @Test
-  void writeFailure(@TempDir Path directory) {
-    assertThatThrownBy(() -> Json.write(directory, TEST_OBJECT))
-        .isInstanceOf(UncheckedIOException.class)
-        .hasMessageContaining("Failure writing to '%s'", directory)
-        .hasCauseInstanceOf(FileNotFoundException.class);
-  }
-
   @Test
   void read(@TempDir Path directory) throws IOException {
     Path file = directory.resolve("test.json");
@@ -42,13 +31,5 @@ void read(@TempDir Path directory) throws IOException {
     assertThat(Json.read(file, TestObject.class)).isEqualTo(TEST_OBJECT);
   }
 
-  @Test
-  void readFailure(@TempDir Path directory) {
-    assertThatThrownBy(() -> Json.read(directory, TestObject.class))
-        .isInstanceOf(UncheckedIOException.class)
-        .hasMessageContaining("Failure reading from '%s'", directory)
-        .hasCauseInstanceOf(FileNotFoundException.class);
-  }
-
   private record TestObject(String string, int number) {}
 }

error-prone-contrib/pom.xml

@@ -288,6 +288,11 @@
             <artifactId>testng</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>tools.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 
     <build>

…rorprone/refasterrules/JacksonRules.java …orprone/refasterrules/Jackson2Rules.javaerror-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/JacksonRules.java renamed to error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/Jackson2Rules.java error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/JacksonRules.java renamed to error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/Jackson2Rules.java

@@ -9,10 +9,10 @@
 import java.util.Optional;
 import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
 
-/** Refaster rules related to Jackson expressions and statements. */
+/** Refaster rules related to Jackson 2.x expressions and statements. */
 @OnlineDocumentation
-final class JacksonRules {
-  private JacksonRules() {}
+final class Jackson2Rules {
+  private Jackson2Rules() {}
 
   /** Prefer {@link JsonNode#optional(int)} over more contrived alternatives. */
   static final class JsonNodeOptionalInt {

error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/Jackson3Rules.java

@@ -0,0 +1,65 @@
+package tech.picnic.errorprone.refasterrules;
+
+import com.google.errorprone.refaster.Refaster;
+import com.google.errorprone.refaster.annotation.AfterTemplate;
+import com.google.errorprone.refaster.annotation.BeforeTemplate;
+import java.util.Optional;
+import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
+import tools.jackson.databind.JsonNode;
+import tools.jackson.databind.ObjectMapper;
+
+/** Refaster rules related to Jackson 3.x expressions and statements. */
+@OnlineDocumentation
+final class Jackson3Rules {
+  private Jackson3Rules() {}
+
+  /** Prefer {@link JsonNode#optional(int)} over more contrived alternatives. */
+  static final class JsonNodeOptionalInt {
+    @BeforeTemplate
+    Optional<JsonNode> before(JsonNode node, int index) {
+      return Refaster.anyOf(
+          node.get(index).asOptional(),
+          node.path(index).asOptional(),
+          Optional.of(node.get(index)),
+          Optional.ofNullable(node.get(index)));
+    }
+
+    @AfterTemplate
+    Optional<JsonNode> after(JsonNode node, int index) {
+      return node.optional(index);
+    }
+  }
+
+  /** Prefer {@link JsonNode#optional(String)} over more contrived alternatives. */
+  static final class JsonNodeOptionalString {
+    @BeforeTemplate
+    Optional<JsonNode> before(JsonNode node, String fieldName) {
+      return Refaster.anyOf(
+          node.get(fieldName).asOptional(),
+          node.path(fieldName).asOptional(),
+          Optional.of(node.get(fieldName)),
+          Optional.ofNullable(node.get(fieldName)));
+    }
+
+    @AfterTemplate
+    Optional<JsonNode> after(JsonNode node, String fieldName) {
+      return node.optional(fieldName);
+    }
+  }
+
+  /**
+   * Prefer {@link ObjectMapper#valueToTree(Object)} over more contrived and less efficient
+   * alternatives.
+   */
+  static final class ObjectMapperValueToTree {
+    @BeforeTemplate
+    JsonNode before(ObjectMapper objectMapper, Object object) {
+      return objectMapper.readTree(objectMapper.writeValueAsString(object));
+    }
+
+    @AfterTemplate
+    JsonNode after(ObjectMapper objectMapper, Object object) {
+      return objectMapper.valueToTree(object);
+    }
+  }
+}

error-prone-contrib/src/test/java/tech/picnic/errorprone/refasterrules/RefasterRulesTest.java

@@ -64,7 +64,8 @@ final class RefasterRulesTest {
           ImmutableTableRules.class,
           InputStreamRules.class,
           IntStreamRules.class,
-          JacksonRules.class,
+          Jackson2Rules.class,
+          Jackson3Rules.class,
           JUnitRules.class,
           JUnitToAssertJRules.class,
           LongStreamRules.class,

…refasterrules/JacksonRulesTestInput.java …efasterrules/Jackson2RulesTestInput.javaerror-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/JacksonRulesTestInput.java renamed to error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/Jackson2RulesTestInput.java error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/JacksonRulesTestInput.java renamed to error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/Jackson2RulesTestInput.java

@@ -8,7 +8,7 @@
 import java.util.Optional;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
-final class JacksonRulesTest implements RefasterRuleCollectionTestCase {
+final class Jackson2RulesTest implements RefasterRuleCollectionTestCase {
   ImmutableSet<Optional<JsonNode>> testJsonNodeOptionalInt() {
     return ImmutableSet.of(
         NullNode.getInstance().get(1).asOptional(),

…efasterrules/JacksonRulesTestOutput.java …fasterrules/Jackson2RulesTestOutput.javaerror-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/JacksonRulesTestOutput.java renamed to error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/Jackson2RulesTestOutput.java error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/JacksonRulesTestOutput.java renamed to error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/Jackson2RulesTestOutput.java

@@ -8,7 +8,7 @@
 import java.util.Optional;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
-final class JacksonRulesTest implements RefasterRuleCollectionTestCase {
+final class Jackson2RulesTest implements RefasterRuleCollectionTestCase {
   ImmutableSet<Optional<JsonNode>> testJsonNodeOptionalInt() {
     return ImmutableSet.of(
         NullNode.getInstance().optional(1),

error-prone-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/Jackson3RulesTestInput.java

@@ -0,0 +1,30 @@
+package tech.picnic.errorprone.refasterrules;
+
+import com.google.common.collect.ImmutableSet;
+import java.util.Optional;
+import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
+import tools.jackson.databind.JsonNode;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.node.NullNode;
+
+final class Jackson3RulesTest implements RefasterRuleCollectionTestCase {
+  ImmutableSet<Optional<JsonNode>> testJsonNodeOptionalInt() {
+    return ImmutableSet.of(
+        NullNode.getInstance().get(1).asOptional(),
+        NullNode.getInstance().path(2).asOptional(),
+        Optional.of(NullNode.getInstance().get(3)),
+        Optional.ofNullable(NullNode.getInstance().get(4)));
+  }
+
+  ImmutableSet<Optional<JsonNode>> testJsonNodeOptionalString() {
+    return ImmutableSet.of(
+        NullNode.getInstance().get("foo").asOptional(),
+        NullNode.getInstance().path("bar").asOptional(),
+        Optional.of(NullNode.getInstance().get("baz")),
+        Optional.ofNullable(NullNode.getInstance().get("qux")));
+  }
+
+  JsonNode testObjectMapperValueToTree() {
+    return new ObjectMapper().readTree(new ObjectMapper().writeValueAsString("foo"));
+  }
+}