Cleanup tests for union types having null value + fix backward binary compatibility

Author: plokhotnyuk

jsoniter-scala-macros/shared/src/main/scala-3/com/github/plokhotnyuk/jsoniter_scala/macros/JsonCodecMaker.scala

@@ -56,8 +56,6 @@ final class stringified extends StaticAnnotation
   *                               arrays or collections (turned on by default)
   * @param transientNone          a flag that turns on skipping serialization of fields that have empty values of
   *                               options (turned on by default)
-  * @param transientNull          a flag that turns on skipping serialization of fields that have null values of
-  *                               objects (turned off by default)
   * @param requireCollectionFields a flag that turn on checking of presence of collection fields and forces
   *                               serialization when they are empty
   * @param bigDecimalPrecision    a precision in 'BigDecimal' values (34 by default that is a precision for decimal128,
@@ -103,6 +101,8 @@ final class stringified extends StaticAnnotation
   *                               when the codec derived is for an ADT leaf class and not the ADT base class. Note that
   *                               this flag has no effect on generated decoders -- that is this flag does NOT cause
   *                               decoders to start requiring the discriminator field when they are not strictly necessary
+  * @param transientNull          a flag that turns on skipping serialization of fields that have null values of
+  *                               objects (turned off by default)
   */
 class CodecMakerConfig private[macros] (
     val fieldNameMapper: NameMapper,
@@ -115,7 +115,6 @@ class CodecMakerConfig private[macros] (
     val transientDefault: Boolean,
     val transientEmpty: Boolean,
     val transientNone: Boolean,
-    val transientNull: Boolean,
     val requireCollectionFields: Boolean,
     val bigDecimalPrecision: Int,
     val bigDecimalScaleLimit: Int,
@@ -135,7 +134,8 @@ class CodecMakerConfig private[macros] (
     val checkFieldDuplication: Boolean,
     val scalaTransientSupport: Boolean,
     val inlineOneValueClasses: Boolean,
-    val alwaysEmitDiscriminator: Boolean) {
+    val alwaysEmitDiscriminator: Boolean,
+    val transientNull: Boolean) {
   def withFieldNameMapper(fieldNameMapper: PartialFunction[String, String]): CodecMakerConfig =
     copy(fieldNameMapper = fieldNameMapper)
 
@@ -164,8 +164,6 @@ class CodecMakerConfig private[macros] (
 
   def withTransientNone(transientNone: Boolean): CodecMakerConfig = copy(transientNone = transientNone)
 
-  def withTransientNull(transientNull: Boolean): CodecMakerConfig = copy(transientNull = transientNull)
-
   def withRequireCollectionFields(requireCollectionFields: Boolean): CodecMakerConfig =
     copy(requireCollectionFields = requireCollectionFields)
 
@@ -219,6 +217,8 @@ class CodecMakerConfig private[macros] (
   def withInlineOneValueClasses(inlineOneValueClasses: Boolean): CodecMakerConfig =
     copy(inlineOneValueClasses = inlineOneValueClasses)
 
+  def withTransientNull(transientNull: Boolean): CodecMakerConfig = copy(transientNull = transientNull)
+
   private[this] def copy(fieldNameMapper: NameMapper = fieldNameMapper,
                          javaEnumValueNameMapper: NameMapper = javaEnumValueNameMapper,
                          adtLeafClassNameMapper: NameMapper = adtLeafClassNameMapper,
@@ -229,7 +229,6 @@ class CodecMakerConfig private[macros] (
                          transientDefault: Boolean = transientDefault,
                          transientEmpty: Boolean = transientEmpty,
                          transientNone: Boolean = transientNone,
-                         transientNull: Boolean = transientNull,
                          requireCollectionFields: Boolean = requireCollectionFields,
                          bigDecimalPrecision: Int = bigDecimalPrecision,
                          bigDecimalScaleLimit: Int = bigDecimalScaleLimit,
@@ -249,7 +248,8 @@ class CodecMakerConfig private[macros] (
                          checkFieldDuplication: Boolean = checkFieldDuplication,
                          scalaTransientSupport: Boolean = scalaTransientSupport,
                          inlineOneValueClasses: Boolean = inlineOneValueClasses,
-                         alwaysEmitDiscriminator: Boolean = alwaysEmitDiscriminator): CodecMakerConfig =
+                         alwaysEmitDiscriminator: Boolean = alwaysEmitDiscriminator,
+                         transientNull: Boolean = transientNull): CodecMakerConfig =
     new CodecMakerConfig(
       fieldNameMapper = fieldNameMapper,
       javaEnumValueNameMapper = javaEnumValueNameMapper,
@@ -261,7 +261,6 @@ class CodecMakerConfig private[macros] (
       transientDefault = transientDefault,
       transientEmpty = transientEmpty,
       transientNone = transientNone,
-      transientNull = transientNull,
       requireCollectionFields = requireCollectionFields,
       bigDecimalPrecision = bigDecimalPrecision,
       bigDecimalScaleLimit = bigDecimalScaleLimit,
@@ -281,7 +280,8 @@ class CodecMakerConfig private[macros] (
       checkFieldDuplication = checkFieldDuplication,
       scalaTransientSupport = scalaTransientSupport,
       inlineOneValueClasses = inlineOneValueClasses,
-      alwaysEmitDiscriminator = alwaysEmitDiscriminator)
+      alwaysEmitDiscriminator = alwaysEmitDiscriminator,
+      transientNull = transientNull)
 }
 
 object CodecMakerConfig extends CodecMakerConfig(
@@ -295,7 +295,6 @@ object CodecMakerConfig extends CodecMakerConfig(
   transientDefault = true,
   transientEmpty = true,
   transientNone = true,
-  transientNull = false,
   requireCollectionFields = false,
   bigDecimalPrecision = 34,
   bigDecimalScaleLimit = 6178,
@@ -315,7 +314,8 @@ object CodecMakerConfig extends CodecMakerConfig(
   checkFieldDuplication = true,
   scalaTransientSupport = false,
   inlineOneValueClasses = false,
-  alwaysEmitDiscriminator = false) {
+  alwaysEmitDiscriminator = false,
+  transientNull = false) {
 
   /**
     * Use to enable printing of codec during compilation:
@@ -348,7 +348,6 @@ object CodecMakerConfig extends CodecMakerConfig(
         case '{ ($x: CodecMakerConfig).withTransientDefault($v) } => Some(x.valueOrAbort.withTransientDefault(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withTransientEmpty($v) } => Some(x.valueOrAbort.withTransientEmpty(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withTransientNone($v) } => Some(x.valueOrAbort.withTransientNone(v.valueOrAbort))
-        case '{ ($x: CodecMakerConfig).withTransientNull($v) } => Some(x.valueOrAbort.withTransientNull(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withRequireCollectionFields($v) } => Some(x.valueOrAbort.withRequireCollectionFields(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withRequireDefaultFields($v) } => Some(x.valueOrAbort.withRequireDefaultFields(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withScalaTransientSupport($v) } => Some(x.valueOrAbort.withScalaTransientSupport(v.valueOrAbort))
@@ -363,6 +362,7 @@ object CodecMakerConfig extends CodecMakerConfig(
         case '{ ($x: CodecMakerConfig).withSetMaxInsertNumber($v) } => Some(x.valueOrAbort.withSetMaxInsertNumber(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withSkipNestedOptionValues($v) } => Some(x.valueOrAbort.withSkipNestedOptionValues(v.valueOrAbort))
         case '{ ($x: CodecMakerConfig).withCirceLikeObjectEncoding($v) } => Some(x.valueOrAbort.withCirceLikeObjectEncoding(v.valueOrAbort))
+        case '{ ($x: CodecMakerConfig).withTransientNull($v) } => Some(x.valueOrAbort.withTransientNull(v.valueOrAbort))
         case other =>
           report.error(s"Can't interpret ${other.show} as a constant expression, tree=$other")
           None

jsoniter-scala-macros/shared/src/test/scala-3/com/github/plokhotnyuk/jsoniter_scala/macros/JsonCodecMakerNewTypeSpec.scala

@@ -30,6 +30,29 @@ case class IArrays(aa: IArray[IArray[Int]], a: IArray[BigInt])
 
 case class IArrayDefaults(aa: IArray[IArray[Int]] = IArray(IArray[Int](1)), a: IArray[BigInt] = IArray[BigInt](2))
 
+case class NullableProperty(a: Int | Null | String)
+
+given nullableValueCodec: JsonValueCodec[Int | Null | String] = new JsonValueCodec[Int | Null | String] {
+  def decodeValue(in: JsonReader, default: Int | Null | String): Int | Null | String = {
+    val t = in.nextToken()
+    if (t != 'n') {
+      in.rollbackToken()
+      if (t == '"') in.readString(null)
+      else in.readInt()
+    } else {
+      in.readNullOrError("", "expected 'Int | Null | String'")
+      null
+    }
+  }
+
+  def encodeValue(x: Int | Null | String, out: JsonWriter): Unit =
+    if (x == null) out.writeNull()
+    else if (x.isInstanceOf[String]) out.writeVal(x.asInstanceOf[String])
+    else out.writeVal(x.asInstanceOf[Int])
+
+  def nullValue: Int | Null | String = null
+}
+
 class JsonCodecMakerNewTypeSpec extends VerifyingSpec {
   val codecOfIArrays = make[IArrays]
 
@@ -287,6 +310,16 @@ class JsonCodecMakerNewTypeSpec extends VerifyingSpec {
       verifySerDeser(jsonCodec, arr("VVV", 1.2, true, obj("WWW" -> None, "XXX" -> 777)),
         """["VVV",1.2,true,{"WWW":null,"XXX":777}]""")
     }
+    "serialize and deserialize case class with union types having null value (default behavior)" in {
+      verifySerDeser(make[List[NullableProperty]],
+        List(NullableProperty(null), NullableProperty(1), NullableProperty("VVV")),
+        """[{"a":null},{"a":1},{"a":"VVV"}]""")
+    }
+    "serialize and deserialize case class with union types having null value (transient null behavior)" in {
+      verifySerDeser(make[List[NullableProperty]](CodecMakerConfig.withTransientNull(true)),
+        List(NullableProperty(null), NullableProperty(1), NullableProperty("VVV")),
+        """[{},{"a":1},{"a":"VVV"}]""")
+    }
     "don't generate codecs for non-concrete ADTs with at least one free type parameter" in {
       assert(intercept[TestFailedException](assertCompiles {
         """sealed trait TypeBase[T]

jsoniter-scala-macros/shared/src/test/scala-3/com/github/plokhotnyuk/jsoniter_scala/macros/JsonCodecMakerNullableSpec.scala

@@ -1 +1 @@
-ThisBuild / version := "2.36.9-SNAPSHOT"
+ThisBuild / version := "2.37.0-SNAPSHOT"