Add option to use default case class value during decoding of AvroTransient field (sksamuel#904)

* Add useDefault option to AvroTransient

* Remove gpg steps for PR from fork

Author: minosiants

.github/workflows/pr_scala_3.yml

@@ -28,11 +28,13 @@ jobs:
         run: sbt test
 
       - name: Import GPG key
+        if: github.event.pull_request.head.repo.fork == false
         id: import_gpg
         uses: crazy-max/ghaction-import-gpg@v3
         with:
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.PGP_PASSPHRASE }}
 
       - name: publish local
+        if: github.event.pull_request.head.repo.fork == false
         run: sbt publishLocalSigned

avro4s-core/src/main/scala/com/sksamuel/avro4s/annotations.scala

@@ -68,7 +68,7 @@ trait AvroFixable extends AvroFieldReflection {
   */
 case class AvroName(override val name: String) extends AvroNameable
 
-case class AvroTransient() extends StaticAnnotation
+case class AvroTransient(useDefault:Boolean=false) extends StaticAnnotation
 
 trait AvroNameable extends AvroFieldReflection {
   val name: String

avro4s-core/src/main/scala/com/sksamuel/avro4s/decoders/records.scala

@@ -16,7 +16,10 @@ class RecordDecoder[T](ctx: magnolia1.CaseClass[Decoder, T]) extends Decoder[T]
     val decoders: Array[FieldDecoder[T]] = ctx.params
       .map { param =>
         val annos = Annotations(param.annotations)
-        if (annos.transient) TransientFieldDecoder else new SchemaFieldDecoder(param, schema)
+        annos.transient match {
+          case Some(useDefault) => TransientFieldDecoder(useDefault, param)
+          case None => new SchemaFieldDecoder(param, schema)
+        }
       }.toArray
     { t => decodeT(schema, decoders, t) }
   }
@@ -48,8 +51,13 @@ trait FieldDecoder[+T] extends Serializable {
 /**
   * Fields marked with @AvroTransient are always decoded as None's.
   */
-object TransientFieldDecoder extends FieldDecoder[Nothing] {
-  override def decode(record: IndexedRecord): Any = None
+case class TransientFieldDecoder[T](useDefault:Boolean, param: magnolia1.CaseClass.Param[Decoder, T]) extends FieldDecoder[Nothing] {
+  override def decode(record: IndexedRecord): Any = {
+    if(useDefault)
+      param.default.get
+    else 
+     None  
+  }
 }
 
 /**

avro4s-core/src/main/scala/com/sksamuel/avro4s/schemas/records.scala

@@ -24,7 +24,7 @@ object Records:
 
     val fields = ctx.params.toList.flatMap { param =>
       val fieldAnnos = Annotations(param.annotations)
-      if (fieldAnnos.transient) None
+      if (fieldAnnos.transient.isDefined) None
       else {
         val doc = fieldAnnos.doc //.orElse(valueTypeDoc).orNull
         //        val doc = valueTypeDoc(ctx, param)

avro4s-core/src/main/scala/com/sksamuel/avro4s/typeutils/Annotations.scala

@@ -27,10 +27,10 @@ class Annotations(annos: Seq[Any], inheritedAnnos: Seq[Any] = Nil) {
     case t: AvroDocumentable => t.doc
   }
 
-  def transient: Boolean = annos.collectFirst {
-    case t: AvroTransient => t
-  }.isDefined
-
+  def transient: Option[Boolean] = annos.collectFirst {
+    case t: AvroTransient => t.useDefault
+  }
+  
   def erased: Boolean = annos.collectFirst {
     case t: AvroErasedName => t
   }.isDefined

avro4s-core/src/test/scala/com/sksamuel/avro4s/record/decoder/TransientDecoderTest.scala

@@ -16,4 +16,14 @@ class TransientDecoderTest extends AnyFunSuite with Matchers {
     record.put("a", new Utf8("hello"))
     Decoder[TransientFoo].decode(schema).apply(record) shouldBe TransientFoo("hello", None)
   }
+
+  case class Foo(name:String)
+  case class TransientFooWithDefault(a: String, @AvroTransient(true) b: Foo = Foo("hello"))
+
+  test("decoder should populate transient fields with default case class value") {
+    val schema = AvroSchema[TransientFooWithDefault]
+    val record = new GenericData.Record(schema)
+    record.put("a", new Utf8("hello"))
+    Decoder[TransientFooWithDefault].decode(schema).apply(record) shouldBe TransientFooWithDefault("hello")
+  }
 }