fix(r5): address the third /code-review high round — 7 findings
- the sweep guard anchors the rating_key to digits: the round-2 widening had degenerated to "anything ending in _<digits>" (backup_2024, release_10) - RSS counts apply-side failures too, so a read-only database no longer reports a wholly failed poll as "ok — new=0, failed=0" - the player reads/writes its volume directly (readAccount/writeAccount): the persisted-object hook rendered nothing and cost a second write per settle - new tests: the sweep guard's accept/reject table, and run_ffmpeg's threading (drain, cancel while silent, stall watchdog, stderr tail on a nonzero exit) - the breaker sentinel is checked one way (isinstance) at all four sites - run_rss_poll is typed dict[str, int] All three new test groups were mutation-checked: reverting each fix turns them red (or, for the cancel/stall pair, hangs — which is the bug itself).
This commit is contained in:
@@ -0,0 +1,133 @@
|
||||
"""run_ffmpeg's process plumbing — the part that can hang a worker thread forever.
|
||||
|
||||
No ffmpeg here: a fake Popen stands in, so the reader threads, the 1s poll loop, the stall watchdog
|
||||
and the bounded exit wait are all exercised on any machine. These are regression tests for a real
|
||||
deadlock: stderr was opened and never read, so a chatty ffmpeg filled the ~64KB pipe, blocked on its
|
||||
next write and never exited, and `proc.wait()` never returned."""
|
||||
import time
|
||||
|
||||
import pytest
|
||||
|
||||
from app.downloads import edit
|
||||
|
||||
|
||||
class _FakeStream:
|
||||
"""A pipe. `block=True` = the process is alive but silent (a wedged ffmpeg): iteration parks
|
||||
until the stream is closed, which is what terminate()/kill() does to a real pipe."""
|
||||
|
||||
def __init__(self, lines=(), block=False):
|
||||
self._lines = list(lines)
|
||||
self._block = block
|
||||
self.closed = False
|
||||
self.consumed = 0
|
||||
|
||||
def __iter__(self):
|
||||
return self
|
||||
|
||||
def __next__(self):
|
||||
if self._lines:
|
||||
self.consumed += 1
|
||||
return self._lines.pop(0)
|
||||
while self._block and not self.closed:
|
||||
time.sleep(0.02)
|
||||
raise StopIteration
|
||||
|
||||
def close(self):
|
||||
self.closed = True
|
||||
|
||||
|
||||
class _FakeProc:
|
||||
pid = 4242
|
||||
|
||||
def __init__(self, stdout, stderr, returncode=0):
|
||||
self.stdout = stdout
|
||||
self.stderr = stderr
|
||||
self._rc = returncode
|
||||
self.terminated = False
|
||||
self.killed = False
|
||||
|
||||
def terminate(self):
|
||||
self.terminated = True
|
||||
# A terminated process's pipes hit EOF — that is how the reader threads finish.
|
||||
self.stdout.close()
|
||||
self.stderr.close()
|
||||
|
||||
def kill(self):
|
||||
self.killed = True
|
||||
self.terminate()
|
||||
|
||||
def wait(self, timeout=None):
|
||||
return self._rc
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def fake_popen(monkeypatch):
|
||||
"""Install a fake Popen and hand the test the process it will produce."""
|
||||
|
||||
def install(proc):
|
||||
monkeypatch.setattr(edit.subprocess, "Popen", lambda *a, **k: proc)
|
||||
return proc
|
||||
|
||||
return install
|
||||
|
||||
|
||||
def test_progress_is_reported_and_a_clean_exit_returns(fake_popen):
|
||||
proc = fake_popen(
|
||||
_FakeProc(_FakeStream(["out_time_us=5000000\n", "progress=continue\n"]), _FakeStream())
|
||||
)
|
||||
seen = []
|
||||
edit.run_ffmpeg(["ffmpeg"], total_s=10, on_progress=seen.append, should_cancel=lambda: False)
|
||||
assert seen == [50.0] # 5s of 10s
|
||||
assert not proc.terminated
|
||||
|
||||
|
||||
def test_progress_is_capped_below_100(fake_popen):
|
||||
fake_popen(_FakeProc(_FakeStream(["out_time_us=99000000\n"]), _FakeStream()))
|
||||
seen = []
|
||||
edit.run_ffmpeg(["ffmpeg"], total_s=10, on_progress=seen.append, should_cancel=lambda: False)
|
||||
assert seen == [99.0] # never reports done before the process actually exits
|
||||
|
||||
|
||||
def test_a_nonzero_exit_raises_with_the_stderr_tail(fake_popen):
|
||||
# The tail must come from the drained stderr — reading the pipe only AFTER the exit was the
|
||||
# original deadlock.
|
||||
proc = fake_popen(
|
||||
_FakeProc(_FakeStream([]), _FakeStream(["Invalid data found\n"]), returncode=2)
|
||||
)
|
||||
with pytest.raises(RuntimeError, match="Invalid data found"):
|
||||
edit.run_ffmpeg(["ffmpeg"], total_s=10, on_progress=lambda _p: None, should_cancel=lambda: False)
|
||||
assert proc._rc == 2
|
||||
|
||||
|
||||
def test_cancel_is_honoured_while_the_process_is_silent(fake_popen):
|
||||
# The pre-fix loop only checked cancel when a progress line arrived, so a quiet ffmpeg was
|
||||
# uncancellable. The 1s poll tick is what makes this terminate.
|
||||
proc = fake_popen(_FakeProc(_FakeStream(block=True), _FakeStream(block=True)))
|
||||
started = time.monotonic()
|
||||
with pytest.raises(edit.EditAborted):
|
||||
edit.run_ffmpeg(["ffmpeg"], total_s=10, on_progress=lambda _p: None, should_cancel=lambda: True)
|
||||
assert proc.terminated
|
||||
assert time.monotonic() - started < 5 # not "whenever ffmpeg next speaks"
|
||||
|
||||
|
||||
def test_a_wedged_process_is_killed_by_the_stall_watchdog(fake_popen):
|
||||
proc = fake_popen(_FakeProc(_FakeStream(block=True), _FakeStream(block=True)))
|
||||
with pytest.raises(RuntimeError, match="stalled"):
|
||||
edit.run_ffmpeg(
|
||||
["ffmpeg"],
|
||||
total_s=10,
|
||||
on_progress=lambda _p: None,
|
||||
should_cancel=lambda: False,
|
||||
stall_timeout_s=0.5,
|
||||
)
|
||||
assert proc.terminated # the worker thread is freed, not parked forever
|
||||
|
||||
|
||||
def test_stderr_is_drained_while_the_process_runs(fake_popen):
|
||||
# The deadlock case: a chatty ffmpeg that exits 0. EVERY stderr line must be consumed — with a
|
||||
# real pipe, an unread one fills at ~64KB and blocks ffmpeg's next write forever.
|
||||
err = _FakeStream([f"warning {i}\n" for i in range(500)])
|
||||
fake_popen(_FakeProc(_FakeStream(["out_time_us=1000000\n"]), err))
|
||||
edit.run_ffmpeg(["ffmpeg"], total_s=10, on_progress=lambda _p: None, should_cancel=lambda: False)
|
||||
assert err.consumed == 500
|
||||
assert err.closed
|
||||
Reference in New Issue
Block a user