Compare commits
1
Commits
next
..
5c02f6ba62
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5c02f6ba62 |
@@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
title: API Policies
|
|
||||||
last_modified: 2026-10-27
|
|
||||||
---
|
|
||||||
|
|
||||||
A value in an API response is never a string with a label or unit in it. A value
|
|
||||||
of a native type is sent as that type, and its unit goes in the field name, for
|
|
||||||
example `_ms`.
|
|
||||||
|
|
||||||
Wrong:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "execution_time": "0 ms" }
|
|
||||||
```
|
|
||||||
|
|
||||||
Right:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "execution_time_ms": 0 }
|
|
||||||
```
|
|
||||||
+22
-92
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-10-27
|
last_modified: 2026-10-18
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -12,7 +12,6 @@ style conventions are in separate documents:
|
|||||||
- [JavaScript](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_JS.md)
|
- [JavaScript](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_JS.md)
|
||||||
- [Python](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_PYTHON.md)
|
- [Python](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_PYTHON.md)
|
||||||
- [Go HTTP Server Conventions](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/GO_HTTP_SERVER_CONVENTIONS.md)
|
- [Go HTTP Server Conventions](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/GO_HTTP_SERVER_CONVENTIONS.md)
|
||||||
- [API Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/API_POLICIES.md)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -175,32 +174,27 @@ style conventions are in separate documents:
|
|||||||
`script/cibuild`. `script/lint`, `script/test`, `script/cibuild` and
|
`script/cibuild`. `script/lint`, `script/test`, `script/cibuild` and
|
||||||
`script/docker` are the four, and there is no fifth — `script/check` runs the
|
`script/docker` are the four, and there is no fifth — `script/check` runs the
|
||||||
two gate phases and `script/fmt-check`, and builds no image of its own. In
|
two gate phases and `script/fmt-check`, and builds no image of its own. In
|
||||||
every stage of the `Dockerfile`, every step that lints, tests or compiles
|
every stage of the `Dockerfile`, `ARG CACHEBUST` comes right after the steps
|
||||||
comes after `ARG CACHEBUST`. `ARG CACHEBUST` comes right after these steps:
|
that install system packages and download Go's modules, or right after `FROM`
|
||||||
- the steps that install system packages
|
in a stage with neither, and every step that lints, tests or compiles comes
|
||||||
- the steps that download Go's modules
|
after it. A step that installs anything else as well, such as a
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
`script/bootstrap` that also installs node packages, comes after it too. A new
|
||||||
packages from `Pipfile.lock`
|
value reruns every `RUN` step after that line; `COPY` steps are compared by
|
||||||
|
content and need nothing. Docker keeps the layers above the line until the
|
||||||
A stage with none of these steps declares `ARG CACHEBUST` right after
|
base image, their own lines or the files they copy change. A stage without the
|
||||||
`FROM`. A step that installs anything else as well, such as a
|
`ARG` line is served from cache on an unchanged tree, so a repository
|
||||||
`script/bootstrap` that also installs node packages, comes after it too. A
|
re-vendors the scripts and adds the `ARG` lines in one commit. The scripts do
|
||||||
new value reruns every `RUN` step after that line; `COPY` steps are compared
|
not pass `--no-cache`: it reruns every step too, but it also builds the layers
|
||||||
by content and need nothing. Docker keeps the layers above the line until
|
above the line again and empties every cache mount, so Go's build cache and
|
||||||
the base image, their own lines or the files they copy change. A stage
|
golangci-lint's, which the canonical Go `Dockerfile` below mounts so that they
|
||||||
without the `ARG` line is served from cache on an unchanged tree, so a
|
survive between check builds, would start empty every time. A bare
|
||||||
repository re-vendors the scripts and adds the `ARG` lines in one commit.
|
`docker build .` is not evidence that anything ran: a sub-second build
|
||||||
The scripts do not pass `--no-cache`: it reruns every step too, but it also
|
reporting success is a cache hit, not a result. Never invalidate by pruning —
|
||||||
builds the layers above the line again and empties every cache mount, so
|
`docker builder prune` and friends destroy a build cache shared with every
|
||||||
Go's build cache and golangci-lint's, which the canonical Go `Dockerfile`
|
other build on the host. When a check is added or changed, prove it works by
|
||||||
below mounts so that they survive between check builds, would start empty
|
planting a defect it must catch and watching the run fail on it, then revert
|
||||||
every time. A bare `docker build .` is not evidence that anything ran: a
|
the defect. A green run alone shows neither that the check ran nor that it
|
||||||
sub-second build reporting success is a cache hit, not a result. Never
|
covers what it should.
|
||||||
invalidate by pruning — `docker builder prune` and friends destroy a build
|
|
||||||
cache shared with every other build on the host. When a check is added or
|
|
||||||
changed, prove it works by planting a defect it must catch and watching the
|
|
||||||
run fail on it, then revert the defect. A green run alone shows neither that
|
|
||||||
the check ran nor that it covers what it should.
|
|
||||||
|
|
||||||
- **The gate phases are separate stages, and the build stage depends on both.**
|
- **The gate phases are separate stages, and the build stage depends on both.**
|
||||||
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
||||||
@@ -315,9 +309,6 @@ style conventions are in separate documents:
|
|||||||
a package's findings only when the package's files and those of every
|
a package's findings only when the package's files and those of every
|
||||||
package it imports, `go.mod`, the linters and their settings in
|
package it imports, `go.mod`, the linters and their settings in
|
||||||
`.golangci.yml`, and the golangci-lint version are all unchanged.
|
`.golangci.yml`, and the golangci-lint version are all unchanged.
|
||||||
- In a Python `test` phase, the layer of the step that runs
|
|
||||||
`script/bootstrap` to install the packages from `Pipfile.lock`, as
|
|
||||||
described for that phase below.
|
|
||||||
- If the project uses `//go:embed` directives that reference build artifacts
|
- If the project uses `//go:embed` directives that reference build artifacts
|
||||||
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
||||||
create placeholder files so the embed directives resolve. Example:
|
create placeholder files so the embed directives resolve. Example:
|
||||||
@@ -372,67 +363,6 @@ style conventions are in separate documents:
|
|||||||
`--build-arg VERSION=...`, as `script/docker` and `script/cibuild` already
|
`--build-arg VERSION=...`, as `script/docker` and `script/cibuild` already
|
||||||
do.
|
do.
|
||||||
|
|
||||||
- **A Python `test` phase that installs its packages from `Pipfile.lock` does it
|
|
||||||
above `ARG CACHEBUST`, so check builds keep them.** The steps are
|
|
||||||
`COPY script/ script/`, `COPY Pipfile Pipfile.lock ./` and
|
|
||||||
`RUN script/bootstrap`, with `ARG CACHEBUST` right after them. Docker keeps
|
|
||||||
what that `RUN` installed until the base image, `script/`, `Pipfile`,
|
|
||||||
`Pipfile.lock` or a line up to and including the `RUN` changes. The tests run
|
|
||||||
after `ARG CACHEBUST`, on every check build. In every other stage, a step that
|
|
||||||
installs Python packages comes after `ARG CACHEBUST`.
|
|
||||||
- When `script/bootstrap` runs in that step, it installs nothing beyond
|
|
||||||
system packages, pipenv and its dependencies, and the packages from
|
|
||||||
`Pipfile.lock`. It installs no Python there: the tests use the base
|
|
||||||
image's Python, which the image's hash pins. If it installs anything else
|
|
||||||
there, the step goes after `ARG CACHEBUST`.
|
|
||||||
- Every external reference must be pinned by hash, so `script/bootstrap`
|
|
||||||
installs pipenv and its dependencies by hash. It does so with
|
|
||||||
`pip install --require-hashes -r` and a requirements file in `script/`
|
|
||||||
that lists each of them with `==` and its `--hash`. pip refuses to install
|
|
||||||
a dependency the file does not list.
|
|
||||||
- It then runs `pipenv install --deploy`, with `--dev` when the tests need
|
|
||||||
the development packages. `--deploy` installs only what `Pipfile.lock`
|
|
||||||
names, checks every package against the lockfile's hashes, and fails when
|
|
||||||
the lockfile is out of date with `Pipfile`.
|
|
||||||
- A kept layer holds nothing a new install would refuse: pip checked pipenv
|
|
||||||
and its dependencies, and pipenv checked the lockfile's packages, against
|
|
||||||
their hashes. pipenv creates its virtual environment with the `virtualenv`
|
|
||||||
package. The packages that `virtualenv` adds come from wheels inside that
|
|
||||||
package, so the hash pip checked for it covers them. Two things in the
|
|
||||||
layer are not fixed by a hash. A package with no ready-built wheel for the
|
|
||||||
image is built from source. pip downloads the build tools without a hash
|
|
||||||
check, so a kept layer's build of such a package may differ from a new
|
|
||||||
one. And system packages keep the versions the package manager gave when
|
|
||||||
the layer was built; a new install may get newer ones.
|
|
||||||
- As with Go's modules, the packages are kept in a layer, not a cache mount.
|
|
||||||
A cache mount is shared by every build on the host, and nothing checks its
|
|
||||||
files again.
|
|
||||||
|
|
||||||
In this example, `script/bootstrap` finds `make` and `git` already
|
|
||||||
installed, installs pipenv and its dependencies by hash, and runs
|
|
||||||
`pipenv install --dev --deploy`:
|
|
||||||
|
|
||||||
```dockerfile
|
|
||||||
# Test phase. The 90-second timeout covers both pytest runs.
|
|
||||||
# python:3.x-slim, YYYY-MM-DD
|
|
||||||
FROM python@sha256:... AS test
|
|
||||||
# make and git are base tools that script/bootstrap installs when they
|
|
||||||
# are missing. Installed here, they stay in their own layer when
|
|
||||||
# script/ changes.
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends make git \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
WORKDIR /app
|
|
||||||
COPY script/ script/
|
|
||||||
COPY Pipfile Pipfile.lock ./
|
|
||||||
RUN script/bootstrap
|
|
||||||
ARG CACHEBUST
|
|
||||||
COPY . .
|
|
||||||
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
|
||||||
echo "--- Rerunning with -v for details ---"; \
|
|
||||||
pipenv run pytest -v; exit 1; }'
|
|
||||||
```
|
|
||||||
|
|
||||||
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
runs `script/cibuild` on push, and checks out the repo as its only other step,
|
runs `script/cibuild` on push, and checks out the repo as its only other step,
|
||||||
with `persist-credentials: false`: `script/cibuild` needs no token, and
|
with `persist-credentials: false`: `script/cibuild` needs no token, and
|
||||||
|
|||||||
@@ -10,231 +10,114 @@
|
|||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
RouteWatch is pre-1.0, with no git tags. `main` last took `next` on 2026-10-27,
|
pre-1.0. No git tags. `main` last took `next` on 2026-10-06, through
|
||||||
through https://git.eeqj.de/sneak/routewatch/pulls/166.
|
https://git.eeqj.de/sneak/routewatch/pulls/6. The linter and the tests are
|
||||||
https://git.eeqj.de/sneak/routewatch/pulls/202 carries the commits since then
|
phases of the Docker build, and the Gitea workflow runs `script/cibuild` (the
|
||||||
into `main`. It is labelled `merge-ready` and waits for sneak.
|
format check of the Go code and the markdown, both phases, then the image) on
|
||||||
|
every push. The image sets memory ceilings for a 5 GiB container (README
|
||||||
The linter and the tests are phases of the Docker build. The Gitea workflow runs
|
"Memory") and the README says how to run it under upaas (README "Running under
|
||||||
`script/cibuild` on every push. That script runs the two phases and checks the
|
upaas"). A 25-hour run of `a9b6860` on the live feed peaked at about 0.6 GiB
|
||||||
formatting of the Go code and the markdown. Then it builds the image.
|
(https://git.eeqj.de/sneak/routewatch/issues/3). A run of `825afa2` on the live
|
||||||
|
feed found the prefix handler dropping about a quarter of its updates because
|
||||||
The image sets memory ceilings for a 5 GiB container (README "Memory"). README
|
its route writes were slower than the feed
|
||||||
"Running under upaas" says how to run it.
|
(https://git.eeqj.de/sneak/routewatch/issues/96); the cheaper writes since then
|
||||||
|
are measured by a benchmark, not yet on the live feed.
|
||||||
A five-day run of `1c65656` on the live feed, from 2026-10-27 to 2026-11-01,
|
|
||||||
found three problems:
|
|
||||||
|
|
||||||
- The prefix handler dropped updates while a peer's session went down
|
|
||||||
(https://git.eeqj.de/sneak/routewatch/issues/216).
|
|
||||||
- The AS handler dropped updates when the feed burst
|
|
||||||
(https://git.eeqj.de/sneak/routewatch/issues/217).
|
|
||||||
- The WHOIS fetcher kept asking a registry that had refused it
|
|
||||||
(https://git.eeqj.de/sneak/routewatch/issues/218).
|
|
||||||
|
|
||||||
All three are fixed on `next`. So is
|
|
||||||
https://git.eeqj.de/sneak/routewatch/issues/222, which the third fix brought up.
|
|
||||||
A run of `26d939a` on the live feed showed the prefix handler still dropping
|
|
||||||
updates while the home page's cards were worked out.
|
|
||||||
https://git.eeqj.de/sneak/routewatch/issues/226 fixed that on `next`.
|
|
||||||
https://git.eeqj.de/sneak/routewatch/issues/225, also on `next`, takes the peers
|
|
||||||
whose sessions go down together out of the table in one walk. A 24-hour run of
|
|
||||||
`9bd0e91` on the live feed is checking whether any handler still drops updates.
|
|
||||||
|
|
||||||
Two questions wait for sneak: which history the prefix page keeps
|
|
||||||
(https://git.eeqj.de/sneak/routewatch/issues/161), and which fields the IP
|
|
||||||
lookup answer gains (https://git.eeqj.de/sneak/routewatch/issues/203).
|
|
||||||
|
|
||||||
The order of the project's remaining work is kept on
|
|
||||||
https://git.eeqj.de/sneak/routewatch/issues/86.
|
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
Post the outcome of the 24-hour run of `9bd0e91` on
|
Run `next` on the live feed, as README "Running under upaas" describes, until
|
||||||
https://git.eeqj.de/sneak/routewatch/issues/226: whether any handler still drops
|
the routing table stops growing. Post its size and memory figures on
|
||||||
updates, and the process's peak memory against 5 GiB. File an issue for each
|
https://git.eeqj.de/sneak/routewatch/issues/122. The same run makes the final
|
||||||
problem the run finds.
|
check https://git.eeqj.de/sneak/routewatch/issues/96 names: whether the prefix
|
||||||
|
handler still drops updates after the first hour. If it does, a new issue
|
||||||
|
follows with the numbers. Then an audit of the code at the commit that run
|
||||||
|
tested.
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-11-03: the streamer drops an update for a handler only when that
|
- 2026-10-27: every result of the IP lookup has the same fields. A field without
|
||||||
handler's queue is full. It used to drop a random share of the updates once
|
a value is null. It used to be left out. An address with no live route has
|
||||||
the queue was half full. The prefix handler's queue now holds 100,000
|
every route and AS field set to null, and `ptr` is an empty list when there
|
||||||
messages, about 100 MiB. It used to hold 20,000. While the routing table's
|
are no PTR names. New fields give the number of origin ASes of the netblock,
|
||||||
`Overview` walks every prefix, the prefix handler applies updates more slowly.
|
in `num_origins`, and which they are, in `origin_asns` (closes #200)
|
||||||
In a run on the live feed, the feed paused during such a walk and then sent
|
- 2026-10-27: with `TRUSTED_PROXIES` unset, the server trusts reverse proxies at
|
||||||
its backlog. The streamer then dropped about 10,000 of the prefix handler's
|
|
||||||
updates (closes #229)
|
|
||||||
- 2026-11-02: `README.md` is rewritten from scratch, sentence by sentence,
|
|
||||||
against the rules of https://git.eeqj.de/sneak/routewatch/issues/157. Every
|
|
||||||
statement was checked against the code on `next` (closes #157)
|
|
||||||
- 2026-11-02: `TODO.md` is rewritten from scratch, sentence by sentence, against
|
|
||||||
the rules of https://git.eeqj.de/sneak/routewatch/issues/157. Every Completed
|
|
||||||
Steps entry keeps its date, its facts and its issue. Status and Next Step
|
|
||||||
describe the repo as the tracker shows it (part of #157)
|
|
||||||
- 2026-11-02: when the sessions of several peers go down, the prefix handler
|
|
||||||
takes the peers out of the routing table together. The table's `PeersDown`
|
|
||||||
takes several peers out of every prefix in one walk. One walk runs at a time.
|
|
||||||
The next one takes every peer whose session went down since the previous one
|
|
||||||
began. Each peer used to have a walk of its own. A peer's messages stayed held
|
|
||||||
back while the walks queued ahead of its own ran. The handler holds back at
|
|
||||||
most 150,000 messages, about 150 MiB. It used to hold back at most 20,000. The
|
|
||||||
status page shows how many messages the handler holds back (closes #225)
|
|
||||||
- 2026-11-02: working out the home page's cards no longer stops the prefix
|
|
||||||
handler. The walk over the routing table holds the table's lock for 10,000
|
|
||||||
prefixes at a time, then lets the lock go for as long again, as `PeerDown`
|
|
||||||
does. It used to take the lock back at once. The prefix handler then applied
|
|
||||||
about one update per 10,000 prefixes walked. During a walk, its queue could
|
|
||||||
fill, and the streamer then dropped updates for it (closes #226)
|
|
||||||
- 2026-11-02: A skipped WHOIS lookup now makes the fetcher wait longer before
|
|
||||||
the next one, as a failed lookup does. A lookup is skipped when its RIR is
|
|
||||||
paused. An RIR is one of the five regional Internet registries. The longest
|
|
||||||
wait is one minute. The status page does not count a skip as a failure. A skip
|
|
||||||
used to leave the wait as it was. Each lookup asks IANA which RIR holds the AS
|
|
||||||
before it finds that RIR paused. So while most stale ASes belonged to a paused
|
|
||||||
RIR, the fetcher could ask IANA every second (closes #222)
|
|
||||||
- 2026-11-02: A peer's session going down no longer stops the prefix handler.
|
|
||||||
The handler runs the routing table's `PeerDown` on a goroutine of its own, one
|
|
||||||
peer at a time. Meanwhile it goes on taking messages. `PeerDown` holds the
|
|
||||||
table's lock for 10,000 prefixes at a time, then lets the lock go for as long
|
|
||||||
again. The handler holds back the down peer's later messages until that peer's
|
|
||||||
`PeerDown` returns. Then the handler applies them in order, one at a time, and
|
|
||||||
takes new messages in between. It holds back at most 20,000 messages. At that
|
|
||||||
number, `HandleMessage` waits until one of them is applied. When `Stop` runs
|
|
||||||
past its deadline, it logs how many held-back messages were not applied
|
|
||||||
(closes #216)
|
|
||||||
- 2026-11-02: RouteWatch pauses an RIR's or NIC.br's WHOIS server for an hour
|
|
||||||
after the server refuses a query. NIC.br is Brazil's registry. A refused or
|
|
||||||
reset connection is a refusal. So is an answer with an `%ERROR:201:` or
|
|
||||||
`%ERROR:202:` line. Lookups at the other servers go on. An AS whose RIR is
|
|
||||||
paused is looked up after the pause. While NIC.br is paused, a Brazilian AS
|
|
||||||
gets the details from LACNIC's answer. IANA is never paused, because a pause
|
|
||||||
of IANA would stop every lookup. A refusal by IANA is an ordinary failure.
|
|
||||||
NIC.br is also paused for an hour after it says RouteWatch has passed its
|
|
||||||
query limit. Before, the fetcher asked a server again within seconds of a
|
|
||||||
refusal (closes #218)
|
|
||||||
- 2026-11-02: The AS handler never waits for a database write. Its batch holds
|
|
||||||
one entry per AS, with the earliest and the latest time of its updates. So the
|
|
||||||
batch no longer grows with the feed's rate. It used to hold one entry for each
|
|
||||||
AS of each path. At 300,000 entries it waited for the write in progress. In a
|
|
||||||
burst of the feed its queue then filled, and the streamer dropped messages for
|
|
||||||
it (closes #217)
|
|
||||||
- 2026-10-27: The tests of `internal/routewatch` no longer fail on a loaded
|
|
||||||
host. Five of them gave `HandleMessage` two seconds to apply a full prefix
|
|
||||||
batch. Under the race detector that can take longer. A test now waits up to 15
|
|
||||||
seconds for each step it expects. The tests of the handlers' limits now give
|
|
||||||
the handlers small limits. So the package no longer runs past its 90-second
|
|
||||||
limit (closes #213, #215)
|
|
||||||
- 2026-10-27: The server works out the home page's cards every minute until it
|
|
||||||
stops. It used to work them out only once, at startup. The end of the context
|
|
||||||
given to `Start` stopped the refreshes (closes #211)
|
|
||||||
- 2026-10-27: README "Rationale" says why RouteWatch exists. RouteWatch answers
|
|
||||||
our other services' questions about IP addresses, from its own routing table
|
|
||||||
and the WHOIS details it keeps. The section still says what RIS Live does not
|
|
||||||
give (closes #204)
|
|
||||||
- 2026-10-27: Every JSON answer carries `@meta`. A panic on a JSON route answers
|
|
||||||
500 with the JSON error body. `/status.json` and the health check answer 405
|
|
||||||
with the JSON error body to any method they do not take. The 500 and the 405
|
|
||||||
used to have an empty body. The home page's IP lookup shows the whole JSON
|
|
||||||
answer, `@meta` included. It used to show only the answer's `data`, or only
|
|
||||||
the message of an error answer. A test checks `@meta` on every JSON route, in
|
|
||||||
its successes and its errors (closes #201)
|
|
||||||
- 2026-10-27: Every value with a unit in a JSON answer is a number. The unit is
|
|
||||||
at the end of the field name. `@meta.execution_time` is now
|
|
||||||
`execution_time_ms`. In the stats, `uptime` is now `uptime_seconds`,
|
|
||||||
`connection_duration` is now `connection_duration_seconds`, and `memory_usage`
|
|
||||||
is now `memory_usage_bytes`. `whois_stats.current_interval` is now
|
|
||||||
`whois_stats.current_interval_seconds`. They used to be strings such as "12
|
|
||||||
ms", "1h18m34s" or "1.1 GB". `connection_duration_seconds` is null while the
|
|
||||||
feed is not connected. `API_POLICIES.md` is vendored from `sneak/prompts`, and
|
|
||||||
`REPO_POLICIES.md` is re-vendored (closes #199)
|
|
||||||
- 2026-10-27: Every result of the IP lookup has the same fields. A field without
|
|
||||||
a value is null. It used to be left out. An address with no route in the
|
|
||||||
routing table has every route and AS field set to null. `ptr` is an empty list
|
|
||||||
when there are no PTR names. The new field `num_origins` gives the number of
|
|
||||||
origin ASes of the netblock, and `origin_asns` gives which they are (closes
|
|
||||||
#200)
|
|
||||||
- 2026-10-27: With `TRUSTED_PROXIES` unset, the server trusts reverse proxies at
|
|
||||||
the private addresses of RFC 1918. `/ip/`, the home page's `curl` card and the
|
the private addresses of RFC 1918. `/ip/`, the home page's `curl` card and the
|
||||||
request log then give the client's address from `X-Forwarded-For`. They used
|
request log then give the client's address from `X-Forwarded-For`. They used
|
||||||
to give the proxy's address. A list in `TRUSTED_PROXIES` replaces the default.
|
to give the proxy's address. A list in `TRUSTED_PROXIES` replaces the default,
|
||||||
`TRUSTED_PROXIES` set but empty trusts no proxy (closes #198)
|
and `TRUSTED_PROXIES` set but empty trusts no proxy (closes #198)
|
||||||
- 2026-10-27: The home page has cards with figures of the routing table. One
|
- 2026-10-27: the home page has cards with figures of the routing table: the
|
||||||
card shows the newest and the oldest kept route. One shows the newest and the
|
newest and oldest kept route, the newest and oldest updated AS, the AS with
|
||||||
oldest updated AS. One shows the AS with the most prefixes. One shows the ASes
|
the most prefixes, the ASes with a single prefix, and fifteen well-known
|
||||||
with a single prefix. One shows fifteen well-known networks. Two cards count
|
networks. Two cards count the bogon announcements and the prefixes with more
|
||||||
the bogon announcements and the prefixes with more than one origin AS. They
|
than one origin AS, and link to the new pages `/bogons` and
|
||||||
link to the new pages `/bogons` and `/multiple-origins`, which list them. A
|
`/multiple-origins` that list them. A new package, `internal/bogon`, tells
|
||||||
new package, `internal/bogon`, tells which prefixes and AS numbers are
|
which prefixes and AS numbers are reserved. The server works the figures out
|
||||||
reserved. The server works the figures out once a minute (closes #154)
|
once a minute (closes #154)
|
||||||
- 2026-10-27: The per-peer route tables are gone, with the code that wrote,
|
- 2026-10-27: the per-peer route tables are gone, with the code that wrote,
|
||||||
counted and read them. The prefix handler applies each update to the routing
|
counted and read them. The prefix handler applies each update to the routing
|
||||||
table in memory. It writes the table's changes every second. It also stores
|
table in memory and writes the table's changes every second. It also stores
|
||||||
each new prefix with its first-seen time. The image's memory limits fit a full
|
each new prefix with its first-seen time. The image's memory limits are set
|
||||||
routing table of about 1 GB. `GOMEMLIMIT` is 2.5 GiB. The writing connection's
|
for a full routing table of about 1 GB: `GOMEMLIMIT` is 2.5 GiB, the writing
|
||||||
page cache is 512 MiB. SQLite's soft and hard heap limits are 768 MiB and 1
|
connection's page cache 512 MiB, and SQLite's heap limits 768 MiB and 1 GiB
|
||||||
GiB (closes #122)
|
(closes #122)
|
||||||
- 2026-10-27: The pages, the API and the stats read every route from the routing
|
- 2026-10-27: the pages, the API and the stats read every route from the routing
|
||||||
table in memory. For a prefix with several origin ASes, the IP lookup gives
|
table in memory. For a prefix with several origin ASes, the IP lookup gives
|
||||||
the one most peers carry. Its `last_seen` is the newest kept route's time. The
|
the one most peers carry. Its `last_seen` is the newest kept route's time. The
|
||||||
prefix page and API list every peer that carries the prefix. Only the kept
|
prefix page and API list every peer that carries the prefix, with an AS path,
|
||||||
routes show an AS path, a next hop and a time. The stats count the origins
|
next hop and time only for the kept routes. The stats count the origins whose
|
||||||
whose kept routes were all withdrawn, in `origins_without_kept_route` (part of
|
kept routes were all withdrawn, in `origins_without_kept_route` (part of #122)
|
||||||
|
- 2026-10-27: the prefix, AS and peer handlers make a timed write on every tick
|
||||||
|
of their timers, every 1, 2 and 2 seconds. They used to skip every other tick.
|
||||||
|
A full batch's write restarts the timer, so the next timed write comes one
|
||||||
|
interval after that write began (closes #192)
|
||||||
|
- 2026-10-27: once the stop deadline has passed, the AS, peer and peering
|
||||||
|
handlers start no write either. A full batch or a tick of the timer that
|
||||||
|
waited while a write ran past the deadline could still start one. The flush
|
||||||
|
goroutines of the prefix, AS and peer handlers now run the same code (closes
|
||||||
|
#189)
|
||||||
|
- 2026-10-27: once the stop deadline has passed, the prefix handler starts no
|
||||||
|
flush. A batch that filled while a write ran past the deadline could still be
|
||||||
|
written after it (closes #188)
|
||||||
|
- 2026-10-27: the prefix handler applies each update to the routing table in
|
||||||
|
memory, and writes the table's changes to the database every second. A write
|
||||||
|
takes at most 20,000 changed pairs, and the rest follow in the next writes. A
|
||||||
|
failed write is written again later. Startup reads the table before the
|
||||||
|
streamer connects. The pages still read the per-peer route tables (part of
|
||||||
#122)
|
#122)
|
||||||
- 2026-10-27: The prefix, AS and peer handlers make a timed write on every tick
|
- 2026-10-27: the database keeps a copy of the whole routing table in a new
|
||||||
of their timers. The prefix handler's timer ticks every second. The other two
|
|
||||||
tick every two seconds. They used to skip every other tick. A full batch's
|
|
||||||
write restarts the timer. So the next timed write comes one interval after
|
|
||||||
that write began (closes #192)
|
|
||||||
- 2026-10-27: Once the stop deadline has passed, the AS, peer and peering
|
|
||||||
handlers start no write either. Before, a full batch or a timer tick could
|
|
||||||
wait while a write ran past the deadline. Either could then start one more
|
|
||||||
write. The flush goroutines of the prefix, AS and peer handlers now run the
|
|
||||||
same code (closes #189)
|
|
||||||
- 2026-10-27: Once the stop deadline has passed, the prefix handler starts no
|
|
||||||
flush. Before, a batch that filled during a late write could still be written
|
|
||||||
after the deadline (closes #188)
|
|
||||||
- 2026-10-27: The prefix handler applies each update to the routing table in
|
|
||||||
memory. It writes the table's changes to the database every second. A write
|
|
||||||
takes at most 20,000 changed pairs of prefix and origin AS. The rest follow in
|
|
||||||
the next writes. A failed write is written again later. Startup reads the
|
|
||||||
table before the streamer connects. The pages still read the per-peer route
|
|
||||||
tables (part of #122)
|
|
||||||
- 2026-10-27: The database keeps a copy of the whole routing table in a new
|
|
||||||
`routes` table, one row per prefix and origin AS. The peers' numbers are in a
|
`routes` table, one row per prefix and origin AS. The peers' numbers are in a
|
||||||
new `route_peers` table. One function writes the pairs that changed in memory.
|
new `route_peers` table. One function writes the pairs that changed in memory,
|
||||||
Another reads the whole table back into memory at startup. Nothing uses them
|
and another reads the whole table back into memory at startup. Nothing uses
|
||||||
yet (part of #122)
|
them yet (part of #122)
|
||||||
- 2026-10-27: A new package, `internal/routetable`, holds the whole routing
|
- 2026-10-27: a new package, `internal/routetable`, holds the whole routing
|
||||||
table in memory. For each prefix and origin AS it keeps the peers that carry
|
table in memory. For each prefix and origin AS it keeps the peers that carry
|
||||||
it, one bit per peer. It also keeps the two newest of their routes. Nothing
|
it, one bit per peer, and the two newest of their routes. Nothing uses it yet
|
||||||
uses it yet (part of #122)
|
(part of #122)
|
||||||
- 2026-10-27: Each result of the IP lookup lists the public blocklists the
|
- 2026-10-27: each result of the IP lookup lists the public blocklists the
|
||||||
address is on, in `blocklists`. The lists are DShield, Feodo Tracker, two
|
address is on, in `blocklists`. The lists are DShield, Feodo Tracker, two
|
||||||
FireHOL lists, two Spamhaus DROP lists and the Tor exit list. RouteWatch
|
FireHOL lists, Spamhaus DROP and the Tor exit list. RouteWatch downloads each
|
||||||
downloads each list on its own schedule and answers from copies in memory. The
|
list on its own schedule and answers from copies in memory. The copies are
|
||||||
copies are also kept in the state directory's `blocklists` directory. IP
|
also kept in the state directory's `blocklists` directory. IP lookup answers
|
||||||
lookup answers carry `Cache-Control`. An address with no route now has a
|
carry `Cache-Control`. An address with no live route now has a result too,
|
||||||
result too, without route fields. So the IP lookup no longer answers 404
|
without route fields, so the IP lookup no longer answers 404 (closes #158)
|
||||||
(closes #158)
|
- 2026-10-27: the home page has an IP information API card. It shows the `curl`
|
||||||
- 2026-10-27: The home page has an IP information API card. It shows the `curl`
|
command that looks up the visitor's own address at `/ip/{addr}`, and that
|
||||||
command that looks up the visitor's own address at `/ip/{addr}`. It also shows
|
command's live answer (closes #156)
|
||||||
that command's live answer (closes #156)
|
- 2026-10-27: on the AS page, a click on the heading of the IPv4 or the IPv6
|
||||||
- 2026-10-27: On the AS page, a click on the heading of the IPv4 or the IPv6
|
|
||||||
prefix list folds or unfolds the list. Both lists start open (closes #155)
|
prefix list folds or unfolds the list. Both lists start open (closes #155)
|
||||||
- 2026-10-27: The AS page lists its IPv4 and its IPv6 prefixes by mask length,
|
- 2026-10-27: the AS page lists its IPv4 and its IPv6 prefixes by mask length,
|
||||||
shortest first. Prefixes of one mask length are listed by address. They used
|
shortest first, and prefixes of one mask length by address. They used to be
|
||||||
to be sorted by address first, then by mask length (closes #153)
|
listed by address (closes #153)
|
||||||
- 2026-10-27: The connection status on `/` and `/status` gets a spinner. It
|
- 2026-10-27: on `/` and `/status`, a spinner beside the status turns one frame
|
||||||
turns one frame each time the stats show more messages than the time before.
|
each time the stats show more messages than the time before. A page that has
|
||||||
After three refreshes with no new messages, the page shows "stale" in red
|
not seen more messages for three refreshes shows "stale" and the time since
|
||||||
instead. Next to it is the time since the last fresh answer (closes #152)
|
then instead, in red (closes #152)
|
||||||
- 2026-10-27: The WHOIS details of a Brazilian AS keep their accented letters.
|
- 2026-10-27: the WHOIS details of a Brazilian AS keep their accented letters.
|
||||||
LACNIC's answer for such an AS is NIC.br's answer with each accented letter
|
LACNIC's answer for such an AS comes from NIC.br, Brazil's registry, with each
|
||||||
replaced. NIC.br is Brazil's registry. The details now come from NIC.br's own
|
accented letter replaced. The details now come from NIC.br's own server,
|
||||||
server, `whois.registro.br`. When that query fails, the details from LACNIC's
|
`whois.registro.br`. When that query fails, the details from LACNIC's answer
|
||||||
answer are kept and a warning is logged. RouteWatch stops asking NIC.br for an
|
are kept and a warning is logged. After NIC.br answers that RouteWatch is over
|
||||||
hour after NIC.br says RouteWatch is over its query limit (closes #174)
|
its query limit, RouteWatch stops asking NIC.br for an hour (closes #174)
|
||||||
- 2026-10-27: `make asupdate` stops with an error when the download of `as.csv`
|
- 2026-10-27: `make asupdate` stops with an error when the download of `as.csv`
|
||||||
breaks off. The generator used to retry the failed read forever. A record that
|
breaks off. The generator used to retry the failed read forever. A record that
|
||||||
does not parse is still logged and skipped (closes #177)
|
does not parse is still logged and skipped (closes #177)
|
||||||
@@ -243,192 +126,182 @@ problem the run finds.
|
|||||||
one AS. A failed download used to replace the list with an empty file. The
|
one AS. A failed download used to replace the list with an empty file. The
|
||||||
generator reads `as.csv` from `ipverse/as-metadata`, the source's new name
|
generator reads `as.csv` from `ipverse/as-metadata`, the source's new name
|
||||||
(closes #173)
|
(closes #173)
|
||||||
- 2026-10-27: The WHOIS details of an AS at RIPE, APNIC or AFRINIC come only
|
- 2026-10-27: the WHOIS details of an AS at RIPE, APNIC or AFRINIC come only
|
||||||
from its `aut-num` object and the organisation object it names. RIPE and APNIC
|
from its `aut-num` object and the organisation object it names. RIPE and APNIC
|
||||||
start their answer with the `as-block` object of the AS's block. Its dates
|
start their answer with the `as-block` object of the AS's block. Its dates
|
||||||
were stored as the AS's (closes #168)
|
were stored as the AS's (closes #168)
|
||||||
- 2026-10-27: AS names keep their accented letters. The AS list built into
|
- 2026-10-27: AS names keep their accented letters. The AS list built into
|
||||||
RouteWatch is rebuilt from today's `as.csv`, which added a country code
|
RouteWatch is rebuilt from today's `as.csv`, which added a country code
|
||||||
column. That file no longer lists AS 0 or the documentation AS numbers. A
|
column. That file no longer lists AS 0 or the documentation AS numbers. A
|
||||||
WHOIS answer that is not valid UTF-8 is decoded as Latin-1 before it is parsed
|
WHOIS answer that is not valid UTF-8 is decoded as Latin-1, which RIPE and
|
||||||
and stored. RIPE and APNIC send Latin-1 (closes #165)
|
APNIC send, before it is parsed and stored (closes #165)
|
||||||
- 2026-10-27: The Age column on the AS and prefix pages reads in words, such as
|
- 2026-10-27: the Age column on the AS and prefix pages reads in words, such as
|
||||||
"5 minutes ago" or "2 weeks ago". It used to print Go durations such as
|
"5 minutes ago" or "2 weeks ago", instead of Go durations such as "360h0m0s
|
||||||
"360h0m0s ago". An age under a minute reads "now" or in seconds. An age over a
|
ago". An age under a minute reads in seconds, and one over a month in months
|
||||||
month reads in months or years instead of a date (closes #163)
|
or years instead of a date (closes #163)
|
||||||
- 2026-10-26: A write to a stored AS, peering or peer keeps the earlier of the
|
- 2026-10-26: a write to a stored AS, peering or peer keeps the earlier of the
|
||||||
two first-seen times. It keeps the later of the two last-seen times. An old
|
two first-seen times and the later of the two last-seen times. An old update
|
||||||
update from a collector catching up on a backlog no longer moves last seen
|
from a collector catching up on a backlog no longer moves last seen back
|
||||||
back (closes #162)
|
(closes #162)
|
||||||
- 2026-10-26: The status page shows "Route Churn/min". That is the number of
|
- 2026-10-26: the status page shows "Route Churn/min", the number of prefix
|
||||||
prefix announcements and withdrawals from all peers in the last full clock
|
announcements and withdrawals, from all peers, in the last full clock minute.
|
||||||
minute. `/api/v1/stats` reports it as `route_churn_per_min` in `stream`. It
|
`/api/v1/stats` reports it as `route_churn_per_min` in `stream`, which
|
||||||
replaces the moving average `route_churn_per_sec`. The messages and updates
|
replaces the moving average `route_churn_per_sec`. The messages and updates
|
||||||
per second on `/` and `/status` are whole numbers (closes #160)
|
per second on `/` and `/status` are whole numbers (closes #160)
|
||||||
- 2026-10-26: The WHOIS fetcher backs off more slowly. A failure makes its wait
|
- 2026-10-26: the WHOIS fetcher backs off more slowly. A failure makes its wait
|
||||||
1.5 times as long, up to one minute instead of five. Its queries to RIPE,
|
1.5 times as long, up to one minute instead of five. Its queries to RIPE,
|
||||||
APNIC and AFRINIC leave out person and role objects. RIPE counts those objects
|
APNIC and AFRINIC leave out person and role objects, which RIPE counts against
|
||||||
against a daily limit per address. A refused query is logged with the RIR's
|
a daily limit per address. A refused query is logged with the RIR's error line
|
||||||
error line (closes #159)
|
(closes #159)
|
||||||
- 2026-10-26: The home page's AS name search works. It lists the ASes whose
|
- 2026-10-26: the home page's AS name search lists the ASes whose handle or
|
||||||
handle or description holds the text, as links to their pages. The new
|
description holds the text, as links to their pages, from the new
|
||||||
`/api/v1/search/as` answers it. The search ignores case. When the database has
|
`/api/v1/search/as`; the search ignores case. When the database has no record
|
||||||
no record of an AS, its page takes the handle and description from the AS list
|
of an AS, its page takes the handle and description from the AS list built
|
||||||
built into RouteWatch. It still lists the AS's prefixes (closes #151)
|
into RouteWatch and still lists the AS's prefixes (closes #151)
|
||||||
- 2026-10-19: README "HTTP Endpoints" lists every route with what it answers.
|
- 2026-10-19: README "HTTP Endpoints" lists every route with what it answers,
|
||||||
README "Database Schema" matches `schema.sql`. The rest of the README matches
|
"Database Schema" matches `schema.sql`, and the rest of the README matches the
|
||||||
the code. This file is brought up to date (closes #72)
|
code; this file brought up to date (closes #72)
|
||||||
- 2026-10-19: Route writes are cheaper. The live route and prefix tables lose
|
- 2026-10-19: route writes are cheaper: the live route and prefix tables lose
|
||||||
their random UUID keys. The prefix tables lose their duplicate index. A route
|
their random UUID keys and the prefix tables their duplicate index, a route
|
||||||
update sets only the columns that change. Every write goes through one
|
update sets only the columns that change, and every write goes through one
|
||||||
connection with a page cache of 1 GiB (README "Memory"). A benchmark writes
|
connection with a page cache of 1 GiB (README "Memory"). A benchmark writes
|
||||||
the prefix handler's largest batch faster than the feed sends it (closes #96)
|
the prefix handler's largest batch faster than the feed sends it (closes #96)
|
||||||
- 2026-10-19: The checkpoint of the WAL (SQLite's write-ahead log), the
|
- 2026-10-19: the WAL checkpoint, the incremental vacuum and ANALYZE take the
|
||||||
incremental vacuum and `ANALYZE` take the database lock that every batch write
|
database lock every batch write holds, so a vacuum no longer fails with
|
||||||
holds. So a vacuum no longer fails with "database is locked". An `ANALYZE` no
|
"database is locked" and an ANALYZE no longer makes a batch write lose its
|
||||||
longer makes a batch write lose its updates. `ANALYZE` runs as
|
updates; ANALYZE runs as `PRAGMA optimize` with an analysis limit (closes #94)
|
||||||
`PRAGMA optimize` with an analysis limit (closes #94)
|
- 2026-10-19: shutdown stops the streamer first, and each handler writes
|
||||||
- 2026-10-19: Shutdown stops the streamer first. Each handler then writes
|
everything left on its queue before it stops, so the updates waiting there are
|
||||||
everything left on its queue before it stops. So the updates waiting there are
|
|
||||||
no longer lost (closes #69)
|
no longer lost (closes #69)
|
||||||
- 2026-10-19: A path that ends in an AS set of several members has origin AS 0,
|
- 2026-10-19: a path that ends in an AS set of several members has origin AS 0,
|
||||||
which means no known origin. It used to have the set's last member as its
|
no known origin, instead of the set's last member, and the set adds no
|
||||||
origin. The set adds no peerings. The pages show such a route as having no
|
peerings; the pages show such a route as having no known origin (closes #75)
|
||||||
known origin (closes #75)
|
|
||||||
- 2026-10-19: `bgp_peer_count` drops to 0 when the last peer goes down (closes
|
- 2026-10-19: `bgp_peer_count` drops to 0 when the last peer goes down (closes
|
||||||
#92)
|
#92)
|
||||||
- 2026-10-19: `bgp_peer_count` counts every peer the feed has heard from. It
|
- 2026-10-19: `bgp_peer_count` counts every peer the feed has heard from, not
|
||||||
used to count only the peers whose session opened since startup. It drops a
|
only those whose session opened since startup, and drops a peer whose session
|
||||||
peer whose session goes down (closes #74)
|
goes down (closes #74)
|
||||||
- 2026-10-19: The shared files are re-vendored from `sneak/prompts` at
|
- 2026-10-19: the shared files are re-vendored from `sneak/prompts` at
|
||||||
`0653579`. The linter is `golangci-lint` v2.14.0 with its configuration. Lint
|
`0653579`: golangci-lint v2.14.0 and its configuration, lint and test as
|
||||||
and test are `Dockerfile` phases that keep Go's and `golangci-lint`'s caches.
|
`Dockerfile` phases that keep Go's and golangci-lint's caches, markdown
|
||||||
`make fmt` also formats the markdown with `prettier`. The agent guidance moves
|
formatted with prettier, agent guidance in `AGENTS.md`; the code is fixed for
|
||||||
to `AGENTS.md`. The code is fixed for what the new linter configuration finds
|
what the new linter configuration finds (closes #52)
|
||||||
(closes #52)
|
- 2026-10-19: the streamer reads feed lines up to 1 MiB, so a line over 64 KiB
|
||||||
- 2026-10-19: The streamer reads feed lines up to 1 MiB. A line over 64 KiB used
|
no longer ends the connection (closes #76)
|
||||||
to end the connection (closes #76)
|
- 2026-10-19: a peer's live routes are removed when its BGP session goes down;
|
||||||
- 2026-10-19: A peer's live routes are removed when its BGP session goes down.
|
`STATE` messages are never dropped for backpressure, and one that finds its
|
||||||
`STATE` messages are never dropped when a queue is full. One that finds its
|
|
||||||
queue full waits for room ahead of the handler's other messages (closes #56)
|
queue full waits for room ahead of the handler's other messages (closes #56)
|
||||||
- 2026-10-19: The prefix-length pages pick their sample with a bounded number of
|
- 2026-10-19: the prefix-length pages pick their sample with a bounded number of
|
||||||
index lookups. They used to read every route of that length. They list each
|
index lookups instead of reading every route of that length, and list each
|
||||||
prefix once (closes #66)
|
prefix once (closes #66)
|
||||||
- 2026-10-19: A request past its time limit answers 504 instead of 408.
|
- 2026-10-19: a request past its time limit answers 504 instead of 408, and
|
||||||
`/api/v1/stats` answers 504 instead of 500 when its read runs out of time
|
`/api/v1/stats` answers 504 instead of 500 when its read runs out of time
|
||||||
(closes #70)
|
(closes #70)
|
||||||
- 2026-10-19: The AS, peer and prefix handlers write each batch outside the lock
|
- 2026-10-19: the AS, peer and prefix handlers write each batch outside the lock
|
||||||
their message handling needs. So messages keep coming off their queues during
|
their message handling needs, so messages keep coming off their queues during
|
||||||
a write. Meanwhile the next batch grows to at most ten batch sizes (closes
|
a write; meanwhile the next batch grows to at most ten batch sizes (closes
|
||||||
#65)
|
#65)
|
||||||
- 2026-10-19: A live route is identified by prefix and peer. So an announcement
|
- 2026-10-19: a live route is identified by prefix and peer, so an announcement
|
||||||
with a new origin AS replaces the peer's route. A withdrawal removes it
|
with a new origin AS replaces the peer's route and a withdrawal removes it
|
||||||
whatever its origin AS (closes #55)
|
whatever its origin AS (closes #55)
|
||||||
- 2026-10-14: The streamer reconnects when RIS Live ends the stream or sends
|
- 2026-10-14: the streamer reconnects when RIS Live ends the stream or sends
|
||||||
nothing for 60 seconds. The health check reports the feed disconnected
|
nothing for 60 seconds, and the health check reports the feed disconnected
|
||||||
meanwhile (closes #53)
|
meanwhile (closes #53)
|
||||||
- 2026-10-14: The prefix page takes the names of the origin ASes from the prefix
|
- 2026-10-14: the prefix page takes the names of the origin ASes from the prefix
|
||||||
query. It used to read every route of each origin AS (closes #67)
|
query instead of reading every route of each origin AS (closes #67)
|
||||||
- 2026-10-14: The daemon exits with status 1 when its web server cannot listen
|
- 2026-10-14: the daemon exits with status 1 when its web server cannot listen
|
||||||
on its port. It used to run on without a web server (closes #73)
|
on its port, instead of running on without it (closes #73)
|
||||||
- 2026-10-14: The prefix pages parse the prefix before looking it up. One that
|
- 2026-10-14: the prefix pages parse the prefix before looking it up: one that
|
||||||
does not parse answers 400. Any valid way of writing a prefix finds its routes
|
does not parse answers 400, and any valid way of writing a prefix finds its
|
||||||
(closes #71)
|
routes (closes #71)
|
||||||
- 2026-10-14: The IP lookup ignores routes shorter than /8 for IPv4 and /16 for
|
- 2026-10-14: the IP lookup ignores routes shorter than /8 for IPv4 and /16 for
|
||||||
IPv6. So a default route is no longer named as an address's owner (closes #57)
|
IPv6, so a default route is no longer named as an address's owner (closes #57)
|
||||||
- 2026-10-14: A prefix batch keeps each peer's last update for a prefix. It used
|
- 2026-10-14: a prefix batch keeps each peer's last update for a prefix, instead
|
||||||
to keep one update per prefix across all peers (closes #54)
|
of one update per prefix across all peers (closes #54)
|
||||||
- 2026-10-14: `reconnect_count` in `/api/v1/stats` counts every reconnect
|
- 2026-10-14: `reconnect_count` in `/api/v1/stats` counts every reconnect
|
||||||
(closes #68)
|
(closes #68)
|
||||||
- 2026-10-03: `/api/v1/stats` serves the prefix distribution from memory. The
|
- 2026-10-03: `/api/v1/stats` serves the prefix distribution from memory, seeded
|
||||||
distribution is seeded at startup and adjusted on every live-route write. So a
|
at startup and adjusted on every live-route write, so a request no longer
|
||||||
request no longer reads every live route (closes #30)
|
reads every live route (closes #30)
|
||||||
- 2026-10-03: A new database is created with `auto_vacuum` set to incremental.
|
- 2026-10-03: a new database is created with `auto_vacuum` set to incremental,
|
||||||
The setting goes in the connection string, so it is set before the file is
|
through the connection string so it is set before the file is first written,
|
||||||
first written. Each periodic incremental vacuum now returns up to 1000 free
|
and each periodic incremental vacuum now returns up to 1000 free pages; the
|
||||||
pages. The late `PRAGMA auto_vacuum` in `Initialize`, which SQLite ignored, is
|
late `PRAGMA auto_vacuum` in `Initialize`, which SQLite ignored, is gone
|
||||||
gone (closes #43)
|
(closes #43)
|
||||||
- 2026-10-03: Looking up an IP address no longer reads every IPv6 route. Both
|
- 2026-10-03: looking up an IP address no longer reads every IPv6 route: both
|
||||||
families find the most specific live route with at most 33 or 129 lookups on
|
families find the most specific live route with at most 33 or 129 lookups on
|
||||||
the prefix index. The IPv4 range columns are gone. Prefixes from the feed are
|
the prefix index, and the IPv4 range columns are gone. Prefixes from the feed
|
||||||
stored in one text form. So an IPv6 withdrawal, which the feed sends
|
are stored in one text form, so an IPv6 withdrawal, which the feed sends
|
||||||
uncompressed, now removes its route (closes #48)
|
uncompressed, now removes its route (closes #48)
|
||||||
- 2026-10-02: A plain `docker build .` stamps the commit's tag or short commit
|
- 2026-10-02: a plain `docker build .` stamps the commit's tag or short commit
|
||||||
into the page footer. It used to stamp `unknown`. The value comes from
|
(`git describe --tags --always`) into the page footer instead of `unknown`:
|
||||||
`git describe --tags --always`. `.dockerignore` sends `.git` without
|
`.dockerignore` sends `.git` without `.git/config`, a `VERSION` build argument
|
||||||
`.git/config`. A `VERSION` build argument takes precedence. `make build`
|
takes precedence, and `make build` stamps the same value (closes #46)
|
||||||
stamps the same value (closes #46)
|
- 2026-09-29: the entrypoint creates the data directory if it is missing and
|
||||||
- 2026-09-29: The entrypoint creates the data directory if it is missing. It
|
stops the start if a step fails; README "Running under upaas" no longer asks
|
||||||
stops the start if a step fails. README "Running under upaas" no longer asks
|
|
||||||
for the host directory to be created first (closes #42)
|
for the host directory to be created first (closes #42)
|
||||||
- 2026-09-29: `.dockerignore` keeps `.git`, local build output, local databases
|
- 2026-09-29: `.dockerignore` keeps `.git`, local build output, local databases
|
||||||
and `.env` out of the Docker build context. So they stay out of the source
|
and `.env` out of the Docker build context, and so out of the source archive
|
||||||
archive in the image (closes #39)
|
in the image (closes #39)
|
||||||
- 2026-09-29: The README's first line names the MIT licence and the author. The
|
- 2026-09-29: README first line names the MIT license and the author; the
|
||||||
License section says MIT and links `LICENSE`. An Author section is added. This
|
License section now says MIT and links `LICENSE`, and an Author section was
|
||||||
file is brought up to date (closes #38)
|
added; this file brought up to date (closes #38)
|
||||||
- 2026-09-29: `LICENSE` is added, with the MIT licence (closes #1)
|
- 2026-09-29: MIT `LICENSE` (closes #1)
|
||||||
- 2026-09-28: Stopping the daemon while the feed is flowing no longer panics
|
- 2026-09-28: stopping the daemon while the feed is flowing no longer panics
|
||||||
with "send on closed channel". The read loop checks for a stop just before
|
with "send on closed channel": the read loop checks for a stop just before
|
||||||
handing a message to the handler queues. A second `Stop` no longer closes the
|
handing a message to the handler queues, and a second `Stop` no longer closes
|
||||||
queues again (closes #34)
|
the queues again (closes #34)
|
||||||
- 2026-09-28: `docker stop` no longer kills the daemon 2 seconds after the stop
|
- 2026-09-28: `docker stop` no longer kills the daemon 2 seconds after the stop
|
||||||
signal. The entrypoint switches to the `routewatch` user with `setpriv`
|
signal: the entrypoint switches to the `routewatch` user with `setpriv`
|
||||||
instead of `runuser`. So the daemon receives the signal itself. It gets the
|
instead of `runuser`, so the daemon receives the signal itself and gets the
|
||||||
whole wait `docker stop` allows, up to its own 60-second limit (closes #33)
|
whole wait `docker stop` allows, up to its own 60-second limit (closes #33)
|
||||||
- 2026-09-28: RouteWatch is ready to run under upaas. A set but invalid `PORT`,
|
- 2026-09-28: ready to run under upaas: a set but invalid `PORT`,
|
||||||
`XDG_DATA_HOME` or `MALLOC_ARENA_MAX` stops the start. The health check
|
`XDG_DATA_HOME` or `MALLOC_ARENA_MAX` stops the start, the health check
|
||||||
follows `PORT`. README gains a "Running under upaas" section (closes #31)
|
follows `PORT`, README "Running under upaas" section (closes #31)
|
||||||
- 2026-09-22: The database statistics are kept in memory. The counts are seeded
|
- 2026-09-22: realtime in-memory database statistics: counts seeded at startup
|
||||||
at startup and adjusted on every write. The oldest and newest route times come
|
and adjusted on every write, oldest/newest route timestamps via index-end
|
||||||
from a lookup at each end of an index. `/api/v1/stats` no longer scans the
|
lookups; `/api/v1/stats` no longer scans the tables (closes #27)
|
||||||
tables (closes #27)
|
- 2026-09-21: batch writes take the write lock when their transaction begins
|
||||||
- 2026-09-21: Batch writes take the write lock when their transaction begins
|
(`_txlock=immediate`), so they wait out a WAL checkpoint instead of failing
|
||||||
(`_txlock=immediate`). So they wait out a WAL checkpoint instead of failing
|
|
||||||
with "database is locked" (closes #25)
|
with "database is locked" (closes #25)
|
||||||
- 2026-09-21: `MALLOC_ARENA_MAX=2` in the image caps the number of glibc malloc
|
- 2026-09-21: `MALLOC_ARENA_MAX=2` in the image caps glibc malloc arenas, so
|
||||||
arenas. So memory outside the Go runtime no longer grows with the core count
|
memory outside the Go runtime no longer grows with the core count (closes #23)
|
||||||
(closes #23)
|
- 2026-09-21: `GOMEMLIMIT=1536MiB` in the image; README Memory section with the
|
||||||
- 2026-09-21: The image sets `GOMEMLIMIT=1536MiB`. README "Memory" gives the
|
|
||||||
memory budget and the 5 GiB container limit (closes #13)
|
memory budget and the 5 GiB container limit (closes #13)
|
||||||
- 2026-09-21: The four handler queues hold at most 20,000 messages each, down
|
- 2026-09-21: the four handler queues hold at most 20,000 messages each, down
|
||||||
from 100,000 (closes #11)
|
from 100,000 (closes #11)
|
||||||
- 2026-09-21: Two goroutine leaks are fixed. The stats handlers leaked after a
|
- 2026-09-21: two goroutine leaks fixed: the stats handlers after a timeout and
|
||||||
timeout. The streamer's tickers leaked on every reconnect (closes #12)
|
the streamer's tickers on every reconnect (closes #12)
|
||||||
- 2026-09-21: Parsed RIS messages no longer keep the unused `Community` and
|
- 2026-09-21: parsed RIS messages no longer keep the unused `Community` and
|
||||||
`Raw` fields (closes #9)
|
`Raw` fields (closes #9)
|
||||||
- 2026-09-21: `.editorconfig` is added. A Gitea workflow runs `script/cibuild`
|
- 2026-09-21: `.editorconfig`, and a Gitea workflow that runs `script/cibuild`
|
||||||
on every push (closes #14)
|
on every push (closes #14)
|
||||||
- 2026-09-21: The peering handler's AS-path map holds at most 500,000 paths.
|
- 2026-09-21: the peering handler's AS-path map holds at most 500,000 paths and
|
||||||
Every 30 seconds it is swapped for an empty one instead of copied (closes #10)
|
is swapped for an empty one every 30 seconds instead of copied (closes #10)
|
||||||
- 2026-09-21: SQLite's memory is bounded across the whole connection pool. Each
|
- 2026-09-21: SQLite memory bounded across the whole connection pool: a 64 MiB
|
||||||
connection has a 64 MiB page cache. The heap limits are 1 GiB soft and 1.5 GiB
|
page cache on each connection, 1 GiB soft and 1.5 GiB hard heap limits (closes
|
||||||
hard (closes #8)
|
#8)
|
||||||
- 2026-09-21: The Docker build runs the format check, the linter and the tests.
|
- 2026-09-21: the Docker build runs the format check, the linter and the tests,
|
||||||
Linting runs in a separate stage on a `golangci-lint` image pinned by digest
|
linting in a separate stage on a golangci-lint image pinned by digest (closes
|
||||||
(closes #5)
|
#5)
|
||||||
- 2026-09-21: `make test` skips the live feed test, with `-short`. So
|
- 2026-09-21: `make test` skips the live-network feed test (`-short`), so
|
||||||
`make check` no longer depends on the network (closes #2)
|
`make check` no longer depends on the network (closes #2)
|
||||||
- 2026-07-07: The scripts-to-rule-them-all layout is adopted. `script/` holds
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile
|
||||||
the entrypoints. The `Makefile` targets `check`, `test`, `lint`, `fmt` and
|
shims, README Entrypoints section
|
||||||
`fmt-check` call them. So do `bootstrap`, `setup`, `docker` and `hooks`.
|
- 2026-02-22: repo policy compliance: required policy files, .gitignore update,
|
||||||
README gains an "Entrypoints" section
|
Makefile fmt-check/check/docker/hooks targets, gofmt pass
|
||||||
- 2026-02-22: The repo is brought in line with the repo policies. The required
|
(repo-policies-compliance, unmerged)
|
||||||
policy files are added. `.gitignore` is updated. The `Makefile` gains
|
- 2026-01-01: WAL checkpointing: periodic (5s), on startup with logging,
|
||||||
`fmt-check`, `check`, `docker` and `hooks` targets. The Go code is formatted
|
TRUNCATE mode; fixed slow queries
|
||||||
with `gofmt`. The work was on the branch `repo-policies-compliance`, unmerged
|
- 2025-12-31: status page: navbar, home page with search, oldest/newest route
|
||||||
when this entry was written
|
timestamps, NULL handling in WHOIS stats; container runs as routewatch user
|
||||||
- 2026-01-01: The WAL is checkpointed every 5 seconds, and at startup with a log
|
with proper state dir
|
||||||
line. Checkpoints run in `TRUNCATE` mode. This fixed slow queries
|
- 2025-12-30: structured HTTP request logging, increased timeouts, CIDR prefix
|
||||||
- 2025-12-31: The pages get a navigation bar and a home page with a search. The
|
URL routing fixes, status page metrics and footer
|
||||||
status page shows the oldest and newest route times. The WHOIS stats query
|
- 2025-12-29: Dockerfile multi-stage build with source archive; SQLite
|
||||||
handles `NULL`. The container runs as the `routewatch` user with the right
|
incremental vacuum for non-blocking space reclamation
|
||||||
state directory
|
- 2025-07-27: initial RouteWatch BGP stream monitor
|
||||||
- 2025-12-30: HTTP requests are logged as structured log lines. The HTTP
|
|
||||||
timeouts are longer. Prefix URLs with a slash in them route correctly. The
|
|
||||||
status page gets more metrics and a footer
|
|
||||||
- 2025-12-29: The `Dockerfile` builds in stages and puts a source archive in the
|
|
||||||
image. SQLite reclaims space with incremental vacuum, which does not block
|
|
||||||
- 2025-07-27: The first commit: RouteWatch, a BGP stream monitor
|
|
||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
|
None.
|
||||||
|
|||||||
@@ -273,7 +273,7 @@ func TestVacuumReturnsFreePages(t *testing.T) {
|
|||||||
writeTableChanges(t, db, table)
|
writeTableChanges(t, db, table)
|
||||||
|
|
||||||
// The peer going down removes every prefix, and so every row.
|
// The peer going down removes every prefix, and so every row.
|
||||||
table.PeersDown([]string{peerA})
|
table.PeerDown(peerA)
|
||||||
writeTableChanges(t, db, table)
|
writeTableChanges(t, db, table)
|
||||||
|
|
||||||
var before int
|
var before int
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ func TestReadRouteTableGivesBackWhatWasWritten(t *testing.T) {
|
|||||||
|
|
||||||
// A peer moves to another origin, one goes down and a new one comes.
|
// A peer moves to another origin, one goes down and a new one comes.
|
||||||
announceTo(source, tablePrefixV4, asB, peerA, 60)
|
announceTo(source, tablePrefixV4, asB, peerA, 60)
|
||||||
source.PeersDown([]string{peerC})
|
source.PeerDown(peerC)
|
||||||
announceTo(source, tablePrefixV6, asB, peerE, 70)
|
announceTo(source, tablePrefixV6, asB, peerE, 70)
|
||||||
|
|
||||||
writeTableChanges(t, db, source)
|
writeTableChanges(t, db, source)
|
||||||
@@ -133,7 +133,7 @@ func TestReadRouteTableGivesATableThatTakesLaterUpdates(t *testing.T) {
|
|||||||
// another one goes down, and a new peer comes.
|
// another one goes down, and a new peer comes.
|
||||||
for _, table := range []*routetable.Table{source, read} {
|
for _, table := range []*routetable.Table{source, read} {
|
||||||
table.Withdraw(netip.MustParsePrefix(tablePrefixV4), peerA)
|
table.Withdraw(netip.MustParsePrefix(tablePrefixV4), peerA)
|
||||||
table.PeersDown([]string{peerB})
|
table.PeerDown(peerB)
|
||||||
announceTo(table, tablePrefixShortV4, asB, peerD, 50)
|
announceTo(table, tablePrefixShortV4, asB, peerD, 50)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -10,6 +10,10 @@ import (
|
|||||||
"git.eeqj.de/sneak/routewatch/internal/ristypes"
|
"git.eeqj.de/sneak/routewatch/internal/ristypes"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// walkBatch is how many prefixes the walk over the whole table reads in one
|
||||||
|
// hold of the read lock. The updates waiting for the lock get it in between.
|
||||||
|
const walkBatch = 10000
|
||||||
|
|
||||||
// Overview holds figures about the whole table. Working them out takes a walk
|
// Overview holds figures about the whole table. Working them out takes a walk
|
||||||
// over every prefix, so a caller asks for them now and then and keeps them.
|
// over every prefix, so a caller asks for them now and then and keeps them.
|
||||||
type Overview struct {
|
type Overview struct {
|
||||||
@@ -79,9 +83,8 @@ type OriginPeers struct {
|
|||||||
|
|
||||||
// Overview works out the table's overview. It lists at most maxListed bogon
|
// Overview works out the table's overview. It lists at most maxListed bogon
|
||||||
// announcements and at most maxListed prefixes with more than one origin AS:
|
// announcements and at most maxListed prefixes with more than one origin AS:
|
||||||
// the first in prefix order. It visits every prefix in the table, in batches
|
// the first in prefix order. It walks over every prefix, but holds the read
|
||||||
// of walkBatch. After each batch, it lets the table's lock go for as long as
|
// lock for walkBatch prefixes at a time.
|
||||||
// it held the lock for the batch.
|
|
||||||
func (t *Table) Overview(maxListed int) Overview {
|
func (t *Table) Overview(maxListed int) Overview {
|
||||||
var overview Overview
|
var overview Overview
|
||||||
|
|
||||||
@@ -111,18 +114,15 @@ func (t *Table) Overview(maxListed int) Overview {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// walkPrefixes calls visit with every prefix of the table and its origins. It
|
// walkPrefixes calls visit with every prefix of the table and its origins. It
|
||||||
// holds the read lock for walkBatch prefixes at a time. After each batch, it
|
// holds the read lock, but lets it go after every walkBatch prefixes, so the
|
||||||
// lets the table's lock go for as long as it held the lock for the batch.
|
// updates waiting for it get in. A prefix that is added or removed in such a
|
||||||
// During a walk over many batches, updates can then take the lock about half
|
// gap may or may not be visited, as Go allows for a map that changes during a
|
||||||
// of the time. The walk may or may not visit a prefix that is added or removed
|
// range over it. visit must not keep origins once it returns.
|
||||||
// while the lock is let go. Go allows this in a range over a map that changes.
|
|
||||||
// visit must not keep origins once it returns.
|
|
||||||
func (t *Table) walkPrefixes(visit func(prefix netip.Prefix, origins []*origin)) {
|
func (t *Table) walkPrefixes(visit func(prefix netip.Prefix, origins []*origin)) {
|
||||||
t.mu.RLock()
|
t.mu.RLock()
|
||||||
defer t.mu.RUnlock()
|
defer t.mu.RUnlock()
|
||||||
|
|
||||||
visited := 0
|
visited := 0
|
||||||
batchStart := time.Now()
|
|
||||||
|
|
||||||
for _, f := range []*family{&t.ipv4, &t.ipv6} {
|
for _, f := range []*family{&t.ipv4, &t.ipv6} {
|
||||||
for _, prefixes := range f.byLength {
|
for _, prefixes := range f.byLength {
|
||||||
@@ -131,13 +131,8 @@ func (t *Table) walkPrefixes(visit func(prefix netip.Prefix, origins []*origin))
|
|||||||
|
|
||||||
visited++
|
visited++
|
||||||
if visited%walkBatch == 0 {
|
if visited%walkBatch == 0 {
|
||||||
held := time.Since(batchStart)
|
|
||||||
|
|
||||||
t.mu.RUnlock()
|
t.mu.RUnlock()
|
||||||
time.Sleep(held)
|
|
||||||
t.mu.RLock()
|
t.mu.RLock()
|
||||||
|
|
||||||
batchStart = time.Now()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -131,61 +131,3 @@ func TestWalkPrefixesLetsUpdatesIn(t *testing.T) {
|
|||||||
"before its second batch")
|
"before its second batch")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestOverviewLetsUpdatesIn applies another peer's 1,000 announcements while
|
|
||||||
// Overview walks a table with more prefixes than five of the walk's batches.
|
|
||||||
// After each batch, the walk lets the lock go for as long as it held the lock.
|
|
||||||
// So all 1,000 announcements must be applied before Overview returns. A walk
|
|
||||||
// that takes the lock back at once lets in about one update per batch.
|
|
||||||
func TestOverviewLetsUpdatesIn(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
asn = 1000
|
|
||||||
peer = "192.0.2.1"
|
|
||||||
otherPeer = "192.0.2.2"
|
|
||||||
// prefixCount is more prefixes than five of the walk's batches.
|
|
||||||
prefixCount = 5*walkBatch + 1
|
|
||||||
announcements = 1000
|
|
||||||
)
|
|
||||||
|
|
||||||
routeTime := time.Date(2026, 1, 2, 3, 4, 5, 0, time.UTC)
|
|
||||||
table := New(Params{})
|
|
||||||
prefixes := make([]netip.Prefix, 0, prefixCount)
|
|
||||||
addr := netip.MustParseAddr("1.0.0.0")
|
|
||||||
|
|
||||||
for range prefixCount {
|
|
||||||
prefix := netip.PrefixFrom(addr, addr.BitLen())
|
|
||||||
table.Announce(prefix, asn, Route{Peer: peer, Time: routeTime})
|
|
||||||
prefixes = append(prefixes, prefix)
|
|
||||||
addr = addr.Next()
|
|
||||||
}
|
|
||||||
|
|
||||||
overviewDone := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
defer close(overviewDone)
|
|
||||||
|
|
||||||
table.Overview(0)
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Wait until Overview holds the read lock. TryLock fails while a reader
|
|
||||||
// holds it.
|
|
||||||
for table.mu.TryLock() {
|
|
||||||
table.mu.Unlock()
|
|
||||||
runtime.Gosched()
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, prefix := range prefixes[:announcements] {
|
|
||||||
table.Announce(prefix, asn, Route{Peer: otherPeer, Time: routeTime})
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-overviewDone:
|
|
||||||
t.Fatal("Overview returned before another peer's 1,000 announcements " +
|
|
||||||
"were applied")
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
<-overviewDone
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -227,7 +227,7 @@ func TestCounts(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
// peerC was the last peer of the IPv6 prefix. It keeps its number.
|
// peerC was the last peer of the IPv6 prefix. It keeps its number.
|
||||||
table.PeersDown([]string{peerC})
|
table.PeerDown(peerC)
|
||||||
checkCounts(t, table, routetable.Counts{
|
checkCounts(t, table, routetable.Counts{
|
||||||
Pairs: 2,
|
Pairs: 2,
|
||||||
Peers: 3,
|
Peers: 3,
|
||||||
|
|||||||
@@ -27,11 +27,6 @@ const (
|
|||||||
// kept routes in order: each of its nodes holds up to 63 times.
|
// kept routes in order: each of its nodes holds up to 63 times.
|
||||||
keptTimesDegree = 32
|
keptTimesDegree = 32
|
||||||
|
|
||||||
// walkBatch is how many prefixes a walk over the whole table visits in
|
|
||||||
// one hold of the lock. Overview and PeersDown each walk the whole table.
|
|
||||||
// Callers waiting for the lock get it between batches.
|
|
||||||
walkBatch = 10000
|
|
||||||
|
|
||||||
ipv4Bits = 32
|
ipv4Bits = 32
|
||||||
ipv6Bits = 128
|
ipv6Bits = 128
|
||||||
|
|
||||||
@@ -205,60 +200,24 @@ func (t *Table) Withdraw(prefix netip.Prefix, peer string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// PeersDown applies the sessions of peers going down: each of the peers leaves
|
// PeerDown applies a peer's session going down: the peer leaves every peer
|
||||||
// every peer set, and every route of each is dropped. When any of them carries
|
// set, and every route of it is dropped. When the peer carries any prefix, it
|
||||||
// a prefix, PeersDown visits every prefix in the table once, in batches of
|
// visits every prefix in the table.
|
||||||
// walkBatch. After each batch, it lets the table's lock go for as long as it
|
func (t *Table) PeerDown(peer string) {
|
||||||
// held the lock for the batch. During a walk over many batches, reads and
|
|
||||||
// updates can then take the lock about half of the time. An announcement by
|
|
||||||
// one of the peers applied during the walk may be dropped too. So the caller
|
|
||||||
// applies those peers' later updates only once PeersDown has returned.
|
|
||||||
func (t *Table) PeersDown(peers []string) {
|
|
||||||
t.mu.Lock()
|
t.mu.Lock()
|
||||||
defer t.mu.Unlock()
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
// numbers holds the number of each of the peers that carries a prefix.
|
|
||||||
numbers := make([]uint, 0, len(peers))
|
|
||||||
|
|
||||||
for _, peer := range peers {
|
|
||||||
number, known := t.peerNumbers[peer]
|
number, known := t.peerNumbers[peer]
|
||||||
if known && t.peerPrefixes[number] > 0 {
|
if !known || t.peerPrefixes[number] == 0 {
|
||||||
numbers = append(numbers, number)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(numbers) == 0 {
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
visited := 0
|
|
||||||
batchStart := time.Now()
|
|
||||||
|
|
||||||
for _, f := range []*family{&t.ipv4, &t.ipv6} {
|
for _, f := range []*family{&t.ipv4, &t.ipv6} {
|
||||||
for _, prefixes := range f.byLength {
|
for _, prefixes := range f.byLength {
|
||||||
for prefix, origins := range prefixes {
|
for prefix, origins := range prefixes {
|
||||||
for _, number := range numbers {
|
|
||||||
o := originWithPeer(origins, number)
|
o := originWithPeer(origins, number)
|
||||||
if o != nil {
|
if o != nil {
|
||||||
t.leave(prefix, o, number)
|
t.leave(prefix, o, number)
|
||||||
|
|
||||||
// leave may have removed an origin of the
|
|
||||||
// prefix, or the prefix itself.
|
|
||||||
origins = prefixes[prefix]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Go allows the map to change before the next step of
|
|
||||||
// the range over it.
|
|
||||||
visited++
|
|
||||||
if visited%walkBatch == 0 {
|
|
||||||
held := time.Since(batchStart)
|
|
||||||
|
|
||||||
t.mu.Unlock()
|
|
||||||
time.Sleep(held)
|
|
||||||
t.mu.Lock()
|
|
||||||
|
|
||||||
batchStart = time.Now()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
package routetable
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/netip"
|
|
||||||
"runtime"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestPeersDownLetsReadsIn reads the table's counts again and again while a
|
|
||||||
// peer that carries more than two batches of prefixes goes down. PeersDown lets
|
|
||||||
// the lock go after every walkBatch prefixes, so a read must get in while the
|
|
||||||
// peer still carries some of its prefixes but no longer all.
|
|
||||||
func TestPeersDownLetsReadsIn(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
asn = 1000
|
|
||||||
peer = "192.0.2.1"
|
|
||||||
// prefixCount is more prefixes than two of walkBatch.
|
|
||||||
prefixCount = 2*walkBatch + 1
|
|
||||||
)
|
|
||||||
|
|
||||||
routeTime := time.Date(2026, 1, 2, 3, 4, 5, 0, time.UTC)
|
|
||||||
table := New(Params{})
|
|
||||||
addr := netip.MustParseAddr("1.0.0.0")
|
|
||||||
|
|
||||||
for range prefixCount {
|
|
||||||
prefix := netip.PrefixFrom(addr, addr.BitLen())
|
|
||||||
table.Announce(prefix, asn, Route{Peer: peer, Time: routeTime})
|
|
||||||
|
|
||||||
addr = addr.Next()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hold a read lock until PeersDown waits for the lock, so that the first
|
|
||||||
// read below starts once PeersDown holds it. TryRLock fails once a writer
|
|
||||||
// waits.
|
|
||||||
table.mu.RLock()
|
|
||||||
|
|
||||||
peerDownDone := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
defer close(peerDownDone)
|
|
||||||
|
|
||||||
table.PeersDown([]string{peer})
|
|
||||||
}()
|
|
||||||
|
|
||||||
for table.mu.TryRLock() {
|
|
||||||
table.mu.RUnlock()
|
|
||||||
runtime.Gosched()
|
|
||||||
}
|
|
||||||
|
|
||||||
table.mu.RUnlock()
|
|
||||||
|
|
||||||
for {
|
|
||||||
routes := table.Counts().IPv4Routes
|
|
||||||
if routes > 0 && routes < prefixCount {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-peerDownDone:
|
|
||||||
t.Fatal("no read got in while PeersDown ran")
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
<-peerDownDone
|
|
||||||
}
|
|
||||||
@@ -69,10 +69,10 @@ func withdraw(peer string) step {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// peersDown is the step of the sessions of peers going down.
|
// peerDown is the step of peer's session going down.
|
||||||
func peersDown(peers ...string) step {
|
func peerDown(peer string) step {
|
||||||
return func(table *routetable.Table, _ netip.Prefix) {
|
return func(table *routetable.Table, _ netip.Prefix) {
|
||||||
table.PeersDown(peers)
|
table.PeerDown(peer)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -272,28 +272,21 @@ func TestWithdrawalsAndPeerDowns(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "a peer going down leaves the prefix",
|
name: "a peer going down leaves the prefix",
|
||||||
steps: []step{announce(peerA, asA, 10), announce(peerB, asA, 20),
|
steps: []step{announce(peerA, asA, 10), announce(peerB, asA, 20),
|
||||||
peersDown(peerB)},
|
peerDown(peerB)},
|
||||||
want: []routetable.Origin{{ASN: asA, Peers: []string{peerA},
|
want: []routetable.Origin{{ASN: asA, Peers: []string{peerA},
|
||||||
Routes: []routetable.Route{routeOf(peerA, asA, 10)}}},
|
Routes: []routetable.Route{routeOf(peerA, asA, 10)}}},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "a peer going down after it withdrew changes nothing",
|
name: "a peer going down after it withdrew changes nothing",
|
||||||
steps: []step{announce(peerA, asA, 10), announce(peerB, asA, 20),
|
steps: []step{announce(peerA, asA, 10), announce(peerB, asA, 20),
|
||||||
withdraw(peerB), peersDown(peerB)},
|
withdraw(peerB), peerDown(peerB)},
|
||||||
want: []routetable.Origin{{ASN: asA, Peers: []string{peerA},
|
want: []routetable.Origin{{ASN: asA, Peers: []string{peerA},
|
||||||
Routes: []routetable.Route{routeOf(peerA, asA, 10)}}},
|
Routes: []routetable.Route{routeOf(peerA, asA, 10)}}},
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: "peers going down together each leave the prefix",
|
|
||||||
steps: []step{announce(peerA, asA, 10), announce(peerB, asB, 20),
|
|
||||||
announce(peerC, asB, 30), peersDown(peerA, peerB)},
|
|
||||||
want: []routetable.Origin{{ASN: asB, Peers: []string{peerC},
|
|
||||||
Routes: []routetable.Route{routeOf(peerC, asB, 30)}}},
|
|
||||||
},
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPeersDownLeavesEveryPrefix(t *testing.T) {
|
func TestPeerDownLeavesEveryPrefix(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
table := routetable.New(routetable.Params{})
|
table := routetable.New(routetable.Params{})
|
||||||
@@ -310,7 +303,7 @@ func TestPeersDownLeavesEveryPrefix(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
table.Announce(prefixes[0], asB, routeOf(peerB, asB, 20))
|
table.Announce(prefixes[0], asB, routeOf(peerB, asB, 20))
|
||||||
table.PeersDown([]string{peerA})
|
table.PeerDown(peerA)
|
||||||
|
|
||||||
want := []routetable.Origin{{ASN: asB, Peers: []string{peerB},
|
want := []routetable.Origin{{ASN: asB, Peers: []string{peerB},
|
||||||
Routes: []routetable.Route{routeOf(peerB, asB, 20)}}}
|
Routes: []routetable.Route{routeOf(peerB, asB, 20)}}}
|
||||||
@@ -340,32 +333,6 @@ func TestPeersDownLeavesEveryPrefix(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestPeersDownTakesOutPeersOfDifferentPrefixes takes peerA and peerB out in
|
|
||||||
// one PeersDown. peerA carries only prefixV4, and peerB only prefixV6. So
|
|
||||||
// peerA's leaving removes prefixV4 before PeersDown looks for peerB there. Both
|
|
||||||
// prefixes must then be gone.
|
|
||||||
func TestPeersDownTakesOutPeersOfDifferentPrefixes(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
table := routetable.New(routetable.Params{})
|
|
||||||
prefixes := []netip.Prefix{
|
|
||||||
netip.MustParsePrefix(prefixV4),
|
|
||||||
netip.MustParsePrefix(prefixV6),
|
|
||||||
}
|
|
||||||
|
|
||||||
table.Announce(prefixes[0], asA, routeOf(peerA, asA, 10))
|
|
||||||
table.Announce(prefixes[1], asB, routeOf(peerB, asB, 20))
|
|
||||||
table.PeersDown([]string{peerA, peerB})
|
|
||||||
|
|
||||||
for _, prefix := range prefixes {
|
|
||||||
got := table.Origins(prefix)
|
|
||||||
if got != nil {
|
|
||||||
t.Errorf("Origins(%s) = %+v after its only peer went down, want nil",
|
|
||||||
prefix, got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCountsOriginsWithoutKeptRoute(t *testing.T) {
|
func TestCountsOriginsWithoutKeptRoute(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -391,7 +358,7 @@ func TestCountsOriginsWithoutKeptRoute(t *testing.T) {
|
|||||||
{announce(peerC, asA, 30), 0},
|
{announce(peerC, asA, 30), 0},
|
||||||
{withdraw(peerB), 0},
|
{withdraw(peerB), 0},
|
||||||
{withdraw(peerC), 1},
|
{withdraw(peerC), 1},
|
||||||
{peersDown(peerA), 0},
|
{peerDown(peerA), 0},
|
||||||
}
|
}
|
||||||
|
|
||||||
for i, s := range steps {
|
for i, s := range steps {
|
||||||
@@ -497,7 +464,7 @@ func TestTakeChangesHoldsOnlyPairsThatChanged(t *testing.T) {
|
|||||||
checkChanges(t, table, []change{}, map[string]uint{})
|
checkChanges(t, table, []change{}, map[string]uint{})
|
||||||
|
|
||||||
// peerA going down changes v4, the one prefix it carries.
|
// peerA going down changes v4, the one prefix it carries.
|
||||||
table.PeersDown([]string{peerA})
|
table.PeerDown(peerA)
|
||||||
checkChanges(t, table, []change{
|
checkChanges(t, table, []change{
|
||||||
{Prefix: prefixV4, OriginASN: asA, Peers: []uint{1, 2},
|
{Prefix: prefixV4, OriginASN: asA, Peers: []uint{1, 2},
|
||||||
Routes: []routetable.Route{
|
Routes: []routetable.Route{
|
||||||
@@ -506,7 +473,7 @@ func TestTakeChangesHoldsOnlyPairsThatChanged(t *testing.T) {
|
|||||||
}, map[string]uint{})
|
}, map[string]uint{})
|
||||||
|
|
||||||
// peerA, which carries nothing now, goes down again.
|
// peerA, which carries nothing now, goes down again.
|
||||||
table.PeersDown([]string{peerA})
|
table.PeerDown(peerA)
|
||||||
checkChanges(t, table, []change{}, map[string]uint{})
|
checkChanges(t, table, []change{}, map[string]uint{})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -650,7 +617,7 @@ func TestConcurrentUse(t *testing.T) {
|
|||||||
func(round int) { table.Announce(prefix, asA, routeOf(peerA, asA, round)) },
|
func(round int) { table.Announce(prefix, asA, routeOf(peerA, asA, round)) },
|
||||||
func(round int) { table.Announce(prefix, asB, routeOf(peerB, asB, round)) },
|
func(round int) { table.Announce(prefix, asB, routeOf(peerB, asB, round)) },
|
||||||
func(int) { table.Withdraw(prefix, peerA) },
|
func(int) { table.Withdraw(prefix, peerA) },
|
||||||
func(int) { table.PeersDown([]string{peerB}) },
|
func(int) { table.PeerDown(peerB) },
|
||||||
func(int) { table.PutBackChanges(table.TakeChanges(math.MaxInt)) },
|
func(int) { table.PutBackChanges(table.TakeChanges(math.MaxInt)) },
|
||||||
func(int) { table.ChangeCount() },
|
func(int) { table.ChangeCount() },
|
||||||
func(int) { table.Lookup(prefix.Addr()) },
|
func(int) { table.Lookup(prefix.Addr()) },
|
||||||
|
|||||||
@@ -509,6 +509,8 @@ func announcementFeed(prefixes []string) string {
|
|||||||
func TestShutdownWritesTheUpdatesQueuedInTheStreamer(t *testing.T) {
|
func TestShutdownWritesTheUpdatesQueuedInTheStreamer(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
const maxWait = 10 * time.Second
|
||||||
|
|
||||||
prefixes := []string{"192.0.2.0/24", "198.51.100.0/24", "203.0.113.0/24"}
|
prefixes := []string{"192.0.2.0/24", "198.51.100.0/24", "203.0.113.0/24"}
|
||||||
feed := announcementFeed(prefixes)
|
feed := announcementFeed(prefixes)
|
||||||
|
|
||||||
@@ -554,9 +556,9 @@ func TestShutdownWritesTheUpdatesQueuedInTheStreamer(t *testing.T) {
|
|||||||
for range cap(linesSeen) {
|
for range cap(linesSeen) {
|
||||||
select {
|
select {
|
||||||
case <-linesSeen:
|
case <-linesSeen:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(maxWait):
|
||||||
t.Fatalf("the streamer did not read %d lines within %s",
|
t.Fatalf("the streamer did not read %d lines within %s",
|
||||||
cap(linesSeen), stepTimeout)
|
cap(linesSeen), maxWait)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -569,8 +571,8 @@ func TestShutdownWritesTheUpdatesQueuedInTheStreamer(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-shutDown:
|
case <-shutDown:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(maxWait):
|
||||||
t.Fatalf("Shutdown did not return within %s", stepTimeout)
|
t.Fatalf("Shutdown did not return within %s", maxWait)
|
||||||
}
|
}
|
||||||
|
|
||||||
store.mu.Lock()
|
store.mu.Lock()
|
||||||
@@ -607,16 +609,21 @@ func freePort(t *testing.T) int {
|
|||||||
return addr.Port
|
return addr.Port
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestShutdownDoesNotWaitForABlockedWrite starts the HTTP server and has the
|
// TestShutdownReturnsByItsDeadlineWhileAWriteIsBlocked starts the HTTP server
|
||||||
// AS handler start a write that the store holds until the test ends, past
|
// and has the AS handler start a write that the store holds until the test
|
||||||
// Shutdown's deadline. Shutdown must return without waiting for the write, with
|
// ends, past Shutdown's deadline. Shutdown must return within its deadline
|
||||||
// the HTTP server stopped, and must neither checkpoint nor close the database:
|
// plus a small margin, with the HTTP server stopped, and must neither
|
||||||
// the real one would wait for the write.
|
// checkpoint nor close the database: the real one would wait for the write.
|
||||||
// Before the fix Shutdown waited for the write.
|
// Before the fix Shutdown waited for the write.
|
||||||
func TestShutdownDoesNotWaitForABlockedWrite(t *testing.T) {
|
func TestShutdownReturnsByItsDeadlineWhileAWriteIsBlocked(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const deadline = 100 * time.Millisecond
|
const (
|
||||||
|
deadline = 100 * time.Millisecond
|
||||||
|
// margin is how long Shutdown may take after its deadline, to stop
|
||||||
|
// the HTTP server.
|
||||||
|
margin = 2 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
blocking := newBlockingStore()
|
blocking := newBlockingStore()
|
||||||
defer blocking.releaseWrites()
|
defer blocking.releaseWrites()
|
||||||
@@ -644,8 +651,9 @@ func TestShutdownDoesNotWaitForABlockedWrite(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
rw.dbHandler = NewASHandler(store, log)
|
rw.dbHandler = NewASHandler(store, log)
|
||||||
|
fill := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchSize)}
|
||||||
startBlockedWrite(t, blocking, rw.dbHandler,
|
startBlockedWrite(t, blocking, rw.dbHandler,
|
||||||
[]*ristypes.RISMessage{{Path: pathOfASes(asnBatchSize)}})
|
[]*ristypes.RISMessage{{Path: fill}})
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(t.Context(), deadline)
|
ctx, cancel := context.WithTimeout(t.Context(), deadline)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
@@ -659,9 +667,9 @@ func TestShutdownDoesNotWaitForABlockedWrite(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-shutDown:
|
case <-shutDown:
|
||||||
case <-time.After(deadline + stepTimeout):
|
case <-time.After(deadline + margin):
|
||||||
t.Fatalf("Shutdown did not return within %s of its deadline while "+
|
t.Fatalf("Shutdown did not return within %s of its deadline while "+
|
||||||
"a write was blocked", stepTimeout)
|
"a write was blocked", margin)
|
||||||
}
|
}
|
||||||
|
|
||||||
var dialer net.Dialer
|
var dialer net.Dialer
|
||||||
@@ -736,6 +744,8 @@ func (s *closeOrderStore) record(call string) {
|
|||||||
func TestShutdownCheckpointsAndClosesTheDatabaseLast(t *testing.T) {
|
func TestShutdownCheckpointsAndClosesTheDatabaseLast(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
const deadline = 10 * time.Second
|
||||||
|
|
||||||
store := &closeOrderStore{Store: newMockStore()}
|
store := &closeOrderStore{Store: newMockStore()}
|
||||||
log := logger.New()
|
log := logger.New()
|
||||||
cfg := &config.Config{}
|
cfg := &config.Config{}
|
||||||
@@ -753,7 +763,7 @@ func TestShutdownCheckpointsAndClosesTheDatabaseLast(t *testing.T) {
|
|||||||
Path: ristypes.ASPath{Sequence: []int{testASNA}},
|
Path: ristypes.ASPath{Sequence: []int{testASNA}},
|
||||||
})
|
})
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(t.Context(), stepTimeout)
|
ctx, cancel := context.WithTimeout(t.Context(), deadline)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
rw.Shutdown(ctx)
|
rw.Shutdown(ctx)
|
||||||
|
|||||||
@@ -18,34 +18,39 @@ const (
|
|||||||
// (asnBatchTimeout), so a queue smaller than asnBatchSize is fine.
|
// (asnBatchTimeout), so a queue smaller than asnBatchSize is fine.
|
||||||
asHandlerQueueSize = 20000
|
asHandlerQueueSize = 20000
|
||||||
|
|
||||||
// asnBatchSize is the number of ASes in a full batch, which wakes the
|
// asnBatchSize is the number of ASN operations to batch together
|
||||||
// flush goroutine to write it.
|
|
||||||
asnBatchSize = 30000
|
asnBatchSize = 30000
|
||||||
|
|
||||||
|
// asnBatchMaxSize is the most ASN operations the batch holds while the
|
||||||
|
// flush goroutine writes the previous one: ten batches, about 10 MiB
|
||||||
|
// (README "Memory"). At this size HandleMessage waits until the flush
|
||||||
|
// goroutine takes the batch.
|
||||||
|
asnBatchMaxSize = 300000
|
||||||
|
|
||||||
// asnBatchTimeout is the maximum time to wait before flushing a batch
|
// asnBatchTimeout is the maximum time to wait before flushing a batch
|
||||||
// DO NOT reduce this timeout - larger batches are more efficient
|
// DO NOT reduce this timeout - larger batches are more efficient
|
||||||
asnBatchTimeout = 2 * time.Second
|
asnBatchTimeout = 2 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
// ASHandler records every AS in the AS paths of BGP UPDATE messages. Its batch
|
// ASHandler processes Autonomous System Number (ASN) information extracted from
|
||||||
// holds the earliest and the latest time of each AS's updates. The flush
|
// BGP UPDATE messages. It uses batched database operations to efficiently store
|
||||||
// goroutine writes the batch to the database when it holds asnBatchSize ASes,
|
// ASN data, collecting operations into batches that are flushed either when the
|
||||||
// and every asnBatchTimeout.
|
// batch reaches a size threshold or after a timeout period.
|
||||||
type ASHandler struct {
|
type ASHandler struct {
|
||||||
db database.Store
|
db database.Store
|
||||||
logger *logger.Logger
|
logger *logger.Logger
|
||||||
|
|
||||||
// Batching. mu guards batch and writing only. The flush goroutine takes
|
// Batching. mu guards batch and writing only: the flush goroutine takes
|
||||||
// the batch under mu and writes it after releasing mu. So HandleMessage
|
// the batch under mu and writes it after releasing mu, so HandleMessage
|
||||||
// never waits for a database write.
|
// waits for a database write only while batch is at asnBatchMaxSize.
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
// batch holds the earliest and the latest time of the updates for each AS
|
batch []asnOp
|
||||||
// since the flush goroutine last took it. It holds one entry per AS,
|
// writing is how many operations the flush goroutine took from batch
|
||||||
// however many updates arrive.
|
// and has not finished writing.
|
||||||
batch map[int]database.SeenTimes
|
|
||||||
// writing is how many ASes the flush goroutine took from batch and has
|
|
||||||
// not finished writing.
|
|
||||||
writing int
|
writing int
|
||||||
|
// batchTaken is signalled when the flush goroutine takes batch; its L is
|
||||||
|
// &mu.
|
||||||
|
batchTaken sync.Cond
|
||||||
batchFullCh chan struct{} // wakes the flush goroutine when batch is full
|
batchFullCh chan struct{} // wakes the flush goroutine when batch is full
|
||||||
// stopCh hands Stop's context to the flush goroutine. It holds one, so
|
// stopCh hands Stop's context to the flush goroutine. It holds one, so
|
||||||
// Stop does not wait for a write in progress to hand it over.
|
// Stop does not wait for a write in progress to hand it over.
|
||||||
@@ -53,10 +58,16 @@ type ASHandler struct {
|
|||||||
done chan struct{} // closed when the flush goroutine returns
|
done chan struct{} // closed when the flush goroutine returns
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type asnOp struct {
|
||||||
|
number int
|
||||||
|
timestamp time.Time
|
||||||
|
}
|
||||||
|
|
||||||
// NewASHandler creates and returns a new ASHandler instance. It initializes
|
// NewASHandler creates and returns a new ASHandler instance. It initializes
|
||||||
// the batching system and starts a background goroutine that periodically
|
// the batching system and starts a background goroutine that periodically
|
||||||
// writes the collected ASes to the database. The caller must call Stop when
|
// flushes accumulated ASN operations to the database. The caller must call
|
||||||
// finished, to write the pending ASes and end the background goroutine.
|
// Stop when finished to ensure all pending operations are flushed and the
|
||||||
|
// background goroutine is terminated.
|
||||||
func NewASHandler(db database.Store, logger *logger.Logger) *ASHandler {
|
func NewASHandler(db database.Store, logger *logger.Logger) *ASHandler {
|
||||||
return newASHandler(db, logger, asnBatchTimeout)
|
return newASHandler(db, logger, asnBatchTimeout)
|
||||||
}
|
}
|
||||||
@@ -70,11 +81,12 @@ func newASHandler(
|
|||||||
h := &ASHandler{
|
h := &ASHandler{
|
||||||
db: db,
|
db: db,
|
||||||
logger: logger,
|
logger: logger,
|
||||||
batch: make(map[int]database.SeenTimes),
|
batch: make([]asnOp, 0, asnBatchSize),
|
||||||
batchFullCh: make(chan struct{}, 1),
|
batchFullCh: make(chan struct{}, 1),
|
||||||
stopCh: make(chan context.Context, 1),
|
stopCh: make(chan context.Context, 1),
|
||||||
done: make(chan struct{}),
|
done: make(chan struct{}),
|
||||||
}
|
}
|
||||||
|
h.batchTaken.L = &h.mu
|
||||||
|
|
||||||
// Start the flush timer goroutine
|
// Start the flush timer goroutine
|
||||||
go flushLoop(batchTimeout, h.batchFullCh, h.stopCh, h.done, h.flushBatch)
|
go flushLoop(batchTimeout, h.batchFullCh, h.stopCh, h.done, h.flushBatch)
|
||||||
@@ -98,25 +110,48 @@ func (h *ASHandler) QueueCapacity() int {
|
|||||||
return asHandlerQueueSize
|
return asHandlerQueueSize
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleMessage adds the time of msg to the batch entry of each AS in its AS
|
// HandleMessage processes a RIS Live BGP message by extracting all ASNs from
|
||||||
// path, the origin AS and the members of an AS set included. When the batch
|
// the AS path and queuing them for batch insertion into the database. The
|
||||||
// holds asnBatchSize ASes, HandleMessage wakes the flush goroutine to write it.
|
// origin ASN and all transit ASNs are recorded with their associated
|
||||||
|
// timestamps. When the batch reaches the configured size threshold, the flush
|
||||||
|
// goroutine is woken to write it.
|
||||||
func (h *ASHandler) HandleMessage(msg *ristypes.RISMessage) {
|
func (h *ASHandler) HandleMessage(msg *ristypes.RISMessage) {
|
||||||
|
// Use the pre-parsed timestamp
|
||||||
|
timestamp := msg.ParsedTimestamp
|
||||||
|
|
||||||
|
originASN := msg.Path.Origin()
|
||||||
|
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
defer h.mu.Unlock()
|
defer h.mu.Unlock()
|
||||||
|
|
||||||
// The origin AS is the last AS of the sequence, so the loop adds it too.
|
// While the batch is at its maximum size, wait until the flush goroutine
|
||||||
|
// takes it. Meanwhile the handler takes nothing off its queue, which
|
||||||
|
// fills, and the streamer drops messages for it.
|
||||||
|
for len(h.batch) >= asnBatchMaxSize {
|
||||||
|
h.batchTaken.Wait()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Queue origin ASN operation
|
||||||
|
if originASN > 0 {
|
||||||
|
h.batch = append(h.batch, asnOp{
|
||||||
|
number: originASN,
|
||||||
|
timestamp: timestamp,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Also track all ASNs in the path, the members of an AS set included
|
||||||
for _, asn := range slices.Concat(msg.Path.Sequence, msg.Path.Set) {
|
for _, asn := range slices.Concat(msg.Path.Sequence, msg.Path.Set) {
|
||||||
if asn > 0 {
|
if asn > 0 {
|
||||||
seen := h.batch[asn]
|
h.batch = append(h.batch, asnOp{
|
||||||
seen.Add(msg.ParsedTimestamp)
|
number: asn,
|
||||||
h.batch[asn] = seen
|
timestamp: timestamp,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
||||||
// waits in batchFullCh and the batch keeps taking updates until the write
|
// waits in batchFullCh and the batch keeps growing until the write ends
|
||||||
// ends.
|
// or the batch reaches asnBatchMaxSize.
|
||||||
if len(h.batch) >= asnBatchSize {
|
if len(h.batch) >= asnBatchSize {
|
||||||
select {
|
select {
|
||||||
case h.batchFullCh <- struct{}{}:
|
case h.batchFullCh <- struct{}{}:
|
||||||
@@ -125,11 +160,10 @@ func (h *ASHandler) HandleMessage(msg *ristypes.RISMessage) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stop stops the flush goroutine and waits for it until ctx ends. The flush
|
// Stop stops the flush goroutine, which writes the operations the handler holds
|
||||||
// goroutine writes the batch before it returns, unless ctx has ended. A write
|
// before it returns, and waits for it until ctx ends. Once ctx has ended the
|
||||||
// still running when the process exits is lost. Stop logs how many entries are
|
// flush goroutine skips that last write, and a write still running is lost
|
||||||
// not written, in the batch being written and in the next batch. An AS in both
|
// when the process exits, so Stop logs how many operations are not written.
|
||||||
// batches counts twice.
|
|
||||||
func (h *ASHandler) Stop(ctx context.Context) {
|
func (h *ASHandler) Stop(ctx context.Context) {
|
||||||
h.stopCh <- ctx
|
h.stopCh <- ctx
|
||||||
|
|
||||||
@@ -144,14 +178,14 @@ func (h *ASHandler) Stop(ctx context.Context) {
|
|||||||
|
|
||||||
if unwritten > 0 {
|
if unwritten > 0 {
|
||||||
h.logger.Error("Stop deadline passed before the AS handler wrote "+
|
h.logger.Error("Stop deadline passed before the AS handler wrote "+
|
||||||
"its batches", "batch_entries", unwritten)
|
"its updates", "updates", unwritten)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// takeBatch returns the pending ASes and leaves an empty batch in their place
|
// takeBatch returns the pending operations and leaves an empty batch in their
|
||||||
// for HandleMessage to fill. They count in writing until flushBatch has written
|
// place for HandleMessage to fill. They count in writing until flushBatch has
|
||||||
// them.
|
// written them.
|
||||||
func (h *ASHandler) takeBatch() map[int]database.SeenTimes {
|
func (h *ASHandler) takeBatch() []asnOp {
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
defer h.mu.Unlock()
|
defer h.mu.Unlock()
|
||||||
|
|
||||||
@@ -161,7 +195,8 @@ func (h *ASHandler) takeBatch() map[int]database.SeenTimes {
|
|||||||
|
|
||||||
batch := h.batch
|
batch := h.batch
|
||||||
h.writing = len(batch)
|
h.writing = len(batch)
|
||||||
h.batch = make(map[int]database.SeenTimes)
|
h.batch = make([]asnOp, 0, asnBatchSize)
|
||||||
|
h.batchTaken.Broadcast()
|
||||||
|
|
||||||
return batch
|
return batch
|
||||||
}
|
}
|
||||||
@@ -174,11 +209,21 @@ func (h *ASHandler) flushBatch() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The earliest and the latest time the batch saw each AS. The batch holds
|
||||||
|
// several updates for an AS, from many peers, so a new AS is stored first
|
||||||
|
// seen at the earliest of them and last seen at the latest.
|
||||||
|
asns := make(map[int]database.SeenTimes)
|
||||||
|
for _, op := range batch {
|
||||||
|
seen := asns[op.number]
|
||||||
|
seen.Add(op.timestamp)
|
||||||
|
asns[op.number] = seen
|
||||||
|
}
|
||||||
|
|
||||||
// Process all ASNs in a single batch transaction
|
// Process all ASNs in a single batch transaction
|
||||||
err := h.db.GetOrCreateASNBatch(batch)
|
err := h.db.GetOrCreateASNBatch(asns)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.logger.Error("Failed to process ASN batch",
|
h.logger.Error("Failed to process ASN batch",
|
||||||
"error", err, "count", len(batch))
|
"error", err, "count", len(asns))
|
||||||
}
|
}
|
||||||
|
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
|
|||||||
@@ -5,43 +5,28 @@ import (
|
|||||||
"slices"
|
"slices"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"git.eeqj.de/sneak/routewatch/internal/database"
|
|
||||||
"git.eeqj.de/sneak/routewatch/internal/logger"
|
"git.eeqj.de/sneak/routewatch/internal/logger"
|
||||||
"git.eeqj.de/sneak/routewatch/internal/ristypes"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// pathOfASes returns an AS path of n different ASes: AS 1 to AS n. With n up to
|
|
||||||
// asnBatchSize, none of them is testASNA to testASND.
|
|
||||||
func pathOfASes(n int) ristypes.ASPath {
|
|
||||||
sequence := make([]int, n)
|
|
||||||
for i := range sequence {
|
|
||||||
sequence[i] = i + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
return ristypes.ASPath{Sequence: sequence}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestASHandlerStoresTheEarliestAndLatestTimesOfANewAS handles two updates
|
// TestASHandlerStoresTheEarliestAndLatestTimesOfANewAS handles two updates
|
||||||
// whose path carries an AS the database does not hold yet, in one batch into a
|
// whose path carries an AS the database does not hold yet, the second 5
|
||||||
// real database. The second is 5 seconds after the first, and the handler gets
|
// seconds after the first, in one batch into a real database. The AS is stored
|
||||||
// it first. The AS is stored first seen at the time of the first update and
|
// first seen at the time of the first update and last seen at the time of the
|
||||||
// last seen at the time of the second.
|
// second.
|
||||||
func TestASHandlerStoresTheEarliestAndLatestTimesOfANewAS(t *testing.T) {
|
func TestASHandlerStoresTheEarliestAndLatestTimesOfANewAS(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
db := newTestDatabase(t)
|
db := newTestDatabase(t)
|
||||||
|
|
||||||
// Built without NewASHandler's flush goroutine, so the test flushes itself.
|
// Built without NewASHandler's flush goroutine, so the test flushes itself.
|
||||||
h := &ASHandler{
|
h := &ASHandler{db: db, logger: logger.New()}
|
||||||
db: db, logger: logger.New(), batch: make(map[int]database.SeenTimes),
|
|
||||||
}
|
|
||||||
|
|
||||||
first := peerAnnouncement(testPeerIP, testV4Prefix)
|
first := peerAnnouncement(testPeerIP, testV4Prefix)
|
||||||
second := peerAnnouncement(testPeerIP, testV4Prefix)
|
second := peerAnnouncement(testPeerIP, testV4Prefix)
|
||||||
second.ParsedTimestamp = first.ParsedTimestamp.Add(secondUpdateAfter)
|
second.ParsedTimestamp = first.ParsedTimestamp.Add(secondUpdateAfter)
|
||||||
|
|
||||||
h.HandleMessage(second)
|
|
||||||
h.HandleMessage(first)
|
h.HandleMessage(first)
|
||||||
|
h.HandleMessage(second)
|
||||||
h.flushBatch()
|
h.flushBatch()
|
||||||
|
|
||||||
asn, _, err := db.GetAS(t.Context(), testASNA)
|
asn, _, err := db.GetAS(t.Context(), testASNA)
|
||||||
@@ -69,9 +54,7 @@ func TestASHandlerRecordsNothingFromAPathWithASZero(t *testing.T) {
|
|||||||
store := newMockStore()
|
store := newMockStore()
|
||||||
|
|
||||||
// Built without NewASHandler's flush goroutine, so the test flushes itself.
|
// Built without NewASHandler's flush goroutine, so the test flushes itself.
|
||||||
h := &ASHandler{
|
h := &ASHandler{db: store, logger: logger.New()}
|
||||||
db: store, logger: logger.New(), batch: make(map[int]database.SeenTimes),
|
|
||||||
}
|
|
||||||
|
|
||||||
msg := peerAnnouncement(testPeerIP, testV4Prefix)
|
msg := peerAnnouncement(testPeerIP, testV4Prefix)
|
||||||
msg.Path = decodePath(t, testASNA, 0, testASNB)
|
msg.Path = decodePath(t, testASNA, 0, testASNB)
|
||||||
|
|||||||
@@ -187,33 +187,25 @@ func (f *ASNFetcher) recordSuccess() {
|
|||||||
f.statsMu.Unlock()
|
f.statsMu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// lengthenInterval makes the interval 1.5 times as long, up to maxInterval.
|
// recordFailure increases the interval on failed fetch using exponential backoff.
|
||||||
// A failed lookup and a skipped one both lengthen it.
|
func (f *ASNFetcher) recordFailure() {
|
||||||
func (f *ASNFetcher) lengthenInterval() {
|
|
||||||
f.intervalMu.Lock()
|
f.intervalMu.Lock()
|
||||||
defer f.intervalMu.Unlock()
|
f.consecutiveFails++
|
||||||
|
|
||||||
|
// Exponential backoff: multiply by 1.5, capped at max
|
||||||
newInterval := min(
|
newInterval := min(
|
||||||
f.currentInterval*backoffNumerator/backoffDenominator, maxInterval)
|
f.currentInterval*backoffNumerator/backoffDenominator, maxInterval)
|
||||||
|
|
||||||
if newInterval != f.currentInterval {
|
if newInterval != f.currentInterval {
|
||||||
f.logger.Debug("Increased fetch interval",
|
f.logger.Debug("Increased fetch interval due to failure",
|
||||||
"old_interval", f.currentInterval,
|
"old_interval", f.currentInterval,
|
||||||
"new_interval", newInterval,
|
"new_interval", newInterval,
|
||||||
"consecutive_failures", f.consecutiveFails,
|
"consecutive_failures", f.consecutiveFails,
|
||||||
)
|
)
|
||||||
f.currentInterval = newInterval
|
f.currentInterval = newInterval
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// recordFailure counts a failed fetch and lengthens the interval.
|
|
||||||
func (f *ASNFetcher) recordFailure() {
|
|
||||||
f.intervalMu.Lock()
|
|
||||||
f.consecutiveFails++
|
|
||||||
f.intervalMu.Unlock()
|
f.intervalMu.Unlock()
|
||||||
|
|
||||||
f.lengthenInterval()
|
|
||||||
|
|
||||||
// Record error time for stats, dropping those older than statsWindow
|
// Record error time for stats, dropping those older than statsWindow
|
||||||
f.statsMu.Lock()
|
f.statsMu.Lock()
|
||||||
now := f.now()
|
now := f.now()
|
||||||
@@ -295,16 +287,6 @@ func (f *ASNFetcher) fetchNextStale(ctx context.Context) {
|
|||||||
// so the AS stays stale. An AS IANA refers to no RIR is stored with no
|
// so the AS stays stale. An AS IANA refers to no RIR is stored with no
|
||||||
// WHOIS data, so it is not looked up again until it is stale; that counts
|
// WHOIS data, so it is not looked up again until it is stale; that counts
|
||||||
// as neither a success nor a failure.
|
// as neither a success nor a failure.
|
||||||
//
|
|
||||||
// The WHOIS client pauses an RIR's or NIC.br's server for whois.PauseTime
|
|
||||||
// after the server refuses a query. Lookups at the other servers go on. IANA
|
|
||||||
// is never paused, so a refusal by IANA is an ordinary failure. A lookup
|
|
||||||
// whose RIR is paused fails with whois.ErrPaused and is skipped. A skipped
|
|
||||||
// lookup leaves the AS stale and is not counted as a failure. Like a
|
|
||||||
// failure, a skipped lookup lengthens the interval. Each lookup asks IANA
|
|
||||||
// before it finds its RIR paused, so with a one-second interval the fetcher
|
|
||||||
// would ask IANA every second. The lookups that QueueImmediate asks for also
|
|
||||||
// run through fetchAndUpdate.
|
|
||||||
func (f *ASNFetcher) fetchAndUpdate(ctx context.Context, asn int) bool {
|
func (f *ASNFetcher) fetchAndUpdate(ctx context.Context, asn int) bool {
|
||||||
ctx, cancel := context.WithTimeout(ctx, time.Minute)
|
ctx, cancel := context.WithTimeout(ctx, time.Minute)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
@@ -325,14 +307,6 @@ func (f *ASNFetcher) fetchAndUpdate(ctx context.Context, asn int) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if errors.Is(err, whois.ErrPaused) {
|
|
||||||
f.logger.Info("Skipped WHOIS lookup, the RIR's server is paused",
|
|
||||||
"asn", asn, "error", err)
|
|
||||||
f.lengthenInterval()
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
f.logger.Error("WHOIS lookup failed", "asn", asn, "error", err)
|
f.logger.Error("WHOIS lookup failed", "asn", asn, "error", err)
|
||||||
f.recordFailure()
|
f.recordFailure()
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ import (
|
|||||||
|
|
||||||
"git.eeqj.de/sneak/routewatch/internal/database"
|
"git.eeqj.de/sneak/routewatch/internal/database"
|
||||||
"git.eeqj.de/sneak/routewatch/internal/logger"
|
"git.eeqj.de/sneak/routewatch/internal/logger"
|
||||||
"git.eeqj.de/sneak/routewatch/internal/whois"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// The WHOIS servers a lookup asks: IANA first, then the RIR IANA refers it
|
// The WHOIS servers a lookup asks: IANA first, then the RIR IANA refers it
|
||||||
@@ -132,151 +131,6 @@ func TestFetchAndUpdateKeepsTheRowWhenTheLookupFails(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestFetchAndUpdateWaitsOutAPause looks up an AS at RIPE while RIPE refuses
|
|
||||||
// the query. The test sets the WHOIS client's clock. The next lookup comes a
|
|
||||||
// second before whois.PauseTime has passed. It sends RIPE nothing and leaves
|
|
||||||
// the AS never looked up. It counts as neither a success nor a failure. A
|
|
||||||
// lookup at whois.PauseTime asks RIPE again.
|
|
||||||
func TestFetchAndUpdateWaitsOutAPause(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f, db := newFetcherWithWHOISAnswers(t, map[string]string{
|
|
||||||
ianaWHOISServer: ianaRefersToRIPE,
|
|
||||||
ripeWHOISServer: ripeAccessDenied,
|
|
||||||
})
|
|
||||||
|
|
||||||
ripeAsks := 0
|
|
||||||
dial := f.whoisClient.DialContext
|
|
||||||
f.whoisClient.DialContext = func(
|
|
||||||
ctx context.Context, network, address string,
|
|
||||||
) (net.Conn, error) {
|
|
||||||
if address == ripeWHOISServer {
|
|
||||||
ripeAsks++
|
|
||||||
}
|
|
||||||
|
|
||||||
return dial(ctx, network, address)
|
|
||||||
}
|
|
||||||
|
|
||||||
start := time.Date(2026, 11, 2, 0, 0, 0, 0, time.UTC)
|
|
||||||
now := start
|
|
||||||
f.whoisClient.Now = func() time.Time { return now }
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
now = start.Add(whois.PauseTime - time.Second)
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
if ripeAsks != 1 {
|
|
||||||
t.Errorf("RIPE was asked %d times during its pause, want 1", ripeAsks)
|
|
||||||
}
|
|
||||||
|
|
||||||
stats, err := db.GetWHOISStats(t.Context(), whoisStaleThreshold)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetWHOISStats: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if stats.NeverFetched != 1 {
|
|
||||||
t.Errorf("never looked up = %d, want 1", stats.NeverFetched)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := f.GetStats()
|
|
||||||
if got.ConsecutiveFails != 1 || got.ErrorsLastHour != 1 ||
|
|
||||||
got.SuccessesLastHour != 0 {
|
|
||||||
t.Errorf("%d failures in a row, %d errors, %d successes; want 1, 1, 0",
|
|
||||||
got.ConsecutiveFails, got.ErrorsLastHour, got.SuccessesLastHour)
|
|
||||||
}
|
|
||||||
|
|
||||||
now = start.Add(whois.PauseTime)
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
if ripeAsks != 2 {
|
|
||||||
t.Errorf("RIPE was asked %d times after its pause, want 2", ripeAsks)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFetchAndUpdateBacksOffDuringAPause looks up an AS at RIPE while RIPE
|
|
||||||
// refuses the query. The refusal pauses RIPE for an hour, so every later
|
|
||||||
// lookup in the test is skipped. The test sets the WHOIS client's clock and
|
|
||||||
// looks the AS up again each time the interval has passed. Like a failure,
|
|
||||||
// each skip must make the interval 1.5 times as long, up to one minute. The
|
|
||||||
// skips must not count as failures.
|
|
||||||
func TestFetchAndUpdateBacksOffDuringAPause(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f, _ := newFetcherWithWHOISAnswers(t, map[string]string{
|
|
||||||
ianaWHOISServer: ianaRefersToRIPE,
|
|
||||||
ripeWHOISServer: ripeAccessDenied,
|
|
||||||
})
|
|
||||||
|
|
||||||
now := time.Date(2026, 11, 2, 0, 0, 0, 0, time.UTC)
|
|
||||||
f.whoisClient.Now = func() time.Time { return now }
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
for i, want := range []time.Duration{
|
|
||||||
33750 * time.Millisecond,
|
|
||||||
50625 * time.Millisecond,
|
|
||||||
time.Minute,
|
|
||||||
time.Minute,
|
|
||||||
} {
|
|
||||||
now = now.Add(f.getInterval())
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
if got := f.getInterval(); got != want {
|
|
||||||
t.Errorf("interval after %d skipped lookups = %v, want %v",
|
|
||||||
i+1, got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
got := f.GetStats()
|
|
||||||
if got.ConsecutiveFails != 1 || got.ErrorsLastHour != 1 {
|
|
||||||
t.Errorf("%d failures in a row and %d errors, want 1 and 1",
|
|
||||||
got.ConsecutiveFails, got.ErrorsLastHour)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFetchAndUpdateKeepsAskingIANA looks up an AS while IANA's server
|
|
||||||
// refuses the connection. The test sets the WHOIS client's clock. The next
|
|
||||||
// lookup comes a second before whois.PauseTime has passed. IANA is never
|
|
||||||
// paused, so that lookup asks IANA again. Each refusal counts as a failure.
|
|
||||||
func TestFetchAndUpdateKeepsAskingIANA(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// With no answers, every server refuses the connection.
|
|
||||||
f, _ := newFetcherWithWHOISAnswers(t, map[string]string{})
|
|
||||||
|
|
||||||
ianaAsks := 0
|
|
||||||
dial := f.whoisClient.DialContext
|
|
||||||
f.whoisClient.DialContext = func(
|
|
||||||
ctx context.Context, network, address string,
|
|
||||||
) (net.Conn, error) {
|
|
||||||
if address == ianaWHOISServer {
|
|
||||||
ianaAsks++
|
|
||||||
}
|
|
||||||
|
|
||||||
return dial(ctx, network, address)
|
|
||||||
}
|
|
||||||
|
|
||||||
start := time.Date(2026, 11, 2, 0, 0, 0, 0, time.UTC)
|
|
||||||
now := start
|
|
||||||
f.whoisClient.Now = func() time.Time { return now }
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
now = start.Add(whois.PauseTime - time.Second)
|
|
||||||
|
|
||||||
f.fetchAndUpdate(t.Context(), testASNA)
|
|
||||||
|
|
||||||
got := f.GetStats()
|
|
||||||
if ianaAsks != 2 || got.ConsecutiveFails != 2 {
|
|
||||||
t.Errorf("IANA was asked %d times, with %d failures in a row; "+
|
|
||||||
"want 2 and 2", ianaAsks, got.ConsecutiveFails)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRecordStepsTheInterval has the fetcher fail from its base interval of
|
// TestRecordStepsTheInterval has the fetcher fail from its base interval of
|
||||||
// 15 seconds, then succeed. Each failure makes the interval 1.5 times as
|
// 15 seconds, then succeed. Each failure makes the interval 1.5 times as
|
||||||
// long, up to one minute, and each success halves it, down to one second.
|
// long, up to one minute, and each success halves it, down to one second.
|
||||||
@@ -370,7 +224,7 @@ func TestASNFetcherStopReturnsByItsDeadline(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-lookupStarted:
|
case <-lookupStarted:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the fetcher did not start the lookup")
|
t.Fatal("the fetcher did not start the lookup")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -386,22 +240,22 @@ func TestASNFetcherStopReturnsByItsDeadline(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-f.done:
|
case <-f.done:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the fetcher goroutine did not return after the lookup ended")
|
t.Fatal("the fetcher goroutine did not return after the lookup ended")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRecordKeepsOnlyTheStatsWindow records a success and a failure every
|
// TestRecordKeepsOnlyTheStatsWindow records a success and a failure every
|
||||||
// second, by a clock the test sets, for three times statsWindow, and never
|
// second, by a clock the test sets, far longer than statsWindow, and never
|
||||||
// asks for the stats. The fetcher must keep only the times within the last
|
// asks for the stats. The fetcher must keep only the times within the last
|
||||||
// statsWindow.
|
// statsWindow.
|
||||||
func TestRecordKeepsOnlyTheStatsWindow(t *testing.T) {
|
func TestRecordKeepsOnlyTheStatsWindow(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
records = 100_000
|
||||||
step = time.Second
|
step = time.Second
|
||||||
want = int(statsWindow / step)
|
want = int(statsWindow / step)
|
||||||
records = 3 * want
|
|
||||||
)
|
)
|
||||||
|
|
||||||
clock := time.Now()
|
clock := time.Now()
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"slices"
|
"slices"
|
||||||
"sync"
|
"sync"
|
||||||
@@ -20,15 +19,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// stepTimeout is how long a test waits for a step it expects, such as
|
// handleMessageTimeout is how long a test waits for HandleMessage to
|
||||||
// HandleMessage returning, a write starting or Shutdown returning, before
|
// return, or for a write to start, before it fails.
|
||||||
// it fails. Only a step that never comes should reach it. On a loaded
|
handleMessageTimeout = 2 * time.Second
|
||||||
// host, under the race detector, HandleMessage takes seconds to apply a
|
|
||||||
// full prefix batch. The helpers below bound every wait with it, Stop
|
|
||||||
// included. A test that hangs in one of them waits out at most two of
|
|
||||||
// these bounds, its step's and Stop's, and then fails with its own
|
|
||||||
// message. That leaves time before go test's 90-second timeout.
|
|
||||||
stepTimeout = 15 * time.Second
|
|
||||||
|
|
||||||
// stillWaitingAfter is how long a test watches a HandleMessage that must
|
// stillWaitingAfter is how long a test watches a HandleMessage that must
|
||||||
// wait. One that does not wait returns well within it.
|
// wait. One that does not wait returns well within it.
|
||||||
@@ -178,14 +171,12 @@ type stopLog struct {
|
|||||||
Msg string `json:"msg"`
|
Msg string `json:"msg"`
|
||||||
Updates int `json:"updates"`
|
Updates int `json:"updates"`
|
||||||
TableChanges int `json:"table_changes"`
|
TableChanges int `json:"table_changes"`
|
||||||
HeldMessages int `json:"held_messages"`
|
|
||||||
Paths int `json:"paths"`
|
Paths int `json:"paths"`
|
||||||
BatchEntries int `json:"batch_entries"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// newErrorLogger returns a logger that writes only errors, as JSON lines, to
|
// newErrorLogger returns a logger that writes only errors, as JSON lines, to
|
||||||
// logs.
|
// logs.
|
||||||
func newErrorLogger(logs io.Writer) *logger.Logger {
|
func newErrorLogger(logs *bytes.Buffer) *logger.Logger {
|
||||||
return &logger.Logger{Logger: slog.New(slog.NewJSONHandler(logs,
|
return &logger.Logger{Logger: slog.New(slog.NewJSONHandler(logs,
|
||||||
&slog.HandlerOptions{Level: slog.LevelError}))}
|
&slog.HandlerOptions{Level: slog.LevelError}))}
|
||||||
}
|
}
|
||||||
@@ -207,7 +198,7 @@ func lastLogged(t *testing.T, logs *bytes.Buffer) stopLog {
|
|||||||
return logged
|
return logged
|
||||||
}
|
}
|
||||||
|
|
||||||
// returnsInTime reports whether f returns within stepTimeout.
|
// returnsInTime reports whether f returns within handleMessageTimeout.
|
||||||
func returnsInTime(f func()) bool {
|
func returnsInTime(f func()) bool {
|
||||||
done := make(chan struct{})
|
done := make(chan struct{})
|
||||||
|
|
||||||
@@ -219,22 +210,11 @@ func returnsInTime(f func()) bool {
|
|||||||
select {
|
select {
|
||||||
case <-done:
|
case <-done:
|
||||||
return true
|
return true
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// stopInTime stops h, with no deadline, and fails the test if Stop does not
|
|
||||||
// return within stepTimeout. It only marks the test failed, so it can be
|
|
||||||
// deferred.
|
|
||||||
func stopInTime(t *testing.T, h interface{ Stop(ctx context.Context) }) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
if !returnsInTime(func() { h.Stop(t.Context()) }) {
|
|
||||||
t.Errorf("Stop did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// startBlockedWrite hands h the messages in fill and waits until h starts to
|
// startBlockedWrite hands h the messages in fill and waits until h starts to
|
||||||
// write them to store. The prefix, AS and peer handlers start when fill fills
|
// write them to store. The prefix, AS and peer handlers start when fill fills
|
||||||
// their batch, and the peering handler on its timer. store holds the write
|
// their batch, and the peering handler on its timer. store holds the write
|
||||||
@@ -260,7 +240,7 @@ func startBlockedWrite(
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-store.writeStarted:
|
case <-store.writeStarted:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the handler did not start to write the messages")
|
t.Fatal("the handler did not start to write the messages")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -281,7 +261,7 @@ func handleWhileAWriteIsBlocked(
|
|||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
defer h.Stop(t.Context())
|
||||||
defer store.releaseWrites()
|
defer store.releaseWrites()
|
||||||
|
|
||||||
startBlockedWrite(t, store, h, fill)
|
startBlockedWrite(t, store, h, fill)
|
||||||
@@ -295,9 +275,7 @@ func handleWhileAWriteIsBlocked(
|
|||||||
// while store holds the write, hands h the messages in toMax, which bring its
|
// while store holds the write, hands h the messages in toMax, which bring its
|
||||||
// next batch to its maximum size, and the message extra. HandleMessage for
|
// next batch to its maximum size, and the message extra. HandleMessage for
|
||||||
// extra must wait until the test lets the write finish, and return after. Then
|
// extra must wait until the test lets the write finish, and return after. Then
|
||||||
// it stops h, which writes what it holds. The tests lower h's maximum batch
|
// it stops h, which writes what it holds.
|
||||||
// size to one batch, so toMax is one batch: the real maximum of ten batches is
|
|
||||||
// slow to reach under the race detector.
|
|
||||||
func handleAtMaxBatchSize(
|
func handleAtMaxBatchSize(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
store *blockingStore,
|
store *blockingStore,
|
||||||
@@ -310,19 +288,14 @@ func handleAtMaxBatchSize(
|
|||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
defer h.Stop(t.Context())
|
||||||
defer store.releaseWrites()
|
defer store.releaseWrites()
|
||||||
|
|
||||||
startBlockedWrite(t, store, h, fill)
|
startBlockedWrite(t, store, h, fill)
|
||||||
|
|
||||||
if !returnsInTime(func() {
|
|
||||||
for _, msg := range toMax {
|
for _, msg := range toMax {
|
||||||
h.HandleMessage(msg)
|
h.HandleMessage(msg)
|
||||||
}
|
}
|
||||||
}) {
|
|
||||||
t.Fatal("HandleMessage did not return while the batch grew to its " +
|
|
||||||
"maximum size")
|
|
||||||
}
|
|
||||||
|
|
||||||
returned := make(chan struct{})
|
returned := make(chan struct{})
|
||||||
|
|
||||||
@@ -342,7 +315,7 @@ func handleAtMaxBatchSize(
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-returned:
|
case <-returned:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("HandleMessage did not return after the database write finished")
|
t.Fatal("HandleMessage did not return after the database write finished")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -372,13 +345,9 @@ func stopWhileAWriteIsBlocked(
|
|||||||
|
|
||||||
startBlockedWrite(t, store, h, fill)
|
startBlockedWrite(t, store, h, fill)
|
||||||
|
|
||||||
if !returnsInTime(func() {
|
|
||||||
for _, msg := range extra {
|
for _, msg := range extra {
|
||||||
h.HandleMessage(msg)
|
h.HandleMessage(msg)
|
||||||
}
|
}
|
||||||
}) {
|
|
||||||
t.Fatal("HandleMessage did not return while a database write was blocked")
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(t.Context(), stopDeadline)
|
ctx, cancel := context.WithTimeout(t.Context(), stopDeadline)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
@@ -392,7 +361,7 @@ func stopWhileAWriteIsBlocked(
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-done:
|
case <-done:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the flush goroutine did not return after the write finished")
|
t.Fatal("the flush goroutine did not return after the write finished")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -411,8 +380,7 @@ func TestPrefixHandlerSkipsItsLastWriteAfterTheStopDeadline(t *testing.T) {
|
|||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newPrefixHandler(store, newErrorLogger(&logs),
|
h := newPrefixHandler(store, newErrorLogger(&logs),
|
||||||
routetable.New(routetable.Params{}), longerThanAnyTest,
|
routetable.New(routetable.Params{}), longerThanAnyTest)
|
||||||
maxTableChangesPerWrite)
|
|
||||||
fill := slices.Repeat([]string{testV4Prefix}, prefixBatchSize)
|
fill := slices.Repeat([]string{testV4Prefix}, prefixBatchSize)
|
||||||
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
||||||
[]*ristypes.RISMessage{prefixAnnouncement(fill)},
|
[]*ristypes.RISMessage{prefixAnnouncement(fill)},
|
||||||
@@ -498,20 +466,20 @@ func TestPrefixHandlerStopCountsTheTableChangesOfAWriteInProgress(t *testing.T)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestASHandlerSkipsItsLastWriteAfterTheStopDeadline also checks what Stop
|
|
||||||
// logs: the asnBatchSize entries of the held write and the entry for testASNB,
|
|
||||||
// handled since, are not written.
|
|
||||||
func TestASHandlerSkipsItsLastWriteAfterTheStopDeadline(t *testing.T) {
|
func TestASHandlerSkipsItsLastWriteAfterTheStopDeadline(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const wantEntries = asnBatchSize + 1
|
// Each message gives an update for its origin AS and one for each AS
|
||||||
|
// in its path: fill asnBatchSize+1, extra 2.
|
||||||
|
const wantUpdates = asnBatchSize + 1 + 2
|
||||||
|
|
||||||
var logs bytes.Buffer
|
var logs bytes.Buffer
|
||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newASHandler(store, newErrorLogger(&logs), longerThanAnyTest)
|
h := newASHandler(store, newErrorLogger(&logs), longerThanAnyTest)
|
||||||
|
fill := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchSize)}
|
||||||
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
||||||
[]*ristypes.RISMessage{{Path: pathOfASes(asnBatchSize)}},
|
[]*ristypes.RISMessage{{Path: fill}},
|
||||||
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
||||||
|
|
||||||
store.mu.Lock()
|
store.mu.Lock()
|
||||||
@@ -521,27 +489,26 @@ func TestASHandlerSkipsItsLastWriteAfterTheStopDeadline(t *testing.T) {
|
|||||||
t.Errorf("AS%d was written after the stop deadline", testASNB)
|
t.Errorf("AS%d was written after the stop deadline", testASNB)
|
||||||
}
|
}
|
||||||
|
|
||||||
if logged := lastLogged(t, &logs); logged.BatchEntries != wantEntries {
|
if logged := lastLogged(t, &logs); logged.Updates != wantUpdates {
|
||||||
t.Errorf("Stop logged %d batch entries not written, want %d",
|
t.Errorf("Stop logged %d updates not written, want %d",
|
||||||
logged.BatchEntries, wantEntries)
|
logged.Updates, wantUpdates)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestASHandlerSkipsAFullBatchAfterTheStopDeadline hands the AS handler a full
|
// TestASHandlerSkipsAFullBatchAfterTheStopDeadline hands the AS handler a full
|
||||||
// batch while a write is held, so the batch's wake-up of the flush goroutine
|
// batch while a write is held, so the batch's wake-up of the flush goroutine
|
||||||
// waits. The full batch holds the fill's ASes again, and testASNB. The stop
|
// waits. The stop deadline passes meanwhile. When the write ends, the flush
|
||||||
// deadline passes meanwhile. When the write ends, the flush goroutine must stop
|
// goroutine must stop instead of writing the batch.
|
||||||
// instead of writing the batch.
|
|
||||||
func TestASHandlerSkipsAFullBatchAfterTheStopDeadline(t *testing.T) {
|
func TestASHandlerSkipsAFullBatchAfterTheStopDeadline(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
||||||
fill := &ristypes.RISMessage{Path: pathOfASes(asnBatchSize)}
|
fill := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchSize)}
|
||||||
|
full := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNB}, asnBatchSize)}
|
||||||
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
||||||
[]*ristypes.RISMessage{fill},
|
[]*ristypes.RISMessage{{Path: fill}},
|
||||||
fill,
|
&ristypes.RISMessage{Path: full})
|
||||||
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
|
||||||
|
|
||||||
store.mu.Lock()
|
store.mu.Lock()
|
||||||
defer store.mu.Unlock()
|
defer store.mu.Unlock()
|
||||||
@@ -630,7 +597,7 @@ func TestPeeringHandlerStopCountsTheWriteInProgress(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-h.done:
|
case <-h.done:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the processing goroutine did not return after the write " +
|
t.Fatal("the processing goroutine did not return after the write " +
|
||||||
"finished")
|
"finished")
|
||||||
}
|
}
|
||||||
@@ -651,7 +618,7 @@ func TestPeeringHandlerStartsNoWriteAfterTheStopDeadline(t *testing.T) {
|
|||||||
const processInterval = 10 * time.Millisecond
|
const processInterval = 10 * time.Millisecond
|
||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newPeeringHandler(store, logger.New(), processInterval, maxTrackedPaths)
|
h := newPeeringHandler(store, logger.New(), processInterval)
|
||||||
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
stopWhileAWriteIsBlocked(t, store, h, h.done,
|
||||||
[]*ristypes.RISMessage{
|
[]*ristypes.RISMessage{
|
||||||
{Path: ristypes.ASPath{Sequence: []int{testASNA, testASNB}}},
|
{Path: ristypes.ASPath{Sequence: []int{testASNA, testASNB}}},
|
||||||
@@ -707,8 +674,9 @@ func TestASHandlerHandlesMessagesWhileAWriteIsBlocked(t *testing.T) {
|
|||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
||||||
|
fill := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchSize)}
|
||||||
handleWhileAWriteIsBlocked(t, store, h,
|
handleWhileAWriteIsBlocked(t, store, h,
|
||||||
[]*ristypes.RISMessage{{Path: pathOfASes(asnBatchSize)}},
|
[]*ristypes.RISMessage{{Path: fill}},
|
||||||
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
||||||
|
|
||||||
store.mu.Lock()
|
store.mu.Lock()
|
||||||
@@ -746,11 +714,9 @@ func TestPrefixHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
|||||||
const extraPrefix = "198.51.100.0/24"
|
const extraPrefix = "198.51.100.0/24"
|
||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newPrefixHandler(store, logger.New(), routetable.New(routetable.Params{}),
|
h := NewPrefixHandler(store, logger.New(), routetable.New(routetable.Params{}))
|
||||||
longerThanAnyTest, maxTableChangesPerWrite)
|
|
||||||
h.batchMaxSize = prefixBatchSize
|
|
||||||
fill := slices.Repeat([]string{testV4Prefix}, prefixBatchSize)
|
fill := slices.Repeat([]string{testV4Prefix}, prefixBatchSize)
|
||||||
toMax := slices.Repeat([]string{testV4Prefix}, prefixBatchSize)
|
toMax := slices.Repeat([]string{testV4Prefix}, prefixBatchMaxSize)
|
||||||
handleAtMaxBatchSize(t, store, h,
|
handleAtMaxBatchSize(t, store, h,
|
||||||
[]*ristypes.RISMessage{prefixAnnouncement(fill)},
|
[]*ristypes.RISMessage{prefixAnnouncement(fill)},
|
||||||
[]*ristypes.RISMessage{prefixAnnouncement(toMax)},
|
[]*ristypes.RISMessage{prefixAnnouncement(toMax)},
|
||||||
@@ -765,48 +731,31 @@ func TestPrefixHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestASHandlerNeverWaitsForAWrite starts a write that the store holds. Then it
|
func TestASHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
||||||
// hands the AS handler twenty messages whose paths each hold one AS
|
|
||||||
// asnBatchSize times. HandleMessage must return each time, and the batch must
|
|
||||||
// hold one entry, for that AS.
|
|
||||||
func TestASHandlerNeverWaitsForAWrite(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const messages = 20
|
|
||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
h := newASHandler(store, logger.New(), longerThanAnyTest)
|
||||||
|
fill := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchSize)}
|
||||||
|
toMax := ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, asnBatchMaxSize)}
|
||||||
|
handleAtMaxBatchSize(t, store, h,
|
||||||
|
[]*ristypes.RISMessage{{Path: fill}},
|
||||||
|
[]*ristypes.RISMessage{{Path: toMax}},
|
||||||
|
&ristypes.RISMessage{Path: ristypes.ASPath{Sequence: []int{testASNB}}})
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
store.mu.Lock()
|
||||||
defer store.releaseWrites()
|
defer store.mu.Unlock()
|
||||||
|
|
||||||
startBlockedWrite(t, store, h,
|
if !store.asns[testASNB] {
|
||||||
[]*ristypes.RISMessage{{Path: pathOfASes(asnBatchSize)}})
|
t.Errorf("Stop did not write AS%d, handled after the batch reached its "+
|
||||||
|
"maximum size", testASNB)
|
||||||
oneAS := &ristypes.RISMessage{
|
|
||||||
Path: ristypes.ASPath{Sequence: slices.Repeat([]int{testASNB}, asnBatchSize)},
|
|
||||||
}
|
|
||||||
|
|
||||||
if !returnsInTime(func() {
|
|
||||||
for range messages {
|
|
||||||
h.HandleMessage(oneAS)
|
|
||||||
}
|
|
||||||
}) {
|
|
||||||
t.Fatal("HandleMessage did not return while a database write was blocked")
|
|
||||||
}
|
|
||||||
|
|
||||||
h.mu.Lock()
|
|
||||||
defer h.mu.Unlock()
|
|
||||||
|
|
||||||
if len(h.batch) != 1 {
|
|
||||||
t.Errorf("the batch holds %d entries for one AS, want 1", len(h.batch))
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestPeerHandlerWaitsAtTheMaximumBatchSize must not have its flush timer fire.
|
// TestPeerHandlerWaitsAtTheMaximumBatchSize must not have its flush timer fire.
|
||||||
// A timer flush during the fill would take only part of it. The batch would
|
// A timer flush during the fill would take only part of it. The batch would
|
||||||
// then reach its maximum size before the test's last message, and the test
|
// then reach its maximum size before the test's last message, and the test
|
||||||
// would fail.
|
// would hang.
|
||||||
func TestPeerHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
func TestPeerHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -814,11 +763,10 @@ func TestPeerHandlerWaitsAtTheMaximumBatchSize(t *testing.T) {
|
|||||||
|
|
||||||
store := newBlockingStore()
|
store := newBlockingStore()
|
||||||
h := newPeerHandler(store, logger.New(), longerThanAnyTest)
|
h := newPeerHandler(store, logger.New(), longerThanAnyTest)
|
||||||
h.batchMaxSize = peerBatchSize
|
|
||||||
message := []*ristypes.RISMessage{{Peer: testPeerIP}}
|
message := []*ristypes.RISMessage{{Peer: testPeerIP}}
|
||||||
handleAtMaxBatchSize(t, store, h,
|
handleAtMaxBatchSize(t, store, h,
|
||||||
slices.Repeat(message, peerBatchSize),
|
slices.Repeat(message, peerBatchSize),
|
||||||
slices.Repeat(message, peerBatchSize),
|
slices.Repeat(message, peerBatchMaxSize),
|
||||||
&ristypes.RISMessage{Peer: otherPeerIP})
|
&ristypes.RISMessage{Peer: otherPeerIP})
|
||||||
|
|
||||||
store.mu.Lock()
|
store.mu.Lock()
|
||||||
@@ -848,7 +796,6 @@ func TestHandlersWakeTheFlushGoroutineWhenTheBatchIsFull(t *testing.T) {
|
|||||||
batchSize: prefixBatchSize,
|
batchSize: prefixBatchSize,
|
||||||
handle: func(n int) chan struct{} {
|
handle: func(n int) chan struct{} {
|
||||||
h := &PrefixHandler{
|
h := &PrefixHandler{
|
||||||
batchMaxSize: prefixBatchMaxSize,
|
|
||||||
batchFullCh: make(chan struct{}, 1),
|
batchFullCh: make(chan struct{}, 1),
|
||||||
table: routetable.New(routetable.Params{}),
|
table: routetable.New(routetable.Params{}),
|
||||||
}
|
}
|
||||||
@@ -862,12 +809,11 @@ func TestHandlersWakeTheFlushGoroutineWhenTheBatchIsFull(t *testing.T) {
|
|||||||
name: "AS",
|
name: "AS",
|
||||||
batchSize: asnBatchSize,
|
batchSize: asnBatchSize,
|
||||||
handle: func(n int) chan struct{} {
|
handle: func(n int) chan struct{} {
|
||||||
h := &ASHandler{
|
h := &ASHandler{batchFullCh: make(chan struct{}, 1)}
|
||||||
batch: make(map[int]database.SeenTimes),
|
// The origin AS and each AS in the path are one update each.
|
||||||
batchFullCh: make(chan struct{}, 1),
|
h.HandleMessage(&ristypes.RISMessage{
|
||||||
}
|
Path: ristypes.ASPath{Sequence: slices.Repeat([]int{testASNA}, n-1)},
|
||||||
// Each of the path's n ASes is one entry of the batch.
|
})
|
||||||
h.HandleMessage(&ristypes.RISMessage{Path: pathOfASes(n)})
|
|
||||||
|
|
||||||
return h.batchFullCh
|
return h.batchFullCh
|
||||||
},
|
},
|
||||||
@@ -876,10 +822,7 @@ func TestHandlersWakeTheFlushGoroutineWhenTheBatchIsFull(t *testing.T) {
|
|||||||
name: "peer",
|
name: "peer",
|
||||||
batchSize: peerBatchSize,
|
batchSize: peerBatchSize,
|
||||||
handle: func(n int) chan struct{} {
|
handle: func(n int) chan struct{} {
|
||||||
h := &PeerHandler{
|
h := &PeerHandler{batchFullCh: make(chan struct{}, 1)}
|
||||||
batchMaxSize: peerBatchMaxSize,
|
|
||||||
batchFullCh: make(chan struct{}, 1),
|
|
||||||
}
|
|
||||||
for range n {
|
for range n {
|
||||||
h.HandleMessage(&ristypes.RISMessage{Peer: testPeerIP})
|
h.HandleMessage(&ristypes.RISMessage{Peer: testPeerIP})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -97,7 +97,7 @@ func TestDBMaintainerStopReturnsByItsDeadline(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-store.started:
|
case <-store.started:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the maintainer did not start the checkpoint")
|
t.Fatal("the maintainer did not start the checkpoint")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@ func TestDBMaintainerStopReturnsByItsDeadline(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-m.done:
|
case <-m.done:
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(handleMessageTimeout):
|
||||||
t.Fatal("the maintenance goroutine did not return after the " +
|
t.Fatal("the maintenance goroutine did not return after the " +
|
||||||
"checkpoint ended")
|
"checkpoint ended")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -43,14 +43,10 @@ type PeerHandler struct {
|
|||||||
db database.Store
|
db database.Store
|
||||||
logger *logger.Logger
|
logger *logger.Logger
|
||||||
|
|
||||||
// batchMaxSize is peerBatchMaxSize. Only HandleMessage reads it, so a test
|
|
||||||
// may lower it before it hands the handler a message.
|
|
||||||
batchMaxSize int
|
|
||||||
|
|
||||||
// Batching. mu guards peerBatch and writing only: the flush goroutine
|
// Batching. mu guards peerBatch and writing only: the flush goroutine
|
||||||
// takes the batch under mu and writes it after releasing mu, so
|
// takes the batch under mu and writes it after releasing mu, so
|
||||||
// HandleMessage waits for a database write only while peerBatch is at
|
// HandleMessage waits for a database write only while peerBatch is at
|
||||||
// batchMaxSize.
|
// peerBatchMaxSize.
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
peerBatch []peerUpdate
|
peerBatch []peerUpdate
|
||||||
// writing is how many updates the flush goroutine took from peerBatch
|
// writing is how many updates the flush goroutine took from peerBatch
|
||||||
@@ -90,7 +86,6 @@ func newPeerHandler(
|
|||||||
h := &PeerHandler{
|
h := &PeerHandler{
|
||||||
db: db,
|
db: db,
|
||||||
logger: logger,
|
logger: logger,
|
||||||
batchMaxSize: peerBatchMaxSize,
|
|
||||||
peerBatch: make([]peerUpdate, 0, peerBatchSize),
|
peerBatch: make([]peerUpdate, 0, peerBatchSize),
|
||||||
batchFullCh: make(chan struct{}, 1),
|
batchFullCh: make(chan struct{}, 1),
|
||||||
stopCh: make(chan context.Context, 1),
|
stopCh: make(chan context.Context, 1),
|
||||||
@@ -140,7 +135,7 @@ func (h *PeerHandler) HandleMessage(msg *ristypes.RISMessage) {
|
|||||||
// While the batch is at its maximum size, wait until the flush goroutine
|
// While the batch is at its maximum size, wait until the flush goroutine
|
||||||
// takes it. Meanwhile the handler takes nothing off its queue, which
|
// takes it. Meanwhile the handler takes nothing off its queue, which
|
||||||
// fills, and the streamer drops messages for it.
|
// fills, and the streamer drops messages for it.
|
||||||
for len(h.peerBatch) >= h.batchMaxSize {
|
for len(h.peerBatch) >= peerBatchMaxSize {
|
||||||
h.batchTaken.Wait()
|
h.batchTaken.Wait()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -154,7 +149,7 @@ func (h *PeerHandler) HandleMessage(msg *ristypes.RISMessage) {
|
|||||||
|
|
||||||
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
||||||
// waits in batchFullCh and the batch keeps growing until the write ends
|
// waits in batchFullCh and the batch keeps growing until the write ends
|
||||||
// or the batch reaches batchMaxSize.
|
// or the batch reaches peerBatchMaxSize.
|
||||||
if len(h.peerBatch) >= peerBatchSize {
|
if len(h.peerBatch) >= peerBatchSize {
|
||||||
select {
|
select {
|
||||||
case h.batchFullCh <- struct{}{}:
|
case h.batchFullCh <- struct{}{}:
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ func TestPeerHandlerWritesTheEarliestAndLatestTimesOfANewPeer(t *testing.T) {
|
|||||||
|
|
||||||
// Built without NewPeerHandler's flush goroutine, so the test flushes
|
// Built without NewPeerHandler's flush goroutine, so the test flushes
|
||||||
// itself.
|
// itself.
|
||||||
h := &PeerHandler{db: store, logger: logger.New(), batchMaxSize: peerBatchMaxSize}
|
h := &PeerHandler{db: store, logger: logger.New()}
|
||||||
|
|
||||||
first := peerAnnouncement(testPeerIP, testV4Prefix)
|
first := peerAnnouncement(testPeerIP, testV4Prefix)
|
||||||
second := peerAnnouncement(testPeerIP, testV4Prefix)
|
second := peerAnnouncement(testPeerIP, testV4Prefix)
|
||||||
|
|||||||
@@ -42,10 +42,6 @@ type PeeringHandler struct {
|
|||||||
db database.Store
|
db database.Store
|
||||||
logger *logger.Logger
|
logger *logger.Logger
|
||||||
|
|
||||||
// maxPaths is the most paths asPaths holds: maxTrackedPaths, except in
|
|
||||||
// tests that give a smaller one.
|
|
||||||
maxPaths int
|
|
||||||
|
|
||||||
// In-memory AS path tracking: each path, JSON-encoded, with the earliest
|
// In-memory AS path tracking: each path, JSON-encoded, with the earliest
|
||||||
// and the latest time an update carried it.
|
// and the latest time an update carried it.
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
@@ -66,22 +62,19 @@ type PeeringHandler struct {
|
|||||||
// periodically processes accumulated AS paths into peering records. The
|
// periodically processes accumulated AS paths into peering records. The
|
||||||
// handler begins processing immediately upon creation.
|
// handler begins processing immediately upon creation.
|
||||||
func NewPeeringHandler(db database.Store, logger *logger.Logger) *PeeringHandler {
|
func NewPeeringHandler(db database.Store, logger *logger.Logger) *PeeringHandler {
|
||||||
return newPeeringHandler(db, logger, peeringProcessInterval, maxTrackedPaths)
|
return newPeeringHandler(db, logger, peeringProcessInterval)
|
||||||
}
|
}
|
||||||
|
|
||||||
// newPeeringHandler is NewPeeringHandler with the processing timer's interval,
|
// newPeeringHandler is NewPeeringHandler with the processing timer's interval,
|
||||||
// processInterval, in place of peeringProcessInterval, and the most paths it
|
// processInterval, in place of peeringProcessInterval. A test gives a short
|
||||||
// holds, maxPaths, in place of maxTrackedPaths. A test gives a short interval to
|
// one to have the timer start a write.
|
||||||
// have the timer start a write, and a small maxPaths to fill the map quickly.
|
|
||||||
func newPeeringHandler(
|
func newPeeringHandler(
|
||||||
db database.Store, logger *logger.Logger, processInterval time.Duration,
|
db database.Store, logger *logger.Logger, processInterval time.Duration,
|
||||||
maxPaths int,
|
|
||||||
) *PeeringHandler {
|
) *PeeringHandler {
|
||||||
h := &PeeringHandler{
|
h := &PeeringHandler{
|
||||||
db: db,
|
db: db,
|
||||||
logger: logger,
|
logger: logger,
|
||||||
asPaths: make(map[string]database.SeenTimes),
|
asPaths: make(map[string]database.SeenTimes),
|
||||||
maxPaths: maxPaths,
|
|
||||||
stopCh: make(chan context.Context, 1),
|
stopCh: make(chan context.Context, 1),
|
||||||
done: make(chan struct{}),
|
done: make(chan struct{}),
|
||||||
}
|
}
|
||||||
@@ -138,7 +131,7 @@ func (h *PeeringHandler) HandleMessage(msg *ristypes.RISMessage) {
|
|||||||
defer h.mu.Unlock()
|
defer h.mu.Unlock()
|
||||||
|
|
||||||
seen, exists := h.asPaths[key]
|
seen, exists := h.asPaths[key]
|
||||||
if !exists && len(h.asPaths) >= h.maxPaths {
|
if !exists && len(h.asPaths) >= maxTrackedPaths {
|
||||||
// Map is full; drop this new path and count it.
|
// Map is full; drop this new path and count it.
|
||||||
h.droppedPaths++
|
h.droppedPaths++
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"maps"
|
"maps"
|
||||||
"slices"
|
"slices"
|
||||||
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@@ -19,10 +20,6 @@ const (
|
|||||||
testASNB = 64501
|
testASNB = 64501
|
||||||
testASNC = 64502
|
testASNC = 64502
|
||||||
testASND = 64503
|
testASND = 64503
|
||||||
|
|
||||||
// testMaxTrackedPaths is a limit of the path map that a test fills
|
|
||||||
// quickly, in place of maxTrackedPaths.
|
|
||||||
testMaxTrackedPaths = 10
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// recordingStore wraps mockStore to count every RecordPeering call, so a
|
// recordingStore wraps mockStore to count every RecordPeering call, so a
|
||||||
@@ -58,7 +55,6 @@ func newTestHandler(db database.Store) *PeeringHandler {
|
|||||||
db: db,
|
db: db,
|
||||||
logger: logger.New(),
|
logger: logger.New(),
|
||||||
asPaths: make(map[string]database.SeenTimes),
|
asPaths: make(map[string]database.SeenTimes),
|
||||||
maxPaths: maxTrackedPaths,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -248,28 +244,25 @@ func TestPeeringHandlerStopWritesTheRemainingPaths(t *testing.T) {
|
|||||||
|
|
||||||
// TestPeeringHandlerCapDropsAndCounts verifies that a full map drops new paths
|
// TestPeeringHandlerCapDropsAndCounts verifies that a full map drops new paths
|
||||||
// and counts them, while a path already tracked is refreshed rather than
|
// and counts them, while a path already tracked is refreshed rather than
|
||||||
// dropped. The handler's limit is small, and its timer does not fire.
|
// dropped.
|
||||||
func TestPeeringHandlerCapDropsAndCounts(t *testing.T) {
|
func TestPeeringHandlerCapDropsAndCounts(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
store := &recordingStore{mockStore: newMockStore()}
|
store := &recordingStore{mockStore: newMockStore()}
|
||||||
h := newPeeringHandler(store, logger.New(), longerThanAnyTest,
|
h := newTestHandler(store)
|
||||||
testMaxTrackedPaths)
|
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
now := time.Now().UTC()
|
now := time.Now().UTC()
|
||||||
|
|
||||||
// Fill the map to exactly its limit, including one real path key so the
|
// Fill the map to exactly maxTrackedPaths, including one real path key so
|
||||||
// "already tracked" branch can be exercised. The other paths are of one
|
// the "already tracked" branch can be exercised. The filler keys are never
|
||||||
// AS, so they carry no peering.
|
// processed in this test, so their contents do not matter.
|
||||||
existing := pathKey(t, testASNA, testASNB)
|
existing := pathKey(t, testASNA, testASNB)
|
||||||
|
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
h.asPaths[existing] = database.SeenTimes{First: now, Last: now}
|
h.asPaths[existing] = database.SeenTimes{First: now, Last: now}
|
||||||
|
|
||||||
for asn := 1; len(h.asPaths) < testMaxTrackedPaths; asn++ {
|
for i := 0; len(h.asPaths) < maxTrackedPaths; i++ {
|
||||||
h.asPaths[pathKey(t, asn)] = database.SeenTimes{First: now, Last: now}
|
h.asPaths[strconv.Itoa(i)] = database.SeenTimes{First: now, Last: now}
|
||||||
}
|
}
|
||||||
h.mu.Unlock()
|
h.mu.Unlock()
|
||||||
|
|
||||||
@@ -277,9 +270,8 @@ func TestPeeringHandlerCapDropsAndCounts(t *testing.T) {
|
|||||||
handle(h, now.Add(time.Second), testASNA, testASNC)
|
handle(h, now.Add(time.Second), testASNA, testASNC)
|
||||||
|
|
||||||
tracked, dropped := snapshot(h)
|
tracked, dropped := snapshot(h)
|
||||||
if tracked != testMaxTrackedPaths {
|
if tracked != maxTrackedPaths {
|
||||||
t.Fatalf("want map size %d after drop, got %d", testMaxTrackedPaths,
|
t.Fatalf("want map size %d after drop, got %d", maxTrackedPaths, tracked)
|
||||||
tracked)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if dropped != 1 {
|
if dropped != 1 {
|
||||||
@@ -291,9 +283,8 @@ func TestPeeringHandlerCapDropsAndCounts(t *testing.T) {
|
|||||||
handle(h, refreshed, testASNA, testASNB)
|
handle(h, refreshed, testASNA, testASNB)
|
||||||
|
|
||||||
tracked, dropped = snapshot(h)
|
tracked, dropped = snapshot(h)
|
||||||
if tracked != testMaxTrackedPaths {
|
if tracked != maxTrackedPaths {
|
||||||
t.Fatalf("want map size %d after refresh, got %d", testMaxTrackedPaths,
|
t.Fatalf("want map size %d after refresh, got %d", maxTrackedPaths, tracked)
|
||||||
tracked)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if dropped != 1 {
|
if dropped != 1 {
|
||||||
@@ -312,21 +303,17 @@ func TestPeeringHandlerCapDropsAndCounts(t *testing.T) {
|
|||||||
|
|
||||||
// TestPeeringHandlerRunResetsTheDroppedCount fills the map, has the handler
|
// TestPeeringHandlerRunResetsTheDroppedCount fills the map, has the handler
|
||||||
// drop one path, and runs the processing. The count of dropped paths is the
|
// drop one path, and runs the processing. The count of dropped paths is the
|
||||||
// run's own, so it is 0 again after the run. The handler's limit is small, and
|
// run's own, so it is 0 again after the run.
|
||||||
// its timer does not fire.
|
|
||||||
func TestPeeringHandlerRunResetsTheDroppedCount(t *testing.T) {
|
func TestPeeringHandlerRunResetsTheDroppedCount(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
h := newPeeringHandler(newMockStore(), logger.New(), longerThanAnyTest,
|
h := newTestHandler(newMockStore())
|
||||||
testMaxTrackedPaths)
|
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
now := time.Now().UTC()
|
now := time.Now().UTC()
|
||||||
|
|
||||||
// Paths of one AS carry no peering, so the run records nothing.
|
// Paths of one AS carry no peering, so the run records nothing.
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
for asn := 1; len(h.asPaths) < testMaxTrackedPaths; asn++ {
|
for asn := 1; len(h.asPaths) < maxTrackedPaths; asn++ {
|
||||||
h.asPaths[pathKey(t, asn)] = database.SeenTimes{First: now, Last: now}
|
h.asPaths[pathKey(t, asn)] = database.SeenTimes{First: now, Last: now}
|
||||||
}
|
}
|
||||||
h.mu.Unlock()
|
h.mu.Unlock()
|
||||||
|
|||||||
@@ -15,15 +15,12 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// prefixHandlerQueueSize is the most messages the handler's queue holds.
|
// prefixHandlerQueueSize is the queue capacity for prefix tracking
|
||||||
// While the routing table's Overview or PeersDown walks every prefix, it
|
// operations, about 4 seconds of feed at peak. The streamer drops updates
|
||||||
// holds the table's lock about half of the time. The handler then applies
|
// rather than blocks when a queue is full (a STATE message is held until
|
||||||
// updates more slowly. When the feed pauses for some seconds and then
|
// there is room), so this bounds memory. Batches still flush on a timer
|
||||||
// catches up, its backlog can arrive faster than that, and the queue
|
// (prefixBatchTimeout).
|
||||||
// holds the backlog. The streamer drops an update that finds the queue
|
prefixHandlerQueueSize = 20000
|
||||||
// full. A message takes about 1 KiB, so a full queue takes about 100 MiB
|
|
||||||
// (README "Memory").
|
|
||||||
prefixHandlerQueueSize = 100000
|
|
||||||
|
|
||||||
// prefixBatchSize is the number of prefix updates to batch together
|
// prefixBatchSize is the number of prefix updates to batch together
|
||||||
prefixBatchSize = 25000
|
prefixBatchSize = 25000
|
||||||
@@ -47,21 +44,6 @@ const (
|
|||||||
// most one pair. So the million pairs that a full-table peer's session
|
// most one pair. So the million pairs that a full-table peer's session
|
||||||
// going down changes are written in about a minute.
|
// going down changes are written in about a minute.
|
||||||
maxTableChangesPerWrite = 20000
|
maxTableChangesPerWrite = 20000
|
||||||
|
|
||||||
// maxHeldBackMessages is the most messages the handler holds back from
|
|
||||||
// peers whose session went down. A peer's messages are held back from
|
|
||||||
// the moment its session goes down until peerDown has applied them. If
|
|
||||||
// peerDown is running at that moment, the peer waits for the rest of
|
|
||||||
// peerDown's current PeersDown call. The peer also waits while peerDown
|
|
||||||
// applies the messages held back from that call's peers, those that
|
|
||||||
// arrive meanwhile included. The next PeersDown call takes the peer out.
|
|
||||||
// Once that call returns, peerDown applies the messages held back from
|
|
||||||
// that call's peers, one peer after another, in the order the call lists
|
|
||||||
// them. A held-back message that says the peer's session went down again
|
|
||||||
// makes the peer's later messages wait for the next call. A message takes
|
|
||||||
// about 1 KiB, so 150,000 take about 150 MiB (README "Memory"). At this
|
|
||||||
// number HandleMessage waits until one of them is applied.
|
|
||||||
maxHeldBackMessages = 150000
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// PrefixHandler keeps the routing table in memory current from the feed. It
|
// PrefixHandler keeps the routing table in memory current from the feed. It
|
||||||
@@ -70,17 +52,6 @@ const (
|
|||||||
// does an announcement whose AS path is empty or holds AS 0 anywhere. A peer
|
// does an announcement whose AS path is empty or holds AS 0 anywhere. A peer
|
||||||
// whose BGP session goes down leaves every prefix.
|
// whose BGP session goes down leaves every prefix.
|
||||||
//
|
//
|
||||||
// The table's PeersDown applies sessions going down. It visits every prefix,
|
|
||||||
// which takes seconds on a full table. So the handler runs PeersDown on a
|
|
||||||
// separate goroutine and goes on taking messages meanwhile. One PeersDown runs
|
|
||||||
// at a time. The next one takes every peer whose session went down since the
|
|
||||||
// previous one began. PeersDown lets the table's lock go about half of the
|
|
||||||
// time, so the handler applies other peers' messages while PeersDown runs. The
|
|
||||||
// handler holds back a down peer's later messages until peerDown applies them,
|
|
||||||
// as the doc of maxHeldBackMessages describes. It applies them in order, one at
|
|
||||||
// a time, and takes new messages in between. It holds back at most
|
|
||||||
// maxHeldBackMessages messages.
|
|
||||||
//
|
|
||||||
// Each flush writes the table's changes to the database. It also stores each
|
// Each flush writes the table's changes to the database. It also stores each
|
||||||
// prefix the updates name with the time it was first seen.
|
// prefix the updates name with the time it was first seen.
|
||||||
type PrefixHandler struct {
|
type PrefixHandler struct {
|
||||||
@@ -89,17 +60,10 @@ type PrefixHandler struct {
|
|||||||
metrics *metrics.Tracker
|
metrics *metrics.Tracker
|
||||||
table *routetable.Table
|
table *routetable.Table
|
||||||
|
|
||||||
// batchMaxSize is prefixBatchMaxSize. Only HandleMessage reads it, so a
|
// Batching. mu guards batch, writing and writingTableChanges only: the
|
||||||
// test may lower it before it hands the handler a message.
|
|
||||||
batchMaxSize int
|
|
||||||
// tableChangesPerWrite is maxTableChangesPerWrite, except in tests that
|
|
||||||
// give a smaller one.
|
|
||||||
tableChangesPerWrite int
|
|
||||||
|
|
||||||
// Batching. mu guards batch, writing and writingTableChanges: the
|
|
||||||
// flush goroutine takes them under mu and writes them after releasing
|
// flush goroutine takes them under mu and writes them after releasing
|
||||||
// mu, so HandleMessage waits for a database write only while batch is at
|
// mu, so HandleMessage waits for a database write only while batch is at
|
||||||
// batchMaxSize.
|
// prefixBatchMaxSize.
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
batch []seenPrefix
|
batch []seenPrefix
|
||||||
// writing is how many updates the flush goroutine took and has not
|
// writing is how many updates the flush goroutine took and has not
|
||||||
@@ -116,26 +80,6 @@ type PrefixHandler struct {
|
|||||||
// Stop does not wait for a write in progress to hand it over.
|
// Stop does not wait for a write in progress to hand it over.
|
||||||
stopCh chan context.Context
|
stopCh chan context.Context
|
||||||
done chan struct{} // closed when the flush goroutine returns
|
done chan struct{} // closed when the flush goroutine returns
|
||||||
|
|
||||||
// Peers whose session went down. heldBack, under mu, holds each such
|
|
||||||
// peer's later messages, in order, until the peer has left every prefix
|
|
||||||
// and they are applied. A peer with no such messages yet has an empty
|
|
||||||
// entry. heldCount, under mu, is how many messages heldBack holds.
|
|
||||||
// heldTaken is signalled each time a held-back message is taken out to
|
|
||||||
// be applied; its L is &mu.
|
|
||||||
heldBack map[string][]*ristypes.RISMessage
|
|
||||||
heldCount int
|
|
||||||
heldTaken sync.Cond
|
|
||||||
// downPeers, under mu, lists the peers whose session went down and that
|
|
||||||
// the next PeersDown takes. peerDownRunning, under mu, says whether
|
|
||||||
// peerDown is running. peerDowns counts the peerDown goroutines that have
|
|
||||||
// not returned.
|
|
||||||
downPeers []string
|
|
||||||
peerDownRunning bool
|
|
||||||
peerDowns sync.WaitGroup
|
|
||||||
// tablePeersDown is the table's PeersDown. Only peerDown calls it, so a
|
|
||||||
// test may replace it before it hands the handler a message.
|
|
||||||
tablePeersDown func(peers []string)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// seenPrefix is what the batch keeps of an update: the prefix it names and its
|
// seenPrefix is what the batch keeps of an update: the prefix it names and its
|
||||||
@@ -175,35 +119,26 @@ func (u prefixUpdate) announcesRoute() bool {
|
|||||||
func NewPrefixHandler(
|
func NewPrefixHandler(
|
||||||
db database.Store, logger *logger.Logger, table *routetable.Table,
|
db database.Store, logger *logger.Logger, table *routetable.Table,
|
||||||
) *PrefixHandler {
|
) *PrefixHandler {
|
||||||
return newPrefixHandler(db, logger, table, prefixBatchTimeout,
|
return newPrefixHandler(db, logger, table, prefixBatchTimeout)
|
||||||
maxTableChangesPerWrite)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// newPrefixHandler is NewPrefixHandler with the flush timer's interval,
|
// newPrefixHandler is NewPrefixHandler with the flush timer's interval,
|
||||||
// batchTimeout, in place of prefixBatchTimeout, and tableChangesPerWrite in
|
// batchTimeout, in place of prefixBatchTimeout. A test that the timer must not
|
||||||
// place of maxTableChangesPerWrite. A test that the timer must not disturb
|
// disturb gives an interval longer than the test runs.
|
||||||
// gives an interval longer than the test runs. A test of writes split over
|
|
||||||
// several flushes gives a small tableChangesPerWrite, so that it exceeds it
|
|
||||||
// with few changes.
|
|
||||||
func newPrefixHandler(
|
func newPrefixHandler(
|
||||||
db database.Store, logger *logger.Logger, table *routetable.Table,
|
db database.Store, logger *logger.Logger, table *routetable.Table,
|
||||||
batchTimeout time.Duration, tableChangesPerWrite int,
|
batchTimeout time.Duration,
|
||||||
) *PrefixHandler {
|
) *PrefixHandler {
|
||||||
h := &PrefixHandler{
|
h := &PrefixHandler{
|
||||||
db: db,
|
db: db,
|
||||||
logger: logger,
|
logger: logger,
|
||||||
table: table,
|
table: table,
|
||||||
batch: make([]seenPrefix, 0, prefixBatchSize),
|
batch: make([]seenPrefix, 0, prefixBatchSize),
|
||||||
batchMaxSize: prefixBatchMaxSize,
|
|
||||||
tableChangesPerWrite: tableChangesPerWrite,
|
|
||||||
batchFullCh: make(chan struct{}, 1),
|
batchFullCh: make(chan struct{}, 1),
|
||||||
stopCh: make(chan context.Context, 1),
|
stopCh: make(chan context.Context, 1),
|
||||||
done: make(chan struct{}),
|
done: make(chan struct{}),
|
||||||
heldBack: make(map[string][]*ristypes.RISMessage),
|
|
||||||
tablePeersDown: table.PeersDown,
|
|
||||||
}
|
}
|
||||||
h.batchTaken.L = &h.mu
|
h.batchTaken.L = &h.mu
|
||||||
h.heldTaken.L = &h.mu
|
|
||||||
|
|
||||||
// Start the flush timer goroutine
|
// Start the flush timer goroutine
|
||||||
go flushLoop(batchTimeout, h.batchFullCh, h.stopCh, h.done, h.flushBatch)
|
go flushLoop(batchTimeout, h.batchFullCh, h.stopCh, h.done, h.flushBatch)
|
||||||
@@ -231,100 +166,11 @@ func (h *PrefixHandler) QueueCapacity() int {
|
|||||||
return prefixHandlerQueueSize
|
return prefixHandlerQueueSize
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleMessage processes a message to track prefix information. A message
|
// HandleMessage processes a message to track prefix information
|
||||||
// from a peer whose session went down is held back until peerDown applies it.
|
|
||||||
func (h *PrefixHandler) HandleMessage(msg *ristypes.RISMessage) {
|
func (h *PrefixHandler) HandleMessage(msg *ristypes.RISMessage) {
|
||||||
h.mu.Lock()
|
|
||||||
defer h.mu.Unlock()
|
|
||||||
|
|
||||||
// While maxHeldBackMessages messages are held back, wait until one of them
|
|
||||||
// is taken out to be applied. Meanwhile the handler takes nothing off its
|
|
||||||
// queue, as at batchMaxSize.
|
|
||||||
for h.heldCount >= maxHeldBackMessages {
|
|
||||||
h.heldTaken.Wait()
|
|
||||||
}
|
|
||||||
|
|
||||||
held, goingDown := h.heldBack[msg.Peer]
|
|
||||||
if goingDown {
|
|
||||||
h.heldBack[msg.Peer] = append(held, msg)
|
|
||||||
h.heldCount++
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
h.applyMessage(msg)
|
|
||||||
}
|
|
||||||
|
|
||||||
// HeldBackCount returns how many messages the handler holds back from peers
|
|
||||||
// whose session went down. The status page shows it.
|
|
||||||
func (h *PrefixHandler) HeldBackCount() int {
|
|
||||||
h.mu.Lock()
|
|
||||||
defer h.mu.Unlock()
|
|
||||||
|
|
||||||
return h.heldCount
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stop waits for every PeersDown the handler started and for the messages held
|
|
||||||
// back meanwhile to be applied. It gives up this wait once ctx ends. Then Stop
|
|
||||||
// stops the flush goroutine and waits for it until ctx ends. The flush
|
|
||||||
// goroutine makes one last flush before it returns. That flush writes at most
|
|
||||||
// tableChangesPerWrite of the routing table's changes, and the prefixes of the
|
|
||||||
// updates the handler holds. Once ctx has ended the flush goroutine skips that
|
|
||||||
// last flush, and a write still running is lost when the process exits. A
|
|
||||||
// failed write of the table's changes is not retried either. Stop logs how
|
|
||||||
// many updates and table changes are not written. It also logs how many
|
|
||||||
// held-back messages are not applied. The caller calls Stop once its last
|
|
||||||
// HandleMessage has returned.
|
|
||||||
func (h *PrefixHandler) Stop(ctx context.Context) {
|
|
||||||
peerDownsDone := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
h.peerDowns.Wait()
|
|
||||||
close(peerDownsDone)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-peerDownsDone:
|
|
||||||
case <-ctx.Done():
|
|
||||||
}
|
|
||||||
|
|
||||||
h.stopCh <- ctx
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-h.done:
|
|
||||||
case <-ctx.Done():
|
|
||||||
}
|
|
||||||
|
|
||||||
h.mu.Lock()
|
|
||||||
unwritten := h.writing + len(h.batch)
|
|
||||||
tableChanges := h.writingTableChanges + h.table.ChangeCount()
|
|
||||||
heldMessages := h.heldCount
|
|
||||||
h.mu.Unlock()
|
|
||||||
|
|
||||||
if unwritten == 0 && tableChanges == 0 && heldMessages == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
h.logger.Error("Stop deadline passed before the prefix handler wrote "+
|
|
||||||
"its updates", "updates", unwritten, "table_changes", tableChanges,
|
|
||||||
"held_messages", heldMessages)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
h.logger.Error("The prefix handler stopped before it wrote everything",
|
|
||||||
"updates", unwritten, "table_changes", tableChanges,
|
|
||||||
"held_messages", heldMessages)
|
|
||||||
}
|
|
||||||
|
|
||||||
// applyMessage applies msg. The caller holds mu. A peer's session going down
|
|
||||||
// has the peer leave every prefix. An update is applied to the routing table,
|
|
||||||
// and its prefixes join the batch.
|
|
||||||
func (h *PrefixHandler) applyMessage(msg *ristypes.RISMessage) {
|
|
||||||
if msg.Type == ristypes.MessageTypeState {
|
if msg.Type == ristypes.MessageTypeState {
|
||||||
if msg.State == ristypes.StateDown {
|
if msg.State == ristypes.StateDown {
|
||||||
h.startPeerDown(msg.Peer)
|
h.table.PeerDown(msg.Peer)
|
||||||
}
|
}
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -339,10 +185,13 @@ func (h *PrefixHandler) applyMessage(msg *ristypes.RISMessage) {
|
|||||||
// the path after the rest of it.
|
// the path after the rest of it.
|
||||||
path := slices.Concat(msg.Path.Sequence, msg.Path.Set)
|
path := slices.Concat(msg.Path.Sequence, msg.Path.Set)
|
||||||
|
|
||||||
|
h.mu.Lock()
|
||||||
|
defer h.mu.Unlock()
|
||||||
|
|
||||||
// While the batch is at its maximum size, wait until the flush goroutine
|
// While the batch is at its maximum size, wait until the flush goroutine
|
||||||
// takes it. Meanwhile the handler takes nothing off its queue, which
|
// takes it. Meanwhile the handler takes nothing off its queue, which
|
||||||
// fills, and the streamer drops messages for it.
|
// fills, and the streamer drops messages for it.
|
||||||
for len(h.batch) >= h.batchMaxSize {
|
for len(h.batch) >= prefixBatchMaxSize {
|
||||||
h.batchTaken.Wait()
|
h.batchTaken.Wait()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -390,7 +239,7 @@ func (h *PrefixHandler) applyMessage(msg *ristypes.RISMessage) {
|
|||||||
|
|
||||||
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
// A full batch wakes the flush goroutine. If it is writing, the wake-up
|
||||||
// waits in batchFullCh and the batch keeps growing until the write ends
|
// waits in batchFullCh and the batch keeps growing until the write ends
|
||||||
// or the batch reaches batchMaxSize.
|
// or the batch reaches prefixBatchMaxSize.
|
||||||
if len(h.batch) >= prefixBatchSize {
|
if len(h.batch) >= prefixBatchSize {
|
||||||
select {
|
select {
|
||||||
case h.batchFullCh <- struct{}{}:
|
case h.batchFullCh <- struct{}{}:
|
||||||
@@ -399,88 +248,39 @@ func (h *PrefixHandler) applyMessage(msg *ristypes.RISMessage) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// startPeerDown adds peer to downPeers. It starts peerDown on a new goroutine
|
// Stop stops the flush goroutine, which makes one last flush before it returns,
|
||||||
// unless peerDown is running. The caller holds mu. The peer's messages are
|
// and waits for it until ctx ends. That flush writes at most
|
||||||
// held back until peerDown has applied them. Messages held back for an earlier
|
// maxTableChangesPerWrite of the routing table's changes, and the prefixes of
|
||||||
// session of the peer going down, and not yet applied, stay held back.
|
// the updates the handler holds. Once ctx has ended the flush goroutine skips
|
||||||
func (h *PrefixHandler) startPeerDown(peer string) {
|
// that last flush, and a write still running is lost when the process exits. A
|
||||||
_, goingDown := h.heldBack[peer]
|
// failed write of the table's changes is not retried either. Stop logs how many
|
||||||
if !goingDown {
|
// updates and how many of the table's changes are not written.
|
||||||
h.heldBack[peer] = []*ristypes.RISMessage{}
|
func (h *PrefixHandler) Stop(ctx context.Context) {
|
||||||
|
h.stopCh <- ctx
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-h.done:
|
||||||
|
case <-ctx.Done():
|
||||||
}
|
}
|
||||||
|
|
||||||
h.downPeers = append(h.downPeers, peer)
|
|
||||||
|
|
||||||
if h.peerDownRunning {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
h.peerDownRunning = true
|
|
||||||
h.peerDowns.Add(1)
|
|
||||||
|
|
||||||
go h.peerDown()
|
|
||||||
}
|
|
||||||
|
|
||||||
// peerDown takes every peer in downPeers and runs the table's PeersDown for
|
|
||||||
// them. Then it applies the messages held back from each of those peers. It
|
|
||||||
// repeats this until downPeers is empty.
|
|
||||||
func (h *PrefixHandler) peerDown() {
|
|
||||||
defer h.peerDowns.Done()
|
|
||||||
|
|
||||||
for {
|
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
|
unwritten := h.writing + len(h.batch)
|
||||||
peers := h.downPeers
|
tableChanges := h.writingTableChanges + h.table.ChangeCount()
|
||||||
h.downPeers = nil
|
|
||||||
|
|
||||||
if len(peers) == 0 {
|
|
||||||
h.peerDownRunning = false
|
|
||||||
h.mu.Unlock()
|
h.mu.Unlock()
|
||||||
|
|
||||||
|
if unwritten == 0 && tableChanges == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
h.logger.Error("Stop deadline passed before the prefix handler wrote "+
|
||||||
|
"its updates", "updates", unwritten, "table_changes", tableChanges)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
h.mu.Unlock()
|
h.logger.Error("The prefix handler stopped before it wrote everything",
|
||||||
|
"updates", unwritten, "table_changes", tableChanges)
|
||||||
h.tablePeersDown(peers)
|
|
||||||
|
|
||||||
for _, peer := range peers {
|
|
||||||
h.applyHeldBack(peer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// applyHeldBack applies the messages held back from peer, in order. It takes
|
|
||||||
// mu for one message at a time, so HandleMessage takes new messages in
|
|
||||||
// between. The peer's new messages join the end of the held-back ones. A
|
|
||||||
// held-back message that says the peer's session went down again adds the
|
|
||||||
// peer to downPeers. The rest stay held back until the next PeersDown has
|
|
||||||
// returned.
|
|
||||||
func (h *PrefixHandler) applyHeldBack(peer string) {
|
|
||||||
for {
|
|
||||||
h.mu.Lock()
|
|
||||||
|
|
||||||
held := h.heldBack[peer]
|
|
||||||
if len(held) == 0 {
|
|
||||||
delete(h.heldBack, peer)
|
|
||||||
h.mu.Unlock()
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
msg := held[0]
|
|
||||||
held[0] = nil // so that the message is freed once applied
|
|
||||||
h.heldBack[peer] = held[1:]
|
|
||||||
h.heldCount--
|
|
||||||
h.heldTaken.Broadcast()
|
|
||||||
h.applyMessage(msg)
|
|
||||||
h.mu.Unlock()
|
|
||||||
|
|
||||||
if msg.Type == ristypes.MessageTypeState &&
|
|
||||||
msg.State == ristypes.StateDown {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// takeBatch returns the pending updates and leaves an empty batch in their
|
// takeBatch returns the pending updates and leaves an empty batch in their
|
||||||
@@ -578,13 +378,14 @@ func (h *PrefixHandler) applyToTable(update prefixUpdate) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// writeTableChanges writes at most tableChangesPerWrite changes of the routing
|
// writeTableChanges writes at most maxTableChangesPerWrite changes of the
|
||||||
// table in memory, and every peer the table numbered since the last write.
|
// routing table in memory, and every peer the table numbered since the last
|
||||||
|
// write.
|
||||||
// When the write fails, they go back to the table, so that a later write writes
|
// When the write fails, they go back to the table, so that a later write writes
|
||||||
// them again, each pair with its content then.
|
// them again, each pair with its content then.
|
||||||
func (h *PrefixHandler) writeTableChanges() {
|
func (h *PrefixHandler) writeTableChanges() {
|
||||||
h.mu.Lock()
|
h.mu.Lock()
|
||||||
changes, newPeers := h.table.TakeChanges(h.tableChangesPerWrite)
|
changes, newPeers := h.table.TakeChanges(maxTableChangesPerWrite)
|
||||||
h.writingTableChanges = len(changes)
|
h.writingTableChanges = len(changes)
|
||||||
h.mu.Unlock()
|
h.mu.Unlock()
|
||||||
|
|
||||||
|
|||||||
@@ -237,119 +237,22 @@ func TestPrefixHandlerStopLogsNothingWhenItWroteEverything(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestPrefixHandlerStopLogsTheMessagesHeldBack stops a prefix handler with a
|
// longerThanAnyTest is a flush timer interval that no test lasts. A test whose
|
||||||
// deadline that has passed, while a peer's PeersDown is held up and one message
|
// prefix, AS or peer handler must flush only when its batch is full and on Stop
|
||||||
// of the peer is held back. Stop must log that message as not applied.
|
// gives it to newPrefixHandler, newASHandler or newPeerHandler.
|
||||||
func TestPrefixHandlerStopLogsTheMessagesHeldBack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var logs bytes.Buffer
|
|
||||||
|
|
||||||
h := newPrefixHandler(newMockStore(), newErrorLogger(&logs),
|
|
||||||
routetable.New(routetable.Params{}), longerThanAnyTest,
|
|
||||||
maxTableChangesPerWrite)
|
|
||||||
|
|
||||||
release := holdUpPeersDown(h)
|
|
||||||
defer close(release)
|
|
||||||
|
|
||||||
h.HandleMessage(peerAnnouncement(testPeerIP, testV4Prefix))
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
h.HandleMessage(peerAnnouncement(testPeerIP, testV6Prefix))
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(t.Context())
|
|
||||||
cancel()
|
|
||||||
h.Stop(ctx)
|
|
||||||
|
|
||||||
logged := lastLogged(t, &logs)
|
|
||||||
if logged.HeldMessages != 1 {
|
|
||||||
t.Errorf("Stop logged %d held messages not applied, want 1",
|
|
||||||
logged.HeldMessages)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerStopWaitsForTheMessagesHeldBack stops a prefix handler
|
|
||||||
// while a peer's PeersDown is held up and an announcement of the peer is held
|
|
||||||
// back. Stop must wait. Once the PeersDown is let go and Stop returns, the
|
|
||||||
// announcement must be in the database.
|
|
||||||
func TestPrefixHandlerStopWaitsForTheMessagesHeldBack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := newTestDatabase(t)
|
|
||||||
h := newPrefixHandler(db, logger.New(), routetable.New(routetable.Params{}),
|
|
||||||
longerThanAnyTest, maxTableChangesPerWrite)
|
|
||||||
|
|
||||||
release := holdUpPeersDown(h)
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
h.HandleMessage(peerAnnouncement(testPeerIP, testV4Prefix))
|
|
||||||
|
|
||||||
stopped := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
h.Stop(t.Context())
|
|
||||||
close(stopped)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-stopped:
|
|
||||||
t.Error("Stop returned while a PeersDown was held up")
|
|
||||||
case <-time.After(stillWaitingAfter):
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-stopped:
|
|
||||||
case <-time.After(stepTimeout):
|
|
||||||
t.Fatalf("Stop did not return within %s of the PeersDown's release",
|
|
||||||
stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
read, err := db.ReadRouteTable(t.Context())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ReadRouteTable: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, read, map[string]map[int][]string{
|
|
||||||
testV4Prefix: {testASNB: {testPeerIP}},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// longerThanAnyTest is a timer interval that no test lasts. A test gives it to
|
|
||||||
// newPrefixHandler, newASHandler, newPeerHandler or newPeeringHandler when the
|
|
||||||
// handler must write only when its batch is full, when the test says, or on
|
|
||||||
// Stop.
|
|
||||||
const longerThanAnyTest = time.Hour
|
const longerThanAnyTest = time.Hour
|
||||||
|
|
||||||
// prefixHandlerWithoutTimer returns a prefix handler that writes to store and
|
// prefixHandlerWithoutTimer returns a prefix handler that writes to store and
|
||||||
// applies the updates to an empty routing table. It is built without
|
// applies the updates to an empty routing table. It is built without
|
||||||
// NewPrefixHandler's flush goroutine, so the test flushes itself.
|
// NewPrefixHandler's flush goroutine, so the test flushes itself.
|
||||||
func prefixHandlerWithoutTimer(store database.Store) *PrefixHandler {
|
func prefixHandlerWithoutTimer(store database.Store) *PrefixHandler {
|
||||||
table := routetable.New(routetable.Params{})
|
|
||||||
|
|
||||||
return &PrefixHandler{
|
return &PrefixHandler{
|
||||||
db: store,
|
db: store,
|
||||||
logger: logger.New(),
|
logger: logger.New(),
|
||||||
table: table,
|
table: routetable.New(routetable.Params{}),
|
||||||
batchMaxSize: prefixBatchMaxSize,
|
|
||||||
tableChangesPerWrite: maxTableChangesPerWrite,
|
|
||||||
heldBack: make(map[string][]*ristypes.RISMessage),
|
|
||||||
tablePeersDown: table.PeersDown,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// holdUpPeersDown makes each PeersDown of h wait until the returned channel is
|
|
||||||
// closed, as another peer's long PeersDown would hold it up. The test calls it
|
|
||||||
// before it hands h a message.
|
|
||||||
func holdUpPeersDown(h *PrefixHandler) chan struct{} {
|
|
||||||
release := make(chan struct{})
|
|
||||||
h.tablePeersDown = func(peers []string) {
|
|
||||||
<-release
|
|
||||||
h.table.PeersDown(peers)
|
|
||||||
}
|
|
||||||
|
|
||||||
return release
|
|
||||||
}
|
|
||||||
|
|
||||||
// newTestDatabase opens a database in a new temporary directory. It is closed
|
// newTestDatabase opens a database in a new temporary directory. It is closed
|
||||||
// when the test ends.
|
// when the test ends.
|
||||||
func newTestDatabase(t *testing.T) *database.Database {
|
func newTestDatabase(t *testing.T) *database.Database {
|
||||||
|
|||||||
@@ -7,10 +7,8 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"reflect"
|
"reflect"
|
||||||
"runtime"
|
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -32,13 +30,12 @@ const (
|
|||||||
|
|
||||||
// firstManyPrefix is the first prefix announceManyPrefixes announces.
|
// firstManyPrefix is the first prefix announceManyPrefixes announces.
|
||||||
firstManyPrefix = "10.0.0.0/32"
|
firstManyPrefix = "10.0.0.0/32"
|
||||||
|
|
||||||
// testMaxTableChangesPerWrite is a limit of one write of the routing
|
|
||||||
// table's changes that a test exceeds quickly, in place of
|
|
||||||
// maxTableChangesPerWrite.
|
|
||||||
testMaxTableChangesPerWrite = 10
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// tableWriteTimeout is how long a test waits for the flush timer to write the
|
||||||
|
// routing table's changes: a few ticks of it.
|
||||||
|
const tableWriteTimeout = 5 * prefixBatchTimeout
|
||||||
|
|
||||||
// tableCase is one test of the routing table in memory: the messages handed to
|
// tableCase is one test of the routing table in memory: the messages handed to
|
||||||
// the prefix handler, and for each prefix the peers that carry it with each
|
// the prefix handler, and for each prefix the peers that carry it with each
|
||||||
// origin AS after them.
|
// origin AS after them.
|
||||||
@@ -103,359 +100,6 @@ func TestPrefixHandlerAppliesUpdatesToTheRoutingTable(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestPrefixHandlerTakesMessagesWhileAPeerGoesDown holds up the PeersDown of a
|
|
||||||
// peer whose session went down, as another peer's long PeersDown would. The
|
|
||||||
// handler must go on taking messages. It applies another peer's announcement
|
|
||||||
// at once. It holds back these messages of the down peer, in this order:
|
|
||||||
// - an announcement;
|
|
||||||
// - its session going down again;
|
|
||||||
// - a second announcement.
|
|
||||||
//
|
|
||||||
// HeldBackCount must count them. Once the PeersDown calls have returned, the
|
|
||||||
// down peer must carry only the prefix of the second announcement.
|
|
||||||
func TestPrefixHandlerTakesMessagesWhileAPeerGoesDown(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const heldMessages = 3
|
|
||||||
|
|
||||||
h := prefixHandlerWithoutTimer(newMockStore())
|
|
||||||
release := holdUpPeersDown(h)
|
|
||||||
h.HandleMessage(peerAnnouncement(testPeerIP, testV4Prefix))
|
|
||||||
|
|
||||||
handled := returnsInTime(func() {
|
|
||||||
for _, msg := range []*ristypes.RISMessage{
|
|
||||||
sessionDown(),
|
|
||||||
peerAnnouncement(secondPeerIP, otherV4Prefix),
|
|
||||||
peerAnnouncement(testPeerIP, testV6Prefix),
|
|
||||||
sessionDown(),
|
|
||||||
peerAnnouncement(testPeerIP, setV4Prefix),
|
|
||||||
} {
|
|
||||||
h.HandleMessage(msg)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
if !handled {
|
|
||||||
t.Fatalf("the handler did not take the messages after the session "+
|
|
||||||
"went down within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, h.table, map[string]map[int][]string{
|
|
||||||
testV4Prefix: {testASNB: {testPeerIP}},
|
|
||||||
otherV4Prefix: {testASNB: {secondPeerIP}},
|
|
||||||
testV6Prefix: {},
|
|
||||||
setV4Prefix: {},
|
|
||||||
})
|
|
||||||
|
|
||||||
if h.HeldBackCount() != heldMessages {
|
|
||||||
t.Errorf("HeldBackCount() = %d, want %d", h.HeldBackCount(),
|
|
||||||
heldMessages)
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
if !returnsInTime(h.peerDowns.Wait) {
|
|
||||||
t.Fatalf("the PeersDown calls did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, h.table, map[string]map[int][]string{
|
|
||||||
testV4Prefix: {},
|
|
||||||
otherV4Prefix: {testASNB: {secondPeerIP}},
|
|
||||||
testV6Prefix: {},
|
|
||||||
setV4Prefix: {testASNB: {testPeerIP}},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerTakesPeersDownTogether has four peers announce testV4Prefix.
|
|
||||||
// It holds up the PeersDown of the first peer, whose session goes down.
|
|
||||||
// Meanwhile the sessions of the three others go down, and each of them
|
|
||||||
// announces otherV4Prefix. Once the first PeersDown is let go, the next one
|
|
||||||
// must take the three others together. No peer may then carry testV4Prefix,
|
|
||||||
// and the three others must carry otherV4Prefix.
|
|
||||||
func TestPrefixHandlerTakesPeersDownTogether(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
others := []string{secondPeerIP, thirdPeerIP, fourthPeerIP}
|
|
||||||
h := prefixHandlerWithoutTimer(newMockStore())
|
|
||||||
|
|
||||||
// calls receives the peers of each PeersDown, with room for one call
|
|
||||||
// for each peer.
|
|
||||||
calls := make(chan []string, len(others)+1)
|
|
||||||
release := make(chan struct{})
|
|
||||||
h.tablePeersDown = func(peers []string) {
|
|
||||||
calls <- slices.Clone(peers)
|
|
||||||
|
|
||||||
<-release
|
|
||||||
h.table.PeersDown(peers)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, peer := range append([]string{testPeerIP}, others...) {
|
|
||||||
h.HandleMessage(peerAnnouncement(peer, testV4Prefix))
|
|
||||||
}
|
|
||||||
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-calls:
|
|
||||||
case <-time.After(stepTimeout):
|
|
||||||
t.Fatalf("PeersDown did not begin within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, peer := range others {
|
|
||||||
h.HandleMessage(sessionDownOf(peer))
|
|
||||||
h.HandleMessage(peerAnnouncement(peer, otherV4Prefix))
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
if !returnsInTime(h.peerDowns.Wait) {
|
|
||||||
t.Fatalf("the PeersDown calls did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
close(calls)
|
|
||||||
|
|
||||||
later := make([][]string, 0, len(calls))
|
|
||||||
for peers := range calls {
|
|
||||||
later = append(later, peers)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(later, [][]string{others}) {
|
|
||||||
t.Errorf("the PeersDown calls after the first took %v, want %v "+
|
|
||||||
"together", later, others)
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, h.table, map[string]map[int][]string{
|
|
||||||
testV4Prefix: {},
|
|
||||||
otherV4Prefix: {testASNB: others},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerAppliesMessagesWhilePeersDownRuns gives a peer 50,000
|
|
||||||
// prefixes and hands the prefix handler that peer's session going down. The
|
|
||||||
// table's PeersDown then visits the prefixes in five batches. Once PeersDown
|
|
||||||
// has begun, the handler is handed 1,000 announcements of another peer. The
|
|
||||||
// handler must apply them all before PeersDown ends, while the down peer still
|
|
||||||
// carries some of its prefixes.
|
|
||||||
func TestPrefixHandlerAppliesMessagesWhilePeersDownRuns(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
// downPeerPrefixes is five times the 10,000 prefixes PeersDown visits
|
|
||||||
// in one hold of the table's lock.
|
|
||||||
downPeerPrefixes = 50000
|
|
||||||
// otherPeerMessages is far more messages than the handler applies
|
|
||||||
// while PeersDown runs, if PeersDown takes the lock back at once after
|
|
||||||
// each batch. The handler then applies only a few for each batch.
|
|
||||||
otherPeerMessages = 1000
|
|
||||||
// firstOtherAddr is the address of the other peer's first prefix.
|
|
||||||
firstOtherAddr = "2001:db8:2::"
|
|
||||||
)
|
|
||||||
|
|
||||||
h := prefixHandlerWithoutTimer(newMockStore())
|
|
||||||
announceManyPrefixes(h.table, downPeerPrefixes)
|
|
||||||
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
|
|
||||||
// Wait until PeersDown has begun: the down peer has left some of its
|
|
||||||
// prefixes. The down peer's prefixes are IPv4 and the other peer's are
|
|
||||||
// IPv6, so the counts tell them apart.
|
|
||||||
for h.table.Counts().IPv4Routes == downPeerPrefixes {
|
|
||||||
runtime.Gosched()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Each announcement names the /128 of the next address.
|
|
||||||
addr := netip.MustParseAddr(firstOtherAddr)
|
|
||||||
for range otherPeerMessages {
|
|
||||||
h.HandleMessage(peerAnnouncement(secondPeerIP,
|
|
||||||
netip.PrefixFrom(addr, addr.BitLen()).String()))
|
|
||||||
|
|
||||||
addr = addr.Next()
|
|
||||||
}
|
|
||||||
|
|
||||||
counts := h.table.Counts()
|
|
||||||
if counts.IPv6Routes != otherPeerMessages {
|
|
||||||
t.Errorf("the other peer carries %d prefixes, want %d",
|
|
||||||
counts.IPv6Routes, otherPeerMessages)
|
|
||||||
}
|
|
||||||
|
|
||||||
if counts.IPv4Routes == 0 {
|
|
||||||
t.Errorf("PeersDown ended before the handler applied the other peer's "+
|
|
||||||
"%d announcements", otherPeerMessages)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !returnsInTime(h.peerDowns.Wait) {
|
|
||||||
t.Fatalf("the PeersDown did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerTakesMessagesWhileAReturningPeerSendsItsTable gives a peer
|
|
||||||
// 50,000 prefixes and hands the prefix handler that peer's session going down.
|
|
||||||
// Once PeersDown has begun, the peer comes back and sends more announcements
|
|
||||||
// than the handler's queue holds, as a peer that sends its whole table again
|
|
||||||
// does. The handler must hold them back and go on taking messages. Another
|
|
||||||
// peer's announcement, handed next, must be applied before PeersDown ends.
|
|
||||||
func TestPrefixHandlerTakesMessagesWhileAReturningPeerSendsItsTable(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
// downPeerPrefixes is five times the 10,000 prefixes PeersDown visits
|
|
||||||
// in one hold of the table's lock.
|
|
||||||
downPeerPrefixes = 50000
|
|
||||||
returningMessages = prefixHandlerQueueSize + 1
|
|
||||||
)
|
|
||||||
|
|
||||||
table := routetable.New(routetable.Params{})
|
|
||||||
announceManyPrefixes(table, downPeerPrefixes)
|
|
||||||
|
|
||||||
h := newPrefixHandler(newMockStore(), logger.New(), table,
|
|
||||||
longerThanAnyTest, maxTableChangesPerWrite)
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
|
|
||||||
// Wait until PeersDown has begun: the down peer has left some of its
|
|
||||||
// prefixes, which are all IPv4.
|
|
||||||
for h.table.Counts().IPv4Routes == downPeerPrefixes {
|
|
||||||
runtime.Gosched()
|
|
||||||
}
|
|
||||||
|
|
||||||
returning := peerAnnouncement(testPeerIP, testV6Prefix)
|
|
||||||
|
|
||||||
if !returnsInTime(func() {
|
|
||||||
for range returningMessages {
|
|
||||||
h.HandleMessage(returning)
|
|
||||||
}
|
|
||||||
|
|
||||||
h.HandleMessage(peerAnnouncement(secondPeerIP, testV6Prefix))
|
|
||||||
}) {
|
|
||||||
t.Fatalf("the handler did not take the messages within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
if h.table.Counts().IPv4Routes == 0 {
|
|
||||||
t.Error("PeersDown ended before the handler took the other peer's " +
|
|
||||||
"announcement")
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, h.table, map[string]map[int][]string{
|
|
||||||
testV6Prefix: {testASNB: {secondPeerIP}},
|
|
||||||
})
|
|
||||||
|
|
||||||
if !returnsInTime(h.peerDowns.Wait) {
|
|
||||||
t.Fatalf("the PeersDown did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
checkTableOrigins(t, h.table, map[string]map[int][]string{
|
|
||||||
testV6Prefix: {testASNB: {testPeerIP, secondPeerIP}},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerTakesMessagesWhileItAppliesHeldBackOnes holds back many
|
|
||||||
// messages of a peer whose session went down. Each names a prefix that does
|
|
||||||
// not parse, so applying it logs an error. Each log write takes a
|
|
||||||
// millisecond. While the handler applies the held-back messages, it must take
|
|
||||||
// another peer's announcement.
|
|
||||||
func TestPrefixHandlerTakesMessagesWhileItAppliesHeldBackOnes(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
// heldMessages take the handler at least a second to apply.
|
|
||||||
heldMessages = 1000
|
|
||||||
badPrefix = "not a prefix"
|
|
||||||
)
|
|
||||||
|
|
||||||
logs := &slowWriter{firstWrite: make(chan struct{})}
|
|
||||||
h := newPrefixHandler(newMockStore(), newErrorLogger(logs),
|
|
||||||
routetable.New(routetable.Params{}), longerThanAnyTest,
|
|
||||||
maxTableChangesPerWrite)
|
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
release := holdUpPeersDown(h)
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
|
|
||||||
for range heldMessages {
|
|
||||||
h.HandleMessage(peerAnnouncement(testPeerIP, badPrefix))
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-logs.firstWrite:
|
|
||||||
case <-time.After(stepTimeout):
|
|
||||||
t.Fatal("the handler did not start to apply the held-back messages")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !returnsInTime(func() {
|
|
||||||
h.HandleMessage(peerAnnouncement(secondPeerIP, otherV4Prefix))
|
|
||||||
}) {
|
|
||||||
t.Fatalf("HandleMessage did not return within %s", stepTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
h.mu.Lock()
|
|
||||||
left := len(h.heldBack[testPeerIP])
|
|
||||||
h.mu.Unlock()
|
|
||||||
|
|
||||||
if left == 0 {
|
|
||||||
t.Error("the handler took another peer's announcement only once it " +
|
|
||||||
"had applied every held-back message")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerWaitsAtTheMaximumHeldBack holds up the PeersDown of a peer
|
|
||||||
// whose session went down. It hands the handler maxHeldBackMessages messages
|
|
||||||
// of that peer. HandleMessage must then wait, even for another peer's
|
|
||||||
// message, until the PeersDown returns and a held-back message is applied.
|
|
||||||
func TestPrefixHandlerWaitsAtTheMaximumHeldBack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h := newPrefixHandler(newMockStore(), logger.New(),
|
|
||||||
routetable.New(routetable.Params{}), longerThanAnyTest,
|
|
||||||
maxTableChangesPerWrite)
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
release := holdUpPeersDown(h)
|
|
||||||
h.HandleMessage(sessionDown())
|
|
||||||
|
|
||||||
held := peerAnnouncement(testPeerIP, testV6Prefix)
|
|
||||||
for range maxHeldBackMessages {
|
|
||||||
h.HandleMessage(held)
|
|
||||||
}
|
|
||||||
|
|
||||||
returned := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
h.HandleMessage(peerAnnouncement(secondPeerIP, otherV4Prefix))
|
|
||||||
close(returned)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-returned:
|
|
||||||
t.Error("HandleMessage returned while maxHeldBackMessages messages " +
|
|
||||||
"were held back")
|
|
||||||
case <-time.After(stillWaitingAfter):
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-returned:
|
|
||||||
case <-time.After(stepTimeout):
|
|
||||||
t.Fatal("HandleMessage did not return after the PeersDown returned")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// slowWriter takes a millisecond over each write and drops what it is given.
|
|
||||||
// It closes firstWrite at the first write.
|
|
||||||
type slowWriter struct {
|
|
||||||
firstWrite chan struct{}
|
|
||||||
once sync.Once
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *slowWriter) Write(p []byte) (int, error) {
|
|
||||||
w.once.Do(func() { close(w.firstWrite) })
|
|
||||||
time.Sleep(time.Millisecond)
|
|
||||||
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPrefixHandlerAppliesAPathWithoutAnOriginToTheRoutingTable hands the
|
// TestPrefixHandlerAppliesAPathWithoutAnOriginToTheRoutingTable hands the
|
||||||
// prefix handler announcements whose AS path gives no origin. One whose path
|
// prefix handler announcements whose AS path gives no origin. One whose path
|
||||||
// is empty or holds AS 0 removes the peer's route, as a withdrawal does; one
|
// is empty or holds AS 0 removes the peer's route, as a withdrawal does; one
|
||||||
@@ -554,9 +198,8 @@ func TestPrefixHandlerKeepsThePathOfAPathEndingInASet(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkTableCases hands the messages of each case to a new prefix handler. It
|
// checkTableCases hands the messages of each case to a new prefix handler and
|
||||||
// checks the handler's routing table once the handler's PeersDown calls have
|
// checks its routing table right after, with no flush.
|
||||||
// returned, with no flush.
|
|
||||||
func checkTableCases(t *testing.T, tests []tableCase) {
|
func checkTableCases(t *testing.T, tests []tableCase) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
@@ -569,26 +212,15 @@ func checkTableCases(t *testing.T, tests []tableCase) {
|
|||||||
h.HandleMessage(msg)
|
h.HandleMessage(msg)
|
||||||
}
|
}
|
||||||
|
|
||||||
h.peerDowns.Wait()
|
for prefix, want := range tt.want {
|
||||||
checkTableOrigins(t, h.table, tt.want)
|
got := tableOrigins(h.table, prefix)
|
||||||
})
|
if !reflect.DeepEqual(got, want) {
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkTableOrigins checks, for each prefix in want, the peers that carry it
|
|
||||||
// in table with each origin AS.
|
|
||||||
func checkTableOrigins(
|
|
||||||
t *testing.T, table *routetable.Table, want map[string]map[int][]string,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for prefix, wantOrigins := range want {
|
|
||||||
got := tableOrigins(table, prefix)
|
|
||||||
if !reflect.DeepEqual(got, wantOrigins) {
|
|
||||||
t.Errorf("peers of %s by origin AS = %v, want %v",
|
t.Errorf("peers of %s by origin AS = %v, want %v",
|
||||||
prefix, got, wantOrigins)
|
prefix, got, want)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// tableWritesStore is a real database that hands each write of the routing
|
// tableWritesStore is a real database that hands each write of the routing
|
||||||
@@ -644,9 +276,9 @@ func TestPrefixHandlerWritesTheTableChangesEachSecond(t *testing.T) {
|
|||||||
t.Fatalf("wrote %+v, want the pair of %s and AS%d with "+
|
t.Fatalf("wrote %+v, want the pair of %s and AS%d with "+
|
||||||
"removed %t", changes, prefix, testASNB, step.wantRemoved)
|
"removed %t", changes, prefix, testASNB, step.wantRemoved)
|
||||||
}
|
}
|
||||||
case <-time.After(stepTimeout):
|
case <-time.After(tableWriteTimeout):
|
||||||
t.Fatalf("the routing table's change was not written within %s",
|
t.Fatalf("the routing table's change was not written within %s",
|
||||||
stepTimeout)
|
tableWriteTimeout)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -743,32 +375,25 @@ func (s *tableWriteSizesStore) WriteRouteChanges(
|
|||||||
// takes, then flushes three times. The first write must hold as many pairs as
|
// takes, then flushes three times. The first write must hold as many pairs as
|
||||||
// one write takes, and the peer. The second must hold the other pairs, and the
|
// one write takes, and the peer. The second must hold the other pairs, and the
|
||||||
// third flush must write nothing. The database must then hold the table in
|
// third flush must write nothing. The database must then hold the table in
|
||||||
// memory. The handler's limit is small, and its timer does not fire.
|
// memory.
|
||||||
func TestPrefixHandlerWritesManyTableChangesOverSeveralFlushes(t *testing.T) {
|
func TestPrefixHandlerWritesManyTableChangesOverSeveralFlushes(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const (
|
||||||
pairs = testMaxTableChangesPerWrite * 3 / 2
|
pairs = maxTableChangesPerWrite * 3 / 2
|
||||||
flushes = 3
|
flushes = 3
|
||||||
)
|
)
|
||||||
|
|
||||||
db := newTestDatabase(t)
|
db := newTestDatabase(t)
|
||||||
store := &tableWriteSizesStore{Database: db}
|
store := &tableWriteSizesStore{Database: db}
|
||||||
table := routetable.New(routetable.Params{})
|
h := prefixHandlerWithoutTimer(store)
|
||||||
announceManyPrefixes(table, pairs)
|
announceManyPrefixes(h.table, pairs)
|
||||||
|
|
||||||
h := newPrefixHandler(store, logger.New(), table, longerThanAnyTest,
|
|
||||||
testMaxTableChangesPerWrite)
|
|
||||||
|
|
||||||
defer stopInTime(t, h)
|
|
||||||
|
|
||||||
for range flushes {
|
for range flushes {
|
||||||
h.flushBatch()
|
h.flushBatch()
|
||||||
}
|
}
|
||||||
|
|
||||||
wantChanges := []int{
|
wantChanges := []int{maxTableChangesPerWrite, pairs - maxTableChangesPerWrite}
|
||||||
testMaxTableChangesPerWrite, pairs - testMaxTableChangesPerWrite,
|
|
||||||
}
|
|
||||||
wantNewPeers := []int{1, 0}
|
wantNewPeers := []int{1, 0}
|
||||||
|
|
||||||
if !slices.Equal(store.changes, wantChanges) ||
|
if !slices.Equal(store.changes, wantChanges) ||
|
||||||
@@ -790,11 +415,11 @@ func TestPrefixHandlerWritesManyTableChangesOverSeveralFlushes(t *testing.T) {
|
|||||||
// takes. Its last flush writes one write's worth, so Stop must log the pairs
|
// takes. Its last flush writes one write's worth, so Stop must log the pairs
|
||||||
// that no write took, and must not say that the stop deadline passed. The
|
// that no write took, and must not say that the stop deadline passed. The
|
||||||
// flush timer must not fire, or its writes could leave no pairs for Stop to
|
// flush timer must not fire, or its writes could leave no pairs for Stop to
|
||||||
// log. The handler's limit of one write is small.
|
// log.
|
||||||
func TestPrefixHandlerStopLogsTheTableChangesLeftUnwritten(t *testing.T) {
|
func TestPrefixHandlerStopLogsTheTableChangesLeftUnwritten(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const pairs = testMaxTableChangesPerWrite + 1
|
const pairs = maxTableChangesPerWrite + 1
|
||||||
|
|
||||||
var logs bytes.Buffer
|
var logs bytes.Buffer
|
||||||
|
|
||||||
@@ -802,8 +427,7 @@ func TestPrefixHandlerStopLogsTheTableChangesLeftUnwritten(t *testing.T) {
|
|||||||
table := routetable.New(routetable.Params{})
|
table := routetable.New(routetable.Params{})
|
||||||
announceManyPrefixes(table, pairs)
|
announceManyPrefixes(table, pairs)
|
||||||
|
|
||||||
h := newPrefixHandler(store, newErrorLogger(&logs), table, longerThanAnyTest,
|
h := newPrefixHandler(store, newErrorLogger(&logs), table, longerThanAnyTest)
|
||||||
testMaxTableChangesPerWrite)
|
|
||||||
h.Stop(t.Context())
|
h.Stop(t.Context())
|
||||||
|
|
||||||
written := 0
|
written := 0
|
||||||
@@ -865,7 +489,6 @@ func TestARestartReadsTheRoutingTableBack(t *testing.T) {
|
|||||||
h.HandleMessage(msg)
|
h.HandleMessage(msg)
|
||||||
}
|
}
|
||||||
|
|
||||||
h.peerDowns.Wait()
|
|
||||||
h.flushBatch()
|
h.flushBatch()
|
||||||
|
|
||||||
var logs bytes.Buffer
|
var logs bytes.Buffer
|
||||||
@@ -904,7 +527,6 @@ func TestARestartReadsTheRoutingTableBack(t *testing.T) {
|
|||||||
restarted.HandleMessage(msg)
|
restarted.HandleMessage(msg)
|
||||||
}
|
}
|
||||||
|
|
||||||
h.peerDowns.Wait()
|
|
||||||
restarted.Stop(t.Context())
|
restarted.Stop(t.Context())
|
||||||
|
|
||||||
read, err := db.ReadRouteTable(t.Context())
|
read, err := db.ReadRouteTable(t.Context())
|
||||||
|
|||||||
+26
-36
@@ -23,6 +23,7 @@ import (
|
|||||||
"git.eeqj.de/sneak/routewatch/internal/streamer"
|
"git.eeqj.de/sneak/routewatch/internal/streamer"
|
||||||
"git.eeqj.de/sneak/routewatch/internal/templates"
|
"git.eeqj.de/sneak/routewatch/internal/templates"
|
||||||
asinfo "git.eeqj.de/sneak/routewatch/pkg/asinfo"
|
asinfo "git.eeqj.de/sneak/routewatch/pkg/asinfo"
|
||||||
|
"github.com/dustin/go-humanize"
|
||||||
"github.com/go-chi/chi/v5"
|
"github.com/go-chi/chi/v5"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -225,23 +226,18 @@ type WHOISStatsInfo struct {
|
|||||||
NeverFetched int `json:"never_fetched"`
|
NeverFetched int `json:"never_fetched"`
|
||||||
SuccessesLastHour int `json:"successes_last_hour"`
|
SuccessesLastHour int `json:"successes_last_hour"`
|
||||||
ErrorsLastHour int `json:"errors_last_hour"`
|
ErrorsLastHour int `json:"errors_last_hour"`
|
||||||
|
CurrentInterval string `json:"current_interval"`
|
||||||
ConsecutiveFails int `json:"consecutive_fails"`
|
ConsecutiveFails int `json:"consecutive_fails"`
|
||||||
FreshPercent float64 `json:"fresh_percent"`
|
FreshPercent float64 `json:"fresh_percent"`
|
||||||
|
|
||||||
// CurrentIntervalSeconds is the wait between two fetches. It can have a
|
|
||||||
// fractional part, such as 22.5.
|
|
||||||
CurrentIntervalSeconds float64 `json:"current_interval_seconds"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stats is the /status.json answer: uptime, message counts, database stats,
|
// Stats is the /status.json answer: uptime, message counts, database stats,
|
||||||
// and the routing table's figures. UptimeSeconds is the time since the stream
|
// and the routing table's figures. OldestRoute and NewestRoute are the times
|
||||||
// last connected, or 0 if it has never connected. MemoryUsageBytes is the Go
|
// of the oldest and the newest kept routes.
|
||||||
// heap in use. OldestRoute and NewestRoute are the times of the oldest and the
|
|
||||||
// newest kept routes.
|
|
||||||
//
|
//
|
||||||
//nolint:tagliatelle // field names are the existing JSON API
|
//nolint:tagliatelle // field names are the existing JSON API
|
||||||
type Stats struct {
|
type Stats struct {
|
||||||
UptimeSeconds int64 `json:"uptime_seconds"`
|
Uptime string `json:"uptime"`
|
||||||
TotalMessages uint64 `json:"total_messages"`
|
TotalMessages uint64 `json:"total_messages"`
|
||||||
TotalBytes uint64 `json:"total_bytes"`
|
TotalBytes uint64 `json:"total_bytes"`
|
||||||
TotalWireBytes uint64 `json:"total_wire_bytes"`
|
TotalWireBytes uint64 `json:"total_wire_bytes"`
|
||||||
@@ -251,7 +247,7 @@ type Stats struct {
|
|||||||
Connected bool `json:"connected"`
|
Connected bool `json:"connected"`
|
||||||
GoVersion string `json:"go_version"`
|
GoVersion string `json:"go_version"`
|
||||||
Goroutines int `json:"goroutines"`
|
Goroutines int `json:"goroutines"`
|
||||||
MemoryUsageBytes uint64 `json:"memory_usage_bytes"`
|
MemoryUsage string `json:"memory_usage"`
|
||||||
ASNs int `json:"asns"`
|
ASNs int `json:"asns"`
|
||||||
Prefixes int `json:"prefixes"`
|
Prefixes int `json:"prefixes"`
|
||||||
IPv4Prefixes int `json:"ipv4_prefixes"`
|
IPv4Prefixes int `json:"ipv4_prefixes"`
|
||||||
@@ -366,7 +362,7 @@ func (s *Server) statusStats(
|
|||||||
runtime.ReadMemStats(&memStats)
|
runtime.ReadMemStats(&memStats)
|
||||||
|
|
||||||
return Stats{
|
return Stats{
|
||||||
UptimeSeconds: uptimeSeconds(streamMetrics.ConnectedSince),
|
Uptime: streamUptime(streamMetrics.ConnectedSince),
|
||||||
TotalMessages: streamMetrics.TotalMessages,
|
TotalMessages: streamMetrics.TotalMessages,
|
||||||
TotalBytes: streamMetrics.TotalBytes,
|
TotalBytes: streamMetrics.TotalBytes,
|
||||||
TotalWireBytes: streamMetrics.TotalWireBytes,
|
TotalWireBytes: streamMetrics.TotalWireBytes,
|
||||||
@@ -376,7 +372,7 @@ func (s *Server) statusStats(
|
|||||||
Connected: streamMetrics.Connected,
|
Connected: streamMetrics.Connected,
|
||||||
GoVersion: runtime.Version(),
|
GoVersion: runtime.Version(),
|
||||||
Goroutines: runtime.NumGoroutine(),
|
Goroutines: runtime.NumGoroutine(),
|
||||||
MemoryUsageBytes: memStats.Alloc,
|
MemoryUsage: humanize.Bytes(memStats.Alloc),
|
||||||
ASNs: dbStats.ASNs,
|
ASNs: dbStats.ASNs,
|
||||||
Prefixes: counts.IPv4Prefixes + counts.IPv6Prefixes,
|
Prefixes: counts.IPv4Prefixes + counts.IPv6Prefixes,
|
||||||
IPv4Prefixes: counts.IPv4Prefixes,
|
IPv4Prefixes: counts.IPv4Prefixes,
|
||||||
@@ -443,31 +439,30 @@ func (s *Server) getWHOISStats(ctx context.Context) *WHOISStatsInfo {
|
|||||||
NeverFetched: dbStats.NeverFetched,
|
NeverFetched: dbStats.NeverFetched,
|
||||||
SuccessesLastHour: fetcherStats.SuccessesLastHour,
|
SuccessesLastHour: fetcherStats.SuccessesLastHour,
|
||||||
ErrorsLastHour: fetcherStats.ErrorsLastHour,
|
ErrorsLastHour: fetcherStats.ErrorsLastHour,
|
||||||
|
CurrentInterval: fetcherStats.CurrentInterval.String(),
|
||||||
ConsecutiveFails: fetcherStats.ConsecutiveFails,
|
ConsecutiveFails: fetcherStats.ConsecutiveFails,
|
||||||
FreshPercent: freshPercent,
|
FreshPercent: freshPercent,
|
||||||
|
|
||||||
CurrentIntervalSeconds: fetcherStats.CurrentInterval.Seconds(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// uptimeSeconds is the number of whole seconds since the stream last
|
// streamUptime is how long the stream has been connected, to the second, or
|
||||||
// connected, or 0 if it has never connected.
|
// "0s" if it has never connected.
|
||||||
func uptimeSeconds(connectedSince time.Time) int64 {
|
func streamUptime(connectedSince time.Time) string {
|
||||||
if connectedSince.IsZero() {
|
if connectedSince.IsZero() {
|
||||||
return 0
|
return "0s"
|
||||||
}
|
}
|
||||||
|
|
||||||
return int64(time.Since(connectedSince) / time.Second)
|
return time.Since(connectedSince).Truncate(time.Second).String()
|
||||||
}
|
}
|
||||||
|
|
||||||
// connectionDurationSeconds is the number of whole seconds the stream has
|
// connectionDuration is how long the stream has been connected, to the
|
||||||
// been connected, or nil while it is not connected.
|
// second, or "disconnected".
|
||||||
func connectionDurationSeconds(connected bool, connectedSince time.Time) *int64 {
|
func connectionDuration(connected bool, connectedSince time.Time) string {
|
||||||
if !connected || connectedSince.IsZero() {
|
if !connected || connectedSince.IsZero() {
|
||||||
return nil
|
return "disconnected"
|
||||||
}
|
}
|
||||||
|
|
||||||
return new(uptimeSeconds(connectedSince))
|
return time.Since(connectedSince).Truncate(time.Second).String()
|
||||||
}
|
}
|
||||||
|
|
||||||
// whoisStaleThreshold matches the fetcher's threshold for consistency.
|
// whoisStaleThreshold matches the fetcher's threshold for consistency.
|
||||||
@@ -486,7 +481,6 @@ type HandlerStatsInfo struct {
|
|||||||
QueueHighWaterMark int `json:"queue_high_water_mark"`
|
QueueHighWaterMark int `json:"queue_high_water_mark"`
|
||||||
ProcessedCount uint64 `json:"processed_count"`
|
ProcessedCount uint64 `json:"processed_count"`
|
||||||
DroppedCount uint64 `json:"dropped_count"`
|
DroppedCount uint64 `json:"dropped_count"`
|
||||||
HeldBackCount int `json:"held_back_count"`
|
|
||||||
AvgProcessTimeMs float64 `json:"avg_process_time_ms"`
|
AvgProcessTimeMs float64 `json:"avg_process_time_ms"`
|
||||||
MinProcessTimeMs float64 `json:"min_process_time_ms"`
|
MinProcessTimeMs float64 `json:"min_process_time_ms"`
|
||||||
MaxProcessTimeMs float64 `json:"max_process_time_ms"`
|
MaxProcessTimeMs float64 `json:"max_process_time_ms"`
|
||||||
@@ -518,7 +512,7 @@ type StreamStats struct {
|
|||||||
//
|
//
|
||||||
//nolint:tagliatelle // field names are the existing JSON API
|
//nolint:tagliatelle // field names are the existing JSON API
|
||||||
type StatsResponse struct {
|
type StatsResponse struct {
|
||||||
UptimeSeconds int64 `json:"uptime_seconds"`
|
Uptime string `json:"uptime"`
|
||||||
TotalMessages uint64 `json:"total_messages"`
|
TotalMessages uint64 `json:"total_messages"`
|
||||||
TotalBytes uint64 `json:"total_bytes"`
|
TotalBytes uint64 `json:"total_bytes"`
|
||||||
TotalWireBytes uint64 `json:"total_wire_bytes"`
|
TotalWireBytes uint64 `json:"total_wire_bytes"`
|
||||||
@@ -526,10 +520,11 @@ type StatsResponse struct {
|
|||||||
MbitsPerSec float64 `json:"mbits_per_sec"`
|
MbitsPerSec float64 `json:"mbits_per_sec"`
|
||||||
WireMbitsPerSec float64 `json:"wire_mbits_per_sec"`
|
WireMbitsPerSec float64 `json:"wire_mbits_per_sec"`
|
||||||
Connected bool `json:"connected"`
|
Connected bool `json:"connected"`
|
||||||
|
ConnectionDuration string `json:"connection_duration"`
|
||||||
ReconnectCount uint64 `json:"reconnect_count"`
|
ReconnectCount uint64 `json:"reconnect_count"`
|
||||||
GoVersion string `json:"go_version"`
|
GoVersion string `json:"go_version"`
|
||||||
Goroutines int `json:"goroutines"`
|
Goroutines int `json:"goroutines"`
|
||||||
MemoryUsageBytes uint64 `json:"memory_usage_bytes"`
|
MemoryUsage string `json:"memory_usage"`
|
||||||
GC GCStats `json:"gc"`
|
GC GCStats `json:"gc"`
|
||||||
Stream StreamStats `json:"stream"`
|
Stream StreamStats `json:"stream"`
|
||||||
ASNs int `json:"asns"`
|
ASNs int `json:"asns"`
|
||||||
@@ -551,9 +546,6 @@ type StatsResponse struct {
|
|||||||
IPv6PrefixDistribution []PrefixDistribution `json:"ipv6_prefix_distribution"`
|
IPv6PrefixDistribution []PrefixDistribution `json:"ipv6_prefix_distribution"`
|
||||||
WHOISStats *WHOISStatsInfo `json:"whois_stats,omitempty"`
|
WHOISStats *WHOISStatsInfo `json:"whois_stats,omitempty"`
|
||||||
|
|
||||||
// ConnectionDurationSeconds is null while the stream is not connected.
|
|
||||||
ConnectionDurationSeconds *int64 `json:"connection_duration_seconds"`
|
|
||||||
|
|
||||||
OriginsWithoutKeptRoute int `json:"origins_without_kept_route"`
|
OriginsWithoutKeptRoute int `json:"origins_without_kept_route"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -571,7 +563,6 @@ func handlerStatsInfo(handlerStats []streamer.HandlerStats) []HandlerStatsInfo {
|
|||||||
QueueHighWaterMark: hs.QueueHighWaterMark,
|
QueueHighWaterMark: hs.QueueHighWaterMark,
|
||||||
ProcessedCount: hs.ProcessedCount,
|
ProcessedCount: hs.ProcessedCount,
|
||||||
DroppedCount: hs.DroppedCount,
|
DroppedCount: hs.DroppedCount,
|
||||||
HeldBackCount: hs.HeldBackCount,
|
|
||||||
AvgProcessTimeMs: float64(hs.AvgProcessTime.Microseconds()) /
|
AvgProcessTimeMs: float64(hs.AvgProcessTime.Microseconds()) /
|
||||||
microsecondsPerMillisecond,
|
microsecondsPerMillisecond,
|
||||||
MinProcessTimeMs: float64(hs.MinProcessTime.Microseconds()) /
|
MinProcessTimeMs: float64(hs.MinProcessTime.Microseconds()) /
|
||||||
@@ -693,7 +684,7 @@ func (s *Server) statsResponse(
|
|||||||
runtime.ReadMemStats(&memStats)
|
runtime.ReadMemStats(&memStats)
|
||||||
|
|
||||||
return StatsResponse{
|
return StatsResponse{
|
||||||
UptimeSeconds: uptimeSeconds(streamMetrics.ConnectedSince),
|
Uptime: streamUptime(streamMetrics.ConnectedSince),
|
||||||
TotalMessages: streamMetrics.TotalMessages,
|
TotalMessages: streamMetrics.TotalMessages,
|
||||||
TotalBytes: streamMetrics.TotalBytes,
|
TotalBytes: streamMetrics.TotalBytes,
|
||||||
TotalWireBytes: streamMetrics.TotalWireBytes,
|
TotalWireBytes: streamMetrics.TotalWireBytes,
|
||||||
@@ -701,10 +692,12 @@ func (s *Server) statsResponse(
|
|||||||
MbitsPerSec: streamMetrics.BitsPerSec / bitsPerMegabit,
|
MbitsPerSec: streamMetrics.BitsPerSec / bitsPerMegabit,
|
||||||
WireMbitsPerSec: streamMetrics.WireBitsPerSec / bitsPerMegabit,
|
WireMbitsPerSec: streamMetrics.WireBitsPerSec / bitsPerMegabit,
|
||||||
Connected: streamMetrics.Connected,
|
Connected: streamMetrics.Connected,
|
||||||
|
ConnectionDuration: connectionDuration(
|
||||||
|
streamMetrics.Connected, streamMetrics.ConnectedSince),
|
||||||
ReconnectCount: streamMetrics.ReconnectCount,
|
ReconnectCount: streamMetrics.ReconnectCount,
|
||||||
GoVersion: runtime.Version(),
|
GoVersion: runtime.Version(),
|
||||||
Goroutines: runtime.NumGoroutine(),
|
Goroutines: runtime.NumGoroutine(),
|
||||||
MemoryUsageBytes: memStats.Alloc,
|
MemoryUsage: humanize.Bytes(memStats.Alloc),
|
||||||
GC: gcStats(&memStats),
|
GC: gcStats(&memStats),
|
||||||
Stream: s.streamStats(),
|
Stream: s.streamStats(),
|
||||||
ASNs: dbStats.ASNs,
|
ASNs: dbStats.ASNs,
|
||||||
@@ -726,9 +719,6 @@ func (s *Server) statsResponse(
|
|||||||
IPv6PrefixDistribution: prefixDistribution(counts.IPv6PrefixesByLength),
|
IPv6PrefixDistribution: prefixDistribution(counts.IPv6PrefixesByLength),
|
||||||
WHOISStats: whoisStats,
|
WHOISStats: whoisStats,
|
||||||
|
|
||||||
ConnectionDurationSeconds: connectionDurationSeconds(
|
|
||||||
streamMetrics.Connected, streamMetrics.ConnectedSince),
|
|
||||||
|
|
||||||
OriginsWithoutKeptRoute: counts.OriginsWithoutKeptRoute,
|
OriginsWithoutKeptRoute: counts.OriginsWithoutKeptRoute,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -73,8 +73,8 @@ func emptyTable() *routetable.Table {
|
|||||||
// Paths several tests request.
|
// Paths several tests request.
|
||||||
const (
|
const (
|
||||||
asPagePath = "/as/64500"
|
asPagePath = "/as/64500"
|
||||||
asJSONPath = "/api/v1/as/64500"
|
|
||||||
prefixLengthPagePath = "/prefixlength/24"
|
prefixLengthPagePath = "/prefixlength/24"
|
||||||
|
statusJSONPath = "/status.json"
|
||||||
statsPath = "/api/v1/stats"
|
statsPath = "/api/v1/stats"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -295,204 +295,6 @@ func TestStatsAnswerCarriesChurnPerMinute(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// heldBackMessages is how many messages heldBackHandler holds back.
|
|
||||||
const heldBackMessages = 7
|
|
||||||
|
|
||||||
// heldBackHandler is a stream handler that wants no message and holds back
|
|
||||||
// heldBackMessages messages.
|
|
||||||
type heldBackHandler struct{}
|
|
||||||
|
|
||||||
func (heldBackHandler) WantsMessage(string) bool { return false }
|
|
||||||
func (heldBackHandler) HandleMessage(*ristypes.RISMessage) {}
|
|
||||||
func (heldBackHandler) QueueCapacity() int { return 1 }
|
|
||||||
func (heldBackHandler) HeldBackCount() int { return heldBackMessages }
|
|
||||||
|
|
||||||
// TestStatsAnswerGivesHowManyMessagesAHandlerHoldsBack registers a handler
|
|
||||||
// that holds back messages. Its figures in /api/v1/stats, which the status
|
|
||||||
// page shows, must give how many.
|
|
||||||
func TestStatsAnswerGivesHowManyMessagesAHandlerHoldsBack(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
s.streamer.RegisterHandler(heldBackHandler{})
|
|
||||||
|
|
||||||
var body struct {
|
|
||||||
Data StatsResponse `json:"data"`
|
|
||||||
}
|
|
||||||
|
|
||||||
err := json.Unmarshal(get(t, s, statsPath).Body.Bytes(), &body)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("decoding the answer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
stats := body.Data.HandlerStats
|
|
||||||
if len(stats) != 1 || stats[0].HeldBackCount != heldBackMessages {
|
|
||||||
t.Errorf("handler figures %+v, want one handler holding back %d "+
|
|
||||||
"messages", stats, heldBackMessages)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// fixedIntervalASNFetcher is a WHOIS fetcher that does nothing and reports
|
|
||||||
// interval as its wait between fetches.
|
|
||||||
type fixedIntervalASNFetcher struct {
|
|
||||||
idleASNFetcher
|
|
||||||
|
|
||||||
interval time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fixedIntervalASNFetcher) GetStats() ASNFetcherStats {
|
|
||||||
return ASNFetcherStats{CurrentInterval: f.interval}
|
|
||||||
}
|
|
||||||
|
|
||||||
// unitStats holds the figures of a stats answer that carry a unit. Each is a
|
|
||||||
// pointer, so that a figure missing from the answer is nil.
|
|
||||||
//
|
|
||||||
//nolint:tagliatelle // field names are the existing JSON API
|
|
||||||
type unitStats struct {
|
|
||||||
UptimeSeconds *int64 `json:"uptime_seconds"`
|
|
||||||
MemoryUsageBytes *uint64 `json:"memory_usage_bytes"`
|
|
||||||
WHOISStats struct {
|
|
||||||
CurrentIntervalSeconds *float64 `json:"current_interval_seconds"`
|
|
||||||
} `json:"whois_stats"`
|
|
||||||
GC struct {
|
|
||||||
HeapAllocBytes uint64 `json:"heap_alloc_bytes"`
|
|
||||||
} `json:"gc"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStatsAnswersGiveUnitsInFieldNames checks that the figures of both stats
|
|
||||||
// answers that carry a unit are numbers, with the unit at the end of their
|
|
||||||
// names. They used to be strings with the unit in them, such as "1h18m34s" or
|
|
||||||
// "1.1 GB" (https://git.eeqj.de/sneak/routewatch/issues/199). The stream has
|
|
||||||
// never connected, so the uptime is 0. The memory use in /api/v1/stats is the
|
|
||||||
// same number of bytes as its gc.heap_alloc_bytes.
|
|
||||||
func TestStatsAnswersGiveUnitsInFieldNames(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const fetchInterval = 18200 * time.Millisecond
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
s.SetASNFetcher(fixedIntervalASNFetcher{interval: fetchInterval})
|
|
||||||
|
|
||||||
for _, path := range []string{statusJSONPath, statsPath} {
|
|
||||||
answer := get(t, s, path).Body.Bytes()
|
|
||||||
|
|
||||||
var body struct {
|
|
||||||
Data unitStats `json:"data"`
|
|
||||||
}
|
|
||||||
|
|
||||||
err := json.Unmarshal(answer, &body)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("%s: figures are not numbers: %v; answer %s", path, err, answer)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
got := body.Data
|
|
||||||
if got.UptimeSeconds == nil || *got.UptimeSeconds != 0 {
|
|
||||||
t.Errorf("%s: uptime_seconds is not 0: %s", path, answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got.MemoryUsageBytes == nil || *got.MemoryUsageBytes == 0 {
|
|
||||||
t.Errorf("%s: memory_usage_bytes is not a number of bytes: %s",
|
|
||||||
path, answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
interval := got.WHOISStats.CurrentIntervalSeconds
|
|
||||||
if interval == nil || *interval != fetchInterval.Seconds() {
|
|
||||||
t.Errorf("%s: whois_stats.current_interval_seconds is not %v: %s",
|
|
||||||
path, fetchInterval.Seconds(), answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
if path == statsPath && got.MemoryUsageBytes != nil &&
|
|
||||||
*got.MemoryUsageBytes != got.GC.HeapAllocBytes {
|
|
||||||
t.Errorf("%s: memory_usage_bytes %d, want gc.heap_alloc_bytes %d",
|
|
||||||
path, *got.MemoryUsageBytes, got.GC.HeapAllocBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStatsAnswerGivesConnectionDurationInSeconds checks that the
|
|
||||||
// connection_duration_seconds of /api/v1/stats is null while the stream is not
|
|
||||||
// connected, and a whole number of seconds once it is. It used to be the
|
|
||||||
// string "disconnected", or a Go duration such as "1h18m34s"
|
|
||||||
// (https://git.eeqj.de/sneak/routewatch/issues/199).
|
|
||||||
func TestStatsAnswerGivesConnectionDurationInSeconds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
|
|
||||||
connectionDuration := func() json.RawMessage {
|
|
||||||
answer := get(t, s, statsPath).Body.Bytes()
|
|
||||||
|
|
||||||
var body struct {
|
|
||||||
Data map[string]json.RawMessage `json:"data"`
|
|
||||||
}
|
|
||||||
|
|
||||||
err := json.Unmarshal(answer, &body)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("decoding the answer: %v; answer %s", err, answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
duration, ok := body.Data["connection_duration_seconds"]
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("no connection_duration_seconds: %s", answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
return duration
|
|
||||||
}
|
|
||||||
|
|
||||||
disconnected := connectionDuration()
|
|
||||||
if string(disconnected) != "null" {
|
|
||||||
t.Errorf("disconnected: connection_duration_seconds = %s, want null",
|
|
||||||
disconnected)
|
|
||||||
}
|
|
||||||
|
|
||||||
s.streamer.GetMetricsTracker().SetConnected(true)
|
|
||||||
|
|
||||||
var seconds int64
|
|
||||||
|
|
||||||
connected := connectionDuration()
|
|
||||||
|
|
||||||
err := json.Unmarshal(connected, &seconds)
|
|
||||||
if err != nil || seconds != 0 {
|
|
||||||
t.Errorf("just connected: connection_duration_seconds = %s, want 0",
|
|
||||||
connected)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStreamDurationsCountSeconds checks that the uptime and the connection
|
|
||||||
// duration of a stream that connected 90 seconds ago are both 90. A stream
|
|
||||||
// that has never connected has an uptime of 0, and one that is not connected
|
|
||||||
// has no connection duration.
|
|
||||||
func TestStreamDurationsCountSeconds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const connectedFor = 90 * time.Second
|
|
||||||
|
|
||||||
connectedSince := time.Now().Add(-connectedFor)
|
|
||||||
want := int64(connectedFor / time.Second)
|
|
||||||
|
|
||||||
if got := uptimeSeconds(connectedSince); got != want {
|
|
||||||
t.Errorf("uptimeSeconds = %d, want %d", got, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := uptimeSeconds(time.Time{}); got != 0 {
|
|
||||||
t.Errorf("uptimeSeconds before any connection = %d, want 0", got)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch got := connectionDurationSeconds(true, connectedSince); {
|
|
||||||
case got == nil:
|
|
||||||
t.Errorf("connectionDurationSeconds = nil, want %d", want)
|
|
||||||
case *got != want:
|
|
||||||
t.Errorf("connectionDurationSeconds = %d, want %d", *got, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := connectionDurationSeconds(false, connectedSince); got != nil {
|
|
||||||
t.Errorf("connectionDurationSeconds while not connected = %d, want nil",
|
|
||||||
*got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// newTestTable returns a routing table that holds a route for testPrefixV4,
|
// newTestTable returns a routing table that holds a route for testPrefixV4,
|
||||||
// with origin AS 64500, and one for testPrefixV6, with origin AS 64501.
|
// with origin AS 64500, and one for testPrefixV6, with origin AS 64501.
|
||||||
func newTestTable() *routetable.Table {
|
func newTestTable() *routetable.Table {
|
||||||
@@ -964,7 +766,7 @@ func TestRoutesAnswer504WhenDatabaseReadIsCutOff(t *testing.T) {
|
|||||||
{path: "/ip/" + addrInTestPrefixV4, wantJSONBody: true},
|
{path: "/ip/" + addrInTestPrefixV4, wantJSONBody: true},
|
||||||
{path: statsPath, wantJSONBody: true},
|
{path: statsPath, wantJSONBody: true},
|
||||||
{path: "/api/v1/ip/" + addrInTestPrefixV4, wantJSONBody: true},
|
{path: "/api/v1/ip/" + addrInTestPrefixV4, wantJSONBody: true},
|
||||||
{path: asJSONPath, wantJSONBody: true},
|
{path: "/api/v1/as/64500", wantJSONBody: true},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
@@ -1145,10 +947,10 @@ func TestJSONRoutesDoNotSendErrorDetails(t *testing.T) {
|
|||||||
path string
|
path string
|
||||||
wantCode int
|
wantCode int
|
||||||
}{
|
}{
|
||||||
{healthCheckPath, http.StatusServiceUnavailable},
|
{"/.well-known/healthcheck.json", http.StatusServiceUnavailable},
|
||||||
{statusJSONPath, http.StatusInternalServerError},
|
{statusJSONPath, http.StatusInternalServerError},
|
||||||
{statsPath, http.StatusInternalServerError},
|
{statsPath, http.StatusInternalServerError},
|
||||||
{asJSONPath, http.StatusInternalServerError},
|
{"/api/v1/as/64500", http.StatusInternalServerError},
|
||||||
{"/api/v1/ip/" + addrInTestPrefixV4, http.StatusInternalServerError},
|
{"/api/v1/ip/" + addrInTestPrefixV4, http.StatusInternalServerError},
|
||||||
{"/api/v1/prefix/foo/24", http.StatusBadRequest},
|
{"/api/v1/prefix/foo/24", http.StatusBadRequest},
|
||||||
}
|
}
|
||||||
@@ -1514,9 +1316,6 @@ func TestIPLookupReportsBlocklists(t *testing.T) {
|
|||||||
// jsonNull is how JSON writes a field without a value.
|
// jsonNull is how JSON writes a field without a value.
|
||||||
const jsonNull = "null"
|
const jsonNull = "null"
|
||||||
|
|
||||||
// jsonEmptyList is how JSON writes an empty list.
|
|
||||||
const jsonEmptyList = "[]"
|
|
||||||
|
|
||||||
// resultFields decodes an IP lookup answer and returns each of its results as
|
// resultFields decodes an IP lookup answer and returns each of its results as
|
||||||
// its JSON fields.
|
// its JSON fields.
|
||||||
func resultFields(t *testing.T, answer []byte) []map[string]json.RawMessage {
|
func resultFields(t *testing.T, answer []byte) []map[string]json.RawMessage {
|
||||||
@@ -1652,37 +1451,6 @@ func TestIPLookupResultsHaveTheSameFields(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestIPLookupOfAnAddressWithoutPTRNamesOrStoredNetblock looks up a routed
|
|
||||||
// address that has no PTR names, and whose netblock the database has not
|
|
||||||
// stored. Its ptr is an empty list and its first_seen is null. Before the fix
|
|
||||||
// ptr was left out, and first_seen was 0001-01-01T00:00:00Z
|
|
||||||
// (https://git.eeqj.de/sneak/routewatch/issues/200).
|
|
||||||
func TestIPLookupOfAnAddressWithoutPTRNamesOrStoredNetblock(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
s.resolver = &fakeResolver{}
|
|
||||||
|
|
||||||
path := "/api/v1/ip/" + addrInTestPrefixV4
|
|
||||||
|
|
||||||
results := resultFields(t, get(t, s, path).Body.Bytes())
|
|
||||||
if len(results) != 1 {
|
|
||||||
t.Fatalf("%s: %d results, want 1", path, len(results))
|
|
||||||
}
|
|
||||||
|
|
||||||
want := map[string]string{
|
|
||||||
"ptr": jsonEmptyList,
|
|
||||||
"first_seen": jsonNull,
|
|
||||||
}
|
|
||||||
|
|
||||||
for name, value := range want {
|
|
||||||
got := string(results[0][name])
|
|
||||||
if got != value {
|
|
||||||
t.Errorf("%s: %s is %s, want %s", path, name, got, value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestIPLookupAnswersMayBeCached checks the Cache-Control header of the IP
|
// TestIPLookupAnswersMayBeCached checks the Cache-Control header of the IP
|
||||||
// lookup answers. Caches may keep them for the blocklists' shortest interval,
|
// lookup answers. Caches may keep them for the blocklists' shortest interval,
|
||||||
// and only the caller's own browser may keep the answer about the caller's
|
// and only the caller's own browser may keep the answer about the caller's
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"testing/synctest"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"git.eeqj.de/sneak/routewatch/internal/database"
|
"git.eeqj.de/sneak/routewatch/internal/database"
|
||||||
@@ -342,66 +341,6 @@ func TestStartedServerWorksOutTheCards(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestStartedServerWorksOutTheCardsUntilStop starts a server with a context
|
|
||||||
// that ends as soon as Start returns. It runs in a synctest bubble, whose clock
|
|
||||||
// is fake: time.Sleep there moves the clock on and returns at once. The server
|
|
||||||
// must work the cards out again a minute later, and no more after Stop. Each
|
|
||||||
// time it works them out, it keeps a new copy. Before the fix the end of
|
|
||||||
// Start's context stopped the goroutine that works them out.
|
|
||||||
func TestStartedServerWorksOutTheCardsUntilStop(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// The server is made outside the bubble. The streamer's metrics start a
|
|
||||||
// goroutine that never returns, and a bubble waits for each of its
|
|
||||||
// goroutines to return.
|
|
||||||
s := newServerWithTable(t, newCardsTable())
|
|
||||||
|
|
||||||
synctest.Test(t, func(t *testing.T) {
|
|
||||||
ctx, cancel := context.WithCancel(t.Context())
|
|
||||||
|
|
||||||
err := s.Start(ctx)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Start: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
// The bubble's clock moves only while each of its goroutines waits
|
|
||||||
// on the bubble, and the goroutine that serves HTTP waits on the
|
|
||||||
// network. The test sends no request, so it closes the HTTP server.
|
|
||||||
_ = s.srv.Close()
|
|
||||||
|
|
||||||
synctest.Wait()
|
|
||||||
|
|
||||||
started := s.cards.Load()
|
|
||||||
if started == nil {
|
|
||||||
t.Fatal("the server did not work out the cards when it started")
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(homeCardsRefreshInterval)
|
|
||||||
synctest.Wait()
|
|
||||||
|
|
||||||
if s.cards.Load() == started {
|
|
||||||
t.Error("the server did not work out the cards again a minute " +
|
|
||||||
"after its start context ended")
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.Stop(t.Context())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Stop: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
stopped := s.cards.Load()
|
|
||||||
|
|
||||||
time.Sleep(homeCardsRefreshInterval)
|
|
||||||
synctest.Wait()
|
|
||||||
|
|
||||||
if s.cards.Load() != stopped {
|
|
||||||
t.Error("the server worked out the cards again after Stop")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// waitUntil fails the test unless done reports true within maxWait.
|
// waitUntil fails the test unless done reports true within maxWait.
|
||||||
func waitUntil(t *testing.T, maxWait time.Duration, done func() bool) {
|
func waitUntil(t *testing.T, maxWait time.Duration, done func() bool) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/go-chi/chi/v5"
|
"github.com/go-chi/chi/v5"
|
||||||
"github.com/go-chi/chi/v5/middleware"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// responseWriter wraps http.ResponseWriter to capture the response
|
// responseWriter wraps http.ResponseWriter to capture the response
|
||||||
@@ -54,15 +53,6 @@ func (rw *responseWriter) Header() http.Header {
|
|||||||
return rw.ResponseWriter.Header()
|
return rw.ResponseWriter.Header()
|
||||||
}
|
}
|
||||||
|
|
||||||
// The @meta object JSONResponseMiddleware adds to a JSON answer: its key, and
|
|
||||||
// the keys of its fields.
|
|
||||||
const (
|
|
||||||
jsonKeyMeta = "@meta"
|
|
||||||
metaKeyTimeZone = "time_zone"
|
|
||||||
metaKeyAPIVersion = "api_version"
|
|
||||||
metaKeyExecutionTimeMs = "execution_time_ms"
|
|
||||||
)
|
|
||||||
|
|
||||||
// JSONResponseMiddleware is an HTTP middleware that wraps all JSON responses
|
// JSONResponseMiddleware is an HTTP middleware that wraps all JSON responses
|
||||||
// with a @meta field containing execution metadata. The metadata includes the
|
// with a @meta field containing execution metadata. The metadata includes the
|
||||||
// time zone (always UTC), API version, and request execution time in milliseconds.
|
// time zone (always UTC), API version, and request execution time in milliseconds.
|
||||||
@@ -116,10 +106,10 @@ func JSONResponseMiddleware(next http.Handler) http.Handler {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Add @meta field
|
// Add @meta field
|
||||||
originalResponse[jsonKeyMeta] = map[string]any{
|
originalResponse["@meta"] = map[string]any{
|
||||||
metaKeyTimeZone: "UTC",
|
"time_zone": "UTC",
|
||||||
metaKeyAPIVersion: 1,
|
"api_version": 1,
|
||||||
metaKeyExecutionTimeMs: execTime.Milliseconds(),
|
"execution_time": fmt.Sprintf("%d ms", execTime.Milliseconds()),
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write the enhanced response
|
// Write the enhanced response
|
||||||
@@ -155,8 +145,7 @@ func deadlinePassed(ctx context.Context) bool {
|
|||||||
// has passed, it answers 504 with the error message "Request timeout". A 4xx
|
// has passed, it answers 504 with the error message "Request timeout". A 4xx
|
||||||
// keeps its status, with the status's standard text as the message. For other
|
// keeps its status, with the status's standard text as the message. For other
|
||||||
// errors, it returns "Internal server error", with status 500 if the original
|
// errors, it returns "Internal server error", with status 500 if the original
|
||||||
// status was 200. A panic in the handler answers 500 with "Internal server
|
// status was 200.
|
||||||
// error" too.
|
|
||||||
//
|
//
|
||||||
// Non-JSON responses are passed through unchanged.
|
// Non-JSON responses are passed through unchanged.
|
||||||
func JSONValidationMiddleware(next http.Handler) http.Handler {
|
func JSONValidationMiddleware(next http.Handler) http.Handler {
|
||||||
@@ -168,9 +157,8 @@ func JSONValidationMiddleware(next http.Handler) http.Handler {
|
|||||||
statusCode: http.StatusOK,
|
statusCode: http.StatusOK,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Serve the request. Recoverer logs a panic in the handler and turns it
|
// Serve the request
|
||||||
// into a 500 without a body, which gets the JSON error body below.
|
next.ServeHTTP(rw, r)
|
||||||
middleware.Recoverer(next).ServeHTTP(rw, r)
|
|
||||||
|
|
||||||
// Check if it's meant to be a JSON response
|
// Check if it's meant to be a JSON response
|
||||||
contentType := rw.Header().Get("Content-Type")
|
contentType := rw.Header().Get("Content-Type")
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
@@ -11,7 +10,6 @@ import (
|
|||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
"regexp"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@@ -102,219 +100,6 @@ func TestJSONValidationKeeps4xxWithoutBody(t *testing.T) {
|
|||||||
checkJSONErrorMessage(t, name, rec, http.StatusText(http.StatusBadRequest))
|
checkJSONErrorMessage(t, name, rec, http.StatusText(http.StatusBadRequest))
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestJSONAnswersPutNoUnitInAString sends a request to each JSON route and
|
|
||||||
// checks each answer. Its @meta.execution_time_ms is a number, and none of its
|
|
||||||
// strings is a number with a unit, such as "12 ms", "1.1 GB" or "1h18m34s"
|
|
||||||
// (https://git.eeqj.de/sneak/routewatch/issues/199). The health check answers
|
|
||||||
// 503, since the stream is not connected, and the last path matches no route.
|
|
||||||
func TestJSONAnswersPutNoUnitInAString(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
numberWithUnit := regexp.MustCompile(
|
|
||||||
`^([0-9]+(\.[0-9]+)? ?(ns|µs|ms|s|m|h|B|kB|MB|GB|TB))+$`)
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
s.resolver = &fakeResolver{}
|
|
||||||
s.SetASNFetcher(fixedIntervalASNFetcher{interval: time.Second})
|
|
||||||
|
|
||||||
paths := []string{
|
|
||||||
statusJSONPath,
|
|
||||||
statsPath,
|
|
||||||
healthCheckPath,
|
|
||||||
"/api/v1/ip/" + untrustedPeerAddr,
|
|
||||||
"/ip/" + untrustedPeerAddr,
|
|
||||||
asJSONPath,
|
|
||||||
"/api/v1/prefix/" + testPrefixV4,
|
|
||||||
"/api/v1/search/as?q=google",
|
|
||||||
"/api/v1/no-such-route",
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, path := range paths {
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
s.router.ServeHTTP(rec, httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodGet, path, nil))
|
|
||||||
|
|
||||||
var answer map[string]any
|
|
||||||
|
|
||||||
err := json.Unmarshal(rec.Body.Bytes(), &answer)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("%s: decoding the answer: %v; answer %s", path, err, rec.Body)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
meta, _ := answer["@meta"].(map[string]any)
|
|
||||||
if _, ok := meta["execution_time_ms"].(float64); !ok {
|
|
||||||
t.Errorf("%s: @meta.execution_time_ms is not a number: %s",
|
|
||||||
path, rec.Body)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, value := range stringsIn(answer) {
|
|
||||||
if numberWithUnit.MatchString(value) {
|
|
||||||
t.Errorf("%s: %q is a number with a unit in a string", path, value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestJSONAnswersCarryMeta sends requests to every JSON route through the
|
|
||||||
// server's router, and checks that each answer carries @meta with its three
|
|
||||||
// fields. The answers include successes, and errors that the handlers, the
|
|
||||||
// router and the middleware write. Before the fix a panic in a handler, and a
|
|
||||||
// method /status.json or the health check does not take, answered with an
|
|
||||||
// empty body (https://git.eeqj.de/sneak/routewatch/issues/201).
|
|
||||||
func TestJSONAnswersCarryMeta(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// JSON routes whose handlers write nothing or panic, so that the JSON
|
|
||||||
// check on the route writes the error answer itself.
|
|
||||||
const (
|
|
||||||
writesNothingPath = "/writes-nothing.json"
|
|
||||||
panicsPath = "/panics.json"
|
|
||||||
)
|
|
||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
|
||||||
s.resolver = &fakeResolver{}
|
|
||||||
s.streamer.GetMetricsTracker().SetConnected(true)
|
|
||||||
s.router.Get(writesNothingPath, JSONValidationMiddleware(http.HandlerFunc(
|
|
||||||
func(http.ResponseWriter, *http.Request) {})).ServeHTTP)
|
|
||||||
s.router.Get(panicsPath, JSONValidationMiddleware(http.HandlerFunc(
|
|
||||||
func(http.ResponseWriter, *http.Request) { panic(errDiskIO) })).ServeHTTP)
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
method string
|
|
||||||
path string
|
|
||||||
wantCode int
|
|
||||||
}{
|
|
||||||
// Answers that succeed
|
|
||||||
{http.MethodGet, statusJSONPath, http.StatusOK},
|
|
||||||
{http.MethodGet, healthCheckPath, http.StatusOK},
|
|
||||||
{http.MethodGet, "/ip", http.StatusOK},
|
|
||||||
{http.MethodGet, ownAddressPath, http.StatusOK},
|
|
||||||
{http.MethodGet, "/ip/" + addrInTestPrefixV4, http.StatusOK},
|
|
||||||
{http.MethodGet, statsPath, http.StatusOK},
|
|
||||||
{http.MethodGet, "/api/v1/ip/" + addrInTestPrefixV4, http.StatusOK},
|
|
||||||
{http.MethodGet, asJSONPath, http.StatusOK},
|
|
||||||
{http.MethodGet, "/api/v1/prefix/" + testPrefixV4, http.StatusOK},
|
|
||||||
{http.MethodGet, "/api/v1/search/as?q=google", http.StatusOK},
|
|
||||||
// Errors the handlers write
|
|
||||||
{http.MethodGet, "/ip/no-such-host.example", http.StatusBadRequest},
|
|
||||||
{http.MethodGet, "/api/v1/ip/no-such-host.example", http.StatusBadRequest},
|
|
||||||
{http.MethodGet, "/api/v1/as/foo", http.StatusBadRequest},
|
|
||||||
{http.MethodGet, "/api/v1/as/0", http.StatusNotFound},
|
|
||||||
{http.MethodGet, "/api/v1/prefix/192.0.2.0/33", http.StatusBadRequest},
|
|
||||||
{http.MethodGet, "/api/v1/prefix/198.51.100.0/24", http.StatusNotFound},
|
|
||||||
{http.MethodGet, "/api/v1/search/as", http.StatusBadRequest},
|
|
||||||
// Errors the router and the middleware write
|
|
||||||
{http.MethodGet, "/api/v1/no-such-route", http.StatusNotFound},
|
|
||||||
{http.MethodGet, "/ip/192.0.2.1/nothing", http.StatusNotFound},
|
|
||||||
{http.MethodPost, statsPath, http.StatusMethodNotAllowed},
|
|
||||||
{http.MethodPost, ownAddressPath, http.StatusMethodNotAllowed},
|
|
||||||
{http.MethodPost, statusJSONPath, http.StatusMethodNotAllowed},
|
|
||||||
{http.MethodPut, healthCheckPath, http.StatusMethodNotAllowed},
|
|
||||||
{http.MethodGet, writesNothingPath, http.StatusInternalServerError},
|
|
||||||
{http.MethodGet, panicsPath, http.StatusInternalServerError},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
checkAnswerCarriesMeta(t, s, httptest.NewRequestWithContext(
|
|
||||||
t.Context(), tt.method, tt.path, nil), tt.wantCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A request whose time limit has already passed answers 504. The handlers
|
|
||||||
// write the answers of the first five routes, and the JSON check on the
|
|
||||||
// route writes the last.
|
|
||||||
pastTimeLimit, cancel := context.WithDeadline(t.Context(), time.Now())
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
for _, path := range []string{
|
|
||||||
statusJSONPath, statsPath, "/ip/" + addrInTestPrefixV4,
|
|
||||||
"/api/v1/ip/" + addrInTestPrefixV4, asJSONPath, writesNothingPath,
|
|
||||||
} {
|
|
||||||
checkAnswerCarriesMeta(t, s, httptest.NewRequestWithContext(
|
|
||||||
pastTimeLimit, http.MethodGet, path, nil), http.StatusGatewayTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
// With a store whose reads fail, the health check answers 503, and the
|
|
||||||
// handlers of the other routes 500.
|
|
||||||
failing := New(failingDB{}, newTestTable(),
|
|
||||||
streamer.New(logger.New(), metrics.New()), logger.New(), &config.Config{})
|
|
||||||
failing.resolver = &fakeResolver{}
|
|
||||||
|
|
||||||
checkAnswerCarriesMeta(t, failing, httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodGet, healthCheckPath, nil),
|
|
||||||
http.StatusServiceUnavailable)
|
|
||||||
|
|
||||||
for _, path := range []string{
|
|
||||||
statusJSONPath, statsPath, asJSONPath,
|
|
||||||
"/api/v1/ip/" + addrInTestPrefixV4, "/ip/" + addrInTestPrefixV4,
|
|
||||||
} {
|
|
||||||
checkAnswerCarriesMeta(t, failing, httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodGet, path, nil), http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkAnswerCarriesMeta serves req through the server's router, and checks
|
|
||||||
// that it answers wantCode with @meta and its three fields.
|
|
||||||
func checkAnswerCarriesMeta(
|
|
||||||
t *testing.T, s *Server, req *http.Request, wantCode int,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
// The values README "JSON API" gives the two fields that never change.
|
|
||||||
const (
|
|
||||||
wantTimeZone = "UTC"
|
|
||||||
wantAPIVersion = 1
|
|
||||||
)
|
|
||||||
|
|
||||||
name := req.Method + " " + req.URL.String()
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
s.router.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != wantCode {
|
|
||||||
t.Errorf("%s: status %d, want %d; body %s", name, rec.Code, wantCode, rec.Body)
|
|
||||||
}
|
|
||||||
|
|
||||||
var answer map[string]any
|
|
||||||
|
|
||||||
err := json.Unmarshal(rec.Body.Bytes(), &answer)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("%s: decoding the answer %q: %v", name, rec.Body, err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
meta, _ := answer[jsonKeyMeta].(map[string]any)
|
|
||||||
_, timeIsNumber := meta[metaKeyExecutionTimeMs].(float64)
|
|
||||||
|
|
||||||
if meta[metaKeyTimeZone] != wantTimeZone ||
|
|
||||||
meta[metaKeyAPIVersion] != float64(wantAPIVersion) || !timeIsNumber {
|
|
||||||
t.Errorf("%s: @meta %v, want time_zone %q, api_version %d and a "+
|
|
||||||
"number in execution_time_ms", name, meta, wantTimeZone, wantAPIVersion)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// stringsIn returns every string in a decoded JSON value, at any depth.
|
|
||||||
func stringsIn(value any) []string {
|
|
||||||
var found []string
|
|
||||||
|
|
||||||
switch v := value.(type) {
|
|
||||||
case string:
|
|
||||||
found = append(found, v)
|
|
||||||
case []any:
|
|
||||||
for _, item := range v {
|
|
||||||
found = append(found, stringsIn(item)...)
|
|
||||||
}
|
|
||||||
case map[string]any:
|
|
||||||
for _, item := range v {
|
|
||||||
found = append(found, stringsIn(item)...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return found
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPagesCarryTheCSPNonce checks that every script and style block of each
|
// TestPagesCarryTheCSPNonce checks that every script and style block of each
|
||||||
// page carries the nonce its Content-Security-Policy header names, so that the
|
// page carries the nonce its Content-Security-Policy header names, so that the
|
||||||
// browser runs and applies them, that each answer has a nonce of its own, and
|
// browser runs and applies them, that each answer has a nonce of its own, and
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ import (
|
|||||||
"github.com/go-chi/chi/v5/middleware"
|
"github.com/go-chi/chi/v5/middleware"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The error messages the JSON routes answer with when no route matches the
|
// The error messages the JSON routes under /api/v1 and /ip answer with when no
|
||||||
// path, and when the route does not take the method.
|
// route matches the path, and when none takes the method.
|
||||||
const (
|
const (
|
||||||
notFoundMessage = "Not found"
|
notFoundMessage = "Not found"
|
||||||
methodNotAllowedMessage = "Method not allowed"
|
methodNotAllowedMessage = "Method not allowed"
|
||||||
@@ -19,13 +19,6 @@ const (
|
|||||||
jsonRoutesAllow = "GET, HEAD"
|
jsonRoutesAllow = "GET, HEAD"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The paths of the status figures and the health check, the two JSON routes
|
|
||||||
// outside /api/v1 and /ip.
|
|
||||||
const (
|
|
||||||
statusJSONPath = "/status.json"
|
|
||||||
healthCheckPath = "/.well-known/healthcheck.json"
|
|
||||||
)
|
|
||||||
|
|
||||||
// setupRoutes configures the HTTP routes
|
// setupRoutes configures the HTTP routes
|
||||||
func (s *Server) setupRoutes() {
|
func (s *Server) setupRoutes() {
|
||||||
r := chi.NewRouter()
|
r := chi.NewRouter()
|
||||||
@@ -39,8 +32,6 @@ func (s *Server) setupRoutes() {
|
|||||||
r.Use(middleware.RequestID)
|
r.Use(middleware.RequestID)
|
||||||
r.Use(RealIPMiddleware(s.trustedProxies))
|
r.Use(RealIPMiddleware(s.trustedProxies))
|
||||||
r.Use(RequestLoggerMiddleware(s.logger.Logger)) // Structured request logging
|
r.Use(RequestLoggerMiddleware(s.logger.Logger)) // Structured request logging
|
||||||
// Recoverer answers a panic on a page. JSONValidationMiddleware recovers a
|
|
||||||
// panic on a JSON route itself, so that the answer is JSON with @meta.
|
|
||||||
r.Use(middleware.Recoverer)
|
r.Use(middleware.Recoverer)
|
||||||
r.Use(JSONResponseMiddleware)
|
r.Use(JSONResponseMiddleware)
|
||||||
// Timeout must come after JSONResponseMiddleware, which sends its answer
|
// Timeout must come after JSONResponseMiddleware, which sends its answer
|
||||||
@@ -52,6 +43,11 @@ func (s *Server) setupRoutes() {
|
|||||||
// Routes
|
// Routes
|
||||||
r.Get("/", s.handleIndex())
|
r.Get("/", s.handleIndex())
|
||||||
r.Get("/status", s.handleStatusHTML())
|
r.Get("/status", s.handleStatusHTML())
|
||||||
|
r.Get("/status.json", JSONValidationMiddleware(s.handleStatusJSON()).ServeHTTP)
|
||||||
|
r.Get(
|
||||||
|
"/.well-known/healthcheck.json",
|
||||||
|
JSONValidationMiddleware(s.handleHealthCheck()).ServeHTTP,
|
||||||
|
)
|
||||||
|
|
||||||
// AS and prefix detail pages
|
// AS and prefix detail pages
|
||||||
r.Get("/as/{asn}", s.handleASDetail())
|
r.Get("/as/{asn}", s.handleASDetail())
|
||||||
@@ -74,21 +70,6 @@ func (s *Server) setupRoutes() {
|
|||||||
s.writeJSONError(w, http.StatusMethodNotAllowed, methodNotAllowedMessage)
|
s.writeJSONError(w, http.StatusMethodNotAllowed, methodNotAllowedMessage)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The status figures and the health check. chi sets one 405 answer for a
|
|
||||||
// whole router. These two routes are on the pages' router, whose 405 stays
|
|
||||||
// chi's own. So each method they do not take is routed to the JSON 405
|
|
||||||
// here.
|
|
||||||
r.Get(statusJSONPath, JSONValidationMiddleware(s.handleStatusJSON()).ServeHTTP)
|
|
||||||
r.Get(healthCheckPath, JSONValidationMiddleware(s.handleHealthCheck()).ServeHTTP)
|
|
||||||
|
|
||||||
for _, method := range []string{
|
|
||||||
http.MethodPost, http.MethodPut, http.MethodPatch, http.MethodDelete,
|
|
||||||
http.MethodOptions, http.MethodTrace, http.MethodConnect,
|
|
||||||
} {
|
|
||||||
r.MethodFunc(method, statusJSONPath, jsonMethodNotAllowed)
|
|
||||||
r.MethodFunc(method, healthCheckPath, jsonMethodNotAllowed)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IP info JSON endpoints (replaces old /ip redirect)
|
// IP info JSON endpoints (replaces old /ip redirect)
|
||||||
r.Route("/ip", func(r chi.Router) {
|
r.Route("/ip", func(r chi.Router) {
|
||||||
r.Use(JSONValidationMiddleware)
|
r.Use(JSONValidationMiddleware)
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ func TestRoutesAnswerHEAD(t *testing.T) {
|
|||||||
|
|
||||||
s := newServerWithTestRoutes(t)
|
s := newServerWithTestRoutes(t)
|
||||||
|
|
||||||
for _, path := range []string{"/", statusJSONPath, statsPath, "/ip", "/ip/"} {
|
for _, path := range []string{"/", statsPath, "/ip", "/ip/"} {
|
||||||
rec := httptest.NewRecorder()
|
rec := httptest.NewRecorder()
|
||||||
s.router.ServeHTTP(rec, httptest.NewRequestWithContext(
|
s.router.ServeHTTP(rec, httptest.NewRequestWithContext(
|
||||||
t.Context(), http.MethodHead, path, nil))
|
t.Context(), http.MethodHead, path, nil))
|
||||||
@@ -31,13 +31,10 @@ func TestRoutesAnswerHEAD(t *testing.T) {
|
|||||||
|
|
||||||
// TestJSONRoutesAnswerUnmatchedRequestsWithJSONErrors sends a method the JSON
|
// TestJSONRoutesAnswerUnmatchedRequestsWithJSONErrors sends a method the JSON
|
||||||
// routes do not take, and a path none of them matches, to each group of JSON
|
// routes do not take, and a path none of them matches, to each group of JSON
|
||||||
// routes through the server's router. It also sends a method they do not take
|
// routes through the server's router. Each must answer with the JSON error
|
||||||
// to /status.json and the health check. Each must answer with the JSON error
|
|
||||||
// body, and a 405 must name the methods the routes take in its Allow header.
|
// body, and a 405 must name the methods the routes take in its Allow header.
|
||||||
// Before the fix a 405 said "Internal server error" and a 404 was chi's plain
|
// Before the fix a 405 said "Internal server error" and a 404 was chi's plain
|
||||||
// text answer (https://git.eeqj.de/sneak/routewatch/issues/111).
|
// text answer (https://git.eeqj.de/sneak/routewatch/issues/111).
|
||||||
// /status.json and the health check gave chi's empty 405
|
|
||||||
// (https://git.eeqj.de/sneak/routewatch/issues/201).
|
|
||||||
func TestJSONRoutesAnswerUnmatchedRequestsWithJSONErrors(t *testing.T) {
|
func TestJSONRoutesAnswerUnmatchedRequestsWithJSONErrors(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -51,14 +48,6 @@ func TestJSONRoutesAnswerUnmatchedRequestsWithJSONErrors(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{http.MethodPost, statsPath, http.StatusMethodNotAllowed, methodNotAllowedMessage},
|
{http.MethodPost, statsPath, http.StatusMethodNotAllowed, methodNotAllowedMessage},
|
||||||
{http.MethodPost, "/ip/", http.StatusMethodNotAllowed, methodNotAllowedMessage},
|
{http.MethodPost, "/ip/", http.StatusMethodNotAllowed, methodNotAllowedMessage},
|
||||||
{
|
|
||||||
http.MethodDelete, statusJSONPath,
|
|
||||||
http.StatusMethodNotAllowed, methodNotAllowedMessage,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
http.MethodOptions, healthCheckPath,
|
|
||||||
http.StatusMethodNotAllowed, methodNotAllowedMessage,
|
|
||||||
},
|
|
||||||
{http.MethodGet, "/api/v1/nothing", http.StatusNotFound, notFoundMessage},
|
{http.MethodGet, "/api/v1/nothing", http.StatusNotFound, notFoundMessage},
|
||||||
{http.MethodGet, "/ip/192.0.2.1/nothing", http.StatusNotFound, notFoundMessage},
|
{http.MethodGet, "/ip/192.0.2.1/nothing", http.StatusNotFound, notFoundMessage},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -82,12 +82,6 @@ type Server struct {
|
|||||||
// cards is the copy of the home page's cards that the pages serve, nil
|
// cards is the copy of the home page's cards that the pages serve, nil
|
||||||
// until the server first works them out
|
// until the server first works them out
|
||||||
cards atomic.Pointer[homeCards]
|
cards atomic.Pointer[homeCards]
|
||||||
|
|
||||||
// stopCards ends the goroutine that works out the cards, and
|
|
||||||
// cardsStopped is closed once it has returned. Both are nil until Start
|
|
||||||
// starts the goroutine.
|
|
||||||
stopCards context.CancelFunc
|
|
||||||
cardsStopped chan struct{}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new HTTP server that reads routes from table, the routing
|
// New creates a new HTTP server that reads routes from table, the routing
|
||||||
@@ -117,8 +111,7 @@ func New(
|
|||||||
// Start listens on the configured port and serves HTTP in the background.
|
// Start listens on the configured port and serves HTTP in the background.
|
||||||
// It returns an error if it cannot listen, for example because the port is
|
// It returns an error if it cannot listen, for example because the port is
|
||||||
// already in use. ctx bounds opening the port, not serving. Once listening,
|
// already in use. ctx bounds opening the port, not serving. Once listening,
|
||||||
// the server works out the home page's cards every minute until Stop: the end
|
// the server works out the home page's cards every minute until ctx ends.
|
||||||
// of ctx does not stop it.
|
|
||||||
func (s *Server) Start(ctx context.Context) error {
|
func (s *Server) Start(ctx context.Context) error {
|
||||||
const (
|
const (
|
||||||
network = "tcp"
|
network = "tcp"
|
||||||
@@ -155,22 +148,16 @@ func (s *Server) Start(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
ctx, s.stopCards = context.WithCancel(context.WithoutCancel(ctx))
|
|
||||||
s.cardsStopped = make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
defer close(s.cardsStopped)
|
|
||||||
|
|
||||||
s.keepHomeCardsFresh(ctx, homeCardsRefreshInterval)
|
s.keepHomeCardsFresh(ctx, homeCardsRefreshInterval)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stop stops the goroutine that works out the home page's cards, and waits
|
// Stop stops the HTTP server. It waits, until ctx ends, for the requests in
|
||||||
// until it has returned or ctx ends. It then stops the HTTP server. It waits,
|
// progress to finish, and then closes the connections of those still running
|
||||||
// until ctx ends, for the requests in progress to finish, and then closes the
|
// and returns ctx's error.
|
||||||
// connections of those still running and returns ctx's error.
|
|
||||||
func (s *Server) Stop(ctx context.Context) error {
|
func (s *Server) Stop(ctx context.Context) error {
|
||||||
if s.srv == nil {
|
if s.srv == nil {
|
||||||
return nil
|
return nil
|
||||||
@@ -178,16 +165,6 @@ func (s *Server) Stop(ctx context.Context) error {
|
|||||||
|
|
||||||
s.logger.Info("Stopping HTTP server")
|
s.logger.Info("Stopping HTTP server")
|
||||||
|
|
||||||
// Start returns before it starts the goroutine when it cannot listen.
|
|
||||||
if s.stopCards != nil {
|
|
||||||
s.stopCards()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-s.cardsStopped:
|
|
||||||
case <-ctx.Done():
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
err := s.srv.Shutdown(ctx)
|
err := s.srv.Shutdown(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Join(err, s.srv.Close())
|
return errors.Join(err, s.srv.Close())
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"math"
|
"math"
|
||||||
|
"math/rand"
|
||||||
"net/http"
|
"net/http"
|
||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
@@ -57,6 +58,10 @@ const (
|
|||||||
// Well above an extended BGP message (RFC 8654) in hex plus its prefixes
|
// Well above an extended BGP message (RFC 8654) in hex plus its prefixes
|
||||||
maxLineSize = bytesPerMB
|
maxLineSize = bytesPerMB
|
||||||
maxConcurrentHandlers = 800 // Maximum number of concurrent message handlers
|
maxConcurrentHandlers = 800 // Maximum number of concurrent message handlers
|
||||||
|
|
||||||
|
// Backpressure constants
|
||||||
|
backpressureThreshold = 0.5 // Start dropping at 50% queue utilization
|
||||||
|
backpressureSlope = 2.0 // Slope for linear drop probability increase
|
||||||
)
|
)
|
||||||
|
|
||||||
// messageTypeNotification is the type of a BGP NOTIFICATION message, which ends
|
// messageTypeNotification is the type of a BGP NOTIFICATION message, which ends
|
||||||
@@ -88,8 +93,9 @@ type MessageHandler interface {
|
|||||||
|
|
||||||
// QueueCapacity returns the desired queue capacity for this handler.
|
// QueueCapacity returns the desired queue capacity for this handler.
|
||||||
// Handlers that process quickly can have larger queues to buffer bursts.
|
// Handlers that process quickly can have larger queues to buffer bursts.
|
||||||
// While the queue is full, the streamer drops the handler's messages,
|
// When the queue fills up, messages will be dropped according to the
|
||||||
// except STATE messages, which are held until there is room.
|
// backpressure algorithm, except STATE messages, which are held until
|
||||||
|
// there is room.
|
||||||
QueueCapacity() int
|
QueueCapacity() int
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -120,8 +126,8 @@ type handlerInfo struct {
|
|||||||
|
|
||||||
// Streamer manages a connection to the RIPE RIS Live streaming API for receiving
|
// Streamer manages a connection to the RIPE RIS Live streaming API for receiving
|
||||||
// real-time BGP UPDATE messages. It handles automatic reconnection with exponential
|
// real-time BGP UPDATE messages. It handles automatic reconnection with exponential
|
||||||
// backoff and dispatches messages to registered handlers via per-handler queues.
|
// backoff, dispatches messages to registered handlers via per-handler queues, and
|
||||||
// Its read loop never waits for room on a queue (see queueMessage).
|
// implements backpressure to prevent queue overflow during high traffic periods.
|
||||||
type Streamer struct {
|
type Streamer struct {
|
||||||
logger *logger.Logger
|
logger *logger.Logger
|
||||||
client *http.Client
|
client *http.Client
|
||||||
@@ -138,6 +144,7 @@ type Streamer struct {
|
|||||||
workers sync.WaitGroup // the handler workers; Stop waits for them
|
workers sync.WaitGroup // the handler workers; Stop waits for them
|
||||||
metrics *metrics.Tracker
|
metrics *metrics.Tracker
|
||||||
totalDropped atomic.Uint64 // Total dropped messages across all handlers
|
totalDropped atomic.Uint64 // Total dropped messages across all handlers
|
||||||
|
random *rand.Rand // Random number generator for backpressure drops
|
||||||
bgpPeers map[string]bool // Track active BGP peers by peer IP
|
bgpPeers map[string]bool // Track active BGP peers by peer IP
|
||||||
bgpPeersMu sync.RWMutex // Protects bgpPeers map
|
bgpPeersMu sync.RWMutex // Protects bgpPeers map
|
||||||
}
|
}
|
||||||
@@ -161,6 +168,8 @@ func New(logger *logger.Logger, metrics *metrics.Tracker) *Streamer {
|
|||||||
},
|
},
|
||||||
handlers: make([]*handlerInfo, 0),
|
handlers: make([]*handlerInfo, 0),
|
||||||
metrics: metrics,
|
metrics: metrics,
|
||||||
|
//nolint:gosec // Non-cryptographic randomness is fine for backpressure
|
||||||
|
random: rand.New(rand.NewSource(time.Now().UnixNano())),
|
||||||
bgpPeers: make(map[string]bool),
|
bgpPeers: make(map[string]bool),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -342,10 +351,6 @@ type HandlerStats struct {
|
|||||||
AvgProcessTime time.Duration
|
AvgProcessTime time.Duration
|
||||||
MinProcessTime time.Duration
|
MinProcessTime time.Duration
|
||||||
MaxProcessTime time.Duration
|
MaxProcessTime time.Duration
|
||||||
// HeldBackCount is how many messages the handler holds back to apply
|
|
||||||
// later: what its HeldBackCount method returns, or 0 for a handler
|
|
||||||
// without one.
|
|
||||||
HeldBackCount int
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetHandlerStats returns a snapshot of performance statistics for all registered
|
// GetHandlerStats returns a snapshot of performance statistics for all registered
|
||||||
@@ -387,11 +392,6 @@ func (s *Streamer) GetHandlerStats() []HandlerStats {
|
|||||||
|
|
||||||
info.metrics.mu.Unlock()
|
info.metrics.mu.Unlock()
|
||||||
|
|
||||||
holder, holdsBack := info.handler.(interface{ HeldBackCount() int })
|
|
||||||
if holdsBack {
|
|
||||||
hs.HeldBackCount = holder.HeldBackCount()
|
|
||||||
}
|
|
||||||
|
|
||||||
stats = append(stats, hs)
|
stats = append(stats, hs)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -399,7 +399,7 @@ func (s *Streamer) GetHandlerStats() []HandlerStats {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetDroppedMessages returns the total number of messages dropped across all
|
// GetDroppedMessages returns the total number of messages dropped across all
|
||||||
// handlers because their queue was full. This counter is monotonically
|
// handlers due to queue overflow or backpressure. This counter is monotonically
|
||||||
// increasing and is safe to call concurrently.
|
// increasing and is safe to call concurrently.
|
||||||
func (s *Streamer) GetDroppedMessages() uint64 {
|
func (s *Streamer) GetDroppedMessages() uint64 {
|
||||||
return s.totalDropped.Load()
|
return s.totalDropped.Load()
|
||||||
@@ -882,13 +882,13 @@ func (s *Streamer) dispatchMessage(
|
|||||||
// msg instead. It never waits for room, so a full queue does not hold up the
|
// msg instead. It never waits for room, so a full queue does not hold up the
|
||||||
// read loop.
|
// read loop.
|
||||||
//
|
//
|
||||||
// A message that finds the queue full is dropped, except a STATE message. A
|
// A message is dropped while the queue is filling up (shouldDropForBackpressure)
|
||||||
// STATE message whose state is down is the only notice that all of a peer's
|
// or full, except a STATE message: one whose state is down is the only notice
|
||||||
// routes are gone. A STATE message that finds the queue full is held in
|
// that all of a peer's routes are gone. A STATE message skips the random drop,
|
||||||
// info.heldState instead. Held messages go into the queue, oldest first, when a
|
// and one that finds the queue full is held in info.heldState. Held messages
|
||||||
// later message for the handler finds room, or when Stop is called. While any
|
// go into the queue, oldest first, before anything else for the handler, as
|
||||||
// message is held, the handler's other messages are dropped, so none of them
|
// soon as there is room, or when Stop is called; while any is still held, the
|
||||||
// overtakes a held STATE message.
|
// handler's other messages are dropped, so none of them overtakes a held down.
|
||||||
//
|
//
|
||||||
// The held list stays small: a STATE message is a few hundred bytes and the
|
// The held list stays small: a STATE message is a few hundred bytes and the
|
||||||
// feed sends about ten a second, so a queue full for a minute holds about 600.
|
// feed sends about ten a second, so a queue full for a minute holds about 600.
|
||||||
@@ -907,7 +907,7 @@ func (s *Streamer) queueMessage(
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(info.heldState) > 0 {
|
if len(info.heldState) > 0 || s.shouldDropForBackpressure(info) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -923,3 +923,26 @@ func trySend(queue chan *ristypes.RISMessage, msg *ristypes.RISMessage) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// shouldDropForBackpressure determines if a message should be dropped based on
|
||||||
|
// queue utilization
|
||||||
|
func (s *Streamer) shouldDropForBackpressure(info *handlerInfo) bool {
|
||||||
|
// Calculate queue utilization
|
||||||
|
queueLen := len(info.queue)
|
||||||
|
queueCap := cap(info.queue)
|
||||||
|
utilization := float64(queueLen) / float64(queueCap)
|
||||||
|
|
||||||
|
// No drops below threshold
|
||||||
|
if utilization < backpressureThreshold {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Calculate drop probability (0.0 at threshold, 1.0 at 100% full)
|
||||||
|
dropProbability := (utilization - backpressureThreshold) * backpressureSlope
|
||||||
|
if dropProbability > 1.0 {
|
||||||
|
dropProbability = 1.0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Random drop based on probability
|
||||||
|
return s.random.Float64() < dropProbability
|
||||||
|
}
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -259,65 +258,6 @@ func TestHeldStateMessagesKeepTheirPlaceInTheQueue(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// burstQueueCapacity is the size of a burstHandler's queue.
|
|
||||||
const burstQueueCapacity = 1000
|
|
||||||
|
|
||||||
// burstHandler wants UPDATE messages and has a queue of burstQueueCapacity.
|
|
||||||
// Tests read what it is handed from its queue, so HandleMessage does nothing.
|
|
||||||
type burstHandler struct{}
|
|
||||||
|
|
||||||
func (burstHandler) WantsMessage(messageType string) bool {
|
|
||||||
return messageType == ristypes.MessageTypeUpdate
|
|
||||||
}
|
|
||||||
|
|
||||||
func (burstHandler) QueueCapacity() int { return burstQueueCapacity }
|
|
||||||
|
|
||||||
func (burstHandler) HandleMessage(*ristypes.RISMessage) {}
|
|
||||||
|
|
||||||
// TestUpdatesDroppedOnlyWhenTheQueueIsFull has the server send one UPDATE more
|
|
||||||
// than the handler's queue holds, each with its own timestamp. Nothing takes
|
|
||||||
// messages off the queue meanwhile. The streamer must queue the updates in
|
|
||||||
// feed order until the queue is full, and drop only the last one.
|
|
||||||
func TestUpdatesDroppedOnlyWhenTheQueueIsFull(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
|
||||||
firstTimestamp = 1700000000
|
|
||||||
lineFormat = `{"type":"ris_message","data":{"type":"UPDATE",` +
|
|
||||||
`"peer":"192.0.2.1","peer_asn":"64496","timestamp":%d}}` + "\n"
|
|
||||||
)
|
|
||||||
|
|
||||||
var lines strings.Builder
|
|
||||||
|
|
||||||
for i := range burstQueueCapacity + 1 {
|
|
||||||
fmt.Fprintf(&lines, lineFormat, firstTimestamp+i)
|
|
||||||
}
|
|
||||||
|
|
||||||
s := New(logger.New(), metrics.New())
|
|
||||||
s.RegisterHandler(burstHandler{})
|
|
||||||
|
|
||||||
streamLines(t, s, lines.String())
|
|
||||||
|
|
||||||
dropped := s.GetHandlerStats()[0].DroppedCount
|
|
||||||
if dropped != 1 {
|
|
||||||
t.Errorf("%d updates dropped, want only the one that found the queue "+
|
|
||||||
"full", dropped)
|
|
||||||
}
|
|
||||||
|
|
||||||
queue := s.handlers[0].queue
|
|
||||||
if len(queue) != burstQueueCapacity {
|
|
||||||
t.Fatalf("%d updates queued, want %d", len(queue), burstQueueCapacity)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := range burstQueueCapacity {
|
|
||||||
msg := <-queue
|
|
||||||
if msg.Timestamp != float64(firstTimestamp+i) {
|
|
||||||
t.Fatalf("update %d on the queue has timestamp %.0f, want %d",
|
|
||||||
i, msg.Timestamp, firstTimestamp+i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// takeAll takes the messages off queue, as a handler's worker would, and sends
|
// takeAll takes the messages off queue, as a handler's worker would, and sends
|
||||||
// them on the returned channel once queue is closed.
|
// them on the returned channel once queue is closed.
|
||||||
func takeAll(queue chan *ristypes.RISMessage) chan []*ristypes.RISMessage {
|
func takeAll(queue chan *ristypes.RISMessage) chan []*ristypes.RISMessage {
|
||||||
|
|||||||
@@ -714,8 +714,7 @@
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// IP lookup: show the whole JSON answer, its @meta and an error answer
|
// IP lookup
|
||||||
// included, as the IP information API card does.
|
|
||||||
document.getElementById('ip-form').addEventListener('submit', function(e) {
|
document.getElementById('ip-form').addEventListener('submit', function(e) {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
const ip = document.getElementById('ip-input').value.trim();
|
const ip = document.getElementById('ip-input').value.trim();
|
||||||
@@ -731,11 +730,18 @@
|
|||||||
|
|
||||||
fetch('/ip/' + encodeURIComponent(ip))
|
fetch('/ip/' + encodeURIComponent(ip))
|
||||||
.then(response => response.json())
|
.then(response => response.json())
|
||||||
.then(answer => {
|
.then(response => {
|
||||||
|
contentEl.classList.remove('loading');
|
||||||
|
if (response.status === 'error') {
|
||||||
|
contentEl.className = 'error';
|
||||||
|
contentEl.textContent = 'Error: ' + response.error.msg;
|
||||||
|
} else {
|
||||||
contentEl.className = '';
|
contentEl.className = '';
|
||||||
contentEl.textContent = JSON.stringify(answer, null, 2);
|
contentEl.textContent = JSON.stringify(response.data, null, 2);
|
||||||
|
}
|
||||||
})
|
})
|
||||||
.catch(error => {
|
.catch(error => {
|
||||||
|
contentEl.classList.remove('loading');
|
||||||
contentEl.className = 'error';
|
contentEl.className = 'error';
|
||||||
contentEl.textContent = 'Error: ' + error.message;
|
contentEl.textContent = 'Error: ' + error.message;
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -401,8 +401,6 @@
|
|||||||
const REFRESH_PERIOD_MS = 2000;
|
const REFRESH_PERIOD_MS = 2000;
|
||||||
const STALE_AFTER_REFRESHES = 3;
|
const STALE_AFTER_REFRESHES = 3;
|
||||||
const MS_PER_SECOND = 1000;
|
const MS_PER_SECOND = 1000;
|
||||||
const SECONDS_PER_MINUTE = 60;
|
|
||||||
const SECONDS_PER_HOUR = 3600;
|
|
||||||
const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
|
const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
|
||||||
const SPINNER_COLOURS = ['#e74c3c', '#e67e22', '#f1c40f', '#27ae60', '#3498db', '#9b59b6'];
|
const SPINNER_COLOURS = ['#e74c3c', '#e67e22', '#f1c40f', '#27ae60', '#3498db', '#9b59b6'];
|
||||||
|
|
||||||
@@ -446,17 +444,6 @@
|
|||||||
return num.toLocaleString();
|
return num.toLocaleString();
|
||||||
}
|
}
|
||||||
|
|
||||||
// formatDuration writes a number of seconds in hours, minutes and
|
|
||||||
// seconds, such as "1h 18m 34s" or "18.2s", with at most one decimal.
|
|
||||||
function formatDuration(totalSeconds) {
|
|
||||||
const hours = Math.floor(totalSeconds / SECONDS_PER_HOUR);
|
|
||||||
const minutes = Math.floor(totalSeconds % SECONDS_PER_HOUR / SECONDS_PER_MINUTE);
|
|
||||||
const seconds = parseFloat((totalSeconds % SECONDS_PER_MINUTE).toFixed(1));
|
|
||||||
if (hours > 0) return hours + 'h ' + minutes + 'm ' + seconds + 's';
|
|
||||||
if (minutes > 0) return minutes + 'm ' + seconds + 's';
|
|
||||||
return seconds + 's';
|
|
||||||
}
|
|
||||||
|
|
||||||
function formatProcessingTime(ms) {
|
function formatProcessingTime(ms) {
|
||||||
if (ms < 0.001) {
|
if (ms < 0.001) {
|
||||||
return (ms * 1000).toFixed(0) + ' µs';
|
return (ms * 1000).toFixed(0) + ' µs';
|
||||||
@@ -541,10 +528,6 @@
|
|||||||
<span class="metric-label">Dropped</span>
|
<span class="metric-label">Dropped</span>
|
||||||
<span class="metric-value ${handler.dropped_count > 0 ? 'disconnected' : ''}">${formatNumber(handler.dropped_count)}</span>
|
<span class="metric-value ${handler.dropped_count > 0 ? 'disconnected' : ''}">${formatNumber(handler.dropped_count)}</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="metric">
|
|
||||||
<span class="metric-label">Held Back</span>
|
|
||||||
<span class="metric-value">${formatNumber(handler.held_back_count)}</span>
|
|
||||||
</div>
|
|
||||||
<div class="metric">
|
<div class="metric">
|
||||||
<span class="metric-label">Avg Time</span>
|
<span class="metric-label">Avg Time</span>
|
||||||
<span class="metric-value">${formatProcessingTime(handler.avg_process_time_ms)}</span>
|
<span class="metric-value">${formatProcessingTime(handler.avg_process_time_ms)}</span>
|
||||||
@@ -636,13 +619,11 @@
|
|||||||
noteMessageCount(data.total_messages);
|
noteMessageCount(data.total_messages);
|
||||||
|
|
||||||
// Update all metrics
|
// Update all metrics
|
||||||
document.getElementById('uptime').textContent = formatDuration(data.uptime_seconds);
|
document.getElementById('uptime').textContent = data.uptime;
|
||||||
document.getElementById('go_version').textContent = data.go_version;
|
document.getElementById('go_version').textContent = data.go_version;
|
||||||
document.getElementById('goroutines').textContent = formatNumber(data.goroutines);
|
document.getElementById('goroutines').textContent = formatNumber(data.goroutines);
|
||||||
document.getElementById('memory_usage').textContent = formatBytes(data.memory_usage_bytes);
|
document.getElementById('memory_usage').textContent = data.memory_usage;
|
||||||
// connection_duration_seconds is null while the stream is not connected.
|
document.getElementById('connection_duration').textContent = data.connection_duration;
|
||||||
document.getElementById('connection_duration').textContent =
|
|
||||||
data.connection_duration_seconds === null ? 'disconnected' : formatDuration(data.connection_duration_seconds);
|
|
||||||
document.getElementById('reconnect_count').textContent = formatNumber(data.reconnect_count);
|
document.getElementById('reconnect_count').textContent = formatNumber(data.reconnect_count);
|
||||||
document.getElementById('total_messages').textContent = formatNumber(data.total_messages);
|
document.getElementById('total_messages').textContent = formatNumber(data.total_messages);
|
||||||
document.getElementById('messages_per_sec').textContent = formatNumber(Math.round(data.messages_per_sec));
|
document.getElementById('messages_per_sec').textContent = formatNumber(Math.round(data.messages_per_sec));
|
||||||
@@ -691,7 +672,7 @@
|
|||||||
const errorsEl = document.getElementById('whois_errors');
|
const errorsEl = document.getElementById('whois_errors');
|
||||||
errorsEl.textContent = formatNumber(data.whois_stats.errors_last_hour);
|
errorsEl.textContent = formatNumber(data.whois_stats.errors_last_hour);
|
||||||
errorsEl.className = 'metric-value' + (data.whois_stats.errors_last_hour > 0 ? ' disconnected' : '');
|
errorsEl.className = 'metric-value' + (data.whois_stats.errors_last_hour > 0 ? ' disconnected' : '');
|
||||||
document.getElementById('whois_interval').textContent = formatDuration(data.whois_stats.current_interval_seconds);
|
document.getElementById('whois_interval').textContent = data.whois_stats.current_interval;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Update handler stats
|
// Update handler stats
|
||||||
|
|||||||
+36
-82
@@ -12,7 +12,6 @@ import (
|
|||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"syscall"
|
|
||||||
"time"
|
"time"
|
||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
|
|
||||||
@@ -71,12 +70,12 @@ const nicbrHeader = "% Copyright (c) Nic.br"
|
|||||||
// queries to stop the data being taken in bulk.
|
// queries to stop the data being taken in bulk.
|
||||||
const nicbrLimitReached = "Query rate limit exceeded"
|
const nicbrLimitReached = "Query rate limit exceeded"
|
||||||
|
|
||||||
// PauseTime is how long the client sends an RIR's or NIC.br's server no
|
// NICbrSkipTime is how long the client stops asking NIC.br after NIC.br
|
||||||
// query after that server refuses a query. queryRegistry says what a
|
// answers that the client is over its query limit. NIC.br publishes
|
||||||
// refusal is. RIPE refuses an address for good when the address keeps
|
// neither the limit nor how long it lasts. An hour outlasts a limit
|
||||||
// passing RIPE's limit (see noPersonalFlag). An hour outlasts a limit
|
// counted per minute or per hour. The ASes looked up meanwhile get
|
||||||
// counted per minute or per hour.
|
// NIC.br's fields when they are next refreshed.
|
||||||
const PauseTime = time.Hour
|
const NICbrSkipTime = time.Hour
|
||||||
|
|
||||||
// RIR identifiers.
|
// RIR identifiers.
|
||||||
const (
|
const (
|
||||||
@@ -126,10 +125,6 @@ var (
|
|||||||
errAnswerTooLarge = errors.New("WHOIS answer reached the size cap")
|
errAnswerTooLarge = errors.New("WHOIS answer reached the size cap")
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrPaused is returned when a lookup needs a server that refused a query
|
|
||||||
// less than PauseTime ago. The client sends that server nothing meanwhile.
|
|
||||||
var ErrPaused = errors.New("WHOIS server paused after refusing a query")
|
|
||||||
|
|
||||||
// ASNInfo contains parsed WHOIS information for an ASN.
|
// ASNInfo contains parsed WHOIS information for an ASN.
|
||||||
type ASNInfo struct {
|
type ASNInfo struct {
|
||||||
ASN int
|
ASN int
|
||||||
@@ -161,12 +156,12 @@ type Client struct {
|
|||||||
|
|
||||||
logger *slog.Logger
|
logger *slog.Logger
|
||||||
|
|
||||||
// mu guards pausedUntil.
|
// mu guards nicbrSkipUntil.
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
|
|
||||||
// pausedUntil maps a server, given as host:port, to the time the client
|
// nicbrSkipUntil is when the client next asks NIC.br, after NIC.br
|
||||||
// may ask it again.
|
// answered that the client is over its query limit.
|
||||||
pausedUntil map[string]time.Time
|
nicbrSkipUntil time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewClient creates a new WHOIS client that logs to logger.
|
// NewClient creates a new WHOIS client that logs to logger.
|
||||||
@@ -177,29 +172,23 @@ func NewClient(logger *slog.Logger) *Client {
|
|||||||
DialContext: dialer.DialContext,
|
DialContext: dialer.DialContext,
|
||||||
Now: time.Now,
|
Now: time.Now,
|
||||||
logger: logger,
|
logger: logger,
|
||||||
pausedUntil: make(map[string]time.Time),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// LookupASN asks IANA which RIR holds the given ASN, asks that RIR, and
|
// LookupASN asks IANA which RIR holds the given ASN, asks that RIR, and
|
||||||
// returns what the RIR's answer says. When LACNIC's answer is NIC.br's, it
|
// returns what the RIR's answer says. When LACNIC's answer is NIC.br's, it
|
||||||
// returns what NIC.br's own server says instead, unless that query fails or
|
// returns what NIC.br's own server says instead, unless that query fails or
|
||||||
// NIC.br is paused, as askNICbr says.
|
// is skipped, as askNICbr says.
|
||||||
//
|
//
|
||||||
// It returns ErrNoReferral when IANA refers the AS to no RIR. Its error
|
// It returns ErrNoReferral when IANA refers the AS to no RIR, and another
|
||||||
// wraps ErrPaused when the RIR is paused. It returns another error in each
|
// error when the query to IANA or to the RIR fails, when the RIR refuses
|
||||||
// of these cases:
|
// it, when IANA's answer has neither a referral nor the AS's block, when
|
||||||
//
|
// IANA refers the AS to a server none of the five RIRs run, or when the
|
||||||
// - the query to IANA or to the RIR fails
|
// answer carries none of ASNInfo's fields.
|
||||||
// - the RIR refuses the query
|
|
||||||
// - IANA's answer has neither a referral nor the AS's block
|
|
||||||
// - IANA refers the AS to a server none of the five RIRs run
|
|
||||||
// - the answer carries none of ASNInfo's fields
|
|
||||||
func (c *Client) LookupASN(ctx context.Context, asn int) (*ASNInfo, error) {
|
func (c *Client) LookupASN(ctx context.Context, asn int) (*ASNInfo, error) {
|
||||||
// Query IANA first to find the authoritative RIR
|
// Query IANA first to find the authoritative RIR
|
||||||
query := fmt.Sprintf("AS%d", asn)
|
query := fmt.Sprintf("AS%d", asn)
|
||||||
|
|
||||||
// IANA is never paused, because a pause of IANA would stop every lookup.
|
|
||||||
ianaResp, err := c.query(ctx, whoisServerIANA, query)
|
ianaResp, err := c.query(ctx, whoisServerIANA, query)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("IANA query failed: %w", err)
|
return nil, fmt.Errorf("IANA query failed: %w", err)
|
||||||
@@ -222,7 +211,7 @@ func (c *Client) LookupASN(ctx context.Context, asn int) (*ASNInfo, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Query the authoritative RIR
|
// Query the authoritative RIR
|
||||||
rirResp, err := c.queryRegistry(ctx, whoisServer, rirQuery(rir, query))
|
rirResp, err := c.queryRIR(ctx, whoisServer, rirQuery(rir, query))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("RIR query failed: %w", err)
|
return nil, fmt.Errorf("RIR query failed: %w", err)
|
||||||
}
|
}
|
||||||
@@ -252,19 +241,22 @@ func (c *Client) LookupASN(ctx context.Context, asn int) (*ASNInfo, error) {
|
|||||||
// askNICbr returns lacnicInfo, what LACNIC's answer says, and logs a
|
// askNICbr returns lacnicInfo, what LACNIC's answer says, and logs a
|
||||||
// warning when the query fails, when NIC.br sends the reduced answer for a
|
// warning when the query fails, when NIC.br sends the reduced answer for a
|
||||||
// client over its limit, or when NIC.br's answer carries none of ASNInfo's
|
// client over its limit, or when NIC.br's answer carries none of ASNInfo's
|
||||||
// fields. The reduced answer pauses NIC.br, as a refusal does. While NIC.br
|
// fields. After the reduced answer, it returns lacnicInfo without asking
|
||||||
// is paused, askNICbr returns lacnicInfo without a warning. The ASes looked
|
// NIC.br until NICbrSkipTime has passed.
|
||||||
// up meanwhile get NIC.br's fields when they are next refreshed.
|
|
||||||
func (c *Client) askNICbr(
|
func (c *Client) askNICbr(
|
||||||
ctx context.Context, asQuery string, lacnicInfo *ASNInfo,
|
ctx context.Context, asQuery string, lacnicInfo *ASNInfo,
|
||||||
) *ASNInfo {
|
) *ASNInfo {
|
||||||
asn := lacnicInfo.ASN
|
asn := lacnicInfo.ASN
|
||||||
|
|
||||||
answer, err := c.queryRegistry(ctx, whoisServerNICbr, asQuery)
|
c.mu.Lock()
|
||||||
if errors.Is(err, ErrPaused) {
|
skipping := c.Now().Before(c.nicbrSkipUntil)
|
||||||
|
c.mu.Unlock()
|
||||||
|
|
||||||
|
if skipping {
|
||||||
return lacnicInfo
|
return lacnicInfo
|
||||||
}
|
}
|
||||||
|
|
||||||
|
answer, err := c.query(ctx, whoisServerNICbr, asQuery)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
c.logger.Warn("NIC.br query failed, keeping LACNIC's fields",
|
c.logger.Warn("NIC.br query failed, keeping LACNIC's fields",
|
||||||
"asn", asn, "error", err)
|
"asn", asn, "error", err)
|
||||||
@@ -273,11 +265,13 @@ func (c *Client) askNICbr(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if strings.Contains(answer, nicbrLimitReached) {
|
if strings.Contains(answer, nicbrLimitReached) {
|
||||||
c.pause(whoisServerNICbr)
|
c.mu.Lock()
|
||||||
|
c.nicbrSkipUntil = c.Now().Add(NICbrSkipTime)
|
||||||
|
c.mu.Unlock()
|
||||||
|
|
||||||
c.logger.Warn("NIC.br answered that the client is over its query "+
|
c.logger.Warn("NIC.br answered that the client is over its query "+
|
||||||
"limit, keeping LACNIC's fields and pausing NIC.br",
|
"limit, keeping LACNIC's fields and skipping NIC.br",
|
||||||
"asn", asn, "pause_for", PauseTime)
|
"asn", asn, "skip_for", NICbrSkipTime)
|
||||||
|
|
||||||
return lacnicInfo
|
return lacnicInfo
|
||||||
}
|
}
|
||||||
@@ -315,65 +309,25 @@ func rirQuery(rir, asQuery string) string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// queryRegistry sends query to the server of an RIR or of NIC.br, and
|
// queryRIR sends query to an RIR's server and returns the answer. An answer
|
||||||
// returns the answer. The client pauses the server for PauseTime when the
|
// holding an error line with which the server refuses the query is an
|
||||||
// server refuses the query. Each of these is a refusal:
|
// error, and the error holds that line.
|
||||||
//
|
func (c *Client) queryRIR(
|
||||||
// - a refused connection
|
|
||||||
// - a reset connection
|
|
||||||
// - an %ERROR:201: or %ERROR:202: line in the answer
|
|
||||||
//
|
|
||||||
// A refusal is returned as an error. While the server is paused,
|
|
||||||
// queryRegistry sends it nothing and returns an error that wraps ErrPaused.
|
|
||||||
func (c *Client) queryRegistry(
|
|
||||||
ctx context.Context, server, query string,
|
ctx context.Context, server, query string,
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
c.mu.Lock()
|
|
||||||
pausedUntil := c.pausedUntil[server]
|
|
||||||
c.mu.Unlock()
|
|
||||||
|
|
||||||
if c.Now().Before(pausedUntil) {
|
|
||||||
return "", fmt.Errorf("%w: %s until %s", ErrPaused, server,
|
|
||||||
pausedUntil.UTC().Format(time.RFC3339))
|
|
||||||
}
|
|
||||||
|
|
||||||
answer, err := c.query(ctx, server, query)
|
answer, err := c.query(ctx, server, query)
|
||||||
if err == nil {
|
|
||||||
err = checkRefusal(answer)
|
|
||||||
}
|
|
||||||
|
|
||||||
if errors.Is(err, errRefused) || errors.Is(err, syscall.ECONNREFUSED) ||
|
|
||||||
errors.Is(err, syscall.ECONNRESET) {
|
|
||||||
c.pause(server)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
return answer, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkRefusal returns an error holding the first line of answer that
|
|
||||||
// starts with accessDeniedError or accessLimitError. It returns nil when
|
|
||||||
// answer has no such line.
|
|
||||||
func checkRefusal(answer string) error {
|
|
||||||
for line := range strings.SplitSeq(answer, "\n") {
|
for line := range strings.SplitSeq(answer, "\n") {
|
||||||
if strings.HasPrefix(line, accessDeniedError) ||
|
if strings.HasPrefix(line, accessDeniedError) ||
|
||||||
strings.HasPrefix(line, accessLimitError) {
|
strings.HasPrefix(line, accessLimitError) {
|
||||||
return fmt.Errorf("%w: %s", errRefused, line)
|
return "", fmt.Errorf("%w: %s", errRefused, line)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return answer, nil
|
||||||
}
|
|
||||||
|
|
||||||
// pause stops queryRegistry from querying server until PauseTime has passed.
|
|
||||||
func (c *Client) pause(server string) {
|
|
||||||
c.mu.Lock()
|
|
||||||
defer c.mu.Unlock()
|
|
||||||
|
|
||||||
c.pausedUntil[server] = c.Now().Add(PauseTime)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// query performs a raw WHOIS query to the specified server and returns the
|
// query performs a raw WHOIS query to the specified server and returns the
|
||||||
|
|||||||
@@ -718,10 +718,9 @@ func TestLookupASNKeepsLACNICsAnswerWhenNICbrFails(t *testing.T) {
|
|||||||
|
|
||||||
// TestLookupASNSkipsNICbrAfterItsLimit looks up an AS that NIC.br
|
// TestLookupASNSkipsNICbrAfterItsLimit looks up an AS that NIC.br
|
||||||
// registers three times with one client, while NIC.br answers that the
|
// registers three times with one client, while NIC.br answers that the
|
||||||
// client is over its query limit. The test sets the client's clock. The
|
// client is over its query limit. The first lookup asks NIC.br. The
|
||||||
// first lookup asks NIC.br. The next comes a second before PauseTime has
|
// second, a second before NICbrSkipTime has passed, does not. The third,
|
||||||
// passed, and does not ask NIC.br. The last comes at PauseTime and asks
|
// once NICbrSkipTime has passed, asks again. Each keeps LACNIC's fields.
|
||||||
// NIC.br again. Each keeps LACNIC's fields.
|
|
||||||
func TestLookupASNSkipsNICbrAfterItsLimit(t *testing.T) {
|
func TestLookupASNSkipsNICbrAfterItsLimit(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -741,8 +740,8 @@ func TestLookupASNSkipsNICbrAfterItsLimit(t *testing.T) {
|
|||||||
wantAsks int
|
wantAsks int
|
||||||
}{
|
}{
|
||||||
{after: 0, wantAsks: 1},
|
{after: 0, wantAsks: 1},
|
||||||
{after: whois.PauseTime - time.Second, wantAsks: 1},
|
{after: whois.NICbrSkipTime - time.Second, wantAsks: 1},
|
||||||
{after: whois.PauseTime, wantAsks: 2},
|
{after: whois.NICbrSkipTime, wantAsks: 2},
|
||||||
} {
|
} {
|
||||||
now = start.Add(step.after)
|
now = start.Add(step.after)
|
||||||
|
|
||||||
@@ -786,142 +785,6 @@ func TestLookupASNReportsARefusal(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// resetServer starts a TCP server on the loopback address and returns the
|
|
||||||
// server's address. The server reads one query on each connection, then
|
|
||||||
// resets the connection.
|
|
||||||
func resetServer(t *testing.T) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var listenConfig net.ListenConfig
|
|
||||||
|
|
||||||
listener, err := listenConfig.Listen(t.Context(), "tcp", "127.0.0.1:0")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(func() { _ = listener.Close() })
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
conn, err := listener.Accept()
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
_, _ = bufio.NewReader(conn).ReadString('\n')
|
|
||||||
|
|
||||||
// Closing a connection whose linger time is zero resets it.
|
|
||||||
if tcpConn, ok := conn.(*net.TCPConn); ok {
|
|
||||||
_ = tcpConn.SetLinger(0)
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = conn.Close()
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
return listener.Addr().String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRIPEClient returns a client whose fake servers send answers. The
|
|
||||||
// client adds one to *ripeAsks each time it connects to RIPE's server. When
|
|
||||||
// reset is true, RIPE's server resets the connection instead of answering.
|
|
||||||
func newRIPEClient(
|
|
||||||
t *testing.T, answers map[string]string, reset bool, ripeAsks *int,
|
|
||||||
) *whois.Client {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
dial := fakeServers(t, answers)
|
|
||||||
resetAddress := resetServer(t)
|
|
||||||
|
|
||||||
client := whois.NewClient(slog.New(slog.DiscardHandler))
|
|
||||||
client.DialContext = func(
|
|
||||||
ctx context.Context, network, address string,
|
|
||||||
) (net.Conn, error) {
|
|
||||||
if address == ripeServer {
|
|
||||||
*ripeAsks++
|
|
||||||
}
|
|
||||||
|
|
||||||
if address == ripeServer && reset {
|
|
||||||
var dialer net.Dialer
|
|
||||||
|
|
||||||
return dialer.DialContext(ctx, network, resetAddress)
|
|
||||||
}
|
|
||||||
|
|
||||||
return dial(ctx, network, address)
|
|
||||||
}
|
|
||||||
|
|
||||||
return client
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLookupASNPausesAServerThatRefuses looks up an AS at RIPE while RIPE
|
|
||||||
// refuses the query, in each of the ways a server refuses. The test sets
|
|
||||||
// the client's clock. A lookup a second before PauseTime has passed fails
|
|
||||||
// with ErrPaused and asks RIPE nothing. A lookup of an AS at APNIC succeeds
|
|
||||||
// during the pause. A lookup at PauseTime asks RIPE again.
|
|
||||||
func TestLookupASNPausesAServerThatRefuses(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for name, test := range map[string]struct {
|
|
||||||
// ripeAnswer is RIPE's answer. With none, RIPE's server refuses
|
|
||||||
// the connection, or resets it when reset is true.
|
|
||||||
ripeAnswer string
|
|
||||||
reset bool
|
|
||||||
}{
|
|
||||||
"access denied": {ripeAnswer: ripeRefusal},
|
|
||||||
"limit reached": {ripeAnswer: ripeLimitReached + "\n"},
|
|
||||||
"refused connection": {},
|
|
||||||
"reset connection": {reset: true},
|
|
||||||
} {
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
answers := map[string]string{
|
|
||||||
ianaQuery: ianaReferral,
|
|
||||||
apnicIANAQuery: "refer: whois.apnic.net\n",
|
|
||||||
apnicQuery: apnicRecord,
|
|
||||||
}
|
|
||||||
if test.ripeAnswer != "" {
|
|
||||||
answers[ripeQuery] = test.ripeAnswer
|
|
||||||
}
|
|
||||||
|
|
||||||
ripeAsks := 0
|
|
||||||
client := newRIPEClient(t, answers, test.reset, &ripeAsks)
|
|
||||||
|
|
||||||
start := time.Date(2026, 11, 2, 0, 0, 0, 0, time.UTC)
|
|
||||||
now := start
|
|
||||||
client.Now = func() time.Time { return now }
|
|
||||||
|
|
||||||
_, err := client.LookupASN(t.Context(), testASN)
|
|
||||||
if err == nil || errors.Is(err, whois.ErrPaused) {
|
|
||||||
t.Fatalf("LookupASN while RIPE refuses: error %v, want a "+
|
|
||||||
"refusal", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
now = start.Add(whois.PauseTime - time.Second)
|
|
||||||
|
|
||||||
_, err = client.LookupASN(t.Context(), testASN)
|
|
||||||
if !errors.Is(err, whois.ErrPaused) || ripeAsks != 1 {
|
|
||||||
t.Errorf("LookupASN during the pause: error %v after %d "+
|
|
||||||
"queries to RIPE, want ErrPaused after 1", err, ripeAsks)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = client.LookupASN(t.Context(), apnicASN)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("LookupASN of an AS at APNIC during RIPE's "+
|
|
||||||
"pause: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
now = start.Add(whois.PauseTime)
|
|
||||||
|
|
||||||
_, _ = client.LookupASN(t.Context(), testASN)
|
|
||||||
if ripeAsks != 2 {
|
|
||||||
t.Errorf("RIPE was asked %d times after the pause, want 2",
|
|
||||||
ripeAsks)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLookupASNFailsWhenTheRIRGivesNoAnswer looks up an AS IANA refers to
|
// TestLookupASNFailsWhenTheRIRGivesNoAnswer looks up an AS IANA refers to
|
||||||
// RIPE when RIPE's server refuses the connection, and when it answers only
|
// RIPE when RIPE's server refuses the connection, and when it answers only
|
||||||
// with an error. Neither is a lookup that found the AS.
|
// with an error. Neither is a lookup that found the AS.
|
||||||
|
|||||||
Reference in New Issue
Block a user