Add renderSchema helper (#1877)

ghostdogpr · Sep 9, 2023 · 7a0ff58 · 7a0ff58
1 parent c2cecbb
commit 7a0ff58
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 2 deletions.
diff --git a/core/src/main/scala/caliban/package.scala b/core/src/main/scala/caliban/package.scala
@@ -1,5 +1,8 @@
+import caliban.execution.Feature
 import caliban.introspection.adt.__Directive
-import caliban.parsing.adt.Directive
+import caliban.parsing.SourceMapper
+import caliban.parsing.adt.Definition.TypeSystemDefinition.SchemaDefinition
+import caliban.parsing.adt.{ Directive, Document }
 import caliban.rendering.DocumentRenderer
 import caliban.schema.Types.collectTypes
 import caliban.schema._
@@ -34,7 +37,7 @@ package object caliban {
     )
     val wrappers: List[Wrapper[R]]              = Nil
     val additionalDirectives: List[__Directive] = directives
-    val features                                = Set.empty
+    val features: Set[Feature]                  = Set.empty
   }
 
   /**
@@ -49,4 +52,44 @@ package object caliban {
    */
   def renderWith[R, T](implicit schema: Schema[R, T]): String =
     DocumentRenderer.typesRenderer.render(collectTypes(schema.toType_(), Nil))
+
+  /**
+   * Returns a string that renders the given schema into the GraphQL SDL.
+   */
+  def renderSchema[Q, M, S](
+    directives: List[__Directive] = Nil,
+    schemaDirectives: List[Directive] = Nil,
+    schemaDescription: Option[String] = None
+  )(implicit querySchema: Schema[Any, Q], mutationSchema: Schema[Any, M], subscriptionSchema: Schema[Any, S]): String =
+    renderSchemaWith[Any, Q, M, S](directives, schemaDirectives, schemaDescription)
+
+  /**
+   * Returns a string that renders the given schema into the GraphQL SDL.
+   * This variant of the method allows specifying the environment type when it's not `Any`.
+   */
+  def renderSchemaWith[R, Q, M, S](
+    directives: List[__Directive] = Nil,
+    schemaDirectives: List[Directive] = Nil,
+    schemaDescription: Option[String] = None
+  )(implicit querySchema: Schema[R, Q], mutationSchema: Schema[R, M], subscriptionSchema: Schema[R, S]): String = {
+    val hasQuery        = querySchema.toType_().allFields.nonEmpty
+    val hasMutation     = mutationSchema.toType_().allFields.nonEmpty
+    val hasSubscription = subscriptionSchema.toType_().allFields.nonEmpty
+    DocumentRenderer.render(
+      Document(
+        SchemaDefinition(
+          schemaDirectives,
+          if (hasQuery) querySchema.toType_().name else None,
+          if (hasMutation) mutationSchema.toType_().name else None,
+          if (hasSubscription) subscriptionSchema.toType_().name else None,
+          schemaDescription
+        ) ::
+          (if (hasQuery) collectTypes(querySchema.toType_()).flatMap(_.toTypeDefinition) else Nil) ++
+          (if (hasMutation) collectTypes(mutationSchema.toType_()).flatMap(_.toTypeDefinition) else Nil) ++
+          (if (hasSubscription) collectTypes(subscriptionSchema.toType_()).flatMap(_.toTypeDefinition) else Nil) ++
+          directives.map(_.toDirectiveDefinition),
+        SourceMapper.empty
+      )
+    )
+  }
 }
diff --git a/core/src/test/scala/caliban/schema/SchemaSpec.scala b/core/src/test/scala/caliban/schema/SchemaSpec.scala
@@ -254,6 +254,14 @@ object SchemaSpec extends ZIOSpecDefault {
         object schema extends GenericSchema[Env]
         import schema.auto._
         assertTrue(caliban.renderWith[Env, EnvironmentSchema].nonEmpty)
+      },
+      test("renderSchema can be called with a Schema where R is any") {
+        assertTrue(caliban.renderSchema[EffectfulFieldSchema, Unit, Unit]().nonEmpty)
+      },
+      test("renderSchema can be called with a Schema where R is not any") {
+        object schema extends GenericSchema[Env]
+        import schema.auto._
+        assertTrue(caliban.renderSchemaWith[Env, EnvironmentSchema, Unit, Unit]().nonEmpty)
       }
     )