Merge branch '3.x' into test-scala3.8

Author: pjfanning

.github/workflows/ci.yml

@@ -9,9 +9,9 @@ name: Continuous Integration
 
 on:
   pull_request:
-    branches: [3.x, 3.0]
+    branches: [3.x, 3.2, 3.1, 3.0]
   push:
-    branches: [3.x, 3.0]
+    branches: [3.x, 3.2, 3.1, 3.0]
     tags: [v*]
 
 env:
@@ -68,7 +68,7 @@ jobs:
         run: tar cf targets.tar target project/target
 
       - name: Upload target directories
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v7
         with:
           name: target-${{ matrix.os }}-${{ matrix.scala }}-${{ matrix.java }}
           path: targets.tar
@@ -117,7 +117,7 @@ jobs:
         uses: sbt/setup-sbt@v1
 
       - name: Download target directories (2.12.21)
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v8
         with:
           name: target-${{ matrix.os }}-2.12.21-${{ matrix.java }}
 
@@ -127,7 +127,7 @@ jobs:
           rm targets.tar
 
       - name: Download target directories (2.13.18)
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v8
         with:
           name: target-${{ matrix.os }}-2.13.18-${{ matrix.java }}
 

README.md

@@ -103,7 +103,7 @@ Consult the [Scaladoc](https://fasterxml.github.io/jackson-module-scala/latest/a
 
 To import in sbt:
 ```scala
-libraryDependencies += "tools.jackson.module" %% "jackson-module-scala" % "3.0.0"
+libraryDependencies += "tools.jackson.module" %% "jackson-module-scala" % "3.1.2"
 ```
 
 ## Java/Kotlin users

build.sbt

@@ -27,8 +27,8 @@ ThisBuild / publishTo := {
 bomFormat := "xml"
 
 resolvers += Resolver.sonatypeCentralSnapshots
-ThisBuild / version := "3.1.0-SNAPSHOT"
-val jacksonVersion = "3.1.0-SNAPSHOT"
+ThisBuild / version := "3.3.0-SNAPSHOT"
+val jacksonVersion = "3.3.0-SNAPSHOT"
 
 autoAPIMappings := true
 
@@ -121,10 +121,9 @@ else
   )
 
 libraryDependencies ++= jacksonDependencies ++ Seq(
-  "org.scala-lang.modules" %% "scala-java8-compat" % "1.0.2" % Test,
   "javax.ws.rs" % "javax.ws.rs-api" % "2.1.1" % Test,
   "io.swagger" % "swagger-core" % "1.6.8" % Test,
-  "org.scalatest" %% "scalatest" % "3.2.19" % Test
+  "org.scalatest" %% "scalatest" % "3.2.20" % Test
 )
 
 // build.properties
@@ -140,7 +139,7 @@ Test / parallelExecution := false
 ThisBuild / githubWorkflowSbtCommand := "sbt -J-Xmx2G"
 ThisBuild / githubWorkflowJavaVersions := Seq(JavaSpec(Zulu, "17"), JavaSpec(Zulu, "21"), JavaSpec(Zulu, "25"))
 ThisBuild / githubWorkflowBuild := Seq(WorkflowStep.Sbt(List("test", "mimaReportBinaryIssues")))
-ThisBuild / githubWorkflowTargetBranches := Seq("3.x", "3.0")
+ThisBuild / githubWorkflowTargetBranches := Seq("3.x", "3.2", "3.1", "3.0")
 ThisBuild / githubWorkflowTargetTags ++= Seq("v*")
 ThisBuild / githubWorkflowPublishTargetBranches :=
   Seq(

project/build.properties

@@ -1 +1 @@
-sbt.version=1.12.1
+sbt.version=1.12.11

project/plugins.sbt

@@ -8,7 +8,7 @@ addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.0")
 
 addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.1.4")
 
-addSbtPlugin("com.github.sbt" % "sbt-github-actions" % "0.29.0")
+addSbtPlugin("com.github.sbt" % "sbt-github-actions" % "0.30.0")
 
 addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.3.1")
 addSbtPlugin("com.github.sbt" % "sbt-git" % "2.1.0")

release-notes/VERSION.md

@@ -1,3 +1,29 @@
+# Version: 2.22.0
+
+This patch release tracks Jackson 2.22. The 2.22 series has full support for
+Scala 2.11, 2.12, 2.13 and 3.3+. Java 8 is the minimum supported Java version.
+There are no new fixes in this release.
+
+# Version: 2.21.4
+
+There are no new fixes in this release; it serves to track the 2.21.4 release
+of the upstream Jackson projects.
+
+# Version: 2.21.3
+
+There are no new fixes in this release; it serves to track the 2.21.3 release
+of the upstream Jackson projects.
+
+# Version: 2.21.2
+
+There are no new fixes in this release; it serves to track the 2.21.2 release
+of the upstream Jackson projects.
+
+# Version: 2.21.1
+
+There are no new fixes in this release; it serves to track the 2.21.1 release
+of the upstream Jackson projects.
+
 # Version: 2.21.0
 
 This patch release tracks Jackson 2.21. The 2.21 series has full support for
@@ -58,6 +84,21 @@ Scala 2.11, 2.12, 2.13 and 3.3+. Java 8 is the minimum supported Java version.
 * [[gh-pr-713]](https://github.com/FasterXML/jackson-module-scala/pull/713) Add ScalaModule.builder() to over another way to customise the Scala module
 * [[gh-722]](https://github.com/FasterXML/jackson-module-scala/issues/722) Collection deserializer should create empty collection instead of null (when input is null)
 
+# Version: 2.18.8
+
+There are no new fixes in this release; it serves to track the 2.18.7 release
+of the upstream Jackson projects.
+
+# Version: 2.18.7
+
+There are no new fixes in this release; it serves to track the 2.18.7 release
+of the upstream Jackson projects.
+
+# Version: 2.18.6
+
+There are no new fixes in this release; it serves to track the 2.18.6 release
+of the upstream Jackson projects.
+
 # Version: 2.18.5
 
 There are no new fixes in this release; it serves to track the 2.18.5 release

release-notes/VERSION3.md

@@ -1,10 +1,36 @@
 Check VERSION.md for jackson-module-scala 2.x release information. This file tracks jackson-module-scala 3.x.
 
-# 3.1.0-rc1
+# 3.2.0
 
-This patch release tracks Jackson 3.1.0-rc1. The 3.1 series has full support for Scala 2.12, 2.13 and 3.
+This patch release tracks Jackson 3.2.0. The 3.2 series has full support for Scala 2.12, 2.13 and 3.
+There are no new fixes in this release.
+
+# 3.1.4
+
+There are no new fixes in this release; it serves to track the 3.1.4 release
+of the upstream Jackson projects.
+
+# 3.1.3
+
+There are no new fixes in this release; it serves to track the 3.1.3 release
+of the upstream Jackson projects.
+
+# 3.1.2
+
+There are no new fixes in this release; it serves to track the 3.1.2 release
+of the upstream Jackson projects.
+
+# 3.1.1
+
+There are no new fixes in this release; it serves to track the 3.1.1 release
+of the upstream Jackson projects.
+
+# 3.1.0
+
+This patch release tracks Jackson 3.1.0. The 3.1 series has full support for Scala 2.12, 2.13 and 3.
 
 * [[gh-787]](https://github.com/FasterXML/jackson-module-scala/issues/787) support JsonInclude filter for Scala collections
+* [[gh-pr-799]](https://github.com/FasterXML/jackson-module-scala/pull/799) Scala 3.8+ requires us to make an underlying field in a Scala 2 Enumeration class accessible
 
 # 3.0.4
 
@@ -31,6 +57,7 @@ of the upstream Jackson projects.
 # 3.0.0
 
 This patch release tracks Jackson 3.0.0. The 3.0 series has full support for Scala 2.12, 2.13 and 3.
+Java 17 is the minimum supported version now (Jackson 3 generally has a minimum requirement of Java 17).
 There are many changes in related Jackson libraries that affect all Jackson users. jackson-module-scala changes
 are less significant. The most notable change is the addition of ScalaModule builder.
 Users who don't use DefaultScalaModule may need to change to using ScalaModule builder.

src/test/scala-2.+/tools/jackson/module/scala/deser/MergeScala2Test.scala

@@ -0,0 +1,49 @@
+package tools.jackson.module.scala.deser
+
+import com.fasterxml.jackson.annotation.JsonMerge
+import tools.jackson.core.`type`.TypeReference
+import tools.jackson.databind.{MapperFeature, ObjectMapper, ObjectReader}
+import tools.jackson.module.scala.DefaultScalaModule
+
+import scala.collection.{Map, mutable}
+
+class MergeScala2Test extends DeserializerTest {
+
+  val module: DefaultScalaModule.type = DefaultScalaModule
+
+  // This test relies on enabling MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS
+  // which is not enabled by default in Jackson v2 but not in Jackson v3
+  def newScalaMapper: ObjectMapper = newBuilder
+    .enable(MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS)
+    .build()
+
+
+  val firstPairMapJson = """{"one":{"first":"1"},"two":{"second":"2"},"three":{"first":"3","second":"4"}}"""
+  val secondPairMapJson = """{"two":{"first":"22"},"three":{"second":"33"}}"""
+  val secondPairMap = Map("two" -> Pair("22", null), "three" -> Pair(null, "33"))
+  val mergedPairMap = Map("one" -> Pair("1", null), "two" -> Pair("22", "2"), "three" -> Pair("3", "33"))
+
+  behavior of "The DefaultScalaModule when reading for updating"
+
+  // started failing in jackson-module-scala v3.2.0 but only for Scala 3
+  // see https://github.com/FasterXML/jackson-module-scala/issues/817
+  it should "merge only the annotated pair map" in {
+    val typeReference = new TypeReference[ClassWithMaps[Pair]]{}
+    val initial = deserialize(classJson(firstPairMapJson), typeReference)
+    val result = updateValue(newScalaMapper, initial, typeReference, classJson(secondPairMapJson))
+
+    result shouldBe ClassWithMaps(secondPairMap, mergedPairMap)
+  }
+
+  def classJson(nestedJson: String) = s"""{"field1":$nestedJson,"field2":$nestedJson}"""
+
+  private def updateValue[T](mapper: ObjectMapper, valueToUpdate: T,
+                             typeReference: TypeReference[T], src: String): T = {
+    objectReaderFor(mapper, valueToUpdate, typeReference).readValue(src)
+  }
+
+  private def objectReaderFor[T](mapper: ObjectMapper, valueToUpdate: T,
+                                 typeReference: TypeReference[T]): ObjectReader = {
+    mapper.readerForUpdating(valueToUpdate).forType(typeReference)
+  }
+}

src/test/scala/tools/jackson/module/scala/deser/CaseObjectDeserializerTest.scala

@@ -8,8 +8,6 @@ import tools.jackson.databind.json.JsonMapper
 import tools.jackson.module.scala.{ClassTagExtensions, DefaultScalaModule}
 import tools.jackson.module.scala.introspect.ScalaAnnotationIntrospectorModule
 
-import scala.compat.java8.FunctionConverters.asJavaUnaryOperator
-
 object CaseObjectDeserializerTest {
   case object TestObject
 
@@ -51,11 +49,11 @@ class CaseObjectDeserializerTest extends DeserializerTest {
 
   it should "deserialize Foo and not create a new instance (visibility settings)" in {
     val mapper = newBuilder
-      .changeDefaultVisibility(asJavaUnaryOperator((a: Any) => {
+      .changeDefaultVisibility(_ => {
         VisibilityChecker.defaultInstance()
           .withFieldVisibility(JsonAutoDetect.Visibility.ANY)
           .withGetterVisibility(JsonAutoDetect.Visibility.NONE)
-      }))
+      })
       .build()
     val original = Foo
     val json = mapper.writeValueAsString(original)

src/test/scala/tools/jackson/module/scala/deser/MergeTest.scala

@@ -17,8 +17,8 @@ class MergeTest extends DeserializerTest {
 
   val module: DefaultScalaModule.type = DefaultScalaModule
 
-  // This test replies on enabling MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS
-  // which is not enabled by default in the Jackson v2 but not in Jackson v3
+  // This test relies on enabling MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS
+  // which is not enabled by default in Jackson v2 but not in Jackson v3
   def newScalaMapper: ObjectMapper = newBuilder
     .enable(MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS)
     .build()
@@ -28,6 +28,21 @@ class MergeTest extends DeserializerTest {
     .defaultMergeable(true)
     .build()
 
+  val firstListJson = """["one","two"]"""
+  val secondListJson = """["three"]"""
+  val secondList = List("three")
+  val mergedList = List("one", "two", "three")
+
+  val firstStringMapJson = """{"one":"1","two":"2"}"""
+  val secondStringMapJson = """{"two":"22","three":"33"}"""
+  val secondStringMap = Map("two" -> "22", "three" -> "33")
+  val mergedStringMap = Map("one" -> "1", "two" -> "22", "three" -> "33")
+
+  val firstPairMapJson = """{"one":{"first":"1"},"two":{"second":"2"},"three":{"first":"3","second":"4"}}"""
+  val secondPairMapJson = """{"two":{"first":"22"},"three":{"second":"33"}}"""
+  val secondPairMap = Map("two" -> Pair("22", null), "three" -> Pair(null, "33"))
+  val mergedPairMap = Map("one" -> Pair("1", null), "two" -> Pair("22", "2"), "three" -> Pair("3", "33"))
+
   behavior of "The DefaultScalaModule when reading for updating"
 
   it should "merge both lists" in {
@@ -69,15 +84,7 @@ class MergeTest extends DeserializerTest {
 
     result shouldBe ClassWithMaps(mergedPairMap, mergedPairMap)
   }
-
-  it should "merge only the annotated pair map" in {
-    val typeReference = new TypeReference[ClassWithMaps[Pair]]{}
-    val initial = deserialize(classJson(firstPairMapJson), typeReference)
-    val result = updateValue(newScalaMapper, initial, typeReference, classJson(secondPairMapJson))
-
-    result shouldBe ClassWithMaps(secondPairMap, mergedPairMap)
-  }
-
+  
   it should "merge both mutable maps" in {
     val typeReference = new TypeReference[ClassWithMutableMaps[String]]{}
     val initial = deserialize(classJson(firstStringMapJson), typeReference)
@@ -94,22 +101,7 @@ class MergeTest extends DeserializerTest {
     result shouldBe ClassWithMutableMaps(mutable.Map() ++ secondStringMap, mutable.Map() ++ mergedStringMap)
   }
 
-  def classJson(nestedJson: String) = s"""{"field1":$nestedJson,"field2":$nestedJson}"""
-
-  val firstListJson = """["one","two"]"""
-  val secondListJson = """["three"]"""
-  val secondList = List("three")
-  val mergedList = List("one", "two", "three")
-
-  val firstStringMapJson = """{"one":"1","two":"2"}"""
-  val secondStringMapJson = """{"two":"22","three":"33"}"""
-  val secondStringMap = Map("two" -> "22", "three" -> "33")
-  val mergedStringMap = Map("one" -> "1", "two" -> "22", "three" -> "33")
-
-  val firstPairMapJson = """{"one":{"first":"1"},"two":{"second":"2"},"three":{"first":"3","second":"4"}}"""
-  val secondPairMapJson = """{"two":{"first":"22"},"three":{"second":"33"}}"""
-  val secondPairMap = Map("two" -> Pair("22", null), "three" -> Pair(null, "33"))
-  val mergedPairMap = Map("one" -> Pair("1", null), "two" -> Pair("22", "2"), "three" -> Pair("3", "33"))
+  private def classJson(nestedJson: String) = s"""{"field1":$nestedJson,"field2":$nestedJson}"""
 
   private def updateValue[T](mapper: ObjectMapper, valueToUpdate: T,
                              typeReference: TypeReference[T], src: String): T = {