mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-07-02 23:31:44 +00:00
efiten
22fe929da2
Implements #1727. ## What this adds **Mobile client-RX coverage** — an opt-in, crowdsourced RF-coverage feature. A roaming MeshCore **companion** radio (driven by the open-source [corescope-rx](https://github.com/efiten/corescope-rx) PWA, GPLv3) reports which nodes it heard directly, tagged with the phone's GPS and the packet's SNR/RSSI. CoreScope ingests these into a new `client_receptions` table and renders per-node **hex coverage** on the Reach page, plus a standalone **Coverage dashboard** (`#/rx-coverage`) with a top-mobile-observers leaderboard. Also includes **`GET /api/nodes/resolve?prefix=<hex>`** — a read-only node-name lookup by pubkey prefix (`{name, pubkey, ambiguous}`), used by the companion app for friendly names. ## Opt-in — default OFF (zero impact on existing deployments) The whole feature is gated behind one config flag, **disabled by default**: ```jsonc "clientRxCoverage": { "enabled": false } ``` When disabled (the default): the ingestor writes **no** `client_receptions`; the three coverage endpoints return a clean **404**; the UI hides the Coverage nav link, the `#/rx-coverage` route, and the Reach-page toggle. `/api/nodes/resolve` is always available (not coverage-specific). ## How it works ``` companion ──BLE 0x88 (snr+rssi+raw)──▶ corescope-rx PWA ──▶ MQTT meshcore/client/{pubkey}/packets │ ingestor (gated) ──▶ client_receptions (GPS + SNR + heard-key) │ server: pure-Go hex grid ──▶ GeoJSON ──▶ Reach hex overlay + Coverage dashboard ``` - **Direct-only capture:** records only what the companion heard itself and directly — a 0-hop advert's pubkey, or `path[last]` (last forwarder) for FLOOD routes; ≥2-byte path-hash required. Upstream hops discarded. - **No new deps:** hexbins are a pure-Go pointy-top grid over Web Mercator (`cmd/server/hexgrid.go`) computed at query time (`CGO_ENABLED=0` / `modernc.org/sqlite` friendly); frontend uses the existing Leaflet. - **Trust:** companion pubkey = identity; an EMQX ACL binds each client to publish only to its own `meshcore/client/{pubkey}/packets` topic. Payload contract in `docs/client-rx-coverage.md`. ## How to enable / try it 1. In `config.json`, set `"clientRxCoverage": { "enabled": true }` and restart server + ingestor. 2. Point an EMQX (or any broker) listener so a client can publish to `meshcore/client/<pubkey>/packets`; the ingestor already subscribes under `meshcore/#`. 3. Run the [corescope-rx](https://github.com/efiten/corescope-rx) PWA on an Android phone paired (BLE) to a MeshCore companion — it captures heard nodes + GPS and publishes. 4. View results: per-node Reach page → toggle **coverage**, or the **Coverage** dashboard at `#/rx-coverage`. ## What's where - **Ingestor:** `cmd/ingestor/client_reception.go` (ingest), `db.go` (`client_receptions` + `client_observers` schema), `main.go` (gated dispatch), `config.go` (flag). - **Server:** `cmd/server/rx_coverage.go` + `rx_dashboard.go` (endpoints, self-guard 404 when off), `hexgrid.go` (pure-Go grid), `node_resolve.go` (resolve), `routes.go` / `types.go` / `config.go` (wiring + flag + `/api/config/client` field). - **Frontend:** `public/rx-coverage.js` (dashboard), `node-reach-coverage.js` + `.css` (overlay), `node-reach.js` (Reach toggle, flag-gated), `roles.js` (reads the flag, hides nav when off). - **Docs:** `docs/client-rx-coverage.md`. ## Testing - Go: `cd cmd/server && go test ./...` and `cd cmd/ingestor && go test ./...` — green, including new gate tests (`coverage_gate_test.go` in both: off → no rows / 404, on → works) and the rx-coverage / resolve / hexgrid suites. - JS: `node test-coverage-gate.js`, `node test-node-reach-coverage.js` (wired into CI). The Playwright `test-node-reach-coverage-e2e.js` is wired into the e2e job and **skips when `clientRxCoverage` is disabled**, so it's safe under the default-off config. ## Notes for reviewers - The four new routes are registered in `cmd/server/openapi_known_gaps.json` (the existing OpenAPI-completeness ratchet), matching how other not-yet-spec'd routes are tracked. Happy to write full OpenAPI spec entries instead if you prefer. - Commits are split per layer (ingestor / server endpoints / resolve / frontend / CI) for review. --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Erwin Fiten <e.fiten@opteco.be>
68 lines
2.1 KiB
Go
68 lines
2.1 KiB
Go
package main
|
|
|
|
import (
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gorilla/mux"
|
|
)
|
|
|
|
// gateTestServer builds a minimal *Server with the given client-RX coverage
|
|
// config and registers all routes, mirroring routes_test.go's setup but
|
|
// skipping the packet store (none of the gated routes need it for the 404 /
|
|
// registration assertions below).
|
|
func gateTestServer(t *testing.T, cov *ClientRxCoverageConfig) *mux.Router {
|
|
t.Helper()
|
|
db := setupTestDB(t)
|
|
cfg := &Config{Port: 3000, ClientRxCoverage: cov}
|
|
hub := NewHub()
|
|
srv := NewServer(db, cfg, hub)
|
|
router := mux.NewRouter()
|
|
srv.RegisterRoutes(router)
|
|
return router
|
|
}
|
|
|
|
func TestCoverageRoutesGatedOff(t *testing.T) {
|
|
router := gateTestServer(t, nil)
|
|
|
|
req := httptest.NewRequest("GET", "/api/rx-coverage", nil)
|
|
rr := httptest.NewRecorder()
|
|
router.ServeHTTP(rr, req)
|
|
if rr.Code != http.StatusNotFound {
|
|
t.Fatalf("expected 404 for /api/rx-coverage when disabled, got %d", rr.Code)
|
|
}
|
|
|
|
creq := httptest.NewRequest("GET", "/api/config/client", nil)
|
|
crr := httptest.NewRecorder()
|
|
router.ServeHTTP(crr, creq)
|
|
if crr.Code != http.StatusOK {
|
|
t.Fatalf("config/client status %d body %s", crr.Code, crr.Body.String())
|
|
}
|
|
if !strings.Contains(crr.Body.String(), `"clientRxCoverage":false`) {
|
|
t.Fatalf("expected clientRxCoverage:false in config body, got %s", crr.Body.String())
|
|
}
|
|
}
|
|
|
|
func TestCoverageRoutesGatedOn(t *testing.T) {
|
|
router := gateTestServer(t, &ClientRxCoverageConfig{Enabled: true})
|
|
|
|
req := httptest.NewRequest("GET", "/api/rx-coverage", nil)
|
|
rr := httptest.NewRecorder()
|
|
router.ServeHTTP(rr, req)
|
|
if rr.Code == http.StatusNotFound {
|
|
t.Fatalf("expected /api/rx-coverage to be registered when enabled, got 404")
|
|
}
|
|
|
|
creq := httptest.NewRequest("GET", "/api/config/client", nil)
|
|
crr := httptest.NewRecorder()
|
|
router.ServeHTTP(crr, creq)
|
|
if crr.Code != http.StatusOK {
|
|
t.Fatalf("config/client status %d body %s", crr.Code, crr.Body.String())
|
|
}
|
|
if !strings.Contains(crr.Body.String(), `"clientRxCoverage":true`) {
|
|
t.Fatalf("expected clientRxCoverage:true in config body, got %s", crr.Body.String())
|
|
}
|
|
}
|