Add support for distinguishing explicit and implicit null in ArgBuild…

…ers (#929) * Add support for distinguishing explicit and implicit null in ArgBuilders * Add scaladoc * Add tests * Fix lint issues * Make Scala 3 happy * Fix more lint issues * Move test * Remove left over imports
ghostdogpr · Jun 17, 2021 · 6ac0b94 · 6ac0b94
1 parent ec6d0bd
commit 6ac0b94
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 11 deletions.
diff --git a/core/src/main/scala-2/caliban/schema/ArgBuilderDerivation.scala b/core/src/main/scala-2/caliban/schema/ArgBuilderDerivation.scala
@@ -31,7 +31,7 @@ trait ArgBuilderDerivation {
         input match {
           case InputValue.ObjectValue(fields) =>
             val label = p.annotations.collectFirst { case GQLName(name) => name }.getOrElse(p.label)
-            p.typeclass.build(fields.getOrElse(label, NullValue))
+            fields.get(label).fold(p.typeclass.buildMissing)(p.typeclass.build)
           case value                          => p.typeclass.build(value)
         }
       }

diff --git a/core/src/main/scala-3/caliban/schema/ArgBuilderDerivation.scala b/core/src/main/scala-3/caliban/schema/ArgBuilderDerivation.scala
@@ -51,14 +51,12 @@ trait ArgBuilderDerivation {
         new ArgBuilder[A] {
           def build(input: InputValue): Either[ExecutionError, A] = {
             fields.map { (label, _, builder) =>
-              val newInput =
-                input match {
-                  case InputValue.ObjectValue(fields) =>
-                    val finalLabel = annotations.getOrElse(label, Nil).collectFirst { case GQLName(name) => name }.getOrElse(label)
-                    fields.getOrElse(finalLabel, NullValue)
-                  case value => value
-                }
-              builder.build(newInput)
+              input match {
+                case InputValue.ObjectValue(fields) =>
+                  val finalLabel = annotations.getOrElse(label, Nil).collectFirst { case GQLName(name) => name }.getOrElse(label)
+                  fields.get(finalLabel).fold(builder.buildMissing)(builder.build)
+                case value => builder.build(value)
+              }
             }.foldRight[Either[ExecutionError, Tuple]](Right(EmptyTuple)) { case (item, acc) =>
               item match {
                 case error: Left[ExecutionError, Any] => error.asInstanceOf[Left[ExecutionError, Tuple]]

diff --git a/core/src/main/scala/caliban/schema/ArgBuilder.scala b/core/src/main/scala/caliban/schema/ArgBuilder.scala
@@ -33,6 +33,13 @@ trait ArgBuilder[T] { self =>
    */
   def build(input: InputValue): Either[ExecutionError, T]
 
+  /**
+   * Builds a value of type `T` from a missing input value.
+   * By default, this delegates to [[build]], passing it NullValue.
+   * Fails with an [[caliban.CalibanError.ExecutionError]] if it was impossible to build the value.
+   */
+  def buildMissing: Either[ExecutionError, T] = build(NullValue)
+
   /**
    * Builds a new `ArgBuilder` of `A` from an existing `ArgBuilder` of `T` and a function from `T` to `A`.
    * @param f a function from `T` to `A`.

diff --git a/core/src/test/scala/caliban/schema/ArgBuilderSpec.scala b/core/src/test/scala/caliban/schema/ArgBuilderSpec.scala
@@ -1,10 +1,12 @@
 package caliban.schema
 
 import java.time.{ Instant, LocalDate, LocalDateTime, OffsetDateTime, OffsetTime, ZoneOffset, ZonedDateTime }
-
-import caliban.Value.{ IntValue, StringValue }
+import caliban.Value.{ IntValue, NullValue, StringValue }
 import zio.test._
 import Assertion._
+import caliban.CalibanError.ExecutionError
+import caliban.InputValue
+import caliban.InputValue.ObjectValue
 
 object ArgBuilderSpec extends DefaultRunnableSpec {
   def spec = suite("ArgBuilder")(
@@ -56,6 +58,32 @@ object ArgBuilderSpec extends DefaultRunnableSpec {
           isRight(equalTo(ZonedDateTime.ofInstant(Instant.ofEpochMilli(100), ZoneOffset.UTC)))
         )
       )
+    ),
+    suite("buildMissing")(
+      test("works with derived case class ArgBuilders") {
+        sealed abstract class Nullable[+T]
+        case class SomeNullable[+T](t: T) extends Nullable[T]
+        case object NullNullable          extends Nullable[Nothing]
+        case object MissingNullable       extends Nullable[Nothing]
+
+        implicit def nullableArgBuilder[A](implicit ev: ArgBuilder[A]): ArgBuilder[Nullable[A]] =
+          new ArgBuilder[Nullable[A]] {
+            def build(input: InputValue): Either[ExecutionError, Nullable[A]] = input match {
+              case NullValue => Right(NullNullable)
+              case _         => ev.build(input).map(SomeNullable(_))
+            }
+
+            override def buildMissing: Either[ExecutionError, Nullable[A]] = Right(MissingNullable)
+          }
+
+        case class Wrapper(a: Nullable[String])
+
+        val deriviedAB = implicitly[ArgBuilder[Wrapper]]
+
+        assert(deriviedAB.build(ObjectValue(Map())))(equalTo(Right(Wrapper(MissingNullable)))) &&
+        assert(deriviedAB.build(ObjectValue(Map("a" -> NullValue))))(equalTo(Right(Wrapper(NullNullable)))) &&
+        assert(deriviedAB.build(ObjectValue(Map("a" -> StringValue("x")))))(equalTo(Right(Wrapper(SomeNullable("x")))))
+      }
     )
   )
 }