thermograph/frontend
Emi Griffith 083d3bd0f8
All checks were successful
PR build (required check) / changes (pull_request) Successful in 6s
secrets-guard / encrypted (pull_request) Successful in 5s
PR build (required check) / validate-observability (pull_request) Has been skipped
PR build (required check) / build-frontend (pull_request) Successful in 1m8s
PR build (required check) / build-backend (pull_request) Successful in 1m36s
PR build (required check) / gate (pull_request) Successful in 2s
Approximate-location fallback from the client IP (feature-flagged off)
A visitor who declines browser geolocation currently has no location at all —
the copy sends them to the map picker. This adds an opt-in fallback that
suggests a coarse city from the request's own IP, presented as a guess with a
one-tap correction, so the dead end has a way out.

backend/data/geoip.py does the lookup against a local MMDB file (DB-IP IP to
City Lite or GeoLite2 City — same format, either works, attribution derived
from the file's metadata). Off unless THERMOGRAPH_GEOIP is truthy AND the
database exists AND maxminddb imports; every degraded case — private/reserved/
CGNAT/IPv6-ULA addresses, unparseable input, no record, a country-centroid
record with no city, a record wider than the accuracy limit, a corrupt file —
returns None, which the route answers as 204 and the client treats exactly as
today.

The IP is read in memory and dropped. GET /api/v2/geoip runs no RunAudit,
records no metric dimension, and is excluded from the access log (its own
"geoip" traffic category) so no stored, joinable (IP, location) pair is ever
written. The response is no-store/Vary:* and takes no parameters.

Client-side rather than server-rendered on purpose: the homepage's HTML and
weak ETag must stay byte-identical for every visitor, or any cache added in
front of it can serve one visitor's city to another. The suggestion is fetched
only after a declined/unavailable prompt, and only when nothing is remembered.

A guess is never persisted — no localStorage write, no URL hash — and the hero
and results headings say "roughly near"/"near … approximate" rather than
letting the reverse-geocoded cell name a neighbourhood the lookup never knew.

The /privacy page's "never looks up your location from your IP address"
paragraph now follows the same flag out of the same env file, so the published
statement and the behaviour flip together.

Database lifecycle is a host-side systemd timer (infra/deploy/geoip-refresh.*)
that verifies a download opens and answers before swapping it in atomically,
bind-mounted read-only; geoip.py re-opens on mtime change, so a refresh needs
no restart. GEOIP-APPROX-LOCATION.md carries the database comparison, the
SSR-vs-client argument, the privacy analysis, and the open decisions.
2026-07-23 16:22:37 -07:00
..
content Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
scripts Subtree-merge thermograph-frontend origin/dev into frontend/ (two-tier test suite; CI workflow ported to root) 2026-07-22 22:23:50 -07:00
static Approximate-location fallback from the client IP (feature-flagged off) 2026-07-23 16:22:37 -07:00
templates Approximate-location fallback from the client IP (feature-flagged off) 2026-07-23 16:22:37 -07:00
tests Approximate-location fallback from the client IP (feature-flagged off) 2026-07-23 16:22:37 -07:00
tools Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
.gitignore Subtree-merge thermograph-frontend origin/dev into frontend/ (two-tier test suite; CI workflow ported to root) 2026-07-22 22:23:50 -07:00
api_client.py Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
app.py Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
CLAUDE.md Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
content.py Approximate-location fallback from the client IP (feature-flagged off) 2026-07-23 16:22:37 -07:00
content_loader.py Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
DESIGN.md Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
docker-compose.test.yml Subtree-merge thermograph-frontend origin/dev into frontend/ (two-tier test suite; CI workflow ported to root) 2026-07-22 22:23:50 -07:00
Dockerfile Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
format.py Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
Makefile Subtree-merge thermograph-frontend origin/dev into frontend/ (two-tier test suite; CI workflow ported to root) 2026-07-22 22:23:50 -07:00
paths.py Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
README.md Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00
requirements-dev.txt Subtree-merge thermograph-frontend origin/dev into frontend/ (two-tier test suite; CI workflow ported to root) 2026-07-22 22:23:50 -07:00
requirements.txt Subtree-merge thermograph-frontend (origin/main) into frontend/ 2026-07-22 22:01:11 -07:00

Thermograph frontend

The server-rendered content pages, the interactive-tool SPA shells, and every static asset for Thermograph — grades recent local weather against ~45 years of climate history. This repo holds no climate data and does no compute; it renders pages and serves the JS/CSS/image assets that call the backend's API from the browser. It was split out of the emi/thermograph monorepo (frontend_ssr/ + frontend/ there) so it can build its own image and deploy independently of the backend. See CLAUDE.md for the full agent-facing detail on the split topology and deploy contract, and thermograph-docs (sibling repo) for the architecture decision record behind the split.

Layout

api_client.py       HTTP client for the backend's content API (api/content_routes.py
                     on the backend). Fails loud at import if
                     THERMOGRAPH_API_BASE_INTERNAL is unset. TTL-cached (10 min
                     default) in front of every call.
app.py               FastAPI app: /healthz, the interactive tool's SPA-shell
                     routes (calendar/day/score/compare/legend/alerts), and the
                     StaticFiles mount for everything else. Calls
                     content.register(app) for the SSR routes below.
content.py           Server-rendered pages: climate hub, per-city, month,
                     records, glossary, about, privacy, robots.txt, sitemap.xml.
content_loader.py    Loads content/glossary.yaml + content/pages.yaml (SSR copy),
                     validated fail-loud at load time.
format.py            Unit-aware (°C/°F) formatting for the SSR templates,
                     ContextVar-scoped active unit.
paths.py             Canonical filesystem locations (STATIC_DIR, TEMPLATES_DIR,
                     CONTENT_DIR), resolved from the repo root.
templates/           Jinja templates content.py renders (base, home, city, month,
                     hub, records, glossary, glossary_term, about, privacy).
static/              Every static asset: the interactive tool's JS
                     (app.js, calendar.js, day.js, score.js, compare.js,
                     account.js, cache.js, shared.js, units.js, mappicker.js, …),
                     the SPA-shell HTML pages, style.css (all design tokens —
                     see DESIGN.md), icons/favicons, manifest.webmanifest, sw.js.
content/             Structured SSR copy: glossary.yaml, pages.yaml.
tests/               pytest suite — see the KNOWN GAP note below before relying on it.
tools/               shoot.py — the make-shots visual-verify screenshot tool
                     (see DESIGN.md).
Dockerfile           Builds this repo's own image (python:3.12-slim,
                     uvicorn app:app), independent of the backend's.

How it fits the split

Four sibling repos replace the old monorepo:

  • thermograph-backend — the FastAPI API, grading/scoring/grid compute, and DB. This repo's only runtime dependency.
  • thermograph-frontend (this repo).
  • thermograph-infra — Terraform, compose files, deploy/deploy.sh (the script both repos' deploy workflows SSH into), the secrets vault.
  • thermograph-docs — architecture/decision docs and runbooks.

Each app repo now builds and publishes its own image (git.thermograph.org/emi/thermograph-frontend/app, tagged by git SHA and semver) instead of the old shared emi/thermograph/app image, and deploys via its own .forgejo/workflows/deploy.yml (main → beta) and deploy-prod.yml (release → prod), each rolling only the frontend compose service on the target VPS.

Talking to the backend

All data comes from the backend's content API over HTTP (api_client.py) — this process holds nothing in-process. Two env vars control the topology:

  • THERMOGRAPH_API_BASE_INTERNAL (required) — where this process reaches the backend server-side, e.g. http://backend:8137 in compose, or http://127.0.0.1:8137 for a local backend checkout. api_client.py raises at import if this is unset — a missing backend URL should break boot, not silently 500 the first request.
  • THERMOGRAPH_API_BASE_PUBLIC (optional) — the backend's browser-facing origin, used only when frontend and backend are served cross-origin (e.g. a genuinely separate LAN-dev topology). Left empty (the default), asset/API references stay relative and same-origin, which is today's real deployed topology.

Same-origin cookie-auth caveat: the interactive tool's auth (static/account.js) is an HttpOnly session cookie. It uses credentials: "include" (not the fetch default) specifically so the cookie still rides along if this script is ever loaded cross-origin, but the backend must actually be configured to accept credentialed cross-origin requests (CORS + SameSite) for that case to work — in the default same-origin deployment this is a non-issue. Don't assume a fully decoupled, independently- hosted frontend "just works" for logged-in features without checking that cookie/CORS configuration first.

THERMOGRAPH_BASE (default /thermograph) must be set identically on both frontend and backend in every real deployment — it's how both processes agree on the shared URL prefix (or the deployed clean-root /, which the Dockerfile sets by default).

Build & run

python3 -m venv .venv && .venv/bin/pip install -r requirements.txt
THERMOGRAPH_API_BASE_INTERNAL=http://127.0.0.1:8137 \
THERMOGRAPH_BASE=/thermograph \
  .venv/bin/uvicorn app:app --host 0.0.0.0 --port 8080

Or build the image directly:

docker build -t thermograph-frontend .
docker run -p 8080:8080 -e THERMOGRAPH_API_BASE_INTERNAL=http://backend:8137 thermograph-frontend

The image healthchecks GET /healthz (liveness only — it does no I/O, so it stays cheap; it does not prove the backend is reachable).

More detail

  • CLAUDE.md — agent-facing instructions: deploy contract, API-version pinning, the cross-repo /cell/ETag and pctOrd() contracts, and the current known test-suite gap.
  • DESIGN.md — the visual system (tokens, components, breakpoints) and make shots visual verification.
  • thermograph-docs — the repo-topology decision record this split implements.