Add schema-transform API (#6450)

martinbonnin · web-flow · commit ae35a9b67914 · 2025-04-07T10:43:20.000+02:00
* add schema-transform API

* fix tests
diff --git a/libraries/apollo-compiler/api/apollo-compiler.api b/libraries/apollo-compiler/api/apollo-compiler.api
@@ -8,10 +8,10 @@ public final class com/apollographql/apollo/compiler/AdapterInitializer$Companio
 
 public final class com/apollographql/apollo/compiler/ApolloCompiler {
 	public static final field INSTANCE Lcom/apollographql/apollo/compiler/ApolloCompiler;
-	public final fun buildCodegenSchema (Ljava/util/List;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;Lcom/apollographql/apollo/compiler/CodegenSchemaOptions;Ljava/util/List;)Lcom/apollographql/apollo/compiler/CodegenSchema;
+	public final fun buildCodegenSchema (Ljava/util/List;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;Lcom/apollographql/apollo/compiler/CodegenSchemaOptions;Ljava/util/List;Lcom/apollographql/apollo/compiler/SchemaTransform;)Lcom/apollographql/apollo/compiler/CodegenSchema;
 	public final fun buildIrOperations (Lcom/apollographql/apollo/compiler/CodegenSchema;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lcom/apollographql/apollo/compiler/IrOptions;Lcom/apollographql/apollo/compiler/DocumentTransform;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;)Lcom/apollographql/apollo/compiler/ir/IrOperations;
 	public final fun buildSchemaAndOperationsSources (Lcom/apollographql/apollo/compiler/CodegenSchema;Ljava/util/List;Lcom/apollographql/apollo/compiler/IrOptions;Lcom/apollographql/apollo/compiler/CodegenOptions;Lcom/apollographql/apollo/compiler/LayoutFactory;Lcom/apollographql/apollo/compiler/OperationOutputGenerator;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/DocumentTransform;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;Ljava/io/File;)Lcom/apollographql/apollo/compiler/codegen/SourceOutput;
-	public final fun buildSchemaAndOperationsSources (Ljava/util/List;Ljava/util/List;Lcom/apollographql/apollo/compiler/CodegenSchemaOptions;Lcom/apollographql/apollo/compiler/IrOptions;Lcom/apollographql/apollo/compiler/CodegenOptions;Lcom/apollographql/apollo/compiler/LayoutFactory;Lcom/apollographql/apollo/compiler/OperationOutputGenerator;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/DocumentTransform;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;Ljava/io/File;)Lcom/apollographql/apollo/compiler/codegen/SourceOutput;
+	public final fun buildSchemaAndOperationsSources (Ljava/util/List;Ljava/util/List;Lcom/apollographql/apollo/compiler/CodegenSchemaOptions;Lcom/apollographql/apollo/compiler/IrOptions;Lcom/apollographql/apollo/compiler/CodegenOptions;Lcom/apollographql/apollo/compiler/LayoutFactory;Lcom/apollographql/apollo/compiler/OperationOutputGenerator;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/DocumentTransform;Lcom/apollographql/apollo/compiler/SchemaTransform;Lcom/apollographql/apollo/compiler/ApolloCompiler$Logger;Ljava/io/File;)Lcom/apollographql/apollo/compiler/codegen/SourceOutput;
 	public final fun buildSchemaAndOperationsSourcesFromIr (Lcom/apollographql/apollo/compiler/CodegenSchema;Lcom/apollographql/apollo/compiler/ir/IrOperations;Lcom/apollographql/apollo/compiler/UsedCoordinates;Ljava/util/List;Lcom/apollographql/apollo/compiler/CodegenOptions;Lcom/apollographql/apollo/compiler/codegen/SchemaAndOperationsLayout;Lcom/apollographql/apollo/compiler/OperationOutputGenerator;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;Ljava/io/File;)Lcom/apollographql/apollo/compiler/codegen/SourceOutput;
 	public final fun buildSchemaSources (Lcom/apollographql/apollo/compiler/CodegenSchema;Lcom/apollographql/apollo/compiler/UsedCoordinates;Lcom/apollographql/apollo/compiler/CodegenOptions;Lcom/apollographql/apollo/compiler/codegen/SchemaLayout;Lcom/apollographql/apollo/compiler/Transform;Lcom/apollographql/apollo/compiler/Transform;)Lcom/apollographql/apollo/compiler/codegen/SourceOutput;
 }
@@ -33,6 +33,7 @@ public abstract interface class com/apollographql/apollo/compiler/ApolloCompiler
 	public fun layout (Lcom/apollographql/apollo/compiler/CodegenSchema;)Lcom/apollographql/apollo/compiler/codegen/SchemaAndOperationsLayout;
 	public fun operationIds (Ljava/util/List;)Ljava/util/List;
 	public fun schemaListener ()Lcom/apollographql/apollo/compiler/SchemaListener;
+	public fun schemaTransform ()Lcom/apollographql/apollo/compiler/SchemaTransform;
 }
 
 public final class com/apollographql/apollo/compiler/ApolloCompilerPluginEnvironment {
@@ -427,6 +428,10 @@ public abstract interface class com/apollographql/apollo/compiler/SchemaListener
 	public abstract fun onSchema (Lcom/apollographql/apollo/ast/Schema;Ljava/io/File;)V
 }
 
+public abstract interface class com/apollographql/apollo/compiler/SchemaTransform {
+	public abstract fun transform (Lcom/apollographql/apollo/ast/GQLDocument;)Lcom/apollographql/apollo/ast/GQLDocument;
+}
+
 public final class com/apollographql/apollo/compiler/StringsKt {
 	public static final fun capitalizeFirstLetter (Ljava/lang/String;)Ljava/lang/String;
 	public static final fun decapitalizeFirstLetter (Ljava/lang/String;)Ljava/lang/String;
diff --git a/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompiler.kt b/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompiler.kt
@@ -61,6 +61,7 @@ object ApolloCompiler {
       logger: Logger?,
       codegenSchemaOptions: CodegenSchemaOptions,
       foreignSchemas: List<ForeignSchema>,
+      schemaTransform: SchemaTransform?,
   ): CodegenSchema {
     val schemaDocuments = schemaFiles.map {
       it.normalizedPath to it.file.toGQLDocument(allowJson = true)
@@ -118,11 +119,15 @@ object ApolloCompiler {
     }
     val scalarExtensions = sdl.toGQLDocument().definitions
 
-    val schemaDocument = GQLDocument(
+    var schemaDocument = GQLDocument(
         definitions = schemaDefinitions + scalarExtensions,
         sourceLocation = null
     )
 
+    if (schemaTransform != null) {
+      schemaDocument = schemaTransform.transform(schemaDocument)
+    }
+
     val result = schemaDocument.validateAsSchema(
         validationOptions = SchemaValidationOptions(
             /**
@@ -475,14 +480,16 @@ object ApolloCompiler {
       javaOutputTransform: Transform<JavaOutput>?,
       kotlinOutputTransform: Transform<KotlinOutput>?,
       documentTransform: DocumentTransform?,
+      schemaTransform: SchemaTransform?,
       logger: Logger?,
       operationManifestFile: File?,
   ): SourceOutput {
     val codegenSchema = buildCodegenSchema(
         schemaFiles = schemaFiles,
         logger = logger,
         codegenSchemaOptions = codegenSchemaOptions,
-        foreignSchemas = emptyList()
+        foreignSchemas = emptyList(),
+        schemaTransform = schemaTransform
     )
 
     return buildSchemaAndOperationsSources(
diff --git a/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompilerPlugin.kt b/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/ApolloCompilerPlugin.kt
@@ -62,6 +62,15 @@ interface ApolloCompilerPlugin {
     return null
   }
 
+  /**
+   * @return a [SchemaTransform] to transform the schema
+   */
+  @ApolloExperimental
+  fun schemaTransform(): SchemaTransform? {
+    return null
+  }
+
+
   /**
    * @return the [Transform] to be applied to [IrOperations] or null to use the default [Transform]
    */
@@ -99,6 +108,15 @@ interface SchemaListener {
   fun onSchema(schema: Schema, outputDirectory: File)
 }
 
+@ApolloExperimental
+interface SchemaTransform {
+  /**
+   * Transforms the given schema document.
+   *
+   * [transform] is called before validation of the schema.
+   */
+  fun transform(schemaDocument: GQLDocument): GQLDocument
+}
 
 /**
  * A [DocumentTransform] transforms operations and fragments at build time. [DocumentTransform] can add or remove fields automatically for an example.
diff --git a/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/entrypoints.kt b/libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/entrypoints.kt
@@ -40,7 +40,8 @@ class EntryPoints {
         schemaFiles = normalizedSchemaFiles.toInputFiles(),
         logger = warning.toLogger(),
         codegenSchemaOptions = codegenSchemaOptionsFile.toCodegenSchemaOptions(),
-        foreignSchemas = plugin?.foreignSchemas().orEmpty()
+        foreignSchemas = plugin?.foreignSchemas().orEmpty(),
+        schemaTransform = plugin?.schemaTransform()
     ).writeTo(codegenSchemaFile)
   }
 
@@ -133,7 +134,8 @@ class EntryPoints {
         schemaFiles = schemaFiles.toInputFiles(),
         codegenSchemaOptions = codegenSchemaOptions.toCodegenSchemaOptions(),
         foreignSchemas = plugin?.foreignSchemas().orEmpty(),
-        logger = warning.toLogger()
+        logger = warning.toLogger(),
+        schemaTransform = plugin?.schemaTransform()
     )
 
     ApolloCompiler.buildSchemaAndOperationsSources(
diff --git a/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/CodegenTest.kt b/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/CodegenTest.kt
@@ -454,7 +454,8 @@ private fun ApolloCompiler.buildSchemaAndOperationsSourcesAndReturnIrOperations(
       schemaFiles = schemaFiles,
       logger = logger,
       codegenSchemaOptions = codegenSchemaOptions,
-      foreignSchemas = emptyList()
+      foreignSchemas = emptyList(),
+      null
   )
 
   val irOperations = buildIrOperations(
diff --git a/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/MetadataTest.kt b/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/MetadataTest.kt
@@ -45,6 +45,7 @@ class MetadataTest {
         logger = null,
         codegenSchemaOptions = codegenSchemaOptionsFile.toCodegenSchemaOptions(),
         foreignSchemas = emptyList(),
+        null
     ).writeTo(codegenSchemaFile)
 
     ApolloCompiler.buildIrOperations(
diff --git a/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/conditionalFragments/ConditionalFragmentsTest.kt b/libraries/apollo-compiler/src/test/kotlin/com/apollographql/apollo/compiler/conditionalFragments/ConditionalFragmentsTest.kt
@@ -39,6 +39,7 @@ class ConditionalFragmentsTest {
           javaOutputTransform = null,
           kotlinOutputTransform = null,
           documentTransform = null,
+          schemaTransform = null
       )
     }
 
@@ -61,6 +62,7 @@ class ConditionalFragmentsTest {
         javaOutputTransform = null,
         kotlinOutputTransform = null,
         documentTransform = null,
+        schemaTransform = null
     )
   }
 }
diff --git a/libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo/gradle/internal/ApolloGenerateSourcesTask.kt b/libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo/gradle/internal/ApolloGenerateSourcesTask.kt
@@ -52,7 +52,8 @@ abstract class ApolloGenerateSourcesTask : ApolloGenerateSourcesBaseTask() {
           schemaFiles = schemaInputFiles,
           codegenSchemaOptions = codegenSchemaOptionsFile.get().asFile.toCodegenSchemaOptions(),
           foreignSchemas = emptyList(),
-          logger = logger()
+          logger = logger(),
+          schemaTransform = null
       )
       ApolloCompiler.buildSchemaAndOperationsSources(
           codegenSchema = codegenSchema,
diff --git a/tests/schema-transform/app/build.gradle.kts b/tests/schema-transform/app/build.gradle.kts
@@ -0,0 +1,24 @@
+@file:OptIn(ApolloExperimental::class)
+
+import com.apollographql.apollo.annotations.ApolloExperimental
+import com.apollographql.apollo.compiler.MODELS_RESPONSE_BASED
+
+plugins {
+  id("org.jetbrains.kotlin.jvm")
+  id("com.apollographql.apollo")
+}
+
+apolloTest()
+
+dependencies {
+  implementation(libs.apollo.runtime)
+  testImplementation(libs.kotlin.test)
+  testImplementation(libs.junit)
+}
+
+apollo {
+  service("service") {
+    packageName.set("com.example")
+    plugin(project(":schema-transform-plugin")) {}
+  }
+}
diff --git a/tests/schema-transform/app/src/main/graphql/operation.graphql b/tests/schema-transform/app/src/main/graphql/operation.graphql
@@ -0,0 +1,13 @@
+query GetAll {
+  node {
+    id
+  }
+  product {
+    id
+    price
+  }
+  review {
+    id
+    stars
+  }
+}
diff --git a/tests/schema-transform/app/src/main/graphql/schema.graphqls b/tests/schema-transform/app/src/main/graphql/schema.graphqls
@@ -0,0 +1,22 @@
+extend schema @link(url: "https://specs.apollo.dev/nullability/v0.4", import: ["@catchByDefault", "@semanticNonNull"])
+extend schema @catchByDefault(to: THROW)
+
+type Query {
+  node: Node
+  product: Product
+  review: Review
+}
+
+interface Node {
+  id:ID @semanticNonNull
+}
+
+type Product implements Node {
+  id: ID
+  price: Float
+}
+
+type Review implements Node {
+  id: ID
+  stars: Int
+}
diff --git a/tests/schema-transform/app/src/test/kotlin/test/MainTest.kt b/tests/schema-transform/app/src/test/kotlin/test/MainTest.kt
@@ -0,0 +1,17 @@
+package test
+
+import com.example.GetAllQuery
+import org.junit.Test
+
+class MainTest {
+  // No assertion, we just check the shape of the codegen
+  fun stuff(
+      node: GetAllQuery.Node,
+      product: GetAllQuery.Product,
+      review: GetAllQuery.Review
+  ) {
+    node.id.length
+    product.id.length
+    review.id.length
+  }
+}
diff --git a/tests/schema-transform/plugin/build.gradle.kts b/tests/schema-transform/plugin/build.gradle.kts
@@ -0,0 +1,10 @@
+plugins {
+  id("org.jetbrains.kotlin.jvm")
+}
+
+apolloTest()
+
+dependencies {
+  implementation(libs.apollo.compiler)
+  implementation(libs.apollo.ast)
+}
diff --git a/tests/schema-transform/plugin/src/main/kotlin/com/example/TestPlugin.kt b/tests/schema-transform/plugin/src/main/kotlin/com/example/TestPlugin.kt
@@ -0,0 +1,112 @@
+package com.example
+
+import com.apollographql.apollo.ast.GQLDefinition
+import com.apollographql.apollo.ast.GQLDocument
+import com.apollographql.apollo.ast.GQLFieldDefinition
+import com.apollographql.apollo.ast.GQLInterfaceTypeDefinition
+import com.apollographql.apollo.ast.GQLObjectTypeDefinition
+import com.apollographql.apollo.ast.SourceAwareException
+import com.apollographql.apollo.ast.toUtf8
+import com.apollographql.apollo.compiler.ApolloCompilerPlugin
+import com.apollographql.apollo.compiler.ApolloCompilerPluginEnvironment
+import com.apollographql.apollo.compiler.ApolloCompilerPluginProvider
+import com.apollographql.apollo.compiler.SchemaTransform
+
+class TestPluginProvider : ApolloCompilerPluginProvider {
+  override fun create(environment: ApolloCompilerPluginEnvironment): ApolloCompilerPlugin {
+    return TestPlugin()
+  }
+}
+
+private class TraversalState(
+    val originalInterfaces: Map<String, GQLInterfaceTypeDefinition>,
+) {
+  val visitedInterfaces = mutableMapOf<String, GQLInterfaceTypeDefinition>()
+  val definitions = mutableListOf<GQLDefinition>()
+}
+
+private fun traverse(definition: GQLDefinition, state: TraversalState) {
+  when (definition) {
+    is GQLObjectTypeDefinition -> {
+      var patchedFields = definition.fields
+      definition.implementsInterfaces.forEach {
+        var superInterface = state.visitedInterfaces.get(it)
+        if (superInterface == null) {
+          traverse(state.originalInterfaces.get(it) as GQLInterfaceTypeDefinition, state)
+          superInterface = state.visitedInterfaces.get(it)!!
+        }
+
+        val fieldsByName = superInterface.fields.associateBy { it.name }
+        patchedFields = patchedFields.patch(fieldsByName)
+      }
+      val patchedDefinition = definition.copy(fields = patchedFields)
+      state.definitions.add(patchedDefinition)
+    }
+    is GQLInterfaceTypeDefinition -> {
+      if (state.visitedInterfaces.containsKey(definition.name)) {
+        return
+      }
+      var patchedFields = definition.fields
+      definition.implementsInterfaces.forEach {
+        var superInterface = state.visitedInterfaces.get(it)
+        if (superInterface == null) {
+          traverse(state.originalInterfaces.get(it) as GQLInterfaceTypeDefinition, state)
+          superInterface = state.visitedInterfaces.get(it)!!
+        }
+
+        val fieldsByName = superInterface.fields.associateBy { it.name }
+        patchedFields = patchedFields.patch(fieldsByName)
+      }
+      val patchedDefinition = definition.copy(fields = patchedFields)
+      state.visitedInterfaces.put(definition.name, patchedDefinition)
+      state.definitions.add(patchedDefinition)
+    }
+    else -> {
+      state.definitions.add(definition)
+    }
+  }
+}
+
+private fun List<GQLFieldDefinition>.patch(superFields: Map<String, GQLFieldDefinition>): List<GQLFieldDefinition> {
+  return map { fieldDefinition ->
+    val superField = superFields.get(fieldDefinition.name)
+    if (superField == null) {
+      return@map fieldDefinition
+    }
+
+    val superSemanticNonNull = superField.directives.firstOrNull { it.name == "semanticNonNull" }
+    if (superSemanticNonNull == null) {
+      return@map fieldDefinition
+    }
+
+    val selfSemanticNonNull = fieldDefinition.directives.firstOrNull { it.name == "semanticNonNull" }
+    if (selfSemanticNonNull == null) {
+      return@map fieldDefinition.copy(directives = fieldDefinition.directives + superSemanticNonNull)
+    }
+
+    val superStr = superSemanticNonNull.toUtf8()
+    val selfStr = selfSemanticNonNull.toUtf8()
+    if(superStr != selfStr) {
+      throw SourceAwareException("The @semanticNonNull directive doesn't match the super field directive (expected '$superStr')", selfSemanticNonNull.sourceLocation)
+    }
+
+    return@map fieldDefinition
+  }
+
+}
+
+class TestPlugin : ApolloCompilerPlugin {
+  override fun schemaTransform(): SchemaTransform? {
+    return object : SchemaTransform {
+      override fun transform(schemaDocument: GQLDocument): GQLDocument {
+        val state = TraversalState(schemaDocument.definitions.filterIsInstance<GQLInterfaceTypeDefinition>().associateBy { it.name })
+
+        schemaDocument.definitions.forEach {
+          traverse(it, state)
+        }
+
+        return GQLDocument(state.definitions, null)
+      }
+    }
+  }
+}
diff --git a/tests/schema-transform/plugin/src/main/resources/META-INF/services/com.apollographql.apollo.compiler.ApolloCompilerPluginProvider b/tests/schema-transform/plugin/src/main/resources/META-INF/services/com.apollographql.apollo.compiler.ApolloCompilerPluginProvider
@@ -0,0 +1 @@
+com.example.TestPluginProvider

Original file line number	Diff line number	Diff line change
`@@ -454,7 +454,8 @@ private fun ApolloCompiler.buildSchemaAndOperationsSourcesAndReturnIrOperations(`
`454`	`454`	`schemaFiles = schemaFiles,`
`455`	`455`	`logger = logger,`
`456`	`456`	`codegenSchemaOptions = codegenSchemaOptions,`
`457`		`- foreignSchemas = emptyList()`
	`457`	`+ foreignSchemas = emptyList(),`
	`458`	`+ null`
`458`	`459`	`)`
`459`	`460`
`460`	`461`	`val irOperations = buildIrOperations(`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ class ConditionalFragmentsTest {`
`39`	`39`	`javaOutputTransform = null,`
`40`	`40`	`kotlinOutputTransform = null,`
`41`	`41`	`documentTransform = null,`
	`42`	`+ schemaTransform = null`
`42`	`43`	`)`
`43`	`44`	`}`
`44`	`45`
`@@ -61,6 +62,7 @@ class ConditionalFragmentsTest {`
`61`	`62`	`javaOutputTransform = null,`
`62`	`63`	`kotlinOutputTransform = null,`
`63`	`64`	`documentTransform = null,`
	`65`	`+ schemaTransform = null`
`64`	`66`	`)`
`65`	`67`	`}`
`66`	`68`	`}`