Target check timeout is 80% of the refresh interval (closes #78)
check / check (push) Successful in 1m55s
check / check (push) Successful in 1m55s
Each target check now times out after 80% of the refresh interval, 24 seconds at 30 seconds, where it was capped at 3 seconds, so slow, far targets are recorded with their real time. Rounds never overlap: a round gives up the last round's checks if they are still waiting, which happens only when a round starts early, after an interval change or when the recovery probe finds a target answering. The probe still checks every half second, giving up its previous checks, so they do not pile up. The frontend has its first unit tests, run by script/frontend-test with Node's built-in test runner on a mocked clock. index.html now links src/styles.css, which src/main.js imported, since Node cannot import CSS. Model: opus-5-5
This commit was merged in pull request #79.
This commit is contained in:
+3
-2
@@ -65,8 +65,9 @@ RUN yarn install --frozen-lockfile
|
|||||||
RUN apk add --no-cache git make
|
RUN apk add --no-cache git make
|
||||||
COPY . .
|
COPY . .
|
||||||
# make frontend-check is the frontend half of make check (test + lint +
|
# make frontend-check is the frontend half of make check (test + lint +
|
||||||
# fmt-check); its test step is the production yarn build, so this both
|
# fmt-check); its test step runs the unit tests, then the production
|
||||||
# produces dist/ and gates the image on lint/fmt-check/test regressions.
|
# yarn build, so this both produces dist/ and gates the image on
|
||||||
|
# lint/fmt-check/test regressions.
|
||||||
# This node stage has neither Go nor Docker; the lint and builder stages
|
# This node stage has neither Go nor Docker; the lint and builder stages
|
||||||
# above gate the backend half.
|
# above gate the backend half.
|
||||||
RUN make frontend-check
|
RUN make frontend-check
|
||||||
|
|||||||
@@ -52,8 +52,8 @@ halves, so the root `make check` fails if either one is broken. We provide:
|
|||||||
- `script/fmt` — format all files (writes): prettier, then gofmt over `backend/`
|
- `script/fmt` — format all files (writes): prettier, then gofmt over `backend/`
|
||||||
- `script/fmt-check` — check formatting (read-only): prettier, then gofmt
|
- `script/fmt-check` — check formatting (read-only): prettier, then gofmt
|
||||||
- `script/check` — run test, lint, and fmt-check
|
- `script/check` — run test, lint, and fmt-check
|
||||||
- `script/frontend-test` — run the production build as the frontend's test (no
|
- `script/frontend-test` — run the unit tests in `test/unit/` with Node's
|
||||||
unit tests yet)
|
built-in test runner, then the production build
|
||||||
- `script/frontend-lint` — run prettier in check mode
|
- `script/frontend-lint` — run prettier in check mode
|
||||||
- `script/frontend-fmt` — format everything prettier understands (writes)
|
- `script/frontend-fmt` — format everything prettier understands (writes)
|
||||||
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
||||||
@@ -136,8 +136,14 @@ Local hosts are tracked separately from WAN stats.
|
|||||||
### Latency measurement
|
### Latency measurement
|
||||||
|
|
||||||
HEAD requests with `mode: 'no-cors'` and `cache: 'no-store'`, timed with
|
HEAD requests with `mode: 'no-cors'` and `cache: 'no-store'`, timed with
|
||||||
`performance.now()`. 1-second timeout; anything over 1000ms is clamped to
|
`performance.now()`. Each check times out after 80% of the refresh interval (24
|
||||||
unreachable. IPv4 only.
|
seconds at 30 seconds) and is then recorded as a timeout, so a round's checks
|
||||||
|
have all finished before the next round is due. When no WAN host answers, a
|
||||||
|
recovery probe checks 4 random WAN hosts every half second, giving up the checks
|
||||||
|
it started half a second before. As soon as one answers, a new round starts at
|
||||||
|
once, as it does after an interval change. A round started early gives up the
|
||||||
|
last round's checks if they are still waiting, and that round records nothing,
|
||||||
|
so rounds never overlap. IPv4 only.
|
||||||
|
|
||||||
### Color coding
|
### Color coding
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,14 @@ latest run passes.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-03: each target check times out after 80% of the refresh interval
|
||||||
|
(issue #78), 24 seconds at 30 seconds, where it was capped at 3 seconds. A
|
||||||
|
round started early, after an interval change or when the recovery probe finds
|
||||||
|
a target answering, gives up the last round's checks if they are still
|
||||||
|
waiting, so rounds never overlap; the recovery probe gives up its own checks
|
||||||
|
after half a second. The frontend has its first unit tests, run by
|
||||||
|
`script/frontend-test` with Node's built-in test runner; for them,
|
||||||
|
`index.html` now links `src/styles.css`, which `src/main.js` used to import
|
||||||
- 2026-09-29: the container sets up its own data directory (issue #75):
|
- 2026-09-29: the container sets up its own data directory (issue #75):
|
||||||
`bin/entrypoint.sh`, still as root, creates `DATA_DIR` if missing and gives it
|
`bin/entrypoint.sh`, still as root, creates `DATA_DIR` if missing and gives it
|
||||||
and `/data` to the `netwatch` user with mode 750 before starting the backend
|
and `/data` to the `netwatch` user with mode 750 before starting the backend
|
||||||
|
|||||||
@@ -9,6 +9,9 @@
|
|||||||
type="image/svg+xml"
|
type="image/svg+xml"
|
||||||
href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>📡</text></svg>"
|
href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>📡</text></svg>"
|
||||||
/>
|
/>
|
||||||
|
<!-- Linked here, not imported by src/main.js, so the unit tests can
|
||||||
|
import that module in Node, which cannot import CSS. -->
|
||||||
|
<link rel="stylesheet" href="/src/styles.css" />
|
||||||
</head>
|
</head>
|
||||||
<body class="bg-gray-900 text-white min-h-screen">
|
<body class="bg-gray-900 text-white min-h-screen">
|
||||||
<div id="app"></div>
|
<div id="app"></div>
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/frontend-test: run the frontend test suite. The frontend has no
|
# script/frontend-test: run the frontend test suite: the unit tests in
|
||||||
# unit tests; the production build serves as the test (fails on broken
|
# test/unit/ with Node's built-in test runner, then the production
|
||||||
# code).
|
# build, which fails on broken code.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
timeout 30 node --test test/unit/*.test.js
|
||||||
timeout 30 yarn build
|
timeout 30 yarn build
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+54
-29
@@ -1,14 +1,14 @@
|
|||||||
import "./styles.css";
|
|
||||||
|
|
||||||
// --- Configuration -----------------------------------------------------------
|
// --- Configuration -----------------------------------------------------------
|
||||||
|
|
||||||
// Timing, axis labels, and display constants. Latency above maxLatency is
|
// Timing, axis labels, and display constants. A target check times out
|
||||||
// clamped to "unreachable". The sparkline Y-axis is capped at
|
// after requestTimeout, 80% of updateInterval, so a round's checks have
|
||||||
|
// all finished before the next round is due; latency above maxLatency is
|
||||||
|
// recorded as a timeout. The sparkline Y-axis is capped at
|
||||||
// graphMaxLatency — values above it pin to the top of the chart but still
|
// graphMaxLatency — values above it pin to the top of the chart but still
|
||||||
// display their real value in the latency figure. The history buffer holds
|
// display their real value in the latency figure. The history buffer holds
|
||||||
// maxHistoryPoints samples (historyDuration / updateInterval).
|
// maxHistoryPoints samples (historyDuration / updateInterval).
|
||||||
// reportInterval is how often collected samples are POSTed to the backend.
|
// reportInterval is how often collected samples are POSTed to the backend.
|
||||||
const CONFIG = {
|
export const CONFIG = {
|
||||||
updateInterval: 3000,
|
updateInterval: 3000,
|
||||||
maxHistoryPoints: 100,
|
maxHistoryPoints: 100,
|
||||||
reportInterval: 60000,
|
reportInterval: 60000,
|
||||||
@@ -16,7 +16,7 @@ const CONFIG = {
|
|||||||
return (this.maxHistoryPoints * this.updateInterval) / 1000;
|
return (this.maxHistoryPoints * this.updateInterval) / 1000;
|
||||||
},
|
},
|
||||||
get requestTimeout() {
|
get requestTimeout() {
|
||||||
return Math.min(this.updateInterval - 100, 3000);
|
return this.updateInterval * 0.8;
|
||||||
},
|
},
|
||||||
get maxLatency() {
|
get maxLatency() {
|
||||||
return this.requestTimeout;
|
return this.requestTimeout;
|
||||||
@@ -503,12 +503,16 @@ class Reporter {
|
|||||||
|
|
||||||
// --- Latency Measurement -----------------------------------------------------
|
// --- Latency Measurement -----------------------------------------------------
|
||||||
|
|
||||||
async function measureLatency(url) {
|
// Checks one target. The check times out after CONFIG.requestTimeout; the
|
||||||
|
// caller can give it up sooner through the optional signal, which also ends
|
||||||
|
// it as a timeout.
|
||||||
|
export async function measureLatency(url, signal) {
|
||||||
const controller = new AbortController();
|
const controller = new AbortController();
|
||||||
const timeoutId = setTimeout(
|
const timeoutId = setTimeout(
|
||||||
() => controller.abort(),
|
() => controller.abort(),
|
||||||
CONFIG.requestTimeout,
|
CONFIG.requestTimeout,
|
||||||
);
|
);
|
||||||
|
signal?.addEventListener("abort", () => controller.abort());
|
||||||
|
|
||||||
const targetUrl = new URL(url);
|
const targetUrl = new URL(url);
|
||||||
targetUrl.searchParams.set("_cb", Date.now().toString());
|
targetUrl.searchParams.set("_cb", Date.now().toString());
|
||||||
@@ -1101,7 +1105,7 @@ function sortAndRebuildWAN(state) {
|
|||||||
|
|
||||||
// --- Main Loop ---------------------------------------------------------------
|
// --- Main Loop ---------------------------------------------------------------
|
||||||
|
|
||||||
async function tick(state, onOffline) {
|
async function tick(state, signal, onOffline) {
|
||||||
const ts = Date.now();
|
const ts = Date.now();
|
||||||
|
|
||||||
if (state.paused) {
|
if (state.paused) {
|
||||||
@@ -1123,11 +1127,12 @@ async function tick(state, onOffline) {
|
|||||||
log.debug(`Tick #${state.tickCount + 1} started`);
|
log.debug(`Tick #${state.tickCount + 1} started`);
|
||||||
|
|
||||||
const results = await Promise.all(
|
const results = await Promise.all(
|
||||||
state.allHosts.map((h) => measureLatency(h.url)),
|
state.allHosts.map((h) => measureLatency(h.url, signal)),
|
||||||
);
|
);
|
||||||
|
|
||||||
// User may have paused while awaiting results — discard them
|
// User may have paused, or the next round may have given up this
|
||||||
if (state.paused) return;
|
// one's checks, while awaiting results — discard them
|
||||||
|
if (state.paused || signal.aborted) return;
|
||||||
|
|
||||||
state.tickCount++;
|
state.tickCount++;
|
||||||
|
|
||||||
@@ -1168,9 +1173,10 @@ async function tick(state, onOffline) {
|
|||||||
|
|
||||||
// --- Recovery Probe ----------------------------------------------------------
|
// --- Recovery Probe ----------------------------------------------------------
|
||||||
|
|
||||||
// When offline, rapidly poll 4 random WAN hosts every 500ms. As soon as any
|
// When offline, check 4 random WAN hosts every 500ms, giving up the checks
|
||||||
// responds, stop probing and fire a normal tick to refresh all hosts.
|
// started 500ms before, so at most 4 are ever waiting. As soon as one
|
||||||
function startRecoveryProbe(state, triggerTick) {
|
// answers, stop probing and start a new round at once.
|
||||||
|
function startRecoveryProbe(state, startRounds) {
|
||||||
if (state._recoveryProbeId) return; // already running
|
if (state._recoveryProbeId) return; // already running
|
||||||
const candidates = [...state.wan];
|
const candidates = [...state.wan];
|
||||||
for (let i = candidates.length - 1; i > 0; i--) {
|
for (let i = candidates.length - 1; i > 0; i--) {
|
||||||
@@ -1181,15 +1187,18 @@ function startRecoveryProbe(state, triggerTick) {
|
|||||||
log.notice(
|
log.notice(
|
||||||
`Recovery probe started (${canaries.map((h) => h.name).join(", ")})`,
|
`Recovery probe started (${canaries.map((h) => h.name).join(", ")})`,
|
||||||
);
|
);
|
||||||
state._recoveryProbeId = setInterval(async () => {
|
state._recoveryProbeId = setInterval(() => {
|
||||||
if (state.paused) return;
|
if (state.paused) return;
|
||||||
const results = await Promise.all(
|
state._recoveryProbeChecks?.abort();
|
||||||
canaries.map((h) => measureLatency(h.url)),
|
const checks = new AbortController();
|
||||||
);
|
state._recoveryProbeChecks = checks;
|
||||||
if (results.some((r) => r.error === null)) {
|
for (const host of canaries) {
|
||||||
log.notice("Recovery probe: connectivity detected");
|
measureLatency(host.url, checks.signal).then((r) => {
|
||||||
stopRecoveryProbe(state);
|
if (r.error !== null || checks.signal.aborted) return;
|
||||||
triggerTick();
|
log.notice("Recovery probe: connectivity detected");
|
||||||
|
stopRecoveryProbe(state);
|
||||||
|
startRounds();
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}, 500);
|
}, 500);
|
||||||
}
|
}
|
||||||
@@ -1198,6 +1207,7 @@ function stopRecoveryProbe(state) {
|
|||||||
if (state._recoveryProbeId) {
|
if (state._recoveryProbeId) {
|
||||||
clearInterval(state._recoveryProbeId);
|
clearInterval(state._recoveryProbeId);
|
||||||
state._recoveryProbeId = null;
|
state._recoveryProbeId = null;
|
||||||
|
state._recoveryProbeChecks?.abort();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1374,18 +1384,34 @@ async function init() {
|
|||||||
updateClocks();
|
updateClocks();
|
||||||
setInterval(updateClocks, 1000);
|
setInterval(updateClocks, 1000);
|
||||||
|
|
||||||
|
// Rounds never overlap: a round first gives up the last round's checks
|
||||||
|
// if they are still waiting, and the last round then records nothing.
|
||||||
|
// At a steady interval they never are, as they time out at 80% of it;
|
||||||
|
// they can be when a round starts early, after an interval change or
|
||||||
|
// when the recovery probe finds a target answering.
|
||||||
|
let roundChecks = new AbortController();
|
||||||
function doTick() {
|
function doTick() {
|
||||||
tick(state, () => startRecoveryProbe(state, doTick));
|
roundChecks.abort();
|
||||||
|
roundChecks = new AbortController();
|
||||||
|
tick(state, roundChecks.signal, () =>
|
||||||
|
startRecoveryProbe(state, startRounds),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
doTick();
|
// Starts a round now and then one every CONFIG.updateInterval.
|
||||||
let tickIntervalId = setInterval(doTick, CONFIG.updateInterval);
|
let tickIntervalId;
|
||||||
|
function startRounds() {
|
||||||
|
clearInterval(tickIntervalId);
|
||||||
|
doTick();
|
||||||
|
tickIntervalId = setInterval(doTick, CONFIG.updateInterval);
|
||||||
|
}
|
||||||
|
|
||||||
|
startRounds();
|
||||||
|
|
||||||
document
|
document
|
||||||
.getElementById("interval-select")
|
.getElementById("interval-select")
|
||||||
.addEventListener("change", (e) => {
|
.addEventListener("change", (e) => {
|
||||||
const newInterval = parseInt(e.target.value, 10);
|
const newInterval = parseInt(e.target.value, 10);
|
||||||
clearInterval(tickIntervalId);
|
|
||||||
CONFIG.updateInterval = newInterval;
|
CONFIG.updateInterval = newInterval;
|
||||||
log.notice(
|
log.notice(
|
||||||
`Interval changed to ${humanDuration(newInterval / 1000)}, history reset`,
|
`Interval changed to ${humanDuration(newInterval / 1000)}, history reset`,
|
||||||
@@ -1434,8 +1460,7 @@ async function init() {
|
|||||||
|
|
||||||
// Start immediately with new interval
|
// Start immediately with new interval
|
||||||
stopRecoveryProbe(state);
|
stopRecoveryProbe(state);
|
||||||
doTick();
|
startRounds();
|
||||||
tickIntervalId = setInterval(doTick, CONFIG.updateInterval);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
window.addEventListener("resize", () => handleResize(state));
|
window.addEventListener("resize", () => handleResize(state));
|
||||||
@@ -1444,7 +1469,7 @@ async function init() {
|
|||||||
|
|
||||||
// Bootstrap only when loaded as the page: a real DOM containing the #app
|
// Bootstrap only when loaded as the page: a real DOM containing the #app
|
||||||
// mount point this module renders into. Importing the module in a unit test
|
// mount point this module renders into. Importing the module in a unit test
|
||||||
// (which has no #app) runs nothing, so buildReport can be tested in isolation.
|
// (which has no #app) runs nothing, so its exports can be tested in isolation.
|
||||||
if (typeof document !== "undefined" && document.getElementById("app")) {
|
if (typeof document !== "undefined" && document.getElementById("app")) {
|
||||||
if (document.readyState === "loading") {
|
if (document.readyState === "loading") {
|
||||||
document.addEventListener("DOMContentLoaded", init);
|
document.addEventListener("DOMContentLoaded", init);
|
||||||
|
|||||||
@@ -0,0 +1,66 @@
|
|||||||
|
// Unit tests for src/main.js, run by script/frontend-test with Node's
|
||||||
|
// built-in test runner. Importing the module does not start the page.
|
||||||
|
|
||||||
|
import { test } from "node:test";
|
||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { CONFIG, measureLatency } from "../../src/main.js";
|
||||||
|
|
||||||
|
// measureLatency writes timeouts to the debug log, which looks for its
|
||||||
|
// panel in the page. There is no page here.
|
||||||
|
globalThis.document = { getElementById: () => null };
|
||||||
|
|
||||||
|
// Mocks the clock for test t, so that a check lasting seconds takes no real
|
||||||
|
// time, and replaces fetch with a target that answers after answerAfter
|
||||||
|
// milliseconds of that clock, or never when answerAfter is Infinity. Both
|
||||||
|
// are restored when the test ends.
|
||||||
|
function mockTarget(t, answerAfter) {
|
||||||
|
t.mock.timers.enable({ apis: ["setTimeout", "Date"] });
|
||||||
|
t.mock.method(performance, "now", () => Date.now());
|
||||||
|
t.mock.method(
|
||||||
|
globalThis,
|
||||||
|
"fetch",
|
||||||
|
(url, { signal }) =>
|
||||||
|
new Promise((resolve, reject) => {
|
||||||
|
if (answerAfter !== Infinity) setTimeout(resolve, answerAfter);
|
||||||
|
signal.addEventListener("abort", () => reject(signal.reason));
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The result of check if it has ended, otherwise "still waiting".
|
||||||
|
function settled(check) {
|
||||||
|
return Promise.race([
|
||||||
|
check,
|
||||||
|
new Promise((resolve) => setImmediate(resolve, "still waiting")),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const interval of [10000, 30000]) {
|
||||||
|
const timeout = interval * 0.8;
|
||||||
|
// Over 3 seconds, which the timeout used to be capped at.
|
||||||
|
const slowAnswer = timeout - 1000;
|
||||||
|
|
||||||
|
test(`at a ${interval}ms interval, an answer after ${slowAnswer}ms is recorded with its real time`, async (t) => {
|
||||||
|
CONFIG.updateInterval = interval;
|
||||||
|
mockTarget(t, slowAnswer);
|
||||||
|
const check = measureLatency("https://target.test");
|
||||||
|
t.mock.timers.tick(slowAnswer);
|
||||||
|
assert.deepEqual(await settled(check), {
|
||||||
|
latency: slowAnswer,
|
||||||
|
error: null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`at a ${interval}ms interval, a target that never answers is recorded as a timeout after ${timeout}ms`, async (t) => {
|
||||||
|
CONFIG.updateInterval = interval;
|
||||||
|
mockTarget(t, Infinity);
|
||||||
|
const check = measureLatency("https://target.test");
|
||||||
|
t.mock.timers.tick(timeout - 1);
|
||||||
|
assert.equal(await settled(check), "still waiting");
|
||||||
|
t.mock.timers.tick(1);
|
||||||
|
assert.deepEqual(await settled(check), {
|
||||||
|
latency: null,
|
||||||
|
error: "timeout",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user