Migrated RpcClient and kRPC to new descriptor API

Author: Mr3zee

core/src/commonMain/kotlin/kotlinx/rpc/RPCCall.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.rpc
+
+import kotlinx.rpc.descriptor.RpcServiceDescriptor
+
+/**
+ * Represents a method or field call of an RPC service.
+ *
+ * @property callableName The name of the callable. Can be the name of the method or field.
+ * @property data The data for the call.
+ * @property descriptor the descriptor of the service, that made the call.
+ */
+public data class RpcCall(
+    val descriptor: RpcServiceDescriptor<*>,
+    val callableName: String,
+    val data: Any,
+    val serviceId: Long,
+)

core/src/commonMain/kotlin/kotlinx/rpc/RPCClient.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.rpc
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+import kotlin.coroutines.CoroutineContext
+
+/**
+ * [RpcClient] represents an abstraction of an RPC client, that can handle requests from several RPC services,
+ * transform them, send to the server and handle responses and errors.
+ * [CoroutineScope] defines the lifetime of the client.
+ */
+public interface RpcClient : CoroutineScope {
+    /**
+     * This method is used by generated clients to perform a call to the server.
+     *
+     * @param T type of the result
+     * @param call an object that contains all required information about the called method,
+     * that is needed to route it properly to the server.
+     * @return actual result of the call, for example, data from the server.
+     */
+    public suspend fun <T> call(call: RpcCall): T
+
+    /**
+     * This method is used by generated clients to perform a call to the server.
+     *
+     * @param T type of the result
+     * @param serviceScope service's coroutine scope
+     * @param call an object that contains all required information about the called method,
+     * that is needed to route it properly to the server.
+     * @return actual result of the call, for example, data from the server
+     */
+    public fun <T> callSync(serviceScope: CoroutineScope, call: RpcCall): Deferred<T>
+
+    /**
+     * Provides child [CoroutineContext] for a new [RemoteService] service stub.
+     *
+     * This function shouldn't be called directly.
+     *
+     * @param serviceId id of the new service. Used for service cancellation messages.
+     */
+    public fun provideStubContext(serviceId: Long): CoroutineContext
+}

core/src/commonMain/kotlin/kotlinx/rpc/RpcCall.kt

@@ -23,7 +23,7 @@ import kotlinx.rpc.RemoteService
  *    suspend fun sayHello(firstName: String, lastName: String, age: Int): String
  * }
  * // client code
- * val rpcClient: RPCClient
+ * val rpcClient: RpcClient
  * val myService = rpcClient.withService<MyService>()
  * val greetingFromServer = myService.sayHello("Alex", "Smith", 35)
  * // server code

core/src/commonMain/kotlin/kotlinx/rpc/RpcClient.kt

@@ -5,7 +5,7 @@
 package kotlinx.rpc
 
 import kotlinx.rpc.descriptor.serviceDescriptorOf
-import kotlinx.rpc.internal.RPCDeferredField
+import kotlinx.rpc.internal.RpcDeferredField
 import kotlin.reflect.KClass
 
 /**
@@ -29,9 +29,9 @@ import kotlin.reflect.KClass
 public suspend fun <T : RemoteService, R> T.awaitFieldInitialization(getter: T.() -> R): R {
     val field = getter()
 
-    if (field is RPCDeferredField<*>) {
+    if (field is RpcDeferredField<*>) {
         @Suppress("UNCHECKED_CAST")
-        return (field as RPCDeferredField<R>).await()
+        return (field as RpcDeferredField<R>).await()
     }
 
     error("Please choose required field for a valid RPC client generated by RPCClient.withService method")

core/src/commonMain/kotlin/kotlinx/rpc/annotations/Rpc.kt

@@ -4,8 +4,8 @@
 
 package kotlinx.rpc.descriptor
 
-import kotlinx.rpc.RPCClient
 import kotlinx.rpc.RemoteService
+import kotlinx.rpc.RpcClient
 import kotlinx.rpc.internal.*
 import kotlinx.rpc.internal.utils.ExperimentalRPCApi
 import kotlin.reflect.KClass
@@ -42,34 +42,34 @@ public fun <T : RemoteService> serviceDescriptorOf(kClass: KClass<T>): RpcServic
 public interface RpcServiceDescriptor<T : RemoteService> {
     public val fqName: String
 
-    public fun getFields(service: T): List<RPCDeferredField<*>>
+    public fun getFields(service: T): List<RpcDeferredField<*>>
 
     public fun getCallable(name: String): RpcCallable<T>?
 
-    public fun createInstance(serviceId: Long, client: RPCClient): T
+    public fun createInstance(serviceId: Long, client: RpcClient): T
 }
 
 @ExperimentalRPCApi
-public data class RpcCallable<T : RemoteService>(
+public class RpcCallable<T : RemoteService>(
     public val name: String,
     public val dataType: KType,
     public val returnType: KType,
     public val invokator: RpcInvokator<T>,
-    public val parameters: List<RpcParameter>,
+    public val parameters: Array<RpcParameter>,
 )
 
 @ExperimentalRPCApi
 public sealed interface RpcInvokator<T : RemoteService> {
     @ExperimentalRPCApi
-    public interface Method<T : RemoteService> : RpcInvokator<T> {
+    public fun interface Method<T : RemoteService> : RpcInvokator<T> {
         public suspend fun call(service: T, data: Any?): Any?
     }
 
     @ExperimentalRPCApi
-    public interface Field<T : RemoteService> : RpcInvokator<T> {
+    public fun interface Field<T : RemoteService> : RpcInvokator<T> {
         public fun call(service: T): Any?
     }
 }
 
 @ExperimentalRPCApi
-public data class RpcParameter(val name: String, val type: KType)
+public class RpcParameter(public val name: String, public val type: KType)

core/src/commonMain/kotlin/kotlinx/rpc/awaitFieldInitialization.kt

@@ -2,12 +2,14 @@
  * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package kotlinx.rpc.krpc.client.internal
+package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlinx.serialization.Serializable
 
 /**
  * Used for field initialization call
  */
 @Serializable
-internal object FieldDataObject
+@InternalRPCApi
+public object FieldDataObject

core/src/commonMain/kotlin/kotlinx/rpc/descriptor/RpcServiceDescriptor.kt

@@ -7,6 +7,6 @@ package kotlinx.rpc.internal
 import kotlinx.rpc.internal.utils.InternalRPCApi
 
 @InternalRPCApi
-public interface RPCDeferredField<Self> {
+public interface RpcDeferredField<Self> {
     public suspend fun await(): Self
 }

krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/internal/FieldDataObject.kt renamed to core/src/commonMain/kotlin/kotlinx/rpc/internal/FieldDataObject.kt

@@ -2,16 +2,17 @@
  * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package kotlinx.rpc.krpc.client.internal
+package kotlinx.rpc.internal
 
 import kotlinx.coroutines.CompletableDeferred
+import kotlinx.coroutines.Deferred
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.rpc.UninitializedRPCFieldException
 import kotlin.reflect.KProperty
 
-internal class RPCFieldProvider<T, R>(
+internal class RpcFieldProvider<T, R>(
     private val serviceName: String,
-    private val deferred: CompletableDeferred<T> = CompletableDeferred(),
+    private val deferred: Deferred<T> = CompletableDeferred(),
     val getter: T.() -> R,
 ) {
     @OptIn(ExperimentalCoroutinesApi::class)
@@ -25,9 +26,9 @@ internal class RPCFieldProvider<T, R>(
 }
 
 @Suppress("unused")
-internal fun <T> RPCFieldProvider(
+internal fun <T> RpcFieldProvider(
     serviceName: String,
     deferred: CompletableDeferred<T> = CompletableDeferred()
-): RPCFieldProvider<T, T> {
-    return RPCFieldProvider(serviceName, deferred) { this }
+): RpcFieldProvider<T, T> {
+    return RpcFieldProvider(serviceName, deferred) { this }
 }