Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

fix(workflows): fail fan-in step on non-list wait_for instead of crashing (#3482)

Noor ul aina965413a24f1
diff --git a/src/specify_cli/workflows/steps/fan_in/__init__.py b/src/specify_cli/workflows/steps/fan_in/__init__.py
index 7b82df50b..1e466e5fa 100644
--- a/src/specify_cli/workflows/steps/fan_in/__init__.py
+++ b/src/specify_cli/workflows/steps/fan_in/__init__.py
@@ -24,6 +24,24 @@ class FanInStep(StepBase):
if not isinstance(output_config, dict):
output_config = {}
+ # The engine does not auto-validate step config, so an unvalidated run
+ # with a non-list ``wait_for`` reaches here raw. Iterating it then
+ # either crashes the whole run (a scalar like an int or None raises
+ # TypeError) or, worse, silently iterates a string's characters and
+ # yields a bogus join of empty results with a COMPLETED status β€” the
+ # exact "silent empty result + COMPLETED" wiring bug the engine's
+ # fan-in validation guards against. Fail this step loudly instead,
+ # mirroring the fan-out step's non-list ``items`` handling.
+ if not isinstance(wait_for, list):
+ return StepResult(
+ status=StepStatus.FAILED,
+ error=(
+ f"Fan-in step {config.get('id', '?')!r}: 'wait_for' must be "
+ f"a list of step IDs, got {type(wait_for).__name__}."
+ ),
+ output={"results": []},
+ )
+
# Collect results from referenced steps
results = []
for step_id in wait_for:
diff --git a/tests/test_workflows.py b/tests/test_workflows.py
index 4ec99f399..dcd7d19b8 100644
--- a/tests/test_workflows.py
+++ b/tests/test_workflows.py
@@ -2475,6 +2475,29 @@ class TestFanInStep:
result = step.execute(config, ctx)
assert result.output["results"] == [{}]
+ @pytest.mark.parametrize("bad_wait_for", ["stepA", 5, None, {"a": 1}])
+ def test_execute_non_list_wait_for_fails_loudly(self, bad_wait_for):
+ """A non-list ``wait_for`` must fail the step, not crash the run or
+ silently produce a bogus join.
+
+ ``validate`` rejects a non-list ``wait_for``, but the engine's
+ ``execute()`` does not auto-validate. Before the guard, ``execute``
+ iterated the raw value: a scalar (int/None) raised TypeError and took
+ down the whole run, while a string silently iterated its characters and
+ returned a join of empty results with a COMPLETED status β€” the exact
+ "silent empty result + COMPLETED" wiring bug the engine's fan-in
+ validation warns against. Mirrors the fan-out non-list ``items`` guard.
+ """
+ from specify_cli.workflows.steps.fan_in import FanInStep
+ from specify_cli.workflows.base import StepContext, StepStatus
+
+ step = FanInStep()
+ ctx = StepContext(steps={"a": {"output": {"x": 1}}})
+ result = step.execute({"id": "collect", "wait_for": bad_wait_for}, ctx)
+ assert result.status == StepStatus.FAILED
+ assert "'wait_for' must be a list" in (result.error or "")
+ assert result.output["results"] == []
+
def test_validate_empty_wait_for(self):
from specify_cli.workflows.steps.fan_in import FanInStep