Skip to content

NOTES.md

Latest commit

 

History

History
48 lines (37 loc) · 5.97 KB

NOTES.md

File metadata and controls

48 lines (37 loc) · 5.97 KB
Raw

Notes for agents

Gotchas, decisions and conventions learned while working on this repo. Add with the flightplan-context add_note tool; keep each note short and specific.

Build

  • Rust lives in ~/.cargo/bin (not on PATH in fresh shells): export PATH=$HOME/.cargo/bin:$PATH. Node 22 is in ~/.local/node/bin. (2026-10-24)
  • Native app: cd native && cargo build --release → native/target/release/flightplan (~40 s incremental). The server crate is a library the app links (server/src/lib.rs). (2026-10-24)
  • No sudo on the dev box. tippecanoe needs SQLite headers: point CPATH/LIBRARY_PATH at an extracted libsqlite3-dev .deb. (2026-10-24)

Network

  • IPv6 is broken on the dev machine: use curl -4 and retries for downloads. (2026-10-24)

egui

  • egui/eframe 0.36: eframe::App::ui(&mut self, root: &mut Ui, frame) (not update), ctx.global_style()/set_global_style, TextEdit.frame(Frame::NONE), DroppedFile::path(). (2026-10-24)
  • Phosphor icons come from egui-phosphor; Inter had its private-use glyphs stripped (assets/fonts/README.md) so icons aren't shadowed. Don't put the phosphor font first: it breaks lowercase text. (2026-10-24)
  • Panels take state: &mut S and pass it to both closures; use Cell for flags to avoid double borrows of app. (2026-10-24)
  • A single-line TextEdit loses focus on the frame Enter is pressed: check lost_focus() && key_pressed(Enter), not has_focus(). Same for click-to-pick lists under a text field: keep them open with a flag, because pressing the mouse drops the focus before the click lands (ui/search.rs). (2026-10-24)
  • Painted buttons (rail, cards) need resp.widget_info(WidgetInfo::labeled(...)) or screen readers and the kittest click-by-label harness cannot find them. (2026-10-24)

Testing

  • The windowed app stalls when the screen is locked (no compositor frames). Use the headless screenshot harness instead: cargo build --features shots --bin shots, then FP_DATA_DIR=<dir> ./target/debug/shots <script> <outdir>. Script actions are in native/src/ui/shot.rs and native/src/bin/shots.rs. (2026-10-24)
  • Point FP_DATA_DIR at a scratch copy of a data dir so screenshots never touch the user's ~/.local/share/flightplan. (2026-10-24)

Repo conventions

  • Never add Co-Authored-By / Claude attribution lines to commits or PRs (owner's rule). (2026-10-24)
  • License is AGPL-3.0-only. (2026-10-24)
  • Desktop app must stay native (Rust + egui), never a webview wrapper. (2026-10-24)
  • Owner rule: never synthesize or derive weather forecasts in the app (no home-made radar from model points, no model-field checks). Show and read official products as published: NEXRAD, HRRR, TAF, NBM, WPC chart / QPF, SPC outlooks, AIRMET/SIGMET/G-AIRMET. (2026-10-24)

Weather data

  • IEM HRRR extended-run tiles (hrrr::REFD-F1140..2880) often 503 past ~38 h even though refd_{min}.json exists; radar.rs Runs probes the last served hour by binary search on tile 4/3/5. (2026-10-24)
  • G-AIRMET/SIGMET from aviationweather.gov are only valid for hours: filter by the ETA at the crossing point (hazards.rs lateral) or a departure days out gets flagged by today's advisories. (2026-10-24)
  • FAA TFR shapes have no machine-readable times, but titles carry dates ("Friday, October 23, 2026 through Sunday, October 25, 2026 Local"). hazards::tfr_days parses them (12 h slack for zones); undated or old single-date titles count as always active. (2026-10-24)
  • Winds aloft are the NWS FB forecast only (owner rule: official products). FB columns are fixed: each level field ends where its header label ends; 3000 ft has no temp; dd>36 means 100 kt+ (dd-50, ff+100); 9900 = light and variable; temps above 24,000 ft are negative without a sign. Only ~24 h ahead: past that the navlog has no wind and the verdict says so. (2026-10-24)

Plan

  • Route.rev is serde(skip) and must deserialize to 1, not 0: Plan treats fetched_rev 0 as already fetched, so a route restored at startup never loaded its profile. The verdict waits for profile_rev == route.rev and a non-empty profile, so it never says GO without terrain. (2026-10-24)

Chart

  • Black hatched blobs on the chart at zoom 8-10 were hundreds of wind-turbine obstacle symbols overprinting; view.rs now thins obstacles tallest-first with a pixel grid below zoom 12.5. (2026-10-24)

Web app

  • The web app mirrors the desktop app feature for feature; plan logic is ported to TS (nav/navlog.ts, hazards.ts, verdict.ts, wx/forecast.ts, notams.ts, radar.svelte.ts). When a native feature changes, change the TS twin too. Network fetches for forecasts live once in server/src/forecast.rs (used by native and by /api/wx/station|official|outlooks|hrrr). Headless UI checks: playwright-core with ~/.cache/ms-playwright/chromium-*/chrome-linux64/chrome and --use-angle=swiftshader --enable-unsafe-swiftshader, else the MapLibre canvas never appears. (2026-10-25) (2026-10-25)
  • The web server is password-locked (server/src/auth.rs). Anything under web/src/lib/auth runs before sign-in: never import stores, api.ts or io/files there (they hit the API, get 401 and api.ts reloads the page in a loop). Headless tests need the setup code from /setup-code.txt; a fresh scratch data dir starts locked. Use pgrep -x flightplan-serv to stop test servers: pkill -f <pattern> matches the calling shell too. (2026-10-25) (2026-10-25)

Deploy

  • deploy/proxmox/flightplan-lxc.sh (Proxmox host) pushes deploy/lxc/install.sh into a Debian 12 LXC. Test the installer for real with Docker: debian:12 + systemd image run with -e container=docker --privileged --cgroupns=private --memory 1g --memory-swap 1536m --tmpfs /run --tmpfs /run/lock, docker cp the scripts in (a bind-mounted file keeps its old inode after sed -i), install with TARBALL=. Build the tarball's binary in rust:1-bookworm (this dev box's glibc 2.38 binary won't run on Debian 12). Docker shows the host's 24 cores: cap make -j and TIPPECANOE_MAX_THREADS or a 1 GB container OOMs. Full cycle build in 1 GB: ~33 min, 4.5 min CPU, mostly the network-bound Overture step (reused for 90 days). (2026-10-26) (2026-10-26)