mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-06-22 15:51:53 +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>
66 lines
3.0 KiB
JavaScript
66 lines
3.0 KiB
JavaScript
'use strict';
|
|
// Unit test for the client-RX coverage frontend gate (SP2).
|
|
//
|
|
// The coverage toggle (#nqCoverage) and its legend (#nqCovLegend) are built
|
|
// inline inside node-reach.js's load() — a large async function that depends on
|
|
// api()/Leaflet, so it can't be invoked headless. Instead we extract the exact
|
|
// actions-HTML concatenation block from the real source and evaluate it in a vm
|
|
// sandbox with both values of window.MC_CLIENT_RX_COVERAGE. This exercises the
|
|
// real source markup logic (no hand-copied duplicate) for the gate.
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const vm = require('vm');
|
|
|
|
const src = fs.readFileSync(path.join(__dirname, 'public', 'node-reach.js'), 'utf8');
|
|
|
|
// Slice the actions-HTML expression: from the '<div class="nq-actions ...' line
|
|
// through the table that closes the block (ends with '</div></div>';).
|
|
const startMarker = "'<div class=\"nq-actions nq-noprint\">'";
|
|
const startIdx = src.indexOf(startMarker);
|
|
assert.ok(startIdx >= 0, 'could not locate nq-actions block start in node-reach.js');
|
|
const endMarker = "'</div></div>';";
|
|
const endIdx = src.indexOf(endMarker, startIdx);
|
|
assert.ok(endIdx >= 0, 'could not locate nq-actions block end in node-reach.js');
|
|
// Drop the trailing ";" so we can wrap the concatenation as a single expression.
|
|
let block = src.slice(startIdx, endIdx + endMarker.length).replace(/;\s*$/, '');
|
|
|
|
// Render the actions HTML for a given flag value via a controlled sandbox.
|
|
function renderActions(flag) {
|
|
const sandbox = {
|
|
window: { MC_CLIENT_RX_COVERAGE: flag },
|
|
coverageOn: false,
|
|
statsHtml: '',
|
|
};
|
|
vm.createContext(sandbox);
|
|
return vm.runInContext('(' + block + ')', sandbox);
|
|
}
|
|
|
|
// Flag OFF ⇒ no coverage checkbox, no legend.
|
|
const off = renderActions(false);
|
|
assert.ok(!off.includes('id="nqCoverage"'),
|
|
'flag false: actions HTML must NOT contain id="nqCoverage"');
|
|
assert.ok(!off.includes('id="nqCovLegend"'),
|
|
'flag false: actions HTML must NOT contain id="nqCovLegend"');
|
|
|
|
// Flag ON ⇒ coverage checkbox and legend present.
|
|
const on = renderActions(true);
|
|
assert.ok(on.includes('id="nqCoverage"'),
|
|
'flag true: actions HTML MUST contain id="nqCoverage"');
|
|
assert.ok(on.includes('id="nqCovLegend"'),
|
|
'flag true: actions HTML MUST contain id="nqCovLegend"');
|
|
|
|
// #19: the legend visibility is class-driven (.is-hidden), not an inline
|
|
// style="display:..." that CSS can't override. coverageOn is false in this
|
|
// sandbox, so the legend must carry is-hidden and no inline display style.
|
|
assert.ok(/class="nq-cov-legend[^"]*\bis-hidden\b/.test(on),
|
|
'flag true + coverage off: legend must use the is-hidden class');
|
|
assert.ok(!on.includes('style="display:'),
|
|
'legend must not use an inline display style (#19)');
|
|
|
|
// Sanity: the non-gated controls render regardless of the flag.
|
|
assert.ok(off.includes('id="nqIncoming"') && on.includes('id="nqIncoming"'),
|
|
'incoming filter must render irrespective of the coverage flag');
|
|
|
|
console.log('coverage gate (node-reach actions HTML) OK');
|