File size: 19,795 Bytes
92c4ae6 | 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 | """
Advanced Workflow API Endpoints
Multi-input, multi-step, multi-output workflow support with state management
"""
import asyncio
from datetime import datetime
import logging
from typing import Any, Dict, List, Optional
from fastapi import APIRouter, BackgroundTasks, Depends, HTTPException
from pydantic import BaseModel, Field
from .advanced_workflow_system import (
AdvancedWorkflowDefinition,
ExecutionEngine,
InputParameter,
ParameterType,
ParameterValidator,
StateManager,
WorkflowState,
WorkflowStep,
)
from .workflow_template_manager import WorkflowTemplateManager, get_workflow_template_manager
logger = logging.getLogger(__name__)
router = APIRouter()
# Initialize global instances
state_manager = StateManager()
execution_engine = ExecutionEngine(state_manager)
template_manager = get_workflow_template_manager()
# Request/Response Models
class CreateWorkflowRequest(BaseModel):
name: str
description: str
category: str = "general"
tags: List[str] = []
input_schema: List[Dict[str, Any]] = []
steps: List[Dict[str, Any]] = []
output_config: Optional[Dict[str, Any]] = None
class StartWorkflowRequest(BaseModel):
workflow_id: str
inputs: Dict[str, Any] = {}
class UpdateWorkflowRequest(BaseModel):
inputs: Dict[str, Any] = {}
class WorkflowStepRequest(BaseModel):
step_id: str
inputs: Dict[str, Any] = {}
class WorkflowTemplate(BaseModel):
template_id: str
name: str
description: str
category: str
input_schema: List[Dict[str, Any]]
steps: List[Dict[str, Any]]
tags: List[str] = []
# Helper Functions
def serialize_workflow(workflow: AdvancedWorkflowDefinition) -> Dict[str, Any]:
"""Convert workflow to serializable dict"""
return {
"workflow_id": workflow.workflow_id,
"name": workflow.name,
"description": workflow.description,
"version": workflow.version,
"category": workflow.category,
"tags": workflow.tags,
"input_schema": [param.dict() for param in workflow.input_schema],
"steps": [step.dict() for step in workflow.steps],
"output_config": workflow.output_config.dict() if workflow.output_config else None,
"state": workflow.state.value,
"current_step": workflow.current_step,
"created_at": workflow.created_at.isoformat(),
"updated_at": workflow.updated_at.isoformat(),
"created_by": workflow.created_by
}
# Endpoints
@router.post("/workflows", response_model=Dict[str, Any])
async def create_workflow(request: CreateWorkflowRequest):
"""Create a new advanced workflow"""
try:
# Convert request to workflow definition
workflow_data = {
"workflow_id": f"workflow_{datetime.now().strftime('%Y%m%d_%H%M%S')}_{hash(request.name) % 10000}",
"name": request.name,
"description": request.description,
"category": request.category,
"tags": request.tags,
"input_schema": [InputParameter(**param) for param in request.input_schema],
"steps": [WorkflowStep(**step) for step in request.steps],
"output_config": request.output_config
}
# Create workflow
workflow = await execution_engine.create_workflow(workflow_data)
return {
"status": "success",
"workflow_id": workflow.workflow_id,
"workflow": serialize_workflow(workflow)
}
except Exception as e:
logger.error(f"Failed to create workflow: {e}")
raise HTTPException(status_code=400, detail=str(e))
@router.get("/workflows")
async def list_workflows(
state: Optional[WorkflowState] = None,
category: Optional[str] = None,
tags: Optional[str] = None, # Comma-separated tags
sort_by: str = "updated_at",
sort_order: str = "desc",
limit: Optional[int] = None,
offset: int = 0
):
"""
List workflows with comprehensive filtering and sorting.
Query Parameters:
- state: Filter by workflow state (draft, running, completed, etc.)
- category: Filter by category
- tags: Comma-separated list of tags (workflows must have ALL specified tags)
- sort_by: Field to sort by (updated_at, created_at, name)
- sort_order: Sort order (asc or desc)
- limit: Maximum number of workflows to return
- offset: Number of workflows to skip
"""
try:
# Convert state enum to status string if provided
status_filter = None
if state is not None:
status_filter = state.value if isinstance(state, WorkflowState) else state
# Parse tags from comma-separated string
tags_list = None
if tags:
tags_list = [t.strip() for t in tags.split(",") if t.strip()]
# Get workflows from state manager with all filters
workflows = state_manager.list_workflows(
status=status_filter,
category=category,
tags=tags_list,
sort_by=sort_by,
sort_order=sort_order,
limit=limit,
offset=offset
)
# Get total count (without pagination for accurate total)
total_workflows = len(state_manager.list_workflows(
status=status_filter,
category=category,
tags=tags_list
))
# Return workflows with pagination metadata
return {
"workflows": workflows,
"total": total_workflows,
"offset": offset,
"limit": limit if limit is not None else len(workflows),
"filters": {
"state": status_filter,
"category": category,
"tags": tags_list
}
}
except Exception as e:
logger.error(f"Failed to list workflows: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/workflows/{workflow_id}", response_model=Dict[str, Any])
async def get_workflow(workflow_id: str):
"""Get workflow details"""
try:
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
workflow = AdvancedWorkflowDefinition(**state)
return {
"status": "success",
"workflow": serialize_workflow(workflow),
"execution_status": execution_engine.get_workflow_status(workflow_id)
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to get workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/{workflow_id}/start", response_model=Dict[str, Any])
async def start_workflow(workflow_id: str, request: StartWorkflowRequest):
"""Start or resume workflow execution"""
try:
# Validate inputs
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
workflow = AdvancedWorkflowDefinition(**state)
# Validate inputs
validation_errors = []
for param in workflow.input_schema:
if param.name in request.inputs:
is_valid, error_msg = ParameterValidator.validate_parameter(param, request.inputs[param.name])
if not is_valid:
validation_errors.append(f"{param.name}: {error_msg}")
if validation_errors:
raise HTTPException(status_code=400, detail={
"type": "validation_error",
"errors": validation_errors
})
# Start execution
result = await execution_engine.start_workflow(workflow_id, request.inputs)
return {
"status": "success",
"result": result
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to start workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/{workflow_id}/pause", response_model=Dict[str, Any])
async def pause_workflow(workflow_id: str):
"""Pause workflow execution"""
try:
success = execution_engine.pause_workflow(workflow_id)
if not success:
raise HTTPException(status_code=400, detail="Workflow cannot be paused")
return {
"status": "success",
"message": "Workflow paused"
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to pause workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/{workflow_id}/resume", response_model=Dict[str, Any])
async def resume_workflow(workflow_id: str, request: UpdateWorkflowRequest):
"""Resume paused workflow execution"""
try:
result = execution_engine.resume_workflow(workflow_id, request.inputs)
return {
"status": "success",
"result": result
}
except Exception as e:
logger.error(f"Failed to resume workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/{workflow_id}/cancel", response_model=Dict[str, Any])
async def cancel_workflow(workflow_id: str):
"""Cancel workflow execution"""
try:
success = execution_engine.cancel_workflow(workflow_id)
if not success:
raise HTTPException(status_code=400, detail="Workflow cannot be cancelled")
return {
"status": "success",
"message": "Workflow cancelled"
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to cancel workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/workflows/{workflow_id}/status", response_model=Dict[str, Any])
async def get_workflow_status(workflow_id: str):
"""Get current workflow execution status"""
try:
status = execution_engine.get_workflow_status(workflow_id)
if not status:
raise HTTPException(status_code=404, detail="Workflow not found")
return {
"status": "success",
"workflow_status": status
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to get workflow status {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/workflows/{workflow_id}/step/{step_id}", response_model=Dict[str, Any])
async def get_workflow_step(workflow_id: str, step_id: str):
"""Get specific workflow step details"""
try:
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
workflow = AdvancedWorkflowDefinition(**state)
# Find the step
step = next((s for s in workflow.steps if s.step_id == step_id), None)
if not step:
raise HTTPException(status_code=404, detail="Step not found")
# Get step result if available
step_result = workflow.step_results.get(step_id, None)
return {
"status": "success",
"step": step.dict(),
"result": step_result,
"is_current_step": workflow.current_step == step_id
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to get workflow step {workflow_id}/{step_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/{workflow_id}/step/{step_id}/execute", response_model=Dict[str, Any])
async def execute_workflow_step(workflow_id: str, step_id: str, request: WorkflowStepRequest):
"""Execute a specific workflow step with provided inputs"""
try:
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
workflow = AdvancedWorkflowDefinition(**state)
# Find the step
step = next((s for s in workflow.steps if s.step_id == step_id), None)
if not step:
raise HTTPException(status_code=404, detail="Step not found")
# Prepare step inputs
step_inputs = request.inputs
step_inputs.update(workflow.user_inputs)
# Validate step inputs
validation_errors = []
for param in step.input_parameters:
if param.name in step_inputs:
is_valid, error_msg = ParameterValidator.validate_parameter(param, step_inputs[param.name])
if not is_valid:
validation_errors.append(f"{param.name}: {error_msg}")
if validation_errors:
raise HTTPException(status_code=400, detail={
"type": "validation_error",
"errors": validation_errors
})
# Execute step
result = await execution_engine._execute_step(workflow, step)
# Update workflow state
workflow.step_results[step_id] = result
workflow.updated_at = datetime.now()
state_manager.save_state(workflow_id, workflow.dict())
return {
"status": "success",
"step_result": result
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to execute workflow step {workflow_id}/{step_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.get("/workflows/{workflow_id}/inputs/required", response_model=Dict[str, Any])
async def get_required_inputs(workflow_id: str):
"""Get required inputs for the workflow"""
try:
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
workflow = AdvancedWorkflowDefinition(**state)
# Get missing inputs
missing_inputs = execution_engine._get_missing_inputs(workflow, workflow.user_inputs)
return {
"status": "success",
"required_inputs": [param.dict() for param in missing_inputs],
"current_step": workflow.current_step,
"workflow_state": workflow.state.value
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to get required inputs {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
# Template Management
@router.get("/workflows/templates", response_model=List[Dict[str, Any]])
async def list_workflow_templates(
category: Optional[str] = None,
tags: Optional[List[str]] = None,
active_only: bool = True
):
"""List available workflow templates"""
try:
templates = template_manager.list_templates(
category=category,
tags=tags,
active_only=active_only
)
return [template.dict() for template in templates]
except Exception as e:
logger.error(f"Failed to list workflow templates: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/templates", response_model=Dict[str, Any])
async def create_workflow_template(template: Dict[str, Any]):
"""Create a workflow template"""
try:
created_template = template_manager.create_template(template)
return {
"status": "success",
"template_id": created_template.template_id,
"template": created_template.dict()
}
except ValueError as e:
raise HTTPException(status_code=400, detail=str(e))
except Exception as e:
logger.error(f"Failed to create workflow template: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/from-template", response_model=Dict[str, Any])
async def create_workflow_from_template(
template_id: str,
workflow_data: Dict[str, Any]
):
"""Create a new workflow from a template"""
try:
# Get workflow definition from template
workflow_definition = template_manager.create_workflow_from_template(
template_id=template_id,
workflow_data=workflow_data
)
# Create the workflow
workflow = await execution_engine.create_workflow(workflow_definition)
return {
"status": "success",
"workflow_id": workflow.workflow_id,
"template_id": template_id,
"workflow": serialize_workflow(workflow)
}
except ValueError as e:
raise HTTPException(status_code=404, detail=str(e))
except Exception as e:
logger.error(f"Failed to create workflow from template {template_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
# Parameter Types and Validation
@router.get("/workflows/parameter-types", response_model=List[str])
async def get_parameter_types():
"""Get available parameter types"""
return [param_type.value for param_type in ParameterType]
@router.post("/workflows/validate-parameters", response_model=Dict[str, Any])
async def validate_parameters(
parameters: List[Dict[str, Any]],
inputs: Dict[str, Any]
):
"""Validate input parameters"""
try:
results = {}
for param_data in parameters:
param = InputParameter(**param_data)
value = inputs.get(param.name)
is_valid, error_msg = ParameterValidator.validate_parameter(param, value)
results[param.name] = {
"valid": is_valid,
"error": error_msg,
"type": param.type.value,
"required": param.required
}
return {
"status": "success",
"validation_results": results,
"all_valid": all(r["valid"] for r in results.values())
}
except Exception as e:
logger.error(f"Failed to validate parameters: {e}")
raise HTTPException(status_code=500, detail=str(e))
# Export/Import
@router.get("/workflows/{workflow_id}/export", response_model=Dict[str, Any])
async def export_workflow(workflow_id: str):
"""Export workflow definition"""
try:
state = state_manager.load_state(workflow_id)
if not state:
raise HTTPException(status_code=404, detail="Workflow not found")
# Remove execution-specific data for export
export_data = state.copy()
export_data.pop("step_results", None)
export_data.pop("execution_context", None)
export_data.pop("state", None)
export_data.pop("current_step", None)
return {
"status": "success",
"workflow_definition": export_data
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to export workflow {workflow_id}: {e}")
raise HTTPException(status_code=500, detail=str(e))
@router.post("/workflows/import", response_model=Dict[str, Any])
async def import_workflow(workflow_definition: Dict[str, Any]):
"""Import workflow definition"""
try:
# Create new workflow from definition
workflow_definition["workflow_id"] = f"imported_{datetime.now().strftime('%Y%m%d_%H%M%S')}"
workflow_definition["state"] = WorkflowState.DRAFT
workflow = await execution_engine.create_workflow(workflow_definition)
return {
"status": "success",
"workflow_id": workflow.workflow_id,
"workflow": serialize_workflow(workflow)
}
except Exception as e:
logger.error(f"Failed to import workflow: {e}")
raise HTTPException(status_code=500, detail=str(e)) |