Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
fix: run registered browser cleanup for VM browser contexts (SKY-10189) (#6200)
LawyZheng38fa9cc7eae7
diff --git a/skyvern/webeye/browser_state.py b/skyvern/webeye/browser_state.pyindex a430e6276..3dd05c311 100644--- a/skyvern/webeye/browser_state.py+++ b/skyvern/webeye/browser_state.py@@ -75,7 +75,7 @@ class BrowserState(Protocol):async def reload_page(self) -> None: ...- async def close(self, close_browser_on_completion: bool = True) -> None: ...+ async def close(self, close_browser_on_completion: bool = True, skip_cleanup: bool = False) -> None: ...async def take_fullpage_screenshot(self, file_path: str | None = None) -> bytes: ...diff --git a/skyvern/webeye/real_browser_manager.py b/skyvern/webeye/real_browser_manager.pyindex 4e2369455..a506b90b9 100644--- a/skyvern/webeye/real_browser_manager.py+++ b/skyvern/webeye/real_browser_manager.py@@ -552,7 +552,8 @@ class RealBrowserManager(BrowserManager):workflow_run_id=workflow_run_id,)try:- await task_browser_state.close(close_browser_on_completion=effective_close)+ # Cleanup runs once at the workflow level; skip here to avoid double-execution.+ await task_browser_state.close(close_browser_on_completion=effective_close, skip_cleanup=True)except Exception:LOG.info("Failed to close the browser state from the task block, might because it's already closed.",diff --git a/skyvern/webeye/real_browser_state.py b/skyvern/webeye/real_browser_state.pyindex 4f0113ea8..bc2477308 100644--- a/skyvern/webeye/real_browser_state.py+++ b/skyvern/webeye/real_browser_state.py@@ -402,7 +402,7 @@ class RealBrowserState(BrowserState):must_included_tags=must_included_tags,)- async def close(self, close_browser_on_completion: bool = True) -> None:+ async def close(self, close_browser_on_completion: bool = True, skip_cleanup: bool = False) -> None:LOG.info("Closing browser state")try:async with asyncio.timeout(BROWSER_CLOSE_TIMEOUT):@@ -413,12 +413,13 @@ class RealBrowserState(BrowserState):except Exception:LOG.warning("Failed to close browser context", exc_info=True)LOG.info("Main browser context and all its pages are closed")- if self.browser_cleanup is not None:- try:- await self.browser_cleanup()- LOG.info("Main browser cleanup is executed")- except Exception:- LOG.warning("Failed to execute browser cleanup", exc_info=True)++ if self.browser_cleanup is not None and not skip_cleanup:+ try:+ await self.browser_cleanup()+ LOG.info("Main browser cleanup is executed")+ except Exception:+ LOG.warning("Failed to execute browser cleanup", exc_info=True)except asyncio.TimeoutError:LOG.error("Timeout to close browser context, going to stop playwright directly")diff --git a/tests/unit/test_browser_state_cleanup.py b/tests/unit/test_browser_state_cleanup.pynew file mode 100644index 000000000..c390cd464--- /dev/null+++ b/tests/unit/test_browser_state_cleanup.py@@ -0,0 +1,74 @@+from __future__ import annotations++from unittest.mock import AsyncMock, MagicMock++import pytest++from skyvern.webeye.real_browser_state import RealBrowserState+++def browser_state():+ pw = MagicMock()+ pw.stop = AsyncMock()+ ctx = MagicMock()+ ctx.close = AsyncMock()+ cleanup = AsyncMock()+ state = RealBrowserState(+ pw=pw,+ browser_context=ctx,+ browser_cleanup=cleanup,+ )+ return state, pw, ctx, cleanup+++class TestBrowserStateClose:+ @pytest.mark.asyncio+ async def test_close_true_runs_context_close_and_cleanup(self, browser_state):+ state, pw, ctx, cleanup = browser_state+ await state.close(close_browser_on_completion=True)+ ctx.close.assert_called_once()+ cleanup.assert_called_once()+ pw.stop.assert_called_once()++ @pytest.mark.asyncio+ async def test_close_false_still_runs_cleanup(self, browser_state):+ state, pw, ctx, cleanup = browser_state+ await state.close(close_browser_on_completion=False)+ ctx.close.assert_not_called()+ cleanup.assert_called_once()+ pw.stop.assert_not_called()++ @pytest.mark.asyncio+ async def test_close_skip_cleanup(self, browser_state):+ state, pw, ctx, cleanup = browser_state+ await state.close(close_browser_on_completion=False, skip_cleanup=True)+ ctx.close.assert_not_called()+ cleanup.assert_not_called()+ pw.stop.assert_not_called()++ @pytest.mark.asyncio+ async def test_close_true_skip_cleanup(self, browser_state):+ state, pw, ctx, cleanup = browser_state+ await state.close(close_browser_on_completion=True, skip_cleanup=True)+ ctx.close.assert_called_once()+ cleanup.assert_not_called()+ pw.stop.assert_called_once()++ @pytest.mark.asyncio+ async def test_close_no_cleanup_func_is_noop(self):+ pw = MagicMock()+ pw.stop = AsyncMock()+ ctx = MagicMock()+ ctx.close = AsyncMock()+ state = RealBrowserState(pw=pw, browser_context=ctx, browser_cleanup=None)+ await state.close(close_browser_on_completion=False)+ ctx.close.assert_not_called()+ pw.stop.assert_not_called()++ @pytest.mark.asyncio+ async def test_cleanup_failure_does_not_raise(self, browser_state):+ state, pw, ctx, cleanup = browser_state+ cleanup.side_effect = RuntimeError("cleanup failed")+ await state.close(close_browser_on_completion=False)+ cleanup.assert_called_once()