Increase RPC method max roundtrip time to 7s

Author: davidliu

.changeset/tough-rings-unite.md

@@ -0,0 +1,5 @@
+---
+"client-sdk-android": patch
+---
+
+Increase RPC method max roundtrip time to 7s

livekit-android-sdk/src/main/java/io/livekit/android/room/participant/LocalParticipant.kt

@@ -1031,39 +1031,6 @@ internal constructor(
         return engine.sendData(dataPacket)
     }
 
-    /**
-     * Establishes the participant as a receiver for calls of the specified RPC method.
-     * Will overwrite any existing callback for the same method.
-     *
-     * Example:
-     * ```kt
-     * room.localParticipant.registerRpcMethod("greet") { (requestId, callerIdentity, payload, responseTimeout) ->
-     *     Log.i("TAG", "Received greeting from ${callerIdentity}: ${payload}")
-     *
-     *     // Return a string
-     *     "Hello, ${callerIdentity}!"
-     * }
-     * ```
-     *
-     * The handler receives an [RpcInvocationData] with the following parameters:
-     * - `requestId`: A unique identifier for this RPC request
-     * - `callerIdentity`: The identity of the RemoteParticipant who initiated the RPC call
-     * - `payload`: The data sent by the caller (as a string)
-     * - `responseTimeout`: The maximum time available to return a response
-     *
-     * The handler should return a string.
-     * If unable to respond within [RpcInvocationData.responseTimeout], the request will result in an error on the caller's side.
-     *
-     * You may throw errors of type [RpcError] with a string `message` in the handler,
-     * and they will be received on the caller's side with the message intact.
-     * Other errors thrown in your handler will not be transmitted as-is, and will instead arrive to the caller as `1500` ("Application Error").
-     *
-     * @param method The name of the indicated RPC method
-     * @param handler Will be invoked when an RPC request for this method is received
-     * @see RpcHandler
-     * @see RpcInvocationData
-     * @see performRpc
-     */
     override fun registerRpcMethod(
         method: String,
         handler: RpcHandler,
@@ -1122,23 +1089,15 @@ internal constructor(
         }
     }
 
-    /**
-     * Initiate an RPC call to a remote participant
-     * @param destinationIdentity The identity of the destination participant.
-     * @param method The method name to call.
-     * @param payload The payload to pass to the method.
-     * @param responseTimeout Timeout for receiving a response after initial connection.
-     *      Defaults to 10000. Max value of UInt.MAX_VALUE milliseconds.
-     * @return The response payload.
-     * @throws RpcError on failure. Details in [RpcError.message].
-     */
     override suspend fun performRpc(
         destinationIdentity: Identity,
         method: String,
         payload: String,
         responseTimeout: Duration,
     ): String = coroutineScope {
-        val maxRoundTripLatency = 2.seconds
+        // Maximum amount of time it should ever take for an RPC request to reach the destination, and the ACK to come back
+        // This is set to 7 seconds to account for various relay timeouts and retries in LiveKit Cloud that occur in rare cases
+        val maxRoundTripLatency = 7.seconds
 
         if (payload.byteLength() > RTCEngine.MAX_DATA_PACKET_SIZE) {
             throw RpcError.BuiltinRpcError.REQUEST_PAYLOAD_TOO_LARGE.create()

livekit-android-sdk/src/main/java/io/livekit/android/room/rpc/RpcManager.kt

@@ -79,14 +79,14 @@ interface RpcManager {
      * @param method The method name to call.
      * @param payload The payload to pass to the method.
      * @param responseTimeout Timeout for receiving a response after initial connection.
-     *      Defaults to 10000. Max value of UInt.MAX_VALUE milliseconds.
+     *      Defaults to 15 seconds.
      * @return The response payload.
      * @throws RpcError on failure. Details in [RpcError.message].
      */
     suspend fun performRpc(
         destinationIdentity: Identity,
         method: String,
         payload: String,
-        responseTimeout: Duration = 10.seconds,
+        responseTimeout: Duration = 15.seconds,
     ): String
 }