Python
fix(shell): a PowerShell parse error is exit code 1, not 0
Devika Vermadf69eb9997c9
diff --git a/coworker/sandbox/runner/executor.py b/coworker/sandbox/runner/executor.pyindex 94e5bdab..e6e2cb96 100644--- a/coworker/sandbox/runner/executor.py+++ b/coworker/sandbox/runner/executor.py@@ -25,6 +25,7 @@ when they exit or via `shell_task_kill`.from __future__ import annotations+import base64import osimport queueimport signal@@ -184,6 +185,8 @@ class LocalExecutor(Executor):self.default_timeout = default_timeoutself.max_output_chars = max_output_charsself._marker = f"__COWORKER_DONE_{uuid.uuid4().hex}__"+ # Ends the PowerShell parse check's answer (Windows only; see run()).+ self._parse_marker = f"__COWORKER_PARSED_{uuid.uuid4().hex}__"self._is_windows = _IS_WINDOWSself._bg_tasks: dict[str, _BackgroundTask] = {}self._bg_counter = 0@@ -282,12 +285,22 @@ class LocalExecutor(Executor):timeout = timeout or self.default_timeoutself._abort.clear()+ deadline = time.monotonic() + timeout++ if self._is_windows:+ # PowerShell's `-Command -` REPL skips a line it cannot parse, so the trailer's+ # `$?` still holds the previous (successful) trailer and the result said exit 0.+ # An unclosed quote was worse: it swallowed the trailer and hung to the timeout.+ # So parse first, with PowerShell's own parser; on errors nothing runs.+ checked = self._powershell_parse_check(command, deadline)+ if checked is not None:+ return checked+# Run the command, then emit a marker line with exit code + cwd.self._proc.stdin.write(command + "\n")self._proc.stdin.write(self._trailer())self._proc.stdin.flush()- deadline = time.monotonic() + timeoutinterrupted = Falsetimed_out = Falseaborted = False@@ -356,6 +369,60 @@ class LocalExecutor(Executor):error="interrupted by user" if aborted else None,)+ def _powershell_parse_check(+ self, command: str, deadline: float+ ) -> Optional[dict[str, Any]]:+ """Parse `command` in the running PowerShell before it is sent. Returns None when it+ parses (the caller runs it), else the finished result: exit code 1 and PowerShell's+ own error text, the same text and code `powershell -Command` gives. The command+ travels as base64, so no quoting in it can break the check line; the check's+ variables are removed again so the session never sees them."""+ assert self._proc.stdin is not None+ encoded = base64.b64encode(command.encode("utf-8")).decode("ascii")+ self._proc.stdin.write(+ "$__cwSrc=[Text.Encoding]::UTF8.GetString([Convert]::FromBase64String("+ f"'{encoded}'));$__cwErr=$null;"+ "$null=[Management.Automation.Language.Parser]::ParseInput("+ "$__cwSrc,[ref]$null,[ref]$__cwErr);$__cwN=@($__cwErr).Count;"+ "if($__cwN){(New-Object Management.Automation.ParseException (,$__cwErr)).Message};"+ "Remove-Variable __cwSrc,__cwErr -ErrorAction Ignore;"+ f'"`n{self._parse_marker} $__cwN";Remove-Variable __cwN -ErrorAction Ignore\n'+ )+ self._proc.stdin.flush()++ lines: list[str] = []+ while True:+ aborted = self._abort.is_set()+ remaining = deadline - time.monotonic()+ if aborted or remaining <= 0:+ # Same as a command that overran on Windows: kill the shell, the next+ # run() respawns it in the last cwd.+ self.close()+ return self._result(+ command,+ None,+ "",+ timed_out=not aborted,+ error="interrupted by user" if aborted else None,+ )+ try:+ item = self._queue.get(timeout=min(remaining, 0.5))+ except queue.Empty:+ continue+ if item is None:+ return self._result(+ command, None, "".join(lines), timed_out=False, error="shell exited"+ )+ if self._parse_marker in item:+ count = _parse_exit_code(item, self._parse_marker)+ break+ lines.append(item)+ if not count:+ return None+ # A parse error is the command failing, not the tool: like bash's syntax error,+ # it is a non-zero exit code with the shell's message as the output.+ return self._result(command, 1, "".join(lines).strip("\n") + "\n", timed_out=False)+def interrupt_now(self) -> None:"""User Stop: make an in-flight foreground `run()` bail on its next read tick(≤0.5s). Thread-safe; a no-op when nothing is running. Background tasks arediff --git a/tests/test_shell.py b/tests/test_shell.pyindex ab71b79a..7f0b3ec4 100644--- a/tests/test_shell.py+++ b/tests/test_shell.py@@ -112,6 +112,43 @@ def test_exit_code_captured(executor):assert executor.run(EXIT_FAIL)["exit_code"] == 1[email protected](not _WIN, reason="PowerShell's REPL skips a line it cannot parse")+ "command, message",+ [+ # Round-2 F-8: `@notes.txt` (curl's upload syntax) is splatting to PowerShell.+ ("Write-Output @notes.txt", "splatting operator"),+ ("if (1 {", "Missing closing"),+ # An unclosed quote used to swallow the trailer and hang until the timeout.+ ("Write-Output 'unclosed", "missing the terminator"),+ ],+)+def test_powershell_parse_error_is_a_failure(executor, command, message):+ start = time.monotonic()+ result = executor.run("Write-Output before") # a success first: `$?` was left true+ assert result["exit_code"] == 0+ result = executor.run(command)+ assert result["exit_code"] == 1+ assert result["timed_out"] is False+ assert message in result["output"]+ assert "At line:1 char:" in result["output"]+ assert time.monotonic() - start < 8.0+ # Nothing of the check is left in the session, and the shell carries on.+ after = executor.run("Get-Variable __cw* -ErrorAction SilentlyContinue | Measure-Object | % Count")+ assert after["exit_code"] == 0+ assert after["output"].strip() == "0"++[email protected](not _WIN, reason="PowerShell parse check")+def test_powershell_parse_check_leaves_valid_commands_alone(executor, tmp_path):+ # Quotes and `$` travel through the check unchanged; state persists.+ result = executor.run("$cwValue = \"it's $(1+1) ok\"; Write-Output $cwValue")+ assert result["exit_code"] == 0+ assert "it's 2 ok" in result["output"]+ assert "it's 2 ok" in executor.run("Write-Output $cwValue")["output"]+ assert executor.run("cmd /c exit 3")["exit_code"] == 3++def test_timeout_kills_command(executor):start = time.monotonic()result = executor.run(SLEEP_5, timeout=1)