feat: add pipeline engine with approval flow and file triggers
Sequential step executor (script, claude_prompt, approval, api_call, template, skyvern placeholder), reaction-based approvals, file upload trigger matching, portal API state sync. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
6
pipelines/__init__.py
Normal file
6
pipelines/__init__.py
Normal file
@@ -0,0 +1,6 @@
|
||||
"""Pipeline orchestration engine for Matrix bot."""
|
||||
|
||||
from .engine import PipelineEngine
|
||||
from .state import PipelineStateManager
|
||||
|
||||
__all__ = ["PipelineEngine", "PipelineStateManager"]
|
||||
18
pipelines/approval.py
Normal file
18
pipelines/approval.py
Normal file
@@ -0,0 +1,18 @@
|
||||
"""Approval handling — maps Matrix reactions to pipeline approvals."""
|
||||
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Reaction emoji to response mapping
|
||||
APPROVAL_REACTIONS = {
|
||||
"\U0001f44d": "approve", # thumbs up
|
||||
"\U0001f44e": "decline", # thumbs down
|
||||
"\u2705": "approve", # check mark
|
||||
"\u274c": "decline", # cross mark
|
||||
}
|
||||
|
||||
|
||||
def reaction_to_response(reaction_key: str) -> str | None:
|
||||
"""Map a reaction emoji to an approval response."""
|
||||
return APPROVAL_REACTIONS.get(reaction_key)
|
||||
276
pipelines/engine.py
Normal file
276
pipelines/engine.py
Normal file
@@ -0,0 +1,276 @@
|
||||
"""Pipeline execution engine — runs steps sequentially with output chaining."""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import re
|
||||
import time
|
||||
from datetime import datetime, timezone, timedelta
|
||||
|
||||
from .state import PipelineStateManager
|
||||
from .steps import execute_step
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PipelineEngine:
|
||||
"""Executes pipeline steps sequentially, managing state and output chaining."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
state: PipelineStateManager,
|
||||
send_text,
|
||||
matrix_client,
|
||||
llm_client=None,
|
||||
default_model: str = "claude-haiku",
|
||||
escalation_model: str = "claude-sonnet",
|
||||
on_approval_registered=None,
|
||||
):
|
||||
self.state = state
|
||||
self.send_text = send_text
|
||||
self.matrix_client = matrix_client
|
||||
self.llm = llm_client
|
||||
self.default_model = default_model
|
||||
self.escalation_model = escalation_model
|
||||
self.on_approval_registered = on_approval_registered # callback(event_id, execution_id)
|
||||
# Track active approval listeners: execution_id -> asyncio.Future
|
||||
self._approval_futures: dict[str, asyncio.Future] = {}
|
||||
|
||||
def render_template(self, template: str, context: dict) -> str:
|
||||
"""Simple Jinja2-like template rendering: {{ step_name.output }}"""
|
||||
def replacer(match):
|
||||
expr = match.group(1).strip()
|
||||
parts = expr.split(".")
|
||||
try:
|
||||
value = context
|
||||
for part in parts:
|
||||
if isinstance(value, dict):
|
||||
value = value[part]
|
||||
else:
|
||||
return match.group(0)
|
||||
return str(value)
|
||||
except (KeyError, TypeError):
|
||||
return match.group(0)
|
||||
|
||||
return re.sub(r"\{\{\s*(.+?)\s*\}\}", replacer, template)
|
||||
|
||||
def evaluate_condition(self, condition: str, context: dict) -> bool:
|
||||
"""Evaluate a simple condition like {{ step.response == 'approve' }}"""
|
||||
rendered = self.render_template(condition, context)
|
||||
# Strip template markers if still present
|
||||
rendered = rendered.strip().strip("{}").strip()
|
||||
# Simple equality check
|
||||
if "==" in rendered:
|
||||
left, right = rendered.split("==", 1)
|
||||
return left.strip().strip("'\"") == right.strip().strip("'\"")
|
||||
if "!=" in rendered:
|
||||
left, right = rendered.split("!=", 1)
|
||||
return left.strip().strip("'\"") != right.strip().strip("'\"")
|
||||
# Truthy check
|
||||
return bool(rendered) and rendered.lower() not in ("false", "none", "0", "")
|
||||
|
||||
async def run(self, pipeline: dict, trigger_data: dict | None = None) -> None:
|
||||
"""Execute a full pipeline run."""
|
||||
pipeline_id = pipeline["id"]
|
||||
pipeline_name = pipeline["name"]
|
||||
target_room = pipeline["targetRoom"]
|
||||
steps = pipeline.get("steps", [])
|
||||
|
||||
if not steps:
|
||||
logger.warning("Pipeline %s has no steps", pipeline_name)
|
||||
return
|
||||
|
||||
# Create execution record
|
||||
execution = await self.state.create_execution(pipeline_id, trigger_data)
|
||||
execution_id = execution["id"]
|
||||
|
||||
context: dict[str, dict] = {}
|
||||
if trigger_data:
|
||||
context["trigger"] = trigger_data
|
||||
|
||||
step_results: list[dict] = []
|
||||
|
||||
try:
|
||||
for i, step in enumerate(steps):
|
||||
step_name = step.get("name", f"step_{i}")
|
||||
step_type = step.get("type", "")
|
||||
|
||||
# Evaluate condition
|
||||
condition = step.get("if")
|
||||
if condition and not self.evaluate_condition(condition, context):
|
||||
logger.info("Pipeline %s: skipping step %s (condition not met)", pipeline_name, step_name)
|
||||
result = {"name": step_name, "output": "skipped", "status": "skipped", "timestamp": time.time()}
|
||||
step_results.append(result)
|
||||
context[step_name] = {"output": "skipped", "status": "skipped"}
|
||||
continue
|
||||
|
||||
# Update execution state
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
currentStep=i,
|
||||
stepResults=step_results,
|
||||
state="running",
|
||||
)
|
||||
|
||||
logger.info("Pipeline %s: executing step %s (%s)", pipeline_name, step_name, step_type)
|
||||
|
||||
# Render templates in step config
|
||||
rendered_step = {}
|
||||
for key, value in step.items():
|
||||
if isinstance(value, str):
|
||||
rendered_step[key] = self.render_template(value, context)
|
||||
elif isinstance(value, dict):
|
||||
rendered_step[key] = {
|
||||
k: self.render_template(v, context) if isinstance(v, str) else v
|
||||
for k, v in value.items()
|
||||
}
|
||||
else:
|
||||
rendered_step[key] = value
|
||||
|
||||
# Execute step
|
||||
try:
|
||||
timeout_s = step.get("timeout_s", 60)
|
||||
|
||||
if step_type == "approval":
|
||||
output = await self._execute_approval_step(
|
||||
rendered_step, target_room, execution_id, timeout_s
|
||||
)
|
||||
else:
|
||||
output = await asyncio.wait_for(
|
||||
execute_step(
|
||||
step_type=step_type,
|
||||
step_config=rendered_step,
|
||||
context=context,
|
||||
send_text=self.send_text,
|
||||
target_room=target_room,
|
||||
llm=self.llm,
|
||||
default_model=self.default_model,
|
||||
escalation_model=self.escalation_model,
|
||||
),
|
||||
timeout=timeout_s,
|
||||
)
|
||||
|
||||
result = {
|
||||
"name": step_name,
|
||||
"output": output,
|
||||
"status": "success",
|
||||
"timestamp": time.time(),
|
||||
}
|
||||
step_results.append(result)
|
||||
context[step_name] = {"output": output, "status": "success"}
|
||||
|
||||
# For approval steps, also store the response field
|
||||
if step_type == "approval":
|
||||
context[step_name]["response"] = output
|
||||
|
||||
except asyncio.TimeoutError:
|
||||
error_msg = f"Step {step_name} timed out after {step.get('timeout_s', 60)}s"
|
||||
logger.error("Pipeline %s: %s", pipeline_name, error_msg)
|
||||
step_results.append({
|
||||
"name": step_name,
|
||||
"output": None,
|
||||
"status": "timeout",
|
||||
"error": error_msg,
|
||||
"timestamp": time.time(),
|
||||
})
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
state="failed",
|
||||
stepResults=step_results,
|
||||
error=error_msg,
|
||||
)
|
||||
await self.send_text(target_room, f"**{pipeline_name}**: {error_msg}")
|
||||
return
|
||||
|
||||
except Exception as exc:
|
||||
error_msg = f"Step {step_name} failed: {exc}"
|
||||
logger.error("Pipeline %s: %s", pipeline_name, error_msg, exc_info=True)
|
||||
step_results.append({
|
||||
"name": step_name,
|
||||
"output": None,
|
||||
"status": "error",
|
||||
"error": str(exc),
|
||||
"timestamp": time.time(),
|
||||
})
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
state="failed",
|
||||
stepResults=step_results,
|
||||
error=error_msg,
|
||||
)
|
||||
await self.send_text(target_room, f"**{pipeline_name}**: {error_msg}")
|
||||
return
|
||||
|
||||
# All steps completed
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
state="complete",
|
||||
stepResults=step_results,
|
||||
)
|
||||
logger.info("Pipeline %s completed successfully", pipeline_name)
|
||||
|
||||
except Exception as exc:
|
||||
logger.error("Pipeline %s failed unexpectedly: %s", pipeline_name, exc, exc_info=True)
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
state="failed",
|
||||
stepResults=step_results,
|
||||
error=str(exc),
|
||||
)
|
||||
|
||||
async def _execute_approval_step(
|
||||
self, step: dict, target_room: str, execution_id: str, timeout_s: int
|
||||
) -> str:
|
||||
"""Post approval message and wait for reaction."""
|
||||
message = step.get("message", "Approve this action?")
|
||||
formatted_msg = f"**Approval Required**\n\n{message}\n\nReact with \U0001f44d to approve or \U0001f44e to decline."
|
||||
|
||||
# Send message and get event ID
|
||||
resp = await self.matrix_client.room_send(
|
||||
room_id=target_room,
|
||||
message_type="m.room.message",
|
||||
content={
|
||||
"msgtype": "m.text",
|
||||
"body": formatted_msg,
|
||||
"format": "org.matrix.custom.html",
|
||||
"formatted_body": formatted_msg.replace("\n", "<br>"),
|
||||
},
|
||||
)
|
||||
event_id = resp.event_id if hasattr(resp, "event_id") else None
|
||||
|
||||
if not event_id:
|
||||
raise RuntimeError("Failed to send approval message")
|
||||
|
||||
# Notify bot of approval event mapping
|
||||
if self.on_approval_registered:
|
||||
self.on_approval_registered(event_id, execution_id)
|
||||
|
||||
# Register approval listener
|
||||
future = asyncio.get_event_loop().create_future()
|
||||
self._approval_futures[execution_id] = future
|
||||
|
||||
# Update execution with approval tracking
|
||||
expires_at = (datetime.now(timezone.utc) + timedelta(seconds=timeout_s)).isoformat()
|
||||
await self.state.update_execution(
|
||||
execution_id,
|
||||
state="waiting_approval",
|
||||
approvalMsgId=event_id,
|
||||
approvalExpiresAt=expires_at,
|
||||
)
|
||||
|
||||
try:
|
||||
result = await asyncio.wait_for(future, timeout=timeout_s)
|
||||
return result # "approve" or "decline"
|
||||
except asyncio.TimeoutError:
|
||||
await self.send_text(target_room, "Approval timed out. Pipeline aborted.")
|
||||
await self.state.update_execution(execution_id, state="aborted", error="Approval timed out")
|
||||
raise
|
||||
finally:
|
||||
self._approval_futures.pop(execution_id, None)
|
||||
|
||||
def resolve_approval(self, execution_id: str, response: str) -> bool:
|
||||
"""Resolve a pending approval. Called by reaction handler."""
|
||||
future = self._approval_futures.get(execution_id)
|
||||
if future and not future.done():
|
||||
future.set_result(response)
|
||||
return True
|
||||
return False
|
||||
62
pipelines/state.py
Normal file
62
pipelines/state.py
Normal file
@@ -0,0 +1,62 @@
|
||||
"""Pipeline state management — syncs with matrixhost portal API."""
|
||||
|
||||
import logging
|
||||
from datetime import datetime, timezone
|
||||
|
||||
import httpx
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class PipelineStateManager:
|
||||
"""Manages pipeline state via portal API."""
|
||||
|
||||
def __init__(self, portal_url: str, api_key: str):
|
||||
self.portal_url = portal_url.rstrip("/")
|
||||
self.api_key = api_key
|
||||
|
||||
async def fetch_active_pipelines(self) -> list[dict]:
|
||||
async with httpx.AsyncClient(timeout=15.0) as client:
|
||||
resp = await client.get(
|
||||
f"{self.portal_url}/api/pipelines/active",
|
||||
headers={"x-api-key": self.api_key},
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
return data.get("pipelines", [])
|
||||
|
||||
async def create_execution(self, pipeline_id: str, trigger_data: dict | None = None) -> dict:
|
||||
async with httpx.AsyncClient(timeout=10.0) as client:
|
||||
resp = await client.post(
|
||||
f"{self.portal_url}/api/pipelines/{pipeline_id}/execution",
|
||||
headers={"x-api-key": self.api_key},
|
||||
json={"triggerData": trigger_data},
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
return data["execution"]
|
||||
|
||||
async def update_execution(self, execution_id: str, **kwargs) -> None:
|
||||
try:
|
||||
async with httpx.AsyncClient(timeout=10.0) as client:
|
||||
await client.put(
|
||||
f"{self.portal_url}/api/pipelines/executions/{execution_id}",
|
||||
headers={"x-api-key": self.api_key},
|
||||
json=kwargs,
|
||||
)
|
||||
except Exception:
|
||||
logger.warning("Failed to update execution %s", execution_id, exc_info=True)
|
||||
|
||||
async def fetch_pending_approvals(self) -> list[dict]:
|
||||
try:
|
||||
async with httpx.AsyncClient(timeout=10.0) as client:
|
||||
resp = await client.get(
|
||||
f"{self.portal_url}/api/pipelines/executions/pending",
|
||||
headers={"x-api-key": self.api_key},
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
return data.get("executions", [])
|
||||
except Exception:
|
||||
logger.debug("Failed to fetch pending approvals", exc_info=True)
|
||||
return []
|
||||
45
pipelines/steps/__init__.py
Normal file
45
pipelines/steps/__init__.py
Normal file
@@ -0,0 +1,45 @@
|
||||
"""Step type registry and dispatcher."""
|
||||
|
||||
import logging
|
||||
|
||||
from .script import execute_script
|
||||
from .claude_prompt import execute_claude_prompt
|
||||
from .template import execute_template
|
||||
from .api_call import execute_api_call
|
||||
from .skyvern import execute_skyvern
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
STEP_EXECUTORS = {
|
||||
"script": execute_script,
|
||||
"claude_prompt": execute_claude_prompt,
|
||||
"template": execute_template,
|
||||
"api_call": execute_api_call,
|
||||
"skyvern": execute_skyvern,
|
||||
}
|
||||
|
||||
|
||||
async def execute_step(
|
||||
step_type: str,
|
||||
step_config: dict,
|
||||
context: dict,
|
||||
send_text,
|
||||
target_room: str,
|
||||
llm=None,
|
||||
default_model: str = "claude-haiku",
|
||||
escalation_model: str = "claude-sonnet",
|
||||
) -> str:
|
||||
"""Execute a pipeline step and return its output as a string."""
|
||||
executor = STEP_EXECUTORS.get(step_type)
|
||||
if not executor:
|
||||
raise ValueError(f"Unknown step type: {step_type}")
|
||||
|
||||
return await executor(
|
||||
config=step_config,
|
||||
context=context,
|
||||
send_text=send_text,
|
||||
target_room=target_room,
|
||||
llm=llm,
|
||||
default_model=default_model,
|
||||
escalation_model=escalation_model,
|
||||
)
|
||||
33
pipelines/steps/api_call.py
Normal file
33
pipelines/steps/api_call.py
Normal file
@@ -0,0 +1,33 @@
|
||||
"""API call step — make HTTP requests."""
|
||||
|
||||
import logging
|
||||
|
||||
import httpx
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def execute_api_call(config: dict, **_kwargs) -> str:
|
||||
"""Make an HTTP request and return the response body."""
|
||||
url = config.get("url", "")
|
||||
if not url:
|
||||
raise ValueError("api_call step requires 'url' field")
|
||||
|
||||
method = config.get("method", "GET").upper()
|
||||
headers = config.get("headers", {})
|
||||
body = config.get("body")
|
||||
|
||||
async with httpx.AsyncClient(timeout=30.0) as client:
|
||||
if method == "GET":
|
||||
resp = await client.get(url, headers=headers)
|
||||
elif method == "POST":
|
||||
resp = await client.post(url, headers=headers, content=body)
|
||||
elif method == "PUT":
|
||||
resp = await client.put(url, headers=headers, content=body)
|
||||
elif method == "DELETE":
|
||||
resp = await client.delete(url, headers=headers)
|
||||
else:
|
||||
raise ValueError(f"Unsupported HTTP method: {method}")
|
||||
|
||||
resp.raise_for_status()
|
||||
return resp.text
|
||||
32
pipelines/steps/claude_prompt.py
Normal file
32
pipelines/steps/claude_prompt.py
Normal file
@@ -0,0 +1,32 @@
|
||||
"""Claude prompt step — call LLM via LiteLLM proxy."""
|
||||
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def execute_claude_prompt(
|
||||
config: dict,
|
||||
llm=None,
|
||||
default_model: str = "claude-haiku",
|
||||
escalation_model: str = "claude-sonnet",
|
||||
**_kwargs,
|
||||
) -> str:
|
||||
"""Send a prompt to Claude and return the response."""
|
||||
if not llm:
|
||||
raise RuntimeError("LLM client not configured")
|
||||
|
||||
prompt = config.get("prompt", "")
|
||||
if not prompt:
|
||||
raise ValueError("claude_prompt step requires 'prompt' field")
|
||||
|
||||
model_name = config.get("model", "default")
|
||||
model = escalation_model if model_name == "escalation" else default_model
|
||||
|
||||
response = await llm.chat.completions.create(
|
||||
model=model,
|
||||
messages=[{"role": "user", "content": prompt}],
|
||||
max_tokens=4096,
|
||||
)
|
||||
|
||||
return response.choices[0].message.content or ""
|
||||
27
pipelines/steps/script.py
Normal file
27
pipelines/steps/script.py
Normal file
@@ -0,0 +1,27 @@
|
||||
"""Script step — execute a shell command and capture output."""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def execute_script(config: dict, **_kwargs) -> str:
|
||||
"""Execute a shell script and return stdout."""
|
||||
script = config.get("script", "")
|
||||
if not script:
|
||||
raise ValueError("Script step requires 'script' field")
|
||||
|
||||
proc = await asyncio.create_subprocess_shell(
|
||||
script,
|
||||
stdout=asyncio.subprocess.PIPE,
|
||||
stderr=asyncio.subprocess.PIPE,
|
||||
)
|
||||
stdout, stderr = await proc.communicate()
|
||||
|
||||
output = stdout.decode("utf-8", errors="replace").strip()
|
||||
if proc.returncode != 0:
|
||||
err = stderr.decode("utf-8", errors="replace").strip()
|
||||
raise RuntimeError(f"Script exited with code {proc.returncode}: {err or output}")
|
||||
|
||||
return output
|
||||
24
pipelines/steps/skyvern.py
Normal file
24
pipelines/steps/skyvern.py
Normal file
@@ -0,0 +1,24 @@
|
||||
"""Skyvern step — browser automation via Skyvern API (Phase 2 placeholder)."""
|
||||
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def execute_skyvern(config: dict, send_text=None, target_room: str = "", **_kwargs) -> str:
|
||||
"""Dispatch a browser task to Skyvern.
|
||||
|
||||
Phase 2: Will integrate with self-hosted Skyvern on matrixhost.
|
||||
"""
|
||||
task = config.get("task", {})
|
||||
url = task.get("url", "")
|
||||
goal = task.get("goal", "")
|
||||
|
||||
if send_text and target_room:
|
||||
await send_text(
|
||||
target_room,
|
||||
f"**Browser Task**: Skyvern integration pending setup.\n"
|
||||
f"URL: {url}\nGoal: {goal}",
|
||||
)
|
||||
|
||||
raise NotImplementedError("Skyvern step not yet implemented (Phase 2)")
|
||||
18
pipelines/steps/template.py
Normal file
18
pipelines/steps/template.py
Normal file
@@ -0,0 +1,18 @@
|
||||
"""Template step — format and post a message to the target room."""
|
||||
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def execute_template(config: dict, send_text=None, target_room: str = "", **_kwargs) -> str:
|
||||
"""Render a template message and post it to the target room."""
|
||||
template = config.get("template", config.get("message", ""))
|
||||
if not template:
|
||||
raise ValueError("template step requires 'template' or 'message' field")
|
||||
|
||||
# Template is already rendered by the engine before reaching here
|
||||
if send_text and target_room:
|
||||
await send_text(target_room, template)
|
||||
|
||||
return template
|
||||
Reference in New Issue
Block a user