Add GraphQLIgnore annotation

Add GraphQLIgnore to be able to ignore fields, classes and interfaces

Author: oas004

apollo-execution-processor/src/main/kotlin/com/apollographql/execution/processor/ApolloProcessor.kt

@@ -23,14 +23,14 @@ class ApolloProcessor(
   private fun getRootSymbol(resolver: Resolver, annotationName: String): KSClassDeclaration? {
     val ret = getSymbolsWithAnnotation(resolver, annotationName).toList()
 
-    if (ret.size > 1) {
+    if (ret.size > 1  && annotationName != KotlinSymbols.GraphQLIgnore.canonicalName) {
       val locations = ret.map { it.location }.joinToString("\n")
       logger.error("There can be only one '$annotationName' annotated class, found ${ret.size}:\n$locations", ret.first())
       return null
     }
 
     ret.forEach {
-      if (it !is KSClassDeclaration || it.isAbstract()) {
+      if ((it !is KSClassDeclaration || it.isAbstract()) && annotationName != KotlinSymbols.GraphQLIgnore.canonicalName) {
         logger.error("'$annotationName' cannot be set on node $it", it)
         return null
       }
@@ -53,6 +53,7 @@ class ApolloProcessor(
     done = true
 
     val query = getRootSymbol(resolver, KotlinSymbols.GraphQLQuery.canonicalName)
+
     if (query == null) {
       logger.error("No '@GraphQLQuery' class found")
       return emptyList()

apollo-execution-processor/src/main/kotlin/com/apollographql/execution/processor/codegen/KotlinSymbols.kt

@@ -21,6 +21,7 @@ internal object KotlinSymbols {
   val GraphQLQuery = ClassName(annotationPackageName, "GraphQLQuery")
   val GraphQLMutation = ClassName(annotationPackageName, "GraphQLMutation")
   val GraphQLSubscription = ClassName(annotationPackageName, "GraphQLSubscription")
+  val GraphQLIgnore = ClassName(annotationPackageName, "GraphQLIgnore")
 
   val AstDocument = ClassName(apolloAstPackageName, "GQLDocument")
   val AstScalarTypeDefinition = ClassName(apolloAstPackageName, "GQLScalarTypeDefinition")

apollo-execution-processor/src/main/kotlin/com/apollographql/execution/processor/definitions.kt

@@ -1,6 +1,7 @@
 package com.apollographql.execution.processor
 
 import com.apollographql.apollo.ast.*
+import com.apollographql.execution.processor.codegen.KotlinSymbols.GraphQLIgnore
 import com.apollographql.execution.processor.sir.*
 import com.apollographql.execution.processor.sir.Instantiation
 import com.apollographql.execution.processor.sir.SirArgumentDefinition
@@ -19,10 +20,7 @@ import com.apollographql.execution.processor.sir.SirObjectDefinition
 import com.apollographql.execution.processor.sir.SirType
 import com.apollographql.execution.processor.sir.SirTypeDefinition
 import com.apollographql.execution.processor.sir.SirUnionDefinition
-import com.google.devtools.ksp.getAllSuperTypes
-import com.google.devtools.ksp.getDeclaredProperties
-import com.google.devtools.ksp.isConstructor
-import com.google.devtools.ksp.isPublic
+import com.google.devtools.ksp.*
 import com.google.devtools.ksp.processing.KSPLogger
 import com.google.devtools.ksp.symbol.*
 
@@ -41,7 +39,7 @@ internal fun doTraversal(
 }
 
 private class TypeDefinitionContext(
-  val logger: KSPLogger,
+  val logger: KSPLogger
 ) {
   /**
    * key is qualifiedName
@@ -172,11 +170,6 @@ private class TypeDefinitionContext(
     }
     usedTypeNames.add(name)
 
-    if (declaration.typeParameters.isNotEmpty()) {
-      logger.error("Generic classes are not supported")
-      return null
-    }
-
     if (declaration is KSTypeAlias) {
       return declaration.toSirScalarDefinition(qualifiedName)
     }
@@ -378,10 +371,13 @@ private class TypeDefinitionContext(
       logger.error("Cannot map to a GraphQL output type", this)
       return null
     }
-
     val usedNames = mutableSetOf<String>()
     val allFields = declarations.filter { it.isPublic() }.mapNotNull {
       val name = it.graphqlName()
+      val hasIsIgnoreAnnotation = this.annotations.any {
+        it.annotationType.resolve().declaration.qualifiedName?.asString() == "com.apollographql.execution.annotation.GraphQLIgnore"
+      }
+      if (hasIsIgnoreAnnotation) return@mapNotNull null
       if (usedNames.contains(name)) {
         logger.error("Duplicate field '$name'. Either rename the declaration or use @GraphQLName.", it)
         return@mapNotNull null
@@ -435,7 +431,10 @@ private class TypeDefinitionContext(
 
       ClassKind.INTERFACE -> {
         if (!modifiers.contains(Modifier.SEALED)) {
-          logger.error("Interfaces and unions must be sealed interfaces", this)
+          logger.error(
+            "Interfaces and unions must be sealed interfaces or you can use @GraphQLIgnore to ignore the interface generation",
+            this
+          )
           return null
         }
 
@@ -503,10 +502,11 @@ private class TypeDefinitionContext(
   private fun KSClassDeclaration.interfaces(objectName: String?): List<String> {
     return getAllSuperTypes().mapNotNull {
       val declaration = it.declaration
-      if (it.arguments.isNotEmpty()) {
-        logger.error("Generic interfaces are not supported", this)
-        null
-      } else if (declaration is KSClassDeclaration) {
+      val hasIsIgnoreAnnotation = this.annotations.any {
+        it.annotationType.resolve().declaration.qualifiedName?.asString() == "com.apollographql.execution.annotation.GraphQLIgnore"
+      }
+      if (hasIsIgnoreAnnotation) return@mapNotNull null
+      if (declaration is KSClassDeclaration) {
         if (declaration.asClassName().asString() == "kotlin.Any") {
           // kotlin.Any is a super type of everything, just ignore it
           null

apollo-execution-runtime/src/commonMain/kotlin/com/apollographql/execution/annotation/GraphQLIgnore.kt

@@ -0,0 +1,5 @@
+package com.apollographql.execution.annotation
+
+@Retention(AnnotationRetention.SOURCE)
+@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY)
+annotation class GraphQLIgnore

tests/federation/src/main/kotlin/graphql.kt

@@ -1,11 +1,18 @@
 import com.apollographql.execution.annotation.GraphQLQuery
+import com.apollographql.execution.annotation.GraphQLIgnore
 import com.apollographql.execution.subgraph.GraphQLKey
 
+@GraphQLIgnore
+interface SomeGenericInterface<T>
+
 @GraphQLQuery
-class Query {
+class Query : SomeGenericInterface<String>{
   fun products(): List<Product> {
     return products
   }
+
+  @GraphQLIgnore
+  fun internalFields(): Int = 1
 }
 
 class Product(
@@ -23,4 +30,4 @@ class Product(
 val products = listOf(
   Product("1", "foo"),
   Product("2", "bar")
-)
+)