mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 10:51:36 -04:00
ebdf9dcc4b
* ui: a preview map that waited for a container it could never see
Both map preview modals -- the per-region eye button and "View All Regions"
-- opened to an empty box. Each renders a div into a Modal and hands it to
MapLibre from an effect gated on `open`, reading the node out of a `useRef`:
if (!open || !mapContainer.current) return;
Mantine's Modal mounts its body one commit after `opened` flips true, so on
the render that opens the modal the ref is still null. The effect returns,
nothing it depends on changes again, and it never runs a second time. No
console error, no rejected promise, no canvas -- just an empty div.
Semantic UI's Portal mounted the body in the same commit that opened it, so
the ref was attached by the time effects ran. The effect bodies are
byte-identical across that migration; the modal library is the only variable,
confirmed against a device still running the older build where both previews
render.
A callback ref instead, so the effect re-runs when the node arrives and this
stops depending on any modal's mounting schedule. The async source lookup
also gets a cancelled flag: it could resolve after the cleanup ran, building
a map nothing would ever remove and leaking a WebGL context per open.
The tests drive the real page and assert a map was built against a node that
is in the document -- the outcome, rather than the mechanism that quietly
changed underneath it. Seven of the eight fail on the code before this.
* build: docker had no world underneath its map regions
Caddy serves /blobs/map-overview.pmtiles out of /opt/wrolpi-blobs, and that
blob is the world at zoom 0-6 -- what a regional extract sits on top of.
Without it a user who subscribes to a few regions gets those regions floating
on an empty background everywhere their data does not reach. Only a full
planet file, at 134GB, makes it unnecessary.
Raspberry Pi and Debian installs get the blob from pi-gen, the live-build
config, and upgrade.sh. Docker got nothing: the compose file bind-mounted a
git-ignored host directory over /opt/wrolpi-blobs, and a bind mount replaces
the image's directory rather than merging with it, so the path existed and was
empty on every Docker WROLPi. Verified against a running deployment, where
that URL returned 404 while the same URL on hardware returned 206.
So the web image fetches the blob at build time, as the other three builders
do, and the mount that would hide it is gone. `curl -f` so an HTTP error
fails the layer -- an image that builds without the blob is this same bug,
except silent at build time too.
The tests read the deployment files rather than a built container: building
to check costs a CDN download and several minutes, and both things that broke
-- nothing fetches it, a mount hides it -- are visible in the source.
* ui: cancel the load handler too, and make the cancel test falsifiable
Review follow-ups on the preview modals.
The `cancelled` flag was checked before constructing the map but not inside
the `load` handler it installs, so cleanup landing between the two left that
body drawing into a map `remove()` had already torn down. Guarded, mirroring
the `destroyed` pattern in MapViewer.js. The source promise also gets a
`.catch`: the helper cannot reject today, but nothing says it never will, and
an unhandled rejection here would be as quiet as the bug this all started as.
Two test corrections, both cases of an assertion claiming more than it read:
The region-drawing test spied on `addSource` AFTER construction and then
re-fired `load` by hand, so its count came entirely from that manual call and
said nothing about the production path. FakeMap now records the sources it is
given, and the assertion reads what the component's own `load` drew -- each
region once, in order, and none for the entry with no bbox.
The new cancel test passed with the guard deleted, which is worse than not
having it: Mantine had not mounted the modal body when it closed, so the
effect had never run and there was nothing to cancel. It now waits for the
effect to reach the source lookup before closing, and ships beside a control
that releases the same held promise WITHOUT closing and requires a map. The
control is what makes the zero meaningful; verified that removing the guard
fails the cancel test while the control still passes.
118 lines
5.1 KiB
Python
118 lines
5.1 KiB
Python
"""
|
|
The map overview blob must reach `/opt/wrolpi-blobs` in the Docker deployment.
|
|
|
|
The React map viewer draws the world at zoom 0-6 from `/blobs/map-overview.pmtiles`, which
|
|
Caddy serves out of `/opt/wrolpi-blobs`. A user who subscribes to regional extracts -- the
|
|
normal case, since the planet file is 134GB -- gets that blob and nothing else underneath
|
|
their regions, so when it is missing the regions float on an empty background and the map
|
|
reads as broken.
|
|
|
|
Raspberry Pi and Debian installs get the blob from pi-gen, the live-build config, and
|
|
upgrade.sh. Docker had no equivalent: the compose file bind-mounted a git-ignored (and
|
|
therefore empty) host directory over `/opt/wrolpi-blobs`, so the path existed and was empty
|
|
on every Docker WROLPi. Verified on a running deployment -- `/blobs/map-overview.pmtiles`
|
|
returned 404 while the same URL returned 206 on hardware.
|
|
|
|
These read the deployment files rather than a running container: building the image to check
|
|
takes a CDN download and several minutes, and the two things that actually broke -- nothing
|
|
fetches the blob, and a mount hides it -- are both visible in the source.
|
|
"""
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
import yaml
|
|
|
|
from wrolpi.vars import PROJECT_DIR
|
|
|
|
BLOBS_DIR = '/opt/wrolpi-blobs'
|
|
OVERVIEW_NAME = 'map-overview.pmtiles'
|
|
|
|
WEB_DOCKERFILE = PROJECT_DIR / 'docker/web/Dockerfile'
|
|
COMPOSE_FILE = PROJECT_DIR / 'docker-compose.yml'
|
|
WEB_CADDYFILE = PROJECT_DIR / 'docker/web/Caddyfile'
|
|
|
|
|
|
@pytest.fixture
|
|
def web_dockerfile() -> str:
|
|
return WEB_DOCKERFILE.read_text()
|
|
|
|
|
|
@pytest.fixture
|
|
def compose() -> dict:
|
|
return yaml.safe_load(COMPOSE_FILE.read_text())
|
|
|
|
|
|
def test_files_exist():
|
|
"""The premise. A missing file would read exactly like a passing test below."""
|
|
for path in (WEB_DOCKERFILE, COMPOSE_FILE, WEB_CADDYFILE):
|
|
assert path.is_file(), f'{path} is missing'
|
|
|
|
|
|
def test_web_caddy_serves_blobs_from_the_blobs_directory():
|
|
"""The premise for the rest: `/blobs/*` really is `/opt/wrolpi-blobs`."""
|
|
caddyfile = WEB_CADDYFILE.read_text()
|
|
assert 'handle_path /blobs/*' in caddyfile
|
|
assert BLOBS_DIR in caddyfile
|
|
|
|
|
|
def test_web_image_provisions_the_map_overview_blob(web_dockerfile):
|
|
"""The web image must put the overview blob at the path Caddy serves."""
|
|
assert OVERVIEW_NAME in web_dockerfile, \
|
|
f'docker/web/Dockerfile never provisions {OVERVIEW_NAME}; a Docker WROLPi with only ' \
|
|
f'regional map files will have no world basemap'
|
|
assert f'{BLOBS_DIR}/{OVERVIEW_NAME}' in web_dockerfile
|
|
|
|
|
|
def test_web_image_fails_the_build_when_the_blob_is_missing(web_dockerfile):
|
|
"""
|
|
A silent failure here is the whole bug: an image that builds without the blob ships and
|
|
the map is broken at runtime, where nothing explains why. pi-gen and the live-build
|
|
config both hard-fail on this, so the Docker build does too.
|
|
"""
|
|
fetch = [line for line in web_dockerfile.splitlines() if OVERVIEW_NAME in line]
|
|
assert fetch, 'no line mentions the overview blob'
|
|
# `curl -f` turns an HTTP error into a non-zero exit, which fails the RUN layer. Without
|
|
# it curl writes the error body to the output file and exits 0.
|
|
assert any('curl -f' in line or 'curl --fail' in line for line in fetch), \
|
|
'the blob download must use curl -f so an HTTP error fails the build'
|
|
|
|
|
|
def test_compose_does_not_shadow_the_blobs_directory(compose):
|
|
"""
|
|
A bind mount over `/opt/wrolpi-blobs` replaces what the image provides -- it does not
|
|
merge with it. The compose file mounted a git-ignored host directory there, so the blob
|
|
baked into the image would be invisible even once the Dockerfile fetches it. This is the
|
|
assertion that fails on the original code.
|
|
"""
|
|
volumes = compose['services']['web'].get('volumes') or []
|
|
for volume in volumes:
|
|
# Entries are "source:target" or "source:target:mode".
|
|
target = volume.split(':')[1] if ':' in volume else ''
|
|
assert target != BLOBS_DIR, \
|
|
f'docker-compose.yml mounts {volume!r} over {BLOBS_DIR}, hiding the ' \
|
|
f'{OVERVIEW_NAME} baked into the web image'
|
|
|
|
|
|
def test_no_git_ignored_blobs_directory_is_relied_upon():
|
|
"""
|
|
The host `./blobs` directory this used to mount is in .gitignore, so it is empty on every
|
|
fresh clone. Nothing in the deployment should depend on a user populating it by hand.
|
|
"""
|
|
gitignore = (PROJECT_DIR / '.gitignore').read_text()
|
|
if '/blobs/' not in gitignore:
|
|
pytest.skip('./blobs is no longer git-ignored')
|
|
compose_text = COMPOSE_FILE.read_text()
|
|
assert './blobs:' not in compose_text, \
|
|
'./blobs is git-ignored and therefore empty; the compose file must not depend on it'
|
|
|
|
|
|
def test_pi_and_docker_agree_on_the_blob_location():
|
|
"""
|
|
Hardware and Docker must serve the same URL from the same path, or a fix to one silently
|
|
leaves the other broken -- which is exactly how this shipped.
|
|
"""
|
|
pi_caddyfile = (PROJECT_DIR / 'etc/raspberrypios/Caddyfile').read_text()
|
|
docker_caddyfile = WEB_CADDYFILE.read_text()
|
|
for caddyfile in (pi_caddyfile, docker_caddyfile):
|
|
assert 'handle_path /blobs/*' in caddyfile
|
|
assert f'root * {BLOBS_DIR}' in caddyfile
|