Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
SKY-13518: Stop asserting a minted run as browser-session owner in run_sdk_action (#8071)
Aaron Perez2f46c1287dcc
diff --git a/skyvern/exceptions.py b/skyvern/exceptions.pyindex 945c7c548..7b17ac491 100644--- a/skyvern/exceptions.py+++ b/skyvern/exceptions.py@@ -1376,6 +1376,14 @@ class BrowserSessionAlreadyOccupiedError(SkyvernHTTPException):super().__init__(f"Browser session {browser_session_id} is already occupied by {runnable_id}")+class BrowserSessionOwnershipConflict(SkyvernHTTPException):+ def __init__(self, browser_session_id: str) -> None:+ super().__init__(+ f"Persistent browser session {browser_session_id} is owned by a different runnable",+ status_code=HTTPStatus.CONFLICT,+ )++class BrowserSessionNotRenewable(SkyvernException):def __init__(self, reason: str, browser_session_id: str) -> None:super().__init__(f"Browser session {browser_session_id} is not renewable: {reason}")diff --git a/skyvern/forge/sdk/core/skyvern_context.py b/skyvern/forge/sdk/core/skyvern_context.pyindex 9e6688b26..5d1564c69 100644--- a/skyvern/forge/sdk/core/skyvern_context.py+++ b/skyvern/forge/sdk/core/skyvern_context.py@@ -102,6 +102,9 @@ class SkyvernContext:# both values forward; they never reconstruct ownership from mutable task or session rows.browser_session_runnable_id: str | None = Nonebrowser_session_runnable_generation_id: str | None = None+ # Set only by run_sdk_action when it mints a bookkeeping run for a standalone action. A minted+ # run never begins the browser session, so it must not be presented as the expected owner.+ workflow_run_is_synthetic: bool = Falsebrowser_runtime: str | None = Nonebrowser_address_is_server_assigned: bool = Falsetz_info: ZoneInfo | None = Nonediff --git a/skyvern/forge/sdk/routes/sdk.py b/skyvern/forge/sdk/routes/sdk.pyindex ddfdec1ff..57b16dea9 100644--- a/skyvern/forge/sdk/routes/sdk.py+++ b/skyvern/forge/sdk/routes/sdk.py@@ -147,6 +147,7 @@ async def run_sdk_action(max_screenshot_scrolls=task.max_screenshot_scrolls,workflow_id=workflow.workflow_id,workflow_run_id=workflow_run.workflow_run_id,+ workflow_run_is_synthetic=created_workflow_run,))result: Any | None = Nonediff --git a/skyvern/webeye/real_browser_manager.py b/skyvern/webeye/real_browser_manager.pyindex 0cc99ca5e..607367611 100644--- a/skyvern/webeye/real_browser_manager.py+++ b/skyvern/webeye/real_browser_manager.py@@ -222,6 +222,7 @@ class _EngineSelectionOwner:class _PersistentSessionLease:session_id: strorganization_id: str+ # Only a runnable that owns the session may create a cleanup lease.runnable_id: strbrowser_state: BrowserStaterunnable_generation_id: str | None = None@@ -805,10 +806,15 @@ class RealBrowserManager(BrowserManager):if browser_session_id:context = skyvern_context.current()+ # A synthetic run (minted per-action by run_sdk_action) never begins the session, so+ # presenting it as the expected owner can only ever fail the ownership guard (SKY-13518).+ owner_fallback_id = (+ None if context is not None and context.workflow_run_is_synthetic else workflow_run.workflow_run_id+ )expected_runnable_id = (browser_session_runnable_idor (context.browser_session_runnable_id if context else None)- or workflow_run.workflow_run_id+ or owner_fallback_id)expected_runnable_generation_id = browser_session_runnable_generation_id or (context.browser_session_runnable_generation_id if context else None@@ -840,14 +846,17 @@ class RealBrowserManager(BrowserManager):)else:LOG.info("Used to occupy browser session here", browser_session_id=browser_session_id)- await _rebind_pbs_download_dir(browser_state, download_run_id, browser_session_id)- self._persistent_session_leases[workflow_run.workflow_run_id] = _PersistentSessionLease(- session_id=browser_session_id,- organization_id=workflow_run.organization_id,- runnable_id=expected_runnable_id,- runnable_generation_id=expected_runnable_generation_id,- browser_state=browser_state,- )+ # An SDK-minted synthetic run only reads a session owned by another runnable.+ # It cannot rebind that runnable's download directory or acquire a cleanup lease.+ if expected_runnable_id is not None:+ await _rebind_pbs_download_dir(browser_state, download_run_id, browser_session_id)+ self._persistent_session_leases[workflow_run.workflow_run_id] = _PersistentSessionLease(+ session_id=browser_session_id,+ organization_id=workflow_run.organization_id,+ runnable_id=expected_runnable_id,+ runnable_generation_id=expected_runnable_generation_id,+ browser_state=browser_state,+ )page = await browser_state.get_working_page()if page:if url and navigate:@@ -891,14 +900,15 @@ class RealBrowserManager(BrowserManager):)if browser_state is None:raise- self._persistent_session_leases[workflow_run.workflow_run_id] = _PersistentSessionLease(- session_id=browser_session_id,- organization_id=workflow_run.organization_id,- runnable_id=expected_runnable_id,- runnable_generation_id=expected_runnable_generation_id,- browser_state=browser_state,- )- await _rebind_pbs_download_dir(browser_state, download_run_id, browser_session_id)+ if expected_runnable_id is not None:+ self._persistent_session_leases[workflow_run.workflow_run_id] = _PersistentSessionLease(+ session_id=browser_session_id,+ organization_id=workflow_run.organization_id,+ runnable_id=expected_runnable_id,+ runnable_generation_id=expected_runnable_generation_id,+ browser_state=browser_state,+ )+ await _rebind_pbs_download_dir(browser_state, download_run_id, browser_session_id)page = await browser_state.get_working_page()if page is not None:await browser_state.navigate_to_url(page=page, url=url)diff --git a/tests/unit/test_real_browser_manager.py b/tests/unit/test_real_browser_manager.pyindex 55e55c3ae..488425519 100644--- a/tests/unit/test_real_browser_manager.py+++ b/tests/unit/test_real_browser_manager.py@@ -145,6 +145,72 @@ async def test_pbs_workflow_run_returns_own_cache_not_parent() -> None:assert result is child_state+async def test_pbs_workflow_run_with_synthetic_run_does_not_assert_session_ownership() -> None:+ """SKY-13518: a synthetic bookkeeping run (minted per-action by run_sdk_action) never begins the+ session, so presenting it as the expected owner can only ever fail the DB ownership guard."""+ manager = RealBrowserManager()+ workflow_run = make_workflow_run("wfr_synthetic")++ pbs_state = MagicMock()+ pbs_state.get_working_page = AsyncMock(return_value=None)+ pbs_state.get_or_create_page = AsyncMock()++ skyvern_context.set(SkyvernContext(workflow_run_id="wfr_synthetic", workflow_run_is_synthetic=True))+ try:+ with (+ patch("skyvern.webeye.real_browser_manager.app") as mock_app,+ patch(+ "skyvern.webeye.real_browser_manager._rebind_pbs_download_dir",+ new_callable=AsyncMock,+ ) as mock_rebind,+ ):+ configure_browser_context_acquired_hook(mock_app)+ mock_app.PERSISTENT_SESSIONS_MANAGER.get_browser_state = AsyncMock(return_value=pbs_state)+ mock_app.PERSISTENT_SESSIONS_MANAGER.set_browser_state = AsyncMock()++ await manager.get_or_create_for_workflow_run(+ workflow_run=workflow_run,+ url="https://example.com",+ browser_session_id="bs_123",+ )+ finally:+ skyvern_context.reset()++ call_kwargs = mock_app.PERSISTENT_SESSIONS_MANAGER.get_browser_state.await_args.kwargs+ assert call_kwargs["expected_runnable_id"] is None+ # A synthetic run only reads a session owned by another runnable. It must not change that+ # runnable's download destination or acquire a lease that could later release the session.+ mock_rebind.assert_not_awaited()+ assert "wfr_synthetic" not in manager._persistent_session_leases+++async def test_pbs_workflow_run_without_lease_still_asserts_run_as_expected_owner() -> None:+ """Without the synthetic marker the run-id fallback stays: cross-process reads must keep being+ governed by the DB ownership guard (SKY-13473)."""+ manager = RealBrowserManager()+ workflow_run = make_workflow_run("wfr_child")++ pbs_state = MagicMock()+ pbs_state.get_working_page = AsyncMock(return_value=None)+ pbs_state.get_or_create_page = AsyncMock()++ with patch("skyvern.webeye.real_browser_manager.app") as mock_app:+ configure_browser_context_acquired_hook(mock_app)+ mock_app.PERSISTENT_SESSIONS_MANAGER.get_browser_state = AsyncMock(return_value=pbs_state)+ mock_app.PERSISTENT_SESSIONS_MANAGER.set_browser_state = AsyncMock()++ await manager.get_or_create_for_workflow_run(+ workflow_run=workflow_run,+ url="https://example.com",+ browser_session_id="bs_123",+ )++ call_kwargs = mock_app.PERSISTENT_SESSIONS_MANAGER.get_browser_state.await_args.kwargs+ assert call_kwargs["expected_runnable_id"] == "wfr_child"++@pytest.mark.asyncioasync def test_non_pbs_workflow_run_cache_hit_on_second_call() -> None:"""Non-PBS runs must also hit the early cache check on subsequent calls."""diff --git a/tests/unit/test_run_sdk_action_failures.py b/tests/unit/test_run_sdk_action_failures.pyindex f96a3f267..7052251b1 100644--- a/tests/unit/test_run_sdk_action_failures.py+++ b/tests/unit/test_run_sdk_action_failures.py@@ -187,3 +187,55 @@ async def test_owned_workflow_run_context_is_removed_on_cleanup(await run_sdk_action(mock_request, organization=mock_organization)mock_app.WORKFLOW_CONTEXT_MANAGER.remove_workflow_run_context.assert_called_once_with("wr_owned")+++async def test_minted_workflow_run_is_marked_synthetic_on_context(+ mock_request: Any, mock_organization: Any, mock_app: Any+) -> None:+ # SKY-13518: the minted run never begins the browser session, so the context must mark it+ # synthetic — downstream browser acquisition must not present it as the expected session owner.+ mock_request.workflow_run_id = None+ workflow = MagicMock(workflow_id="w_test", workflow_permanent_id="wpid_test", title="t")+ workflow_run = MagicMock(workflow_run_id="wr_owned", workflow_id="w_test")+ mock_app.WORKFLOW_SERVICE.create_empty_workflow = AsyncMock(return_value=workflow)+ mock_app.WORKFLOW_SERVICE.setup_workflow_run = AsyncMock(return_value=workflow_run)+ mock_app.WORKFLOW_SERVICE.mark_workflow_run_as_completed = AsyncMock(return_value=workflow_run)+ with (+ patch("skyvern.forge.sdk.routes.sdk.app", mock_app),+ patch("skyvern.forge.sdk.routes.sdk.skyvern_context") as mock_ctx,+ patch(+ "skyvern.core.script_generations.script_skyvern_page.ScriptSkyvernPage.create_scraped_page",+ new_callable=AsyncMock,+ side_effect=RuntimeError("stop inside try"),+ ),+ ):+ mock_ctx.ensure_context.return_value = MagicMock(request_id="req_test", tz_info=None, prompt=None)+ with pytest.raises(RuntimeError, match="stop inside try"):+ await run_sdk_action(mock_request, organization=mock_organization)++ replaced_context = mock_ctx.replace.call_args.args[0]+ assert replaced_context.workflow_run_is_synthetic is True+++async def test_client_provided_workflow_run_is_not_marked_synthetic(+ mock_request: Any, mock_organization: Any, mock_app: Any+) -> None:+ # A client-provided run may genuinely own the session (it can have begun it), so ownership+ # must still be asserted for it.+ with (+ patch("skyvern.forge.sdk.routes.sdk.app", mock_app),+ patch("skyvern.forge.sdk.routes.sdk.skyvern_context") as mock_ctx,+ patch(+ "skyvern.core.script_generations.script_skyvern_page.ScriptSkyvernPage.create_scraped_page",+ new_callable=AsyncMock,+ side_effect=RuntimeError("stop inside try"),+ ),+ ):+ mock_ctx.ensure_context.return_value = MagicMock(request_id="req_test", tz_info=None, prompt=None)+ with pytest.raises(RuntimeError, match="stop inside try"):+ await run_sdk_action(mock_request, organization=mock_organization)++ replaced_context = mock_ctx.replace.call_args.args[0]+ assert replaced_context.workflow_run_is_synthetic is False