mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 06:15:09 +00:00
refactor(api-v3): split the 10,469-line blueprint into a package (#553)
* refactor(api-v3): split the 10,469-line blueprint into a package web_interface/blueprints/api_v3.py held 111 routes, 56 helpers and 181 functions in one module -- 9% of the core by line count and three times the next largest file. It becomes a package of nine route modules grouped by path segment, plus __init__.py for the shared imports, constants, Blueprint and helpers. Every route module decorates the SAME api_v3 Blueprint object, so endpoint names stay api_v3.<function>, the URL map is unchanged and app.py is untouched. Verified: 111 routes before, 111 after, byte-identical rules, endpoints and methods, and every endpoint still on the one blueprint. plugins 3,867 config 1,178 starlark 692 system 619 fonts 452 misc 398 wifi 361 display 326 backup 212 __init__ 1,787 (imports, constants, Blueprint, 56 helpers) Two things the URL-map check could not catch, both found by running the suite: 1. PROJECT_ROOT = Path(__file__).parent.parent.parent. Moving the code one directory deeper made that resolve to web_interface/ instead of the project root. Nothing failed at import; it surfaced as ~110 tests failing with 404s and "installation script not found", because every path built from it was one level too shallow. Now parents[3], and test_api_v3_url_map.py asserts PROJECT_ROOT/run.py exists so the next move cannot repeat it. 2. Module-attribute patching. Tests do monkeypatch.setattr(api_v3_module, "_BACKUP_EXPORT_DIR", ...) and a route module that binds such a name by value never sees the patch. The shared code therefore stays in __init__.py rather than moving to a _common submodule -- it has to live on the module the tests patch -- and the eleven names tests patch are read back through the package (_pkg.X) instead of bound by value. Those eleven were found by AST-scanning every setattr in the test tree, not by guessing; "time" is among them, used to drive a fake clock through the second-resolution credential-backup filenames. Test changes are confined to what genuinely moved: patch targets that now name the owning route module, imports of helpers, and six tests that scan the api_v3 source as a file and now read the package directory. Full suite: 4,278 passed, 68 skipped, 0 failed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014RRtqXDCnvnY6EQwhT5CV9 * fix(api-v3): address CodeRabbit findings from the blueprint-split review Fixes to the api_v3 package split (PR #553), one per finding verified against the actual code: - __init__.py: _redact_credentials only blanked scalar values under a credential-named key; a bare list of secrets under such a key (e.g. tokens: ["a", "b"]) passed through untouched, since the list branch recursed with no memory that its key looked like a credential. Nested dicts still walk normally (a documented, tested behaviour -- a container like secrets: {api_key: ..., note: ...} is a section name, not a value to blank outright), but any value reached under a credential-shaped key is now actually blanked. - __init__.py: the OAuth helper script's raw stderr/stdout went to logger.error unredacted (CWE-532) right next to a comment claiming this was deliberate; the HTTP response already used the existing redact_text helper. Routed the log line through the same helper. - __init__.py / starlark.py: the standalone Starlark manifest fallback (used when the plugin instance isn't loaded) read-modified-wrote manifest.json with no lock, unlike StarlarkAppsPlugin._update_manifest_safe (plugin-repos/starlark-apps/manager.py), which already holds an flock for the same file when the plugin is loaded. Added _starlark_manifest_lock, mirroring that pattern, and wrapped every standalone read-modify-write call site in it. The app-config update route also wrote config.json and the manifest as two separate, non-transactional writes (a second, distinct finding at the same call site); config.json is now rolled back if the manifest write that follows it fails. - backup.py: restore options used bare bool() on values from the request, so {"restore_secrets": "false"} restored secrets anyway (bool("false") is True). Switched to the existing _coerce_to_bool helper already used for this exact purpose elsewhere in the package. - config.py: an automated import-rewrite mangled four user-facing validation strings and their neighbouring comments -- "Invalid start time" had become "Invalid start _pkg.time" (and likewise for "end time") in both the schedule and dim-schedule per-day validation paths. - display.py: `import _pkg.time as time_module` -- _pkg is a local alias for the package, not a real importable module, so this raised ModuleNotFoundError whenever a caller restarted an already-running display service via /display/on-demand/start, after the on-demand request was already written to cache. Fixed to `import time`. Audited the rest of the package for the same `_pkg.<module>` import mistake; every other `_pkg.` reference is a legitimate attribute read-through (`_pkg.time.time()`, `_pkg._get_starlark_plugin()`, ...), not a broken import statement. - fonts.py: validate_file_upload's max_size_mb parameter is silently unused by that helper (it only checks filename/extension) -- the font upload route saved arbitrarily large files as a result. Added the same seek-and-check pattern already used for the sibling .star upload. - wifi.py: two ad hoc, inconsistent bool coercions. POST /wifi/ap/auto-enable used bare bool(), so a JSON string "false" enabled it. POST /wifi/radio's enabled/force parsing recognized real bool and some strings but not int 1/0 (1 is True is False in Python). Factored one small _parse_bool_ish helper local to this file and used it at all three sites. Not changed: the "unknown/misspelled restore option keys default to True" half of the backup.py finding -- the file's own comment documents that a missing key deliberately means "restore everything," matching the already-existing JSON-parse-failure guard a few lines above it; only the bool-coercion defect was a real bug. Added or extended regression tests for every fix, following each area's existing test conventions. Full suite: 4328 passed, 62 skipped, 2 failed on both this branch and origin/main (missing tzdata package breaks two timezone-alias tests in test_onboarding_checklist.py, unrelated to this change) -- no new failures. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01S3bPMESe2TfrGvbs1ef9c5 * fix(api-v3): reject unknown restore option keys CodeRabbit's review of the blueprint split (#553) asked that POST /backup/restore reject option keys outside RestoreOptions' known set. The follow-up commit fixed the bool("false")-is-True bug with _coerce_to_bool but never added the key check: a typo'd or renamed key (e.g. "restoreSecrets") is silently ignored by opts_dict.get(key, True), so the flag stays at its True default and secrets get restored despite the caller's request saying otherwise -- with no indication anything was wrong. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Vmcwf5vMgYqdt8bJTZtiwb * fix(api-v3): address CodeRabbit findings on the blueprint split - _redact_credentials: blank scalar descendants of objects reached through a credential-owned list (e.g. tokens: [{"value": "secret"}]) regardless of field name -- the existing name-based walk only protected direct dict values under a credential key, not list items. - wifi.py: reject enabled/force/auto_enable_ap_mode values _parse_bool_ish can't recognize (400) instead of silently treating them as False, which could disable Wi-Fi or the radio itself. - Starlark manifest locking: lock a stable manifest.json.lock sidecar instead of manifest.json itself, in both the standalone route path (_starlark_manifest_lock) and the plugin path (StarlarkAppsPlugin._save_manifest / _update_manifest_safe). manifest.json is replaced by an atomic rename on every write, which swaps in a fresh inode; a lock held on the old inode does not exclude a second locker that opens the path afresh right after the rename and gets the new inode, so two writers could race despite each holding "a lock". A sidecar that no write ever touches always resolves to the same inode for every locker. Skipped as stale: the "serialize the complete manifest read-modify-write" finding at api_v3/__init__.py -- every standalone handler that calls _write_starlark_manifest is already wrapped in _starlark_manifest_lock() on this branch. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(api-v3): re-check reconciliation findings by the reconciler's own rules Both CodeRabbit findings on the merge commit, verified against the code first. Major, plugins.py: the stale-findings filter derived its own notion of "in config" and "on disk", and both were looser than the reconciliation module's. set(load_config()) also contains system keys, the secrets-file keys load_config() merges in, and non-dict values; and any directory holding a manifest.json counted as installed even when that manifest does not parse. Either looseness clears a finding that is still true -- and a secrets key read as a plugin is the precise bug the filter exists to stop reporting, so reintroducing that asymmetry while re-checking was the wrong way round. The two extractions now live in state_reconciliation.py as config_plugin_ids() and disk_plugin_ids(), with ignored_config_keys() and secrets_top_level_keys() alongside. _get_config_state() and _get_disk_state() use them too, so there is one definition rather than two that can drift. _get_disk_state() re-reads each manifest for version/name after taking membership from the shared extractor; that costs one extra small read per plugin on a path that runs once per boot. Minor, the new test: the fixture assigned api_v3.config_manager and api_v3.plugin_manager directly. Those live on a module-level blueprint singleton, so the mocks leaked into every later test that imports api_v3 -- pointing at a tmp_path already deleted. Both now go through monkeypatch.setattr, which restores them. This is the same pollution class that made an earlier test in this session break seven unrelated ones, so it is worth getting right. Five cases added for the parity itself: a secrets key, a system key and a non-dict value must not clear an "installed but missing from config" finding, and neither an unparseable manifest nor a .standalone-backup- directory may count as installed. All five fail against the looser version. Linux CI on the preceding commit: Core unit tests, plugin harness, CodeQL and CodeRabbit all pass. Codacy reads action_required on every commit of this branch including the first, so it is pre-existing and not from this work. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,136 @@
|
||||
"""The /api/v3 URL map is a contract, and the split must not have moved it.
|
||||
|
||||
api_v3.py was one 10,469-line module and is now a package. Every route module
|
||||
in it decorates the *same* Blueprint object, so this refactor was supposed to
|
||||
be invisible from outside: same URLs, same endpoint names, same methods.
|
||||
|
||||
"Supposed to be" is the problem. A route function silently dropped during a
|
||||
move -- a module that never gets imported, a decorator left behind -- costs
|
||||
nothing at import time and fails only when someone hits the URL. So the map is
|
||||
pinned here.
|
||||
|
||||
The snapshot is intentionally the *whole* map rather than a count. A count
|
||||
passes when one route is deleted and another added, which is exactly the shape
|
||||
a careless move produces.
|
||||
|
||||
If you are adding a route, this test is meant to fail: add the entry to
|
||||
EXPECTED. If you are moving one between modules, it is meant to pass unchanged
|
||||
-- endpoint names are `api_v3.<function>` regardless of which module the
|
||||
function lives in, and that is the property that makes the package safe.
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
|
||||
import pytest
|
||||
from flask import Flask
|
||||
|
||||
from web_interface.blueprints.api_v3 import api_v3
|
||||
|
||||
SNAPSHOT = os.path.join(os.path.dirname(os.path.abspath(__file__)),
|
||||
"fixtures", "api_v3_url_map.json")
|
||||
|
||||
|
||||
def _current_map():
|
||||
app = Flask(__name__)
|
||||
app.register_blueprint(api_v3, url_prefix="/api/v3")
|
||||
return sorted(
|
||||
[r.rule, r.endpoint, sorted(r.methods)]
|
||||
for r in app.url_map.iter_rules()
|
||||
if r.endpoint != "static"
|
||||
)
|
||||
|
||||
|
||||
def test_the_url_map_matches_the_snapshot():
|
||||
current = _current_map()
|
||||
with open(SNAPSHOT, encoding="utf-8") as fh:
|
||||
expected = json.load(fh)
|
||||
|
||||
cur = {(r, e) for r, e, _ in current}
|
||||
exp = {(r, e) for r, e, _ in expected}
|
||||
|
||||
lost = sorted(exp - cur)
|
||||
added = sorted(cur - exp)
|
||||
assert not lost, (
|
||||
f"{len(lost)} route(s) disappeared from /api/v3: {lost[:5]}. "
|
||||
"A route lost in a module move costs nothing at import time and fails "
|
||||
"only when someone hits the URL.")
|
||||
assert not added, (
|
||||
f"{len(added)} new route(s): {added[:5]}. If that is intended, "
|
||||
f"regenerate {os.path.relpath(SNAPSHOT)}.")
|
||||
|
||||
# Methods too: a route that quietly loses POST is still a broken route.
|
||||
cur_methods = {(r, e): m for r, e, m in current}
|
||||
for rule, endpoint, methods in expected:
|
||||
assert cur_methods[(rule, endpoint)] == methods, (
|
||||
f"{rule} ({endpoint}) methods changed: "
|
||||
f"{methods} -> {cur_methods[(rule, endpoint)]}")
|
||||
|
||||
|
||||
def test_every_endpoint_is_on_the_one_blueprint():
|
||||
"""The package must not fragment into several blueprints.
|
||||
|
||||
Splitting into per-domain *blueprints* would rename every endpoint from
|
||||
`api_v3.foo` to `api_v3_plugins.foo` and break any url_for() that names
|
||||
one. Keeping a single Blueprint object across the modules is what makes
|
||||
the split a pure code move, so assert it rather than trusting it.
|
||||
"""
|
||||
for rule, endpoint, _ in _current_map():
|
||||
assert endpoint.startswith("api_v3."), (
|
||||
f"{rule} is registered as {endpoint}, not on the api_v3 blueprint")
|
||||
|
||||
|
||||
def test_the_snapshot_is_not_empty():
|
||||
"""Guards the failure mode this file exists to prevent.
|
||||
|
||||
An empty or truncated snapshot would make every assertion above pass
|
||||
vacuously -- the same trap as a route map that imports no modules.
|
||||
"""
|
||||
with open(SNAPSHOT, encoding="utf-8") as fh:
|
||||
expected = json.load(fh)
|
||||
assert len(expected) > 100, (
|
||||
f"snapshot has only {len(expected)} routes; it should have the whole "
|
||||
"/api/v3 surface")
|
||||
|
||||
|
||||
@pytest.mark.parametrize("module", [
|
||||
"backup", "config", "display", "fonts", "misc",
|
||||
"plugins", "starlark", "system", "wifi",
|
||||
])
|
||||
def test_every_route_module_contributes(module):
|
||||
"""Each module must actually register something.
|
||||
|
||||
A module that fails to import, or that is left out of __init__, takes its
|
||||
routes with it silently -- the package still imports and the app still
|
||||
starts.
|
||||
"""
|
||||
import importlib
|
||||
mod = importlib.import_module(f"web_interface.blueprints.api_v3.{module}")
|
||||
routes = [n for n in dir(mod)
|
||||
if callable(getattr(mod, n, None))
|
||||
and getattr(getattr(mod, n), "__module__", "") == mod.__name__]
|
||||
assert routes, f"{module}.py defines no view functions"
|
||||
|
||||
|
||||
def test_project_root_points_at_the_project():
|
||||
"""PROJECT_ROOT is derived from __file__, so moving the file breaks it.
|
||||
|
||||
The split moved this code from web_interface/blueprints/api_v3.py to
|
||||
web_interface/blueprints/api_v3/_common.py -- one directory deeper -- and
|
||||
`Path(__file__).parent.parent.parent` quietly began resolving to
|
||||
web_interface/ instead of the project root. Nothing failed at import. It
|
||||
surfaced as routes returning 404 and "installation script not found",
|
||||
because every path built from it pointed one level too shallow.
|
||||
|
||||
A URL-map check cannot catch that: the routes were all registered, they
|
||||
just could not find anything.
|
||||
"""
|
||||
from pathlib import Path
|
||||
|
||||
from web_interface.blueprints.api_v3 import PROJECT_ROOT
|
||||
|
||||
# The project root is the directory holding run.py and web_interface/.
|
||||
assert (PROJECT_ROOT / "run.py").is_file(), (
|
||||
f"PROJECT_ROOT is {PROJECT_ROOT}, which has no run.py; it is not the "
|
||||
"project root")
|
||||
assert (PROJECT_ROOT / "web_interface").is_dir()
|
||||
assert PROJECT_ROOT == Path(__file__).resolve().parents[1]
|
||||
Reference in New Issue
Block a user