- TaskRunner.run() and WorkflowRunner.run()/resume() accept an optional stop_reason callable alongside should_stop, distinguishing a genuine cancellation from other stop conditions (e.g. lost lease). - is_cancellation_reason() shared helper added to runtime/task.py. - WorkflowRunner._stop_status() now branches cancelled/failed based on stop_reason, correcting a prior blanket cancelled-on-any-stop behavior that conflicted with the host-agent-protocol spec's requirement to distinguish cancellation from lease-loss stops. - Default behavior (stop_reason=None) is preserved exactly for both runners so existing callers/tests are unaffected. - Task 1 of openspec change task-cancellation.
353 lines
12 KiB
Python
353 lines
12 KiB
Python
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
from core.models import Bounds, Scene, SceneElement, Task
|
|
from runtime.executor import Executor, ExecutorConfig
|
|
from runtime.planner import PlannedStep, Planner
|
|
from runtime.task import TaskRunner, TaskRunnerConfig
|
|
from storage.artifact_store import ArtifactStore
|
|
from storage.task_metadata import TaskMetadataStore
|
|
from storage.timeline import Timeline
|
|
from tests.fakes import PNG_10X20
|
|
|
|
|
|
class ScriptedPlanner(Planner):
|
|
def __init__(self, steps: list[PlannedStep]) -> None:
|
|
self.steps = steps
|
|
|
|
def plan(self, *, goal, scene, context):
|
|
if len(context.step_results) >= len(self.steps):
|
|
return []
|
|
return [self.steps[len(context.step_results)]]
|
|
|
|
def goal_reached(self, *, goal, scene, context):
|
|
return len(context.step_results) >= len(self.steps) and all(
|
|
result.success for result in context.step_results
|
|
)
|
|
|
|
|
|
def test_task_runner_executes_loop_and_writes_timeline(tmp_path) -> None:
|
|
scene = Scene(
|
|
width=10,
|
|
height=20,
|
|
elements=[
|
|
SceneElement(
|
|
id="search",
|
|
type="input",
|
|
text="Search",
|
|
bounds=Bounds(1, 2, 4, 4),
|
|
)
|
|
],
|
|
)
|
|
planner = ScriptedPlanner(
|
|
[
|
|
PlannedStep(action="tap", description="tap search", args={"x": 3, "y": 4}),
|
|
PlannedStep(
|
|
action="input_text",
|
|
description="type query",
|
|
args={"text": "Mac mini"},
|
|
),
|
|
]
|
|
)
|
|
executor = Executor(
|
|
tools={
|
|
"tap": lambda **kwargs: {"ok": True, **kwargs},
|
|
"input_text": lambda **kwargs: {"ok": True, **kwargs},
|
|
},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
)
|
|
metadata = TaskMetadataStore(tmp_path / "tasks.sqlite3")
|
|
timeline = Timeline(ArtifactStore(tmp_path / "history"))
|
|
task = Task(goal="open app and search", device_id="iphone-1")
|
|
|
|
runner = TaskRunner(
|
|
planner=planner,
|
|
executor=executor,
|
|
metadata_store=metadata,
|
|
timeline=timeline,
|
|
config=TaskRunnerConfig(max_steps=5),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
|
|
result = runner.run(task)
|
|
|
|
assert result.status == "completed"
|
|
assert len(timeline.read(task.id)) == 2
|
|
assert metadata.get_task(task.id)["status"] == "completed"
|
|
|
|
|
|
def test_task_runner_stops_before_the_next_planned_action() -> None:
|
|
scene = Scene(width=10, height=20, elements=[])
|
|
stop_requested = False
|
|
actions: list[str] = []
|
|
|
|
def record_action(**kwargs):
|
|
nonlocal stop_requested
|
|
actions.append("tap")
|
|
stop_requested = True
|
|
return {"ok": True}
|
|
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[
|
|
PlannedStep(action="tap", description="first", args={}),
|
|
PlannedStep(action="tap", description="second", args={}),
|
|
]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": record_action},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
config=TaskRunnerConfig(max_steps=5),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
|
|
result = runner.run(
|
|
Task(goal="perform two actions", device_id="phone"),
|
|
should_stop=lambda: stop_requested,
|
|
)
|
|
|
|
assert result.status == "failed"
|
|
assert result.failure_reason == "execution interrupted"
|
|
assert actions == ["tap"]
|
|
|
|
|
|
def test_task_runner_stop_reason_cancellation_yields_cancelled_status() -> None:
|
|
scene = Scene(width=10, height=20, elements=[])
|
|
stop_requested = False
|
|
|
|
def record_action(**kwargs):
|
|
nonlocal stop_requested
|
|
stop_requested = True
|
|
return {"ok": True}
|
|
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[
|
|
PlannedStep(action="tap", description="first", args={}),
|
|
PlannedStep(action="tap", description="second", args={}),
|
|
]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": record_action},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
config=TaskRunnerConfig(max_steps=5),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
|
|
result = runner.run(
|
|
Task(goal="perform two actions", device_id="phone"),
|
|
should_stop=lambda: stop_requested,
|
|
stop_reason=lambda: "cancellation requested by control plane",
|
|
)
|
|
|
|
assert result.status == "cancelled"
|
|
assert result.failure_reason == "cancellation requested by control plane"
|
|
|
|
|
|
def test_task_runner_stop_reason_lease_loss_yields_failed_status() -> None:
|
|
scene = Scene(width=10, height=20, elements=[])
|
|
stop_requested = False
|
|
|
|
def record_action(**kwargs):
|
|
nonlocal stop_requested
|
|
stop_requested = True
|
|
return {"ok": True}
|
|
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[
|
|
PlannedStep(action="tap", description="first", args={}),
|
|
PlannedStep(action="tap", description="second", args={}),
|
|
]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": record_action},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
config=TaskRunnerConfig(max_steps=5),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
|
|
result = runner.run(
|
|
Task(goal="perform two actions", device_id="phone"),
|
|
should_stop=lambda: stop_requested,
|
|
stop_reason=lambda: "lease rejected by control plane",
|
|
)
|
|
|
|
assert result.status == "failed"
|
|
assert result.failure_reason == "lease rejected by control plane"
|
|
|
|
|
|
def test_task_runner_persists_action_evidence_and_raw_ocr(tmp_path) -> None:
|
|
scene = Scene(
|
|
width=10,
|
|
height=20,
|
|
elements=[],
|
|
ocr_elements=[
|
|
SceneElement(
|
|
id="ocr-001",
|
|
type="text",
|
|
text="Search",
|
|
bounds=Bounds(1, 2, 3, 4),
|
|
confidence=0.98,
|
|
source="ocr",
|
|
)
|
|
],
|
|
)
|
|
screenshots = iter(
|
|
[
|
|
b"planning",
|
|
b"before-action",
|
|
b"after-action",
|
|
b"completion-check",
|
|
]
|
|
)
|
|
timeline = Timeline(ArtifactStore(tmp_path / "history"))
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[PlannedStep(action="tap", description="tap search", args={})]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": lambda **kwargs: {"ok": True}},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
timeline=timeline,
|
|
config=TaskRunnerConfig(max_steps=2),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: next(screenshots),
|
|
)
|
|
|
|
result = runner.run(Task(goal="tap search", device_id="iphone-1"))
|
|
|
|
assert result.status == "completed"
|
|
record = timeline.read(result.id)[0]
|
|
# The first step of a plan batch reuses the screenshot already captured
|
|
# for planning as its "before action" evidence, instead of taking a new
|
|
# one, so it can't drift from what the planner actually saw.
|
|
assert Path(record["before_screenshot_path"]).read_bytes() == b"planning"
|
|
assert Path(record["after_screenshot_path"]).read_bytes() == b"before-action"
|
|
assert record["tool_call"]["description"] == "tap search"
|
|
assert record["ocr_results"][0]["text"] == "Search"
|
|
|
|
|
|
def test_task_runner_only_reuses_planning_screenshot_for_first_step_in_batch(
|
|
tmp_path,
|
|
) -> None:
|
|
scene = Scene(width=10, height=20, elements=[])
|
|
|
|
class BatchPlanner(Planner):
|
|
def plan(self, *, goal, scene, context):
|
|
if context.step_results:
|
|
return []
|
|
return [
|
|
PlannedStep(action="tap", description="first", args={}),
|
|
PlannedStep(action="tap", description="second", args={}),
|
|
]
|
|
|
|
def goal_reached(self, *, goal, scene, context):
|
|
return len(context.step_results) >= 2
|
|
|
|
screenshots = iter(
|
|
[
|
|
b"planning", # vision screenshot + step 1's reused before_screenshot
|
|
b"after-step1",
|
|
b"before-step2", # step 2 has no matching planning-time capture
|
|
b"after-step2",
|
|
]
|
|
)
|
|
timeline = Timeline(ArtifactStore(tmp_path / "history"))
|
|
runner = TaskRunner(
|
|
planner=BatchPlanner(),
|
|
executor=Executor(
|
|
tools={"tap": lambda **kwargs: {"ok": True}},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
timeline=timeline,
|
|
config=TaskRunnerConfig(max_steps=2),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: next(screenshots),
|
|
)
|
|
|
|
result = runner.run(Task(goal="do two things", device_id="iphone-1"))
|
|
|
|
assert result.status == "completed"
|
|
records = timeline.read(result.id)
|
|
# Step 1 reuses the screenshot already captured for planning.
|
|
assert Path(records[0]["before_screenshot_path"]).read_bytes() == b"planning"
|
|
# Step 2 has no matching "at planning time" screenshot (step 1 already
|
|
# ran), so it must take a fresh one rather than reuse stale bytes.
|
|
assert Path(records[1]["before_screenshot_path"]).read_bytes() == b"before-step2"
|
|
|
|
|
|
def test_task_runner_persists_ui_tree_elements_from_fused_scene(tmp_path) -> None:
|
|
scene = Scene(
|
|
width=10,
|
|
height=20,
|
|
elements=[
|
|
SceneElement(
|
|
id="ui-000",
|
|
type="button",
|
|
text="Search",
|
|
bounds=Bounds(1, 2, 3, 4),
|
|
source="ui",
|
|
),
|
|
SceneElement(
|
|
id="ocr-000",
|
|
type="text",
|
|
text="Unrelated label",
|
|
bounds=Bounds(5, 6, 3, 4),
|
|
source="ocr",
|
|
),
|
|
],
|
|
)
|
|
timeline = Timeline(ArtifactStore(tmp_path / "history"))
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[PlannedStep(action="tap", description="tap search", args={})]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": lambda **kwargs: {"ok": True}},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
timeline=timeline,
|
|
config=TaskRunnerConfig(max_steps=2),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
|
|
result = runner.run(Task(goal="tap search", device_id="iphone-1"))
|
|
|
|
record = timeline.read(result.id)[0]
|
|
assert [element["text"] for element in record["ui_tree_results"]] == ["Search"]
|
|
assert [element["text"] for element in record["ocr_results"]] == ["Unrelated label"]
|
|
|
|
|
|
def test_task_runner_persists_empty_ui_tree_results_when_scene_has_no_ui_elements(
|
|
tmp_path,
|
|
) -> None:
|
|
scene = Scene(width=10, height=20, elements=[])
|
|
timeline = Timeline(ArtifactStore(tmp_path / "history"))
|
|
runner = TaskRunner(
|
|
planner=ScriptedPlanner(
|
|
[PlannedStep(action="tap", description="tap search", args={})]
|
|
),
|
|
executor=Executor(
|
|
tools={"tap": lambda **kwargs: {"ok": True}},
|
|
config=ExecutorConfig(max_retries=1, backoff_seconds=0),
|
|
),
|
|
timeline=timeline,
|
|
config=TaskRunnerConfig(max_steps=2),
|
|
observer=lambda device_id: scene,
|
|
screenshot_provider=lambda device_id: PNG_10X20,
|
|
)
|
|
result = runner.run(Task(goal="tap search", device_id="iphone-1"))
|
|
record = timeline.read(result.id)[0]
|
|
assert record["ui_tree_results"] == []
|