Add a special comment to disable the GraphQL intelliJ plugin inspection (#5154)

* Add a special comment to disable the GraphQL intelliJ plugin inspection

* Update libraries/apollo-ast/src/commonMain/kotlin/com/apollographql/apollo3/ast/gqldocument.kt

Co-authored-by: Benoit Lubek <[email protected]>

---------

Co-authored-by: Benoit Lubek <[email protected]>

Author: martinbonnin

libraries/apollo-ast/src/commonMain/kotlin/com/apollographql/apollo3/ast/gql.kt

@@ -727,6 +727,7 @@ class GQLDirectiveDefinition(
         "include",
         "skip",
         "deprecated",
+        "specifiedBy"
     )
   }
 }

libraries/apollo-ast/src/commonMain/kotlin/com/apollographql/apollo3/ast/gqldocument.kt

@@ -6,6 +6,7 @@ import com.apollographql.apollo3.ast.internal.apollo_v0_1_definitionsStr
 import com.apollographql.apollo3.ast.internal.apollo_v0_2_definitionsStr
 import com.apollographql.apollo3.ast.internal.builtinsDefinitionsStr
 import com.apollographql.apollo3.ast.internal.linkDefinitionsStr
+import okio.Buffer
 
 /**
  * Add builtin definitions from the latest spec version to the [GQLDocument]
@@ -47,7 +48,7 @@ fun apolloDefinitions() = definitionsFromString(apollo_v0_1_definitionsStr)
  * Extra apollo specific definitions from https://specs.apollo.dev/kotlin_labs/<[version]>
  */
 fun apolloDefinitions(version: String): List<GQLDefinition> {
-  return definitionsFromString(when(version) {
+  return definitionsFromString(when (version) {
     "v0.1" -> apollo_v0_1_definitionsStr
     "v0.2" -> apollo_v0_2_definitionsStr
     else -> error("Apollo definitions $version are not supported")
@@ -91,7 +92,11 @@ internal enum class ConflictResolution {
   TakeLeft
 }
 
-internal fun combineDefinitions(left: List<GQLDefinition>, right: List<GQLDefinition>, conflictResolution: ConflictResolution): List<GQLDefinition> {
+internal fun combineDefinitions(
+    left: List<GQLDefinition>,
+    right: List<GQLDefinition>,
+    conflictResolution: ConflictResolution,
+): List<GQLDefinition> {
   val mergedDefinitions = left.toMutableList()
 
   right.forEach { builtInTypeDefinition ->
@@ -111,6 +116,7 @@ internal fun combineDefinitions(left: List<GQLDefinition>, right: List<GQLDefini
 
   return mergedDefinitions
 }
+
 private fun GQLDocument.withDefinitions(definitions: List<GQLDefinition>): GQLDocument {
   return copy(
       definitions = combineDefinitions(this.definitions, definitions, ConflictResolution.TakeLeft)
@@ -126,9 +132,33 @@ private fun GQLDocument.withDefinitions(definitions: List<GQLDefinition>): GQLDo
  */
 @ApolloExperimental
 fun GQLDocument.toSDL(indent: String = "  "): String {
-  return this.copy(
-      definitions = definitions.filter {
-        it !is GQLScalarTypeDefinition || it.name !in GQLTypeDefinition.builtInTypes
+  val buffer = Buffer()
+  val writer = SDLWriter(buffer, indent)
+
+  definitions.forEachIndexed { index, definition ->
+    when {
+      definition is GQLScalarTypeDefinition && definition.name in GQLTypeDefinition.builtInTypes -> {
+        // Always skip scalar definitions, it's a must in the spec
+        return@forEachIndexed
       }
-  ).toUtf8(indent)
+
+      definition is GQLTypeDefinition && definition.name in GQLTypeDefinition.builtInTypes ||
+          definition is GQLDirectiveDefinition && definition.name in GQLDirectiveDefinition.builtInDirectives -> {
+        // Tools like the GraphQL intelliJ plugin expect a "server" schema, without builtin types
+        // Suppress the errors for now
+        buffer.writeUtf8("# See https://github.com/JetBrains/js-graphql-intellij-plugin/issues/665\n")
+        buffer.writeUtf8("# noinspection GraphQLTypeRedefinition\n")
+        writer.write(definition)
+
+      }
+
+      else -> {
+        writer.write(definition)
+      }
+    }
+    if (index < definitions.size - 1) {
+      writer.write("\n")
+    }
+  }
+  return buffer.readUtf8()
 }

libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo3/graphql/ast/test/ParserTest.kt

@@ -14,7 +14,7 @@ class ParserTest {
   @Test
   fun parserProducesExpectedValues(@TestParameter(valuesProvider = ParametersProvider::class) graphqlFile: File) {
     checkExpected(graphqlFile) {
-      graphqlFile.parseAsGQLDocument()
+      it.parseAsGQLDocument()
           .issues
           .serialize()
     }
@@ -32,28 +32,6 @@ class ParserTest {
     }
   }
 
-  /**
-   * run the block and checks the result against the .expected file. Will overwrite the result if required
-   *
-   * @param block the callback to produce the result.
-   */
-  fun checkExpected(graphQLFile: File, block: () -> String) {
-    val actual = block()
-
-    val expectedFile = File(graphQLFile.parent, graphQLFile.nameWithoutExtension + ".expected")
-    val expected = try {
-      expectedFile.readText()
-    } catch (e: Exception) {
-      null
-    }
-
-    if (shouldUpdateTestFixtures()) {
-      expectedFile.writeText(actual)
-    } else {
-      assertEquals(expected, actual)
-    }
-  }
-
   companion object {
     private const val separator = "\n------------\n"
 
@@ -77,5 +55,27 @@ class ParserTest {
 
       return Regex(testFilter).containsMatchIn(value)
     }
+
+    /**
+     * run the block and checks the result against the .expected file. Will overwrite the result if required
+     *
+     * @param block the callback to produce the result.
+     */
+    fun checkExpected(graphQLFile: File, block: (File) -> String) {
+      val actual = block(graphQLFile)
+
+      val expectedFile = File(graphQLFile.parent, graphQLFile.nameWithoutExtension + ".expected")
+      val expected = try {
+        expectedFile.readText()
+      } catch (e: Exception) {
+        null
+      }
+
+      if (shouldUpdateTestFixtures()) {
+        expectedFile.writeText(actual)
+      } else {
+        assertEquals(expected, actual)
+      }
+    }
   }
 }

libraries/apollo-ast/src/commonTest/kotlin/com/apollographql/apollo3/graphql/ast/test/SDLWriterTest.kt renamed to libraries/apollo-ast/src/jvmTest/kotlin/com/apollographql/apollo3/graphql/ast/test/SDLWriterTest.kt

@@ -1,48 +1,39 @@
 package com.apollographql.apollo3.graphql.ast.test
 
-import com.apollographql.apollo3.ast.GQLDocument
+import com.apollographql.apollo3.ast.introspection.toSchema
 import com.apollographql.apollo3.ast.parseAsGQLDocument
 import com.apollographql.apollo3.ast.toSDL
+import com.apollographql.apollo3.ast.withBuiltinDefinitions
+import com.apollographql.apollo3.graphql.ast.test.ParserTest.Companion.checkExpected
+import java.io.File
 import kotlin.test.Test
-import kotlin.test.assertEquals
 
 class SDLWriterTest {
   @Test
   fun simpleTest() {
-    val schemaString = """
-      schema {
-          query: Query
-      }
-      
-      type Query {
-          foo: Int
-      }
-      
-      interface A {
-          a: String
-      }
-      
-      interface B {
-          b: String
-      }
-      
-      type C implements A & B {
-          a: String
-      
-          b: String
-      }
-      
-      interface D implements A & B {
-          a: String
-      
-          b: String
-      }
+    val sdlSchema = File("${CWD}/test-fixtures/sdl/simple.graphqls")
 
-    """.trimIndent()
+    checkExpected(sdlSchema) {
+      it.parseAsGQLDocument().getOrThrow().toSDL("    ")
+    }
+  }
+
+  @Test
+  fun typeRedefinitionInspectionIsIgnored() {
+    val sdlSchema = File("${CWD}/test-fixtures/sdl/type_redefinitions.graphqls")
+
+    checkExpected(sdlSchema) {
+      it.parseAsGQLDocument().getOrThrow().withBuiltinDefinitions().toSDL("    ")
+    }
+  }
+
+  @Test
+  fun introspectionSchema() {
+    val sdlSchema = File("${CWD}/test-fixtures/sdl/introspection.json")
 
-    val schema: GQLDocument = schemaString.parseAsGQLDocument().getOrThrow()
-    val sdl = schema.toSDL("    ")
-    assertEquals(schemaString, sdl)
+    checkExpected(sdlSchema) {
+      it.toSchema().toGQLDocument().toSDL("    ")
+    }
   }
 
   @Test