Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
feat: add refresh-session API endpoint and storage deletion (SKY-8955 BE) (#5544)
Aaron Pereze13f34b99668
diff --git a/skyvern/forge/sdk/api/aws.py b/skyvern/forge/sdk/api/aws.pyindex a553e0a0d..5b3a4b54d 100644--- a/skyvern/forge/sdk/api/aws.py+++ b/skyvern/forge/sdk/api/aws.py@@ -296,7 +296,7 @@ class AsyncAWSClient:LOG.exception("S3 download failed", uri=uri)return None- async def delete_file(self, uri: str, log_exception: bool = True) -> None:+ async def delete_file(self, uri: str, log_exception: bool = True, raise_on_error: bool = False) -> None:# https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/delete_object.htmlasync def _op() -> None:async with self._s3_client() as client:@@ -308,6 +308,8 @@ class AsyncAWSClient:except Exception:if log_exception:LOG.exception("S3 delete failed", uri=uri)+ if raise_on_error:+ raiseasync def get_object_info(self, uri: str) -> dict:async def _op() -> dict:diff --git a/skyvern/forge/sdk/artifact/storage/azure.py b/skyvern/forge/sdk/artifact/storage/azure.pyindex c937266f3..0923c4063 100644--- a/skyvern/forge/sdk/artifact/storage/azure.py+++ b/skyvern/forge/sdk/artifact/storage/azure.py@@ -194,6 +194,16 @@ class AzureStorage(BaseStorage):temp_zip_file.close()return temp_dir+ async def delete_browser_session(self, organization_id: str, workflow_permanent_id: str) -> None:+ browser_session_uri = f"azure://{settings.AZURE_STORAGE_CONTAINER_BROWSER_SESSIONS}/{settings.ENV}/{organization_id}/{workflow_permanent_id}.zip"+ LOG.info(+ "Deleting persisted browser session",+ organization_id=organization_id,+ workflow_permanent_id=workflow_permanent_id,+ browser_session_uri=browser_session_uri,+ )+ await self.async_client.delete_file(browser_session_uri)+async def store_browser_profile(self, organization_id: str, profile_id: str, directory: str) -> None:"""Store browser profile to Azure."""temp_zip_file = create_named_temporary_file()diff --git a/skyvern/forge/sdk/artifact/storage/base.py b/skyvern/forge/sdk/artifact/storage/base.pyindex 66dcb241e..72f484402 100644--- a/skyvern/forge/sdk/artifact/storage/base.py+++ b/skyvern/forge/sdk/artifact/storage/base.py@@ -126,6 +126,10 @@ class BaseStorage(ABC):async def retrieve_browser_session(self, organization_id: str, workflow_permanent_id: str) -> str | None:pass+ @abstractmethod+ async def delete_browser_session(self, organization_id: str, workflow_permanent_id: str) -> None:+ pass+@abstractmethodasync def store_browser_profile(self, organization_id: str, profile_id: str, directory: str) -> None:"""Store a browser profile from a directory."""diff --git a/skyvern/forge/sdk/artifact/storage/local.py b/skyvern/forge/sdk/artifact/storage/local.pyindex f59da9127..848f968f6 100644--- a/skyvern/forge/sdk/artifact/storage/local.py+++ b/skyvern/forge/sdk/artifact/storage/local.py@@ -227,6 +227,29 @@ class LocalStorage(BaseStorage):return Nonereturn str(stored_folder_path)+ async def delete_browser_session(self, organization_id: str, workflow_permanent_id: str) -> None:+ stored_folder_path = self._resolve_browser_storage_path(organization_id, workflow_permanent_id)+ if stored_folder_path is None:+ LOG.warning(+ "Refused to delete browser session outside storage base path",+ organization_id=organization_id,+ workflow_permanent_id=workflow_permanent_id,+ base_path=settings.BROWSER_SESSION_BASE_PATH,+ )+ return+ if not stored_folder_path.exists():+ return+ try:+ shutil.rmtree(stored_folder_path)+ except Exception:+ LOG.exception(+ "Failed to delete local browser session",+ organization_id=organization_id,+ workflow_permanent_id=workflow_permanent_id,+ path=str(stored_folder_path),+ )+ raise+async def store_browser_profile(self, organization_id: str, profile_id: str, directory: str) -> None:"""Store browser profile locally."""stored_folder_path = self._resolve_browser_storage_path(organization_id, "profiles", profile_id)diff --git a/skyvern/forge/sdk/artifact/storage/s3.py b/skyvern/forge/sdk/artifact/storage/s3.pyindex 25dffb623..51b934ea5 100644--- a/skyvern/forge/sdk/artifact/storage/s3.py+++ b/skyvern/forge/sdk/artifact/storage/s3.py@@ -226,6 +226,18 @@ class S3Storage(BaseStorage):temp_zip_file.close()return temp_dir+ async def delete_browser_session(self, organization_id: str, workflow_permanent_id: str) -> None:+ browser_session_uri = f"s3://{settings.AWS_S3_BUCKET_BROWSER_SESSIONS}/{settings.ENV}/{organization_id}/{workflow_permanent_id}.zip"+ LOG.info(+ "Deleting persisted browser session",+ organization_id=organization_id,+ workflow_permanent_id=workflow_permanent_id,+ browser_session_uri=browser_session_uri,+ )+ # S3 DeleteObject is idempotent: deleting a missing key is a no-op, so only real+ # failures (AccessDenied, network, etc.) will raise here.+ await self.async_client.delete_file(browser_session_uri, log_exception=True, raise_on_error=True)+async def store_browser_profile(self, organization_id: str, profile_id: str, directory: str) -> None:"""Store browser profile to S3."""temp_zip_file = create_named_temporary_file()diff --git a/skyvern/forge/sdk/routes/agent_protocol.py b/skyvern/forge/sdk/routes/agent_protocol.pyindex 0c8c3312a..4bca19bff 100644--- a/skyvern/forge/sdk/routes/agent_protocol.py+++ b/skyvern/forge/sdk/routes/agent_protocol.py@@ -2941,6 +2941,63 @@ async def get_workflow_versions()+@base_router.post(+ "/workflows/{workflow_permanent_id}/browser_session/refresh",+ status_code=http_status.HTTP_204_NO_CONTENT,+ tags=["Workflows"],+ summary="Refresh persisted browser session",+ description=(+ "Clear the persisted browser session for a workflow that uses `Save & Reuse Session`. "+ "The next run will start from a fresh browser state. Use when a saved session is corrupted."+ ),+ responses={+ 204: {"description": "Successfully cleared persisted browser session"},+ 404: {"description": "Workflow not found"},+ },+)+@base_router.post(+ "/workflows/{workflow_permanent_id}/browser_session/refresh/",+ status_code=http_status.HTTP_204_NO_CONTENT,+ include_in_schema=False,+)+async def refresh_workflow_browser_session(+ workflow_permanent_id: str = Path(+ ...,+ description="The permanent ID of the workflow. Starts with `wpid_`.",+ examples=["wpid_123"],+ ),+ current_org: Organization = Depends(org_auth_service.get_current_org),+) -> None:+ analytics.capture("skyvern-oss-agent-workflow-browser-session-refresh")+ # Verify the workflow exists and belongs to the caller's organization.+ await app.WORKFLOW_SERVICE.get_workflow_by_permanent_id(+ workflow_permanent_id=workflow_permanent_id,+ organization_id=current_org.organization_id,+ )+ LOG.info(+ "Refreshing persisted browser session for workflow",+ organization_id=current_org.organization_id,+ workflow_permanent_id=workflow_permanent_id,+ )+ try:+ await app.STORAGE.delete_browser_session(+ organization_id=current_org.organization_id,+ workflow_permanent_id=workflow_permanent_id,+ )+ except SkyvernHTTPException:+ raise+ except Exception as exc:+ LOG.exception(+ "Failed to refresh persisted browser session for workflow",+ organization_id=current_org.organization_id,+ workflow_permanent_id=workflow_permanent_id,+ )+ raise SkyvernHTTPException(+ message="Failed to clear the persisted browser session. Please retry the refresh operation.",+ status_code=http_status.HTTP_500_INTERNAL_SERVER_ERROR,+ ) from exc++@legacy_base_router.post("/suggest/{ai_suggestion_type}",include_in_schema=False,diff --git a/tests/unit/forge/sdk/test_refresh_browser_session_route.py b/tests/unit/forge/sdk/test_refresh_browser_session_route.pynew file mode 100644index 000000000..b547d70dc--- /dev/null+++ b/tests/unit/forge/sdk/test_refresh_browser_session_route.py@@ -0,0 +1,71 @@+"""Tests for POST /workflows/{wpid}/browser_session/refresh."""++from __future__ import annotations++from types import SimpleNamespace+from unittest.mock import AsyncMock++import pytest+from fastapi import FastAPI, Request+from fastapi.responses import JSONResponse+from fastapi.testclient import TestClient++from skyvern.exceptions import SkyvernHTTPException, WorkflowNotFound+from skyvern.forge import app as forge_app+from skyvern.forge.sdk.routes import routers as routers_module+from skyvern.forge.sdk.services import org_auth_service+++def _build_client(monkeypatch: pytest.MonkeyPatch) -> tuple[TestClient, AsyncMock, AsyncMock]:+ async def _fake_org() -> SimpleNamespace:+ return SimpleNamespace(organization_id="org_oss")++ get_workflow = AsyncMock()+ delete_browser_session = AsyncMock()+ monkeypatch.setattr(forge_app.WORKFLOW_SERVICE, "get_workflow_by_permanent_id", get_workflow)+ monkeypatch.setattr(forge_app.STORAGE, "delete_browser_session", delete_browser_session)++ fastapi_app = FastAPI()+ fastapi_app.dependency_overrides[org_auth_service.get_current_org] = _fake_org+ fastapi_app.include_router(routers_module.base_router, prefix="/v1")++ @fastapi_app.exception_handler(SkyvernHTTPException)+ async def _handle_skyvern_http_exception(request: Request, exc: SkyvernHTTPException) -> JSONResponse:+ return JSONResponse(status_code=exc.status_code, content={"detail": exc.message})++ return TestClient(fastapi_app), get_workflow, delete_browser_session+++def test_refresh_browser_session_clears_storage(monkeypatch: pytest.MonkeyPatch) -> None:+ client, get_workflow, delete_browser_session = _build_client(monkeypatch)+ get_workflow.return_value = SimpleNamespace(workflow_permanent_id="wpid_123")++ response = client.post("/v1/workflows/wpid_123/browser_session/refresh")++ assert response.status_code == 204+ get_workflow.assert_awaited_once_with(workflow_permanent_id="wpid_123", organization_id="org_oss")+ delete_browser_session.assert_awaited_once_with(+ organization_id="org_oss",+ workflow_permanent_id="wpid_123",+ )+++def test_refresh_browser_session_workflow_not_found(monkeypatch: pytest.MonkeyPatch) -> None:+ client, get_workflow, delete_browser_session = _build_client(monkeypatch)+ get_workflow.side_effect = WorkflowNotFound(workflow_permanent_id="wpid_missing")++ response = client.post("/v1/workflows/wpid_missing/browser_session/refresh")++ assert response.status_code == 404+ delete_browser_session.assert_not_awaited()+++def test_refresh_browser_session_storage_failure_returns_500(monkeypatch: pytest.MonkeyPatch) -> None:+ client, get_workflow, delete_browser_session = _build_client(monkeypatch)+ get_workflow.return_value = SimpleNamespace(workflow_permanent_id="wpid_123")+ delete_browser_session.side_effect = RuntimeError("s3 AccessDenied")++ response = client.post("/v1/workflows/wpid_123/browser_session/refresh")++ assert response.status_code == 500+ assert "retry" in response.json()["detail"].lower()