mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-07-02 12:51:44 +00:00
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>
74 lines
3.0 KiB
JavaScript
74 lines
3.0 KiB
JavaScript
'use strict';
|
|
// Unit test for #6: pan/zoom coverage redraws must be debounced so dragging the
|
|
// map fires at most one /api/...rx-coverage request per settle, not one per
|
|
// moveend. We load node-reach-coverage.js in a vm sandbox with controllable
|
|
// timers + the real debounce, bind the layer, fire a burst of map events, then
|
|
// advance the fake clock and assert exactly one extra fetch happened.
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const vm = require('vm');
|
|
|
|
const code = fs.readFileSync(path.join(__dirname, 'public', 'node-reach-coverage.js'), 'utf8');
|
|
|
|
// Controllable timer queue.
|
|
let now = 0;
|
|
let nextId = 1;
|
|
let timers = [];
|
|
function setTimeoutStub(fn, ms) { const id = nextId++; timers.push({ id: id, fn: fn, at: now + (ms || 0) }); return id; }
|
|
function clearTimeoutStub(id) { timers = timers.filter(function (t) { return t.id !== id; }); }
|
|
function advance(ms) {
|
|
now += ms;
|
|
const due = timers.filter(function (t) { return t.at <= now; });
|
|
timers = timers.filter(function (t) { return t.at > now; });
|
|
due.forEach(function (t) { t.fn(); });
|
|
}
|
|
|
|
let fetchCount = 0;
|
|
function fakeFetch() {
|
|
fetchCount++;
|
|
// Chainable stub whose then/catch never invoke callbacks (we only count calls).
|
|
const chain = { then: function () { return chain; }, catch: function () { return chain; } };
|
|
return chain;
|
|
}
|
|
|
|
const fakeGroup = { addTo: function () { return fakeGroup; }, clearLayers: function () {}, };
|
|
const map = {
|
|
handlers: {},
|
|
on: function (ev, fn) { this.handlers[ev] = fn; },
|
|
off: function () {},
|
|
getBounds: function () { return { getSouth: function () { return 0; }, getWest: function () { return 0; }, getNorth: function () { return 1; }, getEast: function () { return 1; } }; },
|
|
getZoom: function () { return 10; },
|
|
removeLayer: function () {},
|
|
};
|
|
|
|
const sandbox = {
|
|
window: {},
|
|
console: { warn: function () {} },
|
|
setTimeout: setTimeoutStub,
|
|
clearTimeout: clearTimeoutStub,
|
|
fetch: fakeFetch,
|
|
L: { layerGroup: function () { return fakeGroup; } },
|
|
getComputedStyle: function () { return { getPropertyValue: function () { return ''; } }; },
|
|
document: { documentElement: {} },
|
|
};
|
|
vm.createContext(sandbox);
|
|
// Define debounce IN the context so it uses the controllable timers above.
|
|
vm.runInContext('function debounce(fn, ms){var t; return function(){var a=arguments, c=this; clearTimeout(t); t=setTimeout(function(){fn.apply(c,a);}, ms);};}', sandbox);
|
|
vm.runInContext(code, sandbox);
|
|
|
|
const handle = sandbox.window.NodeReachCoverage.addLayer(map, 'aabbccddeeff');
|
|
assert.strictEqual(fetchCount, 1, 'addLayer should fetch once initially');
|
|
|
|
// Burst of pan/zoom events.
|
|
const fire = map.handlers['moveend zoomend'];
|
|
assert.strictEqual(typeof fire, 'function', 'moveend/zoomend handler must be bound');
|
|
for (let i = 0; i < 6; i++) fire();
|
|
assert.strictEqual(fetchCount, 1, 'burst must not fetch immediately (debounced)');
|
|
|
|
advance(200);
|
|
assert.strictEqual(fetchCount, 2, 'after settle, exactly one coalesced fetch (got ' + fetchCount + ')');
|
|
|
|
handle.off();
|
|
console.log('node-reach-coverage debounce OK');
|