forked from SciSharp/BotSharp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRuleEngine.cs
More file actions
655 lines (566 loc) · 22 KB
/
RuleEngine.cs
File metadata and controls
655 lines (566 loc) · 22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
namespace BotSharp.Core.Rules.Engines;
public class RuleEngine : IRuleEngine
{
private readonly IServiceProvider _services;
private readonly ILogger<RuleEngine> _logger;
public RuleEngine(
IServiceProvider services,
ILogger<RuleEngine> logger)
{
_services = services;
_logger = logger;
}
public async Task<IEnumerable<string>> Triggered(IRuleTrigger trigger, string text, IEnumerable<MessageState>? states = null, RuleTriggerOptions? options = null)
{
var newConversationIds = new List<string>();
// Pull all user defined rules
var agentService = _services.GetRequiredService<IAgentService>();
var agents = await agentService.GetAgents(options?.AgentFilter ?? new AgentFilter
{
Pager = new Pagination
{
Size = 1000
}
});
// Trigger agents
var filteredAgents = agents.Items.Where(x => x.Rules.Exists(r => r.TriggerName.IsEqualTo(trigger.Name) && !x.Disabled)).ToList();
foreach (var agent in filteredAgents)
{
var rule = agent.Rules.FirstOrDefault(x => x.TriggerName.IsEqualTo(trigger.Name) && !x.Disabled);
if (rule == null)
{
continue;
}
var ruleConfig = rule.Config;
var ruleFlowTopologyName = options?.Flow?.TopologyName ?? ruleConfig?.TopologyName;
if (!string.IsNullOrEmpty(ruleFlowTopologyName))
{
// Execute graph
// 1. Load graph
var graph = await LoadGraph(ruleFlowTopologyName, agent, trigger, options?.Flow);
if (graph == null)
{
continue;
}
// 2. Get root node
var param = options?.Flow?.Parameters;
var rootNodeName = param != null ? param.GetValueOrDefault("root_node_name")?.ToString() : null;
var root = graph.GetRootNode(rootNodeName);
if (root == null)
{
graph.Clear();
continue;
}
// 3. Execute graph
var execResults = new List<RuleFlowStepResult>();
await ExecuteGraphNode(root, graph, agent, trigger, text, states, null, options, execResults);
graph.Clear();
// Get conversation id to support legacy features
var convIds = execResults.Where(x => x.Success && x.Data.TryGetValue("conversation_id", out _))
.Select(x => x.Data.GetValueOrDefault("conversation_id", string.Empty))
.Where(x => !string.IsNullOrEmpty(x))
.ToList();
newConversationIds.AddRange(convIds);
}
else
{
var convId = await SendMessageToAgent(agent, trigger, text, states);
newConversationIds.Add(convId);
}
}
return newConversationIds;
}
public async Task ExecuteGraphNode(RuleNode node, RuleGraph graph, string agentId, IRuleTrigger trigger, RuleNodeExecutionOptions options)
{
if (node == null || graph == null || options == null)
{
return;
}
var agentService = _services.GetRequiredService<IAgentService>();
var agent = await agentService.GetAgent(agentId);
var triggerOptions = new RuleTriggerOptions
{
Flow = options.Flow,
JsonOptions = options.JsonOptions
};
var execResults = new List<RuleFlowStepResult>();
await ExecuteGraphNode(
node, graph,
agent, trigger,
options.Text,
options.States,
null,
triggerOptions,
execResults);
graph.Clear();
}
#region Graph
private async Task<RuleGraph?> LoadGraph(string name, Agent agent, IRuleTrigger trigger, RuleFlowOptions? options)
{
var flow = _services.GetServices<IRuleFlow<RuleGraph>>().FirstOrDefault(x => x.Name.IsEqualTo(name));
if (flow == null)
{
return null;
}
try
{
var config = await flow.GetTopologyConfigAsync(options: new()
{
TopologyName = name
});
var topologyId = config?.TopologyId;
if (string.IsNullOrEmpty(topologyId))
{
return null;
}
var param = new Dictionary<string, object>(options?.Parameters ?? []);
param["agent"] = param.GetValueOrDefault("agent", agent.Name);
param["agent_id"] = param.GetValueOrDefault("agent_id", agent.Id);
param["trigger"] = param.GetValueOrDefault("trigger", trigger.Name);
return await flow.GetTopologyAsync(topologyId, options: new()
{
Query = options?.Query,
Parameters = param
});
}
catch (Exception ex)
{
_logger.LogError(ex, $"Error when loading graph (name: {name}, agent: {agent}, trigger: {trigger?.Name})");
return null;
}
}
private async Task ExecuteGraphNode(
RuleNode node,
RuleGraph graph,
Agent agent,
IRuleTrigger trigger,
string text,
IEnumerable<MessageState>? states,
Dictionary<string, string?>? data,
RuleTriggerOptions? options,
List<RuleFlowStepResult> results)
{
try
{
if (options?.Flow?.TraversalAlgorithm?.IsEqualTo("bfs") == true)
{
await ExecuteGraphNodeBfs(node, graph, agent, trigger, text, states, data, options, results);
}
else
{
await ExecuteGraphNodeDfs(node, graph, agent, trigger, text, states, data, options, results);
}
}
catch { }
}
private async Task ExecuteGraphNodeDfs(
RuleNode node,
RuleGraph graph,
Agent agent,
IRuleTrigger trigger,
string text,
IEnumerable<MessageState>? states,
Dictionary<string, string?>? data,
RuleTriggerOptions? options,
List<RuleFlowStepResult> results)
{
// Check whether the action nodes have been visited more than limit
var visited = results.Count();
var param = options?.Flow?.Parameters ?? [];
var maxRecursion = int.TryParse(param.GetValueOrDefault("max_recursion")?.ToString(), out var depth) && depth > 0
? depth : RuleConstant.MAX_GRAPH_RECURSION;
var innerData = new Dictionary<string, string?>(data ?? []);
if (visited >= maxRecursion)
{
_logger.LogWarning("Exceed max graph recursion {MaxRecursion} (agent {Agent} and trigger {Trigger}).",
maxRecursion, agent.Name, trigger.Name);
return;
}
// Get current node successors
var nextNodes = graph.GetChildrenNodes(node);
if (nextNodes.IsNullOrEmpty())
{
return;
}
// Visit neighbor nodes
foreach (var (nextNode, edge) in nextNodes)
{
// Build context
var context = new RuleFlowContext
{
Node = nextNode,
Edge = edge,
Graph = graph,
Text = text,
Parameters = BuildParameters(nextNode.Config, states, innerData),
PrevStepResults = results,
JsonOptions = options?.JsonOptions
};
if (RuleConstant.CONDITION_NODE_TYPES.Contains(nextNode.Type, StringComparer.OrdinalIgnoreCase))
{
// Execute condition node
var conditionResult = await ExecuteCondition(nextNode, edge, graph, agent, trigger, context);
if (conditionResult == null)
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = false,
ErrorMessage = $"Unable to find condition {nextNode.Name}."
}, nextNode));
continue;
}
results.Add(RuleFlowStepResult.FromResult(conditionResult, nextNode));
// If condition result is true, then execute the next node, otherwise skip
if (conditionResult.Success)
{
await ExecuteGraphNodeDfs(nextNode, graph, agent, trigger, text, states, context.Parameters, options, results);
}
else
{
_logger.LogInformation("Condition {ConditionName} evaluated to false, skipping next node (agent {Agent} and trigger {Trigger}).",
nextNode.Name, agent.Name, trigger.Name);
}
}
else if (RuleConstant.ACTION_NODE_TYPES.Contains(nextNode.Type, StringComparer.OrdinalIgnoreCase))
{
// Execute action node
var actionResult = await ExecuteAction(nextNode, edge, graph, agent, trigger, context);
if (actionResult == null)
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = false,
ErrorMessage = $"Unable to find action {nextNode.Name}."
}, nextNode));
continue;
}
results.Add(RuleFlowStepResult.FromResult(actionResult, nextNode));
if (actionResult.IsDelayed)
{
continue;
}
await ExecuteGraphNodeDfs(nextNode, graph, agent, trigger, text, states, context.Parameters, options, results);
}
else
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = true,
Response = $"Pass through node {nextNode.Name}."
}, nextNode));
await ExecuteGraphNodeDfs(nextNode, graph, agent, trigger, text, states, context.Parameters, options, results);
}
}
}
private async Task ExecuteGraphNodeBfs(
RuleNode root,
RuleGraph graph,
Agent agent,
IRuleTrigger trigger,
string text,
IEnumerable<MessageState>? states,
Dictionary<string, string?>? data,
RuleTriggerOptions? options,
List<RuleFlowStepResult> results)
{
var param = options?.Flow?.Parameters ?? [];
var maxRecursion = int.TryParse(param.GetValueOrDefault("max_recursion")?.ToString(), out var depth) && depth > 0
? depth : RuleConstant.MAX_GRAPH_RECURSION;
var innerData = new Dictionary<string, string?>(data ?? []);
// Each queue entry is (node-to-process, edge-that-leads-to-it)
var queue = new Queue<(RuleNode Node, RuleEdge Edge)>();
foreach (var (childNode, edge) in graph.GetChildrenNodes(root))
{
queue.Enqueue((childNode, edge));
}
while (queue.Count > 0)
{
if (results.Count >= maxRecursion)
{
_logger.LogWarning("Exceed max graph nodes {MaxNodes} during BFS (agent {Agent} and trigger {Trigger}).",
maxRecursion, agent.Name, trigger.Name);
break;
}
var (nextNode, nextEdge) = queue.Dequeue();
var context = new RuleFlowContext
{
Node = nextNode,
Edge = nextEdge,
Graph = graph,
Text = text,
Parameters = BuildParameters(nextNode.Config, states, innerData),
PrevStepResults = results,
JsonOptions = options?.JsonOptions
};
if (RuleConstant.CONDITION_NODE_TYPES.Contains(nextNode.Type, StringComparer.OrdinalIgnoreCase))
{
// Execute condition node
var conditionResult = await ExecuteCondition(nextNode, nextEdge, graph, agent, trigger, context);
innerData = new(context.Parameters ?? []);
if (conditionResult == null)
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = false,
ErrorMessage = $"Unable to find condition {nextNode.Name}."
}, nextNode));
continue;
}
results.Add(RuleFlowStepResult.FromResult(conditionResult, nextNode));
// If condition is true, enqueue children; otherwise skip the branch
if (conditionResult.Success)
{
foreach (var (childNode, childEdge) in graph.GetChildrenNodes(nextNode))
{
queue.Enqueue((childNode, childEdge));
}
}
else
{
_logger.LogInformation("Condition {ConditionName} evaluated to false, skipping next node (agent {Agent} and trigger {Trigger}).",
nextNode.Name, agent.Name, trigger.Name);
}
}
else if (RuleConstant.ACTION_NODE_TYPES.Contains(nextNode.Type, StringComparer.OrdinalIgnoreCase))
{
// Execute action node
var actionResult = await ExecuteAction(nextNode, nextEdge, graph, agent, trigger, context);
innerData = new(context.Parameters ?? []);
if (actionResult == null)
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = false,
ErrorMessage = $"Unable to find action {nextNode.Name}."
}, nextNode));
continue;
}
results.Add(RuleFlowStepResult.FromResult(actionResult, nextNode));
if (!actionResult.IsDelayed)
{
foreach (var (childNode, childEdge) in graph.GetChildrenNodes(nextNode))
{
queue.Enqueue((childNode, childEdge));
}
}
}
else
{
results.Add(RuleFlowStepResult.FromResult(new()
{
Success = true,
Response = $"Pass through node {nextNode.Name}."
}, nextNode));
foreach (var (childNode, childEdge) in graph.GetChildrenNodes(nextNode))
{
queue.Enqueue((childNode, childEdge));
}
}
}
}
#endregion
#region Action
private async Task<RuleNodeResult?> ExecuteAction(
RuleNode node,
RuleEdge incomingEdge,
RuleGraph graph,
Agent agent,
IRuleTrigger trigger,
RuleFlowContext context)
{
try
{
// Find the matching action
var foundAction = GetRuleAction(node, agent, trigger);
if (foundAction == null)
{
var errorMsg = $"No rule action {node?.Name} is found";
_logger.LogWarning(errorMsg);
return null;
}
_logger.LogInformation("Start execution rule action {ActionName} for agent {AgentId} with trigger {TriggerName}",
foundAction.Name, agent.Id, trigger.Name);
var hooks = _services.GetHooks<IRuleTriggerHook>(agent.Id);
foreach (var hook in hooks)
{
await hook.BeforeRuleActionExecuting(agent, node, incomingEdge, trigger, context);
}
// Execute action
context.Parameters ??= [];
var result = await foundAction.ExecuteAsync(agent, trigger, context);
foreach (var hook in hooks)
{
await hook.AfterRuleActionExecuted(agent, node, incomingEdge, trigger, context, result);
}
return result;
}
catch (Exception ex)
{
_logger.LogError(ex, "Error executing rule action {ActionName} for agent {AgentId}", node?.Name, agent.Id);
return new RuleNodeResult
{
Success = false,
ErrorMessage = ex.Message
};
}
}
// Find the matching action
private IRuleAction? GetRuleAction(RuleNode node, Agent agent, IRuleTrigger trigger)
{
var actions = _services.GetServices<IRuleAction>()
.Where(x => x.Name.IsEqualTo(node?.Name))
.ToList();
var found = actions.FirstOrDefault(x => !string.IsNullOrEmpty(x.AgentId) && x.AgentId.IsEqualTo(agent.Id) && x.Triggers?.Contains(trigger.Name) == true);
if (found != null)
{
return found;
}
found = actions.FirstOrDefault(x => !string.IsNullOrEmpty(x.AgentId) && x.AgentId.IsEqualTo(agent.Id));
if (found != null)
{
return found;
}
found = actions.FirstOrDefault(x => x.Triggers?.Contains(trigger.Name, StringComparer.OrdinalIgnoreCase) == true);
if (found != null)
{
return found;
}
found = actions.FirstOrDefault();
if (found != null)
{
return found;
}
return null;
}
#endregion
#region Condition
private async Task<RuleNodeResult?> ExecuteCondition(
RuleNode node,
RuleEdge incomingEdge,
RuleGraph graph,
Agent agent,
IRuleTrigger trigger,
RuleFlowContext context)
{
try
{
// Find the matching condition
var foundCondition = GetRuleCondition(node, agent, trigger);
if (foundCondition == null)
{
var errorMsg = $"No rule condition {node?.Name} is found";
_logger.LogWarning(errorMsg);
return null;
}
_logger.LogInformation("Start execution rule condition {ConditionName} for agent {AgentId} with trigger {TriggerName}",
foundCondition.Name, agent.Id, trigger.Name);
var hooks = _services.GetHooks<IRuleTriggerHook>(agent.Id);
foreach (var hook in hooks)
{
await hook.BeforeRuleConditionExecuting(agent, node, incomingEdge, trigger, context);
}
// Execute condition
context.Parameters ??= [];
var result = await foundCondition.EvaluateAsync(agent, trigger, context);
foreach (var hook in hooks)
{
await hook.AfterRuleConditionExecuted(agent, node, incomingEdge, trigger, context, result);
}
return result;
}
catch (Exception ex)
{
_logger.LogError(ex, "Error executing rule condition {ConditionName} for agent {AgentId}", node?.Name, agent.Id);
return new RuleNodeResult
{
Success = false,
ErrorMessage = ex.Message
};
}
}
// Find the matching condition
private IRuleCondition? GetRuleCondition(RuleNode node, Agent agent, IRuleTrigger trigger)
{
var conditions = _services.GetServices<IRuleCondition>()
.Where(x => x.Name.IsEqualTo(node?.Name))
.ToList();
var found = conditions.FirstOrDefault(x => !string.IsNullOrEmpty(x.AgentId) && x.AgentId.IsEqualTo(agent.Id) && x.Triggers?.Contains(trigger.Name) == true);
if (found != null)
{
return found;
}
found = conditions.FirstOrDefault(x => !string.IsNullOrEmpty(x.AgentId) && x.AgentId.IsEqualTo(agent.Id));
if (found != null)
{
return found;
}
found = conditions.FirstOrDefault(x => x.Triggers?.Contains(trigger.Name, StringComparer.OrdinalIgnoreCase) == true);
if (found != null)
{
return found;
}
found = conditions.FirstOrDefault();
if (found != null)
{
return found;
}
return null;
}
#endregion
#region Private methods
private Dictionary<string, string?> BuildParameters(
Dictionary<string, string?>? config,
IEnumerable<MessageState>? states,
Dictionary<string, string?>? param = null)
{
var dict = new Dictionary<string, string?>();
if (config != null)
{
dict = new(config);
}
if (!states.IsNullOrEmpty())
{
foreach (var state in states!)
{
dict[state.Key] = state.Value?.ConvertToString();
}
}
if (!param.IsNullOrEmpty())
{
foreach (var pair in param!)
{
dict[pair.Key] = pair.Value;
}
}
return dict;
}
#endregion
#region Legacy conversation
private async Task<string> SendMessageToAgent(Agent agent, IRuleTrigger trigger, string text, IEnumerable<MessageState>? states = null)
{
var convService = _services.GetRequiredService<IConversationService>();
var conv = await convService.NewConversation(new Conversation
{
Channel = trigger.Channel,
Title = text,
AgentId = agent.Id
});
var message = new RoleDialogModel(AgentRole.User, text);
var allStates = new List<MessageState>
{
new("channel", trigger.Channel)
};
if (!states.IsNullOrEmpty())
{
allStates.AddRange(states!);
}
await convService.SetConversationId(conv.Id, allStates);
await convService.SendMessage(agent.Id,
message,
null,
msg => Task.CompletedTask);
await convService.SaveStates();
return conv.Id;
}
#endregion
}