[⚙️compiler] Remove OperationOutputGenerator from the Plugin API

libraries/apollo-compiler/api/apollo-compiler.api

@@ -365,7 +365,7 @@ public abstract interface class com/apollographql/apollo3/compiler/Plugin {
 	public fun javaOutputTransform ()Lcom/apollographql/apollo3/compiler/Transform;
 	public fun kotlinOutputTransform ()Lcom/apollographql/apollo3/compiler/Transform;
 	public fun layout (Lcom/apollographql/apollo3/compiler/CodegenSchema;)Lcom/apollographql/apollo3/compiler/codegen/SchemaAndOperationsLayout;
-	public fun operationOutputGenerator ()Lcom/apollographql/apollo3/compiler/OperationOutputGenerator;
+	public fun operationIds (Ljava/util/List;)Ljava/util/List;
 }
 
 public final class com/apollographql/apollo3/compiler/RuntimeAdapterInitializer : com/apollographql/apollo3/compiler/AdapterInitializer {
@@ -759,8 +759,10 @@ public final class com/apollographql/apollo3/compiler/operationoutput/OperationD
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }
 
-public final class com/apollographql/apollo3/compiler/operationoutput/OperationOutputKt {
-	public static final fun findOperationId (Ljava/util/Map;Ljava/lang/String;)Ljava/lang/String;
+public final class com/apollographql/apollo3/compiler/operationoutput/OperationId {
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
+	public final fun getId ()Ljava/lang/String;
+	public final fun getName ()Ljava/lang/String;
 }
 
 public final class com/apollographql/apollo3/compiler/pqm/PersistedQueryManifest {

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/ApolloCompiler.kt

@@ -365,7 +365,7 @@ object ApolloCompiler {
       upstreamCodegenMetadata: List<CodegenMetadata>,
       codegenOptions: CodegenOptions,
       layout: SchemaAndOperationsLayout?,
-      operationOutputGenerator: OperationOutputGenerator?,
+      @Suppress("DEPRECATION") operationOutputGenerator: OperationOutputGenerator?,
       irOperationsTransform: Transform<IrOperations>?,
       javaOutputTransform: Transform<JavaOutput>?,
       kotlinOutputTransform: Transform<KotlinOutput>?,
@@ -464,7 +464,7 @@ object ApolloCompiler {
       irOptions: IrOptions,
       codegenOptions: CodegenOptions,
       layoutFactory: LayoutFactory?,
-      operationOutputGenerator: OperationOutputGenerator?,
+      @Suppress("DEPRECATION") operationOutputGenerator: OperationOutputGenerator?,
       irOperationsTransform: Transform<IrOperations>?,
       javaOutputTransform: Transform<JavaOutput>?,
       kotlinOutputTransform: Transform<KotlinOutput>?,
@@ -510,6 +510,7 @@ object ApolloCompiler {
       packageName: String,
       serviceName: String,
   ): SourceOutput {
+    @Suppress("DEPRECATION")
     val layout = LayoutImpl(
         codegenSchema = codegenSchema,
         packageNameGenerator = PackageNameGenerator.Flat(packageName),

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/OperationOutputGenerator.kt

@@ -1,5 +1,6 @@
 package com.apollographql.apollo3.compiler
 
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import com.apollographql.apollo3.compiler.operationoutput.OperationDescriptor
 import com.apollographql.apollo3.compiler.operationoutput.OperationOutput
 
@@ -10,6 +11,9 @@ import com.apollographql.apollo3.compiler.operationoutput.OperationOutput
  *
  * If you don't need batch compute, use [OperationOutputGenerator.Default]
  */
+@Suppress("DEPRECATION")
+@Deprecated("Use Apollo compiler plugins instead")
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
 interface OperationOutputGenerator {
   /**
    * Generate

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/PackageNameGenerator.kt

@@ -1,12 +1,15 @@
 package com.apollographql.apollo3.compiler
 
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import java.io.File
 
 /**
  * A [PackageNameGenerator] computes the package name for a given file. Files can be either
  * - executable files containing operations and fragments
  * - schema files containing type definitions or introspection json
  */
+@Deprecated("Use Apollo compiler plugins instead")
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
 interface PackageNameGenerator {
   /**
    * This will be called with

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/Plugin.kt

@@ -4,6 +4,8 @@ import com.apollographql.apollo3.compiler.codegen.SchemaAndOperationsLayout
 import com.apollographql.apollo3.compiler.codegen.java.JavaOutput
 import com.apollographql.apollo3.compiler.codegen.kotlin.KotlinOutput
 import com.apollographql.apollo3.compiler.ir.IrOperations
+import com.apollographql.apollo3.compiler.operationoutput.OperationDescriptor
+import com.apollographql.apollo3.compiler.operationoutput.OperationId
 
 /**
  * Entry point for customizing the behaviour of the Apollo Compiler besides the
@@ -19,9 +21,11 @@ interface Plugin {
   }
 
   /**
-   * @return the [OperationOutputGenerator] or null to use the default [OperationOutputGenerator]
+   * Computes operation ids for persisted queries.
+   *
+   * @return a list of [OperationId] matching an operation name to its id or null to use the SHA256 default
    */
-  fun operationOutputGenerator(): OperationOutputGenerator? {
+  fun operationIds(descriptors: List<OperationDescriptor>): List<OperationId>? {
     return null
   }
 

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/codegen/LayoutImpl.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.apollographql.apollo3.compiler.codegen
 
 import com.apollographql.apollo3.annotations.ApolloInternal

libraries/apollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/operationoutput/OperationOutput.kt

@@ -5,21 +5,35 @@ import kotlinx.serialization.Serializable
 /**
  * [OperationOutput] is a map where the operationId is the key and [OperationDescriptor] the value
  *
- * By default the operationId is a sha256 but it can be changed for custom whitelisting implementations
+ * By default, the operationId is a sha256. It can be changed for custom whitelisting/persisted queries implementations.
  */
 typealias OperationOutput = Map<String, OperationDescriptor>
 
 /**
- * This structure is also generated by other tools (iOS, cli, ...), try to keep the field names if possible.
+ * A description of an operation to compute an id from
  */
 @Serializable
 class OperationDescriptor(
+    /**
+     * The name of the operation
+     */
     val name: String,
+    /**
+     * The source of the operation as it is sent over the wire, including fragments
+     */
     val source: String,
+    /**
+     * The type of the operation. One of "query", "mutation", "subscription"
+     */
     val type: String
 )
 
-fun OperationOutput.findOperationId(name: String): String {
+/**
+ * The id of an operation associated with its name so that it can be looked up.
+ */
+class OperationId(val id: String, val name: String)
+
+internal fun OperationOutput.findOperationId(name: String): String {
   val id = entries.find { it.value.name == name }?.key
   check(id != null) {
     "cannot find operation ID for '$name', check your operationOutput.json"

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo3/gradle/api/Service.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.apollographql.apollo3.gradle.api
 
 import com.android.build.gradle.api.BaseVariant
@@ -268,6 +270,9 @@ interface Service {
    *
    * Default value: [OperationIdGenerator.Sha256]
    */
+  @Suppress("DEPRECATION")
+  @Deprecated("Use Apollo compiler plugins instead")
+  @ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
   val operationOutputGenerator: Property<OperationOutputGenerator>
 
   /**
@@ -296,6 +301,8 @@ interface Service {
    *
    * @see [packageName]
    */
+  @Deprecated("Use Apollo compiler plugins instead")
+  @ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
   val packageNameGenerator: Property<PackageNameGenerator>
 
   /**

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo3/gradle/internal/ApolloGenerateSourcesFromIrTask.kt

@@ -109,7 +109,7 @@ private abstract class GenerateSourcesFromIr : WorkAction<GenerateSourcesFromIrP
           javaOutputTransform = plugin?.javaOutputTransform(),
           kotlinOutputTransform = plugin?.kotlinOutputTransform(),
           operationManifestFile = operationManifestFile.orNull?.asFile,
-          operationOutputGenerator = plugin?.operationOutputGenerator()
+          operationOutputGenerator = plugin?.toOperationOutputGenerator()
       ).writeTo(outputDir.get().asFile, true, metadataOutputFile.orNull?.asFile)
     }
   }

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo3/gradle/internal/ApolloGenerateSourcesTask.kt

@@ -116,7 +116,7 @@ private abstract class GenerateSources : WorkAction<GenerateSourcesParameters> {
               return plugin?.layout(codegenSchema)
             }
           },
-          operationOutputGenerator = plugin?.operationOutputGenerator(),
+          operationOutputGenerator = plugin?.toOperationOutputGenerator(),
           irOperationsTransform = plugin?.irOperationsTransform(),
           javaOutputTransform = plugin?.javaOutputTransform(),
           kotlinOutputTransform = plugin?.kotlinOutputTransform(),

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo3/gradle/internal/DefaultApolloExtension.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.apollographql.apollo3.gradle.internal
 
 import com.apollographql.apollo3.compiler.APOLLO_VERSION

libraries/apollo-gradle-plugin-external/src/main/kotlin/com/apollographql/apollo3/gradle/internal/defaults.kt

@@ -1,8 +1,16 @@
+@file:Suppress("DEPRECATION")
+
 package com.apollographql.apollo3.gradle.internal
 
 import com.apollographql.apollo3.compiler.MANIFEST_NONE
 import com.apollographql.apollo3.compiler.MANIFEST_OPERATION_OUTPUT
 import com.apollographql.apollo3.compiler.MANIFEST_PERSISTED_QUERY
+import com.apollographql.apollo3.compiler.OperationIdGenerator
+import com.apollographql.apollo3.compiler.OperationOutputGenerator
+import com.apollographql.apollo3.compiler.Plugin
+import com.apollographql.apollo3.compiler.operationoutput.OperationDescriptor
+import com.apollographql.apollo3.compiler.operationoutput.OperationId
+import com.apollographql.apollo3.compiler.operationoutput.OperationOutput
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Provider
 import java.io.File
@@ -79,3 +87,17 @@ internal fun DefaultService.operationManifestFormat(): Provider<String> {
   }
 }
 
+internal fun Plugin.toOperationOutputGenerator(): OperationOutputGenerator {
+  return object : OperationOutputGenerator {
+    override fun generate(operationDescriptorList: Collection<OperationDescriptor>): OperationOutput {
+      var operationIds = operationIds(operationDescriptorList.toList())
+      if (operationIds == null) {
+        operationIds = operationDescriptorList.map { OperationId(OperationIdGenerator.Sha256.apply(it.source, it.name), it.name) }
+      }
+      return operationDescriptorList.associateBy { descriptor ->
+        val operationId = operationIds.firstOrNull { it.name == descriptor.name } ?: error("No id found for operation ${descriptor.name}")
+        operationId.id
+      }
+    }
+  }
+}

libraries/apollo-gradle-plugin/testProjects/operationIdsWithIsolation/apollo-compiler-plugin/src/main/kotlin/apollo/plugin/MyPlugin.kt

@@ -3,16 +3,10 @@ package apollo.plugin
 import com.apollographql.apollo3.compiler.OperationOutputGenerator
 import com.apollographql.apollo3.compiler.Plugin
 import com.apollographql.apollo3.compiler.operationoutput.OperationDescriptor
-import com.apollographql.apollo3.compiler.operationoutput.OperationOutput
+import com.apollographql.apollo3.compiler.operationoutput.OperationId
 
 class MyPlugin: Plugin {
-    override fun operationOutputGenerator(): OperationOutputGenerator {
-        return object : OperationOutputGenerator {
-            override fun generate(operationDescriptorList: Collection<OperationDescriptor>): OperationOutput {
-                return operationDescriptorList.map {
-                    "${it.name}CustomId" to it
-                }.toMap()
-            }
-        }
+    override fun operationIds(descriptors: List<OperationDescriptor>): List<OperationId>? {
+        return descriptors.map { OperationId("${it.name}CustomId", it.name) }
     }
 }

tests/compiler-hooks/app/build.gradle.kts → tests/compiler-plugins/app/build.gradle.kts

@@ -22,7 +22,7 @@ apollo {
         val name = it.name.replace("-", "")
         service(name) {
           packageName.set("hooks.$name")
-          plugin(project(":compiler-hooks-${it.name}"))
+          plugin(project(":compiler-plugins-${it.name}"))
           languageVersion.set("1.5")
           if (name == "gettersandsetters") {
             generateKotlinModels.set(false)