Python: DevUI: Add OpenAI Responses API proxy support + HIL for Workflows (#1737)

* DevUI: Add OpenAI Responses API proxy support with enhanced UI features

This commit adds support for proxying requests to OpenAI's Responses API,
allowing DevUI to route conversations to OpenAI models when configured to enable testing.

Backend changes:
- Add OpenAI proxy executor with conversation routing logic
- Enhance event mapper to support OpenAI Responses API format
- Extend server endpoints to handle OpenAI proxy mode
- Update models with OpenAI-specific response types
- Remove emojis from logging and CLI output for cleaner text

Frontend changes:
- Add settings modal with OpenAI proxy configuration UI
- Enhance agent and workflow views with improved state management
- Add new UI components (separator, switch) for settings
- Update debug panel with better event filtering
- Improve message renderers for OpenAI content types
- Update types and API client for OpenAI integration

* update ui, settings modal and workflow input form, add register cleanup hooks.

* add workflow HIL support, user mode, other fixes

* feat(devui): add human-in-the-loop (HIL) support with dynamic response schemas

Implement  HIL workflow support allowing workflows to pause for user input
with dynamically generated JSON schemas based on response handler type hints.

Key Features:
- Automatic response schema extraction from @response_handler decorators
- Dynamic form generation in UI based on Pydantic/dataclass response types
- Checkpoint-based conversation storage for HIL requests/responses
- Resume workflow execution after user provides HIL response

Backend Changes:
- Add extract_response_type_from_executor() to introspect response handlers
- Enrich RequestInfoEvent with response_schema via _enrich_request_info_event_with_response_schema()
- Map RequestInfoEvent to response.input.requested OpenAI event format
- Store HIL responses in conversation history and restore checkpoints

Frontend Changes:
- Add HILInputModal component with SchemaFormRenderer for dynamic forms
- Support Pydantic BaseModel and dataclass response types
- Render enum fields as dropdowns, strings as text/textarea, numbers, booleans, arrays, objects
- Display original request context alongside response form

Testing:
- Add  tests for checkpoint storage (test_checkpoints.py)
- Add schema generation tests for all input types (test_schema_generation.py)
- Validate end-to-end HIL flow with spam workflow sample

This enables workflows to seamlessly pause execution and request structured user input
with type-safe, validated forms generated automatically from response type annotations.

* improve HIL support, improve workflow execution view

* ui updates

* ui updates

* improve HIL for workflows, add auth and view modes

* update workflow

* security improvements , ui fixes

* fix mypy error

* update loading spinner in ui

---------

Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com>
This commit is contained in:
Victor Dibia
2025-11-07 15:28:32 -08:00
committed by GitHub
Unverified
parent 85484c0259
commit 94eae24082
52 changed files with 10178 additions and 1599 deletions
+135
View File
@@ -241,6 +241,100 @@ async def test_multiple_credential_attributes() -> None:
assert mock_cred2.close.called, "Async credential should be closed"
def test_ui_mode_configuration():
"""Test UI mode configuration."""
dev_server = DevServer(mode="developer")
assert dev_server.mode == "developer"
user_server = DevServer(mode="user")
assert user_server.mode == "user"
@pytest.mark.asyncio
async def test_api_restrictions_in_user_mode():
"""Test that developer APIs are restricted in user mode."""
from fastapi.testclient import TestClient
# Create servers with different modes
dev_server = DevServer(mode="developer")
user_server = DevServer(mode="user")
dev_app = dev_server.create_app()
user_app = user_server.create_app()
dev_client = TestClient(dev_app)
user_client = TestClient(user_app)
# Test 1: Health endpoint should work in both modes
assert dev_client.get("/health").status_code == 200
assert user_client.get("/health").status_code == 200
# Test 2: Meta endpoint should reflect correct mode
dev_meta = dev_client.get("/meta").json()
assert dev_meta["ui_mode"] == "developer"
user_meta = user_client.get("/meta").json()
assert user_meta["ui_mode"] == "user"
# Test 3: Entity listing should work in both modes
assert dev_client.get("/v1/entities").status_code == 200
assert user_client.get("/v1/entities").status_code == 200
# Test 4: Entity info should be restricted in user mode
dev_response = dev_client.get("/v1/entities/test_agent/info")
assert dev_response.status_code in [200, 404, 500] # Not 403
user_response = user_client.get("/v1/entities/test_agent/info")
assert user_response.status_code == 403
error_data = user_response.json()
# FastAPI wraps HTTPException detail in 'detail' field
error = error_data.get("detail", {}).get("error") or error_data.get("error")
assert error is not None
assert "developer mode" in error["message"].lower()
assert error["code"] == "developer_mode_required"
# Test 5: Hot reload should be restricted in user mode
dev_response = dev_client.post("/v1/entities/test_agent/reload")
assert dev_response.status_code in [200, 404, 500] # Not 403
user_response = user_client.post("/v1/entities/test_agent/reload")
assert user_response.status_code == 403
error_data = user_response.json()
error = error_data.get("detail", {}).get("error") or error_data.get("error")
assert "developer mode" in error["message"].lower()
# Test 6: Deployment endpoints should be restricted in user mode
# List deployments (simplest test - no payload needed)
user_response = user_client.get("/v1/deployments")
assert user_response.status_code == 403
error_data = user_response.json()
error = error_data.get("detail", {}).get("error") or error_data.get("error")
assert "developer mode" in error["message"].lower()
# Get deployment
user_response = user_client.get("/v1/deployments/test-id")
assert user_response.status_code == 403
# Delete deployment
user_response = user_client.delete("/v1/deployments/test-id")
assert user_response.status_code == 403
# Test 7: Conversation endpoints should work in both modes
dev_response = dev_client.post("/v1/conversations", json={})
assert dev_response.status_code == 200
user_response = user_client.post("/v1/conversations", json={})
assert user_response.status_code == 200
# Test 8: Chat endpoint should work in both modes
chat_payload = {"model": "test_agent", "input": "Hello"}
dev_response = dev_client.post("/v1/responses", json=chat_payload)
assert dev_response.status_code in [200, 404] # 404 if agent doesn't exist
user_response = user_client.post("/v1/responses", json=chat_payload)
assert user_response.status_code in [200, 404]
if __name__ == "__main__":
# Simple test runner
async def run_tests():
@@ -273,3 +367,44 @@ class WeatherAgent:
await executor.execute_sync(request)
asyncio.run(run_tests())
@pytest.mark.asyncio
async def test_checkpoint_api_endpoints(test_entities_dir):
"""Test checkpoint list and delete API endpoints."""
from agent_framework._workflows._checkpoint import WorkflowCheckpoint
server = DevServer(entities_dir=test_entities_dir)
executor = await server._ensure_executor()
# Create a conversation
conversation = executor.conversation_store.create_conversation(metadata={"name": "Test Session"})
conv_id = conversation.id
# Get checkpoint storage and add a checkpoint
storage = executor.checkpoint_manager.get_checkpoint_storage(conv_id)
checkpoint = WorkflowCheckpoint(
checkpoint_id="test_checkpoint_1",
workflow_id="test_workflow",
shared_state={"key": "value"},
iteration_count=1,
)
await storage.save_checkpoint(checkpoint)
# Test list checkpoints endpoint
checkpoints = await storage.list_checkpoints()
assert len(checkpoints) == 1
assert checkpoints[0].checkpoint_id == "test_checkpoint_1"
assert checkpoints[0].workflow_id == "test_workflow"
# Test delete checkpoint endpoint
deleted = await storage.delete_checkpoint("test_checkpoint_1")
assert deleted is True
# Verify checkpoint was deleted
remaining = await storage.list_checkpoints()
assert len(remaining) == 0
# Test delete non-existent checkpoint
deleted = await storage.delete_checkpoint("nonexistent")
assert deleted is False