Adhere to specification for schema extension (#2433)

ghostdogpr · Dec 12, 2024 · f072518 · f072518
1 parent 9b88896
commit f072518
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/core/src/main/scala/caliban/rendering/DocumentRenderer.scala b/core/src/main/scala/caliban/rendering/DocumentRenderer.scala
@@ -327,7 +327,8 @@ object DocumentRenderer extends Renderer[Document] {
       definition match {
         case SchemaDefinition(directives, query, mutation, subscription, description) =>
           val hasTypes    = query.nonEmpty || mutation.nonEmpty || subscription.nonEmpty
-          val isExtension = directives.nonEmpty && !hasTypes
+          val isExtension =
+            (!hasTypes && directives.nonEmpty) || (query.isEmpty && (mutation.nonEmpty || subscription.nonEmpty))
           var first       = true
 
           def renderOp(name: String, op: Option[String]): Unit =

diff --git a/core/src/test/scala/caliban/RenderingSpec.scala b/core/src/test/scala/caliban/RenderingSpec.scala
@@ -17,6 +17,7 @@ import caliban.schema.Annotations.GQLOneOfInput
 import caliban.schema.Schema.auto._
 import caliban.schema.ArgBuilder.auto._
 import caliban.schema.{ ArgBuilder, Schema }
+import zio.stream.ZStream
 import zio.{ IO, ZIO }
 import zio.test.Assertion._
 import zio.test._
@@ -101,14 +102,41 @@ object RenderingSpec extends ZIOSpecDefault {
         assertTrue(graphQL(InvalidSchemas.resolverEmpty).render.trim == "")
       },
       test(
-        "it should render a schema extension with schema directives even if no queries, mutations, or subscription"
+        "it should render a schema extension with directives only"
       ) {
         val renderedType =
           graphQL(InvalidSchemas.resolverEmpty, schemaDirectives = List(SchemaDirectives.Link)).render.trim
         assertTrue(
           renderedType == """extend schema @link(url: "https://example.com", import: ["@key", {name: "@provides", as: "@self"}])"""
         )
       },
+      test("it should render a schema extension with directives and a mutation") {
+        val resolver     = RootResolver(
+          Option.empty[Unit],
+          Some(MutationIO(_ => ZIO.unit)),
+          Option.empty[Unit]
+        )
+        val renderedType = graphQL(resolver, schemaDirectives = List(SchemaDirectives.Link)).render.trim
+        assertTrue(renderedType.startsWith("extend schema"))
+      },
+      test("it should render a schema extension with directives and a subscription") {
+        val resolver     = RootResolver(
+          Option.empty[Unit],
+          Option.empty[Unit],
+          Some(SubscriptionIO(ZStream.empty))
+        )
+        val renderedType = graphQL(resolver, schemaDirectives = List(SchemaDirectives.Link)).render.trim
+        assertTrue(renderedType.startsWith("extend schema"))
+      },
+      test("it should render a schema extension with a subscription and mutation but no directives") {
+        val resolver     = RootResolver(
+          Option.empty[Unit],
+          Some(MutationIO(_ => ZIO.unit)),
+          Some(SubscriptionIO(ZStream.empty))
+        )
+        val renderedType = graphQL(resolver).render.trim
+        assertTrue(renderedType.startsWith("extend schema"))
+      },
       test("it should render object arguments in type directives") {
         val testType     = __Type(
           __TypeKind.OBJECT,