Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
fix(SKY-10152): gate persistent profile write-back on run success (#6169)
LawyZheng3d31cc77a609
diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.pyindex 8939089a0..79fada83c 100644--- a/skyvern/forge/sdk/workflow/service.py+++ b/skyvern/forge/sdk/workflow/service.py@@ -5388,12 +5388,22 @@ class WorkflowService:and browser_state.browser_artifacts.browser_session_dirand not workflow_run.browser_profile_id):- await app.STORAGE.store_browser_session(- workflow_run.organization_id,- workflow.workflow_permanent_id,- browser_state.browser_artifacts.browser_session_dir,- )- LOG.info("Persisted browser session for workflow run", workflow_run_id=workflow_run.workflow_run_id)+ if workflow_run.status == WorkflowRunStatus.completed:+ await app.STORAGE.store_browser_session(+ workflow_run.organization_id,+ workflow.workflow_permanent_id,+ browser_state.browser_artifacts.browser_session_dir,+ )+ LOG.info(+ "Persisted browser session for workflow run",+ workflow_run_id=workflow_run.workflow_run_id,+ )+ else:+ LOG.info(+ "Skipped persisting browser session for non-completed workflow run",+ workflow_run_id=workflow_run.workflow_run_id,+ workflow_run_status=workflow_run.status,+ )await app.ARTIFACT_MANAGER.wait_for_upload_aiotasks(all_workflow_task_ids)diff --git a/tests/unit/test_workflow_service_profile_writeback.py b/tests/unit/test_workflow_service_profile_writeback.pynew file mode 100644index 000000000..a1bedaf72--- /dev/null+++ b/tests/unit/test_workflow_service_profile_writeback.py@@ -0,0 +1,108 @@+"""Tests for persistent browser profile write-back gating.++The persistent browser session should only be written back to S3 when the+workflow run completes successfully. Crashed or failed runs must NOT+overwrite the shared S3 profile with their dirty state.+"""++from __future__ import annotations++from unittest.mock import AsyncMock, MagicMock++import pytest++from skyvern.forge import app+from skyvern.forge.sdk.workflow.models.workflow import WorkflowRunStatus+++def _make_workflow(persist: bool = True) -> MagicMock:+ wf = MagicMock()+ wf.persist_browser_session = persist+ wf.workflow_permanent_id = "wpid_test"+ return wf+++def _make_workflow_run(status: WorkflowRunStatus) -> MagicMock:+ wr = MagicMock()+ wr.workflow_run_id = "wr_test"+ wr.organization_id = "o_test"+ wr.status = status+ wr.browser_profile_id = None+ wr.browser_address = None+ wr.webhook_callback_url = None+ wr.created_at = None+ wr.workflow_permanent_id = "wpid_test"+ return wr+++def _make_browser_state() -> MagicMock:+ bs = MagicMock()+ bs.browser_artifacts.browser_session_dir = "/tmp/fake_profile"+ return bs+++def _patch_clean_up_deps(monkeypatch: pytest.MonkeyPatch, browser_state: MagicMock) -> AsyncMock:+ """Patch all external dependencies of clean_up_workflow. Returns the store mock."""+ store_mock = AsyncMock()+ monkeypatch.setattr(app.STORAGE, "store_browser_session", store_mock)+ monkeypatch.setattr(app.STORAGE, "save_downloaded_files", AsyncMock())+ monkeypatch.setattr(app.BROWSER_MANAGER, "cleanup_for_workflow_run", AsyncMock(return_value=browser_state))+ monkeypatch.setattr(app.ARTIFACT_MANAGER, "wait_for_upload_aiotasks", AsyncMock())+ monkeypatch.setattr(app.AGENT_FUNCTION, "release_proxy_session_for_owner", AsyncMock())+ monkeypatch.setattr(+ app.DATABASE.workflow_runs,+ "get_workflow_runs_by_parent_workflow_run_id",+ AsyncMock(return_value=[]),+ )+ return store_mock+++async def test_profile_persisted_on_completed_run(monkeypatch: pytest.MonkeyPatch) -> None:+ """Completed runs should write the browser profile back to S3."""+ from skyvern.forge.sdk.workflow.service import WorkflowService++ workflow = _make_workflow(persist=True)+ workflow_run = _make_workflow_run(WorkflowRunStatus.completed)+ browser_state = _make_browser_state()+ store_mock = _patch_clean_up_deps(monkeypatch, browser_state)++ svc = WorkflowService()+ monkeypatch.setattr(svc, "persist_video_data", AsyncMock())+ monkeypatch.setattr(svc, "get_tasks_by_workflow_run_id", AsyncMock(return_value=[]))++ await svc.clean_up_workflow(workflow=workflow, workflow_run=workflow_run, need_call_webhook=False)++ store_mock.assert_awaited_once_with("o_test", "wpid_test", "/tmp/fake_profile")+++ "status",+ [+ WorkflowRunStatus.failed,+ WorkflowRunStatus.terminated,+ WorkflowRunStatus.canceled,+ WorkflowRunStatus.timed_out,+ WorkflowRunStatus.running,+ ],+)+async def test_profile_not_persisted_on_non_completed_run(+ monkeypatch: pytest.MonkeyPatch,+ status: WorkflowRunStatus,+) -> None:+ """Non-completed runs must NOT write the browser profile back to S3."""+ from skyvern.forge.sdk.workflow.service import WorkflowService++ workflow = _make_workflow(persist=True)+ workflow_run = _make_workflow_run(status)+ browser_state = _make_browser_state()+ store_mock = _patch_clean_up_deps(monkeypatch, browser_state)++ svc = WorkflowService()+ monkeypatch.setattr(svc, "persist_video_data", AsyncMock())+ monkeypatch.setattr(svc, "get_tasks_by_workflow_run_id", AsyncMock(return_value=[]))++ await svc.clean_up_workflow(workflow=workflow, workflow_run=workflow_run, need_call_webhook=False)++ store_mock.assert_not_awaited()