Merge pull request SciSharp#1302 from yileicn/master

Add OnRoutingRulesLoaded hook to allow rewriting routing rules

Author: Oceania2018

src/Infrastructure/BotSharp.Abstraction/Routing/IRoutingHook.cs

@@ -1,5 +1,6 @@
 using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Hooks;
+using BotSharp.Abstraction.Routing.Models;
 
 namespace BotSharp.Abstraction.Routing;
 
@@ -28,4 +29,13 @@ Task OnAgentReplaced(string fromAgentId, string toAgentId, string? reason = null
 
     Task OnAgentQueueEmptied(string agentId, string? reason = null)
         => Task.CompletedTask;
+
+    /// <summary>
+    /// Called when routing rules are loaded for an agent (GetRulesByAgentName / GetRulesByAgentId).
+    /// Hooks can modify rules in place to rewrite or filter rules before they are returned.
+    /// </summary>
+    /// <param name="agentId">Agent id the rules belong to.</param>
+    /// <param name="rules">Mutable list of routing rules.</param>
+    Task OnRoutingRulesLoaded(string agentId, IList<RoutingRule> rules)
+        => Task.CompletedTask;
 }

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

@@ -37,6 +37,21 @@ public override string ToString()
 
     public RoutingRule()
     {
-        
     }
+
+    /// <summary>
+    /// Returns a defensive copy so hook mutations do not affect cached/shared instances.
+    /// </summary>
+    public RoutingRule Clone() => new RoutingRule
+    {
+        AgentId = AgentId,
+        AgentName = AgentName,
+        Type = Type,
+        Field = Field,
+        Description = Description,
+        FieldType = FieldType,
+        Required = Required,
+        RedirectTo = RedirectTo,
+        RedirectToAgentName = RedirectToAgentName
+    };
 }

src/Infrastructure/BotSharp.Core/Routing/Hooks/RoutingAgentHook.cs

@@ -68,7 +68,11 @@ public override async Task<bool> OnFunctionsLoaded(List<FunctionDef> functions)
         {
             // check if enabled the routing rule
             var routing = _services.GetRequiredService<IRoutingService>();
-            var rules = await routing.GetRulesByAgentId(_agent.Id);
+            var rules = (await routing.GetRulesByAgentId(_agent.Id)).ToList();
+            if (!rules.IsNullOrEmpty())
+            {
+                await HookEmitter.Emit<IRoutingHook>(_services, async hook => await hook.OnRoutingRulesLoaded(_agent.Id, rules), _agent.Id);
+            }
             var rule = rules.FirstOrDefault(x => x.Type == RuleType.Fallback);
             if (rule != null)
             {

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

@@ -16,13 +16,13 @@ public partial class RoutingService
         var args = JsonSerializer.Deserialize<RoutingArgs>(message.FunctionArgs);
         var routing = _services.GetRequiredService<IRoutingService>();
 
-        var routingRules = await routing.GetRulesByAgentName(args.AgentName);
-
-        if (routingRules == null || !routingRules.Any())
+        var routingRules = (await routing.GetRulesByAgentName(args.AgentName)).ToList();
+        if (routingRules.IsNullOrEmpty())
         {
             agentId = message.CurrentAgentId;
             return (false, reason, agentId);
         }
+        await HookEmitter.Emit<IRoutingHook>(_services, async hook => await hook.OnRoutingRulesLoaded(routingRules[0].AgentId, routingRules), routingRules[0].AgentId);
 
         agentId = routingRules.First().AgentId;
         // Add routed agent

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

@@ -149,6 +149,7 @@ public async Task<RoutingRule[]> GetRulesByAgentName(string name)
         var records = await GetRoutingRecords();
         return records
             .Where(x => x.AgentName.ToLower() == name.ToLower())
+            .Select(r => r.Clone())
             .ToArray();
     }
 
@@ -157,6 +158,7 @@ public async Task<RoutingRule[]> GetRulesByAgentId(string id)
         var records = await GetRoutingRecords();
         return records
             .Where(x => x.AgentId == id)
+            .Select(r => r.Clone())
             .ToArray();
     }
 }