mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-18 04:49:13 +00:00
fix(scroll,cache): resolve CodeRabbit review on #523
Eight findings, all reproduced before fixing.
scroll_config.configure() read the refresh rate *after* resolve() had
already used it. resolve() fills in target_fps, pixels_per_frame and the
judder warning from that rate, so on a 60Hz panel every one of them
described 100Hz -- and with snap_to_crisp=False nothing downstream
corrected it, so set_target_fps() paced the helper to 100 FPS. The rate
is now settled first, and falls back to the global config rather than
straight to the default.
refresh_hz_from_config() used `(cfg.get("display") or {}).get(...)`,
which raises AttributeError when either level is truthy but not a
mapping -- out of a function whose whole contract is a rate or a default.
The frame-stats line reported the upper-middle sample as the median and
the 96th sorted sample as p95 of 100. Both are also thresholds (stalls
at 1.5x the median, skips at 0.5x), so the counts were biased too. The
arithmetic is now in frame_stats()/format_frame_stats(), testable
without a clock.
configure()'s docstring and docs/SCROLL_PERFORMANCE.md still said it
applies the frame hold and warns when it cannot. It deliberately does
neither since "tie the frame hold to the scroll, not the plugin"; a
caller following the old text would omit set_scrolling_state() and slow
snapped speeds would still present every refresh.
disk_cache had no policy for non-finite floats: orjson writes null,
the stdlib writes NaN/Infinity, and orjson then rejects those legacy
files so DiskCache.get deleted them as corrupt. One behaviour on both
paths now -- write null, keep legacy records readable. allow_nan=False
detects the values; the replacement walk runs only when there is one,
so the ordinary write path is byte-identical and pays nothing.
build_rgbmatrix_nogil.sh picked the build artifact with a glob piped to
`head -1`, which sorts cpython-311 ahead of cpython-313, so a stale .so
staged in from the source tree was installed as core.so while the GIL
check -- which reads the generated core.cpp, not the .so -- still passed.
It now requires the current interpreter's exact ABI name and fails
closed. Its systemctl calls were also unchecked under `set -uo pipefail`:
a failed stop left the old service running, the following start
succeeded as a no-op, and the health check reported SUCCESS for a
binding that was never loaded.
orjson floor raised to 3.11.6 for CVE-2025-67221 (unbounded recursion
in dumps); it covers the project's Python 3.10-3.13 range.
Adds test/test_cache_nonfinite_floats.py (14) plus regression tests in
test_scroll_config.py and test_scroll_helper.py. 9 of the cache tests
and 9 of the scroll_config tests fail against the pre-fix code.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014RRtqXDCnvnY6EQwhT5CV9
This commit is contained in:
co-authored by
Claude Opus 5
parent
2622c15265
commit
571cc6fdac
@@ -11,7 +11,11 @@ import time
|
||||
from unittest.mock import patch
|
||||
from PIL import Image
|
||||
|
||||
from src.common.scroll_helper import ScrollHelper
|
||||
from src.common.scroll_helper import (
|
||||
ScrollHelper,
|
||||
format_frame_stats,
|
||||
frame_stats,
|
||||
)
|
||||
|
||||
|
||||
DISPLAY_W = 64
|
||||
@@ -315,3 +319,77 @@ class TestGetScrollInfo:
|
||||
helper.scroll_position = 42.0
|
||||
info = helper.get_scroll_info()
|
||||
assert info["scroll_position"] == 42.0
|
||||
|
||||
|
||||
class TestFrameStatsPercentiles:
|
||||
"""The stats line is the instrument this whole scroll change is measured
|
||||
with, so its median and p95 have to be the real ones.
|
||||
|
||||
Both are also thresholds: stalls are counted at 1.5x the median and skips
|
||||
at 0.5x, so an off-by-one in the median biases the counts as well as the
|
||||
printed numbers.
|
||||
"""
|
||||
|
||||
# 100 samples of 1..100ms. True median 50.5ms (the mean of the two middle
|
||||
# samples, not the upper one at 51ms); nearest-rank p95 is the 95th
|
||||
# sample at 95ms, not the 96th at 96ms.
|
||||
HUNDRED = [i / 1000.0 for i in range(1, 101)]
|
||||
|
||||
def test_even_window_median_averages_both_middle_samples(self):
|
||||
assert frame_stats(self.HUNDRED)["median"] == pytest.approx(0.0505)
|
||||
|
||||
def test_p95_uses_nearest_rank(self):
|
||||
assert frame_stats(self.HUNDRED)["p95"] == pytest.approx(0.095)
|
||||
|
||||
def test_odd_window_median_is_the_middle_sample(self):
|
||||
times = [i / 1000.0 for i in range(1, 102)] # 101 samples
|
||||
assert frame_stats(times)["median"] == pytest.approx(0.051)
|
||||
|
||||
def test_single_sample_window_does_not_index_out_of_range(self):
|
||||
stats = frame_stats([0.010])
|
||||
assert stats["median"] == pytest.approx(0.010)
|
||||
assert stats["p95"] == pytest.approx(0.010)
|
||||
assert stats["min"] == stats["max"] == pytest.approx(0.010)
|
||||
|
||||
def test_two_sample_window(self):
|
||||
stats = frame_stats([0.010, 0.020])
|
||||
assert stats["median"] == pytest.approx(0.015)
|
||||
assert stats["p95"] == pytest.approx(0.020)
|
||||
|
||||
def test_input_order_does_not_matter(self):
|
||||
assert frame_stats(list(reversed(self.HUNDRED))) == frame_stats(self.HUNDRED)
|
||||
|
||||
def test_caller_window_is_not_mutated(self):
|
||||
times = [0.030, 0.010, 0.020]
|
||||
frame_stats(times)
|
||||
assert times == [0.030, 0.010, 0.020]
|
||||
|
||||
def test_stall_threshold_follows_the_median(self):
|
||||
# Ten 10ms frames and two 30ms stalls: median 10ms, so >15ms is a
|
||||
# stall -- exactly the two.
|
||||
stats = frame_stats([0.010] * 10 + [0.030] * 2)
|
||||
assert stats["stalls"] == 2
|
||||
assert stats["skips"] == 0
|
||||
|
||||
def test_skips_are_frames_that_never_reached_the_panel(self):
|
||||
stats = frame_stats([0.010] * 10 + [0.002] * 3)
|
||||
assert stats["skips"] == 3
|
||||
assert stats["stalls"] == 0
|
||||
|
||||
def test_fps_is_the_reciprocal_of_the_mean(self):
|
||||
assert frame_stats([0.010] * 50)["fps"] == pytest.approx(100.0)
|
||||
|
||||
def test_formatted_line_reports_the_corrected_values(self):
|
||||
line = format_frame_stats(self.HUNDRED)
|
||||
assert "median 50.50ms" in line, line
|
||||
assert "p95 95.00ms" in line, line
|
||||
assert "over 100 frames" in line, line
|
||||
|
||||
def test_log_frame_rate_emits_the_line_and_clears_the_window(self, helper):
|
||||
helper._window = [0.010] * 20
|
||||
helper.last_fps_log_time = 0.0 # force the 5s boundary
|
||||
with patch.object(helper.logger, "info") as info:
|
||||
helper.log_frame_rate()
|
||||
assert info.called
|
||||
assert "Scroll frame stats" in info.call_args[0][0]
|
||||
assert helper._window == []
|
||||
|
||||
Reference in New Issue
Block a user