Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
485aa4194a | ||
|
|
a279cf8583 |
@@ -1,6 +1,5 @@
|
|||||||
node_modules
|
node_modules
|
||||||
dist
|
dist
|
||||||
tmp
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
*.log
|
*.log
|
||||||
.claude
|
.claude
|
||||||
|
|||||||
@@ -6,5 +6,5 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
# script/cibuild builds the image, whose stages run every check.
|
|
||||||
- run: script/cibuild
|
- run: script/cibuild
|
||||||
|
- run: docker build -f Dockerfile.backend .
|
||||||
|
|||||||
+1
-25
@@ -1,28 +1,4 @@
|
|||||||
# OS
|
|
||||||
.DS_Store
|
|
||||||
Thumbs.db
|
|
||||||
|
|
||||||
# Editors
|
|
||||||
*.swp
|
|
||||||
*.swo
|
|
||||||
*~
|
|
||||||
*.bak
|
|
||||||
.idea/
|
|
||||||
.vscode/
|
|
||||||
*.sublime-*
|
|
||||||
|
|
||||||
# Node
|
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
# Environment / secrets
|
|
||||||
.env
|
|
||||||
.env.*
|
|
||||||
*.pem
|
|
||||||
*.key
|
|
||||||
|
|
||||||
# Build output
|
|
||||||
dist/
|
dist/
|
||||||
tmp/
|
.DS_Store
|
||||||
|
|
||||||
# Logs
|
|
||||||
*.log
|
*.log
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
backend/
|
backend/
|
||||||
dist/
|
dist/
|
||||||
node_modules/
|
node_modules/
|
||||||
tmp/
|
|
||||||
yarn.lock
|
yarn.lock
|
||||||
.claude/
|
.claude/
|
||||||
|
|||||||
+5
-73
@@ -1,86 +1,18 @@
|
|||||||
# The one image netwatch ships: nginx serves the built frontend and
|
|
||||||
# passes /api/ and /.well-known/healthcheck to netwatch-server, the Go
|
|
||||||
# backend, which runs in the same container on loopback only.
|
|
||||||
# bin/entrypoint.sh starts and watches both.
|
|
||||||
|
|
||||||
# Lint stage — fast feedback on formatting and lint issues. The
|
|
||||||
# golangci/golangci-lint image ships Go, gofmt, make and the linter, so
|
|
||||||
# nothing is installed here. The root make lint builds this stage alone.
|
|
||||||
# golangci/golangci-lint:v2.12.2 (2026-08-10)
|
|
||||||
FROM golangci/golangci-lint@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS lint
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
COPY backend/go.mod backend/go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY backend/ .
|
|
||||||
RUN make fmt-check
|
|
||||||
RUN make lint
|
|
||||||
|
|
||||||
# Backend build stage
|
|
||||||
# golang:1.25-alpine (2026-02-27)
|
|
||||||
FROM golang:1.25-alpine@sha256:f6751d823c26342f9506c03797d2527668d095b0a15f1862cddb4d927a7a4ced AS builder
|
|
||||||
|
|
||||||
RUN apk add --no-cache make
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
|
|
||||||
# Force BuildKit to run the lint stage before proceeding. BuildKit runs
|
|
||||||
# stages in parallel by default; without this no-op copy a lint failure
|
|
||||||
# would not gate compilation.
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
|
|
||||||
COPY backend/go.mod backend/go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY backend/ .
|
|
||||||
|
|
||||||
RUN make test
|
|
||||||
|
|
||||||
# make build is a shim around backend/script/build, the one definition
|
|
||||||
# of the build command:
|
|
||||||
# CGO_ENABLED=0 go build -trimpath -ldflags "-s -w -X main.Version=... -X main.Buildarch=..."
|
|
||||||
# That script reads VERSION from the environment, so it is handed over
|
|
||||||
# there rather than as a make variable.
|
|
||||||
ARG VERSION=dev
|
|
||||||
RUN VERSION="${VERSION}" make build
|
|
||||||
|
|
||||||
# Frontend stage
|
|
||||||
# node:22-alpine as of 2026-02-22
|
# node:22-alpine as of 2026-02-22
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS frontend
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS build
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN yarn install --frozen-lockfile
|
RUN yarn install --frozen-lockfile
|
||||||
RUN apk add --no-cache git make
|
RUN apk add --no-cache git
|
||||||
COPY . .
|
COPY . .
|
||||||
# make frontend-check is the frontend half of make check (test + lint +
|
RUN yarn build
|
||||||
# fmt-check); its test step is the production yarn build, so this both
|
|
||||||
# produces dist/ and gates the image on lint/fmt-check/test regressions.
|
|
||||||
# This node stage has neither Go nor Docker; the lint and builder stages
|
|
||||||
# above gate the backend half.
|
|
||||||
RUN make frontend-check
|
|
||||||
|
|
||||||
# Runtime stage
|
|
||||||
# nginx:stable-alpine as of 2026-02-22
|
# nginx:stable-alpine as of 2026-02-22
|
||||||
FROM nginx@sha256:15e96e59aa3b0aada3a121296e3bce117721f42d88f5f64217ef4b18f458c6ab
|
FROM nginx@sha256:15e96e59aa3b0aada3a121296e3bce117721f42d88f5f64217ef4b18f458c6ab
|
||||||
|
|
||||||
# netwatch-server runs as this user, which owns the report directory.
|
|
||||||
# nginx keeps the image's own arrangement: its main process runs as
|
|
||||||
# root, its worker processes as the nginx user.
|
|
||||||
RUN addgroup -g 1000 -S netwatch && \
|
|
||||||
adduser -u 1000 -S netwatch -G netwatch
|
|
||||||
|
|
||||||
RUN rm /etc/nginx/conf.d/default.conf
|
RUN rm /etc/nginx/conf.d/default.conf
|
||||||
COPY nginx.conf /etc/nginx/conf.d/netwatch.conf
|
COPY nginx.conf /etc/nginx/conf.d/netwatch.conf
|
||||||
COPY --from=frontend /app/dist /usr/share/nginx/html
|
COPY --from=build /app/dist /usr/share/nginx/html
|
||||||
COPY --from=builder /src/netwatch-server /usr/local/bin/netwatch-server
|
|
||||||
COPY bin/entrypoint.sh /usr/local/bin/entrypoint.sh
|
|
||||||
|
|
||||||
ENV DATA_DIR=/data/reports
|
|
||||||
RUN mkdir -p /data/reports && chown -R netwatch:netwatch /data
|
|
||||||
VOLUME /data
|
|
||||||
|
|
||||||
EXPOSE 8080
|
EXPOSE 8080
|
||||||
|
|
||||||
# The nginx image stops its container with SIGQUIT; the entrypoint
|
CMD ["nginx", "-g", "daemon off;"]
|
||||||
# acts on TERM and INT.
|
|
||||||
STOPSIGNAL SIGTERM
|
|
||||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# golang:1.25-alpine (2026-02-27)
|
||||||
|
FROM golang:1.25-alpine@sha256:f6751d823c26342f9506c03797d2527668d095b0a15f1862cddb4d927a7a4ced AS builder
|
||||||
|
|
||||||
|
RUN apk add --no-cache git make gcc musl-dev
|
||||||
|
|
||||||
|
# golangci-lint v2.7.2 (2026-02-27)
|
||||||
|
RUN CGO_ENABLED=0 go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@9f61b0f53f80672872fced07b6874397c3ed197b
|
||||||
|
|
||||||
|
WORKDIR /repo/backend
|
||||||
|
COPY backend/go.mod backend/go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY .git /repo/.git
|
||||||
|
COPY backend/ .
|
||||||
|
|
||||||
|
RUN make check
|
||||||
|
RUN make build
|
||||||
|
|
||||||
|
# alpine:3.23 (2026-02-27)
|
||||||
|
FROM alpine:3.23@sha256:25109184c71bdad752c8312a8623239686a9a2071e8825f20acb8f2198c3f659
|
||||||
|
|
||||||
|
RUN apk add --no-cache ca-certificates
|
||||||
|
COPY --from=builder /repo/backend/netwatch-server /usr/local/bin/netwatch-server
|
||||||
|
|
||||||
|
EXPOSE 8080
|
||||||
|
ENTRYPOINT ["netwatch-server"]
|
||||||
@@ -1,10 +1,8 @@
|
|||||||
.PHONY: bootstrap setup dev test lint fmt fmt-check check frontend-check \
|
.PHONY: bootstrap setup dev test lint fmt fmt-check check docker hooks
|
||||||
frontend-viewport-test docker hooks
|
|
||||||
|
|
||||||
# Standard targets are thin shims; the implementations live in script/
|
# Standard targets are thin shims; the implementations live in script/
|
||||||
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
||||||
# of README.md). test, lint, fmt, fmt-check and check cover the whole
|
# of README.md).
|
||||||
# repo: the frontend here and the Go backend in backend/.
|
|
||||||
|
|
||||||
bootstrap:
|
bootstrap:
|
||||||
@script/bootstrap
|
@script/bootstrap
|
||||||
@@ -30,17 +28,6 @@ fmt-check:
|
|||||||
check:
|
check:
|
||||||
@script/check
|
@script/check
|
||||||
|
|
||||||
# The frontend half of check, for Dockerfile's node build stage, which
|
|
||||||
# has neither Go nor Docker. Use check everywhere else.
|
|
||||||
frontend-check:
|
|
||||||
@script/frontend-check
|
|
||||||
|
|
||||||
# Responsive-layout verification in a containerised browser. Kept out of
|
|
||||||
# check: it needs Docker and takes minutes, where make test has to stay
|
|
||||||
# under 20 seconds.
|
|
||||||
frontend-viewport-test:
|
|
||||||
@script/frontend-viewport-test
|
|
||||||
|
|
||||||
docker:
|
docker:
|
||||||
@script/docker
|
@script/docker
|
||||||
|
|
||||||
|
|||||||
@@ -23,62 +23,29 @@ docker build -t netwatch .
|
|||||||
docker run -p 8080:8080 netwatch
|
docker run -p 8080:8080 netwatch
|
||||||
```
|
```
|
||||||
|
|
||||||
`yarn dev` proxies `/api` to `http://127.0.0.1:8080`, so a locally running
|
|
||||||
`netwatch-server` (see `backend/`) receives the reports the page posts.
|
|
||||||
|
|
||||||
## Entrypoints
|
## Entrypoints
|
||||||
|
|
||||||
This repository adheres to the
|
This repository adheres to the
|
||||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
||||||
standard: normalized scripts in `script/` are the entrypoints for the
|
standard: normalized scripts in `script/` are the entrypoints for the
|
||||||
development workflow, and the Makefile targets are thin shims that call them.
|
development workflow, and the Makefile targets are thin shims that call them. We
|
||||||
The Go backend in `backend/` has its own `script/` directory and shim Makefile
|
provide:
|
||||||
(see [backend/README.md](backend/README.md)). The root scripts cover both
|
|
||||||
halves, so the root `make check` fails if either one is broken. We provide:
|
|
||||||
|
|
||||||
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
||||||
yarn via corepack, `yarn install --frozen-lockfile`, the pinned Go unless one
|
yarn via corepack, `yarn install --frozen-lockfile`)
|
||||||
at least as new as `backend/go.mod` asks for is installed, and the Go
|
|
||||||
modules), linking what it installs itself into `~/.local/bin`, which has to be
|
|
||||||
on `PATH`. It installs no Go linter and not Docker: `make lint` runs the
|
|
||||||
linter in Docker
|
|
||||||
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
||||||
git pre-commit hook
|
git pre-commit hook
|
||||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
- `script/projectname` — print the project name (used for the Docker image tag)
|
||||||
- `script/test` — run `script/frontend-test`, then the backend's Go tests, both
|
- `script/test` — run the production build as the test (no unit tests yet)
|
||||||
within one 30-second timeout
|
- `script/lint` — run prettier in check mode
|
||||||
- `script/lint` — run `script/frontend-lint`, then golangci-lint in Docker, by
|
- `script/fmt` — format all files (writes)
|
||||||
building the lint stage of `Dockerfile` without the cache
|
- `script/fmt-check` — check formatting (read-only)
|
||||||
- `script/fmt` — format all files (writes): prettier, then gofmt over `backend/`
|
|
||||||
- `script/fmt-check` — check formatting (read-only): prettier, then gofmt
|
|
||||||
- `script/check` — run test, lint, and fmt-check
|
- `script/check` — run test, lint, and fmt-check
|
||||||
- `script/frontend-test` — run the production build as the frontend's test (no
|
- `script/docker` — build the Docker image tagged via `script/projectname`
|
||||||
unit tests yet)
|
- `script/cibuild` — CI entrypoint: plain `docker build .`
|
||||||
- `script/frontend-lint` — run prettier in check mode
|
|
||||||
- `script/frontend-fmt` — format everything prettier understands (writes)
|
|
||||||
- `script/frontend-fmt-check` — check prettier formatting (read-only)
|
|
||||||
- `script/frontend-check` — the frontend half of `script/check`, for
|
|
||||||
`Dockerfile`, whose node build stage has neither Go nor Docker
|
|
||||||
- `script/frontend-viewport-test` — responsive-layout verification of the built
|
|
||||||
frontend in a containerised headless Chrome (see
|
|
||||||
[test/viewport/README.md](test/viewport/README.md)). Not part of
|
|
||||||
`script/check`: it needs Docker and takes minutes.
|
|
||||||
- `script/docker` — build the image from `Dockerfile` without the build cache,
|
|
||||||
tagged `netwatch` via `script/projectname`
|
|
||||||
- `script/cibuild` — CI entrypoint: builds the image
|
|
||||||
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
||||||
- `script/install-precommit` — install the git pre-commit hook
|
- `script/install-precommit` — install the git pre-commit hook
|
||||||
|
|
||||||
## Responsive layout
|
|
||||||
|
|
||||||
The narrow-viewport layout lives in the `max-width: 768px` media block in
|
|
||||||
`src/styles.css`. It is verified automatically by `make frontend-viewport-test`,
|
|
||||||
which drives a digest-pinned headless Chrome against the built `dist/` and
|
|
||||||
asserts on computed layout at widths derived from that CSS — one pixel either
|
|
||||||
side of every breakpoint it declares, plus a 320px floor, a desktop baseline and
|
|
||||||
two landscape sizes. See [test/viewport/README.md](test/viewport/README.md) for
|
|
||||||
what it covers and what it genuinely cannot.
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
When debugging network issues, it's useful to have a persistent at-a-glance view
|
When debugging network issues, it's useful to have a persistent at-a-glance view
|
||||||
@@ -104,18 +71,6 @@ code lives in `src/main.js` with a class-based architecture:
|
|||||||
- **`tick()`**: Main loop — measures all hosts in parallel via `Promise.all`,
|
- **`tick()`**: Main loop — measures all hosts in parallel via `Promise.all`,
|
||||||
pushes samples, redraws UI. When paused, pushes blank markers (no probes, no
|
pushes samples, redraws UI. When paused, pushes blank markers (no probes, no
|
||||||
false outage)
|
false outage)
|
||||||
- **`Reporter`**: Posts collected samples to the backend
|
|
||||||
|
|
||||||
### Reporting
|
|
||||||
|
|
||||||
Every `reportInterval` (default 60s) the page POSTs a JSON report to the
|
|
||||||
same-origin path `/api/v1/reports`: a random per-browser `clientId` kept in
|
|
||||||
`localStorage`, `geo` sent as null, and each host's unreported, non-paused
|
|
||||||
samples (timestamp, latency, error). A per-host high-water mark makes every
|
|
||||||
report a delta, so only new samples are sent; the mark advances only on a
|
|
||||||
delivered report, and while paused nothing is sent. Delivery failure is quiet —
|
|
||||||
one debug-log line per outage, retried at the next interval, never blocking
|
|
||||||
probing. The report-building step is a pure function of host state.
|
|
||||||
|
|
||||||
### Monitoring targets
|
### Monitoring targets
|
||||||
|
|
||||||
@@ -170,6 +125,9 @@ dist/
|
|||||||
false outage)
|
false outage)
|
||||||
- Clickable service URLs
|
- Clickable service URLs
|
||||||
- Canvas-based sparkline rendering with devicePixelRatio scaling
|
- Canvas-based sparkline rendering with devicePixelRatio scaling
|
||||||
|
- Mobile detection: viewports narrower than 768px show a friendly "not yet
|
||||||
|
available on mobile" message instead of the monitoring UI (no polling or
|
||||||
|
network requests on mobile)
|
||||||
- Zero runtime dependencies: all resources bundled into build artifacts
|
- Zero runtime dependencies: all resources bundled into build artifacts
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
@@ -178,21 +136,13 @@ After running `yarn build`, deploy the contents of the `dist/` directory to any
|
|||||||
static file host (S3, GCS, Cloudflare Pages, Vercel, Netlify, GitHub Pages) or
|
static file host (S3, GCS, Cloudflare Pages, Vercel, Netlify, GitHub Pages) or
|
||||||
use the Docker image behind a reverse proxy.
|
use the Docker image behind a reverse proxy.
|
||||||
|
|
||||||
The Docker image, built from `Dockerfile`, is the whole service in one
|
The Docker image:
|
||||||
container: nginx serves the built frontend and passes `/api/` and
|
|
||||||
`/.well-known/healthcheck` to the Go backend, `netwatch-server`, which listens
|
|
||||||
only inside the container, on `127.0.0.1:8081`. The image:
|
|
||||||
|
|
||||||
- Listens on port 8080 by default (override with `PORT` env var)
|
- Listens on port 8080 by default (override with `PORT` env var)
|
||||||
- Trusts `X-Forwarded-For` from RFC1918 reverse proxies (10/8, 172.16/12,
|
- Trusts `X-Forwarded-For` from RFC1918 reverse proxies (10/8, 172.16/12,
|
||||||
192.168/16)
|
192.168/16)
|
||||||
- Sends access logs to stdout
|
- Sends access logs to stdout
|
||||||
- Caches static assets with immutable headers
|
- Caches static assets with immutable headers
|
||||||
- Stores reports in `DATA_DIR`, `/data/reports` by default, on the `/data`
|
|
||||||
volume. The backend runs as user `netwatch` (uid 1000), so a directory
|
|
||||||
bind-mounted at `/data` must be writable by uid 1000
|
|
||||||
- Writes buffered reports to disk on `docker stop`, and exits non-zero if nginx
|
|
||||||
or the backend exits on its own, so the platform restarts it
|
|
||||||
|
|
||||||
## Browser Compatibility
|
## Browser Compatibility
|
||||||
|
|
||||||
@@ -201,6 +151,8 @@ properties.
|
|||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
|
- **Mobile**: Viewports below 768px wide show a static "not yet available"
|
||||||
|
message. The full monitoring UI requires a desktop-width browser.
|
||||||
- **CORS**: Some hosts may block cross-origin HEAD requests. The app uses
|
- **CORS**: Some hosts may block cross-origin HEAD requests. The app uses
|
||||||
`no-cors` mode which allows the request but provides opaque responses. Latency
|
`no-cors` mode which allows the request but provides opaque responses. Latency
|
||||||
is still measurable based on request timing.
|
is still measurable based on request timing.
|
||||||
|
|||||||
@@ -10,126 +10,23 @@
|
|||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags. `feat/reportbuf-storage` is merged; the backend, the CI
|
pre-1.0. No git tags. Backend work in flight on feat/reportbuf-storage (dirty:
|
||||||
workflow, and the backend repo standard files are all on `main`. Frontend and
|
src/main.js). Frontend is functional; backend is new and unmerged.
|
||||||
backend are both functional. Working toward the 1.0.0 milestone by closing the
|
|
||||||
remaining repo-compliance issues on the tracker.
|
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
Confirm the `.gitea/workflows/check.yml` run is green (main always green
|
Land feat/reportbuf-storage: finish the in-progress src/main.js change, get make
|
||||||
policy). The workflow file is already on `main`; what is unverified is that its
|
check green, and merge the branch to main. The branch adds the backend (buffered
|
||||||
latest run passes.
|
zstd-compressed report storage), the CI workflow, and backend repo standard
|
||||||
|
files, so merging it also closes most compliance gaps.
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-09-29: report file names can no longer collide (issue #61): each is
|
|
||||||
`reports-<timestamp>-<number>.jsonl.zst`, where the number counts the files
|
|
||||||
written since the server started, so two flushes in the same millisecond, such
|
|
||||||
as a flush for size and the final flush at shutdown, each get a file of their
|
|
||||||
own instead of the second one failing
|
|
||||||
- 2026-09-29: bounded the report endpoint (issue #20): `POST /api/v1/reports`
|
|
||||||
still needs no credentials, but each client address, as resolved through
|
|
||||||
`TRUSTED_PROXIES`, may send `REPORTS_PER_MINUTE` (default 60) reports a
|
|
||||||
minute, counted by `go-chi/httprate`, and past that gets 429 with
|
|
||||||
`Retry-After`; the report files in `DATA_DIR`, counted from start with those
|
|
||||||
already there, may total at most `DATA_DIR_MAX_BYTES` (default 1 GiB), past
|
|
||||||
which reports get 507; and the wildcard CORS is gone: no CORS headers unless
|
|
||||||
`CORS_ALLOWED_ORIGINS` lists origins, and an entry that is not a plain
|
|
||||||
`scheme://host[:port]` origin, `*` included, stops the server from starting.
|
|
||||||
Deleting report files frees room only at the next start; pruning is issue #54
|
|
||||||
- 2026-09-28: one container image (issue #52): the root `Dockerfile` builds the
|
|
||||||
only image, and `Dockerfile.backend` is gone. nginx serves the frontend on
|
|
||||||
port 8080 and proxies `/api/` and `/.well-known/healthcheck` to the backend,
|
|
||||||
which listens on `127.0.0.1:8081` in the same container; the new
|
|
||||||
`BIND_ADDRESS` setting sets its listen address. `bin/entrypoint.sh` starts
|
|
||||||
both, passes TERM and INT on to both, and exits non-zero when either exits on
|
|
||||||
its own. The backend runs as user `netwatch` and stores reports on the `/data`
|
|
||||||
volume. `script/docker` is the org model again
|
|
||||||
- 2026-09-28: unified the gate (issue #16): the root `make check` covers the Go
|
|
||||||
backend as well as the frontend, and the pre-commit hook with it; the backend
|
|
||||||
moved onto scripts-to-rule-them-all (`backend/script/*`, `backend/Makefile` as
|
|
||||||
shims, its duplicate hook installer removed); `script/cibuild` builds both
|
|
||||||
images and is the workflow's only build step. The root `make lint` runs
|
|
||||||
golangci-lint only in Docker, by building the lint stage of
|
|
||||||
`Dockerfile.backend` without the cache. `script/bootstrap` installs the pinned
|
|
||||||
Go unless the installed one is at least what `backend/go.mod` asks for, links
|
|
||||||
what it installs into `~/.local/bin` without replacing anything it did not
|
|
||||||
create, and installs no linter. Root `make test` runs both halves within one
|
|
||||||
30-second timeout. When `VERSION` is unset or empty, the backend binary's
|
|
||||||
version falls back to `git describe` inside a git checkout, then to `dev`
|
|
||||||
- 2026-09-28: frontend reporting client (issue #53): a `Reporter` class posts
|
|
||||||
collected samples to `/api/v1/reports` every `reportInterval` (default 60s) as
|
|
||||||
a per-host delta, with the report-building step a pure exported function of
|
|
||||||
host state; a per-host mark advances only on a delivered POST; at most one
|
|
||||||
report POST is pending at a time and it is abandoned after half the interval,
|
|
||||||
so a slow POST never overlaps the next report and a mark never moves
|
|
||||||
backwards; the samples of an abandoned POST are sent again at the next
|
|
||||||
interval, so a backend that stored them but answered late receives them twice;
|
|
||||||
the per-browser client id works in insecure (plain-HTTP) contexts;
|
|
||||||
`vite.config.js` proxies `/api` to the local backend for `yarn dev`
|
|
||||||
- 2026-09-28: report ingest correctness (issue #23): a storage failure now
|
|
||||||
returns 500 instead of a false `ok`; oversize bodies return 413 (distinguished
|
|
||||||
from malformed JSON, which stays 400); a `MaxBodyBytes` middleware caps every
|
|
||||||
route, not just the report route; the raw attacker-controlled `geo` blob is no
|
|
||||||
longer logged (only its length), and `client_id`, `timestamp` and decode error
|
|
||||||
text are length-bounded before logging; a `decodeJSON` handler helper was
|
|
||||||
added; panic recovery now routes the stack through slog instead of chi's
|
|
||||||
plain-text stderr; and writing a report file now returns its error, so a
|
|
||||||
failed final flush on shutdown makes the process exit non-zero instead of
|
|
||||||
losing the buffered reports silently
|
|
||||||
- 2026-09-21: shutdown lifecycle correctness. The process now shuts down through
|
|
||||||
fx instead of `os.Exit`, so every component's `OnStop` runs and buffered
|
|
||||||
reports are flushed to disk on `SIGTERM` — previously a full flush window of
|
|
||||||
telemetry was silently lost on every restart. The `http.Server` is now built
|
|
||||||
before its serving goroutine starts, so shutdown can no longer race or
|
|
||||||
nil-deref it; a listen failure exits non-zero via `fx.Shutdowner`; `reportbuf`
|
|
||||||
`OnStop` is idempotent; and `writeTimeout` now exceeds the chi per-request
|
|
||||||
budget so that budget is actually reachable. Dead `startupTime`, `exitCode`,
|
|
||||||
and `cancelFunc` fields were removed
|
|
||||||
- 2026-09-21: backend HTTP hardening (issue #19): added `ReadHeaderTimeout` and
|
|
||||||
`IdleTimeout` to the server, a `SecurityHeaders` middleware (HSTS, tight CSP,
|
|
||||||
frame/sniff/referrer/permissions headers) registered before CORS, and
|
|
||||||
trusted-proxy client IP resolution honouring `X-Forwarded-For` / `X-Real-IP`
|
|
||||||
only from a `TRUSTED_PROXIES` allowlist (loopback plus RFC1918 by default)
|
|
||||||
- 2026-08-10: adopted the org-standard `backend/.golangci.yml` verbatim and
|
|
||||||
moved the pinned golangci-lint from v2.7.2 to v2.12.2 (the `lint` stage of
|
|
||||||
`Dockerfile.backend` now pins the `golangci/golangci-lint:v2.12.2` image by
|
|
||||||
digest); the previous config declared `version: "2"` but used v1 schema keys,
|
|
||||||
so every threshold in it was inert and its green result was meaningless.
|
|
||||||
`backend/Makefile`'s `lint` target now asserts the config's sha256 against the
|
|
||||||
canonical file first, so drift from the org standard fails the build instead
|
|
||||||
of silently degrading to defaults
|
|
||||||
- 2026-08-10: every interactive control now meets the 44x44 CSS px minimum tap
|
|
||||||
target (`.pin-btn`, `#interval-select`, the debug-log label and, on narrow
|
|
||||||
viewports, `#pause-btn`). The pin button's hit area grows via matching
|
|
||||||
negative margins, so its layout footprint and row density are unchanged
|
|
||||||
- 2026-08-10: per-host status line wraps below the 768px breakpoint instead of
|
|
||||||
forcing horizontal page scroll at 320px
|
|
||||||
- 2026-08-09: `Dockerfile.backend` reworked to the mandated Go multistage
|
|
||||||
lint-stage pattern: separate `lint` stage on the hash-pinned
|
|
||||||
`golangci/golangci-lint` image, `COPY --from=lint` stage dependency,
|
|
||||||
`CGO_ENABLED=0` static build driven by `ARG VERSION`, and no more `COPY .git`
|
|
||||||
- 2026-08-09: dotfile compliance — lifted `backend/.editorconfig` to the repo
|
|
||||||
root so `root = true` covers the frontend too, and replaced `.gitignore` with
|
|
||||||
the org model (OS, editor, node, and environment/secrets sections) plus this
|
|
||||||
repo's `dist/` and `*.log`. `.env`, `.env.*`, `*.pem`, and `*.key` are now
|
|
||||||
ignored repo-wide, not just under `backend/`. Excluding `.git` from
|
|
||||||
`.dockerignore` stays deferred: both images read git metadata at build time
|
|
||||||
(`COPY .git` in `Dockerfile.backend`, `git rev-parse` in `vite.config.js`)
|
|
||||||
- 2026-08-09: automated responsive-layout harness
|
|
||||||
(`make frontend-viewport-test`): digest-pinned headless Chrome driven over CDP
|
|
||||||
against the built `dist/`, viewport widths derived from the breakpoints in
|
|
||||||
`src/styles.css` ([#13](https://git.eeqj.de/sneak/netwatch/issues/13)). Every
|
|
||||||
check carries a presence guard so none of them can pass against a page it is
|
|
||||||
not actually measuring. Found two real layout defects, filed as
|
|
||||||
[#42](https://git.eeqj.de/sneak/netwatch/issues/42) and
|
|
||||||
[#43](https://git.eeqj.de/sneak/netwatch/issues/43)
|
|
||||||
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints, Makefile
|
||||||
shims, README Entrypoints section
|
shims, README Entrypoints section
|
||||||
- 2026-02-27: backend with buffered zstd-compressed report storage; CI workflow
|
- 2026-02-27: backend with buffered zstd-compressed report storage; CI workflow
|
||||||
and backend repo standard files; backend Dockerfile fixed (Go 1.25,
|
and backend repo standard files; backend Dockerfile fixed (Go 1.25,
|
||||||
golangci-lint) and moved to repo root (feat/reportbuf-storage)
|
golangci-lint) and moved to repo root (feat/reportbuf-storage, unmerged)
|
||||||
- 2026-02-26: host row layout redesigned with CSS grid; overflow and spacing
|
- 2026-02-26: host row layout redesigned with CSS grid; overflow and spacing
|
||||||
fixes; nginx config extracted; port hardcoded to 8080
|
fixes; nginx config extracted; port hardcoded to 8080
|
||||||
- 2026-02-26: debug log panel, median stats, recovery probe, Docker build fix,
|
- 2026-02-26: debug log panel, median stats, recovery probe, Docker build fix,
|
||||||
@@ -142,18 +39,9 @@ latest run passes.
|
|||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
- Wire `script/frontend-viewport-test` into CI as its own step (deliberately not
|
|
||||||
part of `make check` today; the decision has real CI-runtime cost and is
|
|
||||||
tracked separately)
|
|
||||||
- Compliance top-up as one small commit: add .editorconfig and add the hooks
|
- Compliance top-up as one small commit: add .editorconfig and add the hooks
|
||||||
target to the Makefile
|
target to the Makefile
|
||||||
- After merge, confirm .gitea/workflows/check.yml is on main and CI is green
|
- After merge, confirm .gitea/workflows/check.yml is on main and CI is green
|
||||||
(main always green policy)
|
(main always green policy)
|
||||||
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
||||||
it
|
it
|
||||||
- Upstream fix needed in `sneak/prompts`: the org-standard `.golangci.yml`
|
|
||||||
enables `gomodguard`, which golangci-lint v2.12.2 reports as deprecated since
|
|
||||||
v2.12.0 and replaced by `gomodguard_v2`, so every backend lint run prints a
|
|
||||||
deprecation warning. The file is standardized and must never be edited in this
|
|
||||||
repo, so nothing can be done here beyond tracking it — tracked at
|
|
||||||
<https://git.eeqj.de/sneak/netwatch/issues/41>
|
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
version: "2"
|
version: "2"
|
||||||
|
|
||||||
# Config schema uses the golangci-lint v2 layout (settings live under
|
|
||||||
# linters.settings, not top-level linters-settings) so that the
|
|
||||||
# thresholds below are actually applied by golangci-lint >= v2.
|
|
||||||
|
|
||||||
run:
|
run:
|
||||||
timeout: 5m
|
timeout: 5m
|
||||||
modules-download-mode: readonly
|
modules-download-mode: readonly
|
||||||
@@ -18,7 +14,8 @@ linters:
|
|||||||
- wsl # Deprecated, replaced by wsl_v5
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
settings:
|
|
||||||
|
linters-settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
funlen:
|
funlen:
|
||||||
@@ -30,5 +27,6 @@ linters:
|
|||||||
threshold: 100
|
threshold: 100
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
|
exclude-use-default: false
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
max-same-issues: 0
|
max-same-issues: 0
|
||||||
|
|||||||
+38
-15
@@ -1,30 +1,53 @@
|
|||||||
# Thin shims; the implementations live in backend/script/ (see the
|
UNAME_S := $(shell uname -s)
|
||||||
# Entrypoints section of README.md). There is no check, hooks or docker
|
VERSION := $(shell git describe --always --dirty)
|
||||||
# target here: the root Makefile's check covers this directory, its
|
BUILDARCH := $(shell uname -m)
|
||||||
# hooks target installs the repo's only pre-commit hook, and its docker
|
BINARY := netwatch-server
|
||||||
# target builds the one image, which contains this backend.
|
|
||||||
|
|
||||||
.PHONY: all build test lint fmt fmt-check run clean
|
GOLDFLAGS += -X main.Version=$(VERSION)
|
||||||
|
GOLDFLAGS += -X main.Buildarch=$(BUILDARCH)
|
||||||
|
|
||||||
|
ifeq ($(UNAME_S),Darwin)
|
||||||
|
GOFLAGS := -ldflags "$(GOLDFLAGS)"
|
||||||
|
else
|
||||||
|
GOFLAGS = -ldflags "-linkmode external -extldflags -static $(GOLDFLAGS)"
|
||||||
|
endif
|
||||||
|
|
||||||
|
.PHONY: all build test lint fmt fmt-check check docker hooks run clean
|
||||||
|
|
||||||
all: build
|
all: build
|
||||||
|
|
||||||
build:
|
build: ./$(BINARY)
|
||||||
@script/build
|
|
||||||
|
./$(BINARY): $(shell find . -name '*.go' -type f) go.mod go.sum
|
||||||
|
go build -o $@ $(GOFLAGS) ./cmd/netwatch-server/
|
||||||
|
|
||||||
test:
|
test:
|
||||||
@script/test
|
timeout 30 go test ./...
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
@script/lint
|
golangci-lint run ./...
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
@script/fmt
|
go fmt ./...
|
||||||
|
|
||||||
fmt-check:
|
fmt-check:
|
||||||
@script/fmt-check
|
@test -z "$$(gofmt -l .)" || \
|
||||||
|
(echo "Files not formatted:"; gofmt -l .; exit 1)
|
||||||
|
|
||||||
run:
|
check: test lint fmt-check
|
||||||
@script/run
|
|
||||||
|
docker:
|
||||||
|
timeout 300 docker build -t netwatch-server -f ../Dockerfile.backend ..
|
||||||
|
|
||||||
|
hooks:
|
||||||
|
@printf '#!/bin/sh\ncd backend && make check\n' > \
|
||||||
|
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
||||||
|
@chmod +x \
|
||||||
|
$$(git rev-parse --show-toplevel)/.git/hooks/pre-commit
|
||||||
|
@echo "Pre-commit hook installed"
|
||||||
|
|
||||||
|
run: build
|
||||||
|
./$(BINARY)
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
@script/clean
|
rm -f ./$(BINARY)
|
||||||
|
|||||||
+8
-98
@@ -4,51 +4,18 @@ SPA and persists them as zstd-compressed JSONL files on disk.
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
From this directory:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build and run locally
|
# Build and run locally
|
||||||
make run
|
make run
|
||||||
```
|
|
||||||
|
|
||||||
From the repo root, whose `Dockerfile` builds the one image that ships this
|
# Run tests, lint, and format check
|
||||||
backend behind nginx (see [Container image](#container-image)):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run tests, lint, and format check over the frontend and this backend
|
|
||||||
make check
|
make check
|
||||||
|
|
||||||
# Build the image: nginx, the frontend and this backend
|
# Docker
|
||||||
make docker
|
docker build -t netwatch-server .
|
||||||
docker run -p 8080:8080 netwatch
|
docker run -p 8080:8080 netwatch-server
|
||||||
```
|
```
|
||||||
|
|
||||||
## Entrypoints
|
|
||||||
|
|
||||||
This directory follows the same
|
|
||||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
|
||||||
pattern as the repo root: the targets in `backend/Makefile` are thin shims over
|
|
||||||
`backend/script/`. The root `Dockerfile` runs them, and the root scripts call
|
|
||||||
`test`, `fmt` and `fmt-check`:
|
|
||||||
|
|
||||||
- `script/build` — compile the static `netwatch-server` binary with its version
|
|
||||||
and architecture stamped in. The version is `VERSION` from the environment;
|
|
||||||
when that is unset or empty, it falls back to `git describe` inside a git
|
|
||||||
checkout, then to `dev`
|
|
||||||
- `script/test` — run the Go tests under a 30-second timeout
|
|
||||||
- `script/lint` — check `.golangci.yml` against its pinned sha256, then run
|
|
||||||
golangci-lint. It runs inside the golangci-lint image of the lint stage of
|
|
||||||
the root `Dockerfile`; from a checkout, run `make lint` at the repo root,
|
|
||||||
which builds that stage
|
|
||||||
- `script/fmt` — format the Go sources (writes)
|
|
||||||
- `script/fmt-check` — check Go formatting (read-only)
|
|
||||||
- `script/run` — build and run the server locally
|
|
||||||
- `script/clean` — remove build artifacts
|
|
||||||
|
|
||||||
There is no `check`, `hooks` or `docker` target here: the root `make check`
|
|
||||||
covers this directory, the root `make hooks` installs the repo's only pre-commit
|
|
||||||
hook, and the root `make docker` builds the image that contains this backend.
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
The NetWatch frontend collects latency measurements from the browser but has no
|
The NetWatch frontend collects latency measurements from the browser but has no
|
||||||
@@ -76,73 +43,16 @@ Internal packages in `internal/` follow standard Go project layout:
|
|||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
| Variable | Default | Description |
|
| Variable | Default | Description |
|
||||||
| ---------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
|
| ---------- | ------------------ | --------------------------------- |
|
||||||
| `BIND_ADDRESS` | empty | IP address to listen on; empty listens on every interface |
|
|
||||||
| `PORT` | `8080` | HTTP listen port |
|
| `PORT` | `8080` | HTTP listen port |
|
||||||
| `DATA_DIR` | `./data/reports` | Directory for compressed reports |
|
| `DATA_DIR` | `./data/reports` | Directory for compressed reports |
|
||||||
| `DATA_DIR_MAX_BYTES` | `1073741824` (1 GiB) | Largest total size of the report files in `DATA_DIR`; see [Report limits](#report-limits) |
|
|
||||||
| `DEBUG` | `false` | Enable debug logging |
|
| `DEBUG` | `false` | Enable debug logging |
|
||||||
| `TRUSTED_PROXIES` | loopback + RFC1918 | Comma-separated CIDRs whose `X-Forwarded-For` / `X-Real-IP` headers are trusted for client IP resolution |
|
|
||||||
| `REPORTS_PER_MINUTE` | `60` | Reports each client address may send a minute; see [Report limits](#report-limits) |
|
|
||||||
| `CORS_ALLOWED_ORIGINS` | empty | Comma-separated origins whose pages may call the API; see [CORS](#cors) |
|
|
||||||
|
|
||||||
`TRUSTED_PROXIES` defaults to `127.0.0.1/32,::1/128,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16`.
|
|
||||||
The loopback entries cover the reverse proxy that shares the container; the
|
|
||||||
RFC1918 ranges match `nginx.conf`. A request whose direct peer is outside this
|
|
||||||
set has its forwarded headers ignored, and the direct peer is logged instead.
|
|
||||||
|
|
||||||
### Container image
|
|
||||||
|
|
||||||
The root `Dockerfile` builds one image in which nginx listens on the public port
|
|
||||||
8080, serves the frontend, and proxies `/api/` and `/.well-known/healthcheck` to
|
|
||||||
this server. The image's entrypoint, `bin/entrypoint.sh`, starts the server as
|
|
||||||
user `netwatch` (uid 1000) with `BIND_ADDRESS=127.0.0.1` and `PORT=8081`, so
|
|
||||||
only nginx reaches it. `DATA_DIR` is `/data/reports`, on the `/data` volume,
|
|
||||||
which `netwatch` owns.
|
|
||||||
|
|
||||||
### Report storage
|
### Report storage
|
||||||
|
|
||||||
Reports are written as `reports-<timestamp>-<number>.jsonl.zst` files in
|
Reports are written as `reports-<timestamp>.jsonl.zst` files in `DATA_DIR`.
|
||||||
`DATA_DIR`. The timestamp is in UTC to the millisecond, so the names sort by
|
Each file contains one JSON object per line, compressed with zstd. Files are
|
||||||
time; the number counts the files the server has written since it started, so
|
created with `O_EXCL` to prevent overwrites.
|
||||||
two files written in the same millisecond still get different names. Each file
|
|
||||||
contains one JSON object per line, compressed with zstd. Files are created with
|
|
||||||
`O_EXCL` to prevent overwrites.
|
|
||||||
|
|
||||||
### Report limits
|
|
||||||
|
|
||||||
`POST /api/v1/reports` takes reports from anyone who can reach it, without
|
|
||||||
credentials, so it is bounded instead. Both refusals below answer with the same
|
|
||||||
`{"status":"error"}` body as any other error.
|
|
||||||
|
|
||||||
- **Rate limit.** Each client address, resolved through `TRUSTED_PROXIES`, may
|
|
||||||
send `REPORTS_PER_MINUTE` reports a minute; past that it gets 429 with
|
|
||||||
`Retry-After: 60`. The minute slides: reports from the minute before still
|
|
||||||
count, fading out over the current one, so an address is sure never to be
|
|
||||||
refused only while it sends at most half of `REPORTS_PER_MINUTE` in any 60
|
|
||||||
seconds. The page sends one report a minute from each open tab, so the default
|
|
||||||
of 60 refuses nothing from up to 30 tabs behind one address, such as a
|
|
||||||
household or an office sharing it, however their reports bunch up. Report
|
|
||||||
responses also carry `X-RateLimit-Limit`, `X-RateLimit-Remaining` and
|
|
||||||
`X-RateLimit-Reset` headers.
|
|
||||||
- **Size cap.** The report files in `DATA_DIR` may total at most
|
|
||||||
`DATA_DIR_MAX_BYTES`, counting the files already there at start. Reports
|
|
||||||
waiting in memory count at their uncompressed size until they are written, so
|
|
||||||
a report that would take the total past the cap is refused with 507, and
|
|
||||||
nothing of it is stored. Deleting report files frees room only at the next
|
|
||||||
start, when the files are counted again. The default of 1 GiB is small enough
|
|
||||||
for any host; set it to the space you can give `DATA_DIR`.
|
|
||||||
|
|
||||||
### CORS
|
|
||||||
|
|
||||||
The page calls the API from the origin it is served from, so by default the
|
|
||||||
server sends no CORS headers, and browsers let no other origin's pages call it.
|
|
||||||
To serve the page from elsewhere, list that origin in `CORS_ALLOWED_ORIGINS`
|
|
||||||
(for example `https://netwatch.example.com`); pages from a listed origin may
|
|
||||||
`GET` and `POST` with a `Content-Type` header. Each entry must be a plain
|
|
||||||
origin, `scheme://host` with an optional `:port`, as browsers send it: no path,
|
|
||||||
not even a trailing `/`, and no `*`. Any other entry stops the server from
|
|
||||||
starting, with an error naming `CORS_ALLOWED_ORIGINS`.
|
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
|
|||||||
+1
-4
@@ -5,7 +5,6 @@ go 1.25.5
|
|||||||
require (
|
require (
|
||||||
github.com/go-chi/chi/v5 v5.2.5
|
github.com/go-chi/chi/v5 v5.2.5
|
||||||
github.com/go-chi/cors v1.2.2
|
github.com/go-chi/cors v1.2.2
|
||||||
github.com/go-chi/httprate v0.16.0
|
|
||||||
github.com/joho/godotenv v1.5.1
|
github.com/joho/godotenv v1.5.1
|
||||||
github.com/klauspost/compress v1.18.4
|
github.com/klauspost/compress v1.18.4
|
||||||
github.com/spf13/viper v1.21.0
|
github.com/spf13/viper v1.21.0
|
||||||
@@ -15,7 +14,6 @@ require (
|
|||||||
require (
|
require (
|
||||||
github.com/fsnotify/fsnotify v1.9.0 // indirect
|
github.com/fsnotify/fsnotify v1.9.0 // indirect
|
||||||
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
|
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
|
||||||
github.com/klauspost/cpuid/v2 v2.2.10 // indirect
|
|
||||||
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
||||||
github.com/sagikazarmark/locafero v0.11.0 // indirect
|
github.com/sagikazarmark/locafero v0.11.0 // indirect
|
||||||
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
|
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
|
||||||
@@ -23,11 +21,10 @@ require (
|
|||||||
github.com/spf13/cast v1.10.0 // indirect
|
github.com/spf13/cast v1.10.0 // indirect
|
||||||
github.com/spf13/pflag v1.0.10 // indirect
|
github.com/spf13/pflag v1.0.10 // indirect
|
||||||
github.com/subosito/gotenv v1.6.0 // indirect
|
github.com/subosito/gotenv v1.6.0 // indirect
|
||||||
github.com/zeebo/xxh3 v1.0.2 // indirect
|
|
||||||
go.uber.org/dig v1.19.0 // indirect
|
go.uber.org/dig v1.19.0 // indirect
|
||||||
go.uber.org/multierr v1.10.0 // indirect
|
go.uber.org/multierr v1.10.0 // indirect
|
||||||
go.uber.org/zap v1.26.0 // indirect
|
go.uber.org/zap v1.26.0 // indirect
|
||||||
go.yaml.in/yaml/v3 v3.0.4 // indirect
|
go.yaml.in/yaml/v3 v3.0.4 // indirect
|
||||||
golang.org/x/sys v0.30.0 // indirect
|
golang.org/x/sys v0.29.0 // indirect
|
||||||
golang.org/x/text v0.28.0 // indirect
|
golang.org/x/text v0.28.0 // indirect
|
||||||
)
|
)
|
||||||
|
|||||||
+2
-10
@@ -8,8 +8,6 @@ github.com/go-chi/chi/v5 v5.2.5 h1:Eg4myHZBjyvJmAFjFvWgrqDTXFyOzjj7YIm3L3mu6Ug=
|
|||||||
github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0=
|
github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0=
|
||||||
github.com/go-chi/cors v1.2.2 h1:Jmey33TE+b+rB7fT8MUy1u0I4L+NARQlK6LhzKPSyQE=
|
github.com/go-chi/cors v1.2.2 h1:Jmey33TE+b+rB7fT8MUy1u0I4L+NARQlK6LhzKPSyQE=
|
||||||
github.com/go-chi/cors v1.2.2/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58=
|
github.com/go-chi/cors v1.2.2/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58=
|
||||||
github.com/go-chi/httprate v0.16.0 h1:8V5DH9j6pSK6UQoBsTpvMyFxycqaKEIToyPKzHJjUa8=
|
|
||||||
github.com/go-chi/httprate v0.16.0/go.mod h1:A8lo+qRhk+s9LiuP5saS7XCGDXRXMcrueq0NfIuCa/I=
|
|
||||||
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
|
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
|
||||||
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
||||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||||
@@ -18,8 +16,6 @@ github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
|
|||||||
github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
|
github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
|
||||||
github.com/klauspost/compress v1.18.4 h1:RPhnKRAQ4Fh8zU2FY/6ZFDwTVTxgJ/EMydqSTzE9a2c=
|
github.com/klauspost/compress v1.18.4 h1:RPhnKRAQ4Fh8zU2FY/6ZFDwTVTxgJ/EMydqSTzE9a2c=
|
||||||
github.com/klauspost/compress v1.18.4/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4=
|
github.com/klauspost/compress v1.18.4/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4=
|
||||||
github.com/klauspost/cpuid/v2 v2.2.10 h1:tBs3QSyvjDyFTq3uoc/9xFpCuOsJQFNPiAhYdw2skhE=
|
|
||||||
github.com/klauspost/cpuid/v2 v2.2.10/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0=
|
|
||||||
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
||||||
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
|
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
|
||||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||||
@@ -46,10 +42,6 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
|
|||||||
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||||
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
|
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
|
||||||
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
|
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
|
||||||
github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ=
|
|
||||||
github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0=
|
|
||||||
github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0=
|
|
||||||
github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA=
|
|
||||||
go.uber.org/dig v1.19.0 h1:BACLhebsYdpQ7IROQ1AGPjrXcP5dF80U3gKoFzbaq/4=
|
go.uber.org/dig v1.19.0 h1:BACLhebsYdpQ7IROQ1AGPjrXcP5dF80U3gKoFzbaq/4=
|
||||||
go.uber.org/dig v1.19.0/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE=
|
go.uber.org/dig v1.19.0/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE=
|
||||||
go.uber.org/fx v1.24.0 h1:wE8mruvpg2kiiL1Vqd0CC+tr0/24XIB10Iwp2lLWzkg=
|
go.uber.org/fx v1.24.0 h1:wE8mruvpg2kiiL1Vqd0CC+tr0/24XIB10Iwp2lLWzkg=
|
||||||
@@ -62,8 +54,8 @@ go.uber.org/zap v1.26.0 h1:sI7k6L95XOKS281NhVKOFCUNIvv9e0w4BF8N3u+tCRo=
|
|||||||
go.uber.org/zap v1.26.0/go.mod h1:dtElttAiwGvoJ/vj4IwHBS/gXsEu/pZ50mUIRWuG0so=
|
go.uber.org/zap v1.26.0/go.mod h1:dtElttAiwGvoJ/vj4IwHBS/gXsEu/pZ50mUIRWuG0so=
|
||||||
go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
|
go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
|
||||||
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
||||||
golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
|
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
|
||||||
golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
|
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
|
||||||
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
|
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
|||||||
@@ -4,10 +4,7 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/globals"
|
"sneak.berlin/go/netwatch/internal/globals"
|
||||||
"sneak.berlin/go/netwatch/internal/logger"
|
"sneak.berlin/go/netwatch/internal/logger"
|
||||||
@@ -17,28 +14,6 @@ import (
|
|||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
)
|
)
|
||||||
|
|
||||||
// defaultTrustedProxies lists the networks whose forwarded
|
|
||||||
// headers are honoured by default. It covers the RFC1918
|
|
||||||
// ranges (to match nginx.conf) plus IPv4 and IPv6 loopback,
|
|
||||||
// because the reverse proxy shares the container and reaches
|
|
||||||
// the backend over loopback.
|
|
||||||
const defaultTrustedProxies = "127.0.0.1/32,::1/128," +
|
|
||||||
"10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
|
|
||||||
|
|
||||||
// Default limits on stored reports; backend/README.md gives the
|
|
||||||
// reasons for these values.
|
|
||||||
const (
|
|
||||||
defaultReportsPerMinute = 60
|
|
||||||
defaultDataDirMaxBytes = 1 << 30 // 1 GiB
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
errNotPositive = errors.New("must be a positive whole number")
|
|
||||||
errNotOrigin = errors.New(
|
|
||||||
"must be an origin, scheme://host with an optional port",
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
// Params defines the dependencies for Config.
|
// Params defines the dependencies for Config.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -49,17 +24,12 @@ type Params struct {
|
|||||||
|
|
||||||
// Config holds the resolved application configuration.
|
// Config holds the resolved application configuration.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
BindAddress string
|
|
||||||
CORSAllowedOrigins []string
|
|
||||||
DataDir string
|
DataDir string
|
||||||
DataDirMaxBytes int64
|
|
||||||
Debug bool
|
Debug bool
|
||||||
MetricsPassword string
|
MetricsPassword string
|
||||||
MetricsUsername string
|
MetricsUsername string
|
||||||
Port int
|
Port int
|
||||||
ReportsPerMinute int
|
|
||||||
SentryDSN string
|
SentryDSN string
|
||||||
TrustedProxies []string
|
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
params *Params
|
params *Params
|
||||||
}
|
}
|
||||||
@@ -80,19 +50,12 @@ func New(
|
|||||||
|
|
||||||
viper.AutomaticEnv()
|
viper.AutomaticEnv()
|
||||||
|
|
||||||
// An empty CORS_ALLOWED_ORIGINS allows no other origin.
|
|
||||||
viper.SetDefault("CORS_ALLOWED_ORIGINS", "")
|
|
||||||
viper.SetDefault("DATA_DIR", "./data/reports")
|
viper.SetDefault("DATA_DIR", "./data/reports")
|
||||||
viper.SetDefault("DATA_DIR_MAX_BYTES", defaultDataDirMaxBytes)
|
|
||||||
viper.SetDefault("DEBUG", "false")
|
viper.SetDefault("DEBUG", "false")
|
||||||
// An empty BIND_ADDRESS listens on every interface.
|
|
||||||
viper.SetDefault("BIND_ADDRESS", "")
|
|
||||||
viper.SetDefault("PORT", "8080")
|
viper.SetDefault("PORT", "8080")
|
||||||
viper.SetDefault("REPORTS_PER_MINUTE", defaultReportsPerMinute)
|
|
||||||
viper.SetDefault("SENTRY_DSN", "")
|
viper.SetDefault("SENTRY_DSN", "")
|
||||||
viper.SetDefault("METRICS_USERNAME", "")
|
viper.SetDefault("METRICS_USERNAME", "")
|
||||||
viper.SetDefault("METRICS_PASSWORD", "")
|
viper.SetDefault("METRICS_PASSWORD", "")
|
||||||
viper.SetDefault("TRUSTED_PROXIES", defaultTrustedProxies)
|
|
||||||
|
|
||||||
err := viper.ReadInConfig()
|
err := viper.ReadInConfig()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -104,38 +67,16 @@ func New(
|
|||||||
}
|
}
|
||||||
|
|
||||||
s := &Config{
|
s := &Config{
|
||||||
BindAddress: viper.GetString("BIND_ADDRESS"),
|
|
||||||
CORSAllowedOrigins: splitList(viper.GetString("CORS_ALLOWED_ORIGINS")),
|
|
||||||
DataDir: viper.GetString("DATA_DIR"),
|
DataDir: viper.GetString("DATA_DIR"),
|
||||||
DataDirMaxBytes: viper.GetInt64("DATA_DIR_MAX_BYTES"),
|
|
||||||
Debug: viper.GetBool("DEBUG"),
|
Debug: viper.GetBool("DEBUG"),
|
||||||
MetricsPassword: viper.GetString("METRICS_PASSWORD"),
|
MetricsPassword: viper.GetString("METRICS_PASSWORD"),
|
||||||
MetricsUsername: viper.GetString("METRICS_USERNAME"),
|
MetricsUsername: viper.GetString("METRICS_USERNAME"),
|
||||||
Port: viper.GetInt("PORT"),
|
Port: viper.GetInt("PORT"),
|
||||||
ReportsPerMinute: viper.GetInt("REPORTS_PER_MINUTE"),
|
|
||||||
SentryDSN: viper.GetString("SENTRY_DSN"),
|
SentryDSN: viper.GetString("SENTRY_DSN"),
|
||||||
TrustedProxies: splitList(viper.GetString("TRUSTED_PROXIES")),
|
|
||||||
log: log,
|
log: log,
|
||||||
params: ¶ms,
|
params: ¶ms,
|
||||||
}
|
}
|
||||||
|
|
||||||
// viper reads a value that is not a number as 0, so this also
|
|
||||||
// catches a mistyped setting.
|
|
||||||
if s.ReportsPerMinute <= 0 {
|
|
||||||
return nil, fmt.Errorf("REPORTS_PER_MINUTE %q: %w",
|
|
||||||
viper.GetString("REPORTS_PER_MINUTE"), errNotPositive)
|
|
||||||
}
|
|
||||||
|
|
||||||
if s.DataDirMaxBytes <= 0 {
|
|
||||||
return nil, fmt.Errorf("DATA_DIR_MAX_BYTES %q: %w",
|
|
||||||
viper.GetString("DATA_DIR_MAX_BYTES"), errNotPositive)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = checkOrigins(s.CORSAllowedOrigins)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if s.Debug {
|
if s.Debug {
|
||||||
params.Logger.EnableDebugLogging()
|
params.Logger.EnableDebugLogging()
|
||||||
s.log = params.Logger.Get()
|
s.log = params.Logger.Get()
|
||||||
@@ -143,38 +84,3 @@ func New(
|
|||||||
|
|
||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkOrigins fails on the first CORS_ALLOWED_ORIGINS entry that is
|
|
||||||
// not a plain origin, scheme://host with an optional port, as browsers
|
|
||||||
// send it; anything more, such as a trailing "/", would match no page.
|
|
||||||
// go-chi/cors reads a "*" anywhere in an entry as a wildcard, so no
|
|
||||||
// entry may contain one.
|
|
||||||
func checkOrigins(origins []string) error {
|
|
||||||
for _, origin := range origins {
|
|
||||||
u, err := url.Parse(origin)
|
|
||||||
if err != nil || u.Scheme == "" || u.Host == "" ||
|
|
||||||
strings.Contains(origin, "*") ||
|
|
||||||
origin != u.Scheme+"://"+u.Host {
|
|
||||||
return fmt.Errorf("CORS_ALLOWED_ORIGINS %q: %w",
|
|
||||||
origin, errNotOrigin)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// splitList turns a comma-separated setting into a trimmed
|
|
||||||
// slice, dropping empty entries.
|
|
||||||
func splitList(raw string) []string {
|
|
||||||
parts := strings.Split(raw, ",")
|
|
||||||
|
|
||||||
out := make([]string, 0, len(parts))
|
|
||||||
for _, p := range parts {
|
|
||||||
p = strings.TrimSpace(p)
|
|
||||||
if p != "" {
|
|
||||||
out = append(out, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,64 +0,0 @@
|
|||||||
package config_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
|
||||||
"sneak.berlin/go/netwatch/internal/globals"
|
|
||||||
"sneak.berlin/go/netwatch/internal/logger"
|
|
||||||
|
|
||||||
"go.uber.org/fx"
|
|
||||||
)
|
|
||||||
|
|
||||||
// requireConfigError builds the config as main does and fails the
|
|
||||||
// test unless that fails with an error naming setting. It uses
|
|
||||||
// fx.New, because fxtest.New fails the test itself on an error.
|
|
||||||
func requireConfigError(t *testing.T, setting string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
app := fx.New(
|
|
||||||
fx.NopLogger,
|
|
||||||
fx.Provide(globals.New, logger.New, config.New),
|
|
||||||
fx.Invoke(func(*config.Config) {}),
|
|
||||||
)
|
|
||||||
|
|
||||||
err := app.Err()
|
|
||||||
if err == nil || !strings.Contains(err.Error(), setting) {
|
|
||||||
t.Fatalf("config error = %v, want one naming %s", err, setting)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReportsPerMinuteMustBePositive: unchecked, zero would panic
|
|
||||||
// when the routes are built, and a negative rate would lift the
|
|
||||||
// limit.
|
|
||||||
func TestReportsPerMinuteMustBePositive(t *testing.T) {
|
|
||||||
t.Setenv("REPORTS_PER_MINUTE", "0")
|
|
||||||
|
|
||||||
requireConfigError(t, "REPORTS_PER_MINUTE")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDataDirMaxBytesMustBeANumber: viper reads a value that is not
|
|
||||||
// a number, such as "1GB", as 0, which would refuse every report.
|
|
||||||
func TestDataDirMaxBytesMustBeANumber(t *testing.T) {
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES", "1GB")
|
|
||||||
|
|
||||||
requireConfigError(t, "DATA_DIR_MAX_BYTES")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCORSAllowedOriginsMustBeOrigins: "*" would let every origin in,
|
|
||||||
// and an entry that is not a plain origin would match no page.
|
|
||||||
func TestCORSAllowedOriginsMustBeOrigins(t *testing.T) {
|
|
||||||
for _, entry := range []string{
|
|
||||||
"*",
|
|
||||||
"https://*.netwatch.example",
|
|
||||||
"netwatch.example",
|
|
||||||
"https://netwatch.example/",
|
|
||||||
} {
|
|
||||||
t.Run(entry, func(t *testing.T) {
|
|
||||||
t.Setenv("CORS_ALLOWED_ORIGINS", entry)
|
|
||||||
|
|
||||||
requireConfigError(t, "CORS_ALLOWED_ORIGINS")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
package handlers
|
|
||||||
|
|
||||||
import "log/slog"
|
|
||||||
|
|
||||||
// MaxLoggedFieldBytes exposes the log bound to the external tests.
|
|
||||||
const MaxLoggedFieldBytes = maxLoggedFieldBytes
|
|
||||||
|
|
||||||
// NewForTest builds a Handlers around a report sink and logger,
|
|
||||||
// bypassing the fx graph so handler behaviour (including the
|
|
||||||
// storage failure path) is exercisable in unit tests.
|
|
||||||
func NewForTest(buf reportAppender, log *slog.Logger) *Handlers {
|
|
||||||
return &Handlers{buf: buf, log: log}
|
|
||||||
}
|
|
||||||
@@ -18,13 +18,6 @@ import (
|
|||||||
|
|
||||||
const jsonContentType = "application/json; charset=utf-8"
|
const jsonContentType = "application/json; charset=utf-8"
|
||||||
|
|
||||||
// reportAppender is the subset of the report buffer the handlers
|
|
||||||
// depend on. Defining it here keeps the storage failure path
|
|
||||||
// exercisable with a stub in tests.
|
|
||||||
type reportAppender interface {
|
|
||||||
Append(v any) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Params defines the dependencies for Handlers.
|
// Params defines the dependencies for Handlers.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -37,7 +30,7 @@ type Params struct {
|
|||||||
|
|
||||||
// Handlers provides HTTP handler factories for all endpoints.
|
// Handlers provides HTTP handler factories for all endpoints.
|
||||||
type Handlers struct {
|
type Handlers struct {
|
||||||
buf reportAppender
|
buf *reportbuf.Buffer
|
||||||
hc *healthcheck.Healthcheck
|
hc *healthcheck.Healthcheck
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
params *Params
|
params *Params
|
||||||
@@ -79,15 +72,3 @@ func (s *Handlers) respondJSON(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// decodeJSON decodes the request body into v. The body is
|
|
||||||
// expected to already be bounded by the body-size middleware, so
|
|
||||||
// a caller can distinguish an over-limit body from malformed
|
|
||||||
// JSON by testing the returned error for *http.MaxBytesError.
|
|
||||||
func (s *Handlers) decodeJSON(
|
|
||||||
_ http.ResponseWriter,
|
|
||||||
r *http.Request,
|
|
||||||
v any,
|
|
||||||
) error {
|
|
||||||
return json.NewDecoder(r.Body).Decode(v)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -2,16 +2,10 @@ package handlers
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/reportbuf"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// maxLoggedFieldBytes bounds untrusted text (string fields,
|
const maxReportBodyBytes = 1 << 20 // 1 MiB
|
||||||
// decode error text) before it is logged, so a caller cannot
|
|
||||||
// inflate log volume with an oversized value.
|
|
||||||
const maxLoggedFieldBytes = 128
|
|
||||||
|
|
||||||
type reportSample struct {
|
type reportSample struct {
|
||||||
T int64 `json:"t"`
|
T int64 `json:"t"`
|
||||||
@@ -41,94 +35,48 @@ func (s *Handlers) HandleReport() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
r.Body = http.MaxBytesReader(
|
||||||
|
w, r.Body, maxReportBodyBytes,
|
||||||
|
)
|
||||||
|
|
||||||
var rpt report
|
var rpt report
|
||||||
|
|
||||||
err := s.decodeJSON(w, r, &rpt)
|
err := json.NewDecoder(r.Body).Decode(&rpt)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.respondJSON(w, r,
|
|
||||||
&response{Status: "error"},
|
|
||||||
s.decodeErrorStatus(err),
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s.logReportReceived(rpt)
|
|
||||||
|
|
||||||
err = s.buf.Append(rpt)
|
|
||||||
if err != nil {
|
|
||||||
s.respondJSON(w, r,
|
|
||||||
&response{Status: "error"},
|
|
||||||
s.appendErrorStatus(err),
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s.respondJSON(w, r, &response{Status: "ok"}, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// decodeErrorStatus logs a report decode failure and returns the
|
|
||||||
// status to send: 413 when the body exceeded the size limit,
|
|
||||||
// otherwise 400 for malformed JSON.
|
|
||||||
func (s *Handlers) decodeErrorStatus(err error) int {
|
|
||||||
var tooLarge *http.MaxBytesError
|
|
||||||
if errors.As(err, &tooLarge) {
|
|
||||||
s.log.Warn("report body too large", "limit_bytes", tooLarge.Limit)
|
|
||||||
|
|
||||||
return http.StatusRequestEntityTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
// The decoder's error text can quote request bytes (a whole
|
|
||||||
// oversized number, for example), so it is bounded too.
|
|
||||||
s.log.Error("failed to decode report",
|
s.log.Error("failed to decode report",
|
||||||
"error", boundedForLog(err.Error()),
|
"error", err,
|
||||||
|
)
|
||||||
|
s.respondJSON(w, r,
|
||||||
|
&response{Status: "error"},
|
||||||
|
http.StatusBadRequest,
|
||||||
)
|
)
|
||||||
|
|
||||||
return http.StatusBadRequest
|
return
|
||||||
}
|
|
||||||
|
|
||||||
// appendErrorStatus logs a failure to store a report and returns
|
|
||||||
// the status to send: 507 when the report files are at their size
|
|
||||||
// cap, otherwise 500.
|
|
||||||
func (s *Handlers) appendErrorStatus(err error) int {
|
|
||||||
if errors.Is(err, reportbuf.ErrFull) {
|
|
||||||
s.log.Warn("report refused: report files at their size cap")
|
|
||||||
|
|
||||||
return http.StatusInsufficientStorage
|
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log.Error("failed to buffer report", "error", err)
|
|
||||||
|
|
||||||
return http.StatusInternalServerError
|
|
||||||
}
|
|
||||||
|
|
||||||
// logReportReceived logs an accepted report. Untrusted fields are
|
|
||||||
// bounded (client_id, timestamp) or reduced to a length
|
|
||||||
// (geo_bytes) so the raw attacker-controlled body never reaches
|
|
||||||
// the log.
|
|
||||||
func (s *Handlers) logReportReceived(rpt report) {
|
|
||||||
totalSamples := 0
|
totalSamples := 0
|
||||||
for _, h := range rpt.Hosts {
|
for _, h := range rpt.Hosts {
|
||||||
totalSamples += len(h.History)
|
totalSamples += len(h.History)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log.Info("report received",
|
s.log.Info("report received",
|
||||||
"client_id", boundedForLog(rpt.ClientID),
|
"client_id", rpt.ClientID,
|
||||||
"timestamp", boundedForLog(rpt.Timestamp),
|
"timestamp", rpt.Timestamp,
|
||||||
"host_count", len(rpt.Hosts),
|
"host_count", len(rpt.Hosts),
|
||||||
"total_samples", totalSamples,
|
"total_samples", totalSamples,
|
||||||
"geo_bytes", len(rpt.Geo),
|
"geo", string(rpt.Geo),
|
||||||
)
|
)
|
||||||
}
|
|
||||||
|
|
||||||
// boundedForLog truncates an untrusted string to a fixed byte
|
bufErr := s.buf.Append(rpt)
|
||||||
// bound so an attacker-controlled field cannot dominate the log.
|
if bufErr != nil {
|
||||||
func boundedForLog(s string) string {
|
s.log.Error("failed to buffer report",
|
||||||
if len(s) > maxLoggedFieldBytes {
|
"error", bufErr,
|
||||||
return s[:maxLoggedFieldBytes]
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
return s
|
s.respondJSON(w, r,
|
||||||
|
&response{Status: "ok"},
|
||||||
|
http.StatusOK,
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,239 +0,0 @@
|
|||||||
package handlers_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/handlers"
|
|
||||||
"sneak.berlin/go/netwatch/internal/middleware"
|
|
||||||
"sneak.berlin/go/netwatch/internal/reportbuf"
|
|
||||||
)
|
|
||||||
|
|
||||||
var errStorageFailed = errors.New("storage failed")
|
|
||||||
|
|
||||||
// stubAppender drives the storage success/failure path without a
|
|
||||||
// real buffer or disk.
|
|
||||||
type stubAppender struct {
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s stubAppender) Append(any) error { return s.err }
|
|
||||||
|
|
||||||
func newTestHandlers(buf stubAppender, out io.Writer) *handlers.Handlers {
|
|
||||||
return handlers.NewForTest(buf, slog.New(slog.NewJSONHandler(out, nil)))
|
|
||||||
}
|
|
||||||
|
|
||||||
func decodeStatus(t *testing.T, body []byte) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var resp struct {
|
|
||||||
Status string `json:"status"`
|
|
||||||
}
|
|
||||||
|
|
||||||
err := json.Unmarshal(body, &resp)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("response body not JSON: %v (%q)", err, body)
|
|
||||||
}
|
|
||||||
|
|
||||||
return resp.Status
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportStorageFailureIsNon2xx(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{err: errStorageFailed}, io.Discard)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"clientId":"c1","hosts":[]}`),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code < 500 {
|
|
||||||
t.Fatalf("storage failure status = %d, want a 5xx", rec.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := decodeStatus(t, rec.Body.Bytes()); got != "error" {
|
|
||||||
t.Fatalf("status field = %q, want %q", got, "error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleReportFullIs507 checks the answer when the report files
|
|
||||||
// are at their size cap: 507 and the usual error body, which tells
|
|
||||||
// the client nothing more.
|
|
||||||
func TestHandleReportFullIs507(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{err: reportbuf.ErrFull}, io.Discard)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"clientId":"c1","hosts":[]}`),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusInsufficientStorage {
|
|
||||||
t.Fatalf("status = %d, want %d",
|
|
||||||
rec.Code, http.StatusInsufficientStorage)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := rec.Body.String(); got != "{\"status\":\"error\"}\n" {
|
|
||||||
t.Errorf("body = %q, want %q", got, "{\"status\":\"error\"}\n")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportMalformedJSONIs400(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{}, io.Discard)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{not json`),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusBadRequest {
|
|
||||||
t.Fatalf("malformed status = %d, want %d",
|
|
||||||
rec.Code, http.StatusBadRequest)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportOversizeIs413(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const limit = 32
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{}, io.Discard)
|
|
||||||
handler := (&middleware.Middleware{}).MaxBodyBytes(limit)(
|
|
||||||
h.HandleReport(),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"clientId":"`+strings.Repeat("x", 200)+`"}`),
|
|
||||||
)
|
|
||||||
// No declared length, so only the middleware's read cap can
|
|
||||||
// stop this body.
|
|
||||||
req.ContentLength = -1
|
|
||||||
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
||||||
t.Fatalf("oversize status = %d, want %d",
|
|
||||||
rec.Code, http.StatusRequestEntityTooLarge)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportDoesNotLogRawGeo(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const sentinel = "SENSITIVE-GEO-BLOB"
|
|
||||||
|
|
||||||
var logbuf bytes.Buffer
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{}, &logbuf)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(
|
|
||||||
`{"clientId":"c1","geo":{"raw":"`+sentinel+`"},"hosts":[]}`,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusOK {
|
|
||||||
t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(logbuf.String(), sentinel) {
|
|
||||||
t.Fatal("raw geo bytes were written to the log")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(logbuf.String(), "geo_bytes") {
|
|
||||||
t.Fatal("expected a bounded geo_bytes field in the log")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportLogsClientIDCutToBound(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
long := strings.Repeat("c", 2*handlers.MaxLoggedFieldBytes)
|
|
||||||
|
|
||||||
var logbuf bytes.Buffer
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{}, &logbuf)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(
|
|
||||||
`{"clientId":"`+long+`","timestamp":"`+long+`","hosts":[]}`,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
var logged map[string]any
|
|
||||||
|
|
||||||
err := json.Unmarshal(logbuf.Bytes(), &logged)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("log line not JSON: %v (%q)", err, logbuf.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
want := long[:handlers.MaxLoggedFieldBytes]
|
|
||||||
|
|
||||||
if logged["client_id"] != want {
|
|
||||||
t.Fatalf("logged client_id not cut to %d bytes: %q",
|
|
||||||
handlers.MaxLoggedFieldBytes, logged["client_id"])
|
|
||||||
}
|
|
||||||
|
|
||||||
if logged["timestamp"] != want {
|
|
||||||
t.Fatalf("logged timestamp not cut to %d bytes: %q",
|
|
||||||
handlers.MaxLoggedFieldBytes, logged["timestamp"])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleReportDecodeErrorLogIsBounded(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// A number too large for its int64 field makes the decoder's
|
|
||||||
// error text quote the whole number.
|
|
||||||
huge := strings.Repeat("9", 2*handlers.MaxLoggedFieldBytes)
|
|
||||||
|
|
||||||
var logbuf bytes.Buffer
|
|
||||||
|
|
||||||
h := newTestHandlers(stubAppender{}, &logbuf)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"hosts":[{"history":[{"t":`+huge+`}]}]}`),
|
|
||||||
)
|
|
||||||
|
|
||||||
h.HandleReport().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusBadRequest {
|
|
||||||
t.Fatalf("status = %d, want %d", rec.Code, http.StatusBadRequest)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(logbuf.String(), huge) {
|
|
||||||
t.Fatal("the whole oversized number was written to the log")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/netip"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Test-only wrappers exposing unexported helpers to the
|
|
||||||
// external middleware_test package.
|
|
||||||
|
|
||||||
// NewWithLogger builds a Middleware around a logger for tests
|
|
||||||
// that exercise the logging paths without the fx graph.
|
|
||||||
func NewWithLogger(log *slog.Logger) *Middleware {
|
|
||||||
return &Middleware{log: log}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewWithTrustedProxies builds a Middleware that honours forwarded
|
|
||||||
// headers from the given networks, for tests of the client address
|
|
||||||
// paths without the fx graph.
|
|
||||||
func NewWithTrustedProxies(trusted []netip.Prefix) *Middleware {
|
|
||||||
return &Middleware{trustedProxies: trusted}
|
|
||||||
}
|
|
||||||
|
|
||||||
func ClientIP(
|
|
||||||
remoteAddr string,
|
|
||||||
header http.Header,
|
|
||||||
trusted []netip.Prefix,
|
|
||||||
) string {
|
|
||||||
return clientIP(remoteAddr, header, trusted)
|
|
||||||
}
|
|
||||||
|
|
||||||
func ParseTrustedProxies(cidrs []string) ([]netip.Prefix, error) {
|
|
||||||
return parseTrustedProxies(cidrs)
|
|
||||||
}
|
|
||||||
@@ -3,15 +3,9 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/netip"
|
|
||||||
"runtime/debug"
|
|
||||||
"strings"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
"sneak.berlin/go/netwatch/internal/config"
|
||||||
@@ -20,29 +14,11 @@ import (
|
|||||||
|
|
||||||
"github.com/go-chi/chi/v5/middleware"
|
"github.com/go-chi/chi/v5/middleware"
|
||||||
"github.com/go-chi/cors"
|
"github.com/go-chi/cors"
|
||||||
"github.com/go-chi/httprate"
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const corsMaxAgeSec = 300
|
const corsMaxAgeSec = 300
|
||||||
|
|
||||||
// jsonErrorBody is the body written for errors raised inside
|
|
||||||
// middleware, matching the {"status":"error"} shape the handlers
|
|
||||||
// return so clients see one error contract across the API.
|
|
||||||
const (
|
|
||||||
jsonContentType = "application/json; charset=utf-8"
|
|
||||||
jsonErrorBody = "{\"status\":\"error\"}\n"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Security header values. The backend is a JSON API with no
|
|
||||||
// HTML surface, so the CSP forbids every resource type and
|
|
||||||
// framing outright.
|
|
||||||
const (
|
|
||||||
hstsValue = "max-age=31536000; includeSubDomains"
|
|
||||||
cspValue = "default-src 'none'; frame-ancestors 'none'"
|
|
||||||
permissionsPolicyValue = "camera=(), microphone=(), geolocation=()"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Params defines the dependencies for Middleware.
|
// Params defines the dependencies for Middleware.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -56,7 +32,6 @@ type Params struct {
|
|||||||
type Middleware struct {
|
type Middleware struct {
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
params *Params
|
params *Params
|
||||||
trustedProxies []netip.Prefix
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a Middleware instance.
|
// New creates a Middleware instance.
|
||||||
@@ -64,38 +39,13 @@ func New(
|
|||||||
_ fx.Lifecycle,
|
_ fx.Lifecycle,
|
||||||
params Params,
|
params Params,
|
||||||
) (*Middleware, error) {
|
) (*Middleware, error) {
|
||||||
trusted, err := parseTrustedProxies(params.Config.TrustedProxies)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
s := new(Middleware)
|
s := new(Middleware)
|
||||||
s.params = ¶ms
|
s.params = ¶ms
|
||||||
s.log = params.Logger.Get()
|
s.log = params.Logger.Get()
|
||||||
s.trustedProxies = trusted
|
|
||||||
|
|
||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseTrustedProxies converts CIDR strings into prefixes,
|
|
||||||
// failing fast on any malformed entry.
|
|
||||||
func parseTrustedProxies(cidrs []string) ([]netip.Prefix, error) {
|
|
||||||
prefixes := make([]netip.Prefix, 0, len(cidrs))
|
|
||||||
|
|
||||||
for _, cidr := range cidrs {
|
|
||||||
prefix, err := netip.ParsePrefix(cidr)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf(
|
|
||||||
"trusted proxy %q: %w", cidr, err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
prefixes = append(prefixes, prefix.Masked())
|
|
||||||
}
|
|
||||||
|
|
||||||
return prefixes, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type loggingResponseWriter struct {
|
type loggingResponseWriter struct {
|
||||||
http.ResponseWriter
|
http.ResponseWriter
|
||||||
|
|
||||||
@@ -122,70 +72,6 @@ func ipFromHostPort(hostPort string) string {
|
|||||||
return host
|
return host
|
||||||
}
|
}
|
||||||
|
|
||||||
// clientIP resolves the caller's address. X-Forwarded-For and
|
|
||||||
// X-Real-IP are honoured only when the direct peer is a
|
|
||||||
// trusted proxy; otherwise the direct peer is returned so a
|
|
||||||
// spoofed header cannot forge the logged address.
|
|
||||||
func clientIP(
|
|
||||||
remoteAddr string,
|
|
||||||
header http.Header,
|
|
||||||
trusted []netip.Prefix,
|
|
||||||
) string {
|
|
||||||
peer := ipFromHostPort(remoteAddr)
|
|
||||||
|
|
||||||
if !addrInAny(peer, trusted) {
|
|
||||||
return peer
|
|
||||||
}
|
|
||||||
|
|
||||||
if xff := firstForwardedFor(header.Get("X-Forwarded-For")); xff != "" {
|
|
||||||
return xff
|
|
||||||
}
|
|
||||||
|
|
||||||
if xr := strings.TrimSpace(header.Get("X-Real-IP")); validIP(xr) {
|
|
||||||
return xr
|
|
||||||
}
|
|
||||||
|
|
||||||
return peer
|
|
||||||
}
|
|
||||||
|
|
||||||
// firstForwardedFor returns the left-most valid address in an
|
|
||||||
// X-Forwarded-For list (the original client), or "" if none.
|
|
||||||
func firstForwardedFor(value string) string {
|
|
||||||
for part := range strings.SplitSeq(value, ",") {
|
|
||||||
candidate := strings.TrimSpace(part)
|
|
||||||
if validIP(candidate) {
|
|
||||||
return candidate
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func validIP(s string) bool {
|
|
||||||
_, err := netip.ParseAddr(s)
|
|
||||||
|
|
||||||
return err == nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// addrInAny reports whether s parses as an address contained
|
|
||||||
// in any of the trusted prefixes.
|
|
||||||
func addrInAny(s string, trusted []netip.Prefix) bool {
|
|
||||||
addr, err := netip.ParseAddr(s)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
addr = addr.Unmap()
|
|
||||||
|
|
||||||
for _, prefix := range trusted {
|
|
||||||
if prefix.Contains(addr) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Logging returns middleware that logs each request with
|
// Logging returns middleware that logs each request with
|
||||||
// timing, status code, and client information.
|
// timing, status code, and client information.
|
||||||
func (s *Middleware) Logging() func(http.Handler) http.Handler {
|
func (s *Middleware) Logging() func(http.Handler) http.Handler {
|
||||||
@@ -210,11 +96,7 @@ func (s *Middleware) Logging() func(http.Handler) http.Handler {
|
|||||||
"referer", r.Referer(),
|
"referer", r.Referer(),
|
||||||
"proto", r.Proto,
|
"proto", r.Proto,
|
||||||
"remote_ip",
|
"remote_ip",
|
||||||
clientIP(
|
ipFromHostPort(r.RemoteAddr),
|
||||||
r.RemoteAddr,
|
|
||||||
r.Header,
|
|
||||||
s.trustedProxies,
|
|
||||||
),
|
|
||||||
"status", lrw.statusCode,
|
"status", lrw.statusCode,
|
||||||
"latency_ms",
|
"latency_ms",
|
||||||
latency.Milliseconds(),
|
latency.Milliseconds(),
|
||||||
@@ -227,137 +109,21 @@ func (s *Middleware) Logging() func(http.Handler) http.Handler {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SecurityHeaders returns middleware that sets response
|
// CORS returns middleware that adds permissive CORS headers.
|
||||||
// security headers. It runs before CORS so the headers are
|
func (s *Middleware) CORS() func(http.Handler) http.Handler {
|
||||||
// present on preflight responses the CORS handler writes.
|
|
||||||
func (s *Middleware) SecurityHeaders() func(http.Handler) http.Handler {
|
|
||||||
return func(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
h := w.Header()
|
|
||||||
h.Set("Strict-Transport-Security", hstsValue)
|
|
||||||
h.Set("Content-Security-Policy", cspValue)
|
|
||||||
h.Set("X-Frame-Options", "DENY")
|
|
||||||
h.Set("X-Content-Type-Options", "nosniff")
|
|
||||||
h.Set("Referrer-Policy", "no-referrer")
|
|
||||||
h.Set("Permissions-Policy", permissionsPolicyValue)
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
},
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeJSONError writes the shared JSON error body with the
|
|
||||||
// given status. Used where middleware must reject a request
|
|
||||||
// before it reaches a handler.
|
|
||||||
func writeJSONError(w http.ResponseWriter, status int) {
|
|
||||||
w.Header().Set("Content-Type", jsonContentType)
|
|
||||||
w.WriteHeader(status)
|
|
||||||
_, _ = io.WriteString(w, jsonErrorBody)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MaxBodyBytes returns middleware that caps the request body at
|
|
||||||
// limit bytes. A declared Content-Length over the limit is
|
|
||||||
// rejected immediately with 413. Bodies without a declared
|
|
||||||
// length (or that understate it) are capped as they are read, so
|
|
||||||
// a handler that reads the body sees a *http.MaxBytesError it can
|
|
||||||
// map to 413. Mounted again on a route group, it can only lower
|
|
||||||
// the limit: a cap applied earlier in the chain still holds.
|
|
||||||
func (s *Middleware) MaxBodyBytes(
|
|
||||||
limit int64,
|
|
||||||
) func(http.Handler) http.Handler {
|
|
||||||
return func(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.ContentLength > limit {
|
|
||||||
writeJSONError(
|
|
||||||
w,
|
|
||||||
http.StatusRequestEntityTooLarge,
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
r.Body = http.MaxBytesReader(w, r.Body, limit)
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
},
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Recoverer returns middleware that recovers from a panic in a
|
|
||||||
// downstream handler, logs the panic and stack trace through
|
|
||||||
// slog, and responds 500 with no body. http.ErrAbortHandler is
|
|
||||||
// re-panicked so the server can abort the response as intended.
|
|
||||||
func (s *Middleware) Recoverer() func(http.Handler) http.Handler {
|
|
||||||
return func(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
defer func() {
|
|
||||||
rec := recover()
|
|
||||||
if rec == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
err, ok := rec.(error)
|
|
||||||
if ok && errors.Is(err, http.ErrAbortHandler) {
|
|
||||||
panic(rec)
|
|
||||||
}
|
|
||||||
|
|
||||||
s.log.ErrorContext(r.Context(),
|
|
||||||
"panic recovered",
|
|
||||||
"panic", fmt.Sprintf("%v", rec),
|
|
||||||
"stack", string(debug.Stack()),
|
|
||||||
)
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusInternalServerError)
|
|
||||||
}()
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
},
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CORS returns middleware that lets pages served from the given
|
|
||||||
// origins call the API. With no origins it adds no CORS headers at
|
|
||||||
// all, so only same-origin pages can use the API. That case must not
|
|
||||||
// reach cors.Handler, which treats an empty origin list as "allow
|
|
||||||
// every origin".
|
|
||||||
func (s *Middleware) CORS(
|
|
||||||
origins []string,
|
|
||||||
) func(http.Handler) http.Handler {
|
|
||||||
if len(origins) == 0 {
|
|
||||||
return func(next http.Handler) http.Handler { return next }
|
|
||||||
}
|
|
||||||
|
|
||||||
return cors.Handler(cors.Options{
|
return cors.Handler(cors.Options{
|
||||||
AllowedOrigins: origins,
|
AllowedOrigins: []string{"*"},
|
||||||
AllowedMethods: []string{http.MethodGet, http.MethodPost},
|
AllowedMethods: []string{
|
||||||
AllowedHeaders: []string{"Content-Type"},
|
"GET", "POST", "PUT", "DELETE", "OPTIONS",
|
||||||
|
},
|
||||||
|
AllowedHeaders: []string{
|
||||||
|
"Accept",
|
||||||
|
"Authorization",
|
||||||
|
"Content-Type",
|
||||||
|
"X-CSRF-Token",
|
||||||
|
},
|
||||||
|
ExposedHeaders: []string{"Link"},
|
||||||
AllowCredentials: false,
|
AllowCredentials: false,
|
||||||
MaxAge: corsMaxAgeSec,
|
MaxAge: corsMaxAgeSec,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// RateLimit returns middleware that allows each client address
|
|
||||||
// perMinute requests a minute and answers the rest with 429, the
|
|
||||||
// Retry-After header httprate sets, and the usual error body. The
|
|
||||||
// address is the one clientIP resolves, so clients behind the reverse
|
|
||||||
// proxy are limited one by one, not together as the proxy.
|
|
||||||
func (s *Middleware) RateLimit(
|
|
||||||
perMinute int,
|
|
||||||
) func(http.Handler) http.Handler {
|
|
||||||
return httprate.LimitBy(perMinute, time.Minute,
|
|
||||||
func(r *http.Request) (string, error) {
|
|
||||||
return clientIP(r.RemoteAddr, r.Header, s.trustedProxies), nil
|
|
||||||
},
|
|
||||||
httprate.WithLimitHandler(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
writeJSONError(w, http.StatusTooManyRequests)
|
|
||||||
},
|
|
||||||
),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,505 +0,0 @@
|
|||||||
package middleware_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/netip"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"testing/synctest"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/middleware"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// loopbackPeer is a remote address inside the trusted-proxy allowlist.
|
|
||||||
loopbackPeer = "127.0.0.1:5000"
|
|
||||||
// forwardedIP is the client address presented via X-Forwarded-For.
|
|
||||||
forwardedIP = "203.0.113.7"
|
|
||||||
// realIP is the client address presented via X-Real-IP.
|
|
||||||
realIP = "203.0.113.9"
|
|
||||||
)
|
|
||||||
|
|
||||||
func mustPrefixes(t *testing.T, cidrs ...string) []netip.Prefix {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
prefixes, err := middleware.ParseTrustedProxies(cidrs)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ParseTrustedProxies(%v): %v", cidrs, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return prefixes
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseTrustedProxiesRejectsMalformed(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := middleware.ParseTrustedProxies([]string{"not-a-cidr"})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for malformed CIDR, got nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type clientIPCase struct {
|
|
||||||
name string
|
|
||||||
remoteAddr string
|
|
||||||
xff string
|
|
||||||
xRealIP string
|
|
||||||
want string
|
|
||||||
}
|
|
||||||
|
|
||||||
func clientIPCases() []clientIPCase {
|
|
||||||
return []clientIPCase{
|
|
||||||
{
|
|
||||||
name: "trusted proxy uses forwarded-for",
|
|
||||||
remoteAddr: loopbackPeer,
|
|
||||||
xff: forwardedIP,
|
|
||||||
want: forwardedIP,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trusted proxy uses left-most of chain",
|
|
||||||
remoteAddr: "10.1.2.3:5000",
|
|
||||||
xff: forwardedIP + ", 10.1.2.3",
|
|
||||||
want: forwardedIP,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trusted proxy falls back to x-real-ip",
|
|
||||||
remoteAddr: loopbackPeer,
|
|
||||||
xRealIP: realIP,
|
|
||||||
want: realIP,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "untrusted peer ignores forwarded-for",
|
|
||||||
remoteAddr: "198.51.100.4:5000",
|
|
||||||
xff: forwardedIP,
|
|
||||||
want: "198.51.100.4",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "untrusted peer ignores x-real-ip",
|
|
||||||
remoteAddr: "198.51.100.4:5000",
|
|
||||||
xRealIP: realIP,
|
|
||||||
want: "198.51.100.4",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trusted proxy with no headers uses peer",
|
|
||||||
remoteAddr: "10.1.2.3:5000",
|
|
||||||
want: "10.1.2.3",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trusted proxy with garbage header uses peer",
|
|
||||||
remoteAddr: loopbackPeer,
|
|
||||||
xff: "not-an-ip",
|
|
||||||
want: "127.0.0.1",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestClientIP(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
trusted := mustPrefixes(t, "127.0.0.1/32", "::1/128", "10.0.0.0/8")
|
|
||||||
|
|
||||||
for _, tc := range clientIPCases() {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
header := http.Header{}
|
|
||||||
if tc.xff != "" {
|
|
||||||
header.Set("X-Forwarded-For", tc.xff)
|
|
||||||
}
|
|
||||||
|
|
||||||
if tc.xRealIP != "" {
|
|
||||||
header.Set("X-Real-IP", tc.xRealIP)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := middleware.ClientIP(tc.remoteAddr, header, trusted)
|
|
||||||
if got != tc.want {
|
|
||||||
t.Errorf("ClientIP() = %q, want %q", got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSecurityHeaders(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
handler := (&middleware.Middleware{}).SecurityHeaders()(
|
|
||||||
http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", http.NoBody)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
want := map[string]string{
|
|
||||||
"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
|
|
||||||
"Content-Security-Policy": "default-src 'none'; frame-ancestors 'none'",
|
|
||||||
"X-Frame-Options": "DENY",
|
|
||||||
"X-Content-Type-Options": "nosniff",
|
|
||||||
"Referrer-Policy": "no-referrer",
|
|
||||||
"Permissions-Policy": "camera=(), microphone=(), geolocation=()",
|
|
||||||
}
|
|
||||||
|
|
||||||
for name, value := range want {
|
|
||||||
if got := rec.Header().Get(name); got != value {
|
|
||||||
t.Errorf("header %s = %q, want %q", name, got, value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestMaxBodyBytesRejectsOversizeOnNonReadingRoute confirms the
|
|
||||||
// limit is enforced even for a handler that never reads the body
|
|
||||||
// (for example the health check), via the Content-Length check.
|
|
||||||
func TestMaxBodyBytesRejectsOversizeOnNonReadingRoute(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const limit = 16
|
|
||||||
|
|
||||||
called := false
|
|
||||||
handler := (&middleware.Middleware{}).MaxBodyBytes(limit)(
|
|
||||||
http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) {
|
|
||||||
called = true
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/.well-known/healthcheck",
|
|
||||||
strings.NewReader(strings.Repeat("x", limit+1)),
|
|
||||||
)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
||||||
t.Fatalf("status = %d, want %d",
|
|
||||||
rec.Code, http.StatusRequestEntityTooLarge)
|
|
||||||
}
|
|
||||||
|
|
||||||
if called {
|
|
||||||
t.Fatal("handler ran despite oversize body")
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := rec.Body.String(); got != "{\"status\":\"error\"}\n" {
|
|
||||||
t.Errorf("body = %q, want %q", got, "{\"status\":\"error\"}\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
got := rec.Header().Get("Content-Type")
|
|
||||||
if got != "application/json; charset=utf-8" {
|
|
||||||
t.Errorf("Content-Type = %q, want a JSON content type", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMaxBodyBytesAllowsWithinLimit(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const limit = 64
|
|
||||||
|
|
||||||
handler := (&middleware.Middleware{}).MaxBodyBytes(limit)(
|
|
||||||
http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"clientId":"c1"}`),
|
|
||||||
)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusOK {
|
|
||||||
t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRecovererReturns500AndLogsThroughSlog(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var logbuf bytes.Buffer
|
|
||||||
|
|
||||||
mw := middleware.NewWithLogger(
|
|
||||||
slog.New(slog.NewJSONHandler(&logbuf, nil)),
|
|
||||||
)
|
|
||||||
|
|
||||||
handler := mw.Recoverer()(
|
|
||||||
http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) {
|
|
||||||
panic("boom")
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", http.NoBody)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusInternalServerError {
|
|
||||||
t.Fatalf("status = %d, want %d",
|
|
||||||
rec.Code, http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
|
|
||||||
var record map[string]any
|
|
||||||
|
|
||||||
err := json.Unmarshal(logbuf.Bytes(), &record)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("panic log is not one JSON record: %v (%q)", err, logbuf.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if record["msg"] != "panic recovered" || record["level"] != "ERROR" {
|
|
||||||
t.Errorf("log record = %v, want msg %q at level ERROR",
|
|
||||||
record, "panic recovered")
|
|
||||||
}
|
|
||||||
|
|
||||||
if record["panic"] != "boom" {
|
|
||||||
t.Errorf("panic field = %v, want %q", record["panic"], "boom")
|
|
||||||
}
|
|
||||||
|
|
||||||
stack, _ := record["stack"].(string)
|
|
||||||
if !strings.HasPrefix(stack, "goroutine ") {
|
|
||||||
t.Errorf("stack field = %q, want a stack trace", stack)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRecovererRepanicsOnAbortHandler checks that a handler aborting
|
|
||||||
// with http.ErrAbortHandler is not treated as a crash: Recoverer
|
|
||||||
// panics again so the server aborts the response, and logs nothing.
|
|
||||||
func TestRecovererRepanicsOnAbortHandler(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var logbuf bytes.Buffer
|
|
||||||
|
|
||||||
mw := middleware.NewWithLogger(
|
|
||||||
slog.New(slog.NewJSONHandler(&logbuf, nil)),
|
|
||||||
)
|
|
||||||
|
|
||||||
handler := mw.Recoverer()(
|
|
||||||
http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) {
|
|
||||||
panic(http.ErrAbortHandler)
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", http.NoBody)
|
|
||||||
|
|
||||||
var recovered any
|
|
||||||
|
|
||||||
func() {
|
|
||||||
defer func() { recovered = recover() }()
|
|
||||||
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
}()
|
|
||||||
|
|
||||||
err, _ := recovered.(error)
|
|
||||||
if !errors.Is(err, http.ErrAbortHandler) {
|
|
||||||
t.Errorf("Recoverer panicked with %v, want http.ErrAbortHandler", recovered)
|
|
||||||
}
|
|
||||||
|
|
||||||
if logbuf.Len() != 0 {
|
|
||||||
t.Errorf("abort was logged: %q", logbuf.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// okHandler stands in for the route a middleware guards.
|
|
||||||
func okHandler() http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRateLimitRefusesPastAllowanceThenResets checks one client
|
|
||||||
// address: it may use its whole allowance at once, the next request
|
|
||||||
// is refused with 429, and later it may send again.
|
|
||||||
func TestRateLimitRefusesPastAllowanceThenResets(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// synctest runs this on a fake clock: time.Sleep returns at once,
|
|
||||||
// with the clock moved on.
|
|
||||||
synctest.Test(t, func(t *testing.T) {
|
|
||||||
const perMinute = 2
|
|
||||||
|
|
||||||
handler := (&middleware.Middleware{}).RateLimit(perMinute)(okHandler())
|
|
||||||
|
|
||||||
post := func() *httptest.ResponseRecorder {
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports", http.NoBody)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := range perMinute {
|
|
||||||
if code := post().Code; code != http.StatusOK {
|
|
||||||
t.Fatalf("request %d: status = %d, want %d",
|
|
||||||
i+1, code, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := post()
|
|
||||||
if rec.Code != http.StatusTooManyRequests {
|
|
||||||
t.Fatalf("request past the allowance: status = %d, want %d",
|
|
||||||
rec.Code, http.StatusTooManyRequests)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := rec.Body.String(); got != "{\"status\":\"error\"}\n" {
|
|
||||||
t.Errorf("body = %q, want %q", got, "{\"status\":\"error\"}\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := rec.Header().Get("Retry-After"); got != "60" {
|
|
||||||
t.Fatalf("Retry-After = %q, want %q", got, "60")
|
|
||||||
}
|
|
||||||
|
|
||||||
// httprate also counts the previous minute's requests, fading
|
|
||||||
// them out over the current one, so two minutes on the whole
|
|
||||||
// allowance is back.
|
|
||||||
time.Sleep(2 * time.Minute)
|
|
||||||
|
|
||||||
for i := range perMinute {
|
|
||||||
if code := post().Code; code != http.StatusOK {
|
|
||||||
t.Fatalf("two minutes later, request %d: status = %d, want %d",
|
|
||||||
i+1, code, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// postForwarded sends handler a report from peer that names client in
|
|
||||||
// X-Forwarded-For, and returns the status.
|
|
||||||
func postForwarded(
|
|
||||||
t *testing.T,
|
|
||||||
handler http.Handler,
|
|
||||||
peer, client string,
|
|
||||||
) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports", http.NoBody)
|
|
||||||
req.RemoteAddr = peer
|
|
||||||
req.Header.Set("X-Forwarded-For", client)
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec.Code
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRateLimitIsPerForwardedClient checks that clients behind a
|
|
||||||
// trusted proxy each get their own allowance: the limit is keyed on
|
|
||||||
// the client address clientIP resolves, not on the proxy's.
|
|
||||||
func TestRateLimitIsPerForwardedClient(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const otherClient = "203.0.113.8"
|
|
||||||
|
|
||||||
mw := middleware.NewWithTrustedProxies(mustPrefixes(t, "127.0.0.1/32"))
|
|
||||||
handler := mw.RateLimit(1)(okHandler())
|
|
||||||
|
|
||||||
code := postForwarded(t, handler, loopbackPeer, forwardedIP)
|
|
||||||
if code != http.StatusOK {
|
|
||||||
t.Fatalf("first request: status = %d, want %d", code, http.StatusOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
code = postForwarded(t, handler, loopbackPeer, forwardedIP)
|
|
||||||
if code != http.StatusTooManyRequests {
|
|
||||||
t.Fatalf("same client again: status = %d, want %d",
|
|
||||||
code, http.StatusTooManyRequests)
|
|
||||||
}
|
|
||||||
|
|
||||||
code = postForwarded(t, handler, loopbackPeer, otherClient)
|
|
||||||
if code != http.StatusOK {
|
|
||||||
t.Fatalf("other client behind the same proxy: status = %d, want %d",
|
|
||||||
code, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRateLimitIgnoresForwardedForFromUntrustedPeer checks that a
|
|
||||||
// peer that is not a trusted proxy cannot get a fresh allowance by
|
|
||||||
// naming a different client in X-Forwarded-For on each request.
|
|
||||||
func TestRateLimitIgnoresForwardedForFromUntrustedPeer(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const untrustedPeer = "198.51.100.4:5000"
|
|
||||||
|
|
||||||
mw := middleware.NewWithTrustedProxies(mustPrefixes(t, "127.0.0.1/32"))
|
|
||||||
handler := mw.RateLimit(1)(okHandler())
|
|
||||||
|
|
||||||
code := postForwarded(t, handler, untrustedPeer, "203.0.113.8")
|
|
||||||
if code != http.StatusOK {
|
|
||||||
t.Fatalf("first request: status = %d, want %d", code, http.StatusOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
code = postForwarded(t, handler, untrustedPeer, "203.0.113.9")
|
|
||||||
if code != http.StatusTooManyRequests {
|
|
||||||
t.Fatalf("same peer naming another client: status = %d, want %d",
|
|
||||||
code, http.StatusTooManyRequests)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// preflight sends cors the preflight request a browser makes before
|
|
||||||
// it POSTs JSON from origin.
|
|
||||||
func preflight(
|
|
||||||
t *testing.T,
|
|
||||||
cors func(http.Handler) http.Handler,
|
|
||||||
origin string,
|
|
||||||
) *httptest.ResponseRecorder {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodOptions, "/api/v1/reports", http.NoBody)
|
|
||||||
req.Header.Set("Origin", origin)
|
|
||||||
req.Header.Set("Access-Control-Request-Method", http.MethodPost)
|
|
||||||
req.Header.Set("Access-Control-Request-Headers", "content-type")
|
|
||||||
cors(okHandler()).ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCORSWithoutOriginsAddsNoHeaders checks the default: with no
|
|
||||||
// origins configured, no origin is given any CORS header.
|
|
||||||
func TestCORSWithoutOriginsAddsNoHeaders(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
rec := preflight(t,
|
|
||||||
(&middleware.Middleware{}).CORS(nil), "https://elsewhere.example")
|
|
||||||
|
|
||||||
for name := range rec.Header() {
|
|
||||||
if strings.HasPrefix(name, "Access-Control-") {
|
|
||||||
t.Errorf("CORS header %s set with no origins configured", name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCORSAllowsOnlyListedOrigins(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const listed = "https://netwatch.example"
|
|
||||||
|
|
||||||
cors := (&middleware.Middleware{}).CORS([]string{listed})
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
origin string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{name: "listed origin allowed", origin: listed, want: listed},
|
|
||||||
{name: "other origin refused", origin: "https://elsewhere.example"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
rec := preflight(t, cors, tc.origin)
|
|
||||||
|
|
||||||
got := rec.Header().Get("Access-Control-Allow-Origin")
|
|
||||||
if got != tc.want {
|
|
||||||
t.Errorf("Access-Control-Allow-Origin = %q, want %q",
|
|
||||||
got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
package reportbuf
|
|
||||||
|
|
||||||
// Flush writes the buffered reports to a file now, as the periodic
|
|
||||||
// flush does, so tests need not wait a minute for it.
|
|
||||||
func (b *Buffer) Flush() error {
|
|
||||||
return b.flushLocked()
|
|
||||||
}
|
|
||||||
@@ -6,15 +6,12 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
|
||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
"sneak.berlin/go/netwatch/internal/config"
|
||||||
@@ -30,17 +27,8 @@ const (
|
|||||||
defaultDataDir = "./data/reports"
|
defaultDataDir = "./data/reports"
|
||||||
dirPerms fs.FileMode = 0o750
|
dirPerms fs.FileMode = 0o750
|
||||||
filePerms fs.FileMode = 0o640
|
filePerms fs.FileMode = 0o640
|
||||||
|
|
||||||
// Report files are named filePrefix + timestamp + "-" + number +
|
|
||||||
// fileSuffix; see writeFile.
|
|
||||||
filePrefix = "reports-"
|
|
||||||
fileSuffix = ".jsonl.zst"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrFull is returned by Append when storing the report would
|
|
||||||
// take the report files past the configured maximum size.
|
|
||||||
var ErrFull = errors.New("report files at their size cap")
|
|
||||||
|
|
||||||
// Params defines the dependencies for Buffer.
|
// Params defines the dependencies for Buffer.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -56,16 +44,7 @@ type Buffer struct {
|
|||||||
dataDir string
|
dataDir string
|
||||||
done chan struct{}
|
done chan struct{}
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
maxBytes int64
|
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
// seq numbers the report files, so that two named in the same
|
|
||||||
// millisecond still get different names.
|
|
||||||
seq atomic.Uint64
|
|
||||||
stopOnce sync.Once
|
|
||||||
// usedBytes is what Append checks against maxBytes: the size
|
|
||||||
// of the report files in dataDir, plus the reports not yet
|
|
||||||
// written to one at their uncompressed size.
|
|
||||||
usedBytes int64
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a Buffer and registers lifecycle hooks to
|
// New creates a Buffer and registers lifecycle hooks to
|
||||||
@@ -83,7 +62,6 @@ func New(
|
|||||||
dataDir: dir,
|
dataDir: dir,
|
||||||
done: make(chan struct{}),
|
done: make(chan struct{}),
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
maxBytes: params.Config.DataDirMaxBytes,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
@@ -93,30 +71,15 @@ func New(
|
|||||||
return fmt.Errorf("create data dir: %w", err)
|
return fmt.Errorf("create data dir: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Report files left by earlier runs count too.
|
|
||||||
b.usedBytes, err = reportFilesSize(b.dataDir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
go b.flushLoop()
|
go b.flushLoop()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
OnStop: func(_ context.Context) error {
|
OnStop: func(_ context.Context) error {
|
||||||
// stopOnce makes OnStop idempotent: a second
|
|
||||||
// invocation must not close an already-closed channel
|
|
||||||
// (which would panic) or flush again.
|
|
||||||
var err error
|
|
||||||
|
|
||||||
b.stopOnce.Do(func() {
|
|
||||||
close(b.done)
|
close(b.done)
|
||||||
err = b.flushLocked()
|
b.flushLocked()
|
||||||
})
|
|
||||||
|
|
||||||
// A failed final flush fails the stop, so the process
|
return nil
|
||||||
// exits non-zero.
|
|
||||||
return err
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -124,27 +87,15 @@ func New(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Append marshals v as a single JSON line and appends it to
|
// Append marshals v as a single JSON line and appends it to
|
||||||
// the buffer. It stores nothing and returns ErrFull if the line
|
// the buffer. If the buffer reaches the size threshold, it is
|
||||||
// would take usedBytes past maxBytes. If the buffer reaches the
|
// drained and written to disk asynchronously.
|
||||||
// size threshold, it is drained and written to disk
|
|
||||||
// asynchronously.
|
|
||||||
func (b *Buffer) Append(v any) error {
|
func (b *Buffer) Append(v any) error {
|
||||||
line, err := json.Marshal(v)
|
line, err := json.Marshal(v)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("marshal report: %w", err)
|
return fmt.Errorf("marshal report: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
lineBytes := int64(len(line)) + 1 // with its newline
|
|
||||||
|
|
||||||
b.mu.Lock()
|
b.mu.Lock()
|
||||||
|
|
||||||
if b.usedBytes+lineBytes > b.maxBytes {
|
|
||||||
b.mu.Unlock()
|
|
||||||
|
|
||||||
return ErrFull
|
|
||||||
}
|
|
||||||
|
|
||||||
b.usedBytes += lineBytes
|
|
||||||
b.buf.Write(line)
|
b.buf.Write(line)
|
||||||
b.buf.WriteByte('\n')
|
b.buf.WriteByte('\n')
|
||||||
|
|
||||||
@@ -152,12 +103,7 @@ func (b *Buffer) Append(v any) error {
|
|||||||
data := b.drainBuf()
|
data := b.drainBuf()
|
||||||
b.mu.Unlock()
|
b.mu.Unlock()
|
||||||
|
|
||||||
go func() {
|
go b.writeFile(data)
|
||||||
writeErr := b.writeFile(data)
|
|
||||||
if writeErr != nil {
|
|
||||||
b.log.Error("flush reports failed", "error", writeErr)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -176,10 +122,7 @@ func (b *Buffer) flushLoop() {
|
|||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
case <-ticker.C:
|
case <-ticker.C:
|
||||||
err := b.flushLocked()
|
b.flushLocked()
|
||||||
if err != nil {
|
|
||||||
b.log.Error("flush reports failed", "error", err)
|
|
||||||
}
|
|
||||||
case <-b.done:
|
case <-b.done:
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -188,19 +131,19 @@ func (b *Buffer) flushLoop() {
|
|||||||
|
|
||||||
// flushLocked acquires the lock, drains the buffer, and
|
// flushLocked acquires the lock, drains the buffer, and
|
||||||
// writes the data to a compressed file.
|
// writes the data to a compressed file.
|
||||||
func (b *Buffer) flushLocked() error {
|
func (b *Buffer) flushLocked() {
|
||||||
b.mu.Lock()
|
b.mu.Lock()
|
||||||
|
|
||||||
if b.buf.Len() == 0 {
|
if b.buf.Len() == 0 {
|
||||||
b.mu.Unlock()
|
b.mu.Unlock()
|
||||||
|
|
||||||
return nil
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
data := b.drainBuf()
|
data := b.drainBuf()
|
||||||
b.mu.Unlock()
|
b.mu.Unlock()
|
||||||
|
|
||||||
return b.writeFile(data)
|
b.writeFile(data)
|
||||||
}
|
}
|
||||||
|
|
||||||
// drainBuf copies the buffer contents and resets it.
|
// drainBuf copies the buffer contents and resets it.
|
||||||
@@ -215,91 +158,42 @@ func (b *Buffer) drainBuf() []byte {
|
|||||||
|
|
||||||
// writeFile creates a timestamped zstd-compressed JSONL file
|
// writeFile creates a timestamped zstd-compressed JSONL file
|
||||||
// in the data directory.
|
// in the data directory.
|
||||||
func (b *Buffer) writeFile(data []byte) error {
|
func (b *Buffer) writeFile(data []byte) {
|
||||||
// The timestamp comes first, so the names sort by time; the number
|
|
||||||
// after it tells apart files named in the same millisecond.
|
|
||||||
ts := time.Now().UTC().Format("2006-01-02T15-04-05.000Z")
|
ts := time.Now().UTC().Format("2006-01-02T15-04-05.000Z")
|
||||||
name := fmt.Sprintf("%s%s-%d%s", filePrefix, ts, b.seq.Add(1), fileSuffix)
|
name := fmt.Sprintf("reports-%s.jsonl.zst", ts)
|
||||||
path := filepath.Join(b.dataDir, name)
|
path := filepath.Join(b.dataDir, name)
|
||||||
|
|
||||||
// path is built from the operator-supplied dataDir plus a
|
f, err := os.OpenFile( //nolint:gosec // path built from controlled dataDir + timestamp
|
||||||
// generated timestamp and number, so it carries no external input.
|
|
||||||
f, err := os.OpenFile( //nolint:gosec // see comment above
|
|
||||||
path,
|
path,
|
||||||
os.O_WRONLY|os.O_CREATE|os.O_EXCL,
|
os.O_WRONLY|os.O_CREATE|os.O_EXCL,
|
||||||
filePerms,
|
filePerms,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("create report file: %w", err)
|
b.log.Error("create report file", "error", err)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Closes the file on the early returns below. The success
|
|
||||||
// path closes it explicitly to check the error; closing it
|
|
||||||
// a second time here is harmless.
|
|
||||||
defer func() { _ = f.Close() }()
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
enc, err := zstd.NewWriter(f)
|
enc, err := zstd.NewWriter(f)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("create zstd encoder: %w", err)
|
b.log.Error("create zstd encoder", "error", err)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = enc.Write(data)
|
_, writeErr := enc.Write(data)
|
||||||
if err != nil {
|
if writeErr != nil {
|
||||||
|
b.log.Error("write compressed data", "error", writeErr)
|
||||||
|
|
||||||
_ = enc.Close()
|
_ = enc.Close()
|
||||||
|
|
||||||
return fmt.Errorf("write compressed data: %w", err)
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
err = enc.Close()
|
closeErr := enc.Close()
|
||||||
if err != nil {
|
if closeErr != nil {
|
||||||
return fmt.Errorf("close zstd encoder: %w", err)
|
b.log.Error("close zstd encoder", "error", closeErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
info, err := f.Stat()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("stat report file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = f.Close()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("close report file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The reports counted at their uncompressed size while they
|
|
||||||
// waited; now they count as the file. After a failed write they
|
|
||||||
// stay counted as they were, which errs toward refusing reports
|
|
||||||
// early rather than letting the files pass the cap.
|
|
||||||
b.mu.Lock()
|
|
||||||
b.usedBytes += info.Size() - int64(len(data))
|
|
||||||
b.mu.Unlock()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// reportFilesSize returns the total size of the report files in
|
|
||||||
// dir.
|
|
||||||
func reportFilesSize(dir string) (int64, error) {
|
|
||||||
entries, err := os.ReadDir(dir)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("read data dir: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var total int64
|
|
||||||
|
|
||||||
for _, entry := range entries {
|
|
||||||
name := entry.Name()
|
|
||||||
if !strings.HasPrefix(name, filePrefix) ||
|
|
||||||
!strings.HasSuffix(name, fileSuffix) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
info, err := entry.Info()
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("stat report file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
total += info.Size()
|
|
||||||
}
|
|
||||||
|
|
||||||
return total, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,458 +1,13 @@
|
|||||||
package reportbuf_test
|
package reportbuf_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io/fs"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"slices"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
_ "sneak.berlin/go/netwatch/internal/reportbuf"
|
||||||
"sneak.berlin/go/netwatch/internal/globals"
|
|
||||||
"sneak.berlin/go/netwatch/internal/logger"
|
|
||||||
"sneak.berlin/go/netwatch/internal/reportbuf"
|
|
||||||
|
|
||||||
"github.com/klauspost/compress/zstd"
|
|
||||||
"go.uber.org/fx"
|
|
||||||
"go.uber.org/fx/fxtest"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestFlushOnShutdown proves the flush-on-shutdown path: a
|
func TestImport(t *testing.T) {
|
||||||
// report appended after start but before the periodic flush
|
t.Parallel()
|
||||||
// window must reach disk when the fx lifecycle stops. This is
|
// Compilation check — verifies the package parses
|
||||||
// the exact case that silent data loss on restart used to
|
// and all imports resolve.
|
||||||
// destroy.
|
|
||||||
func TestFlushOnShutdown(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
var buf *reportbuf.Buffer
|
|
||||||
|
|
||||||
app := fxtest.New(t,
|
|
||||||
fx.Provide(
|
|
||||||
globals.New,
|
|
||||||
logger.New,
|
|
||||||
config.New,
|
|
||||||
reportbuf.New,
|
|
||||||
),
|
|
||||||
fx.Populate(&buf),
|
|
||||||
)
|
|
||||||
|
|
||||||
app.RequireStart()
|
|
||||||
|
|
||||||
err := buf.Append(map[string]string{"probe": "shutdown"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("append report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireStop runs the reportbuf OnStop hook, which is the
|
|
||||||
// only code path that flushes buffered reports on shutdown.
|
|
||||||
app.RequireStop()
|
|
||||||
|
|
||||||
if !hasReportFile(t, dir) {
|
|
||||||
t.Fatal("no report file on disk after shutdown; " +
|
|
||||||
"the buffered report was lost")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFailedFinalFlushFailsStop proves a final flush that cannot
|
|
||||||
// write its file makes the stop fail, which makes the process
|
|
||||||
// exit non-zero instead of dropping the buffered reports silently.
|
|
||||||
func TestFailedFinalFlushFailsStop(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
var buf *reportbuf.Buffer
|
|
||||||
|
|
||||||
app := fxtest.New(t,
|
|
||||||
fx.Provide(
|
|
||||||
globals.New,
|
|
||||||
logger.New,
|
|
||||||
config.New,
|
|
||||||
reportbuf.New,
|
|
||||||
),
|
|
||||||
fx.Populate(&buf),
|
|
||||||
)
|
|
||||||
|
|
||||||
app.RequireStart()
|
|
||||||
|
|
||||||
err := buf.Append(map[string]string{"probe": "shutdown"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("append report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Removing the data directory leaves the final flush nowhere to
|
|
||||||
// write. A read-only directory would not do: tests run as root
|
|
||||||
// in the backend image, and root ignores the read-only bit.
|
|
||||||
err = os.RemoveAll(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("remove data dir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = app.Stop(t.Context())
|
|
||||||
if !errors.Is(err, fs.ErrNotExist) {
|
|
||||||
t.Fatalf("stop error = %v, want the final flush's error", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// startBuffer starts a Buffer through fx, as main does, with the
|
|
||||||
// DATA_DIR and DATA_DIR_MAX_BYTES the calling test has set.
|
|
||||||
func startBuffer(t *testing.T) *reportbuf.Buffer {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var buf *reportbuf.Buffer
|
|
||||||
|
|
||||||
app := fxtest.New(t,
|
|
||||||
fx.Provide(
|
|
||||||
globals.New,
|
|
||||||
logger.New,
|
|
||||||
config.New,
|
|
||||||
reportbuf.New,
|
|
||||||
),
|
|
||||||
fx.Populate(&buf),
|
|
||||||
)
|
|
||||||
|
|
||||||
app.RequireStart()
|
|
||||||
t.Cleanup(app.RequireStop)
|
|
||||||
|
|
||||||
return buf
|
|
||||||
}
|
|
||||||
|
|
||||||
// lineBytes is what one report takes in the buffer: its JSON and a
|
|
||||||
// newline.
|
|
||||||
func lineBytes(t *testing.T, report any) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
line, err := json.Marshal(report)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return len(line) + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAppendPastCapIsRefused(t *testing.T) {
|
|
||||||
report := map[string]string{"id": "cap"}
|
|
||||||
|
|
||||||
t.Setenv("DATA_DIR", t.TempDir())
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES", strconv.Itoa(lineBytes(t, report)))
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
|
|
||||||
err := buf.Append(report)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("report that fills the cap exactly: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Append(report)
|
|
||||||
if !errors.Is(err, reportbuf.ErrFull) {
|
|
||||||
t.Fatalf("report past the cap: error = %v, want ErrFull", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCapCountsReportFilesAlreadyInDataDir starts on a data
|
|
||||||
// directory holding a report file from an earlier run, and a file
|
|
||||||
// that is not a report, which must not count.
|
|
||||||
func TestCapCountsReportFilesAlreadyInDataDir(t *testing.T) {
|
|
||||||
const earlierBytes = 100
|
|
||||||
|
|
||||||
report := map[string]string{"id": "cap"}
|
|
||||||
dir := t.TempDir()
|
|
||||||
|
|
||||||
writeBytes(t, filepath.Join(dir, "reports-2026-01-01T00-00-00.000Z.jsonl.zst"),
|
|
||||||
earlierBytes)
|
|
||||||
writeBytes(t, filepath.Join(dir, "notes.txt"), 10*earlierBytes)
|
|
||||||
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES",
|
|
||||||
strconv.Itoa(earlierBytes+lineBytes(t, report)))
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
|
|
||||||
err := buf.Append(report)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("report that fills the cap exactly: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Append(report)
|
|
||||||
if !errors.Is(err, reportbuf.ErrFull) {
|
|
||||||
t.Fatalf("report past the cap: error = %v, want ErrFull", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWrittenReportsCountAtFileSize checks that once reports are
|
|
||||||
// written, they count as their compressed file, not their
|
|
||||||
// uncompressed size, which frees room under the cap.
|
|
||||||
func TestWrittenReportsCountAtFileSize(t *testing.T) {
|
|
||||||
// Repetitive, so its file is far smaller than its JSON.
|
|
||||||
report := map[string]string{"id": strings.Repeat("a", 1000)}
|
|
||||||
size := lineBytes(t, report)
|
|
||||||
|
|
||||||
t.Setenv("DATA_DIR", t.TempDir())
|
|
||||||
// Room for the report twice over only if the first one counts
|
|
||||||
// at its file's size by the time the second arrives.
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES", strconv.Itoa(2*size-1))
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
|
|
||||||
err := buf.Append(report)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("first report: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Flush()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("flush: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Append(report)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("second report, after the first was written: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWrittenReportsKeepCounting writes one report file after another
|
|
||||||
// under a small cap: each report must be taken while the files on disk
|
|
||||||
// leave room for it, and refused once they do not.
|
|
||||||
func TestWrittenReportsKeepCounting(t *testing.T) {
|
|
||||||
const maxBytes = 200
|
|
||||||
|
|
||||||
report := map[string]string{"id": "written"}
|
|
||||||
size := int64(lineBytes(t, report))
|
|
||||||
dir := t.TempDir()
|
|
||||||
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES", strconv.Itoa(maxBytes))
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
|
|
||||||
// Every file takes at least a byte, so they fill the cap within
|
|
||||||
// maxBytes rounds.
|
|
||||||
for range maxBytes {
|
|
||||||
used := reportFilesBytes(t, dir)
|
|
||||||
|
|
||||||
err := buf.Append(report)
|
|
||||||
if used+size > maxBytes {
|
|
||||||
if !errors.Is(err, reportbuf.ErrFull) {
|
|
||||||
t.Fatalf("with %d bytes of report files: error = %v, "+
|
|
||||||
"want ErrFull", used, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("with %d bytes of report files: %v", used, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Flush()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("flush: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Fatal("the report files never filled the cap")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestConcurrentAppendsStopAtCap appends from many goroutines at once
|
|
||||||
// with room for exactly roomFor reports: exactly that many must be
|
|
||||||
// taken, which holds only if Append checks and counts each report
|
|
||||||
// under one lock.
|
|
||||||
func TestConcurrentAppendsStopAtCap(t *testing.T) {
|
|
||||||
const (
|
|
||||||
roomFor = 5
|
|
||||||
senders = 50
|
|
||||||
)
|
|
||||||
|
|
||||||
// Large, so each Append takes long enough for the senders to
|
|
||||||
// overlap while the cap is reached.
|
|
||||||
report := map[string]string{"id": strings.Repeat("a", 1_000_000)}
|
|
||||||
|
|
||||||
t.Setenv("DATA_DIR", t.TempDir())
|
|
||||||
t.Setenv("DATA_DIR_MAX_BYTES",
|
|
||||||
strconv.Itoa(roomFor*lineBytes(t, report)))
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
|
|
||||||
var (
|
|
||||||
taken atomic.Int64
|
|
||||||
wg sync.WaitGroup
|
|
||||||
)
|
|
||||||
|
|
||||||
start := make(chan struct{})
|
|
||||||
|
|
||||||
for range senders {
|
|
||||||
wg.Go(func() {
|
|
||||||
<-start
|
|
||||||
|
|
||||||
err := buf.Append(report)
|
|
||||||
if err == nil {
|
|
||||||
taken.Add(1)
|
|
||||||
} else if !errors.Is(err, reportbuf.ErrFull) {
|
|
||||||
t.Errorf("append: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
close(start)
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
if got := taken.Load(); got != roomFor {
|
|
||||||
t.Fatalf("%d reports taken, want %d", got, roomFor)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestTwoFlushesInOneMillisecond flushes twice within one millisecond,
|
|
||||||
// as a flush for size and the final flush at shutdown can: each flush
|
|
||||||
// must write a file of its own, and the files must hold every report.
|
|
||||||
func TestTwoFlushesInOneMillisecond(t *testing.T) {
|
|
||||||
// A pair of flushes may straddle a millisecond, which proves
|
|
||||||
// nothing, so pairs are flushed until one falls within one.
|
|
||||||
const maxPairs = 1000
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
|
||||||
t.Setenv("DATA_DIR", dir)
|
|
||||||
|
|
||||||
buf := startBuffer(t)
|
|
||||||
flushes := 0
|
|
||||||
|
|
||||||
for pair := 1; ; pair++ {
|
|
||||||
start := time.Now().Truncate(time.Millisecond)
|
|
||||||
|
|
||||||
for range 2 {
|
|
||||||
flushes++
|
|
||||||
|
|
||||||
err := buf.Append(map[string]int{"id": flushes})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("append report %d: %v", flushes, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = buf.Flush()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("flush %d: %v", flushes, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if time.Now().Truncate(time.Millisecond).Equal(start) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
if pair == maxPairs {
|
|
||||||
t.Fatalf("no pair of flushes fell within one millisecond "+
|
|
||||||
"in %d tries", maxPairs)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
files := readReportFiles(t, dir)
|
|
||||||
if len(files) != flushes {
|
|
||||||
t.Fatalf("%d report files after %d flushes", len(files), flushes)
|
|
||||||
}
|
|
||||||
|
|
||||||
for id := 1; id <= flushes; id++ {
|
|
||||||
want := fmt.Sprintf(`{"id":%d}`+"\n", id)
|
|
||||||
if !slices.Contains(files, want) {
|
|
||||||
t.Fatalf("no report file holds report %d alone", id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// reportFilesBytes returns the total size of the report files in dir.
|
|
||||||
func reportFilesBytes(t *testing.T, dir string) int64 {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
paths, err := filepath.Glob(filepath.Join(dir, "reports-*.jsonl.zst"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("list report files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var total int64
|
|
||||||
|
|
||||||
for _, path := range paths {
|
|
||||||
info, statErr := os.Stat(path)
|
|
||||||
if statErr != nil {
|
|
||||||
t.Fatalf("stat %s: %v", path, statErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
total += info.Size()
|
|
||||||
}
|
|
||||||
|
|
||||||
return total
|
|
||||||
}
|
|
||||||
|
|
||||||
// readReportFiles returns the decompressed contents of each report
|
|
||||||
// file in dir.
|
|
||||||
func readReportFiles(t *testing.T, dir string) []string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
files := os.DirFS(dir)
|
|
||||||
|
|
||||||
names, err := fs.Glob(files, "reports-*.jsonl.zst")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("list report files: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
dec, err := zstd.NewReader(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create zstd decoder: %v", err)
|
|
||||||
}
|
|
||||||
defer dec.Close()
|
|
||||||
|
|
||||||
contents := make([]string, 0, len(names))
|
|
||||||
|
|
||||||
for _, name := range names {
|
|
||||||
compressed, readErr := fs.ReadFile(files, name)
|
|
||||||
if readErr != nil {
|
|
||||||
t.Fatalf("read %s: %v", name, readErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
data, decErr := dec.DecodeAll(compressed, nil)
|
|
||||||
if decErr != nil {
|
|
||||||
t.Fatalf("decompress %s: %v", name, decErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
contents = append(contents, string(data))
|
|
||||||
}
|
|
||||||
|
|
||||||
return contents
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeBytes(t *testing.T, path string, n int) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
err := os.WriteFile(path, make([]byte, n), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("write %s: %v", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func hasReportFile(t *testing.T, dir string) bool {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
entries, err := os.ReadDir(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read data dir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, e := range entries {
|
|
||||||
if strings.HasSuffix(e.Name(), ".jsonl.zst") {
|
|
||||||
info, statErr := e.Info()
|
|
||||||
if statErr != nil {
|
|
||||||
t.Fatalf("stat %s: %v", e.Name(), statErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.Size() > 0 {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
// MaxRequestBodyBytes exposes the router-wide body limit to the
|
|
||||||
// external tests.
|
|
||||||
const MaxRequestBodyBytes = maxRequestBodyBytes
|
|
||||||
|
|
||||||
// ListenAddr exposes the address the server listens on to the
|
|
||||||
// external tests.
|
|
||||||
func (s *Server) ListenAddr() string {
|
|
||||||
return s.newHTTPServer().Addr
|
|
||||||
}
|
|
||||||
@@ -2,69 +2,42 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"net"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
readTimeout = 10 * time.Second
|
readTimeout = 10 * time.Second
|
||||||
readHeaderTimeout = 5 * time.Second
|
writeTimeout = 10 * time.Second
|
||||||
idleTimeout = 60 * time.Second
|
|
||||||
maxHeaderBytes = 1 << 20 // 1 MiB
|
maxHeaderBytes = 1 << 20 // 1 MiB
|
||||||
|
|
||||||
// requestTimeout (routes.go) is the single per-request
|
|
||||||
// processing budget, enforced by chi's middleware.Timeout.
|
|
||||||
// writeTimeout must exceed that budget so a handler can write
|
|
||||||
// its 503 when the chi timeout fires; if it were shorter the
|
|
||||||
// server would abort the write first and the chi budget would
|
|
||||||
// be unreachable dead configuration.
|
|
||||||
writeTimeout = requestTimeout + 5*time.Second
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// newHTTPServer constructs the http.Server. It performs no I/O
|
func (s *Server) serveUntilShutdown() {
|
||||||
// and does not start listening.
|
listenAddr := fmt.Sprintf(":%d", s.params.Config.Port)
|
||||||
func (s *Server) newHTTPServer() *http.Server {
|
|
||||||
listenAddr := net.JoinHostPort(
|
|
||||||
s.params.Config.BindAddress,
|
|
||||||
strconv.Itoa(s.params.Config.Port),
|
|
||||||
)
|
|
||||||
|
|
||||||
return &http.Server{
|
s.httpServer = &http.Server{
|
||||||
Addr: listenAddr,
|
Addr: listenAddr,
|
||||||
Handler: s,
|
Handler: s,
|
||||||
MaxHeaderBytes: maxHeaderBytes,
|
MaxHeaderBytes: maxHeaderBytes,
|
||||||
ReadTimeout: readTimeout,
|
ReadTimeout: readTimeout,
|
||||||
ReadHeaderTimeout: readHeaderTimeout,
|
|
||||||
WriteTimeout: writeTimeout,
|
WriteTimeout: writeTimeout,
|
||||||
IdleTimeout: idleTimeout,
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// listenAndServe runs the listener until the server is shut
|
s.SetupRoutes()
|
||||||
// down. A genuine listen failure (not the expected
|
|
||||||
// ErrServerClosed from a clean shutdown) requests process
|
|
||||||
// shutdown through fx with a non-zero exit code, so the failure
|
|
||||||
// is visible to any supervisor.
|
|
||||||
func (s *Server) listenAndServe() {
|
|
||||||
s.log.Info("http begin listen",
|
s.log.Info("http begin listen",
|
||||||
"listenaddr", s.httpServer.Addr,
|
"listenaddr", listenAddr,
|
||||||
"version", s.params.Globals.Version,
|
"version", s.params.Globals.Version,
|
||||||
"buildarch", s.params.Globals.Buildarch,
|
"buildarch", s.params.Globals.Buildarch,
|
||||||
)
|
)
|
||||||
|
|
||||||
err := s.httpServer.ListenAndServe()
|
err := s.httpServer.ListenAndServe()
|
||||||
if err == nil || errors.Is(err, http.ErrServerClosed) {
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s.log.Error("listen error", "error", err)
|
s.log.Error("listen error", "error", err)
|
||||||
|
|
||||||
shutdownErr := s.shutdowner.Shutdown(fx.ExitCode(1))
|
if s.cancelFunc != nil {
|
||||||
if shutdownErr != nil {
|
s.cancelFunc()
|
||||||
s.log.Error("request shutdown failed", "error", shutdownErr)
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
package server_test
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
// TestListenAddress checks that the server listens on BIND_ADDRESS
|
|
||||||
// and PORT, and on port 8080 on every interface when neither is set.
|
|
||||||
// The container image sets both, to keep the backend on loopback
|
|
||||||
// behind nginx.
|
|
||||||
func TestListenAddress(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
bindAddress string
|
|
||||||
port string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{bindAddress: "", port: "", want: ":8080"},
|
|
||||||
{bindAddress: "127.0.0.1", port: "8081", want: "127.0.0.1:8081"},
|
|
||||||
{bindAddress: "::1", port: "8081", want: "[::1]:8081"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.want, func(t *testing.T) {
|
|
||||||
// t.Setenv rules out t.Parallel.
|
|
||||||
t.Setenv("BIND_ADDRESS", tt.bindAddress)
|
|
||||||
t.Setenv("PORT", tt.port)
|
|
||||||
|
|
||||||
got := newServer(t).ListenAddr()
|
|
||||||
if got != tt.want {
|
|
||||||
t.Errorf("listen address = %q, want %q", got, tt.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -7,26 +7,17 @@ import (
|
|||||||
"github.com/go-chi/chi/v5/middleware"
|
"github.com/go-chi/chi/v5/middleware"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const requestTimeout = 60 * time.Second
|
||||||
requestTimeout = 60 * time.Second
|
|
||||||
|
|
||||||
// maxRequestBodyBytes caps every request body. A route group
|
|
||||||
// can mount s.mw.MaxBodyBytes with a smaller value to lower
|
|
||||||
// its bound, but cannot raise it: this cap runs first.
|
|
||||||
maxRequestBodyBytes int64 = 1 << 20 // 1 MiB
|
|
||||||
)
|
|
||||||
|
|
||||||
// SetupRoutes configures the chi router with middleware and
|
// SetupRoutes configures the chi router with middleware and
|
||||||
// all application routes.
|
// all application routes.
|
||||||
func (s *Server) SetupRoutes() {
|
func (s *Server) SetupRoutes() {
|
||||||
s.router = chi.NewRouter()
|
s.router = chi.NewRouter()
|
||||||
|
|
||||||
s.router.Use(s.mw.Recoverer())
|
s.router.Use(middleware.Recoverer)
|
||||||
s.router.Use(middleware.RequestID)
|
s.router.Use(middleware.RequestID)
|
||||||
s.router.Use(s.mw.Logging())
|
s.router.Use(s.mw.Logging())
|
||||||
s.router.Use(s.mw.SecurityHeaders())
|
s.router.Use(s.mw.CORS())
|
||||||
s.router.Use(s.mw.CORS(s.params.Config.CORSAllowedOrigins))
|
|
||||||
s.router.Use(s.mw.MaxBodyBytes(maxRequestBodyBytes))
|
|
||||||
s.router.Use(middleware.Timeout(requestTimeout))
|
s.router.Use(middleware.Timeout(requestTimeout))
|
||||||
|
|
||||||
s.router.Get(
|
s.router.Get(
|
||||||
@@ -35,7 +26,6 @@ func (s *Server) SetupRoutes() {
|
|||||||
)
|
)
|
||||||
|
|
||||||
s.router.Route("/api/v1", func(r chi.Router) {
|
s.router.Route("/api/v1", func(r chi.Router) {
|
||||||
r.With(s.mw.RateLimit(s.params.Config.ReportsPerMinute)).
|
r.Post("/reports", s.h.HandleReport())
|
||||||
Post("/reports", s.h.HandleReport())
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,142 +0,0 @@
|
|||||||
package server_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
|
||||||
"sneak.berlin/go/netwatch/internal/globals"
|
|
||||||
"sneak.berlin/go/netwatch/internal/handlers"
|
|
||||||
"sneak.berlin/go/netwatch/internal/healthcheck"
|
|
||||||
"sneak.berlin/go/netwatch/internal/logger"
|
|
||||||
"sneak.berlin/go/netwatch/internal/middleware"
|
|
||||||
"sneak.berlin/go/netwatch/internal/reportbuf"
|
|
||||||
"sneak.berlin/go/netwatch/internal/server"
|
|
||||||
|
|
||||||
"go.uber.org/fx"
|
|
||||||
"go.uber.org/fx/fxtest"
|
|
||||||
)
|
|
||||||
|
|
||||||
// newServer builds a Server from the same constructors as main,
|
|
||||||
// configured from the environment. It is never started, so nothing
|
|
||||||
// listens.
|
|
||||||
func newServer(t *testing.T) *server.Server {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var srv *server.Server
|
|
||||||
|
|
||||||
app := fxtest.New(t,
|
|
||||||
fx.Provide(
|
|
||||||
config.New,
|
|
||||||
globals.New,
|
|
||||||
handlers.New,
|
|
||||||
healthcheck.New,
|
|
||||||
logger.New,
|
|
||||||
middleware.New,
|
|
||||||
reportbuf.New,
|
|
||||||
server.New,
|
|
||||||
),
|
|
||||||
fx.Populate(&srv),
|
|
||||||
)
|
|
||||||
|
|
||||||
err := app.Err()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("build server: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return srv
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReportsAreRateLimited checks that POST /api/v1/reports is
|
|
||||||
// behind the per-address rate limit, set here to two a minute.
|
|
||||||
func TestReportsAreRateLimited(t *testing.T) {
|
|
||||||
t.Setenv("REPORTS_PER_MINUTE", "2")
|
|
||||||
|
|
||||||
srv := newServer(t)
|
|
||||||
srv.SetupRoutes()
|
|
||||||
|
|
||||||
post := func() int {
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodPost, "/api/v1/reports",
|
|
||||||
strings.NewReader(`{"clientId":"c1","hosts":[]}`),
|
|
||||||
)
|
|
||||||
srv.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec.Code
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := range 2 {
|
|
||||||
if code := post(); code != http.StatusOK {
|
|
||||||
t.Fatalf("report %d: status = %d, want %d",
|
|
||||||
i+1, code, http.StatusOK)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if code := post(); code != http.StatusTooManyRequests {
|
|
||||||
t.Fatalf("third report in a minute: status = %d, want %d",
|
|
||||||
code, http.StatusTooManyRequests)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCORSAllowedOriginsReachTheRouter checks that an origin listed in
|
|
||||||
// CORS_ALLOWED_ORIGINS is allowed by the router, not only when handed
|
|
||||||
// to the CORS middleware directly.
|
|
||||||
func TestCORSAllowedOriginsReachTheRouter(t *testing.T) {
|
|
||||||
const origin = "https://netwatch.example:8443"
|
|
||||||
|
|
||||||
t.Setenv("CORS_ALLOWED_ORIGINS", origin)
|
|
||||||
|
|
||||||
srv := newServer(t)
|
|
||||||
srv.SetupRoutes()
|
|
||||||
|
|
||||||
// The preflight a browser sends before it POSTs JSON from origin.
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodOptions, "/api/v1/reports", http.NoBody)
|
|
||||||
req.Header.Set("Origin", origin)
|
|
||||||
req.Header.Set("Access-Control-Request-Method", http.MethodPost)
|
|
||||||
req.Header.Set("Access-Control-Request-Headers", "content-type")
|
|
||||||
srv.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
got := rec.Header().Get("Access-Control-Allow-Origin")
|
|
||||||
if got != origin {
|
|
||||||
t.Fatalf("Access-Control-Allow-Origin = %q, want %q", got, origin)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHealthCheckRejectsOversizeBody sends the health check, which
|
|
||||||
// never reads its body, a body one byte over the limit. Only the
|
|
||||||
// router-wide body limit can reject it.
|
|
||||||
func TestHealthCheckRejectsOversizeBody(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := newServer(t)
|
|
||||||
srv.SetupRoutes()
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(),
|
|
||||||
http.MethodGet, "/.well-known/healthcheck",
|
|
||||||
strings.NewReader(
|
|
||||||
strings.Repeat("x", int(server.MaxRequestBodyBytes)+1),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
srv.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
||||||
t.Fatalf("status = %d, want %d",
|
|
||||||
rec.Code, http.StatusRequestEntityTooLarge)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := rec.Body.String(); got != "{\"status\":\"error\"}\n" {
|
|
||||||
t.Errorf("body = %q, want %q", got, "{\"status\":\"error\"}\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
got := rec.Header().Get("Content-Type")
|
|
||||||
if got != "application/json; charset=utf-8" {
|
|
||||||
t.Errorf("Content-Type = %q, want a JSON content type", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +1,16 @@
|
|||||||
// Package server provides the HTTP server lifecycle,
|
// Package server provides the HTTP server lifecycle,
|
||||||
// including startup, routing, and graceful shutdown. The
|
// including startup, routing, signal handling, and graceful
|
||||||
// process lifetime is owned by fx: shutdown is requested
|
// shutdown.
|
||||||
// through fx.Shutdowner so every component's OnStop hook runs
|
|
||||||
// in dependency order.
|
|
||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/netwatch/internal/config"
|
"sneak.berlin/go/netwatch/internal/config"
|
||||||
"sneak.berlin/go/netwatch/internal/globals"
|
"sneak.berlin/go/netwatch/internal/globals"
|
||||||
@@ -29,18 +31,19 @@ type Params struct {
|
|||||||
Handlers *handlers.Handlers
|
Handlers *handlers.Handlers
|
||||||
Logger *logger.Logger
|
Logger *logger.Logger
|
||||||
Middleware *middleware.Middleware
|
Middleware *middleware.Middleware
|
||||||
Shutdowner fx.Shutdowner
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Server is the top-level HTTP server orchestrator.
|
// Server is the top-level HTTP server orchestrator.
|
||||||
type Server struct {
|
type Server struct {
|
||||||
|
cancelFunc context.CancelFunc
|
||||||
|
exitCode int
|
||||||
h *handlers.Handlers
|
h *handlers.Handlers
|
||||||
httpServer *http.Server
|
httpServer *http.Server
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
mw *middleware.Middleware
|
mw *middleware.Middleware
|
||||||
params Params
|
params Params
|
||||||
router *chi.Mux
|
router *chi.Mux
|
||||||
shutdowner fx.Shutdowner
|
startupTime time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a Server and registers lifecycle hooks for
|
// New creates a Server and registers lifecycle hooks for
|
||||||
@@ -54,25 +57,23 @@ func New(
|
|||||||
s.mw = params.Middleware
|
s.mw = params.Middleware
|
||||||
s.h = params.Handlers
|
s.h = params.Handlers
|
||||||
s.log = params.Logger.Get()
|
s.log = params.Logger.Get()
|
||||||
s.shutdowner = params.Shutdowner
|
|
||||||
|
|
||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
OnStart: func(_ context.Context) error {
|
OnStart: func(_ context.Context) error {
|
||||||
// Build the router and http.Server synchronously
|
s.startupTime = time.Now().UTC()
|
||||||
// here, before spawning the serving goroutine, so
|
|
||||||
// httpServer is fully constructed by the time OnStop
|
|
||||||
// (or an early signal) can read it. fx guarantees
|
|
||||||
// OnStart returns before OnStop runs, so no
|
|
||||||
// synchronization or nil check is needed at shutdown.
|
|
||||||
s.SetupRoutes()
|
|
||||||
s.httpServer = s.newHTTPServer()
|
|
||||||
|
|
||||||
go s.listenAndServe()
|
go func() { //nolint:contextcheck // fx OnStart ctx is startup-only; run() creates its own
|
||||||
|
s.run()
|
||||||
|
}()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
OnStop: func(ctx context.Context) error {
|
OnStop: func(_ context.Context) error {
|
||||||
return s.shutdown(ctx)
|
if s.cancelFunc != nil {
|
||||||
|
s.cancelFunc()
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -87,17 +88,60 @@ func (s *Server) ServeHTTP(
|
|||||||
s.router.ServeHTTP(w, r)
|
s.router.ServeHTTP(w, r)
|
||||||
}
|
}
|
||||||
|
|
||||||
// shutdown gracefully stops the HTTP server within the
|
func (s *Server) run() {
|
||||||
// deadline of the context fx provides for OnStop.
|
exitCode := s.serve()
|
||||||
func (s *Server) shutdown(ctx context.Context) error {
|
os.Exit(exitCode)
|
||||||
err := s.httpServer.Shutdown(ctx)
|
}
|
||||||
if err != nil {
|
|
||||||
s.log.Error("server clean shutdown failed", "error", err)
|
|
||||||
|
|
||||||
return err
|
func (s *Server) serve() int {
|
||||||
|
var ctx context.Context //nolint:wsl // ctx must be declared before multi-assign
|
||||||
|
|
||||||
|
ctx, s.cancelFunc = context.WithCancel(
|
||||||
|
context.Background(),
|
||||||
|
)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
c := make(chan os.Signal, 1)
|
||||||
|
|
||||||
|
signal.Ignore(syscall.SIGPIPE)
|
||||||
|
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
|
||||||
|
|
||||||
|
sig := <-c
|
||||||
|
s.log.Info("signal received", "signal", sig)
|
||||||
|
|
||||||
|
if s.cancelFunc != nil {
|
||||||
|
s.cancelFunc()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
s.serveUntilShutdown()
|
||||||
|
}()
|
||||||
|
|
||||||
|
<-ctx.Done()
|
||||||
|
s.cleanShutdown()
|
||||||
|
|
||||||
|
return s.exitCode
|
||||||
|
}
|
||||||
|
|
||||||
|
const shutdownTimeout = 5 * time.Second
|
||||||
|
|
||||||
|
func (s *Server) cleanShutdown() {
|
||||||
|
s.exitCode = 0
|
||||||
|
|
||||||
|
ctxShutdown, shutdownCancel := context.WithTimeout(
|
||||||
|
context.Background(),
|
||||||
|
shutdownTimeout,
|
||||||
|
)
|
||||||
|
defer shutdownCancel()
|
||||||
|
|
||||||
|
err := s.httpServer.Shutdown(ctxShutdown)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"server clean shutdown failed",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log.Info("server stopped")
|
s.log.Info("server stopped")
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/build: compile the static netwatch-server binary into the
|
|
||||||
# backend project root, with its version and architecture stamped in.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
|
|
||||||
# VERSION comes from the environment (the root Dockerfile passes its
|
|
||||||
# ARG VERSION in). Unset or empty, it is git describe, or "dev" where
|
|
||||||
# there is no git or no repository history.
|
|
||||||
version="${VERSION:-$(git describe --always --dirty 2>/dev/null || echo dev)}"
|
|
||||||
|
|
||||||
CGO_ENABLED=0 go build -trimpath \
|
|
||||||
-ldflags "-s -w -X main.Version=$version -X main.Buildarch=$(uname -m)" \
|
|
||||||
-o netwatch-server ./cmd/netwatch-server/
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/clean: remove build artifacts.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
rm -f netwatch-server
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/fmt: format the Go sources (writes).
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
go fmt ./...
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/fmt-check: check Go formatting (read-only). Same scope as
|
|
||||||
# script/fmt, but fails instead of writing.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
unformatted="$(gofmt -l .)"
|
|
||||||
if [ -n "$unformatted" ]; then
|
|
||||||
echo "Files not formatted:" >&2
|
|
||||||
echo "$unformatted" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/lint: run golangci-lint over the backend. This runs inside the
|
|
||||||
# lint stage of the root Dockerfile, whose digest-pinned golangci-lint
|
|
||||||
# image provides the linter; nothing installs golangci-lint on the host.
|
|
||||||
# From a checkout, run `make lint` at the repo root, which builds that
|
|
||||||
# stage.
|
|
||||||
#
|
|
||||||
# .golangci.yml is standardized org-wide and must never be edited here
|
|
||||||
# (REPO_POLICIES.md). Its last silent drift replaced the v2 schema with
|
|
||||||
# v1 keys, which left every threshold in the file inert while the build
|
|
||||||
# stayed green. So the file is first checked against the canonical
|
|
||||||
# copy's sha256: a local comparison, no network, nothing unpinned.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
GOLANGCI_CONFIG_SHA256="021cc83f4e6fc7c31b95b34b846723dfcf20b66b7baeea1dc40406e643346bcb"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
actual="$(sha256sum .golangci.yml | cut -d' ' -f1)"
|
|
||||||
if [ "$actual" != "$GOLANGCI_CONFIG_SHA256" ]; then
|
|
||||||
echo ".golangci.yml has drifted from the org standard." >&2
|
|
||||||
echo " expected $GOLANGCI_CONFIG_SHA256" >&2
|
|
||||||
echo " actual $actual" >&2
|
|
||||||
echo "Restore it verbatim from sneak/prompts; do not edit it." >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
golangci-lint run ./...
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/run: build and run netwatch-server locally.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
"$ROOT/script/build"
|
|
||||||
exec ./netwatch-server "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/test: run the backend test suite.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
timeout 30 go test ./...
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# The container's entrypoint: runs netwatch-server and nginx side by
|
|
||||||
# side. TERM or INT stops both, and the container exits 0 if both exit
|
|
||||||
# cleanly. If either exits on its own, the other is stopped too and the
|
|
||||||
# container exits non-zero, so the platform restarts it instead of
|
|
||||||
# leaving it half up.
|
|
||||||
#
|
|
||||||
# No set -e: kill and wait return non-zero here in normal operation.
|
|
||||||
set -u
|
|
||||||
|
|
||||||
# A stop signal is only noted here; the loop below acts on it.
|
|
||||||
stop_requested=""
|
|
||||||
trap 'stop_requested=yes' TERM INT
|
|
||||||
|
|
||||||
# netwatch-server runs as the netwatch user and listens on loopback
|
|
||||||
# only, on a port other than the public one; nginx.conf proxies to this
|
|
||||||
# address. The netwatch user has no login shell, hence -s /bin/sh.
|
|
||||||
# busybox su replaces itself with the command instead of staying on as
|
|
||||||
# its parent, so $! is the server's own PID.
|
|
||||||
BIND_ADDRESS=127.0.0.1 PORT=8081 \
|
|
||||||
su -s /bin/sh netwatch -c 'exec netwatch-server' &
|
|
||||||
backend=$!
|
|
||||||
|
|
||||||
# nginx starts through the nginx image's own entrypoint, which applies
|
|
||||||
# the image's start-up configuration and then replaces itself with
|
|
||||||
# nginx.
|
|
||||||
/docker-entrypoint.sh nginx -g 'daemon off;' &
|
|
||||||
nginx=$!
|
|
||||||
|
|
||||||
running() {
|
|
||||||
kill -0 "$1" 2>/dev/null
|
|
||||||
}
|
|
||||||
|
|
||||||
# POSIX sh cannot wait for whichever of two children exits first, so
|
|
||||||
# look once a second. The shell collects a child that has exited while
|
|
||||||
# it runs sleep, and running() is false for that child from then on.
|
|
||||||
while [ -z "$stop_requested" ] && running "$backend" && running "$nginx"; do
|
|
||||||
sleep 1
|
|
||||||
done
|
|
||||||
|
|
||||||
# Stop both, then wait until neither is left.
|
|
||||||
kill -TERM "$backend" "$nginx" 2>/dev/null
|
|
||||||
while running "$backend" || running "$nginx"; do
|
|
||||||
sleep 1
|
|
||||||
done
|
|
||||||
|
|
||||||
wait "$backend"
|
|
||||||
backend_status=$?
|
|
||||||
wait "$nginx"
|
|
||||||
nginx_status=$?
|
|
||||||
echo "entrypoint: netwatch-server exited $backend_status," \
|
|
||||||
"nginx exited $nginx_status"
|
|
||||||
|
|
||||||
# Success is a requested stop that both processes exited cleanly from.
|
|
||||||
if [ -n "$stop_requested" ] && [ "$backend_status" -eq 0 ] &&
|
|
||||||
[ "$nginx_status" -eq 0 ]; then
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
exit 1
|
|
||||||
-19
@@ -25,23 +25,4 @@ server {
|
|||||||
expires 1y;
|
expires 1y;
|
||||||
add_header Cache-Control "public, immutable";
|
add_header Cache-Control "public, immutable";
|
||||||
}
|
}
|
||||||
|
|
||||||
# netwatch-server, the Go backend, runs in the same container and
|
|
||||||
# listens on loopback only: bin/entrypoint.sh starts it on
|
|
||||||
# 127.0.0.1:8081. These headers go with every request passed to it.
|
|
||||||
# X-Forwarded-For carries only the client address, as resolved by
|
|
||||||
# the real IP settings above, and not the chain the request came
|
|
||||||
# with: the backend takes the first entry, which a client can write.
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
|
||||||
|
|
||||||
location /api/ {
|
|
||||||
proxy_pass http://127.0.0.1:8081;
|
|
||||||
}
|
|
||||||
|
|
||||||
location = /.well-known/healthcheck {
|
|
||||||
proxy_pass http://127.0.0.1:8081;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,7 +14,6 @@
|
|||||||
"autoprefixer": "^10.4.23",
|
"autoprefixer": "^10.4.23",
|
||||||
"postcss": "^8.5.6",
|
"postcss": "^8.5.6",
|
||||||
"prettier": "^3.8.1",
|
"prettier": "^3.8.1",
|
||||||
"puppeteer-core": "25.5.0",
|
|
||||||
"tailwindcss": "^4.1.18",
|
"tailwindcss": "^4.1.18",
|
||||||
"vite": "^7.3.1"
|
"vite": "^7.3.1"
|
||||||
}
|
}
|
||||||
|
|||||||
+11
-126
@@ -5,18 +5,7 @@
|
|||||||
# or apk (detected in that order); assumes nothing is present. Node is
|
# or apk (detected in that order); assumes nothing is present. Node is
|
||||||
# used directly if installed; otherwise it is installed at a pinned
|
# used directly if installed; otherwise it is installed at a pinned
|
||||||
# version via nvm (installing nvm itself first, from a hash-verified
|
# version via nvm (installing nvm itself first, from a hash-verified
|
||||||
# release archive, never curl | sh). Go, with its gofmt, is used
|
# release archive, never curl | sh).
|
||||||
# directly if it is at least the version backend/go.mod asks for;
|
|
||||||
# otherwise the pinned Go release is installed from its hash-verified
|
|
||||||
# archive.
|
|
||||||
#
|
|
||||||
# What this script installs outside the system package manager lives
|
|
||||||
# under $HOME and is linked into ~/.local/bin, where make and the git
|
|
||||||
# hook find it once that directory is on PATH. Nothing in ~/.local/bin
|
|
||||||
# that this script did not create is ever replaced.
|
|
||||||
#
|
|
||||||
# golangci-lint is not installed: make lint runs it in Docker, which
|
|
||||||
# this script does not install either.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
@@ -27,12 +16,6 @@ NVM_VERSION="0.40.3"
|
|||||||
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
|
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
|
||||||
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
|
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
|
||||||
YARN_VERSION="1.22.22"
|
YARN_VERSION="1.22.22"
|
||||||
# The Go inside the golang:1.25-alpine image Dockerfile builds the
|
|
||||||
# backend with, 2026-08-09. The archive hashes are in ensure_go.
|
|
||||||
GO_VERSION="1.25.7"
|
|
||||||
|
|
||||||
BIN_DIR="$HOME/.local/bin"
|
|
||||||
TOOLCHAIN="$HOME/.local/share/$("$ROOT/script/projectname")/toolchain"
|
|
||||||
|
|
||||||
PKGMGR=""
|
PKGMGR=""
|
||||||
SUDO=""
|
SUDO=""
|
||||||
@@ -96,26 +79,6 @@ verify_sha256() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# link_bin <target> <name>: make an installed tool reachable as
|
|
||||||
# $BIN_DIR/<name>. Only a symlink this script made, one pointing into
|
|
||||||
# $TOOLCHAIN or ~/.nvm, is ever replaced; if anything else is already
|
|
||||||
# there, bootstrap stops.
|
|
||||||
link_bin() {
|
|
||||||
link="$BIN_DIR/$2"
|
|
||||||
if [ -L "$link" ] || [ -e "$link" ]; then
|
|
||||||
case "$(readlink "$link" || true)" in
|
|
||||||
"$TOOLCHAIN"/* | "$HOME"/.nvm/*) ;;
|
|
||||||
*)
|
|
||||||
echo "bootstrap: $link was not created by this script;" >&2
|
|
||||||
echo " remove or rename it, then re-run bootstrap" >&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
fi
|
|
||||||
mkdir -p "$BIN_DIR"
|
|
||||||
ln -sf "$1" "$link"
|
|
||||||
}
|
|
||||||
|
|
||||||
# nvm is a bash script; run a command in a bash with nvm loaded
|
# nvm is a bash script; run a command in a bash with nvm loaded
|
||||||
nvm_sh() {
|
nvm_sh() {
|
||||||
bash -c ". \"\$HOME/.nvm/nvm.sh\" && $*"
|
bash -c ". \"\$HOME/.nvm/nvm.sh\" && $*"
|
||||||
@@ -140,117 +103,39 @@ ensure_node() {
|
|||||||
if ! missing node; then return 0; fi
|
if ! missing node; then return 0; fi
|
||||||
ensure_nvm
|
ensure_nvm
|
||||||
nvm_sh "nvm install $NODE_VERSION"
|
nvm_sh "nvm install $NODE_VERSION"
|
||||||
link_bin "$HOME/.nvm/versions/node/v$NODE_VERSION/bin/node" node
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# ensure_yarn: corepack writes its shims (pnpm and yarnpkg as well as
|
|
||||||
# yarn) into $TOOLCHAIN rather than next to itself, and the npm fallback
|
|
||||||
# installs there too; only yarn is linked.
|
|
||||||
ensure_yarn() {
|
ensure_yarn() {
|
||||||
if ! missing yarn; then return 0; fi
|
if ! missing yarn; then return 0; fi
|
||||||
shims="$TOOLCHAIN/corepack-shims"
|
|
||||||
mkdir -p "$shims"
|
|
||||||
if ! missing corepack; then
|
if ! missing corepack; then
|
||||||
corepack enable --install-directory "$shims"
|
corepack enable
|
||||||
corepack prepare "yarn@$YARN_VERSION" --activate
|
corepack prepare "yarn@$YARN_VERSION" --activate
|
||||||
elif [ -s "$HOME/.nvm/nvm.sh" ]; then
|
elif [ -s "$HOME/.nvm/nvm.sh" ]; then
|
||||||
nvm_sh "nvm use $NODE_VERSION >/dev/null && \
|
nvm_sh "nvm use $NODE_VERSION >/dev/null && corepack enable && \
|
||||||
corepack enable --install-directory \"$shims\" && \
|
|
||||||
corepack prepare yarn@$YARN_VERSION --activate"
|
corepack prepare yarn@$YARN_VERSION --activate"
|
||||||
else
|
else
|
||||||
npm install -g --prefix "$TOOLCHAIN/npm-global" "yarn@$YARN_VERSION"
|
npm install -g "yarn@$YARN_VERSION"
|
||||||
shims="$TOOLCHAIN/npm-global/bin"
|
|
||||||
fi
|
fi
|
||||||
link_bin "$shims/yarn" yarn
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# go_ok: the go on PATH has its gofmt beside it (a Go release ships the
|
install_js_deps() {
|
||||||
# two together) and is at least the version backend/go.mod asks for.
|
if missing yarn && [ -s "$HOME/.nvm/nvm.sh" ]; then
|
||||||
# GOTOOLCHAIN=local makes an older go fail here instead of fetching a
|
nvm_sh "nvm use $NODE_VERSION >/dev/null && cd \"$ROOT\" && \
|
||||||
# newer toolchain for itself.
|
yarn install --frozen-lockfile"
|
||||||
go_ok() {
|
else
|
||||||
if missing go; then return 1; fi
|
yarn install --frozen-lockfile
|
||||||
[ -x "$(dirname "$(command -v go)")/gofmt" ] || return 1
|
|
||||||
(cd "$ROOT/backend" && GOTOOLCHAIN=local go list -m >/dev/null 2>&1)
|
|
||||||
}
|
|
||||||
|
|
||||||
# ensure_go: unless go_ok, install GO_VERSION and link its go and gofmt.
|
|
||||||
# They are linked on every run that needs them, so a deleted link is put
|
|
||||||
# back, and the archive is unpacked again if either binary is missing.
|
|
||||||
ensure_go() {
|
|
||||||
if go_ok; then return 0; fi
|
|
||||||
go_dir="$TOOLCHAIN/go-$GO_VERSION"
|
|
||||||
if [ ! -x "$go_dir/bin/go" ] || [ ! -x "$go_dir/bin/gofmt" ]; then
|
|
||||||
# sha256 of each archive, from https://go.dev/dl/?mode=json
|
|
||||||
case "$(uname -s)-$(uname -m)" in
|
|
||||||
Linux-x86_64)
|
|
||||||
plat="linux-amd64"
|
|
||||||
sha="12e6d6a191091ae27dc31f6efc630e3a3b8ba409baf3573d955b196fdf086005"
|
|
||||||
;;
|
|
||||||
Linux-aarch64)
|
|
||||||
plat="linux-arm64"
|
|
||||||
sha="ba611a53534135a81067240eff9508cd7e256c560edd5d8c2fef54f083c07129"
|
|
||||||
;;
|
|
||||||
Darwin-x86_64)
|
|
||||||
plat="darwin-amd64"
|
|
||||||
sha="bf5050a2152f4053837b886e8d9640c829dbacbc3370f913351eb0904cb706f5"
|
|
||||||
;;
|
|
||||||
Darwin-arm64)
|
|
||||||
plat="darwin-arm64"
|
|
||||||
sha="ff18369ffad05c57d5bed888b660b31385f3c913670a83ef557cdfd98ea9ae1b"
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
echo "bootstrap: no pinned Go release for this platform" >&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
if missing curl; then pkg_install curl curl curl curl; fi
|
|
||||||
mkdir -p "$TOOLCHAIN"
|
|
||||||
curl -fsSL -o "$go_dir.tar.gz" \
|
|
||||||
"https://go.dev/dl/go$GO_VERSION.$plat.tar.gz"
|
|
||||||
verify_sha256 "$go_dir.tar.gz" "$sha"
|
|
||||||
# Unpacked beside its final place and then moved there, so an
|
|
||||||
# interrupted run never leaves a partial Go that looks complete.
|
|
||||||
rm -rf "$go_dir.partial"
|
|
||||||
mkdir "$go_dir.partial"
|
|
||||||
tar -xzf "$go_dir.tar.gz" -C "$go_dir.partial" --strip-components=1
|
|
||||||
rm -rf "$go_dir" "$go_dir.tar.gz"
|
|
||||||
mv "$go_dir.partial" "$go_dir"
|
|
||||||
fi
|
fi
|
||||||
link_bin "$go_dir/bin/go" go
|
|
||||||
link_bin "$go_dir/bin/gofmt" gofmt
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|
||||||
# Tools linked on an earlier run count as installed, and tools linked
|
|
||||||
# on this run are found by the steps after it.
|
|
||||||
path_hint=""
|
|
||||||
case ":$PATH:" in
|
|
||||||
*":$BIN_DIR:"*) ;;
|
|
||||||
*) path_hint=yes ;;
|
|
||||||
esac
|
|
||||||
PATH="$BIN_DIR:$PATH"
|
|
||||||
|
|
||||||
if missing make; then pkg_install gnumake make make make; fi
|
if missing make; then pkg_install gnumake make make make; fi
|
||||||
if missing git; then pkg_install git git git git; fi
|
if missing git; then pkg_install git git git git; fi
|
||||||
|
|
||||||
ensure_node
|
ensure_node
|
||||||
ensure_yarn
|
ensure_yarn
|
||||||
yarn install --frozen-lockfile
|
install_js_deps
|
||||||
|
|
||||||
ensure_go
|
|
||||||
(cd "$ROOT/backend" && go mod download)
|
|
||||||
|
|
||||||
if missing docker; then
|
|
||||||
echo "bootstrap: docker not found; make lint, and so make check" >&2
|
|
||||||
echo " and the pre-commit hook, need it to run the Go linter" >&2
|
|
||||||
fi
|
|
||||||
if [ -n "$path_hint" ] && [ -d "$BIN_DIR" ]; then
|
|
||||||
echo "bootstrap: add $BIN_DIR to the front of your PATH, e.g." >&2
|
|
||||||
echo " export PATH=\"\$HOME/.local/bin:\$PATH\"" >&2
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "bootstrap complete"
|
echo "bootstrap complete"
|
||||||
}
|
}
|
||||||
|
|||||||
+3
-5
@@ -1,15 +1,13 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build: build the one image from Dockerfile,
|
# script/cibuild: run the CI build. The Dockerfile runs make check, so
|
||||||
# whose stages run the checks as build steps (the backend's fmt-check,
|
# a successful build implies all checks pass.
|
||||||
# lint and tests, and the frontend's test, lint and fmt-check). This is
|
|
||||||
# the only build step the Gitea workflow runs.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
timeout 300 docker build .
|
docker build .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+2
-13
@@ -1,8 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the Docker image tagged with the project name.
|
||||||
# Identical in all repos; the tag comes from script/projectname.
|
# The tag comes from script/projectname.
|
||||||
# --no-cache because the gate phases the final stage depends on are RUN
|
|
||||||
# steps, and a cached one is a check that did not run.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -10,16 +8,7 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Own line: a failing command substitution inside an argument does
|
timeout 300 docker build -t "$("$SCRIPT_DIR/projectname")" .
|
||||||
# not trip `set -e`, so the inline form degrades silently to an
|
|
||||||
# empty constant. VERSION is computed here because .dockerignore
|
|
||||||
# excludes .git, so `git describe` in a build stage yields an empty
|
|
||||||
# version without failing.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
|
||||||
[ -n "$version" ] || version="unknown"
|
|
||||||
docker build --no-cache \
|
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+2
-4
@@ -1,14 +1,12 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/fmt: format the whole repo (writes): prettier over everything
|
# script/fmt: format all files (writes).
|
||||||
# it understands, then gofmt over the Go backend.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
"$ROOT/script/frontend-fmt"
|
yarn prettier --write .
|
||||||
"$ROOT/backend/script/fmt"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+3
-4
@@ -1,14 +1,13 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/fmt-check: check formatting across the whole repo (read-only).
|
# script/fmt-check: check formatting (read-only). Same scope as
|
||||||
# Same scope as script/fmt, but fails instead of writing.
|
# script/fmt, but fails instead of writing.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
"$ROOT/script/frontend-fmt-check"
|
yarn prettier --check .
|
||||||
"$ROOT/backend/script/fmt-check"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-check: run the frontend half of the checks only (test,
|
|
||||||
# lint, fmt-check). This exists for the frontend stage of Dockerfile, a
|
|
||||||
# node image with neither Go nor Docker; the Dockerfile's lint and
|
|
||||||
# backend build stages gate the backend half. Everywhere else, use
|
|
||||||
# script/check, which covers the whole repo. Must not modify any files.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
"$ROOT/script/frontend-test"
|
|
||||||
"$ROOT/script/frontend-lint"
|
|
||||||
"$ROOT/script/frontend-fmt-check"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-fmt: format the frontend and every other file prettier
|
|
||||||
# understands, repo-wide (writes). backend/ is in .prettierignore; Go
|
|
||||||
# sources are formatted by backend/script/fmt.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
yarn prettier --write .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-fmt-check: check prettier formatting (read-only). Same
|
|
||||||
# scope as script/frontend-fmt, but fails instead of writing.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
yarn prettier --check .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-lint: run the frontend linter (prettier in check mode).
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
yarn prettier --check .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-test: run the frontend test suite. The frontend has no
|
|
||||||
# unit tests; the production build serves as the test (fails on broken
|
|
||||||
# code).
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
timeout 30 yarn build
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/frontend-viewport-test: verify the responsive layout of the built
|
|
||||||
# frontend in a real browser engine.
|
|
||||||
#
|
|
||||||
# Builds dist/, serves it with the same nginx image and the same nginx.conf
|
|
||||||
# the shipping container uses, points a containerised headless Chrome at it
|
|
||||||
# over CDP, and asserts on computed layout at every viewport width derived
|
|
||||||
# from the app's own CSS. See test/viewport/README.md for what this covers
|
|
||||||
# and what it cannot.
|
|
||||||
#
|
|
||||||
# Deliberately not part of script/check: it needs Docker and takes far
|
|
||||||
# longer than the 20s budget make test has to stay inside.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
# chromedp/headless-shell 151.0.7922.109, 2026-08-09
|
|
||||||
BROWSER_IMAGE="chromedp/headless-shell@sha256:2d349b544a1ea6b5b5fd7c0fe99215ff662339c57407ee2e8c0a11af93516b04"
|
|
||||||
# nginx:stable-alpine, 2026-02-22 (the digest Dockerfile ships)
|
|
||||||
SERVER_IMAGE="nginx@sha256:15e96e59aa3b0aada3a121296e3bce117721f42d88f5f64217ef4b18f458c6ab"
|
|
||||||
# node:22-alpine, 2026-02-22 (the digest Dockerfile builds with)
|
|
||||||
NODE_IMAGE="node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34"
|
|
||||||
|
|
||||||
RUN_ID="$$-$(date +%s)"
|
|
||||||
NETWORK="netwatch-viewport-$RUN_ID"
|
|
||||||
SERVER="netwatch-viewport-server-$RUN_ID"
|
|
||||||
BROWSER="netwatch-viewport-browser-$RUN_ID"
|
|
||||||
HARNESS="netwatch-viewport-harness-$RUN_ID"
|
|
||||||
ARTIFACT_DIR="$ROOT/tmp/viewport"
|
|
||||||
|
|
||||||
# Every container is named and removed here, including the harness itself:
|
|
||||||
# `timeout` below kills the `docker run` client, not the container it
|
|
||||||
# started, and an unnamed survivor keeps the --internal network in use so
|
|
||||||
# `docker network rm` fails too. This host runs many sessions at once and
|
|
||||||
# neither may be left behind.
|
|
||||||
cleanup() {
|
|
||||||
docker rm -f "$HARNESS" > /dev/null 2>&1 || true
|
|
||||||
docker rm -f "$BROWSER" > /dev/null 2>&1 || true
|
|
||||||
docker rm -f "$SERVER" > /dev/null 2>&1 || true
|
|
||||||
docker network rm "$NETWORK" > /dev/null 2>&1 || true
|
|
||||||
}
|
|
||||||
trap cleanup EXIT INT TERM
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
|
|
||||||
# Test what ships: the production build, not a dev server.
|
|
||||||
"$ROOT/script/frontend-test"
|
|
||||||
if [ ! -f "$ROOT/dist/index.html" ]; then
|
|
||||||
echo "frontend-viewport-test: dist/index.html missing after build" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
mkdir -p "$ARTIFACT_DIR"
|
|
||||||
|
|
||||||
# An --internal network has no route off the host, so the browser
|
|
||||||
# cannot reach the real internet no matter what the page asks for.
|
|
||||||
# Latency probes are answered by the harness instead. This also means
|
|
||||||
# no port can be published from it, which is why the harness itself
|
|
||||||
# runs as a third container on the same network rather than on the
|
|
||||||
# host.
|
|
||||||
docker network create --internal "$NETWORK" > /dev/null
|
|
||||||
|
|
||||||
docker run -d --rm --name "$SERVER" \
|
|
||||||
--network "$NETWORK" --network-alias netwatch \
|
|
||||||
-v "$ROOT/dist:/usr/share/nginx/html:ro" \
|
|
||||||
-v "$ROOT/nginx.conf:/etc/nginx/conf.d/default.conf:ro" \
|
|
||||||
"$SERVER_IMAGE" > /dev/null
|
|
||||||
|
|
||||||
# The image's own entrypoint already exposes CDP on 9222 and passes
|
|
||||||
# --no-sandbox, so only extra flags belong here; re-specifying the
|
|
||||||
# debugging port collides with it and leaves the endpoint bound to
|
|
||||||
# loopback only. --hide-scrollbars keeps innerWidth equal to
|
|
||||||
# clientWidth, so the overflow assertion has no scrollbar-sized slack
|
|
||||||
# to hide behind, and matches the overlay scrollbars phones use.
|
|
||||||
docker run -d --rm --name "$BROWSER" --init --shm-size=1g \
|
|
||||||
--network "$NETWORK" \
|
|
||||||
"$BROWSER_IMAGE" \
|
|
||||||
--hide-scrollbars \
|
|
||||||
> /dev/null
|
|
||||||
|
|
||||||
# Chrome refuses DevTools requests whose Host header is neither
|
|
||||||
# localhost nor an IP address, so dial the container by address rather
|
|
||||||
# than by its network alias.
|
|
||||||
browser_ip="$(docker inspect \
|
|
||||||
-f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' \
|
|
||||||
"$BROWSER")"
|
|
||||||
|
|
||||||
timeout 900 docker run --rm --init --name "$HARNESS" \
|
|
||||||
--network "$NETWORK" \
|
|
||||||
--user "$(id -u):$(id -g)" \
|
|
||||||
-v "$ROOT:/app" \
|
|
||||||
-w /app \
|
|
||||||
-e NETWATCH_ROOT=/app \
|
|
||||||
-e NETWATCH_BASE_URL=http://netwatch:8080 \
|
|
||||||
-e "NETWATCH_CDP_URL=http://$browser_ip:9222" \
|
|
||||||
-e NETWATCH_ARTIFACT_DIR=/app/tmp/viewport \
|
|
||||||
"$NODE_IMAGE" \
|
|
||||||
node test/viewport/harness.js
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
+2
-11
@@ -1,21 +1,12 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: lint the whole repo: prettier over the frontend, then the
|
# script/lint: run the linter (prettier in check mode).
|
||||||
# Go linter over backend/.
|
|
||||||
#
|
|
||||||
# The Go linter runs only in Docker: this builds the lint stage of
|
|
||||||
# Dockerfile, the digest-pinned golangci-lint image, which runs the
|
|
||||||
# backend's fmt-check and lint targets. --no-cache makes the linter
|
|
||||||
# really run every time rather than reuse an earlier result, and the
|
|
||||||
# stage is built for its checks alone, so no image is kept.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
"$ROOT/script/frontend-lint"
|
yarn prettier --check .
|
||||||
timeout 300 docker build --no-cache --target lint \
|
|
||||||
--output type=cacheonly .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+3
-4
@@ -1,14 +1,13 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test: run the test suite for the whole repo: the frontend at
|
# script/test: run the test suite. This repo has no unit tests; the
|
||||||
# the repo root, then the Go backend in backend/. Both halves together
|
# production build serves as the test (fails on broken code).
|
||||||
# get 30 seconds; each also keeps its own limit for the Dockerfiles.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
timeout 30 sh -c 'script/frontend-test && backend/script/test'
|
timeout 30 yarn build
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+57
-214
@@ -7,11 +7,9 @@ import "./styles.css";
|
|||||||
// graphMaxLatency — values above it pin to the top of the chart but still
|
// graphMaxLatency — values above it pin to the top of the chart but still
|
||||||
// display their real value in the latency figure. The history buffer holds
|
// display their real value in the latency figure. The history buffer holds
|
||||||
// maxHistoryPoints samples (historyDuration / updateInterval).
|
// maxHistoryPoints samples (historyDuration / updateInterval).
|
||||||
// reportInterval is how often collected samples are POSTed to the backend.
|
|
||||||
const CONFIG = {
|
const CONFIG = {
|
||||||
updateInterval: 3000,
|
updateInterval: 3000,
|
||||||
maxHistoryPoints: 100,
|
maxHistoryPoints: 100,
|
||||||
reportInterval: 60000,
|
|
||||||
get historyDuration() {
|
get historyDuration() {
|
||||||
return (this.maxHistoryPoints * this.updateInterval) / 1000;
|
return (this.maxHistoryPoints * this.updateInterval) / 1000;
|
||||||
},
|
},
|
||||||
@@ -348,159 +346,6 @@ class AppState {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Reporting ---------------------------------------------------------------
|
|
||||||
|
|
||||||
// A random UUIDv4. `crypto.randomUUID` exists only in secure contexts
|
|
||||||
// (HTTPS or localhost); over plain HTTP to any other host — the normal LAN
|
|
||||||
// deployment — it is undefined, so feature-detect it and otherwise build the
|
|
||||||
// id from `crypto.getRandomValues`, which is available in insecure contexts.
|
|
||||||
function randomId() {
|
|
||||||
if (typeof crypto !== "undefined" && crypto.randomUUID) {
|
|
||||||
return crypto.randomUUID();
|
|
||||||
}
|
|
||||||
const bytes = new Uint8Array(16);
|
|
||||||
crypto.getRandomValues(bytes);
|
|
||||||
bytes[6] = (bytes[6] & 0x0f) | 0x40; // version 4
|
|
||||||
bytes[8] = (bytes[8] & 0x3f) | 0x80; // variant 1
|
|
||||||
const hex = [...bytes].map((b) => b.toString(16).padStart(2, "0"));
|
|
||||||
return (
|
|
||||||
hex.slice(0, 4).join("") +
|
|
||||||
"-" +
|
|
||||||
hex.slice(4, 6).join("") +
|
|
||||||
"-" +
|
|
||||||
hex.slice(6, 8).join("") +
|
|
||||||
"-" +
|
|
||||||
hex.slice(8, 10).join("") +
|
|
||||||
"-" +
|
|
||||||
hex.slice(10, 16).join("")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// A random id identifying this browser across reports. Generated once and
|
|
||||||
// kept in localStorage; if storage is unavailable (e.g. private mode) a
|
|
||||||
// fresh id is used for this session only.
|
|
||||||
function getClientId() {
|
|
||||||
const key = "netwatch-client-id";
|
|
||||||
try {
|
|
||||||
let id = localStorage.getItem(key);
|
|
||||||
if (!id) {
|
|
||||||
id = randomId();
|
|
||||||
localStorage.setItem(key, id);
|
|
||||||
}
|
|
||||||
return id;
|
|
||||||
} catch {
|
|
||||||
return randomId();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build the delta report body the backend decodes, plus the new per-host
|
|
||||||
// high-water marks. Pure function of the passed state: `hosts` is an array
|
|
||||||
// of { name, url, status, history }, `since` maps a host url to the Unix-ms
|
|
||||||
// timestamp of the last sample already reported for it, and `now` is a Date.
|
|
||||||
// Only non-paused samples newer than the mark are included. Returns null
|
|
||||||
// when no host has an unreported sample.
|
|
||||||
export function buildReport(hosts, clientId, now, since) {
|
|
||||||
const reportHosts = [];
|
|
||||||
const marks = new Map();
|
|
||||||
for (const host of hosts) {
|
|
||||||
const mark = since.get(host.url) ?? 0;
|
|
||||||
const samples = [];
|
|
||||||
let high = mark;
|
|
||||||
for (const p of host.history) {
|
|
||||||
if (p.paused) continue;
|
|
||||||
if (p.timestamp <= mark) continue;
|
|
||||||
samples.push({
|
|
||||||
t: p.timestamp,
|
|
||||||
latency: p.latency,
|
|
||||||
error: p.error ?? null,
|
|
||||||
});
|
|
||||||
if (p.timestamp > high) high = p.timestamp;
|
|
||||||
}
|
|
||||||
if (samples.length === 0) continue;
|
|
||||||
reportHosts.push({
|
|
||||||
name: host.name,
|
|
||||||
url: host.url,
|
|
||||||
status: host.status,
|
|
||||||
history: samples,
|
|
||||||
});
|
|
||||||
marks.set(host.url, high);
|
|
||||||
}
|
|
||||||
if (reportHosts.length === 0) return null;
|
|
||||||
return {
|
|
||||||
body: {
|
|
||||||
clientId,
|
|
||||||
geo: null,
|
|
||||||
hosts: reportHosts,
|
|
||||||
timestamp: now.toISOString(),
|
|
||||||
},
|
|
||||||
marks,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// Periodically POSTs unreported samples to the same-origin backend. Holds
|
|
||||||
// the per-host high-water marks so each report is a delta; marks only
|
|
||||||
// advance on a delivered report, so a failed POST simply re-sends those
|
|
||||||
// samples next interval (bounded by the history window — whatever has since
|
|
||||||
// fallen out is dropped). Failure is quiet: one debug line per outage, one
|
|
||||||
// on recovery, never an alert, never a tight retry loop.
|
|
||||||
//
|
|
||||||
// Only one report is ever in flight, and it is abandoned after half the
|
|
||||||
// interval, so a slow POST can neither overlap the next report (which would
|
|
||||||
// carry the same samples) nor stall reporting for good.
|
|
||||||
class Reporter {
|
|
||||||
constructor(state, clientId, intervalMs) {
|
|
||||||
this.state = state;
|
|
||||||
this.clientId = clientId;
|
|
||||||
this.intervalMs = intervalMs;
|
|
||||||
this.marks = new Map();
|
|
||||||
this.failing = false;
|
|
||||||
this.sending = false;
|
|
||||||
this.timerId = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
start() {
|
|
||||||
if (this.timerId) return;
|
|
||||||
this.timerId = setInterval(() => this.flush(), this.intervalMs);
|
|
||||||
}
|
|
||||||
|
|
||||||
async flush() {
|
|
||||||
if (this.sending || this.state.paused) return;
|
|
||||||
const report = buildReport(
|
|
||||||
this.state.allHosts,
|
|
||||||
this.clientId,
|
|
||||||
new Date(),
|
|
||||||
this.marks,
|
|
||||||
);
|
|
||||||
if (!report) return;
|
|
||||||
this.sending = true;
|
|
||||||
try {
|
|
||||||
const resp = await fetch("/api/v1/reports", {
|
|
||||||
method: "POST",
|
|
||||||
headers: { "Content-Type": "application/json" },
|
|
||||||
credentials: "omit",
|
|
||||||
body: JSON.stringify(report.body),
|
|
||||||
signal: AbortSignal.timeout(this.intervalMs / 2),
|
|
||||||
});
|
|
||||||
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
|
|
||||||
for (const [url, t] of report.marks) {
|
|
||||||
const current = this.marks.get(url) ?? 0;
|
|
||||||
this.marks.set(url, Math.max(current, t));
|
|
||||||
}
|
|
||||||
if (this.failing) {
|
|
||||||
log.debug("Report delivery recovered");
|
|
||||||
this.failing = false;
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
if (!this.failing) {
|
|
||||||
log.debug(`Report delivery failed: ${err.message}`);
|
|
||||||
this.failing = true;
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
this.sending = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Latency Measurement -----------------------------------------------------
|
// --- Latency Measurement -----------------------------------------------------
|
||||||
|
|
||||||
async function measureLatency(url) {
|
async function measureLatency(url) {
|
||||||
@@ -692,12 +537,6 @@ class SparklineRenderer {
|
|||||||
|
|
||||||
// --- UI Renderer -------------------------------------------------------------
|
// --- UI Renderer -------------------------------------------------------------
|
||||||
|
|
||||||
// The per-host status line must stay wrappable: its populated content is
|
|
||||||
// wider than the host column at a 320px viewport, and `whitespace-nowrap`
|
|
||||||
// here overflows the element and forces the whole document to scroll
|
|
||||||
// horizontally.
|
|
||||||
const STATUS_TEXT_CLASS = "status-text text-xs text-right col-span-2 mt-5";
|
|
||||||
|
|
||||||
function hostRowHTML(host, index, showPin = true) {
|
function hostRowHTML(host, index, showPin = true) {
|
||||||
const pinColor = host.pinned
|
const pinColor = host.pinned
|
||||||
? "text-blue-500"
|
? "text-blue-500"
|
||||||
@@ -723,7 +562,7 @@ function hostRowHTML(host, index, showPin = true) {
|
|||||||
<span class="text-gray-500">---</span>
|
<span class="text-gray-500">---</span>
|
||||||
</div>
|
</div>
|
||||||
<a href="${host.url}" target="_blank" rel="noopener" class="text-xs text-gray-500 truncate block col-span-2 -mt-2">${host.url}</a>
|
<a href="${host.url}" target="_blank" rel="noopener" class="text-xs text-gray-500 truncate block col-span-2 -mt-2">${host.url}</a>
|
||||||
<div class="${STATUS_TEXT_CLASS} text-gray-500" data-host="${index}">waiting...</div>
|
<div class="status-text text-xs text-gray-500 whitespace-nowrap text-right col-span-2 mt-5" data-host="${index}">waiting...</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="flex-grow sparkline-container rounded overflow-hidden border border-gray-700/30">
|
<div class="flex-grow sparkline-container rounded overflow-hidden border border-gray-700/30">
|
||||||
<canvas class="sparkline-canvas w-full" data-host="${index}" height="${CONFIG.canvasHeight}"></canvas>
|
<canvas class="sparkline-canvas w-full" data-host="${index}" height="${CONFIG.canvasHeight}"></canvas>
|
||||||
@@ -832,7 +671,7 @@ function buildUI(state) {
|
|||||||
</p>
|
</p>
|
||||||
<p class="mt-2"><a href="https://git.eeqj.de/sneak/netwatch/commit/${__COMMIT_FULL__}" target="_blank" rel="noopener" class="text-gray-600 hover:text-gray-400">${__COMMIT_HASH__}</a></p>
|
<p class="mt-2"><a href="https://git.eeqj.de/sneak/netwatch/commit/${__COMMIT_FULL__}" target="_blank" rel="noopener" class="text-gray-600 hover:text-gray-400">${__COMMIT_HASH__}</a></p>
|
||||||
<p class="mt-2">
|
<p class="mt-2">
|
||||||
<label class="debug-toggle-label cursor-pointer">
|
<label class="cursor-pointer">
|
||||||
<input type="checkbox" id="debug-toggle" class="mr-1">
|
<input type="checkbox" id="debug-toggle" class="mr-1">
|
||||||
<span>Debug log</span>
|
<span>Debug log</span>
|
||||||
</label>
|
</label>
|
||||||
@@ -849,26 +688,6 @@ function buildUI(state) {
|
|||||||
|
|
||||||
// --- UI Updaters -------------------------------------------------------------
|
// --- UI Updaters -------------------------------------------------------------
|
||||||
|
|
||||||
// Renders `min 1ms / med 2ms / avg 3ms / max 4ms`. Each label, value and
|
|
||||||
// trailing separator is one unbreakable unit, so wrapping only ever happens
|
|
||||||
// between stats and a wrapped line never starts with a separator.
|
|
||||||
function statusStatsHTML(stats) {
|
|
||||||
return stats
|
|
||||||
.map(([label, value], i) => {
|
|
||||||
const sep =
|
|
||||||
i < stats.length - 1
|
|
||||||
? ` <span class="text-gray-500">/</span>`
|
|
||||||
: "";
|
|
||||||
return (
|
|
||||||
`<span class="whitespace-nowrap">` +
|
|
||||||
`<span class="text-gray-400">${label} </span>` +
|
|
||||||
`<span class="${latencyClass(value, "online")}">${value}ms</span>` +
|
|
||||||
`${sep}</span>`
|
|
||||||
);
|
|
||||||
})
|
|
||||||
.join(" ");
|
|
||||||
}
|
|
||||||
|
|
||||||
function updateHostRow(host, index) {
|
function updateHostRow(host, index) {
|
||||||
const latencyEl = document.querySelector(
|
const latencyEl = document.querySelector(
|
||||||
`.latency-value[data-host="${index}"]`,
|
`.latency-value[data-host="${index}"]`,
|
||||||
@@ -893,22 +712,28 @@ function updateHostRow(host, index) {
|
|||||||
const min = host.minLatency();
|
const min = host.minLatency();
|
||||||
const max = host.maxLatency();
|
const max = host.maxLatency();
|
||||||
if (host.status === "online" && avg !== null) {
|
if (host.status === "online" && avg !== null) {
|
||||||
statusEl.innerHTML = statusStatsHTML([
|
statusEl.innerHTML =
|
||||||
["min", min],
|
`<span class="text-gray-400">min </span><span class="${latencyClass(min, "online")}">${min}ms</span>` +
|
||||||
["med", med],
|
` <span class="text-gray-500">/</span> ` +
|
||||||
["avg", avg],
|
`<span class="text-gray-400">med </span><span class="${latencyClass(med, "online")}">${med}ms</span>` +
|
||||||
["max", max],
|
` <span class="text-gray-500">/</span> ` +
|
||||||
]);
|
`<span class="text-gray-400">avg </span><span class="${latencyClass(avg, "online")}">${avg}ms</span>` +
|
||||||
statusEl.className = STATUS_TEXT_CLASS;
|
` <span class="text-gray-500">/</span> ` +
|
||||||
|
`<span class="text-gray-400">max </span><span class="${latencyClass(max, "online")}">${max}ms</span>`;
|
||||||
|
statusEl.className =
|
||||||
|
"status-text text-xs whitespace-nowrap text-right col-span-2 mt-5";
|
||||||
} else if (host.status === "offline") {
|
} else if (host.status === "offline") {
|
||||||
statusEl.textContent = "unreachable";
|
statusEl.textContent = "unreachable";
|
||||||
statusEl.className = `${STATUS_TEXT_CLASS} text-red-400`;
|
statusEl.className =
|
||||||
|
"status-text text-xs text-red-400 whitespace-nowrap text-right col-span-2 mt-5";
|
||||||
} else if (host.status === "error") {
|
} else if (host.status === "error") {
|
||||||
statusEl.textContent = "timeout";
|
statusEl.textContent = "timeout";
|
||||||
statusEl.className = `${STATUS_TEXT_CLASS} text-orange-400`;
|
statusEl.className =
|
||||||
|
"status-text text-xs text-orange-400 whitespace-nowrap text-right col-span-2 mt-5";
|
||||||
} else {
|
} else {
|
||||||
statusEl.textContent = "connecting...";
|
statusEl.textContent = "connecting...";
|
||||||
statusEl.className = `${STATUS_TEXT_CLASS} text-gray-500`;
|
statusEl.className =
|
||||||
|
"status-text text-xs text-gray-500 whitespace-nowrap text-right col-span-2 mt-5";
|
||||||
}
|
}
|
||||||
|
|
||||||
SparklineRenderer.draw(canvas, host.history);
|
SparklineRenderer.draw(canvas, host.history);
|
||||||
@@ -1219,7 +1044,8 @@ function greyOutUI(state) {
|
|||||||
}
|
}
|
||||||
if (statusEl) {
|
if (statusEl) {
|
||||||
statusEl.textContent = "paused";
|
statusEl.textContent = "paused";
|
||||||
statusEl.className = `${STATUS_TEXT_CLASS} text-gray-500`;
|
statusEl.className =
|
||||||
|
"status-text text-xs text-gray-500 whitespace-nowrap text-right col-span-2 mt-5";
|
||||||
}
|
}
|
||||||
// Grey out the status dot
|
// Grey out the status dot
|
||||||
const row = document.querySelector(`.host-row[data-index="${i}"]`);
|
const row = document.querySelector(`.host-row[data-index="${i}"]`);
|
||||||
@@ -1300,11 +1126,46 @@ function handleResize(state) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Mobile Detection --------------------------------------------------------
|
||||||
|
|
||||||
|
const MOBILE_BREAKPOINT = 768;
|
||||||
|
|
||||||
|
function isMobileViewport() {
|
||||||
|
return window.innerWidth < MOBILE_BREAKPOINT;
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildMobileUI() {
|
||||||
|
const app = document.getElementById("app");
|
||||||
|
app.innerHTML = `
|
||||||
|
<div class="mx-auto px-[5%] py-8">
|
||||||
|
<header class="mb-8">
|
||||||
|
<h1 class="text-3xl font-bold text-white"><a href="https://git.eeqj.de/sneak/netwatch" target="_blank" rel="noopener" class="underline decoration-dashed decoration-gray-500 underline-offset-4">NetWatch</a> by <a href="https://sneak.berlin" target="_blank" rel="noopener" class="text-blue-400 underline hover:text-blue-300">@sneak</a></h1>
|
||||||
|
<p class="text-gray-400 text-sm mt-2">Real-time network latency monitor</p>
|
||||||
|
</header>
|
||||||
|
<div class="flex items-center justify-center min-h-[60vh]">
|
||||||
|
<div class="bg-gray-800/70 border border-gray-700/50 rounded-lg p-8 max-w-md text-center">
|
||||||
|
<p class="text-4xl mb-4">📡</p>
|
||||||
|
<p class="text-xl font-semibold text-white mb-2">Not yet available on mobile</p>
|
||||||
|
<p class="text-gray-400 text-sm">NetWatch requires a wider viewport to display latency charts and monitoring data. Please visit on a desktop browser.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer class="mt-8 text-center text-gray-600 text-xs">
|
||||||
|
<p><a href="https://git.eeqj.de/sneak/netwatch/commit/${__COMMIT_FULL__}" target="_blank" rel="noopener" class="text-gray-600 hover:text-gray-400">${__COMMIT_HASH__}</a></p>
|
||||||
|
</footer>
|
||||||
|
</div>`;
|
||||||
|
}
|
||||||
|
|
||||||
// --- Bootstrap ---------------------------------------------------------------
|
// --- Bootstrap ---------------------------------------------------------------
|
||||||
|
|
||||||
async function init() {
|
async function init() {
|
||||||
log.info("NetWatch starting");
|
log.info("NetWatch starting");
|
||||||
|
|
||||||
|
if (isMobileViewport()) {
|
||||||
|
log.info("Mobile viewport detected — skipping monitoring");
|
||||||
|
buildMobileUI();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// Probe common gateway IPs to find the local router
|
// Probe common gateway IPs to find the local router
|
||||||
const gateway = await detectGateway();
|
const gateway = await detectGateway();
|
||||||
const localHosts = [LOCAL_CPE];
|
const localHosts = [LOCAL_CPE];
|
||||||
@@ -1317,19 +1178,6 @@ async function init() {
|
|||||||
buildUI(state);
|
buildUI(state);
|
||||||
log.info("UI built, starting tick loop");
|
log.info("UI built, starting tick loop");
|
||||||
|
|
||||||
// Reporting is best-effort: any failure setting it up (e.g. no usable
|
|
||||||
// crypto for the client id) must never stop the monitor from probing.
|
|
||||||
try {
|
|
||||||
const reporter = new Reporter(
|
|
||||||
state,
|
|
||||||
getClientId(),
|
|
||||||
CONFIG.reportInterval,
|
|
||||||
);
|
|
||||||
reporter.start();
|
|
||||||
} catch (err) {
|
|
||||||
log.error(`Reporting disabled: ${err.message}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
document
|
document
|
||||||
.getElementById("pause-btn")
|
.getElementById("pause-btn")
|
||||||
.addEventListener("click", () => togglePause(state));
|
.addEventListener("click", () => togglePause(state));
|
||||||
@@ -1442,13 +1290,8 @@ async function init() {
|
|||||||
setTimeout(() => handleResize(state), 100);
|
setTimeout(() => handleResize(state), 100);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Bootstrap only when loaded as the page: a real DOM containing the #app
|
if (document.readyState === "loading") {
|
||||||
// mount point this module renders into. Importing the module in a unit test
|
|
||||||
// (which has no #app) runs nothing, so buildReport can be tested in isolation.
|
|
||||||
if (typeof document !== "undefined" && document.getElementById("app")) {
|
|
||||||
if (document.readyState === "loading") {
|
|
||||||
document.addEventListener("DOMContentLoaded", init);
|
document.addEventListener("DOMContentLoaded", init);
|
||||||
} else {
|
} else {
|
||||||
init();
|
init();
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-34
@@ -14,38 +14,6 @@ body {
|
|||||||
ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace;
|
ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ---- Minimum tap targets ----------------------------------------------
|
|
||||||
Every interactive control is at least 44x44 CSS px (Apple HIG, WCAG 2.2
|
|
||||||
SC 2.5.5). Not scoped to a breakpoint or to `pointer: coarse`: a large
|
|
||||||
phone in landscape is above the 768px breakpoint and still a touch
|
|
||||||
device. */
|
|
||||||
|
|
||||||
/* The button grows to 44x44 while the negative margins keep its layout
|
|
||||||
footprint at the 16x16 of the icon inside it, so row height and the
|
|
||||||
icon's position are unchanged. */
|
|
||||||
.pin-btn {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
width: 2.75rem;
|
|
||||||
height: 2.75rem;
|
|
||||||
margin: -0.875rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* A select paints its own background and border, so it has to actually be
|
|
||||||
44 tall rather than borrow the trick above. */
|
|
||||||
#interval-select {
|
|
||||||
min-height: 2.75rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* The tappable target for #debug-toggle is the label wrapping it. */
|
|
||||||
.debug-toggle-label {
|
|
||||||
display: inline-flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
min-height: 2.75rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sparkline-container {
|
.sparkline-container {
|
||||||
background: linear-gradient(
|
background: linear-gradient(
|
||||||
to bottom,
|
to bottom,
|
||||||
@@ -70,10 +38,9 @@ body {
|
|||||||
gap: 0.75rem;
|
gap: 0.75rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Pause button: smaller on mobile, but not below the tap-target floor */
|
/* Pause button: smaller on mobile */
|
||||||
#pause-btn {
|
#pause-btn {
|
||||||
padding: 0.5rem 1rem;
|
padding: 0.5rem 1rem;
|
||||||
min-height: 2.75rem;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#pause-btn svg {
|
#pause-btn svg {
|
||||||
|
|||||||
@@ -1,112 +0,0 @@
|
|||||||
# Responsive-layout harness
|
|
||||||
|
|
||||||
Automated verification of the responsive layout that landed in #5. Run it with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make frontend-viewport-test
|
|
||||||
```
|
|
||||||
|
|
||||||
It builds `dist/`, serves it from the same digest-pinned `nginx` image and the
|
|
||||||
same `nginx.conf` the shipping container uses, drives a digest-pinned headless
|
|
||||||
Chrome against it over CDP, and asserts on computed layout at every viewport
|
|
||||||
width derived from the app's own CSS. Screenshots land in `tmp/viewport/`
|
|
||||||
alongside a `results.json`; they are artifacts for a human to look at when
|
|
||||||
something fails, not the evidence. The assertions are the evidence.
|
|
||||||
|
|
||||||
The target is deliberately outside `make check`: it needs Docker and takes
|
|
||||||
minutes, and `make test` has to stay under 20 seconds.
|
|
||||||
|
|
||||||
## How the widths are chosen
|
|
||||||
|
|
||||||
Not from a list of phone models. `viewports.js` parses the `@media` conditions
|
|
||||||
out of `src/styles.css` and scans `src/main.js` and `index.html` for Tailwind
|
|
||||||
responsive prefixes, then tests every breakpoint it finds at one pixel below it,
|
|
||||||
exactly on it, and one pixel above it. A generic 375px "phone" test sails
|
|
||||||
straight past an off-by-one at a media query boundary; `max-width: 768px`
|
|
||||||
matches _at_ 768, and the sweep pins down which side of that line each layout is
|
|
||||||
on.
|
|
||||||
|
|
||||||
Nothing hardcodes 768. Add a second media block or start using `md:` classes and
|
|
||||||
the new breakpoint is covered without this directory being touched. The app is
|
|
||||||
desktop-first today (all narrow rules live in `max-width` blocks); a
|
|
||||||
`min-width`-only, mobile-first set is handled as its inverse, and a set that
|
|
||||||
mixes the two makes the run fail loudly rather than test the right widths with
|
|
||||||
the wrong expectation. Four further viewports are fixed anchors, each with a
|
|
||||||
stated reason: a 320px floor, a 1280px desktop baseline, and two phone-landscape
|
|
||||||
sizes straddling the breakpoint for the rotation case.
|
|
||||||
|
|
||||||
## What it asserts
|
|
||||||
|
|
||||||
- **app-rendered** — enough host rows exist and enough of them show a numeric
|
|
||||||
latency. This one exists so the rest cannot pass vacuously against a blank
|
|
||||||
page.
|
|
||||||
- **no-horizontal-overflow** — `documentElement.scrollWidth` fits the layout
|
|
||||||
viewport, with the widest offending element named.
|
|
||||||
- **nothing-past-viewport-edge** — no visible element's box extends past the
|
|
||||||
viewport edge.
|
|
||||||
- **no-clipped-text** — nothing hides text behind `overflow: hidden`. Deliberate
|
|
||||||
ellipsis truncation (Tailwind's `truncate`, used on host names and URLs) is
|
|
||||||
excluded: it is a design choice, not breakage.
|
|
||||||
- **tap-targets-44px** — every interactive control is at least 44x44 CSS px on
|
|
||||||
touch viewports, _and_ each selector in the control list matched at least the
|
|
||||||
number of visible elements it declares. The second half is what stops the
|
|
||||||
check passing vacuously: with size alone, a renamed class would take its
|
|
||||||
controls out of the measured set and the check would report "all 0 controls
|
|
||||||
are at least 44x44" and pass. See below.
|
|
||||||
- **host-rows-stacked / host-rows-side-by-side** — the rows genuinely reflow.
|
|
||||||
Computed `flex-direction` _and_ the actual geometry are checked, and in the
|
|
||||||
narrow layout the info block and the sparkline must each occupy essentially
|
|
||||||
the full row width. A row that merely shrank its 420px column would fail.
|
|
||||||
- **probing-still-runs / gateway-detection-still-runs** — narrow viewports keep
|
|
||||||
probing and keep detecting the gateway. The mobile early-return path proposed
|
|
||||||
in #8 was rejected; this is what would catch it coming back.
|
|
||||||
|
|
||||||
### The tap-target threshold
|
|
||||||
|
|
||||||
44x44 CSS px. That is the figure in Apple's Human Interface Guidelines and in
|
|
||||||
WCAG 2.2 SC 2.5.5 "Target Size (Enhanced)". WCAG 2.2 SC 2.5.8 (level AA) sets a
|
|
||||||
lower 24x24 floor, but that floor comes with a spacing exception these controls
|
|
||||||
do not qualify for — the pin buttons sit directly against the host name they
|
|
||||||
belong to.
|
|
||||||
|
|
||||||
## Determinism
|
|
||||||
|
|
||||||
The browser container runs on an `--internal` docker network and has no route to
|
|
||||||
the internet, so the app's latency probes cannot reach anything real. The
|
|
||||||
harness answers them itself from a fixed delay table, with a deterministic
|
|
||||||
fraction failed outright, so the rows render a realistic spread of one-, two-
|
|
||||||
and three-digit latencies plus some unreachable rows. That spread is what the
|
|
||||||
layout has to survive; 24 identical `---` placeholders would not exercise it.
|
|
||||||
|
|
||||||
## What this cannot verify
|
|
||||||
|
|
||||||
Real limits, so nobody re-parks this issue as needing hardware:
|
|
||||||
|
|
||||||
- **Non-Chromium engines.** This is Chrome. iOS Safari is WebKit and cannot be
|
|
||||||
emulated by it; Safari-specific bugs (viewport units under a collapsing URL
|
|
||||||
bar, `-webkit-fill-available`, form control metrics) will not show up here.
|
|
||||||
- **Real touch input.** `hasTouch` emulation changes what the page is told, not
|
|
||||||
how a finger behaves. Gesture handling, scroll momentum, double-tap zoom and
|
|
||||||
hover-state fallbacks on touch are out of scope.
|
|
||||||
- **Physical pixel density and rendering.** `deviceScaleFactor` is set, but
|
|
||||||
subpixel antialiasing, OLED colour rendering and actual legibility at a given
|
|
||||||
physical size are not measurable here.
|
|
||||||
- **Fonts.** The container has DejaVu, not the platform's own UI monospace. Text
|
|
||||||
metrics are therefore close to, but not identical to, a real device — a layout
|
|
||||||
that fits here by a few pixels might not there.
|
|
||||||
- **On-device performance.** Canvas sparkline redraw cost, battery, and
|
|
||||||
behaviour on a slow radio are not measured.
|
|
||||||
- **Browser chrome.** The address bar, safe-area insets and notch cutouts are
|
|
||||||
not simulated.
|
|
||||||
|
|
||||||
Everything else this issue was actually about — does the layout reflow, does
|
|
||||||
anything overflow, is content clipped, are the controls big enough — is a
|
|
||||||
function of viewport width and CSS, and is covered above.
|
|
||||||
|
|
||||||
## Relation to the unit test framework (#21)
|
|
||||||
|
|
||||||
Complementary layers, not two stacks. `vitest` (#21) will exercise module-level
|
|
||||||
logic in-process with no browser. This harness exercises rendered layout in a
|
|
||||||
real engine and is the only thing here that can see a media query. Neither
|
|
||||||
replaces the other; assertions about computed styles and element geometry belong
|
|
||||||
here, assertions about functions belong in `vitest`.
|
|
||||||
@@ -1,245 +0,0 @@
|
|||||||
// Pass/fail decisions for the responsive-layout harness.
|
|
||||||
//
|
|
||||||
// Kept in node rather than in the page so that a failure can be reported
|
|
||||||
// with the measurements that produced it. Every check runs at every
|
|
||||||
// viewport; none of them short-circuits, so one failure does not hide the
|
|
||||||
// rest.
|
|
||||||
|
|
||||||
// Minimum tap target, in CSS pixels. 44x44 is the figure in Apple's Human
|
|
||||||
// Interface Guidelines and in WCAG 2.2 SC 2.5.5 "Target Size (Enhanced)".
|
|
||||||
// WCAG 2.2 SC 2.5.8 (level AA) sets a lower 24x24 floor, but that floor
|
|
||||||
// comes with a spacing exception these controls do not qualify for: the
|
|
||||||
// pin buttons sit directly against the host name they belong to. Held at
|
|
||||||
// 44 deliberately.
|
|
||||||
export const MIN_TAP_TARGET_PX = 44;
|
|
||||||
|
|
||||||
// The controls named in the definition of done, plus the pause button.
|
|
||||||
// Each carries the smallest number of *visible* instances the page has to
|
|
||||||
// contain for the tap-target oracle to be measuring anything at all.
|
|
||||||
//
|
|
||||||
// Without those floors the check is inert: `undersized` is empty both when
|
|
||||||
// every control is large enough and when the selectors have gone stale and
|
|
||||||
// matched nothing, and the pass condition cannot tell those apart. A single
|
|
||||||
// combined floor would not be enough either — 26 pin buttons would cover
|
|
||||||
// for all three singleton controls vanishing at once — so the floor is per
|
|
||||||
// selector, and one stale selector out of four fails the check.
|
|
||||||
export const INTERACTIVE_CONTROLS = [
|
|
||||||
{ selector: "#pause-btn", minCount: 1 },
|
|
||||||
{ selector: "#interval-select", minCount: 1 },
|
|
||||||
// One per pinnable host row. `app-rendered` already requires at least
|
|
||||||
// 10 host rows, so a count below that means the pin buttons stopped
|
|
||||||
// being rendered per row rather than that there were fewer hosts.
|
|
||||||
{ selector: ".pin-btn", minCount: 10 },
|
|
||||||
{ selector: "#debug-toggle", minCount: 1 },
|
|
||||||
];
|
|
||||||
|
|
||||||
export const INTERACTIVE_SELECTORS = INTERACTIVE_CONTROLS.map(
|
|
||||||
(control) => control.selector,
|
|
||||||
);
|
|
||||||
|
|
||||||
// A host row is only "reflowed" if it stacked *and* went full width.
|
|
||||||
// A row that merely shrank its 420px info column would keep
|
|
||||||
// flex-direction: row, and a row that stacked but left the info column at
|
|
||||||
// its fixed width would fail the width test.
|
|
||||||
const FULL_WIDTH_FRACTION = 0.9;
|
|
||||||
|
|
||||||
function summarise(items, format, limit = 3) {
|
|
||||||
const shown = items.slice(0, limit).map(format).join("; ");
|
|
||||||
const rest = items.length > limit ? ` (+${items.length - limit} more)` : "";
|
|
||||||
return shown + rest;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Collapse an overflow report to the elements actually responsible.
|
|
||||||
// Identical elements (24 host rows all doing the same thing) are counted
|
|
||||||
// rather than listed, and the deepest ones come first, since every
|
|
||||||
// ancestor of an overflowing element also reports as overflowing.
|
|
||||||
function deepestOffenders(entries) {
|
|
||||||
const byElement = new Map();
|
|
||||||
for (const entry of entries) {
|
|
||||||
const reach = entry.reach ?? entry.right;
|
|
||||||
const existing = byElement.get(entry.el);
|
|
||||||
if (existing) {
|
|
||||||
existing.count += 1;
|
|
||||||
existing.reach = Math.max(existing.reach, reach);
|
|
||||||
} else {
|
|
||||||
byElement.set(entry.el, { ...entry, reach, count: 1 });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return [...byElement.values()].sort(
|
|
||||||
(a, b) => b.depth - a.depth || b.reach - a.reach,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function checkRowLayout(row, expectStacked) {
|
|
||||||
if (expectStacked) {
|
|
||||||
if (row.flexDirection !== "column") {
|
|
||||||
return `row ${row.index}: flex-direction is ${row.flexDirection}, expected column`;
|
|
||||||
}
|
|
||||||
if (row.sparkline.top < row.info.bottom - 1) {
|
|
||||||
return `row ${row.index}: sparkline top ${row.sparkline.top} is above info bottom ${row.info.bottom} — still side by side`;
|
|
||||||
}
|
|
||||||
const minWidth = row.containerWidth * FULL_WIDTH_FRACTION;
|
|
||||||
if (row.info.width < minWidth) {
|
|
||||||
return `row ${row.index}: info block is ${row.info.width}px of ${row.containerWidth}px — shrunk, not reflowed`;
|
|
||||||
}
|
|
||||||
if (row.sparkline.width < minWidth) {
|
|
||||||
return `row ${row.index}: sparkline is ${row.sparkline.width}px of ${row.containerWidth}px — shrunk, not reflowed`;
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (row.flexDirection !== "row") {
|
|
||||||
return `row ${row.index}: flex-direction is ${row.flexDirection}, expected row`;
|
|
||||||
}
|
|
||||||
if (row.sparkline.left < row.info.right - 1) {
|
|
||||||
return `row ${row.index}: sparkline left ${row.sparkline.left} overlaps info right ${row.info.right} — not side by side`;
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function evaluateChecks(facts, viewport, probes) {
|
|
||||||
const checks = [];
|
|
||||||
const check = (name, ok, detail) => checks.push({ name, ok, detail });
|
|
||||||
|
|
||||||
// Guard against the whole harness passing vacuously because the page
|
|
||||||
// never rendered. Everything below is only meaningful if this holds.
|
|
||||||
check(
|
|
||||||
"app-rendered",
|
|
||||||
facts.rowCount >= 10 && facts.numericLatencies >= 5,
|
|
||||||
`${facts.rowCount} host rows, ${facts.numericLatencies} showing a numeric latency`,
|
|
||||||
);
|
|
||||||
|
|
||||||
const viewportWidth = Math.min(facts.innerWidth, facts.documentClientWidth);
|
|
||||||
const culprits = deepestOffenders([
|
|
||||||
...facts.overflowing,
|
|
||||||
...facts.contentOverflowing,
|
|
||||||
]);
|
|
||||||
check(
|
|
||||||
"no-horizontal-overflow",
|
|
||||||
facts.documentScrollWidth <= viewportWidth,
|
|
||||||
`documentElement.scrollWidth ${facts.documentScrollWidth} vs viewport ${viewportWidth}` +
|
|
||||||
(culprits.length === 0
|
|
||||||
? ""
|
|
||||||
: "; widest content: " +
|
|
||||||
summarise(
|
|
||||||
culprits,
|
|
||||||
(c) =>
|
|
||||||
`${c.el} reaches ${Math.round(c.reach)}px${c.count > 1 ? ` (x${c.count})` : ""}`,
|
|
||||||
)),
|
|
||||||
);
|
|
||||||
|
|
||||||
check(
|
|
||||||
"nothing-past-viewport-edge",
|
|
||||||
facts.overflowing.length === 0,
|
|
||||||
facts.overflowing.length === 0
|
|
||||||
? "no element extends past the viewport"
|
|
||||||
: `${facts.overflowing.length} element(s) past the edge: ` +
|
|
||||||
summarise(
|
|
||||||
facts.overflowing,
|
|
||||||
(o) => `${o.el} spans ${o.left}..${o.right}`,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
check(
|
|
||||||
"no-clipped-text",
|
|
||||||
facts.clipped.length === 0,
|
|
||||||
facts.clipped.length === 0
|
|
||||||
? "no element hides text behind overflow (deliberate ellipsis excluded)"
|
|
||||||
: `${facts.clipped.length} element(s) clipping text: ` +
|
|
||||||
summarise(
|
|
||||||
facts.clipped,
|
|
||||||
(c) =>
|
|
||||||
`${c.el} scrollWidth ${c.scrollWidth} > clientWidth ${c.clientWidth}`,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
if (viewport.touch) {
|
|
||||||
// Presence first: a selector that matches nothing contributes no
|
|
||||||
// undersized targets, so without this the check would report
|
|
||||||
// "all 0 controls are at least 44x44" and pass.
|
|
||||||
const seen = new Map();
|
|
||||||
for (const target of facts.tapTargets) {
|
|
||||||
seen.set(target.selector, (seen.get(target.selector) ?? 0) + 1);
|
|
||||||
}
|
|
||||||
const missing = INTERACTIVE_CONTROLS.filter(
|
|
||||||
(control) => (seen.get(control.selector) ?? 0) < control.minCount,
|
|
||||||
);
|
|
||||||
|
|
||||||
const undersized = facts.tapTargets.filter(
|
|
||||||
(t) => t.width < MIN_TAP_TARGET_PX || t.height < MIN_TAP_TARGET_PX,
|
|
||||||
);
|
|
||||||
const bySelector = new Map();
|
|
||||||
for (const target of undersized) {
|
|
||||||
const existing = bySelector.get(target.selector);
|
|
||||||
if (!existing || target.width * target.height < existing.area) {
|
|
||||||
bySelector.set(target.selector, {
|
|
||||||
...target,
|
|
||||||
area: target.width * target.height,
|
|
||||||
count: (existing?.count ?? 0) + 1,
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
existing.count += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const detail = [];
|
|
||||||
if (missing.length > 0) {
|
|
||||||
detail.push(
|
|
||||||
"oracle is not measuring the page: " +
|
|
||||||
summarise(
|
|
||||||
missing,
|
|
||||||
(c) =>
|
|
||||||
`${c.selector} matched ${seen.get(c.selector) ?? 0} visible element(s), expected at least ${c.minCount}`,
|
|
||||||
4,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
detail.push(
|
|
||||||
undersized.length === 0
|
|
||||||
? `${facts.tapTargets.length} controls measured, all at least ${MIN_TAP_TARGET_PX}x${MIN_TAP_TARGET_PX}`
|
|
||||||
: `${undersized.length} of ${facts.tapTargets.length} controls below ${MIN_TAP_TARGET_PX}x${MIN_TAP_TARGET_PX}: ` +
|
|
||||||
summarise(
|
|
||||||
[...bySelector.values()],
|
|
||||||
(t) =>
|
|
||||||
`${t.selector} ${t.width}x${t.height}${t.count > 1 ? ` (x${t.count})` : ""}`,
|
|
||||||
4,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
check(
|
|
||||||
`tap-targets-${MIN_TAP_TARGET_PX}px`,
|
|
||||||
missing.length === 0 && undersized.length === 0,
|
|
||||||
detail.join("; "),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const badRows = facts.rows
|
|
||||||
.map((row) => checkRowLayout(row, viewport.expectStacked))
|
|
||||||
.filter(Boolean);
|
|
||||||
check(
|
|
||||||
viewport.expectStacked ? "host-rows-stacked" : "host-rows-side-by-side",
|
|
||||||
facts.rows.length > 0 && badRows.length === 0,
|
|
||||||
facts.rows.length === 0
|
|
||||||
? "no host rows were measured"
|
|
||||||
: badRows.length === 0
|
|
||||||
? `all ${facts.rows.length} rows laid out as expected`
|
|
||||||
: `${badRows.length} of ${facts.rows.length} rows wrong: ` +
|
|
||||||
summarise(badRows, (r) => r),
|
|
||||||
);
|
|
||||||
|
|
||||||
// The mobile early-return path proposed in #8 was rejected: narrow
|
|
||||||
// viewports must keep probing and keep detecting the gateway, not
|
|
||||||
// quietly skip work.
|
|
||||||
check(
|
|
||||||
"probing-still-runs",
|
|
||||||
probes.attempted > 0,
|
|
||||||
`${probes.attempted} outbound probe requests issued`,
|
|
||||||
);
|
|
||||||
check(
|
|
||||||
"gateway-detection-still-runs",
|
|
||||||
facts.gatewayDetected,
|
|
||||||
facts.gatewayDetected
|
|
||||||
? "Local Gateway row present"
|
|
||||||
: "no Local Gateway row — gateway detection did not run or did not complete",
|
|
||||||
);
|
|
||||||
|
|
||||||
return checks;
|
|
||||||
}
|
|
||||||
@@ -1,184 +0,0 @@
|
|||||||
// Layout facts collected from inside the page.
|
|
||||||
//
|
|
||||||
// This function is serialised and evaluated in the browser, so it must be
|
|
||||||
// entirely self-contained: no imports, no closures over module scope. It
|
|
||||||
// only *measures*; every pass/fail decision is made back in node by
|
|
||||||
// checks.js, so failures can be reported with real numbers attached.
|
|
||||||
|
|
||||||
export function collectLayoutFacts(options) {
|
|
||||||
const describe = (el) => {
|
|
||||||
const id = el.id ? "#" + el.id : "";
|
|
||||||
const classes =
|
|
||||||
typeof el.className === "string" && el.className.trim()
|
|
||||||
? "." + el.className.trim().split(/\s+/).slice(0, 3).join(".")
|
|
||||||
: "";
|
|
||||||
return el.tagName.toLowerCase() + id + classes;
|
|
||||||
};
|
|
||||||
|
|
||||||
const round = (n) => Math.round(n * 10) / 10;
|
|
||||||
|
|
||||||
// Overflow propagates up every ancestor, so a single wide element
|
|
||||||
// reports as body, #app, the row, and so on. Depth lets the report
|
|
||||||
// name the deepest — that is, the actual — offender.
|
|
||||||
const depthOf = (el) => {
|
|
||||||
let depth = 0;
|
|
||||||
for (let node = el.parentElement; node; node = node.parentElement) {
|
|
||||||
depth++;
|
|
||||||
}
|
|
||||||
return depth;
|
|
||||||
};
|
|
||||||
|
|
||||||
const isVisible = (el) => {
|
|
||||||
const style = getComputedStyle(el);
|
|
||||||
if (style.display === "none") return false;
|
|
||||||
if (style.visibility === "hidden") return false;
|
|
||||||
const rect = el.getBoundingClientRect();
|
|
||||||
return rect.width > 0 && rect.height > 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
const innerWidth = window.innerWidth;
|
|
||||||
const clientWidth = document.documentElement.clientWidth;
|
|
||||||
// Under mobile emulation Chrome lets window.innerWidth *grow* to the
|
|
||||||
// width of overflowing content, exactly as a phone zooms out to fit a
|
|
||||||
// too-wide page. Measuring against it would therefore hide the
|
|
||||||
// overflow it is supposed to expose: at a 320px device width a page
|
|
||||||
// that spills to 350 reports innerWidth 350 and looks clean. Every
|
|
||||||
// comparison below is against the layout viewport instead.
|
|
||||||
const viewportWidth = Math.min(innerWidth, clientWidth);
|
|
||||||
const elements = Array.from(document.querySelectorAll("body *"));
|
|
||||||
|
|
||||||
// Elements sticking out past the right (or left) edge of the viewport.
|
|
||||||
// The document-level scrollWidth check says *that* the page overflows;
|
|
||||||
// this says *what* is doing it.
|
|
||||||
const overflowing = [];
|
|
||||||
// Elements clipping their own text. Deliberate ellipsis truncation
|
|
||||||
// (Tailwind's `truncate`) is opt-in and excluded: it is a design
|
|
||||||
// choice, not breakage.
|
|
||||||
const clipped = [];
|
|
||||||
// Elements whose content spills out of their own box without being
|
|
||||||
// clipped, past the right edge of the viewport. A block element is
|
|
||||||
// only ever as wide as its container, so text overflowing it has no
|
|
||||||
// element rect of its own to catch — but it is exactly what drags
|
|
||||||
// documentElement.scrollWidth past the viewport width, so without
|
|
||||||
// this the page-level overflow failure has nothing to point at.
|
|
||||||
const contentOverflowing = [];
|
|
||||||
|
|
||||||
for (const el of elements) {
|
|
||||||
if (!isVisible(el)) continue;
|
|
||||||
const rect = el.getBoundingClientRect();
|
|
||||||
if (rect.right > viewportWidth + 1 || rect.left < -1) {
|
|
||||||
overflowing.push({
|
|
||||||
el: describe(el),
|
|
||||||
depth: depthOf(el),
|
|
||||||
left: round(rect.left),
|
|
||||||
right: round(rect.right),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
const style = getComputedStyle(el);
|
|
||||||
const clips =
|
|
||||||
style.overflowX === "hidden" || style.overflowX === "clip";
|
|
||||||
const ellipsis = style.textOverflow === "ellipsis";
|
|
||||||
const hasText = el.textContent.trim().length > 0;
|
|
||||||
const spills =
|
|
||||||
el.clientWidth > 0 && el.scrollWidth > el.clientWidth + 1;
|
|
||||||
if (clips && !ellipsis && hasText && spills) {
|
|
||||||
clipped.push({
|
|
||||||
el: describe(el),
|
|
||||||
scrollWidth: el.scrollWidth,
|
|
||||||
clientWidth: el.clientWidth,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (
|
|
||||||
!clips &&
|
|
||||||
spills &&
|
|
||||||
rect.left + el.scrollWidth > viewportWidth + 1
|
|
||||||
) {
|
|
||||||
contentOverflowing.push({
|
|
||||||
el: describe(el),
|
|
||||||
depth: depthOf(el),
|
|
||||||
scrollWidth: el.scrollWidth,
|
|
||||||
clientWidth: el.clientWidth,
|
|
||||||
reach: round(rect.left + el.scrollWidth),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Interactive controls. The measured target is the nearest thing that
|
|
||||||
// is genuinely tappable — for a checkbox that is the <label> wrapping
|
|
||||||
// it, which is larger than the box itself and is what a finger hits.
|
|
||||||
const tapTargets = [];
|
|
||||||
for (const selector of options.interactiveSelectors) {
|
|
||||||
for (const el of document.querySelectorAll(selector)) {
|
|
||||||
if (!isVisible(el)) continue;
|
|
||||||
const target = el.closest("button, a, label, select") || el;
|
|
||||||
const rect = target.getBoundingClientRect();
|
|
||||||
tapTargets.push({
|
|
||||||
selector,
|
|
||||||
el: describe(target),
|
|
||||||
width: round(rect.width),
|
|
||||||
height: round(rect.height),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Host rows. The question is not "did it get narrower" but "did it
|
|
||||||
// reflow": the info block and the sparkline must end up stacked
|
|
||||||
// vertically and full width in the narrow layout, and side by side in
|
|
||||||
// the wide one. Both the computed flex-direction and the actual
|
|
||||||
// geometry are recorded so a row that claims to be a column but is
|
|
||||||
// still laid out side by side cannot slip through.
|
|
||||||
const rows = [];
|
|
||||||
for (const row of document.querySelectorAll(".host-row")) {
|
|
||||||
const inner = row.firstElementChild;
|
|
||||||
if (!inner) continue;
|
|
||||||
const sparkline = inner.querySelector(".sparkline-container");
|
|
||||||
const info = sparkline ? sparkline.previousElementSibling : null;
|
|
||||||
if (!sparkline || !info) continue;
|
|
||||||
const innerStyle = getComputedStyle(inner);
|
|
||||||
const innerRect = inner.getBoundingClientRect();
|
|
||||||
const infoRect = info.getBoundingClientRect();
|
|
||||||
const sparkRect = sparkline.getBoundingClientRect();
|
|
||||||
rows.push({
|
|
||||||
index: row.dataset.index,
|
|
||||||
flexDirection: innerStyle.flexDirection,
|
|
||||||
containerWidth: round(innerRect.width),
|
|
||||||
info: {
|
|
||||||
left: round(infoRect.left),
|
|
||||||
right: round(infoRect.right),
|
|
||||||
bottom: round(infoRect.bottom),
|
|
||||||
width: round(infoRect.width),
|
|
||||||
},
|
|
||||||
sparkline: {
|
|
||||||
left: round(sparkRect.left),
|
|
||||||
top: round(sparkRect.top),
|
|
||||||
width: round(sparkRect.width),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const localRows = Array.from(
|
|
||||||
document.querySelectorAll("#local-hosts .host-row"),
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
|
||||||
innerWidth,
|
|
||||||
// innerWidth includes any classic scrollbar, clientWidth does not.
|
|
||||||
// Reported separately so the overflow check can hold itself to the
|
|
||||||
// narrower of the two rather than to whichever one is more
|
|
||||||
// forgiving.
|
|
||||||
documentClientWidth: document.documentElement.clientWidth,
|
|
||||||
documentScrollWidth: document.documentElement.scrollWidth,
|
|
||||||
overflowing,
|
|
||||||
contentOverflowing,
|
|
||||||
clipped,
|
|
||||||
tapTargets,
|
|
||||||
rows,
|
|
||||||
rowCount: document.querySelectorAll(".host-row").length,
|
|
||||||
numericLatencies: Array.from(
|
|
||||||
document.querySelectorAll(".latency-value"),
|
|
||||||
).filter((el) => /\d/.test(el.textContent)).length,
|
|
||||||
gatewayDetected: localRows.some((row) =>
|
|
||||||
row.textContent.includes("Local Gateway"),
|
|
||||||
),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,258 +0,0 @@
|
|||||||
// Responsive-layout harness.
|
|
||||||
//
|
|
||||||
// Drives the built frontend in a real, containerised, digest-pinned Chrome
|
|
||||||
// over CDP and asserts on computed layout at every viewport width derived
|
|
||||||
// from the app's own CSS. Screenshots are written alongside as artifacts;
|
|
||||||
// they are not the evidence, the assertions are.
|
|
||||||
//
|
|
||||||
// This is not meant to be run by hand. `make frontend-viewport-test` brings
|
|
||||||
// up the browser and the web server and then runs this; every input it
|
|
||||||
// needs arrives in the environment.
|
|
||||||
|
|
||||||
import { mkdirSync, writeFileSync } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import puppeteer from "puppeteer-core";
|
|
||||||
import { collectLayoutFacts } from "./facts.js";
|
|
||||||
import { evaluateChecks, INTERACTIVE_SELECTORS } from "./checks.js";
|
|
||||||
import { deriveViewports } from "./viewports.js";
|
|
||||||
|
|
||||||
function required(name) {
|
|
||||||
const value = process.env[name];
|
|
||||||
if (!value) {
|
|
||||||
throw new Error(
|
|
||||||
`${name} is not set; run this via script/frontend-viewport-test`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
const ROOT = required("NETWATCH_ROOT");
|
|
||||||
const BASE_URL = required("NETWATCH_BASE_URL");
|
|
||||||
const CDP_URL = required("NETWATCH_CDP_URL");
|
|
||||||
const ARTIFACT_DIR = required("NETWATCH_ARTIFACT_DIR");
|
|
||||||
|
|
||||||
const BROWSER_TIMEOUT_MS = 60000;
|
|
||||||
const PAGE_TIMEOUT_MS = 30000;
|
|
||||||
|
|
||||||
// Canned responses for the app's outbound latency probes. The browser
|
|
||||||
// container sits on an --internal docker network and physically cannot
|
|
||||||
// reach the internet, so nothing here is about blocking traffic; it is
|
|
||||||
// about determinism. Real probes would render 24 rows of whatever the
|
|
||||||
// network happened to be doing. These delays make the rows show a
|
|
||||||
// realistic spread of value widths — one, two and three digit latencies,
|
|
||||||
// plus some unreachable rows — because that spread is what the layout has
|
|
||||||
// to survive.
|
|
||||||
const PROBE_DELAYS_MS = [2, 45, 123, 456, 780];
|
|
||||||
// One in every UNREACHABLE_MODULUS probes is failed outright so that the
|
|
||||||
// offline row rendering is exercised too.
|
|
||||||
const UNREACHABLE_MODULUS = 7;
|
|
||||||
// The gateway candidate that "answers", so gateway detection succeeds and
|
|
||||||
// the Local Gateway row renders. Matches GATEWAY_CANDIDATES in src/main.js.
|
|
||||||
const RESPONSIVE_GATEWAY = "http://192.168.1.1";
|
|
||||||
|
|
||||||
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
||||||
|
|
||||||
function stableHash(text) {
|
|
||||||
let hash = 0;
|
|
||||||
for (let i = 0; i < text.length; i++) {
|
|
||||||
hash = (hash * 31 + text.charCodeAt(i)) | 0;
|
|
||||||
}
|
|
||||||
return Math.abs(hash);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function connectBrowser() {
|
|
||||||
const deadline = Date.now() + BROWSER_TIMEOUT_MS;
|
|
||||||
let lastError;
|
|
||||||
for (;;) {
|
|
||||||
try {
|
|
||||||
const response = await fetch(`${CDP_URL}/json/version`);
|
|
||||||
const info = await response.json();
|
|
||||||
// The endpoint advertises whatever Host it was reached on;
|
|
||||||
// pin it back to the address we actually dialled.
|
|
||||||
const endpoint = new URL(info.webSocketDebuggerUrl);
|
|
||||||
endpoint.host = new URL(CDP_URL).host;
|
|
||||||
const browser = await puppeteer.connect({
|
|
||||||
browserWSEndpoint: endpoint.toString(),
|
|
||||||
protocolTimeout: BROWSER_TIMEOUT_MS,
|
|
||||||
});
|
|
||||||
return { browser, version: info.Browser };
|
|
||||||
} catch (error) {
|
|
||||||
lastError = error;
|
|
||||||
if (Date.now() > deadline) {
|
|
||||||
throw new Error(`browser never came up: ${lastError}`);
|
|
||||||
}
|
|
||||||
await sleep(250);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function installProbeResponder(page, probes) {
|
|
||||||
const respond = (request, delayMs) =>
|
|
||||||
sleep(delayMs).then(() =>
|
|
||||||
request.respond({
|
|
||||||
status: 200,
|
|
||||||
contentType: "text/plain",
|
|
||||||
body: "",
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
page.on("request", (request) => {
|
|
||||||
const url = request.url();
|
|
||||||
const settle = async () => {
|
|
||||||
if (url.startsWith(BASE_URL) || url.startsWith("data:")) {
|
|
||||||
return request.continue();
|
|
||||||
}
|
|
||||||
probes.attempted++;
|
|
||||||
if (url.startsWith(RESPONSIVE_GATEWAY)) {
|
|
||||||
probes.fulfilled++;
|
|
||||||
return respond(request, 5);
|
|
||||||
}
|
|
||||||
const hash = stableHash(url);
|
|
||||||
if (hash % UNREACHABLE_MODULUS === 0) {
|
|
||||||
probes.failed++;
|
|
||||||
return request.abort("connectionfailed");
|
|
||||||
}
|
|
||||||
probes.fulfilled++;
|
|
||||||
return respond(
|
|
||||||
request,
|
|
||||||
PROBE_DELAYS_MS[hash % PROBE_DELAYS_MS.length],
|
|
||||||
);
|
|
||||||
};
|
|
||||||
// The page may be torn down while a delayed response is pending;
|
|
||||||
// that is not a harness failure.
|
|
||||||
settle().catch(() => {});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async function runViewport(browser, viewport) {
|
|
||||||
const page = await browser.newPage();
|
|
||||||
const probes = { attempted: 0, fulfilled: 0, failed: 0 };
|
|
||||||
try {
|
|
||||||
page.setDefaultTimeout(PAGE_TIMEOUT_MS);
|
|
||||||
await page.setRequestInterception(true);
|
|
||||||
installProbeResponder(page, probes);
|
|
||||||
await page.setViewport({
|
|
||||||
width: viewport.width,
|
|
||||||
height: viewport.height,
|
|
||||||
deviceScaleFactor: viewport.deviceScaleFactor,
|
|
||||||
isMobile: viewport.touch,
|
|
||||||
hasTouch: viewport.touch,
|
|
||||||
isLandscape: viewport.width > viewport.height,
|
|
||||||
});
|
|
||||||
|
|
||||||
await page.goto(BASE_URL, { waitUntil: "load" });
|
|
||||||
await page.waitForSelector(".host-row");
|
|
||||||
|
|
||||||
// The app discards its first tick as a cold start, so rows only
|
|
||||||
// carry real values from the second one. Changing the interval
|
|
||||||
// restarts the loop at 1s, which reaches a populated UI without
|
|
||||||
// waiting out two default 3s intervals — and exercises the
|
|
||||||
// interval dropdown while we are at it.
|
|
||||||
await page.select("#interval-select", "1000");
|
|
||||||
await page.waitForFunction(
|
|
||||||
() =>
|
|
||||||
Array.from(document.querySelectorAll(".latency-value")).filter(
|
|
||||||
(el) => /\d/.test(el.textContent),
|
|
||||||
).length >= 5,
|
|
||||||
);
|
|
||||||
// Let the resize/redraw handlers settle before measuring.
|
|
||||||
await page.evaluate(
|
|
||||||
() =>
|
|
||||||
new Promise((resolve) =>
|
|
||||||
requestAnimationFrame(() => requestAnimationFrame(resolve)),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
const facts = await page.evaluate(collectLayoutFacts, {
|
|
||||||
interactiveSelectors: INTERACTIVE_SELECTORS,
|
|
||||||
});
|
|
||||||
|
|
||||||
const screenshot = join(
|
|
||||||
ARTIFACT_DIR,
|
|
||||||
`${viewport.width}x${viewport.height}-${viewport.name}.png`,
|
|
||||||
);
|
|
||||||
await page.screenshot({ path: screenshot, fullPage: true });
|
|
||||||
|
|
||||||
return {
|
|
||||||
viewport,
|
|
||||||
probes,
|
|
||||||
facts,
|
|
||||||
screenshot,
|
|
||||||
checks: evaluateChecks(facts, viewport, probes),
|
|
||||||
};
|
|
||||||
} finally {
|
|
||||||
await page.close().catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function report(results, conditions, browserVersion) {
|
|
||||||
const label = (viewport) =>
|
|
||||||
`${viewport.width}x${viewport.height}`.padEnd(9) +
|
|
||||||
" " +
|
|
||||||
viewport.name.padEnd(24);
|
|
||||||
|
|
||||||
console.log(`browser: ${browserVersion}`);
|
|
||||||
console.log(`served from: ${BASE_URL} (built dist/)`);
|
|
||||||
console.log(
|
|
||||||
"breakpoints: " +
|
|
||||||
conditions
|
|
||||||
.map((c) => `${c.type}-width ${c.px}px (${c.source})`)
|
|
||||||
.join(", "),
|
|
||||||
);
|
|
||||||
console.log("");
|
|
||||||
|
|
||||||
let passed = 0;
|
|
||||||
let failed = 0;
|
|
||||||
for (const result of results) {
|
|
||||||
const bad = result.checks.filter((c) => !c.ok);
|
|
||||||
passed += result.checks.length - bad.length;
|
|
||||||
failed += bad.length;
|
|
||||||
// Passing viewports get one line. Detail is for failures.
|
|
||||||
console.log(
|
|
||||||
`${bad.length === 0 ? "PASS" : "FAIL"} ${label(result.viewport)} ` +
|
|
||||||
`${result.checks.length - bad.length}/${result.checks.length} checks` +
|
|
||||||
`${result.viewport.expectStacked ? " [narrow layout expected]" : ""}`,
|
|
||||||
);
|
|
||||||
for (const check of bad) {
|
|
||||||
console.log(` ${check.name}: ${check.detail}`);
|
|
||||||
}
|
|
||||||
if (bad.length > 0) {
|
|
||||||
console.log(` why this width: ${result.viewport.why}`);
|
|
||||||
console.log(` screenshot: ${result.screenshot}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log("");
|
|
||||||
console.log(
|
|
||||||
`${results.length} viewports, ${passed + failed} checks: ` +
|
|
||||||
`${passed} passed, ${failed} failed`,
|
|
||||||
);
|
|
||||||
console.log(`artifacts: ${ARTIFACT_DIR}`);
|
|
||||||
return failed;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function main() {
|
|
||||||
const { conditions, viewports } = deriveViewports(ROOT);
|
|
||||||
mkdirSync(ARTIFACT_DIR, { recursive: true });
|
|
||||||
|
|
||||||
const { browser, version } = await connectBrowser();
|
|
||||||
const results = [];
|
|
||||||
try {
|
|
||||||
for (const viewport of viewports) {
|
|
||||||
results.push(await runViewport(browser, viewport));
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
await browser.disconnect().catch(() => {});
|
|
||||||
}
|
|
||||||
|
|
||||||
writeFileSync(
|
|
||||||
join(ARTIFACT_DIR, "results.json"),
|
|
||||||
JSON.stringify({ browser: version, conditions, results }, null, 2) +
|
|
||||||
"\n",
|
|
||||||
);
|
|
||||||
|
|
||||||
const failed = report(results, conditions, version);
|
|
||||||
process.exitCode = failed === 0 ? 0 : 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
await main();
|
|
||||||
@@ -1,224 +0,0 @@
|
|||||||
// Viewport derivation for the responsive-layout harness.
|
|
||||||
//
|
|
||||||
// The widths tested are read out of the CSS the application actually
|
|
||||||
// ships, not taken from a list of popular phone models. A generic 375px
|
|
||||||
// "phone" test sails straight past an off-by-one error at a media query
|
|
||||||
// boundary, which is the classic way a responsive layout breaks, so
|
|
||||||
// every breakpoint found in the sources is probed three times: one pixel
|
|
||||||
// below it, exactly on it, and one pixel above it.
|
|
||||||
//
|
|
||||||
// Nothing here hardcodes 768. If someone adds a second media block or
|
|
||||||
// starts using Tailwind responsive prefixes, that breakpoint starts
|
|
||||||
// being covered without this file being edited.
|
|
||||||
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
|
||||||
|
|
||||||
// Tailwind CSS v4 default breakpoints, in rem. The app currently uses
|
|
||||||
// none of these prefixes, so the whole table is inert until someone
|
|
||||||
// writes an `md:`-prefixed utility class.
|
|
||||||
const TAILWIND_BREAKPOINT_REM = {
|
|
||||||
sm: 40,
|
|
||||||
md: 48,
|
|
||||||
lg: 64,
|
|
||||||
xl: 80,
|
|
||||||
"2xl": 96,
|
|
||||||
};
|
|
||||||
|
|
||||||
// The app does not override the root font size, so rem and em in media
|
|
||||||
// queries resolve against the browser default.
|
|
||||||
const ROOT_FONT_SIZE_PX = 16;
|
|
||||||
|
|
||||||
// Extract every min-width / max-width condition from the @media blocks in
|
|
||||||
// a stylesheet. Returns e.g. [{ type: "max", px: 768, source: "..." }].
|
|
||||||
export function mediaConditionsFromCss(css, source) {
|
|
||||||
const conditions = [];
|
|
||||||
for (const block of css.matchAll(/@media([^{]+)\{/g)) {
|
|
||||||
const features = block[1].matchAll(
|
|
||||||
/\(\s*(min|max)-width\s*:\s*([\d.]+)(px|rem|em)\s*\)/g,
|
|
||||||
);
|
|
||||||
for (const feature of features) {
|
|
||||||
const scale = feature[3] === "px" ? 1 : ROOT_FONT_SIZE_PX;
|
|
||||||
conditions.push({
|
|
||||||
type: feature[1],
|
|
||||||
px: Math.round(Number(feature[2]) * scale),
|
|
||||||
source,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return conditions;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Extract the breakpoints implied by Tailwind responsive prefixes used in
|
|
||||||
// markup. A prefix only counts when it opens a utility class, so `text-sm`
|
|
||||||
// does not masquerade as the `sm:` breakpoint.
|
|
||||||
export function mediaConditionsFromMarkup(sources) {
|
|
||||||
const conditions = [];
|
|
||||||
for (const { path, text } of sources) {
|
|
||||||
for (const [name, rem] of Object.entries(TAILWIND_BREAKPOINT_REM)) {
|
|
||||||
const used = new RegExp(
|
|
||||||
`(^|["'\\s])${name}:[a-z0-9[\\](),_./%-]+`,
|
|
||||||
"m",
|
|
||||||
).test(text);
|
|
||||||
if (used) {
|
|
||||||
conditions.push({
|
|
||||||
type: "min",
|
|
||||||
px: rem * ROOT_FONT_SIZE_PX,
|
|
||||||
source: path,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return conditions;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Whether a given width should be rendering the app's narrow (stacked)
|
|
||||||
// layout.
|
|
||||||
//
|
|
||||||
// Two breakpoint styles can be answered from the condition list alone:
|
|
||||||
//
|
|
||||||
// - Desktop-first, which is what the app ships today: the wide layout is
|
|
||||||
// unconditional and every narrow rule lives in a `max-width` block, so
|
|
||||||
// a width is narrow exactly when one of those blocks matches. Note that
|
|
||||||
// `max-width: 768px` matches *at* 768 — getting this inclusive boundary
|
|
||||||
// wrong in either direction is what the three-widths-per-breakpoint
|
|
||||||
// sweep exists to catch.
|
|
||||||
// - Mobile-first, which is what Tailwind's `sm:`/`md:` prefixes are: the
|
|
||||||
// stacked layout is the unconditional base and a `min-width` block is
|
|
||||||
// what widens it, so a width is narrow exactly when it sits below every
|
|
||||||
// `min-width` breakpoint.
|
|
||||||
//
|
|
||||||
// A mix of the two cannot be resolved from the breakpoints alone — which
|
|
||||||
// block owns the host-row reflow is a property of the rules inside it, not
|
|
||||||
// of the condition — so this throws rather than guessing. Guessing is how
|
|
||||||
// the wrong expectation gets applied at the right widths and the whole
|
|
||||||
// sweep quietly verifies nothing.
|
|
||||||
export function expectsStackedLayout(width, conditions) {
|
|
||||||
const kinds = new Set(conditions.map((c) => c.type));
|
|
||||||
for (const kind of kinds) {
|
|
||||||
if (kind !== "max" && kind !== "min") {
|
|
||||||
throw new Error(
|
|
||||||
`unsupported media condition type "${kind}" in ` +
|
|
||||||
"expectsStackedLayout (test/viewport/viewports.js)",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (kinds.has("max") && kinds.has("min")) {
|
|
||||||
throw new Error(
|
|
||||||
"the app now mixes max-width and min-width breakpoints (" +
|
|
||||||
conditions
|
|
||||||
.map((c) => `${c.type}-width ${c.px}px in ${c.source}`)
|
|
||||||
.join(", ") +
|
|
||||||
"), so which layout a width should be showing can no longer " +
|
|
||||||
"be inferred from the breakpoint list; teach " +
|
|
||||||
"expectsStackedLayout in test/viewport/viewports.js which " +
|
|
||||||
"block owns the host-row reflow",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
if (kinds.has("min")) {
|
|
||||||
return !conditions.some((c) => width >= c.px);
|
|
||||||
}
|
|
||||||
return conditions.some((c) => width <= c.px);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Viewports that are not derived from a breakpoint. Each one is here for
|
|
||||||
// a stated reason; none of them is a stand-in for "a phone".
|
|
||||||
const ANCHOR_VIEWPORTS = [
|
|
||||||
{
|
|
||||||
name: "floor-portrait",
|
|
||||||
width: 320,
|
|
||||||
height: 568,
|
|
||||||
deviceScaleFactor: 2,
|
|
||||||
touch: true,
|
|
||||||
why: "320px is the narrowest viewport still in mainstream use; nothing has to work below it",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "phone-landscape-narrow",
|
|
||||||
width: 667,
|
|
||||||
height: 375,
|
|
||||||
deviceScaleFactor: 2,
|
|
||||||
touch: true,
|
|
||||||
why: "phone rotated to landscape, still inside the narrow layout",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "phone-landscape-wide",
|
|
||||||
width: 844,
|
|
||||||
height: 390,
|
|
||||||
deviceScaleFactor: 3,
|
|
||||||
touch: true,
|
|
||||||
why: "large phone rotated to landscape: crosses into the wide layout while still being a touch device",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "desktop",
|
|
||||||
width: 1280,
|
|
||||||
height: 800,
|
|
||||||
deviceScaleFactor: 1,
|
|
||||||
touch: false,
|
|
||||||
why: "desktop baseline",
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
export function deriveViewports(root) {
|
|
||||||
const conditions = [
|
|
||||||
...mediaConditionsFromCss(
|
|
||||||
readFileSync(join(root, "src/styles.css"), "utf8"),
|
|
||||||
"src/styles.css",
|
|
||||||
),
|
|
||||||
...mediaConditionsFromMarkup([
|
|
||||||
{
|
|
||||||
path: "src/main.js",
|
|
||||||
text: readFileSync(join(root, "src/main.js"), "utf8"),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
path: "index.html",
|
|
||||||
text: readFileSync(join(root, "index.html"), "utf8"),
|
|
||||||
},
|
|
||||||
]),
|
|
||||||
];
|
|
||||||
|
|
||||||
if (conditions.length === 0) {
|
|
||||||
throw new Error(
|
|
||||||
"no responsive breakpoints found in src/styles.css, src/main.js or " +
|
|
||||||
"index.html — either the responsive layout was deleted or this " +
|
|
||||||
"derivation has stopped matching the sources",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const viewports = new Map();
|
|
||||||
const add = (viewport) => {
|
|
||||||
const key = `${viewport.width}x${viewport.height}`;
|
|
||||||
if (!viewports.has(key)) viewports.set(key, viewport);
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const condition of conditions) {
|
|
||||||
for (const [offset, label] of [
|
|
||||||
[-1, "below"],
|
|
||||||
[0, "at"],
|
|
||||||
[+1, "above"],
|
|
||||||
]) {
|
|
||||||
const width = condition.px + offset;
|
|
||||||
add({
|
|
||||||
name: `${condition.type}-width-${condition.px}-${label}`,
|
|
||||||
width,
|
|
||||||
// Tall enough that the whole app is laid out in one column
|
|
||||||
// without the viewport height influencing wrapping.
|
|
||||||
height: 1024,
|
|
||||||
deviceScaleFactor: 2,
|
|
||||||
touch: true,
|
|
||||||
why: `${offset === 0 ? "exactly on" : `1px ${label}`} the ${condition.type}-width: ${condition.px}px breakpoint declared in ${condition.source}`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const anchor of ANCHOR_VIEWPORTS) add(anchor);
|
|
||||||
|
|
||||||
return {
|
|
||||||
conditions,
|
|
||||||
viewports: [...viewports.values()]
|
|
||||||
.map((viewport) => ({
|
|
||||||
...viewport,
|
|
||||||
expectStacked: expectsStackedLayout(viewport.width, conditions),
|
|
||||||
}))
|
|
||||||
.sort((a, b) => a.width - b.width || a.height - b.height),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -7,13 +7,6 @@ const commitFull = execSync("git rev-parse HEAD").toString().trim();
|
|||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
plugins: [tailwindcss()],
|
plugins: [tailwindcss()],
|
||||||
server: {
|
|
||||||
// Proxy /api to a locally running netwatch-server so `yarn dev`
|
|
||||||
// exercises the real report-posting path.
|
|
||||||
proxy: {
|
|
||||||
"/api": "http://127.0.0.1:8080",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
define: {
|
define: {
|
||||||
__COMMIT_HASH__: JSON.stringify(commitHash),
|
__COMMIT_HASH__: JSON.stringify(commitHash),
|
||||||
__COMMIT_FULL__: JSON.stringify(commitFull),
|
__COMMIT_FULL__: JSON.stringify(commitFull),
|
||||||
|
|||||||
@@ -197,14 +197,6 @@
|
|||||||
"@emnapi/runtime" "^1.7.1"
|
"@emnapi/runtime" "^1.7.1"
|
||||||
"@tybys/wasm-util" "^0.10.1"
|
"@tybys/wasm-util" "^0.10.1"
|
||||||
|
|
||||||
"@puppeteer/browsers@3.1.0":
|
|
||||||
version "3.1.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/@puppeteer/browsers/-/browsers-3.1.0.tgz#5728ae0bc649263133ac1f8bd5d360eb75d11748"
|
|
||||||
integrity sha512-RDLpio3fH/qrj5k4DVY6eyiN8tCS0Zovd/6jW//n605oeqkWcUjn+3k+9ZtZBnbwMpsu0F7xDIiKXvVmG5c5Bw==
|
|
||||||
dependencies:
|
|
||||||
modern-tar "^0.7.6"
|
|
||||||
yargs "^18.0.0"
|
|
||||||
|
|
||||||
"@rollup/rollup-android-arm-eabi@4.57.0":
|
"@rollup/rollup-android-arm-eabi@4.57.0":
|
||||||
version "4.57.0"
|
version "4.57.0"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.57.0.tgz#f762035679a6b168138c94c960fda0b0cdb00d98"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.57.0.tgz#f762035679a6b168138c94c960fda0b0cdb00d98"
|
||||||
@@ -449,16 +441,6 @@
|
|||||||
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e"
|
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e"
|
||||||
integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==
|
integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==
|
||||||
|
|
||||||
ansi-regex@^6.2.2:
|
|
||||||
version "6.2.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1"
|
|
||||||
integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==
|
|
||||||
|
|
||||||
ansi-styles@^6.2.1:
|
|
||||||
version "6.2.3"
|
|
||||||
resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041"
|
|
||||||
integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==
|
|
||||||
|
|
||||||
autoprefixer@^10.4.23:
|
autoprefixer@^10.4.23:
|
||||||
version "10.4.23"
|
version "10.4.23"
|
||||||
resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-10.4.23.tgz#c6aa6db8e7376fcd900f9fd79d143ceebad8c4e6"
|
resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-10.4.23.tgz#c6aa6db8e7376fcd900f9fd79d143ceebad8c4e6"
|
||||||
@@ -491,43 +473,16 @@ caniuse-lite@^1.0.30001759, caniuse-lite@^1.0.30001760:
|
|||||||
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001766.tgz#b6f6b55cb25a2d888d9393104d14751c6a7d6f7a"
|
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001766.tgz#b6f6b55cb25a2d888d9393104d14751c6a7d6f7a"
|
||||||
integrity sha512-4C0lfJ0/YPjJQHagaE9x2Elb69CIqEPZeG0anQt9SIvIoOH4a4uaRl73IavyO+0qZh6MDLH//DrXThEYKHkmYA==
|
integrity sha512-4C0lfJ0/YPjJQHagaE9x2Elb69CIqEPZeG0anQt9SIvIoOH4a4uaRl73IavyO+0qZh6MDLH//DrXThEYKHkmYA==
|
||||||
|
|
||||||
chromium-bidi@17.0.2:
|
|
||||||
version "17.0.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/chromium-bidi/-/chromium-bidi-17.0.2.tgz#921a586deecd0c2d8b9242c4c1b73c3aa39ff77c"
|
|
||||||
integrity sha512-5v9GQFhTktFvotn/OFNJBmKLKRAb6n9r0bVCwf7sHgWc3/JryK0bj1nn93L3pHFrfgcsu6Be6EWsDi+1XHTGDg==
|
|
||||||
dependencies:
|
|
||||||
mitt "^3.0.1"
|
|
||||||
zod "^3.24.1"
|
|
||||||
|
|
||||||
cliui@^9.0.1:
|
|
||||||
version "9.0.1"
|
|
||||||
resolved "https://registry.yarnpkg.com/cliui/-/cliui-9.0.1.tgz#6f7890f386f6f1f79953adc1f78dec46fcc2d291"
|
|
||||||
integrity sha512-k7ndgKhwoQveBL+/1tqGJYNz097I7WOvwbmmU2AR5+magtbjPWQTS1C5vzGkBC8Ym8UWRzfKUzUUqFLypY4Q+w==
|
|
||||||
dependencies:
|
|
||||||
string-width "^7.2.0"
|
|
||||||
strip-ansi "^7.1.0"
|
|
||||||
wrap-ansi "^9.0.0"
|
|
||||||
|
|
||||||
detect-libc@^2.0.3:
|
detect-libc@^2.0.3:
|
||||||
version "2.1.2"
|
version "2.1.2"
|
||||||
resolved "https://registry.yarnpkg.com/detect-libc/-/detect-libc-2.1.2.tgz#689c5dcdc1900ef5583a4cb9f6d7b473742074ad"
|
resolved "https://registry.yarnpkg.com/detect-libc/-/detect-libc-2.1.2.tgz#689c5dcdc1900ef5583a4cb9f6d7b473742074ad"
|
||||||
integrity sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==
|
integrity sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==
|
||||||
|
|
||||||
devtools-protocol@0.0.1653615:
|
|
||||||
version "0.0.1653615"
|
|
||||||
resolved "https://registry.yarnpkg.com/devtools-protocol/-/devtools-protocol-0.0.1653615.tgz#c600e0c619612156b2422a66d958ba188d87dbe8"
|
|
||||||
integrity sha512-pGVkY3T/qXxAp2nFPodwYqOevk6ncNMSmvL8QfRCx5ZWGd6Vor7AFNmyaA8Zs6uJyP1QAfjuLandCgvSix1BNA==
|
|
||||||
|
|
||||||
electron-to-chromium@^1.5.263:
|
electron-to-chromium@^1.5.263:
|
||||||
version "1.5.282"
|
version "1.5.282"
|
||||||
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.282.tgz#6695816e5b170210d6aa07561546ed7d97347630"
|
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.282.tgz#6695816e5b170210d6aa07561546ed7d97347630"
|
||||||
integrity sha512-FCPkJtpst28UmFzd903iU7PdeVTfY0KAeJy+Lk0GLZRwgwYHn/irRcaCbQQOmr5Vytc/7rcavsYLvTM8RiHYhQ==
|
integrity sha512-FCPkJtpst28UmFzd903iU7PdeVTfY0KAeJy+Lk0GLZRwgwYHn/irRcaCbQQOmr5Vytc/7rcavsYLvTM8RiHYhQ==
|
||||||
|
|
||||||
emoji-regex@^10.3.0:
|
|
||||||
version "10.6.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-10.6.0.tgz#bf3d6e8f7f8fd22a65d9703475bc0147357a6b0d"
|
|
||||||
integrity sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==
|
|
||||||
|
|
||||||
enhanced-resolve@^5.18.3:
|
enhanced-resolve@^5.18.3:
|
||||||
version "5.18.4"
|
version "5.18.4"
|
||||||
resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.4.tgz#c22d33055f3952035ce6a144ce092447c525f828"
|
resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.4.tgz#c22d33055f3952035ce6a144ce092447c525f828"
|
||||||
@@ -568,7 +523,7 @@ esbuild@^0.27.0:
|
|||||||
"@esbuild/win32-ia32" "0.27.2"
|
"@esbuild/win32-ia32" "0.27.2"
|
||||||
"@esbuild/win32-x64" "0.27.2"
|
"@esbuild/win32-x64" "0.27.2"
|
||||||
|
|
||||||
escalade@^3.1.1, escalade@^3.2.0:
|
escalade@^3.2.0:
|
||||||
version "3.2.0"
|
version "3.2.0"
|
||||||
resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5"
|
resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5"
|
||||||
integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==
|
integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==
|
||||||
@@ -588,16 +543,6 @@ fsevents@~2.3.2, fsevents@~2.3.3:
|
|||||||
resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6"
|
resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6"
|
||||||
integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
|
integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
|
||||||
|
|
||||||
get-caller-file@^2.0.5:
|
|
||||||
version "2.0.5"
|
|
||||||
resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
|
|
||||||
integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==
|
|
||||||
|
|
||||||
get-east-asian-width@^1.0.0, get-east-asian-width@^1.5.0:
|
|
||||||
version "1.6.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/get-east-asian-width/-/get-east-asian-width-1.6.0.tgz#216900f91df11a8b2c198c3e1d93d6c035a776b9"
|
|
||||||
integrity sha512-QRbvDIbx6YklUe6RxeTeleMR0yv3cYH6PsPZHcnVn7xv7zO1BHN8r0XETu8n6Ye3Q+ahtSarc3WgtNWmehIBfA==
|
|
||||||
|
|
||||||
graceful-fs@^4.2.4:
|
graceful-fs@^4.2.4:
|
||||||
version "4.2.11"
|
version "4.2.11"
|
||||||
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3"
|
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3"
|
||||||
@@ -689,16 +634,6 @@ magic-string@^0.30.21:
|
|||||||
dependencies:
|
dependencies:
|
||||||
"@jridgewell/sourcemap-codec" "^1.5.5"
|
"@jridgewell/sourcemap-codec" "^1.5.5"
|
||||||
|
|
||||||
mitt@^3.0.1:
|
|
||||||
version "3.0.1"
|
|
||||||
resolved "https://registry.yarnpkg.com/mitt/-/mitt-3.0.1.tgz#ea36cf0cc30403601ae074c8f77b7092cdab36d1"
|
|
||||||
integrity sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==
|
|
||||||
|
|
||||||
modern-tar@^0.7.6:
|
|
||||||
version "0.7.7"
|
|
||||||
resolved "https://registry.yarnpkg.com/modern-tar/-/modern-tar-0.7.7.tgz#ca71d79603630076b10733b0751ccab284bbc1ef"
|
|
||||||
integrity sha512-t9VmxaqrmANnEOBhpSDI6HD192Ge48k8vmWqQQL7hSFEqHEYwZbbsu49+aKLWZeRvFs3j1pMhXOqqF4kPlvjkQ==
|
|
||||||
|
|
||||||
nanoid@^3.3.11:
|
nanoid@^3.3.11:
|
||||||
version "3.3.11"
|
version "3.3.11"
|
||||||
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b"
|
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b"
|
||||||
@@ -738,18 +673,6 @@ prettier@^3.8.1:
|
|||||||
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.8.1.tgz#edf48977cf991558f4fcbd8a3ba6015ba2a3a173"
|
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.8.1.tgz#edf48977cf991558f4fcbd8a3ba6015ba2a3a173"
|
||||||
integrity sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==
|
integrity sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==
|
||||||
|
|
||||||
puppeteer-core@25.5.0:
|
|
||||||
version "25.5.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/puppeteer-core/-/puppeteer-core-25.5.0.tgz#a41b14d582056b998e0bc3561ac47c7615d38a53"
|
|
||||||
integrity sha512-XPNT0dQJtphqQ4I29zxlG4IIPbg1iEHAQKWuQgtMJGXjACV77pZSmJvDi51IIIfd+DTKICcopJwUx4upVQ4XbA==
|
|
||||||
dependencies:
|
|
||||||
"@puppeteer/browsers" "3.1.0"
|
|
||||||
chromium-bidi "17.0.2"
|
|
||||||
devtools-protocol "0.0.1653615"
|
|
||||||
typed-query-selector "^2.12.2"
|
|
||||||
webdriver-bidi-protocol "0.4.2"
|
|
||||||
ws "^8.21.1"
|
|
||||||
|
|
||||||
rollup@^4.43.0:
|
rollup@^4.43.0:
|
||||||
version "4.57.0"
|
version "4.57.0"
|
||||||
resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.57.0.tgz#9fa13c1fb779d480038f45708b5e01b9449b6853"
|
resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.57.0.tgz#9fa13c1fb779d480038f45708b5e01b9449b6853"
|
||||||
@@ -789,30 +712,6 @@ source-map-js@^1.2.1:
|
|||||||
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46"
|
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46"
|
||||||
integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==
|
integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==
|
||||||
|
|
||||||
string-width@^7.0.0, string-width@^7.2.0:
|
|
||||||
version "7.2.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/string-width/-/string-width-7.2.0.tgz#b5bb8e2165ce275d4d43476dd2700ad9091db6dc"
|
|
||||||
integrity sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==
|
|
||||||
dependencies:
|
|
||||||
emoji-regex "^10.3.0"
|
|
||||||
get-east-asian-width "^1.0.0"
|
|
||||||
strip-ansi "^7.1.0"
|
|
||||||
|
|
||||||
string-width@^8.2.1:
|
|
||||||
version "8.2.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/string-width/-/string-width-8.2.2.tgz#7310516493df575742fe98af6fae87d85d5ed0ac"
|
|
||||||
integrity sha512-GaPUh5gfdrYzqeVNZvUfT23vYYxXzKYidUcnMtJg/3rxRV63EFZy3k6xfKlmfeJD0176lnUV/Usr3XcwSvFzpg==
|
|
||||||
dependencies:
|
|
||||||
get-east-asian-width "^1.5.0"
|
|
||||||
strip-ansi "^7.1.2"
|
|
||||||
|
|
||||||
strip-ansi@^7.1.0, strip-ansi@^7.1.2:
|
|
||||||
version "7.2.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.2.0.tgz#d22a269522836a627af8d04b5c3fd2c7fa3e32e3"
|
|
||||||
integrity sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==
|
|
||||||
dependencies:
|
|
||||||
ansi-regex "^6.2.2"
|
|
||||||
|
|
||||||
tailwindcss@4.1.18, tailwindcss@^4.1.18:
|
tailwindcss@4.1.18, tailwindcss@^4.1.18:
|
||||||
version "4.1.18"
|
version "4.1.18"
|
||||||
resolved "https://registry.yarnpkg.com/tailwindcss/-/tailwindcss-4.1.18.tgz#f488ba47853abdb5354daf9679d3e7791fc4f4e3"
|
resolved "https://registry.yarnpkg.com/tailwindcss/-/tailwindcss-4.1.18.tgz#f488ba47853abdb5354daf9679d3e7791fc4f4e3"
|
||||||
@@ -836,11 +735,6 @@ tslib@^2.4.0:
|
|||||||
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f"
|
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f"
|
||||||
integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==
|
integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==
|
||||||
|
|
||||||
typed-query-selector@^2.12.2:
|
|
||||||
version "2.12.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/typed-query-selector/-/typed-query-selector-2.12.2.tgz#65e2462ac6b0aecfae1bfac1a4f3027070dbabaa"
|
|
||||||
integrity sha512-EOPFbyIub4ngnEdqi2yOcNeDLaX/0jcE1JoAXQDDMIthap7FoN795lc/SHfIq2d416VufXpM8z/lD+WRm2gfOQ==
|
|
||||||
|
|
||||||
update-browserslist-db@^1.2.0:
|
update-browserslist-db@^1.2.0:
|
||||||
version "1.2.3"
|
version "1.2.3"
|
||||||
resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz#64d76db58713136acbeb4c49114366cc6cc2e80d"
|
resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz#64d76db58713136acbeb4c49114366cc6cc2e80d"
|
||||||
@@ -862,49 +756,3 @@ vite@^7.3.1:
|
|||||||
tinyglobby "^0.2.15"
|
tinyglobby "^0.2.15"
|
||||||
optionalDependencies:
|
optionalDependencies:
|
||||||
fsevents "~2.3.3"
|
fsevents "~2.3.3"
|
||||||
|
|
||||||
webdriver-bidi-protocol@0.4.2:
|
|
||||||
version "0.4.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/webdriver-bidi-protocol/-/webdriver-bidi-protocol-0.4.2.tgz#f51bb71c2606e90e3d5727607c728b25d617b58b"
|
|
||||||
integrity sha512-VSV+fzfChirL3e7jay2yUC7B4HQCGtEWEg/MSSQbK+qWbqeGlRLlXTzPpYr3XGUvbpDHumWZBJxgesg4N7dbtA==
|
|
||||||
|
|
||||||
wrap-ansi@^9.0.0:
|
|
||||||
version "9.0.2"
|
|
||||||
resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-9.0.2.tgz#956832dea9494306e6d209eb871643bb873d7c98"
|
|
||||||
integrity sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==
|
|
||||||
dependencies:
|
|
||||||
ansi-styles "^6.2.1"
|
|
||||||
string-width "^7.0.0"
|
|
||||||
strip-ansi "^7.1.0"
|
|
||||||
|
|
||||||
ws@^8.21.1:
|
|
||||||
version "8.21.3"
|
|
||||||
resolved "https://registry.yarnpkg.com/ws/-/ws-8.21.3.tgz#660b4faddb6a3e575c86e078126919961f4de4fc"
|
|
||||||
integrity sha512-201TZ/kPWxoPr/OKWjquZR1SWKXcvxdH+e1xrx89b3YbmzLMFCLfnaG1HFIgWzJOEWZ7MvpK++odZufgYR50Rw==
|
|
||||||
|
|
||||||
y18n@^5.0.5:
|
|
||||||
version "5.0.8"
|
|
||||||
resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55"
|
|
||||||
integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==
|
|
||||||
|
|
||||||
yargs-parser@^22.0.0:
|
|
||||||
version "22.0.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-22.0.0.tgz#87b82094051b0567717346ecd00fd14804b357c8"
|
|
||||||
integrity sha512-rwu/ClNdSMpkSrUb+d6BRsSkLUq1fmfsY6TOpYzTwvwkg1/NRG85KBy3kq++A8LKQwX6lsu+aWad+2khvuXrqw==
|
|
||||||
|
|
||||||
yargs@^18.0.0:
|
|
||||||
version "18.1.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/yargs/-/yargs-18.1.0.tgz#cd7e98c703ef51695bbbf062ed58f28e94291b56"
|
|
||||||
integrity sha512-2rAgRKu54VsHkqI0/tYkmluGXHD4KW7yZoycuqDQ15QOTnc2VVfy0nN/1eMhnQLO00A+dwtK20xuCnc1YGeUyg==
|
|
||||||
dependencies:
|
|
||||||
cliui "^9.0.1"
|
|
||||||
escalade "^3.1.1"
|
|
||||||
get-caller-file "^2.0.5"
|
|
||||||
string-width "^8.2.1"
|
|
||||||
y18n "^5.0.5"
|
|
||||||
yargs-parser "^22.0.0"
|
|
||||||
|
|
||||||
zod@^3.24.1:
|
|
||||||
version "3.25.76"
|
|
||||||
resolved "https://registry.yarnpkg.com/zod/-/zod-3.25.76.tgz#26841c3f6fd22a6a2760e7ccb719179768471e34"
|
|
||||||
integrity sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==
|
|
||||||
|
|||||||
Reference in New Issue
Block a user