chain timeout added

Author: k0dep

Deployf.Botf/Attributes/Handle.cs

@@ -21,5 +21,6 @@ public enum Handle
     /// Execute action before message go to routing and whole the botf
     /// </summary>
     BeforeAll,
-    ClearState
+    ClearState,
+    ChainTimeout
 }

Deployf.Botf/BotController.cs

@@ -490,19 +490,43 @@ public string FPath(string controller, string action, params object[] args)
 
     #region chaining
 
-    public async Task<IUpdateContext> AwaitNextUpdate()
+    public async Task<IUpdateContext> AwaitNextUpdate(Action onCanceled = null)
     {
+        var options = ((BotfBot)Context.Bot).Options;
         var store = Context.Services.GetRequiredService<ChainStorage>();
         var tcs = new TaskCompletionSource<IUpdateContext>();
         store.Set(ChatId, new (tcs));
-        return await tcs.Task;
+        if(options.ChainTimeout.HasValue)
+        {
+            _ = Task.Run(async () =>
+            {
+                await Task.Delay(options.ChainTimeout.Value);
+                if(tcs != null)
+                {
+                    store.Clear(ChatId);
+                    tcs.SetCanceled();
+                }
+            });
+        }
+        
+        try
+        {
+            var context = await tcs.Task;
+            tcs = null;
+            return context;
+        }
+        catch(TaskCanceledException)
+        {
+            onCanceled?.Invoke();
+            throw new ChainTimeoutException(onCanceled != null);
+        }
     }
 
-    public async Task<string> AwaitText()
+    public async Task<string> AwaitText(Action onCanceled = null)
     {
         while (true)
         {
-            var update = await AwaitNextUpdate();
+            var update = await AwaitNextUpdate(onCanceled);
             if (update.Update.Type != UpdateType.Message)
             {
                 continue;
@@ -512,11 +536,11 @@ public async Task<string> AwaitText()
         }
     }
 
-    public async Task<string> AwaitQuery()
+    public async Task<string> AwaitQuery(Action onCanceled = null)
     {
         while (true)
         {
-            var update = await AwaitNextUpdate();
+            var update = await AwaitNextUpdate(onCanceled);
             if (update.Update.Type != UpdateType.CallbackQuery)
             {
                 continue;

Deployf.Botf/Middlewares/BotControllersChainMiddleware.cs

@@ -6,36 +6,51 @@ public class BotControllersChainMiddleware : IUpdateHandler
 {
     readonly ILogger<BotControllersChainMiddleware> _log;
     readonly ChainStorage _chainStorage;
+    readonly BotControllersInvoker _invoker;
+    readonly BotControllerHandlers _handlers;
 
-    public BotControllersChainMiddleware(ILogger<BotControllersChainMiddleware> log, ChainStorage chainStorage)
+    public BotControllersChainMiddleware(ILogger<BotControllersChainMiddleware> log, ChainStorage chainStorage, BotControllersInvoker invoker, BotControllerHandlers handlers)
     {
         _log = log;
         _chainStorage = chainStorage;
+        _invoker = invoker;
+        _handlers = handlers;
     }
 
     public async Task HandleAsync(IUpdateContext context, UpdateDelegate next, CancellationToken cancellationToken)
     {
-        var id = context.GetSafeChatId();
-        if (id != null)
+        try
         {
-            var chain = _chainStorage.Get(id.Value);
-            if(chain != null)
+            var id = context.GetSafeChatId();
+            if (id != null)
             {
-                _log.LogTrace("Found chain for user {userId}, triggered continue execution of chain", id.Value);
-                _chainStorage.Clear(id.Value);
-                if (chain.Synchronizator != null)
+                var chain = _chainStorage.Get(id.Value);
+                if (chain != null)
                 {
-                    chain.Synchronizator.SetResult(context);
+                    _log.LogTrace("Found chain for user {userId}, triggered continue execution of chain", id.Value);
+                    _chainStorage.Clear(id.Value);
+                    if (chain.Synchronizator != null)
+                    {
+                        chain.Synchronizator.SetResult(context);
+                    }
+                }
+                else
+                {
+                    await next(context, cancellationToken);
                 }
             }
             else
             {
                 await next(context, cancellationToken);
             }
         }
-        else
+        catch(ChainTimeoutException e)
         {
-            await next(context, cancellationToken);
+            _log.LogDebug("Chain timeout reached for chat {chatId}", context.GetChatId());
+            if (!e.Handled && _handlers.TryGetValue(Handle.ChainTimeout, out var controller))
+            {
+                await _invoker.Invoke(context, cancellationToken, controller);
+            }
         }
     }
 }

Deployf.Botf/System/BotfOptions.cs

@@ -20,7 +20,7 @@ public string? Username
     public bool HandleOnlyMentionedInGroups { get; set; }
     public string ApiBaseUrl { get; set; }
     public bool AutoCleanReplyKeyboard { get; set; }
-
+    public TimeSpan? ChainTimeout { get; set; } = TimeSpan.FromHours(1);
     public bool UseWebhooks => !string.IsNullOrEmpty(WebhookUrl);
     public string? WebhookPath
     {

Deployf.Botf/System/ChainStorage.cs

@@ -1,4 +1,5 @@
-using Telegram.Bot.Framework.Abstractions;
+using System.Collections.Concurrent;
+using Telegram.Bot.Framework.Abstractions;
 
 namespace Deployf.Botf;
 
@@ -8,7 +9,7 @@ public class ChainStorage
 
     public ChainStorage()
     {
-        _chains = new Dictionary<long, ChainItem?>();
+        _chains = new ConcurrentDictionary<long, ChainItem?>();
     }
 
     public ChainItem? Get(long id)
@@ -19,7 +20,11 @@ public ChainStorage()
 
     public void Clear(long id)
     {
-        _chains[id] = null;
+        if(_chains.ContainsKey(id))
+        {
+            _chains[id] = null;
+            _chains.Remove(id);
+        }
     }
 
     public void Set(long id, ChainItem item)

Deployf.Botf/System/ChainTimeoutException.cs

@@ -0,0 +1,11 @@
+namespace Deployf.Botf;
+
+public class ChainTimeoutException : Exception
+{
+    public readonly bool Handled;
+
+    public ChainTimeoutException(bool handled)
+    {
+        Handled = handled;
+    }
+}

Deployf.Botf/System/ConnectionString.cs

@@ -72,6 +72,9 @@ public static BotfOptions Parse(string value)
                         options.AutoCleanReplyKeyboard = autoclean;
                     }
                     break;
+                case "chain_timeout":
+                    options.ChainTimeout = cortage[1].TryParseTimeSpan();
+                    break;
             }
         }
 

Deployf.Botf/System/TimeSpanFormatExtensions.cs

@@ -0,0 +1,21 @@
+namespace Deployf.Botf;
+
+public static class TimeSpanFormatExtensions
+{
+    public static TimeSpan? TryParseTimeSpan(this string format)
+    {
+        if(format == "-1")
+        {
+            return null;
+        }
+
+        if (TimeSpan.TryParse(format, out var result))
+        {
+            return result;
+        }
+        else
+        {
+            throw new FormatException("TimeSpan wrong format");
+        }
+    }
+}

Examples/Deployf.Botf.ChainedExample/Program.cs

@@ -18,7 +18,7 @@ public async Task Start()
     {
         await Send($"Hi! What is your name?");
 
-        var name = await AwaitText();
+        var name = await AwaitText(() => Send("Use /start to try again"));
         await Send($"Hi, {name}! Where are you from?");
 
         var place = await AwaitText();
@@ -59,4 +59,10 @@ public async Task Ex(Exception e)
             Push("Error");
         }
     }
+
+    [On(Handle.ChainTimeout)]
+    public async Task ChainTimeout()
+    {
+        PushL("timeout");
+    }
 }