Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
feat(SKY-10355): onboarding-state POST endpoint + workflow save/run milestone hooks (SKY-10356) (#6333)
Aaron Perez2cad4401e8b7
diff --git a/skyvern/forge/agent_functions.py b/skyvern/forge/agent_functions.pyindex c436c0cee..03783476f 100644--- a/skyvern/forge/agent_functions.py+++ b/skyvern/forge/agent_functions.py@@ -1325,3 +1325,19 @@ class AgentFunction:Override in cloud to dispatch to platform-specific widget fillers."""return None++ async def on_workflow_saved(+ self,+ organization_id: str,+ edited_by: str | None,+ ) -> None:+ """Fired after a workflow is saved. Overrides must be best-effort and never raise."""+ return None++ async def on_workflow_run_completed(+ self,+ organization_id: str,+ workflow_id: str,+ ) -> None:+ """Fired after a workflow run reaches a final status. Overrides must be best-effort and never raise."""+ return Nonediff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.pyindex b4de86353..02a848b4b 100644--- a/skyvern/forge/sdk/workflow/service.py+++ b/skyvern/forge/sdk/workflow/service.py@@ -4159,35 +4159,44 @@ class WorkflowService:created_by=created_by,edited_by=edited_by,)- return updated_workflow+ else:+ updated_workflow = await app.DATABASE.workflows.update_workflow(+ workflow_id=workflow_id,+ title=title,+ organization_id=organization_id,+ description=description,+ workflow_definition=None,+ proxy_location=proxy_location,+ webhook_callback_url=webhook_callback_url,+ totp_verification_url=totp_verification_url,+ totp_identifier=totp_identifier,+ persist_browser_session=persist_browser_session,+ browser_profile_id=browser_profile_id,+ model=model,+ max_screenshot_scrolling_times=max_screenshot_scrolling_times,+ max_elapsed_time_minutes=max_elapsed_time_minutes,+ extra_http_headers=extra_http_headers,+ cdp_connect_headers=cdp_connect_headers,+ run_with=run_with,+ ai_fallback=ai_fallback,+ cache_key=cache_key,+ adaptive_caching=adaptive_caching,+ code_version=code_version,+ run_sequentially=run_sequentially,+ sequential_key=sequential_key,+ created_by=created_by,+ edited_by=edited_by,+ )- updated_workflow = await app.DATABASE.workflows.update_workflow(- workflow_id=workflow_id,- title=title,- organization_id=organization_id,- description=description,- workflow_definition=None,- proxy_location=proxy_location,- webhook_callback_url=webhook_callback_url,- totp_verification_url=totp_verification_url,- totp_identifier=totp_identifier,- persist_browser_session=persist_browser_session,- browser_profile_id=browser_profile_id,- model=model,- max_screenshot_scrolling_times=max_screenshot_scrolling_times,- max_elapsed_time_minutes=max_elapsed_time_minutes,- extra_http_headers=extra_http_headers,- cdp_connect_headers=cdp_connect_headers,- run_with=run_with,- ai_fallback=ai_fallback,- cache_key=cache_key,- adaptive_caching=adaptive_caching,- code_version=code_version,- run_sequentially=run_sequentially,- sequential_key=sequential_key,- created_by=created_by,- edited_by=edited_by,+ _edited_by: str | None = cast("str | None", edited_by) if edited_by is not _UNSET else None+ task = asyncio.create_task(+ app.AGENT_FUNCTION.on_workflow_saved(+ organization_id=updated_workflow.organization_id,+ edited_by=_edited_by,+ ),)+ self._background_tasks.add(task)+ task.add_done_callback(self._background_tasks.discard)return updated_workflow@@ -4587,6 +4596,14 @@ class WorkflowService:trigger_type=workflow_run.trigger_type,workflow_schedule_id=workflow_run.workflow_schedule_id,)+ run_completed_task = asyncio.create_task(+ app.AGENT_FUNCTION.on_workflow_run_completed(+ organization_id=workflow_run.organization_id,+ workflow_id=workflow_run.workflow_id,+ ),+ )+ self._background_tasks.add(run_completed_task)+ run_completed_task.add_done_callback(self._background_tasks.discard)# Best-effort fire-and-forget write-through to task_runs table.# Runs off the hot path so workflow status transitions stay fast.bg = asyncio.create_task(diff --git a/tests/unit/test_onboarding_milestone_hooks.py b/tests/unit/test_onboarding_milestone_hooks.pynew file mode 100644index 000000000..da6d2f542--- /dev/null+++ b/tests/unit/test_onboarding_milestone_hooks.py@@ -0,0 +1,192 @@+"""Tests that the workflow save and run-completion paths fire the onboarding milestone hooks."""++from __future__ import annotations++import asyncio+from datetime import datetime+from unittest.mock import AsyncMock, MagicMock, patch++import pytest++from skyvern.forge.agent_functions import AgentFunction+++def base_agent_fn() -> AgentFunction:+ return AgentFunction()+++class TestBaseAgentFunctionNoOps:+ """OSS base stubs are no-ops and never raise."""++ @pytest.mark.asyncio+ async def test_on_workflow_saved_noop(self, base_agent_fn: AgentFunction) -> None:+ result = await base_agent_fn.on_workflow_saved(+ organization_id="o_test",+ edited_by="u_test",+ )+ assert result is None++ @pytest.mark.asyncio+ async def test_on_workflow_run_completed_noop(self, base_agent_fn: AgentFunction) -> None:+ result = await base_agent_fn.on_workflow_run_completed(+ organization_id="o_test",+ workflow_id="wf_test",+ )+ assert result is None+++class TestWorkflowSaveHookFires:+ """update_workflow_definition fires on_workflow_saved as a background task."""++ @pytest.mark.asyncio+ async def test_save_fires_on_workflow_saved(self) -> None:+ mock_agent_fn = MagicMock(spec=AgentFunction)+ mock_agent_fn.on_workflow_saved = AsyncMock()++ mock_workflow = MagicMock()+ mock_workflow.organization_id = "o_123"++ mock_db = MagicMock()+ mock_db.workflows.update_workflow = AsyncMock(return_value=mock_workflow)++ with (+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,+ ):+ mock_app.AGENT_FUNCTION = mock_agent_fn+ mock_app.DATABASE = mock_db++ from skyvern.forge.sdk.workflow.service import WorkflowService++ svc = WorkflowService.__new__(WorkflowService)+ svc._background_tasks = set()+ await svc.update_workflow_definition(+ workflow_id="wf_1",+ organization_id="o_123",+ title="Test",+ edited_by="u_456",+ )+ await asyncio.sleep(0)++ mock_agent_fn.on_workflow_saved.assert_awaited_once_with(+ organization_id="o_123",+ edited_by="u_456",+ )++ @pytest.mark.asyncio+ async def test_save_passes_none_edited_by_when_unset(self) -> None:+ mock_agent_fn = MagicMock(spec=AgentFunction)+ mock_agent_fn.on_workflow_saved = AsyncMock()++ mock_workflow = MagicMock()+ mock_workflow.organization_id = "o_123"++ mock_db = MagicMock()+ mock_db.workflows.update_workflow = AsyncMock(return_value=mock_workflow)++ with (+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,+ ):+ mock_app.AGENT_FUNCTION = mock_agent_fn+ mock_app.DATABASE = mock_db++ from skyvern.forge.sdk.workflow.service import WorkflowService++ svc = WorkflowService.__new__(WorkflowService)+ svc._background_tasks = set()+ await svc.update_workflow_definition(+ workflow_id="wf_1",+ organization_id="o_123",+ )+ await asyncio.sleep(0)++ mock_agent_fn.on_workflow_saved.assert_awaited_once_with(+ organization_id="o_123",+ edited_by=None,+ )+++class TestWorkflowRunCompleteHookFires:+ """_update_workflow_run_status fires on_workflow_run_completed for final statuses."""++ @pytest.mark.asyncio+ async def test_run_complete_fires_hook(self) -> None:+ mock_agent_fn = MagicMock(spec=AgentFunction)+ mock_agent_fn.on_workflow_run_completed = AsyncMock()++ mock_workflow_run = MagicMock()+ mock_workflow_run.organization_id = "o_789"+ mock_workflow_run.workflow_id = "wf_1"+ mock_workflow_run.workflow_permanent_id = "wpid_1"+ mock_workflow_run.status = "completed"+ mock_workflow_run.started_at = datetime(2025, 1, 1, 0, 0, 5)+ mock_workflow_run.created_at = datetime(2025, 1, 1)+ mock_workflow_run.run_with = None+ mock_workflow_run.ai_fallback = None+ mock_workflow_run.trigger_type = None+ mock_workflow_run.workflow_schedule_id = None++ mock_status = MagicMock()+ mock_status.is_final.return_value = True++ mock_db = MagicMock()+ mock_db.workflow_runs.update_workflow_run = AsyncMock(return_value=mock_workflow_run)++ with (+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,+ patch("skyvern.forge.sdk.workflow.service.extraction_cache") as mock_cache,+ ):+ mock_app.AGENT_FUNCTION = mock_agent_fn+ mock_app.DATABASE = mock_db+ mock_cache.clear_workflow_run = MagicMock()++ from skyvern.forge.sdk.workflow.service import WorkflowService++ svc = WorkflowService.__new__(WorkflowService)+ svc._background_tasks = set()+ svc._sync_task_run_from_workflow_run = AsyncMock()++ await svc._update_workflow_run_status(+ workflow_run_id="wr_1",+ status=mock_status,+ )+ await asyncio.sleep(0)++ mock_agent_fn.on_workflow_run_completed.assert_awaited_once_with(+ organization_id="o_789",+ workflow_id="wf_1",+ )++ @pytest.mark.asyncio+ async def test_run_non_final_does_not_fire_hook(self) -> None:+ mock_agent_fn = MagicMock(spec=AgentFunction)+ mock_agent_fn.on_workflow_run_completed = AsyncMock()++ mock_workflow_run = MagicMock()+ mock_workflow_run.organization_id = "o_789"++ mock_status = MagicMock()+ mock_status.is_final.return_value = False++ mock_db = MagicMock()+ mock_db.workflow_runs.update_workflow_run = AsyncMock(return_value=mock_workflow_run)++ with (+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,+ ):+ mock_app.AGENT_FUNCTION = mock_agent_fn+ mock_app.DATABASE = mock_db++ from skyvern.forge.sdk.workflow.service import WorkflowService++ svc = WorkflowService.__new__(WorkflowService)+ svc._background_tasks = set()+ svc._sync_task_run_from_workflow_run = AsyncMock()++ await svc._update_workflow_run_status(+ workflow_run_id="wr_1",+ status=mock_status,+ )+ await asyncio.sleep(0)++ mock_agent_fn.on_workflow_run_completed.assert_not_awaited()