mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-22 08:38:13 +02:00
feat: add workflow graph constraints fixtures
This commit is contained in:
Abhishek Kumar
parent
6d93be3ef6
commit
5a358d4d29
38 changed files with 447 additions and 49 deletions
337
api/services/workflow/workflow_graph.py
Normal file
337
api/services/workflow/workflow_graph.py
Normal file
|
|
@ -0,0 +1,337 @@
|
|||
import re
|
||||
from collections import Counter
|
||||
from typing import Dict, List, Set
|
||||
|
||||
from api.services.workflow.dto import EdgeDataDTO, NodeType, ReactFlowDTO
|
||||
from api.services.workflow.errors import ItemKind, WorkflowError
|
||||
from api.services.workflow.node_specs import REGISTRY
|
||||
|
||||
# Regex for matching {{ variable }} template placeholders.
|
||||
# Captures: group(1) = variable path, group(2) = filter name, group(3) = filter value.
|
||||
# Shared with api.utils.template_renderer via import.
|
||||
TEMPLATE_VAR_PATTERN = r"\{\{\s*([^|\s}]+)(?:\s*\|\s*([^:}]+)(?::([^}]+))?)?\s*\}\}"
|
||||
|
||||
# Variables injected by the system at runtime, not from source data.
|
||||
_SYSTEM_VARIABLES = {"campaign_id", "provider", "source_uuid"}
|
||||
|
||||
|
||||
def extract_template_variables(text: str) -> Set[str]:
|
||||
"""Extract template variable names from a string, excluding nested paths,
|
||||
variables with a fallback filter, and system-injected variables."""
|
||||
variables: Set[str] = set()
|
||||
for match in re.finditer(TEMPLATE_VAR_PATTERN, text):
|
||||
var_name = match.group(1).strip()
|
||||
filter_name = match.group(2).strip() if match.group(2) else None
|
||||
|
||||
# Skip nested paths (runtime-resolved, e.g. gathered_context.city)
|
||||
if "." in var_name:
|
||||
continue
|
||||
# Skip variables with a fallback (they have a default value)
|
||||
# Supports both {{var | default}} and legacy {{var | fallback:default}}
|
||||
if filter_name is not None:
|
||||
continue
|
||||
# Skip system-injected variables
|
||||
if var_name in _SYSTEM_VARIABLES:
|
||||
continue
|
||||
|
||||
variables.add(var_name)
|
||||
return variables
|
||||
|
||||
|
||||
class Edge:
|
||||
def __init__(self, source: str, target: str, data: EdgeDataDTO):
|
||||
self.source = source
|
||||
self.target = target
|
||||
|
||||
self.label = data.label
|
||||
self.condition = data.condition
|
||||
self.transition_speech = data.transition_speech
|
||||
|
||||
self.data = data
|
||||
|
||||
def get_function_name(self):
|
||||
return re.sub(r"[^a-z0-9]", "_", self.label.lower())
|
||||
|
||||
def __eq__(self, other):
|
||||
if not isinstance(other, Edge):
|
||||
return False
|
||||
return self.source == other.source and self.target == other.target
|
||||
|
||||
def __hash__(self):
|
||||
return hash((self.source, self.target))
|
||||
|
||||
|
||||
class Node:
|
||||
def __init__(self, id: str, node_type: NodeType, data):
|
||||
self.id, self.node_type, self.data = id, node_type, data
|
||||
self.out: Dict[str, "Node"] = {} # forward nodes
|
||||
self.out_edges: List[Edge] = [] # forward edges with properties
|
||||
|
||||
# name/is_start/is_end live on every per-type data class (base).
|
||||
self.name = data.name
|
||||
self.is_start = data.is_start
|
||||
self.is_end = data.is_end
|
||||
|
||||
# Type-specific fields — read with getattr so this works for every
|
||||
# node variant in the discriminated union.
|
||||
self.prompt = getattr(data, "prompt", None)
|
||||
self.is_static = getattr(data, "is_static", False)
|
||||
self.allow_interrupt = getattr(data, "allow_interrupt", False)
|
||||
self.extraction_enabled = getattr(data, "extraction_enabled", False)
|
||||
self.extraction_prompt = getattr(data, "extraction_prompt", None)
|
||||
self.extraction_variables = getattr(data, "extraction_variables", None)
|
||||
self.add_global_prompt = getattr(data, "add_global_prompt", True)
|
||||
self.greeting = getattr(data, "greeting", None)
|
||||
self.greeting_type = getattr(data, "greeting_type", None)
|
||||
self.greeting_recording_id = getattr(data, "greeting_recording_id", None)
|
||||
self.detect_voicemail = getattr(data, "detect_voicemail", False)
|
||||
self.delayed_start = getattr(data, "delayed_start", False)
|
||||
self.delayed_start_duration = getattr(data, "delayed_start_duration", None)
|
||||
self.tool_uuids = getattr(data, "tool_uuids", None)
|
||||
self.document_uuids = getattr(data, "document_uuids", None)
|
||||
self.pre_call_fetch_enabled = getattr(data, "pre_call_fetch_enabled", False)
|
||||
self.pre_call_fetch_url = getattr(data, "pre_call_fetch_url", None)
|
||||
self.pre_call_fetch_credential_uuid = getattr(
|
||||
data, "pre_call_fetch_credential_uuid", None
|
||||
)
|
||||
|
||||
self.data = data
|
||||
|
||||
|
||||
class WorkflowGraph:
|
||||
"""
|
||||
*All* business invariants (acyclic, cardinality, etc.) are verified here.
|
||||
The constructor accepts a validated ReactFlowDTO.
|
||||
"""
|
||||
|
||||
def __init__(self, dto: ReactFlowDTO):
|
||||
# build adjacency list. n.type comes off the discriminated-union
|
||||
# variant as a literal string; coerce to NodeType for downstream
|
||||
# comparisons.
|
||||
self.nodes: Dict[str, Node] = {
|
||||
n.id: Node(n.id, NodeType(n.type), n.data) for n in dto.nodes
|
||||
}
|
||||
|
||||
# Store all edges
|
||||
self.edges: List[Edge] = []
|
||||
|
||||
for e in dto.edges:
|
||||
source_node = self.nodes[e.source]
|
||||
target_node = self.nodes[e.target]
|
||||
|
||||
# Create the edge with properties from dto
|
||||
edge = Edge(source=e.source, target=e.target, data=e.data)
|
||||
|
||||
# Add to the edge list
|
||||
self.edges.append(edge)
|
||||
|
||||
# Add to the source node's outgoing edges
|
||||
source_node.out_edges.append(edge)
|
||||
|
||||
# Set up the node references for backward compatibility
|
||||
source_node.out[target_node.id] = target_node
|
||||
|
||||
self._validate_graph()
|
||||
|
||||
# Get a reference to the start node
|
||||
self.start_node_id = [n.id for n in dto.nodes if n.data.is_start][0]
|
||||
|
||||
# Get a reference to the global node
|
||||
try:
|
||||
self.global_node_id = [
|
||||
n.id for n in dto.nodes if n.type == NodeType.globalNode
|
||||
][0]
|
||||
except IndexError:
|
||||
self.global_node_id = None
|
||||
|
||||
# -----------------------------------------------------------
|
||||
# template variable extraction
|
||||
# -----------------------------------------------------------
|
||||
def get_required_template_variables(self) -> Set[str]:
|
||||
"""Extract all template variables referenced in node prompts/greetings
|
||||
and edge transition speeches.
|
||||
|
||||
Scans:
|
||||
- Start node: prompt, greeting
|
||||
- Agent / End / Global nodes: prompt
|
||||
- All edges: transition_speech
|
||||
|
||||
Returns a set of top-level variable names that the workflow expects
|
||||
from the source data (excluding nested paths, fallback vars, and
|
||||
system-injected vars).
|
||||
"""
|
||||
variables: Set[str] = set()
|
||||
|
||||
for node in self.nodes.values():
|
||||
if node.node_type in (
|
||||
NodeType.startNode,
|
||||
NodeType.agentNode,
|
||||
NodeType.endNode,
|
||||
NodeType.globalNode,
|
||||
):
|
||||
if node.prompt:
|
||||
variables |= extract_template_variables(node.prompt)
|
||||
|
||||
# greeting is only relevant on the start node
|
||||
if node.node_type == NodeType.startNode and node.greeting:
|
||||
variables |= extract_template_variables(node.greeting)
|
||||
|
||||
for edge in self.edges:
|
||||
if edge.transition_speech:
|
||||
variables |= extract_template_variables(edge.transition_speech)
|
||||
|
||||
return variables
|
||||
|
||||
# -----------------------------------------------------------
|
||||
# validators
|
||||
# -----------------------------------------------------------
|
||||
def _validate_graph(self) -> None:
|
||||
errors: list[WorkflowError] = []
|
||||
|
||||
# TODO: Figure out what kind of cyclic contraints can be applied, since there can be a cycle in the graph
|
||||
# try:
|
||||
# self._assert_acyclic()
|
||||
# except ValueError as e:
|
||||
# errors.append(
|
||||
# WorkflowError(
|
||||
# kind=ItemKind.workflow, id=None, field=None, message=str(e)
|
||||
# )
|
||||
# )
|
||||
|
||||
errors.extend(self._assert_start_node())
|
||||
errors.extend(self._assert_connection_counts())
|
||||
errors.extend(self._assert_global_node())
|
||||
errors.extend(self._assert_node_configs())
|
||||
if errors:
|
||||
raise ValueError(errors)
|
||||
|
||||
def _assert_acyclic(self):
|
||||
color: Dict[str, str] = {} # white / gray / black
|
||||
|
||||
def dfs(n: Node):
|
||||
if color.get(n.id) == "gray": # back-edge
|
||||
raise ValueError("workflow contains a cycle")
|
||||
if color.get(n.id) != "black":
|
||||
color[n.id] = "gray"
|
||||
for m in n.out.values():
|
||||
dfs(m)
|
||||
color[n.id] = "black"
|
||||
|
||||
for n in self.nodes.values():
|
||||
dfs(n)
|
||||
|
||||
def _assert_start_node(self):
|
||||
errors: list[WorkflowError] = []
|
||||
start_node = [n for n in self.nodes.values() if n.data.is_start]
|
||||
if not start_node:
|
||||
errors.append(
|
||||
WorkflowError(
|
||||
kind=ItemKind.workflow,
|
||||
id=None,
|
||||
field=None,
|
||||
message="Workflow must have exactly one start node",
|
||||
)
|
||||
)
|
||||
elif len(start_node) > 1:
|
||||
errors.append(
|
||||
WorkflowError(
|
||||
kind=ItemKind.workflow,
|
||||
id=None,
|
||||
field=None,
|
||||
message="Workflow must have exactly one start node",
|
||||
)
|
||||
)
|
||||
return errors
|
||||
|
||||
def _assert_global_node(self):
|
||||
errors: list[WorkflowError] = []
|
||||
global_node = [
|
||||
n for n in self.nodes.values() if n.node_type == NodeType.globalNode
|
||||
]
|
||||
if not len(global_node) <= 1:
|
||||
errors.append(
|
||||
WorkflowError(
|
||||
kind=ItemKind.workflow,
|
||||
id=None,
|
||||
field=None,
|
||||
message="Workflow must have at most one global node",
|
||||
)
|
||||
)
|
||||
return errors
|
||||
|
||||
def _assert_connection_counts(self):
|
||||
"""Enforce per-type incoming/outgoing edge constraints.
|
||||
|
||||
Driven by `NodeSpec.graph_constraints` so a single source of truth
|
||||
in the spec dictates what's legal. Types without a `graph_constraints`
|
||||
block are unconstrained (e.g. agentNode on the outgoing side).
|
||||
"""
|
||||
errors: list[WorkflowError] = []
|
||||
|
||||
out_deg = Counter()
|
||||
in_deg = Counter()
|
||||
for n in self.nodes.values():
|
||||
out_deg[n.id] = in_deg[n.id] = 0
|
||||
for src, n in self.nodes.items():
|
||||
for m in n.out.values():
|
||||
out_deg[src] += 1
|
||||
in_deg[m.id] += 1
|
||||
|
||||
for n in self.nodes.values():
|
||||
spec = REGISTRY.get(n.node_type.value)
|
||||
if spec is None or spec.graph_constraints is None:
|
||||
continue
|
||||
gc = spec.graph_constraints
|
||||
in_d, out_d = in_deg[n.id], out_deg[n.id]
|
||||
label = spec.display_name
|
||||
|
||||
if gc.max_incoming is not None and in_d > gc.max_incoming:
|
||||
msg = (
|
||||
f"{label} cannot have incoming edges"
|
||||
if gc.max_incoming == 0
|
||||
else f"{label} can have at most {gc.max_incoming} incoming edge(s)"
|
||||
)
|
||||
errors.append(
|
||||
WorkflowError(kind=ItemKind.node, id=n.id, field=None, message=msg)
|
||||
)
|
||||
if gc.min_incoming is not None and in_d < gc.min_incoming:
|
||||
errors.append(
|
||||
WorkflowError(
|
||||
kind=ItemKind.node,
|
||||
id=n.id,
|
||||
field=None,
|
||||
message=f"{label} must have at least {gc.min_incoming} incoming edge(s)",
|
||||
)
|
||||
)
|
||||
if gc.max_outgoing is not None and out_d > gc.max_outgoing:
|
||||
msg = (
|
||||
f"{label} cannot have outgoing edges"
|
||||
if gc.max_outgoing == 0
|
||||
else f"{label} can have at most {gc.max_outgoing} outgoing edge(s)"
|
||||
)
|
||||
errors.append(
|
||||
WorkflowError(kind=ItemKind.node, id=n.id, field=None, message=msg)
|
||||
)
|
||||
if gc.min_outgoing is not None and out_d < gc.min_outgoing:
|
||||
errors.append(
|
||||
WorkflowError(
|
||||
kind=ItemKind.node,
|
||||
id=n.id,
|
||||
field=None,
|
||||
message=f"{label} must have at least {gc.min_outgoing} outgoing edge(s)",
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _assert_node_configs(self):
|
||||
"""Validate node-specific configuration constraints."""
|
||||
errors: list[WorkflowError] = []
|
||||
|
||||
for node in self.nodes.values():
|
||||
# Validate StartNode constraints
|
||||
if node.node_type == NodeType.startNode:
|
||||
# No specific validations for start node at this time
|
||||
pass
|
||||
|
||||
return errors
|
||||
Loading…
Add table
Add a link
Reference in a new issue