migrate jackson 2.x to 3.x

Author: vmillet-dev

.github/workflows/build-and-test.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/setup-java@v5
         with:
           distribution: temurin
-          java-version: 11
+          java-version: 17
 
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@06832c7b30a0129d7fb559bcc6e43d26f6374244 # v4.3.1

.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
   rl-scanner:
     uses: ./.github/workflows/rl-secure.yml
     with:
-      java-version: 11
+      java-version: 17
       artifact-name: 'java-jwt.tgz'
     secrets:
       RLSECURE_LICENSE: ${{ secrets.RLSECURE_LICENSE }}
@@ -31,7 +31,7 @@ jobs:
     uses: ./.github/workflows/java-release.yml
     needs: rl-scanner
     with:
-      java-version: 11.0.21-tem
+      java-version: 17.0.12-tem
     secrets:
       ossr-username: ${{ secrets.OSSR_USERNAME }}
       ossr-token: ${{ secrets.OSSR_TOKEN }}

.github/workflows/snyk.yml

@@ -34,6 +34,6 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha || github.ref }}
 
-      - uses: snyk/actions/gradle-jdk11@b98d498629f1c368650224d6d212bf7dfa89e4bf # pin@0.4.0
+      - uses: snyk/actions/gradle-jdk17@master # pin@0.4.0
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

gradle/maven-publish.gradle

@@ -19,7 +19,7 @@ tasks.withType(Javadoc).configureEach {
 
 javadoc {
     // Specify the Java version that the project will use
-    options.addStringOption('-release', "11")
+    options.addStringOption('-release', "17")
 }
 artifacts {
     archives sourcesJar, javadocJar

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.6-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

lib/build.gradle

@@ -1,19 +1,8 @@
-buildscript {
-    repositories {
-        jcenter()
-    }
-
-    dependencies {
-        // https://github.com/melix/japicmp-gradle-plugin/issues/36
-        classpath 'com.google.guava:guava:31.1-jre'
-    }
-}
-
 plugins {
     id 'java'
     id 'jacoco'
     id 'checkstyle'
-    id 'me.champeau.gradle.japicmp' version '0.4.1'
+    id 'me.champeau.gradle.japicmp' version '0.4.6'
     id 'maven-publish'
 }
 
@@ -102,29 +91,29 @@ private static File getBaselineJar(Project project, String baselineVersion) {
 
 ext {
     baselineCompareVersion = '4.1.0'
-    testInJavaVersions = [8, 11, 17, 21]
+    testInJavaVersions = [17, 21]
 }
 
 java {
     toolchain {
-        languageVersion = JavaLanguageVersion.of(11)
+        languageVersion = JavaLanguageVersion.of(17)
     }
 }
 
 compileJava {
-    exclude 'module-info.java'
-    // Required to be compatible with JDK 8+
-    options.release = 8
+    options.release = 17
+    options.compilerArgs << "-Xlint:unchecked"
 }
 
 javadoc {
     // Exclude internal implementation package from javadoc
     excludes = ['com/auth0/jwt/impl', 'module-info.java']
+    modularity.inferModulePath = false
 }
 
 dependencies {
-    implementation 'com.fasterxml.jackson.core:jackson-core:2.21.0'
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.21.0'
+    implementation 'tools.jackson.core:jackson-core:3.0.4'
+    implementation 'tools.jackson.core:jackson-databind:3.0.4'
 
     testImplementation 'org.bouncycastle:bcprov-jdk15on:1.70'
     testImplementation 'junit:junit:4.13.2'
@@ -155,39 +144,11 @@ test {
     }
 }
 
-task compileModuleInfoJava(type: JavaCompile) {
-    classpath = files()
-    source = 'src/main/java/module-info.java'
-    destinationDir = compileJava.destinationDir
-    doLast {
-        def descriptor = new File(compileJava.destinationDir, 'module-info.class')
-        def dest = new File(compileJava.destinationDir, 'META-INF/versions/9')
-        ant.move file: descriptor, todir: dest
-    }
-
-    doFirst {
-        options.compilerArgs = [
-                '--release', '9',
-                '--module-path', compileJava.classpath.asPath
-        ]
-    }
-}
-
 compileTestJava {
-    options.release = 8
+    options.release = 17
     options.compilerArgs = ["-Xlint:deprecation"]
 }
 
-def testJava8 = tasks.register('testJava8', Test) {
-    description = 'Runs unit tests on Java 8.'
-    group = 'verification'
-
-    javaLauncher.set(javaToolchains.launcherFor {
-        languageVersion = JavaLanguageVersion.of(8)
-    })
-    shouldRunAfter(tasks.named('test'))
-}
-
 def testJava17 = tasks.register('testJava17', Test) {
     description = 'Runs unit tests on Java 17.'
     group = 'verification'
@@ -209,7 +170,6 @@ def testJava21 = tasks.register('testJava21', Test) {
 }
 
 tasks.named('check') {
-    dependsOn(testJava8)
     dependsOn(testJava17)
     dependsOn(testJava21)
 }
@@ -218,9 +178,6 @@ jar {
     manifest.attributes('Multi-Release': 'true')
 }
 
-compileModuleInfoJava.dependsOn compileJava
-classes.dependsOn compileModuleInfoJava
-
 // you can pass any arguments JMH accepts via Gradle args.
 // Example: ./gradlew runJMH --args="-lrf"
 tasks.register('runJMH', JavaExec) {

lib/src/main/java/com/auth0/jwt/JWTCreator.java

@@ -4,11 +4,11 @@
 import com.auth0.jwt.exceptions.JWTCreationException;
 import com.auth0.jwt.exceptions.SignatureGenerationException;
 import com.auth0.jwt.impl.*;
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.MapperFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.json.JsonMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
+import tools.jackson.databind.MapperFeature;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
+import tools.jackson.databind.module.SimpleModule;
+import tools.jackson.core.JacksonException;
 
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
@@ -38,8 +38,8 @@ public final class JWTCreator {
 
         mapper = JsonMapper.builder()
                 .configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true)
-                .build()
-                .registerModule(module);
+                .addModule(module)
+                .build();
     }
 
     private JWTCreator(Algorithm algorithm, Map<String, Object> headerClaims, Map<String, Object> payloadClaims)
@@ -48,7 +48,7 @@ private JWTCreator(Algorithm algorithm, Map<String, Object> headerClaims, Map<St
         try {
             headerJson = mapper.writeValueAsString(new HeaderClaimsHolder(headerClaims));
             payloadJson = mapper.writeValueAsString(new PayloadClaimsHolder(payloadClaims));
-        } catch (JsonProcessingException e) {
+        } catch (JacksonException e) {
             throw new JWTCreationException("Some of the Claims couldn't be converted to a valid JSON format.", e);
         }
     }
@@ -114,7 +114,7 @@ public Builder withHeader(String headerClaimsJson) throws IllegalArgumentExcepti
             try {
                 Map<String, Object> headerClaims = mapper.readValue(headerClaimsJson, LinkedHashMap.class);
                 return withHeader(headerClaims);
-            } catch (JsonProcessingException e) {
+            } catch (JacksonException e) {
                 throw new IllegalArgumentException("Invalid header JSON", e);
             }
         }
@@ -510,7 +510,7 @@ public Builder withPayload(String payloadClaimsJson) throws IllegalArgumentExcep
             try {
                 Map<String, Object> payloadClaims =  mapper.readValue(payloadClaimsJson, LinkedHashMap.class);
                 return withPayload(payloadClaims);
-            } catch (JsonProcessingException e) {
+            } catch (JacksonException e) {
                 throw new IllegalArgumentException("Invalid payload JSON", e);
             }
         }

lib/src/main/java/com/auth0/jwt/impl/BasicHeader.java

@@ -2,8 +2,8 @@
 
 import com.auth0.jwt.interfaces.Claim;
 import com.auth0.jwt.interfaces.Header;
-import com.fasterxml.jackson.core.ObjectCodec;
-import com.fasterxml.jackson.databind.JsonNode;
+import tools.jackson.databind.DeserializationContext;
+import tools.jackson.databind.JsonNode;
 
 import java.io.Serializable;
 import java.util.Collections;
@@ -22,22 +22,22 @@ class BasicHeader implements Header, Serializable {
     private final String contentType;
     private final String keyId;
     private final Map<String, JsonNode> tree;
-    private final ObjectCodec objectCodec;
+    private final DeserializationContext context;
 
     BasicHeader(
             String algorithm,
             String type,
             String contentType,
             String keyId,
             Map<String, JsonNode> tree,
-            ObjectCodec objectCodec
+            DeserializationContext context
     ) {
         this.algorithm = algorithm;
         this.type = type;
         this.contentType = contentType;
         this.keyId = keyId;
         this.tree = tree == null ? Collections.emptyMap() : Collections.unmodifiableMap(tree);
-        this.objectCodec = objectCodec;
+        this.context = context;
     }
 
     Map<String, JsonNode> getTree() {
@@ -66,6 +66,6 @@ public String getKeyId() {
 
     @Override
     public Claim getHeaderClaim(String name) {
-        return extractClaim(name, tree, objectCodec);
+        return extractClaim(name, tree, context);
     }
 }

lib/src/main/java/com/auth0/jwt/impl/ClaimsSerializer.java

@@ -1,10 +1,10 @@
 package com.auth0.jwt.impl;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import tools.jackson.core.JacksonException;
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.ser.std.StdSerializer;
+import tools.jackson.databind.SerializationContext;
 
-import java.io.IOException;
 import java.time.Instant;
 import java.util.Date;
 import java.util.List;
@@ -22,7 +22,7 @@ public ClaimsSerializer(Class<T> t) {
     }
 
     @Override
-    public void serialize(T holder, JsonGenerator gen, SerializerProvider provider) throws IOException {
+    public void serialize(T holder, JsonGenerator gen, SerializationContext provider) throws JacksonException {
         gen.writeStartObject();
         for (Map.Entry<String, Object> entry : holder.getClaims().entrySet()) {
             writeClaim(entry, gen);
@@ -37,14 +37,14 @@ public void serialize(T holder, JsonGenerator gen, SerializerProvider provider)
      *
      * @param entry The entry that corresponds to the JSON field to write
      * @param gen The {@code JsonGenerator} to use
-     * @throws IOException if there is either an underlying I/O problem or encoding issue at format layer
+     * @throws JacksonException if there is either an underlying I/O problem or encoding issue at format layer
      */
-    protected void writeClaim(Map.Entry<String, Object> entry, JsonGenerator gen) throws IOException {
-        gen.writeFieldName(entry.getKey());
+    protected void writeClaim(Map.Entry<String, Object> entry, JsonGenerator gen) throws JacksonException {
+        gen.writeName(entry.getKey());
         handleSerialization(entry.getValue(), gen);
     }
 
-    private static void handleSerialization(Object value, JsonGenerator gen) throws IOException {
+    private static void handleSerialization(Object value, JsonGenerator gen) throws JacksonException {
         if (value instanceof Date) {
             gen.writeNumber(dateToSeconds((Date) value));
         } else if (value instanceof Instant) { // EXPIRES_AT, ISSUED_AT, NOT_BEFORE, custom Instant claims
@@ -54,21 +54,21 @@ private static void handleSerialization(Object value, JsonGenerator gen) throws
         } else if (value instanceof List) {
             serializeList((List<?>) value, gen);
         } else {
-            gen.writeObject(value);
+            gen.writePOJO(value);
         }
     }
 
-    private static void serializeMap(Map<?, ?> map, JsonGenerator gen) throws IOException {
+    private static void serializeMap(Map<?, ?> map, JsonGenerator gen) throws JacksonException {
         gen.writeStartObject();
         for (Map.Entry<?, ?> entry : map.entrySet()) {
-            gen.writeFieldName((String) entry.getKey());
+            gen.writeName((String) entry.getKey());
             Object value = entry.getValue();
             handleSerialization(value, gen);
         }
         gen.writeEndObject();
     }
 
-    private static void serializeList(List<?> list, JsonGenerator gen) throws IOException {
+    private static void serializeList(List<?> list, JsonGenerator gen) throws JacksonException {
         gen.writeStartArray();
         for (Object entry : list) {
             handleSerialization(entry, gen);

lib/src/main/java/com/auth0/jwt/impl/HeaderDeserializer.java

@@ -3,13 +3,13 @@
 import com.auth0.jwt.HeaderParams;
 import com.auth0.jwt.exceptions.JWTDecodeException;
 import com.auth0.jwt.interfaces.Header;
-import com.fasterxml.jackson.core.JsonParser;
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.DeserializationContext;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+import tools.jackson.core.JacksonException;
+import tools.jackson.core.JsonParser;
+import tools.jackson.core.type.TypeReference;
+import tools.jackson.databind.DeserializationContext;
+import tools.jackson.databind.JsonNode;
+import tools.jackson.databind.deser.std.StdDeserializer;
 
-import java.io.IOException;
 import java.util.Map;
 
 /**
@@ -26,8 +26,8 @@ class HeaderDeserializer extends StdDeserializer<Header> {
     }
 
     @Override
-    public Header deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
-        Map<String, JsonNode> tree = p.getCodec().readValue(p, new TypeReference<Map<String, JsonNode>>() {
+    public Header deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException {
+        Map<String, JsonNode> tree = ctxt.readValue(p, new TypeReference<>() {
         });
         if (tree == null) {
             throw new JWTDecodeException("Parsing the Header's JSON resulted on a Null map");
@@ -37,14 +37,14 @@ public Header deserialize(JsonParser p, DeserializationContext ctxt) throws IOEx
         String type = getString(tree, HeaderParams.TYPE);
         String contentType = getString(tree, HeaderParams.CONTENT_TYPE);
         String keyId = getString(tree, HeaderParams.KEY_ID);
-        return new BasicHeader(algorithm, type, contentType, keyId, tree, p.getCodec());
+        return new BasicHeader(algorithm, type, contentType, keyId, tree, ctxt);
     }
 
     String getString(Map<String, JsonNode> tree, String claimName) {
         JsonNode node = tree.get(claimName);
         if (node == null || node.isNull()) {
             return null;
         }
-        return node.asText(null);
+        return node.asString(null);
     }
 }