diff --git a/README.md b/README.md
index b286f2450b..9b9ff86c88 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,8 @@ The design principles behind the library are the following:
- clean separation between schema definition and implementation: schema is defined and validated at compile time using Scala standard types, resolver (`RootResolver`) is a simple value provided at runtime.
- minimal amount of boilerplate: no need to manually define a schema for every type in your API.
+Caliban can also be used to build GraphQL frontends thanks to a type-safe and functional DSL.
+
### Consult the [Documentation](https://ghostdogpr.github.io/caliban/docs/) to learn how to use Caliban.
### Any questions? Head up to the [#caliban](https://discordapp.com/channels/629491597070827530/633200096393166868) channel on [ZIO Discord](https://discord.gg/EYpumuv).
diff --git a/build.sbt b/build.sbt
index 927a024441..e8480a92de 100644
--- a/build.sbt
+++ b/build.sbt
@@ -1,9 +1,13 @@
import sbtcrossproject.CrossPlugin.autoImport.{ crossProject, CrossType }
-val mainScala = "2.12.10"
-val allScala = Seq("2.13.1", mainScala)
+val mainScala = "2.12.10"
+val allScala = Seq("2.13.1", mainScala)
+
val http4sVersion = "0.21.1"
val silencerVersion = "1.6.0"
+val sttpVersion = "2.0.1"
+val zioVersion = "1.0.0-RC17"
+
inThisBuild(
List(
organization := "com.github.ghostdogpr",
@@ -71,10 +75,10 @@ lazy val core = crossProject(JSPlatform, JVMPlatform)
"com.lihaoyi" %%% "fastparse" % "2.2.4",
"com.propensive" %%% "magnolia" % "0.12.7",
"com.propensive" %%% "mercator" % "0.2.1",
- "dev.zio" %%% "zio" % "1.0.0-RC17",
- "dev.zio" %%% "zio-streams" % "1.0.0-RC17",
- "dev.zio" %%% "zio-test" % "1.0.0-RC17" % "test",
- "dev.zio" %%% "zio-test-sbt" % "1.0.0-RC17" % "test",
+ "dev.zio" %%% "zio" % zioVersion,
+ "dev.zio" %%% "zio-streams" % zioVersion,
+ "dev.zio" %%% "zio-test" % zioVersion % "test",
+ "dev.zio" %%% "zio-test-sbt" % zioVersion % "test",
"io.circe" %%% "circe-derivation" % "0.12.0-M7" % Optional,
compilerPlugin("com.olegpy" %% "better-monadic-for" % "0.3.1")
)
@@ -98,8 +102,8 @@ lazy val codegen = project
libraryDependencies ++= Seq(
"org.scalameta" %% "scalafmt-dynamic" % "2.4.2",
"org.scalameta" %% "scalafmt-core" % "2.4.2",
- "dev.zio" %% "zio-test" % "1.0.0-RC17" % "test",
- "dev.zio" %% "zio-test-sbt" % "1.0.0-RC17" % "test"
+ "dev.zio" %% "zio-test" % zioVersion % "test",
+ "dev.zio" %% "zio-test-sbt" % zioVersion % "test"
)
)
.dependsOn(coreJVM)
@@ -196,10 +200,10 @@ lazy val client = crossProject(JSPlatform, JVMPlatform)
testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework")),
libraryDependencies ++= Seq(
"io.circe" %%% "circe-derivation" % "0.12.0-M7",
- "com.softwaremill.sttp.client" %%% "core" % "2.0.0",
- "com.softwaremill.sttp.client" %%% "circe" % "2.0.0",
- "dev.zio" %%% "zio-test" % "1.0.0-RC17" % "test",
- "dev.zio" %%% "zio-test-sbt" % "1.0.0-RC17" % "test"
+ "com.softwaremill.sttp.client" %%% "core" % sttpVersion,
+ "com.softwaremill.sttp.client" %%% "circe" % sttpVersion,
+ "dev.zio" %%% "zio-test" % zioVersion % "test",
+ "dev.zio" %%% "zio-test-sbt" % zioVersion % "test"
)
)
lazy val clientJVM = client.jvm
@@ -211,7 +215,7 @@ lazy val examples = project
.settings(skip in publish := true)
.settings(
libraryDependencies ++= Seq(
- "com.softwaremill.sttp.client" %% "async-http-client-backend-zio" % "2.0.0"
+ "com.softwaremill.sttp.client" %% "async-http-client-backend-zio" % sttpVersion
)
)
.dependsOn(akkaHttp, http4s, catsInteropJVM, finch, monixInterop, clientJVM)
diff --git a/codegen/src/test/scala/caliban/codegen/ClientWriterSpec.scala b/codegen/src/test/scala/caliban/codegen/ClientWriterSpec.scala
index a55e94cd66..ccb70c56e3 100644
--- a/codegen/src/test/scala/caliban/codegen/ClientWriterSpec.scala
+++ b/codegen/src/test/scala/caliban/codegen/ClientWriterSpec.scala
@@ -3,7 +3,7 @@ package caliban.codegen
import caliban.parsing.Parser
import zio.Task
import zio.test.Assertion._
-import zio.test.{ assertM, suite, testM, DefaultRunnableSpec }
+import zio.test.{ assertM, suite, testM, DefaultRunnableSpec, TestAspect }
object ClientWriterSpec
extends DefaultRunnableSpec(
@@ -361,6 +361,6 @@ object Client {
)
)
}
- )
+ ) @@ TestAspect.sequential
}
)
diff --git a/codegen/src/test/scala/caliban/codegen/SchemaWriterSpec.scala b/codegen/src/test/scala/caliban/codegen/SchemaWriterSpec.scala
index a5800d3f6b..4913fadbb4 100644
--- a/codegen/src/test/scala/caliban/codegen/SchemaWriterSpec.scala
+++ b/codegen/src/test/scala/caliban/codegen/SchemaWriterSpec.scala
@@ -4,7 +4,7 @@ import caliban.parsing.Parser
import caliban.parsing.adt.Document
import zio.Task
import zio.test.Assertion.equalTo
-import zio.test.{ assertM, suite, testM, DefaultRunnableSpec }
+import zio.test.{ assertM, suite, testM, DefaultRunnableSpec, TestAspect }
object SchemaWriterSpec
extends DefaultRunnableSpec({
@@ -307,5 +307,5 @@ object Types {
)
)
}
- )
+ ) @@ TestAspect.sequential
})
diff --git a/core/src/main/scala/caliban/validation/Validator.scala b/core/src/main/scala/caliban/validation/Validator.scala
index a87daa4626..238e06cd60 100644
--- a/core/src/main/scala/caliban/validation/Validator.scala
+++ b/core/src/main/scala/caliban/validation/Validator.scala
@@ -31,14 +31,18 @@ object Validator {
def validateSchema(rootType: RootType): IO[ValidationError, Unit] =
IO.foreach(rootType.types.values) { t =>
t.kind match {
- case __TypeKind.ENUM => validateEnum(t)
- case __TypeKind.UNION => validateUnion(t)
- case __TypeKind.INTERFACE => validateInterface(t)
- case _ => IO.unit
+ case __TypeKind.ENUM => validateEnum(t)
+ case __TypeKind.UNION => validateUnion(t)
+ case __TypeKind.INTERFACE => validateInterface(t)
+ case __TypeKind.INPUT_OBJECT => validateInputObject(t)
+ case _ => IO.unit
}
}
.unit
+ def failValidation[T](msg: String, explanatoryText: String): IO[ValidationError, T] =
+ IO.fail(ValidationError(msg, explanatoryText))
+
/**
* Prepare the request for execution.
* Fails with a [[caliban.CalibanError.ValidationError]] otherwise.
@@ -70,19 +74,19 @@ object Validator {
}
operation match {
- case Left(error) => IO.fail(ValidationError(error, ""))
+ case Left(error) => failValidation(error, "")
case Right(op) =>
(op.operationType match {
case Query => IO.succeed(rootSchema.query)
case Mutation =>
rootSchema.mutation match {
case Some(m) => IO.succeed(m)
- case None => IO.fail(ValidationError("Mutations are not supported on this schema", ""))
+ case None => failValidation("Mutations are not supported on this schema", "")
}
case Subscription =>
rootSchema.subscription match {
case Some(m) => IO.succeed(m)
- case None => IO.fail(ValidationError("Subscriptions are not supported on this schema", ""))
+ case None => failValidation("Subscriptions are not supported on this schema", "")
}
}).map(operation =>
ExecutionRequest(
@@ -183,11 +187,9 @@ object Validator {
private def checkDirectivesUniqueness(directives: List[Directive]): IO[ValidationError, Unit] =
IO.whenCase(directives.groupBy(_.name).find { case (_, v) => v.length > 1 }) {
case Some((name, _)) =>
- IO.fail(
- ValidationError(
- s"Directive '$name' is defined twice.",
- "Directives are used to describe some metadata or behavioral change on the definition they apply to. When more than one directive of the same name is used, the expected metadata or behavior becomes ambiguous, therefore only one of each directive is allowed per location."
- )
+ failValidation(
+ s"Directive '$name' is defined twice.",
+ "Directives are used to describe some metadata or behavioral change on the definition they apply to. When more than one directive of the same name is used, the expected metadata or behavior becomes ambiguous, therefore only one of each directive is allowed per location."
)
}
@@ -198,19 +200,15 @@ object Validator {
case (d, location) =>
Introspector.directives.find(_.name == d.name) match {
case None =>
- IO.fail(
- ValidationError(
- s"Directive '${d.name}' is not supported.",
- "GraphQL servers define what directives they support. For each usage of a directive, the directive must be available on that server."
- )
+ failValidation(
+ s"Directive '${d.name}' is not supported.",
+ "GraphQL servers define what directives they support. For each usage of a directive, the directive must be available on that server."
)
case Some(directive) =>
IO.when(!directive.locations.contains(location))(
- IO.fail(
- ValidationError(
- s"Directive '${d.name}' is used in invalid location '$location'.",
- "GraphQL servers define what directives they support and where they support them. For each usage of a directive, the directive must be used in a location that the server has declared support for."
- )
+ failValidation(
+ s"Directive '${d.name}' is used in invalid location '$location'.",
+ "GraphQL servers define what directives they support and where they support them. For each usage of a directive, the directive must be used in a location that the server has declared support for."
)
)
}
@@ -222,42 +220,34 @@ object Validator {
IO.foreach(op.variableDefinitions.groupBy(_.name)) {
case (name, variables) =>
IO.when(variables.length > 1)(
- IO.fail(
- ValidationError(
- s"Variable '$name' is defined more than once.",
- "If any operation defines more than one variable with the same name, it is ambiguous and invalid. It is invalid even if the type of the duplicate variable is the same."
- )
+ failValidation(
+ s"Variable '$name' is defined more than once.",
+ "If any operation defines more than one variable with the same name, it is ambiguous and invalid. It is invalid even if the type of the duplicate variable is the same."
)
)
} *> IO.foreach(op.variableDefinitions) { v =>
val t = Type.innerType(v.variableType)
IO.whenCase(context.rootType.types.get(t).map(_.kind)) {
case Some(__TypeKind.OBJECT) | Some(__TypeKind.UNION) | Some(__TypeKind.INTERFACE) =>
- IO.fail(
- ValidationError(
- s"Type of variable '${v.name}' is not a valid input type.",
- "Variables can only be input types. Objects, unions, and interfaces cannot be used as inputs."
- )
+ failValidation(
+ s"Type of variable '${v.name}' is not a valid input type.",
+ "Variables can only be input types. Objects, unions, and interfaces cannot be used as inputs."
)
}
} *> {
val variableUsages = collectVariablesUsed(context, op.selectionSet)
IO.foreach(variableUsages)(v =>
IO.when(!op.variableDefinitions.exists(_.name == v))(
- IO.fail(
- ValidationError(
- s"Variable '$v' is not defined.",
- "Variables are scoped on a per‐operation basis. That means that any variable used within the context of an operation must be defined at the top level of that operation"
- )
+ failValidation(
+ s"Variable '$v' is not defined.",
+ "Variables are scoped on a per‐operation basis. That means that any variable used within the context of an operation must be defined at the top level of that operation"
)
)
) *> IO.foreach(op.variableDefinitions)(v =>
IO.when(!variableUsages.contains(v.name))(
- IO.fail(
- ValidationError(
- s"Variable '${v.name}' is not used.",
- "All variables defined by an operation must be used in that operation or a fragment transitively included by that operation. Unused variables cause a validation error."
- )
+ failValidation(
+ s"Variable '${v.name}' is not used.",
+ "All variables defined by an operation must be used in that operation or a fragment transitively included by that operation. Unused variables cause a validation error."
)
)
)
@@ -273,20 +263,15 @@ object Validator {
val spreadNames = spreads.map(_.name).toSet
IO.foreach(context.fragments.values)(f =>
if (!spreadNames.contains(f.name))
- IO.fail(
- ValidationError(
- s"Fragment '${f.name}' is not used in any spread.",
- "Defined fragments must be used within a document."
- )
+ failValidation(
+ s"Fragment '${f.name}' is not used in any spread.",
+ "Defined fragments must be used within a document."
)
else
- IO.fail(
- ValidationError(
- s"Fragment '${f.name}' forms a cycle.",
- "The graph of fragment spreads must not form any cycles including spreading itself. Otherwise an operation could infinitely spread or infinitely execute on cycles in the underlying data."
- )
- )
- .when(detectCycles(context, f))
+ failValidation(
+ s"Fragment '${f.name}' forms a cycle.",
+ "The graph of fragment spreads must not form any cycles including spreading itself. Otherwise an operation could infinitely spread or infinitely execute on cycles in the underlying data."
+ ).when(detectCycles(context, f))
)
.unit
}
@@ -307,11 +292,11 @@ object Validator {
case OperationType.Query => validateFields(context, selectionSet, context.rootType.queryType)
case OperationType.Mutation =>
context.rootType.mutationType.fold[IO[ValidationError, Unit]](
- IO.fail(ValidationError("Mutation operations are not supported on this schema.", ""))
+ failValidation("Mutation operations are not supported on this schema.", "")
)(validateFields(context, selectionSet, _))
case OperationType.Subscription =>
context.rootType.subscriptionType.fold[IO[ValidationError, Unit]](
- IO.fail(ValidationError("Subscription operations are not supported on this schema.", ""))
+ failValidation("Subscription operations are not supported on this schema.", "")
)(validateFields(context, selectionSet, _))
}
case _: FragmentDefinition => IO.unit
@@ -329,11 +314,9 @@ object Validator {
case FragmentSpread(name, _) =>
context.fragments.get(name) match {
case None =>
- IO.fail(
- ValidationError(
- s"Fragment spread '$name' is not defined.",
- "Named fragment spreads must refer to fragments defined within the document. It is a validation error if the target of a spread is not defined."
- )
+ failValidation(
+ s"Fragment spread '$name' is not defined.",
+ "Named fragment spreads must refer to fragments defined within the document. It is a validation error if the target of a spread is not defined."
)
case Some(fragment) =>
validateSpread(context, Some(name), currentType, Some(fragment.typeCondition), fragment.selectionSet)
@@ -356,22 +339,18 @@ object Validator {
val possibleFragmentTypes = getPossibleTypes(fragmentType).flatMap(_.name)
val applicableTypes = possibleTypes intersect possibleFragmentTypes
IO.when(applicableTypes.isEmpty)(
- IO.fail(
- ValidationError(
- s"${name.fold("Inline fragment spread")(n => s"Fragment spread '$n'")} is not possible: possible types are '${possibleTypes
- .mkString(", ")}' and possible fragment types are '${possibleFragmentTypes.mkString(", ")}'.",
- "Fragments are declared on a type and will only apply when the runtime object type matches the type condition. They also are spread within the context of a parent type. A fragment spread is only valid if its type condition could ever apply within the parent type."
- )
+ failValidation(
+ s"${name.fold("Inline fragment spread")(n => s"Fragment spread '$n'")} is not possible: possible types are '${possibleTypes
+ .mkString(", ")}' and possible fragment types are '${possibleFragmentTypes.mkString(", ")}'.",
+ "Fragments are declared on a type and will only apply when the runtime object type matches the type condition. They also are spread within the context of a parent type. A fragment spread is only valid if its type condition could ever apply within the parent type."
)
) *> validateFields(context, selectionSet, fragmentType)
}
case None =>
lazy val typeConditionName = typeCondition.fold("?")(_.name)
- IO.fail(
- ValidationError(
- s"${name.fold("Inline fragment spread")(n => s"Fragment spread '$n'")} targets an invalid type: '$typeConditionName'.",
- "Fragments must be specified on types that exist in the schema. This applies for both named and inline fragments. If they are not defined in the schema, the query does not validate."
- )
+ failValidation(
+ s"${name.fold("Inline fragment spread")(n => s"Fragment spread '$n'")} targets an invalid type: '$typeConditionName'.",
+ "Fragments must be specified on types that exist in the schema. This applies for both named and inline fragments. If they are not defined in the schema, the query does not validate."
)
}
@@ -402,23 +381,19 @@ object Validator {
case (arg, argValue) =>
f.args.find(_.name == arg) match {
case None =>
- IO.fail(
- ValidationError(
- s"Argument '$arg' is not defined on field '${field.name}' of type '${currentType.name.getOrElse("")}'.",
- "Every argument provided to a field or directive must be defined in the set of possible arguments of that field or directive."
- )
+ failValidation(
+ s"Argument '$arg' is not defined on field '${field.name}' of type '${currentType.name.getOrElse("")}'.",
+ "Every argument provided to a field or directive must be defined in the set of possible arguments of that field or directive."
)
case Some(inputValue) => validateInputValues(inputValue, argValue)
}
} *>
IO.foreach(f.args.filter(a => a.`type`().kind == __TypeKind.NON_NULL && a.defaultValue.isEmpty))(arg =>
IO.when(field.arguments.get(arg.name).forall(_ == NullValue))(
- IO.fail(
- ValidationError(
- s"Required argument '${arg.name}' is null or missing on field '${field.name}' of type '${currentType.name
- .getOrElse("")}'.",
- "Arguments can be required. An argument is required if the argument type is non‐null and does not have a default value. Otherwise, the argument is optional."
- )
+ failValidation(
+ s"Required argument '${arg.name}' is null or missing on field '${field.name}' of type '${currentType.name
+ .getOrElse("")}'.",
+ "Arguments can be required. An argument is required if the argument type is non‐null and does not have a default value. Otherwise, the argument is optional."
)
)
)
@@ -433,11 +408,9 @@ object Validator {
case (k, v) =>
inputFields.find(_.name == k) match {
case None =>
- IO.fail(
- ValidationError(
- s"Input field '$k' is not defined on type '${inputType.name.getOrElse("?")}'.",
- "Every input field provided in an input object value must be defined in the set of possible fields of that input object’s expected type."
- )
+ failValidation(
+ s"Input field '$k' is not defined on type '${inputType.name.getOrElse("?")}'.",
+ "Every input field provided in an input object value must be defined in the set of possible fields of that input object’s expected type."
)
case Some(value) => validateInputValues(value, v)
}
@@ -448,11 +421,9 @@ object Validator {
inputField.`type`().kind == __TypeKind.NON_NULL &&
!fields.contains(inputField.name)
)(
- IO.fail(
- ValidationError(
- s"Required field '${inputField.name}' on object '${inputType.name.getOrElse("?")}' was not provided.",
- "Input object fields may be required. Much like a field may have required arguments, an input object may have required fields. An input field is required if it has a non‐null type and does not have a default value. Otherwise, the input object field is optional."
- )
+ failValidation(
+ s"Required field '${inputField.name}' on object '${inputType.name.getOrElse("?")}' was not provided.",
+ "Input object fields may be required. Much like a field may have required arguments, an input object may have required fields. An input field is required if it has a non‐null type and does not have a default value. Otherwise, the input object field is optional."
)
)
)
@@ -464,18 +435,14 @@ object Validator {
private def validateLeafFieldSelection(selections: List[Selection], currentType: __Type): IO[ValidationError, Unit] =
IO.whenCase(currentType.kind) {
case __TypeKind.SCALAR | __TypeKind.ENUM if selections.nonEmpty =>
- IO.fail(
- ValidationError(
- s"Field selection is impossible on type '${currentType.name.getOrElse("")}'.",
- "Field selections on scalars or enums are never allowed, because they are the leaf nodes of any GraphQL query."
- )
+ failValidation(
+ s"Field selection is impossible on type '${currentType.name.getOrElse("")}'.",
+ "Field selections on scalars or enums are never allowed, because they are the leaf nodes of any GraphQL query."
)
case __TypeKind.INTERFACE | __TypeKind.UNION | __TypeKind.OBJECT if selections.isEmpty =>
- IO.fail(
- ValidationError(
- s"Field selection is mandatory on type '${currentType.name.getOrElse("")}'.",
- "Leaf selections on objects, interfaces, and unions without subfields are disallowed."
- )
+ failValidation(
+ s"Field selection is mandatory on type '${currentType.name.getOrElse("")}'.",
+ "Leaf selections on objects, interfaces, and unions without subfields are disallowed."
)
}
@@ -483,11 +450,9 @@ object Validator {
val names = operations.flatMap(_.name).groupBy(identity)
val repeatedNames = names.collect { case (name, items) if items.length > 1 => name }
IO.when(repeatedNames.nonEmpty)(
- IO.fail(
- ValidationError(
- s"Multiple operations have the same name: ${repeatedNames.mkString(", ")}.",
- "Each named operation definition must be unique within a document when referred to by its name."
- )
+ failValidation(
+ s"Multiple operations have the same name: ${repeatedNames.mkString(", ")}.",
+ "Each named operation definition must be unique within a document when referred to by its name."
)
)
}
@@ -495,11 +460,9 @@ object Validator {
private def validateLoneAnonymousOperation(operations: List[OperationDefinition]): IO[ValidationError, Unit] = {
val anonymous = operations.filter(_.name.isEmpty)
IO.when(operations.length > 1 && anonymous.nonEmpty)(
- IO.fail(
- ValidationError(
- "Found both anonymous and named operations.",
- "GraphQL allows a short‐hand form for defining query operations when only that one operation exists in the document."
- )
+ failValidation(
+ "Found both anonymous and named operations.",
+ "GraphQL allows a short‐hand form for defining query operations when only that one operation exists in the document."
)
)
}
@@ -510,11 +473,9 @@ object Validator {
IO.foldLeft(fragments)(Map.empty[String, FragmentDefinition]) {
case (fragmentMap, fragment) =>
if (fragmentMap.contains(fragment.name)) {
- IO.fail(
- ValidationError(
- s"Fragment '${fragment.name}' is defined more than once.",
- "Fragment definitions are referenced in fragment spreads by name. To avoid ambiguity, each fragment’s name must be unique within a document."
- )
+ failValidation(
+ s"Fragment '${fragment.name}' is defined more than once.",
+ "Fragment definitions are referenced in fragment spreads by name. To avoid ambiguity, each fragment’s name must be unique within a document."
)
} else IO.succeed(fragmentMap.updated(fragment.name, fragment))
}
@@ -544,11 +505,9 @@ object Validator {
case __TypeKind.UNION | __TypeKind.INTERFACE | __TypeKind.OBJECT => IO.unit
case _ =>
val targetTypeName = targetType.name.getOrElse("")
- IO.fail(
- ValidationError(
- s"${name.fold("Inline fragment")(n => s"Fragment '$n'")} is defined on invalid type '$targetTypeName'",
- "Fragments can only be declared on unions, interfaces, and objects. They are invalid on scalars. They can only be applied on non‐leaf fields. This rule applies to both inline and named fragments."
- )
+ failValidation(
+ s"${name.fold("Inline fragment")(n => s"Fragment '$n'")} is defined on invalid type '$targetTypeName'",
+ "Fragments can only be declared on unions, interfaces, and objects. They are invalid on scalars. They can only be applied on non‐leaf fields. This rule applies to both inline and named fragments."
)
}
@@ -556,20 +515,18 @@ object Validator {
t.enumValues(__DeprecatedArgs(Some(true))) match {
case Some(_ :: _) => IO.unit
case _ =>
- IO.fail(
- ValidationError(
- s"Enum ${t.name.getOrElse("")} doesn't contain any values",
- "An Enum type must define one or more unique enum values."
- )
+ failValidation(
+ s"Enum ${t.name.getOrElse("")} doesn't contain any values",
+ "An Enum type must define one or more unique enum values."
)
}
private def validateInterface(t: __Type): IO[ValidationError, Unit] = {
def validateName(name: String) = {
if (name.isEmpty) {
- IO.fail(ValidationError("msg", "explanatory"))
+ failValidation("msg", "explanatory")
} else if (name.startsWith("__")) {
- IO.fail(ValidationError("msg", "explanatory"))
+ failValidation("msg", "explanatory")
} else {
IO.unit
}
@@ -597,20 +554,16 @@ object Validator {
t.fields(__DeprecatedArgs(Some(true))) match {
case None | Some(Nil) =>
- IO.fail(
- ValidationError(
+ failValidation(
s"message",
"explanatory"
- )
)
case Some(fields) =>
duplicateFieldName(fields) match {
case Some(value) =>
- IO.fail(
- ValidationError(
+ failValidation(
s"message with $value",
"explanatory"
- )
)
case None =>
IO.foreach(fields){ validateInterfaceField }.unit
@@ -627,25 +580,77 @@ object Validator {
t.possibleTypes match {
case None | Some(Nil) =>
- IO.fail(
- ValidationError(
- s"Union ${t.name.getOrElse("")} doesn't contain any type.",
- "A Union type must include one or more unique member types."
- )
+ failValidation(
+ s"Union ${t.name.getOrElse("")} doesn't contain any type.",
+ "A Union type must include one or more unique member types."
)
case Some(types) if !types.forall(isObject) =>
- IO.fail(
- ValidationError(
- s"Union ${t.name.getOrElse("")} contains the following non Object types: " +
- types.filterNot(isObject).map(_.name.getOrElse("")).filterNot(_.isEmpty).mkString("", ", ", "."),
- s"The member types of a Union type must all be Object base types."
- )
+ failValidation(
+ s"Union ${t.name.getOrElse("")} contains the following non Object types: " +
+ types.filterNot(isObject).map(_.name.getOrElse("")).filterNot(_.isEmpty).mkString("", ", ", "."),
+ s"The member types of a Union type must all be Object base types."
)
case _ => IO.unit
}
}
+ private def validateInputObject(t: __Type): IO[ValidationError, Unit] = {
+ // https://spec.graphql.org/June2018/#IsInputType()
+ def isInputType(t: __Type): Either[__Type, Unit] = t.kind match {
+ case __TypeKind.LIST | __TypeKind.NON_NULL => t.ofType.fold[Either[__Type, Unit]](Left(t))(isInputType)
+ case __TypeKind.SCALAR | __TypeKind.ENUM | __TypeKind.INPUT_OBJECT => Right(())
+ case _ => Left(t)
+ }
+
+ def validateFields(fields: List[__InputValue]): IO[ValidationError, Unit] =
+ duplicateFieldName(fields) <*
+ IO.foreach(fields)(field =>
+ for {
+ _ <- doesNotStartWithUnderscore(field)
+ _ <- onlyInputFieldType(field)
+ } yield ()
+ )
+
+ def duplicateFieldName(fields: List[__InputValue]): IO[ValidationError, Unit] =
+ fields
+ .groupBy(_.name)
+ .collectFirst { case (_, f :: _ :: _) => f }
+ .fold[IO[ValidationError, Unit]](IO.unit)(duplicateField =>
+ failValidation(
+ s"InputObject has repeated fields: ${duplicateField.name}",
+ "The input field must have a unique name within that Input Object type; no two input fields may share the same name"
+ )
+ )
+
+ def doesNotStartWithUnderscore(field: __InputValue): IO[ValidationError, Unit] =
+ IO.when(field.name.startsWith("__"))(
+ failValidation(
+ s"InputObject can't start with '__': ${field.name}",
+ """The input field must not have a name which begins with the
+characters {"__"} (two underscores)"""
+ )
+ )
+
+ def onlyInputFieldType(field: __InputValue): IO[ValidationError, Unit] =
+ IO.whenCase(isInputType(field.`type`())) {
+ case Left(errorType) =>
+ failValidation(
+ s"${errorType.name.getOrElse("")} is of kind ${errorType.kind}, must be an InputType",
+ """The input field must accept a type where IsInputType(inputFieldType) returns true, https://spec.graphql.org/June2018/#IsInputType()"""
+ )
+ }
+
+ t.inputFields match {
+ case None | Some(Nil) =>
+ failValidation(
+ s"InputObject ${t.name.getOrElse("")} does not have fields",
+ "An Input Object type must define one or more input fields"
+ )
+ case Some(fields) => validateFields(fields)
+ }
+ }
+
case class Context(
document: Document,
rootType: RootType,
diff --git a/core/src/test/scala/caliban/RenderingSpec.scala b/core/src/test/scala/caliban/RenderingSpec.scala
index 58357853af..58ac23200a 100644
--- a/core/src/test/scala/caliban/RenderingSpec.scala
+++ b/core/src/test/scala/caliban/RenderingSpec.scala
@@ -27,7 +27,6 @@ object RenderingSpec
| name: String! @external
| nicknames: [String!]! @required
| origin: Origin!
- | role: Role
|}
|
|type Captain {
diff --git a/core/src/test/scala/caliban/TestUtils.scala b/core/src/test/scala/caliban/TestUtils.scala
index 90b362a616..81dfc425c3 100644
--- a/core/src/test/scala/caliban/TestUtils.scala
+++ b/core/src/test/scala/caliban/TestUtils.scala
@@ -4,7 +4,7 @@ import caliban.TestUtils.Origin._
import caliban.TestUtils.Role._
import caliban.Value.StringValue
import caliban.parsing.adt.Directive
-import caliban.schema.Annotations.{ GQLDeprecated, GQLDescription, GQLDirective, GQLInterface }
+import caliban.schema.Annotations.{ GQLDeprecated, GQLDescription, GQLDirective, GQLInputName, GQLInterface }
import caliban.schema.Schema
import zio.UIO
import zio.stream.ZStream
@@ -44,6 +44,13 @@ object TestUtils {
role: Option[Role]
)
+ @GQLInputName("CharacterInput")
+ case class CharacterInput(
+ @GQLDirective(Directive("external")) name: String,
+ @GQLDirective(Directive("required")) nicknames: List[String],
+ origin: Origin
+ )
+
object Character {
implicit val schema: Schema[Any, Character] = Schema.gen[Character]
}
@@ -61,7 +68,7 @@ object TestUtils {
case class CharactersArgs(origin: Option[Origin])
case class CharacterArgs(name: String)
case class CharacterInArgs(@GQLDirective(Directive("lowercase")) names: List[String])
- case class CharacterObjectArgs(character: Character)
+ case class CharacterObjectArgs(character: CharacterInput)
@GQLDescription("Queries")
case class Query(
@@ -107,4 +114,28 @@ object TestUtils {
SubscriptionIO(ZStream.empty)
)
+ object InvalidSchemas {
+ case class DoubleUnderscoreArg(__name: String)
+ case class DoubleUnderscoreInputObjectArg(wrong: DoubleUnderscoreArg)
+ case class WrongMutationUnderscore(w: DoubleUnderscoreInputObjectArg => UIO[Unit])
+
+ val resolverWrongMutationUnderscore = RootResolver(
+ resolverIO.queryResolver,
+ WrongMutationUnderscore(_ => UIO.unit)
+ )
+
+ sealed trait UnionInput
+ object UnionInput {
+ case class A(value: String) extends UnionInput
+ case class B(value: String) extends UnionInput
+ }
+ case class UnionArg(union: UnionInput)
+ case class UnionInputObjectArg(wrong: UnionArg)
+ case class WrongMutationUnion(w: UnionInputObjectArg => UIO[Unit])
+
+ val resolverWrongMutationUnion = RootResolver(
+ resolverIO.queryResolver,
+ WrongMutationUnion(_ => UIO.unit)
+ )
+ }
}
diff --git a/core/src/test/scala/caliban/validation/ValidationSchemaSpec.scala b/core/src/test/scala/caliban/validation/ValidationSchemaSpec.scala
new file mode 100644
index 0000000000..80a5c22495
--- /dev/null
+++ b/core/src/test/scala/caliban/validation/ValidationSchemaSpec.scala
@@ -0,0 +1,32 @@
+package caliban.validation
+
+import caliban.CalibanError.ValidationError
+import caliban.GraphQL
+import caliban.GraphQL.graphQL
+import caliban.TestUtils.InvalidSchemas._
+import zio.IO
+import zio.test.Assertion._
+import zio.test._
+
+object ValidationSchemaSpec
+ extends DefaultRunnableSpec({
+ def check(gql: GraphQL[Any], expectedMessage: String): IO[ValidationError, TestResult] =
+ assertM(gql.interpreter.run, fails[ValidationError](hasField("msg", _.msg, equalTo(expectedMessage))))
+
+ suite("ValidationSchemaSpec")({
+ suite("InputObjects")(
+ testM("name can't start with '__'") {
+ check(
+ graphQL(resolverWrongMutationUnderscore),
+ "InputObject can't start with '__': __name"
+ )
+ },
+ testM("should only contain types for which IsInputType(type) is true") {
+ check(
+ graphQL(resolverWrongMutationUnion),
+ "UnionInput is of kind UNION, must be an InputType"
+ )
+ }
+ )
+ })
+ })
diff --git a/docs/404.html b/docs/404.html
index a5e5b9bdd9..d62617e799 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -4,17 +4,17 @@
Caliban
-
-
+
+
-
-
+
+