Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[scala3] Add test for serializable generated type-class #499

Merged
merged 4 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions core/src/main/scala/magnolia1/impl.scala
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ import scala.reflect.*

import Macro.*

// scala3 lambda generated during derivation reference outer scope
// This fails the typeclass serialization if the outer scope is not serializable
// workaround with this with a serializable fuction
private trait SerializableFunction0[+R] extends Function0[R] with Serializable:
def apply(): R
private trait SerializableFunction1[-T1, +R] extends Function1[T1, R] with Serializable:
def apply(v1: T1): R

object CaseClassDerivation:
inline def fromMirror[Typeclass[_], A](
product: Mirror.ProductOf[A]
Expand Down Expand Up @@ -97,12 +105,17 @@ object CaseClassDerivation:
case _: (EmptyTuple, EmptyTuple) =>
Nil
case _: ((l *: ltail), (p *: ptail)) =>
def unsafeCast(any: Any) = Option.when(any == null || (any: @unchecked).isInstanceOf[p])(any.asInstanceOf[p])
val label = constValue[l].asInstanceOf[String]
val tc = new SerializableFunction0[Typeclass[p]]:
override def apply(): Typeclass[p] = summonInline[Typeclass[p]]

val d = new SerializableFunction0[Option[p]]:
private def unsafeCast(any: Any) = Option.when(any == null || (any: @unchecked).isInstanceOf[p])(any.asInstanceOf[p])
override def apply(): Option[p] = defaults.get(label).flatten.flatMap(d => unsafeCast(d.apply))
paramFromMaps[Typeclass, A, p](
label,
CallByNeed(summonInline[Typeclass[p]]),
CallByNeed.withValueEvaluator(defaults.get(label).flatten.flatMap(d => unsafeCast(d.apply))),
new CallByNeed(tc),
new CallByNeed(d, () => true),
RustedBones marked this conversation as resolved.
Show resolved Hide resolved
repeated,
annotations,
inheritedAnnotations,
Expand Down Expand Up @@ -172,7 +185,16 @@ trait SealedTraitDerivation:
mm.asInstanceOf[m.type],
0
)
case _ =>
case _ => {
val tc = new SerializableFunction0[Typeclass[s]]:
override def apply(): Typeclass[s] = summonFrom {
case tc: Typeclass[`s`] => tc
case _ => deriveSubtype(summonInline[Mirror.Of[s]])
}
val isType = new SerializableFunction1[A, Boolean]:
override def apply(a: A): Boolean = a.isInstanceOf[s & A]
val asType = new SerializableFunction1[A, s & A]:
override def apply(a: A): s & A = a.asInstanceOf[s & A]
List(
new SealedTrait.Subtype[Typeclass, A, s](
typeInfo[s],
Expand All @@ -181,14 +203,12 @@ trait SealedTraitDerivation:
IArray.from(paramTypeAnns[A]),
isObject[s],
idx,
CallByNeed(summonFrom {
case tc: Typeclass[`s`] => tc
case _ => deriveSubtype(summonInline[Mirror.Of[s]])
}),
x => x.isInstanceOf[s & A],
_.asInstanceOf[s & A]
new CallByNeed(tc),
isType,
asType
)
)
}
}
(sub ::: subtypesFromMirror[A, tail](m, idx + 1)).distinctBy(_.typeInfo).sortBy(_.typeInfo.full)
end SealedTraitDerivation
3 changes: 1 addition & 2 deletions core/src/main/scala/magnolia1/interface.scala
Original file line number Diff line number Diff line change
Expand Up @@ -373,8 +373,7 @@ end CallByNeed

// Both params are later nullified to reduce overhead and increase performance.
// The supportDynamicValueEvaluation is passed as a function so that it can be nullified. Otherwise, there is no need for the function value.
final class CallByNeed[+A] private (private[this] var eval: () => A, private var supportDynamicValueEvaluation: () => Boolean)
extends Serializable {
final class CallByNeed[+A](private[this] var eval: () => A, private var supportDynamicValueEvaluation: () => Boolean) extends Serializable {

// This second constructor is necessary to support backwards compatibility for v1.3.6 and earlier
def this(eval: () => A) = this(eval, () => false)
Expand Down
2 changes: 1 addition & 1 deletion examples/src/main/scala/magnolia1/examples/show.scala
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import magnolia1._
*
* Note that this is a more general form of `Show` than is usual, as it permits the return type to be something other than a string.
*/
trait Show[Out, T] { def show(value: T): Out }
trait Show[Out, T] extends Serializable { def show(value: T): Out }

trait GenericShow[Out] extends AutoDerivation[[X] =>> Show[Out, X]] {

Expand Down
42 changes: 42 additions & 0 deletions test/src/test/scalajvm/magnolia1/tests/SerializationTests.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package magnolia1.tests

import magnolia1.*
import magnolia1.examples.*

import java.io.*
class SerializationTests extends munit.FunSuite:
import SerializationTests.*

private def serializeToByteArray(value: Serializable): Array[Byte] =
val buffer = new ByteArrayOutputStream()
val oos = new ObjectOutputStream(buffer)
oos.writeObject(value)
buffer.toByteArray

private def deserializeFromByteArray(encodedValue: Array[Byte]): AnyRef =
val ois = new ObjectInputStream(new ByteArrayInputStream(encodedValue))
ois.readObject()

def ensureSerializable[T <: Serializable](value: T): T =
deserializeFromByteArray(serializeToByteArray(value)).asInstanceOf[T]

test("generate serializable type-classes") {
ensureSerializable(new Outer().showAddress)
ensureSerializable(new Outer().showColor)
}

object SerializationTests:
sealed trait Entity
case class Company(name: String) extends Entity
case class Person(name: String, age: Int) extends Entity
case class Address(line1: String, occupant: Person)

sealed trait Color
case object Red extends Color
case object Green extends Color
case object Blue extends Color
case object Orange extends Color
case object Pink extends Color
class Outer:
val showAddress: Show[String, Address] = summon[Show[String, Address]]
val showColor: Show[String, Color] = summon[Show[String, Color]]
Loading