feat: persist and inspect run step budgets

This commit is contained in:
lda
2026-09-05 21:00:00 +07:00 Verified
parent 344902c17e
commit 7141a8818d
17 changed files with 707 additions and 8 deletions
+3
View File
@@ -83,6 +83,9 @@ class RunResultBase(ArtifactVersionPayload, GuidedResultPayload):
error: str | None
output: JsonObject | None
trace_count: int
max_steps: int
steps_executed: int
steps_remaining: int
class RunResult(RunResultBase):
+2 -1
View File
@@ -13,7 +13,7 @@ from wf_artifacts import (
WorkflowDeployment,
)
from wf_authoring import NodeSpec
from wf_core import RunState
from wf_core import RunLimits, RunState
from wf_platform import CapabilitySource
from .models import RawWorkflowPlan
@@ -61,6 +61,7 @@ class WorkflowRuntimeRunner(Protocol):
deployment: WorkflowDeployment | None = None,
artifact: WorkflowArtifact | None = None,
saved_subgraph_tree: SavedSubgraphTree | None = None,
limits: RunLimits | None = None,
) -> RunState:
"""Execute one raw workflow plan and return its run state."""
...
+22 -2
View File
@@ -25,6 +25,7 @@ from wf_core import (
RunStatus,
dump_run_state,
load_run_state,
load_run_state_with_upgrade,
)
@@ -100,10 +101,29 @@ def persist_stopped_run(
def restore_interrupted_run(
store: RunStore, run_id: str
) -> tuple[WorkflowRunRecord, RunState]:
"""Load a persisted interrupted run and its latest typed runtime state."""
record, run = load_stored_run(store, run_id)
"""Load a persisted interrupted run, persisting a v1 upgrade first.
A pre-budget (v1) checkpoint receives its one-time defaults and is
rewritten as a new v2 interrupted checkpoint under the same run id and
pinned environment *before* the run is returned, so resume dispatch
never runs on unmigrated state and a failed upgrade fails resume before
any handler runs. Ordinary inspection uses :func:`load_stored_run`,
which decodes v1 prospectively without mutating the store.
"""
record = store.get_run(run_id)
if record.status is not StoredRunStatus.INTERRUPTED:
raise ValueError(f"workflow run {run_id!r} is not interrupted")
checkpoint = store.get_latest_checkpoint(run_id)
run, upgraded = load_run_state_with_upgrade(
checkpoint.state.model_dump(mode="json")
)
if upgraded:
record = persist_stopped_run(
store=store,
environment=record.environment,
run=run,
run_id=run_id,
)
return record, run
+33 -1
View File
@@ -11,7 +11,7 @@ from wf_artifacts import (
WorkflowDeployment,
WorkflowRunRecord,
)
from wf_core import RunState
from wf_core import RunLimits, RunState
from .artifact_plans import raw_plan_from_artifact
from .deployments import WorkflowDeploymentApi, _available_sources
@@ -80,6 +80,7 @@ class WorkflowRunApi:
deployment_id: str,
workflow_input: dict[str, Any],
trace_range: TraceRangeLike | None = None,
max_steps: int | None = None,
) -> RunResult:
trace_values = _trace_range_values(trace_range)
deployment, artifact, diagnostics, tree = (
@@ -94,12 +95,16 @@ class WorkflowRunApi:
)
plan = raw_plan_from_artifact(artifact)
limits = (
RunLimits(max_steps=max_steps) if max_steps is not None else RunLimits()
)
run = await self.context.runtime.run_workflow_from_plan(
plan,
workflow_input,
deployment=deployment,
artifact=artifact,
saved_subgraph_tree=tree,
limits=limits,
)
record = persist_stopped_run(
store=self._run_store(),
@@ -121,6 +126,9 @@ class WorkflowRunApi:
error=run.error,
output=run.output,
trace_count=len(run.trace),
max_steps=run.limits.max_steps,
steps_executed=run.steps_executed,
steps_remaining=run.steps_remaining,
**_trace_slice_fields(run, trace_values),
)
@@ -176,6 +184,9 @@ class WorkflowRunApi:
output=stopped_run.output,
diagnostics=diagnostics,
trace_count=len(stopped_run.trace),
max_steps=stopped_run.limits.max_steps,
steps_executed=stopped_run.steps_executed,
steps_remaining=stopped_run.steps_remaining,
)
plan = raw_plan_from_artifact(environment.root_artifact)
tree = saved_subgraph_tree_from_snapshots(environment.child_artifacts)
@@ -205,6 +216,9 @@ class WorkflowRunApi:
error=run.error,
output=run.output,
trace_count=len(run.trace),
max_steps=run.limits.max_steps,
steps_executed=run.steps_executed,
steps_remaining=run.steps_remaining,
**_trace_slice_fields(run, trace_values),
)
@@ -261,6 +275,9 @@ class WorkflowRunApi:
output=run.output,
diagnostics=record.diagnostics,
trace_count=len(run.trace),
max_steps=run.limits.max_steps,
steps_executed=run.steps_executed,
steps_remaining=run.steps_remaining,
)
async def read_run_trace(
@@ -281,6 +298,9 @@ class WorkflowRunApi:
resume_readiness=record.resume_readiness.value,
diagnostics=record.diagnostics,
trace_count=len(run.trace),
max_steps=run.limits.max_steps,
steps_executed=run.steps_executed,
steps_remaining=run.steps_remaining,
**_trace_slice_fields(run, trace_values),
)
# A concrete trace range makes _run_payload include the four trace
@@ -366,7 +386,16 @@ def _run_payload(
trace_start: int | None = None,
trace_limit: int | None = None,
trace_truncated: bool = False,
max_steps: int | None = None,
steps_executed: int = 0,
steps_remaining: int | None = None,
) -> RunResult:
effective_max = max_steps if max_steps is not None else RunLimits().max_steps
effective_remaining = (
steps_remaining
if steps_remaining is not None
else max(effective_max - steps_executed, 0)
)
payload = {
"deployment_id": deployment.id,
"artifact_id": artifact.id,
@@ -382,6 +411,9 @@ def _run_payload(
diagnostic.model_dump(mode="json") for diagnostic in diagnostics or []
],
"trace_count": trace_count,
"max_steps": effective_max,
"steps_executed": steps_executed,
"steps_remaining": effective_remaining,
"next_actions": NextActions.from_run_result(
run_id=run_id,
status=status,
+2
View File
@@ -1048,11 +1048,13 @@ class WorkflowApi:
deployment_id: str,
workflow_input: dict[str, Any],
trace_range: TraceRangeLike | None = None,
max_steps: int | None = None,
) -> RunResult:
return await self.runs.run_deployment(
deployment_id=deployment_id,
workflow_input=workflow_input,
trace_range=trace_range,
max_steps=max_steps,
)
async def resume_run(
+1
View File
@@ -517,6 +517,7 @@ class WorkflowRunSurface(Protocol):
deployment_id: str,
workflow_input: dict[str, Any],
trace_range: TraceRangeLike | None = None,
max_steps: int | None = None,
) -> RunResult: ...
async def resume_run(
+2
View File
@@ -49,6 +49,7 @@ from .runs import (
RunCheckpoint,
RunStore,
StoredRunStatus,
VersionedCheckpointState,
WorkflowRunRecord,
ensure_run_id,
)
@@ -75,6 +76,7 @@ __all__ = [
"RunStore",
"SourceBinding",
"StoredRunStatus",
"VersionedCheckpointState",
"WorkflowArtifact",
"WorkflowArtifactCatalogEntry",
"WorkflowArtifactStore",
+2
View File
@@ -4,6 +4,7 @@ from .models import (
ResumeReadiness,
RunCheckpoint,
StoredRunStatus,
VersionedCheckpointState,
WorkflowRunRecord,
ensure_run_id,
)
@@ -17,6 +18,7 @@ __all__ = [
"RunCheckpoint",
"RunStore",
"StoredRunStatus",
"VersionedCheckpointState",
"WorkflowRunRecord",
"ensure_run_id",
]
+18 -1
View File
@@ -3,6 +3,7 @@ from __future__ import annotations
import re
from datetime import datetime
from enum import StrEnum
from typing import Any, Literal
from pydantic import BaseModel, ConfigDict, Field
@@ -72,6 +73,22 @@ class WorkflowRunRecord(BaseModel):
updated_at: datetime
class VersionedCheckpointState(BaseModel):
"""Lenient read envelope for stopped-run checkpoints.
Writes always produce version 2 via ``wf_core.dump_run_state``; reads
accept version 1 so pre-budget checkpoints reach
``load_run_state_with_upgrade`` instead of failing checkpoint validation
with a ``version == 2`` literal error first. The inner state stays an
untyped dict because core owns strict budget validation there.
"""
model_config = ConfigDict(extra="forbid")
version: Literal[1, 2] = 2
state: dict[str, Any]
class RunCheckpoint(BaseModel):
"""One stopped-state snapshot persisted at an external run boundary."""
@@ -81,5 +98,5 @@ class RunCheckpoint(BaseModel):
run_id: str = Field(pattern=RUN_ID_PATTERN)
sequence: int = Field(ge=1)
reason: CheckpointReason
state: PersistedRunState
state: PersistedRunState | VersionedCheckpointState
created_at: datetime
+7 -3
View File
@@ -6,6 +6,7 @@ from typing import Any
from wf_core.errors import WorkflowExecutionError
from wf_core.models.workflow import Workflow
from wf_core.run_state import ROOT_SCOPE_ID, RunState, RunStatus
from wf_core.runtime.limits import RunLimits
from wf_core.runtime.ops.flow import finalize_run
from wf_core.runtime.ops.merges import ReducerDefinition
from wf_core.runtime.ops.nodes import AsyncNodeHandler, NodeHandler
@@ -25,9 +26,10 @@ def execute_workflow(
*,
reducers: Mapping[str, ReducerDefinition] | None = None,
subgraphs: Mapping[str, PreparedSubgraph[NodeHandler]] | None = None,
limits: RunLimits | None = None,
) -> RunState:
"""Create a run and execute a workflow synchronously until it stops."""
run = create_run_state(workflow, workflow_input)
run = create_run_state(workflow, workflow_input, limits=limits)
try:
prepare_new_run(workflow, workflow_input, run)
@@ -52,9 +54,10 @@ async def execute_workflow_async(
reducers: Mapping[str, ReducerDefinition] | None = None,
subgraphs: Mapping[str, PreparedSubgraph[AsyncNodeHandler]] | None = None,
platform: object | None = None,
limits: RunLimits | None = None,
) -> RunState:
"""Create a run and execute a workflow asynchronously until it stops."""
run = create_run_state(workflow, workflow_input)
run = create_run_state(workflow, workflow_input, limits=limits)
try:
prepare_new_run(workflow, workflow_input, run)
@@ -80,9 +83,10 @@ async def execute_workflow_result_async(
reducers: Mapping[str, ReducerDefinition] | None = None,
subgraphs: Mapping[str, PreparedSubgraph[AsyncNodeHandler]] | None = None,
platform: object | None = None,
limits: RunLimits | None = None,
) -> RunState:
"""Execute asynchronously and return failed state instead of raising failures."""
run = create_run_state(workflow, workflow_input)
run = create_run_state(workflow, workflow_input, limits=limits)
try:
prepare_new_run(workflow, workflow_input, run)
+3
View File
@@ -15,6 +15,7 @@ from wf_artifacts import (
)
from wf_authoring import NodeSpec
from wf_core import (
RunLimits,
RunState,
Workflow,
)
@@ -343,6 +344,7 @@ class WfMcpService:
deployment: WorkflowDeployment | None = None,
artifact: WorkflowArtifact | None = None,
saved_subgraph_tree: SavedSubgraphTree | None = None,
limits: RunLimits | None = None,
):
return await self.workflow_runtime.run_workflow_from_plan(
plan,
@@ -350,6 +352,7 @@ class WfMcpService:
deployment=deployment,
artifact=artifact,
saved_subgraph_tree=saved_subgraph_tree,
limits=limits,
)
async def resume_workflow_from_plan(
@@ -13,6 +13,7 @@ from wf_api.operation_context import (
)
from wf_artifacts import DependencyDiagnostic, WorkflowArtifact, WorkflowDeployment
from wf_authoring import NodeSpec
from wf_core import RunLimits
from .core import WfMcpService
from .events import BrokerEventRecorder
@@ -70,6 +71,7 @@ class WfMcpWorkflowRuntimeRunner(WorkflowRuntimeRunner):
deployment=None,
artifact=None,
saved_subgraph_tree=None,
limits: RunLimits | None = None,
):
return await self.runtime.run_workflow_from_plan(
plan,
@@ -77,6 +79,7 @@ class WfMcpWorkflowRuntimeRunner(WorkflowRuntimeRunner):
deployment=deployment,
artifact=artifact,
saved_subgraph_tree=saved_subgraph_tree,
limits=limits,
)
async def resume_workflow_from_plan(
@@ -16,6 +16,7 @@ from wf_artifacts import WorkflowArtifact, WorkflowArtifactStore, WorkflowDeploy
from wf_authoring import NodeSpec
from wf_core import (
NodeUse,
RunLimits,
RunState,
RunStatus,
Workflow,
@@ -163,6 +164,7 @@ class WorkflowRuntimeService:
deployment: WorkflowDeployment | None = None,
artifact: WorkflowArtifact | None = None,
saved_subgraph_tree: SavedSubgraphTree | None = None,
limits: RunLimits | None = None,
) -> RunState:
self.emit_event(
make_event(
@@ -186,6 +188,7 @@ class WorkflowRuntimeService:
reducers=reducers,
subgraphs=prepared_subgraphs,
platform=platform_context,
limits=limits,
)
self.emit_event(
make_event(
+3
View File
@@ -33,6 +33,7 @@ from wf_artifacts import WorkflowArtifact, WorkflowDeployment
from wf_authoring import NodeSpec
from wf_core import (
NodeUse,
RunLimits,
RunState,
Workflow,
execute_workflow_result_async,
@@ -224,6 +225,7 @@ class LocalWorkflowRuntimeRunner(WorkflowRuntimeRunner):
deployment: WorkflowDeployment | None = None,
artifact: WorkflowArtifact | None = None,
saved_subgraph_tree: SavedSubgraphTree | None = None,
limits: RunLimits | None = None,
) -> RunState:
workflow, registry, reducers, prepared_subgraphs, platform_context = (
self.prepare_workflow_runtime(
@@ -240,6 +242,7 @@ class LocalWorkflowRuntimeRunner(WorkflowRuntimeRunner):
reducers=reducers,
subgraphs=prepared_subgraphs,
platform=platform_context,
limits=limits,
)
async def resume_workflow_from_plan(