Upgrade to Jackson 3.0

asheldon · asheldon · commit 3ef5c760fdf2 · 2026-03-02T16:25:54.000-08:00
diff --git a/gradle-palantir-java-format/build.gradle b/gradle-palantir-java-format/build.gradle
@@ -25,7 +25,7 @@ dependencies {
     testImplementation project(':palantir-java-format')
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation 'org.assertj:assertj-core'
-    testImplementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'
+    testImplementation 'tools.jackson.dataformat:jackson-dataformat-xml'
 
     testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
 
diff --git a/gradle-palantir-java-format/src/test/java/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPluginTest.java b/gradle-palantir-java-format/src/test/java/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPluginTest.java
@@ -19,10 +19,6 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.dataformat.xml.XmlMapper;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 import com.palantir.gradle.testing.execution.GradleInvoker;
 import com.palantir.gradle.testing.files.arbitrary.ArbitraryFile;
 import com.palantir.gradle.testing.junit.DisabledConfigurationCache;
@@ -34,6 +30,10 @@
 import java.util.Optional;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.dataformat.xml.XmlMapper;
+import tools.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
+import tools.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
 @GradlePluginTests
 @DisabledConfigurationCache
diff --git a/idea-plugin/build.gradle b/idea-plugin/build.gradle
@@ -63,6 +63,10 @@ dependencies {
     }
     implementation 'com.palantir.gradle.utils:platform'
 
+    // Avoids use of older jackson-annotations brought in by IntelliJ that is
+    // incompaitble with Jackson 3.0.
+    implementation 'com.fasterxml.jackson.core:jackson-annotations'
+
     formatter project(':palantir-java-format')
 
     testImplementation 'org.assertj:assertj-core'
diff --git a/palantir-java-format-jdk-bootstrap/build.gradle b/palantir-java-format-jdk-bootstrap/build.gradle
@@ -13,13 +13,13 @@ dependencies {
 
     api project(':palantir-java-format-spi')
     compileOnly 'org.immutables:value::annotations'
-    implementation 'com.fasterxml.jackson.core:jackson-databind'
+    implementation 'tools.jackson.core:jackson-databind'
 
     // So that we have pjf on our test classpath
     testImplementation project(':palantir-java-format')
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation 'org.assertj:assertj-core'
-    testImplementation 'com.fasterxml.jackson.core:jackson-databind'
+    testImplementation 'tools.jackson.core:jackson-databind'
     formatterNativeImage(project(':palantir-java-format-native')) {
         attributes {
             attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, project.objects.named(LibraryElements, 'nativeImage'))
diff --git a/palantir-java-format-jdk-bootstrap/src/main/java/com/palantir/javaformat/bootstrap/BootstrappingFormatterService.java b/palantir-java-format-jdk-bootstrap/src/main/java/com/palantir/javaformat/bootstrap/BootstrappingFormatterService.java
@@ -16,10 +16,6 @@
 
 package com.palantir.javaformat.bootstrap;
 
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.json.JsonMapper;
-import com.fasterxml.jackson.datatype.guava.GuavaModule;
 import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Range;
@@ -34,6 +30,10 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 import org.immutables.value.Value;
+import tools.jackson.core.type.TypeReference;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
+import tools.jackson.datatype.guava.GuavaModule;
 
 public final class BootstrappingFormatterService implements FormatterService {
     private static final ObjectMapper MAPPER =
diff --git a/palantir-java-format-jdk-bootstrap/src/main/java/com/palantir/javaformat/bootstrap/NativeImageFormatterService.java b/palantir-java-format-jdk-bootstrap/src/main/java/com/palantir/javaformat/bootstrap/NativeImageFormatterService.java
@@ -16,10 +16,6 @@
 
 package com.palantir.javaformat.bootstrap;
 
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.json.JsonMapper;
-import com.fasterxml.jackson.datatype.guava.GuavaModule;
 import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Range;
@@ -33,6 +29,10 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 import org.immutables.value.Value;
+import tools.jackson.core.type.TypeReference;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
+import tools.jackson.datatype.guava.GuavaModule;
 
 public class NativeImageFormatterService implements FormatterService {
     private static final ObjectMapper MAPPER =
diff --git a/palantir-java-format-native/src/main/resources/META-INF/native-image/reachability-metadata.json b/palantir-java-format-native/src/main/resources/META-INF/native-image/reachability-metadata.json
@@ -1,28 +1,7 @@
 {
   "reflection": [
     {
-      "type": "[Lcom.fasterxml.jackson.databind.deser.Deserializers;"
-    },
-    {
-      "type": "[Lcom.fasterxml.jackson.databind.ser.BeanSerializerModifier;"
-    },
-    {
-      "type": "[Lcom.fasterxml.jackson.databind.ser.Serializers;"
-    },
-    {
-      "type": "[Ljava.lang.Object;"
-    },
-    {
-      "type": "com.fasterxml.jackson.databind.ext.Java7SupportImpl",
-      "methods": [
-        {
-          "name": "<init>",
-          "parameterTypes": []
-        }
-      ]
-    },
-    {
-      "type": "com.fasterxml.jackson.datatype.guava.deser.util.RangeHelper$RangeProperties",
+      "type": "tools.jackson.datatype.guava.deser.util.RangeHelper$RangeProperties",
       "fields": [
         {
           "name": "lowerBoundType"
@@ -204,4 +183,4 @@
       ]
     }
   ]
-}
+}
diff --git a/palantir-java-format-spi/build.gradle b/palantir-java-format-spi/build.gradle
@@ -5,11 +5,11 @@ apply plugin: 'com.palantir.external-publish-jar'
 dependencies {
     api 'com.google.guava:guava'
     api 'com.fasterxml.jackson.core:jackson-annotations'
-    api 'com.fasterxml.jackson.datatype:jackson-datatype-guava'
+    api 'tools.jackson.datatype:jackson-datatype-guava'
 
     testImplementation 'org.assertj:assertj-core'
     testImplementation 'org.junit.jupiter:junit-jupiter'
-    testImplementation 'com.fasterxml.jackson.core:jackson-databind'
+    testImplementation 'tools.jackson.core:jackson-databind'
 }
 
 tasks.withType(JavaCompile).named('compileJava') {
diff --git a/palantir-java-format/build.gradle b/palantir-java-format/build.gradle
@@ -9,10 +9,8 @@ dependencies {
     api project(':palantir-java-format-spi')
     api 'com.google.guava:guava'
     implementation 'org.functionaljava:functionaljava'
-    implementation 'com.fasterxml.jackson.core:jackson-core'
-    implementation 'com.fasterxml.jackson.core:jackson-databind'
-    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8'
-    implementation 'com.fasterxml.jackson.module:jackson-module-parameter-names'
+    implementation 'tools.jackson.core:jackson-core'
+    implementation 'tools.jackson.core:jackson-databind'
 
     testImplementation 'com.google.guava:guava-testlib'
     testImplementation 'com.google.testing.compile:compile-testing'
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/BreakBehaviour.java b/palantir-java-format/src/main/java/com/palantir/javaformat/BreakBehaviour.java
@@ -15,17 +15,15 @@
  */
 package com.palantir.javaformat;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.JsonSerializer;
-import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.google.errorprone.annotations.Immutable;
 import com.palantir.javaformat.doc.Doc;
 import com.palantir.javaformat.doc.Level;
-import java.io.IOException;
-import java.io.UncheckedIOException;
 import org.derive4j.ArgOption;
 import org.derive4j.Data;
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+import tools.jackson.databind.ValueSerializer;
+import tools.jackson.databind.annotation.JsonSerialize;
 
 @Data(arguments = ArgOption.checkedNotNull)
 @Immutable
@@ -72,45 +70,28 @@ public interface Cases<R> {
      * This is gross but just wanted to get something working. See https://github.com/derive4j/derive4j/issues/51 for a
      * potential better implementation.
      */
-    static class Json extends JsonSerializer<BreakBehaviour> {
+    static class Json extends ValueSerializer<BreakBehaviour> {
 
         @Override
-        public void serialize(BreakBehaviour value, JsonGenerator gen, SerializerProvider serializers)
-                throws IOException {
+        public void serialize(BreakBehaviour value, JsonGenerator gen, SerializationContext serializers) {
             gen.writeStartObject();
             BreakBehaviours.caseOf(value)
                     .breakThisLevel(() -> {
-                        try {
-                            gen.writeObjectField("type", "breakThisLevel");
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
-                        }
+                        gen.writeStringProperty("type", "breakThisLevel");
                         return null;
                     })
                     .preferBreakingLastInnerLevel(keepIndentWhenInlined -> {
-                        try {
-                            gen.writeObjectField("type", "preferBreakingLastInnerLevel");
-                            gen.writeObjectField("keepIndentWhenInlined", keepIndentWhenInlined);
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
-                        }
+                        gen.writeStringProperty("type", "preferBreakingLastInnerLevel");
+                        gen.writeBooleanProperty("keepIndentWhenInlined", keepIndentWhenInlined);
                         return null;
                     })
                     .inlineSuffix(() -> {
-                        try {
-                            gen.writeObjectField("type", "inlineSuffix");
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
-                        }
+                        gen.writeStringProperty("type", "inlineSuffix");
                         return null;
                     })
                     .breakOnlyIfInnerLevelsThenFitOnOneLine(keepIndentWhenInlined -> {
-                        try {
-                            gen.writeObjectField("type", "breakOnlyIfInnerLevelsThenFitOnOneLine");
-                            gen.writeObjectField("keepIndentWhenInlined", keepIndentWhenInlined);
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
-                        }
+                        gen.writeStringProperty("type", "breakOnlyIfInnerLevelsThenFitOnOneLine");
+                        gen.writeBooleanProperty("keepIndentWhenInlined", keepIndentWhenInlined);
                         return null;
                     });
             gen.writeEndObject();
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/OpenOp.java b/palantir-java-format/src/main/java/com/palantir/javaformat/OpenOp.java
@@ -14,7 +14,6 @@
 
 package com.palantir.javaformat;
 
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.palantir.javaformat.doc.Doc;
 import com.palantir.javaformat.doc.DocBuilder;
 import com.palantir.javaformat.doc.HasUniqueId;
@@ -23,6 +22,7 @@
 import java.util.OptionalInt;
 import org.immutables.value.Value;
 import org.immutables.value.Value.Default;
+import tools.jackson.databind.annotation.JsonSerialize;
 
 /**
  * An {@code OpenOp} opens a level. It is an {@link Op} in the sequence of {@link Op}s generated by {@link OpsBuilder}.
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/doc/JsonDocVisitor.java b/palantir-java-format/src/main/java/com/palantir/javaformat/doc/JsonDocVisitor.java
@@ -16,15 +16,12 @@
 
 package com.palantir.javaformat.doc;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
-import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
+import tools.jackson.databind.JsonNode;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.node.ObjectNode;
 
 public final class JsonDocVisitor implements DocVisitor<JsonNode> {
-    private static final ObjectMapper MAPPER =
-            new ObjectMapper().registerModule(new ParameterNamesModule()).registerModule(new Jdk8Module());
+    private static final ObjectMapper MAPPER = new ObjectMapper();
     private final State state;
 
     public JsonDocVisitor(State state) {
@@ -58,9 +55,9 @@ public JsonNode visitBreak(Break doc) {
         return MAPPER.createObjectNode()
                 .put("type", "break")
                 .put("flat", doc.getFlat())
-                .<ObjectNode>set("breakState", MAPPER.valueToTree(state.getBreakState(doc)))
-                .<ObjectNode>set("plusIndent", MAPPER.valueToTree(doc.plusIndent()))
-                .<ObjectNode>set("optTag", MAPPER.valueToTree(doc.optTag()))
+                .set("breakState", MAPPER.valueToTree(state.getBreakState(doc)))
+                .set("plusIndent", MAPPER.valueToTree(doc.plusIndent()))
+                .set("optTag", MAPPER.valueToTree(doc.optTag()))
                 .put("evalPlusIndent", doc.evalPlusIndent(state))
                 .put("id", doc.id());
     }
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/doc/State.java b/palantir-java-format/src/main/java/com/palantir/javaformat/doc/State.java
@@ -17,7 +17,6 @@
 package com.palantir.javaformat.doc;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.google.errorprone.annotations.Immutable;
 import com.palantir.javaformat.Indent;
 import fj.data.Set;
@@ -28,6 +27,7 @@
 import java.lang.annotation.Target;
 import org.immutables.value.Value;
 import org.immutables.value.Value.Parameter;
+import tools.jackson.databind.annotation.JsonSerialize;
 
 /** State for writing. */
 // Automatically suppressed to unblock enforcement in new code
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/DebugRenderer.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/DebugRenderer.java
@@ -16,10 +16,6 @@
 
 package com.palantir.javaformat.java;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.ArrayNode;
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.google.common.collect.ImmutableList;
 import com.google.common.hash.Hashing;
 import com.palantir.javaformat.CloseOp;
@@ -42,6 +38,9 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.stream.Collectors;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.node.ArrayNode;
+import tools.jackson.databind.node.ObjectNode;
 
 public class DebugRenderer {
     private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
@@ -139,19 +138,11 @@ private static String opsJson(OpsOutput opsOutput) {
                 json.put("toString", op.toString());
             }
         }
-        try {
-            return OBJECT_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(arrayNode);
-        } catch (JsonProcessingException e) {
-            throw new UncheckedIOException(e);
-        }
+        return OBJECT_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(arrayNode);
     }
 
     private static String jsonEscapedString(String javaInput) {
-        try {
-            return OBJECT_MAPPER.writeValueAsString(javaInput);
-        } catch (JsonProcessingException e) {
-            throw new UncheckedIOException(e);
-        }
+        return OBJECT_MAPPER.writeValueAsString(javaInput);
     }
 
     private static long computeHue(HasUniqueId op) {
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/FormatFileCallable.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/FormatFileCallable.java
@@ -14,18 +14,16 @@
 
 package com.palantir.javaformat.java;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.json.JsonMapper;
-import com.fasterxml.jackson.datatype.guava.GuavaModule;
 import com.google.common.collect.Range;
 import com.google.common.collect.RangeSet;
 import com.google.common.collect.TreeRangeSet;
 import com.palantir.javaformat.Utils;
-import java.io.UncheckedIOException;
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.Callable;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
+import tools.jackson.datatype.guava.GuavaModule;
 
 /** Encapsulates information about a file to be formatted, including which parts of the file to format. */
 class FormatFileCallable implements Callable<String> {
@@ -73,11 +71,7 @@ public String call() throws FormatterException {
     }
 
     String writeFormatReplacements(List<Replacement> replacements) throws FormatterException {
-        try {
-            return MAPPER.writeValueAsString(replacements);
-        } catch (JsonProcessingException e) {
-            throw new UncheckedIOException("Error serializing replacement output", e);
-        }
+        return MAPPER.writeValueAsString(replacements);
     }
 
     private String formatFile(Formatter formatter) throws FormatterException {
diff --git a/palantir-java-format/src/main/java/com/palantir/javaformat/java/JsonSink.java b/palantir-java-format/src/main/java/com/palantir/javaformat/java/JsonSink.java
diff --git a/palantir-java-format/src/test/java/com/palantir/javaformat/java/ReplacementTest.java b/palantir-java-format/src/test/java/com/palantir/javaformat/java/ReplacementTest.java
diff --git a/versions.lock b/versions.lock
diff --git a/versions.props b/versions.props

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,10 @@ dependencies {`
`63`	`63`	`}`
`64`	`64`	`implementation 'com.palantir.gradle.utils:platform'`
`65`	`65`
	`66`	`+ // Avoids use of older jackson-annotations brought in by IntelliJ that is`
	`67`	`+ // incompaitble with Jackson 3.0.`
	`68`	`+ implementation 'com.fasterxml.jackson.core:jackson-annotations'`
	`69`	`+`
`66`	`70`	`formatter project(':palantir-java-format')`
`67`	`71`
`68`	`72`	`testImplementation 'org.assertj:assertj-core'`