Files
LEDMatrix/test/test_web_display_state_freshness.py
T
ChuckandClaude Opus 5 f475038895 fix(cache): web UI can read what the display service caches again (#593)
* fix(cache): web UI can read what the display service caches again

ledmatrix-web.service carried CacheDirectory=ledmatrix. With User= set to
the installing user, systemd re-owns /var/cache/ledmatrix and everything
in it to that user and its primary group whenever the directory's owner
differs -- for a directory root created, on the first start. That erased
the root:ledmatrix setgid layout the installers set up, so every file the
display service (root) wrote afterwards was root:root 0660 and unreadable
by the web interface:

  WARNING - Permission denied loading cache for display_current_state ...

Since #547 install_service.sh renders the web unit from the template, so
every fresh install hit this. Measured on one rig: 392 unreadable files,
and the web UI's display status, on-demand state and plugin health empty.

Existing installs only receive `git pull`, never a reinstalled unit, so
the fix for them is in the code the root display service runs:

- DiskCache.set gives each file the directory's group (when the directory
  is group-writable) and 0660 on the open descriptor before the rename,
  independent of setgid. This also closes a window where a fresh file was
  visible as mkstemp's 0600.
- DiskCache.share_existing_files repairs files an older version left
  behind, once per process from the cleanup thread. It works through
  O_NOFOLLOW descriptors and skips hard links and other users' files: the
  directory is writable by the web user, and root must not be steered
  into changing a file outside it.

For new installs, the web unit drops CacheDirectory=/CacheDirectoryMode=,
and install_web_service.sh stops replacing an existing directory's
ledmatrix group with the user's group.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(web): on-demand and current-display status read the display's latest state

Found testing the cache-permission fix on a rig: once the web interface
could read display_on_demand_state at all, /display/on-demand/status kept
answering "active" for over 100 seconds while the file on disk said
"idle". Both status routes read the display service's keys through the
web process's memory tier, which serves the first copy it read for the
full max_age (120s). Read them with memory_ttl=0, as every other
cross-process reader (plugin health/metrics, the on-demand mailbox)
already does.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(install): re-group the cache dir whenever the web user is outside its group

install_web_service.sh replaced an existing cache directory's group only
when it was root's. A directory in any other group the web user is not a
member of -- root:ledmatrix, for a user who is not in ledmatrix -- was left
alone, and every file root wrote there stayed unreadable to the web
interface. Replace the group whenever the installing user is not in it.

A directory whose group the user is already in (ledmatrix, or the user's
own group where CacheDirectory= left it) is still left as it is: re-grouping
a working directory strands the files already in it on the old group.

When the group does change and root-owned JSON files carrying the old group
are present, try-restart ledmatrix.service so DiskCache.share_existing_files
re-groups them through its symlink- and hard-link-safe path, rather than a
recursive chgrp.

Verified under WSL's systemd for seven directory states (user group,
ledmatrix member, ledmatrix non-member with and without root files,
root:root, missing, unnamed gid); the previous version left the non-member
case unchanged.

Addresses CodeRabbit review on #593.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-17 12:38:39 -04:00

63 lines
2.3 KiB
Python

"""Tests that the web UI reports the display's state as it is now.
The display service writes display_on_demand_state and display_current_state;
the web interface is a different process and can only see them on disk. Its
reads went through the cache's memory tier, which keeps the first copy read
for the full max_age (120s). Measured on a rig once the web interface could
read these files at all: /display/on-demand/status said "active" for over 100
seconds while the file on disk had said "idle" the whole time.
"""
import json
import pytest
from flask import Flask
import web_interface.blueprints.api_v3 as api_pkg
from src.cache_manager import CacheManager
@pytest.fixture
def two_processes(tmp_path, monkeypatch):
"""A display-side and a web-side cache over one directory, as on a rig."""
monkeypatch.setattr(CacheManager, '_get_writable_cache_dir', lambda self: str(tmp_path))
monkeypatch.setattr(CacheManager, 'start_cleanup_thread', lambda self: None)
display, web = CacheManager(), CacheManager()
monkeypatch.setattr(api_pkg, 'cache_manager', web)
monkeypatch.setattr(api_pkg, '_get_display_service_status', lambda: {'active': True})
return display
@pytest.fixture
def client():
app = Flask(__name__)
app.config['TESTING'] = True
if 'api_v3' not in app.blueprints:
app.register_blueprint(api_pkg.api_v3, url_prefix='/api/v3')
with app.test_client() as c:
yield c
def _get(client, url):
response = client.get(url)
assert response.status_code == 200
return json.loads(response.data)['data']
def test_on_demand_status_sees_the_stop_immediately(client, two_processes):
two_processes.set('display_on_demand_state', {'active': True, 'status': 'active'})
assert _get(client, '/api/v3/display/on-demand/status')['state']['status'] == 'active'
two_processes.set('display_on_demand_state', {'active': False, 'status': 'idle'})
assert _get(client, '/api/v3/display/on-demand/status')['state']['status'] == 'idle'
def test_current_status_sees_the_mode_change_immediately(client, two_processes):
two_processes.set('display_current_state', {'mode': 'odds_ticker'})
assert _get(client, '/api/v3/display/current-status')['mode'] == 'odds_ticker'
two_processes.set('display_current_state', {'mode': 'stocks'})
assert _get(client, '/api/v3/display/current-status')['mode'] == 'stocks'