Merge pull request #1364 from yileicn/master

fix: avoid saving routing instruction args as state

Author: yileicn

BotSharp.Core.UnitTests/Routing/RoutingRuleTests.cs

@@ -0,0 +1,84 @@
+using System.Text.Json;
+using BotSharp.Abstraction.Routing.Models;
+using BotSharp.Core.Agents.Services;
+using Xunit;
+
+namespace BotSharp.Core.UnitTests.Routing;
+
+public class RoutingRuleTests
+{
+    [Fact]
+    public void AllowLlmFill_defaults_to_true_for_existing_rules()
+    {
+        var rule = JsonSerializer.Deserialize<RoutingRule>("""{"field":"department_type","required":true}""");
+
+        Assert.NotNull(rule);
+        Assert.True(rule.AllowLlmFill);
+    }
+
+    [Fact]
+    public void AllowLlmFill_maps_from_json_and_survives_clone()
+    {
+        var rule = JsonSerializer.Deserialize<RoutingRule>("""{"field":"department_type","required":true,"allow_llm_fill":false}""");
+
+        Assert.NotNull(rule);
+        Assert.False(rule.AllowLlmFill);
+        Assert.False(rule.Clone().AllowLlmFill);
+    }
+
+    [Fact]
+    public void MergeRoutingRules_preserves_existing_llm_fill_flag_for_matching_rule()
+    {
+        var existingRules = new List<RoutingRule>
+        {
+            new()
+            {
+                Field = "department_type",
+                Type = "data_validation",
+                Required = true,
+                AllowLlmFill = false
+            }
+        };
+        var incomingRules = new List<RoutingRule>
+        {
+            new()
+            {
+                Field = "department_type",
+                Type = "data_validation",
+                Required = true,
+                AllowLlmFill = true
+            }
+        };
+
+        var mergedRules = MergeRoutingRules(existingRules, incomingRules);
+
+        Assert.False(mergedRules.Single().AllowLlmFill);
+    }
+
+    [Fact]
+    public void MergeRoutingRules_uses_incoming_llm_fill_flag_for_new_rule()
+    {
+        var incomingRules = new List<RoutingRule>
+        {
+            new()
+            {
+                Field = "new_field",
+                Type = "data_validation",
+                Required = true,
+                AllowLlmFill = false
+            }
+        };
+
+        var mergedRules = MergeRoutingRules(existingRules: [], incomingRules);
+
+        Assert.False(mergedRules.Single().AllowLlmFill);
+    }
+
+    private static List<RoutingRule> MergeRoutingRules(List<RoutingRule>? existingRules, List<RoutingRule>? incomingRules)
+    {
+        var method = typeof(AgentService).GetMethod("MergeRoutingRules", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Static);
+        Assert.NotNull(method);
+
+        return Assert.IsType<List<RoutingRule>>(method.Invoke(null, [existingRules, incomingRules]));
+    }
+}

src/Infrastructure/BotSharp.Abstraction/Routing/Models/RoutingRule.cs

@@ -23,6 +23,9 @@ public class RoutingRule
 
     public bool Required { get; set; }
 
+    [JsonPropertyName("allow_llm_fill")]
+    public bool AllowLlmFill { get; set; } = true;
+
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? RedirectTo { get; set; }
 
@@ -51,6 +54,7 @@ public RoutingRule()
         Description = Description,
         FieldType = FieldType,
         Required = Required,
+        AllowLlmFill = AllowLlmFill,
         RedirectTo = RedirectTo,
         RedirectToAgentName = RedirectToAgentName
     };

src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.UpdateAgent.cs

@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Routing.Models;
 using BotSharp.Abstraction.Users.Enums;
 using BotSharp.Abstraction.Users.Models;
 
@@ -32,7 +33,7 @@ public async Task UpdateAgent(Agent agent, AgentField updateField)
         record.FuncVisMode = agent.FuncVisMode;
         record.Profiles = agent.Profiles ?? [];
         record.Labels = agent.Labels ?? [];
-        record.RoutingRules = agent.RoutingRules ?? [];
+        record.RoutingRules = MergeRoutingRules(record.RoutingRules, agent.RoutingRules);
         record.Instruction = agent.Instruction ?? string.Empty;
         record.ChannelInstructions = agent.ChannelInstructions ?? [];
         record.Functions = agent.Functions ?? [];
@@ -54,6 +55,28 @@ public async Task UpdateAgent(Agent agent, AgentField updateField)
         await Task.CompletedTask;
     }
 
+    private static List<RoutingRule> MergeRoutingRules(List<RoutingRule>? existingRules, List<RoutingRule>? incomingRules)
+    {
+        if (incomingRules == null)
+        {
+            return [];
+        }
+
+        foreach (var incomingRule in incomingRules)
+        {
+            var existingRule = existingRules?.FirstOrDefault(x =>
+                string.Equals(x.Field, incomingRule.Field, StringComparison.OrdinalIgnoreCase) &&
+                string.Equals(x.Type, incomingRule.Type, StringComparison.OrdinalIgnoreCase));
+
+            if (existingRule != null)
+            {
+                incomingRule.AllowLlmFill = existingRule.AllowLlmFill;
+            }
+        }
+
+        return incomingRules;
+    }
+
 
     public async Task<string> PatchAgentTemplate(Agent agent)
     {

src/Infrastructure/BotSharp.Core/Routing/RoutingService.cs

@@ -113,13 +113,13 @@ public async Task<RoutableAgent[]> GetRoutableAgents(List<string> profiles)
             Type = x.Type,
             Profiles = x.Profiles,
             RequiredFields = x.RoutingRules
-                .Where(p => p.Required)
+                .Where(p => p.Required && p.AllowLlmFill)
                 .Select(p => new ParameterPropertyDef(p.Field, p.Description, type: p.FieldType)
                 {
                     Required = p.Required
                 }).ToList(),
             OptionalFields = x.RoutingRules
-                .Where(p => !p.Required)
+                .Where(p => !p.Required && p.AllowLlmFill)
                 .Select(p => new ParameterPropertyDef(p.Field, p.Description, type: p.FieldType)
                 {
                     Required = p.Required

src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/Request/RoutingRuleUpdateModel.cs

@@ -11,6 +11,8 @@ public class RoutingRuleUpdateModel
     [JsonPropertyName("field_type")]
     public string? FieldType { get; set; }
     public bool Required { get; set; }
+    [JsonPropertyName("allow_llm_fill")]
+    public bool? AllowLlmFill { get; set; }
     public string? RedirectTo { get; set; }
 
     public RoutingRuleUpdateModel()
@@ -27,6 +29,7 @@ public static RoutingRule ToDomainElement(RoutingRuleUpdateModel model)
             Type = model.Type,
             FieldType = model.FieldType,
             Required = model.Required,
+            AllowLlmFill = model.AllowLlmFill ?? true,
             RedirectTo = model.RedirectTo
         };
     }

src/Plugins/BotSharp.Plugin.MongoStorage/Models/RoutingRuleMongoElement.cs

@@ -11,6 +11,7 @@ public class RoutingRuleMongoElement
     public string? RedirectTo { get; set; }
     public string Type { get; set; } = default!;
     public string FieldType { get; set; } = default!;
+    public bool AllowLlmFill { get; set; } = true;
 
     public static RoutingRuleMongoElement ToMongoElement(RoutingRule routingRule)
     {
@@ -21,7 +22,8 @@ public static RoutingRuleMongoElement ToMongoElement(RoutingRule routingRule)
             Required = routingRule.Required,
             RedirectTo = routingRule.RedirectTo,
             Type = routingRule.Type,
-            FieldType = routingRule.FieldType
+            FieldType = routingRule.FieldType,
+            AllowLlmFill = routingRule.AllowLlmFill
         };
     }
 
@@ -36,7 +38,8 @@ public static RoutingRule ToDomainElement(string agentId, string agentName, Rout
             Required = rule.Required,
             RedirectTo = rule.RedirectTo,
             Type = rule.Type,
-            FieldType= rule.FieldType
+            FieldType = rule.FieldType,
+            AllowLlmFill = rule.AllowLlmFill
         };
     }