mirror of
https://github.com/BigBodyCobain/Shadowbroker.git
synced 2026-06-03 21:08:13 +02:00
19fb7f0b1e
Reported by @tg12 in the external security/correctness audit.
Before this change, /api/live-data/{fast,slow} accepted s/w/n/e query
params but their Query() descriptions explicitly said "(ignored)". The
endpoints shipped the full in-memory world dataset on every poll:
/api/live-data/fast → 16.88 MB
/api/live-data/slow → 10.12 MB
── 27 MB per poll cycle, regardless of zoom
For a node with N operators each polling at the steady 15s/120s cadence,
this is hundreds of MB/minute of outbound traffic that never gets used —
the GPU just culls everything outside the viewport client-side. On a
Tor-bridged or LTE-backed node, that bandwidth bill is the actual cost.
This change makes the existing s/w/n/e params honored — when all four
bounds are supplied, the backend bbox-filters a curated set of heavy,
density-driven, time-sensitive collections to that viewport (with the
existing 20% padding from _bbox_filter):
/fast: commercial_flights, military_flights, private_flights,
private_jets, tracked_flights, ships, cctv, uavs, liveuamap,
gps_jamming, sigint, trains
/slow: gdelt, firms_fires, kiwisdr, scanners, psk_reporter
Static reference layers (satellites, datacenters, military_bases,
power_plants, satnogs, weather, news, stocks, etc.) deliberately STAY
world-scale so panning never reveals an "empty world" of infrastructure.
That preserves the no-hostile-UX feel of the existing dashboard.
Behavior contract:
* Without bbox params (or with a partial bbox), the response is
byte-for-byte identical to the pre-#288 implementation. No
behavior change for any existing caller that hasn't opted in.
* World-scale bbox (lng_span >= 300 or lat_span >= 120) short-circuits
filtering and shares the global ETag — zoomed-out operators all
hit the same 304 cache exactly like before.
* ETag now mixes a 1°-quantized bbox suffix when filtering engages,
so two viewports never poison each other's 304 cache. Sub-degree
pans land in the same ETag bucket (i.e. don't bust the cache on
every mouse drag).
Polling cadence, rate-limit windows, and the 304 short-circuit are all
unchanged. Only the SIZE of the responses changes, and only when the
caller opts in via bounds.
Frontend wiring: useViewportBounds reuses the same coarsened/
expanded bounds it already computes for the AIS /api/viewport POST and
pushes them into a new module-level liveDataViewport store.
useDataPolling reads from that store via appendLiveDataBoundsParams
when building each live-data URL.
Tests cover: no-bbox → world data; bbox → heavy layers filtered;
bbox → reference layers untouched; world-scale bbox → no filter;
partial bbox → treated as no bbox; ETag changes with bbox; sub-degree
pan → same ETag; 304 path works; antimeridian-crossing bbox handled.
Co-authored-by: BigBodyCobain <moatbc@gmail.com>
275 lines
10 KiB
TypeScript
275 lines
10 KiB
TypeScript
import { useEffect, useRef } from "react";
|
|
import { API_BASE } from "@/lib/api";
|
|
import { mergeData, setBackendStatus as setStoreBackendStatus } from "./useDataStore";
|
|
import { appendLiveDataBoundsParams } from "@/lib/liveDataViewport";
|
|
|
|
export type BackendStatus = 'connecting' | 'connected' | 'disconnected';
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Polling pause/resume — used by Time Machine snapshot playback
|
|
// ---------------------------------------------------------------------------
|
|
let _pollingPaused = false;
|
|
let _fastEtagRef: { current: string | null } | null = null;
|
|
let _slowEtagRef: { current: string | null } | null = null;
|
|
|
|
/** Pause live data polling (snapshot mode). */
|
|
export function pausePolling() {
|
|
_pollingPaused = true;
|
|
}
|
|
|
|
/** Resume live data polling and invalidate ETags for a full refresh. */
|
|
export function resumePolling() {
|
|
_pollingPaused = false;
|
|
// Invalidate ETags so the next poll gets fresh data (not 304)
|
|
if (_fastEtagRef) _fastEtagRef.current = null;
|
|
if (_slowEtagRef) _slowEtagRef.current = null;
|
|
}
|
|
|
|
/** Resume live mode and fetch both live tiers immediately instead of waiting for the next poll tick. */
|
|
export async function forceRefreshLiveData(): Promise<void> {
|
|
_pollingPaused = false;
|
|
if (_fastEtagRef) _fastEtagRef.current = null;
|
|
if (_slowEtagRef) _slowEtagRef.current = null;
|
|
|
|
try {
|
|
const [fastRes, slowRes] = await Promise.all([
|
|
fetch(appendLiveDataBoundsParams(`${API_BASE}/api/live-data/fast`)),
|
|
fetch(appendLiveDataBoundsParams(`${API_BASE}/api/live-data/slow`)),
|
|
]);
|
|
|
|
if (fastRes.ok) {
|
|
if (_fastEtagRef) _fastEtagRef.current = fastRes.headers.get('etag') || null;
|
|
mergeData(await fastRes.json());
|
|
}
|
|
if (slowRes.ok) {
|
|
if (_slowEtagRef) _slowEtagRef.current = slowRes.headers.get('etag') || null;
|
|
mergeData(await slowRes.json());
|
|
}
|
|
if (fastRes.ok || slowRes.ok) {
|
|
setStoreBackendStatus('connected');
|
|
}
|
|
} catch (e) {
|
|
console.error("Failed forcing live data refresh", e);
|
|
setStoreBackendStatus('disconnected');
|
|
}
|
|
}
|
|
type FastDataProbe = {
|
|
commercial_flights?: unknown[];
|
|
military_flights?: unknown[];
|
|
tracked_flights?: unknown[];
|
|
ships?: unknown[];
|
|
sigint?: unknown[];
|
|
cctv?: unknown[];
|
|
news?: unknown[];
|
|
threat_level?: unknown;
|
|
};
|
|
|
|
function hasMeaningfulFastData(json: FastDataProbe): boolean {
|
|
return (
|
|
(json.commercial_flights?.length || 0) > 100 ||
|
|
(json.military_flights?.length || 0) > 25 ||
|
|
(json.tracked_flights?.length || 0) > 10 ||
|
|
(json.ships?.length || 0) > 100 ||
|
|
(json.sigint?.length || 0) > 100 ||
|
|
(json.cctv?.length || 0) > 100
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Event name dispatched by page.tsx when a layer toggle changes.
|
|
* useDataPolling listens for this to immediately refetch slow-tier data
|
|
* so toggled layers (power plants, GDELT, etc.) appear without the usual
|
|
* 120-second wait.
|
|
*/
|
|
export const LAYER_TOGGLE_EVENT = 'sb:layer-toggle';
|
|
|
|
/**
|
|
* Polls the backend for fast and slow data tiers.
|
|
*
|
|
* Issue #288: heavy, density-driven layers (vessels, aircraft, gdelt
|
|
* events, fires, sigint, …) are bbox-scoped to the visible map area via
|
|
* `appendLiveDataBoundsParams`. Static reference layers (datacenters,
|
|
* military bases, power plants, satellites, weather, news, …) are NOT
|
|
* filtered backend-side, so panning never reveals an "empty world" of
|
|
* infrastructure. World-zoomed views skip bbox params entirely and hit
|
|
* the shared ETag cache exactly like the pre-#288 behaviour.
|
|
*
|
|
* The AIS stream viewport POST (/api/viewport) is still handled separately
|
|
* by useViewportBounds to limit upstream AIS ingestion.
|
|
*/
|
|
export function useDataPolling() {
|
|
const fastEtag = useRef<string | null>(null);
|
|
const slowEtag = useRef<string | null>(null);
|
|
|
|
useEffect(() => {
|
|
// Expose refs so pausePolling/resumePolling can invalidate ETags
|
|
_fastEtagRef = fastEtag;
|
|
_slowEtagRef = slowEtag;
|
|
|
|
let hasData = false;
|
|
let fetchedStartupFastPayload = false;
|
|
let fastTimerId: ReturnType<typeof setTimeout> | null = null;
|
|
let slowTimerId: ReturnType<typeof setTimeout> | null = null;
|
|
const fastAbortRef = { current: null as AbortController | null };
|
|
const slowAbortRef = { current: null as AbortController | null };
|
|
|
|
const fetchCriticalBootstrap = async () => {
|
|
try {
|
|
const res = await fetch(`${API_BASE}/api/bootstrap/critical`, {
|
|
headers: { Accept: 'application/json' },
|
|
});
|
|
if (res.ok) {
|
|
setStoreBackendStatus('connected');
|
|
const json = await res.json();
|
|
mergeData(json);
|
|
if (hasMeaningfulFastData(json) || (json.news?.length || 0) > 0 || json.threat_level) {
|
|
hasData = true;
|
|
}
|
|
}
|
|
} catch (e) {
|
|
const aborted =
|
|
typeof e === 'object' &&
|
|
e !== null &&
|
|
'name' in e &&
|
|
(e as { name?: string }).name === 'AbortError';
|
|
if (!aborted) {
|
|
console.warn("Critical bootstrap fetch will retry via live polling", e);
|
|
}
|
|
}
|
|
};
|
|
|
|
const fetchFastData = async () => {
|
|
if (fastTimerId) {
|
|
clearTimeout(fastTimerId);
|
|
fastTimerId = null;
|
|
}
|
|
// Skip fetch when Time Machine snapshot mode is active
|
|
if (_pollingPaused) { scheduleNext('fast'); return; }
|
|
if (fastAbortRef.current) return;
|
|
const controller = new AbortController();
|
|
fastAbortRef.current = controller;
|
|
try {
|
|
const useStartupPayload = !fetchedStartupFastPayload && !fastEtag.current;
|
|
const headers: Record<string, string> = {};
|
|
if (!useStartupPayload && fastEtag.current) headers['If-None-Match'] = fastEtag.current;
|
|
const url = appendLiveDataBoundsParams(
|
|
`${API_BASE}/api/live-data/fast${useStartupPayload ? '?initial=1' : ''}`,
|
|
);
|
|
const res = await fetch(url, {
|
|
headers,
|
|
signal: controller.signal,
|
|
});
|
|
if (res.status === 304) {
|
|
setStoreBackendStatus('connected');
|
|
scheduleNext('fast');
|
|
return;
|
|
}
|
|
if (res.ok) {
|
|
setStoreBackendStatus('connected');
|
|
// Do not keep the capped startup ETag. The next steady poll should
|
|
// request the full fast dataset and replace the representative first paint.
|
|
fastEtag.current = useStartupPayload ? null : res.headers.get('etag') || null;
|
|
if (useStartupPayload) fetchedStartupFastPayload = true;
|
|
const json = await res.json();
|
|
mergeData(json);
|
|
if (hasMeaningfulFastData(json)) hasData = true;
|
|
}
|
|
} catch (e) {
|
|
const aborted =
|
|
typeof e === 'object' &&
|
|
e !== null &&
|
|
'name' in e &&
|
|
(e as { name?: string }).name === 'AbortError';
|
|
if (!aborted) {
|
|
console.warn("Fast live data fetch will retry after runtime is reachable", e);
|
|
setStoreBackendStatus('disconnected');
|
|
}
|
|
} finally {
|
|
if (fastAbortRef.current === controller) {
|
|
fastAbortRef.current = null;
|
|
}
|
|
}
|
|
scheduleNext('fast');
|
|
};
|
|
|
|
const fetchSlowData = async () => {
|
|
if (_pollingPaused) { scheduleNext('slow'); return; }
|
|
if (slowAbortRef.current) return;
|
|
const controller = new AbortController();
|
|
slowAbortRef.current = controller;
|
|
try {
|
|
const headers: Record<string, string> = {};
|
|
if (slowEtag.current) headers['If-None-Match'] = slowEtag.current;
|
|
const res = await fetch(
|
|
appendLiveDataBoundsParams(`${API_BASE}/api/live-data/slow`),
|
|
{
|
|
headers,
|
|
signal: controller.signal,
|
|
},
|
|
);
|
|
if (res.status === 304) { scheduleNext('slow'); return; }
|
|
if (res.ok) {
|
|
slowEtag.current = res.headers.get('etag') || null;
|
|
const json = await res.json();
|
|
mergeData(json);
|
|
}
|
|
} catch (e) {
|
|
const aborted =
|
|
typeof e === 'object' &&
|
|
e !== null &&
|
|
'name' in e &&
|
|
(e as { name?: string }).name === 'AbortError';
|
|
if (!aborted) {
|
|
console.warn("Slow live data fetch will retry after runtime is reachable", e);
|
|
}
|
|
} finally {
|
|
if (slowAbortRef.current === controller) {
|
|
slowAbortRef.current = null;
|
|
}
|
|
}
|
|
scheduleNext('slow');
|
|
};
|
|
|
|
// Adaptive polling: retry every 3s during startup, back off to normal cadence once data arrives
|
|
const scheduleNext = (tier: 'fast' | 'slow') => {
|
|
if (tier === 'fast') {
|
|
const delay = hasData ? 15000 : 3000; // 3s startup retry → 15s steady state
|
|
const needsFullFastPayload = fetchedStartupFastPayload && !fastEtag.current;
|
|
fastTimerId = setTimeout(fetchFastData, needsFullFastPayload ? 750 : delay);
|
|
} else {
|
|
const delay = hasData ? 120000 : 5000; // 5s startup retry → 120s steady state
|
|
slowTimerId = setTimeout(fetchSlowData, delay);
|
|
}
|
|
};
|
|
|
|
// When a layer toggle fires, immediately refetch slow data so the user
|
|
// doesn't wait up to 120s for power plants / GDELT / etc. to appear.
|
|
const onLayerToggle = () => {
|
|
slowEtag.current = null; // invalidate ETag → guarantees fresh payload
|
|
if (slowTimerId) clearTimeout(slowTimerId);
|
|
slowTimerId = null;
|
|
fetchSlowData();
|
|
};
|
|
window.addEventListener(LAYER_TOGGLE_EVENT, onLayerToggle);
|
|
|
|
void (async () => {
|
|
await fetchCriticalBootstrap();
|
|
fetchFastData();
|
|
// Let the bootstrap/fast payload paint before competing with the slow tier.
|
|
slowTimerId = setTimeout(fetchSlowData, 5000);
|
|
})();
|
|
|
|
return () => {
|
|
window.removeEventListener(LAYER_TOGGLE_EVENT, onLayerToggle);
|
|
if (fastTimerId) clearTimeout(fastTimerId);
|
|
if (slowTimerId) clearTimeout(slowTimerId);
|
|
if (fastAbortRef.current) fastAbortRef.current.abort();
|
|
if (slowAbortRef.current) slowAbortRef.current.abort();
|
|
};
|
|
}, []);
|
|
|
|
// Data and backend status are now accessed via useDataStore hooks
|
|
// (useDataKey, useDataKeys, useDataSnapshot, useBackendStatus).
|
|
// This hook is a pure side-effect — it starts polling and writes to the store.
|
|
}
|