protoc-plugin: Refactoring of intermediate model (#418)

Author: Jozott00

gradle-plugin/src/main/kotlin/kotlinx/rpc/buf/BufExtensions.kt

@@ -5,19 +5,19 @@
 package kotlinx.rpc.buf
 
 import kotlinx.rpc.buf.tasks.BufExecTask
+import kotlinx.rpc.proto.ProtocPlugin
 import org.gradle.api.Action
 import org.gradle.api.Project
-import org.gradle.api.provider.Property
-import org.gradle.kotlin.dsl.property
-import java.io.File
-import javax.inject.Inject
-import kotlin.time.Duration
-import kotlinx.rpc.proto.ProtocPlugin
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.ListProperty
+import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.listProperty
+import org.gradle.kotlin.dsl.property
+import java.io.File
+import javax.inject.Inject
 import kotlin.reflect.KClass
+import kotlin.time.Duration
 
 /**
  * Options for the Buf tasks.
@@ -100,14 +100,14 @@ public open class BufExtension @Inject constructor(objects: ObjectFactory) {
  * Allows registering custom Buf tasks that can operate on the generated workspace.
  */
 public open class BufTasksExtension @Inject constructor(internal val project: Project) {
-    // TODO change to commonMain/commonTest in docs when it's supported KRPC-180
+
     /**
      * Registers a custom Buf task that operates on the generated workspace.
      *
      * Name conventions:
      * `lint` input for [name] will result in tasks
      * named 'bufLintMain' and 'bufLintTest' for Kotlin/JVM projects
-     * and 'bufLintJvmMain' and 'bufLintJvmTest' for Kotlin/Multiplatform projects.
+     * and 'bufLintCommonMain' and 'bufLintCommonTest' for Kotlin/Multiplatform projects.
      *
      * Note the by default 'test' task doesn't depend on 'main' task.
      */
@@ -127,14 +127,14 @@ public open class BufTasksExtension @Inject constructor(internal val project: Pr
         return provider
     }
 
-    // TODO change to commonMain/commonTest in docs when it's supported KRPC-180
+
     /**
      * Registers a custom Buf task that operates on the generated workspace.
      *
      * Name conventions:
      * `lint` input for [name] will result in tasks
      * named 'bufLintMain' and 'bufLintTest' for Kotlin/JVM projects
-     * and 'bufLintJvmMain' and 'bufLintJvmTest' for Kotlin/Multiplatform projects.
+     * and 'bufLintCommonMain' and 'bufLintCommonTest' for Kotlin/Multiplatform projects.
      *
      * Note the by default 'test' task doesn't depend on 'main' task.
      */

gradle-plugin/src/main/kotlin/kotlinx/rpc/grpc/DefaultGrpcExtension.kt

@@ -4,20 +4,14 @@
 
 package kotlinx.rpc.grpc
 
-import kotlinx.rpc.GRPC_KOTLIN_VERSION
-import kotlinx.rpc.GRPC_VERSION
-import kotlinx.rpc.PROTOBUF_VERSION
 import kotlinx.rpc.buf.BufExtension
 import kotlinx.rpc.buf.configureBufExecutable
 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.proto.*
-import kotlinx.rpc.proto.ProtocPlugin.Companion.GRPC_JAVA
-import kotlinx.rpc.proto.ProtocPlugin.Companion.GRPC_KOTLIN
 import kotlinx.rpc.proto.ProtocPlugin.Companion.KOTLIN_MULTIPLATFORM
-import kotlinx.rpc.proto.ProtocPlugin.Companion.PROTOBUF_JAVA
 import kotlinx.rpc.util.ensureDirectoryExists
 import org.gradle.api.Action
 import org.gradle.api.GradleException
@@ -61,9 +55,6 @@ internal open class DefaultGrpcExtension @Inject constructor(
         createDefaultProtocPlugins()
 
         project.protoSourceSets.forEach { protoSourceSet ->
-            protoSourceSet.protocPlugin(protocPlugins.protobufJava)
-            protoSourceSet.protocPlugin(protocPlugins.grpcJava)
-            protoSourceSet.protocPlugin(protocPlugins.grpcKotlin)
             protoSourceSet.protocPlugin(protocPlugins.kotlinMultiplatform)
         }
 
@@ -294,30 +285,6 @@ internal open class DefaultGrpcExtension @Inject constructor(
         // ignore for bufGenerate task caching
         project.normalization.runtimeClasspath.ignore("**/protoc-gen-kotlin-multiplatform.log")
         project.normalization.runtimeClasspath.ignore("**/.keep")
-
-        protocPlugins.create(GRPC_JAVA) {
-            isJava.set(true)
-
-            remote {
-                locator.set("buf.build/grpc/java:v$GRPC_VERSION")
-            }
-        }
-
-        protocPlugins.create(GRPC_KOTLIN) {
-            remote {
-                locator.set("buf.build/grpc/kotlin:v$GRPC_KOTLIN_VERSION")
-            }
-        }
-
-        protocPlugins.create(PROTOBUF_JAVA) {
-            isJava.set(true)
-
-            remote {
-                // for some reason they omit the first digit in this version:
-                // https://buf.build/protocolbuffers/java?version=v31.1
-                locator.set("buf.build/protocolbuffers/java:v${PROTOBUF_VERSION.substringAfter(".")}")
-            }
-        }
     }
 
     private fun DefaultProtoSourceSet.correspondingMainSourceSetOrNull(): DefaultProtoSourceSet? {

gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/DefaultProtoSourceSet.kt

@@ -96,13 +96,11 @@ internal fun Project.createProtoExtensions() {
     }
 
     project.withKotlinKmpExtension {
-        findOrCreateAndConfigure("jvmMain", null)
-        findOrCreateAndConfigure("jvmTest", null)
         findOrCreateAndConfigure("commonMain", null)
         findOrCreateAndConfigure("commonTest", null)
 
         sourceSets.configureEach {
-            if (name == "jvmMain" || name == "jvmTest" || name == "commonMain" || name == "commonTest") {
+            if (name == "commonMain" || name == "commonTest") {
                 findOrCreateAndConfigure(name, this)
             }
         }

gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/ProtocPlugin.kt

@@ -4,10 +4,7 @@
 
 package kotlinx.rpc.proto
 
-import kotlinx.rpc.proto.ProtocPlugin.Companion.GRPC_JAVA
-import kotlinx.rpc.proto.ProtocPlugin.Companion.GRPC_KOTLIN
 import kotlinx.rpc.proto.ProtocPlugin.Companion.KOTLIN_MULTIPLATFORM
-import kotlinx.rpc.proto.ProtocPlugin.Companion.PROTOBUF_JAVA
 import kotlinx.rpc.util.OS
 import org.gradle.api.Action
 import org.gradle.api.NamedDomainObjectContainer
@@ -34,45 +31,6 @@ public fun NamedDomainObjectContainer<ProtocPlugin>.kotlinMultiplatform(action:
     kotlinMultiplatform.configure(action)
 }
 
-/**
- * Access to the `protobuf-java` protoc plugin.
- */
-public val NamedDomainObjectContainer<ProtocPlugin>.protobufJava: NamedDomainObjectProvider<ProtocPlugin>
-    get() = named(PROTOBUF_JAVA)
-
-/**
- * Configures the `protobuf-java` protoc plugin.
- */
-public fun NamedDomainObjectContainer<ProtocPlugin>.protobufJava(action: Action<ProtocPlugin>) {
-    protobufJava.configure(action)
-}
-
-/**
- * Access to the `grpc-java` protoc plugin.
- */
-public val NamedDomainObjectContainer<ProtocPlugin>.grpcJava: NamedDomainObjectProvider<ProtocPlugin>
-    get() = named(GRPC_JAVA)
-
-/**
-     * Configures the grpc-java protoc plugin.
- */
-public fun NamedDomainObjectContainer<ProtocPlugin>.grpcJava(action: Action<ProtocPlugin>) {
-    grpcJava.configure(action)
-}
-
-/**
- * Access to the `grpc-kotlin` protoc plugin.
- */
-public val NamedDomainObjectContainer<ProtocPlugin>.grpcKotlin: NamedDomainObjectProvider<ProtocPlugin>
-    get() = named(GRPC_KOTLIN)
-
-/**
- * Configures the `grpc-kotlin` protoc plugin.
- */
-public fun NamedDomainObjectContainer<ProtocPlugin>.grpcKotlin(action: Action<ProtocPlugin>) {
-    grpcKotlin.configure(action)
-}
-
 /**
  * Access to a specific protoc plugin.
  */
@@ -193,27 +151,6 @@ public open class ProtocPlugin(
          * @see [kotlinMultiplatform]
          */
         public const val KOTLIN_MULTIPLATFORM: String = "kotlin-multiplatform"
-
-        /**
-         * The name of the `protobuf-java` protoc plugin.
-         *
-         * @see [protobufJava]
-         */
-        public const val PROTOBUF_JAVA: String = "java"
-
-        /**
-         * The name of the `grpc-java` protoc plugin.
-         *
-         * @see [grpcJava]
-         */
-        public const val GRPC_JAVA: String = "grpc-java"
-
-        /**
-         * The name of the `grpc-kotlin` protoc plugin.
-         *
-         * @see [grpcKotlin]
-         */
-        public const val GRPC_KOTLIN: String = "grpc-kotlin"
     }
 
     /**

gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/derictory.kt renamed to gradle-plugin/src/main/kotlin/kotlinx/rpc/proto/directory.kt

@@ -135,12 +135,6 @@ class GrpcJvmProjectTest : GrpcBaseTest() {
 version: v2
 clean: true
 plugins:
-  - remote: buf.build/protocolbuffers/java:v${TEST_PROTOBUF_VERSION.substringAfter(".")}
-    out: java
-  - remote: buf.build/grpc/java:v$TEST_GRPC_VERSION
-    out: grpc-java
-  - remote: buf.build/grpc/kotlin:v$TEST_GRPC_KOTLIN_VERSION
-    out: grpc-kotlin
   - local: [protoc-gen-kotlin-multiplatform]
     out: kotlin-multiplatform
     opt:
@@ -174,7 +168,8 @@ inputs:
     }
 
     @Suppress("detekt.MaxLineLength")
-    private val cliFlagsRegex = "- Buf Arguments: \\[.*?, generate, --output, .*?, --include-imports, --include-wkt, --error-format, json, --config, some\\.buf\\.yaml, --log-format, json, --timeout, 60s]".toRegex()
+    private val cliFlagsRegex =
+        "- Buf Arguments: \\[.*?, generate, --output, .*?, --include-imports, --include-wkt, --error-format, json, --config, some\\.buf\\.yaml, --log-format, json, --timeout, 60s]".toRegex()
 
     @Test
     fun `Custom Buf CLI Flags`() = runGrpcTest {

gradle-plugin/src/test/kotlin/kotlinx/rpc/GrpcJvmProjectTest.kt

@@ -9,17 +9,7 @@ import org.gradle.testkit.runner.TaskOutcome
 import org.intellij.lang.annotations.Language
 import org.junit.jupiter.api.TestInstance
 import java.nio.file.Path
-import kotlin.io.path.ExperimentalPathApi
-import kotlin.io.path.absolutePathString
-import kotlin.io.path.deleteRecursively
-import kotlin.io.path.exists
-import kotlin.io.path.extension
-import kotlin.io.path.isRegularFile
-import kotlin.io.path.pathString
-import kotlin.io.path.readLines
-import kotlin.io.path.relativeTo
-import kotlin.io.path.walk
-import kotlin.lazy
+import kotlin.io.path.*
 import kotlin.test.assertEquals
 import kotlin.test.fail
 
@@ -229,7 +219,7 @@ abstract class GrpcBaseTest : BaseTest() {
     }
 
     companion object {
-        private const val KMP_SOURCE_SET = "jvm"
+        private const val KMP_SOURCE_SET = "common"
         private val KMP_SOURCE_SET_CAPITAL = KMP_SOURCE_SET.replaceFirstChar(Char::uppercaseChar)
         private const val KOTLIN_MULTIPLATFORM_DIR = "kotlin-multiplatform"
         const val RPC_INTERNAL = "_rpc_internal"