Skip to content

Automate browser based workflows with AI

Save the final screenshot for Task V3 workflow blocks (SKY-18862) (#9030)

pedrohsdbeccc1c60b225
diff --git a/skyvern/forge/agent.py b/skyvern/forge/agent.py
index 1497020d4..2b50bc8e1 100644
--- a/skyvern/forge/agent.py
+++ b/skyvern/forge/agent.py
@@ -412,6 +412,15 @@ CUA_EXECUTE_ACTIONS_DIRECTIVE = (
)
+def _get_browser_state_for_cleanup(task: Task) -> BrowserState | None:
+ # Workflow blocks that never ran a v1 action (Task V3) register the browser under the run id only.
+ # A plain lookup avoids aliasing the task, which would make workflow-run teardown close the state twice.
+ browser_state = app.BROWSER_MANAGER.get_for_task(task.task_id)
+ if browser_state is None and task.workflow_run_id:
+ browser_state = app.BROWSER_MANAGER.get_for_workflow_run(task.workflow_run_id)
+ return browser_state
+
+
async def resolve_inherited_workflow_task_page(browser_state: BrowserState, workflow_run_id: str) -> Page:
working_page = await browser_state.get_working_page()
if not working_page:
@@ -4456,6 +4465,8 @@ class ForgeAgent:
last_step=step,
api_key=api_key,
need_call_webhook=True,
+ # A goto-only workflow block never took a final screenshot; the full-page capture costs seconds.
+ need_final_screenshot=task.workflow_run_id is None,
close_browser_on_completion=close_browser_on_completion,
browser_session_id=browser_session_id,
)
@@ -9656,7 +9667,7 @@ class ForgeAgent:
# initialization. In this case, we don't have any artifacts to send and we can't take final screenshots etc.
# since the browser is not initialized properly or the proxy is not working.
- browser_state = app.BROWSER_MANAGER.get_for_task(task.task_id)
+ browser_state = _get_browser_state_for_cleanup(task)
if browser_state is not None:
# get_working_page() is inside the try so a raise here cannot propagate and strand the
# task listener/claim state armed (terminal-expiry promise).
@@ -9685,7 +9696,7 @@ class ForgeAgent:
_tracer = otel_trace.get_tracer("skyvern")
with traced_span(_tracer, "skyvern.agent.cleanup.save_downloaded_files") as _cl_save_span:
apply_context_attrs(_cl_save_span)
- browser_state = app.BROWSER_MANAGER.get_for_task(task.task_id)
+ browser_state = _get_browser_state_for_cleanup(task)
browser_context = browser_state.browser_context if browser_state is not None else None
track_download_outcome = has_download_interceptor_for_context(browser_context)
context = skyvern_context.current()
diff --git a/skyvern/forge/sdk/api/llm/api_handler_factory.py b/skyvern/forge/sdk/api/llm/api_handler_factory.py
index 19256aabd..2eef97449 100644
--- a/skyvern/forge/sdk/api/llm/api_handler_factory.py
+++ b/skyvern/forge/sdk/api/llm/api_handler_factory.py
@@ -4092,6 +4092,7 @@ class LLMCaller:
llm_request_payload = {
"model": self.llm_key if openrouter_model_name and self.openai_client else self.llm_config.model_name,
"messages": messages,
+ **({"tools": tools} if tools else {}),
# we're not using active_parameters here because it may contain sensitive information
**parameters,
}
diff --git a/tests/unit/force_stub_app.py b/tests/unit/force_stub_app.py
index adc1de17e..bc61d523e 100644
--- a/tests/unit/force_stub_app.py
+++ b/tests/unit/force_stub_app.py
@@ -67,6 +67,7 @@ def create_forge_stub_app() -> ForgeApp:
# get_for_task is a sync lookup returning None when no browser state is registered; _LazyNamespace
# would otherwise auto-mock it as an (awaitable) AsyncMock, breaking sync callers.
fake_app_module.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ fake_app_module.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
fake_app_module.PERSISTENT_SESSIONS_MANAGER = _LazyNamespace()
# A synchronous capability check; auto-mocked, its un-awaited coroutine leaks into later tests.
fake_app_module.PERSISTENT_SESSIONS_MANAGER.supports_evict_and_reconnect = MagicMock(return_value=False)
diff --git a/tests/unit/test_agent_cleanup_download_suffix.py b/tests/unit/test_agent_cleanup_download_suffix.py
index c8b91e23f..800832aa5 100644
--- a/tests/unit/test_agent_cleanup_download_suffix.py
+++ b/tests/unit/test_agent_cleanup_download_suffix.py
@@ -580,6 +580,7 @@ async def test_execute_step_complete_on_download_does_not_double_finalize(tmp_pa
mock_app.AGENT_FUNCTION.post_step_execution = AsyncMock()
mock_app.ARTIFACT_MANAGER.flush_step_archive = AsyncMock()
mock_app.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ mock_app.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
mock_app.STORAGE.save_downloaded_files = AsyncMock()
mock_app.STORAGE.list_downloaded_files_in_browser_session = AsyncMock(return_value=[])
@@ -710,6 +711,7 @@ async def test_execute_step_reuses_initial_download_baseline_across_recursive_st
mock_app.AGENT_FUNCTION.post_step_execution = AsyncMock()
mock_app.ARTIFACT_MANAGER.flush_step_archive = AsyncMock()
mock_app.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ mock_app.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
mock_app.BROWSER_MANAGER.get_video_artifacts = AsyncMock(return_value=[])
mock_app.STORAGE.save_downloaded_files = AsyncMock()
mock_app.STORAGE.list_downloaded_files_in_browser_session = AsyncMock(return_value=[])
@@ -882,6 +884,7 @@ async def test_execute_step_complete_on_download_emits_finalize_lineage(tmp_path
mock_app.AGENT_FUNCTION.post_step_execution = AsyncMock()
mock_app.ARTIFACT_MANAGER.flush_step_archive = AsyncMock()
mock_app.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ mock_app.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
mock_app.STORAGE.save_downloaded_files = AsyncMock()
mock_app.STORAGE.list_downloaded_files_in_browser_session = AsyncMock(return_value=[])
@@ -1849,6 +1852,7 @@ async def test_execute_step_complete_on_download_closes_claimed_popup_before_han
mock_app.AGENT_FUNCTION.post_step_execution = AsyncMock()
mock_app.ARTIFACT_MANAGER.flush_step_archive = AsyncMock()
mock_app.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ mock_app.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
mock_app.STORAGE.save_downloaded_files = AsyncMock()
mock_app.STORAGE.list_downloaded_files_in_browser_session = AsyncMock(return_value=[])
@@ -1954,6 +1958,7 @@ async def test_execute_step_no_credit_releases_deferred_dispatched_failure_reser
mock_app.AGENT_FUNCTION.post_step_execution = AsyncMock()
mock_app.ARTIFACT_MANAGER.flush_step_archive = AsyncMock()
mock_app.BROWSER_MANAGER.get_for_task = MagicMock(return_value=None)
+ mock_app.BROWSER_MANAGER.get_for_workflow_run = MagicMock(return_value=None)
mock_app.STORAGE.list_downloaded_files_in_browser_session = AsyncMock(return_value=[])
await agent.execute_step(
diff --git a/tests/unit/test_api_handler_factory.py b/tests/unit/test_api_handler_factory.py
index 9dfd52c89..ed7cbcd4b 100644
--- a/tests/unit/test_api_handler_factory.py
+++ b/tests/unit/test_api_handler_factory.py
@@ -36,6 +36,7 @@ from skyvern.forge.sdk.api.llm.exceptions import (
)
from skyvern.forge.sdk.api.llm.models import LLMConfig
from skyvern.forge.sdk.api.llm.utils import uses_only_anthropic_models
+from skyvern.forge.sdk.artifact.models import ArtifactType
from skyvern.forge.sdk.copilot import secret_scrub
from skyvern.forge.sdk.copilot.secret_scrub import REDACTED_SECRET_PLACEHOLDER
from skyvern.forge.sdk.core.skyvern_context import SkyvernContext
@@ -656,6 +657,22 @@ def _stub_successful_llm_caller(
return caller, logger
+async def test_llm_caller_records_the_tool_schema_it_sent(monkeypatch: pytest.MonkeyPatch) -> None:
+ caller, _ = _stub_successful_llm_caller(monkeypatch)
+ api_handler_factory.app.ARTIFACT_MANAGER.prepare_llm_artifact = AsyncMock(return_value=None)
+ tools = [{"type": "function", "function": {"name": "click", "parameters": {"type": "object", "properties": {}}}}]
+
+ await caller.call(prompt="test", prompt_name="tool-schema-test", thought=MagicMock(), tools=tools)
+
+ requests = [
+ json.loads(call.kwargs["data"])
+ for call in api_handler_factory.app.ARTIFACT_MANAGER.prepare_llm_artifact.call_args_list
+ if call.kwargs["artifact_type"] == ArtifactType.LLM_REQUEST
+ ]
+ assert [request["tools"] for request in requests] == [tools]
+
+
@pytest.mark.asyncio
async def test_llm_caller_preserves_generated_cost_and_tokens_during_real_redaction(
monkeypatch: pytest.MonkeyPatch,
diff --git a/tests/unit/test_execute_step_exception_handling.py b/tests/unit/test_execute_step_exception_handling.py
index 59bc54e3b..7203107f4 100644
--- a/tests/unit/test_execute_step_exception_handling.py
+++ b/tests/unit/test_execute_step_exception_handling.py
@@ -560,6 +560,52 @@ async def test_execute_step_releases_scraped_page_before_recursion(monkeypatch:
assert handle_completed_step.await_args.kwargs["scraped_page"] is scraped_page
+ ("workflow_run_id", "expected_final_screenshot"),
+ [("wr-123", False), (None, True)],
+ ids=["workflow-block", "standalone-task"],
+)
+async def test_goto_only_task_takes_final_screenshot_only_outside_a_workflow(
+ monkeypatch: pytest.MonkeyPatch, workflow_run_id: str | None, expected_final_screenshot: bool
+) -> None:
+ agent = ForgeAgent()
+ now = datetime.now(UTC)
+ organization = make_organization(now)
+ task = make_task(
+ now, organization, navigation_goal=None, data_extraction_goal=None, workflow_run_id=workflow_run_id
+ )
+ step = make_step(now, task, step_id="step-0", status=StepStatus.running, order=0, output=None)
+
+ page = MagicMock()
+ page.url = task.url
+ browser_state = MagicMock()
+ browser_state.must_get_working_page = AsyncMock(return_value=page)
+
+ monkeypatch.setattr("skyvern.forge.agent.app.DATABASE.workflow_runs.get_workflow_run", AsyncMock(return_value=None))
+ monkeypatch.setattr("skyvern.forge.agent.app.DATABASE.tasks.get_task", AsyncMock(return_value=None))
+ monkeypatch.setattr("skyvern.forge.agent.app.DATABASE.tasks.update_task", AsyncMock(return_value=task))
+ monkeypatch.setattr("skyvern.forge.agent.app.AGENT_FUNCTION.validate_step_execution", AsyncMock(return_value=None))
+ agent.initialize_execution_state = AsyncMock(return_value=(step, browser_state, None)) # type: ignore[method-assign]
+ agent.update_step = AsyncMock(return_value=step) # type: ignore[method-assign]
+ agent.update_task = AsyncMock(return_value=task) # type: ignore[method-assign]
+ clean_up_task = AsyncMock(return_value=None)
+ agent.clean_up_task = clean_up_task # type: ignore[method-assign]
+
+ skyvern_context.set(
+ SkyvernContext(organization_id=organization.organization_id, task_id=task.task_id, tz_info=ZoneInfo("UTC"))
+ )
+ try:
+ await agent.execute_step(
+ organization=organization, task=task, step=step, api_key="api-key", download_baseline_files=[]
+ )
+ finally:
+ skyvern_context.reset()
+
+ assert clean_up_task.await_count == 1
+ assert clean_up_task.await_args.kwargs["need_final_screenshot"] is expected_final_screenshot
+
+
# These drive the REAL ``fail_task`` and ``clean_up_task``, because mocking exactly those two hides
# that most handlers clean up unconditionally. Only the browser, storage and webhook edges are faked,
# and ``fail_task`` genuinely returns False because the row it is handed is already final.
diff --git a/tests/unit/test_screenshot_target_closed_callers.py b/tests/unit/test_screenshot_target_closed_callers.py
index 6f7bbea22..e33c4a4c8 100644
--- a/tests/unit/test_screenshot_target_closed_callers.py
+++ b/tests/unit/test_screenshot_target_closed_callers.py
@@ -42,6 +42,7 @@ from skyvern.exceptions import (
ScreenshotTargetClosed,
)
from skyvern.forge.agent import ForgeAgent
+from skyvern.forge.sdk.artifact.models import ArtifactType
from skyvern.forge.sdk.core import skyvern_context
from skyvern.forge.sdk.core.skyvern_context import SkyvernContext
from skyvern.forge.sdk.models import StepStatus
@@ -602,6 +603,49 @@ class TestCleanUpTaskTargetClosed:
)
+class TestCleanUpTaskWorkflowRunBrowser:
+ @pytest.mark.asyncio
+ async def test_browser_registered_under_run_id_only_gets_final_screenshot_and_settle(
+ self, monkeypatch: pytest.MonkeyPatch
+ ) -> None:
+ # Task V3 workflow blocks never alias pages[task_id]; cleanup must still find the run's browser.
+ now = datetime.now(UTC)
+ organization = make_organization(now)
+ task = make_task(now, organization, workflow_run_id="wr-cleanup")
+ step = make_step(now, task, step_id="step-cleanup", status=StepStatus.completed, order=0, output=None)
+
+ browser_state, _, page = make_browser_state()
+ browser_state.get_working_page = AsyncMock(return_value=page)
+ browser_state.take_fullpage_screenshot = AsyncMock(return_value=b"png")
+ manager = RealBrowserManager()
+ manager.pages["wr-cleanup"] = browser_state
+
+ app_mock = MagicMock()
+ app_mock.DATABASE.tasks.get_task = AsyncMock(return_value=task)
+ app_mock.BROWSER_MANAGER = manager
+ app_mock.ARTIFACT_MANAGER.create_artifact = AsyncMock()
+ monkeypatch.setattr(agent_mod, "app", app_mock)
+ monkeypatch.setattr(agent_mod.analytics, "capture", MagicMock())
+ settled_contexts: list[object] = []
+
+ @asynccontextmanager
+ async def recording_settle(browser_context: object, *args: Any, **kwargs: Any) -> AsyncIterator[None]:
+ settled_contexts.append(browser_context)
+ yield
+
+ monkeypatch.setattr(agent_mod, "settle_browser_downloads_for_context", recording_settle)
+ skyvern_context.set(SkyvernContext(task_id=task.task_id, organization_id=task.organization_id))
+
+ await ForgeAgent().clean_up_task(task=task, last_step=step)
+
+ artifact_types = [
+ call.kwargs["artifact_type"] for call in app_mock.ARTIFACT_MANAGER.create_artifact.call_args_list
+ ]
+ assert ArtifactType.SCREENSHOT_FINAL in artifact_types
+ assert settled_contexts == [browser_state.browser_context]
+ assert task.task_id not in manager.pages
+
+
class TestHandleActionTargetClosed:
async def _run(self, monkeypatch: pytest.MonkeyPatch, error: Exception) -> tuple[MagicMock, list]:
now = datetime.now(UTC)