Log result failures with stack traces (#282)

This feature will improve the debugging experience for developers by
providing the information about *where exactly* a result has failed

---------

Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>

src/Extensions/ChannelApiExtensions.cs

@@ -20,7 +20,7 @@ public static class ChannelApiExtensions
     {
         if (!embedResult.IsDefined() || !embedResult.Value.IsDefined(out var embed))
         {
-            return Result.FromError(embedResult.Value);
+            return ResultExtensions.FromError(embedResult.Value);
         }
 
         return (Result)await channelApi.CreateMessageAsync(channelId, message, nonce, isTextToSpeech, new[] { embed },

src/Extensions/FeedbackServiceExtensions.cs

@@ -13,7 +13,7 @@ public static class FeedbackServiceExtensions
     {
         if (!embedResult.IsDefined(out var embed))
         {
-            return Result.FromError(embedResult);
+            return ResultExtensions.FromError(embedResult);
         }
 
         return (Result)await feedback.SendContextualEmbedAsync(embed, options, ct);

src/Extensions/ResultExtensions.cs

@@ -0,0 +1,61 @@
+using System.Diagnostics;
+using Microsoft.Extensions.Logging;
+using Remora.Results;
+
+namespace Octobot.Extensions;
+
+public static class ResultExtensions
+{
+    public static Result FromError(Result result)
+    {
+        LogResultStackTrace(result);
+
+        return result;
+    }
+
+    public static Result FromError<T>(Result<T> result)
+    {
+        var casted = (Result)result;
+        LogResultStackTrace(casted);
+
+        return casted;
+    }
+
+    [Conditional("DEBUG")]
+    private static void LogResultStackTrace(Result result)
+    {
+        if (Octobot.StaticLogger is null || result.IsSuccess)
+        {
+            return;
+        }
+
+        Octobot.StaticLogger.LogError("{ErrorType}: {ErrorMessage}{NewLine}{StackTrace}",
+            result.Error.GetType().FullName, result.Error.Message, Environment.NewLine, ConstructStackTrace());
+
+        var inner = result.Inner;
+        while (inner is { IsSuccess: false })
+        {
+            Octobot.StaticLogger.LogError("Caused by: {ResultType}: {ResultMessage}",
+                inner.Error.GetType().FullName, inner.Error.Message);
+
+            inner = inner.Inner;
+        }
+    }
+
+    private static string ConstructStackTrace()
+    {
+        var stackArray = new StackTrace(3, true).ToString().Split(Environment.NewLine).ToList();
+        for (var i = stackArray.Count - 1; i >= 0; i--)
+        {
+            var frame = stackArray[i];
+            var trimmed = frame.TrimStart();
+            if (trimmed.StartsWith("at System.Threading", StringComparison.Ordinal)
+                || trimmed.StartsWith("at System.Runtime.CompilerServices", StringComparison.Ordinal))
+            {
+                stackArray.RemoveAt(i);
+            }
+        }
+
+        return string.Join(Environment.NewLine, stackArray);
+    }
+}