Skip to content

💫 Toolkit to help you get started with SDD or any other process!

fix(workflows): validate persisted step result shapes (#4399)

WOLIKIMCHENGc2a0a0cd2ab5
diff --git a/src/specify_cli/workflows/engine.py b/src/specify_cli/workflows/engine.py
index f6d5a2a66..d81aae321 100644
--- a/src/specify_cli/workflows/engine.py
+++ b/src/specify_cli/workflows/engine.py
@@ -849,6 +849,18 @@ class RunState:
installed_workflow_id = state_data.get("installed_workflow_id")
installed_registry_root = state_data.get("installed_registry_root")
+ step_results = state_data.get("step_results", {})
+ if not isinstance(step_results, dict):
+ raise ValueError(
+ "Invalid run state: 'step_results' must be a JSON object"
+ )
+ for step_id, result in step_results.items():
+ if not isinstance(result, dict):
+ raise ValueError(
+ "Invalid run state: step_results record "
+ f"{step_id!r} must be a JSON object"
+ )
+
state = cls(
run_id=state_data["run_id"],
workflow_id=workflow_id,
@@ -875,7 +887,7 @@ class RunState:
)
state.current_step_index = current_step_index
state.current_step_id = state_data.get("current_step_id")
- state.step_results = state_data.get("step_results", {})
+ state.step_results = step_results
state.workflow_dir = state_data.get("workflow_dir")
state.created_at = state_data.get("created_at", "")
state.updated_at = state_data.get("updated_at", "")
diff --git a/tests/test_workflows.py b/tests/test_workflows.py
index 6c7545f21..771e34afb 100644
--- a/tests/test_workflows.py
+++ b/tests/test_workflows.py
@@ -7681,7 +7681,70 @@ class TestRunState:
assert loaded.workflow_id == "test-workflow"
assert loaded.status == RunStatus.RUNNING
assert loaded.inputs == {"name": "login"}
- assert "step-one" in loaded.step_results
+ assert loaded.step_results == state.step_results
+
+ @pytest.mark.parametrize("invalid_step_results", [None, [], "invalid", 1, True])
+ def test_load_rejects_non_object_step_results(
+ self, project_dir, invalid_step_results
+ ):
+ """Persisted step results must be a JSON object."""
+ from specify_cli.workflows.engine import RunState
+
+ state = RunState(
+ run_id="invalid-results",
+ workflow_id="test-workflow",
+ project_root=project_dir,
+ )
+ state.save()
+ state_path = state.runs_dir / "state.json"
+ state_data = json.loads(state_path.read_text(encoding="utf-8"))
+ state_data["step_results"] = invalid_step_results
+ state_path.write_text(json.dumps(state_data), encoding="utf-8")
+
+ with pytest.raises(ValueError, match="step_results.*JSON object"):
+ RunState.load("invalid-results", project_dir)
+
+ @pytest.mark.parametrize("invalid_result", [None, [], "invalid", 1, True])
+ def test_load_rejects_non_object_step_result_records(
+ self, project_dir, invalid_result
+ ):
+ """Each persisted step result must be a JSON object."""
+ from specify_cli.workflows.engine import RunState
+
+ state = RunState(
+ run_id="invalid-record",
+ workflow_id="test-workflow",
+ project_root=project_dir,
+ )
+ state.save()
+ state_path = state.runs_dir / "state.json"
+ state_data = json.loads(state_path.read_text(encoding="utf-8"))
+ state_data["step_results"] = {"step-one": invalid_result}
+ state_path.write_text(json.dumps(state_data), encoding="utf-8")
+
+ with pytest.raises(
+ ValueError,
+ match="step_results record 'step-one' must be a JSON object",
+ ):
+ RunState.load("invalid-record", project_dir)
+
+ def test_load_defaults_missing_step_results_for_legacy_state(self, project_dir):
+ """Legacy states without step results load with an empty mapping."""
+ from specify_cli.workflows.engine import RunState
+
+ state = RunState(
+ run_id="legacy-results",
+ workflow_id="test-workflow",
+ project_root=project_dir,
+ )
+ state.save()
+ state_path = state.runs_dir / "state.json"
+ state_data = json.loads(state_path.read_text(encoding="utf-8"))
+ state_data.pop("step_results")
+ state_path.write_text(json.dumps(state_data), encoding="utf-8")
+
+ loaded = RunState.load("legacy-results", project_dir)
+ assert loaded.step_results == {}
def test_load_not_found(self, project_dir):
from specify_cli.workflows.engine import RunState