Skip to content

Automate browser based workflows with AI

Fix loop-scoped Task V2 download filtering (#5477)

Shuchang Zhengfa397afc05c4
diff --git a/skyvern/forge/sdk/workflow/models/block.py b/skyvern/forge/sdk/workflow/models/block.py
index 65dd245e9..9ee986061 100644
--- a/skyvern/forge/sdk/workflow/models/block.py
+++ b/skyvern/forge/sdk/workflow/models/block.py
@@ -3,6 +3,7 @@ from __future__ import annotations
import abc
import ast
import asyncio
+import copy
import csv
import json
import os
@@ -4701,6 +4702,11 @@ class TaskV2Block(Block):
workflow_run = await app.DATABASE.workflow_runs.get_workflow_run(workflow_run_id, organization_id)
if not workflow_run:
raise ValueError(f"WorkflowRun not found {workflow_run_id} when running TaskV2Block")
+ current_context = skyvern_context.current()
+ download_lookup_run_id = (
+ current_context.run_id if current_context and current_context.run_id else workflow_run_id
+ )
+ loop_internal_state = copy.deepcopy(current_context.loop_internal_state) if current_context else None
try:
task_v2 = await task_v2_service.initialize_task_v2(
organization=organization,
@@ -4779,19 +4785,18 @@ class TaskV2Block(Block):
)
# Attempt to get downloaded files for the current iteration
- current_context = skyvern_context.current()
downloaded_files: list[FileInfo] = []
try:
async with asyncio.timeout(GET_DOWNLOADED_FILES_TIMEOUT):
downloaded_files = await app.STORAGE.get_downloaded_files(
organization_id=organization_id or "",
- run_id=current_context.run_id if current_context and current_context.run_id else workflow_run_id,
+ run_id=download_lookup_run_id,
)
except asyncio.TimeoutError:
LOG.warning("Timeout getting downloaded files", task_v2_id=task_v2.observer_cruise_id)
downloaded_files = filter_downloaded_files_for_current_iteration(
downloaded_files,
- current_context.loop_internal_state if current_context else None,
+ loop_internal_state,
)
task_v2_output = {
diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.py
index 16d99c1b9..3ecbab9fc 100644
--- a/skyvern/forge/sdk/workflow/service.py
+++ b/skyvern/forge/sdk/workflow/service.py
@@ -1,4 +1,5 @@
import asyncio
+import copy
import importlib.util
import json
import os
@@ -712,6 +713,7 @@ class WorkflowService:
workflow_permanent_id=workflow_run.workflow_permanent_id,
max_steps_override=max_steps_override,
max_screenshot_scrolls=workflow_request.max_screenshot_scrolls,
+ loop_internal_state=copy.deepcopy(context.loop_internal_state) if context else None,
)
)
diff --git a/skyvern/services/task_v2_service.py b/skyvern/services/task_v2_service.py
index f1d0f653a..537df89b6 100644
--- a/skyvern/services/task_v2_service.py
+++ b/skyvern/services/task_v2_service.py
@@ -1,3 +1,4 @@
+import copy
import json
import string
from datetime import UTC, datetime
@@ -492,6 +493,7 @@ async def run_task_v2(
run_id=current_run_id,
request_id=request_id,
browser_session_id=browser_session_id,
+ loop_internal_state=copy.deepcopy(parent_context.loop_internal_state) if parent_context else None,
)
# SKY-7005: scoped() restores the parent context on exit, preserving
# loop_internal_state so per-iteration download filtering continues to
diff --git a/tests/unit/test_taskv2_block_context_preservation.py b/tests/unit/test_taskv2_block_context_preservation.py
index 15e17da4b..0c34a20a9 100644
--- a/tests/unit/test_taskv2_block_context_preservation.py
+++ b/tests/unit/test_taskv2_block_context_preservation.py
@@ -1,4 +1,6 @@
+from types import SimpleNamespace
from typing import Any
+from unittest.mock import AsyncMock, patch
import pytest
@@ -6,6 +8,7 @@ from skyvern.config import settings
from skyvern.forge.sdk.core import skyvern_context
from skyvern.forge.sdk.core.skyvern_context import SkyvernContext
from skyvern.forge.sdk.experimentation import providers as providers_module
+from skyvern.services import task_v2_service
class CaptureLogger:
@@ -220,3 +223,53 @@ def test_replace_flushes_existing_context_before_overwrite(monkeypatch: pytest.M
)
]
assert skyvern_context.current() is replacement_context
+
+
+async def test_run_task_v2_copies_parent_loop_state_into_child_context(monkeypatch: pytest.MonkeyPatch) -> None:
+ loop_state = {"downloaded_file_signatures_before_iteration": [("a.pdf", "abc", "https://files/a.pdf")]}
+ parent_context = SkyvernContext(
+ organization_id="org_parent",
+ organization_name="Parent Org",
+ workflow_run_id="wr_parent",
+ root_workflow_run_id="wr_root",
+ run_id="wr_parent",
+ loop_internal_state=loop_state,
+ )
+ skyvern_context.set(parent_context)
+
+ task_v2 = SimpleNamespace(
+ observer_cruise_id="tsk_v2_child",
+ workflow_id="wf_child",
+ workflow_run_id="wr_child",
+ )
+ captured_contexts: list[SkyvernContext] = []
+
+ async def fake_run_task_v2_helper(**_: Any) -> tuple[object, object, object]:
+ current_context = skyvern_context.ensure_context()
+ captured_contexts.append(current_context)
+ return (
+ SimpleNamespace(workflow_id="wf_child"),
+ SimpleNamespace(parent_workflow_run_id=None, browser_address=None),
+ task_v2,
+ )
+
+ monkeypatch.setattr(task_v2_service, "run_task_v2_helper", fake_run_task_v2_helper)
+
+ with patch("skyvern.services.task_v2_service.app") as mock_app:
+ mock_app.DATABASE.observer.get_task_v2 = AsyncMock(return_value=task_v2)
+ mock_app.WORKFLOW_SERVICE.clean_up_workflow = AsyncMock()
+
+ result = await task_v2_service.run_task_v2(
+ organization=SimpleNamespace(organization_id="org_parent", organization_name="Parent Org"),
+ task_v2_id="tsk_v2_child",
+ )
+
+ assert result is task_v2
+ assert len(captured_contexts) == 1
+ child_context = captured_contexts[0]
+ assert child_context.run_id == "wr_parent"
+ assert child_context.root_workflow_run_id == "wr_root"
+ assert child_context.loop_internal_state == loop_state
+ assert child_context.loop_internal_state is not loop_state
+ assert skyvern_context.current() is parent_context
diff --git a/tests/unit/test_taskv2_block_downloaded_files.py b/tests/unit/test_taskv2_block_downloaded_files.py
index e0a7063d9..24e3a4963 100644
--- a/tests/unit/test_taskv2_block_downloaded_files.py
+++ b/tests/unit/test_taskv2_block_downloaded_files.py
@@ -1,15 +1,37 @@
"""Tests for TaskV2Block downloaded_files output with loop-scoped filtering (SKY-7005)."""
+from datetime import UTC, datetime
+from types import SimpleNamespace
+from unittest.mock import AsyncMock
+
+import pytest
+
from skyvern.forge.sdk.core import skyvern_context
from skyvern.forge.sdk.core.skyvern_context import SkyvernContext
from skyvern.forge.sdk.schemas.files import FileInfo
+from skyvern.forge.sdk.schemas.task_v2 import TaskV2Status
from skyvern.forge.sdk.workflow.loop_download_filter import filter_downloaded_files_for_current_iteration
+from skyvern.forge.sdk.workflow.models import block as block_module
+from skyvern.forge.sdk.workflow.models.block import TaskV2Block
+from skyvern.forge.sdk.workflow.models.parameter import OutputParameter, ParameterType
def _file(url: str, filename: str, checksum: str) -> FileInfo:
return FileInfo(url=url, filename=filename, checksum=checksum)
+def _output_parameter(key: str) -> OutputParameter:
+ now = datetime.now(UTC)
+ return OutputParameter(
+ parameter_type=ParameterType.OUTPUT,
+ key=key,
+ output_parameter_id=f"op_{key}",
+ workflow_id="wf_test",
+ created_at=now,
+ modified_at=now,
+ )
+
+
def test_taskv2_output_includes_downloaded_files_filtered_by_loop() -> None:
"""When inside a loop, TaskV2Block output should include only THIS iteration's downloaded files."""
# Simulate baseline: iteration started with a.pdf already downloaded
@@ -133,3 +155,120 @@ def test_taskv2_context_loop_state_available_after_nested_task_execution() -> No
assert [f.filename for f in filtered] == ["b.pdf"]
skyvern_context.reset()
+
+
[email protected](autouse=True)
+def reset_context() -> None:
+ skyvern_context.reset()
+ yield
+ skyvern_context.reset()
+
+
+async def test_taskv2_block_uses_pre_run_loop_state_for_download_filtering(
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ parent_context = SkyvernContext(
+ organization_id="org_1",
+ workflow_run_id="wr_parent",
+ run_id="wr_parent",
+ loop_internal_state={
+ "downloaded_file_signatures_before_iteration": [
+ ("a.zip", "abc", "file:///app/downloads/wr_parent/a.zip"),
+ ],
+ },
+ )
+ skyvern_context.set(parent_context)
+
+ outer_workflow_run = SimpleNamespace(proxy_location=None, max_screenshot_scrolls=None)
+ child_workflow_run = SimpleNamespace(failure_reason=None)
+ organization = SimpleNamespace(organization_id="org_1", organization_name="Org 1")
+ downloaded_files = [
+ _file("file:///app/downloads/wr_parent/a.zip", "a.zip", "abc"),
+ _file("file:///app/downloads/wr_parent/b.zip", "b.zip", "def"),
+ ]
+
+ fake_app = SimpleNamespace(
+ DATABASE=SimpleNamespace(
+ organizations=SimpleNamespace(get_organization=AsyncMock(return_value=organization)),
+ workflow_runs=SimpleNamespace(
+ get_workflow_run=AsyncMock(side_effect=[outer_workflow_run, child_workflow_run]),
+ update_workflow_run=AsyncMock(),
+ ),
+ observer=SimpleNamespace(
+ update_task_v2=AsyncMock(),
+ update_workflow_run_block=AsyncMock(),
+ ),
+ ),
+ WORKFLOW_SERVICE=SimpleNamespace(
+ get_recent_task_screenshot_artifacts=AsyncMock(return_value=[]),
+ get_recent_workflow_screenshot_artifacts=AsyncMock(return_value=[]),
+ ),
+ STORAGE=SimpleNamespace(get_downloaded_files=AsyncMock(return_value=downloaded_files)),
+ )
+ monkeypatch.setattr(block_module, "app", fake_app)
+
+ from skyvern.services import task_v2_service
+
+ initialized_task_v2 = SimpleNamespace(observer_cruise_id="tsk_v2_1", workflow_run_id="wr_child")
+ completed_task_v2 = SimpleNamespace(
+ observer_cruise_id="tsk_v2_1",
+ workflow_run_id="wr_child",
+ output={"result": "ok"},
+ status=TaskV2Status.completed,
+ summary="done",
+ failure_category=None,
+ )
+ monkeypatch.setattr(task_v2_service, "initialize_task_v2", AsyncMock(return_value=initialized_task_v2))
+
+ async def fake_run_task_v2(**_: object) -> SimpleNamespace:
+ # Simulate nested task execution restoring a parent context that lost loop state.
+ skyvern_context.set(
+ SkyvernContext(
+ organization_id="org_1",
+ workflow_run_id="wr_parent",
+ run_id="wr_parent",
+ loop_internal_state=None,
+ )
+ )
+ return completed_task_v2
+
+ monkeypatch.setattr(task_v2_service, "run_task_v2", fake_run_task_v2)
+
+ recorded_outputs: list[dict[str, object]] = []
+ block = TaskV2Block(
+ label="download_page",
+ output_parameter=_output_parameter("download_page_output"),
+ prompt="download the file",
+ url="https://example.com",
+ )
+ monkeypatch.setattr(
+ TaskV2Block,
+ "get_workflow_run_context",
+ lambda self, workflow_run_id: SimpleNamespace(credential_totp_identifiers={}),
+ )
+ monkeypatch.setattr(TaskV2Block, "format_potential_template_parameters", lambda self, _: None)
+
+ async def fake_record_output_parameter_value(
+ self: TaskV2Block,
+ workflow_run_context: object,
+ workflow_run_id: str,
+ value: dict[str, object],
+ ) -> None:
+ recorded_outputs.append(value)
+
+ async def fake_build_block_result(self: TaskV2Block, **kwargs: object) -> SimpleNamespace:
+ return SimpleNamespace(**kwargs)
+
+ monkeypatch.setattr(TaskV2Block, "record_output_parameter_value", fake_record_output_parameter_value)
+ monkeypatch.setattr(TaskV2Block, "build_block_result", fake_build_block_result)
+
+ await block.execute(
+ workflow_run_id="wr_parent",
+ workflow_run_block_id="wrb_1",
+ organization_id="org_1",
+ )
+
+ assert len(recorded_outputs) == 1
+ assert [file_info["filename"] for file_info in recorded_outputs[0]["downloaded_files"]] == ["b.zip"]
+ assert recorded_outputs[0]["downloaded_file_urls"] == ["file:///app/downloads/wr_parent/b.zip"]
diff --git a/tests/unit/test_workflow_run_parameter_batching.py b/tests/unit/test_workflow_run_parameter_batching.py
index 441cde8ba..25e062180 100644
--- a/tests/unit/test_workflow_run_parameter_batching.py
+++ b/tests/unit/test_workflow_run_parameter_batching.py
@@ -15,6 +15,8 @@ import pytest
from sqlalchemy.exc import IntegrityError
from skyvern.exceptions import InvalidCredentialId, MissingValueForParameter, WorkflowRunParameterPersistenceError
+from skyvern.forge.sdk.core import skyvern_context
+from skyvern.forge.sdk.core.skyvern_context import SkyvernContext
from skyvern.forge.sdk.workflow.models.parameter import WorkflowParameter, WorkflowParameterType
from skyvern.forge.sdk.workflow.models.workflow import WorkflowRequestBody
from skyvern.forge.sdk.workflow.service import WorkflowService
@@ -77,6 +79,13 @@ def _make_service_with_mocks(
return service, organization, workflow_run
[email protected](autouse=True)
+def reset_context() -> None:
+ skyvern_context.reset()
+ yield
+ skyvern_context.reset()
+
+
@pytest.mark.asyncio
async def test_setup_workflow_run_raises_on_missing_required_parameters() -> None:
"""When required parameters have no value and no default, setup should raise MissingValueForParameter."""
@@ -170,3 +179,37 @@ async def test_setup_workflow_run_raises_on_non_string_credential_id() -> None:
)
service.create_workflow_run_parameters.assert_not_awaited()
+
+
+async def test_setup_workflow_run_preserves_parent_loop_state_when_replacing_context() -> None:
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=[])
+
+ loop_state = {"downloaded_file_signatures_before_iteration": [("a.pdf", "abc", "https://files/a.pdf")]}
+ parent_context = SkyvernContext(
+ organization_id="org_test",
+ organization_name="Test Org",
+ workflow_run_id="wr_parent",
+ root_workflow_run_id="wr_root",
+ run_id="wr_parent",
+ loop_internal_state=loop_state,
+ )
+ skyvern_context.set(parent_context)
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=WorkflowRequestBody(data={}),
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ current_context = skyvern_context.current()
+ assert current_context is not None
+ assert current_context.workflow_run_id == "wr_test"
+ assert current_context.run_id == "wr_parent"
+ assert current_context.root_workflow_run_id == "wr_root"
+ assert current_context.loop_internal_state == loop_state
+ assert current_context.loop_internal_state is not loop_state