Better coroutine error handling

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - [Bug](https://github.com/trilitech/tezos-unity-sdk/issues/57) with BeaconConnectorWebGl
 
+### Added
+- Better [coroutine error handling](https://github.com/trilitech/tezos-unity-sdk/issues/39)
+
 
 ## [1.3.1] - 2023-04-27
 ### Changed

Runtime/Scripts/Helpers/CoroutineWrapper.cs

@@ -12,6 +12,10 @@ public class CoroutineWrapper<T> : IEnumerator
     /// Event raised when the coroutine is complete
     /// </summary>
     public readonly Action<T> Completed;
+    /// <summary>
+    /// Event raised when the coroutine throws an exception
+    /// </summary>
+    public readonly Action<Exception> ErrorHandler;
 
     private readonly IEnumerator _targetCoroutine;
 
@@ -33,13 +37,18 @@ public class CoroutineWrapper<T> : IEnumerator
     /// </summary>
     /// <param name="coroutine">Coroutine that will be executed</param>
     /// <param name="callback">Callback that will be called when the coroutine is complete</param>
-    public CoroutineWrapper(IEnumerator coroutine, Action<T> callback = null)
+    /// <param name="errorHandler">Callback that will be called when the coroutine throws an exception</param>
+    public CoroutineWrapper(IEnumerator coroutine, Action<T> callback = null, Action<Exception> errorHandler = null)
     {
         _targetCoroutine = coroutine;
         if (callback != null)
         {
             Completed += callback;
         }
+        if (errorHandler != null)
+        {
+            ErrorHandler += errorHandler;
+        }
     }
 
     /// <inheritdoc/>
@@ -60,9 +69,15 @@ public bool MoveNext()
         }
         catch (Exception e)
         {
-            Debug.LogError("Exception " + e.Message);
             Exception = e;
-            Completed?.Invoke(default);
+            if (ErrorHandler == null)
+            {
+                Debug.LogError($"Exception: {e.Message}");
+            }
+            else
+            {
+                ErrorHandler?.Invoke(e);
+            }
             return false;
         }
     }
@@ -92,8 +107,13 @@ public static CoroutineRunner Instance
         }
     }
 
+    public Coroutine StartCoroutineWrapper(IEnumerator coroutine)
+    {
+        return StartCoroutine(new CoroutineWrapper<object>(coroutine, null, (exception) => Debug.LogError($"Exception on Coroutine: {exception.Message}")));
+    }
+
     private void Awake()
     {
         DontDestroyOnLoad(gameObject);
     }
-}
+}

Runtime/Scripts/Helpers/NetezosExtensions.cs

@@ -22,7 +22,7 @@ public static IEnumerator ReadTZBalance(string rpcUri, string sender, Action<ulo
         {
             var rpc = new Rpc(rpcUri);
             var getBalanceRequest = rpc.GetTzBalance<ulong>(sender);
-            return HttpClient.WrappedRequest(getBalanceRequest, callback);
+            return new CoroutineWrapper<ulong>(getBalanceRequest, callback);
         }
 
         public static IEnumerator ReadView(string rpcUri, string destination, string entrypoint,
@@ -31,7 +31,7 @@ public static IEnumerator ReadView(string rpcUri, string destination, string ent
             var rpc = new Rpc(rpcUri);
             var runViewOp = rpc.RunView<JsonElement>(destination, entrypoint, input);
 
-            return HttpClient.WrappedRequest(runViewOp, (JsonElement result) =>
+            return new CoroutineWrapper<JsonElement>(runViewOp, (JsonElement result) =>
             {
                 if (result.ValueKind != JsonValueKind.Null && result.ValueKind != JsonValueKind.Undefined &&
                     result.TryGetProperty("data", out var val))
@@ -57,7 +57,7 @@ private static IEnumerator FetchContractCode(string rpcUri, string contract)
             if (_contracts.ContainsKey(contract)) yield break;
             var rpc = new Rpc(rpcUri);
             var scriptOp = rpc.GetContractCode<JsonElement>(contract);
-            yield return HttpClient.WrappedRequest(scriptOp, (JsonElement script) =>
+            yield return new CoroutineWrapper<JsonElement>(scriptOp, (JsonElement script) =>
             {
                 var codeElement = script.GetProperty("code").GetRawText();
                 var code = Micheline.FromJson(codeElement);

Runtime/Scripts/Helpers/UnityMainThreadDispatcher.cs

@@ -45,7 +45,10 @@ public void Enqueue(IEnumerator action)
     {
         lock (_executionQueue)
         {
-            _executionQueue.Enqueue(() => { StartCoroutine(action); });
+            var coroutine = new CoroutineWrapper<object>(action, null, (exception) => Debug.LogError($"Exception on MainThread Queue: {exception.Message}"));
+            _executionQueue.Enqueue(() => { 
+                StartCoroutine(coroutine); 
+            });
         }
     }
 

Runtime/Scripts/TezosAPI/HttpClient.cs

@@ -61,14 +61,6 @@ private UnityWebRequest GetUnityWebRequest(string method, string path)
             request.timeout = RequestTimeout;
             return request;
         }
-
-        public static IEnumerator WrappedRequest<T>(IEnumerator op, Action<T> callback)
-        {
-            var counterRoutine = new CoroutineWrapper<T>(op);
-            yield return counterRoutine;
-            var counter = counterRoutine.Result;
-            callback?.Invoke(counter);
-        }
     }
 
     internal static class HttpHeaders

Runtime/Scripts/TezosAPI/Tezos.cs

@@ -84,7 +84,7 @@ private void InitBeaconConnector()
             {
                 var json = JsonSerializer.Deserialize<JsonElement>(transaction);
                 var transactionHash = json.GetProperty("transactionHash").GetString();
-                MessageReceiver.StartCoroutine(MessageReceiver.ContractCallInjection(_indexerNode, transactionHash));
+                MessageReceiver.StartCoroutine(new CoroutineWrapper<object>(MessageReceiver.ContractCallInjection(_indexerNode, transactionHash)));
             };
         }
 
@@ -167,7 +167,7 @@ TokensForOwnerOrder orderBy
                       $"limit={maxItems}";
 
             var requestRoutine = GetJson<IEnumerable<TokenBalance>>(url);
-            return WrappedRequest(requestRoutine, cb);
+            return new CoroutineWrapper<IEnumerable<TokenBalance>>(requestRoutine, cb);
         }
     }
 }

Samples~/Scripts/DemoExample/CopyToClipboard.cs

@@ -28,7 +28,7 @@ public void OnPointerClick(PointerEventData eventData)
 
         // copy text to the clipboard
         GUIUtility.systemCopyBuffer = text.text;
-        CoroutineRunner.Instance.StartCoroutine(OnTextCopied());
+        CoroutineRunner.Instance.StartCoroutineWrapper(OnTextCopied());
     }
 
     IEnumerator OnTextCopied()

Samples~/Scripts/DemoExample/Core/ExampleManager.cs

@@ -42,12 +42,12 @@ public void FetchInventoryItems(Action<List<IItemModel>> callback)
         var entrypoint = "view_items_of";
         var input = new { @string = sender };
 
-        CoroutineRunner.Instance.StartCoroutine(
+        CoroutineRunner.Instance.StartCoroutineWrapper(
             _tezos.ReadView(contractAddress, entrypoint, input, result =>
             {
                 Debug.Log("READING INVENTORY DATA");
                 // deserialize the json data to inventory items
-                CoroutineRunner.Instance.StartCoroutine(
+                CoroutineRunner.Instance.StartCoroutineWrapper(
                     BeaconSDK.NetezosExtensions.HumanizeValue(result, _networkRPC, destination, "humanizeInventory",
                         (ContractInventoryViewResult[] inventory) => OnInventoryFetched(inventory, callback))
                 );
@@ -127,11 +127,11 @@ public void FetchMarketItems(Action<List<IItemModel>> callback)
             Prim = PrimType.Unit
         };
 
-        CoroutineRunner.Instance.StartCoroutine(
+        CoroutineRunner.Instance.StartCoroutineWrapper(
             _tezos.ReadView(contractAddress, entrypoint, input, result =>
             {
                 // deserialize the json data to market items
-                CoroutineRunner.Instance.StartCoroutine(
+                CoroutineRunner.Instance.StartCoroutineWrapper(
                     BeaconSDK.NetezosExtensions.HumanizeValue(result, _networkRPC, destination, "humanizeMarketplace",
                         (ContractMarketplaceViewResult[] market) => OnMarketplaceFetched(market, callback))
                     );
@@ -216,7 +216,7 @@ public User GetCurrentUser()
     public void GetBalance(Action<ulong> callback)
     {
         var routine = _tezos.ReadBalance(callback);
-        CoroutineRunner.Instance.StartCoroutine(routine);
+        CoroutineRunner.Instance.StartCoroutineWrapper(routine);
     }
 
     public void GetSoftBalance(Action<int> callback)
@@ -238,7 +238,7 @@ private void GetSoftBalanceRoutine(Action<int> callback)
             }
         };
 
-        CoroutineRunner.Instance.StartCoroutine(
+        CoroutineRunner.Instance.StartCoroutineWrapper(
             _tezos.ReadView(contractAddress, "get_balance", input, result =>
             {
                 var intProp = result.GetProperty("int");
@@ -343,7 +343,7 @@ public void IsItemOnMarket(int itemID, string owner, Action<bool> callback)
             }
         };
 
-        CoroutineRunner.Instance.StartCoroutine(
+        CoroutineRunner.Instance.StartCoroutineWrapper(
             _tezos.ReadView(contractAddress, entrypoint, input, result =>
             {
                 var boolString = result.GetProperty("prim");

Samples~/Scripts/DemoExample/UIManager.cs

@@ -98,7 +98,7 @@ private void PopulateInventory(List<IItemModel> items)
 			inventory.Init(items);
 			loadingPanel.SetActive(false);
 		};
-		StartCoroutine(DoActionNextFrame(action));
+		CoroutineRunner.Instance.StartCoroutineWrapper(DoActionNextFrame(action));
 	}
 
 	private void PopulateMarket(List<IItemModel> items)
@@ -108,7 +108,7 @@ private void PopulateMarket(List<IItemModel> items)
 			market.Init(items);
 			loadingPanel.SetActive(false);
 		};
-		StartCoroutine(DoActionNextFrame(action));
+		CoroutineRunner.Instance.StartCoroutineWrapper(DoActionNextFrame(action));
 	}
 
 	private IEnumerator DoActionNextFrame(Action action)