Merge pull request #371 from iceljc/features/add-state-change-log

Features/add state change log

Author: Oceania2018

src/Infrastructure/BotSharp.Abstraction/Conversations/ConversationHookBase.cs

@@ -29,7 +29,7 @@ public IConversationHook SetConversation(Conversation conversation)
     public virtual Task OnStateLoaded(ConversationState state)
         => Task.CompletedTask;
 
-    public virtual Task OnStateChanged(string name, string preValue, string currentValue)
+    public virtual Task OnStateChanged(StateChangeModel stateChange)
         => Task.CompletedTask;
 
     public virtual Task OnDialogRecordLoaded(RoleDialogModel dialog)

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationHook.cs

@@ -43,7 +43,7 @@ public interface IConversationHook
     Task OnDialogRecordLoaded(RoleDialogModel dialog);
 
     Task OnStateLoaded(ConversationState state);
-    Task OnStateChanged(string name, string preValue, string currentValue);
+    Task OnStateChanged(StateChangeModel stateChange);
 
     Task OnMessageReceived(RoleDialogModel message);
     Task OnPostbackMessageReceived(RoleDialogModel message, PostbackMessageModel replyMsg);

src/Infrastructure/BotSharp.Abstraction/Conversations/Models/StateChangeModel.cs

@@ -0,0 +1,19 @@
+namespace BotSharp.Abstraction.Conversations.Models;
+
+public class StateChangeModel
+{
+    [JsonPropertyName("conversation_id")]
+    public string ConversationId { get; set; }
+
+    [JsonPropertyName("message_id")]
+    public string MessageId { get; set; }
+
+    [JsonPropertyName("name")]
+    public string Name { get; set; }
+
+    [JsonPropertyName("before_value")]
+    public string BeforeValue { get; set; }
+
+    [JsonPropertyName("after_value")]
+    public string AfterValue { get; set; }
+}

src/Infrastructure/BotSharp.Abstraction/Loggers/Models/StateChangeOutputModel.cs

@@ -0,0 +1,7 @@
+namespace BotSharp.Abstraction.Loggers.Models;
+
+public class StateChangeOutputModel : StateChangeModel
+{
+    [JsonPropertyName("created_at")]
+    public DateTime CreateTime { get; set; } = DateTime.UtcNow;
+}

src/Infrastructure/BotSharp.Abstraction/Messaging/MessageParser.cs

@@ -45,6 +45,10 @@ public MessageParser()
                 {
                     res = JsonSerializer.Deserialize<GenericTemplateMessage<GenericElement>>(jsonText, options);
                 }
+                else if (elementType == typeof(ButtonElement).Name)
+                {
+                    res = JsonSerializer.Deserialize<GenericTemplateMessage<ButtonElement>>(jsonText, options);
+                }
             }
         }
 
@@ -80,6 +84,10 @@ public MessageParser()
                 {
                     res = JsonSerializer.Deserialize<GenericTemplateMessage<GenericElement>>(jsonText, options);
                 }
+                else if (elementType == typeof(ButtonElement).Name)
+                {
+                    res = JsonSerializer.Deserialize<GenericTemplateMessage<ButtonElement>>(jsonText, options);
+                }
             }
         }
 

src/Infrastructure/BotSharp.Core/Conversations/Services/ConversationStateService.cs

@@ -52,12 +52,20 @@ public IConversationStateService SetState<T>(string name, T value, bool isNeedVe
         if (!ContainsState(name) || preValue != currentValue)
         {
             _logger.LogInformation($"[STATE] {name} = {value}");
+            var routingCtx = _services.GetRequiredService<IRoutingContext>();
+
             foreach (var hook in hooks)
             {
-                hook.OnStateChanged(name, preValue, currentValue).Wait();
+                hook.OnStateChanged(new StateChangeModel
+                {
+                    ConversationId = _conversationId,
+                    MessageId = routingCtx.MessageId,
+                    Name = name,
+                    BeforeValue = preValue,
+                    AfterValue = currentValue
+                }).Wait();
             }
-
-            var routingCtx = _services.GetRequiredService<IRoutingContext>();
+            
             var newPair = new StateKeyValue
             {
                 Key = name,
@@ -118,7 +126,7 @@ public Dictionary<string, string> Load(string conversationId)
                         state.Value.Values.Add(new StateValue
                         {
                             Data = value.Data,
-                            MessageId = !string.IsNullOrEmpty(curMsgId) ? curMsgId : value.MessageId,
+                            MessageId = curMsgId,
                             Active = false,
                             ActiveRounds = value.ActiveRounds,
                             UpdateTime = DateTime.UtcNow
@@ -178,7 +186,7 @@ public void CleanStates()
             value.Values.Add(new StateValue
             {
                 Data = lastValue.Data,
-                MessageId = !string.IsNullOrEmpty(curMsgId) ? curMsgId : lastValue.MessageId,
+                MessageId = curMsgId,
                 Active = false,
                 ActiveRounds = lastValue.ActiveRounds,
                 UpdateTime = utcNow

src/Infrastructure/BotSharp.Core/Repository/FileRepository/FileRepository.Conversation.cs

@@ -407,6 +407,11 @@ public List<string> GetIdleConversations(int batchSize, int messageLimit, int bu
             var utcNow = DateTime.UtcNow;
             var dir = Path.Combine(_dbSettings.FileRepository, _conversationSettings.DataDir);
 
+            if (!Directory.Exists(dir))
+            {
+                Directory.CreateDirectory(dir);
+            }
+
             if (batchSize <= 0 || batchSize > batchLimit)
             {
                 batchSize = batchLimit;

src/Plugins/BotSharp.Plugin.ChatHub/Hooks/StreamingLogHook.cs

@@ -213,6 +213,12 @@ public override async Task OnBreakpointUpdated(string conversationId, bool reset
         await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(input));
     }
 
+    public override async Task OnStateChanged(StateChangeModel stateChange)
+    {
+        if (stateChange == null) return;
+
+        await _chatHub.Clients.User(_user.Id).SendAsync("OnStateChangeGenerated", BuildStateChangeLog(stateChange));
+    }
     #endregion
 
     #region IRoutingHook
@@ -379,4 +385,19 @@ private string BuildStateLog(string conversationId, Dictionary<string, string> s
 
         return JsonSerializer.Serialize(log, _options.JsonSerializerOptions);
     }
+
+    private string BuildStateChangeLog(StateChangeModel stateChange)
+    {
+        var log = new StateChangeOutputModel
+        {
+            ConversationId = stateChange.ConversationId,
+            MessageId = stateChange.MessageId,
+            Name = stateChange.Name,
+            BeforeValue = stateChange.BeforeValue,
+            AfterValue = stateChange.AfterValue,
+            CreateTime = DateTime.UtcNow
+        };
+
+        return JsonSerializer.Serialize(log, _options.JsonSerializerOptions);
+    }
 }