Merge pull request #17 from kwan3854/v2.0.3

Improves RPC error handling and removes chunking delay

Author: kwan3854

Packages/WebviewRpc/Runtime/WebViewRpcClient.cs

@@ -16,6 +16,7 @@ public class WebViewRpcClient : IDisposable
         private readonly Dictionary<string, UniTaskCompletionSource<RpcEnvelope>> _pendingRequests = new();
         private readonly ChunkAssembler _chunkAssembler = new();
         private int _requestIdCounter = 1;
+        private readonly object _pendingRequestsLock = new object();
         private bool _disposed;
 
         public WebViewRpcClient(IWebViewBridge bridge)
@@ -32,11 +33,14 @@ public WebViewRpcClient(IWebViewBridge bridge)
         public async UniTask<TResponse> CallMethod<TResponse>(string method, IMessage request)
             where TResponse : IMessage<TResponse>, new()
         {
-            var requestId = (_requestIdCounter++).ToString();
+            var requestId = Interlocked.Increment(ref _requestIdCounter).ToString();
             var requestBytes = request.ToByteArray();
 
             var tcs = new UniTaskCompletionSource<RpcEnvelope>();
-            _pendingRequests[requestId] = tcs;
+            lock (_pendingRequestsLock)
+            {
+                _pendingRequests[requestId] = tcs;
+            }
 
             try
             {
@@ -77,7 +81,10 @@ public async UniTask<TResponse> CallMethod<TResponse>(string method, IMessage re
             }
             finally
             {
-                _pendingRequests.Remove(requestId);
+                lock (_pendingRequestsLock)
+                {
+                    _pendingRequests.Remove(requestId);
+                }
             }
         }
 
@@ -112,13 +119,9 @@ private async UniTask SendChunkedMessage(string requestId, string method, byte[]
                 var bytes = envelope.ToByteArray();
                 var base64 = Convert.ToBase64String(bytes);
                 _bridge.SendMessageToWeb(base64);
-                
-                // Optional: Add small delay between chunks to avoid overwhelming the bridge
-                if (i < totalChunks)
-                {
-                    await UniTask.Delay(1);
-                }
             }
+
+            await UniTask.CompletedTask;
         }
 
         private void OnBridgeMessage(string base64)
@@ -170,9 +173,18 @@ private void OnBridgeMessage(string base64)
 
         private void ProcessCompleteEnvelope(RpcEnvelope envelope)
         {
-            if (!envelope.IsRequest && _pendingRequests.TryGetValue(envelope.RequestId, out var tcs))
+            if (!envelope.IsRequest)
             {
-                tcs.TrySetResult(envelope);
+                UniTaskCompletionSource<RpcEnvelope> tcs = null;
+                lock (_pendingRequestsLock)
+                {
+                    _pendingRequests.TryGetValue(envelope.RequestId, out tcs);
+                }
+                
+                if (tcs != null)
+                {
+                    tcs.TrySetResult(envelope);
+                }
             }
         }
 
@@ -183,11 +195,14 @@ public void Dispose()
                 _bridge.OnMessageReceived -= OnBridgeMessage;
 
                 // Cancel all pending requests
-                foreach (var pending in _pendingRequests.Values)
+                lock (_pendingRequestsLock)
                 {
-                    pending.TrySetCanceled();
+                    foreach (var pending in _pendingRequests.Values)
+                    {
+                        pending.TrySetCanceled();
+                    }
+                    _pendingRequests.Clear();
                 }
-                _pendingRequests.Clear();
 
                 _disposed = true;
             }

Packages/WebviewRpc/Runtime/WebViewRpcServer.cs

@@ -114,8 +114,31 @@ private async UniTask HandleRequestAsync(RpcEnvelope requestEnvelope)
             }
 
             // Send response
-            if (responsePayload != null)
+            // Check if this is an error response
+            if (!string.IsNullOrEmpty(error))
             {
+                // Error response
+                var responseEnvelope = new RpcEnvelope
+                {
+                    RequestId = requestEnvelope.RequestId,
+                    IsRequest = false,
+                    Method = requestEnvelope.Method,
+                    Error = error
+                };
+                
+                // Include payload if available (even if empty)
+                if (responsePayload != null)
+                {
+                    responseEnvelope.Payload = responsePayload;
+                }
+                
+                var bytes = responseEnvelope.ToByteArray();
+                var base64 = Convert.ToBase64String(bytes);
+                _bridge.SendMessageToWeb(base64);
+            }
+            else if (responsePayload != null)
+            {
+                // Success response
                 var responseBytes = responsePayload.ToByteArray();
 
                 // Check if chunking is needed
@@ -125,7 +148,7 @@ private async UniTask HandleRequestAsync(RpcEnvelope requestEnvelope)
                 {
                     // Send as chunks
                     await SendChunkedMessage(requestEnvelope.RequestId, requestEnvelope.Method, 
-                        responseBytes, false, error);
+                        responseBytes, false, null);
                 }
                 else
                 {
@@ -138,26 +161,20 @@ await SendChunkedMessage(requestEnvelope.RequestId, requestEnvelope.Method,
                         Payload = responsePayload
                     };
 
-                    // Only set Error if it's not null or empty
-                    if (!string.IsNullOrEmpty(error))
-                    {
-                        responseEnvelope.Error = error;
-                    }
-                    
                     var bytes = responseEnvelope.ToByteArray();
                     var base64 = Convert.ToBase64String(bytes);
                     _bridge.SendMessageToWeb(base64);
                 }
             }
             else
             {
-                // Error response
+                // No payload and no error - this is an error condition
                 var responseEnvelope = new RpcEnvelope
                 {
                     RequestId = requestEnvelope.RequestId,
                     IsRequest = false,
                     Method = requestEnvelope.Method,
-                    Error = error ?? "Unknown error"
+                    Error = "Method returned null without error"
                 };
 
                 var bytes = responseEnvelope.ToByteArray();
@@ -204,13 +221,9 @@ private async UniTask SendChunkedMessage(string requestId, string method, byte[]
                 var bytes = envelope.ToByteArray();
                 var base64 = Convert.ToBase64String(bytes);
                 _bridge.SendMessageToWeb(base64);
-                
-                // Optional: Add small delay between chunks to avoid overwhelming the bridge
-                if (i < totalChunks)
-                {
-                    await UniTask.Delay(1);
-                }
             }
+            
+            await UniTask.CompletedTask;
         }
 
         public void Dispose()

Packages/WebviewRpc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.kwanjoong.webviewrpc",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "displayName": "Webview RPC",
   "description": "The webview Remote Procedure Call bridge.",
   "unity": "2022.3",

webview_rpc_runtime_library/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.7] - 2025-01-22
+
+### Fixed
+- Improved error handling: errors now take precedence over payload
+- Fixed issue where methods returning null without error were not properly handled
+- Removed unnecessary 1ms delay between chunks (chunk order is already guaranteed by index)
+
+### Changed
+- Error responses can now include payload data if available
+- Clearer error messages when methods return null without setting an error
+
 ## [2.0.6] - 2025-01-22
 
 ### Added

webview_rpc_runtime_library/package.json

@@ -1,6 +1,6 @@
 {
   "name": "app-webview-rpc",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "type": "module",
   "description": "WebView RPC provides an abstraction layer that allows communication between the App (e.g. Unity C#) and WebView (HTML, JS) using protobuf, similar to gRPC.",
   "main": "./dist/cjs/index.js",

webview_rpc_runtime_library/src/core/webview_rpc_client.js

@@ -92,11 +92,6 @@ export class WebViewRpcClient {
             const bytes = encodeRpcEnvelope(envelope);
             const base64 = uint8ArrayToBase64(bytes);
             this._bridge.sendMessage(base64);
-
-            // Optional: Add small delay between chunks
-            if (i < totalChunks) {
-                await new Promise(resolve => setTimeout(resolve, 1));
-            }
         }
     }
 

webview_rpc_runtime_library/src/core/webview_rpc_server.js

@@ -99,7 +99,26 @@ export class WebViewRpcServer {
         }
 
         // Send response
-        if (responsePayload && !error) {
+        // Check if this is an error response
+        if (error) {
+            // Error response
+            const responseEnvelope = {
+                requestId: requestEnvelope.requestId,
+                isRequest: false,
+                method: requestEnvelope.method,
+                error: error
+            };
+            
+            // Include payload if available (even if empty)
+            if (responsePayload) {
+                responseEnvelope.payload = responsePayload;
+            }
+            
+            const responseBytes = encodeRpcEnvelope(responseEnvelope);
+            const responseBase64 = uint8ArrayToBase64(responseBytes);
+            this._bridge.sendMessage(responseBase64);
+        } else if (responsePayload) {
+            // Success response
             // Check if chunking is needed
             const effectivePayloadSize = WebViewRpcConfiguration.getEffectivePayloadSize();
             if (WebViewRpcConfiguration.enableChunking && 
@@ -110,7 +129,7 @@ export class WebViewRpcServer {
                     requestEnvelope.method, 
                     responsePayload, 
                     false, 
-                    error
+                    null
                 );
             } else {
                 // Send as single message
@@ -126,12 +145,12 @@ export class WebViewRpcServer {
                 this._bridge.sendMessage(responseBase64);
             }
         } else {
-            // Error response
+            // No payload and no error - this is an error condition
             const responseEnvelope = {
                 requestId: requestEnvelope.requestId,
                 isRequest: false,
                 method: requestEnvelope.method,
-                error: error || 'Unknown error'
+                error: 'Method returned null without error'
             };
 
             const responseBytes = encodeRpcEnvelope(responseEnvelope);
@@ -175,11 +194,6 @@ export class WebViewRpcServer {
             const bytes = encodeRpcEnvelope(envelope);
             const base64 = uint8ArrayToBase64(bytes);
             this._bridge.sendMessage(base64);
-
-            // Optional: Add small delay between chunks
-            if (i < totalChunks) {
-                await new Promise(resolve => setTimeout(resolve, 1));
-            }
         }
     }