Merge pull request #225 from Elenpay/show-user-channel-opening-failur…

…e-reason Show user channel opening failure reason
Elenpay · Jul 6, 2023 · 598314c · 598314c
2 parents 8754aeb + 8e82e9b
commit 598314c
Show file tree

Hide file tree

Showing 12 changed files with 1,406 additions and 4 deletions.
diff --git a/src/Data/ApplicationDbContext.cs b/src/Data/ApplicationDbContext.cs
@@ -16,7 +16,9 @@
  * along with this program.  If not, see http://www.gnu.org/licenses/.
  */
 
+using System.Text.Json;
 using FundsManager.Data.Models;
+using FundsManager.Helpers;
 using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore;
 
@@ -51,12 +53,21 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             modelBuilder.Entity<Node>().HasIndex(x => x.PubKey).IsUnique();
             modelBuilder.Entity<Node>().HasIndex(x => x.Name).IsUnique();
             modelBuilder.Entity<Wallet>().HasIndex(x => new {x.InternalWalletSubDerivationPath, x.InternalWalletMasterFingerprint}).IsUnique();
-            
+
             //There should be only one Liquidity Rule per Channel
             modelBuilder.Entity<LiquidityRule>().HasIndex(x => x.ChannelId).IsUnique();
-            
+
             modelBuilder.Entity<ApplicationUser>().HasIndex(x => x.NormalizedUserName).IsUnique();
 
+            modelBuilder.Entity<ChannelStatusLog>().HasNoKey();
+
+            modelBuilder.Entity<ChannelOperationRequest>()
+                .Property(e => e.StatusLogs)
+                .HasConversion(
+                    v => JsonSerializer.Serialize(v, new JsonSerializerOptions()),
+                    v => JsonSerializer.Deserialize<List<ChannelStatusLog>>(v, new JsonSerializerOptions())
+                );
+
             base.OnModelCreating(modelBuilder);
         }
 
@@ -81,7 +92,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         public DbSet<InternalWallet> InternalWallets { get; set; }
 
         public DbSet<FMUTXO> FMUTXOs { get; set; }
-        
+
         public DbSet<LiquidityRule> LiquidityRules { get; set; }
     }
 }
diff --git a/src/Data/Models/ChannelOperationRequest.cs b/src/Data/Models/ChannelOperationRequest.cs
@@ -18,7 +18,9 @@
  */
 
 using System.ComponentModel.DataAnnotations.Schema;
+using FundsManager.Helpers;
 using NBitcoin;
+using System.Text.Json;
 
 namespace FundsManager.Data.Models
 {
@@ -101,6 +103,9 @@ public decimal Amount
 
         public decimal? FeeRate { get; set; }
 
+        [Column(TypeName = "jsonb")]
+        public List<ChannelStatusLog> StatusLogs { get; set; } = new();
+
         #region Relationships
 
         public ICollection<ChannelOperationRequestPSBT> ChannelOperationRequestPsbts { get; set; }

diff --git a/src/Helpers/ChannelStatusLog.cs b/src/Helpers/ChannelStatusLog.cs
@@ -0,0 +1,40 @@
+using System.Text.Json.Serialization;
+
+namespace FundsManager.Helpers;
+
+public class ChannelStatusLog
+{
+    public DateTime DateTime { get; set; }
+    public LogLevel Level { get; set; }
+    public string Description { get; set; }
+
+    [JsonConstructor]
+    public ChannelStatusLog(DateTime dateTime, LogLevel level, string description)
+    {
+        DateTime = dateTime;
+        Level = level;
+        Description = description;
+    }
+
+    public ChannelStatusLog(LogLevel level, string description)
+    {
+        DateTime = DateTime.Now;
+        Level = level;
+        Description = description;
+    }
+
+    public static ChannelStatusLog Info(string description)
+    {
+        return new ChannelStatusLog(LogLevel.Information, description);
+    }
+
+    public static ChannelStatusLog Error(string description)
+    {
+        return new ChannelStatusLog(LogLevel.Error, description);
+    }
+
+    public static ChannelStatusLog Warning(string description)
+    {
+        return new ChannelStatusLog(LogLevel.Warning, description);
+    }
+}
diff --git a/src/Helpers/CustomExceptions.cs b/src/Helpers/CustomExceptions.cs
@@ -12,4 +12,14 @@ public NBXplorerNotFullySyncedException(): base("Error, nbxplorer not fully sync
 public class ShowToUserException : Exception
 {
    public ShowToUserException(string? message): base(message) {}
+}
+
+public class PeerNotOnlineException : Exception
+{
+   public PeerNotOnlineException(string? message = null): base(message) {}
+}
+
+public class RemoteCanceledFundingException : Exception
+{
+   public RemoteCanceledFundingException(string? message = null): base(message) {}
 }
diff --git a/src/Helpers/JobTypes.cs b/src/Helpers/JobTypes.cs
@@ -144,6 +144,29 @@ public static async Task OnFail(IJobExecutionContext context, Func<Task> callbac
             await callback();
         }
     }
+
+    /// <summary>
+    /// Get the next interval time
+    /// </summary>
+    /// <param name="context">The execution context of the job</param>
+    public static int? GetNextInterval(IJobExecutionContext context)
+    {
+        var data = context.JobDetail.JobDataMap;
+        var intervals = data.Get("intervalListInMinutes") as int[];
+        if (intervals == null)
+        {
+            throw new Exception("No interval list found, make sure you're using the RetriableJob class");
+        };
+
+        var trigger = context.Trigger as SimpleTriggerImpl;
+
+        if (trigger!.TimesTriggered <= intervals.Length)
+        {
+            return intervals[trigger!.TimesTriggered - 1];
+        }
+
+        return null;
+    } 
 }
 
 public class JobAndTrigger

diff --git a/src/Jobs/ChannelOpenJob.cs b/src/Jobs/ChannelOpenJob.cs
@@ -60,6 +60,8 @@ await RetriableJob.Execute(context, async () =>
         }
         catch (Exception e)
         {
+            var shouldRetry = await LogToChannelRequest(openRequestId, e, context);
+
             await RetriableJob.OnFail(context, async () =>
             {
                 var request = await _channelOperationRequestRepository.GetById(openRequestId);
@@ -68,9 +70,49 @@ await RetriableJob.OnFail(context, async () =>
             });
 
             _logger.LogError(e, "Error on {JobName}", nameof(ChannelOpenJob));
+            if (!shouldRetry)
+            {
+                await context.Scheduler.DeleteJob(context.JobDetail.Key, context.CancellationToken);
+            }
             throw new JobExecutionException(e, false);
         }
 
         _logger.LogInformation("{JobName} ended", nameof(ChannelOpenJob));
     }
+
+    private async Task<bool> LogToChannelRequest(int openRequestId, Exception e, IJobExecutionContext context)
+    {
+        try
+        {
+            var request = await _channelOperationRequestRepository.GetById(openRequestId);
+            if (e is PeerNotOnlineException or RemoteCanceledFundingException)
+            {
+                request.StatusLogs.Add(ChannelStatusLog.Error(e.Message));
+            }
+            else
+            {
+                request.StatusLogs.Add(ChannelStatusLog.Error("Unexpected exception trying to open channel"));
+            }
+
+            if (e is RemoteCanceledFundingException)
+            {
+                request.Status = ChannelOperationRequestStatus.Failed;
+                _channelOperationRequestRepository.Update(request);
+                return false;
+            }
+
+            var nextRetry = RetriableJob.GetNextInterval(context);
+            if (nextRetry != null)
+            {
+                request.StatusLogs.Add(ChannelStatusLog.Info($"Next retry in {nextRetry} minutes"));
+            }
+            _channelOperationRequestRepository.Update(request);
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "Error logging to channel request");
+        }
+
+        return true;
+    }
 }