Compare commits
36 Commits
issue-70-l
...
6f37d05ab6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6f37d05ab6 | ||
| c3b6623be1 | |||
| 39064a3d6c | |||
| c378690977 | |||
| 279effb4c2 | |||
| 9ae19159a3 | |||
| 2ee720a9af | |||
| 0b457ea713 | |||
| 5f18bc3eae | |||
| d8f9d149b5 | |||
| 339548d794 | |||
| 95161c7768 | |||
| 0e397b3174 | |||
| be576096aa | |||
| 3941f0b0ff | |||
| 543005c0c2 | |||
| 9bfd033a29 | |||
| fd6397154a | |||
| d19e33671c | |||
| aab448b076 | |||
| 7c43e095a6 | |||
| 84b758b785 | |||
| d51cd0fd29 | |||
| 15a61173fc | |||
| e50a79ced9 | |||
| c2cd2c440b | |||
| 45890d4f82 | |||
| 0ce8565f51 | |||
| 3e261d2f01 | |||
| 62481a6f1a | |||
| 4f5ecb18e5 | |||
| 734606b7af | |||
| ee7c626071 | |||
| 81413c56e9 | |||
| f6b929f2d7 | |||
| 8ea7f76540 |
@@ -1,5 +1,13 @@
|
|||||||
|
# .ci-fingerprint is deliberately NOT excluded: it is the CI cache barrier
|
||||||
|
# that keeps the check stages from replaying a cached pass. See the lint
|
||||||
|
# stage of the Dockerfile.
|
||||||
.git/
|
.git/
|
||||||
bin/
|
bin/
|
||||||
|
# Third-party browser assets are fetched and hash-verified inside the build by
|
||||||
|
# script/fetch-assets. Excluding any host copy keeps a developer's working tree
|
||||||
|
# from supplying the bytes that get shipped. The script and its
|
||||||
|
# static/vendor.sha256 manifest stay in the context.
|
||||||
|
static/js/alpine.min.js
|
||||||
*.md
|
*.md
|
||||||
LICENSE
|
LICENSE
|
||||||
.editorconfig
|
.editorconfig
|
||||||
|
|||||||
@@ -11,5 +11,53 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 2024-10-23
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 2024-10-23
|
||||||
|
with:
|
||||||
|
# The fingerprint step below needs history to find the last commit
|
||||||
|
# that touched the Docker build context.
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Neutralize superseded run statuses
|
||||||
|
# Gitea cancels the in-flight run when another commit is pushed to the
|
||||||
|
# same branch and records the cancellation as `failure`, so a commit
|
||||||
|
# that was never tested reads red. The cancellation is unconditional
|
||||||
|
# server-side for push events and cannot be disabled from a workflow
|
||||||
|
# file, so the superseding run rewrites those statuses to `skipped`.
|
||||||
|
# Only the exact cancellation status is touched; a real failure is
|
||||||
|
# left alone.
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
|
run: |
|
||||||
|
set -eu
|
||||||
|
api="${GITHUB_API_URL}/repos/${GITHUB_REPOSITORY}"
|
||||||
|
ctx='check / check (push)'
|
||||||
|
for sha in $(git rev-list --max-count=20 "${GITHUB_SHA}^" || true); do
|
||||||
|
latest="$(curl -sf "${api}/commits/${sha}/status" | jq -r \
|
||||||
|
--arg c "$ctx" \
|
||||||
|
'[.statuses[] | select(.context == $c)][0] // empty
|
||||||
|
| "\(.status)|\(.description)"')" || continue
|
||||||
|
[ "$latest" = 'failure|Has been cancelled' ] || continue
|
||||||
|
curl -sf -X POST "${api}/statuses/${sha}" \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d "$(jq -nc --arg c "$ctx" '{
|
||||||
|
context: $c,
|
||||||
|
state: "skipped",
|
||||||
|
description: "Superseded by a newer commit; never tested"
|
||||||
|
}')" >/dev/null
|
||||||
|
echo "neutralized superseded status on ${sha}"
|
||||||
|
done
|
||||||
|
|
||||||
|
- name: Fingerprint the build context
|
||||||
|
# `.dockerignore` keeps docs out of the build context, so a docs-only
|
||||||
|
# commit legitimately replays the whole image from cache and stays
|
||||||
|
# cheap. Every other commit writes a new fingerprint into the context,
|
||||||
|
# which invalidates the `COPY . .` layer of both check stages: a
|
||||||
|
# commit that was never linted, formatted-checked, tested and built
|
||||||
|
# cannot report success from cache.
|
||||||
|
run: |
|
||||||
|
set -eu
|
||||||
|
fp="$(git log -1 --format=%H -- . ':!*.md' ':!LICENSE' ':!.editorconfig')"
|
||||||
|
printf '%s\n' "${fp:-$GITHUB_SHA}" > .ci-fingerprint
|
||||||
|
|
||||||
- name: Build Docker image (runs make check)
|
- name: Build Docker image (runs make check)
|
||||||
run: script/cibuild
|
run: script/cibuild
|
||||||
|
|||||||
8
.gitignore
vendored
8
.gitignore
vendored
@@ -42,3 +42,11 @@ data/
|
|||||||
# Temporary files
|
# Temporary files
|
||||||
tmp/
|
tmp/
|
||||||
temp/
|
temp/
|
||||||
|
|
||||||
|
# CI cache barrier, written into the build context by the check workflow
|
||||||
|
.ci-fingerprint
|
||||||
|
|
||||||
|
# Third-party browser assets, fetched and hash-verified by
|
||||||
|
# script/fetch-assets against static/vendor.sha256. Not committed:
|
||||||
|
# REPO_POLICIES.md forbids minified bundles in version control.
|
||||||
|
/static/js/alpine.min.js
|
||||||
@@ -1,5 +1,9 @@
|
|||||||
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
|
||||||
@@ -14,8 +18,7 @@ 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:
|
||||||
@@ -27,6 +30,5 @@ linters-settings:
|
|||||||
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
|
||||||
|
|||||||
23
Dockerfile
23
Dockerfile
@@ -1,8 +1,8 @@
|
|||||||
# Lint stage
|
# Lint stage
|
||||||
# golangci/golangci-lint:v2.11.3 (Debian-based), 2026-03-17
|
# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
|
||||||
# Using Debian-based image because mattn/go-sqlite3 (CGO) does not
|
# Using Debian-based image because mattn/go-sqlite3 (CGO) does not
|
||||||
# compile on Alpine musl (off64_t is a glibc type).
|
# compile on Alpine musl (off64_t is a glibc type).
|
||||||
FROM golangci/golangci-lint:v2.11.3@sha256:e838e8ab68aaefe83e2408691510867ade9329c0e0b895a3fb35eb93d1c2a4ba AS lint
|
FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS lint
|
||||||
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends make && rm -rf /var/lib/apt/lists/*
|
RUN apt-get update && apt-get install -y --no-install-recommends make && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
@@ -12,7 +12,11 @@ WORKDIR /src
|
|||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
|
|
||||||
# Copy source code
|
# Copy source code. In CI the context also carries .ci-fingerprint, whose
|
||||||
|
# value changes with every commit that touches the build context (see
|
||||||
|
# .gitea/workflows/check.yml). That invalidates this layer, so the checks
|
||||||
|
# below cannot report success by replaying a cached pass. Do not add it to
|
||||||
|
# .dockerignore.
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# Run formatting check and linter
|
# Run formatting check and linter
|
||||||
@@ -28,7 +32,7 @@ FROM golang:1.26.1-bookworm@sha256:4465644228bc2857a954b092167e12aa59c006a349228
|
|||||||
# Depend on lint stage passing
|
# Depend on lint stage passing
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends make && rm -rf /var/lib/apt/lists/*
|
RUN apt-get update && apt-get install -y --no-install-recommends make curl ca-certificates && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /build
|
WORKDIR /build
|
||||||
|
|
||||||
@@ -36,9 +40,18 @@ WORKDIR /build
|
|||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
|
|
||||||
# Copy source code
|
# Copy source code, including the .ci-fingerprint cache barrier described in
|
||||||
|
# the lint stage above.
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
|
# Fetch the third-party browser assets the UI serves. They are not committed
|
||||||
|
# (REPO_POLICIES.md forbids minified bundles in version control) and
|
||||||
|
# .dockerignore keeps any host copy out of the build context, so this step is
|
||||||
|
# the only way they enter the image. Each download is checked against a
|
||||||
|
# hardcoded sha256 and the build fails on mismatch; make test re-checks the
|
||||||
|
# hashes against the bytes go:embed actually put in the binary.
|
||||||
|
RUN script/fetch-assets
|
||||||
|
|
||||||
# Run tests and build
|
# Run tests and build
|
||||||
RUN make test
|
RUN make test
|
||||||
RUN make build
|
RUN make build
|
||||||
|
|||||||
5
Makefile
5
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: bootstrap setup test lint fmt fmt-check check build run dev deps docker clean hooks css
|
.PHONY: bootstrap setup assets test lint fmt fmt-check check build run dev deps docker clean hooks css
|
||||||
|
|
||||||
# Default target
|
# Default target
|
||||||
.DEFAULT_GOAL := check
|
.DEFAULT_GOAL := check
|
||||||
@@ -9,6 +9,9 @@ bootstrap:
|
|||||||
setup:
|
setup:
|
||||||
@script/setup
|
@script/setup
|
||||||
|
|
||||||
|
assets:
|
||||||
|
@script/fetch-assets
|
||||||
|
|
||||||
test:
|
test:
|
||||||
@script/test
|
@script/test
|
||||||
|
|
||||||
|
|||||||
689
README.md
689
README.md
@@ -11,9 +11,14 @@ with retry support, logging, and observability. Category: infrastructure
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Go 1.26+
|
- Go 1.26.1+ (the version in `go.mod`)
|
||||||
- golangci-lint v2.11+
|
- golangci-lint v2.12.2 (the version pinned in `script/bootstrap` and
|
||||||
- Docker (for containerized deployment)
|
in the `Dockerfile`'s lint stage; `make bootstrap` installs it)
|
||||||
|
- Docker (for containerized deployment, and for the lint and test
|
||||||
|
stages of the CI gate)
|
||||||
|
- `curl`, used by `script/fetch-assets` to download the third-party
|
||||||
|
browser assets, which are not committed (`make bootstrap` installs
|
||||||
|
it if missing)
|
||||||
|
|
||||||
### Quick Start
|
### Quick Start
|
||||||
|
|
||||||
@@ -22,14 +27,18 @@ with retry support, logging, and observability. Category: infrastructure
|
|||||||
git clone https://git.eeqj.de/sneak/webhooker.git
|
git clone https://git.eeqj.de/sneak/webhooker.git
|
||||||
cd webhooker
|
cd webhooker
|
||||||
|
|
||||||
# Install Go dependencies
|
# Install Go dependencies, the pinned linter, and the third-party
|
||||||
make deps
|
# browser assets. `make deps` alone is not enough: it only runs
|
||||||
|
# go mod download/tidy, and the checks below need the fetched assets.
|
||||||
|
make bootstrap
|
||||||
|
|
||||||
# Run all checks (format, lint, test, build)
|
# Run all checks (test, lint, format check)
|
||||||
make check
|
make check
|
||||||
|
|
||||||
# Run in development mode (uses SQLite in current directory)
|
# Run in development mode. DATA_DIR defaults to /var/lib/webhooker in
|
||||||
make dev
|
# every environment, so set it (in .env or the shell) to a writable
|
||||||
|
# directory when running from a clone.
|
||||||
|
DATA_DIR=./data make dev
|
||||||
|
|
||||||
# Build Docker image
|
# Build Docker image
|
||||||
make docker
|
make docker
|
||||||
@@ -40,14 +49,20 @@ make docker
|
|||||||
```bash
|
```bash
|
||||||
make bootstrap # Install all dependencies (idempotent)
|
make bootstrap # Install all dependencies (idempotent)
|
||||||
make setup # Bootstrap + install git pre-commit hook
|
make setup # Bootstrap + install git pre-commit hook
|
||||||
|
make assets # Fetch + verify third-party browser assets
|
||||||
make fmt # Format code (gofmt + goimports)
|
make fmt # Format code (gofmt + goimports)
|
||||||
|
make fmt-check # Fail if gofmt would change anything (writes nothing)
|
||||||
make lint # Run golangci-lint
|
make lint # Run golangci-lint
|
||||||
make test # Run tests with race detection
|
make test # Run tests with race detection
|
||||||
make check # test + lint + fmt-check (CI gate)
|
make check # test + lint + fmt-check (CI gate)
|
||||||
make build # Build binary to bin/webhooker
|
make build # Build binary to bin/webhooker
|
||||||
|
make run # build, then run ./bin/webhooker
|
||||||
make dev # go run ./cmd/webhooker
|
make dev # go run ./cmd/webhooker
|
||||||
|
make deps # go mod download + go mod tidy
|
||||||
make docker # Build Docker image
|
make docker # Build Docker image
|
||||||
make hooks # Install git pre-commit hook that runs script/precommit
|
make hooks # Install git pre-commit hook that runs script/precommit
|
||||||
|
make css # Regenerate static/css/tailwind.css (needs tailwindcss)
|
||||||
|
make clean # Remove bin/
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
@@ -89,9 +104,133 @@ TTY detection, and security headers are always applied.
|
|||||||
| `PORT` | HTTP listen port | `8080` |
|
| `PORT` | HTTP listen port | `8080` |
|
||||||
| `DATA_DIR` | Directory for all SQLite databases | `/var/lib/webhooker` |
|
| `DATA_DIR` | Directory for all SQLite databases | `/var/lib/webhooker` |
|
||||||
| `DEBUG` | Enable debug logging | `false` |
|
| `DEBUG` | Enable debug logging | `false` |
|
||||||
|
| `MAINTENANCE_MODE` | Report `maintenanceMode: true` in the healthcheck JSON. It does not change how any request is served — no maintenance page exists | `false` |
|
||||||
| `METRICS_USERNAME` | Basic auth username for `/metrics` | `""` |
|
| `METRICS_USERNAME` | Basic auth username for `/metrics` | `""` |
|
||||||
| `METRICS_PASSWORD` | Basic auth password for `/metrics` | `""` |
|
| `METRICS_PASSWORD` | Basic auth password for `/metrics` | `""` |
|
||||||
| `SENTRY_DSN` | Sentry error reporting DSN | `""` |
|
| `SENTRY_DSN` | Sentry error reporting DSN | `""` |
|
||||||
|
| `RETENTION_SWEEP_INTERVAL` | How often the retention reaper and archive sweeper run (Go duration, must be positive) | `1h` |
|
||||||
|
| `SESSION_IDLE_TIMEOUT` | Idle session timeout (Go duration) | `24h` |
|
||||||
|
| `RECEIVER_RATE_LIMIT` | Receiver requests/minute per IP per entrypoint (10x that per IP across the route) | `120` |
|
||||||
|
| `TRUSTED_PROXIES` | CIDRs whose forwarded headers are trusted (unset: all clients behind a proxy share one rate-limit bucket) | `""` (none) |
|
||||||
|
|
||||||
|
#### Trusted proxies
|
||||||
|
|
||||||
|
`TRUSTED_PROXIES` is a comma-separated list of CIDR blocks (a bare
|
||||||
|
address such as `192.168.1.7` is accepted and treated as a single
|
||||||
|
host), for example `192.168.1.7, 2001:db8::5`. It decides whose
|
||||||
|
`X-Forwarded-For` header the rate limiters believe, so it should name
|
||||||
|
the addresses of your reverse proxies and nothing else.
|
||||||
|
|
||||||
|
`X-Forwarded-For` is honoured **only** when the connecting peer is
|
||||||
|
inside one of these blocks; for every other peer the client identity is
|
||||||
|
the connection's own address and the header is ignored. The default is
|
||||||
|
the empty list, which trusts nobody — anything else would let any
|
||||||
|
client pick its own rate limit bucket, minting a fresh one per request
|
||||||
|
or draining someone else's. Set it to the address of your reverse
|
||||||
|
proxy, and to nothing wider. A set but unparseable value aborts
|
||||||
|
startup.
|
||||||
|
|
||||||
|
That default is safe against forged headers, but leaving it unset in
|
||||||
|
production has a cost you must know about. Production runs behind a
|
||||||
|
TLS-terminating reverse proxy, so with `TRUSTED_PROXIES` unset every
|
||||||
|
request keys on the proxy's own address and all clients share a single
|
||||||
|
bucket per limit. For the login and password-change limits that is a
|
||||||
|
denial of service anyone can perform: a steady five POSTs per minute
|
||||||
|
from any address on the internet keeps the shared login bucket full,
|
||||||
|
and the operator's own login then returns HTTP 429 for as long as the
|
||||||
|
trickle continues. There is no second administrative path and no
|
||||||
|
bypass. Restarting the service clears the in-memory buckets, but a
|
||||||
|
sustained trickle re-locks them immediately.
|
||||||
|
|
||||||
|
The remedy is to set `TRUSTED_PROXIES` to your reverse proxy's
|
||||||
|
address, which restores per-client buckets. webhooker logs a warning
|
||||||
|
at startup whenever `TRUSTED_PROXIES` is empty, in every environment —
|
||||||
|
not only when `WEBHOOKER_ENVIRONMENT=prod`, because that variable
|
||||||
|
defaults to `dev` and an operator who never set it is precisely the
|
||||||
|
one at risk. The warning is informational when nothing proxies to the
|
||||||
|
process: with no proxy in front, the peer address is the client's own
|
||||||
|
and the buckets are already per-client. See
|
||||||
|
[Rate Limiting](#rate-limiting) for what each limit shares.
|
||||||
|
|
||||||
|
`X-Real-IP` and `True-Client-IP` are **never** read, from any peer.
|
||||||
|
Reverse proxies append to `X-Forwarded-For` but forward other client
|
||||||
|
headers verbatim, so a single-valued header is client-controlled even
|
||||||
|
behind a trusted proxy.
|
||||||
|
|
||||||
|
Within a trusted request, `X-Forwarded-For` is read right to left,
|
||||||
|
because the rightmost entry is the one the nearest proxy appended and
|
||||||
|
everything left of it may have been written by the client. The first
|
||||||
|
hop that is not itself a trusted proxy is taken as the client. A hop
|
||||||
|
that is not a bare IP address — `ip:port`, a bracketed IPv6 literal,
|
||||||
|
the token `unknown` — ends the walk and the peer address is used
|
||||||
|
instead, since past such an entry the chain is not the shape assumed
|
||||||
|
here. The peer address is likewise used when the header is absent or
|
||||||
|
every hop in it is a trusted proxy.
|
||||||
|
|
||||||
|
Two operator requirements follow:
|
||||||
|
|
||||||
|
- Your proxy must **append** the peer address to `X-Forwarded-For`
|
||||||
|
(nginx `$proxy_add_x_forwarded_for`, HAProxy `option forwardfor`,
|
||||||
|
Caddy and AWS ALB by default), and must append a bare address with
|
||||||
|
no port.
|
||||||
|
- List proxy hosts **only**. Any address inside `TRUSTED_PROXIES`
|
||||||
|
chooses its own rate-limit key: its `X-Forwarded-For` is walked, so
|
||||||
|
it can name a different address on every request to get a fresh
|
||||||
|
bucket each time, or name another client's address to drain that
|
||||||
|
client's bucket. Never list a block that also covers clients — a
|
||||||
|
broad `10.0.0.0/8` on a network where clients live in the same range
|
||||||
|
makes all three limits, including the unauthenticated webhook
|
||||||
|
receiver, silently bypassable by every client in the block.
|
||||||
|
|
||||||
|
#### Sessions
|
||||||
|
|
||||||
|
Sessions are bounded by two independent clocks, and end at whichever
|
||||||
|
one runs out first:
|
||||||
|
|
||||||
|
- **Idle expiry** (`SESSION_IDLE_TIMEOUT`, default `24h`) is a sliding
|
||||||
|
window. Every authenticated request pushes it forward, so a session
|
||||||
|
in continuous use never hits it, while an abandoned one expires a day
|
||||||
|
after its last use. Any non-positive value (`0`, or a negative
|
||||||
|
duration such as `-1s`) disables idle expiry entirely; the absolute
|
||||||
|
cap below still applies. A set-but-unparseable value aborts startup
|
||||||
|
rather than silently falling back to the default.
|
||||||
|
- **Absolute expiry** is a fixed 7 days from login. Activity does
|
||||||
|
**not** extend it: after a week, every session ends and the user
|
||||||
|
authenticates again.
|
||||||
|
|
||||||
|
Only requests that authenticate with the session count as activity, so
|
||||||
|
an unauthenticated request carrying the cookie cannot keep a session
|
||||||
|
alive. The idle timestamp is rewritten at most once per tenth of the
|
||||||
|
idle window rather than on every request, which means a session may
|
||||||
|
expire up to 10% early relative to the user's true last request, but
|
||||||
|
never late.
|
||||||
|
|
||||||
|
Both clocks are anchored by timestamps stored in the session cookie.
|
||||||
|
Sessions issued before this feature existed carry neither, so they are
|
||||||
|
treated as expired: upgrading to a build that has it logs every
|
||||||
|
existing session out once, and those users sign in again.
|
||||||
|
|
||||||
|
#### Invalid values abort startup
|
||||||
|
|
||||||
|
The defaults above apply **only** to variables that are unset (or set
|
||||||
|
to an empty string). A variable that is set but cannot be parsed is a
|
||||||
|
fatal configuration error: webhooker logs the offending variable and
|
||||||
|
its value and refuses to start, rather than silently running with a
|
||||||
|
substituted default. `PORT=eighty`, `DEBUG=ture`, and
|
||||||
|
`RETENTION_SWEEP_INTERVAL=1 hour` all abort startup. `PORT` must
|
||||||
|
additionally be a number in the range 1–65535,
|
||||||
|
`RECEIVER_RATE_LIMIT` must be at least 1,
|
||||||
|
`RETENTION_SWEEP_INTERVAL` must be greater than zero (it is a ticker
|
||||||
|
period, so `0s` or a negative value would crash the reaper after
|
||||||
|
startup), and every entry in `TRUSTED_PROXIES` must be a CIDR block or
|
||||||
|
a bare IP address. `SESSION_IDLE_TIMEOUT` is the exception: a
|
||||||
|
non-positive value there means idle expiry is disabled, not invalid.
|
||||||
|
|
||||||
|
Boolean variables (`DEBUG`, `MAINTENANCE_MODE`) accept exactly the
|
||||||
|
spellings Go's `strconv.ParseBool` accepts — `1`, `t`, `T`, `TRUE`,
|
||||||
|
`true`, `True`, `0`, `f`, `F`, `FALSE`, `false`, `False` — and nothing
|
||||||
|
else. `yes`, `on`, and `off` are rejected rather than quietly treated
|
||||||
|
as false.
|
||||||
|
|
||||||
On first startup, webhooker automatically generates a cryptographically
|
On first startup, webhooker automatically generates a cryptographically
|
||||||
secure session encryption key and stores it in the database. This key
|
secure session encryption key and stores it in the database. This key
|
||||||
@@ -114,22 +253,27 @@ docker run -d \
|
|||||||
The container runs as a non-root user (`webhooker`, UID 1000), exposes
|
The container runs as a non-root user (`webhooker`, UID 1000), exposes
|
||||||
port 8080, and includes a health check against
|
port 8080, and includes a health check against
|
||||||
`/.well-known/healthcheck`. The `/var/lib/webhooker` volume holds all
|
`/.well-known/healthcheck`. The `/var/lib/webhooker` volume holds all
|
||||||
SQLite databases: the main application database (`webhooker.db`) and
|
SQLite databases: the main application database (`webhooker.db`), the
|
||||||
the per-webhook event databases (`events-{uuid}.db`). Mount this as a
|
per-webhook event databases (`events-{uuid}.db`), and any archive
|
||||||
persistent volume to preserve data across container restarts.
|
databases written by `database` targets (`archive-{uuid}.db`). Mount
|
||||||
|
this as a persistent volume to preserve data across container
|
||||||
|
restarts.
|
||||||
|
|
||||||
## 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
|
development workflow. Ten of the Makefile's sixteen targets are thin
|
||||||
them. We provide:
|
shims that call them; `build`, `run`, `dev`, `deps`, `clean` and `css`
|
||||||
|
are inline commands with no script behind them. We provide:
|
||||||
|
|
||||||
- `script/bootstrap` — install all dependencies (idempotent)
|
- `script/bootstrap` — install all dependencies (idempotent)
|
||||||
- `script/setup` — make a fresh clone ready for development
|
- `script/setup` — make a fresh clone ready for development
|
||||||
(bootstrap, then install-precommit)
|
(bootstrap, then install-precommit)
|
||||||
- `script/projectname` — output the project name ("webhooker")
|
- `script/projectname` — output the project name ("webhooker")
|
||||||
|
- `script/fetch-assets` — download the third-party browser assets into
|
||||||
|
`static/`, verifying each against its pinned sha256
|
||||||
- `script/test` — run the test suite
|
- `script/test` — run the test suite
|
||||||
- `script/lint` — run golangci-lint
|
- `script/lint` — run golangci-lint
|
||||||
- `script/fmt` — format all code (writes)
|
- `script/fmt` — format all code (writes)
|
||||||
@@ -143,6 +287,27 @@ them. We provide:
|
|||||||
- `script/install-precommit` — install the git pre-commit hook that
|
- `script/install-precommit` — install the git pre-commit hook that
|
||||||
runs `script/precommit`
|
runs `script/precommit`
|
||||||
|
|
||||||
|
## Third-party browser assets
|
||||||
|
|
||||||
|
The web UI serves one third-party script, Alpine.js. It is **not** committed:
|
||||||
|
a minified bundle in the tree is unreviewable, and `REPO_POLICIES.md` bars
|
||||||
|
both committed build artifacts and unpinned external references.
|
||||||
|
|
||||||
|
Instead `script/fetch-assets` downloads it from a pinned URL, checks the
|
||||||
|
download against a hardcoded sha256, and installs it under `static/`. The
|
||||||
|
sha256 of every installed asset is recorded in `static/vendor.sha256`, and
|
||||||
|
`static/vendor_test.go` re-hashes the bytes `go:embed` put in the binary
|
||||||
|
against that manifest — so the pin is enforced on what actually ships, not
|
||||||
|
merely written down. Any mismatch fails the build.
|
||||||
|
|
||||||
|
`make bootstrap` runs the fetch for local development, and the Dockerfile
|
||||||
|
runs it in the build stage; `.gitignore` and `.dockerignore` keep the
|
||||||
|
artifact out of both the repo and the build context.
|
||||||
|
|
||||||
|
To move to a new version: update the version, URL, and tarball sha256 in
|
||||||
|
`script/fetch-assets` and the asset sha256 in `static/vendor.sha256`, then
|
||||||
|
run `make assets && make check`.
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
Webhook integrations between services are inherently fragile. The
|
Webhook integrations between services are inherently fragile. The
|
||||||
@@ -171,9 +336,10 @@ webhooker solves this by acting as a durable intermediary:
|
|||||||
targets simultaneously. This enables patterns like forwarding a
|
targets simultaneously. This enables patterns like forwarding a
|
||||||
GitHub webhook to both a deployment service and a Slack channel.
|
GitHub webhook to both a deployment service and a Slack channel.
|
||||||
|
|
||||||
5. **Replay** — Stored events can be manually redelivered for debugging
|
5. **Replay** (not yet implemented) — Every received event is stored in
|
||||||
or testing, without requiring the original sender to fire the webhook
|
full, which is what manual redelivery for debugging or testing will
|
||||||
again.
|
be built on. No redelivery exists today, in the web UI or the API;
|
||||||
|
see [TODO.md](TODO.md).
|
||||||
|
|
||||||
### Use Cases
|
### Use Cases
|
||||||
|
|
||||||
@@ -183,6 +349,7 @@ webhooker solves this by acting as a durable intermediary:
|
|||||||
size, and delivery performance
|
size, and delivery performance
|
||||||
- **Debugging** and introspection of webhook payloads in the web UI
|
- **Debugging** and introspection of webhook payloads in the web UI
|
||||||
- **Replay** of webhook events for application testing and development
|
- **Replay** of webhook events for application testing and development
|
||||||
|
(planned; not yet implemented)
|
||||||
- **Fan-out** delivery of a single webhook to multiple downstream
|
- **Fan-out** delivery of a single webhook to multiple downstream
|
||||||
targets
|
targets
|
||||||
- **High-availability ingestion** for delivery to less reliable backend
|
- **High-availability ingestion** for delivery to less reliable backend
|
||||||
@@ -211,7 +378,11 @@ It uses:
|
|||||||
- **[gorilla/csrf](https://github.com/gorilla/csrf)** for CSRF
|
- **[gorilla/csrf](https://github.com/gorilla/csrf)** for CSRF
|
||||||
protection (cookie-based double-submit tokens)
|
protection (cookie-based double-submit tokens)
|
||||||
- **[go-chi/httprate](https://github.com/go-chi/httprate)** for
|
- **[go-chi/httprate](https://github.com/go-chi/httprate)** for
|
||||||
per-IP login rate limiting (sliding window counter)
|
sliding-window rate limiting of the login, password-change and
|
||||||
|
webhook receiver endpoints. The bucket is per client IP only when
|
||||||
|
`TRUSTED_PROXIES` names the reverse proxy; unset, every client
|
||||||
|
behind that proxy shares one bucket per limit (see
|
||||||
|
[Rate Limiting](#rate-limiting))
|
||||||
- **[Prometheus](https://prometheus.io)** for metrics, served at
|
- **[Prometheus](https://prometheus.io)** for metrics, served at
|
||||||
`/metrics` behind basic auth
|
`/metrics` behind basic auth
|
||||||
- **[Sentry](https://sentry.io)** for optional error reporting
|
- **[Sentry](https://sentry.io)** for optional error reporting
|
||||||
@@ -229,7 +400,7 @@ The codebase uses consistent naming throughout (rename completed in
|
|||||||
|
|
||||||
### Data Model
|
### Data Model
|
||||||
|
|
||||||
webhooker's data model has eight entities organized into two tiers: the
|
webhooker's data model has nine entities organized into two tiers: the
|
||||||
**application tier** (user and webhook configuration) and the **event
|
**application tier** (user and webhook configuration) and the **event
|
||||||
tier** (event ingestion, delivery, and logging).
|
tier** (event ingestion, delivery, and logging).
|
||||||
|
|
||||||
@@ -307,13 +478,45 @@ event routing.
|
|||||||
| `user_id` | UUID | Foreign key → User |
|
| `user_id` | UUID | Foreign key → User |
|
||||||
| `name` | string | Human-readable name |
|
| `name` | string | Human-readable name |
|
||||||
| `description` | string | Optional description |
|
| `description` | string | Optional description |
|
||||||
| `retention_days` | integer | Days to retain events (default: 30) |
|
| `retention_days` | integer | Days to retain events (default: 30; 0 means retain forever) |
|
||||||
|
|
||||||
**Relations:** Belongs to User. Has many Entrypoints. Has many Targets.
|
**Relations:** Belongs to User. Has many Entrypoints. Has many Targets.
|
||||||
|
|
||||||
The `retention_days` field controls how long event data is kept in the
|
The `retention_days` field controls how long event data is kept in the
|
||||||
webhook's dedicated database before automatic cleanup.
|
webhook's dedicated database before automatic cleanup.
|
||||||
|
|
||||||
|
Setting `retention_days` to `0` means "retain events forever". Because
|
||||||
|
the column carries a default of 30, a literal zero cannot survive an
|
||||||
|
insert, so a zero is rewritten on save to a sentinel of `365 * 1000`
|
||||||
|
days (`database.RetentionForeverDays`). The retention reaper recognises
|
||||||
|
that sentinel and skips the webhook entirely, and the web UI displays
|
||||||
|
such a webhook's retention as "forever" rather than as a day count.
|
||||||
|
|
||||||
|
Submitted `retention_days` values therefore fall into three bands, not
|
||||||
|
two:
|
||||||
|
|
||||||
|
- `1` up to `database.MaxFiniteRetentionDays` (106751 days, about 292
|
||||||
|
years) is accepted as a finite retention.
|
||||||
|
- Above that ceiling but below the retain-forever sentinel of 365000
|
||||||
|
(`database.RetentionForeverDays`) is rejected with a 400. This is the
|
||||||
|
band the cap exists for.
|
||||||
|
- `0`, and `365000` or above, are accepted and mean retain forever,
|
||||||
|
collapsing to the sentinel — `0` in `Webhook.BeforeSave`, the large
|
||||||
|
values in `parseRetentionDays`. The large values are not out of
|
||||||
|
range: the edit form pre-fills the sentinel for a retain-forever
|
||||||
|
webhook, so submitting that form back unchanged has to keep meaning
|
||||||
|
"forever".
|
||||||
|
|
||||||
|
A negative value is in none of the three: `parseRetentionDays` rejects
|
||||||
|
it with a 400 before `BeforeSave` ever sees it.
|
||||||
|
|
||||||
|
The cap is not arbitrary: the reaper computes its cutoff as a
|
||||||
|
`time.Duration`, an int64 nanosecond count, and a longer period
|
||||||
|
overflows it. An overflowed cutoff lands in the future, where it
|
||||||
|
matches every row, so the sweep would delete every event the webhook
|
||||||
|
has instead of none. The reaper also clamps the value it is given, so a
|
||||||
|
row written by an older version cannot trigger that either.
|
||||||
|
|
||||||
#### Entrypoint
|
#### Entrypoint
|
||||||
|
|
||||||
A receiver URL where external services POST webhook events. Each
|
A receiver URL where external services POST webhook events. Each
|
||||||
@@ -325,7 +528,7 @@ the full request and creates an Event.
|
|||||||
| -------------- | ------- | ----------- |
|
| -------------- | ------- | ----------- |
|
||||||
| `id` | UUID | Primary key |
|
| `id` | UUID | Primary key |
|
||||||
| `webhook_id` | UUID | Foreign key → Webhook |
|
| `webhook_id` | UUID | Foreign key → Webhook |
|
||||||
| `path` | string | Unique URL path (UUID-based, e.g. `/webhook/{uuid}`) |
|
| `path` | string | Unique bare UUID, generated at creation. The `/webhook/` prefix is route only and is not stored: the receiver matches this column against the raw `{uuid}` path segment |
|
||||||
| `description` | string | Optional description |
|
| `description` | string | Optional description |
|
||||||
| `active` | boolean | Whether this entrypoint accepts events (default: true) |
|
| `active` | boolean | Whether this entrypoint accepts events (default: true) |
|
||||||
|
|
||||||
@@ -349,8 +552,8 @@ events should be forwarded.
|
|||||||
| `type` | TargetType | One of: `http`, `slack`, `database`, `log` |
|
| `type` | TargetType | One of: `http`, `slack`, `database`, `log` |
|
||||||
| `active` | boolean | Whether deliveries are enabled (default: true) |
|
| `active` | boolean | Whether deliveries are enabled (default: true) |
|
||||||
| `config` | JSON text | Type-specific configuration |
|
| `config` | JSON text | Type-specific configuration |
|
||||||
| `max_retries` | integer | Maximum retry attempts for HTTP targets (0 = fire-and-forget, >0 = retries with backoff) |
|
| `max_retries` | integer | Maximum retry attempts for `http` and `slack` targets (0 = fire-and-forget, >0 = retries with backoff and a circuit breaker). Ignored by `database` and `log` targets |
|
||||||
| `max_queue_size` | integer | Maximum queued deliveries (for HTTP targets with retries) |
|
| `max_queue_size` | integer | Stored and shown on the target's detail view, but not enforced anywhere yet: nothing in the delivery engine consults it. Queue depth is set by the two fixed 10,000-entry channels |
|
||||||
|
|
||||||
**Relations:** Belongs to Webhook. Has many Deliveries.
|
**Relations:** Belongs to Webhook. Has many Deliveries.
|
||||||
|
|
||||||
@@ -363,10 +566,17 @@ events should be forwarded.
|
|||||||
greater than 0, failed deliveries are retried with exponential backoff
|
greater than 0, failed deliveries are retried with exponential backoff
|
||||||
up to `max_retries` attempts, protected by a per-target circuit
|
up to `max_retries` attempts, protected by a per-target circuit
|
||||||
breaker.
|
breaker.
|
||||||
- **`database`** — Confirm the event is stored in the webhook's
|
- **`slack`** — Post the event as a formatted message to a
|
||||||
per-webhook database (no external delivery). Since events are always
|
Slack-compatible incoming webhook URL (`webhookUrl` in `config`). It
|
||||||
written to the per-webhook DB on ingestion, this target marks delivery
|
is built on the same HTTP core as `http` and honours `max_retries`
|
||||||
as immediately successful. Useful for ensuring durable event archival.
|
identically, circuit breaker included. See the Slack target section
|
||||||
|
under "Per-Webhook Event Databases" for the message format.
|
||||||
|
- **`database`** — Archive the full event as a row into a separate
|
||||||
|
per-webhook archive database (`archive-{webhookID}.db`) for long-term
|
||||||
|
retention, with an optional creation-validated expiry (default: keep
|
||||||
|
forever). No external delivery and no retries; an archive write
|
||||||
|
failure fails the delivery. See the database target section under
|
||||||
|
"Per-Webhook Event Databases" for the full semantics.
|
||||||
- **`log`** — Write the event to the application log (stdout). Useful
|
- **`log`** — Write the event to the application log (stdout). Useful
|
||||||
for debugging.
|
for debugging.
|
||||||
|
|
||||||
@@ -390,14 +600,14 @@ A programmatic access credential for API authentication.
|
|||||||
#### Event
|
#### Event
|
||||||
|
|
||||||
A captured incoming webhook request. Stores the complete HTTP request
|
A captured incoming webhook request. Stores the complete HTTP request
|
||||||
data for replay and auditing.
|
data for auditing and for the planned replay capability.
|
||||||
|
|
||||||
| Field | Type | Description |
|
| Field | Type | Description |
|
||||||
| -------------- | ------ | ----------- |
|
| -------------- | ------ | ----------- |
|
||||||
| `id` | UUID | Primary key |
|
| `id` | UUID | Primary key |
|
||||||
| `webhook_id` | UUID | Foreign key → Webhook |
|
| `webhook_id` | UUID | Foreign key → Webhook |
|
||||||
| `entrypoint_id` | UUID | Foreign key → Entrypoint |
|
| `entrypoint_id` | UUID | Foreign key → Entrypoint |
|
||||||
| `method` | string | HTTP method (POST, PUT, etc.) |
|
| `method` | string | HTTP method of the captured request. Always `POST`: the receiver answers every other method with 405 before an Event is created |
|
||||||
| `headers` | JSON | Complete request headers |
|
| `headers` | JSON | Complete request headers |
|
||||||
| `body` | text | Raw request body |
|
| `body` | text | Raw request body |
|
||||||
| `content_type` | string | Content-Type header value |
|
| `content_type` | string | Content-Type header value |
|
||||||
@@ -452,7 +662,9 @@ retries) is individually logged for full observability.
|
|||||||
|
|
||||||
#### Common Fields
|
#### Common Fields
|
||||||
|
|
||||||
All entities include these fields from `BaseModel`:
|
Every entity except `Setting` includes these fields from `BaseModel`.
|
||||||
|
`Setting` is a bare key-value row with no `id`, no timestamps and no
|
||||||
|
soft delete:
|
||||||
|
|
||||||
| Field | Type | Description |
|
| Field | Type | Description |
|
||||||
| ------------ | --------- | ----------- |
|
| ------------ | --------- | ----------- |
|
||||||
@@ -498,7 +710,7 @@ handles connection pooling, lazy opening, migrations, and cleanup.
|
|||||||
This separation provides:
|
This separation provides:
|
||||||
|
|
||||||
- **Isolation** — a high-volume webhook won't cause lock contention or
|
- **Isolation** — a high-volume webhook won't cause lock contention or
|
||||||
WAL bloat affecting the main application or other webhooks.
|
journal growth affecting the main application or other webhooks.
|
||||||
- **Independent lifecycle** — event databases can be independently
|
- **Independent lifecycle** — event databases can be independently
|
||||||
backed up, archived, rotated, or size-limited without impacting the
|
backed up, archived, rotated, or size-limited without impacting the
|
||||||
application.
|
application.
|
||||||
@@ -507,16 +719,60 @@ This separation provides:
|
|||||||
DB; the event database file is hard-deleted (permanently removed).
|
DB; the event database file is hard-deleted (permanently removed).
|
||||||
- **Per-webhook retention** — the `retention_days` field on each webhook
|
- **Per-webhook retention** — the `retention_days` field on each webhook
|
||||||
controls automatic cleanup of old events in that webhook's database
|
controls automatic cleanup of old events in that webhook's database
|
||||||
only.
|
only, or disables cleanup entirely when set to `0` (retain forever).
|
||||||
- **Performance** — each webhook's database has its own WAL, its own
|
- **Performance** — each webhook's database has its own page cache and
|
||||||
page cache, and its own lock, so concurrent event ingestion across
|
its own lock, so concurrent event ingestion across webhooks won't
|
||||||
webhooks won't contend.
|
contend. No write-ahead log is involved: both DSNs are
|
||||||
|
`file:{path}?cache=shared&mode=rwc` and no `journal_mode` pragma is
|
||||||
|
ever issued, so every database runs on SQLite's default rollback
|
||||||
|
journal.
|
||||||
|
|
||||||
The **database target type** leverages this architecture: since events
|
The **database target type** builds on this architecture to provide
|
||||||
are already stored in the per-webhook database by design, the database
|
long-term archiving, separate from the per-webhook event database (which
|
||||||
target simply marks the delivery as immediately successful. The
|
may prune events under its own retention). Delivering to a database
|
||||||
per-webhook DB IS the dedicated event database — that's the whole point
|
target writes the full event — body, headers, method, content type, and
|
||||||
of the database target type.
|
webhook/entrypoint/event identifiers — as a row into a dedicated archive
|
||||||
|
database, `archive-{webhookID}.db`, stored under the data directory
|
||||||
|
beside the event database. After each write the archive handle is closed
|
||||||
|
and reopened, debounced to at most once per second, so an operator can
|
||||||
|
move the archive file away for offline archiving without stopping the
|
||||||
|
service; a moved or removed archive file is recreated automatically on
|
||||||
|
the next write. An optional `expiry` in the target's config JSON (e.g.
|
||||||
|
`{"expiry":"720h"}`) is validated when the target is created — the
|
||||||
|
default (unset or the literal `never`) keeps rows forever — and rows
|
||||||
|
older than the expiry are pruned each time the archive is (re)opened. An
|
||||||
|
archive write failure is never silent success: the delivery records a
|
||||||
|
failed attempt with the error and is marked failed.
|
||||||
|
|
||||||
|
Because reopens only happen on writes, an archive belonging to a webhook
|
||||||
|
that has stopped receiving events would never be pruned. A background
|
||||||
|
**archive sweeper** closes that gap: on the same interval as the event
|
||||||
|
retention reaper (`RETENTION_SWEEP_INTERVAL`) it prunes every archive
|
||||||
|
whose database target declares a positive expiry, whether or not the
|
||||||
|
webhook is still receiving traffic. The sweep never creates an archive —
|
||||||
|
a webhook whose archive file does not yet exist is skipped, not
|
||||||
|
initialised — it takes the same per-webhook lock the write path uses, so
|
||||||
|
it can never interleave with a write, and it leaves the archive closed
|
||||||
|
afterwards so the move-the-file-away workflow keeps working. Archives
|
||||||
|
with no expiry, or the expiry `never`, are not touched by the sweep at
|
||||||
|
all.
|
||||||
|
|
||||||
|
Note that a webhook has one archive file but may carry more than one
|
||||||
|
`database` target, each with its own `expiry`. The shortest expiry
|
||||||
|
configured on any of them therefore governs the whole archive, and the
|
||||||
|
sweep applies it whether or not the webhook is still receiving events.
|
||||||
|
Configure a single `database` target per webhook unless you intend that.
|
||||||
|
|
||||||
|
Deleting a webhook releases its archive: the delivery engine's cached
|
||||||
|
archive writer is dropped and its file handle closed, so nothing lingers
|
||||||
|
after the webhook is gone. The archive **file itself is deliberately
|
||||||
|
left on disk**. Unlike the event database — per-webhook working storage
|
||||||
|
that is hard-deleted with the webhook — an archive is long-term storage
|
||||||
|
an operator may still want to keep or move away for offline retention,
|
||||||
|
and destroying it as a side effect of deleting a webhook would be
|
||||||
|
unrecoverable. Removing `archive-{webhookID}.db` is the operator's call.
|
||||||
|
Deleting a webhook's last `database` target releases the writer the same
|
||||||
|
way, and for the same reason leaves the file alone.
|
||||||
|
|
||||||
The **Slack target type** sends webhook events as formatted messages to
|
The **Slack target type** sends webhook events as formatted messages to
|
||||||
any Slack-compatible incoming webhook URL (works with Slack, Mattermost,
|
any Slack-compatible incoming webhook URL (works with Slack, Mattermost,
|
||||||
@@ -525,8 +781,9 @@ and other compatible services). Each message includes event metadata
|
|||||||
pretty-printed in a code block. JSON payloads are automatically
|
pretty-printed in a code block. JSON payloads are automatically
|
||||||
formatted with indentation for readability; non-JSON payloads are shown
|
formatted with indentation for readability; non-JSON payloads are shown
|
||||||
as raw text. Large payloads are truncated to keep messages reasonable.
|
as raw text. Large payloads are truncated to keep messages reasonable.
|
||||||
Config stores `webhook_url` — the Slack/Mattermost incoming webhook
|
Config stores `webhookUrl` — the Slack/Mattermost incoming webhook
|
||||||
endpoint.
|
endpoint. That is the JSON key; the error text for a missing one reads
|
||||||
|
`webhook_url is required`, which is the message, not the key.
|
||||||
|
|
||||||
The database uses the
|
The database uses the
|
||||||
[modernc.org/sqlite](https://pkg.go.dev/modernc.org/sqlite) driver at
|
[modernc.org/sqlite](https://pkg.go.dev/modernc.org/sqlite) driver at
|
||||||
@@ -548,8 +805,9 @@ External Service
|
|||||||
1. Look up Entrypoint by UUID
|
1. Look up Entrypoint by UUID
|
||||||
2. Capture full request as Event
|
2. Capture full request as Event
|
||||||
3. Create Delivery records for each active Target
|
3. Create Delivery records for each active Target
|
||||||
4. Build self-contained DeliveryTask structs
|
4. Build self-contained delivery.Task structs
|
||||||
(target config + event data inline for ≤16KB)
|
(target config + event data inline for
|
||||||
|
bodies < 16 KiB)
|
||||||
5. Notify Engine via channel (no DB read needed)
|
5. Notify Engine via channel (no DB read needed)
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -584,7 +842,7 @@ at any time, preventing goroutine explosions regardless of queue depth.
|
|||||||
a delivery channel (new tasks from the webhook handler) and a retry
|
a delivery channel (new tasks from the webhook handler) and a retry
|
||||||
channel (tasks from backoff timers). Both are buffered to 10,000.
|
channel (tasks from backoff timers). Both are buffered to 10,000.
|
||||||
- **Fan-out via channel, not goroutines:** When an event arrives with
|
- **Fan-out via channel, not goroutines:** When an event arrives with
|
||||||
multiple targets, each `DeliveryTask` is sent to the delivery channel.
|
multiple targets, each `delivery.Task` is sent to the delivery channel.
|
||||||
Workers pick them up and process them — no goroutine-per-target.
|
Workers pick them up and process them — no goroutine-per-target.
|
||||||
- **Worker goroutines:** A fixed number of worker goroutines select from
|
- **Worker goroutines:** A fixed number of worker goroutines select from
|
||||||
both channels. Each worker processes one task at a time, then picks up
|
both channels. Each worker processes one task at a time, then picks up
|
||||||
@@ -608,7 +866,12 @@ This means:
|
|||||||
- **Independent results** — each worker records its own delivery result
|
- **Independent results** — each worker records its own delivery result
|
||||||
in the per-webhook database without coordination.
|
in the per-webhook database without coordination.
|
||||||
- **Graceful shutdown** — cancel the context, workers finish their
|
- **Graceful shutdown** — cancel the context, workers finish their
|
||||||
current task and exit. `WaitGroup.Wait()` ensures clean shutdown.
|
current task and exit. The stop hook waits for the pool via
|
||||||
|
`lifecycle.WaitForShutdown`, which bounds that wait by fx's stop
|
||||||
|
timeout rather than blocking forever on a wedged worker. On timeout
|
||||||
|
it logs at `ERROR` and returns an error, and the goroutines that
|
||||||
|
did not finish are still running — an unclean shutdown is reported
|
||||||
|
rather than hidden.
|
||||||
|
|
||||||
**Recovery paths:**
|
**Recovery paths:**
|
||||||
|
|
||||||
@@ -623,12 +886,26 @@ This means:
|
|||||||
durable fallback that ensures no retry is permanently lost, even under
|
durable fallback that ensures no retry is permanently lost, even under
|
||||||
extreme backpressure.
|
extreme backpressure.
|
||||||
|
|
||||||
### Circuit Breaker (HTTP Targets with Retries)
|
**Changing a target's type does not migrate in-flight deliveries.** Only
|
||||||
|
`http` and `slack` targets own durable retries; `database` and `log`
|
||||||
|
targets are fire-and-forget and never produce a `retrying` delivery. If a
|
||||||
|
target's `type` is edited from a retrying type to a non-retrying (or
|
||||||
|
unknown) one while one of its deliveries is still `retrying`, both
|
||||||
|
recovery paths above terminally mark that delivery `failed` and record a
|
||||||
|
`DeliveryResult` naming the current target type as the reason, logging it
|
||||||
|
at warn level. The delivery is not re-dispatched under the new type — the
|
||||||
|
operator never asked for that delivery — and while the event itself
|
||||||
|
remains stored in the per-webhook event database, there is no way to
|
||||||
|
redeliver it: manual redelivery is planned, not implemented (see
|
||||||
|
[TODO.md](TODO.md)).
|
||||||
|
|
||||||
HTTP targets with `max_retries` > 0 are protected by a **per-target circuit breaker** that
|
### Circuit Breaker (HTTP and Slack Targets with Retries)
|
||||||
prevents hammering a down target with repeated failed delivery attempts.
|
|
||||||
The circuit breaker is in-memory only and resets on restart (which is
|
`http` and `slack` targets with `max_retries` > 0 are protected by a
|
||||||
fine — startup recovery rescans the database anyway).
|
**per-target circuit breaker** that prevents hammering a down target
|
||||||
|
with repeated failed delivery attempts. The circuit breaker is
|
||||||
|
in-memory only and resets on restart (which is fine — startup recovery
|
||||||
|
rescans the database anyway).
|
||||||
|
|
||||||
**States:**
|
**States:**
|
||||||
|
|
||||||
@@ -664,10 +941,12 @@ fine — startup recovery rescans the database anyway).
|
|||||||
- **Failure threshold:** 5 consecutive failures before opening
|
- **Failure threshold:** 5 consecutive failures before opening
|
||||||
- **Cooldown:** 30 seconds in open state before probing
|
- **Cooldown:** 30 seconds in open state before probing
|
||||||
|
|
||||||
**Scope:** Circuit breakers only apply to **HTTP targets with
|
**Scope:** Circuit breakers apply to **`http` and `slack` targets with
|
||||||
`max_retries` > 0**. Fire-and-forget HTTP targets (`max_retries` == 0),
|
`max_retries` > 0**. The Slack target is built on the same HTTP core
|
||||||
Slack targets, database targets (local operations), and log
|
and hands its own `max_retries` to the same retry path, so it gets a
|
||||||
targets (stdout) do not use circuit breakers.
|
breaker with the same 5-failure / 30-second defaults. Fire-and-forget
|
||||||
|
targets of either type (`max_retries` == 0), database targets (local
|
||||||
|
operations), and log targets (stdout) do not use circuit breakers.
|
||||||
|
|
||||||
When a circuit is open and a new delivery arrives, the engine marks the
|
When a circuit is open and a new delivery arrives, the engine marks the
|
||||||
delivery as `retrying` and schedules a retry timer for after the
|
delivery as `retrying` and schedules a retry timer for after the
|
||||||
@@ -676,17 +955,88 @@ just delayed until the target is healthy again.
|
|||||||
|
|
||||||
### Rate Limiting
|
### Rate Limiting
|
||||||
|
|
||||||
Global rate limiting middleware (e.g., per-IP throttling applied at the
|
Global blanket rate limiting middleware (e.g., a per-IP throttle shared
|
||||||
router level) **must not** apply to webhook receiver endpoints. Webhook
|
with the web UI) **must not** apply to webhook receiver endpoints.
|
||||||
endpoints receive automated traffic from external services at
|
Webhook endpoints receive automated traffic from external services at
|
||||||
unpredictable rates, and blanket rate limits would cause legitimate
|
unpredictable rates, and blanket limits shared with other routes would
|
||||||
deliveries to be dropped.
|
cause legitimate deliveries to be dropped.
|
||||||
|
|
||||||
Instead, each webhook has its own individually configurable rate limit,
|
The receiver instead has its own dedicated abuse limit, scoped to the
|
||||||
applied within the webhook handler itself. By default, no rate limit is
|
`/webhook/{uuid}` route only and keyed per client IP per request path
|
||||||
applied — webhook endpoints accept traffic as fast as it arrives. Rate
|
(`httprate.KeyByEndpoint`): one misbehaving sender is throttled without
|
||||||
limits can be configured per-webhook when needed (e.g., to protect
|
affecting other senders of the same entrypoint or the same sender's
|
||||||
against a misbehaving sender).
|
other entrypoints. Keying on the path rather than on the entrypoint
|
||||||
|
matters — see the aggregate limit below. The limit is
|
||||||
|
`RECEIVER_RATE_LIMIT` requests per minute (default 120, generous for
|
||||||
|
legitimate webhook senders). Requests over the limit receive HTTP 429
|
||||||
|
with a `Retry-After` header. A set-but-invalid `RECEIVER_RATE_LIMIT`
|
||||||
|
value aborts startup rather than silently falling back to the default.
|
||||||
|
|
||||||
|
A second limit sits in front of that one, keyed on the client IP alone
|
||||||
|
and covering the whole route at ten times `RECEIVER_RATE_LIMIT` requests
|
||||||
|
per minute (default 1200). The per-entrypoint limit needs it: the route
|
||||||
|
pattern matches any single path segment, so a client that invents a
|
||||||
|
fresh path per request gets a fresh per-entrypoint bucket every time and
|
||||||
|
would otherwise have no aggregate limit at all — while each of those
|
||||||
|
requests still costs an entrypoint lookup before it 404s. The aggregate
|
||||||
|
limit leaves room for one address to drive several entrypoints at their
|
||||||
|
full rate, and it is not configurable separately.
|
||||||
|
|
||||||
|
What that aggregate limit bounds is the database work an invented path
|
||||||
|
costs; log volume it caps rather than eliminates. A path that names no
|
||||||
|
entrypoint is recorded by the handler at `DEBUG`, and the aggregate
|
||||||
|
limiter logs its own rejections at `DEBUG` and without the path, so
|
||||||
|
neither appears at all under the default level. The per-entrypoint
|
||||||
|
limiter is the loud one: it still logs every rejection at `WARN` with
|
||||||
|
the request path, which on this route is attacker-controlled text. A
|
||||||
|
client hammering a single invented path is served `RECEIVER_RATE_LIMIT`
|
||||||
|
requests and has the rest of its aggregate budget rejected there, so
|
||||||
|
the aggregate limit is what bounds those `WARN` lines — to under ten
|
||||||
|
times `RECEIVER_RATE_LIMIT` per minute per client IP, 1080 at the
|
||||||
|
defaults, where before it there was no bound at all. The access log is
|
||||||
|
bounded by neither limit: every request is recorded once at `INFO` with
|
||||||
|
its full URL, served or rejected alike.
|
||||||
|
|
||||||
|
Every limiter here — receiver, login, and password change — identifies
|
||||||
|
the client the same way, through one shared key function: the
|
||||||
|
connection's own address, unless the peer is listed in
|
||||||
|
`TRUSTED_PROXIES`, in which case the forwarded client address is used
|
||||||
|
instead. That address becomes a bucket by family: IPv4 keys on the full
|
||||||
|
address, IPv6 on its `/64` prefix. A routed `/64` is the normal
|
||||||
|
residential and mobile IPv6 allocation, so keying IPv6 per address would
|
||||||
|
let one subscriber rotate source addresses and mint a fresh bucket per
|
||||||
|
request, evading these limits at the network layer without spoofing
|
||||||
|
anything; the cost is that distinct clients inside one `/64` share a
|
||||||
|
bucket. IPv4-mapped addresses (`::ffff:1.2.3.4`) key as the IPv4 address
|
||||||
|
they carry. See [Trusted proxies](#trusted-proxies). Deployed without that
|
||||||
|
variable set, a client behind a reverse proxy shares one bucket with
|
||||||
|
every other client behind the same proxy. Set `TRUSTED_PROXIES` to the
|
||||||
|
proxy's address to get per-client limits back. What the shared bucket
|
||||||
|
costs is not the same for every limiter, and the two cases pull in
|
||||||
|
opposite directions:
|
||||||
|
|
||||||
|
- For the **receiver** limits it costs throughput, which is the safe
|
||||||
|
direction to be wrong in: sharing can only make a limit bind sooner,
|
||||||
|
never let a sender past it. It matters more for the aggregate limit
|
||||||
|
than for the per-entrypoint one: with `TRUSTED_PROXIES` unset behind
|
||||||
|
the reverse proxy a production deployment is required to run behind,
|
||||||
|
every request keys on the proxy, so the aggregate limit becomes a
|
||||||
|
service-wide ceiling of 1200 requests per minute across all senders
|
||||||
|
and all entrypoints, where the per-entrypoint limit's capacity still
|
||||||
|
grows with the number of entrypoints. Any deployment with more than a
|
||||||
|
handful of busy entrypoints must set `TRUSTED_PROXIES`.
|
||||||
|
- For the **login and password-change** limits it costs availability of
|
||||||
|
the only administrative path, which is not safe at all. Five POSTs
|
||||||
|
per minute from any address on the internet keeps the single shared
|
||||||
|
login bucket full, and the operator's own login returns HTTP 429 for
|
||||||
|
as long as that trickle continues. A restart clears the in-memory
|
||||||
|
buckets and a resumed trickle re-locks them. Production deployments
|
||||||
|
must set `TRUSTED_PROXIES`; webhooker warns at startup whenever it is
|
||||||
|
empty, in any environment.
|
||||||
|
|
||||||
|
Finer-grained per-webhook rate limits (configured in the web UI and
|
||||||
|
enforced in the webhook handler) can layer on top of this env-level
|
||||||
|
abuse limit later; they are tracked as future work.
|
||||||
|
|
||||||
### API Endpoints
|
### API Endpoints
|
||||||
|
|
||||||
@@ -694,17 +1044,17 @@ against a misbehaving sender).
|
|||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
| ------ | --------------------------- | ----------- |
|
| ------ | --------------------------- | ----------- |
|
||||||
| `GET` | `/` | Root redirect (authenticated → `/sources`, unauthenticated → `/pages/login`) |
|
| `GET` | `/` | Root redirect, 303 (authenticated → `/sources`, unauthenticated → `/pages/login`) |
|
||||||
| `GET` | `/.well-known/healthcheck` | Health check (JSON: status, uptime, version) |
|
| `GET` | `/.well-known/healthcheck` | Health check (JSON: `status`, `now`, `uptimeSeconds`, `uptimeHuman`, `version`, `appname`, `maintenanceMode`) |
|
||||||
| `GET` | `/s/*` | Static file serving (embedded CSS, JS) |
|
| any | `/s/*` | Static file serving (embedded CSS, JS). Mounted for every method, not just `GET`/`HEAD`: chi's `Mount` registers all methods and `http.FileServer` special-cases only `HEAD` (by omitting the body), so a `POST` or `DELETE` to an asset is answered `200` with the file. Pinned by `TestStaticServesEveryMethod` |
|
||||||
| `ANY` | `/webhook/{uuid}` | Webhook receiver endpoint (accepts all methods) |
|
| `POST` | `/webhook/{uuid}` | Webhook receiver endpoint. `POST` only — every other method is answered `405 Method Not Allowed` with `Allow: POST`. Rate limited (see [Rate Limiting](#rate-limiting)) |
|
||||||
|
|
||||||
#### Authentication Endpoints
|
#### Authentication Endpoints
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
| ------ | --------------- | ----------- |
|
| ------ | --------------- | ----------- |
|
||||||
| `GET` | `/pages/login` | Login page |
|
| `GET` | `/pages/login` | Login page (not rate limited; the limiter applies to POST only) |
|
||||||
| `POST` | `/pages/login` | Login form submission |
|
| `POST` | `/pages/login` | Login form submission (5 per minute per bucket, then 429) |
|
||||||
| `POST` | `/pages/logout` | Logout (destroys session) |
|
| `POST` | `/pages/logout` | Logout (destroys session) |
|
||||||
|
|
||||||
#### Authenticated Endpoints
|
#### Authenticated Endpoints
|
||||||
@@ -712,6 +1062,7 @@ against a misbehaving sender).
|
|||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
| ------ | ------------------------ | ----------- |
|
| ------ | ------------------------ | ----------- |
|
||||||
| `GET` | `/user/{username}` | User profile page |
|
| `GET` | `/user/{username}` | User profile page |
|
||||||
|
| `POST` | `/user/{username}/password` | Change the user's password (5 per minute per bucket, then 429) |
|
||||||
| `GET` | `/sources` | List user's webhooks |
|
| `GET` | `/sources` | List user's webhooks |
|
||||||
| `GET` | `/sources/new` | Create webhook form |
|
| `GET` | `/sources/new` | Create webhook form |
|
||||||
| `POST` | `/sources/new` | Create webhook submission |
|
| `POST` | `/sources/new` | Create webhook submission |
|
||||||
@@ -721,13 +1072,17 @@ against a misbehaving sender).
|
|||||||
| `POST` | `/source/{id}/delete` | Delete webhook |
|
| `POST` | `/source/{id}/delete` | Delete webhook |
|
||||||
| `GET` | `/source/{id}/logs` | Webhook event logs |
|
| `GET` | `/source/{id}/logs` | Webhook event logs |
|
||||||
| `POST` | `/source/{id}/entrypoints` | Add entrypoint to webhook |
|
| `POST` | `/source/{id}/entrypoints` | Add entrypoint to webhook |
|
||||||
|
| `POST` | `/source/{id}/entrypoints/{entrypointID}/delete` | Delete an entrypoint |
|
||||||
|
| `POST` | `/source/{id}/entrypoints/{entrypointID}/toggle` | Enable or disable an entrypoint |
|
||||||
| `POST` | `/source/{id}/targets` | Add target to webhook |
|
| `POST` | `/source/{id}/targets` | Add target to webhook |
|
||||||
|
| `POST` | `/source/{id}/targets/{targetID}/delete` | Delete a target |
|
||||||
|
| `POST` | `/source/{id}/targets/{targetID}/toggle` | Enable or disable a target |
|
||||||
|
|
||||||
#### Infrastructure Endpoints
|
#### Infrastructure Endpoints
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
| ------ | ---------- | ----------- |
|
| ------ | ---------- | ----------- |
|
||||||
| `GET` | `/metrics` | Prometheus metrics (requires basic auth) |
|
| `GET` | `/metrics` | Prometheus metrics, behind basic auth. The route is registered only when `METRICS_USERNAME` is set; otherwise it does not exist and returns 404 |
|
||||||
|
|
||||||
#### API (Planned)
|
#### API (Planned)
|
||||||
|
|
||||||
@@ -741,8 +1096,10 @@ against a misbehaving sender).
|
|||||||
| `GET` | `/api/v1/webhooks/{id}/events` | List events for webhook |
|
| `GET` | `/api/v1/webhooks/{id}/events` | List events for webhook |
|
||||||
| `POST` | `/api/v1/events/{id}/redeliver`| Redeliver an event |
|
| `POST` | `/api/v1/events/{id}/redeliver`| Redeliver an event |
|
||||||
|
|
||||||
API authentication will use API keys passed via `Authorization: Bearer
|
None of these exist yet. `/api/v1` is mounted with no routes, so every
|
||||||
<key>` header.
|
path under it returns 404 today. API authentication will use API keys
|
||||||
|
passed via `Authorization: Bearer <key>` header; no Bearer middleware
|
||||||
|
is implemented either.
|
||||||
|
|
||||||
### Package Layout
|
### Package Layout
|
||||||
|
|
||||||
@@ -770,16 +1127,30 @@ webhooker/
|
|||||||
│ │ ├── model_delivery_result.go # DeliveryResult entity (per-webhook DB)
|
│ │ ├── model_delivery_result.go # DeliveryResult entity (per-webhook DB)
|
||||||
│ │ ├── model_apikey.go # APIKey entity
|
│ │ ├── model_apikey.go # APIKey entity
|
||||||
│ │ ├── password.go # Argon2id hashing and verification
|
│ │ ├── password.go # Argon2id hashing and verification
|
||||||
|
│ │ ├── retention.go # Retention reaper (per-webhook event expiry)
|
||||||
|
│ │ ├── testing.go # NewTestDatabase: wrapper for tests, no fx lifecycle
|
||||||
│ │ └── webhook_db_manager.go # Per-webhook DB lifecycle manager
|
│ │ └── webhook_db_manager.go # Per-webhook DB lifecycle manager
|
||||||
│ ├── globals/
|
│ ├── globals/
|
||||||
│ │ └── globals.go # Build-time variables (appname, version, arch)
|
│ │ └── globals.go # Build-time variables (appname, version, arch)
|
||||||
│ ├── delivery/
|
│ ├── delivery/
|
||||||
│ │ ├── engine.go # Event-driven delivery engine (channel + timer based)
|
│ │ ├── engine.go # Event-driven delivery engine (channel + timer based)
|
||||||
│ │ ├── circuit_breaker.go # Per-target circuit breaker for HTTP targets with retries
|
│ │ ├── circuit_breaker.go # Per-target circuit breaker for http/slack targets with retries
|
||||||
|
│ │ ├── target.go # Target interface, Task, Scheduler
|
||||||
|
│ │ ├── target_http.go # HTTP target (retries, circuit breaker)
|
||||||
|
│ │ ├── target_slack.go # Slack/Mattermost incoming-webhook target
|
||||||
|
│ │ ├── target_database.go # Database archive target
|
||||||
|
│ │ ├── target_database_archive.go # Archive file lifecycle and pruning
|
||||||
|
│ │ ├── target_log.go # Log target (stdout)
|
||||||
|
│ │ ├── target_config_view.go # Masked target config for templates
|
||||||
|
│ │ ├── archive_sweeper.go # Periodic pruning of idle archives
|
||||||
|
│ │ ├── url_mask.go # Strips credentials from *url.Error
|
||||||
│ │ └── ssrf.go # SSRF prevention (IP validation, safe HTTP transport)
|
│ │ └── ssrf.go # SSRF prevention (IP validation, safe HTTP transport)
|
||||||
|
│ ├── lifecycle/
|
||||||
|
│ │ └── lifecycle.go # Shared fx start/stop hook helpers
|
||||||
│ ├── handlers/
|
│ ├── handlers/
|
||||||
│ │ ├── handlers.go # Base handler struct, JSON helpers, template rendering
|
│ │ ├── handlers.go # Base handler struct, JSON helpers, template rendering
|
||||||
│ │ ├── auth.go # Login, logout handlers
|
│ │ ├── auth.go # Login, logout handlers
|
||||||
|
│ │ ├── event_log_view.go # Event log projection, byte-capped in SQL
|
||||||
│ │ ├── healthcheck.go # Health check handler
|
│ │ ├── healthcheck.go # Health check handler
|
||||||
│ │ ├── index.go # Index page handler
|
│ │ ├── index.go # Index page handler
|
||||||
│ │ ├── profile.go # User profile handler
|
│ │ ├── profile.go # User profile handler
|
||||||
@@ -792,20 +1163,27 @@ webhooker/
|
|||||||
│ ├── middleware/
|
│ ├── middleware/
|
||||||
│ │ ├── middleware.go # Logging, CORS, Auth, Metrics, MetricsAuth, SecurityHeaders, MaxBodySize
|
│ │ ├── middleware.go # Logging, CORS, Auth, Metrics, MetricsAuth, SecurityHeaders, MaxBodySize
|
||||||
│ │ ├── csrf.go # CSRF protection middleware (gorilla/csrf)
|
│ │ ├── csrf.go # CSRF protection middleware (gorilla/csrf)
|
||||||
│ │ └── ratelimit.go # Per-IP rate limiting middleware (go-chi/httprate)
|
│ │ ├── ratelimit.go # Per-IP rate limiting middleware (go-chi/httprate)
|
||||||
|
│ │ └── testing.go # NewForTest: Middleware without the fx lifecycle
|
||||||
│ ├── server/
|
│ ├── server/
|
||||||
│ │ ├── server.go # Server struct, fx lifecycle, signal handling
|
│ │ ├── server.go # Server struct, fx lifecycle, signal handling
|
||||||
│ │ ├── http.go # HTTP server setup with timeouts
|
│ │ ├── http.go # HTTP server setup with timeouts
|
||||||
│ │ └── routes.go # All route definitions
|
│ │ └── routes.go # All route definitions
|
||||||
│ └── session/
|
│ └── session/
|
||||||
│ └── session.go # Cookie-based session management
|
│ ├── session.go # Cookie-based session management
|
||||||
|
│ └── testing.go # NewForTest: Session without the fx lifecycle
|
||||||
├── static/
|
├── static/
|
||||||
│ ├── static.go # //go:embed directive
|
│ ├── static.go # //go:embed directive
|
||||||
│ ├── css/style.css # Custom stylesheet (system font stack, card effects, layout)
|
│ ├── css/input.css # Tailwind input, source for tailwind.css (make css)
|
||||||
│ └── js/app.js # Client-side JavaScript (minimal bootstrap)
|
│ ├── css/tailwind.css # Generated stylesheet the pages load
|
||||||
├── templates/ # Go HTML templates (base, index, login, etc.)
|
│ ├── css/style.css # Older hand-written stylesheet, no longer loaded
|
||||||
├── Dockerfile # Multi-stage: lint, build+test, then Alpine runtime
|
│ ├── js/app.js # Progressive-enhancement copy-to-clipboard
|
||||||
├── Makefile # fmt, lint, test, check, build, docker targets
|
│ ├── js/alpine.min.js # Alpine.js, fetched by script/fetch-assets, not committed
|
||||||
|
│ └── vendor.sha256 # Pinned hashes the fetched assets are verified against
|
||||||
|
├── templates/ # Go HTML templates (base, login, sources, etc.)
|
||||||
|
├── script/ # Scripts to Rule Them All entrypoints
|
||||||
|
├── Dockerfile # Three stages: lint, test+build, Alpine runtime
|
||||||
|
├── Makefile # 10 of 16 targets shim script/; 6 are inline
|
||||||
├── go.mod / go.sum
|
├── go.mod / go.sum
|
||||||
└── .golangci.yml # Linter configuration
|
└── .golangci.yml # Linter configuration
|
||||||
```
|
```
|
||||||
@@ -821,21 +1199,27 @@ Components are wired via Uber fx in this order:
|
|||||||
user seed
|
user seed
|
||||||
5. `database.NewWebhookDBManager` — Per-webhook event database
|
5. `database.NewWebhookDBManager` — Per-webhook event database
|
||||||
lifecycle manager
|
lifecycle manager
|
||||||
6. `healthcheck.New` — Health check service
|
6. `database.NewRetentionReaper` — Per-webhook event retention sweep
|
||||||
7. `session.New` — Cookie-based session manager (key from database)
|
7. `healthcheck.New` — Health check service
|
||||||
8. `handlers.New` — HTTP handlers
|
8. `session.New` — Cookie-based session manager (key from database)
|
||||||
9. `middleware.New` — HTTP middleware
|
9. `handlers.New` — HTTP handlers
|
||||||
10. `delivery.New` — Event-driven delivery engine
|
10. `middleware.New` — HTTP middleware
|
||||||
11. `delivery.Engine` → `handlers.DeliveryNotifier` — interface bridge
|
11. `delivery.New` — Event-driven delivery engine
|
||||||
12. `server.New` — HTTP server and router
|
12. `delivery.NewArchiveSweeper` — Periodic pruning of idle archives
|
||||||
|
13. `delivery.Engine` → `delivery.Notifier` — interface bridge
|
||||||
|
14. `delivery.Engine` → `delivery.WebhookEvictor` — interface bridge so
|
||||||
|
deleting a webhook releases its archive writer
|
||||||
|
15. `server.New` — HTTP server and router
|
||||||
|
|
||||||
The server starts via `fx.Invoke(func(*server.Server, *delivery.Engine)
|
The server starts via `fx.Invoke(func(*server.Server, *delivery.Engine,
|
||||||
{})` which triggers the fx lifecycle hooks in dependency order. The
|
*database.RetentionReaper, *delivery.ArchiveSweeper) {})`, which
|
||||||
`DeliveryNotifier` interface allows the webhook handler to send
|
triggers the fx lifecycle hooks in dependency order. The
|
||||||
self-contained `DeliveryTask` slices to the engine without a direct
|
`delivery.Notifier` interface allows the webhook handler to send
|
||||||
|
self-contained `delivery.Task` slices to the engine without a direct
|
||||||
package dependency. Each task carries all target config and event data
|
package dependency. Each task carries all target config and event data
|
||||||
inline (for bodies ≤16KB), so the engine can deliver without reading
|
inline (for bodies under 16 KiB, `delivery.MaxInlineBodySize`), so the
|
||||||
from any database — it only writes to record results.
|
engine can deliver without reading from any database — it only writes
|
||||||
|
to record results.
|
||||||
|
|
||||||
### Middleware Stack
|
### Middleware Stack
|
||||||
|
|
||||||
@@ -854,15 +1238,39 @@ Applied to all routes in this order:
|
|||||||
8. **Sentry** — Error reporting to Sentry (if `SENTRY_DSN` is set;
|
8. **Sentry** — Error reporting to Sentry (if `SENTRY_DSN` is set;
|
||||||
configured with `Repanic: true` so panics still reach Recoverer)
|
configured with `Repanic: true` so panics still reach Recoverer)
|
||||||
|
|
||||||
Additionally, form endpoints (`/pages`, `/sources`, `/source/*`) apply a
|
Additionally, form endpoints (`/pages`, `/user/*`, `/sources`,
|
||||||
**MaxBodySize** middleware that limits POST/PUT/PATCH request bodies to
|
`/source/*`) apply a **MaxBodySize** middleware that limits
|
||||||
1 MB using `http.MaxBytesReader`, preventing oversized form submissions.
|
POST/PUT/PATCH request bodies to 1 MB. It is registered ahead of the
|
||||||
|
CSRF middleware in every one of those route groups, because
|
||||||
|
gorilla/csrf parses the form; if the cap were installed after it, form
|
||||||
|
parsing would run under net/http's 10 MB default and the 1 MB limit
|
||||||
|
would never apply. A request that declares a `Content-Length` over the
|
||||||
|
limit is answered with `413 Request Entity Too Large` without its body
|
||||||
|
being read and without reaching CSRF, the route group's remaining
|
||||||
|
middleware, or the handler. It is not rejected before *any* other
|
||||||
|
middleware, though: the global entries listed above all run first, so
|
||||||
|
such a request is still logged and given the security headers — and
|
||||||
|
counted in the metrics, on a deployment where `METRICS_USERNAME` is
|
||||||
|
set and the Metrics middleware is therefore registered at all. The
|
||||||
|
rejection itself is logged at `WARN` with the method, path and
|
||||||
|
declared length. A chunked request, or
|
||||||
|
one that lies about its length, is hard-capped by
|
||||||
|
`http.MaxBytesReader` and fails downstream at form-parse time.
|
||||||
|
|
||||||
|
Those same four route groups then apply **CSRF** and **NoCache**
|
||||||
|
(`Cache-Control: no-store`, `Pragma: no-cache`), and every group except
|
||||||
|
`/pages` applies **RequireAuth**. The rate limiters are per-route
|
||||||
|
rather than global: **LoginRateLimit** on `/pages/login`,
|
||||||
|
**PasswordChangeRateLimit** on `/user/{username}/password`, and
|
||||||
|
**ReceiverRateLimit** on `/webhook/{uuid}`.
|
||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
- **Web UI:** Cookie-based sessions using gorilla/sessions with
|
- **Web UI:** Cookie-based sessions using gorilla/sessions with
|
||||||
encrypted cookies. Sessions are configured with HttpOnly, SameSite
|
encrypted cookies. Sessions are configured with HttpOnly, SameSite
|
||||||
Lax, and Secure (in production). Session lifetime is 7 days.
|
Lax, and Secure (in production). Absolute session lifetime is 7 days,
|
||||||
|
with a sliding idle timeout on top of it (see
|
||||||
|
[Sessions](#sessions)).
|
||||||
- **API (planned):** API key authentication via `Authorization: Bearer`
|
- **API (planned):** API key authentication via `Authorization: Bearer`
|
||||||
header. API keys are stored per-user with usage tracking
|
header. API keys are stored per-user with usage tracking
|
||||||
(`last_used_at`).
|
(`last_used_at`).
|
||||||
@@ -878,7 +1286,8 @@ Additionally, form endpoints (`/pages`, `/sources`, `/source/*`) apply a
|
|||||||
- Production security headers on all responses: HSTS, X-Content-Type-Options
|
- Production security headers on all responses: HSTS, X-Content-Type-Options
|
||||||
(`nosniff`), X-Frame-Options (`DENY`), Content-Security-Policy, Referrer-Policy,
|
(`nosniff`), X-Frame-Options (`DENY`), Content-Security-Policy, Referrer-Policy,
|
||||||
and Permissions-Policy
|
and Permissions-Policy
|
||||||
- Request body size limits (1 MB) on all form POST endpoints
|
- Request body size limits (1 MB) on all form POST endpoints, enforced
|
||||||
|
by middleware that runs before CSRF parses the form
|
||||||
- **CSRF protection** via [gorilla/csrf](https://github.com/gorilla/csrf)
|
- **CSRF protection** via [gorilla/csrf](https://github.com/gorilla/csrf)
|
||||||
on all state-changing forms (cookie-based double-submit tokens with
|
on all state-changing forms (cookie-based double-submit tokens with
|
||||||
HMAC authentication). Applied to `/pages`, `/sources`, `/source`, and
|
HMAC authentication). Applied to `/pages`, `/sources`, `/source`, and
|
||||||
@@ -892,31 +1301,83 @@ Additionally, form endpoints (`/pages`, `/sources`, `/source/*`) apply a
|
|||||||
(custom HTTP transport with SSRF-safe dialer that validates resolved
|
(custom HTTP transport with SSRF-safe dialer that validates resolved
|
||||||
IPs before connecting, preventing DNS rebinding attacks)
|
IPs before connecting, preventing DNS rebinding attacks)
|
||||||
- **Login rate limiting** via [go-chi/httprate](https://github.com/go-chi/httprate):
|
- **Login rate limiting** via [go-chi/httprate](https://github.com/go-chi/httprate):
|
||||||
per-IP sliding-window rate limiter on the login endpoint (5 POST
|
sliding-window rate limiter on the login endpoint, 5 POST attempts
|
||||||
attempts per minute per IP) to prevent brute-force attacks
|
per minute per bucket, to slow brute-force attacks. GET requests to
|
||||||
|
the login page are not limited. The password-change endpoint carries
|
||||||
|
the same 5-per-minute limit. The bucket is per client IP only when
|
||||||
|
`TRUSTED_PROXIES` names the reverse proxy; unset, every client
|
||||||
|
shares one bucket and the login becomes remotely deniable (see
|
||||||
|
[Rate Limiting](#rate-limiting)). webhooker warns at startup
|
||||||
|
whenever `TRUSTED_PROXIES` is empty
|
||||||
- Prometheus metrics behind basic auth
|
- Prometheus metrics behind basic auth
|
||||||
- Static assets embedded in binary (no filesystem access needed at
|
- Static assets embedded in binary (no filesystem access needed at
|
||||||
runtime)
|
runtime)
|
||||||
- Container runs as non-root user (UID 1000)
|
- Container runs as non-root user (UID 1000)
|
||||||
- GORM soft deletes on all entities (data preserved for audit)
|
- GORM soft deletes on every entity that carries `BaseModel`, which is
|
||||||
|
all of them but `Setting` (data preserved for audit)
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
The Dockerfile uses a multi-stage build:
|
The Dockerfile uses a three-stage build. Each stage is pinned by
|
||||||
|
digest, and the two check stages are separate images so the linter's
|
||||||
|
version is fixed independently of the compiler's:
|
||||||
|
|
||||||
1. **Builder stage** (Debian-based `golang:1.24`) — installs
|
1. **Lint stage** (`golangci/golangci-lint:v2.12.2`, Debian-based) —
|
||||||
golangci-lint, downloads dependencies, copies source, runs `make
|
installs `make`, downloads dependencies, copies the source, and runs
|
||||||
check` (format verification, linting, tests, compilation).
|
`make fmt-check` then `make lint`.
|
||||||
2. **Runtime stage** (`alpine:3.21`) — copies the binary, creates the
|
2. **Builder stage** (`golang:1.26.1-bookworm`) — depends on the lint
|
||||||
`/var/lib/webhooker` directory for all SQLite databases, runs as
|
stage passing (it copies a file from it), runs `script/fetch-assets`
|
||||||
non-root user, exposes port 8080, includes a health check.
|
to download and verify the third-party browser assets, then runs
|
||||||
|
`make test` and `make build`, and finally rebuilds the binary with
|
||||||
|
`CGO_ENABLED=1` and static linking so it runs on musl.
|
||||||
|
3. **Runtime stage** (`alpine:3.21`) — copies the static binary,
|
||||||
|
creates the `/var/lib/webhooker` directory for all SQLite databases,
|
||||||
|
runs as the non-root `webhooker` user (UID 1000), exposes port 8080,
|
||||||
|
and includes a health check against `/.well-known/healthcheck`.
|
||||||
|
|
||||||
The builder uses Debian rather than Alpine because GORM's SQLite
|
Both check stages use Debian rather than Alpine because
|
||||||
dialect pulls in CGO-dependent headers at compile time. The runtime
|
`gorm.io/driver/sqlite` pulls in `mattn/go-sqlite3`, which needs CGO
|
||||||
binary is statically linked and runs on Alpine.
|
and does not compile against musl. Only the final binary is statically
|
||||||
|
linked, which is what lets it run on the Alpine runtime image.
|
||||||
|
|
||||||
`docker build .` is the CI gate — if it passes, the code is formatted,
|
`script/cibuild` — `docker build .` — is the CI gate: the four check
|
||||||
linted, tested, and compiled.
|
targets run inside the image, so a build that succeeds is a repo that
|
||||||
|
is formatted, linted, tested and compiled. Only `script/cibuild` and
|
||||||
|
`script/docker` involve Docker. `script/lint`, and therefore
|
||||||
|
`make lint` and `make check`, run whatever `golangci-lint` is on the
|
||||||
|
host, which can be a different version from the pinned one — so the
|
||||||
|
container is the authoritative lint result
|
||||||
|
([issue #109](https://git.eeqj.de/sneak/webhooker/issues/109) tracks
|
||||||
|
routing local linting through it as well).
|
||||||
|
|
||||||
|
#### CI gate honesty
|
||||||
|
|
||||||
|
A layer cache lets `docker build .` exit 0 in seconds with the lint and
|
||||||
|
test stages replayed rather than executed, which would make a green
|
||||||
|
check meaningless. The `check` workflow therefore writes
|
||||||
|
`.ci-fingerprint` into the build context before building. Its value is
|
||||||
|
the hash of the last commit that touched the build context, so:
|
||||||
|
|
||||||
|
- Any commit that changes code (including a squash merge whose tree
|
||||||
|
matches an already-built branch) gets a new fingerprint, invalidates
|
||||||
|
the `COPY . .` layer of both check stages, and really runs
|
||||||
|
`make fmt-check`, `make lint`, `make test`, and `make build`. A run
|
||||||
|
that reports success ran them.
|
||||||
|
- A docs-only commit leaves the fingerprint unchanged — `.dockerignore`
|
||||||
|
excludes `*.md`, `LICENSE` and `.editorconfig` from the context
|
||||||
|
anyway — so the image replays from cache and costs seconds.
|
||||||
|
|
||||||
|
The module download layer sits above `COPY . .` and stays cached either
|
||||||
|
way.
|
||||||
|
|
||||||
|
A separate workflow step, run before the fingerprint is written, covers
|
||||||
|
a second way the gate lied: Gitea cancels an in-flight run when a newer
|
||||||
|
commit lands on the same branch and records that cancellation as a
|
||||||
|
`failure` status, marking a commit red that was never tested.
|
||||||
|
Cancellation is unconditional server-side for
|
||||||
|
push events, so the superseding run rewrites the exact
|
||||||
|
`Has been cancelled` status to `skipped`. Genuine failures are never
|
||||||
|
touched.
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
|
|||||||
173
TODO.md
173
TODO.md
@@ -1,33 +1,159 @@
|
|||||||
# Workflow
|
# Workflow
|
||||||
|
|
||||||
* branch (from `main`)
|
One issue per unit of work, one branch and one PR per issue:
|
||||||
* do the work in Next Step
|
|
||||||
* move Next Step to the top of Completed Steps
|
* ensure a tracked issue exists with a definition of done
|
||||||
* move the top item of Future Steps into Next Step
|
* branch from `next` (never from `main`)
|
||||||
* commit (`TODO.md` changes in the same commit as the work)
|
* do the work; open a PR based on `next` (never on `main`)
|
||||||
* merge to `main` if the branch is not protected, otherwise open a PR
|
* pass an independent review, then the manager squash-merges into `next`
|
||||||
* push
|
* push; nothing stays local-only
|
||||||
|
|
||||||
|
`next` is the branch for the next milestone and must stay green and
|
||||||
|
mergeable to `main` without notice. One `next` -> `main` PR accumulates
|
||||||
|
the milestone; releases are cut from `main` separately.
|
||||||
|
|
||||||
|
Issue branches do NOT touch this file — the manager maintains it on
|
||||||
|
`next`. Every branch editing `TODO.md` conflicts with every other
|
||||||
|
(#112).
|
||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags exist. main (afe88c6) is a working webhook proxy
|
pre-1.0. No git tags exist. `main` (4f5ecb1) is a working webhook proxy
|
||||||
with auth, CSRF/SSRF protections, login rate limiting, Slack target,
|
with auth, CSRF/SSRF protections, login rate limiting, Slack target,
|
||||||
policy compliance (#6), and pinned lint tooling (#55). Note: TODO.md was
|
event retention (#63), the database archiving target (#43), the admin
|
||||||
deliberately deleted from this repo in f9a9569 (2026-03-01, #6); its
|
password change flow (#65), policy compliance (#6), pinned lint tooling
|
||||||
content was folded into the README TODO section, which this draft
|
(#55), and fail-loud configuration parsing (#80).
|
||||||
reconstructs as of 2026-07-06.
|
|
||||||
|
`next` holds the completed 1.0.0 milestone: every issue in it is closed,
|
||||||
|
and it is verified green by cache-defeated container runs
|
||||||
|
(`docker build --no-cache-filter=lint --no-cache-filter=builder`). The
|
||||||
|
CI status is not independently claimed here: a superseded run is
|
||||||
|
recorded as `skipped` and still rolls up green, so a commit status on
|
||||||
|
`next` does not by itself evidence an executed check (#152). Before
|
||||||
|
#119, a warm layer cache also let the gate report success without
|
||||||
|
executing anything, and replayed the previous build's console log so
|
||||||
|
the lie looked like a real run. Note: `TODO.md` was deliberately
|
||||||
|
deleted from this repo in f9a9569 (2026-03-01, #6); its content was
|
||||||
|
folded into the README TODO section, which this draft reconstructs as
|
||||||
|
of 2026-07-06.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
Implement automatic event retention cleanup based on retention_days: a
|
Merge the milestone PR to `main` and tag 1.0.0 from it.
|
||||||
periodic maintenance job that deletes Events, Deliveries, and
|
|
||||||
DeliveryResults older than the parent webhook's retention_days from each
|
Two decisions are open and belong to the owner, neither blocking the
|
||||||
per-webhook event database. The field exists on the Webhook model and
|
tag: #115 (mask the `http` target's destination URL, implemented
|
||||||
the README promises the behavior, but nothing enforces it, so event
|
speculatively and awaiting a yes or no) and #125 (whether IPv6
|
||||||
databases currently grow without bound.
|
rate-limit keys should bucket by `/64`).
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-08-12 Bound the receiver rate limit per client IP across the
|
||||||
|
whole `/webhook/*` route. The existing limiter keyed on the request
|
||||||
|
path and `/webhook/{uuid}` matches any single segment, so a client
|
||||||
|
that invented a fresh path per request minted a fresh bucket per
|
||||||
|
request: the limit on the only unauthenticated endpoint bounded
|
||||||
|
nothing in aggregate, and every request still cost an entrypoint
|
||||||
|
lookup before it 404ed. An outer limiter keyed on the client address
|
||||||
|
alone now bounds that, chained in front of the unchanged
|
||||||
|
per-entrypoint limiter (#139)
|
||||||
|
- 2026-08-12 Correct release-blocking documentation inaccuracies: the
|
||||||
|
README promised manual redelivery in the present tense in three
|
||||||
|
places when nothing implements it (the same false claim also sat in
|
||||||
|
the doc comment that was its source text), the env table omitted
|
||||||
|
`RETENTION_SWEEP_INTERVAL`, and `TODO.md` itself omitted five landed
|
||||||
|
units (#141)
|
||||||
|
- 2026-08-12 Make the CI gate execute the checks it reports on. The
|
||||||
|
workflow now writes a build-context fingerprint before calling
|
||||||
|
`script/cibuild`, so a code commit invalidates the `COPY` layer of
|
||||||
|
the lint and builder stages while a docs-only commit still replays
|
||||||
|
from cache; a superseding run also rewrites the `failure` status
|
||||||
|
Gitea leaves on commits it cancelled and never tested. Verified by
|
||||||
|
pushing a deliberately broken test and watching CI go red (#119)
|
||||||
|
- 2026-08-12 Require a positive `RETENTION_SWEEP_INTERVAL`: a
|
||||||
|
non-positive value reached `time.NewTicker` in both the retention
|
||||||
|
reaper and the archive sweeper, panicking two goroutines with no
|
||||||
|
recover after startup had already reported success (#140)
|
||||||
|
- 2026-08-12 Bound the `X-Forwarded-For` scan's allocation to the hop
|
||||||
|
cap: the reverse walk cuts entries with `strings.LastIndexByte`
|
||||||
|
instead of joining and splitting, so a 1 MB header allocates 16 bytes
|
||||||
|
rather than 1.6 MB per request on the unauthenticated receiver.
|
||||||
|
Semantics proven unchanged by differential testing against the
|
||||||
|
previous implementation (#133)
|
||||||
|
- 2026-08-12 Cap the `X-Forwarded-For` hop walk at 64 entries, so an
|
||||||
|
attacker-supplied chain cannot burn unbounded CPU in the rate-limit
|
||||||
|
key function; running off the end falls back to the peer address
|
||||||
|
(#124)
|
||||||
|
- 2026-08-12 Gate forwarded-header trust behind a `TRUSTED_PROXIES` CIDR
|
||||||
|
list: all three rate limiters key on the connection's own address
|
||||||
|
unless the direct peer is a configured proxy, in which case
|
||||||
|
`X-Forwarded-For` is walked right to left for the first non-proxy hop.
|
||||||
|
Default trusts nothing, and a set-but-unparseable value aborts
|
||||||
|
startup. Before this, any client could mint a fresh bucket or drain
|
||||||
|
another's by rotating a spoofed header (#88)
|
||||||
|
- 2026-08-11 Web UI cleanup: nav terminology unified on Webhooks, the
|
||||||
|
Profile settings placeholder removed, a progressive-enhancement copy
|
||||||
|
button for the entrypoint URL, and retention form copy that states the
|
||||||
|
actual policy (deletion by the reaper, 0 retains forever) (#57)
|
||||||
|
- 2026-08-11 Mask the webhook credential in delivery errors and logs:
|
||||||
|
Go embeds the request URL in `*url.Error`, so every transport failure
|
||||||
|
persisted the full Slack webhook URL into the per-webhook event
|
||||||
|
database via `DeliveryResult.Error`, a field a future REST API would
|
||||||
|
have served. `maskURLError` drops path, query and userinfo while
|
||||||
|
preserving the wrapped cause, so `errors.Is`/`As` and `Timeout()`
|
||||||
|
still work and DNS, TLS and timeout failures still read differently
|
||||||
|
(#118)
|
||||||
|
- 2026-08-11 Rate-limit the public webhook receiver endpoint
|
||||||
|
(`RECEIVER_RATE_LIMIT`, default 120/min), keyed on client IP plus
|
||||||
|
entrypoint path so one entrypoint cannot exhaust another's budget;
|
||||||
|
over-limit requests get 429 with `Retry-After`. It was the one
|
||||||
|
unauthenticated, internet-facing endpoint with no limit at all (#64)
|
||||||
|
- 2026-08-11 Enforce the body size limit before CSRF parses the form:
|
||||||
|
`MaxBodySize` is now first in all four form-parsing route groups, so
|
||||||
|
an oversized request is rejected with 413 instead of being read in
|
||||||
|
full by the CSRF middleware before any cap applied (#90)
|
||||||
|
- 2026-08-11 Mask target config on the source detail page, which
|
||||||
|
rendered the stored blob verbatim and so exposed the Slack
|
||||||
|
incoming-webhook URL — a bearer credential that cannot be revoked
|
||||||
|
per-holder. Config reaches the template only as a `TargetView` of
|
||||||
|
labelled fields, and header values are rendered as a count (#113)
|
||||||
|
- 2026-08-11 Allow `retention_days` of 0 to mean retain forever, via a
|
||||||
|
sentinel written in `BeforeSave` so the GORM column default cannot
|
||||||
|
win the race. Also bounds the reaper's cutoff arithmetic: day counts
|
||||||
|
above 106751 overflowed `time.Duration` and wrapped the cutoff into
|
||||||
|
the future, where every row matched and the sweep deleted everything
|
||||||
|
(#79)
|
||||||
|
- 2026-08-09 Inactivity-based session timeout: sliding idle expiry
|
||||||
|
(`SESSION_IDLE_TIMEOUT`, default `24h`) refreshed on authenticated
|
||||||
|
requests, with the 7-day absolute cap kept as an independent
|
||||||
|
backstop that activity never extends (#66)
|
||||||
|
- 2026-08-09 Restart recovery and the 60s retry sweep terminally fail an
|
||||||
|
orphaned `retrying` delivery whose target type no longer supports
|
||||||
|
retries, recording a `DeliveryResult` with the reason instead of
|
||||||
|
leaving the delivery stuck forever (#82)
|
||||||
|
- 2026-08-09 Root the delivery engine's worker pool and the retention
|
||||||
|
reaper's sweep loop at `context.Background()` rather than the fx
|
||||||
|
`OnStart` hook context (#97), which carries fx's 15s start timeout and
|
||||||
|
killed both roughly fifteen seconds after boot: the proxy silently
|
||||||
|
stopped delivering webhooks entirely, and the reaper never ran a
|
||||||
|
single sweep under its default one-hour interval
|
||||||
|
- 2026-08-09 Archive writer lifecycle (#89): deleting a webhook (or its
|
||||||
|
last `database` target) evicts the cached archive writer and closes
|
||||||
|
its handle while deliberately leaving `archive-{webhookID}.db` on
|
||||||
|
disk, and a new `ArchiveSweeper` prunes idle archives on the existing
|
||||||
|
`RETENTION_SWEEP_INTERVAL` without ever creating an archive file
|
||||||
|
- 2026-08-09 Configuration parsing fails loudly on set-but-unparseable
|
||||||
|
environment values: `envInt` removed in favour of `envPositiveInt`
|
||||||
|
plus a `PORT` range check, `envBool` now parses with
|
||||||
|
`strconv.ParseBool`, and defaults apply only to unset variables (#80)
|
||||||
|
- 2026-08-07 Automatic event retention cleanup based on
|
||||||
|
`retention_days`, deleting expired events, deliveries, and delivery
|
||||||
|
results from each per-webhook event database (#63)
|
||||||
|
- 2026-08-07 Update golangci-lint to v2.12.2 (Docker image digest in
|
||||||
|
`Dockerfile`, release-archive sha256 pins in `script/bootstrap`),
|
||||||
|
adopt the canonical `.golangci.yml` (v2 `linters.settings` layout so
|
||||||
|
`lll`/`funlen`/`cyclop`/`dupl` thresholds actually apply), and fix
|
||||||
|
all newly surfaced lint findings
|
||||||
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
||||||
Makefile shims, README Entrypoints section
|
Makefile shims, README Entrypoints section
|
||||||
- 2026-03-25 pin golangci-lint Docker image for linting (#55)
|
- 2026-03-25 pin golangci-lint Docker image for linting (#55)
|
||||||
@@ -51,8 +177,9 @@ databases currently grow without bound.
|
|||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
- Manual event redelivery from the web UI (replay is a core promised
|
- Manual event redelivery from the web UI — the "Replay" capability the
|
||||||
capability in the README rationale)
|
README describes as planned. No redelivery code exists anywhere in the
|
||||||
|
tree; events are stored in full, which is all it would be built on
|
||||||
- Delivery status and retry management UI
|
- Delivery status and retry management UI
|
||||||
- Per-webhook rate limiting in the receiver handler (per-webhook config
|
- Per-webhook rate limiting in the receiver handler (per-webhook config
|
||||||
plus handler enforcement; global limits must not apply to receiver
|
plus handler enforcement; global limits must not apply to receiver
|
||||||
@@ -66,8 +193,10 @@ databases currently grow without bound.
|
|||||||
- event redelivery endpoint
|
- event redelivery endpoint
|
||||||
- OpenAPI specification
|
- OpenAPI specification
|
||||||
- Analytics dashboard: success rates, response times, volume
|
- Analytics dashboard: success rates, response times, volume
|
||||||
- Session expiration tuning and a remember-me option
|
- A remember-me option at login
|
||||||
- Password change and reset flow
|
- Password reset flow for a forgotten password. The authenticated
|
||||||
|
password *change* flow already landed on `main` (#65); reset does not
|
||||||
|
exist
|
||||||
- Later, nice to have
|
- Later, nice to have
|
||||||
- email delivery target type
|
- email delivery target type
|
||||||
- SNS and S3 delivery targets
|
- SNS and S3 delivery targets
|
||||||
|
|||||||
@@ -34,16 +34,31 @@ func main() {
|
|||||||
config.New,
|
config.New,
|
||||||
database.New,
|
database.New,
|
||||||
database.NewWebhookDBManager,
|
database.NewWebhookDBManager,
|
||||||
|
database.NewRetentionReaper,
|
||||||
healthcheck.New,
|
healthcheck.New,
|
||||||
session.New,
|
session.New,
|
||||||
handlers.New,
|
handlers.New,
|
||||||
middleware.New,
|
middleware.New,
|
||||||
delivery.New,
|
delivery.New,
|
||||||
|
delivery.NewArchiveSweeper,
|
||||||
// Wire *delivery.Engine as delivery.Notifier so the
|
// Wire *delivery.Engine as delivery.Notifier so the
|
||||||
// webhook handler can notify the engine of new deliveries.
|
// webhook handler can notify the engine of new deliveries.
|
||||||
func(e *delivery.Engine) delivery.Notifier { return e },
|
func(e *delivery.Engine) delivery.Notifier { return e },
|
||||||
|
// Wire *delivery.Engine as delivery.WebhookEvictor so
|
||||||
|
// deleting a webhook releases its archive writer.
|
||||||
|
func(e *delivery.Engine) delivery.WebhookEvictor {
|
||||||
|
return e
|
||||||
|
},
|
||||||
server.New,
|
server.New,
|
||||||
),
|
),
|
||||||
fx.Invoke(func(*server.Server, *delivery.Engine) {}),
|
fx.Invoke(
|
||||||
|
func(
|
||||||
|
*server.Server,
|
||||||
|
*delivery.Engine,
|
||||||
|
*database.RetentionReaper,
|
||||||
|
*delivery.ArchiveSweeper,
|
||||||
|
) {
|
||||||
|
},
|
||||||
|
),
|
||||||
).Run()
|
).Run()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,9 +5,11 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/webhooker/internal/globals"
|
"sneak.berlin/go/webhooker/internal/globals"
|
||||||
@@ -26,12 +28,49 @@ const (
|
|||||||
|
|
||||||
// defaultPort is the default HTTP listen port.
|
// defaultPort is the default HTTP listen port.
|
||||||
defaultPort = 8080
|
defaultPort = 8080
|
||||||
|
|
||||||
|
// defaultRetentionSweepInterval is how often the retention
|
||||||
|
// reaper deletes events older than each webhook's RetentionDays.
|
||||||
|
defaultRetentionSweepInterval = time.Hour
|
||||||
|
|
||||||
|
// defaultSessionIdleTimeout is how long a session may go without
|
||||||
|
// authenticated activity before it expires.
|
||||||
|
defaultSessionIdleTimeout = 24 * time.Hour
|
||||||
|
|
||||||
|
// defaultReceiverRateLimit is the default number of requests
|
||||||
|
// per minute each client IP may send to a single webhook
|
||||||
|
// receiver entrypoint. Generous for legitimate webhook
|
||||||
|
// senders while bounding abuse of the one unauthenticated,
|
||||||
|
// internet-exposed endpoint.
|
||||||
|
defaultReceiverRateLimit = 120
|
||||||
|
|
||||||
|
// maxPort is the highest valid TCP port number. The lower
|
||||||
|
// bound (at least 1) is enforced by envPositiveInt.
|
||||||
|
maxPort = 65535
|
||||||
|
|
||||||
|
// mappedV4Offset is the number of leading bits an IPv4-mapped
|
||||||
|
// IPv6 prefix spends on the ::ffff:0:0/96 wrapper, so a /104
|
||||||
|
// covers the same addresses as an IPv4 /8.
|
||||||
|
mappedV4Offset = 96
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrInvalidEnvironment is returned when WEBHOOKER_ENVIRONMENT
|
// ErrInvalidEnvironment is returned when WEBHOOKER_ENVIRONMENT
|
||||||
// contains an unrecognised value.
|
// contains an unrecognised value.
|
||||||
var ErrInvalidEnvironment = errors.New("invalid environment")
|
var ErrInvalidEnvironment = errors.New("invalid environment")
|
||||||
|
|
||||||
|
// ErrNonPositiveValue is returned when an environment variable that
|
||||||
|
// requires a positive integer is set to zero or a negative number.
|
||||||
|
var ErrNonPositiveValue = errors.New("value must be positive")
|
||||||
|
|
||||||
|
// ErrInvalidPort is returned when an environment variable holding a
|
||||||
|
// TCP port number is set above the valid port range.
|
||||||
|
var ErrInvalidPort = errors.New("invalid port")
|
||||||
|
|
||||||
|
// ErrInvalidCIDR is returned when an environment variable holding a
|
||||||
|
// list of CIDR blocks contains an entry that is neither a CIDR block
|
||||||
|
// nor a bare IP address.
|
||||||
|
var ErrInvalidCIDR = errors.New("invalid CIDR")
|
||||||
|
|
||||||
//nolint:revive // ConfigParams is a standard fx naming convention.
|
//nolint:revive // ConfigParams is a standard fx naming convention.
|
||||||
type ConfigParams struct {
|
type ConfigParams struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -51,6 +90,30 @@ type Config struct {
|
|||||||
MetricsUsername string
|
MetricsUsername string
|
||||||
Port int
|
Port int
|
||||||
SentryDSN string
|
SentryDSN string
|
||||||
|
|
||||||
|
// RetentionSweepInterval is how often the retention reaper runs.
|
||||||
|
// Always positive: it becomes a time.NewTicker period.
|
||||||
|
RetentionSweepInterval time.Duration
|
||||||
|
|
||||||
|
// SessionIdleTimeout is the sliding inactivity window after
|
||||||
|
// which a session expires. Non-positive disables idle expiry.
|
||||||
|
SessionIdleTimeout time.Duration
|
||||||
|
|
||||||
|
// ReceiverRateLimit is the number of requests per minute each
|
||||||
|
// client IP may send to a single webhook receiver entrypoint.
|
||||||
|
ReceiverRateLimit int
|
||||||
|
|
||||||
|
// TrustedProxies is the set of networks whose members are
|
||||||
|
// allowed to speak for the client with X-Forwarded-For, the
|
||||||
|
// only forwarded header read. It is empty unless
|
||||||
|
// TRUSTED_PROXIES is set, and empty means no peer is
|
||||||
|
// trusted: forwarded headers are then ignored entirely and
|
||||||
|
// clients are identified by the connection's own address.
|
||||||
|
// Members can choose their own rate-limit key, so this must
|
||||||
|
// name proxy hosts only, never a block that also covers
|
||||||
|
// clients.
|
||||||
|
TrustedProxies []netip.Prefix
|
||||||
|
|
||||||
params *ConfigParams
|
params *ConfigParams
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
}
|
}
|
||||||
@@ -72,27 +135,333 @@ func envString(key string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// envBool returns the value of the named environment variable
|
// envBool returns the value of the named environment variable
|
||||||
// parsed as a boolean. Returns defaultValue if not set.
|
// parsed as a boolean. Returns defaultValue if not set. If the
|
||||||
func envBool(key string, defaultValue bool) bool {
|
// variable is set but cannot be parsed, it returns a wrapped error
|
||||||
if v := os.Getenv(key); v != "" {
|
// naming the key and the bad value, so startup fails loudly rather
|
||||||
return strings.EqualFold(v, "true") || v == "1"
|
// than silently falling back to the default.
|
||||||
|
//
|
||||||
|
// Parsing is strconv.ParseBool, which accepts 1, t, T, TRUE, true,
|
||||||
|
// True, 0, f, F, FALSE, false and False. Anything else — "yes",
|
||||||
|
// "on", or a typo like "ture" — is an error rather than a silent
|
||||||
|
// false.
|
||||||
|
func envBool(key string, defaultValue bool) (bool, error) {
|
||||||
|
v := os.Getenv(key)
|
||||||
|
if v == "" {
|
||||||
|
return defaultValue, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return defaultValue
|
b, err := strconv.ParseBool(v)
|
||||||
|
if err != nil {
|
||||||
|
return false, fmt.Errorf(
|
||||||
|
"invalid boolean for %s: %q: %w", key, v, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return b, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// envInt returns the value of the named environment variable
|
// envPositiveInt returns the value of the named environment variable
|
||||||
// parsed as an integer. Returns defaultValue if not set or
|
// parsed as a positive integer. Returns defaultValue if not set. If
|
||||||
// unparseable.
|
// the variable is set but cannot be parsed, or parses to less than
|
||||||
func envInt(key string, defaultValue int) int {
|
// one, it returns a wrapped error naming the key and the bad value,
|
||||||
if v := os.Getenv(key); v != "" {
|
// so startup fails loudly rather than silently falling back to the
|
||||||
i, err := strconv.Atoi(v)
|
// default.
|
||||||
if err == nil {
|
func envPositiveInt(
|
||||||
return i
|
key string,
|
||||||
}
|
defaultValue int,
|
||||||
|
) (int, error) {
|
||||||
|
v := os.Getenv(key)
|
||||||
|
if v == "" {
|
||||||
|
return defaultValue, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return defaultValue
|
i, err := strconv.Atoi(v)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"invalid integer for %s: %q: %w", key, v, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if i < 1 {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"%w: %s must be at least 1, got %q",
|
||||||
|
ErrNonPositiveValue, key, v,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return i, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// envPort returns the value of the named environment variable parsed
|
||||||
|
// as a TCP port number. Returns defaultValue if not set. A set value
|
||||||
|
// that is unparseable, below 1, or above maxPort is a hard error
|
||||||
|
// naming the key and the bad value.
|
||||||
|
func envPort(key string, defaultValue int) (int, error) {
|
||||||
|
port, err := envPositiveInt(key, defaultValue)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if port > maxPort {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"%w: %s must be at most %d, got %d",
|
||||||
|
ErrInvalidPort, key, maxPort, port,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return port, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// envDuration returns the value of the named environment variable
|
||||||
|
// parsed as a Go duration (e.g. "1h", "30m"). Returns defaultValue if
|
||||||
|
// not set. If the variable is set but cannot be parsed, it returns a
|
||||||
|
// wrapped error naming the key and the bad value, so startup fails
|
||||||
|
// loudly rather than silently falling back to the default.
|
||||||
|
func envDuration(
|
||||||
|
key string,
|
||||||
|
defaultValue time.Duration,
|
||||||
|
) (time.Duration, error) {
|
||||||
|
v := os.Getenv(key)
|
||||||
|
if v == "" {
|
||||||
|
return defaultValue, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
d, err := time.ParseDuration(v)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"invalid duration for %s: %q: %w", key, v, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// envPositiveDuration returns the value of the named environment
|
||||||
|
// variable parsed as a Go duration that must be greater than zero.
|
||||||
|
// Returns defaultValue if not set. A set value that is unparseable or
|
||||||
|
// non-positive is a hard error naming the key and the bad value.
|
||||||
|
//
|
||||||
|
// This is for durations that reach time.NewTicker, which panics on a
|
||||||
|
// non-positive period, in a goroutine started after startup has
|
||||||
|
// already reported success. It is deliberately not used for durations
|
||||||
|
// where non-positive means "disabled" (SESSION_IDLE_TIMEOUT).
|
||||||
|
func envPositiveDuration(
|
||||||
|
key string,
|
||||||
|
defaultValue time.Duration,
|
||||||
|
) (time.Duration, error) {
|
||||||
|
d, err := envDuration(key, defaultValue)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if d <= 0 {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"%w: %s must be greater than zero, got %s",
|
||||||
|
ErrNonPositiveValue, key, d,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseCIDR parses one trusted-proxy list entry, which may be a
|
||||||
|
// CIDR block ("10.0.0.0/8") or a bare address ("10.0.0.1", treated
|
||||||
|
// as a single-host block).
|
||||||
|
//
|
||||||
|
// Both forms are unmapped, because peer addresses are unmapped
|
||||||
|
// before they are matched against the list: an IPv4-mapped prefix
|
||||||
|
// left in that form would silently never match.
|
||||||
|
func parseCIDR(entry string) (netip.Prefix, error) {
|
||||||
|
if strings.Contains(entry, "/") {
|
||||||
|
prefix, err := netip.ParsePrefix(entry)
|
||||||
|
if err != nil {
|
||||||
|
return netip.Prefix{}, err //nolint:wrapcheck // wrapped by caller
|
||||||
|
}
|
||||||
|
|
||||||
|
if addr := prefix.Addr(); addr.Is4In6() &&
|
||||||
|
prefix.Bits() >= mappedV4Offset {
|
||||||
|
prefix = netip.PrefixFrom(
|
||||||
|
addr.Unmap(), prefix.Bits()-mappedV4Offset,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return prefix.Masked(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, err := netip.ParseAddr(entry)
|
||||||
|
if err != nil {
|
||||||
|
return netip.Prefix{}, err //nolint:wrapcheck // wrapped by caller
|
||||||
|
}
|
||||||
|
|
||||||
|
return netip.PrefixFrom(addr.Unmap(), addr.Unmap().BitLen()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// envPrefixList returns the value of the named environment variable
|
||||||
|
// parsed as a comma-separated list of CIDR blocks (bare addresses
|
||||||
|
// allowed). An unset, empty, or blank value yields an empty list. A
|
||||||
|
// set value containing an unparseable entry is a hard error naming
|
||||||
|
// the key and the bad entry, so startup fails loudly rather than
|
||||||
|
// silently running with a list the operator did not intend.
|
||||||
|
func envPrefixList(key string) ([]netip.Prefix, error) {
|
||||||
|
v := strings.TrimSpace(os.Getenv(key))
|
||||||
|
if v == "" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var prefixes []netip.Prefix
|
||||||
|
|
||||||
|
for entry := range strings.SplitSeq(v, ",") {
|
||||||
|
entry = strings.TrimSpace(entry)
|
||||||
|
if entry == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
prefix, err := parseCIDR(entry)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"%w: %s: %q: %w", ErrInvalidCIDR, key, entry, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
prefixes = append(prefixes, prefix)
|
||||||
|
}
|
||||||
|
|
||||||
|
return prefixes, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveEnvironment reads WEBHOOKER_ENVIRONMENT, defaulting to
|
||||||
|
// dev, and rejects unrecognised values.
|
||||||
|
func resolveEnvironment() (string, error) {
|
||||||
|
environment := os.Getenv("WEBHOOKER_ENVIRONMENT")
|
||||||
|
if environment == "" {
|
||||||
|
environment = EnvironmentDev
|
||||||
|
}
|
||||||
|
|
||||||
|
if environment != EnvironmentDev &&
|
||||||
|
environment != EnvironmentProd {
|
||||||
|
return "", fmt.Errorf(
|
||||||
|
"%w: WEBHOOKER_ENVIRONMENT must be '%s' or '%s', got '%s'",
|
||||||
|
ErrInvalidEnvironment,
|
||||||
|
EnvironmentDev, EnvironmentProd, environment,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return environment, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// loadFromEnv builds a Config from the environment. Every value that
|
||||||
|
// needs parsing fails loudly when it is set but unparseable: the
|
||||||
|
// documented defaults apply only to variables that are unset (or
|
||||||
|
// empty), never as a substitute for a value the operator actually
|
||||||
|
// provided.
|
||||||
|
func loadFromEnv() (*Config, error) {
|
||||||
|
environment, err := resolveEnvironment()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
port, err := envPort("PORT", defaultPort)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
debug, err := envBool("DEBUG", false)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
maintenanceMode, err := envBool("MAINTENANCE_MODE", false)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
retentionSweepInterval, err := envPositiveDuration(
|
||||||
|
"RETENTION_SWEEP_INTERVAL",
|
||||||
|
defaultRetentionSweepInterval,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Non-positive is "disabled" here, not invalid, so this stays on
|
||||||
|
// envDuration.
|
||||||
|
sessionIdleTimeout, err := envDuration(
|
||||||
|
"SESSION_IDLE_TIMEOUT",
|
||||||
|
defaultSessionIdleTimeout,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
receiverRateLimit, err := envPositiveInt(
|
||||||
|
"RECEIVER_RATE_LIMIT",
|
||||||
|
defaultReceiverRateLimit,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
trustedProxies, err := envPrefixList("TRUSTED_PROXIES")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &Config{
|
||||||
|
DataDir: envString("DATA_DIR"),
|
||||||
|
Debug: debug,
|
||||||
|
MaintenanceMode: maintenanceMode,
|
||||||
|
Environment: environment,
|
||||||
|
MetricsUsername: envString("METRICS_USERNAME"),
|
||||||
|
MetricsPassword: envString("METRICS_PASSWORD"),
|
||||||
|
Port: port,
|
||||||
|
SentryDSN: envString("SENTRY_DSN"),
|
||||||
|
RetentionSweepInterval: retentionSweepInterval,
|
||||||
|
SessionIdleTimeout: sessionIdleTimeout,
|
||||||
|
ReceiverRateLimit: receiverRateLimit,
|
||||||
|
TrustedProxies: trustedProxies,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// warnSharedRateLimitBucket logs a startup warning whenever
|
||||||
|
// TRUSTED_PROXIES is empty, in any environment.
|
||||||
|
//
|
||||||
|
// With no trusted proxies every rate limiter keys on the connecting
|
||||||
|
// peer's address. Whether that is harmless or dangerous depends on
|
||||||
|
// what is in front of the process, which this code cannot observe:
|
||||||
|
// with nothing in front, the peer is the client and the limits are
|
||||||
|
// per-client as intended; behind a reverse proxy the peer is the proxy
|
||||||
|
// for every request, so all clients share one bucket per limiter. The
|
||||||
|
// login limiter's bucket is the dangerous one: any remote client can
|
||||||
|
// keep it full, which denies the only administrative login to everyone
|
||||||
|
// until the process restarts.
|
||||||
|
//
|
||||||
|
// The warning is deliberately not gated on WEBHOOKER_ENVIRONMENT. That
|
||||||
|
// variable defaults to dev, so gating on it would silence the warning
|
||||||
|
// for exactly the operator who forgot to configure the deployment —
|
||||||
|
// the case it exists to catch.
|
||||||
|
//
|
||||||
|
// The default of trusting nobody is deliberate — trusting forwarded
|
||||||
|
// headers from arbitrary peers lets any client choose its own bucket —
|
||||||
|
// so this warns rather than failing startup or changing the key.
|
||||||
|
func (c *Config) warnSharedRateLimitBucket(log *slog.Logger) {
|
||||||
|
if len(c.TrustedProxies) > 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Warn(
|
||||||
|
"TRUSTED_PROXIES is empty: every rate limit keys on the "+
|
||||||
|
"connecting peer's address. With nothing proxying to "+
|
||||||
|
"this process that is the client itself and the limits "+
|
||||||
|
"are per-client as intended. Behind a reverse proxy the "+
|
||||||
|
"peer is the proxy on every request, so all clients "+
|
||||||
|
"share one bucket per limit and any remote client can "+
|
||||||
|
"keep the login limit full, denying the admin login — "+
|
||||||
|
"the only administrative path — until restart. If "+
|
||||||
|
"anything proxies to this process, set TRUSTED_PROXIES "+
|
||||||
|
"to its address.",
|
||||||
|
"environment", c.Environment,
|
||||||
|
"trustedProxies", len(c.TrustedProxies),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a Config by reading environment variables.
|
// New creates a Config by reading environment variables.
|
||||||
@@ -101,36 +470,16 @@ func envInt(key string, defaultValue int) int {
|
|||||||
func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
||||||
log := params.Logger.Get()
|
log := params.Logger.Get()
|
||||||
|
|
||||||
// Determine environment from WEBHOOKER_ENVIRONMENT env var,
|
// A set-but-unparseable value anywhere in the environment is a
|
||||||
// default to dev
|
// hard error, so fx aborts startup rather than running with a
|
||||||
environment := os.Getenv("WEBHOOKER_ENVIRONMENT")
|
// silently substituted default.
|
||||||
if environment == "" {
|
s, err := loadFromEnv()
|
||||||
environment = EnvironmentDev
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate environment
|
s.log = log
|
||||||
if environment != EnvironmentDev &&
|
s.params = ¶ms
|
||||||
environment != EnvironmentProd {
|
|
||||||
return nil, fmt.Errorf(
|
|
||||||
"%w: WEBHOOKER_ENVIRONMENT must be '%s' or '%s', got '%s'",
|
|
||||||
ErrInvalidEnvironment,
|
|
||||||
EnvironmentDev, EnvironmentProd, environment,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load configuration values from environment variables
|
|
||||||
s := &Config{
|
|
||||||
DataDir: envString("DATA_DIR"),
|
|
||||||
Debug: envBool("DEBUG", false),
|
|
||||||
MaintenanceMode: envBool("MAINTENANCE_MODE", false),
|
|
||||||
Environment: environment,
|
|
||||||
MetricsUsername: envString("METRICS_USERNAME"),
|
|
||||||
MetricsPassword: envString("METRICS_PASSWORD"),
|
|
||||||
Port: envInt("PORT", defaultPort),
|
|
||||||
SentryDSN: envString("SENTRY_DSN"),
|
|
||||||
log: log,
|
|
||||||
params: ¶ms,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set default DataDir. All SQLite databases (main application
|
// Set default DataDir. All SQLite databases (main application
|
||||||
// DB and per-webhook event DBs) live here. The same default is
|
// DB and per-webhook event DBs) live here. The same default is
|
||||||
@@ -151,10 +500,19 @@ func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
|||||||
"debug", s.Debug,
|
"debug", s.Debug,
|
||||||
"maintenanceMode", s.MaintenanceMode,
|
"maintenanceMode", s.MaintenanceMode,
|
||||||
"dataDir", s.DataDir,
|
"dataDir", s.DataDir,
|
||||||
|
"retentionSweepInterval", s.RetentionSweepInterval.String(),
|
||||||
|
// Logged because a perfectly valid non-positive value here
|
||||||
|
// disables idle expiry entirely, and that is worth showing
|
||||||
|
// back to the operator.
|
||||||
|
"sessionIdleTimeout", s.SessionIdleTimeout.String(),
|
||||||
|
"receiverRateLimit", s.ReceiverRateLimit,
|
||||||
|
"trustedProxies", len(s.TrustedProxies),
|
||||||
"hasSentryDSN", s.SentryDSN != "",
|
"hasSentryDSN", s.SentryDSN != "",
|
||||||
"hasMetricsAuth",
|
"hasMetricsAuth",
|
||||||
s.MetricsUsername != "" && s.MetricsPassword != "",
|
s.MetricsUsername != "" && s.MetricsPassword != "",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
s.warnSharedRateLimitBucket(log)
|
||||||
|
|
||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +1,11 @@
|
|||||||
package config_test
|
package config_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
@@ -13,6 +16,18 @@ import (
|
|||||||
"sneak.berlin/go/webhooker/internal/logger"
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Shared subtest names for the env-parsing tables below, which all
|
||||||
|
// exercise the same three cases against different variables.
|
||||||
|
const (
|
||||||
|
caseUnsetUsesDefault = "unset uses default"
|
||||||
|
caseValidValueParsed = "valid value is parsed"
|
||||||
|
caseUnparseableFails = "unparseable value fails startup"
|
||||||
|
|
||||||
|
// cidrPrivateV4 is the sample trusted-proxy block the
|
||||||
|
// TRUSTED_PROXIES cases are built from.
|
||||||
|
cidrPrivateV4 = "10.0.0.0/8"
|
||||||
|
)
|
||||||
|
|
||||||
func TestEnvironmentConfig(t *testing.T) {
|
func TestEnvironmentConfig(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -120,6 +135,245 @@ func testEnvironmentConfigSuccess(
|
|||||||
assert.Equal(t, isProd, cfg.IsProd())
|
assert.Equal(t, isProd, cfg.IsProd())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRetentionSweepInterval(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
// sentinel, when set, must be wrapped by the startup
|
||||||
|
// error; every error case must additionally name the
|
||||||
|
// variable in its message.
|
||||||
|
sentinel error
|
||||||
|
expected time.Duration
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: caseUnsetUsesDefault,
|
||||||
|
set: false,
|
||||||
|
expected: time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseValidValueParsed,
|
||||||
|
set: true,
|
||||||
|
value: "15m",
|
||||||
|
expected: 15 * time.Minute,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseUnparseableFails,
|
||||||
|
set: true,
|
||||||
|
value: "not-a-duration",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// A non-positive period panics the ticker in the
|
||||||
|
// reaper and archive-sweeper goroutines, long after
|
||||||
|
// startup has reported success, so it has to fail
|
||||||
|
// here instead.
|
||||||
|
name: "zero fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "0s",
|
||||||
|
expectError: true,
|
||||||
|
sentinel: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "negative fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "-1h",
|
||||||
|
expectError: true,
|
||||||
|
sentinel: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv("RETENTION_SWEEP_INTERVAL", tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(
|
||||||
|
"RETENTION_SWEEP_INTERVAL",
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
expectStartupErrorFor(
|
||||||
|
t, "RETENTION_SWEEP_INTERVAL", tt.sentinel,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
testRetentionSweepIntervalSuccess(t, tt.expected)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// startupError builds the app config.New belongs to and returns
|
||||||
|
// the error fx reports, which is non-nil whenever an environment
|
||||||
|
// value is set but invalid.
|
||||||
|
func startupError(t *testing.T) error {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fx.New(
|
||||||
|
fx.NopLogger,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
|
||||||
|
return app.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// expectStartupError asserts that fx refuses to build the app,
|
||||||
|
// which is what a set-but-invalid environment value must cause.
|
||||||
|
func expectStartupError(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
assert.Error(t, startupError(t))
|
||||||
|
}
|
||||||
|
|
||||||
|
// expectStartupErrorFor asserts that startup fails, that the error
|
||||||
|
// names the offending variable so an operator can find it, and,
|
||||||
|
// when sentinel is non-nil, that it wraps that sentinel.
|
||||||
|
func expectStartupErrorFor(
|
||||||
|
t *testing.T,
|
||||||
|
key string,
|
||||||
|
sentinel error,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
err := startupError(t)
|
||||||
|
require.ErrorContains(t, err, key)
|
||||||
|
|
||||||
|
if sentinel != nil {
|
||||||
|
require.ErrorIs(t, err, sentinel)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testRetentionSweepIntervalSuccess(
|
||||||
|
t *testing.T,
|
||||||
|
expected time.Duration,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
require.NoError(t, app.Err())
|
||||||
|
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
defer app.RequireStop()
|
||||||
|
|
||||||
|
assert.Equal(t, expected, cfg.RetentionSweepInterval)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSessionIdleTimeout(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
expected time.Duration
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: caseUnsetUsesDefault,
|
||||||
|
set: false,
|
||||||
|
expected: 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseValidValueParsed,
|
||||||
|
set: true,
|
||||||
|
value: "30m",
|
||||||
|
expected: 30 * time.Minute,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseUnparseableFails,
|
||||||
|
set: true,
|
||||||
|
value: "not-a-duration",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// Non-positive is "idle expiry disabled" for this
|
||||||
|
// variable, not a configuration error: unlike
|
||||||
|
// RETENTION_SWEEP_INTERVAL it never becomes a ticker
|
||||||
|
// period.
|
||||||
|
name: "zero disables idle expiry",
|
||||||
|
set: true,
|
||||||
|
value: "0s",
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "negative disables idle expiry",
|
||||||
|
set: true,
|
||||||
|
value: "-1h",
|
||||||
|
expected: -time.Hour,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv("SESSION_IDLE_TIMEOUT", tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(
|
||||||
|
"SESSION_IDLE_TIMEOUT",
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
expectStartupError(t)
|
||||||
|
} else {
|
||||||
|
testSessionIdleTimeoutSuccess(t, tt.expected)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testSessionIdleTimeoutSuccess(
|
||||||
|
t *testing.T,
|
||||||
|
expected time.Duration,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
require.NoError(t, app.Err())
|
||||||
|
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
defer app.RequireStop()
|
||||||
|
|
||||||
|
assert.Equal(t, expected, cfg.SessionIdleTimeout)
|
||||||
|
}
|
||||||
|
|
||||||
func TestDefaultDataDir(t *testing.T) {
|
func TestDefaultDataDir(t *testing.T) {
|
||||||
for _, env := range []string{"", "dev", "prod"} {
|
for _, env := range []string{"", "dev", "prod"} {
|
||||||
name := env
|
name := env
|
||||||
@@ -163,3 +417,303 @@ func TestDefaultDataDir(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestReceiverRateLimit(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
// sentinel, when set, must be wrapped by the startup
|
||||||
|
// error; every error case must additionally name the
|
||||||
|
// variable in its message.
|
||||||
|
sentinel error
|
||||||
|
expected int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: caseUnsetUsesDefault,
|
||||||
|
set: false,
|
||||||
|
expected: 120,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseValidValueParsed,
|
||||||
|
set: true,
|
||||||
|
value: "30",
|
||||||
|
expected: 30,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseUnparseableFails,
|
||||||
|
set: true,
|
||||||
|
value: "not-a-number",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "zero fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "0",
|
||||||
|
expectError: true,
|
||||||
|
sentinel: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "negative fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "-5",
|
||||||
|
expectError: true,
|
||||||
|
sentinel: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv("RECEIVER_RATE_LIMIT", tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(
|
||||||
|
"RECEIVER_RATE_LIMIT",
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
expectStartupErrorFor(
|
||||||
|
t, "RECEIVER_RATE_LIMIT", tt.sentinel,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
testReceiverRateLimitSuccess(t, tt.expected)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testReceiverRateLimitSuccess(
|
||||||
|
t *testing.T,
|
||||||
|
expected int,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
require.NoError(t, app.Err())
|
||||||
|
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
defer app.RequireStop()
|
||||||
|
|
||||||
|
assert.Equal(t, expected, cfg.ReceiverRateLimit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTrustedProxies(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
expected []string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
// The default must be "trust nobody": an empty list
|
||||||
|
// means forwarded headers are ignored, never that
|
||||||
|
// every peer may speak for the client.
|
||||||
|
name: caseUnsetUsesDefault,
|
||||||
|
set: false,
|
||||||
|
expected: []string{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "blank value trusts nothing",
|
||||||
|
set: true,
|
||||||
|
value: " ",
|
||||||
|
expected: []string{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseValidValueParsed,
|
||||||
|
set: true,
|
||||||
|
value: cidrPrivateV4 + ", 192.168.1.7 ,2001:db8::/32",
|
||||||
|
expected: []string{
|
||||||
|
cidrPrivateV4, "192.168.1.7/32", "2001:db8::/32",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "host bits are masked off",
|
||||||
|
set: true,
|
||||||
|
value: "10.1.2.3/8",
|
||||||
|
expected: []string{cidrPrivateV4},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// Peer addresses are unmapped before they are
|
||||||
|
// matched, so an IPv4-mapped prefix kept in that
|
||||||
|
// form could never match anything.
|
||||||
|
name: "IPv4-mapped prefix is unmapped",
|
||||||
|
set: true,
|
||||||
|
value: "::ffff:10.0.0.0/104",
|
||||||
|
expected: []string{cidrPrivateV4},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: caseUnparseableFails,
|
||||||
|
set: true,
|
||||||
|
value: cidrPrivateV4 + ",not-an-address",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "out-of-range prefix length fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "10.0.0.0/33",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv("TRUSTED_PROXIES", tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv("TRUSTED_PROXIES"))
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
expectStartupErrorFor(
|
||||||
|
t, "TRUSTED_PROXIES", config.ErrInvalidCIDR,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
testTrustedProxiesSuccess(t, tt.expected)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testTrustedProxiesSuccess(
|
||||||
|
t *testing.T,
|
||||||
|
expected []string,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
require.NoError(t, app.Err())
|
||||||
|
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
defer app.RequireStop()
|
||||||
|
|
||||||
|
got := make([]string, 0, len(cfg.TrustedProxies))
|
||||||
|
for _, prefix := range cfg.TrustedProxies {
|
||||||
|
got = append(got, prefix.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(t, expected, got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSharedRateLimitBucketWarning covers the startup warning that
|
||||||
|
// tells an operator a deployment behind a reverse proxy shares one
|
||||||
|
// rate-limit bucket between every client, which makes the admin login
|
||||||
|
// remotely deniable. It must fire whenever TRUSTED_PROXIES is empty,
|
||||||
|
// in any environment: WEBHOOKER_ENVIRONMENT defaults to dev, so gating
|
||||||
|
// on it would silence the warning for exactly the operator who never
|
||||||
|
// configured the deployment. It stays quiet once proxies are named.
|
||||||
|
func TestSharedRateLimitBucketWarning(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
environment string
|
||||||
|
trustedProxies string
|
||||||
|
expectWarning bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "prod without trusted proxies warns",
|
||||||
|
environment: config.EnvironmentProd,
|
||||||
|
expectWarning: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "prod with trusted proxies is quiet",
|
||||||
|
environment: config.EnvironmentProd,
|
||||||
|
trustedProxies: cidrPrivateV4,
|
||||||
|
expectWarning: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// The default environment. An internet-exposed
|
||||||
|
// deployment whose operator never set
|
||||||
|
// WEBHOOKER_ENVIRONMENT lands here and has exactly
|
||||||
|
// the exposure the warning announces.
|
||||||
|
name: "dev without trusted proxies warns",
|
||||||
|
environment: config.EnvironmentDev,
|
||||||
|
expectWarning: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "dev with trusted proxies is quiet",
|
||||||
|
environment: config.EnvironmentDev,
|
||||||
|
trustedProxies: cidrPrivateV4,
|
||||||
|
expectWarning: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", tt.environment)
|
||||||
|
|
||||||
|
if tt.trustedProxies == "" {
|
||||||
|
require.NoError(
|
||||||
|
t, os.Unsetenv("TRUSTED_PROXIES"),
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
t.Setenv("TRUSTED_PROXIES", tt.trustedProxies)
|
||||||
|
}
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
log := slog.New(slog.NewJSONHandler(
|
||||||
|
&buf, &slog.HandlerOptions{
|
||||||
|
Level: slog.LevelDebug,
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
config.WarnSharedRateLimitBucketForTest(log),
|
||||||
|
)
|
||||||
|
|
||||||
|
if !tt.expectWarning {
|
||||||
|
assert.Empty(t, buf.String())
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
logged := buf.String()
|
||||||
|
|
||||||
|
assert.Contains(t, logged, `"level":"WARN"`)
|
||||||
|
assert.Contains(t, logged, "TRUSTED_PROXIES")
|
||||||
|
assert.Contains(t, logged, "share one bucket")
|
||||||
|
assert.Contains(t, logged, "denying the admin login")
|
||||||
|
// The text must stay accurate for a developer with
|
||||||
|
// nothing in front of the process, where an empty
|
||||||
|
// list costs nothing.
|
||||||
|
assert.Contains(
|
||||||
|
t, logged, "nothing proxying to this process",
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
409
internal/config/env_test.go
Normal file
409
internal/config/env_test.go
Normal file
@@ -0,0 +1,409 @@
|
|||||||
|
package config_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/globals"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
// testEnvKey is a throwaway variable name used only by the helper
|
||||||
|
// tables below, so they cannot disturb real configuration.
|
||||||
|
const testEnvKey = "WEBHOOKER_TEST_VALUE"
|
||||||
|
|
||||||
|
// Real configuration variables exercised by the config.New tests.
|
||||||
|
const (
|
||||||
|
envKeyPort = "PORT"
|
||||||
|
envKeyDebug = "DEBUG"
|
||||||
|
envKeyMaintenanceMode = "MAINTENANCE_MODE"
|
||||||
|
)
|
||||||
|
|
||||||
|
// envBoolCase is one row of the envBool table.
|
||||||
|
type envBoolCase struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
defaultValue bool
|
||||||
|
expectError bool
|
||||||
|
expected bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// envBoolCases is the envBool table, kept out of the test body so
|
||||||
|
// the test itself stays readable.
|
||||||
|
func envBoolCases() []envBoolCase {
|
||||||
|
return []envBoolCase{
|
||||||
|
{
|
||||||
|
name: "unset uses default false",
|
||||||
|
defaultValue: false,
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unset uses default true",
|
||||||
|
defaultValue: true,
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "empty uses default true",
|
||||||
|
set: true,
|
||||||
|
value: "",
|
||||||
|
defaultValue: true,
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "true is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "true",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "one is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "1",
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "False is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "False",
|
||||||
|
defaultValue: true,
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "zero is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "0",
|
||||||
|
defaultValue: true,
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "yes is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "yes",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "on is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "on",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "typo is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "ture",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnvBool(t *testing.T) {
|
||||||
|
for _, tt := range envBoolCases() {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv(testEnvKey, tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(testEnvKey))
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := config.EnvBoolForTest(
|
||||||
|
testEnvKey, tt.defaultValue,
|
||||||
|
)
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), testEnvKey)
|
||||||
|
assert.Contains(t, err.Error(), tt.value)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tt.expected, got)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnvPositiveInt(t *testing.T) {
|
||||||
|
const defaultValue = 7
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
errIs error
|
||||||
|
expected int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "unset returns the default integer",
|
||||||
|
expected: defaultValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "empty returns the default integer",
|
||||||
|
set: true,
|
||||||
|
value: "",
|
||||||
|
expected: defaultValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "positive value is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "42",
|
||||||
|
expected: 42,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable value is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "not-a-number",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "zero is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "0",
|
||||||
|
expectError: true,
|
||||||
|
errIs: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "negative is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "-5",
|
||||||
|
expectError: true,
|
||||||
|
errIs: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv(testEnvKey, tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(testEnvKey))
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := config.EnvPositiveIntForTest(
|
||||||
|
testEnvKey, defaultValue,
|
||||||
|
)
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), testEnvKey)
|
||||||
|
assert.Contains(t, err.Error(), tt.value)
|
||||||
|
|
||||||
|
if tt.errIs != nil {
|
||||||
|
require.ErrorIs(t, err, tt.errIs)
|
||||||
|
}
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tt.expected, got)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnvPort(t *testing.T) {
|
||||||
|
const defaultValue = 8080
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
errIs error
|
||||||
|
expected int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "unset returns the default port",
|
||||||
|
expected: defaultValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid port is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "9000",
|
||||||
|
expected: 9000,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "highest port is accepted",
|
||||||
|
set: true,
|
||||||
|
value: "65535",
|
||||||
|
expected: 65535,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable value is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "not-a-port",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "zero is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "0",
|
||||||
|
expectError: true,
|
||||||
|
errIs: config.ErrNonPositiveValue,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "above the port range is rejected",
|
||||||
|
set: true,
|
||||||
|
value: "65536",
|
||||||
|
expectError: true,
|
||||||
|
errIs: config.ErrInvalidPort,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv(testEnvKey, tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(testEnvKey))
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := config.EnvPortForTest(
|
||||||
|
testEnvKey, defaultValue,
|
||||||
|
)
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), testEnvKey)
|
||||||
|
|
||||||
|
if tt.errIs != nil {
|
||||||
|
require.ErrorIs(t, err, tt.errIs)
|
||||||
|
}
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tt.expected, got)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildConfig constructs a Config through fx exactly as the
|
||||||
|
// application does, returning the config and any construction error.
|
||||||
|
func buildConfig(t *testing.T) (*config.Config, error) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fx.New(
|
||||||
|
fx.NopLogger,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
|
||||||
|
return cfg, app.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewRejectsBadEnvValues(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
key string
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
check func(t *testing.T, cfg *config.Config)
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid PORT is used",
|
||||||
|
key: envKeyPort,
|
||||||
|
value: "9001",
|
||||||
|
check: func(t *testing.T, cfg *config.Config) {
|
||||||
|
t.Helper()
|
||||||
|
assert.Equal(t, 9001, cfg.Port)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable PORT aborts startup",
|
||||||
|
key: envKeyPort,
|
||||||
|
value: "eighty-eighty",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "out-of-range PORT aborts startup",
|
||||||
|
key: envKeyPort,
|
||||||
|
value: "70000",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid DEBUG is used",
|
||||||
|
key: envKeyDebug,
|
||||||
|
value: "true",
|
||||||
|
check: func(t *testing.T, cfg *config.Config) {
|
||||||
|
t.Helper()
|
||||||
|
assert.True(t, cfg.Debug)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable DEBUG aborts startup",
|
||||||
|
key: envKeyDebug,
|
||||||
|
value: "ture",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable MAINTENANCE_MODE aborts startup",
|
||||||
|
key: envKeyMaintenanceMode,
|
||||||
|
value: "sometimes",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
t.Setenv(tt.key, tt.value)
|
||||||
|
|
||||||
|
cfg, err := buildConfig(t)
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), tt.key)
|
||||||
|
assert.Contains(t, err.Error(), tt.value)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, cfg)
|
||||||
|
tt.check(t, cfg)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewUsesDefaultsWhenUnset proves the fail-loud behaviour did not
|
||||||
|
// break the legitimate unset case: absent variables still get their
|
||||||
|
// documented defaults.
|
||||||
|
func TestNewUsesDefaultsWhenUnset(t *testing.T) {
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
for _, key := range []string{
|
||||||
|
envKeyPort, envKeyDebug, envKeyMaintenanceMode,
|
||||||
|
} {
|
||||||
|
require.NoError(t, os.Unsetenv(key))
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg, err := buildConfig(t)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, cfg)
|
||||||
|
|
||||||
|
assert.Equal(t, 8080, cfg.Port)
|
||||||
|
assert.False(t, cfg.Debug)
|
||||||
|
assert.False(t, cfg.MaintenanceMode)
|
||||||
|
}
|
||||||
37
internal/config/export_test.go
Normal file
37
internal/config/export_test.go
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import "log/slog"
|
||||||
|
|
||||||
|
// This file exposes the unexported environment parsing helpers to
|
||||||
|
// the external config_test package so each helper can be covered by
|
||||||
|
// its own table-driven test without weakening the package API.
|
||||||
|
|
||||||
|
// WarnSharedRateLimitBucketForTest loads a Config from the current
|
||||||
|
// environment and emits its startup warnings to log. The real logger
|
||||||
|
// writes to stdout, so this lets the warning's firing condition be
|
||||||
|
// asserted against a handler the test controls.
|
||||||
|
func WarnSharedRateLimitBucketForTest(log *slog.Logger) error {
|
||||||
|
c, err := loadFromEnv()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
c.warnSharedRateLimitBucket(log)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnvBoolForTest exposes envBool.
|
||||||
|
func EnvBoolForTest(key string, defaultValue bool) (bool, error) {
|
||||||
|
return envBool(key, defaultValue)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnvPositiveIntForTest exposes envPositiveInt.
|
||||||
|
func EnvPositiveIntForTest(key string, defaultValue int) (int, error) {
|
||||||
|
return envPositiveInt(key, defaultValue)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnvPortForTest exposes envPort.
|
||||||
|
func EnvPortForTest(key string, defaultValue int) (int, error) {
|
||||||
|
return envPort(key, defaultValue)
|
||||||
|
}
|
||||||
@@ -11,6 +11,20 @@ import (
|
|||||||
"sneak.berlin/go/webhooker/internal/logger"
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// testAppname is the Globals.Appname used in tests.
|
||||||
|
testAppname = "webhooker-test"
|
||||||
|
// testVersion is the Globals.Version used in tests.
|
||||||
|
testVersion = "test"
|
||||||
|
// testContentType is the event content type used in tests.
|
||||||
|
testContentType = "application/json"
|
||||||
|
// testWebhookName is the Webhook.Name used in tests.
|
||||||
|
testWebhookName = "test-webhook"
|
||||||
|
// testForeverLabel is Webhook.RetentionLabel for a retain-forever
|
||||||
|
// webhook.
|
||||||
|
testForeverLabel = "forever"
|
||||||
|
)
|
||||||
|
|
||||||
func setupTestDB(
|
func setupTestDB(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
) (*database.Database, *fxtest.Lifecycle) {
|
) (*database.Database, *fxtest.Lifecycle) {
|
||||||
@@ -19,8 +33,8 @@ func setupTestDB(
|
|||||||
lc := fxtest.NewLifecycle(t)
|
lc := fxtest.NewLifecycle(t)
|
||||||
|
|
||||||
g := &globals.Globals{
|
g := &globals.Globals{
|
||||||
Appname: "webhooker-test",
|
Appname: testAppname,
|
||||||
Version: "test",
|
Version: testVersion,
|
||||||
}
|
}
|
||||||
|
|
||||||
l, err := logger.New(
|
l, err := logger.New(
|
||||||
|
|||||||
67
internal/database/export_test.go
Normal file
67
internal/database/export_test.go
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
package database
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewTestRetentionReaper builds a RetentionReaper backed by the given
|
||||||
|
// main database and per-webhook database manager, without the fx
|
||||||
|
// lifecycle. Intended for tests.
|
||||||
|
func NewTestRetentionReaper(
|
||||||
|
db *Database,
|
||||||
|
mgr *WebhookDBManager,
|
||||||
|
) *RetentionReaper {
|
||||||
|
return &RetentionReaper{
|
||||||
|
db: db,
|
||||||
|
dbManager: mgr,
|
||||||
|
log: slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
)),
|
||||||
|
interval: time.Hour,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSweep runs a single retention sweep synchronously for tests.
|
||||||
|
func (r *RetentionReaper) ExportSweep(ctx context.Context) {
|
||||||
|
r.sweep(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportRegisterHooks registers the reaper's real fx lifecycle hooks
|
||||||
|
// on a lifecycle supplied by a test, so a test can drive the exact
|
||||||
|
// OnStart/OnStop functions the application runs and hand OnStart the
|
||||||
|
// kind of context fx actually supplies.
|
||||||
|
func (r *RetentionReaper) ExportRegisterHooks(lc fx.Lifecycle) {
|
||||||
|
r.registerHooks(lc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStart starts the reaper's background loop for tests.
|
||||||
|
func (r *RetentionReaper) ExportStart() {
|
||||||
|
r.start()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStop stops the reaper's background loop for tests.
|
||||||
|
func (r *RetentionReaper) ExportStop(ctx context.Context) error {
|
||||||
|
return r.stop(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportWedgeLoop adds a goroutine to the reaper's WaitGroup that
|
||||||
|
// never observes cancellation and returns only when release is
|
||||||
|
// closed. It stands in for a sweep stuck on a locked database.
|
||||||
|
func (r *RetentionReaper) ExportWedgeLoop(
|
||||||
|
release <-chan struct{},
|
||||||
|
) {
|
||||||
|
r.wg.Go(func() {
|
||||||
|
<-release
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSetInterval overrides the sweep interval for tests.
|
||||||
|
func (r *RetentionReaper) ExportSetInterval(d time.Duration) {
|
||||||
|
r.interval = d
|
||||||
|
}
|
||||||
@@ -5,7 +5,10 @@ type Entrypoint struct {
|
|||||||
BaseModel
|
BaseModel
|
||||||
|
|
||||||
WebhookID string `gorm:"type:uuid;not null" json:"webhookId"`
|
WebhookID string `gorm:"type:uuid;not null" json:"webhookId"`
|
||||||
Path string `gorm:"uniqueIndex;not null" json:"path"` // URL path for this entrypoint
|
|
||||||
|
// Path is the URL path for this entrypoint.
|
||||||
|
Path string `gorm:"uniqueIndex;not null" json:"path"`
|
||||||
|
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
Active bool `gorm:"default:true" json:"active"`
|
Active bool `gorm:"default:true" json:"active"`
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,8 @@ type Target struct {
|
|||||||
// Configuration fields (JSON stored based on type)
|
// Configuration fields (JSON stored based on type)
|
||||||
Config string `gorm:"type:text" json:"config"` // JSON configuration
|
Config string `gorm:"type:text" json:"config"` // JSON configuration
|
||||||
|
|
||||||
// For HTTP targets (max_retries=0 means fire-and-forget, >0 enables retries with backoff)
|
// For HTTP targets (max_retries=0 means fire-and-forget,
|
||||||
|
// >0 enables retries with backoff)
|
||||||
MaxRetries int `json:"maxRetries,omitempty"`
|
MaxRetries int `json:"maxRetries,omitempty"`
|
||||||
MaxQueueSize int `json:"maxQueueSize,omitempty"`
|
MaxQueueSize int `json:"maxQueueSize,omitempty"`
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +1,125 @@
|
|||||||
package database
|
package database
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// DefaultRetentionDays is the event retention period applied to a
|
||||||
|
// webhook created without an explicit retention value. It is the
|
||||||
|
// single source of truth for that policy and must stay in sync
|
||||||
|
// with the `gorm:"default:30"` column default on
|
||||||
|
// Webhook.RetentionDays below; a struct tag cannot reference a
|
||||||
|
// constant, so a test asserts the two agree.
|
||||||
|
DefaultRetentionDays = 30
|
||||||
|
|
||||||
|
// RetentionForeverDays is the sentinel RetentionDays value meaning
|
||||||
|
// "retain events forever". Users express that intent as 0, which
|
||||||
|
// Webhook.BeforeSave rewrites to this value: the column default
|
||||||
|
// substitutes DefaultRetentionDays for a zero value at insert
|
||||||
|
// time, so a zero can never survive a round trip to the database.
|
||||||
|
// Nothing outside this file may hardcode the number.
|
||||||
|
RetentionForeverDays = 365 * 1000
|
||||||
|
|
||||||
|
// MaxFiniteRetentionDays is the largest finite retention period the
|
||||||
|
// reaper's cutoff arithmetic can represent, and therefore the
|
||||||
|
// largest one a caller may request. It is derived from that
|
||||||
|
// arithmetic rather than picked: retentionCutoff computes
|
||||||
|
// retentionDays * hoursPerDay * time.Hour, and a time.Duration is
|
||||||
|
// an int64 nanosecond count, so math.MaxInt64 nanoseconds divided
|
||||||
|
// by an hour and then by a day is the exact ceiling — 106751 days,
|
||||||
|
// a little over 292 years.
|
||||||
|
//
|
||||||
|
// One day more overflows int64, wraps the product negative, and
|
||||||
|
// turns the cutoff into a timestamp in the far future that matches
|
||||||
|
// every row in the webhook's database. That is why this bound is
|
||||||
|
// enforced on input and why retentionCutoff saturates underneath
|
||||||
|
// it. Note that RetentionForeverDays deliberately sits above this
|
||||||
|
// ceiling: such webhooks are skipped before any cutoff is
|
||||||
|
// computed, and never reach the arithmetic at all.
|
||||||
|
MaxFiniteRetentionDays = int(
|
||||||
|
math.MaxInt64 / int64(time.Hour) / hoursPerDay,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
// Webhook represents a webhook processing unit that groups entrypoints and targets
|
// Webhook represents a webhook processing unit that groups entrypoints and targets
|
||||||
|
//
|
||||||
|
// Every method below takes a pointer receiver. BeforeSave has to,
|
||||||
|
// because it mutates the record and GORM only invokes hooks declared
|
||||||
|
// that way; the display helpers follow suit so the receiver kinds do
|
||||||
|
// not mix. Handlers therefore put a *Webhook into template data:
|
||||||
|
// html/template cannot call a pointer method on a value held in a map,
|
||||||
|
// because a map element is not addressable.
|
||||||
type Webhook struct {
|
type Webhook struct {
|
||||||
BaseModel
|
BaseModel
|
||||||
|
|
||||||
UserID string `gorm:"type:uuid;not null" json:"userId"`
|
UserID string `gorm:"type:uuid;not null" json:"userId"`
|
||||||
Name string `gorm:"not null" json:"name"`
|
Name string `gorm:"not null" json:"name"`
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
RetentionDays int `gorm:"default:30" json:"retentionDays"` // Days to retain events
|
|
||||||
|
// RetentionDays is the number of days to retain events. A value of
|
||||||
|
// RetentionForeverDays means retain forever. The column default
|
||||||
|
// must equal DefaultRetentionDays.
|
||||||
|
RetentionDays int `gorm:"default:30" json:"retentionDays"`
|
||||||
|
|
||||||
// Relations
|
// Relations
|
||||||
User User `json:"user,omitzero"`
|
User User `json:"user,omitzero"`
|
||||||
Entrypoints []Entrypoint `json:"entrypoints,omitempty"`
|
Entrypoints []Entrypoint `json:"entrypoints,omitempty"`
|
||||||
Targets []Target `json:"targets,omitempty"`
|
Targets []Target `json:"targets,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BeforeSave normalises RetentionDays on every insert and update. A
|
||||||
|
// non-positive value is the user's way of asking for "retain forever",
|
||||||
|
// which is stored as the RetentionForeverDays sentinel.
|
||||||
|
//
|
||||||
|
// This has to happen in a hook rather than at the call sites. GORM
|
||||||
|
// substitutes the column default (DefaultRetentionDays) for a zero
|
||||||
|
// value while building the insert statement, which runs after
|
||||||
|
// BeforeSave; rewriting any later than this loses that race and the
|
||||||
|
// row lands at 30 days. Living on the model also means a future call
|
||||||
|
// site — a REST API, a fixture, a migration — cannot bypass it.
|
||||||
|
func (w *Webhook) BeforeSave(_ *gorm.DB) error {
|
||||||
|
if w.RetentionDays <= 0 {
|
||||||
|
w.RetentionDays = RetentionForeverDays
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// retainsForever reports whether a stored RetentionDays value means
|
||||||
|
// "keep events indefinitely". It is the single definition of that
|
||||||
|
// question, shared by Webhook.RetainsForever and by the reaper's
|
||||||
|
// cutoff computation so the two cannot disagree about which webhooks
|
||||||
|
// are exempt from reaping.
|
||||||
|
//
|
||||||
|
// It accepts the RetentionForeverDays sentinel written by BeforeSave
|
||||||
|
// and, defensively, the non-positive values that rows written before
|
||||||
|
// the sentinel existed may still carry.
|
||||||
|
func retainsForever(retentionDays int) bool {
|
||||||
|
return retentionDays <= 0 ||
|
||||||
|
retentionDays >= RetentionForeverDays
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetainsForever reports whether this webhook's events are kept
|
||||||
|
// indefinitely.
|
||||||
|
func (w *Webhook) RetainsForever() bool {
|
||||||
|
return retainsForever(w.RetentionDays)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetentionLabel returns the webhook's retention policy as display
|
||||||
|
// text, so that no template has to know about the sentinel value.
|
||||||
|
func (w *Webhook) RetentionLabel() string {
|
||||||
|
if w.RetainsForever() {
|
||||||
|
return "forever"
|
||||||
|
}
|
||||||
|
|
||||||
|
if w.RetentionDays == 1 {
|
||||||
|
return "1 day"
|
||||||
|
}
|
||||||
|
|
||||||
|
return strconv.Itoa(w.RetentionDays) + " days"
|
||||||
|
}
|
||||||
|
|||||||
222
internal/database/model_webhook_test.go
Normal file
222
internal/database/model_webhook_test.go
Normal file
@@ -0,0 +1,222 @@
|
|||||||
|
package database_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// startedTestDB returns a started main database for model-level tests.
|
||||||
|
func startedTestDB(t *testing.T) *gorm.DB {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
db, lc := setupTestDB(t)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
require.NoError(t, lc.Start(ctx))
|
||||||
|
t.Cleanup(func() { require.NoError(t, lc.Stop(ctx)) })
|
||||||
|
|
||||||
|
return db.DB()
|
||||||
|
}
|
||||||
|
|
||||||
|
// storedRetention reads the retention_days column straight out of the
|
||||||
|
// row, so the assertion is about what was persisted rather than about
|
||||||
|
// whatever the in-memory struct happens to hold.
|
||||||
|
func storedRetention(t *testing.T, db *gorm.DB, id string) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var got int
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Model(&database.Webhook{}).
|
||||||
|
Where("id = ?", id).
|
||||||
|
Pluck("retention_days", &got).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return got
|
||||||
|
}
|
||||||
|
|
||||||
|
// newWebhookWithRetention creates a webhook through the ordinary Create
|
||||||
|
// path, so the BeforeSave hook and the GORM column default both apply
|
||||||
|
// exactly as they do in production.
|
||||||
|
func newWebhookWithRetention(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
wh *database.Webhook,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh.UserID = uuid.New().String()
|
||||||
|
wh.Name = testWebhookName
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWebhookBeforeSave_ZeroBecomesForeverSentinel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := startedTestDB(t)
|
||||||
|
|
||||||
|
wh := &database.Webhook{RetentionDays: 0}
|
||||||
|
id := newWebhookWithRetention(t, db, wh)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetention(t, db, id),
|
||||||
|
"a zero retention must be stored as the sentinel, "+
|
||||||
|
"not replaced by the column default",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWebhookBeforeSave_NegativeBecomesForeverSentinel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := startedTestDB(t)
|
||||||
|
|
||||||
|
wh := &database.Webhook{RetentionDays: -5}
|
||||||
|
id := newWebhookWithRetention(t, db, wh)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetention(t, db, id),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWebhookBeforeSave_PositiveIsPreserved(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := startedTestDB(t)
|
||||||
|
|
||||||
|
wh := &database.Webhook{RetentionDays: 7}
|
||||||
|
id := newWebhookWithRetention(t, db, wh)
|
||||||
|
|
||||||
|
assert.Equal(t, 7, storedRetention(t, db, id))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWebhookBeforeSave_UpdateToZeroBecomesSentinel proves the hook
|
||||||
|
// fires on update as well as insert, via the same Save call the edit
|
||||||
|
// handler makes.
|
||||||
|
func TestWebhookBeforeSave_UpdateToZeroBecomesSentinel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := startedTestDB(t)
|
||||||
|
|
||||||
|
wh := &database.Webhook{RetentionDays: 30}
|
||||||
|
id := newWebhookWithRetention(t, db, wh)
|
||||||
|
require.Equal(t, 30, storedRetention(t, db, id))
|
||||||
|
|
||||||
|
wh.RetentionDays = 0
|
||||||
|
require.NoError(t, db.Omit(clause.Associations).Save(wh).Error)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetention(t, db, id),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWebhookRetentionColumnDefaultMatchesConstant guards the one place
|
||||||
|
// the default lives twice: a struct tag cannot reference a constant, so
|
||||||
|
// this asserts the tag and DefaultRetentionDays agree.
|
||||||
|
func TestWebhookRetentionColumnDefaultMatchesConstant(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
field, ok := reflect.TypeFor[database.Webhook]().
|
||||||
|
FieldByName("RetentionDays")
|
||||||
|
require.True(t, ok, "Webhook.RetentionDays must exist")
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
"default:"+strconv.Itoa(database.DefaultRetentionDays),
|
||||||
|
field.Tag.Get("gorm"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMaxFiniteRetentionDaysIsTheOverflowCeiling asserts that the
|
||||||
|
// constant is exactly where the cutoff arithmetic stops working, which
|
||||||
|
// is what makes it a derived bound rather than a round number someone
|
||||||
|
// liked. One day more wraps the int64 nanosecond count negative, and a
|
||||||
|
// negative span is precisely what turned a cutoff into a future
|
||||||
|
// timestamp that matched — and deleted — every row.
|
||||||
|
//
|
||||||
|
// The multiplications are done through variables on purpose: as
|
||||||
|
// constant expressions the overflowing one would not compile.
|
||||||
|
func TestMaxFiniteRetentionDaysIsTheOverflowCeiling(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const hoursPerDay = 24
|
||||||
|
|
||||||
|
atCeiling := database.MaxFiniteRetentionDays
|
||||||
|
overCeiling := database.MaxFiniteRetentionDays + 1
|
||||||
|
|
||||||
|
assert.Positive(
|
||||||
|
t,
|
||||||
|
time.Duration(atCeiling*hoursPerDay)*time.Hour,
|
||||||
|
"the ceiling itself must still be representable",
|
||||||
|
)
|
||||||
|
assert.Negative(
|
||||||
|
t,
|
||||||
|
time.Duration(overCeiling*hoursPerDay)*time.Hour,
|
||||||
|
"one day past the ceiling must overflow",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Less(
|
||||||
|
t,
|
||||||
|
database.MaxFiniteRetentionDays,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
"the sentinel sits above the ceiling and is only safe "+
|
||||||
|
"because retain-forever webhooks skip the arithmetic",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWebhookRetainsForeverAndLabel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
days int
|
||||||
|
forever bool
|
||||||
|
label string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
"sentinel",
|
||||||
|
database.RetentionForeverDays, true, testForeverLabel,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"above sentinel",
|
||||||
|
database.RetentionForeverDays + 1, true, testForeverLabel,
|
||||||
|
},
|
||||||
|
{"legacy zero", 0, true, testForeverLabel},
|
||||||
|
{"legacy negative", -1, true, testForeverLabel},
|
||||||
|
{"default", database.DefaultRetentionDays, false, "30 days"},
|
||||||
|
{"one day", 1, false, "1 day"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
wh := database.Webhook{RetentionDays: tc.days}
|
||||||
|
|
||||||
|
assert.Equal(t, tc.forever, wh.RetainsForever())
|
||||||
|
assert.Equal(t, tc.label, wh.RetentionLabel())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
321
internal/database/retention.go
Normal file
321
internal/database/retention.go
Normal file
@@ -0,0 +1,321 @@
|
|||||||
|
package database
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/lifecycle"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hoursPerDay converts a RetentionDays count into hours for cutoff
|
||||||
|
// computation.
|
||||||
|
const hoursPerDay = 24
|
||||||
|
|
||||||
|
// RetentionReaperParams holds the fx dependencies for the
|
||||||
|
// RetentionReaper.
|
||||||
|
type RetentionReaperParams struct {
|
||||||
|
fx.In
|
||||||
|
|
||||||
|
Config *config.Config
|
||||||
|
Database *Database
|
||||||
|
DBManager *WebhookDBManager
|
||||||
|
Logger *logger.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// RetentionReaper periodically deletes expired events (and their
|
||||||
|
// dependent deliveries and delivery results) from each per-webhook
|
||||||
|
// database, enforcing every webhook's RetentionDays. Rows are removed
|
||||||
|
// permanently so that per-webhook SQLite files do not grow without
|
||||||
|
// bound.
|
||||||
|
type RetentionReaper struct {
|
||||||
|
db *Database
|
||||||
|
dbManager *WebhookDBManager
|
||||||
|
log *slog.Logger
|
||||||
|
interval time.Duration
|
||||||
|
cancel context.CancelFunc
|
||||||
|
wg sync.WaitGroup
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRetentionReaper creates the retention reaper and registers its
|
||||||
|
// fx lifecycle hooks. The background sweep loop starts on OnStart and
|
||||||
|
// stops cleanly on OnStop via context cancellation.
|
||||||
|
func NewRetentionReaper(
|
||||||
|
lc fx.Lifecycle,
|
||||||
|
params RetentionReaperParams,
|
||||||
|
) *RetentionReaper {
|
||||||
|
r := &RetentionReaper{
|
||||||
|
db: params.Database,
|
||||||
|
dbManager: params.DBManager,
|
||||||
|
log: params.Logger.Get(),
|
||||||
|
interval: params.Config.RetentionSweepInterval,
|
||||||
|
}
|
||||||
|
|
||||||
|
r.registerHooks(lc)
|
||||||
|
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// registerHooks wires the reaper's start and stop into the fx
|
||||||
|
// lifecycle. The start hook's context is deliberately ignored (see
|
||||||
|
// start for why the sweep loop must not inherit it); the stop hook's
|
||||||
|
// context is honoured (see stop).
|
||||||
|
func (r *RetentionReaper) registerHooks(lc fx.Lifecycle) {
|
||||||
|
lc.Append(fx.Hook{
|
||||||
|
//nolint:contextcheck // Not inheriting the hook context is
|
||||||
|
// the point: see start.
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
r.start()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(ctx context.Context) error {
|
||||||
|
return r.stop(ctx)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// start launches the background sweep loop.
|
||||||
|
//
|
||||||
|
// The loop's context is derived from context.Background(), NOT from
|
||||||
|
// the fx OnStart hook context. The hook context carries fx's start
|
||||||
|
// timeout (15s by default) and is cancelled once the start phase
|
||||||
|
// completes, so a loop derived from it dies 45 minutes before its
|
||||||
|
// first tick under the default one-hour sweep interval, leaving a
|
||||||
|
// reaper that never reaps. A long-lived goroutine must outlive the
|
||||||
|
// startup phase, so its lifetime is bounded by OnStop instead: stop
|
||||||
|
// cancels this context and waits on the WaitGroup.
|
||||||
|
func (r *RetentionReaper) start() {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
r.cancel = cancel
|
||||||
|
|
||||||
|
r.wg.Add(1)
|
||||||
|
|
||||||
|
go r.run(ctx)
|
||||||
|
|
||||||
|
r.log.Info(
|
||||||
|
"retention reaper started",
|
||||||
|
"interval", r.interval.String(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stop cancels the sweep loop's context and waits for it to
|
||||||
|
// exit, bounded by the stop hook's context: a sweep wedged on a
|
||||||
|
// locked database must not hang the process past fx's stop
|
||||||
|
// timeout.
|
||||||
|
func (r *RetentionReaper) stop(ctx context.Context) error {
|
||||||
|
r.log.Info("retention reaper stopping")
|
||||||
|
|
||||||
|
if r.cancel != nil {
|
||||||
|
r.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
err := lifecycle.WaitForShutdown(
|
||||||
|
ctx, r.log, "retention reaper", &r.wg,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
r.log.Info("retention reaper stopped")
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *RetentionReaper) run(ctx context.Context) {
|
||||||
|
defer r.wg.Done()
|
||||||
|
|
||||||
|
ticker := time.NewTicker(r.interval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
r.sweep(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweep lists every webhook from the main database and reaps expired
|
||||||
|
// rows from each per-webhook database that has a finite retention
|
||||||
|
// policy. Webhooks set to retain forever are skipped entirely.
|
||||||
|
func (r *RetentionReaper) sweep(ctx context.Context) {
|
||||||
|
var webhooks []Webhook
|
||||||
|
|
||||||
|
err := r.db.DB().
|
||||||
|
Model(&Webhook{}).
|
||||||
|
Find(&webhooks).Error
|
||||||
|
if err != nil {
|
||||||
|
r.log.Error(
|
||||||
|
"retention sweep: failed to list webhooks",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range webhooks {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
wh := webhooks[i]
|
||||||
|
|
||||||
|
// Skip retain-forever webhooks before building any query.
|
||||||
|
// RetainsForever covers both the RetentionForeverDays
|
||||||
|
// sentinel and the non-positive values that predate it: the
|
||||||
|
// sentinel is a positive number, so without this the reaper
|
||||||
|
// would compute a cutoff a thousand years in the past and
|
||||||
|
// issue a DELETE matching nothing on every single sweep.
|
||||||
|
if wh.RetainsForever() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing to reap if the per-webhook database has never
|
||||||
|
// been created.
|
||||||
|
if !r.dbManager.DBExists(wh.ID) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
r.reapWebhook(wh.ID, wh.RetentionDays)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// reapWebhook removes every expired event (and its dependents) from a
|
||||||
|
// single webhook's database.
|
||||||
|
func (r *RetentionReaper) reapWebhook(
|
||||||
|
webhookID string,
|
||||||
|
retentionDays int,
|
||||||
|
) {
|
||||||
|
db, err := r.dbManager.GetDB(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
r.log.Error(
|
||||||
|
"retention sweep: failed to open webhook database",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
cutoff, ok := retentionCutoff(time.Now(), retentionDays)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
deleted, err := reapExpired(db, cutoff)
|
||||||
|
if err != nil {
|
||||||
|
r.log.Error(
|
||||||
|
"retention sweep: failed to reap expired events",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if deleted > 0 {
|
||||||
|
r.log.Info(
|
||||||
|
"retention sweep: reaped expired events",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"retention_days", retentionDays,
|
||||||
|
"events_deleted", deleted,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// retentionCutoff returns the timestamp before which a webhook's
|
||||||
|
// events have expired, and whether any cutoff applies at all. It
|
||||||
|
// reports false for a retain-forever policy, so no DELETE is issued.
|
||||||
|
//
|
||||||
|
// The day count is clamped to MaxFiniteRetentionDays first. This is
|
||||||
|
// defense in depth rather than decoration: a time.Duration is an int64
|
||||||
|
// nanosecond count, so an unclamped multiplication overflows above
|
||||||
|
// that ceiling and wraps the span negative. Subtracting a negative
|
||||||
|
// span moves the cutoff into the far future, where it matches every
|
||||||
|
// row in the database: the sweep then deletes every event, delivery,
|
||||||
|
// and delivery result, including ones created seconds ago. Rejecting
|
||||||
|
// out-of-range input at the form is the primary guard; saturating here
|
||||||
|
// means an old row, a migration, or a future call site cannot turn a
|
||||||
|
// too-large retention into total data loss.
|
||||||
|
func retentionCutoff(
|
||||||
|
now time.Time,
|
||||||
|
retentionDays int,
|
||||||
|
) (time.Time, bool) {
|
||||||
|
if retainsForever(retentionDays) {
|
||||||
|
return time.Time{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if retentionDays > MaxFiniteRetentionDays {
|
||||||
|
retentionDays = MaxFiniteRetentionDays
|
||||||
|
}
|
||||||
|
|
||||||
|
return now.Add(
|
||||||
|
-time.Duration(retentionDays*hoursPerDay) * time.Hour,
|
||||||
|
), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// reapExpired hard-deletes, in foreign-key-safe order, the delivery
|
||||||
|
// results, deliveries, and events associated with events older than
|
||||||
|
// cutoff. Deletes are unscoped so rows are physically removed rather
|
||||||
|
// than soft-deleted, reclaiming disk. It returns the number of events
|
||||||
|
// deleted.
|
||||||
|
func reapExpired(db *gorm.DB, cutoff time.Time) (int64, error) {
|
||||||
|
// Fresh subqueries are built per statement to avoid reusing a
|
||||||
|
// mutated builder across executions.
|
||||||
|
expiredEventIDs := func() *gorm.DB {
|
||||||
|
return db.Model(&Event{}).
|
||||||
|
Select("id").
|
||||||
|
Where("created_at < ?", cutoff)
|
||||||
|
}
|
||||||
|
expiredDeliveryIDs := func() *gorm.DB {
|
||||||
|
return db.Model(&Delivery{}).
|
||||||
|
Select("id").
|
||||||
|
Where("event_id IN (?)", expiredEventIDs())
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1. Delivery results whose delivery belongs to an expired event.
|
||||||
|
res := db.Unscoped().
|
||||||
|
Where("delivery_id IN (?)", expiredDeliveryIDs()).
|
||||||
|
Delete(&DeliveryResult{})
|
||||||
|
if res.Error != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"deleting expired delivery results: %w",
|
||||||
|
res.Error,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Deliveries belonging to an expired event.
|
||||||
|
del := db.Unscoped().
|
||||||
|
Where("event_id IN (?)", expiredEventIDs()).
|
||||||
|
Delete(&Delivery{})
|
||||||
|
if del.Error != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"deleting expired deliveries: %w",
|
||||||
|
del.Error,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. The expired events themselves.
|
||||||
|
ev := db.Unscoped().
|
||||||
|
Where("created_at < ?", cutoff).
|
||||||
|
Delete(&Event{})
|
||||||
|
if ev.Error != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"deleting expired events: %w",
|
||||||
|
ev.Error,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ev.RowsAffected, nil
|
||||||
|
}
|
||||||
272
internal/database/retention_lifecycle_test.go
Normal file
272
internal/database/retention_lifecycle_test.go
Normal file
@@ -0,0 +1,272 @@
|
|||||||
|
package database_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// reaperTestInterval is the sweep interval a lifecycle test
|
||||||
|
// runs the reaper at, so a loop that survives startup produces
|
||||||
|
// an observable sweep quickly.
|
||||||
|
reaperTestInterval = 10 * time.Millisecond
|
||||||
|
|
||||||
|
// reaperStopTimeout bounds how long a lifecycle test waits for
|
||||||
|
// the reaper's OnStop hook to return before declaring the
|
||||||
|
// shutdown hung.
|
||||||
|
reaperStopTimeout = 10 * time.Second
|
||||||
|
|
||||||
|
// reaperTestRetentionDays is the retention policy the lifecycle
|
||||||
|
// tests give their webhook.
|
||||||
|
reaperTestRetentionDays = 30
|
||||||
|
|
||||||
|
// reaperWedgeStopTimeout is the stop timeout the wedged-shutdown
|
||||||
|
// test hands OnStop, standing in for fx's StopTimeout. The test
|
||||||
|
// asserts only that the hook returns at all, and allows it
|
||||||
|
// reaperStopTimeout — forty times this budget — to do so, so no
|
||||||
|
// assertion races the wall clock.
|
||||||
|
reaperWedgeStopTimeout = 250 * time.Millisecond
|
||||||
|
)
|
||||||
|
|
||||||
|
// recordingLifecycle is a minimal fx.Lifecycle that records the
|
||||||
|
// hooks a component registers, so a test can invoke the real
|
||||||
|
// OnStart/OnStop functions with a context of its choosing.
|
||||||
|
type recordingLifecycle struct {
|
||||||
|
hooks []fx.Hook
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *recordingLifecycle) Append(h fx.Hook) {
|
||||||
|
l.hooks = append(l.hooks, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
// startReaperViaHook drives the genuine fx hooks the application
|
||||||
|
// registers for the reaper, handing OnStart a context that is
|
||||||
|
// already done. It returns the recorded lifecycle so the caller
|
||||||
|
// can drive OnStop too.
|
||||||
|
func startReaperViaHook(
|
||||||
|
t *testing.T, r *database.RetentionReaper,
|
||||||
|
) *recordingLifecycle {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lc := &recordingLifecycle{}
|
||||||
|
r.ExportRegisterHooks(lc)
|
||||||
|
require.Len(t, lc.hooks, 1)
|
||||||
|
|
||||||
|
// fx hands OnStart a context carrying the application start
|
||||||
|
// timeout, and cancels it when the start phase ends. An
|
||||||
|
// already-cancelled context is that same defect taken to its
|
||||||
|
// limit, and unlike a plain context.Background() it actually
|
||||||
|
// distinguishes a correctly rooted loop from a broken one.
|
||||||
|
hookCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
require.NoError(t, lc.hooks[0].OnStart(hookCtx))
|
||||||
|
|
||||||
|
return lc
|
||||||
|
}
|
||||||
|
|
||||||
|
// eventGone reports whether an event row has been removed. It
|
||||||
|
// takes no *testing.T because it is polled from an
|
||||||
|
// assert.Eventually condition, which runs off the test goroutine
|
||||||
|
// where testify assertions must not be used.
|
||||||
|
func eventGone(db *gorm.DB, eventID string) bool {
|
||||||
|
var n int64
|
||||||
|
|
||||||
|
err := db.Unscoped().Model(&database.Event{}).
|
||||||
|
Where("id = ?", eventID).Count(&n).Error
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return n == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedExpiredWebhook creates a webhook with a finite retention
|
||||||
|
// policy plus one long-expired event chain, and returns the
|
||||||
|
// webhook's database and the chain's event ID.
|
||||||
|
func seedExpiredWebhook(
|
||||||
|
t *testing.T, env *retentionTestEnv,
|
||||||
|
) (*gorm.DB, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
webhookID := createWebhook(
|
||||||
|
t, env.mainDB.DB(), reaperTestRetentionDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
db, err := env.mgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
chain := seedEventChain(
|
||||||
|
t, db, webhookID,
|
||||||
|
time.Now().Add(-365*24*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
return db, chain.eventID
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRetentionReaper_LoopOutlivesStartHookContext is the
|
||||||
|
// regression test for a reaper that never reaped. fx calls
|
||||||
|
// OnStart with a context carrying the application's start timeout
|
||||||
|
// (15s by default) and cancels it when the start phase ends, so a
|
||||||
|
// sweep loop rooted in it is dead three quarters of an hour
|
||||||
|
// before its first tick under the default one-hour interval, and
|
||||||
|
// per-webhook event databases grow without bound exactly as they
|
||||||
|
// did before retention existed.
|
||||||
|
//
|
||||||
|
// Driving OnStart with an already-cancelled context is that
|
||||||
|
// defect taken to its limit: a loop that inherits the hook
|
||||||
|
// context never ticks once, while a correctly rooted loop keeps
|
||||||
|
// sweeping for as long as the process lives.
|
||||||
|
func TestRetentionReaper_LoopOutlivesStartHookContext(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
db, eventID := seedExpiredWebhook(t, env)
|
||||||
|
|
||||||
|
env.reaper.ExportSetInterval(reaperTestInterval)
|
||||||
|
|
||||||
|
lc := startReaperViaHook(t, env.reaper)
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = lc.hooks[0].OnStop(context.Background())
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Eventually(
|
||||||
|
t,
|
||||||
|
func() bool { return eventGone(db, eventID) },
|
||||||
|
5*time.Second,
|
||||||
|
reaperTestInterval,
|
||||||
|
"the sweep loop must keep running after the start "+
|
||||||
|
"hook's context is done; it reaped nothing, so it "+
|
||||||
|
"inherited the hook context and died",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRetentionReaper_StopHookStopsLoop proves the fix did not
|
||||||
|
// trade a startup bug for a shutdown hang: now that the sweep
|
||||||
|
// loop no longer observes the start hook's cancellation, OnStop
|
||||||
|
// is the only thing that can stop it, and it must both return
|
||||||
|
// promptly and actually leave the loop stopped.
|
||||||
|
func TestRetentionReaper_StopHookStopsLoop(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
db, eventID := seedExpiredWebhook(t, env)
|
||||||
|
|
||||||
|
env.reaper.ExportSetInterval(reaperTestInterval)
|
||||||
|
|
||||||
|
lc := startReaperViaHook(t, env.reaper)
|
||||||
|
|
||||||
|
// Let the loop prove it is running before stopping it, so a
|
||||||
|
// fast OnStop cannot pass by stopping something already dead.
|
||||||
|
require.Eventually(
|
||||||
|
t,
|
||||||
|
func() bool { return eventGone(db, eventID) },
|
||||||
|
5*time.Second,
|
||||||
|
reaperTestInterval,
|
||||||
|
)
|
||||||
|
|
||||||
|
var stopErr error
|
||||||
|
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(stopped)
|
||||||
|
|
||||||
|
// stop blocks on the loop's WaitGroup, so returning at all
|
||||||
|
// proves the goroutine observed the cancellation.
|
||||||
|
stopErr = lc.hooks[0].OnStop(context.Background())
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
case <-time.After(reaperStopTimeout):
|
||||||
|
t.Fatal(
|
||||||
|
"OnStop did not return: the retention reaper's " +
|
||||||
|
"WaitGroup is still waiting on a loop that never " +
|
||||||
|
"observed cancellation",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, stopErr)
|
||||||
|
|
||||||
|
// With the loop gone, a newly expired chain must survive.
|
||||||
|
survivor := seedEventChain(
|
||||||
|
t, db, "stopped-webhook",
|
||||||
|
time.Now().Add(-365*24*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
time.Sleep(20 * reaperTestInterval)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t,
|
||||||
|
eventGone(db, survivor.eventID),
|
||||||
|
"a stopped reaper must not sweep anything",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRetentionReaper_StopHookHonoursStopTimeout is the
|
||||||
|
// regression test for a shutdown that could never complete. fx
|
||||||
|
// hands OnStop a context carrying the application's stop timeout;
|
||||||
|
// an OnStop that discards it and calls wg.Wait() bare hangs the
|
||||||
|
// process forever on a sweep blocked on a locked SQLite database
|
||||||
|
// — precisely when a bounded shutdown matters most.
|
||||||
|
//
|
||||||
|
// The wedged goroutine here never observes cancellation, so the
|
||||||
|
// hook can only return by honouring its context, and it must say
|
||||||
|
// so rather than reporting a clean stop.
|
||||||
|
func TestRetentionReaper_StopHookHonoursStopTimeout(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
env.reaper.ExportSetInterval(reaperTestInterval)
|
||||||
|
|
||||||
|
lc := startReaperViaHook(t, env.reaper)
|
||||||
|
|
||||||
|
release := make(chan struct{})
|
||||||
|
|
||||||
|
t.Cleanup(func() { close(release) })
|
||||||
|
|
||||||
|
env.reaper.ExportWedgeLoop(release)
|
||||||
|
|
||||||
|
stopCtx, cancel := context.WithTimeout(
|
||||||
|
context.Background(), reaperWedgeStopTimeout,
|
||||||
|
)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
var stopErr error
|
||||||
|
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(stopped)
|
||||||
|
|
||||||
|
stopErr = lc.hooks[0].OnStop(stopCtx)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
case <-time.After(reaperStopTimeout):
|
||||||
|
t.Fatal(
|
||||||
|
"OnStop did not return: it discarded the stop " +
|
||||||
|
"context and is waiting on a wedged goroutine " +
|
||||||
|
"that will never observe cancellation",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.ErrorIs(t, stopErr, context.DeadlineExceeded)
|
||||||
|
require.ErrorContains(t, stopErr, "retention reaper")
|
||||||
|
}
|
||||||
402
internal/database/retention_test.go
Normal file
402
internal/database/retention_test.go
Normal file
@@ -0,0 +1,402 @@
|
|||||||
|
package database_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx/fxtest"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/globals"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
// retentionTestEnv bundles the pieces a retention test drives.
|
||||||
|
type retentionTestEnv struct {
|
||||||
|
reaper *database.RetentionReaper
|
||||||
|
mainDB *database.Database
|
||||||
|
mgr *database.WebhookDBManager
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupRetentionTest(t *testing.T) *retentionTestEnv {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lc := fxtest.NewLifecycle(t)
|
||||||
|
|
||||||
|
g := &globals.Globals{
|
||||||
|
Appname: testAppname,
|
||||||
|
Version: testVersion,
|
||||||
|
}
|
||||||
|
|
||||||
|
l, err := logger.New(lc, logger.LoggerParams{Globals: g})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
cfg := &config.Config{
|
||||||
|
DataDir: t.TempDir(),
|
||||||
|
Environment: "dev",
|
||||||
|
}
|
||||||
|
|
||||||
|
mainDB, err := database.New(lc, database.DatabaseParams{
|
||||||
|
Config: cfg,
|
||||||
|
Logger: l,
|
||||||
|
})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
mgr, err := database.NewWebhookDBManager(
|
||||||
|
lc,
|
||||||
|
database.WebhookDBManagerParams{Config: cfg, Logger: l},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
require.NoError(t, lc.Start(ctx))
|
||||||
|
t.Cleanup(func() { require.NoError(t, lc.Stop(ctx)) })
|
||||||
|
|
||||||
|
return &retentionTestEnv{
|
||||||
|
reaper: database.NewTestRetentionReaper(mainDB, mgr),
|
||||||
|
mainDB: mainDB,
|
||||||
|
mgr: mgr,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// createWebhook inserts a webhook row into the main database with the
|
||||||
|
// given retention policy and returns its ID.
|
||||||
|
func createWebhook(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
retentionDays int,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: uuid.New().String(),
|
||||||
|
Name: testWebhookName,
|
||||||
|
RetentionDays: retentionDays,
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
// Webhook.BeforeSave rewrites a non-positive RetentionDays to the
|
||||||
|
// retain-forever sentinel, and the column's GORM default would
|
||||||
|
// otherwise substitute 30. Force the requested value with a
|
||||||
|
// column-level update so tests can plant legacy rows that predate
|
||||||
|
// the sentinel and still carry a literal 0 or negative value.
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Model(wh).
|
||||||
|
Update("retention_days", retentionDays).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
// createWebhookNormally inserts a webhook through the ordinary Create
|
||||||
|
// path, with no column-level forcing, so Webhook.BeforeSave applies
|
||||||
|
// exactly as it does in production. Passing 0 therefore yields a row
|
||||||
|
// holding the RetentionForeverDays sentinel.
|
||||||
|
func createWebhookNormally(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
retentionDays int,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: uuid.New().String(),
|
||||||
|
Name: testWebhookName,
|
||||||
|
RetentionDays: retentionDays,
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
// eventChain is the set of row IDs seeded for a single event.
|
||||||
|
type eventChain struct {
|
||||||
|
eventID string
|
||||||
|
deliveryID string
|
||||||
|
resultID string
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedEventChain creates an event with one delivery and one delivery
|
||||||
|
// result, all stamped with createdAt, and returns their IDs.
|
||||||
|
func seedEventChain(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
webhookID string,
|
||||||
|
createdAt time.Time,
|
||||||
|
) eventChain {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
event := &database.Event{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
EntrypointID: uuid.New().String(),
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"seed": true}`,
|
||||||
|
ContentType: testContentType,
|
||||||
|
}
|
||||||
|
event.CreatedAt = createdAt
|
||||||
|
require.NoError(t, db.Create(event).Error)
|
||||||
|
|
||||||
|
delivery := &database.Delivery{
|
||||||
|
EventID: event.ID,
|
||||||
|
TargetID: uuid.New().String(),
|
||||||
|
Status: database.DeliveryStatusDelivered,
|
||||||
|
}
|
||||||
|
delivery.CreatedAt = createdAt
|
||||||
|
require.NoError(t, db.Create(delivery).Error)
|
||||||
|
|
||||||
|
result := &database.DeliveryResult{
|
||||||
|
DeliveryID: delivery.ID,
|
||||||
|
AttemptNum: 1,
|
||||||
|
Success: true,
|
||||||
|
StatusCode: 200,
|
||||||
|
Duration: 10,
|
||||||
|
}
|
||||||
|
result.CreatedAt = createdAt
|
||||||
|
require.NoError(t, db.Create(result).Error)
|
||||||
|
|
||||||
|
return eventChain{
|
||||||
|
eventID: event.ID,
|
||||||
|
deliveryID: delivery.ID,
|
||||||
|
resultID: result.ID,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// countByID returns how many rows of model match the given id,
|
||||||
|
// counting even hard-deletable rows via Unscoped.
|
||||||
|
func countByID(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
model any,
|
||||||
|
id string,
|
||||||
|
) int64 {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var n int64
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.Unscoped().Model(model).
|
||||||
|
Where("id = ?", id).Count(&n).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertChainGone(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
chain eventChain,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
assert.Zero(
|
||||||
|
t,
|
||||||
|
countByID(t, db, &database.Event{}, chain.eventID),
|
||||||
|
"expired event should be removed",
|
||||||
|
)
|
||||||
|
assert.Zero(
|
||||||
|
t,
|
||||||
|
countByID(t, db, &database.Delivery{}, chain.deliveryID),
|
||||||
|
"expired delivery should be removed",
|
||||||
|
)
|
||||||
|
assert.Zero(
|
||||||
|
t,
|
||||||
|
countByID(
|
||||||
|
t, db, &database.DeliveryResult{}, chain.resultID,
|
||||||
|
),
|
||||||
|
"expired delivery result should be removed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertChainPresent(
|
||||||
|
t *testing.T,
|
||||||
|
db *gorm.DB,
|
||||||
|
chain eventChain,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
int64(1),
|
||||||
|
countByID(t, db, &database.Event{}, chain.eventID),
|
||||||
|
"recent event should be retained",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
int64(1),
|
||||||
|
countByID(t, db, &database.Delivery{}, chain.deliveryID),
|
||||||
|
"recent delivery should be retained",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
int64(1),
|
||||||
|
countByID(
|
||||||
|
t, db, &database.DeliveryResult{}, chain.resultID,
|
||||||
|
),
|
||||||
|
"recent delivery result should be retained",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetentionReaper_ReapsExpiredKeepsRecent(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
const retentionDays = 30
|
||||||
|
|
||||||
|
webhookID := createWebhook(
|
||||||
|
t, env.mainDB.DB(), retentionDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
db, err := env.mgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
old := seedEventChain(
|
||||||
|
t, db, webhookID,
|
||||||
|
now.Add(-40*24*time.Hour),
|
||||||
|
)
|
||||||
|
recent := seedEventChain(
|
||||||
|
t, db, webhookID,
|
||||||
|
now.Add(-1*24*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.reaper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assertChainGone(t, db, old)
|
||||||
|
assertChainPresent(t, db, recent)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRetentionReaper_SkipsSentinelReapsFiniteInSameSweep covers the
|
||||||
|
// end-to-end retain-forever path: a webhook created the normal way with
|
||||||
|
// a requested retention of 0 lands on the RetentionForeverDays
|
||||||
|
// sentinel, and the reaper leaves its ancient events alone while still
|
||||||
|
// reaping a finite-retention webhook in the very same sweep.
|
||||||
|
func TestRetentionReaper_SkipsSentinelReapsFiniteInSameSweep(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
foreverID := createWebhookNormally(t, env.mainDB.DB(), 0)
|
||||||
|
|
||||||
|
var stored database.Webhook
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().Where("id = ?", foreverID).
|
||||||
|
First(&stored).Error,
|
||||||
|
)
|
||||||
|
require.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
stored.RetentionDays,
|
||||||
|
"a requested retention of 0 must persist as the sentinel",
|
||||||
|
)
|
||||||
|
|
||||||
|
finiteID := createWebhookNormally(t, env.mainDB.DB(), 30)
|
||||||
|
|
||||||
|
foreverDB, err := env.mgr.GetDB(foreverID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
finiteDB, err := env.mgr.GetDB(finiteID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ancient := time.Now().Add(-365 * 24 * time.Hour)
|
||||||
|
kept := seedEventChain(t, foreverDB, foreverID, ancient)
|
||||||
|
doomed := seedEventChain(t, finiteDB, finiteID, ancient)
|
||||||
|
|
||||||
|
env.reaper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assertChainPresent(t, foreverDB, kept)
|
||||||
|
assertChainGone(t, finiteDB, doomed)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRetentionReaper_HugeFiniteRetentionRetainsRecentEvents pins the
|
||||||
|
// overflow that made a large finite retention destroy everything.
|
||||||
|
//
|
||||||
|
// The cutoff is a time.Duration, an int64 nanosecond count. A day
|
||||||
|
// count above MaxFiniteRetentionDays multiplied out unclamped wraps
|
||||||
|
// negative, so subtracting it moves the cutoff into the far future,
|
||||||
|
// where "created_at < cutoff" matches every row: an event created a
|
||||||
|
// moment ago, and its delivery and delivery result, were all deleted
|
||||||
|
// on the first sweep. 200000 is inside that band and below the
|
||||||
|
// retain-forever sentinel, so it is treated as a finite policy and
|
||||||
|
// really does reach the arithmetic.
|
||||||
|
//
|
||||||
|
// The row is planted at the column level because such a value can no
|
||||||
|
// longer be submitted through the form; the point of the test is that
|
||||||
|
// a row from an older version, or a future call site, still cannot
|
||||||
|
// trigger the wipe.
|
||||||
|
func TestRetentionReaper_HugeFiniteRetentionRetainsRecentEvents(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
const overflowingRetentionDays = 200000
|
||||||
|
|
||||||
|
require.Greater(
|
||||||
|
t,
|
||||||
|
overflowingRetentionDays,
|
||||||
|
database.MaxFiniteRetentionDays,
|
||||||
|
"the test value must exceed what the cutoff can represent",
|
||||||
|
)
|
||||||
|
require.Less(
|
||||||
|
t,
|
||||||
|
overflowingRetentionDays,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
"the test value must not be rescued by the forever skip",
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookID := createWebhook(
|
||||||
|
t, env.mainDB.DB(), overflowingRetentionDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
db, err := env.mgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
fresh := seedEventChain(t, db, webhookID, time.Now())
|
||||||
|
|
||||||
|
env.reaper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assertChainPresent(t, db, fresh)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetentionReaper_RetainsForeverWhenNonPositive(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
|
// A legacy row written before the sentinel existed still carries a
|
||||||
|
// literal 0; the <= 0 guard must keep honouring it.
|
||||||
|
webhookID := createWebhook(t, env.mainDB.DB(), 0)
|
||||||
|
|
||||||
|
db, err := env.mgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ancient := seedEventChain(
|
||||||
|
t, db, webhookID,
|
||||||
|
time.Now().Add(-365*24*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.reaper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assertChainPresent(t, db, ancient)
|
||||||
|
}
|
||||||
@@ -14,7 +14,10 @@ import (
|
|||||||
func NewTestDatabase(db *gorm.DB) *Database {
|
func NewTestDatabase(db *gorm.DB) *Database {
|
||||||
return &Database{
|
return &Database{
|
||||||
db: db,
|
db: db,
|
||||||
log: slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelDebug})),
|
log: slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
)),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -23,6 +26,9 @@ func NewTestDatabase(db *gorm.DB) *Database {
|
|||||||
func NewTestWebhookDBManager(dataDir string) *WebhookDBManager {
|
func NewTestWebhookDBManager(dataDir string) *WebhookDBManager {
|
||||||
return &WebhookDBManager{
|
return &WebhookDBManager{
|
||||||
dataDir: dataDir,
|
dataDir: dataDir,
|
||||||
log: slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelDebug})),
|
log: slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
)),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package database_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -25,8 +26,8 @@ func setupTestWebhookDBManager(
|
|||||||
lc := fxtest.NewLifecycle(t)
|
lc := fxtest.NewLifecycle(t)
|
||||||
|
|
||||||
g := &globals.Globals{
|
g := &globals.Globals{
|
||||||
Appname: "webhooker-test",
|
Appname: testAppname,
|
||||||
Version: "test",
|
Version: testVersion,
|
||||||
}
|
}
|
||||||
|
|
||||||
l, err := logger.New(
|
l, err := logger.New(
|
||||||
@@ -83,10 +84,10 @@ func TestWebhookDBManager_CreateAndGetDB(t *testing.T) {
|
|||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
WebhookID: webhookID,
|
WebhookID: webhookID,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{"Content-Type":["application/json"]}`,
|
Headers: `{"Content-Type":["application/json"]}`,
|
||||||
Body: `{"test": true}`,
|
Body: `{"test": true}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
require.NoError(t, db.Create(event).Error)
|
require.NoError(t, db.Create(event).Error)
|
||||||
assert.NotEmpty(t, event.ID)
|
assert.NotEmpty(t, event.ID)
|
||||||
@@ -99,7 +100,7 @@ func TestWebhookDBManager_CreateAndGetDB(t *testing.T) {
|
|||||||
db.First(&readEvent, "id = ?", event.ID).Error,
|
db.First(&readEvent, "id = ?", event.ID).Error,
|
||||||
)
|
)
|
||||||
assert.Equal(t, webhookID, readEvent.WebhookID)
|
assert.Equal(t, webhookID, readEvent.WebhookID)
|
||||||
assert.Equal(t, "POST", readEvent.Method)
|
assert.Equal(t, http.MethodPost, readEvent.Method)
|
||||||
assert.Equal(t, `{"test": true}`, readEvent.Body)
|
assert.Equal(t, `{"test": true}`, readEvent.Body)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -123,9 +124,9 @@ func TestWebhookDBManager_DeleteDB(t *testing.T) {
|
|||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
WebhookID: webhookID,
|
WebhookID: webhookID,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Body: `{"test": true}`,
|
Body: `{"test": true}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
require.NoError(t, db.Create(event).Error)
|
require.NoError(t, db.Create(event).Error)
|
||||||
|
|
||||||
@@ -196,10 +197,10 @@ func seedDeliveryWorkflow(
|
|||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
WebhookID: webhookID,
|
WebhookID: webhookID,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{"Content-Type":["application/json"]}`,
|
Headers: `{"Content-Type":["application/json"]}`,
|
||||||
Body: `{"payload": "test"}`,
|
Body: `{"payload": "test"}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
require.NoError(t, db.Create(event).Error)
|
require.NoError(t, db.Create(event).Error)
|
||||||
|
|
||||||
@@ -231,7 +232,7 @@ func verifyPendingDeliveries(
|
|||||||
)
|
)
|
||||||
require.Len(t, pending, 1)
|
require.Len(t, pending, 1)
|
||||||
assert.Equal(t, event.ID, pending[0].EventID)
|
assert.Equal(t, event.ID, pending[0].EventID)
|
||||||
assert.Equal(t, "POST", pending[0].Event.Method)
|
assert.Equal(t, http.MethodPost, pending[0].Event.Method)
|
||||||
}
|
}
|
||||||
|
|
||||||
func completeDelivery(
|
func completeDelivery(
|
||||||
@@ -303,16 +304,16 @@ func TestWebhookDBManager_MultipleWebhooks(t *testing.T) {
|
|||||||
event1 := &database.Event{
|
event1 := &database.Event{
|
||||||
WebhookID: webhook1,
|
WebhookID: webhook1,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Body: `{"webhook": 1}`,
|
Body: `{"webhook": 1}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
event2 := &database.Event{
|
event2 := &database.Event{
|
||||||
WebhookID: webhook2,
|
WebhookID: webhook2,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "PUT",
|
Method: http.MethodPut,
|
||||||
Body: `{"webhook": 2}`,
|
Body: `{"webhook": 2}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, db1.Create(event1).Error)
|
require.NoError(t, db1.Create(event1).Error)
|
||||||
|
|||||||
239
internal/delivery/archive_sweeper.go
Normal file
239
internal/delivery/archive_sweeper.go
Normal file
@@ -0,0 +1,239 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/lifecycle"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ArchiveSweeperParams holds the fx dependencies for the
|
||||||
|
// ArchiveSweeper.
|
||||||
|
type ArchiveSweeperParams struct {
|
||||||
|
fx.In
|
||||||
|
|
||||||
|
Config *config.Config
|
||||||
|
Database *database.Database
|
||||||
|
Engine *Engine
|
||||||
|
Logger *logger.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// ArchiveSweeper periodically prunes expired rows from
|
||||||
|
// per-webhook archive databases whose database target carries a
|
||||||
|
// positive expiry.
|
||||||
|
//
|
||||||
|
// Without it, pruning happens only when an archive is
|
||||||
|
// (re)opened, and archives are only ever reopened by writes: an
|
||||||
|
// archive belonging to a webhook that has stopped receiving
|
||||||
|
// events would keep its expired rows forever. The sweep closes
|
||||||
|
// that gap without changing anything for archives whose expiry
|
||||||
|
// is unset or "never".
|
||||||
|
//
|
||||||
|
// It reuses Config.RetentionSweepInterval rather than
|
||||||
|
// introducing a second interval: this is a retention sweep with
|
||||||
|
// the same semantics as the event retention reaper.
|
||||||
|
type ArchiveSweeper struct {
|
||||||
|
db *database.Database
|
||||||
|
eng *Engine
|
||||||
|
log *slog.Logger
|
||||||
|
interval time.Duration
|
||||||
|
cancel context.CancelFunc
|
||||||
|
wg sync.WaitGroup
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewArchiveSweeper creates the archive sweeper and registers
|
||||||
|
// its fx lifecycle hooks. The background sweep loop starts on
|
||||||
|
// OnStart and stops cleanly on OnStop via context cancellation.
|
||||||
|
func NewArchiveSweeper(
|
||||||
|
lc fx.Lifecycle,
|
||||||
|
params ArchiveSweeperParams,
|
||||||
|
) *ArchiveSweeper {
|
||||||
|
s := &ArchiveSweeper{
|
||||||
|
db: params.Database,
|
||||||
|
eng: params.Engine,
|
||||||
|
log: params.Logger.Get(),
|
||||||
|
interval: params.Config.RetentionSweepInterval,
|
||||||
|
}
|
||||||
|
|
||||||
|
s.registerHooks(lc)
|
||||||
|
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// registerHooks wires the sweeper's start and stop into the fx
|
||||||
|
// lifecycle. The start hook's context is deliberately ignored
|
||||||
|
// (see start for why the background loop must not inherit it);
|
||||||
|
// the stop hook's context is honoured (see stop).
|
||||||
|
func (s *ArchiveSweeper) registerHooks(lc fx.Lifecycle) {
|
||||||
|
lc.Append(fx.Hook{
|
||||||
|
//nolint:contextcheck // Not passing the hook context is
|
||||||
|
// the point: see start.
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
s.start()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(ctx context.Context) error {
|
||||||
|
return s.stop(ctx)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// start launches the background sweep loop.
|
||||||
|
//
|
||||||
|
// The loop's context is derived from context.Background(), NOT
|
||||||
|
// from the fx OnStart hook context. The hook context carries
|
||||||
|
// fx's start timeout (15s by default), so a loop derived from it
|
||||||
|
// is cancelled 15 seconds after the application starts — long
|
||||||
|
// before the first tick under the default one-hour sweep
|
||||||
|
// interval, leaving a sweeper that never sweeps. A long-lived
|
||||||
|
// goroutine must outlive the startup phase, so its lifetime is
|
||||||
|
// bounded by OnStop instead: stop cancels this context and waits
|
||||||
|
// on the WaitGroup.
|
||||||
|
func (s *ArchiveSweeper) start() {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
s.cancel = cancel
|
||||||
|
|
||||||
|
s.wg.Add(1)
|
||||||
|
|
||||||
|
go s.run(ctx)
|
||||||
|
|
||||||
|
s.log.Info(
|
||||||
|
"archive sweeper started",
|
||||||
|
"interval", s.interval.String(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stop cancels the sweep loop's context and waits for it to
|
||||||
|
// exit, bounded by the stop hook's context: a prune wedged on a
|
||||||
|
// locked archive must not hang the process past fx's stop
|
||||||
|
// timeout.
|
||||||
|
func (s *ArchiveSweeper) stop(ctx context.Context) error {
|
||||||
|
s.log.Info("archive sweeper stopping")
|
||||||
|
|
||||||
|
if s.cancel != nil {
|
||||||
|
s.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
err := lifecycle.WaitForShutdown(
|
||||||
|
ctx, s.log, "archive sweeper", &s.wg,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
s.log.Info("archive sweeper stopped")
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *ArchiveSweeper) run(ctx context.Context) {
|
||||||
|
defer s.wg.Done()
|
||||||
|
|
||||||
|
ticker := time.NewTicker(s.interval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
s.sweep(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweep prunes every archive whose database target declares a
|
||||||
|
// positive expiry. Targets belonging to a deleted webhook are
|
||||||
|
// soft-deleted along with it, so GORM's default scope already
|
||||||
|
// excludes them.
|
||||||
|
//
|
||||||
|
// A failure for one webhook is logged and the sweep continues,
|
||||||
|
// matching how the write path already treats a prune error as
|
||||||
|
// non-fatal.
|
||||||
|
func (s *ArchiveSweeper) sweep(ctx context.Context) {
|
||||||
|
var targets []database.Target
|
||||||
|
|
||||||
|
err := s.db.DB().
|
||||||
|
Model(&database.Target{}).
|
||||||
|
Where("type = ?", database.TargetTypeDatabase).
|
||||||
|
Find(&targets).Error
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: failed to list database targets",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range targets {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
s.sweepTarget(&targets[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepTarget prunes the archive of a single database target.
|
||||||
|
// A missing, empty, or "never" expiry parses as a zero duration
|
||||||
|
// and is skipped entirely, so those archives keep exactly the
|
||||||
|
// behaviour they had before the sweep existed.
|
||||||
|
func (s *ArchiveSweeper) sweepTarget(target *database.Target) {
|
||||||
|
expiry, err := parseArchiveExpiry(target.Config)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: invalid database target config",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if expiry <= 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.eng == nil || s.eng.dbTarget == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
err = s.eng.dbTarget.sweepWebhook(target.WebhookID, expiry)
|
||||||
|
if err == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// A writer evicted underneath the sweep means the operator
|
||||||
|
// deleted the webhook (or its last database target) while the
|
||||||
|
// sweep was walking the target list. That is an ordinary
|
||||||
|
// interleaving, not a failure, so it must not produce an
|
||||||
|
// error line.
|
||||||
|
if errors.Is(err, errArchiveWriterEvicted) {
|
||||||
|
s.log.Debug(
|
||||||
|
"archive sweep: writer evicted mid-sweep",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: failed to prune archive",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
947
internal/delivery/archive_sweeper_test.go
Normal file
947
internal/delivery/archive_sweeper_test.go
Normal file
@@ -0,0 +1,947 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/driver/sqlite"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
_ "modernc.org/sqlite" // Pure Go SQLite driver.
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// sweepRowOld and sweepRowNew are the event ids
|
||||||
|
// seedArchiveRows assigns to the first and second seeded
|
||||||
|
// rows.
|
||||||
|
sweepRowOld = "ev-0"
|
||||||
|
sweepRowNew = "ev-1"
|
||||||
|
|
||||||
|
// sweepConcurrentWrites is how many deliveries the
|
||||||
|
// concurrent write-plus-sweep test races against the sweep.
|
||||||
|
sweepConcurrentWrites = 20
|
||||||
|
)
|
||||||
|
|
||||||
|
// sweeperEnv bundles the pieces an archive sweep test drives:
|
||||||
|
// a main configuration database holding webhooks and targets, a
|
||||||
|
// delivery engine owning the archive writer registry, and the
|
||||||
|
// data directory the archive files live in.
|
||||||
|
type sweeperEnv struct {
|
||||||
|
sweeper *delivery.ArchiveSweeper
|
||||||
|
eng *delivery.Engine
|
||||||
|
mainDB *database.Database
|
||||||
|
dataDir string
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupSweeperTest(t *testing.T) *sweeperEnv {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
log := archiveTestLogger()
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite",
|
||||||
|
fmt.Sprintf(
|
||||||
|
"file:%s?mode=rwc",
|
||||||
|
filepath.Join(dataDir, "main.db"),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = sqlDB.Close() })
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
mainDB := database.NewTestDatabase(gdb)
|
||||||
|
require.NoError(t, mainDB.Migrate())
|
||||||
|
|
||||||
|
eng := delivery.NewTestEngineWithDB(
|
||||||
|
mainDB,
|
||||||
|
database.NewTestWebhookDBManager(dataDir),
|
||||||
|
log,
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
return &sweeperEnv{
|
||||||
|
sweeper: delivery.NewTestArchiveSweeper(
|
||||||
|
mainDB, eng, log,
|
||||||
|
),
|
||||||
|
eng: eng,
|
||||||
|
mainDB: mainDB,
|
||||||
|
dataDir: dataDir,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePath returns where the engine keeps a webhook's
|
||||||
|
// archive file.
|
||||||
|
func (env *sweeperEnv) archivePath(webhookID string) string {
|
||||||
|
return filepath.Join(
|
||||||
|
env.dataDir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedDatabaseTarget creates a webhook with one database target
|
||||||
|
// carrying the given target config JSON, and returns the
|
||||||
|
// webhook id.
|
||||||
|
func (env *sweeperEnv) seedDatabaseTarget(
|
||||||
|
t *testing.T, configJSON string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: uuid.New().String(),
|
||||||
|
Name: "sweep-test",
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Omit(clause.Associations).
|
||||||
|
Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
tgt := &database.Target{
|
||||||
|
WebhookID: wh.ID,
|
||||||
|
Name: "archive",
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Active: true,
|
||||||
|
Config: configJSON,
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Omit(clause.Associations).
|
||||||
|
Create(tgt).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedArchiveRows creates the archive file for a webhook and
|
||||||
|
// inserts one row per supplied archived-at timestamp, returning
|
||||||
|
// the archive path. The handle is closed before returning, so
|
||||||
|
// the archive is idle exactly as it would be with no traffic.
|
||||||
|
func (env *sweeperEnv) seedArchiveRows(
|
||||||
|
t *testing.T, webhookID string, archivedAt ...time.Time,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=rwc", path),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t, gdb.AutoMigrate(&delivery.ExportArchivedEvent{}),
|
||||||
|
)
|
||||||
|
|
||||||
|
for i, at := range archivedAt {
|
||||||
|
row := delivery.ExportArchivedEvent{
|
||||||
|
EventID: fmt.Sprintf("ev-%d", i),
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"seeded":true}`,
|
||||||
|
ArchivedAt: at,
|
||||||
|
}
|
||||||
|
require.NoError(t, gdb.Create(&row).Error)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, sqlDB.Close())
|
||||||
|
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivedEventIDs returns the event ids currently stored in an
|
||||||
|
// archive file, read through a separate read-only handle.
|
||||||
|
func archivedEventIDs(
|
||||||
|
t *testing.T, path string,
|
||||||
|
) []string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var rows []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
rdb := openArchiveDBForRead(t, path)
|
||||||
|
require.NoError(t, rdb.Order("event_id").Find(&rows).Error)
|
||||||
|
|
||||||
|
ids := make([]string, 0, len(rows))
|
||||||
|
for i := range rows {
|
||||||
|
ids = append(ids, rows[i].EventID)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ids
|
||||||
|
}
|
||||||
|
|
||||||
|
// countArchivedRows counts the rows in an archive file without
|
||||||
|
// asserting anything, so it is safe to poll from an
|
||||||
|
// assert.Eventually condition (which runs off the test
|
||||||
|
// goroutine, where testify assertions must not be used).
|
||||||
|
func countArchivedRows(path string) (int64, error) {
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=ro", path),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = sqlDB.Close() }()
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var count int64
|
||||||
|
|
||||||
|
err = gdb.Model(&delivery.ExportArchivedEvent{}).
|
||||||
|
Count(&count).Error
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return count, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweeper_LoopOutlivesStartHookContext is the
|
||||||
|
// regression test for a sweeper that never swept. fx calls
|
||||||
|
// OnStart with a context carrying the application's start
|
||||||
|
// timeout (15 seconds by default), so a background loop whose
|
||||||
|
// context is derived from it is cancelled 15 seconds into the
|
||||||
|
// process — three quarters of an hour before the first tick
|
||||||
|
// under the default one-hour sweep interval.
|
||||||
|
//
|
||||||
|
// The hook context here is already cancelled, which is the same
|
||||||
|
// defect taken to its limit: a loop that inherits it never runs
|
||||||
|
// a single tick, while a correctly rooted loop keeps sweeping
|
||||||
|
// for as long as the process lives. Handing the hook a plain
|
||||||
|
// context.Background() would assert nothing at all.
|
||||||
|
func TestArchiveSweeper_LoopOutlivesStartHookContext(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
now.Add(-48*time.Hour),
|
||||||
|
now.Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSetInterval(10 * time.Millisecond)
|
||||||
|
|
||||||
|
// Drive the genuine fx hooks the application registers,
|
||||||
|
// rather than a test-only entry point.
|
||||||
|
lc := &recordingLifecycle{}
|
||||||
|
env.sweeper.ExportRegisterHooks(lc)
|
||||||
|
require.Len(t, lc.hooks, 1)
|
||||||
|
|
||||||
|
hookCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
require.NoError(t, lc.hooks[0].OnStart(hookCtx))
|
||||||
|
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = lc.hooks[0].OnStop(context.Background())
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Eventually(
|
||||||
|
t,
|
||||||
|
func() bool {
|
||||||
|
count, err := countArchivedRows(path)
|
||||||
|
|
||||||
|
return err == nil && count == 1
|
||||||
|
},
|
||||||
|
5*time.Second,
|
||||||
|
10*time.Millisecond,
|
||||||
|
"the sweep loop must keep running after the start "+
|
||||||
|
"hook's context is done; it pruned nothing, so it "+
|
||||||
|
"inherited the hook context and died",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotResurrectEvictedWriter covers the
|
||||||
|
// interleaving where a sweep tick has already listed a webhook's
|
||||||
|
// target when the webhook is deleted and its writer evicted. The
|
||||||
|
// sweep must not put a writer back into the registry: nothing
|
||||||
|
// would ever evict it again, which is precisely the leak this
|
||||||
|
// change exists to close.
|
||||||
|
func TestArchiveSweep_DoesNotResurrectEvictedWriter(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Prime the registry the way a delivery would, then evict as
|
||||||
|
// the deletion path does. The target row is deliberately left
|
||||||
|
// in place: this is the tick that listed the webhook before
|
||||||
|
// the deletion committed.
|
||||||
|
_, err := env.eng.ExportEnsureArchiveWriter(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
env.eng.EvictWebhook(webhookID)
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a sweep must never re-register a writer for a webhook "+
|
||||||
|
"whose registry entry has already been released",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_LeavesNoRegistryEntry states the same
|
||||||
|
// invariant in its general form: sweeping an archive whose
|
||||||
|
// webhook has no cached writer must not leave one behind, so the
|
||||||
|
// registry keeps holding only writers a delivery created and an
|
||||||
|
// eviction can reach.
|
||||||
|
func TestArchiveSweep_LeavesNoRegistryEntry(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
time.Now().Add(-48*time.Hour),
|
||||||
|
time.Now().Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew}, archivedEventIDs(t, path),
|
||||||
|
"the sweep must still prune an idle archive",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the sweep must release the registry entry it created",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedByDelivery is the other
|
||||||
|
// half of that invariant: an entry the sweep created but a
|
||||||
|
// delivery then claimed belongs to the registry and must survive
|
||||||
|
// the sweep, or the delivery would be left holding a detached
|
||||||
|
// writer with an open handle that no eviction can reach.
|
||||||
|
func TestArchiveSweep_KeepsWriterAdoptedByDelivery(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a delivery's writer must stay registered",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a sweep must not drop a writer a delivery owns",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedDuringSweep covers the one
|
||||||
|
// interleaving the sweepOwned flag exists for, which
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedByDelivery cannot reach: a
|
||||||
|
// delivery adopting the sweep's own entry WHILE that sweep is
|
||||||
|
// still running.
|
||||||
|
//
|
||||||
|
// The registry operations are driven directly, in the order the
|
||||||
|
// sweep and a concurrent delivery perform them, so the window is
|
||||||
|
// exercised deterministically rather than hoped for:
|
||||||
|
//
|
||||||
|
// 1. the sweep finds no cached writer and registers one of its
|
||||||
|
// own, marked sweep-owned;
|
||||||
|
// 2. a delivery arrives, is handed that very writer, clears the
|
||||||
|
// flag and opens the archive handle;
|
||||||
|
// 3. the sweep finishes and releases what it created.
|
||||||
|
//
|
||||||
|
// Step 3 must leave the entry alone. Dropping it would detach a
|
||||||
|
// writer that is holding an open archive handle inside its
|
||||||
|
// debounce window, and no eviction could ever reach it again —
|
||||||
|
// exactly the process-lifetime handle leak this change exists to
|
||||||
|
// close. The eviction at the end proves the entry is still
|
||||||
|
// reachable.
|
||||||
|
func TestArchiveSweep_KeepsWriterAdoptedDuringSweep(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
sweepWriter, created, err := env.eng.ExportSweepWriterFor(
|
||||||
|
webhookID,
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(
|
||||||
|
t, created,
|
||||||
|
"the sweep must have created the registry entry itself",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The delivery lands mid-sweep and adopts the entry.
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
adopted := env.eng.ExportArchiveWriterFor(webhookID)
|
||||||
|
require.NotNil(t, adopted)
|
||||||
|
require.True(
|
||||||
|
t, sweepWriter.Same(adopted),
|
||||||
|
"the delivery must have adopted the sweep's writer",
|
||||||
|
)
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the delivery leaves the archive handle open",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The sweep finishes.
|
||||||
|
env.eng.ExportReleaseSweepWriter(webhookID, sweepWriter)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a writer adopted by a delivery during a sweep must "+
|
||||||
|
"stay registered, or its open handle is unreachable",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.EvictWebhook(webhookID)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the adopted writer must still be evictable",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, sweepWriter.HandleOpen(),
|
||||||
|
"eviction must have closed the adopted writer's handle",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ContinuesAfterPerWebhookFailure proves a
|
||||||
|
// failure for one webhook does not abort the sweep for the
|
||||||
|
// others: an unparseable expiry and an unreadable archive both
|
||||||
|
// have to be logged and stepped over.
|
||||||
|
func TestArchiveSweep_ContinuesAfterPerWebhookFailure(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
// Seeded first so the sweep reaches them before the healthy
|
||||||
|
// webhook: targets come back in insertion order.
|
||||||
|
badConfigID := env.seedDatabaseTarget(t, `{"expiry":"!!!"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, badConfigID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
corruptID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
require.NoError(t, os.WriteFile(
|
||||||
|
env.archivePath(corruptID),
|
||||||
|
[]byte("this is not a sqlite database"),
|
||||||
|
0o600,
|
||||||
|
))
|
||||||
|
|
||||||
|
healthyID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
healthyPath := env.seedArchiveRows(
|
||||||
|
t, healthyID,
|
||||||
|
time.Now().Add(-48*time.Hour),
|
||||||
|
time.Now().Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew},
|
||||||
|
archivedEventIDs(t, healthyPath),
|
||||||
|
"a failure for an earlier webhook must not stop the "+
|
||||||
|
"sweep from pruning the ones after it",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_OpenExistingDoesNotCreateFile pins the second
|
||||||
|
// of the two no-create guards. The first is the stat in
|
||||||
|
// sweepWebhook; this one is the SQLite open mode, which is what
|
||||||
|
// protects the window between that stat and the open. Flipping
|
||||||
|
// the sweep's mode to create-if-missing makes this fail.
|
||||||
|
func TestArchiveSweep_OpenExistingDoesNotCreateFile(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "archive-absent.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
err := w.OpenExisting(time.Hour)
|
||||||
|
|
||||||
|
require.Error(
|
||||||
|
t, err,
|
||||||
|
"opening a missing archive without create permission "+
|
||||||
|
"must fail rather than conjure the file",
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, suffix := range archiveFileSuffixes() {
|
||||||
|
assert.NoFileExists(t, path+suffix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_PrunesIdleArchive is the core regression
|
||||||
|
// test for this issue: an archive that receives no further
|
||||||
|
// writes must still lose its expired rows. Before the sweeper
|
||||||
|
// existed, pruning only ever ran on a write-triggered reopen,
|
||||||
|
// so an idle archive kept expired rows forever.
|
||||||
|
func TestArchiveSweep_PrunesIdleArchive(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
now.Add(-48*time.Hour),
|
||||||
|
now.Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.Equal(
|
||||||
|
t, []string{sweepRowOld, sweepRowNew},
|
||||||
|
archivedEventIDs(t, path),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew}, archivedEventIDs(t, path),
|
||||||
|
"the sweep should prune rows older than the expiry "+
|
||||||
|
"from an idle archive and keep the rest",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_LeavesArchiveClosed proves the sweep does
|
||||||
|
// not hold the archive open afterwards, so an operator can
|
||||||
|
// still move the file away for offline retention.
|
||||||
|
//
|
||||||
|
// The assertion is made on a writer the test holds a reference
|
||||||
|
// to, and the handle is proven OPEN before the sweep runs, so the
|
||||||
|
// test observes the sweep closing it rather than a writer that
|
||||||
|
// merely never opened anything. Asking the registry instead would
|
||||||
|
// be vacuous here: the sweep releases an entry it created, and a
|
||||||
|
// missing entry reports "not open" whether or not anything was
|
||||||
|
// closed.
|
||||||
|
func TestArchiveSweep_LeavesArchiveClosed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.OpenExisting(time.Hour))
|
||||||
|
require.True(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"the writer must hold an open handle before the sweep",
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.SweepExpired(time.Hour))
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"an idle archive must end the sweep closed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ClosesHandleOfRegisteredWriter states the same
|
||||||
|
// guarantee end to end, through the real sweeper and a writer the
|
||||||
|
// registry keeps.
|
||||||
|
//
|
||||||
|
// The delivery leaves the archive handle open inside its debounce
|
||||||
|
// window and makes the entry delivery-owned, so the sweep finds a
|
||||||
|
// cached writer (created is false, nothing is released) and the
|
||||||
|
// registry query afterwards is answered by a writer that really
|
||||||
|
// exists. A handle left open here would be doubly wrong: it also
|
||||||
|
// blocks the operator's move-the-file-away workflow.
|
||||||
|
func TestArchiveSweep_ClosesHandleOfRegisteredWriter(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the delivery must leave the archive handle open",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the delivery's registry entry must survive the sweep",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the sweep must leave the archive closed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_NeverExpiryUntouched proves the sweep is a
|
||||||
|
// no-op for the default retention policy, so archives with no
|
||||||
|
// expiry (or the literal "never") behave exactly as before.
|
||||||
|
func TestArchiveSweep_NeverExpiryUntouched(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, configJSON := range []string{
|
||||||
|
`{"expiry":"never"}`,
|
||||||
|
`{"expiry":""}`,
|
||||||
|
"",
|
||||||
|
} {
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, configJSON)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
time.Now().Add(-10000*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowOld}, archivedEventIDs(t, path),
|
||||||
|
"config %q must keep rows forever", configJSON,
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"config %q must leave no registry entry behind",
|
||||||
|
configJSON,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_NeverExpirySkipsBeforeOpening pins the
|
||||||
|
// expiry <= 0 boundary in sweepTarget, which the row assertions
|
||||||
|
// above cannot reach: pruning is separately gated on a positive
|
||||||
|
// expiry, so a "never" archive keeps its rows even if the sweep
|
||||||
|
// does open it.
|
||||||
|
//
|
||||||
|
// The spec is stronger than that — a "never" archive is skipped
|
||||||
|
// before any file is touched — so the archive here exists but has
|
||||||
|
// never been migrated. Opening it at all would run AutoMigrate
|
||||||
|
// and create the archive table, which is exactly what must not
|
||||||
|
// happen.
|
||||||
|
func TestArchiveSweep_NeverExpirySkipsBeforeOpening(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"never"}`)
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
seedUnmigratedArchive(t, path)
|
||||||
|
require.False(t, archiveTableExists(t, path))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, archiveTableExists(t, path),
|
||||||
|
"a never-expiry archive must not be opened at all",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedUnmigratedArchive creates an archive file that exists but
|
||||||
|
// carries no archive schema, so any open of it is observable: the
|
||||||
|
// archive table appears only if something ran AutoMigrate.
|
||||||
|
func seedUnmigratedArchive(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=rwc", path),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, err = sqlDB.ExecContext(
|
||||||
|
t.Context(), "CREATE TABLE placeholder (id INTEGER)",
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, sqlDB.Close())
|
||||||
|
}
|
||||||
|
|
||||||
|
// archiveTableExists reports whether an archive file has had the
|
||||||
|
// archive schema migrated into it.
|
||||||
|
func archiveTableExists(t *testing.T, path string) bool {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
return openArchiveDBForRead(t, path).
|
||||||
|
Migrator().
|
||||||
|
HasTable(&delivery.ExportArchivedEvent{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotCreateArchiveFile proves the sweep
|
||||||
|
// never conjures an archive: a webhook with a database target
|
||||||
|
// that has never received an event must still have no archive
|
||||||
|
// file (nor SQLite sidecar) after a sweep.
|
||||||
|
func TestArchiveSweep_DoesNotCreateArchiveFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
require.NoFileExists(t, path)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
for _, suffix := range archiveFileSuffixes() {
|
||||||
|
assert.NoFileExists(
|
||||||
|
t, path+suffix,
|
||||||
|
"the sweep must not create an archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotCreateAfterWriterExists covers the
|
||||||
|
// same guarantee once a writer is cached in the registry but
|
||||||
|
// the file itself is still absent (for instance because the
|
||||||
|
// operator moved the archive away).
|
||||||
|
func TestArchiveSweep_DoesNotCreateAfterWriterExists(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
path, err := env.eng.ExportEnsureArchiveWriter(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoFileExists(t, path)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.NoFileExists(t, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_SkipsDeletedWebhookTargets proves that the
|
||||||
|
// sweep ignores targets soft-deleted along with their webhook,
|
||||||
|
// so a deleted webhook's archive is never reopened.
|
||||||
|
func TestArchiveSweep_SkipsDeletedWebhookTargets(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Where("webhook_id = ?", webhookID).
|
||||||
|
Delete(&database.Target{}).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowOld}, archivedEventIDs(t, path),
|
||||||
|
"a deleted target's archive must be left alone",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ConcurrentWrites proves the sweep serialises
|
||||||
|
// against writes through the per-webhook writer mutex. Run
|
||||||
|
// under -race, an unsynchronised sweep would be caught here.
|
||||||
|
func TestArchiveSweep_ConcurrentWrites(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
|
||||||
|
// The deliveries are seeded up front, on the test's own
|
||||||
|
// goroutine: the seed helpers assert, and testify assertions
|
||||||
|
// must not run off the test goroutine.
|
||||||
|
deliveries := make(
|
||||||
|
[]*database.Delivery, 0, sweepConcurrentWrites,
|
||||||
|
)
|
||||||
|
|
||||||
|
for range sweepConcurrentWrites {
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
|
||||||
|
deliveries = append(
|
||||||
|
deliveries,
|
||||||
|
seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
|
wg.Add(2)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
|
||||||
|
for _, d := range deliveries {
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
|
||||||
|
for range sweepConcurrentWrites {
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
assert.FileExists(t, env.archivePath(webhookID))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweeper_StopsCleanly proves the background loop
|
||||||
|
// exits on OnStop rather than leaking a goroutine.
|
||||||
|
func TestArchiveSweeper_StopsCleanly(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSetInterval(time.Millisecond)
|
||||||
|
env.sweeper.ExportStart()
|
||||||
|
|
||||||
|
// stop blocks on the loop's WaitGroup, so returning without
|
||||||
|
// error proves the loop observed the cancellation and exited
|
||||||
|
// well inside the stop context.
|
||||||
|
require.NoError(
|
||||||
|
t, env.sweeper.ExportStop(context.Background()),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweeper_StopHookHonoursStopTimeout is the sweeper's
|
||||||
|
// half of the same shutdown defect the engine and the retention
|
||||||
|
// reaper carried: an OnStop that discards its context and waits
|
||||||
|
// on the WaitGroup bare hangs the process forever on a prune
|
||||||
|
// wedged inside a locked archive.
|
||||||
|
func TestArchiveSweeper_StopHookHonoursStopTimeout(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
lc := &recordingLifecycle{}
|
||||||
|
env.sweeper.ExportRegisterHooks(lc)
|
||||||
|
require.Len(t, lc.hooks, 1)
|
||||||
|
require.NoError(t, lc.hooks[0].OnStart(context.Background()))
|
||||||
|
|
||||||
|
release := make(chan struct{})
|
||||||
|
|
||||||
|
t.Cleanup(func() { close(release) })
|
||||||
|
|
||||||
|
env.sweeper.ExportWedgeLoop(release)
|
||||||
|
|
||||||
|
requireStopHookExpires(t, lc.hooks[0], "archive sweeper")
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -126,36 +126,6 @@ func iHTTPConfig(url string) string {
|
|||||||
return string(data)
|
return string(data)
|
||||||
}
|
}
|
||||||
|
|
||||||
func iWebhookDB(t *testing.T) *gorm.DB {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
dbPath := filepath.Join(
|
|
||||||
t.TempDir(), "events-test.db",
|
|
||||||
)
|
|
||||||
|
|
||||||
dsn := fmt.Sprintf(
|
|
||||||
"file:%s?cache=shared&mode=rwc", dbPath,
|
|
||||||
)
|
|
||||||
|
|
||||||
sqlDB, err := sql.Open("sqlite", dsn)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
t.Cleanup(func() { _ = sqlDB.Close() })
|
|
||||||
|
|
||||||
db, err := gorm.Open(
|
|
||||||
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
|
||||||
)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
require.NoError(t, db.AutoMigrate(
|
|
||||||
&database.Event{},
|
|
||||||
&database.Delivery{},
|
|
||||||
&database.DeliveryResult{},
|
|
||||||
))
|
|
||||||
|
|
||||||
return db
|
|
||||||
}
|
|
||||||
|
|
||||||
func iEngine(
|
func iEngine(
|
||||||
t *testing.T, workers int,
|
t *testing.T, workers int,
|
||||||
) *delivery.Engine {
|
) *delivery.Engine {
|
||||||
@@ -182,10 +152,10 @@ func iSeedEvent(
|
|||||||
event := database.Event{
|
event := database.Event{
|
||||||
WebhookID: webhookID,
|
WebhookID: webhookID,
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{}`,
|
Headers: `{}`,
|
||||||
Body: body,
|
Body: body,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, db.Create(&event).Error)
|
require.NoError(t, db.Create(&event).Error)
|
||||||
@@ -506,7 +476,7 @@ func TestWorkerLifecycle_StartStop(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
s := newISetup(t)
|
s := newISetup(t)
|
||||||
s.Engine.ExportStart(context.Background())
|
s.Engine.ExportStart()
|
||||||
|
|
||||||
event := iSeedEvent(
|
event := iSeedEvent(
|
||||||
t, s.WebhookDB, s.WebhookID,
|
t, s.WebhookDB, s.WebhookID,
|
||||||
@@ -529,21 +499,17 @@ func TestWorkerLifecycle_StartStop(t *testing.T) {
|
|||||||
|
|
||||||
s.Engine.Notify([]delivery.Task{task})
|
s.Engine.Notify([]delivery.Task{task})
|
||||||
|
|
||||||
iWaitForStatus(
|
iWaitForDelivered(t, s.WebhookDB, d.ID)
|
||||||
t, s.WebhookDB, d.ID,
|
|
||||||
database.DeliveryStatusDelivered,
|
|
||||||
)
|
|
||||||
|
|
||||||
s.Engine.ExportStop()
|
require.NoError(t, s.Engine.ExportStop(context.Background()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// iWaitForStatus polls until the delivery reaches the
|
// iWaitForDelivered polls until the delivery reaches the
|
||||||
// expected status.
|
// delivered status.
|
||||||
func iWaitForStatus(
|
func iWaitForDelivered(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
db *gorm.DB,
|
db *gorm.DB,
|
||||||
deliveryID string,
|
deliveryID string,
|
||||||
expected database.DeliveryStatus,
|
|
||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
@@ -557,7 +523,7 @@ func iWaitForStatus(
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
return d.Status == expected
|
return d.Status == database.DeliveryStatusDelivered
|
||||||
}, 5*time.Second, 50*time.Millisecond)
|
}, 5*time.Second, 50*time.Millisecond)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -588,7 +554,7 @@ func TestWorkerLifecycle_ProcessesRetryChannel(
|
|||||||
database.DeliveryStatusRetrying,
|
database.DeliveryStatusRetrying,
|
||||||
)
|
)
|
||||||
|
|
||||||
s.Engine.ExportStart(context.Background())
|
s.Engine.ExportStart()
|
||||||
|
|
||||||
bodyStr := event.Body
|
bodyStr := event.Body
|
||||||
cfg := iHTTPConfig(ts.URL)
|
cfg := iHTTPConfig(ts.URL)
|
||||||
@@ -599,12 +565,9 @@ func TestWorkerLifecycle_ProcessesRetryChannel(
|
|||||||
|
|
||||||
s.Engine.ExportRetryCh() <- task
|
s.Engine.ExportRetryCh() <- task
|
||||||
|
|
||||||
iWaitForStatus(
|
iWaitForDelivered(t, s.WebhookDB, d.ID)
|
||||||
t, s.WebhookDB, d.ID,
|
|
||||||
database.DeliveryStatusDelivered,
|
|
||||||
)
|
|
||||||
|
|
||||||
s.Engine.ExportStop()
|
require.NoError(t, s.Engine.ExportStop(context.Background()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- processDelivery: unknown target type ---
|
// --- processDelivery: unknown target type ---
|
||||||
@@ -778,6 +741,193 @@ func TestRecoverWebhookDeliveries_RetryingDeliveries(
|
|||||||
case <-time.After(5 * time.Second):
|
case <-time.After(5 * time.Second):
|
||||||
t.Fatal("expected retry task from recovery")
|
t.Fatal("expected retry task from recovery")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Regression guard: a target that still supports retries
|
||||||
|
// must be rescheduled, never terminally failed, and must
|
||||||
|
// not gain a synthetic result row.
|
||||||
|
iAssertStatus(
|
||||||
|
t, s.WebhookDB, d.ID,
|
||||||
|
database.DeliveryStatusRetrying,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Len(t, iResults(t, s.WebhookDB, d.ID), 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Retrying deliveries whose target type changed ---
|
||||||
|
|
||||||
|
// iSeedRetryingWithType seeds a retrying delivery with one
|
||||||
|
// recorded failed attempt against a target of the given type,
|
||||||
|
// standing in for a target whose type was edited in the main
|
||||||
|
// database while the delivery was still retrying.
|
||||||
|
func iSeedRetryingWithType(
|
||||||
|
t *testing.T,
|
||||||
|
s iSetup,
|
||||||
|
targetType database.TargetType,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
targetID := uuid.New().String()
|
||||||
|
|
||||||
|
iCreateTarget(t, s.MainDB, targetID,
|
||||||
|
s.WebhookID, "mutated-target", targetType,
|
||||||
|
iHTTPConfig("http://example.com/hook"), 5,
|
||||||
|
)
|
||||||
|
|
||||||
|
event := iSeedEvent(
|
||||||
|
t, s.WebhookDB, s.WebhookID,
|
||||||
|
`{"orphaned":"retry"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
d := iSeedDelivery(
|
||||||
|
t, s.WebhookDB, event.ID, targetID,
|
||||||
|
database.DeliveryStatusRetrying,
|
||||||
|
)
|
||||||
|
|
||||||
|
iSeedFailedResult(t, s.WebhookDB, d.ID)
|
||||||
|
|
||||||
|
return d.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
// iResults loads a delivery's results in attempt order.
|
||||||
|
func iResults(
|
||||||
|
t *testing.T, db *gorm.DB, deliveryID string,
|
||||||
|
) []database.DeliveryResult {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var results []database.DeliveryResult
|
||||||
|
|
||||||
|
require.NoError(t, db.
|
||||||
|
Where("delivery_id = ?", deliveryID).
|
||||||
|
Order("attempt_num").
|
||||||
|
Find(&results).Error)
|
||||||
|
|
||||||
|
return results
|
||||||
|
}
|
||||||
|
|
||||||
|
// iAssertTerminallyFailed asserts the delivery ended failed
|
||||||
|
// with a result row recording why, and was not rescheduled.
|
||||||
|
func iAssertTerminallyFailed(
|
||||||
|
t *testing.T,
|
||||||
|
s iSetup,
|
||||||
|
deliveryID string,
|
||||||
|
targetType database.TargetType,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
iAssertStatus(
|
||||||
|
t, s.WebhookDB, deliveryID,
|
||||||
|
database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
|
||||||
|
results := iResults(t, s.WebhookDB, deliveryID)
|
||||||
|
require.Len(t, results, 2)
|
||||||
|
|
||||||
|
last := results[1]
|
||||||
|
|
||||||
|
assert.False(t, last.Success)
|
||||||
|
assert.Equal(t, 2, last.AttemptNum)
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, last.Error, string(targetType),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, last.Error, "does not support retries",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Empty(t, s.Engine.ExportRetryCh())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecoverSingleRetry_TypeNoLongerRetries(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
iCreateWebhook(
|
||||||
|
t, s.MainDB, s.WebhookID, "mutated-type",
|
||||||
|
)
|
||||||
|
|
||||||
|
deliveryID := iSeedRetryingWithType(
|
||||||
|
t, s, database.TargetTypeLog,
|
||||||
|
)
|
||||||
|
|
||||||
|
s.Engine.ExportRecoverWebhookDeliveries(
|
||||||
|
context.Background(), s.WebhookID,
|
||||||
|
)
|
||||||
|
|
||||||
|
iAssertTerminallyFailed(
|
||||||
|
t, s, deliveryID, database.TargetTypeLog,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweepSingleRetry_TypeNoLongerRetries(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
iCreateWebhook(
|
||||||
|
t, s.MainDB, s.WebhookID, "mutated-type-sweep",
|
||||||
|
)
|
||||||
|
|
||||||
|
deliveryID := iSeedRetryingWithType(
|
||||||
|
t, s, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
|
||||||
|
s.Engine.ExportSweepWebhookRetries(
|
||||||
|
context.Background(), s.WebhookID,
|
||||||
|
)
|
||||||
|
|
||||||
|
iAssertTerminallyFailed(
|
||||||
|
t, s, deliveryID, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecoverSingleRetry_UnknownTargetType(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
iCreateWebhook(
|
||||||
|
t, s.MainDB, s.WebhookID, "unknown-type",
|
||||||
|
)
|
||||||
|
|
||||||
|
unknown := database.TargetType("not-a-target-type")
|
||||||
|
|
||||||
|
deliveryID := iSeedRetryingWithType(t, s, unknown)
|
||||||
|
|
||||||
|
s.Engine.ExportRecoverWebhookDeliveries(
|
||||||
|
context.Background(), s.WebhookID,
|
||||||
|
)
|
||||||
|
|
||||||
|
iAssertTerminallyFailed(t, s, deliveryID, unknown)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSweepSingleRetry_UnknownTargetType(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
iCreateWebhook(
|
||||||
|
t, s.MainDB, s.WebhookID, "unknown-type-sweep",
|
||||||
|
)
|
||||||
|
|
||||||
|
unknown := database.TargetType("not-a-target-type")
|
||||||
|
|
||||||
|
deliveryID := iSeedRetryingWithType(t, s, unknown)
|
||||||
|
|
||||||
|
s.Engine.ExportSweepWebhookRetries(
|
||||||
|
context.Background(), s.WebhookID,
|
||||||
|
)
|
||||||
|
|
||||||
|
iAssertTerminallyFailed(t, s, deliveryID, unknown)
|
||||||
}
|
}
|
||||||
|
|
||||||
// iSeedFailedResult creates a failed delivery result.
|
// iSeedFailedResult creates a failed delivery result.
|
||||||
@@ -935,7 +1085,7 @@ func TestDeliverHTTP_CustomTargetHeaders(t *testing.T) {
|
|||||||
func TestDeliverHTTP_TargetTimeout(t *testing.T) {
|
func TestDeliverHTTP_TargetTimeout(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
db := iWebhookDB(t)
|
db := testWebhookDB(t)
|
||||||
e := iEngine(t, 1)
|
e := iEngine(t, 1)
|
||||||
|
|
||||||
ts := httptest.NewServer(
|
ts := httptest.NewServer(
|
||||||
@@ -987,10 +1137,10 @@ func iSeedEventAndDelivery(
|
|||||||
event := database.Event{
|
event := database.Event{
|
||||||
WebhookID: uuid.New().String(),
|
WebhookID: uuid.New().String(),
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{"Content-Type":["application/json"]}`,
|
Headers: `{"Content-Type":["application/json"]}`,
|
||||||
Body: body,
|
Body: body,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, db.Create(&event).Error)
|
require.NoError(t, db.Create(&event).Error)
|
||||||
@@ -1067,7 +1217,7 @@ func iAssertResultFailed(
|
|||||||
func TestDeliverHTTP_InvalidConfig(t *testing.T) {
|
func TestDeliverHTTP_InvalidConfig(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
db := iWebhookDB(t)
|
db := testWebhookDB(t)
|
||||||
e := iEngine(t, 1)
|
e := iEngine(t, 1)
|
||||||
|
|
||||||
event, del := iSeedEventAndDelivery(
|
event, del := iSeedEventAndDelivery(
|
||||||
|
|||||||
271
internal/delivery/engine_lifecycle_test.go
Normal file
271
internal/delivery/engine_lifecycle_test.go
Normal file
@@ -0,0 +1,271 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// hookStopTimeout bounds how long a lifecycle test waits for
|
||||||
|
// the engine's OnStop hook to return before declaring the
|
||||||
|
// shutdown hung.
|
||||||
|
hookStopTimeout = 10 * time.Second
|
||||||
|
|
||||||
|
// hookSettleDelay is how long startEngineViaHook waits after
|
||||||
|
// OnStart before the caller may enqueue work. A worker pool
|
||||||
|
// wrongly rooted in the already-done hook context has nothing
|
||||||
|
// but ctx.Done() ready in its select, so it is deterministically
|
||||||
|
// gone by the end of this window. Without the wait, Notify would
|
||||||
|
// race the pool's very first select, in which a ready ctx.Done()
|
||||||
|
// and a ready deliveryCh are chosen between at random and a
|
||||||
|
// doomed pool still delivers.
|
||||||
|
hookSettleDelay = 250 * time.Millisecond
|
||||||
|
|
||||||
|
// wedgeStopTimeout is the stop timeout a wedged-shutdown test
|
||||||
|
// hands OnStop, standing in for fx's StopTimeout. The test
|
||||||
|
// asserts only that the hook returns at all, and allows it
|
||||||
|
// hookStopTimeout — forty times this budget — to do so, so no
|
||||||
|
// assertion here races the wall clock.
|
||||||
|
wedgeStopTimeout = 250 * time.Millisecond
|
||||||
|
)
|
||||||
|
|
||||||
|
// recordingLifecycle is a minimal fx.Lifecycle that records the
|
||||||
|
// hooks a component registers, so a test can invoke the real
|
||||||
|
// OnStart/OnStop functions with a context of its choosing.
|
||||||
|
type recordingLifecycle struct {
|
||||||
|
hooks []fx.Hook
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *recordingLifecycle) Append(h fx.Hook) {
|
||||||
|
l.hooks = append(l.hooks, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
// requireStopHookExpires drives hook.OnStop with a stop context
|
||||||
|
// that expires while a wedged goroutine is still running, and
|
||||||
|
// requires the hook to return the deadline error naming
|
||||||
|
// component instead of blocking on the WaitGroup forever.
|
||||||
|
func requireStopHookExpires(
|
||||||
|
t *testing.T, hook fx.Hook, component string,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
stopCtx, cancel := context.WithTimeout(
|
||||||
|
context.Background(), wedgeStopTimeout,
|
||||||
|
)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
var stopErr error
|
||||||
|
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(stopped)
|
||||||
|
|
||||||
|
stopErr = hook.OnStop(stopCtx)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
case <-time.After(hookStopTimeout):
|
||||||
|
t.Fatal(
|
||||||
|
"OnStop did not return: it discarded the stop " +
|
||||||
|
"context and is waiting on a wedged goroutine " +
|
||||||
|
"that will never observe cancellation",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.ErrorIs(t, stopErr, context.DeadlineExceeded)
|
||||||
|
require.ErrorContains(t, stopErr, component)
|
||||||
|
}
|
||||||
|
|
||||||
|
// startEngineViaHook drives the genuine fx hooks the application
|
||||||
|
// registers for the engine, handing OnStart a context that is
|
||||||
|
// already done, and returns only once a pool that inherited that
|
||||||
|
// context would have exited. It returns the recorded lifecycle so
|
||||||
|
// the caller can drive OnStop too.
|
||||||
|
//
|
||||||
|
// Callers must not seed pending or retrying deliveries before
|
||||||
|
// calling this: restart recovery enqueues those during startup,
|
||||||
|
// which would put work in the queue while the pool is still
|
||||||
|
// racing its first select.
|
||||||
|
func startEngineViaHook(
|
||||||
|
t *testing.T, eng *delivery.Engine,
|
||||||
|
) *recordingLifecycle {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lc := &recordingLifecycle{}
|
||||||
|
eng.ExportRegisterHooks(lc)
|
||||||
|
require.Len(t, lc.hooks, 1)
|
||||||
|
|
||||||
|
// fx hands OnStart a context carrying the application start
|
||||||
|
// timeout, and cancels it when the start phase ends. An
|
||||||
|
// already-cancelled context is that same defect taken to its
|
||||||
|
// limit, and unlike a plain context.Background() it actually
|
||||||
|
// distinguishes a correctly rooted loop from a broken one.
|
||||||
|
hookCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
require.NoError(t, lc.hooks[0].OnStart(hookCtx))
|
||||||
|
|
||||||
|
time.Sleep(hookSettleDelay)
|
||||||
|
|
||||||
|
return lc
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedLogTask seeds a pending delivery for a log target and
|
||||||
|
// returns its ID together with the task that drives it. The log
|
||||||
|
// target needs no network, so a delivery completing proves only
|
||||||
|
// that a worker picked the task up.
|
||||||
|
func seedLogTask(
|
||||||
|
t *testing.T, s iSetup,
|
||||||
|
) (string, delivery.Task) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
event := iSeedEvent(
|
||||||
|
t, s.WebhookDB, s.WebhookID,
|
||||||
|
`{"lifecycle":"hook-context"}`,
|
||||||
|
)
|
||||||
|
targetID := uuid.New().String()
|
||||||
|
|
||||||
|
d := iSeedDelivery(
|
||||||
|
t, s.WebhookDB, event.ID, targetID,
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
)
|
||||||
|
|
||||||
|
bodyStr := event.Body
|
||||||
|
task := iTask(
|
||||||
|
d, event, s.WebhookID, targetID,
|
||||||
|
"hook-context-test", "", 0, 1, &bodyStr,
|
||||||
|
)
|
||||||
|
task.TargetType = database.TargetTypeLog
|
||||||
|
|
||||||
|
return d.ID, task
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEngine_WorkersOutliveStartHookContext is the regression
|
||||||
|
// test for a delivery engine that stopped delivering roughly
|
||||||
|
// fifteen seconds after boot. fx calls OnStart with a context
|
||||||
|
// carrying the application's start timeout (15s by default) and
|
||||||
|
// cancels it when the start phase ends, so a worker pool rooted
|
||||||
|
// in it exits shortly after startup: the process keeps accepting
|
||||||
|
// and persisting events while nothing at all forwards them.
|
||||||
|
//
|
||||||
|
// Driving OnStart with an already-cancelled context is that
|
||||||
|
// defect taken to its limit. A pool that inherits the hook
|
||||||
|
// context is gone before the task is even enqueued; a correctly
|
||||||
|
// rooted pool keeps working for as long as the process lives.
|
||||||
|
func TestEngine_WorkersOutliveStartHookContext(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
lc := startEngineViaHook(t, s.Engine)
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = lc.hooks[0].OnStop(context.Background())
|
||||||
|
})
|
||||||
|
|
||||||
|
// Seeded only after the pool has settled, so restart recovery
|
||||||
|
// cannot enqueue it during startup.
|
||||||
|
deliveryID, task := seedLogTask(t, s)
|
||||||
|
|
||||||
|
s.Engine.Notify([]delivery.Task{task})
|
||||||
|
|
||||||
|
iWaitForDelivered(t, s.WebhookDB, deliveryID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEngine_StopHookStopsWorkers proves the fix did not trade a
|
||||||
|
// startup bug for a shutdown hang: now that the worker pool no
|
||||||
|
// longer observes the start hook's cancellation, OnStop is the
|
||||||
|
// only thing that can stop it, and it must both return promptly
|
||||||
|
// and actually leave the pool drained.
|
||||||
|
func TestEngine_StopHookStopsWorkers(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
lc := startEngineViaHook(t, s.Engine)
|
||||||
|
|
||||||
|
// Let the pool prove it is running before stopping it, so a
|
||||||
|
// fast OnStop cannot pass by stopping something already dead.
|
||||||
|
firstID, firstTask := seedLogTask(t, s)
|
||||||
|
s.Engine.Notify([]delivery.Task{firstTask})
|
||||||
|
iWaitForDelivered(t, s.WebhookDB, firstID)
|
||||||
|
|
||||||
|
var stopErr error
|
||||||
|
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(stopped)
|
||||||
|
|
||||||
|
// stop blocks on the workers' WaitGroup, so returning at
|
||||||
|
// all proves every goroutine observed the cancellation.
|
||||||
|
stopErr = lc.hooks[0].OnStop(context.Background())
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
case <-time.After(hookStopTimeout):
|
||||||
|
t.Fatal(
|
||||||
|
"OnStop did not return: the delivery engine's " +
|
||||||
|
"WaitGroup is still waiting on a goroutine that " +
|
||||||
|
"never observed cancellation",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, stopErr)
|
||||||
|
|
||||||
|
// With every worker gone, a freshly notified task must sit
|
||||||
|
// untouched in the queue rather than being delivered.
|
||||||
|
secondID, secondTask := seedLogTask(t, s)
|
||||||
|
s.Engine.Notify([]delivery.Task{secondTask})
|
||||||
|
|
||||||
|
time.Sleep(200 * time.Millisecond)
|
||||||
|
|
||||||
|
var after database.Delivery
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
s.WebhookDB.First(&after, "id = ?", secondID).Error,
|
||||||
|
)
|
||||||
|
require.Equal(
|
||||||
|
t,
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
after.Status,
|
||||||
|
"a stopped engine must not deliver anything",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEngine_StopHookHonoursStopTimeout is the regression test
|
||||||
|
// for a shutdown that could never complete. fx hands OnStop a
|
||||||
|
// context carrying the application's stop timeout; an OnStop
|
||||||
|
// that discards it and calls wg.Wait() bare hangs the process
|
||||||
|
// forever on a single worker stuck inside a delivery target that
|
||||||
|
// never returns — precisely when a bounded shutdown matters
|
||||||
|
// most.
|
||||||
|
//
|
||||||
|
// The wedged goroutine here never observes cancellation, so the
|
||||||
|
// hook can only return by honouring its context, and it must say
|
||||||
|
// so rather than reporting a clean stop.
|
||||||
|
func TestEngine_StopHookHonoursStopTimeout(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := newISetup(t)
|
||||||
|
|
||||||
|
lc := startEngineViaHook(t, s.Engine)
|
||||||
|
|
||||||
|
release := make(chan struct{})
|
||||||
|
|
||||||
|
t.Cleanup(func() { close(release) })
|
||||||
|
|
||||||
|
s.Engine.ExportWedgeWorker(release)
|
||||||
|
|
||||||
|
requireStopHookExpires(t, lc.hooks[0], "delivery engine")
|
||||||
|
}
|
||||||
@@ -27,6 +27,9 @@ import (
|
|||||||
"sneak.berlin/go/webhooker/internal/delivery"
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// testContentType is the event content type used in tests.
|
||||||
|
const testContentType = "application/json"
|
||||||
|
|
||||||
func testWebhookDB(t *testing.T) *gorm.DB {
|
func testWebhookDB(t *testing.T) *gorm.DB {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
@@ -94,10 +97,10 @@ func seedEvent(
|
|||||||
event := database.Event{
|
event := database.Event{
|
||||||
WebhookID: uuid.New().String(),
|
WebhookID: uuid.New().String(),
|
||||||
EntrypointID: uuid.New().String(),
|
EntrypointID: uuid.New().String(),
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{"Content-Type":["application/json"]}`,
|
Headers: `{"Content-Type":["application/json"]}`,
|
||||||
Body: body,
|
Body: body,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, db.Create(&event).Error)
|
require.NoError(t, db.Create(&event).Error)
|
||||||
@@ -342,33 +345,29 @@ func TestDeliverDatabase_ImmediateSuccess(
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
db := testWebhookDB(t)
|
db := testWebhookDB(t)
|
||||||
e := testEngine(t, 1)
|
|
||||||
|
|
||||||
event := seedEvent(t, db, `{"db":"target"}`)
|
// The database target archives for real now, so the engine
|
||||||
|
// needs a webhook DB manager to locate the data directory.
|
||||||
dlv := seedDelivery(
|
e := delivery.NewTestEngineWithDB(
|
||||||
t, db, event.ID, uuid.New().String(),
|
nil,
|
||||||
database.DeliveryStatusPending,
|
database.NewTestWebhookDBManager(t.TempDir()),
|
||||||
|
slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
)),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
)
|
)
|
||||||
|
|
||||||
d := &database.Delivery{
|
event := seedEvent(t, db, `{"db":"target"}`)
|
||||||
EventID: event.ID,
|
d := seedDatabaseTargetDelivery(t, db, event, "")
|
||||||
TargetID: dlv.TargetID,
|
|
||||||
Status: database.DeliveryStatusPending,
|
|
||||||
Event: event,
|
|
||||||
Target: database.Target{
|
|
||||||
Name: "test-db",
|
|
||||||
Type: database.TargetTypeDatabase,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
d.ID = dlv.ID
|
|
||||||
|
|
||||||
e.ExportDeliverDatabase(db, d)
|
e.ExportDeliverDatabase(db, d)
|
||||||
|
|
||||||
var updated database.Delivery
|
var updated database.Delivery
|
||||||
|
|
||||||
require.NoError(t, db.First(
|
require.NoError(t, db.First(
|
||||||
&updated, "id = ?", dlv.ID,
|
&updated, "id = ?", d.ID,
|
||||||
).Error)
|
).Error)
|
||||||
|
|
||||||
assert.Equal(t,
|
assert.Equal(t,
|
||||||
@@ -379,7 +378,7 @@ func TestDeliverDatabase_ImmediateSuccess(
|
|||||||
var result database.DeliveryResult
|
var result database.DeliveryResult
|
||||||
|
|
||||||
require.NoError(t, db.Where(
|
require.NoError(t, db.Where(
|
||||||
"delivery_id = ?", dlv.ID,
|
"delivery_id = ?", d.ID,
|
||||||
).First(&result).Error)
|
).First(&result).Error)
|
||||||
|
|
||||||
assert.True(t, result.Success)
|
assert.True(t, result.Success)
|
||||||
@@ -436,91 +435,6 @@ func TestDeliverLog_ImmediateSuccess(t *testing.T) {
|
|||||||
assert.True(t, result.Success)
|
assert.True(t, result.Success)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDeliverLog_StructuredLogFields(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := testWebhookDB(t)
|
|
||||||
|
|
||||||
var logBuf bytes.Buffer
|
|
||||||
|
|
||||||
e := delivery.NewTestEngine(
|
|
||||||
slog.New(slog.NewTextHandler(
|
|
||||||
&logBuf,
|
|
||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
|
||||||
)),
|
|
||||||
&http.Client{Timeout: 5 * time.Second},
|
|
||||||
1,
|
|
||||||
)
|
|
||||||
|
|
||||||
event := seedEvent(t, db, `{"log":"structured"}`)
|
|
||||||
|
|
||||||
dlv := seedDelivery(
|
|
||||||
t, db, event.ID, uuid.New().String(),
|
|
||||||
database.DeliveryStatusPending,
|
|
||||||
)
|
|
||||||
|
|
||||||
d := &database.Delivery{
|
|
||||||
EventID: event.ID,
|
|
||||||
TargetID: dlv.TargetID,
|
|
||||||
Status: database.DeliveryStatusPending,
|
|
||||||
Event: event,
|
|
||||||
Target: database.Target{
|
|
||||||
Name: "structured-log",
|
|
||||||
Type: database.TargetTypeLog,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
d.ID = dlv.ID
|
|
||||||
|
|
||||||
e.ExportDeliverLog(db, d)
|
|
||||||
|
|
||||||
// The delivery is marked delivered and a success
|
|
||||||
// DeliveryResult with no HTTP status is recorded,
|
|
||||||
// mirroring the other target types' bookkeeping.
|
|
||||||
var updated database.Delivery
|
|
||||||
|
|
||||||
require.NoError(t, db.First(
|
|
||||||
&updated, "id = ?", dlv.ID,
|
|
||||||
).Error)
|
|
||||||
|
|
||||||
assert.Equal(t,
|
|
||||||
database.DeliveryStatusDelivered, updated.Status,
|
|
||||||
"log target should immediately succeed",
|
|
||||||
)
|
|
||||||
|
|
||||||
var result database.DeliveryResult
|
|
||||||
|
|
||||||
require.NoError(t, db.Where(
|
|
||||||
"delivery_id = ?", dlv.ID,
|
|
||||||
).First(&result).Error)
|
|
||||||
|
|
||||||
assert.True(t, result.Success)
|
|
||||||
assert.Equal(t, 0, result.StatusCode,
|
|
||||||
"log target should not have an HTTP status",
|
|
||||||
)
|
|
||||||
|
|
||||||
assertLogFields(t, logBuf.String(), event, "structured-log")
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertLogFields checks that a log target's structured
|
|
||||||
// log line carries the required fields: event id,
|
|
||||||
// webhook/entrypoint, target name, and outcome.
|
|
||||||
func assertLogFields(
|
|
||||||
t *testing.T,
|
|
||||||
logged string,
|
|
||||||
event database.Event,
|
|
||||||
targetName string,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
assert.Contains(t, logged, "event_id="+event.ID)
|
|
||||||
assert.Contains(t, logged, "webhook_id="+event.WebhookID)
|
|
||||||
assert.Contains(t,
|
|
||||||
logged, "entrypoint_id="+event.EntrypointID,
|
|
||||||
)
|
|
||||||
assert.Contains(t, logged, "target_name="+targetName)
|
|
||||||
assert.Contains(t, logged, "outcome=delivered")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDeliverHTTP_WithRetries_Success(t *testing.T) {
|
func TestDeliverHTTP_WithRetries_Success(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1202,10 +1116,10 @@ func TestDoHTTPRequest_ForwardsHeaders(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
Headers: `{"X-Custom":["value1"],"Content-Type":["application/json"]}`,
|
Headers: `{"X-Custom":["value1"],"Content-Type":["application/json"]}`,
|
||||||
Body: `{"test":true}`,
|
Body: `{"test":true}`,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
}
|
}
|
||||||
|
|
||||||
statusCode, _, _, err := e.ExportDoHTTPRequest(
|
statusCode, _, _, err := e.ExportDoHTTPRequest(
|
||||||
@@ -1227,7 +1141,7 @@ func TestDoHTTPRequest_ForwardsHeaders(t *testing.T) {
|
|||||||
)
|
)
|
||||||
|
|
||||||
assert.Equal(t,
|
assert.Equal(t,
|
||||||
"application/json",
|
testContentType,
|
||||||
receivedHeaders.Get("Content-Type"),
|
receivedHeaders.Get("Content-Type"),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -1243,7 +1157,19 @@ func TestProcessDelivery_RoutesToCorrectHandler(
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
db := testWebhookDB(t)
|
db := testWebhookDB(t)
|
||||||
e := testEngine(t, 1)
|
|
||||||
|
// The database target archives for real now, so the engine
|
||||||
|
// needs a webhook DB manager to locate the data directory.
|
||||||
|
e := delivery.NewTestEngineWithDB(
|
||||||
|
nil,
|
||||||
|
database.NewTestWebhookDBManager(t.TempDir()),
|
||||||
|
slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
)),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -1374,8 +1300,8 @@ func TestFormatSlackMessage_JSONBody(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
Body: `{"action":"push",` +
|
Body: `{"action":"push",` +
|
||||||
`"repo":"test/repo",` +
|
`"repo":"test/repo",` +
|
||||||
`"ref":"refs/heads/main"}`,
|
`"ref":"refs/heads/main"}`,
|
||||||
@@ -1400,7 +1326,7 @@ func TestFormatSlackMessage_NonJSONBody(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
ContentType: "text/plain",
|
ContentType: "text/plain",
|
||||||
Body: "hello world plain text",
|
Body: "hello world plain text",
|
||||||
}
|
}
|
||||||
@@ -1423,8 +1349,8 @@ func TestFormatSlackMessage_EmptyBody(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
Body: "",
|
Body: "",
|
||||||
}
|
}
|
||||||
event.CreatedAt = time.Date(
|
event.CreatedAt = time.Date(
|
||||||
@@ -1452,8 +1378,8 @@ func TestFormatSlackMessage_LargeJSONTruncated(
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
event := &database.Event{
|
event := &database.Event{
|
||||||
Method: "POST",
|
Method: http.MethodPost,
|
||||||
ContentType: "application/json",
|
ContentType: testContentType,
|
||||||
Body: string(largeJSON),
|
Body: string(largeJSON),
|
||||||
}
|
}
|
||||||
event.CreatedAt = time.Date(
|
event.CreatedAt = time.Date(
|
||||||
@@ -1738,6 +1664,179 @@ func TestProcessDelivery_RoutesToSlack(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// newLogCaptureEngine builds a test engine whose logger
|
||||||
|
// writes to the returned buffer, for inspecting log output.
|
||||||
|
func newLogCaptureEngine(
|
||||||
|
t *testing.T,
|
||||||
|
) (*delivery.Engine, *bytes.Buffer) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
log := slog.New(slog.NewTextHandler(
|
||||||
|
&buf,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
))
|
||||||
|
|
||||||
|
e := delivery.NewTestEngine(
|
||||||
|
log, &http.Client{Timeout: 5 * time.Second}, 1,
|
||||||
|
)
|
||||||
|
|
||||||
|
return e, &buf
|
||||||
|
}
|
||||||
|
|
||||||
|
// assertLogLineComplete asserts the captured log output
|
||||||
|
// carries the full inbound webhook content and ids.
|
||||||
|
func assertLogLineComplete(
|
||||||
|
t *testing.T, out string, event database.Event,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
assert.Contains(t, out, "log-body-marker",
|
||||||
|
"log line must contain the full request body",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(t, out, "Content-Type",
|
||||||
|
"log line must contain the full request headers",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(t, out, event.EntrypointID,
|
||||||
|
"log line must contain the entrypoint id",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(t, out, event.WebhookID,
|
||||||
|
"log line must contain the webhook id",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(t, out, testContentType,
|
||||||
|
"log line must contain the content type",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliverLog_LogsFullContent(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := testWebhookDB(t)
|
||||||
|
e, buf := newLogCaptureEngine(t)
|
||||||
|
|
||||||
|
event := seedEvent(
|
||||||
|
t, db, `{"log-body-marker":"abc123"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
dlv := seedDelivery(
|
||||||
|
t, db, event.ID, uuid.New().String(),
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
)
|
||||||
|
|
||||||
|
d := &database.Delivery{
|
||||||
|
EventID: event.ID,
|
||||||
|
TargetID: dlv.TargetID,
|
||||||
|
Status: database.DeliveryStatusPending,
|
||||||
|
Event: event,
|
||||||
|
Target: database.Target{
|
||||||
|
Name: "test-log-full",
|
||||||
|
Type: database.TargetTypeLog,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
d.ID = dlv.ID
|
||||||
|
|
||||||
|
e.ExportDeliverLog(db, d)
|
||||||
|
|
||||||
|
assertLogLineComplete(t, buf.String(), event)
|
||||||
|
|
||||||
|
assertDeliveryStatus(t, db, dlv.ID,
|
||||||
|
database.DeliveryStatusDelivered,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildSlackRetryDelivery builds a Slack delivery whose
|
||||||
|
// target is configured with retries enabled.
|
||||||
|
func buildSlackRetryDelivery(
|
||||||
|
dlv database.Delivery,
|
||||||
|
event database.Event,
|
||||||
|
targetID, cfg string,
|
||||||
|
) *database.Delivery {
|
||||||
|
d := &database.Delivery{
|
||||||
|
EventID: event.ID,
|
||||||
|
TargetID: targetID,
|
||||||
|
Status: database.DeliveryStatusPending,
|
||||||
|
Event: event,
|
||||||
|
Target: database.Target{
|
||||||
|
Name: "test-slack-retry",
|
||||||
|
Type: database.TargetTypeSlack,
|
||||||
|
Config: cfg,
|
||||||
|
MaxRetries: 5,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
d.ID = dlv.ID
|
||||||
|
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliverSlack_WithRetries_SchedulesRetry(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := testWebhookDB(t)
|
||||||
|
ts := newStatusServer(t, http.StatusServiceUnavailable)
|
||||||
|
e := testEngine(t, 1)
|
||||||
|
targetID := uuid.New().String()
|
||||||
|
|
||||||
|
slackCfg, err := json.Marshal(
|
||||||
|
delivery.SlackTargetConfig{WebhookURL: ts.URL},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
event := seedEvent(t, db, `{"slack":"retry"}`)
|
||||||
|
|
||||||
|
dlv := seedDelivery(
|
||||||
|
t, db, event.ID, targetID,
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
)
|
||||||
|
|
||||||
|
d := buildSlackRetryDelivery(
|
||||||
|
dlv, event, targetID, string(slackCfg),
|
||||||
|
)
|
||||||
|
|
||||||
|
task := &delivery.Task{
|
||||||
|
DeliveryID: dlv.ID,
|
||||||
|
TargetID: targetID,
|
||||||
|
TargetType: database.TargetTypeSlack,
|
||||||
|
MaxRetries: 5,
|
||||||
|
AttemptNum: 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
e.ExportProcessDelivery(context.TODO(), db, d, task)
|
||||||
|
|
||||||
|
assertDeliveryStatus(t, db, dlv.ID,
|
||||||
|
database.DeliveryStatusRetrying,
|
||||||
|
)
|
||||||
|
|
||||||
|
assertDeliveryResult(
|
||||||
|
t, db, dlv.ID, false,
|
||||||
|
http.StatusServiceUnavailable,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// newStatusServer starts a test server that always responds
|
||||||
|
// with the given status code.
|
||||||
|
func newStatusServer(
|
||||||
|
t *testing.T, code int,
|
||||||
|
) *httptest.Server {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(
|
||||||
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(code)
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
t.Cleanup(ts.Close)
|
||||||
|
|
||||||
|
return ts
|
||||||
|
}
|
||||||
|
|
||||||
// readAll is a small helper to avoid importing io in
|
// readAll is a small helper to avoid importing io in
|
||||||
// a test handler inline.
|
// a test handler inline.
|
||||||
func readAll(r interface {
|
func readAll(r interface {
|
||||||
|
|||||||
@@ -7,10 +7,17 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
"gorm.io/gorm"
|
"gorm.io/gorm"
|
||||||
"sneak.berlin/go/webhooker/internal/database"
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrExportArchiveWriterEvicted exposes the sentinel returned by
|
||||||
|
// an evicted archive writer. It carries the Err prefix rather
|
||||||
|
// than this file's usual Export one because it is a sentinel
|
||||||
|
// error.
|
||||||
|
var ErrExportArchiveWriterEvicted = errArchiveWriterEvicted
|
||||||
|
|
||||||
// Exported constants for test access.
|
// Exported constants for test access.
|
||||||
const (
|
const (
|
||||||
ExportDeliveryChannelSize = deliveryChannelSize
|
ExportDeliveryChannelSize = deliveryChannelSize
|
||||||
@@ -39,37 +46,50 @@ func ExportTruncate(s string, maxLen int) string {
|
|||||||
return truncate(s, maxLen)
|
return truncate(s, maxLen)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDeliverHTTP exposes deliverHTTP for testing.
|
// ExportDeliverHTTP delivers via the http target for testing.
|
||||||
func (e *Engine) ExportDeliverHTTP(
|
func (e *Engine) ExportDeliverHTTP(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
webhookDB *gorm.DB,
|
webhookDB *gorm.DB,
|
||||||
d *database.Delivery,
|
d *database.Delivery,
|
||||||
task *Task,
|
task *Task,
|
||||||
) {
|
) {
|
||||||
e.deliverHTTP(ctx, webhookDB, d, task)
|
e.httpTarget.Deliver(ctx, webhookDB, d, task, e)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDeliverDatabase exposes deliverDatabase.
|
// ExportDeliverDatabase delivers via the database target.
|
||||||
func (e *Engine) ExportDeliverDatabase(
|
func (e *Engine) ExportDeliverDatabase(
|
||||||
webhookDB *gorm.DB, d *database.Delivery,
|
webhookDB *gorm.DB, d *database.Delivery,
|
||||||
) {
|
) {
|
||||||
e.deliverDatabase(webhookDB, d)
|
e.targets[database.TargetTypeDatabase].Deliver(
|
||||||
|
context.Background(), webhookDB, d, &Task{}, e,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDeliverLog exposes deliverLog for testing.
|
// ExportDeliverLog delivers via the log target for testing.
|
||||||
func (e *Engine) ExportDeliverLog(
|
func (e *Engine) ExportDeliverLog(
|
||||||
webhookDB *gorm.DB, d *database.Delivery,
|
webhookDB *gorm.DB, d *database.Delivery,
|
||||||
) {
|
) {
|
||||||
e.deliverLog(webhookDB, d)
|
e.targets[database.TargetTypeLog].Deliver(
|
||||||
|
context.Background(), webhookDB, d, &Task{}, e,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDeliverSlack exposes deliverSlack for testing.
|
// ExportDeliverSlack delivers via the slack target for
|
||||||
|
// testing.
|
||||||
func (e *Engine) ExportDeliverSlack(
|
func (e *Engine) ExportDeliverSlack(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
webhookDB *gorm.DB,
|
webhookDB *gorm.DB,
|
||||||
d *database.Delivery,
|
d *database.Delivery,
|
||||||
) {
|
) {
|
||||||
e.deliverSlack(ctx, webhookDB, d)
|
task := &Task{
|
||||||
|
DeliveryID: d.ID,
|
||||||
|
TargetID: d.TargetID,
|
||||||
|
AttemptNum: 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
e.targets[database.TargetTypeSlack].Deliver(
|
||||||
|
ctx, webhookDB, d, task, e,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportProcessNewTask exposes processNewTask.
|
// ExportProcessNewTask exposes processNewTask.
|
||||||
@@ -96,53 +116,56 @@ func (e *Engine) ExportProcessDelivery(
|
|||||||
e.processDelivery(ctx, webhookDB, d, task)
|
e.processDelivery(ctx, webhookDB, d, task)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportGetCircuitBreaker exposes getCircuitBreaker.
|
// ExportGetCircuitBreaker exposes the http target's
|
||||||
|
// getCircuitBreaker.
|
||||||
func (e *Engine) ExportGetCircuitBreaker(
|
func (e *Engine) ExportGetCircuitBreaker(
|
||||||
targetID string,
|
targetID string,
|
||||||
) *CircuitBreaker {
|
) *CircuitBreaker {
|
||||||
return e.getCircuitBreaker(targetID)
|
return e.httpTarget.getCircuitBreaker(targetID)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportParseHTTPConfig exposes parseHTTPConfig.
|
// ExportParseHTTPConfig exposes parseHTTPConfig.
|
||||||
func (e *Engine) ExportParseHTTPConfig(
|
func (e *Engine) ExportParseHTTPConfig(
|
||||||
configJSON string,
|
configJSON string,
|
||||||
) (*HTTPTargetConfig, error) {
|
) (*HTTPTargetConfig, error) {
|
||||||
return e.parseHTTPConfig(configJSON)
|
return parseHTTPConfig(configJSON)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportParseSlackConfig exposes parseSlackConfig.
|
// ExportParseSlackConfig exposes parseSlackConfig.
|
||||||
func (e *Engine) ExportParseSlackConfig(
|
func (e *Engine) ExportParseSlackConfig(
|
||||||
configJSON string,
|
configJSON string,
|
||||||
) (*SlackTargetConfig, error) {
|
) (*SlackTargetConfig, error) {
|
||||||
return e.parseSlackConfig(configJSON)
|
return parseSlackConfig(configJSON)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDoHTTPRequest exposes doHTTPRequest.
|
// ExportDoHTTPRequest exposes the http target's
|
||||||
|
// doHTTPRequest.
|
||||||
func (e *Engine) ExportDoHTTPRequest(
|
func (e *Engine) ExportDoHTTPRequest(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
cfg *HTTPTargetConfig,
|
cfg *HTTPTargetConfig,
|
||||||
event *database.Event,
|
event *database.Event,
|
||||||
) (int, string, int64, error) {
|
) (int, string, int64, error) {
|
||||||
return e.doHTTPRequest(ctx, cfg, event)
|
return e.httpTarget.doHTTPRequest(ctx, cfg, event)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportClientForConfig exposes clientForConfig.
|
// ExportClientForConfig exposes the http target's
|
||||||
|
// clientForConfig.
|
||||||
func (e *Engine) ExportClientForConfig(
|
func (e *Engine) ExportClientForConfig(
|
||||||
cfg *HTTPTargetConfig,
|
cfg *HTTPTargetConfig,
|
||||||
) *http.Client {
|
) *http.Client {
|
||||||
return e.clientForConfig(cfg)
|
return e.httpTarget.clientForConfig(cfg)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportClient returns the engine's shared HTTP client.
|
// ExportClient returns the http target's shared HTTP client.
|
||||||
func (e *Engine) ExportClient() *http.Client {
|
func (e *Engine) ExportClient() *http.Client {
|
||||||
return e.client
|
return e.httpTarget.client
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportScheduleRetry exposes scheduleRetry.
|
// ExportScheduleRetry exposes ScheduleRetry.
|
||||||
func (e *Engine) ExportScheduleRetry(
|
func (e *Engine) ExportScheduleRetry(
|
||||||
task Task, delay time.Duration,
|
task Task, delay time.Duration,
|
||||||
) {
|
) {
|
||||||
e.scheduleRetry(task, delay)
|
e.ScheduleRetry(task, delay)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportRecoverPendingDeliveries exposes
|
// ExportRecoverPendingDeliveries exposes
|
||||||
@@ -172,14 +195,40 @@ func (e *Engine) ExportRecoverInFlight(
|
|||||||
e.recoverInFlight(ctx)
|
e.recoverInFlight(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ExportSweepWebhookRetries exposes sweepWebhookRetries.
|
||||||
|
func (e *Engine) ExportSweepWebhookRetries(
|
||||||
|
ctx context.Context, webhookID string,
|
||||||
|
) {
|
||||||
|
e.sweepWebhookRetries(ctx, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
// ExportStart exposes start for testing.
|
// ExportStart exposes start for testing.
|
||||||
func (e *Engine) ExportStart(ctx context.Context) {
|
func (e *Engine) ExportStart() {
|
||||||
e.start(ctx)
|
e.start()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportRegisterHooks registers the engine's real fx lifecycle
|
||||||
|
// hooks on a lifecycle supplied by a test, so a test can drive
|
||||||
|
// the exact OnStart/OnStop functions the application runs and
|
||||||
|
// hand OnStart the kind of context fx actually supplies.
|
||||||
|
func (e *Engine) ExportRegisterHooks(lc fx.Lifecycle) {
|
||||||
|
e.registerHooks(lc)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportStop exposes stop for testing.
|
// ExportStop exposes stop for testing.
|
||||||
func (e *Engine) ExportStop() {
|
func (e *Engine) ExportStop(ctx context.Context) error {
|
||||||
e.stop()
|
return e.stop(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportWedgeWorker adds a goroutine to the engine's WaitGroup
|
||||||
|
// that never observes cancellation and returns only when release
|
||||||
|
// is closed. It stands in for a worker stuck inside a delivery
|
||||||
|
// target that never returns, which is the only way stop can be
|
||||||
|
// made to outlast its context.
|
||||||
|
func (e *Engine) ExportWedgeWorker(release <-chan struct{}) {
|
||||||
|
e.wg.Go(func() {
|
||||||
|
<-release
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExportDeliveryCh returns the delivery channel.
|
// ExportDeliveryCh returns the delivery channel.
|
||||||
@@ -199,13 +248,15 @@ func NewTestEngine(
|
|||||||
client *http.Client,
|
client *http.Client,
|
||||||
workers int,
|
workers int,
|
||||||
) *Engine {
|
) *Engine {
|
||||||
return &Engine{
|
e := &Engine{
|
||||||
log: log,
|
log: log,
|
||||||
client: client,
|
|
||||||
deliveryCh: make(chan Task, deliveryChannelSize),
|
deliveryCh: make(chan Task, deliveryChannelSize),
|
||||||
retryCh: make(chan Task, retryChannelSize),
|
retryCh: make(chan Task, retryChannelSize),
|
||||||
workers: workers,
|
workers: workers,
|
||||||
}
|
}
|
||||||
|
e.initTargets(client)
|
||||||
|
|
||||||
|
return e
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTestEngineSmallRetry creates an Engine with a tiny
|
// NewTestEngineSmallRetry creates an Engine with a tiny
|
||||||
@@ -213,10 +264,13 @@ func NewTestEngine(
|
|||||||
func NewTestEngineSmallRetry(
|
func NewTestEngineSmallRetry(
|
||||||
log *slog.Logger,
|
log *slog.Logger,
|
||||||
) *Engine {
|
) *Engine {
|
||||||
return &Engine{
|
e := &Engine{
|
||||||
log: log,
|
log: log,
|
||||||
retryCh: make(chan Task, 1),
|
retryCh: make(chan Task, 1),
|
||||||
}
|
}
|
||||||
|
e.initTargets(nil)
|
||||||
|
|
||||||
|
return e
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTestEngineWithDB creates an Engine with a real
|
// NewTestEngineWithDB creates an Engine with a real
|
||||||
@@ -228,15 +282,17 @@ func NewTestEngineWithDB(
|
|||||||
client *http.Client,
|
client *http.Client,
|
||||||
workers int,
|
workers int,
|
||||||
) *Engine {
|
) *Engine {
|
||||||
return &Engine{
|
e := &Engine{
|
||||||
database: db,
|
database: db,
|
||||||
dbManager: dbMgr,
|
dbManager: dbMgr,
|
||||||
log: log,
|
log: log,
|
||||||
client: client,
|
|
||||||
deliveryCh: make(chan Task, deliveryChannelSize),
|
deliveryCh: make(chan Task, deliveryChannelSize),
|
||||||
retryCh: make(chan Task, retryChannelSize),
|
retryCh: make(chan Task, retryChannelSize),
|
||||||
workers: workers,
|
workers: workers,
|
||||||
}
|
}
|
||||||
|
e.initTargets(client)
|
||||||
|
|
||||||
|
return e
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTestCircuitBreaker creates a CircuitBreaker with
|
// NewTestCircuitBreaker creates a CircuitBreaker with
|
||||||
@@ -250,3 +306,252 @@ func NewTestCircuitBreaker(
|
|||||||
cooldown: cooldown,
|
cooldown: cooldown,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ExportArchivedEvent aliases the archive row type so black-box
|
||||||
|
// tests can construct and read archive rows.
|
||||||
|
type ExportArchivedEvent = archivedEvent
|
||||||
|
|
||||||
|
// ExportArchiveWriter wraps an archiveWriter so black-box tests
|
||||||
|
// can exercise the per-webhook archive file mechanics.
|
||||||
|
type ExportArchiveWriter struct {
|
||||||
|
w *archiveWriter
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewExportArchiveWriter builds an archive writer for tests,
|
||||||
|
// optionally overriding the reopen debounce (a non-positive
|
||||||
|
// debounce keeps the production default).
|
||||||
|
func NewExportArchiveWriter(
|
||||||
|
path string, log *slog.Logger, debounce time.Duration,
|
||||||
|
) *ExportArchiveWriter {
|
||||||
|
w := newArchiveWriter(path, log)
|
||||||
|
if debounce > 0 {
|
||||||
|
w.debounce = debounce
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExportArchiveWriter{w: w}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write archives a row through the writer.
|
||||||
|
func (e *ExportArchiveWriter) Write(
|
||||||
|
row ExportArchivedEvent, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.write(row, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open opens the archive file, pruning when expiry is positive.
|
||||||
|
func (e *ExportArchiveWriter) Open(expiry time.Duration) error {
|
||||||
|
return e.w.open(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reopen closes and reopens the archive file.
|
||||||
|
func (e *ExportArchiveWriter) Reopen(
|
||||||
|
expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.reopen(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reopens reports how many times the file has been opened.
|
||||||
|
func (e *ExportArchiveWriter) Reopens() int {
|
||||||
|
return e.w.reopens
|
||||||
|
}
|
||||||
|
|
||||||
|
// DB returns the writer's current open handle for row
|
||||||
|
// inspection in tests.
|
||||||
|
func (e *ExportArchiveWriter) DB() *gorm.DB {
|
||||||
|
return e.w.db
|
||||||
|
}
|
||||||
|
|
||||||
|
// Path returns the archive file the writer owns.
|
||||||
|
func (e *ExportArchiveWriter) Path() string {
|
||||||
|
return e.w.path
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenExisting opens the archive without permitting creation,
|
||||||
|
// the way the idle sweep does.
|
||||||
|
func (e *ExportArchiveWriter) OpenExisting(
|
||||||
|
expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.openMode(archiveModeExisting, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SweepExpired runs an idle sweep of the archive.
|
||||||
|
func (e *ExportArchiveWriter) SweepExpired(
|
||||||
|
expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.sweepExpired(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Evict marks the writer evicted and closes its handle, exactly
|
||||||
|
// as leaving the registry does.
|
||||||
|
func (e *ExportArchiveWriter) Evict() {
|
||||||
|
e.w.evict()
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandleOpen reports whether the writer currently holds an open
|
||||||
|
// archive handle.
|
||||||
|
func (e *ExportArchiveWriter) HandleOpen() bool {
|
||||||
|
e.w.mu.Lock()
|
||||||
|
defer e.w.mu.Unlock()
|
||||||
|
|
||||||
|
return e.w.db != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Same reports whether both wrappers refer to the very same
|
||||||
|
// underlying archive writer, so a test can prove a registry entry
|
||||||
|
// is the writer it was handed rather than a replacement.
|
||||||
|
func (e *ExportArchiveWriter) Same(
|
||||||
|
other *ExportArchiveWriter,
|
||||||
|
) bool {
|
||||||
|
return other != nil && e.w == other.w
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportArchiveWriterFor returns the archive writer the registry
|
||||||
|
// currently caches for a webhook, or nil when none is cached. It
|
||||||
|
// never creates one, so a test can hold a reference to the very
|
||||||
|
// writer an eviction is about to detach.
|
||||||
|
func (e *Engine) ExportArchiveWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) *ExportArchiveWriter {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
defer e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
w, ok := e.dbTarget.writers[webhookID]
|
||||||
|
if !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExportArchiveWriter{w: w}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportHasArchiveWriter reports whether the database target
|
||||||
|
// currently caches an archive writer for a webhook.
|
||||||
|
func (e *Engine) ExportHasArchiveWriter(
|
||||||
|
webhookID string,
|
||||||
|
) bool {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
defer e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
_, ok := e.dbTarget.writers[webhookID]
|
||||||
|
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportArchiveHandleOpen reports whether the cached archive
|
||||||
|
// writer for a webhook holds an open database handle. It
|
||||||
|
// returns false when no writer is cached.
|
||||||
|
func (e *Engine) ExportArchiveHandleOpen(
|
||||||
|
webhookID string,
|
||||||
|
) bool {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
w, ok := e.dbTarget.writers[webhookID]
|
||||||
|
e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
return w.db != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportEnsureArchiveWriter creates (if needed) and returns the
|
||||||
|
// archive file path of the cached writer for a webhook, so a
|
||||||
|
// test can prime the registry the way a delivery would.
|
||||||
|
func (e *Engine) ExportEnsureArchiveWriter(
|
||||||
|
webhookID string,
|
||||||
|
) (string, error) {
|
||||||
|
w, err := e.dbTarget.writerFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.path, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSweepWriterFor takes a webhook's registry writer exactly
|
||||||
|
// as the idle sweep does, reporting whether the sweep had to
|
||||||
|
// create the entry. It lets a test drive the registry through the
|
||||||
|
// sweep's own entry point instead of choreographing goroutines.
|
||||||
|
func (e *Engine) ExportSweepWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) (*ExportArchiveWriter, bool, error) {
|
||||||
|
w, created, err := e.dbTarget.sweepWriterFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExportArchiveWriter{w: w}, created, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportReleaseSweepWriter releases a sweep-created registry entry
|
||||||
|
// exactly as a finished sweep does.
|
||||||
|
func (e *Engine) ExportReleaseSweepWriter(
|
||||||
|
webhookID string, w *ExportArchiveWriter,
|
||||||
|
) {
|
||||||
|
e.dbTarget.releaseSweepWriter(webhookID, w.w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewTestArchiveSweeper builds an ArchiveSweeper backed by the
|
||||||
|
// given main database and engine, without the fx lifecycle.
|
||||||
|
// Intended for tests.
|
||||||
|
func NewTestArchiveSweeper(
|
||||||
|
db *database.Database,
|
||||||
|
eng *Engine,
|
||||||
|
log *slog.Logger,
|
||||||
|
) *ArchiveSweeper {
|
||||||
|
return &ArchiveSweeper{
|
||||||
|
db: db,
|
||||||
|
eng: eng,
|
||||||
|
log: log,
|
||||||
|
interval: time.Hour,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSweep runs a single archive sweep synchronously for
|
||||||
|
// tests.
|
||||||
|
func (s *ArchiveSweeper) ExportSweep(ctx context.Context) {
|
||||||
|
s.sweep(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStart starts the sweeper's background loop for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportStart() {
|
||||||
|
s.start()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportRegisterHooks registers the sweeper's real fx lifecycle
|
||||||
|
// hooks on a lifecycle supplied by a test, so a test can drive
|
||||||
|
// the exact OnStart/OnStop functions the application runs and
|
||||||
|
// hand OnStart the kind of context fx actually supplies.
|
||||||
|
func (s *ArchiveSweeper) ExportRegisterHooks(lc fx.Lifecycle) {
|
||||||
|
s.registerHooks(lc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStop stops the sweeper's background loop for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportStop(ctx context.Context) error {
|
||||||
|
return s.stop(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportWedgeLoop adds a goroutine to the sweeper's WaitGroup
|
||||||
|
// that never observes cancellation and returns only when release
|
||||||
|
// is closed. It stands in for a prune stuck on a locked archive.
|
||||||
|
func (s *ArchiveSweeper) ExportWedgeLoop(
|
||||||
|
release <-chan struct{},
|
||||||
|
) {
|
||||||
|
s.wg.Go(func() {
|
||||||
|
<-release
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSetInterval overrides the sweep interval for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportSetInterval(d time.Duration) {
|
||||||
|
s.interval = d
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportParseArchiveExpiry exposes parseArchiveExpiry.
|
||||||
|
func ExportParseArchiveExpiry(
|
||||||
|
configJSON string,
|
||||||
|
) (time.Duration, error) {
|
||||||
|
return parseArchiveExpiry(configJSON)
|
||||||
|
}
|
||||||
|
|||||||
@@ -92,7 +92,12 @@ func ValidateTargetURL(
|
|||||||
) error {
|
) error {
|
||||||
parsed, err := url.Parse(targetURL)
|
parsed, err := url.Parse(targetURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("invalid URL: %w", err)
|
// url.Parse embeds the whole URL in its error, and
|
||||||
|
// this one is logged and shown; mask it. Every other
|
||||||
|
// branch below reports only the hostname.
|
||||||
|
return fmt.Errorf(
|
||||||
|
"invalid URL: %w", maskURLError(err),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = validateScheme(parsed.Scheme)
|
err = validateScheme(parsed.Scheme)
|
||||||
|
|||||||
104
internal/delivery/target.go
Normal file
104
internal/delivery/target.go
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Scheduler re-enqueues a task for a future delivery attempt.
|
||||||
|
// The engine provides one to each target so a target can own
|
||||||
|
// its retries durably: it records the attempt, marks the
|
||||||
|
// delivery retrying, and asks the Scheduler to deliver the
|
||||||
|
// next attempt after delay — exactly what the engine does for
|
||||||
|
// its own restart recovery.
|
||||||
|
type Scheduler interface {
|
||||||
|
ScheduleRetry(task Task, delay time.Duration)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Target delivers an event to one target type. Each type is
|
||||||
|
// an implementation. A Target owns its whole delivery: it
|
||||||
|
// makes the attempt, records the DeliveryResult and updates
|
||||||
|
// the DeliveryStatus, and — for targets that retry — decides
|
||||||
|
// whether to retry, computes its own backoff, gates with its
|
||||||
|
// own circuit breaker, and reschedules via the injected
|
||||||
|
// Scheduler. Fire-and-forget targets simply record a single
|
||||||
|
// attempt.
|
||||||
|
type Target interface {
|
||||||
|
Deliver(
|
||||||
|
ctx context.Context,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// rescheduler is implemented by targets that own durable
|
||||||
|
// retries. The engine's restart recovery and periodic sweep
|
||||||
|
// use it to let the target recompute the schedule for an
|
||||||
|
// orphaned retrying delivery, keeping the retry schedule
|
||||||
|
// target-owned. Fire-and-forget targets do not implement it
|
||||||
|
// and their (never-occurring) retrying deliveries are
|
||||||
|
// skipped.
|
||||||
|
type rescheduler interface {
|
||||||
|
// remainingBackoff returns how long to wait before the
|
||||||
|
// next attempt of a recovered retrying delivery.
|
||||||
|
remainingBackoff(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
deliveryID string,
|
||||||
|
attemptNum int,
|
||||||
|
) time.Duration
|
||||||
|
|
||||||
|
// backoffElapsed reports whether the backoff window for
|
||||||
|
// the last attempt has already passed, so the periodic
|
||||||
|
// sweep can re-enqueue the delivery now.
|
||||||
|
backoffElapsed(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
deliveryID string,
|
||||||
|
attemptNum int,
|
||||||
|
) bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// attemptResult is the outcome of a single delivery attempt,
|
||||||
|
// as reported by a target's per-attempt function to the
|
||||||
|
// shared retry core.
|
||||||
|
type attemptResult struct {
|
||||||
|
statusCode int
|
||||||
|
respBody string
|
||||||
|
duration int64
|
||||||
|
success bool
|
||||||
|
errMsg string
|
||||||
|
}
|
||||||
|
|
||||||
|
// initTargets builds the target registry, wiring each target
|
||||||
|
// to the engine's persistence helpers and giving the HTTP and
|
||||||
|
// Slack targets the shared SSRF-safe client. It is called by
|
||||||
|
// both New and the test constructors so the registry is
|
||||||
|
// always populated.
|
||||||
|
func (e *Engine) initTargets(client *http.Client) {
|
||||||
|
httpT := &httpTarget{
|
||||||
|
httpCore: &httpCore{eng: e},
|
||||||
|
client: client,
|
||||||
|
}
|
||||||
|
|
||||||
|
slackT := &slackTarget{
|
||||||
|
httpCore: &httpCore{eng: e},
|
||||||
|
client: client,
|
||||||
|
}
|
||||||
|
|
||||||
|
dbT := &databaseTarget{eng: e}
|
||||||
|
|
||||||
|
e.httpTarget = httpT
|
||||||
|
e.dbTarget = dbT
|
||||||
|
|
||||||
|
e.targets = map[database.TargetType]Target{
|
||||||
|
database.TargetTypeHTTP: httpT,
|
||||||
|
database.TargetTypeSlack: slackT,
|
||||||
|
database.TargetTypeDatabase: dbT,
|
||||||
|
database.TargetTypeLog: &logTarget{eng: e},
|
||||||
|
}
|
||||||
|
}
|
||||||
208
internal/delivery/target_config_view.go
Normal file
208
internal/delivery/target_config_view.go
Normal file
@@ -0,0 +1,208 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// configUnavailable is what a target's configuration renders
|
||||||
|
// as when it is absent, of an unknown type, or does not
|
||||||
|
// parse. The stored blob is never shown as a fallback: it can
|
||||||
|
// hold a credential (a Slack incoming webhook URL is a bearer
|
||||||
|
// token) and a UI that prints it leaks that credential into
|
||||||
|
// browser history, screenshots and screen shares.
|
||||||
|
const configUnavailable = "(unavailable)"
|
||||||
|
|
||||||
|
// ConfigField is one labelled, display-safe value derived
|
||||||
|
// from a target's stored configuration.
|
||||||
|
type ConfigField struct {
|
||||||
|
Label string
|
||||||
|
Value string
|
||||||
|
}
|
||||||
|
|
||||||
|
// TargetView is the display-safe projection of a target for
|
||||||
|
// the UI. It deliberately has no raw configuration field, so
|
||||||
|
// no template — present or future — can render the stored
|
||||||
|
// blob.
|
||||||
|
type TargetView struct {
|
||||||
|
ID string
|
||||||
|
Name string
|
||||||
|
Type database.TargetType
|
||||||
|
Active bool
|
||||||
|
Config []ConfigField
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewTargetViews projects targets for rendering, replacing
|
||||||
|
// each stored configuration blob with named, display-safe
|
||||||
|
// fields.
|
||||||
|
func NewTargetViews(
|
||||||
|
targets []database.Target,
|
||||||
|
) []TargetView {
|
||||||
|
views := make([]TargetView, 0, len(targets))
|
||||||
|
|
||||||
|
for i := range targets {
|
||||||
|
t := &targets[i]
|
||||||
|
|
||||||
|
views = append(views, TargetView{
|
||||||
|
ID: t.ID,
|
||||||
|
Name: t.Name,
|
||||||
|
Type: t.Type,
|
||||||
|
Active: t.Active,
|
||||||
|
Config: targetConfigFields(t),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return views
|
||||||
|
}
|
||||||
|
|
||||||
|
// targetConfigFields returns the display-safe fields for a
|
||||||
|
// target's configuration. Anything it cannot parse becomes
|
||||||
|
// the neutral placeholder.
|
||||||
|
func targetConfigFields(
|
||||||
|
t *database.Target,
|
||||||
|
) []ConfigField {
|
||||||
|
switch t.Type {
|
||||||
|
case database.TargetTypeSlack:
|
||||||
|
return slackConfigFields(t.Config)
|
||||||
|
case database.TargetTypeHTTP:
|
||||||
|
return httpConfigFields(t)
|
||||||
|
case database.TargetTypeDatabase:
|
||||||
|
return databaseConfigFields(t.Config)
|
||||||
|
case database.TargetTypeLog:
|
||||||
|
// The log target takes no configuration.
|
||||||
|
return nil
|
||||||
|
default:
|
||||||
|
return unavailableConfigFields()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// unavailableConfigFields is the neutral placeholder shown
|
||||||
|
// for a configuration that could not be presented.
|
||||||
|
func unavailableConfigFields() []ConfigField {
|
||||||
|
return []ConfigField{{
|
||||||
|
Label: "Configuration",
|
||||||
|
Value: configUnavailable,
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// slackConfigFields describes a Slack target. Only the masked
|
||||||
|
// webhook URL is shown; the full URL is the credential.
|
||||||
|
func slackConfigFields(configJSON string) []ConfigField {
|
||||||
|
cfg, err := parseSlackConfig(configJSON)
|
||||||
|
if err != nil {
|
||||||
|
return unavailableConfigFields()
|
||||||
|
}
|
||||||
|
|
||||||
|
return []ConfigField{{
|
||||||
|
Label: "Webhook URL",
|
||||||
|
Value: cfg.MaskedWebhookURL(),
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// httpConfigFields describes an HTTP target: its destination
|
||||||
|
// and its retry settings. Header values are not shown — they
|
||||||
|
// routinely carry authorization tokens — only how many are
|
||||||
|
// configured.
|
||||||
|
//
|
||||||
|
// The destination is masked to scheme and host by the same
|
||||||
|
// rule the Slack target uses. An HTTP target's destination is
|
||||||
|
// commonly a Slack, Discord or Teams incoming-webhook endpoint
|
||||||
|
// whose path segments are the credential, and the field takes
|
||||||
|
// an arbitrary URL, so no segment can be assumed non-secret.
|
||||||
|
func httpConfigFields(t *database.Target) []ConfigField {
|
||||||
|
cfg, err := parseHTTPConfig(t.Config)
|
||||||
|
if err != nil {
|
||||||
|
return unavailableConfigFields()
|
||||||
|
}
|
||||||
|
|
||||||
|
fields := []ConfigField{{
|
||||||
|
Label: "Destination URL",
|
||||||
|
Value: MaskURL(cfg.URL),
|
||||||
|
}}
|
||||||
|
|
||||||
|
if cfg.Timeout > 0 {
|
||||||
|
fields = append(fields, ConfigField{
|
||||||
|
Label: "Timeout",
|
||||||
|
Value: strconv.Itoa(cfg.Timeout) + "s",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cfg.Headers) > 0 {
|
||||||
|
fields = append(fields, ConfigField{
|
||||||
|
Label: "Headers",
|
||||||
|
Value: fmt.Sprintf(
|
||||||
|
"%d configured", len(cfg.Headers),
|
||||||
|
),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return append(fields, retryFields(t)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// retryFields describes a target's retry settings, which live
|
||||||
|
// on the target row rather than in its configuration blob.
|
||||||
|
func retryFields(t *database.Target) []ConfigField {
|
||||||
|
retries := strconv.Itoa(t.MaxRetries)
|
||||||
|
if t.MaxRetries == 0 {
|
||||||
|
retries += " (fire-and-forget)"
|
||||||
|
}
|
||||||
|
|
||||||
|
fields := []ConfigField{{
|
||||||
|
Label: "Max Retries",
|
||||||
|
Value: retries,
|
||||||
|
}}
|
||||||
|
|
||||||
|
if t.MaxQueueSize > 0 {
|
||||||
|
fields = append(fields, ConfigField{
|
||||||
|
Label: "Max Queue Size",
|
||||||
|
Value: strconv.Itoa(t.MaxQueueSize),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return fields
|
||||||
|
}
|
||||||
|
|
||||||
|
// databaseConfigFields describes an archive target. Its
|
||||||
|
// configuration is optional, and an absent or empty expiry
|
||||||
|
// means the archive is kept forever. An expiry that is set
|
||||||
|
// but not a valid duration is reported as unavailable rather
|
||||||
|
// than echoed back.
|
||||||
|
func databaseConfigFields(configJSON string) []ConfigField {
|
||||||
|
expiry := archiveExpiryNever
|
||||||
|
|
||||||
|
if configJSON != "" {
|
||||||
|
var cfg databaseTargetConfig
|
||||||
|
|
||||||
|
err := json.Unmarshal([]byte(configJSON), &cfg)
|
||||||
|
if err != nil {
|
||||||
|
return unavailableConfigFields()
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.Expiry != "" {
|
||||||
|
if ValidateArchiveExpiry(cfg.Expiry) != nil {
|
||||||
|
return unavailableConfigFields()
|
||||||
|
}
|
||||||
|
|
||||||
|
expiry = cfg.Expiry
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return []ConfigField{{
|
||||||
|
Label: "Archive Expiry",
|
||||||
|
Value: expiry,
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaskedWebhookURL returns the Slack webhook URL reduced to
|
||||||
|
// its scheme and host, with the path, query and any userinfo
|
||||||
|
// elided. The path segments are the credential, so none of
|
||||||
|
// them is shown: the field accepts an arbitrary URL, so no
|
||||||
|
// segment can be assumed non-secret. A URL that does not
|
||||||
|
// parse into a scheme and host yields the neutral
|
||||||
|
// placeholder, never the raw string.
|
||||||
|
func (c *SlackTargetConfig) MaskedWebhookURL() string {
|
||||||
|
return MaskURL(c.WebhookURL)
|
||||||
|
}
|
||||||
328
internal/delivery/target_config_view_test.go
Normal file
328
internal/delivery/target_config_view_test.go
Normal file
@@ -0,0 +1,328 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// slackSecretPath is the credential-bearing part of a
|
||||||
|
// Slack incoming webhook URL: everything after the host.
|
||||||
|
slackSecretPath = "/services/T00000000/B00000000/" +
|
||||||
|
"XXXXXXXXXXXXXXXXXXXXXXXX"
|
||||||
|
slackWebhookURL = "https://hooks.slack.com" +
|
||||||
|
slackSecretPath
|
||||||
|
|
||||||
|
viewExampleOrigin = "https://example.com"
|
||||||
|
viewExampleHook = viewExampleOrigin + "/hook"
|
||||||
|
viewMaskedOrigin = viewExampleOrigin + "/..."
|
||||||
|
viewUnavailable = "(unavailable)"
|
||||||
|
viewExpiryNever = "never"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMaskedWebhookURL(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := map[string]struct {
|
||||||
|
url string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
"slack webhook": {
|
||||||
|
url: slackWebhookURL,
|
||||||
|
want: "https://hooks.slack.com/...",
|
||||||
|
},
|
||||||
|
"query string dropped": {
|
||||||
|
url: viewExampleOrigin + "/a?token=secret",
|
||||||
|
want: viewExampleOrigin + "/...",
|
||||||
|
},
|
||||||
|
// Fabricated userinfo in a test URL, not a real
|
||||||
|
// credential.
|
||||||
|
//nolint:gosec // G101
|
||||||
|
"userinfo dropped": {
|
||||||
|
url: "https://user:pw@example.com/a/b",
|
||||||
|
want: viewExampleOrigin + "/...",
|
||||||
|
},
|
||||||
|
"no path": {
|
||||||
|
url: viewExampleOrigin,
|
||||||
|
want: viewExampleOrigin,
|
||||||
|
},
|
||||||
|
"root path": {
|
||||||
|
url: viewExampleOrigin + "/",
|
||||||
|
want: viewExampleOrigin,
|
||||||
|
},
|
||||||
|
"not a url": {
|
||||||
|
url: "definitely not a url",
|
||||||
|
want: viewUnavailable,
|
||||||
|
},
|
||||||
|
"empty": {
|
||||||
|
url: "",
|
||||||
|
want: viewUnavailable,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, tc := range tests {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := &delivery.SlackTargetConfig{
|
||||||
|
WebhookURL: tc.url,
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, tc.want, cfg.MaskedWebhookURL(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMaskedWebhookURL_NeverLeaksPath is the direct
|
||||||
|
// expression of the rule: whatever the input, the masked
|
||||||
|
// value never contains a path segment of it.
|
||||||
|
func TestMaskedWebhookURL_NeverLeaksPath(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cfg := &delivery.SlackTargetConfig{
|
||||||
|
WebhookURL: slackWebhookURL,
|
||||||
|
}
|
||||||
|
|
||||||
|
masked := cfg.MaskedWebhookURL()
|
||||||
|
|
||||||
|
assert.NotContains(t, masked, "T00000000")
|
||||||
|
assert.NotContains(t, masked, "B00000000")
|
||||||
|
assert.NotContains(
|
||||||
|
t, masked, "XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
assert.NotContains(t, masked, slackSecretPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
// fieldMap turns a view's config fields into a lookup so
|
||||||
|
// assertions read by label.
|
||||||
|
func fieldMap(fields []delivery.ConfigField) map[string]string {
|
||||||
|
out := make(map[string]string, len(fields))
|
||||||
|
for _, f := range fields {
|
||||||
|
out[f.Label] = f.Value
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// viewFor projects a single target and returns its view.
|
||||||
|
func viewFor(
|
||||||
|
t *testing.T,
|
||||||
|
target database.Target,
|
||||||
|
) delivery.TargetView {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
views := delivery.NewTargetViews(
|
||||||
|
[]database.Target{target},
|
||||||
|
)
|
||||||
|
require.Len(t, views, 1)
|
||||||
|
|
||||||
|
return views[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTargetViews_Slack(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Name: "slack-target",
|
||||||
|
Type: database.TargetTypeSlack,
|
||||||
|
Active: true,
|
||||||
|
Config: `{"webhookUrl":"` +
|
||||||
|
slackWebhookURL + `"}`,
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, "slack-target", view.Name)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
map[string]string{
|
||||||
|
"Webhook URL": "https://hooks.slack.com/...",
|
||||||
|
},
|
||||||
|
fieldMap(view.Config),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTargetViews_HTTP(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Type: database.TargetTypeHTTP,
|
||||||
|
Config: `{"url":"` + viewExampleHook + `",` +
|
||||||
|
`"timeout":30,` +
|
||||||
|
`"headers":{"Authorization":"Bearer sekrit"}}`,
|
||||||
|
MaxRetries: 5,
|
||||||
|
MaxQueueSize: 100,
|
||||||
|
})
|
||||||
|
|
||||||
|
fields := fieldMap(view.Config)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
map[string]string{
|
||||||
|
"Destination URL": viewMaskedOrigin,
|
||||||
|
"Timeout": "30s",
|
||||||
|
"Headers": "1 configured",
|
||||||
|
"Max Retries": "5",
|
||||||
|
"Max Queue Size": "100",
|
||||||
|
},
|
||||||
|
fields,
|
||||||
|
)
|
||||||
|
|
||||||
|
// Header values can be credentials and are never shown.
|
||||||
|
for _, v := range fields {
|
||||||
|
assert.NotContains(t, v, "sekrit")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTargetViews_HTTPFireAndForget(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Type: database.TargetTypeHTTP,
|
||||||
|
Config: `{"url":"` + viewExampleHook + `"}`,
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
map[string]string{
|
||||||
|
"Destination URL": viewMaskedOrigin,
|
||||||
|
"Max Retries": "0 (fire-and-forget)",
|
||||||
|
},
|
||||||
|
fieldMap(view.Config),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewTargetViews_HTTPMasksDestinationURL proves the rule
|
||||||
|
// holds for the http target too: an http destination is
|
||||||
|
// routinely an incoming-webhook endpoint whose path segments
|
||||||
|
// are the credential, so none of them is shown.
|
||||||
|
func TestNewTargetViews_HTTPMasksDestinationURL(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Type: database.TargetTypeHTTP,
|
||||||
|
Config: `{"url":"` + slackWebhookURL + `"}`,
|
||||||
|
})
|
||||||
|
|
||||||
|
fields := fieldMap(view.Config)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
"https://hooks.slack.com/...",
|
||||||
|
fields["Destination URL"],
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, v := range fields {
|
||||||
|
assert.NotContains(t, v, slackSecretPath)
|
||||||
|
assert.NotContains(t, v, "T00000000")
|
||||||
|
assert.NotContains(t, v, "B00000000")
|
||||||
|
assert.NotContains(t, v, "XXXXXXXXXXXXXXXXXXXXXXXX")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTargetViews_Database(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := map[string]struct {
|
||||||
|
config string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
"empty config": {config: "", want: viewExpiryNever},
|
||||||
|
"empty expiry": {config: `{}`, want: viewExpiryNever},
|
||||||
|
"explicit": {
|
||||||
|
config: `{"expiry":"720h"}`,
|
||||||
|
want: "720h",
|
||||||
|
},
|
||||||
|
"never literal": {
|
||||||
|
config: `{"expiry":"` + viewExpiryNever + `"}`,
|
||||||
|
want: viewExpiryNever,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, tc := range tests {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Config: tc.config,
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
map[string]string{"Archive Expiry": tc.want},
|
||||||
|
fieldMap(view.Config),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTargetViews_Log(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, database.Target{
|
||||||
|
Type: database.TargetTypeLog,
|
||||||
|
Config: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Empty(t, view.Config)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNewTargetViews_Unpresentable proves that no config the
|
||||||
|
// view cannot present falls back to the stored blob.
|
||||||
|
func TestNewTargetViews_Unpresentable(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const blob = `{"webhookUrl":"https://hooks.slack.com` +
|
||||||
|
slackSecretPath + `"`
|
||||||
|
|
||||||
|
tests := map[string]database.Target{
|
||||||
|
"unknown target type": {
|
||||||
|
Type: database.TargetType("carrier-pigeon"),
|
||||||
|
Config: blob,
|
||||||
|
},
|
||||||
|
"unparseable json": {
|
||||||
|
Type: database.TargetTypeSlack,
|
||||||
|
Config: blob,
|
||||||
|
},
|
||||||
|
"empty slack config": {
|
||||||
|
Type: database.TargetTypeSlack,
|
||||||
|
},
|
||||||
|
"slack config without url": {
|
||||||
|
Type: database.TargetTypeSlack,
|
||||||
|
Config: `{}`,
|
||||||
|
},
|
||||||
|
"unparseable http json": {
|
||||||
|
Type: database.TargetTypeHTTP,
|
||||||
|
Config: `{"url":`,
|
||||||
|
},
|
||||||
|
"unparseable archive json": {
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Config: `{"expiry":`,
|
||||||
|
},
|
||||||
|
"invalid archive expiry": {
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Config: `{"expiry":"a fortnight"}`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, target := range tests {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
view := viewFor(t, target)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
map[string]string{
|
||||||
|
"Configuration": viewUnavailable,
|
||||||
|
},
|
||||||
|
fieldMap(view.Config),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
295
internal/delivery/target_database.go
Normal file
295
internal/delivery/target_database.go
Normal file
@@ -0,0 +1,295 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// databaseTarget is a no-retry target that archives the
|
||||||
|
// full inbound event into a per-webhook archive SQLite file,
|
||||||
|
// separate from the per-webhook event database. The event is
|
||||||
|
// already persisted in the per-webhook event DB by the time
|
||||||
|
// delivery runs; the database target additionally writes a
|
||||||
|
// durable long-term copy into archive-{webhookID}.db and then
|
||||||
|
// records a single attempt whose outcome reflects whether the
|
||||||
|
// archive write succeeded. See archiveWriter for the
|
||||||
|
// close/reopen, auto-recreate, and expiry semantics.
|
||||||
|
type databaseTarget struct {
|
||||||
|
eng *Engine
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
writers map[string]*archiveWriter
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliver implements Target. It archives the event, then
|
||||||
|
// records one successful attempt and marks the delivery
|
||||||
|
// delivered. An archiving error fails the delivery: the
|
||||||
|
// attempt is recorded as failed with the error and the
|
||||||
|
// delivery is marked failed, so a target that could not do
|
||||||
|
// its one job (archiving) never reports success. The target
|
||||||
|
// does not retry; the event remains durably stored in the
|
||||||
|
// per-webhook event database.
|
||||||
|
func (t *databaseTarget) Deliver(
|
||||||
|
_ context.Context,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
_ *Task,
|
||||||
|
_ Scheduler,
|
||||||
|
) {
|
||||||
|
err := t.archive(d)
|
||||||
|
if err != nil {
|
||||||
|
t.eng.log.Error(
|
||||||
|
"failed to archive event to database target",
|
||||||
|
"delivery_id", d.ID,
|
||||||
|
"event_id", d.EventID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.recordResult(
|
||||||
|
webhookDB, d, 1, false, 0, "",
|
||||||
|
err.Error(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
t.eng.recordResult(
|
||||||
|
webhookDB, d, 1, true, 0, "", "", 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusDelivered,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// archive writes the full event as a row into the webhook's
|
||||||
|
// archive database, honouring the optional per-target expiry
|
||||||
|
// parsed from the target config JSON.
|
||||||
|
func (t *databaseTarget) archive(d *database.Delivery) error {
|
||||||
|
webhookID := d.Event.WebhookID
|
||||||
|
if webhookID == "" {
|
||||||
|
return errArchiveMissingWebhookID
|
||||||
|
}
|
||||||
|
|
||||||
|
expiry, err := parseArchiveExpiry(d.Target.Config)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
w, err := t.writerFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
row := archivedEvent{
|
||||||
|
EventID: d.Event.ID,
|
||||||
|
WebhookID: webhookID,
|
||||||
|
EntrypointID: d.Event.EntrypointID,
|
||||||
|
Method: d.Event.Method,
|
||||||
|
Headers: d.Event.Headers,
|
||||||
|
Body: d.Event.Body,
|
||||||
|
ContentType: d.Event.ContentType,
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.write(row, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// writerFor returns the archiveWriter for a webhook, creating
|
||||||
|
// and caching it on first use. Each webhook has one writer so
|
||||||
|
// its close/reopen debounce state is shared across concurrent
|
||||||
|
// deliveries. The archive file lives beside the per-webhook
|
||||||
|
// event database in the data directory.
|
||||||
|
func (t *databaseTarget) writerFor(
|
||||||
|
webhookID string,
|
||||||
|
) (*archiveWriter, error) {
|
||||||
|
path, err := t.archivePath(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
if t.writers == nil {
|
||||||
|
t.writers = make(map[string]*archiveWriter)
|
||||||
|
}
|
||||||
|
|
||||||
|
w, ok := t.writers[webhookID]
|
||||||
|
if !ok {
|
||||||
|
w = newArchiveWriter(path, t.eng.log)
|
||||||
|
t.writers[webhookID] = w
|
||||||
|
}
|
||||||
|
|
||||||
|
// A delivery claims the entry: even if the idle sweep created
|
||||||
|
// it moments ago, it now belongs to the registry proper and
|
||||||
|
// the sweep must leave it in place when it finishes.
|
||||||
|
w.sweepOwned = false
|
||||||
|
|
||||||
|
return w, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepWriterFor returns the archive writer the idle sweep should
|
||||||
|
// prune a webhook through, together with whether the sweep itself
|
||||||
|
// created the registry entry.
|
||||||
|
//
|
||||||
|
// The sweep must route its prune through the registered writer so
|
||||||
|
// the writer's mutex orders it against concurrent writes, but it
|
||||||
|
// must never leave a registry entry behind: a sweep that ran
|
||||||
|
// concurrently with the webhook's deletion would otherwise
|
||||||
|
// re-create an entry that nothing will ever evict again, which is
|
||||||
|
// exactly the leak eviction exists to prevent. An entry the sweep
|
||||||
|
// creates is therefore marked sweep-owned and handed back to
|
||||||
|
// releaseSweepWriter when the sweep is done.
|
||||||
|
func (t *databaseTarget) sweepWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) (*archiveWriter, bool, error) {
|
||||||
|
path, err := t.archivePath(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
if t.writers == nil {
|
||||||
|
t.writers = make(map[string]*archiveWriter)
|
||||||
|
}
|
||||||
|
|
||||||
|
w, ok := t.writers[webhookID]
|
||||||
|
if ok {
|
||||||
|
return w, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
w = newArchiveWriter(path, t.eng.log)
|
||||||
|
w.sweepOwned = true
|
||||||
|
t.writers[webhookID] = w
|
||||||
|
|
||||||
|
return w, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// releaseSweepWriter drops a registry entry that the idle sweep
|
||||||
|
// created, so a sweep leaves the registry exactly as it found it.
|
||||||
|
//
|
||||||
|
// The entry is removed only if it is still the very writer the
|
||||||
|
// sweep installed and no delivery has claimed it in the meantime
|
||||||
|
// (writerFor clears sweepOwned when it hands a writer to the
|
||||||
|
// write path). Both conditions are evaluated under the registry
|
||||||
|
// lock, so an eviction that raced the sweep — which removes the
|
||||||
|
// entry outright — simply finds nothing left to do here, and a
|
||||||
|
// delivery that adopted the writer keeps a registered, evictable
|
||||||
|
// one.
|
||||||
|
func (t *databaseTarget) releaseSweepWriter(
|
||||||
|
webhookID string, w *archiveWriter,
|
||||||
|
) {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
cur, ok := t.writers[webhookID]
|
||||||
|
if !ok || cur != w || !cur.sweepOwned {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
delete(t.writers, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePath returns the archive file path for a webhook: it
|
||||||
|
// lives beside the per-webhook event database in the data
|
||||||
|
// directory. It does not touch the filesystem.
|
||||||
|
func (t *databaseTarget) archivePath(
|
||||||
|
webhookID string,
|
||||||
|
) (string, error) {
|
||||||
|
if t.eng.dbManager == nil {
|
||||||
|
return "", errArchiveNoDataDir
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := filepath.Dir(t.eng.dbManager.DBPath(webhookID))
|
||||||
|
|
||||||
|
return filepath.Join(
|
||||||
|
dir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// evict drops a webhook's archive writer from the registry and
|
||||||
|
// closes its handle, so a deleted webhook does not leave a
|
||||||
|
// writer (and an open archive handle within its debounce
|
||||||
|
// window) alive for the process lifetime.
|
||||||
|
//
|
||||||
|
// The map entry is removed under the registry lock, which is
|
||||||
|
// then released before the handle is closed under the writer's
|
||||||
|
// own lock: that ordering keeps the registry available to other
|
||||||
|
// webhooks while an in-flight write on this one drains, and
|
||||||
|
// closing under the writer's lock means eviction can never race
|
||||||
|
// a write.
|
||||||
|
//
|
||||||
|
// Eviction is idempotent and silent for a webhook with no
|
||||||
|
// writer, which is the common case: a webhook with no database
|
||||||
|
// target never creates one. It never deletes the archive file.
|
||||||
|
func (t *databaseTarget) evict(webhookID string) {
|
||||||
|
t.mu.Lock()
|
||||||
|
|
||||||
|
w, ok := t.writers[webhookID]
|
||||||
|
if ok {
|
||||||
|
delete(t.writers, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.mu.Unlock()
|
||||||
|
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.evict()
|
||||||
|
|
||||||
|
t.eng.log.Info(
|
||||||
|
"evicted archive writer",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"path", w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepWebhook prunes one webhook's archive of rows older than
|
||||||
|
// expiry, without requiring a write. It returns nil (nothing to
|
||||||
|
// do) when the archive file does not exist, so a sweep never
|
||||||
|
// creates an archive for a webhook that has a database target
|
||||||
|
// but has never received an event.
|
||||||
|
//
|
||||||
|
// It also never leaves a registry entry behind: an entry it had
|
||||||
|
// to create to reach the writer's mutex is released again once
|
||||||
|
// the prune is done, so a sweep racing a webhook deletion cannot
|
||||||
|
// resurrect the writer the eviction just dropped.
|
||||||
|
func (t *databaseTarget) sweepWebhook(
|
||||||
|
webhookID string, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
path, err := t.archivePath(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check before taking a writer at all: a webhook whose
|
||||||
|
// archive has never been created gets no writer, no handle,
|
||||||
|
// and no file.
|
||||||
|
if !fileExists(path) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
w, created, err := t.sweepWriterFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if created {
|
||||||
|
defer t.releaseSweepWriter(webhookID, w)
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.sweepExpired(expiry)
|
||||||
|
}
|
||||||
431
internal/delivery/target_database_archive.go
Normal file
431
internal/delivery/target_database_archive.go
Normal file
@@ -0,0 +1,431 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/driver/sqlite"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
)
|
||||||
|
|
||||||
|
// archiveExpiryNever is the expiry sentinel (and default) that
|
||||||
|
// disables pruning so archived rows are kept forever.
|
||||||
|
const archiveExpiryNever = "never"
|
||||||
|
|
||||||
|
// archiveReopenDebounce bounds how often an archive file is
|
||||||
|
// closed and reopened. After each write the handle is closed
|
||||||
|
// and reopened so an operator can move the file away for
|
||||||
|
// offline archiving, but never more than once per this window.
|
||||||
|
const archiveReopenDebounce = time.Second
|
||||||
|
|
||||||
|
const (
|
||||||
|
// archiveModeCreate is the SQLite URI mode used by the write
|
||||||
|
// path: open the archive file, creating it if missing, so a
|
||||||
|
// first write (or a write after the operator moved the file
|
||||||
|
// away) recreates it.
|
||||||
|
archiveModeCreate = "rwc"
|
||||||
|
|
||||||
|
// archiveModeExisting is the SQLite URI mode used by the idle
|
||||||
|
// sweep: open read-write but never create. A sweep must never
|
||||||
|
// conjure an empty archive file for a webhook that has a
|
||||||
|
// database target but has never received an event.
|
||||||
|
archiveModeExisting = "rw"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// errArchiveMissingWebhookID is returned when an event to
|
||||||
|
// archive has no webhook id to key its archive file on.
|
||||||
|
errArchiveMissingWebhookID = errors.New(
|
||||||
|
"cannot archive event without a webhook id",
|
||||||
|
)
|
||||||
|
|
||||||
|
// errArchiveNoDataDir is returned when the database target
|
||||||
|
// has no webhook database manager and so cannot locate the
|
||||||
|
// data directory for archive files.
|
||||||
|
errArchiveNoDataDir = errors.New(
|
||||||
|
"database target has no data directory",
|
||||||
|
)
|
||||||
|
|
||||||
|
// errArchiveExpiryNotPositive is returned when a
|
||||||
|
// user-supplied archive expiry parses as a duration but is
|
||||||
|
// zero or negative; "never" is the way to disable pruning.
|
||||||
|
errArchiveExpiryNotPositive = errors.New(
|
||||||
|
"expiry must be a positive duration or \"never\"",
|
||||||
|
)
|
||||||
|
|
||||||
|
// errArchiveWriterEvicted is returned when a writer that has
|
||||||
|
// been evicted (its webhook was deleted, or its last database
|
||||||
|
// target was removed) is used again. An evicted writer is no
|
||||||
|
// longer in the registry, so reopening its file would leak a
|
||||||
|
// handle nothing owns.
|
||||||
|
errArchiveWriterEvicted = errors.New(
|
||||||
|
"archive writer has been evicted",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
// databaseTargetConfig is the optional per-target JSON config
|
||||||
|
// for a database (archive) target.
|
||||||
|
type databaseTargetConfig struct {
|
||||||
|
// Expiry is a Go duration (e.g. "720h") after which
|
||||||
|
// archived rows are pruned, or "never" (the default) to
|
||||||
|
// keep them forever.
|
||||||
|
Expiry string `json:"expiry"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivedEvent is one fully captured webhook event stored in a
|
||||||
|
// per-webhook archive database for long-term retention. It is a
|
||||||
|
// self-contained copy — independent of the per-webhook event
|
||||||
|
// database, which may prune events under its own retention.
|
||||||
|
type archivedEvent struct {
|
||||||
|
ID uint `gorm:"primaryKey;autoIncrement"`
|
||||||
|
EventID string `gorm:"index"`
|
||||||
|
WebhookID string
|
||||||
|
EntrypointID string
|
||||||
|
Method string
|
||||||
|
Headers string
|
||||||
|
Body string
|
||||||
|
ContentType string
|
||||||
|
|
||||||
|
// ArchivedAt is when the row was archived and is the age
|
||||||
|
// basis for expiry pruning.
|
||||||
|
ArchivedAt time.Time `gorm:"index"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseArchiveExpiry reads the optional expiry from a database
|
||||||
|
// target's config JSON. An empty config, an empty expiry, or
|
||||||
|
// the literal "never" all mean keep forever, returned as a zero
|
||||||
|
// duration. Any other value must parse as a positive Go
|
||||||
|
// duration; a set-but-invalid value (unparseable, zero, or
|
||||||
|
// negative) is an error rather than a silent default, matching
|
||||||
|
// ValidateArchiveExpiry at target creation.
|
||||||
|
func parseArchiveExpiry(
|
||||||
|
configJSON string,
|
||||||
|
) (time.Duration, error) {
|
||||||
|
if configJSON == "" {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var cfg databaseTargetConfig
|
||||||
|
|
||||||
|
err := json.Unmarshal([]byte(configJSON), &cfg)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"parsing database target config: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.Expiry == "" || cfg.Expiry == archiveExpiryNever {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
dur, err := time.ParseDuration(cfg.Expiry)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"parsing archive expiry %q: %w", cfg.Expiry, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if dur <= 0 {
|
||||||
|
return 0, fmt.Errorf(
|
||||||
|
"%w: %q", errArchiveExpiryNotPositive, cfg.Expiry,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return dur, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateArchiveExpiry checks a user-supplied archive expiry
|
||||||
|
// for a database target at configuration time. Valid values are
|
||||||
|
// empty, "never" (both meaning keep forever), or a positive Go
|
||||||
|
// duration such as "720h". Anything else is an error, so a bad
|
||||||
|
// expiry is rejected when the target is created rather than
|
||||||
|
// failing every subsequent delivery.
|
||||||
|
func ValidateArchiveExpiry(expiry string) error {
|
||||||
|
if expiry == "" || expiry == archiveExpiryNever {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
dur, err := time.ParseDuration(expiry)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"expiry must be %q or a Go duration "+
|
||||||
|
"such as \"720h\": %w",
|
||||||
|
archiveExpiryNever, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if dur <= 0 {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %q", errArchiveExpiryNotPositive, expiry,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// archiveWriter owns one per-webhook archive SQLite file. It
|
||||||
|
// serialises writes, and after each write closes and reopens
|
||||||
|
// the file (debounced to at most once per debounce window) so
|
||||||
|
// an operator can move the file away for offline archiving. The
|
||||||
|
// next write recreates a moved or removed file, because the
|
||||||
|
// file is opened create-if-missing and its schema is migrated
|
||||||
|
// on every open.
|
||||||
|
type archiveWriter struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
path string
|
||||||
|
log *slog.Logger
|
||||||
|
debounce time.Duration
|
||||||
|
db *gorm.DB
|
||||||
|
lastReopen time.Time
|
||||||
|
reopens int
|
||||||
|
|
||||||
|
// evicted marks a writer that has been removed from the
|
||||||
|
// per-webhook registry. Its handle is closed and it must
|
||||||
|
// never open the file again: nothing holds it any more, so a
|
||||||
|
// reopen would leak the handle for the process lifetime.
|
||||||
|
evicted bool
|
||||||
|
|
||||||
|
// sweepOwned marks a registry entry that the idle sweep
|
||||||
|
// created because no writer was cached for the webhook. The
|
||||||
|
// sweep removes such an entry again when it is done, so a
|
||||||
|
// sweep can never leave — or resurrect — a registry entry
|
||||||
|
// for a webhook that has been deleted. A delivery that adopts
|
||||||
|
// the writer clears the flag, handing the entry to the
|
||||||
|
// registry proper.
|
||||||
|
//
|
||||||
|
// Unlike every other field here it is guarded by
|
||||||
|
// databaseTarget.mu, not by this writer's mu: it describes the
|
||||||
|
// registry entry rather than the file.
|
||||||
|
sweepOwned bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// newArchiveWriter builds an archiveWriter for a file path with
|
||||||
|
// the default reopen debounce.
|
||||||
|
func newArchiveWriter(
|
||||||
|
path string, log *slog.Logger,
|
||||||
|
) *archiveWriter {
|
||||||
|
return &archiveWriter{
|
||||||
|
path: path,
|
||||||
|
log: log,
|
||||||
|
debounce: archiveReopenDebounce,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// write appends the event as a row, then applies the debounced
|
||||||
|
// close/reopen. It recreates the archive file if it was moved
|
||||||
|
// or removed since the last open. A positive expiry prunes rows
|
||||||
|
// older than it on each (re)open.
|
||||||
|
func (w *archiveWriter) write(
|
||||||
|
row archivedEvent, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
if w.evicted {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %s", errArchiveWriterEvicted, w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if w.db == nil || !fileExists(w.path) {
|
||||||
|
err := w.reopen(expiry)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
row.ArchivedAt = time.Now()
|
||||||
|
|
||||||
|
err := w.db.Create(&row).Error
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"archiving event to %s: %w", w.path, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if time.Since(w.lastReopen) >= w.debounce {
|
||||||
|
return w.reopen(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// open opens (creating if missing) the archive file, migrates
|
||||||
|
// its schema, records the reopen time, and prunes expired rows
|
||||||
|
// when expiry is positive.
|
||||||
|
func (w *archiveWriter) open(expiry time.Duration) error {
|
||||||
|
return w.openMode(archiveModeCreate, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// openMode opens the archive file with the given SQLite URI
|
||||||
|
// mode, migrates its schema, records the reopen time, and
|
||||||
|
// prunes expired rows when expiry is positive. The write path
|
||||||
|
// passes archiveModeCreate so a missing file is recreated; the
|
||||||
|
// idle sweep passes archiveModeExisting so a missing file is an
|
||||||
|
// error rather than a newly conjured empty archive.
|
||||||
|
func (w *archiveWriter) openMode(
|
||||||
|
mode string, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
dbURL := fmt.Sprintf("file:%s?mode=%s", w.path, mode)
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open("sqlite", dbURL)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"opening archive database %s: %w", w.path, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
_ = sqlDB.Close()
|
||||||
|
|
||||||
|
return fmt.Errorf(
|
||||||
|
"connecting to archive database %s: %w",
|
||||||
|
w.path, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = gdb.AutoMigrate(&archivedEvent{})
|
||||||
|
if err != nil {
|
||||||
|
_ = sqlDB.Close()
|
||||||
|
|
||||||
|
return fmt.Errorf(
|
||||||
|
"migrating archive database %s: %w", w.path, err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
w.db = gdb
|
||||||
|
w.lastReopen = time.Now()
|
||||||
|
w.reopens++
|
||||||
|
|
||||||
|
if expiry > 0 {
|
||||||
|
w.prune(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// reopen closes any open handle and opens the file afresh. The
|
||||||
|
// fresh open recreates the file if it was moved away.
|
||||||
|
func (w *archiveWriter) reopen(expiry time.Duration) error {
|
||||||
|
w.close()
|
||||||
|
|
||||||
|
return w.open(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// close closes the underlying handle, if any.
|
||||||
|
func (w *archiveWriter) close() {
|
||||||
|
if w.db == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sqlDB, err := w.db.DB()
|
||||||
|
if err == nil {
|
||||||
|
_ = sqlDB.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
w.db = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepExpired prunes an archive that may have gone idle, with
|
||||||
|
// no write to trigger the usual on-reopen prune. It takes the
|
||||||
|
// writer's own mutex for the whole operation, so a sweep is
|
||||||
|
// ordered against concurrent writes rather than reaching around
|
||||||
|
// them to the file.
|
||||||
|
//
|
||||||
|
// It never creates the archive file: a missing file is skipped,
|
||||||
|
// and the reopen uses archiveModeExisting so SQLite itself
|
||||||
|
// refuses to create one if the file disappears between the
|
||||||
|
// check and the open.
|
||||||
|
//
|
||||||
|
// The archive is left CLOSED afterwards. An idle archive holding
|
||||||
|
// no handle is what keeps the operator's move-the-file-away
|
||||||
|
// workflow working; the next write reopens (and recreates) the
|
||||||
|
// file as it always has.
|
||||||
|
func (w *archiveWriter) sweepExpired(expiry time.Duration) error {
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
if w.evicted {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %s", errArchiveWriterEvicted, w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !fileExists(w.path) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drop any live handle first so the prune runs against a
|
||||||
|
// freshly opened file, matching the write path's semantics.
|
||||||
|
w.close()
|
||||||
|
|
||||||
|
err := w.openMode(archiveModeExisting, expiry)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
w.close()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// evict closes the writer's handle and marks it unusable. It is
|
||||||
|
// called when the writer leaves the registry, either because the
|
||||||
|
// webhook was deleted or because its last database target was
|
||||||
|
// removed. The archive FILE is deliberately left on disk: it is
|
||||||
|
// long-term storage an operator may still want.
|
||||||
|
func (w *archiveWriter) evict() {
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
w.evicted = true
|
||||||
|
|
||||||
|
w.close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// prune deletes archived rows older than expiry, measured from
|
||||||
|
// each row's archived time. It runs on every (re)open, so a
|
||||||
|
// steadily written archive is swept by its own write traffic. An
|
||||||
|
// archive that goes idle receives no further reopens, which is
|
||||||
|
// why ArchiveSweeper exists to drive sweepExpired on a timer.
|
||||||
|
// Failures are logged, not fatal: a prune error must not stop
|
||||||
|
// archiving.
|
||||||
|
func (w *archiveWriter) prune(expiry time.Duration) {
|
||||||
|
cutoff := time.Now().Add(-expiry)
|
||||||
|
|
||||||
|
res := w.db.Where("archived_at < ?", cutoff).
|
||||||
|
Delete(&archivedEvent{})
|
||||||
|
if res.Error != nil {
|
||||||
|
w.log.Error(
|
||||||
|
"failed to prune expired archive rows",
|
||||||
|
"path", w.path,
|
||||||
|
"error", res.Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.RowsAffected > 0 {
|
||||||
|
w.log.Info(
|
||||||
|
"pruned expired archive rows",
|
||||||
|
"path", w.path,
|
||||||
|
"rows_deleted", res.RowsAffected,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// fileExists reports whether a path currently exists.
|
||||||
|
func fileExists(path string) bool {
|
||||||
|
_, err := os.Stat(path)
|
||||||
|
|
||||||
|
return err == nil
|
||||||
|
}
|
||||||
363
internal/delivery/target_database_evict_test.go
Normal file
363
internal/delivery/target_database_evict_test.go
Normal file
@@ -0,0 +1,363 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// evictTestEngine builds an engine backed by a temporary data
|
||||||
|
// directory and returns it along with that directory.
|
||||||
|
func evictTestEngine(t *testing.T) (*delivery.Engine, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
|
||||||
|
eng := delivery.NewTestEngineWithDB(
|
||||||
|
nil,
|
||||||
|
database.NewTestWebhookDBManager(dataDir),
|
||||||
|
archiveTestLogger(),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
return eng, dataDir
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_ClosesAndRemovesWriter proves that evicting
|
||||||
|
// a webhook drops its archive writer from the registry and
|
||||||
|
// closes the open archive handle, rather than leaving both
|
||||||
|
// alive for the process lifetime.
|
||||||
|
func TestEvictWebhook_ClosesAndRemovesWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, dataDir := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
webhookID := event.WebhookID
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a delivery should have cached an archive writer",
|
||||||
|
)
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the writer should hold an open handle after a write",
|
||||||
|
)
|
||||||
|
|
||||||
|
eng.EvictWebhook(webhookID)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"eviction should remove the registry entry",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"eviction should close the archive handle",
|
||||||
|
)
|
||||||
|
|
||||||
|
archivePath := filepath.Join(
|
||||||
|
dataDir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
)
|
||||||
|
assert.FileExists(
|
||||||
|
t, archivePath,
|
||||||
|
"eviction must not delete the archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_UnknownWebhookIsNoOp proves eviction is safe
|
||||||
|
// for the common case of a webhook that never had a database
|
||||||
|
// target, and that repeating it does not panic.
|
||||||
|
func TestEvictWebhook_UnknownWebhookIsNoOp(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
assert.NotPanics(t, func() {
|
||||||
|
eng.EvictWebhook("no-such-webhook")
|
||||||
|
eng.EvictWebhook("no-such-webhook")
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter("no-such-webhook"),
|
||||||
|
"eviction must not create a writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// evictTestRow builds an archive row for the eviction tests.
|
||||||
|
func evictTestRow(eventID string) delivery.ExportArchivedEvent {
|
||||||
|
return delivery.ExportArchivedEvent{
|
||||||
|
EventID: eventID,
|
||||||
|
WebhookID: "wh-evict",
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"seeded":true}`,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictedWriter_WriteDoesNotReopenFile is the direct test of
|
||||||
|
// the evicted guard on the write path. A writer that has left
|
||||||
|
// the registry is held by nobody, so a handle it opened could
|
||||||
|
// never be closed again: it must refuse the write outright
|
||||||
|
// rather than recreate the archive behind the registry's back.
|
||||||
|
//
|
||||||
|
// The archive file is removed before the eviction, so an
|
||||||
|
// unguarded write is unmistakable — it recreates the file.
|
||||||
|
func TestEvictedWriter_WriteDoesNotReopenFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-evicted.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(evictTestRow("ev-1"), 0))
|
||||||
|
require.FileExists(t, path)
|
||||||
|
|
||||||
|
// The operator moves the archive away for offline retention,
|
||||||
|
// which the write path would ordinarily undo on the next
|
||||||
|
// write by recreating the file.
|
||||||
|
require.NoError(t, os.Remove(path))
|
||||||
|
|
||||||
|
w.Evict()
|
||||||
|
|
||||||
|
err := w.Write(evictTestRow("ev-2"), 0)
|
||||||
|
|
||||||
|
require.ErrorIs(
|
||||||
|
t, err, delivery.ErrExportArchiveWriterEvicted,
|
||||||
|
"an evicted writer must refuse writes",
|
||||||
|
)
|
||||||
|
assert.NoFileExists(
|
||||||
|
t, path,
|
||||||
|
"an evicted writer must not reopen (or recreate) the "+
|
||||||
|
"archive file",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"an evicted writer must hold no handle",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictedWriter_SweepDoesNotReopenFile is the same test for
|
||||||
|
// the sweep path: an idle sweep that reaches a writer already
|
||||||
|
// evicted underneath it must return the sentinel rather than
|
||||||
|
// reopen a file nothing owns.
|
||||||
|
func TestEvictedWriter_SweepDoesNotReopenFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-evicted.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(evictTestRow("ev-1"), 0))
|
||||||
|
require.FileExists(t, path)
|
||||||
|
|
||||||
|
w.Evict()
|
||||||
|
|
||||||
|
err := w.SweepExpired(time.Hour)
|
||||||
|
|
||||||
|
require.ErrorIs(
|
||||||
|
t, err, delivery.ErrExportArchiveWriterEvicted,
|
||||||
|
"an evicted writer must refuse an idle sweep",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"a refused sweep must not leave a handle open",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// racingWrites drives a pack of goroutines writing to one
|
||||||
|
// archive writer until each is refused, so an eviction on the
|
||||||
|
// test goroutine has to take the writer's mutex away from writes
|
||||||
|
// that are already contending for it.
|
||||||
|
type racingWrites struct {
|
||||||
|
wg sync.WaitGroup
|
||||||
|
mu sync.Mutex
|
||||||
|
sawEvicted bool
|
||||||
|
otherErr error
|
||||||
|
started chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// racingWriteGoroutines is how many goroutines contend for the
|
||||||
|
// writer's mutex while the eviction lands.
|
||||||
|
const racingWriteGoroutines = 4
|
||||||
|
|
||||||
|
// startRacingWrites launches the writing goroutines. Each writes
|
||||||
|
// in a loop and stops at its first error, recording whether that
|
||||||
|
// error was the eviction sentinel. The deadline is a backstop
|
||||||
|
// against a hang, not a timing assumption: the first write after
|
||||||
|
// the eviction is refused.
|
||||||
|
func startRacingWrites(
|
||||||
|
w *delivery.ExportArchiveWriter,
|
||||||
|
) *racingWrites {
|
||||||
|
r := &racingWrites{
|
||||||
|
started: make(chan struct{}, racingWriteGoroutines),
|
||||||
|
}
|
||||||
|
|
||||||
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
|
|
||||||
|
r.wg.Add(racingWriteGoroutines)
|
||||||
|
|
||||||
|
for i := range racingWriteGoroutines {
|
||||||
|
go func() {
|
||||||
|
defer r.wg.Done()
|
||||||
|
|
||||||
|
first := true
|
||||||
|
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
err := w.Write(
|
||||||
|
evictTestRow(fmt.Sprintf("ev-%d", i)), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
if first {
|
||||||
|
r.started <- struct{}{}
|
||||||
|
|
||||||
|
first = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if err == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
r.record(err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// record classifies the error that stopped one goroutine.
|
||||||
|
func (r *racingWrites) record(err error) {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
if errors.Is(err, delivery.ErrExportArchiveWriterEvicted) {
|
||||||
|
r.sawEvicted = true
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.otherErr = err
|
||||||
|
}
|
||||||
|
|
||||||
|
// awaitFirstWrite blocks until at least one write has run, so
|
||||||
|
// the eviction that follows is a genuine race.
|
||||||
|
func (r *racingWrites) awaitFirstWrite() {
|
||||||
|
<-r.started
|
||||||
|
}
|
||||||
|
|
||||||
|
// wait joins the goroutines and reports whether any write was
|
||||||
|
// refused with the eviction sentinel, plus any unexpected error.
|
||||||
|
func (r *racingWrites) wait() (bool, error) {
|
||||||
|
r.wg.Wait()
|
||||||
|
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
return r.sawEvicted, r.otherErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_RacingWriteDoesNotReopenHandle exercises the
|
||||||
|
// interleaving the evicted flag exists for: writes already
|
||||||
|
// contending for the writer's mutex when the eviction takes it.
|
||||||
|
// The write that wins the mutex after the eviction must abandon
|
||||||
|
// its work rather than reopen the archive, leaving the writer
|
||||||
|
// permanently handle-free. Run under -race.
|
||||||
|
func TestEvictWebhook_RacingWriteDoesNotReopenHandle(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
// Prime the registry so the test can hold the very writer the
|
||||||
|
// eviction is about to detach.
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
w := eng.ExportArchiveWriterFor(event.WebhookID)
|
||||||
|
require.NotNil(t, w)
|
||||||
|
require.True(t, w.HandleOpen())
|
||||||
|
|
||||||
|
race := startRacingWrites(w)
|
||||||
|
|
||||||
|
// Evict only once writes are genuinely in flight, so the
|
||||||
|
// eviction has to contend for the writer's mutex.
|
||||||
|
race.awaitFirstWrite()
|
||||||
|
|
||||||
|
eng.EvictWebhook(event.WebhookID)
|
||||||
|
|
||||||
|
sawEvicted, otherErr := race.wait()
|
||||||
|
|
||||||
|
require.NoError(t, otherErr)
|
||||||
|
assert.True(
|
||||||
|
t, sawEvicted,
|
||||||
|
"a write after eviction must be refused",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"no write may reopen the archive once the writer has "+
|
||||||
|
"been evicted",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
"the registry entry must stay gone",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_LaterDeliveryRecreatesWriter proves eviction
|
||||||
|
// does not break archiving for a webhook that is still alive: a
|
||||||
|
// subsequent delivery gets a brand new writer from the registry.
|
||||||
|
// It says nothing about the evicted writer itself — that is what
|
||||||
|
// TestEvictedWriter_WriteDoesNotReopenFile covers.
|
||||||
|
func TestEvictWebhook_LaterDeliveryRecreatesWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
)
|
||||||
|
|
||||||
|
eng.EvictWebhook(event.WebhookID)
|
||||||
|
|
||||||
|
// A fresh delivery for the same webhook gets a brand new
|
||||||
|
// writer from the registry, so archiving keeps working.
|
||||||
|
second := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, "",
|
||||||
|
)
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, second)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
"a later delivery should recreate the writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
402
internal/delivery/target_database_test.go
Normal file
402
internal/delivery/target_database_test.go
Normal file
@@ -0,0 +1,402 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/driver/sqlite"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
_ "modernc.org/sqlite" // Pure Go SQLite driver.
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
func archiveTestLogger() *slog.Logger {
|
||||||
|
return slog.New(slog.NewTextHandler(
|
||||||
|
os.Stderr,
|
||||||
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
// openArchiveDBForRead opens an archive file read-only so a
|
||||||
|
// test can inspect the rows the writer persisted.
|
||||||
|
func openArchiveDBForRead(
|
||||||
|
t *testing.T, path string,
|
||||||
|
) *gorm.DB {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite",
|
||||||
|
fmt.Sprintf("file:%s?mode=ro", path),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = sqlDB.Close() })
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
return gdb
|
||||||
|
}
|
||||||
|
|
||||||
|
// archiveFileSuffixes returns the archive file itself and the
|
||||||
|
// SQLite sidecars that accompany an open database. A test that
|
||||||
|
// asserts no archive was created has to check all of them.
|
||||||
|
func archiveFileSuffixes() []string {
|
||||||
|
return []string{"", "-wal", "-shm"}
|
||||||
|
}
|
||||||
|
|
||||||
|
// removeArchiveFiles simulates an operator moving the archive
|
||||||
|
// away by deleting the SQLite file and its sidecar files.
|
||||||
|
func removeArchiveFiles(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
for _, suffix := range []string{
|
||||||
|
"", "-wal", "-shm", "-journal",
|
||||||
|
} {
|
||||||
|
err := os.Remove(path + suffix)
|
||||||
|
if err != nil && !os.IsNotExist(err) {
|
||||||
|
t.Fatalf("removing %s%s: %v", path, suffix, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDeliverDatabase_ArchivesEvent verifies that delivering to
|
||||||
|
// a database target marks the delivery delivered and archives
|
||||||
|
// the full event into a separate per-webhook archive file.
|
||||||
|
func TestDeliverDatabase_ArchivesEvent(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
dbMgr := database.NewTestWebhookDBManager(dataDir)
|
||||||
|
|
||||||
|
e := delivery.NewTestEngineWithDB(
|
||||||
|
nil, dbMgr,
|
||||||
|
archiveTestLogger(),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
e.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
var updated database.Delivery
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.First(
|
||||||
|
&updated, "id = ?", d.ID,
|
||||||
|
).Error)
|
||||||
|
assert.Equal(t,
|
||||||
|
database.DeliveryStatusDelivered, updated.Status,
|
||||||
|
"database target should mark the delivery delivered",
|
||||||
|
)
|
||||||
|
|
||||||
|
archivePath := filepath.Join(
|
||||||
|
dataDir,
|
||||||
|
fmt.Sprintf("archive-%s.db", event.WebhookID),
|
||||||
|
)
|
||||||
|
assert.FileExists(t, archivePath)
|
||||||
|
|
||||||
|
rdb := openArchiveDBForRead(t, archivePath)
|
||||||
|
|
||||||
|
var rows []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
require.NoError(t, rdb.Find(&rows).Error)
|
||||||
|
require.Len(t, rows, 1)
|
||||||
|
assert.Equal(t, event.ID, rows[0].EventID)
|
||||||
|
assert.Equal(t, event.WebhookID, rows[0].WebhookID)
|
||||||
|
assert.Equal(t, event.Method, rows[0].Method)
|
||||||
|
assert.JSONEq(t, `{"archived":true}`, rows[0].Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestArchiveWriter_WritesRow(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-wh.db")
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
row := delivery.ExportArchivedEvent{
|
||||||
|
EventID: "ev-1",
|
||||||
|
WebhookID: "wh-1",
|
||||||
|
EntrypointID: "ep-1",
|
||||||
|
Method: "POST",
|
||||||
|
Headers: `{"X":"Y"}`,
|
||||||
|
Body: `{"hello":"world"}`,
|
||||||
|
ContentType: "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(row, 0))
|
||||||
|
assert.FileExists(t, path)
|
||||||
|
|
||||||
|
var got []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
require.NoError(t, w.DB().Find(&got).Error)
|
||||||
|
require.Len(t, got, 1)
|
||||||
|
assert.Equal(t, "ev-1", got[0].EventID)
|
||||||
|
assert.Equal(t, "wh-1", got[0].WebhookID)
|
||||||
|
assert.Equal(t, "ep-1", got[0].EntrypointID)
|
||||||
|
assert.Equal(t, row.Method, got[0].Method)
|
||||||
|
assert.Equal(t, row.ContentType, got[0].ContentType)
|
||||||
|
assert.JSONEq(t, `{"hello":"world"}`, got[0].Body)
|
||||||
|
assert.False(t, got[0].ArchivedAt.IsZero())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestArchiveWriter_RecreatesAfterRemoval(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-wh.db")
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(
|
||||||
|
delivery.ExportArchivedEvent{EventID: "a"}, 0,
|
||||||
|
))
|
||||||
|
assert.FileExists(t, path)
|
||||||
|
|
||||||
|
// The operator moves the archive away while the handle is
|
||||||
|
// still open.
|
||||||
|
removeArchiveFiles(t, path)
|
||||||
|
require.NoFileExists(t, path)
|
||||||
|
|
||||||
|
// The next write recreates the file with a fresh schema and
|
||||||
|
// only the new row.
|
||||||
|
require.NoError(t, w.Write(
|
||||||
|
delivery.ExportArchivedEvent{EventID: "b"}, 0,
|
||||||
|
))
|
||||||
|
assert.FileExists(t, path)
|
||||||
|
|
||||||
|
var got []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
require.NoError(t, w.DB().Find(&got).Error)
|
||||||
|
require.Len(t, got, 1)
|
||||||
|
assert.Equal(t, "b", got[0].EventID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestArchiveWriter_ReopenDebounce(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// A generous debounce keeps the two rapid writes inside
|
||||||
|
// the window even on a heavily loaded test machine.
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-wh.db")
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 2*time.Second,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(
|
||||||
|
delivery.ExportArchivedEvent{EventID: "a"}, 0,
|
||||||
|
))
|
||||||
|
require.NoError(t, w.Write(
|
||||||
|
delivery.ExportArchivedEvent{EventID: "b"}, 0,
|
||||||
|
))
|
||||||
|
|
||||||
|
// Two writes inside the debounce window trigger only the
|
||||||
|
// initial open — no extra close/reopen.
|
||||||
|
assert.Equal(t, 1, w.Reopens())
|
||||||
|
|
||||||
|
time.Sleep(2100 * time.Millisecond)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(
|
||||||
|
delivery.ExportArchivedEvent{EventID: "c"}, 0,
|
||||||
|
))
|
||||||
|
|
||||||
|
// A write after the window elapses closes and reopens once.
|
||||||
|
assert.Equal(t, 2, w.Reopens())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestArchiveWriter_ExpiryPrune(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-wh.db")
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Open(0))
|
||||||
|
|
||||||
|
old := delivery.ExportArchivedEvent{
|
||||||
|
EventID: "old",
|
||||||
|
ArchivedAt: time.Now().Add(-2 * time.Hour),
|
||||||
|
}
|
||||||
|
fresh := delivery.ExportArchivedEvent{
|
||||||
|
EventID: "fresh",
|
||||||
|
ArchivedAt: time.Now(),
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, w.DB().Create(&old).Error)
|
||||||
|
require.NoError(t, w.DB().Create(&fresh).Error)
|
||||||
|
|
||||||
|
// Reopening with a one-hour expiry prunes the old row.
|
||||||
|
require.NoError(t, w.Reopen(time.Hour))
|
||||||
|
|
||||||
|
var got []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
require.NoError(t, w.DB().Find(&got).Error)
|
||||||
|
require.Len(t, got, 1)
|
||||||
|
assert.Equal(t, "fresh", got[0].EventID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseArchiveExpiry(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
in string
|
||||||
|
want time.Duration
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{"empty config", "", 0, false},
|
||||||
|
{"explicit never", `{"expiry":"never"}`, 0, false},
|
||||||
|
{"empty expiry", `{"expiry":""}`, 0, false},
|
||||||
|
{"duration", `{"expiry":"1h"}`, time.Hour, false},
|
||||||
|
{"unparseable", `{"expiry":"nonsense"}`, 0, true},
|
||||||
|
{"zero duration", `{"expiry":"0s"}`, 0, true},
|
||||||
|
{"negative duration", `{"expiry":"-5h"}`, 0, true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
got, err := delivery.ExportParseArchiveExpiry(tc.in)
|
||||||
|
if tc.wantErr {
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tc.want, got)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedDatabaseTargetDelivery seeds a pending delivery for a
|
||||||
|
// database target with the given config JSON and returns the
|
||||||
|
// in-memory delivery the target handler is invoked with.
|
||||||
|
func seedDatabaseTargetDelivery(
|
||||||
|
t *testing.T,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
event database.Event,
|
||||||
|
config string,
|
||||||
|
) *database.Delivery {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dlv := seedDelivery(
|
||||||
|
t, webhookDB, event.ID, uuid.New().String(),
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
)
|
||||||
|
|
||||||
|
d := &database.Delivery{
|
||||||
|
EventID: event.ID,
|
||||||
|
TargetID: dlv.TargetID,
|
||||||
|
Status: database.DeliveryStatusPending,
|
||||||
|
Event: event,
|
||||||
|
Target: database.Target{
|
||||||
|
Name: "test-db",
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Config: config,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
d.ID = dlv.ID
|
||||||
|
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDeliverDatabase_ArchiveFailureFailsDelivery verifies that
|
||||||
|
// an archive error (here: an unparseable expiry in the target
|
||||||
|
// config) fails the delivery loudly: the attempt is recorded as
|
||||||
|
// failed with the error and the delivery is marked failed, not
|
||||||
|
// delivered.
|
||||||
|
func TestDeliverDatabase_ArchiveFailureFailsDelivery(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
|
||||||
|
e := delivery.NewTestEngineWithDB(
|
||||||
|
nil, database.NewTestWebhookDBManager(dataDir),
|
||||||
|
archiveTestLogger(),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":false}`)
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"nonsense"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
e.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
var updated database.Delivery
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.First(
|
||||||
|
&updated, "id = ?", d.ID,
|
||||||
|
).Error)
|
||||||
|
assert.Equal(t,
|
||||||
|
database.DeliveryStatusFailed, updated.Status,
|
||||||
|
"archive failure must mark the delivery failed",
|
||||||
|
)
|
||||||
|
|
||||||
|
var results []database.DeliveryResult
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.Where(
|
||||||
|
"delivery_id = ?", d.ID,
|
||||||
|
).Find(&results).Error)
|
||||||
|
require.Len(t, results, 1)
|
||||||
|
assert.False(t,
|
||||||
|
results[0].Success,
|
||||||
|
"the attempt must be recorded as failed",
|
||||||
|
)
|
||||||
|
assert.Contains(t,
|
||||||
|
results[0].Error, "nonsense",
|
||||||
|
"the archive error must be recorded on the attempt",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.NoFileExists(t,
|
||||||
|
filepath.Join(
|
||||||
|
dataDir,
|
||||||
|
fmt.Sprintf("archive-%s.db", event.WebhookID),
|
||||||
|
),
|
||||||
|
"no archive file should exist for a failed config",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateArchiveExpiry(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
valid := []string{"", "never", "1h", "720h", "30m"}
|
||||||
|
for _, in := range valid {
|
||||||
|
require.NoError(t,
|
||||||
|
delivery.ValidateArchiveExpiry(in),
|
||||||
|
"expiry %q should be accepted", in,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
invalid := []string{"nonsense", "7d", "-5h", "0s", "0"}
|
||||||
|
for _, in := range invalid {
|
||||||
|
require.Error(t,
|
||||||
|
delivery.ValidateArchiveExpiry(in),
|
||||||
|
"expiry %q should be rejected", in,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
511
internal/delivery/target_http.go
Normal file
511
internal/delivery/target_http.go
Normal file
@@ -0,0 +1,511 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Sentinel errors returned by the config parsers.
|
||||||
|
var (
|
||||||
|
errEmptyTargetConfig = errors.New(
|
||||||
|
"empty target config",
|
||||||
|
)
|
||||||
|
errMissingTargetURL = errors.New(
|
||||||
|
"target URL is required",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
// HTTPTargetConfig holds configuration for http target
|
||||||
|
// types.
|
||||||
|
type HTTPTargetConfig struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
Headers map[string]string `json:"headers,omitempty"`
|
||||||
|
Timeout int `json:"timeout,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// httpCore holds the retry, backoff, and circuit-breaker
|
||||||
|
// machinery shared by the HTTP and Slack targets. Each of
|
||||||
|
// those targets owns its own httpCore instance (and thus its
|
||||||
|
// own circuit breakers); the per-attempt request differs
|
||||||
|
// between them and is supplied as a closure.
|
||||||
|
type httpCore struct {
|
||||||
|
eng *Engine
|
||||||
|
|
||||||
|
// circuitBreakers stores a *CircuitBreaker per target ID.
|
||||||
|
circuitBreakers sync.Map
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliver runs one delivery attempt through the retry core.
|
||||||
|
// A maxRetries of 0 is fire-and-forget: a single attempt is
|
||||||
|
// recorded and no circuit breaker is consulted. A positive
|
||||||
|
// maxRetries gates the attempt on the circuit breaker and
|
||||||
|
// schedules a backed-off retry on failure.
|
||||||
|
func (c *httpCore) deliver(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
maxRetries int,
|
||||||
|
attempt func() attemptResult,
|
||||||
|
) {
|
||||||
|
if maxRetries == 0 {
|
||||||
|
c.fireAndForget(webhookDB, d, attempt())
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
c.withRetry(
|
||||||
|
webhookDB, d, task, sched, maxRetries, attempt,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *httpCore) fireAndForget(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
res attemptResult,
|
||||||
|
) {
|
||||||
|
c.eng.recordResult(
|
||||||
|
webhookDB, d, 1, res.success,
|
||||||
|
res.statusCode, res.respBody, res.errMsg,
|
||||||
|
res.duration,
|
||||||
|
)
|
||||||
|
|
||||||
|
if res.success {
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d,
|
||||||
|
database.DeliveryStatusDelivered,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *httpCore) withRetry(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
maxRetries int,
|
||||||
|
attempt func() attemptResult,
|
||||||
|
) {
|
||||||
|
cb := c.getCircuitBreaker(task.TargetID)
|
||||||
|
if c.circuitBreakerBlock(webhookDB, d, task, sched, cb) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
attemptNum := task.AttemptNum
|
||||||
|
|
||||||
|
res := attempt()
|
||||||
|
|
||||||
|
c.eng.recordResult(
|
||||||
|
webhookDB, d, attemptNum, res.success,
|
||||||
|
res.statusCode, res.respBody, res.errMsg,
|
||||||
|
res.duration,
|
||||||
|
)
|
||||||
|
|
||||||
|
if res.success {
|
||||||
|
cb.RecordSuccess()
|
||||||
|
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d,
|
||||||
|
database.DeliveryStatusDelivered,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
cb.RecordFailure()
|
||||||
|
|
||||||
|
c.handleRetry(
|
||||||
|
webhookDB, d, task, sched, maxRetries, attemptNum,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *httpCore) circuitBreakerBlock(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
cb *CircuitBreaker,
|
||||||
|
) bool {
|
||||||
|
if cb.Allow() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
remaining := cb.CooldownRemaining()
|
||||||
|
|
||||||
|
c.eng.log.Info(
|
||||||
|
"circuit breaker open, skipping delivery",
|
||||||
|
"target_id", task.TargetID,
|
||||||
|
"target_name", task.TargetName,
|
||||||
|
"delivery_id", d.ID,
|
||||||
|
"cooldown_remaining", remaining,
|
||||||
|
)
|
||||||
|
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d,
|
||||||
|
database.DeliveryStatusRetrying,
|
||||||
|
)
|
||||||
|
|
||||||
|
retryTask := *task
|
||||||
|
sched.ScheduleRetry(retryTask, remaining)
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *httpCore) handleRetry(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
maxRetries int,
|
||||||
|
attemptNum int,
|
||||||
|
) {
|
||||||
|
if attemptNum >= maxRetries {
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d,
|
||||||
|
database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
c.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusRetrying,
|
||||||
|
)
|
||||||
|
|
||||||
|
backoff := calcBackoff(attemptNum)
|
||||||
|
|
||||||
|
retryTask := *task
|
||||||
|
retryTask.AttemptNum = attemptNum + 1
|
||||||
|
sched.ScheduleRetry(retryTask, backoff)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *httpCore) getCircuitBreaker(
|
||||||
|
targetID string,
|
||||||
|
) *CircuitBreaker {
|
||||||
|
if val, ok := c.circuitBreakers.Load(targetID); ok {
|
||||||
|
cb, _ := val.(*CircuitBreaker)
|
||||||
|
|
||||||
|
return cb
|
||||||
|
}
|
||||||
|
|
||||||
|
fresh := NewCircuitBreaker()
|
||||||
|
|
||||||
|
actual, _ := c.circuitBreakers.LoadOrStore(
|
||||||
|
targetID, fresh,
|
||||||
|
)
|
||||||
|
|
||||||
|
cb, _ := actual.(*CircuitBreaker)
|
||||||
|
|
||||||
|
return cb
|
||||||
|
}
|
||||||
|
|
||||||
|
// remainingBackoff returns how long remains of the backoff
|
||||||
|
// window for the last attempt of a recovered retrying
|
||||||
|
// delivery. It implements rescheduler.
|
||||||
|
func (c *httpCore) remainingBackoff(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
deliveryID string,
|
||||||
|
attemptNum int,
|
||||||
|
) time.Duration {
|
||||||
|
var lastResult database.DeliveryResult
|
||||||
|
|
||||||
|
err := webhookDB.
|
||||||
|
Where("delivery_id = ?", deliveryID).
|
||||||
|
Order("created_at DESC").
|
||||||
|
First(&lastResult).Error
|
||||||
|
if err != nil {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
backoff := calcBackoff(attemptNum)
|
||||||
|
elapsed := time.Since(lastResult.CreatedAt)
|
||||||
|
remaining := backoff - elapsed
|
||||||
|
|
||||||
|
return max(remaining, 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// backoffElapsed reports whether the backoff window for the
|
||||||
|
// last attempt of a retrying delivery has passed. It
|
||||||
|
// implements rescheduler.
|
||||||
|
func (c *httpCore) backoffElapsed(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
deliveryID string,
|
||||||
|
attemptNum int,
|
||||||
|
) bool {
|
||||||
|
var lastResult database.DeliveryResult
|
||||||
|
|
||||||
|
err := webhookDB.
|
||||||
|
Where("delivery_id = ?", deliveryID).
|
||||||
|
Order("created_at DESC").
|
||||||
|
First(&lastResult).Error
|
||||||
|
if err != nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
backoff := calcBackoff(attemptNum)
|
||||||
|
|
||||||
|
return time.Since(lastResult.CreatedAt) >= backoff
|
||||||
|
}
|
||||||
|
|
||||||
|
func calcBackoff(attemptNum int) time.Duration {
|
||||||
|
shift := max(attemptNum-1, 0)
|
||||||
|
shift = min(shift, maxBackoffShift)
|
||||||
|
|
||||||
|
return time.Duration(1<<uint(shift)) * time.Second
|
||||||
|
}
|
||||||
|
|
||||||
|
// httpTarget delivers events to http targets. It forwards the
|
||||||
|
// event body and (filtered) request headers to the configured
|
||||||
|
// URL and owns retry, backoff, and circuit breaking through
|
||||||
|
// the shared httpCore.
|
||||||
|
type httpTarget struct {
|
||||||
|
*httpCore
|
||||||
|
|
||||||
|
client *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliver implements Target.
|
||||||
|
func (t *httpTarget) Deliver(
|
||||||
|
ctx context.Context,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
) {
|
||||||
|
cfg, err := parseHTTPConfig(d.Target.Config)
|
||||||
|
if err != nil {
|
||||||
|
t.eng.log.Error(
|
||||||
|
"invalid HTTP target config",
|
||||||
|
"target_id", d.TargetID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.recordResult(
|
||||||
|
webhookDB, d, task.AttemptNum,
|
||||||
|
false, 0, "", err.Error(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
attempt := func() attemptResult {
|
||||||
|
return t.attempt(ctx, cfg, &d.Event)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.deliver(
|
||||||
|
webhookDB, d, task, sched,
|
||||||
|
d.Target.MaxRetries, attempt,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// attempt performs a single HTTP delivery attempt and derives
|
||||||
|
// the success flag and error message the same way the engine
|
||||||
|
// did: a non-2xx response is a failure but carries no error
|
||||||
|
// string; only a transport-level error does.
|
||||||
|
func (t *httpTarget) attempt(
|
||||||
|
ctx context.Context,
|
||||||
|
cfg *HTTPTargetConfig,
|
||||||
|
event *database.Event,
|
||||||
|
) attemptResult {
|
||||||
|
statusCode, respBody, duration, reqErr :=
|
||||||
|
t.doHTTPRequest(ctx, cfg, event)
|
||||||
|
|
||||||
|
success := reqErr == nil &&
|
||||||
|
statusCode >= httpSuccessMin &&
|
||||||
|
statusCode < httpSuccessMax
|
||||||
|
|
||||||
|
errMsg := ""
|
||||||
|
if reqErr != nil {
|
||||||
|
errMsg = reqErr.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
return attemptResult{
|
||||||
|
statusCode: statusCode,
|
||||||
|
respBody: respBody,
|
||||||
|
duration: duration,
|
||||||
|
success: success,
|
||||||
|
errMsg: errMsg,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *httpTarget) doHTTPRequest(
|
||||||
|
ctx context.Context,
|
||||||
|
cfg *HTTPTargetConfig,
|
||||||
|
event *database.Event,
|
||||||
|
) (int, string, int64, error) {
|
||||||
|
start := time.Now()
|
||||||
|
|
||||||
|
req, reqErr := http.NewRequestWithContext(
|
||||||
|
ctx,
|
||||||
|
http.MethodPost,
|
||||||
|
cfg.URL,
|
||||||
|
bytes.NewReader([]byte(event.Body)),
|
||||||
|
)
|
||||||
|
if reqErr != nil {
|
||||||
|
return 0, "", 0, fmt.Errorf(
|
||||||
|
"creating request: %w",
|
||||||
|
maskURLError(reqErr),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
applyRequestHeaders(req, event, cfg)
|
||||||
|
|
||||||
|
client := t.clientForConfig(cfg)
|
||||||
|
|
||||||
|
resp, doErr := executeHTTPRequest(client, req)
|
||||||
|
|
||||||
|
dur := time.Since(start).Milliseconds()
|
||||||
|
if doErr != nil {
|
||||||
|
return 0, "", dur, fmt.Errorf(
|
||||||
|
"sending request: %w", doErr,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = resp.Body.Close() }()
|
||||||
|
|
||||||
|
body, readErr := io.ReadAll(
|
||||||
|
io.LimitReader(resp.Body, maxBodyLog),
|
||||||
|
)
|
||||||
|
if readErr != nil {
|
||||||
|
return resp.StatusCode, "", dur,
|
||||||
|
fmt.Errorf(
|
||||||
|
"reading response body: %w", readErr,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return resp.StatusCode, string(body), dur, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *httpTarget) clientForConfig(
|
||||||
|
cfg *HTTPTargetConfig,
|
||||||
|
) *http.Client {
|
||||||
|
if cfg.Timeout > 0 {
|
||||||
|
// Reuse the shared client's SSRF-safe transport so
|
||||||
|
// a per-target timeout does not drop the
|
||||||
|
// request-time private-IP guard. Only the timeout
|
||||||
|
// is overridden.
|
||||||
|
return &http.Client{
|
||||||
|
Timeout: time.Duration(
|
||||||
|
cfg.Timeout,
|
||||||
|
) * time.Second,
|
||||||
|
Transport: t.client.Transport,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return t.client
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseHTTPConfig(
|
||||||
|
configJSON string,
|
||||||
|
) (*HTTPTargetConfig, error) {
|
||||||
|
if configJSON == "" {
|
||||||
|
return nil, errEmptyTargetConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
var cfg HTTPTargetConfig
|
||||||
|
|
||||||
|
err := json.Unmarshal(
|
||||||
|
[]byte(configJSON), &cfg,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"parsing config JSON: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.URL == "" {
|
||||||
|
return nil, errMissingTargetURL
|
||||||
|
}
|
||||||
|
|
||||||
|
return &cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// isForwardableHeader returns true if the header should
|
||||||
|
// be forwarded to targets.
|
||||||
|
func isForwardableHeader(name string) bool {
|
||||||
|
switch http.CanonicalHeaderKey(name) {
|
||||||
|
case "Host", "Connection", "Keep-Alive",
|
||||||
|
"Transfer-Encoding", "Te", "Trailer",
|
||||||
|
"Upgrade", "Proxy-Authorization",
|
||||||
|
"Proxy-Connection", "Content-Length":
|
||||||
|
return false
|
||||||
|
default:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func applyRequestHeaders(
|
||||||
|
req *http.Request,
|
||||||
|
event *database.Event,
|
||||||
|
cfg *HTTPTargetConfig,
|
||||||
|
) {
|
||||||
|
if event.ContentType != "" {
|
||||||
|
req.Header.Set(
|
||||||
|
"Content-Type", event.ContentType,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
var originalHeaders map[string][]string
|
||||||
|
|
||||||
|
if event.Headers != "" {
|
||||||
|
jsonErr := json.Unmarshal(
|
||||||
|
[]byte(event.Headers),
|
||||||
|
&originalHeaders,
|
||||||
|
)
|
||||||
|
if jsonErr == nil {
|
||||||
|
for k, vals := range originalHeaders {
|
||||||
|
if isForwardableHeader(k) {
|
||||||
|
for _, v := range vals {
|
||||||
|
req.Header.Add(k, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range cfg.Headers {
|
||||||
|
req.Header.Set(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("User-Agent", "webhooker/1.0")
|
||||||
|
}
|
||||||
|
|
||||||
|
// executeHTTPRequest sends an HTTP request using the provided
|
||||||
|
// client. URLs are validated by the config parsers and the
|
||||||
|
// SSRF-safe transport before reaching here.
|
||||||
|
//
|
||||||
|
// Transport failures are masked here, at the single point
|
||||||
|
// where every target's request errors are born, because the
|
||||||
|
// caller stores them in DeliveryResult.Error: an unmasked
|
||||||
|
// *url.Error would write the target URL — the credential for
|
||||||
|
// a Slack incoming webhook — into the per-webhook database.
|
||||||
|
func executeHTTPRequest(
|
||||||
|
client *http.Client, req *http.Request,
|
||||||
|
) (*http.Response, error) {
|
||||||
|
resp, err := client.Do(req) //#nosec G704 -- validated URL, SSRF-safe transport
|
||||||
|
if err != nil {
|
||||||
|
return nil, maskURLError(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return resp, nil
|
||||||
|
}
|
||||||
47
internal/delivery/target_log.go
Normal file
47
internal/delivery/target_log.go
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// logTarget is a fire-and-forget target that logs the entire
|
||||||
|
// inbound webhook — the full request body and headers, plus
|
||||||
|
// the method, content type, and the webhook and entrypoint
|
||||||
|
// ids — then records a single successful attempt.
|
||||||
|
type logTarget struct {
|
||||||
|
eng *Engine
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliver implements Target.
|
||||||
|
func (t *logTarget) Deliver(
|
||||||
|
_ context.Context,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
_ *Task,
|
||||||
|
_ Scheduler,
|
||||||
|
) {
|
||||||
|
t.eng.log.Info(
|
||||||
|
"webhook event delivered to log target",
|
||||||
|
"delivery_id", d.ID,
|
||||||
|
"event_id", d.EventID,
|
||||||
|
"target_id", d.TargetID,
|
||||||
|
"target_name", d.Target.Name,
|
||||||
|
"webhook_id", d.Event.WebhookID,
|
||||||
|
"entrypoint_id", d.Event.EntrypointID,
|
||||||
|
"method", d.Event.Method,
|
||||||
|
"content_type", d.Event.ContentType,
|
||||||
|
"headers", d.Event.Headers,
|
||||||
|
"body", d.Event.Body,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.recordResult(
|
||||||
|
webhookDB, d, 1, true, 0, "", "", 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusDelivered,
|
||||||
|
)
|
||||||
|
}
|
||||||
299
internal/delivery/target_slack.go
Normal file
299
internal/delivery/target_slack.go
Normal file
@@ -0,0 +1,299 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// errMissingWebhookURL is returned when a Slack target config
|
||||||
|
// omits its webhook URL.
|
||||||
|
var errMissingWebhookURL = errors.New(
|
||||||
|
"webhook_url is required",
|
||||||
|
)
|
||||||
|
|
||||||
|
// SlackTargetConfig holds configuration for slack target
|
||||||
|
// types.
|
||||||
|
type SlackTargetConfig struct {
|
||||||
|
WebhookURL string `json:"webhookUrl"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// slackTarget delivers events to Slack incoming webhooks. It
|
||||||
|
// formats the event into a Slack message and posts it as
|
||||||
|
// JSON. It shares the retry core with the HTTP target: a
|
||||||
|
// MaxRetries of 0 stays single-attempt fire-and-forget
|
||||||
|
// (preserving existing Slack targets), while a positive
|
||||||
|
// MaxRetries adds backoff and circuit breaking.
|
||||||
|
type slackTarget struct {
|
||||||
|
*httpCore
|
||||||
|
|
||||||
|
client *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliver implements Target.
|
||||||
|
func (t *slackTarget) Deliver(
|
||||||
|
ctx context.Context,
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
task *Task,
|
||||||
|
sched Scheduler,
|
||||||
|
) {
|
||||||
|
cfg, err := parseSlackConfig(d.Target.Config)
|
||||||
|
if err != nil {
|
||||||
|
t.eng.log.Error(
|
||||||
|
"invalid Slack target config",
|
||||||
|
"target_id", d.TargetID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.failConfig(webhookDB, d, err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := FormatSlackMessage(&d.Event)
|
||||||
|
|
||||||
|
payload, err := json.Marshal(
|
||||||
|
map[string]string{"text": msg},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.eng.log.Error(
|
||||||
|
"failed to marshal Slack payload",
|
||||||
|
"target_id", d.TargetID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.failConfig(webhookDB, d, err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
attempt := func() attemptResult {
|
||||||
|
return t.attempt(ctx, cfg, payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.deliver(
|
||||||
|
webhookDB, d, task, sched,
|
||||||
|
d.Target.MaxRetries, attempt,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// failConfig records a first-attempt failure for a delivery
|
||||||
|
// that could not be prepared (bad config or unmarshalable
|
||||||
|
// payload) and marks it failed.
|
||||||
|
func (t *slackTarget) failConfig(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
d *database.Delivery,
|
||||||
|
err error,
|
||||||
|
) {
|
||||||
|
t.eng.recordResult(
|
||||||
|
webhookDB, d, 1,
|
||||||
|
false, 0, "", err.Error(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
t.eng.updateDeliveryStatus(
|
||||||
|
webhookDB, d, database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// attempt performs a single Slack POST and derives its
|
||||||
|
// outcome, preserving the engine's original semantics: a
|
||||||
|
// non-2xx response records an "HTTP <code>" error string and
|
||||||
|
// a transport error records a "sending request" error.
|
||||||
|
func (t *slackTarget) attempt(
|
||||||
|
ctx context.Context,
|
||||||
|
cfg *SlackTargetConfig,
|
||||||
|
payload []byte,
|
||||||
|
) attemptResult {
|
||||||
|
start := time.Now()
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(
|
||||||
|
ctx,
|
||||||
|
http.MethodPost,
|
||||||
|
cfg.WebhookURL,
|
||||||
|
bytes.NewReader(payload),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return attemptResult{
|
||||||
|
success: false,
|
||||||
|
errMsg: maskURLError(err).Error(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
req.Header.Set("User-Agent", "webhooker/1.0")
|
||||||
|
|
||||||
|
resp, doErr := executeHTTPRequest(t.client, req)
|
||||||
|
durationMs := time.Since(start).Milliseconds()
|
||||||
|
|
||||||
|
if doErr != nil {
|
||||||
|
return attemptResult{
|
||||||
|
success: false,
|
||||||
|
duration: durationMs,
|
||||||
|
errMsg: fmt.Errorf(
|
||||||
|
"sending request: %w", doErr,
|
||||||
|
).Error(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = resp.Body.Close() }()
|
||||||
|
|
||||||
|
return t.readSlackResponse(resp, durationMs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *slackTarget) readSlackResponse(
|
||||||
|
resp *http.Response,
|
||||||
|
durationMs int64,
|
||||||
|
) attemptResult {
|
||||||
|
body, readErr := io.ReadAll(
|
||||||
|
io.LimitReader(resp.Body, maxBodyLog),
|
||||||
|
)
|
||||||
|
if readErr != nil {
|
||||||
|
t.eng.log.Error(
|
||||||
|
"failed to read Slack response body",
|
||||||
|
"error", readErr,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
success := resp.StatusCode >= httpSuccessMin &&
|
||||||
|
resp.StatusCode < httpSuccessMax
|
||||||
|
|
||||||
|
errMsg := ""
|
||||||
|
if !success {
|
||||||
|
errMsg = fmt.Sprintf("HTTP %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
return attemptResult{
|
||||||
|
statusCode: resp.StatusCode,
|
||||||
|
respBody: string(body),
|
||||||
|
duration: durationMs,
|
||||||
|
success: success,
|
||||||
|
errMsg: errMsg,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseSlackConfig(
|
||||||
|
configJSON string,
|
||||||
|
) (*SlackTargetConfig, error) {
|
||||||
|
if configJSON == "" {
|
||||||
|
return nil, errEmptyTargetConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
var cfg SlackTargetConfig
|
||||||
|
|
||||||
|
err := json.Unmarshal(
|
||||||
|
[]byte(configJSON), &cfg,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"parsing config JSON: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.WebhookURL == "" {
|
||||||
|
return nil, errMissingWebhookURL
|
||||||
|
}
|
||||||
|
|
||||||
|
return &cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FormatSlackMessage builds a Slack-compatible message
|
||||||
|
// string from a webhook event.
|
||||||
|
func FormatSlackMessage(
|
||||||
|
event *database.Event,
|
||||||
|
) string {
|
||||||
|
var b strings.Builder
|
||||||
|
|
||||||
|
b.WriteString("*Webhook Event Received*\n")
|
||||||
|
|
||||||
|
fmt.Fprintf(
|
||||||
|
&b, "*Method:* `%s`\n", event.Method,
|
||||||
|
)
|
||||||
|
|
||||||
|
fmt.Fprintf(
|
||||||
|
&b,
|
||||||
|
"*Content-Type:* `%s`\n",
|
||||||
|
event.ContentType,
|
||||||
|
)
|
||||||
|
|
||||||
|
fmt.Fprintf(
|
||||||
|
&b,
|
||||||
|
"*Timestamp:* `%s`\n",
|
||||||
|
event.CreatedAt.UTC().Format(time.RFC3339),
|
||||||
|
)
|
||||||
|
|
||||||
|
fmt.Fprintf(
|
||||||
|
&b,
|
||||||
|
"*Body Size:* %d bytes\n",
|
||||||
|
len(event.Body),
|
||||||
|
)
|
||||||
|
|
||||||
|
if event.Body == "" {
|
||||||
|
b.WriteString("\n_(empty body)_\n")
|
||||||
|
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
if formatted := formatJSONBody(event.Body); formatted != "" {
|
||||||
|
b.WriteString(formatted)
|
||||||
|
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
formatRawBody(&b, event.Body)
|
||||||
|
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatJSONBody(body string) string {
|
||||||
|
var parsed json.RawMessage
|
||||||
|
if json.Unmarshal([]byte(body), &parsed) != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
var pretty bytes.Buffer
|
||||||
|
if json.Indent(&pretty, parsed, "", " ") != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
var b strings.Builder
|
||||||
|
|
||||||
|
b.WriteString("\n```\n")
|
||||||
|
|
||||||
|
prettyStr := pretty.String()
|
||||||
|
|
||||||
|
const maxPayloadDisplay = 3500
|
||||||
|
if len(prettyStr) > maxPayloadDisplay {
|
||||||
|
b.WriteString(prettyStr[:maxPayloadDisplay])
|
||||||
|
b.WriteString("\n... (truncated)")
|
||||||
|
} else {
|
||||||
|
b.WriteString(prettyStr)
|
||||||
|
}
|
||||||
|
|
||||||
|
b.WriteString("\n```\n")
|
||||||
|
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatRawBody(b *strings.Builder, body string) {
|
||||||
|
b.WriteString("\n```\n")
|
||||||
|
|
||||||
|
const maxRawDisplay = 3500
|
||||||
|
if len(body) > maxRawDisplay {
|
||||||
|
b.WriteString(body[:maxRawDisplay])
|
||||||
|
b.WriteString("\n... (truncated)")
|
||||||
|
} else {
|
||||||
|
b.WriteString(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
b.WriteString("\n```\n")
|
||||||
|
}
|
||||||
61
internal/delivery/url_mask.go
Normal file
61
internal/delivery/url_mask.go
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"net/url"
|
||||||
|
)
|
||||||
|
|
||||||
|
// urlPathElision stands in for a URL's elided path.
|
||||||
|
const urlPathElision = "/..."
|
||||||
|
|
||||||
|
// MaskURL renders a URL as scheme plus host with everything
|
||||||
|
// that can carry a secret removed. A delivery target URL is
|
||||||
|
// itself a credential — a Slack incoming webhook URL is a
|
||||||
|
// bearer token — so the path, query and userinfo are never
|
||||||
|
// reproduced, in a page, a log line or a stored error. A URL
|
||||||
|
// that does not parse into a scheme and host yields the
|
||||||
|
// neutral placeholder, never the raw string.
|
||||||
|
func MaskURL(raw string) string {
|
||||||
|
parsed, err := url.Parse(raw)
|
||||||
|
if err != nil || parsed.Scheme == "" ||
|
||||||
|
parsed.Host == "" {
|
||||||
|
return configUnavailable
|
||||||
|
}
|
||||||
|
|
||||||
|
masked := parsed.Scheme + "://" + parsed.Host
|
||||||
|
|
||||||
|
if parsed.Path != "" && parsed.Path != "/" {
|
||||||
|
masked += urlPathElision
|
||||||
|
}
|
||||||
|
|
||||||
|
return masked
|
||||||
|
}
|
||||||
|
|
||||||
|
// maskURLError strips the credential from an error raised
|
||||||
|
// against a request URL. The net/http and net/url packages
|
||||||
|
// embed the full request URL in every *url.Error they return,
|
||||||
|
// so an unmodified transport error persisted into
|
||||||
|
// DeliveryResult.Error writes the credential to disk.
|
||||||
|
//
|
||||||
|
// The masked error keeps the operation and the wrapped cause,
|
||||||
|
// so a DNS failure still reads differently from a refused
|
||||||
|
// connection, a TLS handshake failure or a timeout, and Is,
|
||||||
|
// As, Timeout and Temporary keep working on it. Only the
|
||||||
|
// path, query and userinfo of the URL are dropped. Errors
|
||||||
|
// that carry no URL are returned unchanged.
|
||||||
|
//
|
||||||
|
// Call it where the error is raised, before any wrapping: it
|
||||||
|
// replaces the *url.Error itself, so any context wrapped
|
||||||
|
// around it first would be discarded.
|
||||||
|
func maskURLError(err error) error {
|
||||||
|
var urlErr *url.Error
|
||||||
|
if !errors.As(err, &urlErr) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &url.Error{
|
||||||
|
Op: urlErr.Op,
|
||||||
|
URL: MaskURL(urlErr.URL),
|
||||||
|
Err: urlErr.Err,
|
||||||
|
}
|
||||||
|
}
|
||||||
196
internal/delivery/url_mask_test.go
Normal file
196
internal/delivery/url_mask_test.go
Normal file
@@ -0,0 +1,196 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The path of a Slack incoming webhook URL is the credential:
|
||||||
|
// whoever holds these segments can post to the channel
|
||||||
|
// forever. None of them may reach a stored delivery error,
|
||||||
|
// which lives on disk in the per-webhook database and is
|
||||||
|
// serialized by the JSON tag on DeliveryResult.Error.
|
||||||
|
const (
|
||||||
|
maskSecretPath = "/services/T00000000/B00000000/" +
|
||||||
|
"XXXXXXXXXXXXXXXXXXXXXXXX"
|
||||||
|
)
|
||||||
|
|
||||||
|
// assertNoCredential fails if the whole path or any single
|
||||||
|
// segment of it survived into the message, so a partial leak
|
||||||
|
// fails the test too.
|
||||||
|
func assertNoCredential(t *testing.T, msg string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
segments := []string{
|
||||||
|
maskSecretPath,
|
||||||
|
"services",
|
||||||
|
"T00000000",
|
||||||
|
"B00000000",
|
||||||
|
"XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, segment := range segments {
|
||||||
|
assert.NotContains(t, msg, segment)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// storedDeliveryError returns the error string persisted for a
|
||||||
|
// delivery, which is what an operator and any future API read.
|
||||||
|
func storedDeliveryError(
|
||||||
|
t *testing.T, db *gorm.DB, deliveryID string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var result database.DeliveryResult
|
||||||
|
|
||||||
|
require.NoError(t, db.Where(
|
||||||
|
"delivery_id = ?", deliveryID,
|
||||||
|
).First(&result).Error)
|
||||||
|
|
||||||
|
return result.Error
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliverSlackTo runs a Slack delivery against webhookURL and
|
||||||
|
// returns the error string it persisted.
|
||||||
|
func deliverSlackTo(
|
||||||
|
t *testing.T, webhookURL string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
db := testWebhookDB(t)
|
||||||
|
e := testEngine(t, 1)
|
||||||
|
targetID := uuid.New().String()
|
||||||
|
|
||||||
|
slackCfg, err := json.Marshal(
|
||||||
|
delivery.SlackTargetConfig{
|
||||||
|
WebhookURL: webhookURL,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
event := seedEvent(t, db, `{"test":true}`)
|
||||||
|
|
||||||
|
dlv := seedDelivery(
|
||||||
|
t, db, event.ID, targetID,
|
||||||
|
database.DeliveryStatusPending,
|
||||||
|
)
|
||||||
|
|
||||||
|
d := buildSlackDelivery(
|
||||||
|
dlv, event, targetID,
|
||||||
|
"test-slack-mask", string(slackCfg),
|
||||||
|
)
|
||||||
|
|
||||||
|
e.ExportDeliverSlack(context.TODO(), db, d)
|
||||||
|
|
||||||
|
assertDeliveryStatus(t, db, dlv.ID,
|
||||||
|
database.DeliveryStatusFailed,
|
||||||
|
)
|
||||||
|
|
||||||
|
return storedDeliveryError(t, db, dlv.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDeliverSlack_TransportErrorMasksWebhookURL is the
|
||||||
|
// load-bearing regression test: a transport failure must not
|
||||||
|
// persist the webhook URL's credential into the database, and
|
||||||
|
// must still say what went wrong and where.
|
||||||
|
func TestDeliverSlack_TransportErrorMasksWebhookURL(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// A server closed before use gives a deterministic
|
||||||
|
// transport failure against a known host.
|
||||||
|
ts := httptest.NewServer(http.NewServeMux())
|
||||||
|
host := ts.URL
|
||||||
|
|
||||||
|
ts.Close()
|
||||||
|
|
||||||
|
errMsg := deliverSlackTo(t, host+maskSecretPath)
|
||||||
|
|
||||||
|
require.NotEmpty(t, errMsg)
|
||||||
|
assertNoCredential(t, errMsg)
|
||||||
|
|
||||||
|
// The diagnostic value survives: the operation, the host
|
||||||
|
// and the transport failure are all still reported, and
|
||||||
|
// only the path is elided.
|
||||||
|
assert.Contains(t, errMsg, "sending request")
|
||||||
|
assert.Contains(t, errMsg, "Post")
|
||||||
|
assert.Contains(t, errMsg, host+"/...")
|
||||||
|
assert.Contains(t, errMsg, "connection refused")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDeliverSlack_UnparsableURLMasksWebhookURL covers the
|
||||||
|
// other error path out of a Slack attempt: url.Parse also
|
||||||
|
// embeds the whole URL in the error it returns.
|
||||||
|
func TestDeliverSlack_UnparsableURLMasksWebhookURL(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
errMsg := deliverSlackTo(
|
||||||
|
t,
|
||||||
|
"https://hooks.slack.com"+maskSecretPath+"\n",
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NotEmpty(t, errMsg)
|
||||||
|
assertNoCredential(t, errMsg)
|
||||||
|
assert.Contains(t, errMsg, "invalid control character")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDoHTTPRequest_TransportErrorMasksURL proves the HTTP
|
||||||
|
// target's transport errors are masked too; its destination
|
||||||
|
// URL can carry a token in a query string.
|
||||||
|
func TestDoHTTPRequest_TransportErrorMasksURL(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ts := httptest.NewServer(http.NewServeMux())
|
||||||
|
host := ts.URL
|
||||||
|
|
||||||
|
ts.Close()
|
||||||
|
|
||||||
|
e := testEngine(t, 1)
|
||||||
|
|
||||||
|
cfg, err := e.ExportParseHTTPConfig(
|
||||||
|
newHTTPTargetConfig(host + maskSecretPath),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
statusCode, _, _, reqErr := e.ExportDoHTTPRequest(
|
||||||
|
context.TODO(), cfg,
|
||||||
|
&database.Event{Body: `{"test":true}`},
|
||||||
|
)
|
||||||
|
require.Error(t, reqErr)
|
||||||
|
assert.Zero(t, statusCode)
|
||||||
|
|
||||||
|
assertNoCredential(t, reqErr.Error())
|
||||||
|
assert.Contains(t, reqErr.Error(), host+"/...")
|
||||||
|
assert.Contains(
|
||||||
|
t, reqErr.Error(), "connection refused",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestValidateTargetURL_UnparsableURLIsMasked proves the SSRF
|
||||||
|
// validator's error does not carry the submitted URL, which
|
||||||
|
// the handler both logs and shows.
|
||||||
|
func TestValidateTargetURL_UnparsableURLIsMasked(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
err := delivery.ValidateTargetURL(
|
||||||
|
context.TODO(),
|
||||||
|
"https://hooks.slack.com"+maskSecretPath+"\n",
|
||||||
|
)
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
assertNoCredential(t, err.Error())
|
||||||
|
assert.Contains(t, err.Error(), "invalid URL")
|
||||||
|
}
|
||||||
@@ -19,7 +19,7 @@ func (h *Handlers) HandleLoginPage() http.HandlerFunc {
|
|||||||
|
|
||||||
// Render login page
|
// Render login page
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Error": "",
|
tmplKeyError: "",
|
||||||
}
|
}
|
||||||
|
|
||||||
h.renderTemplate(w, r, "login.html", data)
|
h.renderTemplate(w, r, "login.html", data)
|
||||||
@@ -29,10 +29,8 @@ func (h *Handlers) HandleLoginPage() http.HandlerFunc {
|
|||||||
// HandleLoginSubmit handles the login form submission (POST)
|
// HandleLoginSubmit handles the login form submission (POST)
|
||||||
func (h *Handlers) HandleLoginSubmit() http.HandlerFunc {
|
func (h *Handlers) HandleLoginSubmit() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
// Limit request body to prevent memory exhaustion
|
// The body size cap is enforced by the MaxBodySize
|
||||||
r.Body = http.MaxBytesReader(w, r.Body, 1<<maxBodyShift)
|
// middleware, which runs before CSRF parses the form.
|
||||||
|
|
||||||
// Parse form data
|
|
||||||
err := r.ParseForm()
|
err := r.ParseForm()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.log.Error("failed to parse form", "error", err)
|
h.log.Error("failed to parse form", "error", err)
|
||||||
@@ -86,7 +84,7 @@ func (h *Handlers) renderLoginError(
|
|||||||
status int,
|
status int,
|
||||||
) {
|
) {
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Error": msg,
|
tmplKeyError: msg,
|
||||||
}
|
}
|
||||||
|
|
||||||
w.WriteHeader(status)
|
w.WriteHeader(status)
|
||||||
|
|||||||
192
internal/handlers/event_body.go
Normal file
192
internal/handlers/event_body.go
Normal file
@@ -0,0 +1,192 @@
|
|||||||
|
package handlers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// eventBodyQuery reads one event's stored body as bytes. The cast
|
||||||
|
// to blob is what makes the driver hand back the stored bytes
|
||||||
|
// rather than a string conversion, so Content-Length taken from
|
||||||
|
// the result matches what goes on the wire. The soft-delete
|
||||||
|
// predicate is spelled out because Raw bypasses GORM's default
|
||||||
|
// scope, and it is what stops a reaped event still being
|
||||||
|
// downloadable.
|
||||||
|
const eventBodyQuery = "SELECT cast(body as blob) " +
|
||||||
|
"FROM events WHERE id = ? AND webhook_id = ? AND deleted_at IS NULL"
|
||||||
|
|
||||||
|
// HandleEventBodyDownload serves one event's stored body in
|
||||||
|
// full, which the event log page cannot: it caps each rendered
|
||||||
|
// body at maxRenderedBodyBytes.
|
||||||
|
//
|
||||||
|
// The bytes are attacker-supplied — anyone who can reach the
|
||||||
|
// public receiver chooses them — and this route hands them back
|
||||||
|
// inside the operator's own authenticated origin, so the
|
||||||
|
// response is deliberately not renderable. Content-Disposition
|
||||||
|
// makes the browser download rather than display it, and the
|
||||||
|
// octet-stream type plus nosniff stop it being interpreted as
|
||||||
|
// HTML or script. Without those a stored payload would execute
|
||||||
|
// as the logged-in operator. The application's CSP does not
|
||||||
|
// help here: script-src allows 'unsafe-inline' from 'self', so
|
||||||
|
// a document served from this origin could run its own inline
|
||||||
|
// script.
|
||||||
|
func (h *Handlers) HandleEventBodyDownload() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
webhook, ok := h.ownedWebhook(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parsing the id before use serves two purposes: a
|
||||||
|
// malformed id can never reach the SQL or the response
|
||||||
|
// header, and the canonical form below is drawn from
|
||||||
|
// uuid's own fixed alphabet rather than from the
|
||||||
|
// request, so the Content-Disposition value cannot be
|
||||||
|
// steered by a client.
|
||||||
|
eventID, err := uuid.Parse(chi.URLParam(r, "eventID"))
|
||||||
|
if err != nil {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.serveEventBody(w, r, webhook, eventID.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// serveEventBody writes the named event's stored body to w.
|
||||||
|
//
|
||||||
|
// The event must belong to webhook, which is what keeps this
|
||||||
|
// route from reading any event in the system by id alone. Two
|
||||||
|
// things enforce that and they are not equally strong. The
|
||||||
|
// operative one is that events live in a per-webhook SQLite
|
||||||
|
// file, so a sibling webhook's event is not in the database
|
||||||
|
// being queried at all. The webhook_id predicate on the query
|
||||||
|
// below is the second guard, and it is currently redundant
|
||||||
|
// against that isolation; it is there so the scoping survives
|
||||||
|
// any future change that puts more than one webhook's events in
|
||||||
|
// one file.
|
||||||
|
//
|
||||||
|
// The body is read in one query and held whole in memory while
|
||||||
|
// it is written. That is the bound: one body per concurrent
|
||||||
|
// download, and a body is capped at 1 MB when it is ingested,
|
||||||
|
// so a download cannot cost more than that. There is no
|
||||||
|
// cheaper bound available — database/sql exposes no incremental
|
||||||
|
// handle on a SQLite BLOB, and reading byte ranges with substr
|
||||||
|
// does not avoid the cost either, because SQLite materialises
|
||||||
|
// the whole column value to evaluate each substr call. Range
|
||||||
|
// reads only pay for that materialisation once per range.
|
||||||
|
//
|
||||||
|
// One consequence is worth keeping in view: the read finishes
|
||||||
|
// before the client is written to, so no read lock is held for
|
||||||
|
// the length of a slow download. These per-webhook databases
|
||||||
|
// run in SQLite's default journal mode rather than WAL, so a
|
||||||
|
// lock held that long would block the receiver from recording
|
||||||
|
// new events.
|
||||||
|
func (h *Handlers) serveEventBody(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
r *http.Request,
|
||||||
|
webhook database.Webhook,
|
||||||
|
eventID string,
|
||||||
|
) {
|
||||||
|
if !h.dbMgr.DBExists(webhook.ID) {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
webhookDB, err := h.dbMgr.GetDB(webhook.ID)
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(w, "failed to get webhook database", err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
body, found, err := eventBody(webhookDB, webhook.ID, eventID)
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(w, "failed to read event body", err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// A miss is a 404 whether the event belongs to another
|
||||||
|
// webhook or does not exist at all, so the response does
|
||||||
|
// not report which. Reading the body before any header is
|
||||||
|
// written is also what keeps an event reaped mid-request
|
||||||
|
// from producing a torn response: either the read finds the
|
||||||
|
// row and the whole body is served, or it does not and the
|
||||||
|
// response is a clean 404.
|
||||||
|
if !found {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
setEventBodyHeaders(w, eventID, int64(len(body)))
|
||||||
|
|
||||||
|
_, err = w.Write(body)
|
||||||
|
if err != nil {
|
||||||
|
// The status and Content-Length are already committed,
|
||||||
|
// so the client sees a short download. There is no way
|
||||||
|
// to report a 500 from here; the log is the record.
|
||||||
|
h.log.Error(
|
||||||
|
"failed to write event body",
|
||||||
|
"webhook_id", webhook.ID,
|
||||||
|
"event_id", eventID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// eventBody returns an event's stored body and whether the event
|
||||||
|
// exists within the webhook.
|
||||||
|
func eventBody(
|
||||||
|
webhookDB *gorm.DB,
|
||||||
|
webhookID, eventID string,
|
||||||
|
) ([]byte, bool, error) {
|
||||||
|
var body []byte
|
||||||
|
|
||||||
|
err := webhookDB.Raw(
|
||||||
|
eventBodyQuery, eventID, webhookID,
|
||||||
|
).Row().Scan(&body)
|
||||||
|
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return body, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// setEventBodyHeaders applies the response headers that make
|
||||||
|
// this route safe to hand attacker-supplied bytes through. See
|
||||||
|
// HandleEventBodyDownload for why they are a security control
|
||||||
|
// and not a formatting choice.
|
||||||
|
//
|
||||||
|
// nosniff is also set by the global SecurityHeaders middleware.
|
||||||
|
// It is repeated here so the guarantee belongs to the route
|
||||||
|
// that needs it rather than to a middleware someone could
|
||||||
|
// reorder or scope away.
|
||||||
|
func setEventBodyHeaders(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
eventID string,
|
||||||
|
size int64,
|
||||||
|
) {
|
||||||
|
w.Header().Set("Content-Type", "application/octet-stream")
|
||||||
|
w.Header().Set("X-Content-Type-Options", "nosniff")
|
||||||
|
w.Header().Set(
|
||||||
|
"Content-Disposition",
|
||||||
|
`attachment; filename="webhooker-event-`+eventID+`.bin"`,
|
||||||
|
)
|
||||||
|
w.Header().Set("Content-Length", strconv.FormatInt(size, 10))
|
||||||
|
}
|
||||||
506
internal/handlers/event_body_test.go
Normal file
506
internal/handlers/event_body_test.go
Normal file
@@ -0,0 +1,506 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// paramEventID is the chi URL parameter the body download
|
||||||
|
// handler reads.
|
||||||
|
const paramEventID = "eventID"
|
||||||
|
|
||||||
|
// otherTestUserID owns webhooks the session user must not be
|
||||||
|
// able to read.
|
||||||
|
const otherTestUserID = "other-user-id"
|
||||||
|
|
||||||
|
// seedWebhookFor inserts a webhook owned by the given user.
|
||||||
|
func seedWebhookFor(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
userID string,
|
||||||
|
) *database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: userID,
|
||||||
|
Name: "wh-" + userID,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetchEventBody runs the real download handler as the test user
|
||||||
|
// for the given source and event ids.
|
||||||
|
func fetchEventBody(
|
||||||
|
t *testing.T,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
sess *session.Session,
|
||||||
|
sourceID, eventID string,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
// The path is escaped and the raw id goes in the route
|
||||||
|
// context, which is what chi hands a handler: the param is
|
||||||
|
// already percent-decoded by the time it is read.
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet,
|
||||||
|
"/source/"+url.PathEscape(sourceID)+
|
||||||
|
"/logs/"+url.PathEscape(eventID)+"/body",
|
||||||
|
nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
) {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
rctx.URLParams.Add(paramSourceID, sourceID)
|
||||||
|
rctx.URLParams.Add(paramEventID, eventID)
|
||||||
|
|
||||||
|
req = req.WithContext(
|
||||||
|
context.WithValue(
|
||||||
|
req.Context(), chi.RouteCtxKey, rctx,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
h.HandleEventBodyDownload().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_ServesOversizeBodyInFull is the
|
||||||
|
// capability the render cap took away: a body far above what the
|
||||||
|
// event log page will show comes back whole and byte-identical,
|
||||||
|
// with the headers that keep it from being rendered.
|
||||||
|
func TestHandleEventBodyDownload_ServesOversizeBodyInFull(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
// Far above the render cap, with multibyte runes and a
|
||||||
|
// distinctive tail, so a body that the log page can only
|
||||||
|
// show a slice of comes back whole and in order.
|
||||||
|
const sentinel = "TAIL-SENTINEL-1f4a9c"
|
||||||
|
|
||||||
|
stored := strings.Repeat("A", 200*1024) +
|
||||||
|
strings.Repeat(snowman, 1000) + sentinel
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, wh.ID, stored)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, evt.ID)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Greater(t, len(stored), bodyCap)
|
||||||
|
assert.Equal(t, stored, w.Body.String())
|
||||||
|
assert.Equal(
|
||||||
|
t, strconv.Itoa(len(stored)),
|
||||||
|
w.Header().Get("Content-Length"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_BodiesRoundTripByteIdentical
|
||||||
|
// covers the sizes and byte values a stored body can actually
|
||||||
|
// take: empty, one byte, either side of the render cap, and
|
||||||
|
// bytes that are not text at all. Content-Length has to equal
|
||||||
|
// the bytes written in every case, since it is derived from the
|
||||||
|
// same read that produces them.
|
||||||
|
func TestHandleEventBodyDownload_BodiesRoundTripByteIdentical(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// A NUL, invalid UTF-8 and a multibyte rune, so nothing on
|
||||||
|
// the path can be treating the body as text.
|
||||||
|
binary := "\x00\x01\xff\xfe" + snowman + "\x00tail"
|
||||||
|
|
||||||
|
cases := map[string]string{
|
||||||
|
"empty": "",
|
||||||
|
"single byte": "x",
|
||||||
|
"one below cap": strings.Repeat("b", bodyCap-1),
|
||||||
|
"exactly cap": strings.Repeat("c", bodyCap),
|
||||||
|
"one above cap": strings.Repeat("d", bodyCap+1),
|
||||||
|
"binary": binary,
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, stored := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, wh.ID, stored)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, evt.ID)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Equal(t, stored, w.Body.String())
|
||||||
|
assert.Equal(
|
||||||
|
t, strconv.Itoa(len(stored)),
|
||||||
|
w.Header().Get("Content-Length"),
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, len(stored), w.Body.Len(),
|
||||||
|
"Content-Length must equal bytes written",
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_HeadersAreNotRenderable pins the
|
||||||
|
// response headers that stop attacker-supplied bytes executing
|
||||||
|
// in the operator's own origin. They are a security control, not
|
||||||
|
// presentation.
|
||||||
|
func TestHandleEventBodyDownload_HeadersAreNotRenderable(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, wh.ID, `{"small":true}`)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, evt.ID)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Equal(
|
||||||
|
t, "application/octet-stream",
|
||||||
|
w.Header().Get("Content-Type"),
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "nosniff",
|
||||||
|
w.Header().Get("X-Content-Type-Options"),
|
||||||
|
)
|
||||||
|
|
||||||
|
disposition := w.Header().Get("Content-Disposition")
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
`attachment; filename="webhooker-event-`+evt.ID+`.bin"`,
|
||||||
|
disposition,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_ScriptBodyStaysInert proves a
|
||||||
|
// stored HTML payload is handed back as an attachment of opaque
|
||||||
|
// bytes rather than as anything a browser will execute. The
|
||||||
|
// bytes themselves are unaltered: this route reports what was
|
||||||
|
// delivered.
|
||||||
|
func TestHandleEventBodyDownload_ScriptBodyStaysInert(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
const payload = `<html><script>alert(document.cookie)` +
|
||||||
|
`</script></html>`
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, wh.ID, payload)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, evt.ID)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Equal(t, payload, w.Body.String())
|
||||||
|
|
||||||
|
contentType := w.Header().Get("Content-Type")
|
||||||
|
assert.Equal(t, "application/octet-stream", contentType)
|
||||||
|
assert.NotContains(t, contentType, "html")
|
||||||
|
assert.NotContains(t, contentType, "xml")
|
||||||
|
assert.NotContains(t, contentType, "javascript")
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Header().Get("Content-Disposition"), "attachment",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "nosniff",
|
||||||
|
w.Header().Get("X-Content-Type-Options"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_OtherUsersEvent404s is the
|
||||||
|
// authorization test the definition of done asks for: an event
|
||||||
|
// stored under a webhook the session user does not own is not
|
||||||
|
// readable, and the miss does not distinguish itself from a
|
||||||
|
// nonexistent one.
|
||||||
|
func TestHandleEventBodyDownload_OtherUsersEvent404s(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
const theirPayload = "OTHER-USERS-PAYLOAD-8b1d"
|
||||||
|
|
||||||
|
theirs := seedWebhookFor(t, db, otherTestUserID)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, theirs.ID, theirPayload)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, theirs.ID, evt.ID)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusNotFound, w.Code)
|
||||||
|
assert.NotContains(t, w.Body.String(), theirPayload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_EventOfAnotherWebhook404s pins
|
||||||
|
// that holding a valid event id is not enough: the event has to
|
||||||
|
// belong to the webhook in the path. Both webhooks here are the
|
||||||
|
// session user's and both have event databases, so the
|
||||||
|
// ownership check cannot be what produces the 404.
|
||||||
|
//
|
||||||
|
// What does produce it is the per-webhook database file rather
|
||||||
|
// than the webhook_id predicate on the query — removing that
|
||||||
|
// predicate leaves this test green, because the sibling's event
|
||||||
|
// is in a different file. The test is kept as the behavioural
|
||||||
|
// guard the route owes; see serveEventBody for which mechanism
|
||||||
|
// is load-bearing.
|
||||||
|
func TestHandleEventBodyDownload_EventOfAnotherWebhook404s(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
const other = "BELONGS-TO-THE-OTHER-WEBHOOK-3c7e"
|
||||||
|
|
||||||
|
mine := seedWebhook(t, db)
|
||||||
|
seedEventWithBody(t, dbMgr, mine.ID, `{"mine":true}`)
|
||||||
|
|
||||||
|
sibling := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, sibling.ID, other)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, mine.ID, evt.ID)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusNotFound, w.Code)
|
||||||
|
assert.NotContains(t, w.Body.String(), other)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_UnknownEvent404s covers the plain
|
||||||
|
// miss, including an id that is not a uuid at all and so never
|
||||||
|
// reaches the query or the response header.
|
||||||
|
func TestHandleEventBodyDownload_UnknownEvent404s(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedEventWithBody(t, dbMgr, wh.ID, `{"mine":true}`)
|
||||||
|
|
||||||
|
for _, id := range []string{
|
||||||
|
uuid.New().String(),
|
||||||
|
`../../etc/passwd`,
|
||||||
|
"not-a-uuid",
|
||||||
|
`x"; rm -rf /`,
|
||||||
|
} {
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, id)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusNotFound, w.Code,
|
||||||
|
"event id %q", id,
|
||||||
|
)
|
||||||
|
assert.Empty(
|
||||||
|
t, w.Header().Get("Content-Disposition"),
|
||||||
|
"event id %q must not reach a header", id,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleEventBodyDownload_ReapedEvent404s pins what happens
|
||||||
|
// when the retention reaper takes an event out from under this
|
||||||
|
// route. The body is read in one query before any header is
|
||||||
|
// written, so a reaped event cannot produce a partial download:
|
||||||
|
// it is a clean 404 with no Content-Length and no
|
||||||
|
// Content-Disposition. Both removals the codebase performs are
|
||||||
|
// covered — the reaper hard-deletes, and a soft-deleted row is
|
||||||
|
// excluded by the query's own deleted_at predicate rather than
|
||||||
|
// by GORM's default scope, which Raw bypasses.
|
||||||
|
func TestHandleEventBodyDownload_ReapedEvent404s(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for name, hard := range map[string]bool{
|
||||||
|
"soft deleted": false,
|
||||||
|
"hard deleted": true,
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
const payload = "REAPED-PAYLOAD-4d2a"
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
evt := seedEventWithBody(t, dbMgr, wh.ID, payload)
|
||||||
|
|
||||||
|
webhookDB, err := dbMgr.GetDB(wh.ID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
del := webhookDB
|
||||||
|
if hard {
|
||||||
|
del = del.Unscoped()
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
del.Delete(&database.Event{}, "id = ?", evt.ID).
|
||||||
|
Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
w := fetchEventBody(t, h, sess, wh.ID, evt.ID)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusNotFound, w.Code)
|
||||||
|
assert.NotContains(t, w.Body.String(), payload)
|
||||||
|
assert.Empty(t, w.Header().Get("Content-Length"))
|
||||||
|
assert.Empty(
|
||||||
|
t, w.Header().Get("Content-Disposition"),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceLogs_TruncationMarkerLinksToDownload proves
|
||||||
|
// the page tells the reader where the rest of the body is, and
|
||||||
|
// only when there is a rest to fetch.
|
||||||
|
func TestHandleSourceLogs_TruncationMarkerLinksToDownload(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
big := seedWebhook(t, db)
|
||||||
|
bigEvt := seedEventWithBody(
|
||||||
|
t, dbMgr, big.ID, strings.Repeat("A", 4*bodyCap),
|
||||||
|
)
|
||||||
|
|
||||||
|
page := renderSourceLogsPage(t, h, sess, big.ID)
|
||||||
|
assert.Contains(
|
||||||
|
t, page,
|
||||||
|
"/source/"+big.ID+"/logs/"+bigEvt.ID+"/body",
|
||||||
|
)
|
||||||
|
|
||||||
|
small := seedWebhook(t, db)
|
||||||
|
smallEvt := seedEventWithBody(
|
||||||
|
t, dbMgr, small.ID, `{"kept":"whole"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
page = renderSourceLogsPage(t, h, sess, small.ID)
|
||||||
|
assert.NotContains(
|
||||||
|
t, page,
|
||||||
|
"/source/"+small.ID+"/logs/"+smallEvt.ID+"/body",
|
||||||
|
)
|
||||||
|
}
|
||||||
120
internal/handlers/event_log_view.go
Normal file
120
internal/handlers/event_log_view.go
Normal file
@@ -0,0 +1,120 @@
|
|||||||
|
package handlers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// maxRenderedBodyBytes caps how many bytes of a stored event
|
||||||
|
// body reach the event log page. Bodies come from the
|
||||||
|
// unauthenticated receiver under the 1 MB ingest cap and
|
||||||
|
// renderTemplate buffers a whole page before writing it, so
|
||||||
|
// an uncapped page of paginationPerPage events is tens of
|
||||||
|
// megabytes of resident memory per concurrent viewer.
|
||||||
|
const maxRenderedBodyBytes = 8192
|
||||||
|
|
||||||
|
// eventLogColumns is the event log's projection. The casts to
|
||||||
|
// blob are load-bearing: they make substr and length count
|
||||||
|
// bytes rather than characters, so the cap bounds the page in
|
||||||
|
// bytes whatever the payload's encoding. Cutting in SQLite
|
||||||
|
// rather than in Go is the point of the projection — an
|
||||||
|
// oversized body never becomes a Go string at all.
|
||||||
|
const eventLogColumns = "id, created_at, method, content_type, " +
|
||||||
|
"substr(cast(body as blob), 1, ?) AS body, " +
|
||||||
|
"length(cast(body as blob)) AS body_bytes"
|
||||||
|
|
||||||
|
// EventLogView is the display-safe projection of an event for
|
||||||
|
// the event log page, alongside DeliveryView and TargetView.
|
||||||
|
// It carries a capped body plus the true stored size, so the
|
||||||
|
// page can mark a body as truncated without ever holding the
|
||||||
|
// whole thing.
|
||||||
|
type EventLogView struct {
|
||||||
|
ID string
|
||||||
|
CreatedAt time.Time
|
||||||
|
Method string
|
||||||
|
ContentType string
|
||||||
|
|
||||||
|
// Body holds at most maxRenderedBodyBytes bytes of the
|
||||||
|
// stored body.
|
||||||
|
Body string
|
||||||
|
|
||||||
|
// BodyBytes is the true size of the stored body.
|
||||||
|
BodyBytes int64
|
||||||
|
|
||||||
|
// BodyTruncated reports that the stored body was larger
|
||||||
|
// than the cap, so the page owes the reader a marker.
|
||||||
|
BodyTruncated bool
|
||||||
|
|
||||||
|
Deliveries []DeliveryView
|
||||||
|
}
|
||||||
|
|
||||||
|
// BodyShownBytes is how many body bytes the page is actually
|
||||||
|
// rendering, which the truncation marker reports beside the
|
||||||
|
// true size.
|
||||||
|
func (v EventLogView) BodyShownBytes() int {
|
||||||
|
return len(v.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// eventLogRow is one row of the event log projection. Its
|
||||||
|
// body column arrives already cut to the cap by SQLite, with
|
||||||
|
// the true size beside it.
|
||||||
|
type eventLogRow struct {
|
||||||
|
ID string
|
||||||
|
CreatedAt time.Time
|
||||||
|
Method string
|
||||||
|
ContentType string
|
||||||
|
Body []byte
|
||||||
|
BodyBytes int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// view projects a loaded row for rendering.
|
||||||
|
func (r *eventLogRow) view() EventLogView {
|
||||||
|
body := r.Body
|
||||||
|
truncated := r.BodyBytes > int64(len(body))
|
||||||
|
|
||||||
|
// Only a cut body can have been left mid-sequence by
|
||||||
|
// this query. A whole body is passed through exactly as
|
||||||
|
// stored, however malformed.
|
||||||
|
if truncated {
|
||||||
|
body = trimPartialRune(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
return EventLogView{
|
||||||
|
ID: r.ID,
|
||||||
|
CreatedAt: r.CreatedAt,
|
||||||
|
Method: r.Method,
|
||||||
|
ContentType: r.ContentType,
|
||||||
|
Body: string(body),
|
||||||
|
BodyBytes: r.BodyBytes,
|
||||||
|
BodyTruncated: truncated,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// trimPartialRune drops a trailing UTF-8 sequence that the
|
||||||
|
// byte-wise cut left incomplete, so a multi-byte rune severed
|
||||||
|
// at the cap does not surface as a mojibake tail.
|
||||||
|
//
|
||||||
|
// Bytes that are merely invalid UTF-8 are left exactly as
|
||||||
|
// stored: this service receives binary payloads, and rewriting
|
||||||
|
// them would misreport what was delivered. The distinction is
|
||||||
|
// utf8.FullRune's — it reports a complete sequence for an
|
||||||
|
// invalid encoding too, since that decodes to a width-1 error
|
||||||
|
// rune, so only a valid prefix still waiting for its
|
||||||
|
// continuation bytes is removed. A tail with no rune start in
|
||||||
|
// its last utf8.UTFMax bytes cannot be an incomplete sequence
|
||||||
|
// either, and is likewise left alone.
|
||||||
|
func trimPartialRune(b []byte) []byte {
|
||||||
|
for i := len(b) - 1; i >= 0 && len(b)-i <= utf8.UTFMax; i-- {
|
||||||
|
if !utf8.RuneStart(b[i]) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if utf8.FullRune(b[i:]) {
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
return b[:i]
|
||||||
|
}
|
||||||
|
|
||||||
|
return b
|
||||||
|
}
|
||||||
261
internal/handlers/event_log_view_test.go
Normal file
261
internal/handlers/event_log_view_test.go
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"unicode/utf8"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// bodyCap is the number of body bytes the event log page is
|
||||||
|
// allowed to render for one event.
|
||||||
|
const bodyCap = handlers.MaxRenderedBodyBytesForTest
|
||||||
|
|
||||||
|
// snowman is a three-byte rune, so a body of them straddles the
|
||||||
|
// byte-wise cut: bodyCap is not a multiple of three.
|
||||||
|
const snowman = "☃"
|
||||||
|
|
||||||
|
// seedEventWithBody records one event with the given body in the
|
||||||
|
// webhook's own database and returns it, so a caller that needs
|
||||||
|
// the generated event id can have it.
|
||||||
|
func seedEventWithBody(
|
||||||
|
t *testing.T,
|
||||||
|
dbMgr *database.WebhookDBManager,
|
||||||
|
webhookID string,
|
||||||
|
body string,
|
||||||
|
) *database.Event {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
webhookDB, err := dbMgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
event := &database.Event{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: body,
|
||||||
|
ContentType: "application/octet-stream",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.Omit(
|
||||||
|
clause.Associations,
|
||||||
|
).Create(event).Error)
|
||||||
|
|
||||||
|
return event
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedAndProject stores one body and returns the projection the
|
||||||
|
// event log page would be handed for it.
|
||||||
|
func seedAndProject(
|
||||||
|
t *testing.T,
|
||||||
|
body string,
|
||||||
|
) handlers.EventLogView {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedEventWithBody(t, dbMgr, wh.ID, body)
|
||||||
|
|
||||||
|
views := h.LoadEventLogViewsForTest(
|
||||||
|
httptest.NewRecorder(), *wh, 1,
|
||||||
|
)
|
||||||
|
require.Len(t, views, 1)
|
||||||
|
|
||||||
|
return views[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceLogs_BoundsOversizeBody proves the rendered
|
||||||
|
// page is bounded by the cap rather than by the stored payload:
|
||||||
|
// the body here is 64 times the cap, and the ingest path would
|
||||||
|
// accept twice as much again.
|
||||||
|
func TestHandleSourceLogs_BoundsOversizeBody(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
const (
|
||||||
|
sentinel = "TAIL-SENTINEL-1f4a9c"
|
||||||
|
storedBytes = 512 * 1024
|
||||||
|
)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedEventWithBody(
|
||||||
|
t, dbMgr, wh.ID,
|
||||||
|
strings.Repeat("A", storedBytes-len(sentinel))+sentinel,
|
||||||
|
)
|
||||||
|
|
||||||
|
page := renderSourceLogsPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
// Nothing past the cap reaches the page, and the whole page
|
||||||
|
// stays far below the stored body it is reporting on.
|
||||||
|
assert.NotContains(t, page, sentinel)
|
||||||
|
assert.Less(t, len(page), 4*bodyCap)
|
||||||
|
|
||||||
|
// The marker states the true stored size, not the cut one.
|
||||||
|
assert.Contains(
|
||||||
|
t, page,
|
||||||
|
"showing "+strconv.Itoa(bodyCap)+
|
||||||
|
" of "+strconv.Itoa(storedBytes)+" bytes",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceLogs_SmallBodyRendersWhole guards the other
|
||||||
|
// side of the cap: a body under it is shown in full and carries
|
||||||
|
// no truncation marker.
|
||||||
|
func TestHandleSourceLogs_SmallBodyRendersWhole(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedEventWithBody(t, dbMgr, wh.ID, `{"kept":"whole"}`)
|
||||||
|
|
||||||
|
page := renderSourceLogsPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
assert.Contains(t, page, ""kept"")
|
||||||
|
assert.NotContains(t, page, "Body truncated for display")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEventLogView_CutMidRune proves a multi-byte rune severed
|
||||||
|
// by the byte-wise cut is dropped rather than surfaced as a
|
||||||
|
// mojibake tail.
|
||||||
|
func TestEventLogView_CutMidRune(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
body := strings.Repeat(snowman, 4096)
|
||||||
|
view := seedAndProject(t, body)
|
||||||
|
|
||||||
|
// bodyCap bytes hold bodyCap/3 whole snowmen and two bytes
|
||||||
|
// of the next one; those two are dropped.
|
||||||
|
whole := bodyCap / len(snowman)
|
||||||
|
|
||||||
|
assert.True(t, view.BodyTruncated)
|
||||||
|
assert.Equal(t, int64(len(body)), view.BodyBytes)
|
||||||
|
assert.Equal(t, strings.Repeat(snowman, whole), view.Body)
|
||||||
|
assert.True(t, utf8.ValidString(view.Body))
|
||||||
|
assert.LessOrEqual(t, len(view.Body), bodyCap)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEventLogView_BinaryBodyLeftAsStored proves a binary
|
||||||
|
// payload is passed through byte for byte. Its tail is invalid
|
||||||
|
// UTF-8 however the cut falls, so repairing it would misreport
|
||||||
|
// what the sender delivered.
|
||||||
|
func TestEventLogView_BinaryBodyLeftAsStored(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
raw := make([]byte, bodyCap+808)
|
||||||
|
for i := range raw {
|
||||||
|
// 0x80..0xBF: continuation bytes, never a rune start.
|
||||||
|
raw[i] = 0x80 | byte(i%0x40)
|
||||||
|
}
|
||||||
|
|
||||||
|
view := seedAndProject(t, string(raw))
|
||||||
|
|
||||||
|
assert.True(t, view.BodyTruncated)
|
||||||
|
assert.Equal(t, int64(len(raw)), view.BodyBytes)
|
||||||
|
assert.Equal(t, string(raw[:bodyCap]), view.Body)
|
||||||
|
assert.False(t, utf8.ValidString(view.Body))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTrimPartialRune covers the distinction the cut repair
|
||||||
|
// turns on: an incomplete but valid sequence is dropped, while
|
||||||
|
// bytes that are merely invalid UTF-8 are left alone.
|
||||||
|
func TestTrimPartialRune(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
in []byte
|
||||||
|
want []byte
|
||||||
|
}{{
|
||||||
|
name: "complete ascii",
|
||||||
|
in: []byte("abc"),
|
||||||
|
want: []byte("abc"),
|
||||||
|
}, {
|
||||||
|
name: "complete multibyte",
|
||||||
|
in: []byte("ab" + snowman),
|
||||||
|
want: []byte("ab" + snowman),
|
||||||
|
}, {
|
||||||
|
name: "two byte rune cut",
|
||||||
|
in: []byte{'a', 0xC3},
|
||||||
|
want: []byte{'a'},
|
||||||
|
}, {
|
||||||
|
name: "three byte rune cut after one",
|
||||||
|
in: []byte{'a', 0xE2},
|
||||||
|
want: []byte{'a'},
|
||||||
|
}, {
|
||||||
|
name: "three byte rune cut after two",
|
||||||
|
in: []byte{'a', 0xE2, 0x98},
|
||||||
|
want: []byte{'a'},
|
||||||
|
}, {
|
||||||
|
name: "four byte rune cut",
|
||||||
|
in: []byte{'a', 0xF0, 0x9F, 0x92}, // U+1F4A9 cut
|
||||||
|
want: []byte{'a'},
|
||||||
|
}, {
|
||||||
|
name: "invalid start byte kept",
|
||||||
|
in: []byte{'a', 0xFF},
|
||||||
|
want: []byte{'a', 0xFF},
|
||||||
|
}, {
|
||||||
|
name: "orphan continuation bytes kept",
|
||||||
|
in: []byte{0x80, 0x81, 0x82, 0x83, 0x84},
|
||||||
|
want: []byte{0x80, 0x81, 0x82, 0x83, 0x84},
|
||||||
|
}, {
|
||||||
|
name: "truncated sequence followed by junk kept",
|
||||||
|
in: []byte{0xE2, 0x98, 0xFF},
|
||||||
|
want: []byte{0xE2, 0x98, 0xFF},
|
||||||
|
}, {
|
||||||
|
name: "empty",
|
||||||
|
in: []byte{},
|
||||||
|
want: []byte{},
|
||||||
|
}}
|
||||||
|
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, tc.want,
|
||||||
|
handlers.TrimPartialRuneForTest(tc.in),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,46 @@
|
|||||||
package handlers
|
package handlers
|
||||||
|
|
||||||
import "net/http"
|
import (
|
||||||
|
"html/template"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MaxRenderedBodyBytesForTest exposes the event log's body cap
|
||||||
|
// to the handlers_test package.
|
||||||
|
const MaxRenderedBodyBytesForTest = maxRenderedBodyBytes
|
||||||
|
|
||||||
|
// TrimPartialRuneForTest exposes trimPartialRune for use in the
|
||||||
|
// handlers_test package.
|
||||||
|
func TrimPartialRuneForTest(b []byte) []byte {
|
||||||
|
return trimPartialRune(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadEventLogViewsForTest exposes loadEventsWithDeliveries for
|
||||||
|
// use in the handlers_test package. Assertions on the projected
|
||||||
|
// body need the bytes as loaded: html/template rewrites invalid
|
||||||
|
// UTF-8 on the way out, so the rendered page cannot show whether
|
||||||
|
// a binary body survived the projection intact.
|
||||||
|
func (s *Handlers) LoadEventLogViewsForTest(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
webhook database.Webhook,
|
||||||
|
page int,
|
||||||
|
) []EventLogView {
|
||||||
|
views, _ := s.loadEventsWithDeliveries(w, webhook, nil, page)
|
||||||
|
|
||||||
|
return views
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddTemplateForTest registers a template under a page name so that
|
||||||
|
// the handlers_test package can drive the render path with a
|
||||||
|
// template of its own.
|
||||||
|
func (s *Handlers) AddTemplateForTest(
|
||||||
|
pageTemplate string,
|
||||||
|
tmpl *template.Template,
|
||||||
|
) {
|
||||||
|
s.templates[pageTemplate] = tmpl
|
||||||
|
}
|
||||||
|
|
||||||
// RenderTemplateForTest exposes renderTemplate for use in the
|
// RenderTemplateForTest exposes renderTemplate for use in the
|
||||||
// handlers_test package.
|
// handlers_test package.
|
||||||
@@ -13,12 +53,26 @@ func (s *Handlers) RenderTemplateForTest(
|
|||||||
s.renderTemplate(w, r, pageTemplate, data)
|
s.renderTemplate(w, r, pageTemplate, data)
|
||||||
}
|
}
|
||||||
|
|
||||||
// BuildSlackTargetConfigForTest exposes buildSlackTargetConfig
|
// BuildSlackTargetConfigForTest exposes buildURLTargetConfig
|
||||||
// for use in the handlers_test package.
|
// with the Slack target parameters for use in the
|
||||||
|
// handlers_test package.
|
||||||
func (s *Handlers) BuildSlackTargetConfigForTest(
|
func (s *Handlers) BuildSlackTargetConfigForTest(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
targetURL string,
|
targetURL string,
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
return s.buildSlackTargetConfig(w, r, targetURL)
|
return s.buildURLTargetConfig(
|
||||||
|
w, r, targetURL, "webhookUrl",
|
||||||
|
"Webhook URL is required for Slack targets",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildDatabaseTargetConfigForTest exposes
|
||||||
|
// buildDatabaseTargetConfig for use in the handlers_test
|
||||||
|
// package.
|
||||||
|
func (s *Handlers) BuildDatabaseTargetConfigForTest(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
expiry string,
|
||||||
|
) (string, error) {
|
||||||
|
return s.buildDatabaseTargetConfig(w, expiry)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
package handlers
|
package handlers
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
@@ -26,10 +27,13 @@ const (
|
|||||||
maxBodyShift = 20
|
maxBodyShift = 20
|
||||||
// recentEventLimit is the number of recent events to show.
|
// recentEventLimit is the number of recent events to show.
|
||||||
recentEventLimit = 20
|
recentEventLimit = 20
|
||||||
// defaultRetentionDays is the default event retention period.
|
|
||||||
defaultRetentionDays = 30
|
|
||||||
// paginationPerPage is the number of items per page.
|
// paginationPerPage is the number of items per page.
|
||||||
paginationPerPage = 25
|
paginationPerPage = 25
|
||||||
|
|
||||||
|
// tmplKeyError is the template data key for an error message.
|
||||||
|
tmplKeyError = "Error"
|
||||||
|
// tmplKeyWebhook is the template data key for a webhook.
|
||||||
|
tmplKeyWebhook = "Webhook"
|
||||||
)
|
)
|
||||||
|
|
||||||
// errInvalidPassword is returned when a password does not match.
|
// errInvalidPassword is returned when a password does not match.
|
||||||
@@ -46,6 +50,7 @@ type HandlersParams struct {
|
|||||||
Healthcheck *healthcheck.Healthcheck
|
Healthcheck *healthcheck.Healthcheck
|
||||||
Session *session.Session
|
Session *session.Session
|
||||||
Notifier delivery.Notifier
|
Notifier delivery.Notifier
|
||||||
|
Evictor delivery.WebhookEvictor
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handlers provides HTTP handler methods for all application
|
// Handlers provides HTTP handler methods for all application
|
||||||
@@ -58,6 +63,7 @@ type Handlers struct {
|
|||||||
dbMgr *database.WebhookDBManager
|
dbMgr *database.WebhookDBManager
|
||||||
session *session.Session
|
session *session.Session
|
||||||
notifier delivery.Notifier
|
notifier delivery.Notifier
|
||||||
|
evictor delivery.WebhookEvictor
|
||||||
templates map[string]*template.Template
|
templates map[string]*template.Template
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,6 +98,7 @@ func New(
|
|||||||
s.dbMgr = params.WebhookDBMgr
|
s.dbMgr = params.WebhookDBMgr
|
||||||
s.session = params.Session
|
s.session = params.Session
|
||||||
s.notifier = params.Notifier
|
s.notifier = params.Notifier
|
||||||
|
s.evictor = params.Evictor
|
||||||
|
|
||||||
// Parse all page templates once at startup
|
// Parse all page templates once at startup
|
||||||
s.templates = map[string]*template.Template{
|
s.templates = map[string]*template.Template{
|
||||||
@@ -218,13 +225,22 @@ func (s *Handlers) renderTemplate(
|
|||||||
s.executeTemplate(w, tmpl, wrapper)
|
s.executeTemplate(w, tmpl, wrapper)
|
||||||
}
|
}
|
||||||
|
|
||||||
// executeTemplate runs the template and handles errors.
|
// executeTemplate renders the template into a buffer and writes to
|
||||||
|
// the response only once rendering has fully succeeded. Executing
|
||||||
|
// straight into the ResponseWriter commits a partial body and a 200
|
||||||
|
// status before a mid-render error can be reported, leaving no way
|
||||||
|
// to serve a 500. Buffering makes a page's rendered size resident
|
||||||
|
// memory per concurrent viewer, so every page owes it a bound: the
|
||||||
|
// event log caps each stored body at maxRenderedBodyBytes for exactly
|
||||||
|
// this reason.
|
||||||
func (s *Handlers) executeTemplate(
|
func (s *Handlers) executeTemplate(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
tmpl *template.Template,
|
tmpl *template.Template,
|
||||||
data any,
|
data any,
|
||||||
) {
|
) {
|
||||||
err := tmpl.Execute(w, data)
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
err := tmpl.Execute(&buf, data)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.log.Error(
|
s.log.Error(
|
||||||
"failed to execute template", "error", err,
|
"failed to execute template", "error", err,
|
||||||
@@ -233,5 +249,16 @@ func (s *Handlers) executeTemplate(
|
|||||||
w, "Internal server error",
|
w, "Internal server error",
|
||||||
http.StatusInternalServerError,
|
http.StatusInternalServerError,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||||
|
|
||||||
|
_, err = buf.WriteTo(w)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"failed to write rendered page", "error", err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,8 +2,11 @@ package handlers_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
|
"html/template"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -24,6 +27,32 @@ type noopNotifier struct{}
|
|||||||
|
|
||||||
func (n *noopNotifier) Notify([]delivery.Task) {}
|
func (n *noopNotifier) Notify([]delivery.Task) {}
|
||||||
|
|
||||||
|
// recordingEvictor is a delivery.WebhookEvictor that records
|
||||||
|
// the webhook ids it was asked to evict, so a test can prove
|
||||||
|
// that a deletion path reached the delivery engine.
|
||||||
|
type recordingEvictor struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
evicted []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recordingEvictor) EvictWebhook(webhookID string) {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
r.evicted = append(r.evicted, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Evicted returns a copy of the recorded webhook ids.
|
||||||
|
func (r *recordingEvictor) Evicted() []string {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
out := make([]string, len(r.evicted))
|
||||||
|
copy(out, r.evicted)
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func newTestApp(
|
func newTestApp(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
targets ...any,
|
targets ...any,
|
||||||
@@ -47,6 +76,12 @@ func newTestApp(
|
|||||||
func() delivery.Notifier {
|
func() delivery.Notifier {
|
||||||
return &noopNotifier{}
|
return &noopNotifier{}
|
||||||
},
|
},
|
||||||
|
func() *recordingEvictor {
|
||||||
|
return &recordingEvictor{}
|
||||||
|
},
|
||||||
|
func(r *recordingEvictor) delivery.WebhookEvictor {
|
||||||
|
return r
|
||||||
|
},
|
||||||
handlers.New,
|
handlers.New,
|
||||||
),
|
),
|
||||||
fx.Populate(targets...),
|
fx.Populate(targets...),
|
||||||
@@ -186,3 +221,119 @@ func TestRenderTemplate(t *testing.T) {
|
|||||||
t, http.StatusInternalServerError, w.Code,
|
t, http.StatusInternalServerError, w.Code,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// errMidRender is the failure a test template raises partway through
|
||||||
|
// rendering.
|
||||||
|
var errMidRender = errors.New("deliberate mid-render failure")
|
||||||
|
|
||||||
|
// midRenderFailure is template data whose first method renders and
|
||||||
|
// whose second fails, so the template aborts after output has
|
||||||
|
// already been produced.
|
||||||
|
type midRenderFailure struct{}
|
||||||
|
|
||||||
|
// Prefix is the output a streaming renderer would flush before the
|
||||||
|
// failure below aborts the template.
|
||||||
|
func (midRenderFailure) Prefix() string { return partialPageMarker }
|
||||||
|
|
||||||
|
// Boom aborts template execution.
|
||||||
|
func (midRenderFailure) Boom() (string, error) {
|
||||||
|
return "", errMidRender
|
||||||
|
}
|
||||||
|
|
||||||
|
// partialPageMarker is content the failing template emits before it
|
||||||
|
// aborts.
|
||||||
|
const partialPageMarker = "PARTIAL PAGE CONTENT"
|
||||||
|
|
||||||
|
// TestRenderTemplateMidRenderErrorSendsNoPartialBody proves the
|
||||||
|
// renderer does not commit output it cannot finish: a template that
|
||||||
|
// fails partway through must yield a 500 and a body carrying none of
|
||||||
|
// the content emitted before the failure. Against a renderer that
|
||||||
|
// executes straight into the ResponseWriter this fails on both
|
||||||
|
// counts, returning 200 with the prefix already flushed.
|
||||||
|
func TestRenderTemplateMidRenderErrorSendsNoPartialBody(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
app := newTestApp(t, &h)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
h.AddTemplateForTest("failing.html", template.Must(
|
||||||
|
template.New("failing").Parse(
|
||||||
|
`{{.Data.Prefix}}{{.Data.Boom}}TAIL`,
|
||||||
|
),
|
||||||
|
))
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.RenderTemplateForTest(
|
||||||
|
w, req, "failing.html", midRenderFailure{},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusInternalServerError, w.Code,
|
||||||
|
"a failed render must report a 500",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "Internal server error\n", w.Body.String(),
|
||||||
|
"the response must carry no part of the aborted page",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildDatabaseTargetConfig_Valid(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
app := newTestApp(t, &h)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
// Empty expiry: the keep-forever default, empty config.
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
cfg, err := h.BuildDatabaseTargetConfigForTest(w, "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Empty(t, cfg)
|
||||||
|
|
||||||
|
// Explicit never is stored as config.
|
||||||
|
w = httptest.NewRecorder()
|
||||||
|
cfg, err = h.BuildDatabaseTargetConfigForTest(w, "never")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.JSONEq(t, `{"expiry":"never"}`, cfg)
|
||||||
|
|
||||||
|
// A positive duration is stored as config.
|
||||||
|
w = httptest.NewRecorder()
|
||||||
|
cfg, err = h.BuildDatabaseTargetConfigForTest(w, "720h")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.JSONEq(t, `{"expiry":"720h"}`, cfg)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildDatabaseTargetConfig_RejectsBadExpiry(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
app := newTestApp(t, &h)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
for _, bad := range []string{"nonsense", "7d", "-5h"} {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
cfg, err := h.BuildDatabaseTargetConfigForTest(w, bad)
|
||||||
|
|
||||||
|
require.Error(t, err, "expiry %q", bad)
|
||||||
|
assert.Empty(t, cfg)
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusBadRequest, w.Code,
|
||||||
|
"expiry %q should be rejected with 400", bad,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,63 +4,201 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
"github.com/go-chi/chi"
|
"github.com/go-chi/chi"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
)
|
)
|
||||||
|
|
||||||
// HandleProfile returns a handler for the user profile page
|
// HandleProfile returns a handler for the user profile page
|
||||||
func (h *Handlers) HandleProfile() http.HandlerFunc {
|
func (h *Handlers) HandleProfile() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
// Get username from URL
|
sessionUserID, sessionUsername, ok :=
|
||||||
|
h.profileOwnerOrDeny(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.renderProfile(w, r, sessionUserID, sessionUsername, "", "")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandlePasswordChange returns a handler that lets an authenticated
|
||||||
|
// user change their own password. It is served by the CSRF- and
|
||||||
|
// auth-protected POST /password route under /user/{username}.
|
||||||
|
func (h *Handlers) HandlePasswordChange() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
sessionUserID, sessionUsername, ok :=
|
||||||
|
h.profileOwnerOrDeny(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// The body size cap is enforced by the MaxBodySize
|
||||||
|
// middleware, which runs before CSRF parses the form.
|
||||||
|
err := r.ParseForm()
|
||||||
|
if err != nil {
|
||||||
|
h.log.Error("failed to parse form", "error", err)
|
||||||
|
http.Error(w, "Bad request", http.StatusBadRequest)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
successMessage, errorMessage, handled := h.applyPasswordChange(
|
||||||
|
w,
|
||||||
|
sessionUsername,
|
||||||
|
r.FormValue("current_password"),
|
||||||
|
r.FormValue("new_password"),
|
||||||
|
r.FormValue("confirm_password"),
|
||||||
|
)
|
||||||
|
if !handled {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.renderProfile(
|
||||||
|
w, r, sessionUserID, sessionUsername,
|
||||||
|
successMessage, errorMessage,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// applyPasswordChange verifies the current password and, on success,
|
||||||
|
// persists a fresh hash for the user, reusing the same helpers that
|
||||||
|
// bootstrap the admin user. It returns the success and error messages
|
||||||
|
// to display on the profile page. On an internal failure it writes a
|
||||||
|
// 500 response itself and returns handled=false, signalling the caller
|
||||||
|
// to stop without re-rendering the page.
|
||||||
|
func (h *Handlers) applyPasswordChange(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
username, currentPassword, newPassword, confirmPassword string,
|
||||||
|
) (string, string, bool) {
|
||||||
|
// Load the user row so we can verify the current password and
|
||||||
|
// persist the new hash.
|
||||||
|
var user database.User
|
||||||
|
|
||||||
|
err := h.db.DB().Where(
|
||||||
|
"username = ?", username,
|
||||||
|
).First(&user).Error
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(
|
||||||
|
w, "failed to load user for password change", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
valid, err := database.VerifyPassword(
|
||||||
|
currentPassword, user.Password,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(w, "failed to verify password", err)
|
||||||
|
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
if !valid {
|
||||||
|
return "", "Current password is incorrect.", true
|
||||||
|
}
|
||||||
|
|
||||||
|
if newPassword == "" {
|
||||||
|
return "", "New password must not be empty.", true
|
||||||
|
}
|
||||||
|
|
||||||
|
if newPassword != confirmPassword {
|
||||||
|
return "", "New password and confirmation do not match.", true
|
||||||
|
}
|
||||||
|
|
||||||
|
hashedPassword, err := database.HashPassword(newPassword)
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(w, "failed to hash new password", err)
|
||||||
|
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
err = h.db.DB().Model(&user).Update(
|
||||||
|
"password", hashedPassword,
|
||||||
|
).Error
|
||||||
|
if err != nil {
|
||||||
|
h.serverError(w, "failed to update password", err)
|
||||||
|
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
h.log.Info("user changed password", "username", username)
|
||||||
|
|
||||||
|
return "Password changed successfully.", "", true
|
||||||
|
}
|
||||||
|
|
||||||
|
// profileOwnerOrDeny resolves the session identity and enforces that a
|
||||||
|
// user may only act on their own profile (the requested username in the
|
||||||
|
// URL must equal the session username). On any failure it writes the
|
||||||
|
// appropriate HTTP response and returns ok=false; callers must stop
|
||||||
|
// when ok is false.
|
||||||
|
func (h *Handlers) profileOwnerOrDeny(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
r *http.Request,
|
||||||
|
) (string, string, bool) {
|
||||||
requestedUsername := chi.URLParam(r, "username")
|
requestedUsername := chi.URLParam(r, "username")
|
||||||
if requestedUsername == "" {
|
if requestedUsername == "" {
|
||||||
http.NotFound(w, r)
|
http.NotFound(w, r)
|
||||||
|
|
||||||
return
|
return "", "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get session. RequireAuth middleware guarantees an
|
// RequireAuth middleware guarantees an authenticated session
|
||||||
// authenticated session before this handler runs, so we
|
// before this handler runs, so we only need to guard against an
|
||||||
// only need to guard against an unexpected retrieval error.
|
// unexpected retrieval error.
|
||||||
sess, err := h.session.Get(r)
|
sess, err := h.session.Get(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.log.Error("failed to get session", "error", err)
|
h.serverError(w, "failed to get session", err)
|
||||||
http.Error(w, "Internal server error", http.StatusInternalServerError)
|
|
||||||
|
|
||||||
return
|
return "", "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get user info from session
|
|
||||||
sessionUsername, ok := h.session.GetUsername(sess)
|
sessionUsername, ok := h.session.GetUsername(sess)
|
||||||
if !ok {
|
if !ok {
|
||||||
h.log.Error("authenticated session missing username")
|
h.log.Error("authenticated session missing username")
|
||||||
http.Error(w, "Internal server error", http.StatusInternalServerError)
|
http.Error(
|
||||||
|
w, "Internal server error",
|
||||||
|
http.StatusInternalServerError,
|
||||||
|
)
|
||||||
|
|
||||||
return
|
return "", "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
sessionUserID, ok := h.session.GetUserID(sess)
|
sessionUserID, ok := h.session.GetUserID(sess)
|
||||||
if !ok {
|
if !ok {
|
||||||
h.log.Error("authenticated session missing user ID")
|
h.log.Error("authenticated session missing user ID")
|
||||||
http.Error(w, "Internal server error", http.StatusInternalServerError)
|
http.Error(
|
||||||
|
w, "Internal server error",
|
||||||
|
http.StatusInternalServerError,
|
||||||
|
)
|
||||||
|
|
||||||
return
|
return "", "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
// For now, only allow users to view their own profile
|
// Only allow users to act on their own profile.
|
||||||
if requestedUsername != sessionUsername {
|
if requestedUsername != sessionUsername {
|
||||||
http.Error(w, "Forbidden", http.StatusForbidden)
|
http.Error(w, "Forbidden", http.StatusForbidden)
|
||||||
|
|
||||||
return
|
return "", "", false
|
||||||
}
|
}
|
||||||
|
|
||||||
// Prepare data for template
|
return sessionUserID, sessionUsername, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// renderProfile renders the profile page for the given user,
|
||||||
|
// optionally including a success or error message.
|
||||||
|
func (h *Handlers) renderProfile(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
r *http.Request,
|
||||||
|
userID, username, successMessage, errorMessage string,
|
||||||
|
) {
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"User": &UserInfo{
|
"User": &UserInfo{
|
||||||
ID: sessionUserID,
|
ID: userID,
|
||||||
Username: sessionUsername,
|
Username: username,
|
||||||
},
|
},
|
||||||
|
"SuccessMessage": successMessage,
|
||||||
|
"ErrorMessage": errorMessage,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Render the profile page
|
|
||||||
h.renderTemplate(w, r, "profile.html", data)
|
h.renderTemplate(w, r, "profile.html", data)
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,12 +4,15 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/go-chi/chi"
|
"github.com/go-chi/chi"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"sneak.berlin/go/webhooker/internal/config"
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
"sneak.berlin/go/webhooker/internal/handlers"
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
"sneak.berlin/go/webhooker/internal/logger"
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
"sneak.berlin/go/webhooker/internal/middleware"
|
"sneak.berlin/go/webhooker/internal/middleware"
|
||||||
@@ -157,3 +160,134 @@ func TestUserRoute_Unauthenticated_RedirectedByMiddleware(t *testing.T) {
|
|||||||
assert.Equal(t, http.StatusSeeOther, w.Code)
|
assert.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// passwordChangeRequest builds a POST request to the password-change
|
||||||
|
// endpoint for the given username, attaching the supplied cookies, an
|
||||||
|
// urlencoded form body, and the chi URL parameter the handler reads.
|
||||||
|
func passwordChangeRequest(
|
||||||
|
username string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
form url.Values,
|
||||||
|
) *http.Request {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodPost,
|
||||||
|
"/user/"+username+"/password",
|
||||||
|
strings.NewReader(form.Encode()),
|
||||||
|
)
|
||||||
|
req.Header.Set(
|
||||||
|
"Content-Type", "application/x-www-form-urlencoded",
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
rctx.URLParams.Add("username", username)
|
||||||
|
|
||||||
|
return req.WithContext(
|
||||||
|
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandlePasswordChange_Success(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
var db *database.Database
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
oldHash, err := database.HashPassword("oldpassword")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
user := &database.User{Username: "pwuser", Password: oldHash}
|
||||||
|
require.NoError(t, db.DB().Create(user).Error)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(t, sess, user.ID, "pwuser")
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("current_password", "oldpassword")
|
||||||
|
form.Set("new_password", "newpassword")
|
||||||
|
form.Set("confirm_password", "newpassword")
|
||||||
|
|
||||||
|
req := passwordChangeRequest("pwuser", cookies, form)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandlePasswordChange().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Body.String(), "Password changed successfully.",
|
||||||
|
)
|
||||||
|
|
||||||
|
var updated database.User
|
||||||
|
|
||||||
|
require.NoError(t,
|
||||||
|
db.DB().Where("username = ?", "pwuser").First(&updated).Error,
|
||||||
|
)
|
||||||
|
assert.NotEqual(t, oldHash, updated.Password)
|
||||||
|
|
||||||
|
valid, err := database.VerifyPassword(
|
||||||
|
"newpassword", updated.Password,
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, valid, "new password should verify against new hash")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandlePasswordChange_WrongCurrentPassword(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
var db *database.Database
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
oldHash, err := database.HashPassword("oldpassword")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
user := &database.User{Username: "pwuser2", Password: oldHash}
|
||||||
|
require.NoError(t, db.DB().Create(user).Error)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(t, sess, user.ID, "pwuser2")
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("current_password", "wrongpassword")
|
||||||
|
form.Set("new_password", "newpassword")
|
||||||
|
form.Set("confirm_password", "newpassword")
|
||||||
|
|
||||||
|
req := passwordChangeRequest("pwuser2", cookies, form)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandlePasswordChange().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Body.String(), "Current password is incorrect.",
|
||||||
|
)
|
||||||
|
|
||||||
|
var unchanged database.User
|
||||||
|
|
||||||
|
require.NoError(t,
|
||||||
|
db.DB().Where(
|
||||||
|
"username = ?", "pwuser2",
|
||||||
|
).First(&unchanged).Error,
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, oldHash, unchanged.Password,
|
||||||
|
"stored hash must be unchanged after a rejected change",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|||||||
356
internal/handlers/source_delete_test.go
Normal file
356
internal/handlers/source_delete_test.go
Normal file
@@ -0,0 +1,356 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
deleteTestUserID = "test-user-id"
|
||||||
|
deleteTestUsername = "testuser"
|
||||||
|
|
||||||
|
// paramSourceID and paramTargetID are the chi URL parameter
|
||||||
|
// names the deletion handlers read.
|
||||||
|
paramSourceID = "sourceID"
|
||||||
|
paramTargetID = "targetID"
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedWebhook inserts a webhook owned by the test user and
|
||||||
|
// returns it.
|
||||||
|
func seedWebhook(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
) *database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: deleteTestUserID,
|
||||||
|
Name: "delete-me",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedTarget inserts a target of the given type for a webhook
|
||||||
|
// and returns it.
|
||||||
|
func seedTarget(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
webhookID string,
|
||||||
|
targetType database.TargetType,
|
||||||
|
) *database.Target {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
tgt := &database.Target{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Name: "t-" + string(targetType),
|
||||||
|
Type: targetType,
|
||||||
|
Active: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(tgt).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return tgt
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePathFor returns the archive database path the
|
||||||
|
// delivery engine would use for a webhook: beside the webhook's
|
||||||
|
// event database in the data directory.
|
||||||
|
func archivePathFor(
|
||||||
|
t *testing.T,
|
||||||
|
mgr *database.WebhookDBManager,
|
||||||
|
webhookID string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
return filepath.Join(
|
||||||
|
filepath.Dir(mgr.DBPath(webhookID)),
|
||||||
|
"archive-"+webhookID+".db",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeArchivePlaceholder creates a stand-in archive file so a
|
||||||
|
// test can assert the file survives webhook deletion.
|
||||||
|
func writeArchivePlaceholder(path string) error {
|
||||||
|
return os.WriteFile(path, []byte("archive"), 0o600)
|
||||||
|
}
|
||||||
|
|
||||||
|
// postRequest builds an authenticated POST request carrying the
|
||||||
|
// given chi URL parameters.
|
||||||
|
func postRequest(
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
params map[string]string,
|
||||||
|
) *http.Request {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodPost, path, nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
for k, v := range params {
|
||||||
|
rctx.URLParams.Add(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
return req.WithContext(
|
||||||
|
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDelete_EvictsArchiveWriter proves that
|
||||||
|
// deleting a webhook reaches the delivery engine and releases
|
||||||
|
// the webhook's archive writer, exercised through the real
|
||||||
|
// deletion handler rather than by calling the evictor directly.
|
||||||
|
func TestHandleSourceDelete_EvictsArchiveWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{paramSourceID: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleSourceDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{wh.ID}, ev.Evicted(),
|
||||||
|
"deleting a webhook should evict its archive writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDelete_KeepsArchiveFile proves that deleting
|
||||||
|
// a webhook does not remove its archive database file: the
|
||||||
|
// archive is long-term storage the operator owns.
|
||||||
|
func TestHandleSourceDelete_KeepsArchiveFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
mgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &mgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
|
||||||
|
// Place an archive file where the delivery engine would.
|
||||||
|
archivePath := archivePathFor(t, mgr, wh.ID)
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
writeArchivePlaceholder(archivePath),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{paramSourceID: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleSourceDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.FileExists(
|
||||||
|
t, archivePath,
|
||||||
|
"webhook deletion must not destroy the archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_EvictsWhenLastDatabaseTargetGone
|
||||||
|
// proves that removing the last database target releases the
|
||||||
|
// archive writer.
|
||||||
|
func TestHandleTargetDelete_EvictsWhenLastDatabaseTargetGone(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
tgt := seedTarget(
|
||||||
|
t, db, wh.ID, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+tgt.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: tgt.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{wh.ID}, ev.Evicted(),
|
||||||
|
"removing the last database target should evict",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_KeepsWriterWhenDatabaseTargetRemains
|
||||||
|
// proves that deleting one of several database targets leaves
|
||||||
|
// the still-needed archive writer alone: the surviving target
|
||||||
|
// keeps archiving to the same file, so the writer must stay.
|
||||||
|
func TestHandleTargetDelete_KeepsWriterWhenDatabaseTargetRemains(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
doomed := seedTarget(
|
||||||
|
t, db, wh.ID, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+doomed.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: doomed.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Empty(
|
||||||
|
t, ev.Evicted(),
|
||||||
|
"a second database target still needs the writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_KeepsWriterWhenOtherTypeDeleted proves
|
||||||
|
// that deleting a target of an unrelated type leaves a
|
||||||
|
// still-needed archive writer alone: the webhook's database
|
||||||
|
// target is untouched, so its writer must stay.
|
||||||
|
func TestHandleTargetDelete_KeepsWriterWhenOtherTypeDeleted(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
other := seedTarget(t, db, wh.ID, database.TargetTypeLog)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+other.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: other.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Empty(
|
||||||
|
t, ev.Evicted(),
|
||||||
|
"a surviving database target must keep its writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
228
internal/handlers/source_detail_test.go
Normal file
228
internal/handlers/source_detail_test.go
Normal file
@@ -0,0 +1,228 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The secret path segments of a Slack incoming webhook URL.
|
||||||
|
// Holding them is enough to post to the channel forever, so
|
||||||
|
// they must never reach the rendered page.
|
||||||
|
const (
|
||||||
|
slackSecretPath = "/services/T00000000/B00000000/" +
|
||||||
|
"XXXXXXXXXXXXXXXXXXXXXXXX"
|
||||||
|
slackWebhookURL = "https://hooks.slack.com" +
|
||||||
|
slackSecretPath
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedConfiguredTarget inserts a target with a stored config
|
||||||
|
// blob and returns it.
|
||||||
|
func seedConfiguredTarget(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
webhookID string,
|
||||||
|
targetType database.TargetType,
|
||||||
|
config string,
|
||||||
|
) *database.Target {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
tgt := &database.Target{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Name: "t-" + string(targetType),
|
||||||
|
Type: targetType,
|
||||||
|
Active: true,
|
||||||
|
Config: config,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(tgt).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return tgt
|
||||||
|
}
|
||||||
|
|
||||||
|
// renderSourceDetailPage runs the real source detail handler
|
||||||
|
// for a webhook and returns the rendered HTML.
|
||||||
|
func renderSourceDetailPage(
|
||||||
|
t *testing.T,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
sess *session.Session,
|
||||||
|
webhookID string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet,
|
||||||
|
"/source/"+webhookID,
|
||||||
|
nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
) {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
rctx.URLParams.Add(paramSourceID, webhookID)
|
||||||
|
|
||||||
|
req = req.WithContext(
|
||||||
|
context.WithValue(
|
||||||
|
req.Context(), chi.RouteCtxKey, rctx,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
h.HandleSourceDetail().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
|
||||||
|
return w.Body.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDetail_MasksSlackWebhookURL is the
|
||||||
|
// load-bearing regression test for the credential leak: the
|
||||||
|
// rendered page must show the Slack target without any of the
|
||||||
|
// secret path segments of its webhook URL.
|
||||||
|
func TestHandleSourceDetail_MasksSlackWebhookURL(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetTypeSlack,
|
||||||
|
`{"webhookUrl":"`+slackWebhookURL+`"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
body := renderSourceDetailPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
assert.NotContains(t, body, slackSecretPath)
|
||||||
|
assert.NotContains(t, body, "T00000000")
|
||||||
|
assert.NotContains(t, body, "B00000000")
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, "XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
assert.NotContains(t, body, "webhookUrl")
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Webhook URL")
|
||||||
|
assert.Contains(t, body, "https://hooks.slack.com/...")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDetail_MasksHTTPDestinationURL is the
|
||||||
|
// regression test for the same leak reached through the http
|
||||||
|
// target: its destination is routinely an incoming-webhook
|
||||||
|
// endpoint whose path segments are the credential, so the
|
||||||
|
// rendered page must not contain them.
|
||||||
|
func TestHandleSourceDetail_MasksHTTPDestinationURL(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetTypeHTTP,
|
||||||
|
`{"url":"`+slackWebhookURL+`"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
body := renderSourceDetailPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
assert.NotContains(t, body, slackSecretPath)
|
||||||
|
assert.NotContains(t, body, "T00000000")
|
||||||
|
assert.NotContains(t, body, "B00000000")
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, "XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Destination URL")
|
||||||
|
assert.Contains(t, body, "https://hooks.slack.com/...")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDetail_RendersNamedTargetFields proves the
|
||||||
|
// other target types render labelled fields rather than the
|
||||||
|
// stored blob.
|
||||||
|
func TestHandleSourceDetail_RendersNamedTargetFields(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
|
||||||
|
seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetTypeHTTP,
|
||||||
|
`{"url":"https://example.com/hook","timeout":30,`+
|
||||||
|
`"headers":{"Authorization":"Bearer sekrit"}}`,
|
||||||
|
)
|
||||||
|
seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetTypeDatabase,
|
||||||
|
`{"expiry":"720h"}`,
|
||||||
|
)
|
||||||
|
seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetType("carrier-pigeon"),
|
||||||
|
`{"beak":"sharp"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
body := renderSourceDetailPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Destination URL")
|
||||||
|
assert.Contains(t, body, "https://example.com/...")
|
||||||
|
assert.Contains(t, body, "Timeout")
|
||||||
|
assert.Contains(t, body, "1 configured")
|
||||||
|
assert.NotContains(t, body, "sekrit")
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Archive Expiry")
|
||||||
|
assert.Contains(t, body, "720h")
|
||||||
|
|
||||||
|
// An unknown type gets the neutral placeholder, never the
|
||||||
|
// stored blob.
|
||||||
|
assert.Contains(t, body, "(unavailable)")
|
||||||
|
assert.NotContains(t, body, "beak")
|
||||||
|
}
|
||||||
134
internal/handlers/source_logs_test.go
Normal file
134
internal/handlers/source_logs_test.go
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedDeliveredEvent records an event and a delivery for it in
|
||||||
|
// the webhook's own database, so the log page has a delivery
|
||||||
|
// to render against the target.
|
||||||
|
func seedDeliveredEvent(
|
||||||
|
t *testing.T,
|
||||||
|
dbMgr *database.WebhookDBManager,
|
||||||
|
webhookID, targetID string,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
webhookDB, err := dbMgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
event := &database.Event{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"test":true}`,
|
||||||
|
ContentType: "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.Omit(
|
||||||
|
clause.Associations,
|
||||||
|
).Create(event).Error)
|
||||||
|
|
||||||
|
dlv := &database.Delivery{
|
||||||
|
EventID: event.ID,
|
||||||
|
TargetID: targetID,
|
||||||
|
Status: database.DeliveryStatusDelivered,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, webhookDB.Omit(
|
||||||
|
clause.Associations,
|
||||||
|
).Create(dlv).Error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// renderSourceLogsPage runs the real event log handler for a
|
||||||
|
// webhook and returns the rendered HTML.
|
||||||
|
func renderSourceLogsPage(
|
||||||
|
t *testing.T,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
sess *session.Session,
|
||||||
|
webhookID string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet,
|
||||||
|
"/source/"+webhookID+"/logs",
|
||||||
|
nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
) {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
rctx.URLParams.Add(paramSourceID, webhookID)
|
||||||
|
|
||||||
|
req = req.WithContext(
|
||||||
|
context.WithValue(
|
||||||
|
req.Context(), chi.RouteCtxKey, rctx,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
h.HandleSourceLogs().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
|
||||||
|
return w.Body.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceLogs_MasksSlackWebhookURL proves the event
|
||||||
|
// log page is handed a display-safe projection of each target
|
||||||
|
// rather than the stored row, so the credential cannot be
|
||||||
|
// rendered from its template data.
|
||||||
|
func TestHandleSourceLogs_MasksSlackWebhookURL(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
tgt := seedConfiguredTarget(
|
||||||
|
t, db, wh.ID,
|
||||||
|
database.TargetTypeSlack,
|
||||||
|
`{"webhookUrl":"`+slackWebhookURL+`"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
seedDeliveredEvent(t, dbMgr, wh.ID, tgt.ID)
|
||||||
|
|
||||||
|
body := renderSourceLogsPage(t, h, sess, wh.ID)
|
||||||
|
|
||||||
|
assert.NotContains(t, body, slackSecretPath)
|
||||||
|
assert.NotContains(t, body, "T00000000")
|
||||||
|
assert.NotContains(t, body, "B00000000")
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, "XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
assert.NotContains(t, body, "webhookUrl")
|
||||||
|
|
||||||
|
// The page still identifies the delivery's target.
|
||||||
|
assert.Contains(t, body, tgt.Name)
|
||||||
|
assert.Contains(t, body, "delivered")
|
||||||
|
}
|
||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/go-chi/chi"
|
"github.com/go-chi/chi"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
@@ -24,11 +25,81 @@ type WebhookListItem struct {
|
|||||||
// errMissingURL signals that a required URL was not provided.
|
// errMissingURL signals that a required URL was not provided.
|
||||||
var errMissingURL = errors.New("missing URL")
|
var errMissingURL = errors.New("missing URL")
|
||||||
|
|
||||||
// EventWithDeliveries holds an event and its deliveries.
|
// errInvalidRetention signals a retention_days form value that is not
|
||||||
type EventWithDeliveries struct {
|
// a non-negative whole number.
|
||||||
database.Event
|
var errInvalidRetention = errors.New("invalid retention days")
|
||||||
|
|
||||||
Deliveries []database.Delivery
|
// errRetentionTooLarge signals a retention_days form value that is a
|
||||||
|
// whole number but larger than the reaper's cutoff arithmetic can
|
||||||
|
// represent. It is distinguished from errInvalidRetention so the form
|
||||||
|
// can tell the user the actual ceiling instead of implying their input
|
||||||
|
// was not a number.
|
||||||
|
var errRetentionTooLarge = errors.New("retention days out of range")
|
||||||
|
|
||||||
|
// retentionErrorMessage returns the message the create and edit forms
|
||||||
|
// show the user for a rejected retention_days value. Any error other
|
||||||
|
// than errRetentionTooLarge falls back to the generic wording, so an
|
||||||
|
// unrecognised parse failure still produces a sensible 400 rather than
|
||||||
|
// an empty alert.
|
||||||
|
func retentionErrorMessage(err error) string {
|
||||||
|
if errors.Is(err, errRetentionTooLarge) {
|
||||||
|
return "Retention must be at most " +
|
||||||
|
strconv.Itoa(database.MaxFiniteRetentionDays) +
|
||||||
|
" days, or 0 to retain events forever."
|
||||||
|
}
|
||||||
|
|
||||||
|
return "Retention must be a whole number of days, or 0 to " +
|
||||||
|
"retain events forever."
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseRetentionDays interprets a retention_days form value.
|
||||||
|
//
|
||||||
|
// An empty value yields fallback, which lets the create path apply the
|
||||||
|
// default and the edit path leave the stored value unchanged. A value
|
||||||
|
// of 0 is returned as 0 and is rewritten to the retain-forever
|
||||||
|
// sentinel by database.Webhook's BeforeSave hook. Anything unparseable
|
||||||
|
// or negative is an error rather than a silently substituted default.
|
||||||
|
//
|
||||||
|
// The upper bound is not cosmetic. The reaper computes its cutoff as a
|
||||||
|
// time.Duration, an int64 nanosecond count, so a day count above
|
||||||
|
// database.MaxFiniteRetentionDays overflows, puts the cutoff in the
|
||||||
|
// future, and deletes every event the webhook has. A finite value
|
||||||
|
// above that ceiling is therefore a 400.
|
||||||
|
//
|
||||||
|
// A value at or above the retain-forever sentinel is not out of range:
|
||||||
|
// it is what the edit form pre-fills for a retain-forever webhook, so
|
||||||
|
// submitting the form back unchanged has to keep meaning "forever"
|
||||||
|
// rather than being rejected.
|
||||||
|
func parseRetentionDays(raw string, fallback int) (int, error) {
|
||||||
|
raw = strings.TrimSpace(raw)
|
||||||
|
if raw == "" {
|
||||||
|
return fallback, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
v, err := strconv.Atoi(raw)
|
||||||
|
if err != nil || v < 0 {
|
||||||
|
return 0, errInvalidRetention
|
||||||
|
}
|
||||||
|
|
||||||
|
if v >= database.RetentionForeverDays {
|
||||||
|
return database.RetentionForeverDays, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v > database.MaxFiniteRetentionDays {
|
||||||
|
return 0, errRetentionTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
|
return v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeliveryView is the display-safe projection of a delivery
|
||||||
|
// for the event log page. Its target is a TargetView, so the
|
||||||
|
// stored configuration blob — which holds the target's
|
||||||
|
// credential — has no path to the template.
|
||||||
|
type DeliveryView struct {
|
||||||
|
ID string
|
||||||
|
Status database.DeliveryStatus
|
||||||
|
Target delivery.TargetView
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleSourceList shows a list of user's webhooks.
|
// HandleSourceList shows a list of user's webhooks.
|
||||||
@@ -105,11 +176,30 @@ func (h *Handlers) buildWebhookListItems(
|
|||||||
// HandleSourceCreate shows the form to create a new webhook.
|
// HandleSourceCreate shows the form to create a new webhook.
|
||||||
func (h *Handlers) HandleSourceCreate() http.HandlerFunc {
|
func (h *Handlers) HandleSourceCreate() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
data := map[string]any{
|
h.renderTemplate(
|
||||||
"Error": "",
|
w, r, "sources_new.html",
|
||||||
|
newSourceFormData("", "", ""),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
h.renderTemplate(w, r, "sources_new.html", data)
|
// newSourceFormData builds the template data for the webhook creation
|
||||||
|
// form.
|
||||||
|
//
|
||||||
|
// It carries the retention default so the pre-filled value comes from
|
||||||
|
// database.DefaultRetentionDays rather than being a third hardcoded
|
||||||
|
// copy of the same policy, and it carries the submitted name and
|
||||||
|
// description so that re-rendering the form after a validation failure
|
||||||
|
// gives the user their input back instead of a blank form. The edit
|
||||||
|
// form already behaves that way; create now matches it.
|
||||||
|
func newSourceFormData(
|
||||||
|
errMsg, name, description string,
|
||||||
|
) map[string]any {
|
||||||
|
return map[string]any{
|
||||||
|
tmplKeyError: errMsg,
|
||||||
|
"Name": name,
|
||||||
|
"Description": description,
|
||||||
|
"DefaultRetentionDays": database.DefaultRetentionDays,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -126,10 +216,8 @@ func (h *Handlers) HandleSourceCreateSubmit() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// middleware, which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
err := r.ParseForm()
|
err := r.ParseForm()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -144,23 +232,31 @@ func (h *Handlers) HandleSourceCreateSubmit() http.HandlerFunc {
|
|||||||
retentionStr := r.FormValue("retention_days")
|
retentionStr := r.FormValue("retention_days")
|
||||||
|
|
||||||
if name == "" {
|
if name == "" {
|
||||||
data := map[string]any{
|
|
||||||
"Error": "Name is required",
|
|
||||||
}
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
h.renderTemplate(w, r, "sources_new.html", data)
|
h.renderTemplate(
|
||||||
|
w, r, "sources_new.html",
|
||||||
|
newSourceFormData(
|
||||||
|
"Name is required", name, description,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
retentionDays := defaultRetentionDays
|
retentionDays, retErr := parseRetentionDays(
|
||||||
|
retentionStr, database.DefaultRetentionDays,
|
||||||
|
)
|
||||||
|
if retErr != nil {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
h.renderTemplate(
|
||||||
|
w, r, "sources_new.html",
|
||||||
|
newSourceFormData(
|
||||||
|
retentionErrorMessage(retErr),
|
||||||
|
name, description,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
if retentionStr != "" {
|
return
|
||||||
v, convErr := strconv.Atoi(retentionStr)
|
|
||||||
if convErr == nil && v > 0 {
|
|
||||||
retentionDays = v
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
h.createWebhookWithEntrypoint(
|
h.createWebhookWithEntrypoint(
|
||||||
@@ -314,10 +410,15 @@ func (h *Handlers) renderSourceDetail(
|
|||||||
scheme = fwdProto
|
scheme = fwdProto
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The template calls Webhook methods, which take pointer
|
||||||
|
// receivers; html/template cannot address a value stored in a map.
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Webhook": webhook,
|
tmplKeyWebhook: &webhook,
|
||||||
"Entrypoints": entrypoints,
|
"Entrypoints": entrypoints,
|
||||||
"Targets": targets,
|
// Targets are projected to a display-safe view: the
|
||||||
|
// stored config blob holds credentials and must never
|
||||||
|
// reach a template.
|
||||||
|
"Targets": delivery.NewTargetViews(targets),
|
||||||
"Events": events,
|
"Events": events,
|
||||||
"BaseURL": scheme + "://" + host,
|
"BaseURL": scheme + "://" + host,
|
||||||
}
|
}
|
||||||
@@ -351,8 +452,8 @@ func (h *Handlers) HandleSourceEdit() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Webhook": webhook,
|
tmplKeyWebhook: &webhook,
|
||||||
"Error": "",
|
tmplKeyError: "",
|
||||||
}
|
}
|
||||||
|
|
||||||
h.renderTemplate(w, r, "source_edit.html", data)
|
h.renderTemplate(w, r, "source_edit.html", data)
|
||||||
@@ -385,10 +486,8 @@ func (h *Handlers) HandleSourceEditSubmit() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// middleware, which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
err = r.ParseForm()
|
err = r.ParseForm()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -408,15 +507,13 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
r *http.Request,
|
r *http.Request,
|
||||||
webhook *database.Webhook,
|
webhook *database.Webhook,
|
||||||
) {
|
) {
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize middleware,
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
name := r.FormValue("name")
|
name := r.FormValue("name")
|
||||||
if name == "" {
|
if name == "" {
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Webhook": *webhook,
|
tmplKeyWebhook: webhook,
|
||||||
"Error": "Name is required",
|
tmplKeyError: "Name is required",
|
||||||
}
|
}
|
||||||
|
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
@@ -427,7 +524,25 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
|
|
||||||
webhook.Name = name
|
webhook.Name = name
|
||||||
webhook.Description = r.FormValue("description")
|
webhook.Description = r.FormValue("description")
|
||||||
h.parseRetention(r, webhook)
|
|
||||||
|
// An empty field falls back to the stored value, so submitting the
|
||||||
|
// form without touching retention leaves the policy alone.
|
||||||
|
retentionDays, retErr := parseRetentionDays(
|
||||||
|
r.FormValue("retention_days"), webhook.RetentionDays,
|
||||||
|
)
|
||||||
|
if retErr != nil {
|
||||||
|
data := map[string]any{
|
||||||
|
tmplKeyWebhook: webhook,
|
||||||
|
tmplKeyError: retentionErrorMessage(retErr),
|
||||||
|
}
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
h.renderTemplate(w, r, "source_edit.html", data)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
webhook.RetentionDays = retentionDays
|
||||||
|
|
||||||
err := h.db.DB().Save(webhook).Error
|
err := h.db.DB().Save(webhook).Error
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -441,23 +556,6 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseRetention parses and applies retention_days from the
|
|
||||||
// form.
|
|
||||||
func (h *Handlers) parseRetention(
|
|
||||||
r *http.Request,
|
|
||||||
webhook *database.Webhook,
|
|
||||||
) {
|
|
||||||
retStr := r.FormValue("retention_days")
|
|
||||||
if retStr == "" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
v, err := strconv.Atoi(retStr)
|
|
||||||
if err == nil && v > 0 {
|
|
||||||
webhook.RetentionDays = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// HandleSourceDelete handles webhook deletion.
|
// HandleSourceDelete handles webhook deletion.
|
||||||
func (h *Handlers) HandleSourceDelete() http.HandlerFunc {
|
func (h *Handlers) HandleSourceDelete() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -532,6 +630,13 @@ func (h *Handlers) deleteWebhookResources(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Release the delivery engine's per-webhook archiving state
|
||||||
|
// so a deleted webhook's archive writer (and any handle open
|
||||||
|
// within its debounce window) does not linger for the
|
||||||
|
// process lifetime. The archive file itself is deliberately
|
||||||
|
// left on disk; see evictArchiveWriter.
|
||||||
|
h.evictArchiveWriter(webhook.ID)
|
||||||
|
|
||||||
err = h.dbMgr.DeleteDB(webhook.ID)
|
err = h.dbMgr.DeleteDB(webhook.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.log.Error(
|
h.log.Error(
|
||||||
@@ -550,29 +655,113 @@ func (h *Handlers) deleteWebhookResources(
|
|||||||
http.Redirect(w, r, "/sources", http.StatusSeeOther)
|
http.Redirect(w, r, "/sources", http.StatusSeeOther)
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleSourceLogs shows the request/response logs for a
|
// evictArchiveWriter asks the delivery engine to drop its
|
||||||
// webhook.
|
// cached archive writer for a webhook, closing the archive file
|
||||||
func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
// handle.
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
//
|
||||||
|
// The archive database file is NOT deleted. Unlike the event
|
||||||
|
// database — which is per-webhook working storage and is
|
||||||
|
// hard-deleted with the webhook — an archive is explicitly
|
||||||
|
// long-term storage that an operator may want to keep or move
|
||||||
|
// away for offline retention. Destroying it as a side effect of
|
||||||
|
// deleting a webhook would be a surprising and unrecoverable
|
||||||
|
// data loss, so the file is left for the operator to handle.
|
||||||
|
func (h *Handlers) evictArchiveWriter(webhookID string) {
|
||||||
|
if h.evictor == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.evictor.EvictWebhook(webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// evictArchiveWriterIfUnused releases a webhook's archive
|
||||||
|
// writer once the webhook has no database target left to feed
|
||||||
|
// it.
|
||||||
|
//
|
||||||
|
// It is called after any child resource of a webhook is
|
||||||
|
// deleted, and is correct without knowing which kind was: it
|
||||||
|
// evicts only when no database target remains, so deleting one
|
||||||
|
// of several database targets — or deleting an unrelated
|
||||||
|
// target type — leaves a still-needed writer alone. When no
|
||||||
|
// database target ever existed there is no writer and eviction
|
||||||
|
// is a no-op. Soft-deleted targets are excluded by GORM's
|
||||||
|
// default scope, so the row just deleted is not counted.
|
||||||
|
func (h *Handlers) evictArchiveWriterIfUnused(webhookID string) {
|
||||||
|
var remaining int64
|
||||||
|
|
||||||
|
err := h.db.DB().
|
||||||
|
Model(&database.Target{}).
|
||||||
|
Where(
|
||||||
|
"webhook_id = ? AND type = ?",
|
||||||
|
webhookID, database.TargetTypeDatabase,
|
||||||
|
).
|
||||||
|
Count(&remaining).Error
|
||||||
|
if err != nil {
|
||||||
|
h.log.Error(
|
||||||
|
"failed to count remaining database targets",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if remaining > 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.evictArchiveWriter(webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ownedWebhook resolves the request's sourceID parameter to a
|
||||||
|
// webhook the session's user owns.
|
||||||
|
//
|
||||||
|
// Ownership and existence are decided by one query, so a
|
||||||
|
// webhook belonging to another user is indistinguishable from
|
||||||
|
// one that does not exist: both are a 404, and neither confirms
|
||||||
|
// the id. Callers that reach further into a webhook's data —
|
||||||
|
// the event log page and the event body download — share this
|
||||||
|
// one check rather than restating it, so the download cannot
|
||||||
|
// come to authorize differently from the page that links to it.
|
||||||
|
//
|
||||||
|
// It reports false once it has written the response, which is a
|
||||||
|
// redirect to the login page for an unauthenticated request and
|
||||||
|
// a 404 otherwise. The caller returns without writing more.
|
||||||
|
func (h *Handlers) ownedWebhook(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
r *http.Request,
|
||||||
|
) (database.Webhook, bool) {
|
||||||
|
var webhook database.Webhook
|
||||||
|
|
||||||
userID, ok := h.getUserID(r)
|
userID, ok := h.getUserID(r)
|
||||||
if !ok {
|
if !ok {
|
||||||
http.Redirect(
|
http.Redirect(
|
||||||
w, r, "/pages/login", http.StatusSeeOther,
|
w, r, "/pages/login", http.StatusSeeOther,
|
||||||
)
|
)
|
||||||
|
|
||||||
return
|
return database.Webhook{}, false
|
||||||
}
|
}
|
||||||
|
|
||||||
sourceID := chi.URLParam(r, "sourceID")
|
sourceID := chi.URLParam(r, "sourceID")
|
||||||
|
|
||||||
var webhook database.Webhook
|
|
||||||
|
|
||||||
err := h.db.DB().Where(
|
err := h.db.DB().Where(
|
||||||
"id = ? AND user_id = ?", sourceID, userID,
|
"id = ? AND user_id = ?", sourceID, userID,
|
||||||
).First(&webhook).Error
|
).First(&webhook).Error
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.NotFound(w, r)
|
http.NotFound(w, r)
|
||||||
|
|
||||||
|
return database.Webhook{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return webhook, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandleSourceLogs shows the request/response logs for a
|
||||||
|
// webhook.
|
||||||
|
func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
webhook, ok := h.ownedWebhook(w, r)
|
||||||
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -589,7 +778,7 @@ func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
"Webhook": webhook,
|
tmplKeyWebhook: &webhook,
|
||||||
"Events": evts,
|
"Events": evts,
|
||||||
"Page": page,
|
"Page": page,
|
||||||
"TotalPages": totalPages,
|
"TotalPages": totalPages,
|
||||||
@@ -604,22 +793,27 @@ func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadTargetMap loads targets into a map keyed by target ID.
|
// loadTargetMap loads targets into a map of display-safe
|
||||||
|
// views keyed by target ID. The projection happens here so
|
||||||
|
// that no caller can hand a raw target, configuration blob
|
||||||
|
// and all, to a template.
|
||||||
func (h *Handlers) loadTargetMap(
|
func (h *Handlers) loadTargetMap(
|
||||||
webhookID string,
|
webhookID string,
|
||||||
) map[string]database.Target {
|
) map[string]delivery.TargetView {
|
||||||
var targets []database.Target
|
var targets []database.Target
|
||||||
|
|
||||||
h.db.DB().Where(
|
h.db.DB().Where(
|
||||||
"webhook_id = ?", webhookID,
|
"webhook_id = ?", webhookID,
|
||||||
).Find(&targets)
|
).Find(&targets)
|
||||||
|
|
||||||
|
views := delivery.NewTargetViews(targets)
|
||||||
|
|
||||||
targetMap := make(
|
targetMap := make(
|
||||||
map[string]database.Target, len(targets),
|
map[string]delivery.TargetView, len(views),
|
||||||
)
|
)
|
||||||
|
|
||||||
for _, t := range targets {
|
for _, v := range views {
|
||||||
targetMap[t.ID] = t
|
targetMap[v.ID] = v
|
||||||
}
|
}
|
||||||
|
|
||||||
return targetMap
|
return targetMap
|
||||||
@@ -640,16 +834,18 @@ func (h *Handlers) parsePage(r *http.Request) int {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// loadEventsWithDeliveries loads paginated events and their
|
// loadEventsWithDeliveries loads paginated events and their
|
||||||
// deliveries from the per-webhook database.
|
// deliveries from the per-webhook database. Events come back
|
||||||
|
// as capped projections rather than database.Event rows: see
|
||||||
|
// eventLogColumns for why the cut happens in SQL.
|
||||||
func (h *Handlers) loadEventsWithDeliveries(
|
func (h *Handlers) loadEventsWithDeliveries(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
webhook database.Webhook,
|
webhook database.Webhook,
|
||||||
targetMap map[string]database.Target,
|
targetMap map[string]delivery.TargetView,
|
||||||
page int,
|
page int,
|
||||||
) ([]EventWithDeliveries, int64) {
|
) ([]EventLogView, int64) {
|
||||||
var totalEvents int64
|
var totalEvents int64
|
||||||
|
|
||||||
var result []EventWithDeliveries
|
var result []EventLogView
|
||||||
|
|
||||||
if !h.dbMgr.DBExists(webhook.ID) {
|
if !h.dbMgr.DBExists(webhook.ID) {
|
||||||
return result, totalEvents
|
return result, totalEvents
|
||||||
@@ -670,35 +866,54 @@ func (h *Handlers) loadEventsWithDeliveries(
|
|||||||
|
|
||||||
offset := (page - 1) * paginationPerPage
|
offset := (page - 1) * paginationPerPage
|
||||||
|
|
||||||
var events []database.Event
|
var rows []eventLogRow
|
||||||
|
|
||||||
webhookDB.Where(
|
webhookDB.Model(&database.Event{}).Select(
|
||||||
|
eventLogColumns, maxRenderedBodyBytes,
|
||||||
|
).Where(
|
||||||
"webhook_id = ?", webhook.ID,
|
"webhook_id = ?", webhook.ID,
|
||||||
).Order("created_at DESC").Offset(offset).Limit(
|
).Order("created_at DESC").Offset(offset).Limit(
|
||||||
paginationPerPage,
|
paginationPerPage,
|
||||||
).Find(&events)
|
).Find(&rows)
|
||||||
|
|
||||||
result = make([]EventWithDeliveries, len(events))
|
result = make([]EventLogView, len(rows))
|
||||||
|
|
||||||
for i := range events {
|
for i := range rows {
|
||||||
result[i].Event = events[i]
|
result[i] = rows[i].view()
|
||||||
|
|
||||||
|
var deliveries []database.Delivery
|
||||||
|
|
||||||
webhookDB.Where(
|
webhookDB.Where(
|
||||||
"event_id = ?", events[i].ID,
|
"event_id = ?", rows[i].ID,
|
||||||
).Find(&result[i].Deliveries)
|
).Find(&deliveries)
|
||||||
|
|
||||||
for j := range result[i].Deliveries {
|
result[i].Deliveries = newDeliveryViews(
|
||||||
tid := result[i].Deliveries[j].TargetID
|
deliveries, targetMap,
|
||||||
|
)
|
||||||
if target, ok := targetMap[tid]; ok {
|
|
||||||
result[i].Deliveries[j].Target = target
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return result, totalEvents
|
return result, totalEvents
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// newDeliveryViews projects deliveries for rendering,
|
||||||
|
// resolving each one's target to its display-safe view.
|
||||||
|
func newDeliveryViews(
|
||||||
|
deliveries []database.Delivery,
|
||||||
|
targetMap map[string]delivery.TargetView,
|
||||||
|
) []DeliveryView {
|
||||||
|
views := make([]DeliveryView, len(deliveries))
|
||||||
|
|
||||||
|
for i := range deliveries {
|
||||||
|
views[i] = DeliveryView{
|
||||||
|
ID: deliveries[i].ID,
|
||||||
|
Status: deliveries[i].Status,
|
||||||
|
Target: targetMap[deliveries[i].TargetID],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return views
|
||||||
|
}
|
||||||
|
|
||||||
// HandleEntrypointCreate handles adding a new entrypoint.
|
// HandleEntrypointCreate handles adding a new entrypoint.
|
||||||
func (h *Handlers) HandleEntrypointCreate() http.HandlerFunc {
|
func (h *Handlers) HandleEntrypointCreate() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -724,10 +939,8 @@ func (h *Handlers) HandleEntrypointCreate() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// middleware, which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
err = r.ParseForm()
|
err = r.ParseForm()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -784,10 +997,8 @@ func (h *Handlers) HandleTargetCreate() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// middleware, which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
err = r.ParseForm()
|
err = r.ParseForm()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -807,14 +1018,13 @@ func (h *Handlers) processTargetCreate(
|
|||||||
r *http.Request,
|
r *http.Request,
|
||||||
webhook database.Webhook,
|
webhook database.Webhook,
|
||||||
) {
|
) {
|
||||||
r.Body = http.MaxBytesReader(
|
// The body size cap is enforced by the MaxBodySize middleware,
|
||||||
w, r.Body, 1<<maxBodyShift,
|
// which runs before CSRF parses the form.
|
||||||
)
|
|
||||||
|
|
||||||
name := r.FormValue("name")
|
name := r.FormValue("name")
|
||||||
targetType := database.TargetType(r.FormValue("type"))
|
targetType := database.TargetType(r.FormValue("type"))
|
||||||
targetURL := r.FormValue("url")
|
targetURL := r.FormValue("url")
|
||||||
maxRetriesStr := r.FormValue("max_retries")
|
maxRetriesStr := r.FormValue("max_retries")
|
||||||
|
expiry := r.FormValue("expiry")
|
||||||
|
|
||||||
if name == "" {
|
if name == "" {
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -834,7 +1044,7 @@ func (h *Handlers) processTargetCreate(
|
|||||||
}
|
}
|
||||||
|
|
||||||
configJSON, err := h.buildTargetConfig(
|
configJSON, err := h.buildTargetConfig(
|
||||||
w, r, targetType, targetURL,
|
w, r, targetType, targetURL, expiry,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return
|
return
|
||||||
@@ -892,18 +1102,28 @@ func parseNonNegativeInt(s string) int {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// buildTargetConfig builds the JSON config string for a target.
|
// buildTargetConfig builds the JSON config string for a target.
|
||||||
|
// The expiry form value is read by the caller (which bounds the
|
||||||
|
// request body) and applies to database targets only.
|
||||||
func (h *Handlers) buildTargetConfig(
|
func (h *Handlers) buildTargetConfig(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
targetType database.TargetType,
|
targetType database.TargetType,
|
||||||
targetURL string,
|
targetURL, expiry string,
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
switch targetType {
|
switch targetType {
|
||||||
case database.TargetTypeHTTP:
|
case database.TargetTypeHTTP:
|
||||||
return h.buildHTTPTargetConfig(w, r, targetURL)
|
return h.buildURLTargetConfig(
|
||||||
|
w, r, targetURL, "url",
|
||||||
|
"URL is required for HTTP targets",
|
||||||
|
)
|
||||||
case database.TargetTypeSlack:
|
case database.TargetTypeSlack:
|
||||||
return h.buildSlackTargetConfig(w, r, targetURL)
|
return h.buildURLTargetConfig(
|
||||||
case database.TargetTypeDatabase, database.TargetTypeLog:
|
w, r, targetURL, "webhookUrl",
|
||||||
|
"Webhook URL is required for Slack targets",
|
||||||
|
)
|
||||||
|
case database.TargetTypeDatabase:
|
||||||
|
return h.buildDatabaseTargetConfig(w, expiry)
|
||||||
|
case database.TargetTypeLog:
|
||||||
return "", nil
|
return "", nil
|
||||||
default:
|
default:
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -915,16 +1135,18 @@ func (h *Handlers) buildTargetConfig(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildHTTPTargetConfig builds config JSON for an HTTP target.
|
// buildURLTargetConfig builds config JSON for a target whose
|
||||||
func (h *Handlers) buildHTTPTargetConfig(
|
// configuration is a single SSRF-validated URL stored under
|
||||||
|
// configKey. missingMsg is the error shown when no URL is given.
|
||||||
|
func (h *Handlers) buildURLTargetConfig(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
targetURL string,
|
targetURL, configKey, missingMsg string,
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
if targetURL == "" {
|
if targetURL == "" {
|
||||||
http.Error(
|
http.Error(
|
||||||
w,
|
w,
|
||||||
"URL is required for HTTP targets",
|
missingMsg,
|
||||||
http.StatusBadRequest,
|
http.StatusBadRequest,
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -935,9 +1157,12 @@ func (h *Handlers) buildHTTPTargetConfig(
|
|||||||
r.Context(), targetURL,
|
r.Context(), targetURL,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
// The submitted URL can be a credential (a Slack
|
||||||
|
// incoming webhook URL is a bearer token), so the log
|
||||||
|
// records only its scheme and host.
|
||||||
h.log.Warn(
|
h.log.Warn(
|
||||||
"target URL blocked by SSRF protection",
|
"target URL blocked by SSRF protection",
|
||||||
"url", targetURL,
|
"url", delivery.MaskURL(targetURL),
|
||||||
"error", err,
|
"error", err,
|
||||||
)
|
)
|
||||||
http.Error(
|
http.Error(
|
||||||
@@ -949,7 +1174,7 @@ func (h *Handlers) buildHTTPTargetConfig(
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := map[string]any{"url": targetURL}
|
cfg := map[string]any{configKey: targetURL}
|
||||||
|
|
||||||
configBytes, err := json.Marshal(cfg)
|
configBytes, err := json.Marshal(cfg)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -964,41 +1189,33 @@ func (h *Handlers) buildHTTPTargetConfig(
|
|||||||
return string(configBytes), nil
|
return string(configBytes), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildSlackTargetConfig builds config JSON for a Slack target.
|
// buildDatabaseTargetConfig builds config JSON for a database
|
||||||
func (h *Handlers) buildSlackTargetConfig(
|
// (archive) target. The optional expiry (a form value read by
|
||||||
|
// the caller, which bounds the request body) is validated here,
|
||||||
|
// at creation time, so an unparseable value is rejected with a
|
||||||
|
// 400 instead of failing every subsequent delivery. An empty
|
||||||
|
// expiry yields an empty config (the keep-forever default).
|
||||||
|
func (h *Handlers) buildDatabaseTargetConfig(
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
expiry string,
|
||||||
targetURL string,
|
|
||||||
) (string, error) {
|
) (string, error) {
|
||||||
if targetURL == "" {
|
expiry = strings.TrimSpace(expiry)
|
||||||
http.Error(
|
if expiry == "" {
|
||||||
w,
|
return "", nil
|
||||||
"Webhook URL is required for Slack targets",
|
|
||||||
http.StatusBadRequest,
|
|
||||||
)
|
|
||||||
|
|
||||||
return "", errMissingURL
|
|
||||||
}
|
}
|
||||||
|
|
||||||
err := delivery.ValidateTargetURL(
|
err := delivery.ValidateArchiveExpiry(expiry)
|
||||||
r.Context(), targetURL,
|
|
||||||
)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.log.Warn(
|
|
||||||
"target URL blocked by SSRF protection",
|
|
||||||
"url", targetURL,
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
http.Error(
|
http.Error(
|
||||||
w,
|
w,
|
||||||
"Invalid target URL: "+err.Error(),
|
"Invalid archive expiry: "+err.Error(),
|
||||||
http.StatusBadRequest,
|
http.StatusBadRequest,
|
||||||
)
|
)
|
||||||
|
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := map[string]any{"webhookUrl": targetURL}
|
cfg := map[string]any{"expiry": expiry}
|
||||||
|
|
||||||
configBytes, err := json.Marshal(cfg)
|
configBytes, err := json.Marshal(cfg)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -1018,23 +1235,31 @@ func (h *Handlers) HandleEntrypointDelete() http.HandlerFunc {
|
|||||||
return h.deleteChildResource(
|
return h.deleteChildResource(
|
||||||
"entrypointID", &database.Entrypoint{},
|
"entrypointID", &database.Entrypoint{},
|
||||||
"failed to delete entrypoint",
|
"failed to delete entrypoint",
|
||||||
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleTargetDelete handles deleting a target.
|
// HandleTargetDelete handles deleting a target. Deleting the
|
||||||
|
// last database target of a webhook leaves its archive writer
|
||||||
|
// with nothing to write, so the writer is evicted and its
|
||||||
|
// handle closed; the archive file is left on disk.
|
||||||
func (h *Handlers) HandleTargetDelete() http.HandlerFunc {
|
func (h *Handlers) HandleTargetDelete() http.HandlerFunc {
|
||||||
return h.deleteChildResource(
|
return h.deleteChildResource(
|
||||||
"targetID", &database.Target{},
|
"targetID", &database.Target{},
|
||||||
"failed to delete target",
|
"failed to delete target",
|
||||||
|
h.evictArchiveWriterIfUnused,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// deleteChildResource returns a handler that deletes a child
|
// deleteChildResource returns a handler that deletes a child
|
||||||
// resource (entrypoint or target) belonging to a webhook.
|
// resource (entrypoint or target) belonging to a webhook. The
|
||||||
|
// optional afterDelete hook runs with the webhook's id once the
|
||||||
|
// delete has succeeded, before the redirect.
|
||||||
func (h *Handlers) deleteChildResource(
|
func (h *Handlers) deleteChildResource(
|
||||||
idParam string,
|
idParam string,
|
||||||
model any,
|
model any,
|
||||||
errMsg string,
|
errMsg string,
|
||||||
|
afterDelete func(webhookID string),
|
||||||
) http.HandlerFunc {
|
) http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
userID, ok := h.getUserID(r)
|
userID, ok := h.getUserID(r)
|
||||||
@@ -1074,6 +1299,10 @@ func (h *Handlers) deleteChildResource(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if afterDelete != nil {
|
||||||
|
afterDelete(webhook.ID)
|
||||||
|
}
|
||||||
|
|
||||||
http.Redirect(
|
http.Redirect(
|
||||||
w, r,
|
w, r,
|
||||||
"/source/"+webhook.ID,
|
"/source/"+webhook.ID,
|
||||||
|
|||||||
589
internal/handlers/source_management_test.go
Normal file
589
internal/handlers/source_management_test.go
Normal file
@@ -0,0 +1,589 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// sourceTestUserID is the session user id used by the webhook
|
||||||
|
// management tests.
|
||||||
|
sourceTestUserID = "source-test-user"
|
||||||
|
// sourceIDParam is the chi URL parameter naming a webhook.
|
||||||
|
sourceIDParam = "sourceID"
|
||||||
|
)
|
||||||
|
|
||||||
|
// formRequest builds an urlencoded POST to path carrying the given
|
||||||
|
// cookies, plus any chi URL parameters the handler reads.
|
||||||
|
func formRequest(
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
form url.Values,
|
||||||
|
urlParams map[string]string,
|
||||||
|
) *http.Request {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodPost,
|
||||||
|
path,
|
||||||
|
strings.NewReader(form.Encode()),
|
||||||
|
)
|
||||||
|
req.Header.Set(
|
||||||
|
"Content-Type", "application/x-www-form-urlencoded",
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
for k, v := range urlParams {
|
||||||
|
rctx.URLParams.Add(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
return req.WithContext(
|
||||||
|
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getRequest builds a GET to path carrying the given cookies, plus any
|
||||||
|
// chi URL parameters the handler reads.
|
||||||
|
func getRequest(
|
||||||
|
t *testing.T,
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
urlParams map[string]string,
|
||||||
|
) *http.Request {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, path, nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
for k, v := range urlParams {
|
||||||
|
rctx.URLParams.Add(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
return req.WithContext(
|
||||||
|
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// submitCreate posts the webhook creation form with the given
|
||||||
|
// retention_days value (omitted entirely when retention is nil) and
|
||||||
|
// returns the recorder.
|
||||||
|
func submitCreate(
|
||||||
|
t *testing.T,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
name string,
|
||||||
|
retention *string,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("name", name)
|
||||||
|
|
||||||
|
if retention != nil {
|
||||||
|
form.Set("retention_days", *retention)
|
||||||
|
}
|
||||||
|
|
||||||
|
req := formRequest("/sources/new", cookies, form, nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleSourceCreateSubmit().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
// onlyWebhook loads the single webhook belonging to the test user.
|
||||||
|
func onlyWebhook(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
) database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var webhooks []database.Webhook
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Where("user_id = ?", sourceTestUserID).
|
||||||
|
Find(&webhooks).Error,
|
||||||
|
)
|
||||||
|
require.Len(t, webhooks, 1)
|
||||||
|
|
||||||
|
return webhooks[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedWebhookWithRetention inserts a webhook owned by the test user
|
||||||
|
// with an exact stored retention value, bypassing Webhook.BeforeSave
|
||||||
|
// via a column-level update so that legacy rows can be planted too.
|
||||||
|
func seedWebhookWithRetention(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
retentionDays int,
|
||||||
|
) database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: sourceTestUserID,
|
||||||
|
Name: "seeded",
|
||||||
|
RetentionDays: retentionDays,
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Model(wh).
|
||||||
|
Update("retention_days", retentionDays).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
wh.RetentionDays = retentionDays
|
||||||
|
|
||||||
|
return *wh
|
||||||
|
}
|
||||||
|
|
||||||
|
// storedRetentionDays reads the retention_days column for a webhook.
|
||||||
|
func storedRetentionDays(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
id string,
|
||||||
|
) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var got int
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Model(&database.Webhook{}).
|
||||||
|
Where("id = ?", id).
|
||||||
|
Pluck("retention_days", &got).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return got
|
||||||
|
}
|
||||||
|
|
||||||
|
// sourceTestEnv bundles the handler, session, and database a webhook
|
||||||
|
// management test drives.
|
||||||
|
type sourceTestEnv struct {
|
||||||
|
handlers *handlers.Handlers
|
||||||
|
db *database.Database
|
||||||
|
cookies []*http.Cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupSourceTest(t *testing.T) *sourceTestEnv {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
var db *database.Database
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
return &sourceTestEnv{
|
||||||
|
handlers: h,
|
||||||
|
db: db,
|
||||||
|
cookies: authenticatedCookies(
|
||||||
|
t, sess, sourceTestUserID, "sourceuser",
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceCreateSubmit_ZeroRetentionPersistsForever is the core
|
||||||
|
// regression test for the bug: the create form's 0 must reach the
|
||||||
|
// database as the retain-forever sentinel rather than being replaced by
|
||||||
|
// the column's default of 30.
|
||||||
|
func TestHandleSourceCreateSubmit_ZeroRetentionPersistsForever(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
zero := "0"
|
||||||
|
|
||||||
|
w := submitCreate(t, env.handlers, env.cookies, "forever", &zero)
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
|
||||||
|
wh := onlyWebhook(t, env.db)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
)
|
||||||
|
assert.True(t, wh.RetainsForever())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleSourceCreateSubmit_OmittedRetentionUsesDefault(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
|
||||||
|
w := submitCreate(t, env.handlers, env.cookies, "defaulted", nil)
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
|
||||||
|
wh := onlyWebhook(t, env.db)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.DefaultRetentionDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceCreate_PrefillsDefaultFromConstant keeps the create
|
||||||
|
// form's pre-filled retention from becoming a third hardcoded copy of
|
||||||
|
// the 30-day policy.
|
||||||
|
func TestHandleSourceCreate_PrefillsDefaultFromConstant(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
env.handlers.HandleSourceCreate().ServeHTTP(
|
||||||
|
w, getRequest(t, "/sources/new", env.cookies, nil),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
|
||||||
|
body := w.Body.String()
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
`value="`+strconv.Itoa(database.DefaultRetentionDays)+`"`,
|
||||||
|
)
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, `max="365"`,
|
||||||
|
"a max below the sentinel would block retain-forever",
|
||||||
|
)
|
||||||
|
assert.Contains(t, body, `min="0"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleSourceCreateSubmit_InvalidRetentionIsRejected(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, raw := range []string{"abc", "-1", "3.5"} {
|
||||||
|
t.Run(raw, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
|
||||||
|
w := submitCreate(
|
||||||
|
t, env.handlers, env.cookies, "bad", &raw,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Body.String(), "Retention must be",
|
||||||
|
)
|
||||||
|
|
||||||
|
var count int64
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.db.DB().Model(&database.Webhook{}).
|
||||||
|
Where("user_id = ?", sourceTestUserID).
|
||||||
|
Count(&count).Error,
|
||||||
|
)
|
||||||
|
assert.Zero(
|
||||||
|
t, count,
|
||||||
|
"no webhook may be created from a rejected form",
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceCreateSubmit_OverflowingRetentionIsRejected covers
|
||||||
|
// the data-loss path directly: a finite retention above the largest one
|
||||||
|
// the reaper's cutoff arithmetic can represent must never reach the
|
||||||
|
// database, because the sweep would compute a future cutoff and delete
|
||||||
|
// every event the webhook has.
|
||||||
|
func TestHandleSourceCreateSubmit_OverflowingRetentionIsRejected(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tooBig := strconv.Itoa(database.MaxFiniteRetentionDays + 1)
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
|
||||||
|
w := submitCreate(t, env.handlers, env.cookies, "huge", &tooBig)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Body.String(),
|
||||||
|
strconv.Itoa(database.MaxFiniteRetentionDays),
|
||||||
|
"the form tells the user the actual ceiling",
|
||||||
|
)
|
||||||
|
|
||||||
|
var count int64
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.db.DB().Model(&database.Webhook{}).
|
||||||
|
Where("user_id = ?", sourceTestUserID).
|
||||||
|
Count(&count).Error,
|
||||||
|
)
|
||||||
|
assert.Zero(
|
||||||
|
t, count,
|
||||||
|
"no webhook may be created from a rejected form",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceCreateSubmit_SentinelIsAcceptedAsForever guards the
|
||||||
|
// boundary between "too large to represent" and "retain forever": the
|
||||||
|
// sentinel is above MaxFiniteRetentionDays, but it is the value the
|
||||||
|
// edit form pre-fills, so it must be accepted rather than rejected as
|
||||||
|
// out of range.
|
||||||
|
func TestHandleSourceCreateSubmit_SentinelIsAcceptedAsForever(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
||||||
|
|
||||||
|
w := submitCreate(t, env.handlers, env.cookies, "forever", &sentinel)
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
|
||||||
|
wh := onlyWebhook(t, env.db)
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceCreateSubmit_RejectedFormKeepsUserInput checks that a
|
||||||
|
// validation failure hands the user's typing back, matching what the
|
||||||
|
// edit form already does. Losing a long description to a mistyped
|
||||||
|
// retention value is the kind of thing that makes people give up on a
|
||||||
|
// form.
|
||||||
|
func TestHandleSourceCreateSubmit_RejectedFormKeepsUserInput(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
|
||||||
|
const (
|
||||||
|
name = "kept-name"
|
||||||
|
description = "a description worth not losing"
|
||||||
|
)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("name", name)
|
||||||
|
form.Set("description", description)
|
||||||
|
form.Set("retention_days", "nonsense")
|
||||||
|
|
||||||
|
req := formRequest("/sources/new", env.cookies, form, nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
env.handlers.HandleSourceCreateSubmit().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusBadRequest, w.Code)
|
||||||
|
|
||||||
|
body := w.Body.String()
|
||||||
|
|
||||||
|
assert.Contains(t, body, `value="`+name+`"`)
|
||||||
|
assert.Contains(t, body, description)
|
||||||
|
}
|
||||||
|
|
||||||
|
// submitEdit posts the webhook edit form for the given webhook.
|
||||||
|
func submitEdit(
|
||||||
|
t *testing.T,
|
||||||
|
env *sourceTestEnv,
|
||||||
|
wh database.Webhook,
|
||||||
|
retention string,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("name", wh.Name)
|
||||||
|
form.Set("description", wh.Description)
|
||||||
|
form.Set("retention_days", retention)
|
||||||
|
|
||||||
|
req := formRequest(
|
||||||
|
"/source/"+wh.ID+"/edit",
|
||||||
|
env.cookies,
|
||||||
|
form,
|
||||||
|
map[string]string{sourceIDParam: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
env.handlers.HandleSourceEditSubmit().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleSourceEditSubmit_ZeroRetentionPersistsForever(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
wh := seedWebhookWithRetention(
|
||||||
|
t, env.db, database.DefaultRetentionDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
w := submitEdit(t, env, wh, "0")
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleSourceEditSubmit_InvalidRetentionIsRejected(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
wh := seedWebhookWithRetention(
|
||||||
|
t, env.db, database.DefaultRetentionDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
w := submitEdit(t, env, wh, "not-a-number")
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusBadRequest, w.Code)
|
||||||
|
assert.Contains(t, w.Body.String(), "Retention must be")
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.DefaultRetentionDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
"a rejected form must not change the stored retention",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleSourceEditSubmit_EmptyRetentionLeavesValueUnchanged(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
wh := seedWebhookWithRetention(t, env.db, 7)
|
||||||
|
|
||||||
|
w := submitEdit(t, env, wh, "")
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
|
||||||
|
assert.Equal(t, 7, storedRetentionDays(t, env.db, wh.ID))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSourceEditForm_ForeverWebhookRoundTrips walks the exact path that
|
||||||
|
// the removed max="365" cap used to break: render the edit form for a
|
||||||
|
// retain-forever webhook, confirm the pre-filled sentinel is not capped
|
||||||
|
// by browser validation, then submit that pre-filled value straight
|
||||||
|
// back and confirm the retention policy survives untouched.
|
||||||
|
func TestSourceEditForm_ForeverWebhookRoundTrips(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
wh := seedWebhookWithRetention(
|
||||||
|
t, env.db, database.RetentionForeverDays,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := getRequest(
|
||||||
|
t, "/source/"+wh.ID+"/edit", env.cookies,
|
||||||
|
map[string]string{sourceIDParam: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
env.handlers.HandleSourceEdit().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
|
||||||
|
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
||||||
|
body := w.Body.String()
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, body, `value="`+sentinel+`"`,
|
||||||
|
"the edit form pre-fills the stored retention",
|
||||||
|
)
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, `max="365"`,
|
||||||
|
"a max below the sentinel would block saving any edit",
|
||||||
|
)
|
||||||
|
// "Currently forever." is the rendered RetentionLabel, not the
|
||||||
|
// static hint below the input, which says "Enter 0 to retain events
|
||||||
|
// forever." A bare Contains of "forever" would pass for any
|
||||||
|
// webhook and would assert nothing about this one.
|
||||||
|
assert.Contains(
|
||||||
|
t, body, "Currently forever.",
|
||||||
|
"the form reports this webhook's policy as forever",
|
||||||
|
)
|
||||||
|
|
||||||
|
// Submit the pre-filled value back, exactly as a browser would.
|
||||||
|
post := submitEdit(t, env, wh, sentinel)
|
||||||
|
require.Equal(t, http.StatusSeeOther, post.Code)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t,
|
||||||
|
database.RetentionForeverDays,
|
||||||
|
storedRetentionDays(t, env.db, wh.ID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSourceListAndDetail_ShowForeverNotTheSentinelNumber checks that
|
||||||
|
// the retain-forever value is never rendered to the user as a raw day
|
||||||
|
// count on either read-only view.
|
||||||
|
func TestSourceListAndDetail_ShowForeverNotTheSentinelNumber(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSourceTest(t)
|
||||||
|
wh := seedWebhookWithRetention(
|
||||||
|
t, env.db, database.RetentionForeverDays,
|
||||||
|
)
|
||||||
|
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
||||||
|
|
||||||
|
listW := httptest.NewRecorder()
|
||||||
|
env.handlers.HandleSourceList().ServeHTTP(
|
||||||
|
listW, getRequest(t, "/sources", env.cookies, nil),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, listW.Code)
|
||||||
|
assert.Contains(t, listW.Body.String(), "Retention: forever")
|
||||||
|
assert.NotContains(t, listW.Body.String(), sentinel)
|
||||||
|
|
||||||
|
detailW := httptest.NewRecorder()
|
||||||
|
env.handlers.HandleSourceDetail().ServeHTTP(
|
||||||
|
detailW,
|
||||||
|
getRequest(
|
||||||
|
t, "/source/"+wh.ID, env.cookies,
|
||||||
|
map[string]string{sourceIDParam: wh.ID},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusOK, detailW.Code)
|
||||||
|
assert.Contains(t, detailW.Body.String(), "Retention: forever")
|
||||||
|
assert.NotContains(t, detailW.Body.String(), sentinel)
|
||||||
|
}
|
||||||
299
internal/handlers/ui_copy_test.go
Normal file
299
internal/handlers/ui_copy_test.go
Normal file
@@ -0,0 +1,299 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strconv"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Template data keys the page templates read. The handlers package has
|
||||||
|
// its own unexported constants for these; this is the external test
|
||||||
|
// package, so it needs its own.
|
||||||
|
const (
|
||||||
|
dataKeyWebhook = "Webhook"
|
||||||
|
dataKeyError = "Error"
|
||||||
|
)
|
||||||
|
|
||||||
|
// testWebhookID is the identifier given to the webhook under test on
|
||||||
|
// pages that render one.
|
||||||
|
const testWebhookID = "wh-1"
|
||||||
|
|
||||||
|
// renderPage renders a page template through the real template set as
|
||||||
|
// an authenticated user and returns the resulting HTML.
|
||||||
|
func renderPage(
|
||||||
|
t *testing.T,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
sess *session.Session,
|
||||||
|
page string,
|
||||||
|
data map[string]any,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(t, sess, "test-user-id", "testuser")
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil,
|
||||||
|
)
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
h.RenderTemplateForTest(w, req, page, data)
|
||||||
|
|
||||||
|
return w.Body.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNavbarUsesWebhookTerminology pins the user-visible navigation
|
||||||
|
// label to "Webhooks". The /sources route is deliberately unchanged, so
|
||||||
|
// the assertion targets the link text rather than the href.
|
||||||
|
func TestNavbarUsesWebhookTerminology(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
// One item, so the list body renders too: it calls
|
||||||
|
// WebhookListItem.RetentionLabel, promoted from the embedded
|
||||||
|
// Webhook and therefore a pointer method. An empty list would
|
||||||
|
// skip that call and hide a template error behind the
|
||||||
|
// navigation assertions below.
|
||||||
|
item := handlers.WebhookListItem{}
|
||||||
|
item.Name = "wh"
|
||||||
|
item.ID = testWebhookID
|
||||||
|
item.RetentionDays = 14
|
||||||
|
|
||||||
|
body := renderPage(t, h, sess, "sources_list.html", map[string]any{
|
||||||
|
"Webhooks": []handlers.WebhookListItem{item},
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Retention: 14 days")
|
||||||
|
assert.Contains(t, body, `class="btn-text">Webhooks</a>`)
|
||||||
|
assert.Contains(
|
||||||
|
t, body, `class="btn-text w-full text-left">Webhooks</a>`,
|
||||||
|
)
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
`<h1 class="text-2xl font-medium text-gray-900">Webhooks</h1>`,
|
||||||
|
)
|
||||||
|
assert.NotContains(
|
||||||
|
t, body, ">Sources<",
|
||||||
|
"no user-visible element may still be labelled Sources",
|
||||||
|
)
|
||||||
|
assert.Contains(
|
||||||
|
t, body, `href="/sources"`,
|
||||||
|
"the /sources route itself must not change",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEditPageUsesWebhookTerminology pins the edit page's heading and
|
||||||
|
// its back link. The link's href still points at /source/{id}, which is
|
||||||
|
// intentional: only user-visible copy changes.
|
||||||
|
func TestEditPageUsesWebhookTerminology(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
// The webhook goes in as a pointer because source_edit.html calls
|
||||||
|
// Webhook.RetentionLabel, a pointer method: a map element is not
|
||||||
|
// addressable, so a value here renders an error instead of the
|
||||||
|
// page.
|
||||||
|
webhook := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||||
|
webhook.ID = testWebhookID
|
||||||
|
|
||||||
|
body := renderPage(t, h, sess, "source_edit.html", map[string]any{
|
||||||
|
dataKeyWebhook: webhook,
|
||||||
|
dataKeyError: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Edit Webhook")
|
||||||
|
assert.NotContains(t, body, ">Sources<")
|
||||||
|
assert.Contains(t, body, `href="/source/wh-1"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCreateFormRetentionCopyMatchesBehaviour pins the create form's
|
||||||
|
// retention copy to what the code does: the reaper permanently deletes
|
||||||
|
// events past the cutoff, an empty field falls back to
|
||||||
|
// DefaultRetentionDays, and 0 is rewritten to the retain-forever
|
||||||
|
// sentinel by Webhook.BeforeSave.
|
||||||
|
func TestCreateFormRetentionCopyMatchesBehaviour(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
body := renderPage(t, h, sess, "sources_new.html", map[string]any{
|
||||||
|
"Name": "",
|
||||||
|
"Description": "",
|
||||||
|
"DefaultRetentionDays": database.DefaultRetentionDays,
|
||||||
|
dataKeyError: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
"permanently deletes events older than this",
|
||||||
|
"the form must say retention is enforced by deletion",
|
||||||
|
)
|
||||||
|
assert.Contains(t, body, "Enter 0 to retain events forever")
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
"leave blank to use the default of "+
|
||||||
|
strconv.Itoa(database.DefaultRetentionDays)+" days",
|
||||||
|
"blank means the default, not forever",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEditFormRetentionCopyMatchesBehaviour pins the edit form's
|
||||||
|
// retention copy, including that it states the stored policy via
|
||||||
|
// RetentionLabel and that an empty field leaves that policy unchanged
|
||||||
|
// rather than meaning forever.
|
||||||
|
func TestEditFormRetentionCopyMatchesBehaviour(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
finite := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||||
|
finite.ID = testWebhookID
|
||||||
|
|
||||||
|
body := renderPage(t, h, sess, "source_edit.html", map[string]any{
|
||||||
|
dataKeyWebhook: finite,
|
||||||
|
dataKeyError: "",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Contains(t, body, "Currently 14 days.")
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
"permanently deletes events older than this",
|
||||||
|
)
|
||||||
|
assert.Contains(t, body, "Enter 0 to retain events forever")
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
"leave blank to keep the current setting",
|
||||||
|
"blank means unchanged, not forever",
|
||||||
|
)
|
||||||
|
|
||||||
|
forever := &database.Webhook{
|
||||||
|
Name: "wh",
|
||||||
|
RetentionDays: database.RetentionForeverDays,
|
||||||
|
}
|
||||||
|
forever.ID = "wh-2"
|
||||||
|
|
||||||
|
foreverBody := renderPage(
|
||||||
|
t, h, sess, "source_edit.html", map[string]any{
|
||||||
|
dataKeyWebhook: forever,
|
||||||
|
dataKeyError: "",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, foreverBody, "Currently forever.",
|
||||||
|
"a retain-forever webhook must not read as a day count",
|
||||||
|
)
|
||||||
|
assert.Contains(
|
||||||
|
t, foreverBody,
|
||||||
|
"No events are deleted while retention is set to forever",
|
||||||
|
)
|
||||||
|
assert.NotContains(
|
||||||
|
t, foreverBody,
|
||||||
|
"permanently deletes events older than this",
|
||||||
|
"the reaper skips retain-forever webhooks, so the form "+
|
||||||
|
"must not claim it deletes their events",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEntrypointCopyButtonIsProgressiveEnhancement proves the copy
|
||||||
|
// affordance degrades: the button ships with the hidden attribute, so a
|
||||||
|
// browser that never runs app.js shows no dead control, and the URL is
|
||||||
|
// rendered as ordinary selectable text either way.
|
||||||
|
func TestEntrypointCopyButtonIsProgressiveEnhancement(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var h *handlers.Handlers
|
||||||
|
|
||||||
|
var sess *session.Session
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
entrypoint := database.Entrypoint{Path: "abc123"}
|
||||||
|
entrypoint.ID = "ep-1"
|
||||||
|
|
||||||
|
// The webhook goes in as a pointer because source_detail.html
|
||||||
|
// calls Webhook.RetentionLabel, a pointer method: a map element
|
||||||
|
// is not addressable, so a value here aborts execution partway
|
||||||
|
// down the page, after the copy button has already been flushed
|
||||||
|
// to the response.
|
||||||
|
webhook := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||||
|
webhook.ID = testWebhookID
|
||||||
|
webhook.CreatedAt = time.Date(
|
||||||
|
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||||
|
)
|
||||||
|
|
||||||
|
body := renderPage(t, h, sess, "source_detail.html", map[string]any{
|
||||||
|
dataKeyWebhook: webhook,
|
||||||
|
"Entrypoints": []database.Entrypoint{entrypoint},
|
||||||
|
// The handler passes delivery.NewTargetViews(targets), never
|
||||||
|
// raw targets, so the test data has to have that same shape.
|
||||||
|
"Targets": delivery.NewTargetViews(nil),
|
||||||
|
"Events": []database.Event{},
|
||||||
|
"BaseURL": "https://hooks.example.com",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
`<code id="entrypoint-url-ep-1"`,
|
||||||
|
)
|
||||||
|
assert.Contains(t, body, "https://hooks.example.com/webhook/abc123")
|
||||||
|
assert.Contains(
|
||||||
|
t, body,
|
||||||
|
`hidden data-copy-target="entrypoint-url-ep-1"`,
|
||||||
|
"the button must start hidden and be revealed by script",
|
||||||
|
)
|
||||||
|
|
||||||
|
// renderTemplate streams to the ResponseWriter, so an abort
|
||||||
|
// midway still leaves everything above it in the body. This pins
|
||||||
|
// content from the last line of the template, which is below the
|
||||||
|
// assertions above: without it, a page that renders the copy
|
||||||
|
// button and then 500s passes.
|
||||||
|
assert.Contains(
|
||||||
|
t, body, "Retention: 14 days",
|
||||||
|
"the page must render to completion, not abort partway",
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -39,12 +39,6 @@ func (h *Handlers) HandleWebhook() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
h.log.Info("webhook request received",
|
|
||||||
"entrypoint_uuid", entrypointUUID,
|
|
||||||
"method", r.Method,
|
|
||||||
"remote_addr", r.RemoteAddr,
|
|
||||||
)
|
|
||||||
|
|
||||||
entrypoint, ok := h.lookupEntrypoint(
|
entrypoint, ok := h.lookupEntrypoint(
|
||||||
w, r, entrypointUUID,
|
w, r, entrypointUUID,
|
||||||
)
|
)
|
||||||
@@ -52,6 +46,18 @@ func (h *Handlers) HandleWebhook() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Logged only once the UUID is known to name a real
|
||||||
|
// entrypoint. The UUID comes straight out of the path on
|
||||||
|
// the one unauthenticated endpoint, so logging it before
|
||||||
|
// the lookup let a client write an INFO line per invented
|
||||||
|
// path; the request itself is already in the access log
|
||||||
|
// and a miss is already logged at DEBUG.
|
||||||
|
h.log.Info("webhook request received",
|
||||||
|
"entrypoint_uuid", entrypointUUID,
|
||||||
|
"method", r.Method,
|
||||||
|
"remote_addr", r.RemoteAddr,
|
||||||
|
)
|
||||||
|
|
||||||
if !entrypoint.Active {
|
if !entrypoint.Active {
|
||||||
http.Error(w, "Gone", http.StatusGone)
|
http.Error(w, "Gone", http.StatusGone)
|
||||||
|
|
||||||
@@ -329,6 +335,7 @@ func (h *Handlers) buildDeliveryTasks(
|
|||||||
DeliveryID: dlv.ID,
|
DeliveryID: dlv.ID,
|
||||||
EventID: event.ID,
|
EventID: event.ID,
|
||||||
WebhookID: entrypoint.WebhookID,
|
WebhookID: entrypoint.WebhookID,
|
||||||
|
EntrypointID: entrypoint.ID,
|
||||||
TargetID: targets[i].ID,
|
TargetID: targets[i].ID,
|
||||||
TargetName: targets[i].Name,
|
TargetName: targets[i].Name,
|
||||||
TargetType: targets[i].Type,
|
TargetType: targets[i].Type,
|
||||||
|
|||||||
57
internal/lifecycle/lifecycle.go
Normal file
57
internal/lifecycle/lifecycle.go
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
// Package lifecycle holds helpers shared by the components that
|
||||||
|
// register fx start and stop hooks.
|
||||||
|
package lifecycle
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
// WaitForShutdown waits for wg to drain, bounded by ctx.
|
||||||
|
//
|
||||||
|
// fx hands OnStop a context carrying the application's stop
|
||||||
|
// timeout. A bare wg.Wait() discards that deadline, so a single
|
||||||
|
// goroutine that never observes cancellation — a delivery target
|
||||||
|
// that never returns, a SQLite operation blocked on a lock —
|
||||||
|
// hangs the process forever instead of letting it exit when the
|
||||||
|
// timeout expires, which is exactly when a clean shutdown matters
|
||||||
|
// most.
|
||||||
|
//
|
||||||
|
// On timeout it logs at error naming component and returns an
|
||||||
|
// error: the goroutines are still running, and reporting success
|
||||||
|
// would hide an unclean shutdown from the operator. The waiting
|
||||||
|
// goroutine outlives this call and exits when (if) wg drains; it
|
||||||
|
// holds nothing but the channel it closes.
|
||||||
|
func WaitForShutdown(
|
||||||
|
ctx context.Context,
|
||||||
|
log *slog.Logger,
|
||||||
|
component string,
|
||||||
|
wg *sync.WaitGroup,
|
||||||
|
) error {
|
||||||
|
done := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
return nil
|
||||||
|
case <-ctx.Done():
|
||||||
|
log.Error(
|
||||||
|
"shutdown timed out, goroutines still running",
|
||||||
|
"component", component,
|
||||||
|
"error", ctx.Err(),
|
||||||
|
)
|
||||||
|
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%s: shutdown timed out, "+
|
||||||
|
"goroutines still running: %w",
|
||||||
|
component, ctx.Err(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
62
internal/lifecycle/lifecycle_test.go
Normal file
62
internal/lifecycle/lifecycle_test.go
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
package lifecycle_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/webhooker/internal/lifecycle"
|
||||||
|
)
|
||||||
|
|
||||||
|
// waitTimeout is the stop budget the timeout case gives a
|
||||||
|
// goroutine that never returns. The test's own patience is the
|
||||||
|
// go test deadline, so the only thing this value affects is how
|
||||||
|
// long the case takes.
|
||||||
|
const waitTimeout = 100 * time.Millisecond
|
||||||
|
|
||||||
|
func discardLogger() *slog.Logger {
|
||||||
|
return slog.New(slog.DiscardHandler)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWaitForShutdown_DrainedGroup(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
|
wg.Go(func() {})
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
lifecycle.WaitForShutdown(
|
||||||
|
context.Background(), discardLogger(),
|
||||||
|
"test component", &wg,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWaitForShutdown_ContextExpires(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
release := make(chan struct{})
|
||||||
|
|
||||||
|
t.Cleanup(func() { close(release) })
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
|
wg.Go(func() { <-release })
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(
|
||||||
|
context.Background(), waitTimeout,
|
||||||
|
)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
err := lifecycle.WaitForShutdown(
|
||||||
|
ctx, discardLogger(), "test component", &wg,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.ErrorIs(t, err, context.DeadlineExceeded)
|
||||||
|
require.ErrorContains(t, err, "test component")
|
||||||
|
}
|
||||||
@@ -25,6 +25,11 @@ func IPFromHostPort(hp string) string {
|
|||||||
return ipFromHostPort(hp)
|
return ipFromHostPort(hp)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ClientKeyForTest exposes clientKey for testing.
|
||||||
|
func ClientKeyForTest(m *Middleware, r *http.Request) string {
|
||||||
|
return m.clientKey(r)
|
||||||
|
}
|
||||||
|
|
||||||
// IsClientTLS exposes isClientTLS for testing.
|
// IsClientTLS exposes isClientTLS for testing.
|
||||||
func IsClientTLS(r *http.Request) bool {
|
func IsClientTLS(r *http.Request) bool {
|
||||||
return isClientTLS(r)
|
return isClientTLS(r)
|
||||||
@@ -32,3 +37,17 @@ func IsClientTLS(r *http.Request) bool {
|
|||||||
|
|
||||||
// LoginRateLimitConst exposes the loginRateLimit constant.
|
// LoginRateLimitConst exposes the loginRateLimit constant.
|
||||||
const LoginRateLimitConst = loginRateLimit
|
const LoginRateLimitConst = loginRateLimit
|
||||||
|
|
||||||
|
// PasswordChangeRateLimitConst exposes the
|
||||||
|
// passwordChangeRateLimit constant.
|
||||||
|
const PasswordChangeRateLimitConst = passwordChangeRateLimit
|
||||||
|
|
||||||
|
// ReceiverAggregateMultiplierConst exposes the
|
||||||
|
// receiverAggregateMultiplier constant.
|
||||||
|
const ReceiverAggregateMultiplierConst = receiverAggregateMultiplier
|
||||||
|
|
||||||
|
// ReceiverAggregateLimitForTest exposes receiverAggregateLimit for
|
||||||
|
// testing.
|
||||||
|
func ReceiverAggregateLimitForTest(perEntrypoint int) int {
|
||||||
|
return receiverAggregateLimit(perEntrypoint)
|
||||||
|
}
|
||||||
|
|||||||
@@ -186,6 +186,10 @@ func (s *Middleware) RequireAuth() func(http.Handler) http.Handler {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IsAuthenticated also enforces both session expiry
|
||||||
|
// deadlines, so an idle-expired or absolutely-expired
|
||||||
|
// session lands here and is sent back to the login
|
||||||
|
// page.
|
||||||
if !s.session.IsAuthenticated(sess) {
|
if !s.session.IsAuthenticated(sess) {
|
||||||
s.log.Debug(
|
s.log.Debug(
|
||||||
"auth middleware: unauthenticated request",
|
"auth middleware: unauthenticated request",
|
||||||
@@ -199,6 +203,26 @@ func (s *Middleware) RequireAuth() func(http.Handler) http.Handler {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This request authenticated with the session, so it
|
||||||
|
// counts as activity: push the idle deadline forward.
|
||||||
|
// This is the only place sessions are refreshed, which
|
||||||
|
// is what keeps an unauthenticated request from
|
||||||
|
// extending someone else's session. Touch advances the
|
||||||
|
// idle clock only -- the absolute cap is untouched --
|
||||||
|
// and reports false when nothing changed, so most
|
||||||
|
// requests do not re-issue the cookie. Save before the
|
||||||
|
// handler runs, while the headers are still ours to
|
||||||
|
// write.
|
||||||
|
if s.session.Touch(sess) {
|
||||||
|
saveErr := s.session.Save(r, w, sess)
|
||||||
|
if saveErr != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"auth middleware: failed to refresh session",
|
||||||
|
"error", saveErr,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
next.ServeHTTP(w, r)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -265,10 +289,56 @@ func (s *Middleware) SecurityHeaders() func(http.Handler) http.Handler {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// MaxBodySize returns middleware that limits the request body size
|
// NoCache returns middleware that instructs browsers and
|
||||||
// for POST requests. If the body exceeds the given limit in
|
// intermediary proxies not to cache the response. It sets
|
||||||
// bytes, the server returns 413 Request Entity Too Large. This
|
// Cache-Control: no-store and Pragma: no-cache (the latter for
|
||||||
// prevents clients from sending arbitrarily large form bodies.
|
// older HTTP/1.0 intermediaries). Apply it to authenticated pages
|
||||||
|
// so webhook configuration and captured event data are not stored
|
||||||
|
// by caches.
|
||||||
|
func (s *Middleware) NoCache() func(http.Handler) http.Handler {
|
||||||
|
return func(next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(
|
||||||
|
w http.ResponseWriter,
|
||||||
|
r *http.Request,
|
||||||
|
) {
|
||||||
|
w.Header().Set("Cache-Control", "no-store")
|
||||||
|
w.Header().Set("Pragma", "no-cache")
|
||||||
|
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// bodyLimitedMethod reports whether the request method carries a
|
||||||
|
// body that the MaxBodySize middleware should cap.
|
||||||
|
func bodyLimitedMethod(method string) bool {
|
||||||
|
return method == http.MethodPost ||
|
||||||
|
method == http.MethodPut ||
|
||||||
|
method == http.MethodPatch
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaxBodySize returns middleware that limits the size of
|
||||||
|
// POST/PUT/PATCH request bodies to maxBytes. It must be registered
|
||||||
|
// before any middleware that parses the body — notably CSRF, which
|
||||||
|
// calls r.PostFormValue — so that form parsing happens under this
|
||||||
|
// cap rather than net/http's 10 MB default.
|
||||||
|
//
|
||||||
|
// Two enforcement paths exist, because http.MaxBytesReader alone
|
||||||
|
// cannot produce a 413: it reports the overflow as an error from
|
||||||
|
// Read, by which point the body parser downstream has already
|
||||||
|
// converted that error into its own response.
|
||||||
|
//
|
||||||
|
// - Declared oversize: the request announces a Content-Length
|
||||||
|
// greater than maxBytes. The middleware answers 413 Request
|
||||||
|
// Entity Too Large immediately and does not call the next
|
||||||
|
// handler, so neither CSRF nor the endpoint handler runs.
|
||||||
|
// - Undeclared oversize: the request is chunked (Content-Length
|
||||||
|
// of -1) or lies about its Content-Length. There is nothing to
|
||||||
|
// check up front, so http.MaxBytesReader hard-caps the body at
|
||||||
|
// maxBytes and the request fails downstream — the form parse
|
||||||
|
// errors out and CSRF rejects it with 403. The response is less
|
||||||
|
// precise than a 413, but the body is still never buffered
|
||||||
|
// beyond the cap, which is the property that matters.
|
||||||
func (s *Middleware) MaxBodySize(
|
func (s *Middleware) MaxBodySize(
|
||||||
maxBytes int64,
|
maxBytes int64,
|
||||||
) func(http.Handler) http.Handler {
|
) func(http.Handler) http.Handler {
|
||||||
@@ -277,14 +347,31 @@ func (s *Middleware) MaxBodySize(
|
|||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
) {
|
) {
|
||||||
if r.Method == http.MethodPost ||
|
if !bodyLimitedMethod(r.Method) {
|
||||||
r.Method == http.MethodPut ||
|
next.ServeHTTP(w, r)
|
||||||
r.Method == http.MethodPatch {
|
|
||||||
r.Body = http.MaxBytesReader(
|
return
|
||||||
w, r.Body, maxBytes,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if r.ContentLength > maxBytes {
|
||||||
|
s.log.Warn(
|
||||||
|
"request body exceeds limit",
|
||||||
|
"method", r.Method,
|
||||||
|
"path", r.URL.Path,
|
||||||
|
"content_length", r.ContentLength,
|
||||||
|
"limit", maxBytes,
|
||||||
|
)
|
||||||
|
http.Error(
|
||||||
|
w,
|
||||||
|
"Request Entity Too Large",
|
||||||
|
http.StatusRequestEntityTooLarge,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, maxBytes)
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
next.ServeHTTP(w, r)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,11 +3,14 @@ package middleware_test
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"encoding/base64"
|
"encoding/base64"
|
||||||
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -28,6 +31,22 @@ func testMiddleware(
|
|||||||
) (*middleware.Middleware, *session.Session) {
|
) (*middleware.Middleware, *session.Session) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
m, s, _ := testMiddlewareWithSessionClock(t, env, 0, nil)
|
||||||
|
|
||||||
|
return m, s
|
||||||
|
}
|
||||||
|
|
||||||
|
// testMiddlewareWithSessionClock is testMiddleware with a
|
||||||
|
// configurable session idle timeout and a manually advanced clock,
|
||||||
|
// for the session-expiry tests. A nil clock uses the real one.
|
||||||
|
func testMiddlewareWithSessionClock(
|
||||||
|
t *testing.T,
|
||||||
|
env string,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
clock *fakeClock,
|
||||||
|
) (*middleware.Middleware, *session.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
os.Stderr,
|
os.Stderr,
|
||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
@@ -35,6 +54,7 @@ func testMiddleware(
|
|||||||
|
|
||||||
cfg := &config.Config{
|
cfg := &config.Config{
|
||||||
Environment: env,
|
Environment: env,
|
||||||
|
SessionIdleTimeout: idleTimeout,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a real session manager with a known key
|
// Create a real session manager with a known key
|
||||||
@@ -53,11 +73,40 @@ func testMiddleware(
|
|||||||
SameSite: http.SameSiteLaxMode,
|
SameSite: http.SameSiteLaxMode,
|
||||||
}
|
}
|
||||||
|
|
||||||
sessManager := session.NewForTest(store, cfg, log, key)
|
var now func() time.Time
|
||||||
|
|
||||||
|
if clock != nil {
|
||||||
|
now = clock.Now
|
||||||
|
}
|
||||||
|
|
||||||
|
sessManager := session.NewForTest(store, cfg, log, key, now)
|
||||||
|
|
||||||
m := middleware.NewForTest(log, cfg, sessManager)
|
m := middleware.NewForTest(log, cfg, sessManager)
|
||||||
|
|
||||||
return m, sessManager
|
return m, sessManager, clock
|
||||||
|
}
|
||||||
|
|
||||||
|
// fakeClock is a manually advanced clock, so session expiry can be
|
||||||
|
// tested without sleeping.
|
||||||
|
type fakeClock struct {
|
||||||
|
t time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Now() time.Time {
|
||||||
|
return c.t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Advance(d time.Duration) {
|
||||||
|
c.t = c.t.Add(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// newFakeClock returns a clock started at a fixed instant.
|
||||||
|
func newFakeClock() *fakeClock {
|
||||||
|
return &fakeClock{
|
||||||
|
t: time.Date(
|
||||||
|
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||||
|
),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Logging Middleware Tests ---
|
// --- Logging Middleware Tests ---
|
||||||
@@ -387,6 +436,367 @@ func TestRequireAuth_UnauthenticatedSession_RedirectsToLogin(
|
|||||||
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- RequireAuth Session Expiry Tests ---
|
||||||
|
|
||||||
|
// loginCookies authenticates a new session and returns the cookies
|
||||||
|
// a browser would then send back.
|
||||||
|
func loginCookies(
|
||||||
|
t *testing.T,
|
||||||
|
sessManager *session.Session,
|
||||||
|
) []*http.Cookie {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/login", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
sess, err := sessManager.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
sessManager.SetUser(sess, "user-123", "testuser")
|
||||||
|
require.NoError(t, sessManager.Save(req, w, sess))
|
||||||
|
|
||||||
|
cookies := w.Result().Cookies()
|
||||||
|
require.NotEmpty(t, cookies, "session cookie should be set")
|
||||||
|
|
||||||
|
return cookies
|
||||||
|
}
|
||||||
|
|
||||||
|
// runAuthed sends a request carrying cookies through RequireAuth
|
||||||
|
// and reports whether the protected handler ran, plus the response.
|
||||||
|
func runAuthed(
|
||||||
|
t *testing.T,
|
||||||
|
m *middleware.Middleware,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
) (bool, *httptest.ResponseRecorder) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var called bool
|
||||||
|
|
||||||
|
handler := m.RequireAuth()(http.HandlerFunc(
|
||||||
|
func(_ http.ResponseWriter, _ *http.Request) {
|
||||||
|
called = true
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet, "/dashboard", nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
handler.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return called, w
|
||||||
|
}
|
||||||
|
|
||||||
|
// sessionCookies filters a response's cookies down to the session
|
||||||
|
// cookie, so tests can tell whether the session was re-issued.
|
||||||
|
func sessionCookies(
|
||||||
|
w *httptest.ResponseRecorder,
|
||||||
|
) []*http.Cookie {
|
||||||
|
var out []*http.Cookie
|
||||||
|
|
||||||
|
for _, c := range w.Result().Cookies() {
|
||||||
|
if c.Name == session.SessionName {
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_IdleExpiredSession_RedirectsToLogin(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
idle := time.Hour
|
||||||
|
|
||||||
|
m, sessManager, clock := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, idle, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := loginCookies(t, sessManager)
|
||||||
|
|
||||||
|
clock.Advance(idle)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, called,
|
||||||
|
"handler should not run for an idle-expired session",
|
||||||
|
)
|
||||||
|
assert.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
||||||
|
assert.Empty(
|
||||||
|
t, sessionCookies(w),
|
||||||
|
"an expired session must not be refreshed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_RefreshesIdleDeadlineOnActivity(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
idle := time.Hour
|
||||||
|
|
||||||
|
m, sessManager, clock := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, idle, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := loginCookies(t, sessManager)
|
||||||
|
|
||||||
|
// Activity halfway through the idle window.
|
||||||
|
clock.Advance(idle / 2)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
require.True(t, called, "handler should run while valid")
|
||||||
|
|
||||||
|
refreshed := sessionCookies(w)
|
||||||
|
require.NotEmpty(
|
||||||
|
t, refreshed,
|
||||||
|
"activity should re-issue the session cookie",
|
||||||
|
)
|
||||||
|
|
||||||
|
// Past the original deadline. The refreshed cookie is still
|
||||||
|
// good; the original one is not.
|
||||||
|
clock.Advance(idle - time.Second)
|
||||||
|
|
||||||
|
calledRefreshed, _ := runAuthed(t, m, refreshed)
|
||||||
|
assert.True(
|
||||||
|
t, calledRefreshed,
|
||||||
|
"refreshed session should outlive the original deadline",
|
||||||
|
)
|
||||||
|
|
||||||
|
calledStale, staleW := runAuthed(t, m, cookies)
|
||||||
|
assert.False(
|
||||||
|
t, calledStale,
|
||||||
|
"the pre-refresh cookie carries the old idle deadline",
|
||||||
|
)
|
||||||
|
assert.Equal(t, http.StatusSeeOther, staleW.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_UnauthenticatedRequestDoesNotRefresh(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m, sessManager, _ := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, time.Hour, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
// A session cookie that exists but was never authenticated.
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/setup", nil)
|
||||||
|
setupW := httptest.NewRecorder()
|
||||||
|
|
||||||
|
sess, err := sessManager.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, sessManager.Save(req, setupW, sess))
|
||||||
|
|
||||||
|
cookies := setupW.Result().Cookies()
|
||||||
|
require.NotEmpty(t, cookies)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
|
||||||
|
assert.False(t, called)
|
||||||
|
assert.Empty(
|
||||||
|
t, sessionCookies(w),
|
||||||
|
"an unauthenticated request must not stamp the session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- NoCache Middleware Tests ---
|
||||||
|
|
||||||
|
func TestNoCache_SetsHeaders(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m, _ := testMiddleware(t, config.EnvironmentDev)
|
||||||
|
|
||||||
|
var called bool
|
||||||
|
|
||||||
|
handler := m.NoCache()(http.HandlerFunc(
|
||||||
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
called = true
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet, "/sources", nil,
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
handler.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, called,
|
||||||
|
"NoCache middleware should call the next handler",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "no-store",
|
||||||
|
w.Header().Get("Cache-Control"),
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "no-cache",
|
||||||
|
w.Header().Get("Pragma"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- MaxBodySize Middleware Tests ---
|
||||||
|
|
||||||
|
const testBodyLimit int64 = 64
|
||||||
|
|
||||||
|
// maxBodySizeHandler wraps a sentinel handler in MaxBodySize with
|
||||||
|
// testBodyLimit. The sentinel records whether it ran and how much of
|
||||||
|
// the body it managed to read, so tests can distinguish "never
|
||||||
|
// reached" from "reached but truncated".
|
||||||
|
type maxBodySizeResult struct {
|
||||||
|
called bool
|
||||||
|
read int
|
||||||
|
readErr error
|
||||||
|
response *httptest.ResponseRecorder
|
||||||
|
}
|
||||||
|
|
||||||
|
func runMaxBodySize(
|
||||||
|
t *testing.T,
|
||||||
|
req *http.Request,
|
||||||
|
) *maxBodySizeResult {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
m, _ := testMiddleware(t, config.EnvironmentDev)
|
||||||
|
res := &maxBodySizeResult{response: httptest.NewRecorder()}
|
||||||
|
|
||||||
|
handler := m.MaxBodySize(testBodyLimit)(http.HandlerFunc(
|
||||||
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
res.called = true
|
||||||
|
|
||||||
|
body, err := io.ReadAll(r.Body)
|
||||||
|
res.read = len(body)
|
||||||
|
res.readErr = err
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
handler.ServeHTTP(res.response, req)
|
||||||
|
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
// postWithBody builds a POST request whose Content-Length is
|
||||||
|
// accurate for the given payload size.
|
||||||
|
func postWithBody(size int) *http.Request {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodPost, "/pages/login",
|
||||||
|
strings.NewReader(strings.Repeat("a", size)),
|
||||||
|
)
|
||||||
|
req.Header.Set(
|
||||||
|
"Content-Type", "application/x-www-form-urlencoded",
|
||||||
|
)
|
||||||
|
|
||||||
|
return req
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaxBodySize_DeclaredOversize_413AndHandlerNotReached(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
res := runMaxBodySize(t, postWithBody(int(testBodyLimit)+1))
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, res.called,
|
||||||
|
"handler must not be reached for an oversized body",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusRequestEntityTooLarge, res.response.Code,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaxBodySize_AtLimit_PassesThrough(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
res := runMaxBodySize(t, postWithBody(int(testBodyLimit)))
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, res.called,
|
||||||
|
"handler should be reached for a body at the limit",
|
||||||
|
)
|
||||||
|
require.NoError(t, res.readErr)
|
||||||
|
assert.Equal(t, int(testBodyLimit), res.read)
|
||||||
|
assert.Equal(t, http.StatusOK, res.response.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaxBodySize_UnderLimit_PassesThrough(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
res := runMaxBodySize(t, postWithBody(1))
|
||||||
|
|
||||||
|
assert.True(t, res.called)
|
||||||
|
require.NoError(t, res.readErr)
|
||||||
|
assert.Equal(t, 1, res.read)
|
||||||
|
assert.Equal(t, http.StatusOK, res.response.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaxBodySize_GetWithOversizeBody_NotCapped(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet, "/pages/login",
|
||||||
|
strings.NewReader(
|
||||||
|
strings.Repeat("a", int(testBodyLimit)+1),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
res := runMaxBodySize(t, req)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, res.called,
|
||||||
|
"GET requests are not subject to the POST body cap",
|
||||||
|
)
|
||||||
|
require.NoError(t, res.readErr)
|
||||||
|
assert.Equal(t, int(testBodyLimit)+1, res.read)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMaxBodySize_UndeclaredOversize_TruncatedAtCap covers the
|
||||||
|
// chunked / lying-Content-Length case: there is nothing to check up
|
||||||
|
// front, so the request reaches the handler but MaxBytesReader
|
||||||
|
// hard-caps the body and the read fails at the limit.
|
||||||
|
func TestMaxBodySize_UndeclaredOversize_TruncatedAtCap(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
req := postWithBody(int(testBodyLimit) + 1)
|
||||||
|
// Simulate a chunked request: no declared length.
|
||||||
|
req.ContentLength = -1
|
||||||
|
|
||||||
|
res := runMaxBodySize(t, req)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, res.called,
|
||||||
|
"an undeclared oversize body cannot be rejected up front",
|
||||||
|
)
|
||||||
|
require.Error(
|
||||||
|
t, res.readErr,
|
||||||
|
"reading past the cap must fail",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, int(testBodyLimit), res.read,
|
||||||
|
"the handler must not see more than the cap",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// --- Helper Tests ---
|
// --- Helper Tests ---
|
||||||
|
|
||||||
func TestIpFromHostPort(t *testing.T) {
|
func TestIpFromHostPort(t *testing.T) {
|
||||||
@@ -440,13 +850,18 @@ func metricsAuthMiddleware(
|
|||||||
store := sessions.NewCookieStore(key)
|
store := sessions.NewCookieStore(key)
|
||||||
store.Options = &sessions.Options{Path: "/", MaxAge: 86400}
|
store.Options = &sessions.Options{Path: "/", MaxAge: 86400}
|
||||||
|
|
||||||
sessManager := session.NewForTest(store, cfg, log, key)
|
sessManager := session.NewForTest(store, cfg, log, key, nil)
|
||||||
|
|
||||||
return middleware.NewForTest(log, cfg, sessManager)
|
return middleware.NewForTest(log, cfg, sessManager)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMetricsAuth_ValidCredentials(t *testing.T) {
|
// runMetricsAuthRequest sends a GET /metrics request with the
|
||||||
t.Parallel()
|
// given basic-auth password through MetricsAuth and reports
|
||||||
|
// whether the wrapped handler ran plus the recorded response.
|
||||||
|
func runMetricsAuthRequest(
|
||||||
|
t *testing.T, password string,
|
||||||
|
) (bool, *httptest.ResponseRecorder) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
m := metricsAuthMiddleware(t)
|
m := metricsAuthMiddleware(t)
|
||||||
|
|
||||||
@@ -464,12 +879,20 @@ func TestMetricsAuth_ValidCredentials(t *testing.T) {
|
|||||||
context.Background(),
|
context.Background(),
|
||||||
http.MethodGet, "/metrics", nil,
|
http.MethodGet, "/metrics", nil,
|
||||||
)
|
)
|
||||||
req.SetBasicAuth("admin", "secret")
|
req.SetBasicAuth("admin", password)
|
||||||
|
|
||||||
w := httptest.NewRecorder()
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
handler.ServeHTTP(w, req)
|
handler.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return called, w
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMetricsAuth_ValidCredentials(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
called, w := runMetricsAuthRequest(t, "secret")
|
||||||
|
|
||||||
assert.True(
|
assert.True(
|
||||||
t, called,
|
t, called,
|
||||||
"handler should be called with valid basic auth",
|
"handler should be called with valid basic auth",
|
||||||
@@ -480,27 +903,7 @@ func TestMetricsAuth_ValidCredentials(t *testing.T) {
|
|||||||
func TestMetricsAuth_InvalidCredentials(t *testing.T) {
|
func TestMetricsAuth_InvalidCredentials(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
m := metricsAuthMiddleware(t)
|
called, w := runMetricsAuthRequest(t, "wrong-password")
|
||||||
|
|
||||||
var called bool
|
|
||||||
|
|
||||||
handler := m.MetricsAuth()(http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
called = true
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
},
|
|
||||||
))
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
context.Background(),
|
|
||||||
http.MethodGet, "/metrics", nil,
|
|
||||||
)
|
|
||||||
req.SetBasicAuth("admin", "wrong-password")
|
|
||||||
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
|
|
||||||
handler.ServeHTTP(w, req)
|
|
||||||
|
|
||||||
assert.False(
|
assert.False(
|
||||||
t, called,
|
t, called,
|
||||||
|
|||||||
@@ -1,7 +1,11 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"math"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/go-chi/httprate"
|
"github.com/go-chi/httprate"
|
||||||
@@ -14,33 +18,290 @@ const (
|
|||||||
|
|
||||||
// loginRateInterval is the time window for the rate limit.
|
// loginRateInterval is the time window for the rate limit.
|
||||||
loginRateInterval = 1 * time.Minute
|
loginRateInterval = 1 * time.Minute
|
||||||
|
|
||||||
|
// passwordChangeRateLimit is the maximum number of password
|
||||||
|
// change attempts per interval. Each attempt verifies the
|
||||||
|
// current password, so the endpoint must be rate-limited
|
||||||
|
// like any other password-based authentication endpoint.
|
||||||
|
passwordChangeRateLimit = 5
|
||||||
|
|
||||||
|
// passwordChangeRateInterval is the time window for the
|
||||||
|
// password change rate limit.
|
||||||
|
passwordChangeRateInterval = 1 * time.Minute
|
||||||
|
|
||||||
|
// receiverRateInterval is the time window for the webhook
|
||||||
|
// receiver rate limit. The configured limit is expressed in
|
||||||
|
// requests per minute.
|
||||||
|
receiverRateInterval = 1 * time.Minute
|
||||||
|
|
||||||
|
// receiverAggregateMultiplier scales the configured
|
||||||
|
// per-entrypoint receiver limit into the aggregate limit one
|
||||||
|
// client IP may spend across the whole /webhook/* route. Ten
|
||||||
|
// entrypoints' worth lets a single sender address drive several
|
||||||
|
// entrypoints at their full rate, while still capping what one
|
||||||
|
// address costs the unauthenticated receiver.
|
||||||
|
receiverAggregateMultiplier = 10
|
||||||
|
|
||||||
|
// maxForwardedHops bounds how many X-Forwarded-For entries the
|
||||||
|
// chain walk examines. Real chains are one to three hops, but a
|
||||||
|
// client can pad the header up to MaxHeaderBytes, so without a
|
||||||
|
// bound every request pays a walk proportional to whatever the
|
||||||
|
// client sent.
|
||||||
|
maxForwardedHops = 64
|
||||||
|
|
||||||
|
// ipv6BucketBits is the prefix length IPv6 clients are bucketed
|
||||||
|
// on. A routed /64 is the normal residential and mobile
|
||||||
|
// allocation, so it is the unit an attacker gets addresses in
|
||||||
|
// and therefore the unit worth limiting.
|
||||||
|
ipv6BucketBits = 64
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// normalizeAddr strips the IPv4-in-IPv6 wrapper and any zone from
|
||||||
|
// addr so that comparisons and bucket keys are canonical.
|
||||||
|
func normalizeAddr(addr netip.Addr) netip.Addr {
|
||||||
|
return addr.Unmap().WithZone("")
|
||||||
|
}
|
||||||
|
|
||||||
|
// bucketKey is the rate-limit bucket identity of a client address.
|
||||||
|
// IPv4 keys on the full address; IPv6 keys on its /64 prefix,
|
||||||
|
// because keying IPv6 per /128 lets one ordinary subscriber rotate
|
||||||
|
// source addresses inside its own routed /64 and mint a fresh bucket
|
||||||
|
// per request — evading every limiter here at the network layer,
|
||||||
|
// with no spoofing and nothing to detect.
|
||||||
|
//
|
||||||
|
// An IPv4-mapped address (::ffff:1.2.3.4) is keyed as the IPv4
|
||||||
|
// address it carries, never masked to a /64: mapped form all shares
|
||||||
|
// the ::ffff:0:0/96 prefix, so masking would collapse every IPv4
|
||||||
|
// client reaching a proxy that emits it into one bucket. Callers
|
||||||
|
// pass addresses through normalizeAddr, which already unmaps; the
|
||||||
|
// unmap here keeps the property true of the key function itself.
|
||||||
|
//
|
||||||
|
// The two families cannot collide: an IPv4 key is a bare dotted
|
||||||
|
// quad, and an IPv6 key always carries a "/64" suffix.
|
||||||
|
func bucketKey(addr netip.Addr) string {
|
||||||
|
addr = addr.Unmap()
|
||||||
|
|
||||||
|
if addr.Is4() {
|
||||||
|
return addr.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prefix errors only on a negative bit count, on over 32 bits
|
||||||
|
// for an IPv4 address, or on over 128 for IPv6. The count here
|
||||||
|
// is the constant 64 and the IPv4 case returned above, so the
|
||||||
|
// error is unreachable. (The zero Addr does not error either: it
|
||||||
|
// yields the zero Prefix. Neither call site can produce one,
|
||||||
|
// since both parse the address first.)
|
||||||
|
prefix, _ := addr.Prefix(ipv6BucketBits)
|
||||||
|
|
||||||
|
return prefix.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// isTrustedProxy reports whether addr belongs to a network the
|
||||||
|
// operator listed in TRUSTED_PROXIES. The list is empty by default,
|
||||||
|
// so by default nothing is trusted.
|
||||||
|
func (m *Middleware) isTrustedProxy(addr netip.Addr) bool {
|
||||||
|
for _, prefix := range m.params.Config.TrustedProxies {
|
||||||
|
if prefix.Contains(addr) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// forwardedClientAddr returns the client address named by this
|
||||||
|
// request's X-Forwarded-For chain. It is consulted only for requests
|
||||||
|
// whose direct peer is a trusted proxy.
|
||||||
|
//
|
||||||
|
// X-Forwarded-For is the only header read. X-Real-IP and
|
||||||
|
// True-Client-IP are deliberately ignored: the reverse proxies in
|
||||||
|
// common use append to X-Forwarded-For and pass any other header the
|
||||||
|
// client sent through untouched, so believing a single-valued header
|
||||||
|
// would let a client behind the trusted proxy name its own bucket —
|
||||||
|
// the very bypass this gating exists to close.
|
||||||
|
//
|
||||||
|
// The chain is walked right to left, because the rightmost entry is
|
||||||
|
// the one the nearest proxy appended and everything to its left may
|
||||||
|
// have been written by the client. The first hop that is not itself
|
||||||
|
// a trusted proxy is the client. A hop that cannot be read as a bare
|
||||||
|
// address ends the walk: past it the chain is not the shape assumed
|
||||||
|
// here, so the caller falls back to the peer address.
|
||||||
|
//
|
||||||
|
// Only the last maxForwardedHops entries are examined. A longer chain
|
||||||
|
// is padding, and running out of hops falls back to the peer address
|
||||||
|
// the same way an unreadable hop does.
|
||||||
|
//
|
||||||
|
// The entries are cut off the right end of each header value in place
|
||||||
|
// rather than split out of it: the receiver is unauthenticated and a
|
||||||
|
// client can pad the header up to MaxHeaderBytes, so splitting would
|
||||||
|
// allocate in proportion to the padding (about 8 MB for a 1 MB
|
||||||
|
// header) before the cap could discard any of it. Multiple header
|
||||||
|
// values are walked in reverse for the same reason, since joining
|
||||||
|
// them copies the whole chain.
|
||||||
|
func (m *Middleware) forwardedClientAddr(
|
||||||
|
r *http.Request,
|
||||||
|
) (netip.Addr, bool) {
|
||||||
|
seen := 0
|
||||||
|
|
||||||
|
for _, value := range slices.Backward(
|
||||||
|
r.Header.Values("X-Forwarded-For"),
|
||||||
|
) {
|
||||||
|
for last := false; !last && seen < maxForwardedHops; seen++ {
|
||||||
|
hop := value
|
||||||
|
|
||||||
|
comma := strings.LastIndexByte(value, ',')
|
||||||
|
if comma < 0 {
|
||||||
|
last = true
|
||||||
|
} else {
|
||||||
|
hop, value = value[comma+1:], value[:comma]
|
||||||
|
}
|
||||||
|
|
||||||
|
hop = strings.TrimSpace(hop)
|
||||||
|
if hop == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, err := netip.ParseAddr(hop)
|
||||||
|
if err != nil {
|
||||||
|
return netip.Addr{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if addr = normalizeAddr(addr); !m.isTrustedProxy(addr) {
|
||||||
|
return addr, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return netip.Addr{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// rateLimitKey is the client identity every rate limiter in this
|
||||||
|
// package buckets on. Forwarded headers are honoured only when the
|
||||||
|
// direct peer (RemoteAddr) is inside the configured trusted-proxy
|
||||||
|
// set; otherwise the peer address itself is the key. Without that
|
||||||
|
// gate any client could mint a fresh bucket per request, or starve
|
||||||
|
// another client's bucket, by picking an X-Forwarded-For value —
|
||||||
|
// which makes every limit here decorative against a deliberate
|
||||||
|
// attacker.
|
||||||
|
//
|
||||||
|
// The address that identifies the client is then reduced to a bucket
|
||||||
|
// by bucketKey: full address for IPv4, /64 prefix for IPv6.
|
||||||
|
func (m *Middleware) rateLimitKey(r *http.Request) (string, error) {
|
||||||
|
return m.clientKey(r), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// clientKey computes the bucket key described on rateLimitKey.
|
||||||
|
func (m *Middleware) clientKey(r *http.Request) string {
|
||||||
|
peer, err := netip.ParseAddr(ipFromHostPort(r.RemoteAddr))
|
||||||
|
if err != nil {
|
||||||
|
// Not an address we can reason about; key on the raw
|
||||||
|
// value, the most specific identity left. Distinct
|
||||||
|
// RemoteAddr values stay in distinct buckets, so this
|
||||||
|
// path cannot silently collapse unrelated clients
|
||||||
|
// together. On a Unix-socket listener every peer
|
||||||
|
// carries the same RemoteAddr and so shares one bucket,
|
||||||
|
// which is the fail-closed direction.
|
||||||
|
return r.RemoteAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
peer = normalizeAddr(peer)
|
||||||
|
if !m.isTrustedProxy(peer) {
|
||||||
|
return bucketKey(peer)
|
||||||
|
}
|
||||||
|
|
||||||
|
if addr, ok := m.forwardedClientAddr(r); ok {
|
||||||
|
return bucketKey(addr)
|
||||||
|
}
|
||||||
|
|
||||||
|
return bucketKey(peer)
|
||||||
|
}
|
||||||
|
|
||||||
|
// tooManyRequests returns the 429 handler used by the login,
|
||||||
|
// password-change and per-entrypoint receiver limiters: it logs the
|
||||||
|
// rejection with logMessage and answers with responseMessage.
|
||||||
|
// httprate adds the Retry-After header (RFC 6585). The aggregate
|
||||||
|
// receiver limiter uses floodTooManyRequests instead.
|
||||||
|
func (m *Middleware) tooManyRequests(
|
||||||
|
logMessage, responseMessage string,
|
||||||
|
) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
m.log.Warn(logMessage, "path", r.URL.Path)
|
||||||
|
http.Error(w, responseMessage, http.StatusTooManyRequests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// floodTooManyRequests returns the 429 handler for a limiter whose
|
||||||
|
// rejections are themselves the flood: it logs at DEBUG and without
|
||||||
|
// the path, then answers with responseMessage.
|
||||||
|
//
|
||||||
|
// The aggregate receiver limiter trips exactly when one address is
|
||||||
|
// sending faster than the receiver wants to serve, so its rejection
|
||||||
|
// log is one line per request of that flood. At WARN with "path" that
|
||||||
|
// hands a client a way to write its own text into the operator's log,
|
||||||
|
// at a level that trips alerting, once per request — the log-volume
|
||||||
|
// problem this limiter exists to bound. DEBUG is off in production by
|
||||||
|
// default, so a flood costs nothing here; the path is dropped so that
|
||||||
|
// turning DEBUG on to diagnose one does not restore the problem.
|
||||||
|
//
|
||||||
|
// This limiter bounds the database work an invented path costs, not
|
||||||
|
// the number of log lines it produces: the access log in
|
||||||
|
// middleware.go still records every request, served or rejected.
|
||||||
|
func (m *Middleware) floodTooManyRequests(
|
||||||
|
logMessage, responseMessage string,
|
||||||
|
) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
m.log.Debug(logMessage)
|
||||||
|
http.Error(w, responseMessage, http.StatusTooManyRequests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// LoginRateLimit returns middleware that enforces per-IP rate
|
// LoginRateLimit returns middleware that enforces per-IP rate
|
||||||
// limiting on login attempts using go-chi/httprate. Only POST
|
// limiting on login attempts using go-chi/httprate. Only POST
|
||||||
// requests are rate-limited; GET requests (rendering the login
|
// requests are rate-limited; GET requests (rendering the login
|
||||||
// form) pass through unaffected. When the rate limit is exceeded,
|
// form) pass through unaffected. When the rate limit is exceeded,
|
||||||
// a 429 Too Many Requests response is returned. IP extraction
|
// a 429 Too Many Requests response is returned. Clients are
|
||||||
// honours X-Forwarded-For, X-Real-IP, and True-Client-IP headers
|
// identified by rateLimitKey.
|
||||||
// for reverse-proxy setups.
|
|
||||||
func (m *Middleware) LoginRateLimit() func(http.Handler) http.Handler {
|
func (m *Middleware) LoginRateLimit() func(http.Handler) http.Handler {
|
||||||
limiter := httprate.Limit(
|
return m.postRateLimit(
|
||||||
loginRateLimit,
|
loginRateLimit,
|
||||||
loginRateInterval,
|
loginRateInterval,
|
||||||
httprate.WithKeyFuncs(httprate.KeyByRealIP),
|
"login rate limit exceeded",
|
||||||
httprate.WithLimitHandler(http.HandlerFunc(
|
"Too many login attempts. Please try again later.",
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
m.log.Warn("login rate limit exceeded",
|
|
||||||
"path", r.URL.Path,
|
|
||||||
)
|
)
|
||||||
http.Error(
|
}
|
||||||
w,
|
|
||||||
"Too many login attempts. "+
|
// PasswordChangeRateLimit returns middleware that enforces
|
||||||
|
// per-IP rate limiting on password change attempts. The change
|
||||||
|
// endpoint verifies the current password, so without a limit a
|
||||||
|
// stolen session could be used to brute-force it; the limit
|
||||||
|
// matches the login endpoint's.
|
||||||
|
func (m *Middleware) PasswordChangeRateLimit() func(http.Handler) http.Handler {
|
||||||
|
return m.postRateLimit(
|
||||||
|
passwordChangeRateLimit,
|
||||||
|
passwordChangeRateInterval,
|
||||||
|
"password change rate limit exceeded",
|
||||||
|
"Too many password change attempts. "+
|
||||||
"Please try again later.",
|
"Please try again later.",
|
||||||
http.StatusTooManyRequests,
|
|
||||||
)
|
)
|
||||||
},
|
}
|
||||||
)),
|
|
||||||
|
// postRateLimit builds middleware that enforces a per-IP rate
|
||||||
|
// limit on POST requests only; all other methods pass through
|
||||||
|
// unaffected. Requests over the limit receive a 429 with the
|
||||||
|
// given response message, and each rejection is logged with the
|
||||||
|
// given log message. Clients are identified by rateLimitKey.
|
||||||
|
func (m *Middleware) postRateLimit(
|
||||||
|
limit int,
|
||||||
|
interval time.Duration,
|
||||||
|
logMessage, responseMessage string,
|
||||||
|
) func(http.Handler) http.Handler {
|
||||||
|
limiter := httprate.Limit(
|
||||||
|
limit,
|
||||||
|
interval,
|
||||||
|
httprate.WithKeyFuncs(m.rateLimitKey),
|
||||||
|
httprate.WithLimitHandler(
|
||||||
|
m.tooManyRequests(logMessage, responseMessage),
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
return func(next http.Handler) http.Handler {
|
return func(next http.Handler) http.Handler {
|
||||||
@@ -50,8 +311,7 @@ func (m *Middleware) LoginRateLimit() func(http.Handler) http.Handler {
|
|||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
) {
|
) {
|
||||||
// Only rate-limit POST requests (actual login
|
// Only rate-limit POST requests.
|
||||||
// attempts)
|
|
||||||
if r.Method != http.MethodPost {
|
if r.Method != http.MethodPost {
|
||||||
next.ServeHTTP(w, r)
|
next.ServeHTTP(w, r)
|
||||||
|
|
||||||
@@ -62,3 +322,63 @@ func (m *Middleware) LoginRateLimit() func(http.Handler) http.Handler {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ReceiverRateLimit returns middleware that rate-limits the public
|
||||||
|
// webhook receiver endpoint with two limits in series.
|
||||||
|
//
|
||||||
|
// The inner limit is per client IP per request path: the path
|
||||||
|
// contains the entrypoint UUID, so each sender is limited per
|
||||||
|
// entrypoint without affecting other senders or other entrypoints.
|
||||||
|
// It is Config.ReceiverRateLimit requests per minute.
|
||||||
|
//
|
||||||
|
// That limit alone bounds nothing in aggregate. The route pattern
|
||||||
|
// /webhook/{uuid} matches any single segment, so a client that
|
||||||
|
// invents a fresh path per request mints a fresh bucket per request
|
||||||
|
// and never refills one — and every such request still reaches the
|
||||||
|
// handler's entrypoint lookup before it 404s. The outer limit is
|
||||||
|
// therefore keyed on the client IP alone, capping what one address
|
||||||
|
// can spend across the whole route however it varies the path.
|
||||||
|
//
|
||||||
|
// Requests over either limit receive a 429. Clients are identified
|
||||||
|
// by rateLimitKey.
|
||||||
|
func (m *Middleware) ReceiverRateLimit() func(http.Handler) http.Handler {
|
||||||
|
perEntrypoint := httprate.Limit(
|
||||||
|
m.params.Config.ReceiverRateLimit,
|
||||||
|
receiverRateInterval,
|
||||||
|
httprate.WithKeyFuncs(
|
||||||
|
m.rateLimitKey,
|
||||||
|
httprate.KeyByEndpoint,
|
||||||
|
),
|
||||||
|
httprate.WithLimitHandler(m.tooManyRequests(
|
||||||
|
"webhook receiver rate limit exceeded",
|
||||||
|
"Too many requests. Please slow down.",
|
||||||
|
)),
|
||||||
|
)
|
||||||
|
|
||||||
|
aggregate := httprate.Limit(
|
||||||
|
receiverAggregateLimit(m.params.Config.ReceiverRateLimit),
|
||||||
|
receiverRateInterval,
|
||||||
|
httprate.WithKeyFuncs(m.rateLimitKey),
|
||||||
|
httprate.WithLimitHandler(m.floodTooManyRequests(
|
||||||
|
"webhook receiver aggregate rate limit exceeded",
|
||||||
|
"Too many requests. Please slow down.",
|
||||||
|
)),
|
||||||
|
)
|
||||||
|
|
||||||
|
return func(next http.Handler) http.Handler {
|
||||||
|
return aggregate(perEntrypoint(next))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// receiverAggregateLimit is the per-IP aggregate limit derived from
|
||||||
|
// the configured per-entrypoint limit. The operator sets the latter
|
||||||
|
// and nothing bounds it from above, so the multiplication is
|
||||||
|
// saturated rather than allowed to wrap into a negative limit that
|
||||||
|
// would reject every request.
|
||||||
|
func receiverAggregateLimit(perEntrypoint int) int {
|
||||||
|
if perEntrypoint > math.MaxInt/receiverAggregateMultiplier {
|
||||||
|
return math.MaxInt
|
||||||
|
}
|
||||||
|
|
||||||
|
return perEntrypoint * receiverAggregateMultiplier
|
||||||
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
36
internal/server/export_test.go
Normal file
36
internal/server/export_test.go
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/middleware"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MaxFormBodySizeForTest exposes the form body cap so tests can
|
||||||
|
// build requests that sit exactly at, below, and above it.
|
||||||
|
const MaxFormBodySizeForTest = maxFormBodySize
|
||||||
|
|
||||||
|
// NewRouterForTest builds the real route tree via SetupRoutes with
|
||||||
|
// the supplied middleware and handlers, bypassing the fx lifecycle
|
||||||
|
// and the HTTP listener. Tests use it so that route-group middleware
|
||||||
|
// registration order is exercised exactly as it ships, rather than
|
||||||
|
// against a hand-rebuilt chain that could drift from routes.go.
|
||||||
|
func NewRouterForTest(
|
||||||
|
log *slog.Logger,
|
||||||
|
cfg *config.Config,
|
||||||
|
mw *middleware.Middleware,
|
||||||
|
h *handlers.Handlers,
|
||||||
|
) http.Handler {
|
||||||
|
s := &Server{
|
||||||
|
log: log,
|
||||||
|
mw: mw,
|
||||||
|
h: h,
|
||||||
|
params: ServerParams{Config: cfg},
|
||||||
|
}
|
||||||
|
s.SetupRoutes()
|
||||||
|
|
||||||
|
return s.router
|
||||||
|
}
|
||||||
@@ -90,8 +90,11 @@ func (s *Server) setupRoutes() {
|
|||||||
|
|
||||||
func (s *Server) setupPageRoutes() {
|
func (s *Server) setupPageRoutes() {
|
||||||
s.router.Route("/pages", func(r chi.Router) {
|
s.router.Route("/pages", func(r chi.Router) {
|
||||||
r.Use(s.mw.CSRF())
|
// MaxBodySize must precede CSRF: gorilla/csrf parses the
|
||||||
|
// form, so the cap has to be installed before it runs.
|
||||||
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
||||||
|
r.Use(s.mw.CSRF())
|
||||||
|
r.Use(s.mw.NoCache())
|
||||||
|
|
||||||
r.Group(func(r chi.Router) {
|
r.Group(func(r chi.Router) {
|
||||||
r.Use(s.mw.LoginRateLimit())
|
r.Use(s.mw.LoginRateLimit())
|
||||||
@@ -105,31 +108,53 @@ func (s *Server) setupPageRoutes() {
|
|||||||
|
|
||||||
func (s *Server) setupUserRoutes() {
|
func (s *Server) setupUserRoutes() {
|
||||||
s.router.Route("/user/{username}", func(r chi.Router) {
|
s.router.Route("/user/{username}", func(r chi.Router) {
|
||||||
|
// MaxBodySize must precede CSRF: gorilla/csrf parses the
|
||||||
|
// form, so the cap has to be installed before it runs.
|
||||||
|
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
||||||
r.Use(s.mw.CSRF())
|
r.Use(s.mw.CSRF())
|
||||||
|
r.Use(s.mw.NoCache())
|
||||||
r.Use(s.mw.RequireAuth())
|
r.Use(s.mw.RequireAuth())
|
||||||
r.Get("/", s.h.HandleProfile())
|
r.Get("/", s.h.HandleProfile())
|
||||||
|
r.With(s.mw.PasswordChangeRateLimit()).Post(
|
||||||
|
"/password", s.h.HandlePasswordChange(),
|
||||||
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) setupSourceRoutes() {
|
func (s *Server) setupSourceRoutes() {
|
||||||
s.router.Route("/sources", func(r chi.Router) {
|
s.router.Route("/sources", func(r chi.Router) {
|
||||||
r.Use(s.mw.CSRF())
|
// MaxBodySize must precede CSRF: gorilla/csrf parses the
|
||||||
r.Use(s.mw.RequireAuth())
|
// form, so the cap has to be installed before it runs.
|
||||||
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
||||||
|
r.Use(s.mw.CSRF())
|
||||||
|
r.Use(s.mw.NoCache())
|
||||||
|
r.Use(s.mw.RequireAuth())
|
||||||
r.Get("/", s.h.HandleSourceList())
|
r.Get("/", s.h.HandleSourceList())
|
||||||
r.Get("/new", s.h.HandleSourceCreate())
|
r.Get("/new", s.h.HandleSourceCreate())
|
||||||
r.Post("/new", s.h.HandleSourceCreateSubmit())
|
r.Post("/new", s.h.HandleSourceCreateSubmit())
|
||||||
})
|
})
|
||||||
|
|
||||||
s.router.Route("/source/{sourceID}", func(r chi.Router) {
|
s.router.Route("/source/{sourceID}", func(r chi.Router) {
|
||||||
r.Use(s.mw.CSRF())
|
// MaxBodySize must precede CSRF: gorilla/csrf parses the
|
||||||
r.Use(s.mw.RequireAuth())
|
// form, so the cap has to be installed before it runs.
|
||||||
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
r.Use(s.mw.MaxBodySize(maxFormBodySize))
|
||||||
|
r.Use(s.mw.CSRF())
|
||||||
|
r.Use(s.mw.NoCache())
|
||||||
|
r.Use(s.mw.RequireAuth())
|
||||||
r.Get("/", s.h.HandleSourceDetail())
|
r.Get("/", s.h.HandleSourceDetail())
|
||||||
r.Get("/edit", s.h.HandleSourceEdit())
|
r.Get("/edit", s.h.HandleSourceEdit())
|
||||||
r.Post("/edit", s.h.HandleSourceEditSubmit())
|
r.Post("/edit", s.h.HandleSourceEditSubmit())
|
||||||
r.Post("/delete", s.h.HandleSourceDelete())
|
r.Post("/delete", s.h.HandleSourceDelete())
|
||||||
r.Get("/logs", s.h.HandleSourceLogs())
|
r.Get("/logs", s.h.HandleSourceLogs())
|
||||||
|
// The log page renders each body only up to its cap, so
|
||||||
|
// this is the only route that serves a whole one. It
|
||||||
|
// belongs to this group for its RequireAuth and
|
||||||
|
// NoCache; see HandleEventBodyDownload for the headers
|
||||||
|
// that keep the bytes it returns inert.
|
||||||
|
r.Get(
|
||||||
|
"/logs/{eventID}/body",
|
||||||
|
s.h.HandleEventBodyDownload(),
|
||||||
|
)
|
||||||
r.Post(
|
r.Post(
|
||||||
"/entrypoints",
|
"/entrypoints",
|
||||||
s.h.HandleEntrypointCreate(),
|
s.h.HandleEntrypointCreate(),
|
||||||
@@ -155,7 +180,7 @@ func (s *Server) setupSourceRoutes() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) setupWebhookRoutes() {
|
func (s *Server) setupWebhookRoutes() {
|
||||||
s.router.HandleFunc(
|
s.router.With(s.mw.ReceiverRateLimit()).HandleFunc(
|
||||||
"/webhook/{uuid}",
|
"/webhook/{uuid}",
|
||||||
s.h.HandleWebhook(),
|
s.h.HandleWebhook(),
|
||||||
)
|
)
|
||||||
|
|||||||
574
internal/server/routes_test.go
Normal file
574
internal/server/routes_test.go
Normal file
@@ -0,0 +1,574 @@
|
|||||||
|
package server_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"html"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"go.uber.org/fx/fxtest"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
"sneak.berlin/go/webhooker/internal/globals"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/healthcheck"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
"sneak.berlin/go/webhooker/internal/middleware"
|
||||||
|
"sneak.berlin/go/webhooker/internal/server"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
"sneak.berlin/go/webhooker/static"
|
||||||
|
)
|
||||||
|
|
||||||
|
// csrfCookieName is the cookie gorilla/csrf issues when it runs. Its
|
||||||
|
// presence or absence on a response is how these tests tell whether
|
||||||
|
// the CSRF middleware executed.
|
||||||
|
const csrfCookieName = "_gorilla_csrf"
|
||||||
|
|
||||||
|
type noopNotifier struct{}
|
||||||
|
|
||||||
|
func (n *noopNotifier) Notify([]delivery.Task) {}
|
||||||
|
|
||||||
|
// noopEvictor satisfies handlers.New's delivery.WebhookEvictor
|
||||||
|
// dependency. These tests never delete a webhook, so there is
|
||||||
|
// nothing to record.
|
||||||
|
type noopEvictor struct{}
|
||||||
|
|
||||||
|
func (e *noopEvictor) EvictWebhook(string) {}
|
||||||
|
|
||||||
|
// testEnv is the real router from routes.go plus the collaborators
|
||||||
|
// tests need to seed users and forge sessions.
|
||||||
|
type testEnv struct {
|
||||||
|
router http.Handler
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
}
|
||||||
|
|
||||||
|
// newTestEnv wires the dependency graph with fx and builds the
|
||||||
|
// production route tree, so middleware registration order is
|
||||||
|
// exercised exactly as it ships.
|
||||||
|
func newTestEnv(t *testing.T) *testEnv {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var (
|
||||||
|
log *logger.Logger
|
||||||
|
cfg *config.Config
|
||||||
|
mw *middleware.Middleware
|
||||||
|
hnd *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
dbMgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
func() *config.Config {
|
||||||
|
return &config.Config{
|
||||||
|
DataDir: t.TempDir(),
|
||||||
|
Environment: config.EnvironmentDev,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
database.New,
|
||||||
|
database.NewWebhookDBManager,
|
||||||
|
healthcheck.New,
|
||||||
|
session.New,
|
||||||
|
func() delivery.Notifier { return &noopNotifier{} },
|
||||||
|
func() delivery.WebhookEvictor { return &noopEvictor{} },
|
||||||
|
middleware.New,
|
||||||
|
handlers.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&log, &cfg, &mw, &hnd, &sess, &db, &dbMgr),
|
||||||
|
)
|
||||||
|
app.RequireStart()
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
return &testEnv{
|
||||||
|
router: server.NewRouterForTest(log.Get(), cfg, mw, hnd),
|
||||||
|
sess: sess,
|
||||||
|
db: db,
|
||||||
|
dbMgr: dbMgr,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// oversizeValue returns a form value one byte past the route-group
|
||||||
|
// body cap, so an encoded form containing it is guaranteed oversize.
|
||||||
|
func oversizeValue() string {
|
||||||
|
return strings.Repeat("a", int(server.MaxFormBodySizeForTest)+1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// csrfCookieSet reports whether the response issued a gorilla/csrf
|
||||||
|
// cookie, which only happens if the CSRF middleware ran.
|
||||||
|
func csrfCookieSet(w *httptest.ResponseRecorder) bool {
|
||||||
|
for _, c := range w.Result().Cookies() {
|
||||||
|
if c.Name == csrfCookieName {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// get issues a GET through the router with the supplied cookies.
|
||||||
|
func (e *testEnv) get(
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, path, nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
e.router.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
// post issues a urlencoded form POST through the router. The body is
|
||||||
|
// a strings.Reader, so the request carries an accurate
|
||||||
|
// Content-Length — the signal MaxBodySize checks up front.
|
||||||
|
func (e *testEnv) post(
|
||||||
|
path string,
|
||||||
|
form url.Values,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodPost, path,
|
||||||
|
strings.NewReader(form.Encode()),
|
||||||
|
)
|
||||||
|
req.Header.Set(
|
||||||
|
"Content-Type", "application/x-www-form-urlencoded",
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
e.router.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
// csrfFrom renders the page at path and returns the CSRF token from
|
||||||
|
// its form together with every cookie needed for the follow-up POST.
|
||||||
|
func (e *testEnv) csrfFrom(
|
||||||
|
t *testing.T,
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
) (string, []*http.Cookie) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
w := e.get(path, cookies)
|
||||||
|
require.Equal(t, http.StatusOK, w.Code)
|
||||||
|
|
||||||
|
pattern := regexp.MustCompile(
|
||||||
|
`name="csrf_token" value="([^"]+)"`,
|
||||||
|
)
|
||||||
|
|
||||||
|
match := pattern.FindStringSubmatch(w.Body.String())
|
||||||
|
require.Len(t, match, 2, "form must embed a CSRF token")
|
||||||
|
|
||||||
|
// html/template escapes "+" and "=" in attribute values, and
|
||||||
|
// gorilla/csrf tokens are standard base64, so the value read
|
||||||
|
// out of the markup has to be unescaped before it is submitted.
|
||||||
|
token := html.UnescapeString(match[1])
|
||||||
|
|
||||||
|
combined := make([]*http.Cookie, 0, len(cookies))
|
||||||
|
combined = append(combined, cookies...)
|
||||||
|
combined = append(combined, w.Result().Cookies()...)
|
||||||
|
|
||||||
|
return token, combined
|
||||||
|
}
|
||||||
|
|
||||||
|
// authCookies forges an authenticated session for the given user.
|
||||||
|
func (e *testEnv) authCookies(
|
||||||
|
t *testing.T,
|
||||||
|
userID, username string,
|
||||||
|
) []*http.Cookie {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/setup", nil,
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
s, err := e.sess.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
e.sess.SetUser(s, userID, username)
|
||||||
|
require.NoError(t, e.sess.Save(req, w, s))
|
||||||
|
|
||||||
|
cookies := w.Result().Cookies()
|
||||||
|
require.NotEmpty(t, cookies, "session cookie should be set")
|
||||||
|
|
||||||
|
return cookies
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedUser creates a user with the given password and returns the
|
||||||
|
// stored hash so tests can assert whether it later changed.
|
||||||
|
func (e *testEnv) seedUser(
|
||||||
|
t *testing.T,
|
||||||
|
username, password string,
|
||||||
|
) (string, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
hash, err := database.HashPassword(password)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
user := &database.User{Username: username, Password: hash}
|
||||||
|
require.NoError(t, e.db.DB().Create(user).Error)
|
||||||
|
|
||||||
|
return user.ID, hash
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedWebhook creates a webhook owned by the given user.
|
||||||
|
func (e *testEnv) seedWebhook(
|
||||||
|
t *testing.T,
|
||||||
|
userID string,
|
||||||
|
) *database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{UserID: userID, Name: "routed"}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
e.db.DB().Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedEvent records one event with the given body in a webhook's
|
||||||
|
// own database.
|
||||||
|
func (e *testEnv) seedEvent(
|
||||||
|
t *testing.T,
|
||||||
|
webhookID, body string,
|
||||||
|
) *database.Event {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
webhookDB, err := e.dbMgr.GetDB(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
event := &database.Event{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: body,
|
||||||
|
ContentType: "application/octet-stream",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
webhookDB.Omit(clause.Associations).Create(event).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return event
|
||||||
|
}
|
||||||
|
|
||||||
|
// storedHash reads the current password hash for a username.
|
||||||
|
func (e *testEnv) storedHash(t *testing.T, username string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var user database.User
|
||||||
|
|
||||||
|
require.NoError(t,
|
||||||
|
e.db.DB().Where("username = ?", username).
|
||||||
|
First(&user).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return user.Password
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /s static group ---
|
||||||
|
|
||||||
|
// TestStaticServesEveryMethod pins what the static mount actually
|
||||||
|
// answers. chi's Mount registers the handler for all methods and
|
||||||
|
// http.FileServer only special-cases HEAD (by suppressing the body),
|
||||||
|
// so a POST or a DELETE to an asset is served the file rather than
|
||||||
|
// refused. The README documents this; the test is what keeps the two
|
||||||
|
// from drifting.
|
||||||
|
func TestStaticServesEveryMethod(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
body, err := static.Static.ReadFile("js/app.js")
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotEmpty(t, body)
|
||||||
|
|
||||||
|
for _, method := range []string{
|
||||||
|
http.MethodGet,
|
||||||
|
http.MethodHead,
|
||||||
|
http.MethodPost,
|
||||||
|
http.MethodPut,
|
||||||
|
http.MethodDelete,
|
||||||
|
} {
|
||||||
|
t.Run(method, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), method,
|
||||||
|
"/s/js/app.js", nil,
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
env.router.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, w.Code,
|
||||||
|
"static mount answers every method")
|
||||||
|
|
||||||
|
if method == http.MethodHead {
|
||||||
|
assert.Empty(t, w.Body.Bytes(),
|
||||||
|
"HEAD must not carry a body")
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(t, body, w.Body.Bytes(),
|
||||||
|
"the asset itself is returned")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /pages group ---
|
||||||
|
|
||||||
|
// TestPagesLogin_OversizeBody_RejectedBeforeCSRF proves the cap runs
|
||||||
|
// ahead of gorilla/csrf: the response is a clean 413 and no CSRF
|
||||||
|
// cookie was issued, so neither the CSRF middleware nor the login
|
||||||
|
// handler ran.
|
||||||
|
func TestPagesLogin_OversizeBody_RejectedBeforeCSRF(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("username", oversizeValue())
|
||||||
|
form.Set("password", "irrelevant")
|
||||||
|
|
||||||
|
w := env.post("/pages/login", form, nil)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusRequestEntityTooLarge, w.Code,
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, csrfCookieSet(w),
|
||||||
|
"CSRF middleware must not run for an oversized body",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPagesLogin_UnderLimit_NoToken_CSRFRejects is the control for
|
||||||
|
// the test above: an identically shaped but under-limit POST does
|
||||||
|
// reach gorilla/csrf, which rejects it and issues its cookie. Without
|
||||||
|
// this, the missing-cookie assertion above would prove nothing.
|
||||||
|
func TestPagesLogin_UnderLimit_NoToken_CSRFRejects(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("username", "someone")
|
||||||
|
form.Set("password", "irrelevant")
|
||||||
|
|
||||||
|
w := env.post("/pages/login", form, nil)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusForbidden, w.Code)
|
||||||
|
assert.True(
|
||||||
|
t, csrfCookieSet(w),
|
||||||
|
"CSRF middleware should run for an under-limit body",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPagesLogin_UnderLimit_ValidToken_ReachesHandler proves the
|
||||||
|
// reorder did not break CSRF token handling: a token harvested from
|
||||||
|
// the rendered login form is still accepted and the request lands in
|
||||||
|
// the handler.
|
||||||
|
func TestPagesLogin_UnderLimit_ValidToken_ReachesHandler(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
token, cookies := env.csrfFrom(t, "/pages/login", nil)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("csrf_token", token)
|
||||||
|
form.Set("username", "nosuchuser")
|
||||||
|
form.Set("password", "wrongpassword")
|
||||||
|
|
||||||
|
w := env.post("/pages/login", form, cookies)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusUnauthorized, w.Code)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Body.String(), "Invalid username or password",
|
||||||
|
"request should reach the login handler",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /user/{username} group ---
|
||||||
|
|
||||||
|
// TestPasswordChange_OversizeBody_RejectedAndPasswordUnchanged
|
||||||
|
// covers the route that previously had no middleware body cap at
|
||||||
|
// all. The request carries a valid session and a valid CSRF token,
|
||||||
|
// so the only thing that can stop it is the size cap; the unchanged
|
||||||
|
// password hash is the observable proof the handler never ran.
|
||||||
|
func TestPasswordChange_OversizeBody_RejectedAndPasswordUnchanged(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
userID, originalHash := env.seedUser(t, "pwuser", "oldpassword")
|
||||||
|
cookies := env.authCookies(t, userID, "pwuser")
|
||||||
|
token, cookies := env.csrfFrom(t, "/user/pwuser/", cookies)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("csrf_token", token)
|
||||||
|
form.Set("current_password", "oldpassword")
|
||||||
|
form.Set("new_password", oversizeValue())
|
||||||
|
form.Set("confirm_password", oversizeValue())
|
||||||
|
|
||||||
|
w := env.post("/user/pwuser/password", form, cookies)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, http.StatusRequestEntityTooLarge, w.Code,
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, originalHash, env.storedHash(t, "pwuser"),
|
||||||
|
"handler must not run, so the password must be unchanged",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPasswordChange_UnderLimit_Succeeds proves that adding the cap
|
||||||
|
// to the /user/{username} group did not break the route it guards.
|
||||||
|
func TestPasswordChange_UnderLimit_Succeeds(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
userID, originalHash := env.seedUser(t, "okuser", "oldpassword")
|
||||||
|
cookies := env.authCookies(t, userID, "okuser")
|
||||||
|
token, cookies := env.csrfFrom(t, "/user/okuser/", cookies)
|
||||||
|
|
||||||
|
form := url.Values{}
|
||||||
|
form.Set("csrf_token", token)
|
||||||
|
form.Set("current_password", "oldpassword")
|
||||||
|
form.Set("new_password", "brandnewpassword")
|
||||||
|
form.Set("confirm_password", "brandnewpassword")
|
||||||
|
|
||||||
|
w := env.post("/user/okuser/password", form, cookies)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, w.Code)
|
||||||
|
assert.NotEqual(
|
||||||
|
t, originalHash, env.storedHash(t, "okuser"),
|
||||||
|
"an under-limit password change should still apply",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /source/{sourceID} group ---
|
||||||
|
|
||||||
|
// TestSourceLogs_TruncationLinkDownloadsTheBody walks the whole
|
||||||
|
// feature the way a user does: render the event log page through
|
||||||
|
// the production router, take the download URL out of the markup
|
||||||
|
// the template emitted, and fetch that URL through the router
|
||||||
|
// again. Nothing here is hand-written, so a typo in either the
|
||||||
|
// route pattern or the template href fails this test — the
|
||||||
|
// handler-level tests cannot catch that, because they forge
|
||||||
|
// their own route context and assert a URL string they wrote
|
||||||
|
// themselves.
|
||||||
|
func TestSourceLogs_TruncationLinkDownloadsTheBody(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
userID, _ := env.seedUser(t, "loguser", "somepassword")
|
||||||
|
cookies := env.authCookies(t, userID, "loguser")
|
||||||
|
|
||||||
|
// Comfortably over the event log page's render cap, so the
|
||||||
|
// page truncates the body and renders the download link at
|
||||||
|
// all. The exact cap is the handlers package's business and
|
||||||
|
// is pinned by its own tests; this only needs to exceed it.
|
||||||
|
stored := strings.Repeat("Z", 64*1024)
|
||||||
|
|
||||||
|
wh := env.seedWebhook(t, userID)
|
||||||
|
env.seedEvent(t, wh.ID, stored)
|
||||||
|
|
||||||
|
page := env.get("/source/"+wh.ID+"/logs", cookies)
|
||||||
|
require.Equal(t, http.StatusOK, page.Code)
|
||||||
|
|
||||||
|
link := regexp.MustCompile(
|
||||||
|
`href="(/source/[^"]+/body)"`,
|
||||||
|
).FindStringSubmatch(page.Body.String())
|
||||||
|
require.Len(
|
||||||
|
t, link, 2,
|
||||||
|
"truncated body should render a download link",
|
||||||
|
)
|
||||||
|
|
||||||
|
w := env.get(html.UnescapeString(link[1]), cookies)
|
||||||
|
|
||||||
|
require.Equal(
|
||||||
|
t, http.StatusOK, w.Code,
|
||||||
|
"the link the page emits must be a live route",
|
||||||
|
)
|
||||||
|
assert.Equal(t, stored, w.Body.String())
|
||||||
|
assert.Equal(
|
||||||
|
t, strconv.Itoa(len(stored)),
|
||||||
|
w.Header().Get("Content-Length"),
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "application/octet-stream",
|
||||||
|
w.Header().Get("Content-Type"),
|
||||||
|
)
|
||||||
|
assert.Contains(
|
||||||
|
t, w.Header().Get("Content-Disposition"), "attachment",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "nosniff", w.Header().Get("X-Content-Type-Options"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSourceLogsBody_OtherUser404s pins that the download route
|
||||||
|
// as registered is behind the auth the group provides and the
|
||||||
|
// ownership check the handler applies: another logged-in user
|
||||||
|
// asking the real router for the same URL gets a 404, and an
|
||||||
|
// unauthenticated request never reaches the handler at all.
|
||||||
|
func TestSourceLogsBody_OtherUser404s(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
ownerID, _ := env.seedUser(t, "owner", "somepassword")
|
||||||
|
wh := env.seedWebhook(t, ownerID)
|
||||||
|
|
||||||
|
const payload = "OWNERS-PAYLOAD-77c1"
|
||||||
|
|
||||||
|
evt := env.seedEvent(t, wh.ID, payload)
|
||||||
|
path := "/source/" + wh.ID + "/logs/" + evt.ID + "/body"
|
||||||
|
|
||||||
|
intruderID, _ := env.seedUser(t, "intruder", "somepassword")
|
||||||
|
intruder := env.authCookies(t, intruderID, "intruder")
|
||||||
|
|
||||||
|
w := env.get(path, intruder)
|
||||||
|
assert.Equal(t, http.StatusNotFound, w.Code)
|
||||||
|
assert.NotContains(t, w.Body.String(), payload)
|
||||||
|
|
||||||
|
anon := env.get(path, nil)
|
||||||
|
assert.Equal(t, http.StatusSeeOther, anon.Code)
|
||||||
|
assert.Equal(t, "/pages/login", anon.Header().Get("Location"))
|
||||||
|
}
|
||||||
50
internal/server/static_assets_test.go
Normal file
50
internal/server/static_assets_test.go
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
package server_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"regexp"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"sneak.berlin/go/webhooker/templates"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestBaseTemplateScriptsAreServed walks every /s/ script the base
|
||||||
|
// template loads on each page and fetches it through the real router.
|
||||||
|
// Alpine.js is fetched at build time rather than committed, so nothing
|
||||||
|
// in the repo guarantees it is present: this is the check that the page
|
||||||
|
// still gets the JavaScript it asks for.
|
||||||
|
func TestBaseTemplateScriptsAreServed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// scriptSrc matches the src of every <script> tag pointing at the
|
||||||
|
// /s/ static mount.
|
||||||
|
scriptSrc := regexp.MustCompile(`<script[^>]+src="(/s/[^"]+)"`)
|
||||||
|
|
||||||
|
base, err := templates.Templates.ReadFile("base.html")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
matches := scriptSrc.FindAllStringSubmatch(string(base), -1)
|
||||||
|
require.NotEmpty(t, matches, "base.html should load scripts from /s/")
|
||||||
|
|
||||||
|
env := newTestEnv(t)
|
||||||
|
|
||||||
|
for _, m := range matches {
|
||||||
|
src := m[1]
|
||||||
|
t.Run(src, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
w := env.get(src, nil)
|
||||||
|
|
||||||
|
require.Equalf(
|
||||||
|
t, http.StatusOK, w.Code,
|
||||||
|
"base.html loads %s but the server does not serve it", src,
|
||||||
|
)
|
||||||
|
assert.NotEmptyf(
|
||||||
|
t, w.Body.Bytes(), "%s is served but empty", src,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
150
internal/session/codec_test.go
Normal file
150
internal/session/codec_test.go
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
package session_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/base64"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gorilla/sessions"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The tests below exercise the securecookie codecs underneath the
|
||||||
|
// store and nothing else: Session.Get only decodes, so no server-side
|
||||||
|
// expiry check takes part in the result. They exist because
|
||||||
|
// NewCookieStore gives its codecs a 30-day max age that assigning
|
||||||
|
// store.Options does not override, which would let the codec accept a
|
||||||
|
// cookie weeks past the cap the cookie attribute advertises.
|
||||||
|
|
||||||
|
// issuedCookie returns a session cookie the store itself wrote.
|
||||||
|
func issuedCookie(t *testing.T, s *session.Session) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
sess.Values["probe"] = "value"
|
||||||
|
require.NoError(t, s.Save(req, w, sess))
|
||||||
|
|
||||||
|
cookies := w.Result().Cookies()
|
||||||
|
require.Len(t, cookies, 1)
|
||||||
|
|
||||||
|
return cookies[0].Value
|
||||||
|
}
|
||||||
|
|
||||||
|
// restamp rewrites the timestamp inside an encoded session cookie and
|
||||||
|
// re-signs it, yielding the cookie the store would have written at
|
||||||
|
// that instant. securecookie stamps the encoding time itself and
|
||||||
|
// exposes no seam to move it, so its wire format is reproduced here:
|
||||||
|
// the base64url payload is "date|value|mac", where mac is HMAC-SHA256
|
||||||
|
// of "name|date|value" under the store's key.
|
||||||
|
func restamp(
|
||||||
|
t *testing.T,
|
||||||
|
encoded string,
|
||||||
|
at time.Time,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
raw, err := base64.URLEncoding.DecodeString(encoded)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
parts := strings.SplitN(string(raw), "|", 3)
|
||||||
|
require.Len(t, parts, 3)
|
||||||
|
|
||||||
|
stamped := fmt.Sprintf("%d|%s", at.Unix(), parts[1])
|
||||||
|
|
||||||
|
mac := hmac.New(sha256.New, testKey())
|
||||||
|
_, err = mac.Write([]byte(session.SessionName + "|" + stamped))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
payload := append([]byte(stamped+"|"), mac.Sum(nil)...)
|
||||||
|
|
||||||
|
return base64.URLEncoding.EncodeToString(payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// decodeCookie feeds value back through the store's decode path.
|
||||||
|
func decodeCookie(
|
||||||
|
t *testing.T,
|
||||||
|
s *session.Session,
|
||||||
|
value string,
|
||||||
|
) (*sessions.Session, error) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
req.AddCookie(&http.Cookie{
|
||||||
|
Name: session.SessionName,
|
||||||
|
Value: value,
|
||||||
|
Path: "/",
|
||||||
|
HttpOnly: true,
|
||||||
|
Secure: true,
|
||||||
|
SameSite: http.SameSiteLaxMode,
|
||||||
|
})
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NotNil(t, sess)
|
||||||
|
|
||||||
|
return sess, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCodec_AcceptsCookieInsideAbsoluteCap(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := testSession(t)
|
||||||
|
|
||||||
|
sess, err := decodeCookie(t, s, restamp(
|
||||||
|
t,
|
||||||
|
issuedCookie(t, s),
|
||||||
|
time.Now().Add(-(testAbsoluteMaxAge-time.Hour)),
|
||||||
|
))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(
|
||||||
|
t, sess.IsNew,
|
||||||
|
"a cookie inside the cap must still decode",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, "value", sess.Values["probe"],
|
||||||
|
"decoding must yield the values that were saved",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCodec_RejectsCookiePastAbsoluteCap(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s := testSession(t)
|
||||||
|
|
||||||
|
sess, err := decodeCookie(t, s, restamp(
|
||||||
|
t,
|
||||||
|
issuedCookie(t, s),
|
||||||
|
time.Now().Add(-(testAbsoluteMaxAge+time.Hour)),
|
||||||
|
))
|
||||||
|
require.Error(
|
||||||
|
t, err,
|
||||||
|
"the codec must refuse a cookie older than the cap",
|
||||||
|
)
|
||||||
|
assert.Contains(
|
||||||
|
t, err.Error(), "expired timestamp",
|
||||||
|
"rejection must come from the codec's age check",
|
||||||
|
)
|
||||||
|
assert.True(
|
||||||
|
t, sess.IsNew,
|
||||||
|
"a cookie past the cap must not populate a session",
|
||||||
|
)
|
||||||
|
assert.Nil(
|
||||||
|
t, sess.Values["probe"],
|
||||||
|
"a cookie past the cap must not yield its values",
|
||||||
|
)
|
||||||
|
}
|
||||||
10
internal/session/export_test.go
Normal file
10
internal/session/export_test.go
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
package session
|
||||||
|
|
||||||
|
import "github.com/gorilla/sessions"
|
||||||
|
|
||||||
|
// NewStore exposes the production cookie-store constructor so tests
|
||||||
|
// exercise the store the application actually runs with, rather than a
|
||||||
|
// lookalike assembled in the test.
|
||||||
|
func NewStore(key []byte, secure bool) *sessions.CookieStore {
|
||||||
|
return newStore(key, secure)
|
||||||
|
}
|
||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"maps"
|
"maps"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -32,6 +33,18 @@ const (
|
|||||||
// status.
|
// status.
|
||||||
AuthenticatedKey = "authenticated"
|
AuthenticatedKey = "authenticated"
|
||||||
|
|
||||||
|
// CreatedAtKey is the session key holding the Unix timestamp at
|
||||||
|
// which the session was authenticated. It anchors the ABSOLUTE
|
||||||
|
// expiry clock and is written exactly once, by SetUser. Nothing
|
||||||
|
// refreshes it: an absolute deadline that moved with activity
|
||||||
|
// would not be a cap at all.
|
||||||
|
CreatedAtKey = "created_at"
|
||||||
|
|
||||||
|
// LastSeenKey is the session key holding the Unix timestamp of
|
||||||
|
// the most recent authenticated request. It anchors the IDLE
|
||||||
|
// expiry clock and is pushed forward by Touch.
|
||||||
|
LastSeenKey = "last_seen"
|
||||||
|
|
||||||
// sessionKeyLength is the required length in bytes for the
|
// sessionKeyLength is the required length in bytes for the
|
||||||
// session authentication key.
|
// session authentication key.
|
||||||
sessionKeyLength = 32
|
sessionKeyLength = 32
|
||||||
@@ -41,6 +54,19 @@ const (
|
|||||||
|
|
||||||
// secondsPerDay is the number of seconds in a day.
|
// secondsPerDay is the number of seconds in a day.
|
||||||
secondsPerDay = 86400
|
secondsPerDay = 86400
|
||||||
|
|
||||||
|
// sessionAbsoluteMaxAge is the hard upper bound on how long a
|
||||||
|
// session may live, measured from CreatedAtKey. Activity never
|
||||||
|
// extends it, so even a continuously used session ends here and
|
||||||
|
// the user has to authenticate again.
|
||||||
|
sessionAbsoluteMaxAge = sessionMaxAgeDays * secondsPerDay * time.Second
|
||||||
|
|
||||||
|
// idleRefreshDivisor rate-limits idle-deadline refreshes. Touch
|
||||||
|
// only rewrites LastSeenKey once the stored value is older than
|
||||||
|
// idleTimeout/idleRefreshDivisor, so an active session is
|
||||||
|
// re-saved at most this many times per idle window instead of
|
||||||
|
// once per request. See Touch for the tradeoff this buys.
|
||||||
|
idleRefreshDivisor = 10
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrSessionKeyLength is returned when the decoded session key
|
// ErrSessionKeyLength is returned when the decoded session key
|
||||||
@@ -62,6 +88,45 @@ type Session struct {
|
|||||||
key []byte // raw 32-byte auth key, also used for CSRF cookie signing
|
key []byte // raw 32-byte auth key, also used for CSRF cookie signing
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
config *config.Config
|
config *config.Config
|
||||||
|
|
||||||
|
// idleTimeout is the sliding inactivity window. A session that
|
||||||
|
// sees no authenticated request within this window expires,
|
||||||
|
// independently of the absolute cap. Non-positive disables idle
|
||||||
|
// expiry and leaves sessionAbsoluteMaxAge as the only bound.
|
||||||
|
idleTimeout time.Duration
|
||||||
|
|
||||||
|
// now reads the current time. Injected so expiry can be tested
|
||||||
|
// without sleeping.
|
||||||
|
now func() time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// cookieOptions returns the cookie attributes used for every session
|
||||||
|
// cookie. MaxAge is deliberately left at its zero value: for a store
|
||||||
|
// it is set through CookieStore.MaxAge (see newStore), and for a
|
||||||
|
// single session it is copied from the store's options.
|
||||||
|
func cookieOptions(secure bool) *sessions.Options {
|
||||||
|
return &sessions.Options{
|
||||||
|
Path: "/",
|
||||||
|
HttpOnly: true,
|
||||||
|
Secure: secure,
|
||||||
|
SameSite: http.SameSiteLaxMode,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// newStore builds the session cookie store.
|
||||||
|
//
|
||||||
|
// The absolute cap MUST be applied with store.MaxAge and not by
|
||||||
|
// assigning store.Options.MaxAge. NewCookieStore gives the underlying
|
||||||
|
// securecookie codecs a 30-day max age of their own, and assigning
|
||||||
|
// Options never touches Codecs -- so a store configured that way still
|
||||||
|
// decodes a 30-day-old cookie, leaving the cookie attribute and the
|
||||||
|
// codec disagreeing about the same policy. store.MaxAge sets both.
|
||||||
|
func newStore(key []byte, secure bool) *sessions.CookieStore {
|
||||||
|
store := sessions.NewCookieStore(key)
|
||||||
|
store.Options = cookieOptions(secure)
|
||||||
|
store.MaxAge(secondsPerDay * sessionMaxAgeDays)
|
||||||
|
|
||||||
|
return store
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new session manager. The cookie store is
|
// New creates a new session manager. The cookie store is
|
||||||
@@ -75,6 +140,8 @@ func New(
|
|||||||
s := &Session{
|
s := &Session{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
config: params.Config,
|
config: params.Config,
|
||||||
|
idleTimeout: params.Config.SessionIdleTimeout,
|
||||||
|
now: time.Now,
|
||||||
}
|
}
|
||||||
|
|
||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
@@ -104,19 +171,8 @@ func New(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
store := sessions.NewCookieStore(keyBytes)
|
|
||||||
|
|
||||||
// Configure cookie options for security
|
|
||||||
store.Options = &sessions.Options{
|
|
||||||
Path: "/",
|
|
||||||
MaxAge: secondsPerDay * sessionMaxAgeDays,
|
|
||||||
HttpOnly: true,
|
|
||||||
Secure: !params.Config.IsDev(),
|
|
||||||
SameSite: http.SameSiteLaxMode,
|
|
||||||
}
|
|
||||||
|
|
||||||
s.key = keyBytes
|
s.key = keyBytes
|
||||||
s.store = store
|
s.store = newStore(keyBytes, !params.Config.IsDev())
|
||||||
s.log.Info("session manager initialized")
|
s.log.Info("session manager initialized")
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -149,29 +205,98 @@ func (s *Session) Save(
|
|||||||
return sess.Save(r, w)
|
return sess.Save(r, w)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetUser sets the user information in the session.
|
// SetUser sets the user information in the session. It starts both
|
||||||
|
// expiry clocks: CreatedAtKey (absolute, never refreshed again) and
|
||||||
|
// LastSeenKey (idle, refreshed by Touch).
|
||||||
func (s *Session) SetUser(
|
func (s *Session) SetUser(
|
||||||
sess *sessions.Session,
|
sess *sessions.Session,
|
||||||
userID, username string,
|
userID, username string,
|
||||||
) {
|
) {
|
||||||
|
now := s.now().Unix()
|
||||||
|
|
||||||
sess.Values[UserIDKey] = userID
|
sess.Values[UserIDKey] = userID
|
||||||
sess.Values[UsernameKey] = username
|
sess.Values[UsernameKey] = username
|
||||||
sess.Values[AuthenticatedKey] = true
|
sess.Values[AuthenticatedKey] = true
|
||||||
|
sess.Values[CreatedAtKey] = now
|
||||||
|
sess.Values[LastSeenKey] = now
|
||||||
}
|
}
|
||||||
|
|
||||||
// ClearUser removes user information from the session.
|
// ClearUser removes user information from the session, including
|
||||||
|
// both expiry timestamps.
|
||||||
func (s *Session) ClearUser(sess *sessions.Session) {
|
func (s *Session) ClearUser(sess *sessions.Session) {
|
||||||
delete(sess.Values, UserIDKey)
|
delete(sess.Values, UserIDKey)
|
||||||
delete(sess.Values, UsernameKey)
|
delete(sess.Values, UsernameKey)
|
||||||
delete(sess.Values, AuthenticatedKey)
|
delete(sess.Values, AuthenticatedKey)
|
||||||
|
delete(sess.Values, CreatedAtKey)
|
||||||
|
delete(sess.Values, LastSeenKey)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsAuthenticated checks if the session has an authenticated
|
// sessionTime reads a Unix-second timestamp stored under key.
|
||||||
// user.
|
func sessionTime(
|
||||||
|
sess *sessions.Session,
|
||||||
|
key string,
|
||||||
|
) (time.Time, bool) {
|
||||||
|
secs, ok := sess.Values[key].(int64)
|
||||||
|
if !ok {
|
||||||
|
return time.Time{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return time.Unix(secs, 0), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAuthenticated checks if the session has an authenticated user
|
||||||
|
// whose session has not passed either expiry deadline. Every
|
||||||
|
// authentication decision goes through here, so neither clock can
|
||||||
|
// be bypassed by a caller that forgets to check it.
|
||||||
func (s *Session) IsAuthenticated(sess *sessions.Session) bool {
|
func (s *Session) IsAuthenticated(sess *sessions.Session) bool {
|
||||||
auth, ok := sess.Values[AuthenticatedKey].(bool)
|
auth, ok := sess.Values[AuthenticatedKey].(bool)
|
||||||
|
if !ok || !auth {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
return ok && auth
|
return !s.expired(sess)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Touch records authenticated activity by pushing the IDLE deadline
|
||||||
|
// forward. It writes LastSeenKey only; CreatedAtKey is left alone so
|
||||||
|
// the absolute cap keeps counting down even for a user who never
|
||||||
|
// stops clicking.
|
||||||
|
//
|
||||||
|
// Callers must only invoke Touch for a request that authenticated
|
||||||
|
// with this session. Refreshing on an unauthenticated request would
|
||||||
|
// let anyone holding a stolen or abandoned cookie keep the session
|
||||||
|
// alive by polling a public endpoint. Touch enforces that itself by
|
||||||
|
// returning false for any session that is not currently
|
||||||
|
// authenticated and unexpired.
|
||||||
|
//
|
||||||
|
// To avoid re-encrypting and re-emitting the session cookie on every
|
||||||
|
// single request, the timestamp is advanced only once it is older
|
||||||
|
// than idleTimeout/idleRefreshDivisor. The tradeoff is that
|
||||||
|
// LastSeenKey lags real activity by up to that much, so a session
|
||||||
|
// can expire slightly early relative to the user's true last
|
||||||
|
// request -- never late.
|
||||||
|
//
|
||||||
|
// Touch reports whether it changed the session; only then does the
|
||||||
|
// caller need to save it.
|
||||||
|
func (s *Session) Touch(sess *sessions.Session) bool {
|
||||||
|
if s.idleTimeout <= 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if !s.IsAuthenticated(sess) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
now := s.now()
|
||||||
|
|
||||||
|
lastSeen, ok := sessionTime(sess, LastSeenKey)
|
||||||
|
if ok && now.Sub(lastSeen) < s.idleTimeout/idleRefreshDivisor {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
sess.Values[LastSeenKey] = now.Unix()
|
||||||
|
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetUserID retrieves the user ID from the session.
|
// GetUserID retrieves the user ID from the session.
|
||||||
@@ -243,13 +368,46 @@ func (s *Session) Regenerate(
|
|||||||
// Apply the standard session options (the destroyed old
|
// Apply the standard session options (the destroyed old
|
||||||
// session had MaxAge = -1, which store.New might inherit
|
// session had MaxAge = -1, which store.New might inherit
|
||||||
// from the cookie).
|
// from the cookie).
|
||||||
newSess.Options = &sessions.Options{
|
newSess.Options = cookieOptions(!s.config.IsDev())
|
||||||
Path: "/",
|
newSess.Options.MaxAge = secondsPerDay * sessionMaxAgeDays
|
||||||
MaxAge: secondsPerDay * sessionMaxAgeDays,
|
|
||||||
HttpOnly: true,
|
|
||||||
Secure: !s.config.IsDev(),
|
|
||||||
SameSite: http.SameSiteLaxMode,
|
|
||||||
}
|
|
||||||
|
|
||||||
return newSess, nil
|
return newSess, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// expired reports whether the session has passed either of its two
|
||||||
|
// independent deadlines. They are deliberately kept apart:
|
||||||
|
//
|
||||||
|
// - the ABSOLUTE deadline is CreatedAtKey + sessionAbsoluteMaxAge.
|
||||||
|
// It is fixed at login and no amount of activity moves it.
|
||||||
|
// - the IDLE deadline is LastSeenKey + idleTimeout. Activity moves
|
||||||
|
// it forward via Touch.
|
||||||
|
//
|
||||||
|
// Whichever comes first ends the session.
|
||||||
|
//
|
||||||
|
// A session that claims to be authenticated but carries no
|
||||||
|
// timestamps predates this check; it is treated as expired so the
|
||||||
|
// user re-authenticates rather than being granted an unbounded
|
||||||
|
// session.
|
||||||
|
func (s *Session) expired(sess *sessions.Session) bool {
|
||||||
|
now := s.now()
|
||||||
|
|
||||||
|
createdAt, ok := sessionTime(sess, CreatedAtKey)
|
||||||
|
if !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if !now.Before(createdAt.Add(sessionAbsoluteMaxAge)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.idleTimeout <= 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
lastSeen, ok := sessionTime(sess, LastSeenKey)
|
||||||
|
if !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return !now.Before(lastSeen.Add(s.idleTimeout))
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import (
|
|||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -17,28 +18,66 @@ import (
|
|||||||
|
|
||||||
const testKeySize = 32
|
const testKeySize = 32
|
||||||
|
|
||||||
// testSession creates a Session with a real cookie store for
|
// testIdleTimeout is the idle window used by the expiry tests.
|
||||||
// testing.
|
const testIdleTimeout = time.Hour
|
||||||
func testSession(t *testing.T) *session.Session {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
|
// testAbsoluteMaxAge restates the documented absolute session cap
|
||||||
|
// independently of the implementation constant.
|
||||||
|
const testAbsoluteMaxAge = 7 * 24 * time.Hour
|
||||||
|
|
||||||
|
// fakeClock is a manually advanced clock, so expiry can be tested
|
||||||
|
// without sleeping.
|
||||||
|
type fakeClock struct {
|
||||||
|
t time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Now() time.Time {
|
||||||
|
return c.t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Advance(d time.Duration) {
|
||||||
|
c.t = c.t.Add(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// testKey returns the fixed session key the tests sign with. The
|
||||||
|
// codec tests re-sign cookies with it, so it must be the same key the
|
||||||
|
// store was built from.
|
||||||
|
func testKey() []byte {
|
||||||
key := make([]byte, testKeySize)
|
key := make([]byte, testKeySize)
|
||||||
|
|
||||||
for i := range key {
|
for i := range key {
|
||||||
key[i] = byte(i + 42)
|
key[i] = byte(i + 42)
|
||||||
}
|
}
|
||||||
|
|
||||||
store := sessions.NewCookieStore(key)
|
return key
|
||||||
store.Options = &sessions.Options{
|
}
|
||||||
Path: "/",
|
|
||||||
MaxAge: 86400 * 7,
|
// testSession creates a Session with a real cookie store and the
|
||||||
HttpOnly: true,
|
// real clock.
|
||||||
Secure: false,
|
func testSession(t *testing.T) *session.Session {
|
||||||
SameSite: http.SameSiteLaxMode,
|
t.Helper()
|
||||||
}
|
|
||||||
|
s, _ := testSessionWithClock(t, testIdleTimeout, nil)
|
||||||
|
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// testSessionWithClock creates a Session with a real cookie store,
|
||||||
|
// the given idle timeout, and a manually advanced clock. Passing a
|
||||||
|
// nil clock uses the real one.
|
||||||
|
func testSessionWithClock(
|
||||||
|
t *testing.T,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
clock *fakeClock,
|
||||||
|
) (*session.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
key := testKey()
|
||||||
|
store := session.NewStore(key, false)
|
||||||
|
|
||||||
cfg := &config.Config{
|
cfg := &config.Config{
|
||||||
Environment: config.EnvironmentDev,
|
Environment: config.EnvironmentDev,
|
||||||
|
SessionIdleTimeout: idleTimeout,
|
||||||
}
|
}
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
@@ -46,7 +85,46 @@ func testSession(t *testing.T) *session.Session {
|
|||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
))
|
))
|
||||||
|
|
||||||
return session.NewForTest(store, cfg, log, key)
|
var now func() time.Time
|
||||||
|
|
||||||
|
if clock != nil {
|
||||||
|
now = clock.Now
|
||||||
|
}
|
||||||
|
|
||||||
|
return session.NewForTest(store, cfg, log, key, now), clock
|
||||||
|
}
|
||||||
|
|
||||||
|
// newFakeClock returns a clock started at a fixed instant.
|
||||||
|
func newFakeClock() *fakeClock {
|
||||||
|
return &fakeClock{
|
||||||
|
t: time.Date(
|
||||||
|
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// authenticatedSession returns a fresh session that has just been
|
||||||
|
// logged in, along with its manager and clock.
|
||||||
|
func authenticatedSession(
|
||||||
|
t *testing.T,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
) (*session.Session, *sessions.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
s, clock := testSessionWithClock(
|
||||||
|
t, idleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s.SetUser(sess, "user-123", "alice")
|
||||||
|
require.True(t, s.IsAuthenticated(sess))
|
||||||
|
|
||||||
|
return s, sess, clock
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Get and Save Tests ---
|
// --- Get and Save Tests ---
|
||||||
@@ -173,8 +251,18 @@ func TestSetUser_SetsAllFields(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetUserID(t *testing.T) {
|
// testSessionGetter exercises a session string getter before and
|
||||||
t.Parallel()
|
// after SetUser: it must report false with an empty value on a
|
||||||
|
// fresh session, then true with the expected value once
|
||||||
|
// SetUser(sess, "user-xyz", "bob") has run.
|
||||||
|
func testSessionGetter(
|
||||||
|
t *testing.T,
|
||||||
|
get func(
|
||||||
|
*session.Session, *sessions.Session,
|
||||||
|
) (string, bool),
|
||||||
|
expected string,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
s := testSession(t)
|
s := testSession(t)
|
||||||
|
|
||||||
@@ -185,44 +273,46 @@ func TestGetUserID(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Before setting user
|
// Before setting user
|
||||||
userID, ok := s.GetUserID(sess)
|
val, ok := get(s, sess)
|
||||||
assert.False(
|
assert.False(
|
||||||
t, ok, "should return false when no user ID is set",
|
t, ok, "should return false before SetUser",
|
||||||
)
|
)
|
||||||
assert.Empty(t, userID)
|
assert.Empty(t, val)
|
||||||
|
|
||||||
// After setting user
|
// After setting user
|
||||||
s.SetUser(sess, "user-xyz", "bob")
|
s.SetUser(sess, "user-xyz", "bob")
|
||||||
|
|
||||||
userID, ok = s.GetUserID(sess)
|
val, ok = get(s, sess)
|
||||||
assert.True(t, ok)
|
assert.True(t, ok)
|
||||||
assert.Equal(t, "user-xyz", userID)
|
assert.Equal(t, expected, val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetUserID(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
testSessionGetter(
|
||||||
|
t,
|
||||||
|
func(
|
||||||
|
s *session.Session, sess *sessions.Session,
|
||||||
|
) (string, bool) {
|
||||||
|
return s.GetUserID(sess)
|
||||||
|
},
|
||||||
|
"user-xyz",
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetUsername(t *testing.T) {
|
func TestGetUsername(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
s := testSession(t)
|
testSessionGetter(
|
||||||
|
t,
|
||||||
req := httptest.NewRequestWithContext(
|
func(
|
||||||
context.Background(), http.MethodGet, "/", nil)
|
s *session.Session, sess *sessions.Session,
|
||||||
|
) (string, bool) {
|
||||||
sess, err := s.Get(req)
|
return s.GetUsername(sess)
|
||||||
require.NoError(t, err)
|
},
|
||||||
|
"bob",
|
||||||
// Before setting user
|
|
||||||
username, ok := s.GetUsername(sess)
|
|
||||||
assert.False(
|
|
||||||
t, ok, "should return false when no username is set",
|
|
||||||
)
|
)
|
||||||
assert.Empty(t, username)
|
|
||||||
|
|
||||||
// After setting user
|
|
||||||
s.SetUser(sess, "user-xyz", "bob")
|
|
||||||
|
|
||||||
username, ok = s.GetUsername(sess)
|
|
||||||
assert.True(t, ok)
|
|
||||||
assert.Equal(t, "bob", username)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- IsAuthenticated Tests ---
|
// --- IsAuthenticated Tests ---
|
||||||
@@ -418,6 +508,291 @@ func TestSessionConstants(t *testing.T) {
|
|||||||
assert.Equal(t, "user_id", session.UserIDKey)
|
assert.Equal(t, "user_id", session.UserIDKey)
|
||||||
assert.Equal(t, "username", session.UsernameKey)
|
assert.Equal(t, "username", session.UsernameKey)
|
||||||
assert.Equal(t, "authenticated", session.AuthenticatedKey)
|
assert.Equal(t, "authenticated", session.AuthenticatedKey)
|
||||||
|
assert.Equal(t, "created_at", session.CreatedAtKey)
|
||||||
|
assert.Equal(t, "last_seen", session.LastSeenKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Expiry Tests ---
|
||||||
|
|
||||||
|
func TestSetUser_StartsBothClocks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
_, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, clock.Now().Unix(), sess.Values[session.CreatedAtKey],
|
||||||
|
"SetUser should anchor the absolute clock",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, clock.Now().Unix(), sess.Values[session.LastSeenKey],
|
||||||
|
"SetUser should anchor the idle clock",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_WithinIdleWindow(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout - time.Second)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"session should still be valid just inside the idle window",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_IdleExpired(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"session should expire once the idle window lapses",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTouch_DoesNotExtendAbsoluteCap is the regression test for the
|
||||||
|
// refresh-the-wrong-clock bug: a session that is used continuously
|
||||||
|
// must survive well past the idle window and still die at the
|
||||||
|
// absolute cap.
|
||||||
|
func TestTouch_DoesNotExtendAbsoluteCap(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
createdAt := sess.Values[session.CreatedAtKey]
|
||||||
|
|
||||||
|
// Stay active: a request every half idle window, right up to
|
||||||
|
// the absolute cap.
|
||||||
|
step := testIdleTimeout / 2
|
||||||
|
steps := int(testAbsoluteMaxAge/step) - 1
|
||||||
|
|
||||||
|
for i := range steps {
|
||||||
|
clock.Advance(step)
|
||||||
|
s.Touch(sess)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"active session should survive the idle window "+
|
||||||
|
"(step %d of %d)", i+1, steps,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// One more step of activity takes the session to exactly the
|
||||||
|
// absolute cap, measured from login. Nothing that happened in
|
||||||
|
// the loop may have moved that deadline.
|
||||||
|
clock.Advance(step)
|
||||||
|
s.Touch(sess)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"activity must not extend the absolute cap",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, createdAt, sess.Values[session.CreatedAtKey],
|
||||||
|
"Touch must never rewrite the absolute-clock anchor",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_RefreshesIdleDeadline(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
// Halfway through the window, activity happens.
|
||||||
|
clock.Advance(testIdleTimeout / 2)
|
||||||
|
assert.True(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should refresh once past the lazy-refresh threshold",
|
||||||
|
)
|
||||||
|
|
||||||
|
// Past the original deadline, but inside the refreshed one.
|
||||||
|
clock.Advance(testIdleTimeout - time.Second)
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"refreshed session should outlive the original deadline",
|
||||||
|
)
|
||||||
|
|
||||||
|
// And it still expires an idle window after that activity.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"refreshed session should expire one window after activity",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_LazyBelowRefreshThreshold(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
before := sess.Values[session.LastSeenKey]
|
||||||
|
|
||||||
|
// A request arriving almost immediately is not worth a cookie
|
||||||
|
// rewrite.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should not rewrite the session below the threshold",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, before, sess.Values[session.LastSeenKey],
|
||||||
|
"last-seen should be unchanged below the threshold",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_RefreshThresholdIsOneTenthOfIdleWindow(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// testRefreshDivisor restates the documented bound independently
|
||||||
|
// of the implementation constant: the idle timestamp is rewritten
|
||||||
|
// once it is a tenth of the idle window old, which is what makes
|
||||||
|
// "expires up to 10% early, never late" true. Both assertions are
|
||||||
|
// needed to pin it -- a larger divisor fails the first, a smaller
|
||||||
|
// one fails the second.
|
||||||
|
const testRefreshDivisor = 10
|
||||||
|
|
||||||
|
threshold := testIdleTimeout / testRefreshDivisor
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(threshold - time.Second)
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch must not rewrite the session below a tenth of the window",
|
||||||
|
)
|
||||||
|
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
assert.True(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch must rewrite the session at a tenth of the window",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_UnauthenticatedSessionIsNotRefreshed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, clock := testSessionWithClock(
|
||||||
|
t, testIdleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout / 2)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"an unauthenticated session must not be refreshed",
|
||||||
|
)
|
||||||
|
|
||||||
|
_, hasLastSeen := sess.Values[session.LastSeenKey]
|
||||||
|
assert.False(
|
||||||
|
t, hasLastSeen,
|
||||||
|
"Touch must not stamp an unauthenticated session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_IdleExpiredSessionIsNotRevived(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout)
|
||||||
|
require.False(t, s.IsAuthenticated(sess))
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"an already expired session must not be refreshed",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"Touch must not revive an expired session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_MissingTimestamps(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, _ := testSessionWithClock(
|
||||||
|
t, testIdleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// A session from before idle expiry existed: authenticated,
|
||||||
|
// but with no timestamps. Fail closed.
|
||||||
|
sess.Values[session.AuthenticatedKey] = true
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"a session with no timestamps should be rejected",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_MissingLastSeen(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, _ := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
delete(sess.Values, session.LastSeenKey)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"a session with no idle anchor should be rejected",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdleTimeoutDisabled_AbsoluteCapStillApplies(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, 0)
|
||||||
|
|
||||||
|
// Idle expiry is off, so an untouched session survives an
|
||||||
|
// arbitrary idle stretch.
|
||||||
|
clock.Advance(testAbsoluteMaxAge - time.Second)
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"idle expiry should be disabled by a non-positive timeout",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should be a no-op when idle expiry is disabled",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The absolute cap still ends it.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"the absolute cap must still apply with idle expiry off",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClearUser_RemovesTimestamps(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, _ := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
s.ClearUser(sess)
|
||||||
|
|
||||||
|
_, hasCreatedAt := sess.Values[session.CreatedAtKey]
|
||||||
|
assert.False(t, hasCreatedAt, "CreatedAtKey should be removed")
|
||||||
|
|
||||||
|
_, hasLastSeen := sess.Values[session.LastSeenKey]
|
||||||
|
assert.False(t, hasLastSeen, "LastSeenKey should be removed")
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Edge Cases ---
|
// --- Edge Cases ---
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package session
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"sneak.berlin/go/webhooker/internal/config"
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
@@ -12,11 +13,28 @@ import (
|
|||||||
// middleware and handler tests to use real session functionality. The key
|
// middleware and handler tests to use real session functionality. The key
|
||||||
// parameter is the raw 32-byte authentication key used for session encryption
|
// parameter is the raw 32-byte authentication key used for session encryption
|
||||||
// and CSRF cookie signing.
|
// and CSRF cookie signing.
|
||||||
func NewForTest(store *sessions.CookieStore, cfg *config.Config, log *slog.Logger, key []byte) *Session {
|
//
|
||||||
|
// The idle timeout is taken from cfg.SessionIdleTimeout, exactly as in
|
||||||
|
// production. The now parameter supplies the clock used for expiry
|
||||||
|
// checks so tests can advance time without sleeping; pass nil for the
|
||||||
|
// real clock.
|
||||||
|
func NewForTest(
|
||||||
|
store *sessions.CookieStore,
|
||||||
|
cfg *config.Config,
|
||||||
|
log *slog.Logger,
|
||||||
|
key []byte,
|
||||||
|
now func() time.Time,
|
||||||
|
) *Session {
|
||||||
|
if now == nil {
|
||||||
|
now = time.Now
|
||||||
|
}
|
||||||
|
|
||||||
return &Session{
|
return &Session{
|
||||||
store: store,
|
store: store,
|
||||||
key: key,
|
key: key,
|
||||||
config: cfg,
|
config: cfg,
|
||||||
log: log,
|
log: log,
|
||||||
|
idleTimeout: cfg.SessionIdleTimeout,
|
||||||
|
now: now,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,16 +5,17 @@
|
|||||||
# or apk (detected in that order); assumes NOTHING is present (not git,
|
# or apk (detected in that order); assumes NOTHING is present (not git,
|
||||||
# make, or go). golangci-lint is packaged in nix, brew, and apk; on apt
|
# make, or go). golangci-lint is packaged in nix, brew, and apk; on apt
|
||||||
# it is installed from a hash-verified GitHub release archive (never
|
# it is installed from a hash-verified GitHub release archive (never
|
||||||
# curl | sh).
|
# curl | sh). Finishes by running script/fetch-assets, which installs the
|
||||||
|
# hash-pinned third-party browser assets the repo does not commit.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
# Pinned versions, 2026-07-07. Never "latest"; exact versions only.
|
# Pinned versions, 2026-08-07. Never "latest"; exact versions only.
|
||||||
GOLANGCI_LINT_VERSION="2.11.3"
|
GOLANGCI_LINT_VERSION="2.12.2"
|
||||||
# sha256 of golangci-lint-2.11.3-linux-<arch>.tar.gz release archives
|
# sha256 of golangci-lint-2.12.2-linux-<arch>.tar.gz release archives
|
||||||
GOLANGCI_LINT_SHA256_AMD64="87bb8cddbcc825d5778b64e8a91b46c0526b247f4e2f2904dea74ec7450475d1"
|
GOLANGCI_LINT_SHA256_AMD64="8df580d2670fed8fa984aac0507099af8df275e665215f5c7a2ae3943893a553"
|
||||||
GOLANGCI_LINT_SHA256_ARM64="ee3d95f301359e7d578e6d99c8ad5aeadbabc5a13009a30b2b0df11c8058afe9"
|
GOLANGCI_LINT_SHA256_ARM64="44cd40a8c76c86755375adfeea52cfd3533cb43d7bd647771e0ae065e166df3a"
|
||||||
|
|
||||||
PKGMGR=""
|
PKGMGR=""
|
||||||
SUDO=""
|
SUDO=""
|
||||||
@@ -115,6 +116,11 @@ main() {
|
|||||||
|
|
||||||
go mod download
|
go mod download
|
||||||
|
|
||||||
|
# Third-party browser assets are not committed; fetch and verify them
|
||||||
|
# so a fresh clone can build and test.
|
||||||
|
if missing curl; then pkg_install curl curl curl curl; fi
|
||||||
|
"$ROOT/script/fetch-assets"
|
||||||
|
|
||||||
echo "bootstrap complete"
|
echo "bootstrap complete"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
104
script/fetch-assets
Executable file
104
script/fetch-assets
Executable file
@@ -0,0 +1,104 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/fetch-assets: download the third-party browser assets the web UI
|
||||||
|
# ships and install them under static/. Minified bundles are not committed
|
||||||
|
# (REPO_POLICIES.md: no build artifacts in version control), so the build
|
||||||
|
# fetches them here. Every download is verified against a hardcoded sha256
|
||||||
|
# before it is installed, and any mismatch aborts. Idempotent: an asset
|
||||||
|
# already present with its pinned hash is left alone.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# The sha256 of each installed asset lives in static/vendor.sha256, in
|
||||||
|
# sha256sum(1) format, with paths relative to static/. That file is the
|
||||||
|
# single source of truth: this script verifies against it, and
|
||||||
|
# static/vendor_test.go asserts the bytes embedded into the binary match
|
||||||
|
# it, so the hash cannot rot into a value nothing checks.
|
||||||
|
MANIFEST="static/vendor.sha256"
|
||||||
|
|
||||||
|
# Alpine.js 3.14.9, 2026-08-17. Fetched from registry.npmjs.org, the
|
||||||
|
# publisher of record; the jsDelivr and unpkg copies are mirrors of this
|
||||||
|
# same tarball. dist/cdn.min.js is the browser build Alpine publishes for
|
||||||
|
# a <script> tag.
|
||||||
|
ALPINE_VERSION="3.14.9"
|
||||||
|
ALPINE_URL="https://registry.npmjs.org/alpinejs/-/alpinejs-${ALPINE_VERSION}.tgz"
|
||||||
|
# sha256 of alpinejs-3.14.9.tgz
|
||||||
|
ALPINE_TARBALL_SHA256="97dad7c0c81e659cfc8e7700055da9770f8186187cb9a8a76efb57e00d5ce52a"
|
||||||
|
ALPINE_MEMBER="package/dist/cdn.min.js"
|
||||||
|
ALPINE_DEST="js/alpine.min.js"
|
||||||
|
|
||||||
|
sha256_of() {
|
||||||
|
if command -v sha256sum >/dev/null 2>&1; then
|
||||||
|
sha256sum "$1" | cut -d' ' -f1
|
||||||
|
else
|
||||||
|
shasum -a 256 "$1" | cut -d' ' -f1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# expected_sha256 <path-relative-to-static>
|
||||||
|
expected_sha256() {
|
||||||
|
awk -v want="$1" '$2 == want { print $1; found = 1 }
|
||||||
|
END { if (!found) exit 1 }' "$ROOT/$MANIFEST"
|
||||||
|
}
|
||||||
|
|
||||||
|
# verify <file> <expected-sha256> <what>
|
||||||
|
verify() {
|
||||||
|
actual="$(sha256_of "$1")"
|
||||||
|
if [ "$actual" != "$2" ]; then
|
||||||
|
echo "fetch-assets: sha256 mismatch for $3" >&2
|
||||||
|
echo " expected: $2" >&2
|
||||||
|
echo " actual: $actual" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# up_to_date <path-relative-to-static> <expected-sha256>
|
||||||
|
up_to_date() {
|
||||||
|
[ -f "$ROOT/static/$1" ] || return 1
|
||||||
|
[ "$(sha256_of "$ROOT/static/$1")" = "$2" ]
|
||||||
|
}
|
||||||
|
|
||||||
|
fetch_alpine() {
|
||||||
|
want="$(expected_sha256 "$ALPINE_DEST")"
|
||||||
|
|
||||||
|
if up_to_date "$ALPINE_DEST" "$want"; then
|
||||||
|
echo "fetch-assets: static/$ALPINE_DEST already at $want"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "fetch-assets: fetching Alpine.js $ALPINE_VERSION from $ALPINE_URL"
|
||||||
|
tmp="$(mktemp -d)"
|
||||||
|
trap 'rm -rf "$tmp"' EXIT INT TERM
|
||||||
|
curl -fsSL -o "$tmp/alpine.tgz" "$ALPINE_URL"
|
||||||
|
verify "$tmp/alpine.tgz" "$ALPINE_TARBALL_SHA256" "alpinejs-${ALPINE_VERSION}.tgz"
|
||||||
|
tar -xzOf "$tmp/alpine.tgz" "$ALPINE_MEMBER" >"$tmp/alpine.min.js"
|
||||||
|
verify "$tmp/alpine.min.js" "$want" "$ALPINE_MEMBER from alpinejs-${ALPINE_VERSION}.tgz"
|
||||||
|
|
||||||
|
mkdir -p "$(dirname "$ROOT/static/$ALPINE_DEST")"
|
||||||
|
cp "$tmp/alpine.min.js" "$ROOT/static/$ALPINE_DEST"
|
||||||
|
rm -rf "$tmp"
|
||||||
|
trap - EXIT INT TERM
|
||||||
|
echo "fetch-assets: installed static/$ALPINE_DEST ($want)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Re-check every manifest entry against what is now on disk, so an entry
|
||||||
|
# no script installs fails loudly instead of passing silently.
|
||||||
|
verify_manifest() {
|
||||||
|
while read -r want path; do
|
||||||
|
case "$want" in '' | '#'*) continue ;; esac
|
||||||
|
if [ ! -f "$ROOT/static/$path" ]; then
|
||||||
|
echo "fetch-assets: $MANIFEST lists static/$path, which is missing" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
verify "$ROOT/static/$path" "$want" "static/$path"
|
||||||
|
done <"$ROOT/$MANIFEST"
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
fetch_alpine
|
||||||
|
verify_manifest
|
||||||
|
echo "fetch-assets: all assets in $MANIFEST verified"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
5
static/js/alpine.min.js
vendored
5
static/js/alpine.min.js
vendored
File diff suppressed because one or more lines are too long
@@ -1,2 +1,59 @@
|
|||||||
// Webhooker client-side JavaScript
|
// Webhooker client-side JavaScript
|
||||||
console.log("Webhooker loaded");
|
|
||||||
|
// Copy-to-clipboard, as progressive enhancement.
|
||||||
|
//
|
||||||
|
// Markup renders each copy button with the `hidden` attribute and a
|
||||||
|
// `data-copy-target` pointing at the id of the element holding the
|
||||||
|
// text. This script reveals a button only once it has both a resolvable
|
||||||
|
// target and a usable Clipboard API, so a browser without either shows
|
||||||
|
// no button at all and the text stays selectable.
|
||||||
|
(function () {
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const revertDelayMs = 2000;
|
||||||
|
|
||||||
|
function flash(button, message) {
|
||||||
|
const original = button.getAttribute("data-copy-label");
|
||||||
|
button.textContent = message;
|
||||||
|
window.setTimeout(function () {
|
||||||
|
button.textContent = original;
|
||||||
|
}, revertDelayMs);
|
||||||
|
}
|
||||||
|
|
||||||
|
function wire(button) {
|
||||||
|
const target = document.getElementById(
|
||||||
|
button.getAttribute("data-copy-target")
|
||||||
|
);
|
||||||
|
if (!target) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
button.setAttribute("data-copy-label", button.textContent);
|
||||||
|
button.addEventListener("click", function () {
|
||||||
|
navigator.clipboard.writeText(target.textContent.trim()).then(
|
||||||
|
function () {
|
||||||
|
flash(button, "Copied");
|
||||||
|
},
|
||||||
|
function () {
|
||||||
|
flash(button, "Copy failed");
|
||||||
|
}
|
||||||
|
);
|
||||||
|
});
|
||||||
|
button.removeAttribute("hidden");
|
||||||
|
}
|
||||||
|
|
||||||
|
function init() {
|
||||||
|
if (!navigator.clipboard || !navigator.clipboard.writeText) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const buttons = document.querySelectorAll("[data-copy-target]");
|
||||||
|
buttons.forEach(wire);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === "loading") {
|
||||||
|
document.addEventListener("DOMContentLoaded", init);
|
||||||
|
} else {
|
||||||
|
init();
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|||||||
1
static/vendor.sha256
Normal file
1
static/vendor.sha256
Normal file
@@ -0,0 +1 @@
|
|||||||
|
3ed1eed252488921df65e363d6715deb04d7f92aaedb9e52199fdf73cb1e0ad3 js/alpine.min.js
|
||||||
92
static/vendor_test.go
Normal file
92
static/vendor_test.go
Normal file
@@ -0,0 +1,92 @@
|
|||||||
|
package static_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"sneak.berlin/go/webhooker/static"
|
||||||
|
)
|
||||||
|
|
||||||
|
const manifestPath = "vendor.sha256"
|
||||||
|
|
||||||
|
// fetchHint is appended to every failure here: the assets the manifest
|
||||||
|
// covers are fetched by the build, not committed, so a fresh clone that
|
||||||
|
// has not run script/fetch-assets fails this test and should be told why.
|
||||||
|
const fetchHint = "run `script/fetch-assets` (or `make assets`) to install " +
|
||||||
|
"the pinned third-party assets"
|
||||||
|
|
||||||
|
// TestVendoredAssetsMatchManifest asserts that every asset listed in
|
||||||
|
// static/vendor.sha256 is embedded in the binary with exactly the pinned
|
||||||
|
// bytes. script/fetch-assets verifies the same hashes at download time;
|
||||||
|
// this test verifies them again on what actually ships, so a build that
|
||||||
|
// skipped, cached, or subverted the fetch cannot produce a binary serving
|
||||||
|
// unpinned third-party JavaScript.
|
||||||
|
func TestVendoredAssetsMatchManifest(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
entries := readManifest(t)
|
||||||
|
require.NotEmpty(t, entries, "%s lists no assets", manifestPath)
|
||||||
|
|
||||||
|
for path, want := range entries {
|
||||||
|
t.Run(path, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
data, err := static.Static.ReadFile(path)
|
||||||
|
require.NoErrorf(
|
||||||
|
t, err,
|
||||||
|
"%s is listed in %s but is not embedded; %s",
|
||||||
|
path, manifestPath, fetchHint,
|
||||||
|
)
|
||||||
|
|
||||||
|
sum := sha256.Sum256(data)
|
||||||
|
got := hex.EncodeToString(sum[:])
|
||||||
|
require.Equalf(
|
||||||
|
t, want, got,
|
||||||
|
"embedded %s does not match its pinned sha256 in %s; %s",
|
||||||
|
path, manifestPath, fetchHint,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// readManifest parses static/vendor.sha256, which is in sha256sum(1)
|
||||||
|
// format with paths relative to static/.
|
||||||
|
func readManifest(t *testing.T) map[string]string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
f, err := os.Open(manifestPath)
|
||||||
|
require.NoError(t, err, "opening %s", manifestPath)
|
||||||
|
|
||||||
|
defer func() { require.NoError(t, f.Close()) }()
|
||||||
|
|
||||||
|
entries := make(map[string]string)
|
||||||
|
scanner := bufio.NewScanner(f)
|
||||||
|
|
||||||
|
for scanner.Scan() {
|
||||||
|
line := strings.TrimSpace(scanner.Text())
|
||||||
|
if line == "" || strings.HasPrefix(line, "#") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
fields := strings.Fields(line)
|
||||||
|
require.Lenf(
|
||||||
|
t, fields, 2,
|
||||||
|
"%s: malformed entry %q, want \"<sha256> <path>\"",
|
||||||
|
manifestPath, line,
|
||||||
|
)
|
||||||
|
|
||||||
|
sum, path := fields[0], fields[1]
|
||||||
|
require.Lenf(t, sum, 64, "%s: %q is not a sha256", manifestPath, sum)
|
||||||
|
entries[path] = sum
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, scanner.Err(), "reading %s", manifestPath)
|
||||||
|
|
||||||
|
return entries
|
||||||
|
}
|
||||||
@@ -16,7 +16,7 @@
|
|||||||
<!-- Desktop navigation -->
|
<!-- Desktop navigation -->
|
||||||
<div class="hidden md:flex items-center gap-4">
|
<div class="hidden md:flex items-center gap-4">
|
||||||
{{if .User}}
|
{{if .User}}
|
||||||
<a href="/sources" class="btn-text">Sources</a>
|
<a href="/sources" class="btn-text">Webhooks</a>
|
||||||
<a href="/user/{{.User.Username}}" class="btn-text">
|
<a href="/user/{{.User.Username}}" class="btn-text">
|
||||||
<svg class="w-5 h-5 mr-1" fill="currentColor" viewBox="0 0 16 16">
|
<svg class="w-5 h-5 mr-1" fill="currentColor" viewBox="0 0 16 16">
|
||||||
<path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/>
|
<path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/>
|
||||||
@@ -38,7 +38,7 @@
|
|||||||
<div x-show="open" x-cloak x-transition class="md:hidden mt-4 pt-4 border-t border-gray-200">
|
<div x-show="open" x-cloak x-transition class="md:hidden mt-4 pt-4 border-t border-gray-200">
|
||||||
<div class="flex flex-col gap-2">
|
<div class="flex flex-col gap-2">
|
||||||
{{if .User}}
|
{{if .User}}
|
||||||
<a href="/sources" class="btn-text w-full text-left">Sources</a>
|
<a href="/sources" class="btn-text w-full text-left">Webhooks</a>
|
||||||
<a href="/user/{{.User.Username}}" class="btn-text w-full text-left">Profile</a>
|
<a href="/user/{{.User.Username}}" class="btn-text w-full text-left">Profile</a>
|
||||||
<form method="POST" action="/pages/logout">
|
<form method="POST" action="/pages/logout">
|
||||||
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
||||||
|
|||||||
@@ -6,6 +6,18 @@
|
|||||||
<div class="max-w-4xl mx-auto px-6 py-12">
|
<div class="max-w-4xl mx-auto px-6 py-12">
|
||||||
<h1 class="text-2xl font-medium text-gray-900 mb-6">User Profile</h1>
|
<h1 class="text-2xl font-medium text-gray-900 mb-6">User Profile</h1>
|
||||||
|
|
||||||
|
{{if .SuccessMessage}}
|
||||||
|
<div class="alert-success">
|
||||||
|
<span>{{.SuccessMessage}}</span>
|
||||||
|
</div>
|
||||||
|
{{end}}
|
||||||
|
|
||||||
|
{{if .ErrorMessage}}
|
||||||
|
<div class="alert-error">
|
||||||
|
<span>{{.ErrorMessage}}</span>
|
||||||
|
</div>
|
||||||
|
{{end}}
|
||||||
|
|
||||||
<div class="card p-6">
|
<div class="card p-6">
|
||||||
<div class="flex items-center mb-6">
|
<div class="flex items-center mb-6">
|
||||||
<div class="mr-4">
|
<div class="mr-4">
|
||||||
@@ -22,7 +34,6 @@
|
|||||||
|
|
||||||
<hr class="border-gray-200 mb-6">
|
<hr class="border-gray-200 mb-6">
|
||||||
|
|
||||||
<div class="grid grid-cols-1 md:grid-cols-2 gap-8">
|
|
||||||
<div>
|
<div>
|
||||||
<h3 class="text-lg font-medium text-gray-900 mb-3">Account Information</h3>
|
<h3 class="text-lg font-medium text-gray-900 mb-3">Account Information</h3>
|
||||||
<dl class="space-y-3">
|
<dl class="space-y-3">
|
||||||
@@ -36,11 +47,50 @@
|
|||||||
</div>
|
</div>
|
||||||
</dl>
|
</dl>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
|
||||||
<h3 class="text-lg font-medium text-gray-900 mb-3">Settings</h3>
|
|
||||||
<p class="text-sm text-gray-500">Profile settings and preferences will be available here.</p>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="card p-6 mt-6">
|
||||||
|
<h3 class="text-lg font-medium text-gray-900 mb-3">Change Password</h3>
|
||||||
|
<form method="POST" action="/user/{{.User.Username}}/password" class="space-y-6">
|
||||||
|
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="current_password" class="label">Current Password</label>
|
||||||
|
<input
|
||||||
|
type="password"
|
||||||
|
id="current_password"
|
||||||
|
name="current_password"
|
||||||
|
required
|
||||||
|
autocomplete="current-password"
|
||||||
|
class="input"
|
||||||
|
>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="new_password" class="label">New Password</label>
|
||||||
|
<input
|
||||||
|
type="password"
|
||||||
|
id="new_password"
|
||||||
|
name="new_password"
|
||||||
|
required
|
||||||
|
autocomplete="new-password"
|
||||||
|
class="input"
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="confirm_password" class="label">Confirm New Password</label>
|
||||||
|
<input
|
||||||
|
type="password"
|
||||||
|
id="confirm_password"
|
||||||
|
name="confirm_password"
|
||||||
|
required
|
||||||
|
autocomplete="new-password"
|
||||||
|
class="input"
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type="submit" class="btn-primary">Change Password</button>
|
||||||
|
</form>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="mt-6">
|
<div class="mt-6">
|
||||||
|
|||||||
@@ -69,7 +69,12 @@
|
|||||||
</form>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<code class="text-xs text-gray-500 break-all block mt-1">{{$.BaseURL}}/webhook/{{.Path}}</code>
|
<div class="flex items-start gap-2 mt-1">
|
||||||
|
<code id="entrypoint-url-{{.ID}}" class="text-xs text-gray-500 break-all block flex-1">{{$.BaseURL}}/webhook/{{.Path}}</code>
|
||||||
|
<!-- Hidden until app.js reveals it; without the
|
||||||
|
script the URL above stays selectable. -->
|
||||||
|
<button type="button" hidden data-copy-target="entrypoint-url-{{.ID}}" class="text-xs text-gray-500 hover:text-primary-600">Copy</button>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{else}}
|
{{else}}
|
||||||
<div class="p-4 text-sm text-gray-500">No entrypoints configured.</div>
|
<div class="p-4 text-sm text-gray-500">No entrypoints configured.</div>
|
||||||
@@ -113,6 +118,10 @@
|
|||||||
<input type="url" name="url" placeholder="https://hooks.slack.com/services/..." :disabled="targetType !== 'slack'" class="input text-sm">
|
<input type="url" name="url" placeholder="https://hooks.slack.com/services/..." :disabled="targetType !== 'slack'" class="input text-sm">
|
||||||
<p class="text-xs text-gray-500 mt-1">Slack or Mattermost incoming webhook URL. Payloads are pretty-printed in code blocks.</p>
|
<p class="text-xs text-gray-500 mt-1">Slack or Mattermost incoming webhook URL. Payloads are pretty-printed in code blocks.</p>
|
||||||
</div>
|
</div>
|
||||||
|
<div x-show="targetType === 'database'">
|
||||||
|
<input type="text" name="expiry" placeholder="never" :disabled="targetType !== 'database'" class="input text-sm">
|
||||||
|
<p class="text-xs text-gray-500 mt-1">Archive expiry: "never" (default) keeps rows forever, or a duration like "720h" prunes older rows.</p>
|
||||||
|
</div>
|
||||||
<button type="submit" class="btn-primary text-sm">Add Target</button>
|
<button type="submit" class="btn-primary text-sm">Add Target</button>
|
||||||
</form>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
@@ -141,8 +150,11 @@
|
|||||||
</form>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{if .Config}}
|
{{range .Config}}
|
||||||
<code class="text-xs text-gray-500 break-all block mt-1">{{.Config}}</code>
|
<div class="text-xs text-gray-500 break-all mt-1">
|
||||||
|
<span class="font-medium text-gray-700">{{.Label}}:</span>
|
||||||
|
<span>{{.Value}}</span>
|
||||||
|
</div>
|
||||||
{{end}}
|
{{end}}
|
||||||
</div>
|
</div>
|
||||||
{{else}}
|
{{else}}
|
||||||
@@ -177,7 +189,7 @@
|
|||||||
|
|
||||||
<!-- Info -->
|
<!-- Info -->
|
||||||
<div class="mt-4 text-sm text-gray-400">
|
<div class="mt-4 text-sm text-gray-400">
|
||||||
<p>Retention: {{.Webhook.RetentionDays}} days · Created: {{.Webhook.CreatedAt.Format "2006-01-02 15:04:05 UTC"}}</p>
|
<p>Retention: {{.Webhook.RetentionLabel}} · Created: {{.Webhook.CreatedAt.Format "2006-01-02 15:04:05 UTC"}}</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{end}}
|
{{end}}
|
||||||
|
|||||||
@@ -28,7 +28,8 @@
|
|||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="retention_days" class="label">Retention (days)</label>
|
<label for="retention_days" class="label">Retention (days)</label>
|
||||||
<input type="number" id="retention_days" name="retention_days" value="{{.Webhook.RetentionDays}}" min="1" max="365" class="input">
|
<input type="number" id="retention_days" name="retention_days" value="{{.Webhook.RetentionDays}}" min="0" class="input">
|
||||||
|
<p class="text-xs text-gray-500 mt-1">Currently {{.Webhook.RetentionLabel}}.{{if .Webhook.RetainsForever}} No events are deleted while retention is set to forever.{{else}} A periodic cleanup permanently deletes events older than this, along with their delivery records.{{end}} Enter 0 to retain events forever; leave blank to keep the current setting.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="flex gap-3">
|
<div class="flex gap-3">
|
||||||
|
|||||||
@@ -37,6 +37,9 @@
|
|||||||
|
|
||||||
<div x-show="open" x-cloak class="mt-3 p-3 bg-gray-50 rounded-md">
|
<div x-show="open" x-cloak class="mt-3 p-3 bg-gray-50 rounded-md">
|
||||||
<pre class="text-xs text-gray-700 overflow-x-auto whitespace-pre-wrap break-all">{{.Body}}</pre>
|
<pre class="text-xs text-gray-700 overflow-x-auto whitespace-pre-wrap break-all">{{.Body}}</pre>
|
||||||
|
{{if .BodyTruncated}}
|
||||||
|
<p class="mt-2 text-xs text-gray-500">Body truncated for display: showing {{.BodyShownBytes}} of {{.BodyBytes}} bytes. The stored body is unchanged — <a href="/source/{{$.Webhook.ID}}/logs/{{.ID}}/body" class="text-primary-600 hover:text-primary-700 underline">download the full body</a>.</p>
|
||||||
|
{{end}}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{else}}
|
{{else}}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{{template "base" .}}
|
{{template "base" .}}
|
||||||
|
|
||||||
{{define "title"}}Sources - Webhooker{{end}}
|
{{define "title"}}Webhooks - Webhooker{{end}}
|
||||||
|
|
||||||
{{define "content"}}
|
{{define "content"}}
|
||||||
<div class="max-w-6xl mx-auto px-6 py-8">
|
<div class="max-w-6xl mx-auto px-6 py-8">
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
<p class="text-sm text-gray-500 mt-1">{{.Description}}</p>
|
<p class="text-sm text-gray-500 mt-1">{{.Description}}</p>
|
||||||
{{end}}
|
{{end}}
|
||||||
</div>
|
</div>
|
||||||
<span class="badge-info">{{.RetentionDays}}d retention</span>
|
<span class="badge-info">Retention: {{.RetentionLabel}}</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="flex gap-6 mt-4 text-sm text-gray-500">
|
<div class="flex gap-6 mt-4 text-sm text-gray-500">
|
||||||
<span>{{.EntrypointCount}} entrypoint{{if ne .EntrypointCount 1}}s{{end}}</span>
|
<span>{{.EntrypointCount}} entrypoint{{if ne .EntrypointCount 1}}s{{end}}</span>
|
||||||
|
|||||||
@@ -18,18 +18,18 @@
|
|||||||
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="name" class="label">Name</label>
|
<label for="name" class="label">Name</label>
|
||||||
<input type="text" id="name" name="name" required autofocus placeholder="My Webhook" class="input">
|
<input type="text" id="name" name="name" value="{{.Name}}" required autofocus placeholder="My Webhook" class="input">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="description" class="label">Description</label>
|
<label for="description" class="label">Description</label>
|
||||||
<textarea id="description" name="description" rows="3" placeholder="Optional description" class="input"></textarea>
|
<textarea id="description" name="description" rows="3" placeholder="Optional description" class="input">{{.Description}}</textarea>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="retention_days" class="label">Retention (days)</label>
|
<label for="retention_days" class="label">Retention (days)</label>
|
||||||
<input type="number" id="retention_days" name="retention_days" value="30" min="1" max="365" class="input">
|
<input type="number" id="retention_days" name="retention_days" value="{{.DefaultRetentionDays}}" min="0" class="input">
|
||||||
<p class="text-xs text-gray-500 mt-1">How long to keep event data.</p>
|
<p class="text-xs text-gray-500 mt-1">A periodic cleanup permanently deletes events older than this, along with their delivery records. Enter 0 to retain events forever; leave blank to use the default of {{.DefaultRetentionDays}} days.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="flex gap-3">
|
<div class="flex gap-3">
|
||||||
|
|||||||
Reference in New Issue
Block a user