Merge pull request #757 from sangria-graphql/remove_useLegacyCommentD…

…escriptions remove deprecated useLegacyCommentDescriptions
sangria-graphql · Oct 24, 2021 · cd97f13 · cd97f13
2 parents be47416 + 3de699e
commit cd97f13
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 74 deletions.
diff --git a/build.sbt b/build.sbt
@@ -56,6 +56,11 @@ ThisBuild / mimaBinaryIssueFilters ++= Seq(
   ProblemFilters.exclude[MissingClassProblem]("sangria.validation.rules.Conflict$"),
   ProblemFilters.exclude[MissingClassProblem]("sangria.validation.rules.PairSet"),
   ProblemFilters.exclude[Problem]("sangria.validation.rules.experimental.*"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("sangria.schema.AstSchemaBuilder.defaultWithLegacyCommentDescriptions"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("sangria.schema.DefaultAstSchemaBuilder.useLegacyCommentDescriptions"),
+  ProblemFilters.exclude[MissingClassProblem]("sangria.schema.LegacyCommentDescriptionsResolver"),
+  ProblemFilters.exclude[MissingClassProblem]("sangria.schema.LegacyCommentDescriptionsResolver$"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("sangria.schema.ResolverBasedAstSchemaBuilder.useLegacyCommentDescriptions")
 )
 
 lazy val root = project

diff --git a/modules/core/src/main/scala/sangria/schema/AstSchemaBuilder.scala b/modules/core/src/main/scala/sangria/schema/AstSchemaBuilder.scala
@@ -248,11 +248,6 @@ object AstSchemaBuilder {
   def resolverBased[Ctx](resolvers: AstSchemaResolver[Ctx]*) =
     new ResolverBasedAstSchemaBuilder[Ctx](resolvers)
 
-  @deprecated("Please migrate to new string-based description format", "1.3.3")
-  def defaultWithLegacyCommentDescriptions[Ctx] = new DefaultAstSchemaBuilder[Ctx] {
-    override def useLegacyCommentDescriptions = true
-  }
-
   object TypeName {
     def unapply(definition: ast.TypeDefinition): Option[String] =
       Some(definition.name)
@@ -851,35 +846,26 @@ class DefaultAstSchemaBuilder[Ctx] extends AstSchemaBuilder[Ctx] {
   def directiveName(definition: ast.DirectiveDefinition): String =
     definition.name
 
-  @deprecated("Please migrate to new string-based description format", "1.3.3")
-  def useLegacyCommentDescriptions: Boolean = false
-
   def commentDescription(node: ast.WithComments): Option[String] =
     AstSchemaBuilder.extractDescription(node)
 
   def typeDescription(definition: ast.TypeDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def fieldDescription(definition: ast.FieldDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def argumentDescription(definition: ast.InputValueDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def inputFieldDescription(definition: ast.InputValueDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def enumValueDescription(definition: ast.EnumValueDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def directiveDescription(definition: ast.DirectiveDefinition): Option[String] =
-    if (useLegacyCommentDescriptions) commentDescription(definition)
-    else definition.description.map(_.value)
+    definition.description.map(_.value)
 
   def enumValue(
       typeDefinition: Either[ast.EnumTypeDefinition, EnumType[_]],

diff --git a/modules/core/src/main/scala/sangria/schema/AstSchemaResolver.scala b/modules/core/src/main/scala/sangria/schema/AstSchemaResolver.scala
@@ -25,14 +25,6 @@ object AdditionalTypes {
 case class AdditionalDirectives[Ctx](additionalDirectives: Seq[Directive])
     extends AstSchemaResolver[Ctx]
 
-@deprecated("Please migrate to new string-based description format", "1.4.0")
-class LegacyCommentDescriptionsResolver[Ctx] extends AstSchemaResolver[Ctx]
-
-object LegacyCommentDescriptionsResolver {
-  @deprecated("Please migrate to new string-based description format", "1.4.0")
-  def apply[Ctx]() = new LegacyCommentDescriptionsResolver[Ctx]
-}
-
 case class DirectiveResolver[Ctx](
     directive: Directive,
     resolve: AstDirectiveContext[Ctx] => Action[Ctx, Any],

diff --git a/modules/core/src/main/scala/sangria/schema/ResolverBasedAstSchemaBuilder.scala b/modules/core/src/main/scala/sangria/schema/ResolverBasedAstSchemaBuilder.scala
@@ -54,9 +54,6 @@ class ResolverBasedAstSchemaBuilder[Ctx](val resolvers: Seq[AstSchemaResolver[Ct
   protected lazy val validationSchema =
     Schema(stubQueryType, directives = directives.toList ++ BuiltinDirectives)
 
-  override def useLegacyCommentDescriptions: Boolean =
-    resolvers.exists(_.isInstanceOf[LegacyCommentDescriptionsResolver[Ctx]])
-
   override lazy val additionalTypes: List[MaterializedType] = resolvers.flatMap {
     case AdditionalTypes(at) => at
     case _ => Nil

diff --git a/modules/core/src/test/scala/sangria/schema/AstSchemaMaterializerSpec.scala b/modules/core/src/test/scala/sangria/schema/AstSchemaMaterializerSpec.scala
@@ -1121,48 +1121,6 @@ class AstSchemaMaterializerSpec
         query.fields(1).description should be(Some("the second field!"))
       }
 
-      "Support legacy comment-based SDL descriptions" in {
-        val schemaDef =
-          """# fooo bar
-            |# baz
-            |enum MyEnum {
-            |  # value1
-            |  VALUE
-            |
-            |  # value 2
-            |  # line 2
-            |  OLD_VALUE @deprecated
-            |
-            |  # value 3
-            |  OTHER_VALUE @deprecated(reason: "Terrible reasons")
-            |}
-            |
-            |# My super query!
-            |type Query {
-            |  field1: String @deprecated
-            |
-            |  # the second field!
-            |  field2: Int @deprecated(reason: "Because I said so")
-            |  enum: MyEnum
-            |}""".stripMargin
-
-        val schema = Schema.buildFromAst(
-          QueryParser.parse(schemaDef),
-          AstSchemaBuilder.defaultWithLegacyCommentDescriptions)
-
-        val myEnum = schema.inputTypes("MyEnum").asInstanceOf[EnumType[_]]
-
-        myEnum.description should be(Some("fooo bar\nbaz"))
-        myEnum.values(0).description should be(Some("value1"))
-        myEnum.values(1).description should be(Some("value 2\nline 2"))
-        myEnum.values(2).description should be(Some("value 3"))
-
-        val query = schema.outputTypes("Query").asInstanceOf[ObjectType[_, _]]
-
-        query.description should be(Some("My super query!"))
-        query.fields(1).description should be(Some("the second field!"))
-      }
-
       "Use comments for descriptions on arguments" in {
         val schemaDef =
           s"""schema {

diff --git a/modules/core/src/test/scala/sangria/schema/ResolverBasedAstSchemaBuilderSpec.scala b/modules/core/src/test/scala/sangria/schema/ResolverBasedAstSchemaBuilderSpec.scala
@@ -107,7 +107,6 @@ class ResolverBasedAstSchemaBuilderSpec extends AnyWordSpec with Matchers with F
         FieldResolver { case (TypeName("Query"), FieldName("id")) =>
           _ => UUID.fromString("a26bdfd4-0fcf-484f-b363-585091b3319f")
         },
-        LegacyCommentDescriptionsResolver(),
         AnyFieldResolver.defaultInput[Any, JsValue]
       )