π« Toolkit to help you get started with SDD or any other process!
fix: while/do-while loop condition reads stale iteration-0 step output (#2662)
Manfred Riem616eba6a5715
diff --git a/src/specify_cli/workflows/engine.py b/src/specify_cli/workflows/engine.pyindex 934cfbe5e..65d9b3a27 100644--- a/src/specify_cli/workflows/engine.py+++ b/src/specify_cli/workflows/engine.py@@ -673,22 +673,29 @@ class WorkflowEngine:if not evaluate_condition(condition, context):break# Namespace nested step IDs per iteration- iter_steps = []- for ns in result.next_steps:+ # so logs and state keys are unique.+ # Execute one step at a time and alias each+ # result back to the unprefixed key so that+ # later steps in the same body and the loop+ # condition see the latest values.+ for ns_idx, ns in enumerate(result.next_steps):ns_copy = dict(ns)- if "id" in ns_copy:- ns_copy["id"] = f"{step_id}:{ns_copy['id']}:{_loop_iter + 1}"- iter_steps.append(ns_copy)- self._execute_steps(- iter_steps, context, state, registry,- step_offset=-1,- )- if state.status in (- RunStatus.PAUSED,- RunStatus.FAILED,- RunStatus.ABORTED,- ):- return+ orig = ns_copy.get("id")+ base_id = orig or f"step-{ns_idx}"+ ns_copy["id"] = f"{step_id}:{base_id}:{_loop_iter + 1}"+ self._execute_steps(+ [ns_copy], context, state, registry,+ step_offset=-1,+ )+ if state.status in (+ RunStatus.PAUSED,+ RunStatus.FAILED,+ RunStatus.ABORTED,+ ):+ return+ if orig and ns_copy["id"] in context.steps:+ context.steps[orig] = context.steps[ns_copy["id"]]+ state.step_results[orig] = context.steps[ns_copy["id"]]# Fan-out: execute nested step template per item with unique IDsif step_type == "fan-out":diff --git a/tests/test_workflows.py b/tests/test_workflows.pyindex 3fa71f340..f340e9c0d 100644--- a/tests/test_workflows.py+++ b/tests/test_workflows.py@@ -1889,6 +1889,268 @@ steps:errors = validate_workflow(definition)assert any("invalid default" in e for e in errors), errors+ def test_while_loop_condition_reads_latest_iteration(self, project_dir):+ """Regression: while-loop condition must see updated step output+ from the most recent iteration, not stale iteration-0 data.++ See https://github.com/github/spec-kit/issues/2592+ """+ from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition+ from specify_cli.workflows.base import RunStatus++ # Shell step echoes a counter via a file.+ # Condition: exit_code != 0 means "keep looping" β but a non-zero+ # exit code would mark the step FAILED and abort the run, so we+ # use stdout-based comparison instead.+ #+ # Iteration 0: counter=1, echoes "1" β not "done" β loop continues+ # Iteration 1: counter=2, echoes "done" β condition false β stop+ # Without the fix, condition always reads iteration-0 stdout,+ # so the loop runs all max_iterations.+ import sys++ counter_file = project_dir / ".counter"+ counter_file.write_text("0", encoding="utf-8")+ py = sys.executable+ script_file = project_dir / "_tick.py"+ script_file.write_text(+ f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"+ "n = int(p.read_text()) + 1; p.write_text(str(n))\n"+ "print('done' if n >= 2 else str(n), end='')\n",+ encoding="utf-8",+ )++ yaml_str = f"""+schema_version: "1.0"+workflow:+ id: "while-condition-update"+ name: "While Condition Update"+ version: "1.0.0"+steps:+ - id: retry-loop+ type: while+ condition: "{{{{ 'done' not in steps.attempt.output.stdout }}}}"+ max_iterations: 5+ steps:+ - id: attempt+ type: shell+ run: '"{py}" "{script_file}"'+"""+ definition = WorkflowDefinition.from_string(yaml_str)+ engine = WorkflowEngine(project_dir)+ state = engine.execute(definition)++ assert state.status == RunStatus.COMPLETED+ # The unprefixed key should reflect the latest iteration's result.+ assert state.step_results["attempt"]["output"]["stdout"] == "done"+ # Namespaced iteration-1 result should also exist.+ assert "retry-loop:attempt:1" in state.step_results+ # Counter should be 2 (iteration 0 + iteration 1), not 5.+ assert counter_file.read_text(encoding="utf-8").strip() == "2"++ def test_do_while_loop_condition_reads_latest_iteration(self, project_dir):+ """Regression: do-while loop condition must also see updated output.++ See https://github.com/github/spec-kit/issues/2592+ """+ from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition+ from specify_cli.workflows.base import RunStatus++ import sys++ counter_file = project_dir / ".counter"+ counter_file.write_text("0", encoding="utf-8")+ py = sys.executable+ script_file = project_dir / "_tick.py"+ script_file.write_text(+ f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"+ "n = int(p.read_text()) + 1; p.write_text(str(n))\n"+ "print('done' if n >= 2 else str(n), end='')\n",+ encoding="utf-8",+ )++ yaml_str = f"""+schema_version: "1.0"+workflow:+ id: "do-while-condition-update"+ name: "Do While Condition Update"+ version: "1.0.0"+steps:+ - id: retry-loop+ type: do-while+ condition: "{{{{ 'done' not in steps.attempt.output.stdout }}}}"+ max_iterations: 5+ steps:+ - id: attempt+ type: shell+ run: '"{py}" "{script_file}"'+"""+ definition = WorkflowDefinition.from_string(yaml_str)+ engine = WorkflowEngine(project_dir)+ state = engine.execute(definition)++ assert state.status == RunStatus.COMPLETED+ assert state.step_results["attempt"]["output"]["stdout"] == "done"+ assert counter_file.read_text(encoding="utf-8").strip() == "2"++ def test_while_loop_runs_to_max_when_condition_stays_true(self, project_dir):+ """While loop must still run to max_iterations when the condition+ never becomes false β copy-back must not break this path.++ See https://github.com/github/spec-kit/issues/2592+ """+ from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition+ from specify_cli.workflows.base import RunStatus++ import sys++ counter_file = project_dir / ".counter"+ counter_file.write_text("0", encoding="utf-8")+ py = sys.executable+ script_file = project_dir / "_tick.py"+ script_file.write_text(+ f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"+ "n = int(p.read_text()) + 1; p.write_text(str(n))\n"+ "print('pending', end='')\n",+ encoding="utf-8",+ )++ yaml_str = f"""+schema_version: "1.0"+workflow:+ id: "while-max-iterations"+ name: "While Max Iterations"+ version: "1.0.0"+steps:+ - id: retry-loop+ type: while+ condition: "{{{{ 'done' not in steps.tick.output.stdout }}}}"+ max_iterations: 3+ steps:+ - id: tick+ type: shell+ run: '"{py}" "{script_file}"'+"""+ definition = WorkflowDefinition.from_string(yaml_str)+ engine = WorkflowEngine(project_dir)+ state = engine.execute(definition)++ assert state.status == RunStatus.COMPLETED+ # All 3 iterations ran (iteration 0 + 2 loop iterations).+ assert counter_file.read_text(encoding="utf-8").strip() == "3"+ # Unprefixed key holds the last iteration's result.+ assert state.step_results["tick"]["output"]["stdout"] == "pending"+ # Namespaced keys for loop iterations exist.+ assert "retry-loop:tick:1" in state.step_results+ assert "retry-loop:tick:2" in state.step_results++ def test_do_while_loop_runs_to_max_when_condition_stays_true(self, project_dir):+ """Do-while loop must still run to max_iterations when the condition+ never becomes false.++ See https://github.com/github/spec-kit/issues/2592+ """+ from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition+ from specify_cli.workflows.base import RunStatus++ import sys++ counter_file = project_dir / ".counter"+ counter_file.write_text("0", encoding="utf-8")+ py = sys.executable+ script_file = project_dir / "_tick.py"+ script_file.write_text(+ f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"+ "n = int(p.read_text()) + 1; p.write_text(str(n))\n"+ "print('pending', end='')\n",+ encoding="utf-8",+ )++ yaml_str = f"""+schema_version: "1.0"+workflow:+ id: "do-while-max-iterations"+ name: "Do While Max Iterations"+ version: "1.0.0"+steps:+ - id: retry-loop+ type: do-while+ condition: "{{{{ 'done' not in steps.tick.output.stdout }}}}"+ max_iterations: 3+ steps:+ - id: tick+ type: shell+ run: '"{py}" "{script_file}"'+"""+ definition = WorkflowDefinition.from_string(yaml_str)+ engine = WorkflowEngine(project_dir)+ state = engine.execute(definition)++ assert state.status == RunStatus.COMPLETED+ assert counter_file.read_text(encoding="utf-8").strip() == "3"+ assert state.step_results["tick"]["output"]["stdout"] == "pending"++ def test_while_loop_multi_step_body_inter_step_refs(self, project_dir):+ """Multi-step loop body: step B must see step A's output from the+ current iteration, not a stale previous one.++ See https://github.com/github/spec-kit/issues/2592+ """+ from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition+ from specify_cli.workflows.base import RunStatus++ import sys++ counter_file = project_dir / ".counter"+ counter_file.write_text("0", encoding="utf-8")+ py = sys.executable++ # Step A: increments counter file, echoes the value.+ step_a_file = project_dir / "_step_a.py"+ step_a_file.write_text(+ f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"+ "n = int(p.read_text()) + 1; p.write_text(str(n))\n"+ "print(str(n), end='')\n",+ encoding="utf-8",+ )++ # Step B uses {{ steps.step-a.output.stdout }} expression+ # substitution in its run command so the engine resolves the+ # aliased unprefixed key β this is the real inter-step test.+ yaml_str = f"""+schema_version: "1.0"+workflow:+ id: "while-multi-step"+ name: "While Multi Step"+ version: "1.0.0"+steps:+ - id: retry-loop+ type: while+ condition: "{{{{ 'done' not in steps.step-a.output.stdout }}}}"+ max_iterations: 3+ steps:+ - id: step-a+ type: shell+ run: '"{py}" "{step_a_file}"'+ - id: step-b+ type: shell+ run: "echo b-saw-{{{{ steps.step-a.output.stdout }}}}"+"""+ definition = WorkflowDefinition.from_string(yaml_str)+ engine = WorkflowEngine(project_dir)+ state = engine.execute(definition)++ assert state.status == RunStatus.COMPLETED+ # Both unprefixed keys reflect the latest iteration's results.+ assert state.step_results["step-a"]["output"]["stdout"] == "3"+ # Step B saw step A's output via expression substitution.+ assert "b-saw-3" in state.step_results["step-b"]["output"]["stdout"]+ # Namespaced keys exist for loop iterations.+ assert "retry-loop:step-a:1" in state.step_results+ assert "retry-loop:step-b:1" in state.step_results+ assert "retry-loop:step-a:2" in state.step_results+ assert "retry-loop:step-b:2" in state.step_results+# ===== State Persistence Tests =====