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.

Sign up for GitHub

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

Render directives at the top of the schema #1270

Merged
merged 3 commits into from
Jan 28, 2022
Merged

Render directives at the top of the schema #1270

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f31da2
Render directives at the top of the schema
Fluxx Jan 24, 2022
d0661c6
Remove extranous comma
Fluxx Jan 25, 2022
df84d6b
Remove repeatable statement from directives
Fluxx Jan 25, 2022
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
9 changes: 7 additions & 2 deletions core/src/main/scala/caliban/GraphQL.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package caliban

import caliban.CalibanError.ValidationError
import caliban.Rendering.renderTypes
import caliban.Rendering.{ renderDirectives, renderTypes }
import caliban.execution.{ ExecutionRequest, Executor, QueryExecution }
import caliban.introspection.Introspector
import caliban.introspection.adt._
Expand Down Expand Up @@ -45,7 +45,12 @@ trait GraphQL[-R] { self =>
|}""".stripMargin
}

s"""$schema
val directivesPrefix = renderDirectives(additionalDirectives) match {
case "" => ""
case directiveStr => directiveStr + "\n\n"
}

s"""${directivesPrefix}${schema}
|
|${renderTypes(schemaBuilder.types)}""".stripMargin
}
Expand Down
38 changes: 38 additions & 0 deletions core/src/main/scala/caliban/Rendering.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,44 @@ object Rendering {
}
.mkString("\n\n")

def renderDirectives(directives: List[__Directive]): String =
directives.map(renderDirective).mkString("\n")

private def renderDirective(directive: __Directive): String = {
val inputs = directive.args match {
case i if i.nonEmpty => s"""(${i.map(renderInputValue).mkString(", ")})"""
case _ => ""
}
val locationStrings = directive.locations.map {
case __DirectiveLocation.QUERY => "QUERY"
case __DirectiveLocation.MUTATION => "MUTATION"
case __DirectiveLocation.SUBSCRIPTION => "SUBSCRIPTION"
case __DirectiveLocation.FIELD => "FIELD"
case __DirectiveLocation.FRAGMENT_DEFINITION => "FRAGMENT_DEFINITION"
case __DirectiveLocation.FRAGMENT_SPREAD => "FRAGMENT_SPREAD"
case __DirectiveLocation.INLINE_FRAGMENT => "INLINE_FRAGMENT"
case __DirectiveLocation.SCHEMA => "SCHEMA"
case __DirectiveLocation.SCALAR => "SCALAR"
case __DirectiveLocation.OBJECT => "OBJECT"
case __DirectiveLocation.FIELD_DEFINITION => "FIELD_DEFINITION"
case __DirectiveLocation.ARGUMENT_DEFINITION => "ARGUMENT_DEFINITION"
case __DirectiveLocation.INTERFACE => "INTERFACE"
case __DirectiveLocation.UNION => "UNION"
case __DirectiveLocation.ENUM => "ENUM"
case __DirectiveLocation.ENUM_VALUE => "ENUM_VALUE"
case __DirectiveLocation.INPUT_OBJECT => "INPUT_OBJECT"
case __DirectiveLocation.INPUT_FIELD_DEFINITION => "INPUT_FIELD_DEFINITION"
Comment on lines +91 to +108
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a copy paste to the __DirectiveLocation code. Wasn't sure if we wanted to somehow encode the string version of the location in the case object?

}
val directiveLocations = locationStrings.mkString(" | ")

val body = s"""directive @${directive.name}${inputs} repeatable on ${directiveLocations}""".stripMargin
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add repeatable: Boolean to directives with default to true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh shoot I meant to ask about this. Right now it's hard-coded as repeatable. I didn't look at what we did for this with the introspection API but it would be good to allow it to be set as non-repeatable.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah this keyword is new in the 2021 spec, which is why it was not there before. Would be nice to add (otherwise, don't include the keyword).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, let me see what I can do about adding it.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the top of my head, it should be added in the parser, in the Directive and __Directive classes, and maybe a validation rule should be added to check there is only one given if not repeatable.

If that's too much, it can be done in another PR 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Yeah I will remove the repeatable statement for now, and then do another PR to add repeatable.


renderDescription(directive.description) match {
case "" => body
case something => something + body
}
}

private def renderInterfaces(t: __Type): String =
t.interfaces()
.fold("")(_.flatMap(_.name) match {
Expand Down
7 changes: 5 additions & 2 deletions core/src/test/scala/caliban/RenderingSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ object RenderingSpec extends DefaultRunnableSpec {
override def spec: ZSpec[TestEnvironment, Any] =
suite("rendering")(
test("it should render directives") {
assert(graphQL(resolver).render.trim)(
equalTo("""schema {
assert(graphQL(resolver, directives = List(Directives.Test)).render.trim)(
equalTo(""""Test directive"
ghostdogpr marked this conversation as resolved.
Show resolved Hide resolved
|directive @test(foo: Int) repeatable on FIELD_DEFINITION
|
|schema {
| query: Query
|}
|
Expand Down
18 changes: 18 additions & 0 deletions core/src/test/scala/caliban/TestUtils.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import caliban.schema.Schema.scalarSchema
import caliban.schema.{ Schema, Types }
import zio.UIO
import zio.stream.ZStream
import caliban.introspection.adt.{ __Directive, __DirectiveLocation }

object TestUtils {

Expand Down Expand Up @@ -140,6 +141,23 @@ object TestUtils {
SubscriptionIO(ZStream.empty)
)

object Directives {
val Test = __Directive(
name = "test",
description = Some("Test directive"),
locations = Set(__DirectiveLocation.FIELD_DEFINITION),
args = List(
__InputValue(
"foo",
None,
() => Types.int,
None,
None
)
)
),
ghostdogpr marked this conversation as resolved.
Show resolved Hide resolved
}

object InvalidSchemas {
case class DoubleUnderscoreArg(__name: String)
case class DoubleUnderscoreInputObjectArg(wrong: DoubleUnderscoreArg)
Expand Down