Fixed how protoc plugins are applied

Mr3zee · Mr3zee · commit 25e741ec0ca1 · 2025-08-14T11:15:54.000+02:00
diff --git a/gradle-plugin/api/gradle-plugin.api b/gradle-plugin/api/gradle-plugin.api
@@ -39,11 +39,7 @@ public class kotlinx/rpc/RpcStrictModeExtension {
 
 public final class kotlinx/rpc/VersionsKt {
 	public static final field BUF_TOOL_VERSION Ljava/lang/String;
-	public static final field GRPC_KOTLIN_VERSION Ljava/lang/String;
-	public static final field GRPC_VERSION Ljava/lang/String;
 	public static final field LIBRARY_VERSION Ljava/lang/String;
-	public static final field PLUGIN_VERSION Ljava/lang/String;
-	public static final field PROTOBUF_VERSION Ljava/lang/String;
 }
 
 public class kotlinx/rpc/buf/BufExtension {
@@ -179,17 +175,15 @@ public final class kotlinx/rpc/protoc/ProcessProtoFilesKt$inlined$sam$i$org_grad
 
 public abstract interface class kotlinx/rpc/protoc/ProtoSourceSet {
 	public abstract fun getName ()Ljava/lang/String;
+	public abstract fun getPlugins ()Lorg/gradle/api/NamedDomainObjectContainer;
 	public abstract fun getProto ()Lorg/gradle/api/file/SourceDirectorySet;
+	public abstract fun plugins (Lorg/gradle/api/Action;)V
 	public fun proto (Lorg/gradle/api/Action;)V
-	public abstract fun protocPlugin (Lkotlinx/rpc/protoc/ProtocPlugin;)V
-	public abstract fun protocPlugin (Lorg/gradle/api/NamedDomainObjectProvider;)V
 }
 
 public abstract interface class kotlinx/rpc/protoc/ProtocExtension {
 	public abstract fun buf (Lorg/gradle/api/Action;)V
 	public abstract fun getBuf ()Lkotlinx/rpc/buf/BufExtension;
-	public abstract fun getPlugins ()Lorg/gradle/api/NamedDomainObjectContainer;
-	public abstract fun plugins (Lorg/gradle/api/Action;)V
 }
 
 public class kotlinx/rpc/protoc/ProtocPlugin {
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/internal/configureLocalProtocGenDevelopmentDependency.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/internal/configureLocalProtocGenDevelopmentDependency.kt
@@ -7,6 +7,7 @@ package kotlinx.rpc.internal
 import kotlinx.rpc.buf.tasks.BufGenerateTask
 import kotlinx.rpc.protoc.grpcKotlinMultiplatform
 import kotlinx.rpc.protoc.kotlinMultiplatform
+import kotlinx.rpc.protoc.protoSourceSets
 import kotlinx.rpc.rpcExtension
 import org.gradle.api.Project
 import org.gradle.internal.extensions.core.extra
@@ -19,16 +20,21 @@ public fun Project.configureLocalProtocGenDevelopmentDependency(
 ) {
     val globalRootDir: String by extra
 
-    rpcExtension().protoc.plugins {
-        kotlinMultiplatform {
-            local {
-                javaJar("$globalRootDir/protoc-gen/protobuf/build/libs/protobuf-$version-all.jar")
+    // init
+    rpcExtension().protoc()
+
+    protoSourceSets.all {
+        plugins {
+            kotlinMultiplatform {
+                local {
+                    javaJar("$globalRootDir/protoc-gen/protobuf/build/libs/protobuf-$version-all.jar")
+                }
             }
-        }
 
-        grpcKotlinMultiplatform {
-            local {
-                javaJar("$globalRootDir/protoc-gen/grpc/build/libs/grpc-$version-all.jar")
+            grpcKotlinMultiplatform {
+                local {
+                    javaJar("$globalRootDir/protoc-gen/grpc/build/libs/grpc-$version-all.jar")
+                }
             }
         }
     }
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/DefaultProtoSourceSet.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/DefaultProtoSourceSet.kt
@@ -5,6 +5,8 @@
 package kotlinx.rpc.protoc
 
 import kotlinx.rpc.buf.tasks.BufGenerateTask
+import kotlinx.rpc.protoc.ProtocPlugin.Companion.GRPC_KOTLIN_MULTIPLATFORM
+import kotlinx.rpc.protoc.ProtocPlugin.Companion.KOTLIN_MULTIPLATFORM
 import kotlinx.rpc.util.findOrCreate
 import kotlinx.rpc.util.withKotlinJvmExtension
 import kotlinx.rpc.util.withKotlinKmpExtension
@@ -17,6 +19,9 @@ import org.gradle.api.tasks.SourceSetContainer
 import org.gradle.kotlin.dsl.add
 import org.gradle.kotlin.dsl.listProperty
 import org.gradle.kotlin.dsl.property
+import org.gradle.kotlin.dsl.the
+import org.jetbrains.kotlin.gradle.dsl.ExplicitApiMode
+import org.jetbrains.kotlin.gradle.dsl.KotlinBaseExtension
 import javax.inject.Inject
 
 @Suppress("UNCHECKED_CAST")
@@ -34,18 +39,48 @@ internal open class DefaultProtoSourceSet @Inject constructor(
     internal val project: Project,
     override val name: String,
 ) : ProtoSourceSet {
-    val languageSourceSets: ListProperty<Any> = project.objects.listProperty<Any>()
-    val protocPlugins: ListProperty<String> = project.objects.listProperty<String>().convention(emptyList())
-    val generateTask: Property<BufGenerateTask> = project.objects.property<BufGenerateTask>()
+    override val plugins: NamedDomainObjectContainer<ProtocPlugin> =
+        project.objects.domainObjectContainer(ProtocPlugin::class.java) { name ->
+            ProtocPlugin(name, project)
+        }
 
-    override fun protocPlugin(plugin: NamedDomainObjectProvider<ProtocPlugin>) {
-        protocPlugins.add(plugin.name)
+    override fun plugins(action: Action<NamedDomainObjectContainer<ProtocPlugin>>) {
+        action.execute(plugins)
     }
 
-    override fun protocPlugin(plugin: ProtocPlugin) {
-        protocPlugins.add(plugin.name)
+    init {
+        val explicitApiModeEnabled = project.provider {
+            project.the<KotlinBaseExtension>().explicitApi != ExplicitApiMode.Disabled
+        }
+
+        plugins.create(KOTLIN_MULTIPLATFORM) {
+            local {
+                javaJar(project.kotlinMultiplatformProtocPluginJarPath)
+            }
+
+            options.put("debugOutput", "protoc-gen-kotlin-multiplatform.log")
+
+            if (this@DefaultProtoSourceSet.name.lowercase().endsWith("main")) {
+                options.put("explicitApiModeEnabled", explicitApiModeEnabled)
+            }
+        }
+
+        plugins.create(GRPC_KOTLIN_MULTIPLATFORM) {
+            local {
+                javaJar(project.grpcKotlinMultiplatformProtocPluginJarPath)
+            }
+
+            options.put("debugOutput", "protoc-gen-grpc-kotlin-multiplatform.log")
+
+            if (this@DefaultProtoSourceSet.name.lowercase().endsWith("main")) {
+                options.put("explicitApiModeEnabled", explicitApiModeEnabled)
+            }
+        }
     }
 
+    val languageSourceSets: ListProperty<Any> = project.objects.listProperty<Any>()
+    val generateTask: Property<BufGenerateTask> = project.objects.property<BufGenerateTask>()
+
     override val proto: SourceDirectorySet = project.objects.sourceDirectorySet(
         PROTO_SOURCE_DIRECTORY_NAME,
         "Proto sources",
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/DefaultProtocExtension.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/DefaultProtocExtension.kt
@@ -13,12 +13,9 @@ import kotlinx.rpc.buf.tasks.registerBufExecTask
 import kotlinx.rpc.buf.tasks.registerBufGenerateTask
 import kotlinx.rpc.buf.tasks.registerGenerateBufGenYamlTask
 import kotlinx.rpc.buf.tasks.registerGenerateBufYamlTask
-import kotlinx.rpc.protoc.ProtocPlugin.Companion.GRPC_KOTLIN_MULTIPLATFORM
-import kotlinx.rpc.protoc.ProtocPlugin.Companion.KOTLIN_MULTIPLATFORM
 import kotlinx.rpc.util.ensureDirectoryExists
 import org.gradle.api.Action
 import org.gradle.api.GradleException
-import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.Project
 import org.gradle.api.file.ConfigurableFileTree
 import org.gradle.api.model.ObjectFactory
@@ -41,15 +38,6 @@ internal open class DefaultProtocExtension @Inject constructor(
     objects: ObjectFactory,
     private val project: Project,
 ) : ProtocExtension {
-    override val plugins: NamedDomainObjectContainer<ProtocPlugin> =
-        objects.domainObjectContainer(ProtocPlugin::class.java) { name ->
-            ProtocPlugin(name, project)
-        }
-
-    override fun plugins(action: Action<NamedDomainObjectContainer<ProtocPlugin>>) {
-        action.execute(plugins)
-    }
-
     override val buf: BufExtension = project.objects.newInstance<BufExtension>()
     override fun buf(action: Action<BufExtension>) {
         action.execute(buf)
@@ -60,13 +48,10 @@ internal open class DefaultProtocExtension @Inject constructor(
         project.configureKotlinMultiplatformPluginJarConfiguration()
         project.configureGrpcKotlinMultiplatformPluginJarConfiguration()
 
-        createDefaultProtocPlugins()
-
-        project.protoSourceSets.all {
-            protocPlugin(plugins.kotlinMultiplatform)
-            protocPlugin(plugins.grpcKotlinMultiplatform)
-        }
-
+        // ignore for bufGenerate task caching
+        project.normalization.runtimeClasspath.ignore("**/protoc-gen-kotlin-multiplatform.log")
+        project.normalization.runtimeClasspath.ignore("**/protoc-gen-grpc-kotlin-multiplatform.log")
+        project.normalization.runtimeClasspath.ignore("**/.keep")
 
         project.protoSourceSets.all {
             if (this !is DefaultProtoSourceSet) {
@@ -92,16 +77,8 @@ internal open class DefaultProtocExtension @Inject constructor(
 
         val pairSourceSet = protoSourceSet.correspondingMainSourceSetOrNull()
 
-        val mainProtocPlugins = pairSourceSet?.protocPlugins ?: provider { emptyList() }
-        val protocPluginNames = protoSourceSet.protocPlugins
-            .zip(mainProtocPlugins) { left, right -> left + right }
-            .map { it.distinct() }
-
-        val includedProtocPlugins = protocPluginNames.map { list ->
-            list.map { pluginName ->
-                this@DefaultProtocExtension.plugins.findByName(pluginName)
-                    ?: throw GradleException("Protoc plugin $pluginName not found")
-            }
+        val includedProtocPlugins = provider {
+            protoSourceSet.plugins.distinct()
         }
 
         val protoFiles = protoSourceSet.proto
@@ -303,35 +280,6 @@ internal open class DefaultProtocExtension @Inject constructor(
         }
     }
 
-    private fun createDefaultProtocPlugins() {
-        val explicitApiModeEnabled = project.provider {
-            project.the<KotlinBaseExtension>().explicitApi != ExplicitApiMode.Disabled
-        }
-
-        plugins.create(KOTLIN_MULTIPLATFORM) {
-            local {
-                javaJar(project.kotlinMultiplatformProtocPluginJarPath)
-            }
-
-            options.put("debugOutput", "protoc-gen-kotlin-multiplatform.log")
-            options.put("explicitApiModeEnabled", explicitApiModeEnabled)
-        }
-
-        plugins.create(GRPC_KOTLIN_MULTIPLATFORM) {
-            local {
-                javaJar(project.grpcKotlinMultiplatformProtocPluginJarPath)
-            }
-
-            options.put("debugOutput", "protoc-gen-grpc-kotlin-multiplatform.log")
-            options.put("explicitApiModeEnabled", explicitApiModeEnabled)
-        }
-
-        // ignore for bufGenerate task caching
-        project.normalization.runtimeClasspath.ignore("**/protoc-gen-kotlin-multiplatform.log")
-        project.normalization.runtimeClasspath.ignore("**/protoc-gen-grpc-kotlin-multiplatform.log")
-        project.normalization.runtimeClasspath.ignore("**/.keep")
-    }
-
     private fun DefaultProtoSourceSet.correspondingMainSourceSetOrNull(): DefaultProtoSourceSet? {
         return when {
             name.lowercase().endsWith("main") -> {
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/ProtoSourceSet.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/ProtoSourceSet.kt
@@ -21,24 +21,14 @@ public interface ProtoSourceSet {
     public val name: String
 
     /**
-     * Adds a new protoc plugin.
-     *
-     * Example:
-     * ```kotlin
-     * protocPlugin(rpc.protoc.plugins.myPlugin)
-     * ```
+     * Container of protoc plugins to be applied to the source set.
      */
-    public fun protocPlugin(plugin: NamedDomainObjectProvider<ProtocPlugin>)
+    public val plugins: NamedDomainObjectContainer<ProtocPlugin>
 
     /**
-     * Adds a new protoc plugin.
-     *
-     * Example:
-     * ```kotlin
-     * protocPlugin(rpc.protoc.plugins.myPlugin.get())
-     * ```
+     * Configures the protoc plugins.
      */
-    public fun protocPlugin(plugin: ProtocPlugin)
+    public fun plugins(action: Action<NamedDomainObjectContainer<ProtocPlugin>>)
 
     /**
      * Default [SourceDirectorySet] for proto files.
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/ProtocExtension.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/ProtocExtension.kt
@@ -6,29 +6,18 @@ package kotlinx.rpc.protoc
 
 import kotlinx.rpc.buf.BufExtension
 import org.gradle.api.Action
-import org.gradle.api.NamedDomainObjectContainer
 
 /**
- * Configuration for the gRPC capabilities.
+ * Configuration for the Protoc capabilities.
  *
- * To enable the gRPC capabilities, add the following minimal code to your `build.gradle.kts`:
+ * To enable the Protoc capabilities, add the following minimal code to your `build.gradle.kts`:
  * ```kotlin
  * rpc {
  *     protoc()
  * }
  * ```
  */
 public interface ProtocExtension {
-    /**
-     * List of protoc plugins to be applied to the project.
-     */
-    public val plugins: NamedDomainObjectContainer<ProtocPlugin>
-
-    /**
-     * Configures the protoc plugins.
-     */
-    public fun plugins(action: Action<NamedDomainObjectContainer<ProtocPlugin>>)
-
     /**
      * Configuration for the Buf build tool.
      */
diff --git a/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/pluginJars.kt b/gradle-plugin/src/main/kotlin/kotlinx/rpc/protoc/pluginJars.kt
@@ -52,9 +52,9 @@ internal fun Project.configureGrpcKotlinMultiplatformPluginJarConfiguration() {
     )
 }
 
-private fun Project.jarPathAccessor(name: String): Provider<String> =
-    project.configurations.named(name)
-        .map { it.singleFile.absolutePath }
+private fun Project.jarPathAccessor(name: String): Provider<String> = project.provider {
+    configurations.named(name).get().singleFile.absolutePath
+}
 
 private fun Project.configureJarConfiguration(configurationName: String, pluginArtifactName: String) {
     configurations.create(configurationName)
diff --git a/gradle-plugin/src/test/kotlin/kotlinx/rpc/GrpcJvmProjectTest.kt b/gradle-plugin/src/test/kotlin/kotlinx/rpc/GrpcJvmProjectTest.kt
@@ -135,16 +135,16 @@ class GrpcJvmProjectTest : GrpcBaseTest() {
 version: v2
 clean: true
 plugins:
-  - local: [protoc-gen-kotlin-multiplatform]
-    out: kotlin-multiplatform
-    opt:
-      - debugOutput=protoc-gen-kotlin-multiplatform.log
-      - explicitApiModeEnabled=true
   - local: [protoc-gen-grpc-kotlin-multiplatform]
     out: grpc-kotlin-multiplatform
     opt:
       - debugOutput=protoc-gen-grpc-kotlin-multiplatform.log
       - explicitApiModeEnabled=true
+  - local: [protoc-gen-kotlin-multiplatform]
+    out: kotlin-multiplatform
+    opt:
+      - debugOutput=protoc-gen-kotlin-multiplatform.log
+      - explicitApiModeEnabled=true
   - local: [path, to, protoc-gen-myplugin.exe]
     out: myPlugin
     opt:
diff --git a/gradle-plugin/src/test/resources/projects/GrpcJvmProjectTest/can_add_custom_protoc_plugins/build.gradle.kts b/gradle-plugin/src/test/resources/projects/GrpcJvmProjectTest/can_add_custom_protoc_plugins/build.gradle.kts
@@ -11,7 +11,11 @@ plugins {
 }
 
 rpc {
-    protoc {
+    protoc()
+}
+
+protoSourceSets {
+    main {
         plugins {
             create("myPlugin") {
                 local {
@@ -35,10 +39,3 @@ rpc {
         }
     }
 }
-
-protoSourceSets {
-    main {
-        protocPlugin(rpc.protoc.plugins.named("myPlugin"))
-        protocPlugin(rpc.protoc.plugins.named("myRemotePlugin"))
-    }
-}
diff --git a/gradle-plugin/src/test/resources/projects/GrpcJvmProjectTest/custom_protoc_plugins_must_declare_an_artifact/build.gradle.kts b/gradle-plugin/src/test/resources/projects/GrpcJvmProjectTest/custom_protoc_plugins_must_declare_an_artifact/build.gradle.kts
@@ -11,15 +11,13 @@ plugins {
 }
 
 rpc {
-    protoc {
-        plugins {
-            create("myPlugin") {}
-        }
-    }
+    protoc()
 }
 
 protoSourceSets {
     main {
-        protocPlugin(rpc.protoc.plugins.named("myPlugin"))
+        plugins {
+            create("myPlugin") {}
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,9 @@ internal fun Project.configureGrpcKotlinMultiplatformPluginJarConfiguration() {`
`52`	`52`	`)`
`53`	`53`	`}`
`54`	`54`
`55`		`-private fun Project.jarPathAccessor(name: String): Provider<String> =`
`56`		`- project.configurations.named(name)`
`57`		`- .map { it.singleFile.absolutePath }`
	`55`	`+private fun Project.jarPathAccessor(name: String): Provider<String> = project.provider {`
	`56`	`+ configurations.named(name).get().singleFile.absolutePath`
	`57`	`+}`
`58`	`58`
`59`	`59`	`private fun Project.configureJarConfiguration(configurationName: String, pluginArtifactName: String) {`
`60`	`60`	`configurations.create(configurationName)`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,11 @@ plugins {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`rpc {`
`14`		`- protoc {`
	`14`	`+ protoc()`
	`15`	`+}`
	`16`	`+`
	`17`	`+protoSourceSets {`
	`18`	`+ main {`
`15`	`19`	`plugins {`
`16`	`20`	`create("myPlugin") {`
`17`	`21`	`local {`
`@@ -35,10 +39,3 @@ rpc {`
`35`	`39`	`}`
`36`	`40`	`}`
`37`	`41`	`}`
`38`		`-`
`39`		`-protoSourceSets {`
`40`		`- main {`
`41`		`- protocPlugin(rpc.protoc.plugins.named("myPlugin"))`
`42`		`- protocPlugin(rpc.protoc.plugins.named("myRemotePlugin"))`
`43`		`- }`
`44`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,13 @@ plugins {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`rpc {`
`14`		`- protoc {`
`15`		`- plugins {`
`16`		`- create("myPlugin") {}`
`17`		`- }`
`18`		`- }`
	`14`	`+ protoc()`
`19`	`15`	`}`
`20`	`16`
`21`	`17`	`protoSourceSets {`
`22`	`18`	`main {`
`23`		`- protocPlugin(rpc.protoc.plugins.named("myPlugin"))`
	`19`	`+ plugins {`
	`20`	`+ create("myPlugin") {}`
	`21`	`+ }`
`24`	`22`	`}`
`25`	`23`	`}`