[client] add @generated annotation (ExpediaGroup#1251)

* [client] add auto @generated annotation

Update client generation logic to automatically apply `@com.expediagroup.graphql.client.Generated` annotation to all auto-generated classes. This doesn't change any functionality but is a meta-information for JaCoCo to automatically exclude those classes from coverage reports.

* update docs

* unit tests

* fix formatting

Author: dariuszkuc

clients/graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/Generated.kt

@@ -0,0 +1,12 @@
+package com.expediagroup.graphql.client
+
+/**
+ * Annotation to automatically exclude auto-generated client code from JaCoCo reports.
+ *
+ * Starting with JaCoCo 8.3, classes and methods annotated with `@Generated` annotation that has RUNTIME retention will be excluded from
+ * code coverage report. We are using custom annotation instead of `javax.annotation.Generated` or `javax.annotation.processing.Generated`
+ * as their retention policy is just SOURCE.
+ */
+@Target(allowedTargets = [AnnotationTarget.CLASS])
+@Retention(value = AnnotationRetention.RUNTIME)
+annotation class Generated

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/GraphQLClientGenerator.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.exceptions.MultipleOperationsInFileException
 import com.expediagroup.graphql.plugin.client.generator.exceptions.SchemaUnavailableException
 import com.expediagroup.graphql.plugin.client.generator.types.generateGraphQLObjectTypeSpec
@@ -120,6 +121,7 @@ class GraphQLClientGenerator(
             val kotlinResultTypeName = ClassName(context.packageName, "${context.operationName}.${graphQLResponseTypeSpec.name}")
 
             val operationTypeSpec = TypeSpec.classBuilder(capitalizedOperationName)
+                .addAnnotation(Generated::class)
                 .addSuperinterface(ClassName(CORE_TYPES_PACKAGE, "GraphQLClientRequest").parameterizedBy(kotlinResultTypeName))
 
             var queryProperty: PropertySpec = PropertySpec.builder("query", STRING, KModifier.OVERRIDE)

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateGraphQLCustomScalarConverters.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.expediagroup.graphql.plugin.client.generator.ScalarConverterInfo
@@ -69,6 +70,7 @@ private fun generateGraphQLCustomScalarJacksonConverters(
     val serializeConverterName = "${customScalarName}ToAnyConverter"
     val serializerConverterTypeSpec = TypeSpec.classBuilder(serializeConverterName)
         .superclass(StdConverter::class.asTypeName().parameterizedBy(scalarClassName, ANY))
+        .addAnnotation(Generated::class)
         .addProperty(converter)
         .addFunction(
             FunSpec.builder("convert")
@@ -83,6 +85,7 @@ private fun generateGraphQLCustomScalarJacksonConverters(
     val deserializeConverterName = "AnyTo${customScalarName}Converter"
     val deserializerConverterTypeSpec = TypeSpec.classBuilder(deserializeConverterName)
         .superclass(StdConverter::class.asTypeName().parameterizedBy(ANY, scalarClassName))
+        .addAnnotation(Generated::class)
         .addProperty(converter)
         .addFunction(
             FunSpec.builder("convert")
@@ -110,6 +113,7 @@ private fun generateGraphQLCustomScalarKSerializer(
     val serializerName = "${customScalarName}Serializer"
     val serializerTypeSpec = TypeSpec.objectBuilder(serializerName)
         .addSuperinterface(KSerializer::class.asTypeName().parameterizedBy(scalarClassName))
+        .addAnnotation(Generated::class)
 
     val converter = PropertySpec.builder("converter", converterClassName)
         .initializer("%T()", converterClassName)

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateGraphQLEnumTypeSpec.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.fasterxml.jackson.annotation.JsonEnumDefaultValue
@@ -35,6 +36,7 @@ internal const val UNKNOWN_VALUE = "__UNKNOWN_VALUE"
  */
 internal fun generateGraphQLEnumTypeSpec(context: GraphQLClientGeneratorContext, enumDefinition: EnumTypeDefinition): TypeSpec {
     val enumTypeSpecBuilder = TypeSpec.enumBuilder(enumDefinition.name)
+        .addAnnotation(Generated::class)
     enumDefinition.description?.content?.let { kdoc ->
         enumTypeSpecBuilder.addKdoc("%L", kdoc)
     }

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateGraphQLInputObjectTypeSpec.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.squareup.kotlinpoet.ClassName
@@ -37,6 +38,7 @@ import kotlinx.serialization.Serializable
 internal fun generateGraphQLInputObjectTypeSpec(context: GraphQLClientGeneratorContext, inputObjectDefinition: InputObjectTypeDefinition): TypeSpec {
     val inputObjectTypeSpecBuilder = TypeSpec.classBuilder(inputObjectDefinition.name)
         .addModifiers(KModifier.DATA)
+        .addAnnotation(Generated::class)
     inputObjectDefinition.description?.content?.let { kdoc ->
         inputObjectTypeSpecBuilder.addKdoc("%L", kdoc)
     }

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateGraphQLObjectTypeSpec.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.expediagroup.graphql.plugin.client.generator.exceptions.InvalidSelectionSetException
@@ -47,6 +48,7 @@ internal fun generateGraphQLObjectTypeSpec(
     val typeName = objectNameOverride ?: objectDefinition.name
     val objectTypeSpecBuilder = TypeSpec.classBuilder(typeName)
         .addModifiers(KModifier.DATA)
+        .addAnnotation(Generated::class)
     objectDefinition.description?.content?.let { kdoc ->
         objectTypeSpecBuilder.addKdoc("%L", kdoc)
     }

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateInterfaceTypeSpec.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.expediagroup.graphql.plugin.client.generator.exceptions.InvalidFragmentException
@@ -63,10 +64,13 @@ internal fun generateInterfaceTypeSpec(
     val interfaceTypeSpec = if (context.serializer == GraphQLSerializer.KOTLINX) {
         TypeSpec.classBuilder(interfaceName)
             .addModifiers(KModifier.SEALED)
+            .addAnnotation(Generated::class)
             .addAnnotation(Serializable::class)
     } else {
         TypeSpec.interfaceBuilder(interfaceName)
+            .addAnnotation(Generated::class)
     }
+
     if (kdoc != null) {
         interfaceTypeSpec.addKdoc("%L", kdoc)
     }
@@ -181,18 +185,14 @@ private fun updateImplementationTypeSpecWithSuperInformation(
     val commonPropertyNames = commonProperties.map { it.name }
     val implementationTypeSpec = context.typeSpecs[implementationClassName]!!
 
-    val builder = TypeSpec.classBuilder(implementationTypeSpec.name!!)
-        .addModifiers(implementationTypeSpec.modifiers)
-        .addKdoc("%L", implementationTypeSpec.kdoc)
-
+    val builder = implementationTypeSpec.toBuilder()
     val superClassName = ClassName("${context.packageName}.${context.operationName.lowercase()}", interfaceName)
     if (context.serializer == GraphQLSerializer.KOTLINX) {
-        builder.addAnnotation(Serializable::class)
-            .addAnnotation(
-                AnnotationSpec.builder(SerialName::class)
-                    .addMember("value = %S", implementationName)
-                    .build()
-            )
+        builder.addAnnotation(
+            AnnotationSpec.builder(SerialName::class)
+                .addMember("value = %S", implementationName)
+                .build()
+        )
             .superclass(superClassName)
     } else {
         builder.addSuperinterface(superClassName)

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/types/generateVariableTypeSpec.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.client.generator.types
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.plugin.client.generator.GraphQLClientGeneratorContext
 import com.expediagroup.graphql.plugin.client.generator.GraphQLSerializer
 import com.squareup.kotlinpoet.FunSpec
@@ -32,6 +33,7 @@ import kotlinx.serialization.Serializable
 internal fun generateVariableTypeSpec(context: GraphQLClientGeneratorContext, variableDefinitions: List<VariableDefinition>): TypeSpec? {
     val variableTypeSpec = TypeSpec.classBuilder("Variables")
         .addModifiers(KModifier.DATA)
+        .addAnnotation(Generated::class)
     if (context.serializer == GraphQLSerializer.KOTLINX) {
         variableTypeSpec.addAnnotation(Serializable::class)
     }

plugins/client/graphql-kotlin-client-generator/src/test/data/generator/alias/AliasQuery.kt

@@ -1,5 +1,6 @@
 package com.expediagroup.graphql.generated
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import kotlin.Boolean
 import kotlin.String
@@ -8,13 +9,15 @@ import kotlin.reflect.KClass
 public const val ALIAS_QUERY: String =
     "query AliasQuery {\n  first: inputObjectQuery(criteria: { min: 1.0, max: 5.0 } )\n  second: inputObjectQuery(criteria: { min: 5.0, max: 10.0 } )\n}"
 
+@Generated
 public class AliasQuery : GraphQLClientRequest<AliasQuery.Result> {
   public override val query: String = ALIAS_QUERY
 
   public override val operationName: String = "AliasQuery"
 
   public override fun responseType(): KClass<AliasQuery.Result> = AliasQuery.Result::class
 
+  @Generated
   public data class Result(
     /**
      * Query that accepts some input arguments

plugins/client/graphql-kotlin-client-generator/src/test/data/generator/documentation/DocumentationQuery.kt

@@ -1,5 +1,6 @@
 package com.expediagroup.graphql.generated
 
+import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.types.GraphQLClientRequest
 import com.expediagroup.graphql.generated.documentationquery.DocObject
 import kotlin.String
@@ -8,6 +9,7 @@ import kotlin.reflect.KClass
 public const val DOCUMENTATION_QUERY: String =
     "query DocumentationQuery {\n  docQuery {\n    id\n  }\n}"
 
+@Generated
 public class DocumentationQuery : GraphQLClientRequest<DocumentationQuery.Result> {
   public override val query: String = DOCUMENTATION_QUERY
 
@@ -16,6 +18,7 @@ public class DocumentationQuery : GraphQLClientRequest<DocumentationQuery.Result
   public override fun responseType(): KClass<DocumentationQuery.Result> =
       DocumentationQuery.Result::class
 
+  @Generated
   public data class Result(
     /**
      * Query to test doc strings