grpc: Fix service names in the generated descriptor (#457)

* grpc: Fix the service name to be full-qualified

Signed-off-by: Johannes Zottele <[email protected]>

* grpc: Move CoreClientTest to commonTest and provide service server

Signed-off-by: Johannes Zottele <[email protected]>

* grpc: Add test to check if the service and client actually use the `package` option for the service name.

Signed-off-by: Johannes Zottele <[email protected]>

* grpc: Separate between kotlin FQ name and service (grpc) FQ name

Signed-off-by: Johannes Zottele <[email protected]>

* grpc: Address PR comments

Signed-off-by: Johannes Zottele <[email protected]>

* grpc: Avoid delay in this case

Signed-off-by: Johannes Zottele <[email protected]>

---------

Signed-off-by: Johannes Zottele <[email protected]>

Author: Jozott00

compiler-plugin/compiler-plugin-backend/src/main/kotlin/kotlinx/rpc/codegen/extension/RpcDeclarationScanner.kt

@@ -4,14 +4,19 @@
 
 package kotlinx.rpc.codegen.extension
 
+import kotlinx.rpc.codegen.common.RpcClassId
 import kotlinx.rpc.codegen.common.RpcNames
 import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector
 import org.jetbrains.kotlin.ir.declarations.IrClass
 import org.jetbrains.kotlin.ir.declarations.IrDeclaration
 import org.jetbrains.kotlin.ir.declarations.IrProperty
 import org.jetbrains.kotlin.ir.declarations.IrSimpleFunction
+import org.jetbrains.kotlin.ir.expressions.IrConst
+import org.jetbrains.kotlin.ir.expressions.IrConstKind
+import org.jetbrains.kotlin.ir.expressions.IrExpression
 import org.jetbrains.kotlin.ir.util.dumpKotlinLike
+import org.jetbrains.kotlin.ir.util.getAnnotation
 import org.jetbrains.kotlin.ir.util.hasDefaultValue
 
 /**
@@ -25,6 +30,9 @@ internal object RpcDeclarationScanner {
     fun scanServiceDeclaration(service: IrClass, ctx: RpcIrContext, logger: MessageCollector): ServiceDeclaration {
         var stubClass: IrClass? = null
 
+        val grpcAnnotation = service.getAnnotation(RpcClassId.grpcAnnotation.asSingleFqName())
+        val protoPackage = grpcAnnotation?.arguments?.getOrNull(0)?.asConstString() ?: ""
+
         val declarations = service.declarations.memoryOptimizedMap { declaration ->
             when (declaration) {
                 is IrSimpleFunction -> {
@@ -75,6 +83,7 @@ internal object RpcDeclarationScanner {
             service = service,
             stubClass = stubClassNotNull,
             methods = declarations.filterNotNull(),
+            protoPackage = protoPackage.trim()
         )
     }
 }
@@ -87,3 +96,7 @@ private fun unsupportedDeclaration(service: IrClass, declaration: IrDeclaration,
 
     return null
 }
+
+fun IrExpression.asConstString(): String =
+    (this as? IrConst)?.takeIf { it.kind == IrConstKind.String }?.value as? String
+        ?: error("Expected IrConst of kind String, got ${dumpKotlinLike()}")

compiler-plugin/compiler-plugin-backend/src/main/kotlin/kotlinx/rpc/codegen/extension/RpcStubGenerator.kt

@@ -18,11 +18,7 @@ import org.jetbrains.kotlin.ir.builders.declarations.*
 import org.jetbrains.kotlin.ir.declarations.*
 import org.jetbrains.kotlin.ir.expressions.*
 import org.jetbrains.kotlin.ir.expressions.impl.*
-import org.jetbrains.kotlin.ir.symbols.IrClassSymbol
-import org.jetbrains.kotlin.ir.symbols.IrPropertySymbol
-import org.jetbrains.kotlin.ir.symbols.IrSimpleFunctionSymbol
-import org.jetbrains.kotlin.ir.symbols.IrSymbol
-import org.jetbrains.kotlin.ir.symbols.IrValueSymbol
+import org.jetbrains.kotlin.ir.symbols.*
 import org.jetbrains.kotlin.ir.types.*
 import org.jetbrains.kotlin.ir.util.*
 import org.jetbrains.kotlin.name.Name
@@ -39,6 +35,8 @@ private object Stub {
 private object Descriptor {
     const val CALLABLE_MAP = "callableMap"
     const val CALLABLES = "callables"
+
+    // the kotlin class name
     const val FQ_NAME = "fqName"
     const val SIMPLE_NAME = "simpleName"
     const val GET_CALLABLE = "getCallable"
@@ -915,7 +913,8 @@ internal class RpcStubGenerator(
         }.apply {
             overriddenSymbols = listOf(ctx.properties.rpcServiceDescriptorCallables)
 
-            val collectionType = ctx.irBuiltIns.collectionClass.typeWith(ctx.rpcCallable.typeWith(declaration.serviceType))
+            val collectionType =
+                ctx.irBuiltIns.collectionClass.typeWith(ctx.rpcCallable.typeWith(declaration.serviceType))
 
             addGetter {
                 returnType = collectionType
@@ -1086,7 +1085,7 @@ internal class RpcStubGenerator(
      *
      * ```kotlin
      * serviceDescriptor(
-     *     name = MyService, // simpleName
+     *     name = my.proto.package.MyService, // $declaration.serviceFqName
      *     methods = methodDescriptorMap.values, // Collection<MethodDescriptor<*, *>>
      *     schemaDescriptor = null, // for now, only null
      * )
@@ -1105,7 +1104,7 @@ internal class RpcStubGenerator(
         }.apply {
             arguments {
                 values {
-                    +stringConst(declaration.simpleName)
+                    +stringConst(declaration.serviceFqName)
 
                     +irCallProperty(
                         receiver = IrGetValueImpl(
@@ -1130,7 +1129,7 @@ internal class RpcStubGenerator(
      * // In scope: resolver: MessageCodecResolver
      *
      * methodDescriptor<<request-type>, <response-type>>(
-     *     fullMethodName = "${descriptor.simpleName}/${callable.name}",
+     *     fullMethodName = "${descriptor.serviceFqName}/${callable.name}",
      *     requestCodec = <request-codec>,
      *     responseCodec = <response-codec>,
      *     type = MethodType.<method-type>,
@@ -1185,7 +1184,7 @@ internal class RpcStubGenerator(
 
                 values {
                     // fullMethodName
-                    +stringConst("${declaration.simpleName}/${callable.name}")
+                    +stringConst("${declaration.serviceFqName}/${callable.name}")
 
                     // requestCodec
                     +irCodec(requestType, resolver)
@@ -1245,7 +1244,7 @@ internal class RpcStubGenerator(
         val protobufMessage = owner.getAnnotation(ctx.withCodecAnnotation.owner.kotlinFqName)
 
         return if (protobufMessage != null) {
-            val classReference = vsApi{ protobufMessage.argumentsVS }.single() as? IrClassReference
+            val classReference = vsApi { protobufMessage.argumentsVS }.single() as? IrClassReference
                 ?: error("Expected IrClassReference for ${ctx.withCodecAnnotation.owner.kotlinFqName} parameter")
 
             val codec = classReference.classType

compiler-plugin/compiler-plugin-backend/src/main/kotlin/kotlinx/rpc/codegen/extension/ServiceDeclaration.kt

@@ -17,12 +17,15 @@ class ServiceDeclaration(
     val service: IrClass,
     val stubClass: IrClass,
     val methods: List<Method>,
+    val protoPackage: String,
 ) {
     // todo change to extension after KRPC-178
     val isGrpc = service.hasAnnotation(RpcClassId.grpcAnnotation)
     val simpleName = service.kotlinFqName.shortName().asString()
     val fqName = service.kotlinFqName.asString()
 
+    // the name of the service based on the proto file (or @Grpc annotation)
+    val serviceFqName = if (protoPackage.isNotEmpty()) "$protoPackage.$simpleName" else simpleName
     val serviceType = service.defaultType
 
     sealed interface Callable {

compiler-plugin/compiler-plugin-k2/src/main/kotlin/kotlinx/rpc/codegen/checkers/FirRpcStrictModeClassChecker.kt

@@ -10,6 +10,7 @@ import kotlinx.rpc.codegen.checkers.util.functionParametersRecursionCheck
 import kotlinx.rpc.codegen.common.RpcClassId
 import kotlinx.rpc.codegen.vsApi
 import org.jetbrains.kotlin.KtSourceElement
+import org.jetbrains.kotlin.descriptors.isAnnotationClass
 import org.jetbrains.kotlin.diagnostics.DiagnosticReporter
 import org.jetbrains.kotlin.diagnostics.KtDiagnosticFactory0
 import org.jetbrains.kotlin.diagnostics.reportOn
@@ -26,7 +27,10 @@ object FirRpcStrictModeClassChecker {
         context: CheckerContext,
         reporter: DiagnosticReporter,
     ) {
-        if (!context.session.predicateBasedProvider.matches(FirRpcPredicates.rpc, declaration)) {
+        if (!context.session.predicateBasedProvider.matches(FirRpcPredicates.rpc, declaration)
+            // skip checks for annotation classes
+            || declaration.classKind.isAnnotationClass
+        ) {
             return
         }
 
@@ -37,7 +41,10 @@ object FirRpcStrictModeClassChecker {
                 }
 
                 is FirNamedFunctionSymbol -> {
-                    fun reportOn(element: KtSourceElement?, checker: FirRpcStrictModeDiagnostics.() -> KtDiagnosticFactory0) {
+                    fun reportOn(
+                        element: KtSourceElement?,
+                        checker: FirRpcStrictModeDiagnostics.() -> KtDiagnosticFactory0,
+                    ) {
                         reporter.reportOn(element, FirRpcStrictModeDiagnostics.checker(), context)
                     }
 

grpc/grpc-core/src/commonMain/kotlin/kotlinx/rpc/grpc/Status.kt

@@ -32,7 +32,7 @@ public expect class Status {
 
 public expect fun Status(code: StatusCode, description: String? = null, cause: Throwable? = null): Status
 
-public expect val Status.code: StatusCode
+public expect val Status.statusCode: StatusCode
 
 public enum class StatusCode(public val value: Int) {
     OK(0),

grpc/grpc-core/src/commonMain/kotlin/kotlinx/rpc/grpc/annotations/Grpc.kt

@@ -5,11 +5,10 @@
 package kotlinx.rpc.grpc.annotations
 
 import kotlinx.rpc.annotations.Rpc
-import kotlinx.rpc.internal.utils.InternalRpcApi
 
 /**
  * Annotation used for marking gRPC services.
  */
 @Target(AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPE_PARAMETER)
 @Rpc
-public annotation class Grpc
+public annotation class Grpc(val protoPackage: String = "")

grpc/grpc-core/src/commonMain/kotlin/kotlinx/rpc/grpc/internal/suspendClientCalls.kt

@@ -201,7 +201,7 @@ private fun <Response> channelResponseListener(
     },
     onClose = { status: Status, trailers: GrpcTrailers ->
         val cause = when {
-            status.code == StatusCode.OK -> null
+            status.statusCode == StatusCode.OK -> null
             status.getCause() is CancellationException -> status.getCause()
             else -> StatusException(status, trailers)
         }