sneak/webhooker
1
0
Fork 0
Code Issues 13 Pull Requests 1 Actions 6 Packages Projects Releases Wiki Activity

Compare commits

base: sneak/webhooker:16ad6b568091849d5b448c3828215281d4adf452
Branches Tags
sneak/webhooker:main sneak/webhooker:next sneak/webhooker:prod sneak/webhooker:issue-70-log-target
...
compare: sneak/webhooker:next
Branches Tags
sneak/webhooker:next sneak/webhooker:main sneak/webhooker:prod sneak/webhooker:issue-70-log-target
12 Commits
16ad6b5680 ... next
Author SHA1 Message Date
clawbot a9d77e20d7 Make the load-sensitive tests wait for what they check (closes #507)
check / check (push) Waiting to run
Details 
Three tests failed at random on a busy host. The browser test now waits for each page a click opens to load, and for Alpine.js to start on it, before reading it. The delivery tests' drain takes what is already queued instead of racing a 25 ms timer, since both dispatch paths queue before they return. The test phase keeps the tests' temporary directories on a tmpfs, because SQLite waiting for the disk made `internal/handlers` slow under load; the timeout and the parallel cap are unchanged.

Deviation: the delivery tests do not wait with a deadline; dispatch has finished when they read.
Unverified: `internal/handlers` at a host load of 260 to 290.

Model: opus-5-5
 2026-10-06 08:51:35 +02:00
clawbot faf3da9a75 Refresh the package lists before installing in script/bootstrap (closes #508)
check / check (push) Waiting to run
Details 
The CI runner's image starts with empty package lists, so `script/bootstrap`, which `script/cibuild` now runs first, failed to install Go and every CI run stopped there. The apt branch of `pkg_install` now runs `apt-get update` once per run, before its first `apt-get install`, with the same code as the pending shared fix in sneak/prompts#116.

Deviation: `script/bootstrap` differs from the vendored copy until the next re-vendor.
Unverified: proven by running the CI job in the runner's image; the branch's own CI run waits for the runner outage to clear.

Model: opus-5-5
 2026-10-06 07:21:30 +02:00
clawbot fa6a9ed4dc Re-vendor the shared files from sneak/prompts at dd4027b (closes #504)
check / check (push) Waiting to run
Details 
The shared workflow, lint config, prettier settings and policies are the copies at `sneak/prompts` commit `dd4027b`. `.gitignore`, `.editorconfig` and `.dockerignore` are the shared copy followed by this repository's own entries. Linting is the image build's lint phase on golangci-lint v2.14.0, and tests run in their own test phase. Every scripted `docker build` passes `--no-cache`, so the CI fingerprint step and the superseded-run script are gone. The binary is built with `-trimpath -s -w`, and a build that has `.git` but no version fails. The development run keeps its databases outside the checkout.

Deviation: `.dockerignore` also leaves out SQLite databases at any depth.

Model: opus-5-5
 2026-10-06 06:05:42 +02:00
clawbot 46fe7baed0 Mask a target URL's query string when the URL has no path (closes #500)
check / check (push) Successful in 5m57s
Details 
`urlSecrets` treated a target URL's request URI as a secret only when the URL had a path, so for a target URL such as `https://example.com/?token=…` a response echoing the request line showed the token in the event log and on the event's page. It now also treats the query string, and the request URI that carries it, as secrets whenever the URL has one, whatever its path. With "Pass the query string on to this target" on, only the target's own part is masked, not the event's. A URL with a path is masked as before. As for paths and userinfo, no length floor applies.

Model: opus-5-5
 2026-10-04 03:31:37 +02:00
clawbot ea8cba7264 Store and show an event's query string, and pass it on to an HTTP target when set (closes #312)
check / check (push) Successful in 4m45s
Details 
The receiver dropped the query string of every request it received, so a sender's URL parameters were silently lost. Each event now keeps it, as sent, in a new `raw_query` column of the per-webhook `events` table; a resubmitted copy carries its original's. The event log and the event's page show it in the shared request block, the event log leaving out one over 32 KiB with a link, as for headers. The archive and log targets carry it. HTTP targets gain "Pass the query string on to this target", off by default: on, deliveries, replays and resubmits append it to the target URL, joined with `&` to one already there. The access log still hides it.

Model: opus-5-5
 2026-10-04 03:00:34 +02:00
clawbot a8fc0c5d32 Merge main into next after 416 (closes #497)
check / check (push) Successful in 4m34s
Details 
#416 put a `main`-only version of fixes `next` already had onto `main`, so `next` no longer merged into `main`: `script/test` conflicted. This merge makes `main` an ancestor of `next` and keeps `next`'s files throughout, which already hold everything 416 changed, so `next`'s tree is unchanged.

Model: opus-5-5
 2026-10-03 14:29:50 +02:00
clawbot 7963188c1e Merge main into next after 416 (closes #497)
check / check (push) Successful in 6m8s
Details 
Makes main an ancestor of next, so the milestone PR merges again.
script/test conflicted and keeps next's version, which already runs
without -v, caps memory with -p 4 -parallel 8, adds coverage and reruns
failed tests with -v. password.go, password_test.go, export_test.go and
resetpw_test.go merged on their own: main's lines there are the same
as next's. The merged tree equals next's.

Model: opus-5-5
 2026-10-03 12:17:30 +00:00
clawbotandsneak 16ed356b68 main side of 414: cheaper test hashing, and failing tests visible in the build log (closes #414) (#416)
check / check (push) Successful in 3m21s
Details 
The `main` side of #414: the two changes that make `next` green, and nothing else from `next`. Each is its own commit, so it can be compared with its `next` counterpart.

- #404, as merged to `next`: a test binary hashes passwords at a 1 MB Argon2id cost instead of 64 MB, `TestHashPassword_ShippedParameters` keeps the shipped cost covered, and `script/test` runs at most four packages and eight parallel tests at once. Every test that starts a database hashed the admin password at 64 MB, which on a busy host made `internal/handlers` overrun its application start and its 90-second timeout. That is what turned `main` red.
- #415: `script/test` runs without `-v`, so the build log, which the Docker build cuts off at 2 MiB, carries one result line per package and, for a package that fails, everything its tests wrote, application log lines included, instead of only passing packages.

What the diff does not show: `script/test` differs from `next` by one line. `main` has no `script/assets` yet, so it is not called. Several packages failing at once can still reach the 2 MiB limit.

- Judgement call: both commits keep their subjects from `next`, including their `closes` references.
- Deviation and not fixed here: the same two as on #415 (no `-v` rerun on failure, #315; remaining sensitivity to extreme CPU load, #225).

Model: opus-5-5
Co-authored-by: sneak <sneak@sneak.berlin>
Reviewed-on: #416
Co-authored-by: clawbot <35+clawbot@noreply.example.org>
 2026-10-03 14:08:51 +02:00
clawbot fe5e0d4173 Install ESLint and prettier with yarn 4 through corepack (closes #493)
check / check (push) Successful in 3m48s
Details 
The `js-deps` stage installed ESLint and prettier with yarn 1, which is no longer developed and made node print a `url.parse()` deprecation warning on every install. `package.json` now pins yarn 4 by version and hash in its `packageManager` field; the stage enables it through the node image's own corepack and installs with `yarn install --immutable`. `yarn.lock` is regenerated in yarn 4's format with every package at its previously locked version, and `.yarnrc.yml` keeps the install in `node_modules/`, where the lint and Markdown stages run the tools from. The install prints no warning and stays cached until the manifests change.

Model: opus-5-5
 2026-10-03 07:03:31 +02:00
clawbot 9ccaa8ce01 Break long values on the webhook page and event log at phone width (closes #391)
check / check (push) Successful in 3m17s
Details 
At phone width, the event log cut off long event IDs and content types along with the statuses and times after them, and the webhook page ran long names past their cards and scrolled sideways. Elements that hold only a long value (a webhook, target or entrypoint name or description, an event ID, a content type) now break inside it, and the event log's title row wraps; rows themselves still wrap rather than squeeze. Wide screens are unchanged. A 390-pixel browser check of both pages, an event's attempts open, fails when anything runs past the page's or a card's edge or the page scrolls sideways.

Model: opus-5-5
 2026-10-03 06:56:43 +02:00
clawbot 935e18c6f1 Format the Markdown with prettier in make fmt and make fmt-check (closes #215)
check / check (push) Successful in 3m28s
Details 
`make fmt` formatted only Go, so the org's Markdown settings were unenforced and Markdown was wrapped by hand. prettier, pinned in `package.json` and `yarn.lock` beside ESLint, now formats the Markdown with `.prettierrc` (4-space tabs, `proseWrap: always`). It runs only in Docker: `make fmt` writes the formatted files back without a bind mount, and `make fmt-check`, `make check` and the image build fail on unformatted Markdown. The image build's lint stage now runs the Go format check directly and no longer installs `make`. `README.md` and `TODO.md` are reformatted with no word changed: the README reflows from 72 to 80 columns.

Model: opus-5-5
 2026-10-03 06:32:27 +02:00
sneak f703b72ce0 Next (#364)
check / check (push) Successful in 3m59s
Details 
Reviewed-on: #364
 2026-09-29 13:05:57 +02:00
73 changed files with 4696 additions and 4536 deletions
Expand all files Collapse all files
.dockerignore
+83 -29
View File
@@ -1,30 +1,84 @@
# .git is sent so the build can derive the version it stamps into the binary # .dockerignore does NOT use .gitignore semantics. Docker matches with
# (script/version). Its config, which can hold a remote URL carrying a # moby/patternmatcher: filepath.Match plus `**`, so `*` does not cross
# credential and which `git describe` does not need, is left out of a # `/` and an unprefixed pattern is anchored at the context root. Every
# directory context. A context sent as a tar is not filtered by this file, so # depth-independent pattern therefore needs `**/`, or `config/.env` and
# it carries .git/config unless its sender leaves it out. # `certs/server.key` still ship while this file reads as solved. Only
.git/config # genuinely root-anchored entries go unprefixed. Never transplant these
# into .gitignore, where `**/` is wrong.
# No tracked file may be listed here: git in the build would see it as
# deleted and mark the version -dirty.
# #
# .ci-fingerprint is deliberately NOT excluded: it is the CI cache barrier # Matching is case-sensitive, so secrets use character ranges rather
# that keeps the check stages from replaying a cached pass. See the lint # than an ALL-CAPS twin, which would still miss `Server.Key`.
# stage of the Dockerfile. #
bin/ # Extend with this repo's own host-built artifacts, written anchored:
# Extracted from 3p/ by `make assets` inside the build; a host copy is not # `/myapp`, never `**/myapp`, which also matches `cmd/myapp/` and
# needed. The tarball in 3p/ must stay in the context. # deletes the package directory from the context.
static/js/alpine.min.js
# The js-deps stage installs ESLint; a host copy would overwrite it at the # .git is sent without its config. Without a VERSION build argument the
# js-lint stage's `COPY . .`. # stage that compiles runs `git describe --tags --always` on .git, which
node_modules/ # does not need .git/config; that file can hold a credential, such as a
.env # password in a remote URL or the token the CI checkout step stores there.
.env.* # Each submodule keeps a config with the same exposure in its git directory
*.db # under .git/modules/, nested again for a submodule's own submodules, or in
*.sqlite # its own .git directory when it keeps one.
*.sqlite3 # KNOWN GAP: a submodule whose name has a `config` segment (`config`,
.DS_Store # `deploy/config`, `config/lib`) loses its whole git directory, because
.idea/ # `**/.git/modules/**/config` also matches that segment's directory
.vscode/ # under .git/modules/. Go's version stamping then fails the build;
tmp/ # nothing leaks. Name such a submodule without that segment:
temp/ # `git submodule add --name`.
**/.git/config
**/.git/modules/**/config
# Agent scratch: one full checkout of the repo per in-flight agent.
# Anchored because it occurs once where agents run at the repo root.
# KNOWN GAP: a repo running agents in subdirectories still ships
# `services/api/.claude/` and must add its own anchored entry.
.claude
# Environment files. `*.env` covers bare `.env` and the `prod.env`
# convention. Re-include a committed template with a negation if the
# build needs one: `!docs/example.env`.
**/*.[eE][nN][vV]
**/.[eE][nN][vV].*
**/.[eE][nN][vV][rR][cC]
# Private keys and the bundles carrying them. Public certificates
# (*.crt, *.cer) are deliberately absent: they are legitimate inputs.
**/*.[pP][eE][mM]
**/*.[kK][eE][yY]
**/*.[pP]12
**/*.[pP][fF][xX]
**/[iI][dD]_[rR][sS][aA]
**/[iI][dD]_[dD][sS][aA]
**/[iI][dD]_[eE][cC][dD][sS][aA]
**/[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
**/[iI][dD]_[eE][dD]25519
**/[iI][dD]_[eE][dD]25519_[sS][kK]
# Dependencies: restored inside the image, never copied in.
**/node_modules
# OS metadata.
**/.DS_Store
**/Thumbs.db
# Editor state: never a build input, and it churns COPY.
**/*.swp
**/*.swo
**/*~
**/*.bak
**/.idea
**/.vscode
**/*.sublime-*
# This repository's own host-built artifacts: the binary `make build`
# writes, and the Alpine.js file `make assets` extracts from 3p/ (the
# build extracts its own).
/bin
/static/js/alpine.min.js
# SQLite databases, which hold the session key and webhook payloads, at
# any depth.
**/*.db
**/*.sqlite
**/*.sqlite3
.editorconfig
+3
View File
@@ -10,3 +10,6 @@ insert_final_newline = true
[Makefile] [Makefile]
indent_style = tab indent_style = tab
[*.go]
indent_style = tab
.gitea/workflows/check.yml
+7 -35
View File
@@ -1,37 +1,9 @@
name: check name: check
on: [push]
on:
push:
branches:
- '**'
jobs: jobs:
check: check:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout # actions/checkout v4.2.2, 2026-02-22
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 2024-10-23 - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
with: - run: script/cibuild
# The superseded-status step needs history to walk ancestors (it
# aborts on a shallow clone).
fetch-depth: 0
- name: Mark 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 as a test result. The script rewrites
# those statuses to say what happened. See its header for why the
# state stays `failure` and not `skipped`.
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: script/ci-mark-superseded
- name: Fingerprint the build context
# Writes the hash of the commit being checked into the context, which
# invalidates the `COPY . .` layer of every check stage: a commit
# that was never linted, format-checked, stylesheet-checked, tested
# and built cannot report success from cache.
run: git rev-parse HEAD > .ci-fingerprint
- name: Build Docker image (runs make fmt-check, golangci-lint, the stylesheet check, ESLint, make test, make build)
run: script/cibuild
.gitignore
+50 -21
View File
@@ -1,3 +1,53 @@
# OS
.DS_Store
Thumbs.db
# Editors
*.swp
*.swo
*~
*.bak
.idea/
.vscode/
*.sublime-*
# Agent scratch (worktrees of this repo, created and destroyed by
# in-flight tooling). Unanchored: .gitignore patterns already match at
# every depth, so no prefix is wanted here. This is not a .dockerignore
# entry and must not be given a `**/` prefix on the way into one.
.claude/
# Node
node_modules/
# Secrets. Unanchored like every entry above, so each matches at every
# depth. Matching is case-sensitive on Linux, so names use character
# ranges rather than a lowercase form that misses `Server.Key`.
# Environment files. `*.env` covers bare `.env` and the `prod.env`
# convention. Only the templates `example.env` and `sample.env` are
# re-included below. A repository that commits any other template adds
# its own negation after these lines, for example `!.env.example`.
*.[eE][nN][vV]
.[eE][nN][vV].*
.[eE][nN][vV][rR][cC]
!example.env
!sample.env
# Private keys and the bundles carrying them.
*.[pP][eE][mM]
*.[kK][eE][yY]
*.[pP]12
*.[pP][fF][xX]
[iI][dD]_[rR][sS][aA]
[iI][dD]_[dD][sS][aA]
[iI][dD]_[eE][cC][dD][sS][aA]
[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
[iI][dD]_[eE][dD]25519
[iI][dD]_[eE][dD]25519_[sS][kK]
# This repository's own entries, after the shared content above.
# Binaries # Binaries
*.exe *.exe
*.dll *.dll
@@ -15,24 +65,6 @@ bin/
# Go vendor directory # Go vendor directory
vendor/ vendor/
# ESLint and its dependencies, installed from yarn.lock
node_modules/
# IDE specific files
.idea/
*.swp
*.swo
*~
.vscode/
# OS specific files
.DS_Store
Thumbs.db
# Environment and config files
.env
.env.local
# Data directory (SQLite databases) # Data directory (SQLite databases)
data/ data/
*.db *.db
@@ -46,9 +78,6 @@ data/
tmp/ tmp/
temp/ temp/
# CI cache barrier, written into the build context by the check workflow
.ci-fingerprint
# Alpine.js, extracted by `make assets` from its tarball in 3p/, which is # Alpine.js, extracted by `make assets` from its tarball in 3p/, which is
# what is committed. # what is committed.
/static/js/alpine.min.js /static/js/alpine.min.js
.golangci.yml
+67 -2
View File
@@ -10,14 +10,21 @@ run:
linters: linters:
default: all default: all
enable:
# Successor to the deprecated gomodguard. Named explicitly, rather than
# left to `default: all`, because it carries the module policy below.
- gomodguard_v2
disable: disable:
# Genuinely incompatible with project patterns # Genuinely incompatible with project patterns
- exhaustruct # Requires all struct fields - exhaustruct # Requires all struct fields
- depguard # Dependency allow/block lists - exhaustruct_v5 # Requires all struct fields (successor to exhaustruct)
- godot # Requires comments to end with periods - godot # Requires comments to end with periods
- 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
# Deprecated: the warning is attached to the old name, so it is
# silenced by disabling that name, not by enabling the successor.
- wsl # Deprecated, replaced by wsl_v5
- gomodguard # Deprecated, replaced by gomodguard_v2
settings: settings:
lll: lll:
line-length: 88 line-length: 88
@@ -28,6 +35,64 @@ linters:
max-complexity: 15 max-complexity: 15
dupl: dupl:
threshold: 100 threshold: 100
depguard:
# Test-support code must not be compiled into the shipped binary. A
# test-support package exists to hand a test privileges the program
# itself must never have, so a file that is not a test must not import
# one. Test files, and the files inside a package whose directory name
# ends in `test`, are where that code belongs, and are exempt.
#
# The deny list below is the one part of this file a repository is
# expected to extend, and the only part it may. depguard matches an
# import path against a list of prefixes, so it cannot be told "any path
# whose last segment ends in test"; a repository's own test-support
# packages have to be named here one at a time, by full import path,
# under a module path that differs from repository to repository. Add
# them; change nothing else.
rules:
test-support:
list-mode: lax
files:
- "$all"
- "!$test"
- "!**/*test/**"
deny:
- pkg: net/http/httptest
desc: >-
Test-support code belongs in test files and in packages whose
directory name ends in test, not in the shipped binary.
# Only decisions already recorded in the Go package defaults are
# listed here. Every entry matches the module path exactly.
gomodguard_v2:
blocked:
- module: github.com/rs/zerolog
recommendations:
- log/slog
reason: "Structured logging is stdlib log/slog."
# One entry per pre-fork module path, because the later releases
# are separate paths. A prefix match would be shorter but would
# also reach github.com/go-redis/redismock, the test double for
# the successor these entries recommend.
- module: github.com/go-redis/redis
recommendations:
- github.com/redis/go-redis/v9
reason: "Pre-fork module; use the maintained go-redis v9."
- module: github.com/go-redis/redis/v7
recommendations:
- github.com/redis/go-redis/v9
reason: "Pre-fork module; use the maintained go-redis v9."
- module: github.com/go-redis/redis/v8
recommendations:
- github.com/redis/go-redis/v9
reason: "Pre-fork module; use the maintained go-redis v9."
- module: github.com/sergi/go-diff
recommendations:
- github.com/aymanbagabas/go-udiff
reason: "No unified diff output; use go-udiff."
- module: github.com/hexops/gotextdiff
recommendations:
- github.com/aymanbagabas/go-udiff
reason: "Unmaintained fork; use go-udiff."
issues: issues:
max-issues-per-linter: 0 max-issues-per-linter: 0
.prettierignore
+2
View File
@@ -0,0 +1,2 @@
node_modules/
yarn.lock
.prettierrc
+4
View File
@@ -0,0 +1,4 @@
{
"tabWidth": 4,
"proseWrap": "always"
}
.yarnrc.yml
+3
View File
@@ -0,0 +1,3 @@
# Install into node_modules/: the Dockerfile's lint and Markdown stages run
# ESLint and prettier from node_modules/.bin.
nodeLinker: node-modules
Dockerfile
+141 -60
View File
@@ -1,34 +1,3 @@
# Lint stage
# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
# Using Debian-based image because mattn/go-sqlite3 (CGO) does not
# compile on Alpine musl (off64_t is a glibc type).
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/*
WORKDIR /src
# Copy go mod files first for better layer caching
COPY go.mod go.sum ./
RUN go mod download
# Copy source code. In CI the context also carries .ci-fingerprint, which
# holds the hash of the commit being checked (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 . .
# Run formatting check and linter. golangci-lint is invoked directly rather
# than through `make lint`: this stage is already the pinned linter image, and
# script/lint is a wrapper that builds Dockerfile.lint, so calling it here
# would need a docker daemon inside the build. Keep these steps in step with
# Dockerfile.lint, including --network=none (see its header for why).
RUN make fmt-check
RUN script/assets
RUN --network=none golangci-lint config verify --config .golangci.yml
RUN --network=none golangci-lint run --config .golangci.yml --build-tags browser ./...
# Stylesheet stages. static/css/tailwind.css is generated, by this pinned # Stylesheet stages. static/css/tailwind.css is generated, by this pinned
# tailwindcss, from static/css/input.css and the files its @source lines # tailwindcss, from static/css/input.css and the files its @source lines
# name. `make css` (script/css) writes it out from the css-output stage. # name. `make css` (script/css) writes it out from the css-output stage.
@@ -66,34 +35,150 @@ RUN sed 's/}/}\n/g' static/css/tailwind.css > /tmp/committed.css \
} }
# JavaScript lint stages: ESLint, at the version package.json and yarn.lock # JavaScript lint stages: ESLint, at the version package.json and yarn.lock
# pin, checks static/js/ against eslint.config.mjs. js-deps installs it and # pin, checks static/js/ against eslint.config.mjs. js-deps installs it, and
# stays cached until those two files change. script/lint forces only js-lint # prettier for the Markdown stages below. The lint phase below runs js-lint.
# to re-run, and the build stage below runs it too. COPY . . brings in the CI #
# cache barrier described in the lint stage above. # The image's own corepack runs the yarn that package.json's packageManager
# node:24.21.0-alpine (LTS, with yarn 1.22.22), 2026-09-18 # field names, yarn 4.18.1 (released 2026-09-24), and checks it against the
# hash there. The image also ships yarn 1, which `corepack enable yarn`
# replaces.
# node:24.21.0-alpine (LTS), 2026-09-18
FROM node:24.21.0-alpine@sha256:ebfe2f90462722a7a4de65e91990e97fe0d401c70e0e762c5b53302f905ec1c1 AS js-deps FROM node:24.21.0-alpine@sha256:ebfe2f90462722a7a4de65e91990e97fe0d401c70e0e762c5b53302f905ec1c1 AS js-deps
WORKDIR /src WORKDIR /src
COPY package.json yarn.lock ./ COPY package.json yarn.lock .yarnrc.yml ./
RUN yarn install --frozen-lockfile --ignore-scripts RUN corepack enable yarn && yarn install --immutable --mode=skip-build
FROM js-deps AS js-lint FROM js-deps AS js-lint
COPY . . COPY . .
RUN --network=none node_modules/.bin/eslint static/js RUN --network=none node_modules/.bin/eslint static/js
# Markdown stages: prettier, at the version package.json and yarn.lock pin,
# formats every Markdown file in the tree with the settings in .prettierrc.
# `make fmt` (script/fmt) writes the formatted files out from markdown-output.
# markdown-check fails on any file prettier would change; `make fmt-check`
# runs it, and so does the build stage below.
FROM js-deps AS markdown
COPY . .
RUN --network=none node_modules/.bin/prettier --write '**/*.md' \
&& mkdir /out \
&& find . -name '*.md' ! -path './node_modules/*' -exec cp -p --parents {} /out \;
FROM scratch AS markdown-output
COPY --from=markdown /out /
FROM js-deps AS markdown-check
COPY . .
RUN --network=none node_modules/.bin/prettier --check '**/*.md'
# Lint phase: the Go formatting check and golangci-lint over the Go code,
# and ESLint over static/js/ through the copy from js-lint at the end.
# `make lint` (script/lint) builds this stage alone; the build stage below
# depends on it.
#
# golangci/golangci-lint:v2.14.0 (Debian-based), 2026-09-24
# Using Debian-based image because mattn/go-sqlite3 (CGO) does not
# compile on Alpine musl (off64_t is a glibc type).
FROM golangci/golangci-lint:v2.14.0@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f AS lint
WORKDIR /src
# Copy go mod files first for better layer caching
COPY go.mod go.sum ./
RUN go mod download
COPY . .
# gofmt and golangci-lint are invoked directly rather than through `make
# fmt-check` and `make lint`, which are themselves docker builds and would
# need a docker daemon inside this one. The Markdown half of `make
# fmt-check` is the markdown-check stage above.
RUN if [ -n "$(gofmt -s -l .)" ]; then echo "gofmt needed on:"; gofmt -s -l .; exit 1; fi
# static/static.go embeds the Alpine.js file this extracts from 3p/; without
# it the static package does not compile and cannot be linted.
RUN script/assets
# The golangci-lint steps run with --network=none. `golangci-lint config
# verify` is documented as fetching its JSON schema over HTTPS; this pinned
# image resolves the schema without any network, and --network=none enforces
# that. It also proves no linter reaches out at analysis time.
#
# `run` silently ignores config keys it does not recognize, so a typo would
# disable a setting without a word. `config verify` is what catches that.
RUN --network=none golangci-lint config verify --config .golangci.yml
# --build-tags browser also lints the browser test, which is built only with
# that tag (make test-browser).
RUN --network=none golangci-lint run --config .golangci.yml --build-tags browser ./...
# Nothing is wanted from js-lint; the copy is what makes this phase run it.
COPY --from=js-lint /src/yarn.lock /dev/null
# Test phase. -race needs cgo and so a C compiler, which the Debian Go image
# ships and the alpine one does not. `make test` (script/test) builds this
# stage alone; the build stage below depends on it.
#
# golang:1.26.1-bookworm (Debian-based), 2026-03-17
FROM golang:1.26.1-bookworm@sha256:4465644228bc2857a954b092167e12aa59c006a3492282a6c820bf4755fd64a4 AS test
WORKDIR /src
COPY go.mod go.sum ./
RUN go mod download
COPY . .
# static/static.go embeds the Alpine.js file this extracts from 3p/.
RUN script/assets
# -timeout applies to each package on its own, so 90s has only to clear the
# slowest one. -p 4 -parallel 8 keep the run under 2 GB of memory: at most
# four test binaries build or run at once, each with at most eight parallel
# tests. Under -race every test binary and every link costs a few hundred MB,
# so the defaults (one per core) add up to several GB on a many-core host.
#
# The first run has no -v: go test then prints one result line per package,
# with its coverage, and for a package that fails, everything its tests
# wrote. Verbose output from the whole suite passes the 2 MiB at which the
# Docker build cuts off a step's log, so on a failure only the tests that
# failed run again, with -v. go test reports a failed test as a line starting
# "--- FAIL: TestName" (a failed subtest's line is indented, and reruns with
# its parent) and a failed package as "FAIL<tab>package/path<tab>...". A
# failure that names no test, such as a build error or a timeout, is already
# shown in full, so there is nothing to rerun. The step fails after the rerun
# whatever its result: the first run already showed the suite is broken.
#
# TMPDIR, where the tests keep their SQLite databases, is a tmpfs: SQLite
# waits for the disk at every commit, and on a busy host that waiting was
# about 40% of the slowest package's run time. GOTMPDIR keeps go's own
# build files, the test binaries among them, on disk.
#
# bash with pipefail, so that the first run's status is go test's, not tee's.
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
RUN --mount=type=tmpfs,target=/tmp/tests,size=512m \
export TMPDIR=/tmp/tests GOTMPDIR=/tmp; \
go test -race -cover -p 4 -parallel 8 -timeout 90s ./... 2>&1 | tee /tmp/go-test.log && exit 0; \
tests="$(awk '/^--- FAIL: / { print $3 }' /tmp/go-test.log | paste -s -d '|' -)"; \
packages="$(awk '/^FAIL\t/ { print $2 }' /tmp/go-test.log)"; \
if [ -n "$tests" ]; then \
echo "--- Rerunning the failed tests with -v for details ---"; \
go test -race -v -p 4 -parallel 8 -timeout 90s -run "^($tests)\$" $packages; \
fi; \
exit 1
# Build stage # Build stage
# golang:1.26.1-bookworm (Debian-based), 2026-03-17 # golang:1.26.1-bookworm (Debian-based), 2026-03-17
# Using Debian-based image because gorm.io/driver/sqlite pulls in # Using Debian-based image because gorm.io/driver/sqlite pulls in
# mattn/go-sqlite3 (CGO), which does not compile on Alpine musl. # mattn/go-sqlite3 (CGO), which does not compile on Alpine musl. The image
# ships git and make, which the version step below uses.
FROM golang:1.26.1-bookworm@sha256:4465644228bc2857a954b092167e12aa59c006a3492282a6c820bf4755fd64a4 AS builder FROM golang:1.26.1-bookworm@sha256:4465644228bc2857a954b092167e12aa59c006a3492282a6c820bf4755fd64a4 AS builder
# Depend on the lint, stylesheet check and JavaScript lint stages passing # Nothing is wanted from the lint and test phases or from the stylesheet and
# Markdown checks; the copies are what make BuildKit build them first, so
# this stage cannot run unless they all passed.
COPY --from=lint /src/go.sum /dev/null COPY --from=lint /src/go.sum /dev/null
COPY --from=test /src/go.sum /dev/null
COPY --from=css-check /out/tailwind.css /dev/null COPY --from=css-check /out/tailwind.css /dev/null
COPY --from=js-lint /src/yarn.lock /dev/null COPY --from=markdown-check /src/yarn.lock /dev/null
# jq is a runtime dependency of script/ci-mark-superseded, which the test
# suite executes. git is what script/version derives the version with.
RUN apt-get update && apt-get install -y --no-install-recommends make curl ca-certificates jq git && rm -rf /var/lib/apt/lists/*
# A build context sent as a tar archive keeps its files' owners, and git # A build context sent as a tar archive keeps its files' owners, and git
# refuses to read a checkout owned by another user. Trust this one # refuses to read a checkout owned by another user. Trust this one
@@ -106,31 +191,27 @@ WORKDIR /build
COPY go.mod go.sum ./ COPY go.mod go.sum ./
RUN go mod download RUN go mod download
# Copy source code, including the .ci-fingerprint cache barrier described in
# the lint stage above.
COPY . . COPY . .
# Run tests and build. Both first run script/assets, which extracts Alpine.js
# from its tarball in 3p/.
RUN make test
# Version stamped into the binary: the VERSION build arg when one is # Version stamped into the binary: the VERSION build arg when one is
# given, otherwise what script/version derives from the .git the build # given, otherwise what script/version derives from the .git the build
# context carries, so any `docker build .` of a clone stamps its commit. # context carries, so any `docker build .` of a clone stamps its commit.
# With neither, as from a source tarball, it is "unknown". # With neither, as from a source tarball, it is "unknown".
#
# Declared here, below the test step, so a changed version does not
# invalidate its cached layer.
ARG VERSION ARG VERSION
# A context that carries .git must not stamp "unknown": that means git is # A context that carries .git must not stamp an empty version, "dev" or
# missing here or could not read the checkout, and the image could not be # "unknown": that means git is missing here or could not read the
# traced back to its commit. # checkout, and the image could not be traced back to its commit.
RUN if [ -d .git ] && [ "$(make version VERSION="$VERSION")" = unknown ]; then \ RUN version="$(make version VERSION="$VERSION")"; \
echo "version is unknown although the build context carries .git" >&2; \ if [ -e .git ]; then \
exit 1; \ case "$version" in ""|dev|unknown) \
echo "version is '$version' although .git is present" >&2; \
exit 1 ;; \
esac; \
fi fi
# Builds through the Makefile's build target, which runs script/assets
# (Alpine.js, extracted from its tarball in 3p/) first.
RUN make build VERSION="$VERSION" RUN make build VERSION="$VERSION"
# Rebuild with static linking for Alpine runtime. # Rebuild with static linking for Alpine runtime.
Dockerfile.browser
+1 -1
View File
@@ -16,7 +16,7 @@ COPY . .
# The test binary embeds the templates and static files, so the browser # The test binary embeds the templates and static files, so the browser
# stage needs nothing else. -p 4 keeps the compile's memory down, as in # stage needs nothing else. -p 4 keeps the compile's memory down, as in
# script/test. # the test phase of Dockerfile.
RUN make assets && go test -c -p 4 -tags browser -o /browser.test ./internal/server RUN make assets && go test -c -p 4 -tags browser -o /browser.test ./internal/server
# chromedp/headless-shell:151.0.7922.109 (Debian trixie), 2026-08-11. The # chromedp/headless-shell:151.0.7922.109 (Debian trixie), 2026-08-11. The
Dockerfile.lint
-43
View File
@@ -1,43 +0,0 @@
# Lint-only image, built by script/lint. golangci-lint is never installed on
# the host: the repo is COPYed into the pinned image and linted as a build
# step, so a successful build IS a clean lint. This works even when the docker
# daemon is remote and bind mounts are impossible.
#
# script/lint passes --no-cache-filter=lint. Without it an unchanged tree
# replays the lint stage from cache and the build succeeds in under a second
# having run no linter at all. Do not drop that flag.
#
# The lint steps run with --network=none. `golangci-lint config verify` is
# documented as fetching its JSON schema over HTTPS, which would make linting
# depend on an unpinned remote artifact; this pinned image resolves the schema
# without any network, and --network=none enforces that rather than trusting
# it. It also proves no linter reaches out at analysis time. If a future image
# bump makes either step need the network, this build fails loudly instead of
# quietly acquiring an unpinned dependency.
# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
# Using Debian-based image because mattn/go-sqlite3 (CGO) does not
# compile on Alpine musl (off64_t is a glibc type).
FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS deps
WORKDIR /src
# Copy go mod files first for better layer caching. This stage is cacheable;
# only the lint stage below is forced to re-execute.
COPY go.mod go.sum ./
RUN go mod download
FROM deps AS lint
COPY . .
# static/static.go embeds the Alpine.js file this extracts from 3p/; without
# it the static package does not compile and cannot be linted.
RUN script/assets
# `run` silently ignores config keys it does not recognize, so a typo would
# disable a setting without a word. `config verify` is what catches that.
RUN --network=none golangci-lint config verify --config .golangci.yml
# --build-tags browser also lints the browser test, which is built only with
# that tag (make test-browser).
RUN --network=none golangci-lint run --config .golangci.yml --build-tags browser ./...
Makefile
+5 -1
View File
@@ -19,6 +19,10 @@ override VERSION := $(or $(strip $(VERSION)),$(shell script/version))
# Extra linker flags for the build target. The static relink in the # Extra linker flags for the build target. The static relink in the
# Dockerfile adds -extldflags here rather than passing its own -ldflags, # Dockerfile adds -extldflags here rather than passing its own -ldflags,
# so composing flags cannot drop the version stamp. # so composing flags cannot drop the version stamp.
#
# The build target itself always passes -trimpath and -s -w, as the Go
# Dockerfile in REPO_POLICIES.md does: no build paths, symbol table or
# debug information in the binary.
GO_LDFLAGS ?= GO_LDFLAGS ?=
bootstrap: bootstrap:
@@ -49,7 +53,7 @@ check:
@script/check @script/check
build: assets build: assets
go build -ldflags '$(strip -X main.version=$(VERSION) $(GO_LDFLAGS))' -o bin/webhooker ./cmd/webhooker go build -trimpath -ldflags '$(strip -s -w -X main.version=$(VERSION) $(GO_LDFLAGS))' -o bin/webhooker ./cmd/webhooker
run: build run: build
./bin/webhooker ./bin/webhooker
README.md
+2270 -2509
View File
File diff suppressed because it is too large Load Diff
REPO_POLICIES.md
+353 -90
View File
@@ -1,6 +1,6 @@
--- ---
title: Repository Policies title: Repository Policies
last_modified: 2026-08-07 last_modified: 2026-10-04
--- ---
This document covers repository structure, tooling, and workflow standards. Code This document covers repository structure, tooling, and workflow standards. Code
@@ -60,17 +60,28 @@ style conventions are in separate documents:
prerequisite since nvm requires bash. yarn is then pinned via prerequisite since nvm requires bash. yarn is then pinned via
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts"; `corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
always exact versions. `script/cibuild` runs the CI build: it changes to the always exact versions. `script/cibuild` runs the CI build: it changes to the
repo root and runs `docker build .`; the Gitea workflow calls it. Four further repo root, runs `script/bootstrap`, runs `script/check`, and builds the image
scripts are our own extensions to the standard: `script/check` runs with the version; the Gitea workflow calls it. **`script/cibuild` runs
`script/test`, `script/lint`, and `script/fmt-check`; `script/precommit` is `script/bootstrap` first**, because the workflow checks out the repo and runs
what the git pre-commit hook runs, and it calls `script/check`; nothing else, while `script/fmt-check` runs the formatter on the host: on a
`script/install-precommit` installs the git pre-commit hook (the `make hooks` pristine checkout with nothing installed the run dies there, after the
target shims to it); and `script/projectname` (literally that filename) simply containerised gates have passed. **The bootstrap alone is not enough**:
outputs the project's name. Scripts that need the name call `script/bootstrap` installs node and yarn under nvm and leaves neither on the
`script/projectname` — e.g. `script/docker` assembles its image tag from it — `PATH` of the shell that called it, so a bare `yarn` still exits 127. The host
so those scripts stay byte-identical across all repos. Repo-type-specific entrypoints that need yarn — `script/fmt` and `script/fmt-check` — therefore
pre-commit extras (e.g. `go mod tidy` verification in Go repos) belong in source nvm for the pinned node version before invoking it, exactly as
`script/precommit`, not in the hook itself. Model scripts are at `script/bootstrap`'s own install step does. A runner carrying nothing but
docker and git then gets through `script/check`. Four further scripts are our
own extensions to the standard: `script/check` runs `script/test`,
`script/lint` and `script/fmt-check`; `script/precommit` is what the git
pre-commit hook runs, and it calls `script/check`; `script/install-precommit`
installs the git pre-commit hook (the `make hooks` target shims to it); and
`script/projectname` (literally that filename) simply outputs the project's
name. Scripts that need the name call `script/projectname` — e.g.
`script/docker` assembles its image tag from it — so those scripts stay
byte-identical across all repos. Repo-type-specific pre-commit extras (e.g.
`go mod tidy` verification in Go repos) belong in `script/precommit`, not in
the hook itself. Model scripts are at
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README `https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
must document the provided scripts in an **Entrypoints** section (see the must document the provided scripts in an **Entrypoints** section (see the
README requirements below). README requirements below).
@@ -89,87 +100,198 @@ style conventions are in separate documents:
contributor should be able to understand the entire development workflow by contributor should be able to understand the entire development workflow by
reading the Makefile. reading the Makefile.
- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check` - Every repo should have a `Dockerfile`, and it carries the repo's gates: a
as a build step so the build fails if the branch is not green. For non-server `lint` phase and a `test` phase, with the final stage depending on both so the
repos, the Dockerfile should bring up a development environment and run image cannot be built unless they pass. For non-server repos the final stage
`make check`. For server repos, `make check` should run as an early build brings up a development environment; for server repos it is the runtime image.
stage before the final image is assembled. Dockerfiles install development The gate phases and the build stage start from their pinned base images and
prerequisites by running `script/bootstrap` rather than duplicating installs install what those images lack either inline, as the canonical Go `Dockerfile`
inline; COPY `script/` and the dependency manifests (`package.json` + below does for `git`, or by running `script/bootstrap`, as the `prompts`
`yarn.lock`, `go.mod` + `go.sum`, etc.) before running it so the bootstrap repo's own `Dockerfile` does for its yarn packages. The development
layer stays cached until dependencies change. environment stage installs development prerequisites by running
`script/bootstrap` rather than duplicating its installs inline. A stage that
runs `script/bootstrap` COPYs `script/` and the dependency manifests
(`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it.
- **Dockerfiles must use a separate lint stage for fail-fast feedback.** Go - **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
repos use a multistage build where linting runs in an independent stage based no separate lint file. `script/lint` and `script/test` each build one phase
on the `golangci/golangci-lint` image (pinned by hash). This stage runs and nothing else:
`make fmt-check` and `make lint` before the full build begins. The build stage
then declares an explicit dependency on the lint stage via
`COPY --from=lint /src/go.sum /dev/null`, which forces BuildKit to complete
linting before proceeding to compilation and tests. This ensures lint failures
surface in seconds rather than minutes, without blocking on dependency
download or compilation in the build stage.
The standard pattern for a Go repo Dockerfile is: ```sh
docker build --no-cache --target lint -t "$(script/projectname)-lint" .
docker build --no-cache --target test -t "$(script/projectname)-test" .
```
**A stage that is not the last one in the file is built only when the final
stage's chain depends on it, or when `--target` names it.** That is why the
two gates are always invoked by name here, and why the final stage carries a
`COPY --from=` of a harmless file from each of them: without that edge a
plain `docker build .` builds the last stage alone and exits 0 having linted
and tested nothing.
**Every `docker build` in `script/` is tagged**, here and in
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
image behind on every invocation, on every developer host and every CI
runner; a tagged one replaces the previous image.
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
themselves a `docker build` and would recurse into a daemon that does not
exist in a build step. Formatting is the exception and stays on the host:
`script/fmt` writes the working tree, and `script/fmt-check` is its
read-only twin.
**No lint verdict may come from a host invocation of the linter.** On a
shared host golangci-lint reads a result cache keyed on file content rather
than location, so a second checkout of the same content is served the first
one's findings, and a host-global lock in `$TMPDIR` makes concurrent runs
exit non-zero with `parallel golangci-lint is running` — a status a caller
cannot tell from real findings. Both have produced wrong verdicts in this
org, in both directions. A container has its own cache, its own `TMPDIR` and
a digest-pinned binary, so neither is reachable.
- **Any build that runs checks is built with `--no-cache`.** Docker invalidates
a `COPY` layer only when the copied content changes, so on an unchanged tree
the check `RUN` is served from cache, nothing executes, and the build still
exits 0. Every `docker build` in `script/` therefore passes `--no-cache`:
`script/lint`, `script/test`, `script/cibuild` and `script/docker` are the
four, and there is no fifth — `script/check` runs the two gate phases and
`script/fmt-check`, and builds no image of its own. A bare `docker build .` is
not evidence that anything ran: a sub-second build reporting success is a
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
and friends destroy a build cache shared with every other build on the host.
When a check is added or changed, prove it works by planting a defect it must
catch and watching the run fail on it, then revert the defect. A green run
alone shows neither that the check ran nor that it covers what it should.
- **The gate phases are separate stages, and the build stage depends on both.**
The lint phase is based on the `golangci/golangci-lint` image (pinned by
hash), so lint failures surface in seconds rather than after a full compile,
and the test phase is based on the Debian Go image. The canonical Go repo
`Dockerfile`:
```dockerfile ```dockerfile
# Lint stage — fast feedback on formatting and lint issues # Lint phase
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD # golangci/golangci-lint:v2.x.x, YYYY-MM-DD
FROM golangci/golangci-lint@sha256:... AS lint FROM golangci/golangci-lint@sha256:... AS lint
WORKDIR /src WORKDIR /src
COPY go.mod go.sum ./ COPY go.mod go.sum ./
RUN go mod download RUN go mod download
COPY . . COPY . .
RUN make fmt-check RUN golangci-lint run --config .golangci.yml ./...
RUN make lint
# Build stage # Test phase. -race needs cgo and so a C compiler, which the Debian Go
# golang:1.x-alpine, YYYY-MM-DD # image ships and the alpine one does not.
FROM golang@sha256:... AS builder # golang:1.x, YYYY-MM-DD
FROM golang@sha256:... AS test
WORKDIR /src WORKDIR /src
# Force BuildKit to run the lint stage before proceeding
COPY --from=lint /src/go.sum /dev/null
COPY go.mod go.sum ./ COPY go.mod go.sum ./
RUN go mod download RUN go mod download
COPY . . COPY . .
RUN make test RUN go test -timeout 90s -race -cover ./... || \
{ echo "--- Rerunning with -v for details ---"; \
go test -timeout 90s -race -v ./...; exit 1; }
ARG VERSION=dev # Build stage. Nothing is wanted from either phase above; the copies
RUN CGO_ENABLED=0 go build -trimpath \ # are what make BuildKit build them first, so this stage cannot run
-ldflags="-s -w -X main.Version=${VERSION}" \ # unless lint and test passed.
-o /app ./cmd/app/ # golang:1.x-alpine, YYYY-MM-DD
FROM golang@sha256:... AS builder
COPY --from=lint /src/go.sum /dev/null
COPY --from=test /src/go.sum /dev/null
RUN apk add --no-cache git
# A tar-stream context keeps the sender's file owners, which git refuses.
RUN git config --system --add safe.directory /src
WORKDIR /src
COPY go.mod go.sum ./
RUN go mod download
COPY . .
# Runtime stage # The VERSION build arg when one is given, otherwise
# `git describe --tags --always` on the .git in the build context. With
# .git present, a version that is still empty, dev or unknown fails the
# build: git is missing or could not read the checkout.
ARG VERSION
RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \
if [ -e .git ]; then \
case "$VERSION" in ""|dev|unknown) \
echo "version is '$VERSION' although .git is present" >&2; \
exit 1 ;; \
esac; \
fi; \
CGO_ENABLED=0 go build -trimpath \
-ldflags="-s -w -X main.Version=${VERSION}" \
-o /app ./cmd/app/
# Runtime stage, and the last one
FROM alpine@sha256:... FROM alpine@sha256:...
COPY --from=builder /app /usr/local/bin/app COPY --from=builder /app /usr/local/bin/app
ENTRYPOINT ["app"] ENTRYPOINT ["app"]
``` ```
Key points: Key points:
- The lint stage uses the `golangci/golangci-lint` image directly (it - The lint phase uses the `golangci/golangci-lint` image directly (it has
includes both Go and the linter), so there is no need to install the both Go and the linter), so nothing needs installing.
linter separately. - `COPY --from=<phase> /src/go.sum /dev/null` is a no-op copy whose only
- `COPY --from=lint /src/go.sum /dev/null` is a no-op file copy that creates purpose is the ordering edge. BuildKit runs stages in parallel by default,
a stage dependency. BuildKit runs stages in parallel by default; without and a stage nothing depends on is not built at all, so without these two
this line, the build stage would not wait for lint to finish and a lint lines a red gate would not fail the build.
failure might not fail the overall build. - Keep the runtime stage last, and if you add a stage after it, give it the
same two copies. A plain `docker build .` builds the last stage's chain
and nothing else.
- If the project uses `//go:embed` directives that reference build artifacts - If the project uses `//go:embed` directives that reference build artifacts
(e.g. a web frontend compiled in a separate stage), the lint stage must (e.g. a web frontend compiled in a separate stage), the lint phase must
create placeholder files so the embed directives resolve. Example: create placeholder files so the embed directives resolve. Example:
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`. `RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
The lint stage should not depend on the actual build output — it exists to - If the project requires CGO or system libraries for linting, install them
fail fast. in the lint phase. The `golangci/golangci-lint` image is Debian-based and
- If the project requires CGO or system libraries for linting (e.g. has no `apk`, so install with `apt-get` under the Debian package name
`vips-dev`), install them in the lint stage with `apk add`. (`libvips-dev`, where alpine says `vips-dev`), and delete the package
- The build stage runs `make test` after compilation setup. Tests run in the lists in the same `RUN`, so the layer does not keep them:
build stage, not the lint stage, because they may require compiled
artifacts or heavier dependencies. ```dockerfile
RUN apt-get update \
&& apt-get install -y --no-install-recommends libvips-dev \
&& rm -rf /var/lib/apt/lists/*
```
- `.dockerignore` lets `.git` into the build context. It keeps out every git
`config` at any depth (`**/.git/config`, `**/.git/modules/**/config`): the
repository's own, each submodule's under `.git/modules/`, and that of a
submodule keeping its own `.git` directory. `git describe` does not need
them, and each can hold a credential: a password in a remote URL, or the
token the CI checkout step stores there. A submodule whose name has a
`config` segment (`config`, `deploy/config`, `config/lib`) loses its whole
git directory to `**/.git/modules/**/config`, and Go's version stamping
then fails the build: give it a name without that segment
(`git submodule add --name`). The stage that compiles has `git` (the
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
takes the version from the `VERSION` build argument when one is given,
otherwise from `git describe --tags --always`. That gives the tag on a
tagged commit; on a later commit, the tag, the number of commits since it
and the short commit (`v1.2.3-4-gabc1234`); and the short commit when no
tag is reachable. The stage that compiles also marks its working directory
safe for git (`git config --system --add safe.directory /src`): a context
sent as a tar stream keeps the sender's file owners, and git refuses a
checkout owned by another user, so the version would come out empty.
`ARG VERSION` has no default, and the build fails if the context carries
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
`docker build .` with no build arguments must succeed; a Dockerfile that
refuses an empty build argument drops that refusal and keeps the argument.
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that - Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
runs `script/cibuild` (which runs `docker build .`) on push. Since the runs `script/cibuild` on push, and checks out the repo as its only other step.
Dockerfile already runs `make check`, a successful build implies all checks That script bootstraps, runs the gate phases, and then builds the image, so a
pass. successful run means every check passed; a bare `docker build .` does not
carry the same guarantee, because its gate phases may come from the cache. The
image build is uncached and so runs the gate phases a second time. That is the
price of the rule above, and it is worth paying: the image that ships is built
from a run of its own gates rather than from a cache entry. A separate
workflow limited to `main` by a `branches` list under `on: push` cannot be
checked by review: to try a change to it, add the feature branch to that list
and push, then remove the branch from the list again before merging. Keep any
job in it that publishes behind `if: github.ref_name == 'main'`, so the run
from the feature branch publishes nothing.
- Use platform-standard formatters: `black` for Python, `prettier` for - Use platform-standard formatters: `black` for Python, `prettier` for
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
@@ -193,15 +315,17 @@ style conventions are in separate documents:
suite that exceeds it fails. Under 20 seconds is the target. A suite between suite that exceeds it fails. Under 20 seconds is the target. A suite between
20 and 60 seconds is still green, but the overage must be filed as an 20 and 60 seconds is still green, but the overage must be filed as an
improvement bug against that repo. Add a 90-second timeout to the test improvement bug against that repo. Add a 90-second timeout to the test
invocation in the Makefile (`go test -timeout 90s`). The backstop deliberately invocation (`go test -timeout 90s`). The backstop deliberately sits above the
sits above the hard cap so that it catches a genuinely hung test rather than a hard cap so that it catches a genuinely hung test rather than a merely slow
merely slow one. one.
- **`make test` should use the conditional verbose rerun pattern.** Run tests - **The test command should use the conditional verbose rerun pattern.** Run
without `-v` (verbose) first. If tests fail, automatically rerun with `-v` to tests without `-v` (verbose) first. If tests fail, automatically rerun with
show full output. This keeps CI logs and `docker build` output clean on `-v` to show full output. This keeps CI logs and `docker build` output clean
success (just package/suite summaries) while providing full diagnostic detail on success (just package/suite summaries) while providing full diagnostic
on failure (every test case, every assertion). The general shell pattern: detail on failure (every test case, every assertion). The command lives in the
`test` phase of the `Dockerfile`, since `script/test` builds that phase; the
Makefile form below is the same pattern for any repo-local invocation:
```makefile ```makefile
test: test:
@@ -214,11 +338,26 @@ style conventions are in separate documents:
```makefile ```makefile
test: test:
@go test -timeout 90s -race -cover ./... || \ @go test -count=1 -timeout 90s -race -cover ./... || \
{ echo "--- Rerunning with -v for details ---"; \ { echo "--- Rerunning with -v for details ---"; \
go test -timeout 90s -race -v ./...; exit 1; } go test -count=1 -timeout 90s -race -v ./...; exit 1; }
``` ```
`-count=1` is required on both invocations: it defeats Go's test _result_
cache, so neither run can report a stored pass in place of running the
tests. It leaves the build cache alone, so it costs the runtime of the suite
and no recompilation.
That cache is Go's own, separate from Docker's layer cache. Go stores a
passing result in its cache directory (`GOCACHE`), and when the same tests
run again on unchanged code it prints that result, marked `(cached)`,
without running them. That matters on a developer's machine, where this
target runs and the directory lasts from one run to the next. The `test`
phase of the `Dockerfile` needs no `-count=1`: its base image holds no
result for this repo's tests and nothing before its `go test` step runs a
test, so there is nothing to replay. `--no-cache` (above) is what makes that
step run on an unchanged tree.
Python example: Python example:
```makefile ```makefile
@@ -244,10 +383,84 @@ style conventions are in separate documents:
must be in `.gitignore`. No exceptions. must be in `.gitignore`. No exceptions.
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`), - `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`. editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
Fetch the standard `.gitignore` from language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
a new repo. setting up a new repo. These patterns are written to `.gitignore`'s own
semantics, in which an unanchored pattern already matches at every depth; they
are not a `.dockerignore` and must not be transplanted into one unmodified.
- **`.dockerignore` does not use `.gitignore` semantics, and copying patterns
across unmodified leaves secrets in the build context.** Docker matches with
`moby/patternmatcher`: `filepath.Match` semantics plus a `**` extension, so
`*` does not cross `/` and a pattern without a leading `**/` is anchored at
the build-context root. A `.dockerignore` listing `.env`, `*.pem` and `*.key`
therefore excludes only the copies at the repository root, while `config/.env`
and `certs/server.key` still reach the context and can land in an image layer
— which is more dangerous than a short file with no secret patterns at all,
because it reads as solved and stops anyone looking. Give every
depth-independent pattern the `**/` prefix and leave only genuinely
root-anchored entries unprefixed: `.claude`, and the repo's own host-built
binary, written `/myapp` and never `**/myapp`, which would also match
`cmd/myapp/` and delete the package directory from the context. Matching is
case-sensitive, and an ALL-CAPS twin per pattern still misses `Server.Key`, so
secret names use character ranges — `**/*.[kK][eE][yY]`, `**/*.[pP][eE][mM]`,
and likewise for `.envrc` and the extensionless SSH keys. Where such a pattern
also catches something the build needs, re-include it with a negation
(`!docs/example.env`); deleting the pattern reopens the exposure for every
other file it covers. Fetch the standard `.dockerignore` from
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore` and extend
it with the repo's own artifacts.
- **In-repo agent scratch belongs in both files, written to each file's own
semantics.** `.claude/` holds one worktree per in-flight agent — an entire
additional checkout of the repo — so under `COPY . .` the build context
inflates by a multiple of the repo and another session's unreviewed work can
be copied into an image layer. In `.gitignore` the entry is `.claude/`,
unanchored. In `.dockerignore` it is `.claude`, anchored and with **no** `**/`
prefix, because the prefixed form would also delete any nested directory of
that name from the build. Anchoring carries a known gap that the canonical
`.dockerignore` states in its own comment, since consuming repos receive the
file and not the tracker: the directory is created in the agent's working
directory, so a repo running agents in subdirectories still ships
`services/api/.claude/` and must add its own anchored entry there.
- **A plain `docker build .` of a clone stamps the version that
`git describe --tags --always` gives**, derived from the `.git` in the build
context as the canonical `Dockerfile` above shows. Without its failure check,
a missing `git` or an unreadable checkout would leave `-X main.Version=` empty
and the build would still exit 0. `script/docker` and `script/cibuild` pass
the version they compute on the host; it takes precedence. They do this
byte-identically across repos:
```sh
# Own line: a failing command substitution inside an argument does not
# trip `set -e`, so the inline form degrades to an empty constant.
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown"
docker build --no-cache \
--build-arg VERSION="$version" \
-t "$(script/projectname)" .
```
`--always` makes an untagged repo yield an abbreviated commit hash rather
than failing, and the `[ -n "$version" ]` line is the single place the
fallback is applied — a live check that fires on a build from an export with
no `.git` and on a repository with no commits yet. Do not fold it into the
substitution as `|| echo unknown`, which makes the guard unreachable. The
Dockerfile's side is `ARG VERSION` in the stage that compiles, declared
there because `ARG` is stage-scoped; passing `VERSION` to a repo whose
Dockerfile declares no such `ARG` is ignored and costs nothing, which is why
the scripts stay byte-identical. One consequence for CI: the standard
checkout action clones shallow and fetches no tags, so a repo that embeds a
tag-derived version must set `fetch-depth: 0` on its checkout step.
- **Verify `.dockerignore` by enumerating the image, not by reading the
patterns.** Plant files at the root _and_ at least two directories deep, build
a probe image that does `COPY . .`, and list what actually landed
(`docker run --rm --entrypoint find IMAGE /app`). The `transferring context`
size is not a substitute: a nested secret is a few bytes, and BuildKit
transfers only the delta from the previous build.
- **No build artifacts in version control.** Code-derived data (compiled - **No build artifacts in version control.** Code-derived data (compiled
bundles, minified output, generated assets) must never be committed to the bundles, minified output, generated assets) must never be committed to the
@@ -263,12 +476,56 @@ style conventions are in separate documents:
- Make all changes on a feature branch. You can do whatever you want on a - Make all changes on a feature branch. You can do whatever you want on a
feature branch. feature branch.
- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only - `.golangci.yml` is standardized. The vendored copy in a consuming repo must
manually by the user. Fetch from _NEVER_ be modified by an agent: fetch it from
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`. The `https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and keep it
canonical golangci-lint version is v2.12.2 (released 2026-05-06), installed byte-identical, so that no repo can quietly loosen its own linting. Linter
commit-pinned via configuration changes are made to the canonical copy in the `prompts` repo and
`go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@c0d3ddc9cf3faa61a4e378e879ece580256d76e5`. reach consuming repos by re-vendoring; an agent may open a PR against
canonical, which only the user merges. One list is exempt from byte-identity,
because it cannot be written once for every repo: the `deny` list of the
`test-support` depguard rule, where a repo names its own test-support packages
by full import path. A repo adds entries there and changes nothing else, and a
re-vendor carries its entries forward. The canonical golangci-lint version is
v2.14.0 (released 2026-09-24), pinned as the digest of the lint phase's base
image
(`golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f`,
which reports `2.14.0 built with go1.27.0 from 114493f9`). A module's `go`
directive must not name a newer Go minor version than the one golangci-lint
was built with, or golangci-lint refuses to lint it: this release lints
`go 1.27.1` but not `go 1.28`. That digest is the only pin, since no repo
installs golangci-lint on the host. A repo sets the lint phase digest to the
one named here and re-vendors `.golangci.yml` in the same commit, whichever of
the two prompted the change: the canonical copy can name linters that an older
golangci-lint rejects, and a newer golangci-lint can add linters that
`default: all` switches on until the canonical copy disables them.
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
`PATH` only, so on an already-provisioned machine the pin is inert and a
version bump is a silent no-op — while the Dockerfile, installing into a clean
image, gets the pinned version, so a local `make check` and `make docker` can
disagree about what the tool even is. The canonical form:
- compares the installed version against the pin over the **whole** version
token; a parser that stops at the first `-` reports `2.12.2` for a host
running `2.12.2-rc1` and skips the install;
- treats absent, non-zero, empty or unrecognised `--version` output as a
mismatch, so the failure direction is a redundant install and never a
skipped one;
- after installing, re-resolves the binary the way callers do — `hash -r`,
then through `PATH`, not through the directory the installer wrote to —
and fails naming the resolved path, since an install that a shadowing
binary hides succeeds while changing nothing any caller sees;
- is actually called, and prints the version on both success paths: a
function defined and never invoked has the same exit status and the same
empty output as one that worked.
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
A Go tool a repo needs on the host is installed with `go install` pinned to
a commit hash (`go install <package>@<commit hash>`). It is never tracked as
a `go.mod` tool dependency or through a `tools.go` file, either of which
pulls the tool's own dependencies into the repo's `go.mod` and `go.sum`.
- When pinning images or packages by hash, add a comment above the reference - When pinning images or packages by hash, add a comment above the reference
with the version and date (YYYY-MM-DD). with the version and date (YYYY-MM-DD).
@@ -382,12 +639,14 @@ style conventions are in separate documents:
settings. settings.
- Avoid putting files in the repo root unless necessary. Root should contain - Avoid putting files in the repo root unless necessary. Root should contain
only project-level config files (`README.md`, `Makefile`, `Dockerfile`, only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
`LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and `Dockerfile`, `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`,
language-specific config). Everything else goes in a subdirectory. Canonical and language-specific config). Everything else goes in a subdirectory.
subdirectory names: Canonical subdirectory names:
- `bin/` — executable scripts and tools - `bin/` — executable scripts and tools
- `cmd/` — Go command entrypoints - `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
body is a single call into `internal/` or `pkg/`, no project logic in
`cmd/`
- `configs/` — configuration templates and examples - `configs/` — configuration templates and examples
- `deploy/` — deployment manifests (k8s, compose, terraform) - `deploy/` — deployment manifests (k8s, compose, terraform)
- `docs/` — documentation and markdown (README.md stays in root) - `docs/` — documentation and markdown (README.md stays in root)
@@ -414,3 +673,7 @@ style conventions are in separate documents:
- Go: `go.mod`, `go.sum`, `.golangci.yml` - Go: `go.mod`, `go.sum`, `.golangci.yml`
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore` - JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
- Python: `pyproject.toml` - Python: `pyproject.toml`
- Guidance for coding agents lives in one `AGENTS.md` at the repository root. It
is never committed under a file or directory named after one agent tool, such
as `CLAUDE.md` or `.claude/`, and never split into separate memory files.
TODO.md
+313 -349
View File
@@ -2,403 +2,367 @@
One issue per unit of work, one branch and one PR per issue: One issue per unit of work, one branch and one PR per issue:
* ensure a tracked issue exists with a definition of done - ensure a tracked issue exists with a definition of done
* branch from `next` (never from `main`) - branch from `next` (never from `main`)
* do the work; open a PR based on `next` (never on `main`) - do the work; open a PR based on `next` (never on `main`)
* pass an independent review, then the manager squash-merges into `next` - pass an independent review, then the manager squash-merges into `next`
* push; nothing stays local-only - push; nothing stays local-only
`next` is the branch for the next milestone and must stay green and `next` is the branch for the next milestone and must stay green and mergeable to
mergeable to `main` without notice. One `next` -> `main` PR accumulates `main` without notice. One `next` -> `main` PR accumulates the milestone;
the milestone; releases are cut from `main` separately. releases are cut from `main` separately.
Issue branches do NOT touch this file — the manager maintains it on Issue branches do NOT touch this file — the manager maintains it on `next`.
`next`. Every branch editing `TODO.md` conflicts with every other Every branch editing `TODO.md` conflicts with every other (#112).
(#112).
# Status # Status
The milestone (https://git.eeqj.de/sneak/webhooker/milestone/9) is the The milestone (https://git.eeqj.de/sneak/webhooker/milestone/9) is the
authoritative list, and the only place to read a count or a state of authoritative list, and the only place to read a count or a state of play from.
play from. This file records where the project is, not what is in This file records where the project is, not what is in flight: a sentence whose
flight: a sentence whose truth depends on a branch being unmerged is truth depends on a branch being unmerged is wrong the moment it merges, and this
wrong the moment it merges, and this file has been wrong that way file has been wrong that way before.
before.
The durability defect that held the tag has landed The durability defect that held the tag has landed
(https://git.eeqj.de/sneak/webhooker/issues/256, commit `8d64259`). (https://git.eeqj.de/sneak/webhooker/issues/256, commit `8d64259`). Every SQLite
Every SQLite handle opens with WAL journaling and a busy timeout, a handle opens with WAL journaling and a busy timeout, a bookkeeping write that
bookkeeping write that fails leaves its delivery in a recoverable fails leaves its delivery in a recoverable state rather than a lying one, and
state rather than a lying one, and recovery skips a delivery that recovery skips a delivery that already has a successful result row. Final
already has a successful result row. Final pre-tag verification pre-tag verification exercised it and confirmed it holds. Whatever the milestone
exercised it and confirmed it holds. Whatever the milestone still still shows open is what remains before `v1.0.0`.
shows open is what remains before `v1.0.0`.
Delivery is at-least-once by design, not by accident: a send whose Delivery is at-least-once by design, not by accident: a send whose result row
result row does not land is attempted again, so a receiver can see a does not land is attempted again, so a receiver can see a duplicate. That is
duplicate. That is deliberate — the alternative is a silent lost deliberate — the alternative is a silent lost delivery — and the README says so
delivery — and the README says so under Rationale. It is not a defect under Rationale. It is not a defect to re-file.
to re-file.
# Next Step # Next Step
Clear the rest of the open 1.0.0 milestone Clear the rest of the open 1.0.0 milestone
(https://git.eeqj.de/sneak/webhooker/milestone/9) and tag `v1.0.0`. (https://git.eeqj.de/sneak/webhooker/milestone/9) and tag `v1.0.0`. Merging
Merging `next` into `main` is a separate act from tagging and waits on `next` into `main` is a separate act from tagging and waits on neither of those:
neither of those: `next` is kept mergeable at all times, which is the `next` is kept mergeable at all times, which is the point of the branch.
point of the branch.
# Completed Steps # Completed Steps
- 2026-08-24 Bind the plaintext HTTP listener deliberately, via - 2026-08-24 Bind the plaintext HTTP listener deliberately, via `BIND_ADDRESS`
`BIND_ADDRESS` defaulting to `127.0.0.1`, and document the defaulting to `127.0.0.1`, and document the reverse-proxy deployment. A
reverse-proxy deployment. A hostname, an empty value or a value hostname, an empty value or a value carrying a port is a startup error, and
carrying a port is a startup error, and the `Dockerfile` sets the `Dockerfile` sets `0.0.0.0` because a loopback bind inside a container is
`0.0.0.0` because a loopback bind inside a container is unreachable unreachable (https://git.eeqj.de/sneak/webhooker/issues/268). The same commit
(https://git.eeqj.de/sneak/webhooker/issues/268). The same commit removed the shutdown race: `httpServer` is built in the constructor rather
removed the shutdown race: `httpServer` is built in the constructor than assigned from the serving goroutine, which orders the write before every
rather than assigned from the serving goroutine, which orders the fx hook and rules out the nil dereference a SIGTERM arriving first would have
write before every fx hook and rules out the nil dereference a caused, and `sentryEnabled` is an `atomic.Bool`
SIGTERM arriving first would have caused, and `sentryEnabled` is an (https://git.eeqj.de/sneak/webhooker/issues/226)
`atomic.Bool` (https://git.eeqj.de/sneak/webhooker/issues/226) - 2026-08-24 Remove inbound request signature verification. The entrypoint UUID
- 2026-08-24 Remove inbound request signature verification. The is the authentication secret, so the per-entrypoint shared secret, the
entrypoint UUID is the authentication secret, so the per-entrypoint `internal/signature` package, the receiver check, the model fields and the
shared secret, the `internal/signature` package, the receiver check, forms are all gone. This reverses the feature that landed earlier in the same
the model fields and the forms are all gone. This reverses the milestone (https://git.eeqj.de/sneak/webhooker/issues/67,
feature that landed earlier in the same milestone
(https://git.eeqj.de/sneak/webhooker/issues/67,
https://git.eeqj.de/sneak/webhooker/issues/279) https://git.eeqj.de/sneak/webhooker/issues/279)
- 2026-08-24 Stamp the build version into the binary and render it in - 2026-08-24 Stamp the build version into the binary and render it in the UI
the UI footer. `script/version` is the single source — `$VERSION`, footer. `script/version` is the single source — `$VERSION`, else
else `git describe --tags --always --dirty`, else `unknown` — so a `git describe --tags --always --dirty`, else `unknown` — so a `make build`
`make build` binary and a `make docker` image from one checkout binary and a `make docker` image from one checkout report the same thing, and
report the same thing, and nothing in it varies between two builds nothing in it varies between two builds of the same commit, which the release
of the same commit, which the release gate's byte-identical gate's byte-identical assertion would catch
assertion would catch
(https://git.eeqj.de/sneak/webhooker/issues/253) (https://git.eeqj.de/sneak/webhooker/issues/253)
- 2026-08-24 Derive cookie `Secure` and CSRF strictness from the - 2026-08-24 Derive cookie `Secure` and CSRF strictness from the request
request transport rather than from `WEBHOOKER_ENVIRONMENT`. Behind a transport rather than from `WEBHOOKER_ENVIRONMENT`. Behind a real TLS proxy
real TLS proxy with the environment left at its `dev` default, the with the environment left at its `dev` default, the session cookie silently
session cookie silently lost `Secure` while the CSRF cookie on the lost `Secure` while the CSRF cookie on the same response kept it.
same response kept it. `X-Forwarded-Proto` is now matched `X-Forwarded-Proto` is now matched case-insensitively on its first
case-insensitively on its first comma-separated element, so `HTTPS` comma-separated element, so `HTTPS` and `https, http` no longer fall to the
and `https, http` no longer fall to the relaxed CSRF path relaxed CSRF path (https://git.eeqj.de/sneak/webhooker/issues/269)
(https://git.eeqj.de/sneak/webhooker/issues/269) - 2026-08-24 Roll back a failed webhook deletion instead of committing it. A
- 2026-08-24 Roll back a failed webhook deletion instead of committing failing delete committed whatever had already succeeded, hard-deleted the
it. A failing delete committed whatever had already succeeded, per-webhook event database anyway, and redirected as though it had worked —
hard-deleted the per-webhook event database anyway, and redirected as orphaned config plus permanently destroyed history, reported as success. All
though it had worked — orphaned config plus permanently destroyed three delete positions now roll back with the event database intact
history, reported as success. All three delete positions now roll
back with the event database intact
(https://git.eeqj.de/sneak/webhooker/issues/262) (https://git.eeqj.de/sneak/webhooker/issues/262)
- 2026-08-24 Name a deleted target on its historical deliveries, marked - 2026-08-24 Name a deleted target on its historical deliveries, marked
`(deleted)`, rather than leaving the event log unable to say where a `(deleted)`, rather than leaving the event log unable to say where a delivery
delivery went. A deleted target's credentials stay masked exactly as went. A deleted target's credentials stay masked exactly as a live one's, and
a live one's, and it cannot become deliverable again through the it cannot become deliverable again through the receiver, resubmit, replay, the
receiver, resubmit, replay, the edit form or the toggle edit form or the toggle (https://git.eeqj.de/sneak/webhooker/issues/211)
(https://git.eeqj.de/sneak/webhooker/issues/211) - 2026-08-24 Bound both request-controlled `/metrics` label dimensions, so the
- 2026-08-24 Bound both request-controlled `/metrics` label dimensions, unauthenticated receiver is no longer a memory-exhaustion vector: `handler`
so the unauthenticated receiver is no longer a memory-exhaustion carries the chi route pattern, and `method` folds anything chi cannot route
vector: `handler` carries the chi route pattern, and `method` folds onto a single `(unmatched)` sentinel. Both were reproduced before the fix —
anything chi cannot route onto a single `(unmatched)` sentinel. Both 300 random method tokens took the series count from 106 to 7,631, and path
were reproduced before the fix — 300 random method tokens took the flooding reached 62,532 — and a label audit across a live scrape found no
series count from 106 to 7,631, and path flooding reached 62,532 — third unbounded dimension (https://git.eeqj.de/sneak/webhooker/issues/254,
and a label audit across a live scrape found no third unbounded
dimension (https://git.eeqj.de/sneak/webhooker/issues/254,
https://git.eeqj.de/sneak/webhooker/issues/261) https://git.eeqj.de/sneak/webhooker/issues/261)
- 2026-08-24 Validate `max_retries` on both target forms. `abc`, `2.7` - 2026-08-24 Validate `max_retries` on both target forms. `abc`, `2.7` and `-5`
and `-5` silently became 0 — fire-and-forget — including on the edit silently became 0 — fire-and-forget — including on the edit path, where it
path, where it destroyed a working value, and `999999999` stored destroyed a working value, and `999999999` stored verbatim. The ceiling of 20
verbatim. The ceiling of 20 is the `max` both templates already is the `max` both templates already declared
declared (https://git.eeqj.de/sneak/webhooker/issues/221) (https://git.eeqj.de/sneak/webhooker/issues/221)
- 2026-08-24 Resubmit a stored event as a new undelivered event, so a - 2026-08-24 Resubmit a stored event as a new undelivered event, so a backend
backend under development can be tested against real captured under development can be tested against real captured traffic. Per-delivery
traffic. Per-delivery replay cannot serve that: it re-sends one replay cannot serve that: it re-sends one finished delivery to its own
finished delivery to its own original target, and a target created original target, and a target created for a dev backend has no prior delivery
for a dev backend has no prior delivery to replay. Resubmit to replay. Resubmit re-injects the stored event at the top of the receiver
re-injects the stored event at the top of the receiver path and fans path and fans it out to whatever targets are active now
it out to whatever targets are active now
(https://git.eeqj.de/sneak/webhooker/issues/250) (https://git.eeqj.de/sneak/webhooker/issues/250)
- 2026-08-20 Take an exclusive lock on `DATA_DIR` at startup, so two - 2026-08-20 Take an exclusive lock on `DATA_DIR` at startup, so two instances
instances on one directory cannot both deliver on one directory cannot both deliver
(https://git.eeqj.de/sneak/webhooker/issues/201) (https://git.eeqj.de/sneak/webhooker/issues/201)
- 2026-08-20 Shut down the app when the HTTP listener fails. The - 2026-08-20 Shut down the app when the HTTP listener fails. The `OnStart` hook
`OnStart` hook returned as soon as the serving goroutine was returned as soon as the serving goroutine was spawned, so a failed listen left
spawned, so a failed listen left fx reporting RUNNING and a live fx reporting RUNNING and a live process with nothing bound — invisible to
process with nothing bound — invisible to systemd and Docker restart systemd and Docker restart policies
policies (https://git.eeqj.de/sneak/webhooker/issues/200) (https://git.eeqj.de/sneak/webhooker/issues/200)
- 2026-08-20 Stop target credentials leaking into the per-webhook event - 2026-08-20 Stop target credentials leaking into the per-webhook event
databases (https://git.eeqj.de/sneak/webhooker/issues/206), log SQL databases (https://git.eeqj.de/sneak/webhooker/issues/206), log SQL with
with placeholders rather than bound values placeholders rather than bound values
(https://git.eeqj.de/sneak/webhooker/issues/207), and fail loudly on (https://git.eeqj.de/sneak/webhooker/issues/207), and fail loudly on half-set
half-set metrics auth credentials metrics auth credentials (https://git.eeqj.de/sneak/webhooker/issues/205)
(https://git.eeqj.de/sneak/webhooker/issues/205) - 2026-08-20 Read queue depths with `Find`, not `Scan`. `Scan` swaps GORM's own
- 2026-08-20 Read queue depths with `Find`, not `Scan`. `Scan` swaps trace recorder in for the logging adapter, and that recorder does not
GORM's own trace recorder in for the logging adapter, and that implement `gorm.ParamsFilter`, so those statements logged their bound values
recorder does not implement `gorm.ParamsFilter`, so those statements interpolated and bypassed the suppression above. The two units gated green
logged their bound values interpolated and bypassed the suppression against a `next` that lacked the other, and `next` went red when both landed
above. The two units gated green against a `next` that lacked the
other, and `next` went red when both landed
(https://git.eeqj.de/sneak/webhooker/issues/234) (https://git.eeqj.de/sneak/webhooker/issues/234)
- 2026-08-20 Render per-attempt delivery detail in the event log - 2026-08-20 Render per-attempt delivery detail in the event log
(https://git.eeqj.de/sneak/webhooker/issues/202) and add replay of a (https://git.eeqj.de/sneak/webhooker/issues/202) and add replay of a
terminally failed delivery terminally failed delivery (https://git.eeqj.de/sneak/webhooker/issues/203)
(https://git.eeqj.de/sneak/webhooker/issues/203)
- 2026-08-20 Expose delivery metrics on `/metrics` - 2026-08-20 Expose delivery metrics on `/metrics`
(https://git.eeqj.de/sneak/webhooker/issues/209) and document the (https://git.eeqj.de/sneak/webhooker/issues/209) and document the backup,
backup, restore and upgrade procedures restore and upgrade procedures
(https://git.eeqj.de/sneak/webhooker/issues/210) (https://git.eeqj.de/sneak/webhooker/issues/210)
- 2026-08-20 Add a `webhooker resetpw` subcommand and a bootstrap - 2026-08-20 Add a `webhooker resetpw` subcommand and a bootstrap banner. The
banner. The admin bootstrap password was printed once among roughly admin bootstrap password was printed once among roughly 45 fx lines, and under
45 fx lines, and under `docker run -d` went to container logs subject `docker run -d` went to container logs subject to rotation; there was no reset
to rotation; there was no reset path at all, so recovery meant path at all, so recovery meant hand-deleting the users row, documented
hand-deleting the users row, documented nowhere. The password is read nowhere. The password is read from stdin or generated, never from argv where
from stdin or generated, never from argv where `/proc` would publish `/proc` would publish it (https://git.eeqj.de/sneak/webhooker/issues/208)
it (https://git.eeqj.de/sneak/webhooker/issues/208) - 2026-08-20 Add `ALLOWED_EGRESS_CIDRS`, an allowlist-only escape hatch for the
- 2026-08-20 Add `ALLOWED_EGRESS_CIDRS`, an allowlist-only escape hatch SSRF guard, so a self-hosted proxy can forward into the operator's own
for the SSRF guard, so a self-hosted proxy can forward into the network. The guard's always-blocked set cannot be reopened by configuration
operator's own network. The guard's always-blocked set cannot be
reopened by configuration
(https://git.eeqj.de/sneak/webhooker/issues/204) (https://git.eeqj.de/sneak/webhooker/issues/204)
- 2026-08-20 Harden operator-set target headers, which were carried - 2026-08-20 Harden operator-set target headers, which were carried unsafely
unsafely across a redirect across a redirect (https://git.eeqj.de/sneak/webhooker/issues/233)
(https://git.eeqj.de/sneak/webhooker/issues/233)
- 2026-08-20 Add a target edit form with headers and timeout fields - 2026-08-20 Add a target edit form with headers and timeout fields
(https://git.eeqj.de/sneak/webhooker/issues/127) (https://git.eeqj.de/sneak/webhooker/issues/127)
- 2026-08-18 Raise `script/test`'s per-package timeout from 30s to 90s, - 2026-08-18 Raise `script/test`'s per-package timeout from 30s to 90s, matching
matching the org-wide backstop. `go test` applies `-timeout` per the org-wide backstop. `go test` applies `-timeout` per package, and
package, and `internal/handlers` had grown past the old budget: a `internal/handlers` had grown past the old budget: a cache-defeated build
cache-defeated build failed outright at `GOMAXPROCS=4`, and every run failed outright at `GOMAXPROCS=4`, and every run under deliberate host load
under deliberate host load breached 30s. The measurement table lives breached 30s. The measurement table lives in the script (#194)
in the script (#194) - 2026-08-18 Re-sync `REPO_POLICIES.md` from `prompts`. The local copy was stale
- 2026-08-18 Re-sync `REPO_POLICIES.md` from `prompts`. The local copy and still mandated a 20s test target with a 30s timeout, which the org
was stale and still mandated a 20s test target with a 30s timeout, replaced with a 60s cap and a 90s backstop. A synced copy is not a source;
which the org replaced with a 60s cap and a 90s backstop. A synced reading it as one nearly produced a PR against `prompts` proposing a change
copy is not a source; reading it as one nearly produced a PR against already merged there (#196)
`prompts` proposing a change already merged there (#196) - 2026-08-18 Report handler panics through the logger and answer 500. chi
- 2026-08-18 Report handler panics through the logger and answer 500. v1.5.5's `Recoverer` scans for a `panic(0x` frame the runtime no longer emits,
chi v1.5.5's `Recoverer` scans for a `panic(0x` frame the runtime no then indexes `pkg[-1:]`, so it panicked inside its own stack printer before
longer emits, then indexes `pkg[-1:]`, so it panicked inside its own writing a byte: the recovery never ran, the client got a dropped connection
stack printer before writing a byte: the recovery never ran, the instead of a 500, and the original panic was lost. A local middleware replaces
client got a dropped connection instead of a 500, and the original it, bounded by `MaxPanicLogLineBytes` (#187)
panic was lost. A local middleware replaces it, bounded by - 2026-08-18 Route GORM's logger through `slog` and bound it. Every `gorm.Open`
`MaxPanicLogLineBytes` (#187) left `logger.Default` in place at `Warn` with `IgnoreRecordNotFoundError`
- 2026-08-18 Route GORM's logger through `slog` and bound it. Every false, so **every record-not-found printed the fully interpolated SQL to
`gorm.Open` left `logger.Default` in place at `Warn` with stdout** — including the client-chosen path on `/webhook/{uuid}` and the
`IgnoreRecordNotFoundError` false, so **every record-not-found submitted username on the login form, at no level the operator set and outside
printed the fully interpolated SQL to stdout** — including the `internal/logger` entirely. Three call sites, not the two the issue named
client-chosen path on `/webhook/{uuid}` and the submitted username on (#178)
the login form, at no level the operator set and outside - 2026-08-18 Bound every `slog` line against client-chosen text. Eight sites
`internal/logger` entirely. Three call sites, not the two the issue reachable unauthenticated, found by reading every `slog` call in the tree
named (#178) rather than only the one reported; the budget moved to a shared
- 2026-08-18 Bound every `slog` line against client-chosen text. Eight `internal/logfield` so no second truncation exists. `DEBUG` being off by
sites reachable unauthenticated, found by reading every `slog` call in default is not a bound and is not treated as one (#176)
the tree rather than only the one reported; the budget moved to a - 2026-08-18 Stop a slow host turning a login-guard test into a segfault. A
shared `internal/logfield` so no second truncation exists. `DEBUG` non-fatal `assert` on an acquire result was dereferenced on the next line, so
being off by default is not a bound and is not treated as one (#176) one timing miss killed the whole `internal/middleware` binary and reddened CI
- 2026-08-18 Stop a slow host turning a login-guard test into a for unrelated PRs. The fix also removed a real production race — `acquire`
segfault. A non-fatal `assert` on an acquire result was dereferenced could shed a request with a slot standing free, because Go picks uniformly
on the next line, so one timing miss killed the whole among ready `select` cases (#186)
`internal/middleware` binary and reddened CI for unrelated PRs. The - 2026-08-18 Send the chi route pattern to Sentry rather than the concrete path.
fix also removed a real production race — `acquire` could shed a The receiver's path carries the entrypoint capability token, so every Sentry
request with a slot standing free, because Go picks uniformly among event from `/webhook/{uuid}` shipped a live credential to a third party.
ready `select` cases (#186) Request `Data`, `QueryString`, `Cookies` and `Env` are dropped and headers
- 2026-08-18 Send the chi route pattern to Sentry rather than the reduced to an allowlist (#179)
concrete path. The receiver's path carries the entrypoint capability - 2026-08-18 Read form fields from the POST body only. `r.FormValue` merges the
token, so every Sentry event from `/webhook/{uuid}` shipped a live query string, so a login could be driven by URL parameters — putting the
credential to a third party. Request `Data`, `QueryString`, `Cookies` password somewhere that lands in access logs, proxy logs and browser history
and `Env` are dropped and headers reduced to an allowlist (#179) (#160)
- 2026-08-18 Read form fields from the POST body only. `r.FormValue` - 2026-08-18 Verify login credentials before spending rate-limit budget, so a
merges the query string, so a login could be driven by URL parameters flood of wrong passwords cannot lock out the account it is guessing at. The
— putting the password somewhere that lands in access logs, proxy manager took this decision rather than stall the queue; it is flagged on the
logs and browser history (#160) issue for reversal (#150)
- 2026-08-18 Verify login credentials before spending rate-limit - 2026-08-18 Run all linting in Docker via `Dockerfile.lint`. Host lint was
budget, so a flood of wrong passwords cannot lock out the account it wrong in both directions from version skew and shared caches. `script/lint`
is guessing at. The manager took this decision rather than stall the asserts the summary line, because `--no-cache-filter` silently ignores a stage
queue; it is flagged on the issue for reversal (#150) name it does not match — the flag that makes the gate meaningful fails open
- 2026-08-18 Run all linting in Docker via `Dockerfile.lint`. Host lint (#109)
was wrong in both directions from version skew and shared caches. - 2026-08-18 Serve an event's full stored body over HTTP. The list query
`script/lint` asserts the summary line, because `--no-cache-filter` truncates for rendering, and that truncated value was the only way to read a
silently ignores a stage name it does not match — the flag that makes body, so the full payload was unreachable (#157)
the gate meaningful fails open (#109)
- 2026-08-18 Serve an event's full stored body over HTTP. The list
query truncates for rendering, and that truncated value was the only
way to read a body, so the full payload was unreachable (#157)
- 2026-08-18 Bound the access log line against client-chosen text. - 2026-08-18 Bound the access log line against client-chosen text.
`internal/logfield` budgets by *encoded* bytes, not runes, so a `internal/logfield` budgets by _encoded_ bytes, not runes, so a handler's JSON
handler's JSON escaping cannot multiply a field past its allowance escaping cannot multiply a field past its allowance (#146)
(#146) - 2026-08-18 Mark superseded CI commits `failure` rather than `skipped`. A
- 2026-08-18 Mark superseded CI commits `failure` rather than skipped run rolls up green, so a commit that was never tested reported success
`skipped`. A skipped run rolls up green, so a commit that was never (#152)
tested reported success (#152) - 2026-08-18 Set `fx.StopTimeout` inside the container stop grace, so shutdown
- 2026-08-18 Set `fx.StopTimeout` inside the container stop grace, so hooks are bounded by a deadline the orchestrator will actually honour rather
shutdown hooks are bounded by a deadline the orchestrator will than being killed mid-flush (#134)
actually honour rather than being killed mid-flush (#134) - 2026-08-17 Bucket IPv6 rate-limit keys by `/64`. A single allocation hands out
- 2026-08-17 Bucket IPv6 rate-limit keys by `/64`. A single allocation 2^64 addresses, so per-address keying let one client mint unlimited buckets.
hands out 2^64 addresses, so per-address keying let one client mint Manager decision, recorded on the issue (#125)
unlimited buckets. Manager decision, recorded on the issue (#125) - 2026-08-17 Correct release-blocking README and startup-warning inaccuracies,
- 2026-08-17 Correct release-blocking README and startup-warning including claims about behaviour the code does not have (#151)
inaccuracies, including claims about behaviour the code does not have
(#151)
- 2026-08-17 Fetch and verify Alpine.js at build time against - 2026-08-17 Fetch and verify Alpine.js at build time against
`static/vendor.sha256` instead of committing the minified blob, so `static/vendor.sha256` instead of committing the minified blob, so the
the dependency is pinned by hash rather than by trust (#145) dependency is pinned by hash rather than by trust (#145)
- 2026-08-17 Bound the event log's rendered bodies in the query itself, - 2026-08-17 Bound the event log's rendered bodies in the query itself, so a
so a large stored payload cannot be read into memory just to be large stored payload cannot be read into memory just to be truncated for
truncated for display (#135) display (#135)
- 2026-08-17 Mask the `http` target's destination URL in the UI: it can - 2026-08-17 Mask the `http` target's destination URL in the UI: it can carry a
carry a bearer credential in its path or query, and was rendered bearer credential in its path or query, and was rendered verbatim. Manager
verbatim. Manager decision to mask unconditionally (#115) decision to mask unconditionally (#115)
- 2026-08-14 Bound shutdown hooks by their stop context, so a hook that - 2026-08-14 Bound shutdown hooks by their stop context, so a hook that hangs
hangs cannot hold the process past its grace period (#102) cannot hold the process past its grace period (#102)
- 2026-08-14 Render templates via a buffer rather than the - 2026-08-14 Render templates via a buffer rather than the `ResponseWriter`, so
`ResponseWriter`, so a template error part-way through cannot commit a template error part-way through cannot commit a 200 and then fail — the
a 200 and then fail — the response is written only once it is whole response is written only once it is whole (#123)
(#123) - 2026-08-14 Align the session codec's max-age with the 7-day absolute cap. The
- 2026-08-14 Align the session codec's max-age with the 7-day absolute codec accepted cookies the session layer considered expired, so the cap was
cap. The codec accepted cookies the session layer considered expired, enforced in one place and not the other (#108)
so the cap was enforced in one place and not the other (#108) - 2026-08-12 Warn when `TRUSTED_PROXIES` is empty in production, where the safe
- 2026-08-12 Warn when `TRUSTED_PROXIES` is empty in production, where default silently discards forwarded headers and every client rate-limits as
the safe default silently discards forwarded headers and every client the proxy's address (#149)
rate-limits as the proxy's address (#149) - 2026-08-12 Bound the receiver rate limit per client IP across the whole
- 2026-08-12 Bound the receiver rate limit per client IP across the `/webhook/*` route. The existing limiter keyed on the request path and
whole `/webhook/*` route. The existing limiter keyed on the request `/webhook/{uuid}` matches any single segment, so a client that invented a
path and `/webhook/{uuid}` matches any single segment, so a client fresh path per request minted a fresh bucket per request: the limit on the
that invented a fresh path per request minted a fresh bucket per only unauthenticated endpoint bounded nothing in aggregate, and every request
request: the limit on the only unauthenticated endpoint bounded still cost an entrypoint lookup before it 404ed. An outer limiter keyed on the
nothing in aggregate, and every request still cost an entrypoint client address alone now bounds that, chained in front of the unchanged
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) per-entrypoint limiter (#139)
- 2026-08-12 Correct release-blocking documentation inaccuracies: the - 2026-08-12 Correct release-blocking documentation inaccuracies: the README
README promised manual redelivery in the present tense in three promised manual redelivery in the present tense in three places when nothing
places when nothing implements it (the same false claim also sat in implements it (the same false claim also sat in the doc comment that was its
the doc comment that was its source text), the env table omitted source text), the env table omitted `RETENTION_SWEEP_INTERVAL`, and `TODO.md`
`RETENTION_SWEEP_INTERVAL`, and `TODO.md` itself omitted five landed itself omitted five landed units (#141)
units (#141) - 2026-08-12 Make the CI gate execute the checks it reports on. The workflow now
- 2026-08-12 Make the CI gate execute the checks it reports on. The writes a build-context fingerprint before calling `script/cibuild`, so a code
workflow now writes a build-context fingerprint before calling commit invalidates the `COPY` layer of the lint and builder stages while a
`script/cibuild`, so a code commit invalidates the `COPY` layer of docs-only commit still replays from cache; a superseding run also rewrites the
the lint and builder stages while a docs-only commit still replays `failure` status Gitea leaves on commits it cancelled and never tested.
from cache; a superseding run also rewrites the `failure` status Verified by pushing a deliberately broken test and watching CI go red (#119)
Gitea leaves on commits it cancelled and never tested. Verified by - 2026-08-12 Require a positive `RETENTION_SWEEP_INTERVAL`: a non-positive value
pushing a deliberately broken test and watching CI go red (#119) reached `time.NewTicker` in both the retention reaper and the archive sweeper,
- 2026-08-12 Require a positive `RETENTION_SWEEP_INTERVAL`: a panicking two goroutines with no recover after startup had already reported
non-positive value reached `time.NewTicker` in both the retention success (#140)
reaper and the archive sweeper, panicking two goroutines with no - 2026-08-12 Bound the `X-Forwarded-For` scan's allocation to the hop cap: the
recover after startup had already reported success (#140) reverse walk cuts entries with `strings.LastIndexByte` instead of joining and
- 2026-08-12 Bound the `X-Forwarded-For` scan's allocation to the hop splitting, so a 1 MB header allocates 16 bytes rather than 1.6 MB per request
cap: the reverse walk cuts entries with `strings.LastIndexByte` on the unauthenticated receiver. Semantics proven unchanged by differential
instead of joining and splitting, so a 1 MB header allocates 16 bytes testing against the previous implementation (#133)
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 - 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 attacker-supplied chain cannot burn unbounded CPU in the rate-limit key
key function; running off the end falls back to the peer address function; running off the end falls back to the peer address (#124)
(#124) - 2026-08-12 Gate forwarded-header trust behind a `TRUSTED_PROXIES` CIDR list:
- 2026-08-12 Gate forwarded-header trust behind a `TRUSTED_PROXIES` CIDR all three rate limiters key on the connection's own address unless the direct
list: all three rate limiters key on the connection's own address peer is a configured proxy, in which case `X-Forwarded-For` is walked right to
unless the direct peer is a configured proxy, in which case left for the first non-proxy hop. Default trusts nothing, and a
`X-Forwarded-For` is walked right to left for the first non-proxy hop. set-but-unparseable value aborts startup. Before this, any client could mint a
Default trusts nothing, and a set-but-unparseable value aborts fresh bucket or drain another's by rotating a spoofed header (#88)
startup. Before this, any client could mint a fresh bucket or drain - 2026-08-11 Web UI cleanup: nav terminology unified on Webhooks, the Profile
another's by rotating a spoofed header (#88) settings placeholder removed, a progressive-enhancement copy button for the
- 2026-08-11 Web UI cleanup: nav terminology unified on Webhooks, the entrypoint URL, and retention form copy that states the actual policy
Profile settings placeholder removed, a progressive-enhancement copy (deletion by the reaper, 0 retains forever) (#57)
button for the entrypoint URL, and retention form copy that states the - 2026-08-11 Mask the webhook credential in delivery errors and logs: Go embeds
actual policy (deletion by the reaper, 0 retains forever) (#57) the request URL in `*url.Error`, so every transport failure persisted the full
- 2026-08-11 Mask the webhook credential in delivery errors and logs: Slack webhook URL into the per-webhook event database via
Go embeds the request URL in `*url.Error`, so every transport failure `DeliveryResult.Error`, a field a future REST API would have served.
persisted the full Slack webhook URL into the per-webhook event `maskURLError` drops path, query and userinfo while preserving the wrapped
database via `DeliveryResult.Error`, a field a future REST API would cause, so `errors.Is`/`As` and `Timeout()` still work and DNS, TLS and timeout
have served. `maskURLError` drops path, query and userinfo while failures still read differently (#118)
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 - 2026-08-11 Rate-limit the public webhook receiver endpoint
(`RECEIVER_RATE_LIMIT`, default 120/min), keyed on client IP plus (`RECEIVER_RATE_LIMIT`, default 120/min), keyed on client IP plus entrypoint
entrypoint path so one entrypoint cannot exhaust another's budget; path so one entrypoint cannot exhaust another's budget; over-limit requests
over-limit requests get 429 with `Retry-After`. It was the one get 429 with `Retry-After`. It was the one unauthenticated, internet-facing
unauthenticated, internet-facing endpoint with no limit at all (#64) endpoint with no limit at all (#64)
- 2026-08-11 Enforce the body size limit before CSRF parses the form: - 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 `MaxBodySize` is now first in all four form-parsing route groups, so an
an oversized request is rejected with 413 instead of being read in oversized request is rejected with 413 instead of being read in full by the
full by the CSRF middleware before any cap applied (#90) CSRF middleware before any cap applied (#90)
- 2026-08-11 Mask target config on the source detail page, which - 2026-08-11 Mask target config on the source detail page, which rendered the
rendered the stored blob verbatim and so exposed the Slack stored blob verbatim and so exposed the Slack incoming-webhook URL — a bearer
incoming-webhook URL — a bearer credential that cannot be revoked credential that cannot be revoked per-holder. Config reaches the template only
per-holder. Config reaches the template only as a `TargetView` of as a `TargetView` of labelled fields, and header values are rendered as a
labelled fields, and header values are rendered as a count (#113) count (#113)
- 2026-08-11 Allow `retention_days` of 0 to mean retain forever, via a - 2026-08-11 Allow `retention_days` of 0 to mean retain forever, via a sentinel
sentinel written in `BeforeSave` so the GORM column default cannot written in `BeforeSave` so the GORM column default cannot win the race. Also
win the race. Also bounds the reaper's cutoff arithmetic: day counts bounds the reaper's cutoff arithmetic: day counts above 106751 overflowed
above 106751 overflowed `time.Duration` and wrapped the cutoff into `time.Duration` and wrapped the cutoff into the future, where every row
the future, where every row matched and the sweep deleted everything matched and the sweep deleted everything (#79)
(#79)
- 2026-08-09 Inactivity-based session timeout: sliding idle expiry - 2026-08-09 Inactivity-based session timeout: sliding idle expiry
(`SESSION_IDLE_TIMEOUT`, default `24h`) refreshed on authenticated (`SESSION_IDLE_TIMEOUT`, default `24h`) refreshed on authenticated requests,
requests, with the 7-day absolute cap kept as an independent with the 7-day absolute cap kept as an independent backstop that activity
backstop that activity never extends (#66) never extends (#66)
- 2026-08-09 Restart recovery and the 60s retry sweep terminally fail an - 2026-08-09 Restart recovery and the 60s retry sweep terminally fail an
orphaned `retrying` delivery whose target type no longer supports orphaned `retrying` delivery whose target type no longer supports retries,
retries, recording a `DeliveryResult` with the reason instead of recording a `DeliveryResult` with the reason instead of leaving the delivery
leaving the delivery stuck forever (#82) stuck forever (#82)
- 2026-08-09 Root the delivery engine's worker pool and the retention - 2026-08-09 Root the delivery engine's worker pool and the retention reaper's
reaper's sweep loop at `context.Background()` rather than the fx sweep loop at `context.Background()` rather than the fx `OnStart` hook context
`OnStart` hook context (#97), which carries fx's 15s start timeout and (#97), which carries fx's 15s start timeout and killed both roughly fifteen
killed both roughly fifteen seconds after boot: the proxy silently seconds after boot: the proxy silently stopped delivering webhooks entirely,
stopped delivering webhooks entirely, and the reaper never ran a and the reaper never ran a single sweep under its default one-hour interval
single sweep under its default one-hour interval - 2026-08-09 Archive writer lifecycle (#89): deleting a webhook (or its last
- 2026-08-09 Archive writer lifecycle (#89): deleting a webhook (or its `database` target) evicts the cached archive writer and closes its handle
last `database` target) evicts the cached archive writer and closes while deliberately leaving `archive-{webhookID}.db` on disk, and a new
its handle while deliberately leaving `archive-{webhookID}.db` on `ArchiveSweeper` prunes idle archives on the existing
disk, and a new `ArchiveSweeper` prunes idle archives on the existing
`RETENTION_SWEEP_INTERVAL` without ever creating an archive file `RETENTION_SWEEP_INTERVAL` without ever creating an archive file
- 2026-08-09 Configuration parsing fails loudly on set-but-unparseable - 2026-08-09 Configuration parsing fails loudly on set-but-unparseable
environment values: `envInt` removed in favour of `envPositiveInt` environment values: `envInt` removed in favour of `envPositiveInt` plus a
plus a `PORT` range check, `envBool` now parses with `PORT` range check, `envBool` now parses with `strconv.ParseBool`, and
`strconv.ParseBool`, and defaults apply only to unset variables (#80) defaults apply only to unset variables (#80)
- 2026-08-07 Automatic event retention cleanup based on - 2026-08-07 Automatic event retention cleanup based on `retention_days`,
`retention_days`, deleting expired events, deliveries, and delivery deleting expired events, deliveries, and delivery results from each
results from each per-webhook event database (#63) per-webhook event database (#63)
- 2026-08-07 Update golangci-lint to v2.12.2 (Docker image digest in - 2026-08-07 Update golangci-lint to v2.12.2 (Docker image digest in
`Dockerfile`, release-archive sha256 pins in `script/bootstrap`), `Dockerfile`, release-archive sha256 pins in `script/bootstrap`), adopt the
adopt the canonical `.golangci.yml` (v2 `linters.settings` layout so canonical `.golangci.yml` (v2 `linters.settings` layout so
`lll`/`funlen`/`cyclop`/`dupl` thresholds actually apply), and fix `lll`/`funlen`/`cyclop`/`dupl` thresholds actually apply), and fix all newly
all newly surfaced lint findings 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
Makefile shims, README Entrypoints section 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)
- 2026-03-18 CSRF middleware detects TLS per-request, fixing login over - 2026-03-18 CSRF middleware detects TLS per-request, fixing login over plain
plain HTTP and behind reverse proxies (#54) HTTP and behind reverse proxies (#54)
- 2026-03-17 root path redirects based on auth state (#52) - 2026-03-17 root path redirects based on auth state (#52)
- 2026-03-17 CSRF protection, SSRF prevention for HTTP delivery targets - 2026-03-17 CSRF protection, SSRF prevention for HTTP delivery targets with DNS
with DNS rebinding defense, and per-IP login rate limiting (#42) rebinding defense, and per-IP login rate limiting (#42)
- 2026-03-17 Slack target type for incoming webhook notifications (#47) - 2026-03-17 Slack target type for incoming webhook notifications (#47)
- 2026-03-17 Dockerfile absolute paths and static linking (#49); - 2026-03-17 Dockerfile absolute paths and static linking (#49); absolute dev
absolute dev DATA_DIR default and clarified env docs (#46) DATA_DIR default and clarified env docs (#46)
- 2026-03-05 security headers middleware, session regeneration on - 2026-03-05 security headers middleware, session regeneration on login, request
login, request body size limits (#41) body size limits (#41)
- 2026-03-04 tests for delivery, middleware, and session packages - 2026-03-04 tests for delivery, middleware, and session packages (#32); removed
(#32); removed the build-architecture global (#31) the build-architecture global (#31)
- 2026-03-04 1.0 MVP merge: Webhook/Entrypoint/Target rename, core - 2026-03-04 1.0 MVP merge: Webhook/Entrypoint/Target rename, core delivery
delivery engine with bounded worker pool and circuit breaker, engine with bounded worker pool and circuit breaker, parallel fan-out,
parallel fan-out, per-webhook event databases, management UI (#16) per-webhook event databases, management UI (#16)
- 2026-03-01 repo brought to REPO_POLICIES standards; TODO.md folded - 2026-03-01 repo brought to REPO_POLICIES standards; TODO.md folded into README
into README (#6) (#6)
# Future Steps # Future Steps
- Delivery status and retry management UI. Replay of a terminally - Delivery status and retry management UI. Replay of a terminally failed
failed delivery and per-attempt detail already landed delivery and per-attempt detail already landed
(https://git.eeqj.de/sneak/webhooker/issues/203, (https://git.eeqj.de/sneak/webhooker/issues/203,
https://git.eeqj.de/sneak/webhooker/issues/202) https://git.eeqj.de/sneak/webhooker/issues/202)
- Per-webhook rate limiting in the receiver handler (per-webhook config - Per-webhook rate limiting in the receiver handler (per-webhook config plus
plus handler enforcement; global limits must not apply to receiver handler enforcement; global limits must not apply to receiver endpoints)
endpoints) - API key authentication for programmatic access (APIKey model exists; Bearer
- API key authentication for programmatic access (APIKey model exists; token middleware does not)
Bearer token middleware does not)
- REST API v1 - REST API v1
- CRUD for webhooks, entrypoints, targets - CRUD for webhooks, entrypoints, targets
- event viewing and filtering endpoints - event viewing and filtering endpoints
@@ -406,9 +370,9 @@ point of the branch.
- OpenAPI specification - OpenAPI specification
- Analytics dashboard: success rates, response times, volume - Analytics dashboard: success rates, response times, volume
- A remember-me option at login - A remember-me option at login
- Password reset flow for a forgotten password over the web. The - Password reset flow for a forgotten password over the web. The authenticated
authenticated password *change* flow already landed, and a lost password _change_ flow already landed, and a lost password is recoverable from
password is recoverable from the console with `webhooker resetpw` the console with `webhooker resetpw`
(https://git.eeqj.de/sneak/webhooker/issues/208) (https://git.eeqj.de/sneak/webhooker/issues/208)
- Later, nice to have - Later, nice to have
- email delivery target type - email delivery target type
go.mod
+1 -1
View File
@@ -22,7 +22,6 @@ require (
github.com/stretchr/testify v1.11.1 github.com/stretchr/testify v1.11.1
go.uber.org/fx v1.24.0 go.uber.org/fx v1.24.0
golang.org/x/crypto v0.38.0 golang.org/x/crypto v0.38.0
gopkg.in/yaml.v3 v3.0.1
gorm.io/driver/sqlite v1.5.4 gorm.io/driver/sqlite v1.5.4
gorm.io/gorm v1.25.5 gorm.io/gorm v1.25.5
modernc.org/sqlite v1.28.0 modernc.org/sqlite v1.28.0
@@ -59,6 +58,7 @@ require (
golang.org/x/text v0.25.0 // indirect golang.org/x/text v0.25.0 // indirect
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
google.golang.org/protobuf v1.31.0 // indirect google.golang.org/protobuf v1.31.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
lukechampine.com/uint128 v1.2.0 // indirect lukechampine.com/uint128 v1.2.0 // indirect
modernc.org/cc/v3 v3.40.0 // indirect modernc.org/cc/v3 v3.40.0 // indirect
modernc.org/ccgo/v3 v3.16.13 // indirect modernc.org/ccgo/v3 v3.16.13 // indirect
internal/ciscript/ci_mark_superseded_test.go
-387
View File
@@ -1,387 +0,0 @@
package ciscript_test
import (
"maps"
"os"
"os/exec"
"path/filepath"
"slices"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
)
const (
// supersededDesc is the description script/ci-mark-superseded
// writes, and the one an earlier revision of it wrote alongside a
// `skipped` state.
supersededDesc = "Superseded by a newer commit; never tested"
// liveContext is the commit-status context Gitea uses for this
// repository's runs, as seen in its API. The script derives it from
// the workflow and job names rather than hardcoding it; the
// derivation is checked against this value below.
liveContext = "check / check (push)"
scriptPath = "../../script/ci-mark-superseded"
workflow = "../../.gitea/workflows/check.yml"
// failure is the only state that neither folds into a combined
// `success` (as `skipped` does) nor blocks the commit forever (as
// `pending` does).
failure = "failure"
)
// repo is a throwaway git history: parent is the commit a run would be
// cancelled on, head the commit that superseded it.
type repo struct {
dir string
head string
parent string
}
// scriptEnv is the run identity the Gitea runner exports and the script
// builds its context string from.
type scriptEnv struct {
workflow string
job string
event string
}
func defaultEnv() scriptEnv {
return scriptEnv{workflow: "check", job: "check", event: "push"}
}
func cancelled() commitStatus {
return commitStatus{
Context: liveContext,
Status: failure,
Description: "Has been cancelled",
}
}
func running() commitStatus {
return commitStatus{
Context: liveContext,
Status: "pending",
Description: "Has started running",
}
}
func TestMarkSuperseded(t *testing.T) {
t.Parallel()
cases := map[string]struct {
parent commitStatus
wantMark bool
}{
"a cancelled run is marked": {
parent: cancelled(),
wantMark: true,
},
"a laundered skipped status is marked": {
parent: commitStatus{
Context: liveContext,
Status: "skipped",
Description: supersededDesc,
},
wantMark: true,
},
"a genuine failure is left alone": {
parent: commitStatus{
Context: liveContext,
Status: failure,
Description: "Failing after 3m1s",
},
wantMark: false,
},
"a passing run is left alone": {
parent: commitStatus{
Context: liveContext,
Status: "success",
Description: "Successful in 2m52s",
},
wantMark: false,
},
"another context is left alone": {
parent: commitStatus{
Context: "other / other (push)",
Status: failure,
Description: "Has been cancelled",
},
wantMark: false,
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
t.Parallel()
requireTools(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, tc.parent)
out, err := runScript(t, history, api, defaultEnv())
require.NoError(t, err, out)
posted := fake.postedFor(history.parent)
if !tc.wantMark {
require.Empty(t, posted)
return
}
require.Equal(t, []postedStatus{{
Context: liveContext,
// Not `skipped`: Gitea's combined status folds
// that into `success`, which is what made a
// never-tested commit read green.
State: failure,
Description: supersededDesc,
}}, posted)
})
}
}
// A second run must not rewrite what the first one wrote, or every
// later push would post a duplicate status.
func TestMarkSupersededIsIdempotent(t *testing.T) {
t.Parallel()
requireTools(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
for range 2 {
out, err := runScript(t, history, api, defaultEnv())
require.NoError(t, err, out)
}
require.Len(t, fake.postedFor(history.parent), 1)
}
// Renaming the workflow or the job changes the context string Gitea
// uses. The script must say so instead of quietly matching nothing.
func TestMarkSupersededRejectsAnUnknownContext(t *testing.T) {
t.Parallel()
requireTools(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
env := defaultEnv()
env.job = "renamed"
out, err := runScript(t, history, api, env)
require.Error(t, err)
require.Contains(t, out, "renamed")
require.Contains(t, out, liveContext)
require.Empty(t, fake.postedFor(history.parent))
}
// ANCESTOR_LIMIT is a documented knob. A value that is set but unusable
// must abort: handing it to git and discarding the exit status left the
// walk empty and the step green, marking nothing.
func TestMarkSupersededRejectsAnUnparseableAncestorLimit(t *testing.T) {
t.Parallel()
requireTools(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
out, err := runScript(
t, history, api, defaultEnv(), "ANCESTOR_LIMIT=twenty",
)
require.Error(t, err)
require.Contains(t, out, "ANCESTOR_LIMIT")
require.Contains(t, out, "twenty")
require.Empty(t, fake.postedFor(history.parent))
}
// A status read that fails is not the same as a commit with nothing to
// do. Losing curl's exit status through a pipe made the two identical
// and left a laundered commit laundered with no signal.
func TestMarkSupersededFailsOnAnUnreadableAncestorStatus(t *testing.T) {
t.Parallel()
requireTools(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
fake.failStatusRead(history.parent)
out, err := runScript(t, history, api, defaultEnv())
require.Error(t, err)
require.Contains(t, out, history.parent)
require.Contains(t, out, "cannot read commit statuses")
require.Empty(t, fake.postedFor(history.parent))
}
// A shallow clone cannot resolve the parent, so it is indistinguishable
// from a root commit to rev-parse and the walk would exit 0 having
// marked nothing. It must abort instead: dropping `fetch-depth: 0` from
// the checkout step is one edit, and a silent no-op there restores the
// false-green bug this script exists to prevent.
func TestMarkSupersededRejectsAShallowRepository(t *testing.T) {
t.Parallel()
requireTools(t)
history := shallowClone(t, newRepo(t))
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
out, err := runScript(t, history, api, defaultEnv())
require.Error(t, err)
require.Contains(t, out, "shallow repository")
require.Empty(t, fake.postedFor(history.parent))
require.Empty(t, fake.postedFor(history.head))
}
// shallowClone returns the same history as a depth-1 clone. The `file://`
// URL is required: git ignores --depth for a plain local path.
func shallowClone(t *testing.T, history repo) repo {
t.Helper()
dir := t.TempDir()
//nolint:gosec // fixed argv, arguments are test-local paths
cmd := exec.CommandContext(t.Context(), "git", "clone", "-q",
"--depth=1", "file://"+history.dir, dir)
out, err := cmd.CombinedOutput()
require.NoError(t, err, string(out))
return repo{dir: dir, head: history.head, parent: history.parent}
}
// The derived context must equal the one Gitea actually uses, which is
// built from the same workflow and job names.
func TestDerivedContextMatchesGitea(t *testing.T) {
t.Parallel()
requireTools(t)
name, job := workflowIdentity(t)
history := newRepo(t)
fake, api := newFakeGitea(t)
fake.setStatus(history.head, running())
fake.setStatus(history.parent, cancelled())
out, err := runScript(t, history, api, scriptEnv{
workflow: name,
job: job,
event: "push",
})
require.NoError(t, err, out)
posted := fake.postedFor(history.parent)
require.Len(t, posted, 1)
require.Equal(t, liveContext, posted[0].Context)
}
// workflowIdentity reads the workflow name and its single job id out of
// the checked-in workflow file.
func workflowIdentity(t *testing.T) (string, string) {
t.Helper()
raw, err := os.ReadFile(workflow)
require.NoError(t, err)
var parsed struct {
Name string `yaml:"name"`
Jobs map[string]any `yaml:"jobs"`
}
require.NoError(t, yaml.Unmarshal(raw, &parsed))
jobs := slices.Collect(maps.Keys(parsed.Jobs))
require.Len(t, jobs, 1)
return parsed.Name, jobs[0]
}
func runScript(
t *testing.T, history repo, api string, env scriptEnv,
extra ...string,
) (string, error) {
t.Helper()
script, err := filepath.Abs(scriptPath)
require.NoError(t, err)
//nolint:gosec // fixed argv, repo-local script under test
cmd := exec.CommandContext(t.Context(), "sh", script)
cmd.Dir = history.dir
cmd.Env = append(os.Environ(),
"GITHUB_API_URL="+api,
"GITHUB_REPOSITORY=sneak/webhooker",
"GITHUB_SHA="+history.head,
"GITHUB_WORKFLOW="+env.workflow,
"GITHUB_JOB="+env.job,
"GITHUB_EVENT_NAME="+env.event,
"GITEA_TOKEN=test-token",
)
cmd.Env = append(cmd.Env, extra...)
out, err := cmd.CombinedOutput()
return string(out), err
}
func newRepo(t *testing.T) repo {
t.Helper()
dir := t.TempDir()
git := func(args ...string) string {
//nolint:gosec // fixed argv, arguments are test constants
cmd := exec.CommandContext(t.Context(), "git", args...)
cmd.Dir = dir
out, err := cmd.CombinedOutput()
require.NoError(t, err, string(out))
return strings.TrimSpace(string(out))
}
commit := func(message string) string {
git(
"-c", "user.email=ci@example.invalid",
"-c", "user.name=ci",
"-c", "commit.gpgsign=false",
"commit", "-q", "--allow-empty", "-m", message,
)
return git("rev-parse", "HEAD")
}
git("init", "-q", "-b", "main")
parent := commit("parent")
head := commit("head")
return repo{dir: dir, head: head, parent: parent}
}
func requireTools(t *testing.T) {
t.Helper()
for _, tool := range []string{"sh", "git", "curl", "jq"} {
_, err := exec.LookPath(tool)
if err != nil {
t.Skipf("%s is not installed: %v", tool, err)
}
}
}
internal/ciscript/doc.go
-10
View File
@@ -1,10 +0,0 @@
// Package ciscript holds the tests for the repository's CI shell
// scripts in script/. It carries no runtime code: the scripts run on
// the CI runner, not inside the binary, but their behaviour still has
// to be verified by the test suite.
//
// The scripts under test are outside the Go build graph, so `go test`'s
// result cache serves a stale PASS when only a script changed: run the
// container build, or GOFLAGS=-count=1, to trust a result here after
// editing script/.
package ciscript
internal/ciscript/fakegitea_test.go
-162
View File
@@ -1,162 +0,0 @@
package ciscript_test
import (
"encoding/json"
"net/http"
"net/http/httptest"
"sync"
"testing"
)
// commitStatus is the part of an entry in Gitea's combined-status
// response that script/ci-mark-superseded reads.
type commitStatus struct {
Context string `json:"context"`
Status string `json:"status"`
Description string `json:"description"`
}
// postedStatus is the part of a create-status request body the script
// writes.
type postedStatus struct {
Context string `json:"context"`
State string `json:"state"`
Description string `json:"description"`
}
// fakeGitea serves the two endpoints the script talks to. Like Gitea,
// the newest status for a context replaces the previous one, so a
// second run of the script sees what the first one wrote.
type fakeGitea struct {
mu sync.Mutex
statuses map[string][]commitStatus
posted map[string][]postedStatus
// failRead is a commit whose combined-status read answers HTTP
// 500, standing in for a status API that is down.
failRead string
}
// newFakeGitea returns the fake and the base URL to hand the script as
// GITHUB_API_URL.
func newFakeGitea(t *testing.T) (*fakeGitea, string) {
t.Helper()
fake := &fakeGitea{
mu: sync.Mutex{},
statuses: map[string][]commitStatus{},
posted: map[string][]postedStatus{},
failRead: "",
}
srv := httptest.NewServer(fake.routes())
t.Cleanup(srv.Close)
return fake, srv.URL
}
func (f *fakeGitea) routes() http.Handler {
mux := http.NewServeMux()
mux.HandleFunc(
"GET /repos/{owner}/{repo}/commits/{sha}/status",
f.handleCombined,
)
mux.HandleFunc(
"POST /repos/{owner}/{repo}/statuses/{sha}",
f.handleCreate,
)
return mux
}
func (f *fakeGitea) handleCombined(
w http.ResponseWriter, r *http.Request,
) {
f.mu.Lock()
defer f.mu.Unlock()
sha := r.PathValue("sha")
if f.failRead != "" && f.failRead == sha {
http.Error(w, "boom", http.StatusInternalServerError)
return
}
body := struct {
Statuses []commitStatus `json:"statuses"`
}{Statuses: f.statuses[sha]}
payload, err := json.Marshal(body)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write(payload)
}
func (f *fakeGitea) handleCreate(w http.ResponseWriter, r *http.Request) {
var got postedStatus
err := json.NewDecoder(r.Body).Decode(&got)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
sha := r.PathValue("sha")
f.mu.Lock()
defer f.mu.Unlock()
f.posted[sha] = append(f.posted[sha], got)
f.replaceLocked(sha, commitStatus{
Context: got.Context,
Status: got.State,
Description: got.Description,
})
w.WriteHeader(http.StatusCreated)
}
// failStatusRead makes the combined-status read for one commit answer
// HTTP 500.
func (f *fakeGitea) failStatusRead(sha string) {
f.mu.Lock()
defer f.mu.Unlock()
f.failRead = sha
}
// setStatus gives a commit its latest status for a context.
func (f *fakeGitea) setStatus(sha string, status commitStatus) {
f.mu.Lock()
defer f.mu.Unlock()
f.replaceLocked(sha, status)
}
// postedFor returns the statuses the script created for a commit.
func (f *fakeGitea) postedFor(sha string) []postedStatus {
f.mu.Lock()
defer f.mu.Unlock()
return append([]postedStatus(nil), f.posted[sha]...)
}
// replaceLocked requires f.mu.
func (f *fakeGitea) replaceLocked(sha string, status commitStatus) {
for i, existing := range f.statuses[sha] {
if existing.Context == status.Context {
f.statuses[sha][i] = status
return
}
}
f.statuses[sha] = append(f.statuses[sha], status)
}
internal/database/model_event.go
+3 -1
View File
@@ -30,8 +30,10 @@ type Event struct {
WebhookID string `gorm:"type:uuid;not null" json:"webhookId"` WebhookID string `gorm:"type:uuid;not null" json:"webhookId"`
EntrypointID string `gorm:"type:uuid;not null;index:idx_events_entrypoint_id,priority:1" json:"entrypointId"` EntrypointID string `gorm:"type:uuid;not null;index:idx_events_entrypoint_id,priority:1" json:"entrypointId"`
// Request data // Request data. RawQuery is the receiving request's query string
// as sent, without the leading "?".
Method string `gorm:"not null" json:"method"` Method string `gorm:"not null" json:"method"`
RawQuery string `gorm:"type:text" json:"rawQuery"`
Headers string `gorm:"type:text" json:"headers"` // JSON Headers string `gorm:"type:text" json:"headers"` // JSON
Body string `gorm:"type:text" json:"body"` Body string `gorm:"type:text" json:"body"`
ContentType string `json:"contentType"` ContentType string `json:"contentType"`
internal/delivery/engine.go
+3
View File
@@ -110,6 +110,7 @@ type Task struct {
MaxRetries int MaxRetries int
Method string Method string
RawQuery string
Headers string Headers string
ContentType string ContentType string
Body *string Body *string
@@ -1752,6 +1753,7 @@ func buildEventFromTask(task *Task) database.Event {
event := database.Event{ event := database.Event{
EntrypointID: task.EntrypointID, EntrypointID: task.EntrypointID,
Method: task.Method, Method: task.Method,
RawQuery: task.RawQuery,
Headers: task.Headers, Headers: task.Headers,
ContentType: task.ContentType, ContentType: task.ContentType,
} }
@@ -2102,6 +2104,7 @@ func buildRecoveryTask(
TargetConfig: target.Config, TargetConfig: target.Config,
MaxRetries: target.MaxRetries, MaxRetries: target.MaxRetries,
Method: event.Method, Method: event.Method,
RawQuery: event.RawQuery,
Headers: event.Headers, Headers: event.Headers,
ContentType: event.ContentType, ContentType: event.ContentType,
Body: bodyPtr, Body: bodyPtr,
internal/delivery/engine_integration_test.go
+7
View File
@@ -673,6 +673,11 @@ func TestRecoverPendingDeliveries(t *testing.T) {
t, s.WebhookDB, s.WebhookID, targetID, 3, t, s.WebhookDB, s.WebhookID, targetID, 3,
) )
// A recovered delivery still carries its event's query string.
require.NoError(t, s.WebhookDB.Model(&database.Event{}).
Where("webhook_id = ?", s.WebhookID).
Update("raw_query", eventQuery).Error)
s.Engine.ExportRecoverPendingDeliveries( s.Engine.ExportRecoverPendingDeliveries(
context.Background(), s.WebhookDB, context.Background(), s.WebhookDB,
s.WebhookID, s.WebhookID,
@@ -687,6 +692,8 @@ func TestRecoverPendingDeliveries(t *testing.T) {
database.TargetTypeLog, database.TargetTypeLog,
task.TargetType, task.TargetType,
) )
assert.Equal(t, eventQuery, task.RawQuery)
case <-time.After(2 * time.Second): case <-time.After(2 * time.Second):
t.Fatalf("expected task %d", i) t.Fatalf("expected task %d", i)
} }
internal/delivery/engine_test.go
+6
View File
@@ -11,6 +11,7 @@ import (
"net/http/httptest" "net/http/httptest"
"os" "os"
"path/filepath" "path/filepath"
"strconv"
"strings" "strings"
"sync" "sync"
"sync/atomic" "sync/atomic"
@@ -1990,6 +1991,10 @@ func assertLogLineComplete(
"log line must contain the full request headers", "log line must contain the full request headers",
) )
assert.Contains(t, out, "raw_query="+strconv.Quote(event.RawQuery),
"log line must contain the query string",
)
assert.Contains(t, out, event.EntrypointID, assert.Contains(t, out, event.EntrypointID,
"log line must contain the entrypoint id", "log line must contain the entrypoint id",
) )
@@ -2012,6 +2017,7 @@ func TestDeliverLog_LogsFullContent(t *testing.T) {
event := seedEvent( event := seedEvent(
t, db, `{"log-body-marker":"abc123"}`, t, db, `{"log-body-marker":"abc123"}`,
) )
event.RawQuery = eventQuery
dlv := seedDelivery( dlv := seedDelivery(
t, db, event.ID, uuid.New().String(), t, db, event.ID, uuid.New().String(),
internal/delivery/inflight_test.go
+4 -3
View File
@@ -48,8 +48,9 @@ func fSweepSetup(
// //
// Every caller drives the dispatch paths synchronously and has already // Every caller drives the dispatch paths synchronously and has already
// waited for them to return, so anything they queued is in the channel // waited for them to return, so anything they queued is in the channel
// by now. The short grace covers nothing but scheduler jitter, and is // by now, and nothing is waited for. A timer here would race the queued
// kept small because one of these tests runs the drain forty times. // tasks: on a busy host it can be due by the time select looks, and
// select picks at random among the cases that are ready.
func fDrain(e *delivery.Engine) []delivery.Task { func fDrain(e *delivery.Engine) []delivery.Task {
var out []delivery.Task var out []delivery.Task
@@ -59,7 +60,7 @@ func fDrain(e *delivery.Engine) []delivery.Task {
out = append(out, task) out = append(out, task)
case task := <-e.ExportRetryCh(): case task := <-e.ExportRetryCh():
out = append(out, task) out = append(out, task)
case <-time.After(25 * time.Millisecond): default:
return out return out
} }
} }
internal/delivery/target_config_edit.go
+7 -3
View File
@@ -39,6 +39,9 @@ type TargetConfigForm struct {
// Timeout is the HTTP target's per-request timeout in seconds, // Timeout is the HTTP target's per-request timeout in seconds,
// empty when unset. // empty when unset.
Timeout string Timeout string
// ForwardQuery is the HTTP target's setting that passes each
// event's query string on to it.
ForwardQuery bool
// Expiry is the database (archive) target's row expiry. // Expiry is the database (archive) target's row expiry.
Expiry string Expiry string
// Rotation is the database (archive) target's rotation. // Rotation is the database (archive) target's rotation.
@@ -64,9 +67,10 @@ func NewTargetConfigForm(
} }
return TargetConfigForm{ return TargetConfigForm{
URL: cfg.URL, URL: cfg.URL,
Headers: FormatTargetHeaders(cfg.Headers), Headers: FormatTargetHeaders(cfg.Headers),
Timeout: FormatTargetTimeout(cfg.Timeout), Timeout: FormatTargetTimeout(cfg.Timeout),
ForwardQuery: cfg.ForwardQuery,
}, nil }, nil
case database.TargetTypeSlack: case database.TargetTypeSlack:
cfg, err := parseSlackConfig(t.Config) cfg, err := parseSlackConfig(t.Config)
internal/delivery/target_config_view.go
+7
View File
@@ -171,6 +171,13 @@ func httpConfigFields(t *database.Target) []ConfigField {
}) })
} }
if cfg.ForwardQuery {
fields = append(fields, ConfigField{
Label: "Query string",
Value: "passed on to this target",
})
}
fields = append(fields, maxRetriesField(t)) fields = append(fields, maxRetriesField(t))
return fields return fields
internal/delivery/target_config_view_test.go
+3 -1
View File
@@ -223,7 +223,8 @@ func TestNewTargetViews_HTTP(t *testing.T) {
Type: database.TargetTypeHTTP, Type: database.TargetTypeHTTP,
Config: `{"url":"` + viewExampleHook + `",` + Config: `{"url":"` + viewExampleHook + `",` +
`"timeout":30,` + `"timeout":30,` +
`"headers":{"Authorization":"Bearer sekrit"}}`, `"headers":{"Authorization":"Bearer sekrit"},` +
`"forwardQuery":true}`,
MaxRetries: 5, MaxRetries: 5,
}) })
@@ -235,6 +236,7 @@ func TestNewTargetViews_HTTP(t *testing.T) {
"Destination URL": viewMaskedOrigin, "Destination URL": viewMaskedOrigin,
"Timeout": "30s", "Timeout": "30s",
"Headers": "1 configured", "Headers": "1 configured",
"Query string": "passed on to this target",
viewMaxRetries: "5", viewMaxRetries: "5",
}, },
fields, fields,
internal/delivery/target_database.go
+1
View File
@@ -184,6 +184,7 @@ func (t *databaseTarget) archive(d *database.Delivery) error {
WebhookID: webhookID, WebhookID: webhookID,
EntrypointID: d.Event.EntrypointID, EntrypointID: d.Event.EntrypointID,
Method: d.Event.Method, Method: d.Event.Method,
RawQuery: d.Event.RawQuery,
Headers: d.Event.Headers, Headers: d.Event.Headers,
Body: d.Event.Body, Body: d.Event.Body,
ContentType: d.Event.ContentType, ContentType: d.Event.ContentType,
internal/delivery/target_database_archive.go
+1
View File
@@ -101,6 +101,7 @@ type archivedEvent struct {
WebhookID string WebhookID string
EntrypointID string EntrypointID string
Method string Method string
RawQuery string
Headers string Headers string
Body string Body string
ContentType string ContentType string
internal/delivery/target_database_export.go
+1
View File
@@ -360,6 +360,7 @@ func writeRow(w io.Writer, ev *archivedEvent, period string) error {
"webhook_id": ev.WebhookID, "webhook_id": ev.WebhookID,
"entrypoint_id": ev.EntrypointID, "entrypoint_id": ev.EntrypointID,
"method": ev.Method, "method": ev.Method,
"raw_query": ev.RawQuery,
"headers": ev.Headers, "headers": ev.Headers,
"body": ev.Body, "body": ev.Body,
"content_type": ev.ContentType, "content_type": ev.ContentType,
internal/delivery/target_database_export_test.go
+4 -2
View File
@@ -166,6 +166,7 @@ func TestArchiveExport_MatchesStoredRows(t *testing.T) {
WebhookID: exportWebhookID, WebhookID: exportWebhookID,
EntrypointID: "ep-1", EntrypointID: "ep-1",
Method: "POST", Method: "POST",
RawQuery: eventQuery,
Headers: `{"X-Test":["yes"]}`, Headers: `{"X-Test":["yes"]}`,
Body: body, Body: body,
ContentType: testContentType, ContentType: testContentType,
@@ -215,12 +216,13 @@ func assertExportedRow(
assert.Equal(t, row.WebhookID, ev["webhook_id"]) assert.Equal(t, row.WebhookID, ev["webhook_id"])
assert.Equal(t, row.EntrypointID, ev["entrypoint_id"]) assert.Equal(t, row.EntrypointID, ev["entrypoint_id"])
assert.Equal(t, row.Method, ev["method"]) assert.Equal(t, row.Method, ev["method"])
assert.Equal(t, row.RawQuery, ev["raw_query"])
assert.Equal(t, row.Headers, ev["headers"]) assert.Equal(t, row.Headers, ev["headers"])
assert.Equal(t, row.ContentType, ev["content_type"]) assert.Equal(t, row.ContentType, ev["content_type"])
if row.Body != binaryBody { if row.Body != binaryBody {
assert.Equal(t, row.Body, ev["body"]) assert.Equal(t, row.Body, ev["body"])
assert.Len(t, ev, 9, "the nine columns and nothing else: %v", ev) assert.Len(t, ev, 10, "the ten columns and nothing else: %v", ev)
return return
} }
@@ -229,7 +231,7 @@ func assertExportedRow(
require.NoError(t, err) require.NoError(t, err)
assert.Equal(t, binaryBody, string(body)) assert.Equal(t, binaryBody, string(body))
assert.Equal(t, "base64", ev["body_encoding"]) assert.Equal(t, "base64", ev["body_encoding"])
assert.Len(t, ev, 10, "the nine columns and body_encoding: %v", ev) assert.Len(t, ev, 11, "the ten columns and body_encoding: %v", ev)
} }
// TestArchiveExport_Empty proves an archive with nothing in it exports // TestArchiveExport_Empty proves an archive with nothing in it exports
internal/delivery/target_database_test.go
+2
View File
@@ -85,6 +85,7 @@ func TestDeliverDatabase_ArchivesEvent(t *testing.T) {
webhookDB := testWebhookDB(t) webhookDB := testWebhookDB(t)
event := seedEvent(t, webhookDB, `{"archived":true}`) event := seedEvent(t, webhookDB, `{"archived":true}`)
event.RawQuery = eventQuery
d := seedDatabaseTargetDelivery(t, webhookDB, event, tgt) d := seedDatabaseTargetDelivery(t, webhookDB, event, tgt)
env.eng.ExportDeliverDatabase(webhookDB, d) env.eng.ExportDeliverDatabase(webhookDB, d)
@@ -113,6 +114,7 @@ func TestDeliverDatabase_ArchivesEvent(t *testing.T) {
assert.Equal(t, event.ID, rows[0].EventID) assert.Equal(t, event.ID, rows[0].EventID)
assert.Equal(t, event.WebhookID, rows[0].WebhookID) assert.Equal(t, event.WebhookID, rows[0].WebhookID)
assert.Equal(t, event.Method, rows[0].Method) assert.Equal(t, event.Method, rows[0].Method)
assert.Equal(t, eventQuery, rows[0].RawQuery)
assert.JSONEq(t, `{"archived":true}`, rows[0].Body) assert.JSONEq(t, `{"archived":true}`, rows[0].Body)
} }
internal/delivery/target_http.go
+23
View File
@@ -8,6 +8,7 @@ import (
"fmt" "fmt"
"io" "io"
"net/http" "net/http"
"net/url"
"sort" "sort"
"sync" "sync"
"time" "time"
@@ -32,6 +33,11 @@ type HTTPTargetConfig struct {
URL string `json:"url"` URL string `json:"url"`
Headers map[string]string `json:"headers,omitempty"` Headers map[string]string `json:"headers,omitempty"`
Timeout int `json:"timeout,omitempty"` Timeout int `json:"timeout,omitempty"`
// ForwardQuery passes each event's query string on to the target,
// appended to URL. Off, the target URL is sent exactly as
// configured.
ForwardQuery bool `json:"forwardQuery,omitempty"`
} }
// httpCore holds the retry, backoff, and circuit-breaker // httpCore holds the retry, backoff, and circuit-breaker
@@ -444,6 +450,10 @@ func (t *httpTarget) doHTTPRequest(
) )
} }
if cfg.ForwardQuery {
appendQuery(req.URL, event.RawQuery)
}
originScoped := applyRequestHeaders( originScoped := applyRequestHeaders(
req, event, cfg, t.eng.userAgent(), req, event, cfg, t.eng.userAgent(),
) )
@@ -474,6 +484,19 @@ func (t *httpTarget) doHTTPRequest(
return resp.StatusCode, string(body), dur, nil return resp.StatusCode, string(body), dur, nil
} }
// appendQuery adds an event's query string to a delivery's URL, joined
// with "&" to any query string the target URL already has.
func appendQuery(u *url.URL, rawQuery string) {
switch {
case rawQuery == "":
return
case u.RawQuery == "":
u.RawQuery = rawQuery
default:
u.RawQuery += "&" + rawQuery
}
}
// clientForRequest returns the client for one delivery attempt. // clientForRequest returns the client for one delivery attempt.
// originScoped is the header set applyRequestHeaders built for that // originScoped is the header set applyRequestHeaders built for that
// attempt; a request with neither a per-target timeout nor an // attempt; a request with neither a per-target timeout nor an
internal/delivery/target_http_query_test.go
+172
View File
@@ -0,0 +1,172 @@
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"
"sneak.berlin/go/webhooker/internal/database"
"sneak.berlin/go/webhooker/internal/delivery"
)
// eventQuery is the query string the events in these tests arrived
// with.
const eventQuery = "a=1&b=2"
// httpTargetConfig is the stored configuration of an HTTP target at
// targetURL.
func httpTargetConfig(
t *testing.T, targetURL string, forwardQuery bool,
) string {
t.Helper()
cfg, err := json.Marshal(delivery.HTTPTargetConfig{
URL: targetURL, ForwardQuery: forwardQuery,
})
require.NoError(t, err)
return string(cfg)
}
// deliverWithQuery sends one event that arrived with eventQuery to an
// HTTP target configured with cfg, through the path a received event's
// delivery takes, and returns the attempt it recorded.
func deliverWithQuery(t *testing.T, cfg string) database.DeliveryResult {
t.Helper()
s := newISetup(t)
event := iSeedEvent(t, s.WebhookDB, s.WebhookID, "{}")
d := iSeedDelivery(
t, s.WebhookDB, event.ID, uuid.NewString(),
database.DeliveryStatusPending,
)
task := iTask(
d, event, s.WebhookID, d.TargetID, "query", cfg, 0, 1, &event.Body,
)
task.RawQuery = eventQuery
s.Engine.ExportProcessNewTask(context.TODO(), &task)
var result database.DeliveryResult
require.NoError(t, s.WebhookDB.Where(
"delivery_id = ?", d.ID,
).First(&result).Error)
return result
}
// TestDeliverHTTP_ForwardQuery proves the URL a delivery is sent to:
// with the target's setting off, the target URL exactly as configured;
// with it on, the event's query string appended, joined with "&" to a
// query string the target URL already has.
func TestDeliverHTTP_ForwardQuery(t *testing.T) {
t.Parallel()
// The target URL's path, without and with a query string of its
// own.
const (
plain = "/in"
withQuery = "/in?key=k"
)
tests := map[string]struct {
path string
forwardQuery bool
want string
}{
"off": {
path: plain, want: plain,
},
"off, the target URL has a query string": {
path: withQuery, want: withQuery,
},
"on": {
path: plain, forwardQuery: true, want: plain + "?" + eventQuery,
},
"on, the target URL has a query string": {
path: withQuery, forwardQuery: true,
want: withQuery + "&" + eventQuery,
},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
t.Parallel()
received := make(chan string, 1)
ts := httptest.NewServer(http.HandlerFunc(
func(w http.ResponseWriter, r *http.Request) {
received <- r.RequestURI
w.WriteHeader(http.StatusOK)
},
))
t.Cleanup(ts.Close)
result := deliverWithQuery(t, httpTargetConfig(
t, ts.URL+tc.path, tc.forwardQuery,
))
assert.True(t, result.Success)
require.Len(t, received, 1)
assert.Equal(t, tc.want, <-received)
})
}
}
// TestDeliverHTTP_ForwardedQueryKeepsTheTargetURLMasked proves the
// credential in a target URL's own query string stays masked once the
// event's query string is appended to it: in a response or error that
// echoes the URL the target was sent, as the event log's Redactor shows
// it, and in the error a failed connection stores.
func TestDeliverHTTP_ForwardedQueryKeepsTheTargetURLMasked(t *testing.T) {
t.Parallel()
const secret = "s3cr3t"
received := make(chan string, 1)
ts := httptest.NewServer(http.HandlerFunc(
func(w http.ResponseWriter, r *http.Request) {
received <- r.RequestURI
w.WriteHeader(http.StatusBadRequest)
},
))
t.Cleanup(ts.Close)
target := &database.Target{
Type: database.TargetTypeHTTP,
Config: httpTargetConfig(t, ts.URL+"/in?token="+secret, true),
}
deliverWithQuery(t, target.Config)
require.Len(t, received, 1)
sent := <-received
require.Equal(t, "/in?token="+secret+"&"+eventQuery, sent)
redactor := delivery.NewRedactor(target)
for _, echoed := range []string{sent, ts.URL + sent} {
shown := redactor.Redact("rejected " + echoed)
assert.NotContains(t, shown, secret, echoed)
assert.Contains(t, shown, delivery.RedactionMarker, echoed)
}
// Nothing listens on port 1.
failed := deliverWithQuery(t, httpTargetConfig(
t, "http://127.0.0.1:1/in?token="+secret, true,
))
require.NotEmpty(t, failed.Error)
assert.NotContains(t, failed.Error, secret)
assert.NotContains(t, failed.Error, eventQuery)
}
internal/delivery/target_log.go
+4 -3
View File
@@ -9,9 +9,9 @@ import (
) )
// logTarget is a fire-and-forget target that logs the entire // logTarget is a fire-and-forget target that logs the entire
// inbound webhook — the full request body and headers, plus // inbound webhook — the full request body, query string and
// the method, content type, and the webhook and entrypoint // headers, plus the method, content type, and the webhook and
// ids — then records a single successful attempt. // entrypoint ids — then records a single successful attempt.
// //
// This is the one log call in the service that deliberately writes // This is the one log call in the service that deliberately writes
// unbounded client-chosen bytes, so it is the one exception to the // unbounded client-chosen bytes, so it is the one exception to the
@@ -46,6 +46,7 @@ func (t *logTarget) Deliver(
"webhook_id", d.Event.WebhookID, "webhook_id", d.Event.WebhookID,
"entrypoint_id", d.Event.EntrypointID, "entrypoint_id", d.Event.EntrypointID,
"method", d.Event.Method, "method", d.Event.Method,
"raw_query", d.Event.RawQuery,
"content_type", d.Event.ContentType, "content_type", d.Event.ContentType,
"headers", d.Event.Headers, "headers", d.Event.Headers,
"body", d.Event.Body, "body", d.Event.Body,
internal/delivery/target_redact.go
+19 -16
View File
@@ -162,18 +162,22 @@ func targetSecrets(t *database.Target) []string {
} }
// urlSecrets returns the substrings of a destination URL that // urlSecrets returns the substrings of a destination URL that
// must not survive into a rendered page: the whole URL, the // must not survive into a rendered page: the whole URL; its
// parts of it MaskURL elides, and any userinfo. // path, unless that is empty or "/"; its query string, and the
// request URI that carries it, which a remote echoing the
// request line shows even when the URL has no path; and its
// userinfo and password.
// //
// No length floor is applied to the path, and none to the // No length floor is applied to the path, the query string or
// userinfo. A short path or a four-byte username is treated as // the userinfo. A short path or a four-byte username is
// a credential exactly like a long one, because the field takes // treated as a credential exactly like a long one, because the
// an arbitrary URL and no part of it can be assumed non-secret — // field takes an arbitrary URL and no part of it can be
// the same rule MaskURL applies. headerSecrets does carry a // assumed non-secret — the same rule MaskURL applies.
// floor, and the difference is deliberate: a header is picked // headerSecrets does carry a floor, and the difference is
// out by a name-shaped guess and its value may be ordinary // deliberate: a header is picked out by a name-shaped guess
// text, whereas a URL's path and userinfo are credential // and its value may be ordinary text, whereas a URL's path,
// material by position. // query string and userinfo are credential material by
// position.
func urlSecrets(raw string) []string { func urlSecrets(raw string) []string {
raw = strings.TrimSpace(raw) raw = strings.TrimSpace(raw)
if raw == "" { if raw == "" {
@@ -188,12 +192,11 @@ func urlSecrets(raw string) []string {
} }
if parsed.Path != "" && parsed.Path != "/" { if parsed.Path != "" && parsed.Path != "/" {
requestURI := parsed.RequestURI() secrets = append(secrets, parsed.EscapedPath())
secrets = append(secrets, requestURI) }
if escaped := parsed.EscapedPath(); escaped != requestURI { if parsed.RawQuery != "" {
secrets = append(secrets, escaped) secrets = append(secrets, parsed.RequestURI(), parsed.RawQuery)
}
} }
if parsed.User != nil { if parsed.User != nil {
internal/delivery/target_redact_test.go
+42
View File
@@ -202,6 +202,48 @@ func TestRedactor_RemovesHTTPURLQueryAndUserinfo(t *testing.T) {
} }
} }
// TestRedactor_RemovesEchoedQueryOfURLWithoutPath covers an
// HTTP target URL whose credential is all in its query string.
// Written with or without the "/", the request line sends it
// as "/?token=…", and a target passing the event's query string
// on sends that after an "&". The event's part stays visible:
// the event's page shows it anyway.
func TestRedactor_RemovesEchoedQueryOfURLWithoutPath(t *testing.T) {
t.Parallel()
const secret = "s3cr3t"
marker := delivery.RedactionMarker
// An echoed request line, and what the event log shows of it.
echoes := map[string]string{
"POST /?token=" + secret + " HTTP/1.1": "POST " + marker +
" HTTP/1.1",
"POST ?token=" + secret + " HTTP/1.1": "POST ?" + marker +
" HTTP/1.1",
"POST /?token=" + secret + "&a=1&b=2 HTTP/1.1": "POST " +
marker + "&a=1&b=2 HTTP/1.1",
"POST ?token=" + secret + "&a=1&b=2 HTTP/1.1": "POST ?" +
marker + "&a=1&b=2 HTTP/1.1",
}
for _, dest := range []string{
"https://example.com/?token=" + secret,
"https://example.com?token=" + secret,
} {
r := delivery.NewRedactor(&database.Target{
Type: database.TargetTypeHTTP,
Config: `{"url":"` + dest + `"}`,
})
for echoed, want := range echoes {
assert.Equal(
t, want, r.Redact(echoed), "%s: %s", dest, echoed,
)
}
}
}
// TestRedactor_LeavesUnrelatedTextAlone pins that the // TestRedactor_LeavesUnrelatedTextAlone pins that the
// redactor matches literally: it does not guess at what a // redactor matches literally: it does not guess at what a
// secret looks like, so ordinary response content survives. // secret looks like, so ordinary response content survives.
internal/handlers/delivery_replay.go
+1
View File
@@ -310,6 +310,7 @@ func createReplayDelivery(
TargetConfig: target.Config, TargetConfig: target.Config,
MaxRetries: target.MaxRetries, MaxRetries: target.MaxRetries,
Method: event.Method, Method: event.Method,
RawQuery: event.RawQuery,
Headers: event.Headers, Headers: event.Headers,
ContentType: event.ContentType, ContentType: event.ContentType,
Body: replayBody(event.Body), Body: replayBody(event.Body),
internal/handlers/delivery_replay_test.go
+8
View File
@@ -26,6 +26,9 @@ const paramDeliveryID = "deliveryID"
// dispatches to it: the notifier is recorded, not run. // dispatches to it: the notifier is recorded, not run.
const replayTargetURL = "http://93.184.216.34/hook" const replayTargetURL = "http://93.184.216.34/hook"
// replayEventQuery is the query string a seeded event arrived with.
const replayEventQuery = "a=1&b=2"
// seedFailedDelivery records an event, a terminally failed delivery of // seedFailedDelivery records an event, a terminally failed delivery of
// it to the given target, and the attempt that failed. // it to the given target, and the attempt that failed.
func seedFailedDelivery( func seedFailedDelivery(
@@ -42,6 +45,7 @@ func seedFailedDelivery(
WebhookID: webhookID, WebhookID: webhookID,
EntrypointID: "entrypoint-" + webhookID, EntrypointID: "entrypoint-" + webhookID,
Method: http.MethodPost, Method: http.MethodPost,
RawQuery: replayEventQuery,
Headers: `{"X-Test":["yes"]}`, Headers: `{"X-Test":["yes"]}`,
Body: `{"replay":"me"}`, Body: `{"replay":"me"}`,
ContentType: contentTypeJSON, ContentType: contentTypeJSON,
@@ -296,6 +300,10 @@ func assertReplayTask(
"replay must use the target's current configuration", "replay must use the target's current configuration",
) )
assert.Equal(t, event.Method, task.Method) assert.Equal(t, event.Method, task.Method)
assert.Equal(
t, replayEventQuery, task.RawQuery,
"replay re-sends the stored query string",
)
assert.Equal(t, event.Headers, task.Headers) assert.Equal(t, event.Headers, task.Headers)
assert.Equal(t, event.ContentType, task.ContentType) assert.Equal(t, event.ContentType, task.ContentType)
assert.Equal(t, 1, task.AttemptNum) assert.Equal(t, 1, task.AttemptNum)
internal/handlers/event_log.go
+2 -1
View File
@@ -324,7 +324,8 @@ func loadEventLogRows(
var rows []eventLogRow var rows []eventLogRow
err = eventsWithStatus(webhookDB, webhookID, statuses).Select( err = eventsWithStatus(webhookDB, webhookID, statuses).Select(
eventLogColumns, maxRenderedBodyBytes, maxRenderedBodyBytes, eventLogColumns,
maxRenderedBodyBytes, maxRenderedBodyBytes, maxRenderedBodyBytes,
).Order("created_at DESC").Limit(recentEventLimit).Find(&rows).Error ).Order("created_at DESC").Limit(recentEventLimit).Find(&rows).Error
return rows, totalEvents, err return rows, totalEvents, err
internal/handlers/event_log_view.go
+29 -7
View File
@@ -17,19 +17,23 @@ import (
// bytes rather than characters, so the cap bounds the page in // bytes rather than characters, so the cap bounds the page in
// bytes whatever the payload's encoding. Cutting in SQLite // bytes whatever the payload's encoding. Cutting in SQLite
// rather than in Go is the point of the projection — an // rather than in Go is the point of the projection — an
// oversized body or set of request headers never becomes a Go // oversized body, query string or set of request headers never
// string at all. // becomes a Go string at all.
const eventLogColumns = "id, created_at, method, content_type, " + const eventLogColumns = "id, created_at, method, content_type, " +
"resubmitted_from_id, entrypoint_id, " + "resubmitted_from_id, entrypoint_id, " +
"substr(cast(raw_query as blob), 1, ?) AS raw_query, " +
"length(cast(raw_query as blob)) AS raw_query_bytes, " +
"substr(cast(headers as blob), 1, ?) AS headers, " + "substr(cast(headers as blob), 1, ?) AS headers, " +
"length(cast(headers as blob)) AS headers_bytes, " + "length(cast(headers as blob)) AS headers_bytes, " +
"substr(cast(body as blob), 1, ?) AS body, " + "substr(cast(body as blob), 1, ?) AS body, " +
"length(cast(body as blob)) AS body_bytes" "length(cast(body as blob)) AS body_bytes"
// eventColumns is eventLogColumns for the event's own page, which // eventColumns is eventLogColumns for the event's own page, which
// shows the whole body and every request header. // shows the whole body, the whole query string and every request
// header.
const eventColumns = "id, created_at, method, content_type, " + const eventColumns = "id, created_at, method, content_type, " +
"resubmitted_from_id, entrypoint_id, headers, " + "resubmitted_from_id, entrypoint_id, raw_query, " +
"length(cast(raw_query as blob)) AS raw_query_bytes, headers, " +
"length(cast(headers as blob)) AS headers_bytes, " + "length(cast(headers as blob)) AS headers_bytes, " +
"cast(body as blob) AS body, " + "cast(body as blob) AS body, " +
"length(cast(body as blob)) AS body_bytes" "length(cast(body as blob)) AS body_bytes"
@@ -57,6 +61,13 @@ type EventLogView struct {
// entrypoint's secret. // entrypoint's secret.
Entrypoint string Entrypoint string
// RawQuery is the query string the event arrived with.
// RawQueryCut reports one left out, RawQuery then empty, because
// it holds more than maxRenderedBodyBytes; only the event log
// leaves it out.
RawQuery string
RawQueryCut bool
// Headers is the event's request headers as text, one // Headers is the event's request headers as text, one
// "Name: value" line per value, sorted by name. HeadersCut // "Name: value" line per value, sorted by name. HeadersCut
// reports headers left out because they hold more than // reports headers left out because they hold more than
@@ -85,9 +96,9 @@ func (v EventLogView) ResubmittedFrom() bool {
} }
// eventLogRow is one row of the event log projection, or of // eventLogRow is one row of the event log projection, or of
// eventColumns. In the event log its headers and body columns // eventColumns. In the event log its query string, headers and
// arrive already cut to the cap by SQLite, each with its true // body columns arrive already cut to the cap by SQLite, each with
// size beside it. // its true size beside it.
type eventLogRow struct { type eventLogRow struct {
ID string ID string
CreatedAt time.Time CreatedAt time.Time
@@ -95,6 +106,8 @@ type eventLogRow struct {
ContentType string ContentType string
ResubmittedFromID *string ResubmittedFromID *string
EntrypointID string EntrypointID string
RawQuery string
RawQueryBytes int64
Headers string Headers string
HeadersBytes int64 HeadersBytes int64
Body []byte Body []byte
@@ -114,6 +127,13 @@ func (r *eventLogRow) view(
headers, fit := requestHeaderLines(r.Headers, maxHeaderBytes) headers, fit := requestHeaderLines(r.Headers, maxHeaderBytes)
rawQuery := r.RawQuery
rawQueryCut := r.RawQueryBytes > int64(len(rawQuery))
if rawQueryCut {
rawQuery = ""
}
return EventLogView{ return EventLogView{
ID: r.ID, ID: r.ID,
Method: r.Method, Method: r.Method,
@@ -123,6 +143,8 @@ func (r *eventLogRow) view(
Body: newBodyView( Body: newBodyView(
"/hook/"+webhookID+"/events/"+r.ID, r.Body, r.BodyBytes, "/hook/"+webhookID+"/events/"+r.ID, r.Body, r.BodyBytes,
), ),
RawQuery: rawQuery,
RawQueryCut: rawQueryCut,
Headers: strings.Join(headers, "\n"), Headers: strings.Join(headers, "\n"),
HeadersCut: !fit || r.HeadersBytes > int64(len(r.Headers)), HeadersCut: !fit || r.HeadersBytes > int64(len(r.Headers)),
ResubmittedFromID: from, ResubmittedFromID: from,
internal/handlers/event_request_test.go
+75 -3
View File
@@ -1,13 +1,16 @@
package handlers_test package handlers_test
import ( import (
"context"
"encoding/json" "encoding/json"
"net/http" "net/http"
"net/http/httptest"
"slices" "slices"
"strings" "strings"
"testing" "testing"
"time" "time"
"github.com/go-chi/chi"
"github.com/google/uuid" "github.com/google/uuid"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
@@ -17,14 +20,15 @@ import (
// arrivedAt is how a page names the entrypoint an event arrived at. // arrivedAt is how a page names the entrypoint an event arrived at.
func arrivedAt(name string) string { func arrivedAt(name string) string {
return `Arrived at <span class="text-gray-900">` + name + `</span>` return `Arrived at <span class="text-gray-900 wrap-anywhere">` + name +
`</span>`
} }
// copiedRequestArrivedAt is how a page names, for a resubmitted copy, // copiedRequestArrivedAt is how a page names, for a resubmitted copy,
// the entrypoint the request it copies arrived at. // the entrypoint the request it copies arrived at.
func copiedRequestArrivedAt(name string) string { func copiedRequestArrivedAt(name string) string {
return `The request it copies arrived at <span class="text-gray-900">` + return `The request it copies arrived at ` +
name + `</span>` `<span class="text-gray-900 wrap-anywhere">` + name + `</span>`
} }
// headerBox is how a page shows an event's request header lines: as // headerBox is how a page shows an event's request header lines: as
@@ -115,6 +119,7 @@ func TestEventRequest_EachEventShowsItsOwnEntrypointAndHeaders(
t.Helper() t.Helper()
assert.Contains(t, page, arrivedAt("Billing sender")) assert.Contains(t, page, arrivedAt("Billing sender"))
assert.Contains(t, page, "No query string.")
assert.Contains(t, page, headerBox( assert.Contains(t, page, headerBox(
"Accept: */*", "Accept: */*",
"User-Agent: shop/1 build\t7", "User-Agent: shop/1 build\t7",
@@ -330,3 +335,70 @@ func TestEventRequest_ManyShortHeaderLines(t *testing.T) {
}) })
} }
} }
// TestHandleWebhook_StoresAndShowsTheQueryString posts to an
// entrypoint's URL with a query string and proves the event stores it
// as sent, and shows it escaped in the event log and on its own page,
// in a box like the one the request headers show in.
func TestHandleWebhook_StoresAndShowsTheQueryString(t *testing.T) {
t.Parallel()
f := newRecentEventsFixture(t)
ep := seedEntrypoint(t, f.db, f.webhook.ID)
req := httptest.NewRequestWithContext(
context.Background(), http.MethodPost,
"/h/"+ep.Path+"?a=1&b=2", strings.NewReader("{}"),
)
rctx := chi.NewRouteContext()
rctx.URLParams.Add("uuid", ep.Path)
req = req.WithContext(context.WithValue(
req.Context(), chi.RouteCtxKey, rctx,
))
w := httptest.NewRecorder()
f.h.HandleWebhook().ServeHTTP(w, req)
require.Equal(t, http.StatusOK, w.Code)
var stored database.Event
require.NoError(t, f.webhookDB.First(&stored).Error)
assert.Equal(t, "a=1&b=2", stored.RawQuery)
page := renderSourceLogsPage(t, f.h, f.sess, f.webhook.ID)
assert.Contains(t, page, headerBox("a=1&amp;b=2"))
w = serveEventPage(t, f.h, f.sess, f.webhook.ID, stored.ID)
require.Equal(t, http.StatusOK, w.Code)
assert.Contains(t, w.Body.String(), headerBox("a=1&amp;b=2"))
}
// TestEventRequest_QueryStringOverTheLimit proves the event log leaves
// out a query string that holds more than it shows of a body, and links
// to the event's own page, which shows it whole.
func TestEventRequest_QueryStringOverTheLimit(t *testing.T) {
t.Parallel()
f := newRecentEventsFixture(t)
ep := f.entrypoint(t, "Billing sender")
event := f.eventAt(t, ep, `{}`, time.Now())
query := "q=" + strings.Repeat("x", bodyCap)
require.NoError(t, f.webhookDB.Model(event).Update(
"raw_query", query,
).Error)
page := renderSourceLogsPage(t, f.h, f.sess, f.webhook.ID)
assert.Contains(t, page, `<a href="/hook/`+f.webhook.ID+`/events/`+
event.ID+`" class="btn-small">Show the query string</a>`)
assert.NotContains(t, page, "q=x")
assert.Less(t, len(page), 4*bodyCap)
w := serveEventPage(t, f.h, f.sess, f.webhook.ID, event.ID)
require.Equal(t, http.StatusOK, w.Code)
assert.Contains(t, w.Body.String(), headerBox(query))
assert.NotContains(t, w.Body.String(), "Show the query string")
}
internal/handlers/event_resubmit.go
+3 -1
View File
@@ -30,6 +30,7 @@ type resubmitSource struct {
ID string ID string
EntrypointID string EntrypointID string
Method string Method string
RawQuery string
Headers string Headers string
ContentType string ContentType string
Body []byte Body []byte
@@ -39,7 +40,7 @@ type resubmitSource struct {
// The cast to blob is what makes the driver hand back the stored bytes // The cast to blob is what makes the driver hand back the stored bytes
// rather than a string conversion, the same reason eventBodyQuery // rather than a string conversion, the same reason eventBodyQuery
// casts. // casts.
const resubmitColumns = "id, entrypoint_id, method, headers, " + const resubmitColumns = "id, entrypoint_id, method, raw_query, headers, " +
"content_type, cast(body as blob) AS body" "content_type, cast(body as blob) AS body"
// HandleEventResubmit re-injects a stored event as a new undelivered // HandleEventResubmit re-injects a stored event as a new undelivered
@@ -193,6 +194,7 @@ func (h *Handlers) queueResubmit(
WebhookID: webhook.ID, WebhookID: webhook.ID,
EntrypointID: src.EntrypointID, EntrypointID: src.EntrypointID,
Method: src.Method, Method: src.Method,
RawQuery: src.RawQuery,
HeadersJSON: src.Headers, HeadersJSON: src.Headers,
ContentType: src.ContentType, ContentType: src.ContentType,
Body: src.Body, Body: src.Body,
internal/handlers/event_resubmit_test.go
+10 -3
View File
@@ -22,9 +22,13 @@ import (
// dispatches to it: the notifier is recorded, not run. // dispatches to it: the notifier is recorded, not run.
const resubmitTargetURL = "http://93.184.216.34/hook" const resubmitTargetURL = "http://93.184.216.34/hook"
// resubmitEventHeaders is the stored header JSON a seeded event // resubmitEventHeaders and resubmitEventQuery are the stored header
// carries, so a test can prove the copy takes it verbatim. // JSON and query string a seeded event carries, so a test can prove the
const resubmitEventHeaders = `{"X-Test":["yes"],"X-Trace":["abc"]}` // copy takes them verbatim.
const (
resubmitEventHeaders = `{"X-Test":["yes"],"X-Trace":["abc"]}`
resubmitEventQuery = "a=1&b=2"
)
// seedStoredEvent records one event in a webhook's own database with // seedStoredEvent records one event in a webhook's own database with
// no deliveries at all, which is the state a captured event is in when // no deliveries at all, which is the state a captured event is in when
@@ -43,6 +47,7 @@ func seedStoredEvent(
WebhookID: webhookID, WebhookID: webhookID,
EntrypointID: "entrypoint-" + webhookID, EntrypointID: "entrypoint-" + webhookID,
Method: http.MethodPost, Method: http.MethodPost,
RawQuery: resubmitEventQuery,
Headers: resubmitEventHeaders, Headers: resubmitEventHeaders,
Body: body, Body: body,
ContentType: contentTypeJSON, ContentType: contentTypeJSON,
@@ -202,6 +207,7 @@ func assertEventCopy(
t.Helper() t.Helper()
assert.Equal(t, original.Method, fresh.Method) assert.Equal(t, original.Method, fresh.Method)
assert.Equal(t, resubmitEventQuery, fresh.RawQuery)
assert.Equal(t, original.Headers, fresh.Headers) assert.Equal(t, original.Headers, fresh.Headers)
assert.Equal(t, original.Body, fresh.Body) assert.Equal(t, original.Body, fresh.Body)
assert.Equal(t, int64(len(original.Body)), fresh.BodyBytes) assert.Equal(t, int64(len(original.Body)), fresh.BodyBytes)
@@ -236,6 +242,7 @@ func assertResubmitTask(
assert.Equal(t, target.ID, task.TargetID) assert.Equal(t, target.ID, task.TargetID)
assert.Equal(t, target.Type, task.TargetType) assert.Equal(t, target.Type, task.TargetType)
assert.Equal(t, fresh.Method, task.Method) assert.Equal(t, fresh.Method, task.Method)
assert.Equal(t, fresh.RawQuery, task.RawQuery)
assert.Equal(t, fresh.Headers, task.Headers) assert.Equal(t, fresh.Headers, task.Headers)
assert.Equal(t, fresh.ContentType, task.ContentType) assert.Equal(t, fresh.ContentType, task.ContentType)
assert.Equal(t, 1, task.AttemptNum) assert.Equal(t, 1, task.AttemptNum)
internal/handlers/target_create.go
+18 -13
View File
@@ -173,6 +173,9 @@ type targetFormInput struct {
Headers string Headers string
// Timeout is an HTTP target's per-request timeout in seconds. // Timeout is an HTTP target's per-request timeout in seconds.
Timeout string Timeout string
// ForwardQuery is an HTTP target's checkbox that passes each
// event's query string on to it.
ForwardQuery bool
// MaxRetries is an HTTP or Slack target's max_retries. // MaxRetries is an HTTP or Slack target's max_retries.
MaxRetries string MaxRetries string
// Expiry is a database (archive) target's row expiry. // Expiry is a database (archive) target's row expiry.
@@ -195,14 +198,15 @@ type targetFormInput struct {
// tokens. // tokens.
func targetFormInputFrom(r *http.Request) targetFormInput { func targetFormInputFrom(r *http.Request) targetFormInput {
return targetFormInput{ return targetFormInput{
Name: r.PostFormValue("name"), Name: r.PostFormValue("name"),
Type: database.TargetType(r.PostFormValue("type")), Type: database.TargetType(r.PostFormValue("type")),
URL: r.PostFormValue("url"), URL: r.PostFormValue("url"),
Headers: r.PostFormValue("headers"), Headers: r.PostFormValue("headers"),
Timeout: r.PostFormValue("timeout"), Timeout: r.PostFormValue("timeout"),
MaxRetries: r.PostFormValue("max_retries"), ForwardQuery: r.PostFormValue("forward_query") != "",
Expiry: r.PostFormValue("expiry"), MaxRetries: r.PostFormValue("max_retries"),
Rotation: r.PostFormValue("rotation"), Expiry: r.PostFormValue("expiry"),
Rotation: r.PostFormValue("rotation"),
} }
} }
@@ -232,8 +236,8 @@ func (h *Handlers) buildTargetConfig(
} }
// buildHTTPTargetConfig builds config JSON for an HTTP target: an // buildHTTPTargetConfig builds config JSON for an HTTP target: an
// SSRF-validated destination plus the optional headers and timeout // SSRF-validated destination plus the optional headers, timeout and
// the delivery path honours. // query string setting the delivery path honours.
func (h *Handlers) buildHTTPTargetConfig( func (h *Handlers) buildHTTPTargetConfig(
ctx context.Context, ctx context.Context,
in targetFormInput, in targetFormInput,
@@ -256,9 +260,10 @@ func (h *Handlers) buildHTTPTargetConfig(
} }
configJSON, err := marshalTargetConfig(delivery.HTTPTargetConfig{ configJSON, err := marshalTargetConfig(delivery.HTTPTargetConfig{
URL: in.URL, URL: in.URL,
Headers: headers, Headers: headers,
Timeout: timeout, Timeout: timeout,
ForwardQuery: in.ForwardQuery,
}) })
return configJSON, "", err return configJSON, "", err
internal/handlers/target_edit.go
+8 -7
View File
@@ -77,13 +77,14 @@ func (h *Handlers) HandleTargetEdit() http.HandlerFunc {
} }
form := targetFormInput{ form := targetFormInput{
Name: target.Name, Name: target.Name,
URL: cfg.URL, URL: cfg.URL,
Headers: cfg.Headers, Headers: cfg.Headers,
Timeout: cfg.Timeout, Timeout: cfg.Timeout,
MaxRetries: strconv.Itoa(target.MaxRetries), ForwardQuery: cfg.ForwardQuery,
Expiry: cfg.Expiry, MaxRetries: strconv.Itoa(target.MaxRetries),
Rotation: cfg.Rotation, Expiry: cfg.Expiry,
Rotation: cfg.Rotation,
} }
h.renderTargetEdit( h.renderTargetEdit(
internal/handlers/target_edit_test.go
+53
View File
@@ -442,6 +442,59 @@ func TestHandleTargetEdit_CallsTheDatabaseTypeArchive(t *testing.T) {
assert.Contains(t, page, `class="label">Archive rotation</label>`) assert.Contains(t, page, `class="label">Archive rotation</label>`)
} }
// TestHandleTarget_ForwardQuery covers the HTTP target's setting that
// passes each event's query string on to it: the add target form
// stores it checked, the edit form starts with it checked and turns it
// off when saved unchecked, and both forms come back with it checked
// when refused.
func TestHandleTarget_ForwardQuery(t *testing.T) {
t.Parallel()
const checkbox = `name="forward_query" value="on" checked`
env := setupSourceTest(t)
webhook := seedWebhookWithRetention(t, env.db, 30)
targetsPath := "/hook/" + webhook.ID + "/targets"
form := url.Values{}
form.Set("name", "forwarding")
form.Set("type", string(database.TargetTypeHTTP))
form.Set("url", editOriginalURL)
form.Set("forward_query", "on")
w := serveTarget(env, http.MethodPost, targetsPath, form)
require.Equal(t, http.StatusSeeOther, w.Code, w.Body.String())
targets := targetsForWebhook(t, env.db, webhook.ID)
require.Len(t, targets, 1)
assert.True(t, storedHTTPConfig(t, env, targets[0].ID).ForwardQuery)
w = serveTarget(
env, http.MethodGet, targetsPath+"/"+targets[0].ID+"/edit", nil,
)
require.Equal(t, http.StatusOK, w.Code)
assert.Contains(t, w.Body.String(), checkbox)
edit := editForm(editOriginalURL, "", "")
w = submitTargetEdit(env, webhook.ID, targets[0].ID, edit)
require.Equal(t, http.StatusSeeOther, w.Code, w.Body.String())
assert.False(t, storedHTTPConfig(t, env, targets[0].ID).ForwardQuery)
edit.Set("url", editBlockedURL)
edit.Set("forward_query", "on")
w = submitTargetEdit(env, webhook.ID, targets[0].ID, edit)
require.Equal(t, http.StatusBadRequest, w.Code)
assert.Contains(t, w.Body.String(), checkbox)
form.Set("url", editBlockedURL)
w = serveTarget(env, http.MethodPost, targetsPath, form)
require.Equal(t, http.StatusBadRequest, w.Code)
assert.Contains(t, w.Body.String(), "data-forward-query")
}
// TestHandleTargetEditSubmit_Rejects covers every submission that // TestHandleTargetEditSubmit_Rejects covers every submission that
// must not reach storage. // must not reach storage.
// //
internal/handlers/webhook.go
+4
View File
@@ -230,6 +230,7 @@ type eventSource struct {
WebhookID string WebhookID string
EntrypointID string EntrypointID string
Method string Method string
RawQuery string
HeadersJSON string HeadersJSON string
ContentType string ContentType string
Body []byte Body []byte
@@ -245,6 +246,7 @@ func (s eventSource) event() *database.Event {
WebhookID: s.WebhookID, WebhookID: s.WebhookID,
EntrypointID: s.EntrypointID, EntrypointID: s.EntrypointID,
Method: s.Method, Method: s.Method,
RawQuery: s.RawQuery,
Headers: s.HeadersJSON, Headers: s.HeadersJSON,
Body: string(s.Body), Body: string(s.Body),
BodyBytes: int64(len(s.Body)), BodyBytes: int64(len(s.Body)),
@@ -264,6 +266,7 @@ func requestEventSource(
WebhookID: entrypoint.WebhookID, WebhookID: entrypoint.WebhookID,
EntrypointID: entrypoint.ID, EntrypointID: entrypoint.ID,
Method: r.Method, Method: r.Method,
RawQuery: r.URL.RawQuery,
HeadersJSON: string(headersJSON), HeadersJSON: string(headersJSON),
ContentType: r.Header.Get("Content-Type"), ContentType: r.Header.Get("Content-Type"),
Body: body, Body: body,
@@ -441,6 +444,7 @@ func buildDeliveryTasks(
TargetConfig: targets[i].Config, TargetConfig: targets[i].Config,
MaxRetries: targets[i].MaxRetries, MaxRetries: targets[i].MaxRetries,
Method: event.Method, Method: event.Method,
RawQuery: event.RawQuery,
Headers: event.Headers, Headers: event.Headers,
ContentType: event.ContentType, ContentType: event.ContentType,
Body: bodyPtr, Body: bodyPtr,
internal/middleware/loginguard_test.go
+3 -3
View File
@@ -236,9 +236,9 @@ func TestLoginGuard_SemaphoreBoundsConcurrentVerifications(
// rendezvousDeadlock is the deadlock guard described below. // rendezvousDeadlock is the deadlock guard described below.
// It is orders of magnitude longer than any scheduling delay, // It is orders of magnitude longer than any scheduling delay,
// so it never decides the result, and well inside script/test's // so it never decides the result, and well inside the 90s
// 30s timeout, so a wedge fails on the assertion instead of // package timeout of the Dockerfile's test phase, so a wedge
// blowing the package timeout. // fails on the assertion instead of blowing that timeout.
rendezvousDeadlock = 5 * time.Second rendezvousDeadlock = 5 * time.Second
) )
internal/server/alpine_browser_test.go
+111 -15
View File
@@ -98,20 +98,25 @@ func TestAlpineRunsUnderTheSecurityPolicy(t *testing.T) {
checkRefusedNewWebhook(ctx, t, srv.URL+"/hooks/new") checkRefusedNewWebhook(ctx, t, srv.URL+"/hooks/new")
checkEventLog(ctx, t, page+"/events", event.ID, older.ID, target.Name) checkEventLog(ctx, t, page+"/events", event.ID, older.ID, target.Name)
checkMobileMenu(ctx, t, page) checkMobileMenu(ctx, t, page)
checkPhoneWidth(ctx, t, page, page+"/events", target.Name)
assert.Empty(t, problems(), "the browser reported problems") assert.Empty(t, problems(), "the browser reported problems")
} }
// seedBrowserWebhook seeds the webhook the browser test loads, owned by // seedBrowserWebhook seeds the webhook the browser test loads, owned by
// userID: an entrypoint, two events, and a target whose delivery of the // userID: an entrypoint, two events, and a target whose delivery of the
// newer event failed once with a 502. It returns the webhook, the older // newer event failed once with a 502. The webhook's name and the newer
// and the newer event, and the target. // event's content type are each too long for one line on a phone. It
// returns the webhook, the older and the newer event, and the target.
func seedBrowserWebhook( func seedBrowserWebhook(
t *testing.T, env *testEnv, userID string, t *testing.T, env *testEnv, userID string,
) (*database.Webhook, *database.Event, *database.Event, *database.Target) { ) (*database.Webhook, *database.Event, *database.Event, *database.Target) {
t.Helper() t.Helper()
webhook := env.seedWebhook(t, userID) webhook := env.seedWebhook(t, userID)
require.NoError(t, env.db.DB().Model(webhook).Update(
"name", "payment_provider_production_notifications",
).Error)
require.NoError(t, env.db.DB().Omit(clause.Associations).Create( require.NoError(t, env.db.DB().Omit(clause.Associations).Create(
&database.Entrypoint{ &database.Entrypoint{
WebhookID: webhook.ID, WebhookID: webhook.ID,
@@ -126,6 +131,9 @@ func seedBrowserWebhook(
webhookDB, err := env.dbMgr.GetDB(webhook.ID) webhookDB, err := env.dbMgr.GetDB(webhook.ID)
require.NoError(t, err) require.NoError(t, err)
require.NoError(t, webhookDB.Model(event).Update(
"content_type", "application/vnd.paymentprovider.event+json",
).Error)
require.NoError(t, webhookDB.Omit(clause.Associations).Create( require.NoError(t, webhookDB.Omit(clause.Associations).Create(
&database.DeliveryResult{ &database.DeliveryResult{
DeliveryID: dlv.ID, DeliveryID: dlv.ID,
@@ -272,6 +280,23 @@ func click(ctx context.Context, t *testing.T, xpath string) {
)) ))
} }
// clickAndLoad clicks the link or button matching an XPath expression
// and waits, as loadPage does, for the page the click opens to load and
// for Alpine.js to start on it. Reading earlier, a check can find an
// element of the page being left, gone by the time its value is read;
// and the wait in shown is too short for a page load on a busy host.
func clickAndLoad(ctx context.Context, t *testing.T, xpath string) {
t.Helper()
_, err := chromedp.RunResponse(
ctx, chromedp.Click(xpath, chromedp.BySearch),
)
require.NoError(t, err)
require.NoError(t, chromedp.Run(
ctx, chromedp.WaitNotPresent("[x-cloak]", chromedp.ByQuery),
))
}
// checkAddEntrypoint loads a webhook page and checks that the add // checkAddEntrypoint loads a webhook page and checks that the add
// entrypoint form stays hidden until the Add button beside its heading // entrypoint form stays hidden until the Add button beside its heading
// is clicked. The click looks for a button element there, so it also // is clicked. The click looks for a button element there, so it also
@@ -414,7 +439,7 @@ func checkAddTarget(
))) )))
} }
click(ctx, t, saveButton) clickAndLoad(ctx, t, saveButton)
assert.Truef(t, shown(ctx, `//span[text()="`+name+ assert.Truef(t, shown(ctx, `//span[text()="`+name+
`"]/following-sibling::div/span[text()="`+badge+`"]`), `"]/following-sibling::div/span[text()="`+badge+`"]`),
"%s: the added target is not listed as %s", targetType, badge) "%s: the added target is not listed as %s", targetType, badge)
@@ -477,10 +502,9 @@ func checkArchiveChoices(ctx context.Context, t *testing.T, url string) {
`/following-sibling::span[text()="daily"]`), `/following-sibling::span[text()="daily"]`),
"a database target added with daily is not listed as daily") "a database target added with daily is not listed as daily")
click(ctx, t, row+`//a[text()="Edit"]`) clickAndLoad(ctx, t, row+`//a[text()="Edit"]`)
require.NoError(t, chromedp.Run( require.NoError(t, chromedp.Run(
ctx, ctx,
chromedp.WaitReady("#expiry", chromedp.ByQuery),
chromedp.Value("#expiry", &editedExpiry, chromedp.ByQuery), chromedp.Value("#expiry", &editedExpiry, chromedp.ByQuery),
chromedp.Value("#rotation", &editedRotation, chromedp.ByQuery), chromedp.Value("#rotation", &editedRotation, chromedp.ByQuery),
)) ))
@@ -499,9 +523,10 @@ func checkRefusedTarget(ctx context.Context, t *testing.T, url string) {
t.Helper() t.Helper()
const ( const (
refusedURL = "http://127.0.0.1/hook" refusedURL = "http://127.0.0.1/hook"
urlField = `form[action$="/targets"] input[name="url"]` urlField = `form[action$="/targets"] input[name="url"]`
reason = `//div[@class="alert-error"]` forwardQuery = `form[action$="/targets"] input[name="forward_query"]`
reason = `//div[@class="alert-error"]`
) )
require.NoError(t, chromedp.Run(ctx, loadPage(url))) require.NoError(t, chromedp.Run(ctx, loadPage(url)))
@@ -511,25 +536,34 @@ func checkRefusedTarget(ctx context.Context, t *testing.T, url string) {
ctx, ctx,
chromedp.SetValue(targetName, "refused", chromedp.ByQuery), chromedp.SetValue(targetName, "refused", chromedp.ByQuery),
chromedp.SetValue(urlField, refusedURL, chromedp.ByQuery), chromedp.SetValue(urlField, refusedURL, chromedp.ByQuery),
chromedp.Click(forwardQuery, chromedp.ByQuery),
)) ))
click(ctx, t, saveButton) clickAndLoad(ctx, t, saveButton)
assert.True(t, shown(ctx, reason), assert.True(t, shown(ctx, reason),
"a refused target does not show the reason") "a refused target does not show the reason")
var name, typed string var (
name, typed string
checked bool
)
require.NoError(t, chromedp.Run( require.NoError(t, chromedp.Run(
ctx, ctx,
chromedp.Value(targetName, &name, chromedp.ByQuery), chromedp.Value(targetName, &name, chromedp.ByQuery),
chromedp.Value(urlField, &typed, chromedp.ByQuery), chromedp.Value(urlField, &typed, chromedp.ByQuery),
chromedp.JavascriptAttribute(
forwardQuery, "checked", &checked, chromedp.ByQuery,
),
)) ))
assert.Equal(t, "refused", name, assert.Equal(t, "refused", name,
"a refused target does not keep the name entered") "a refused target does not keep the name entered")
assert.Equal(t, refusedURL, typed, assert.Equal(t, refusedURL, typed,
"a refused target does not keep the url entered") "a refused target does not keep the url entered")
assert.True(t, checked,
"a refused target does not keep the query string setting checked")
assert.True(t, shown(ctx, targetName), assert.True(t, shown(ctx, targetName),
"a refused target does not come back with the form open") "a refused target does not come back with the form open")
assert.True(t, hidden(ctx, typeSelect), assert.True(t, hidden(ctx, typeSelect),
@@ -545,10 +579,15 @@ func checkRefusedTarget(ctx context.Context, t *testing.T, url string) {
ctx, ctx,
chromedp.Value(targetName, &name, chromedp.ByQuery), chromedp.Value(targetName, &name, chromedp.ByQuery),
chromedp.Value(urlField, &typed, chromedp.ByQuery), chromedp.Value(urlField, &typed, chromedp.ByQuery),
chromedp.JavascriptAttribute(
forwardQuery, "checked", &checked, chromedp.ByQuery,
),
)) ))
assert.Empty(t, name, "after Cancel, the next Add keeps the name entered") assert.Empty(t, name, "after Cancel, the next Add keeps the name entered")
assert.Empty(t, typed, "after Cancel, the next Add keeps the url entered") assert.Empty(t, typed, "after Cancel, the next Add keeps the url entered")
assert.False(t, checked,
"after Cancel, the next Add keeps the query string setting checked")
} }
// checkTargetDeliveries loads a webhook page and checks that the row of // checkTargetDeliveries loads a webhook page and checks that the row of
@@ -613,7 +652,7 @@ func checkRefusedEdits(
)) ))
} }
click(ctx, t, `//button[text()="Save Changes"]`) clickAndLoad(ctx, t, `//button[text()="Save Changes"]`)
assert.Truef(t, shown(ctx, reason), assert.Truef(t, shown(ctx, reason),
"%s: a refused save does not show the reason", edit.url) "%s: a refused save does not show the reason", edit.url)
@@ -737,7 +776,7 @@ func checkEntrypointEdit(
require.NoError(t, chromedp.Run( require.NoError(t, chromedp.Run(
ctx, chromedp.SendKeys(input, "Billing sender", chromedp.ByQuery), ctx, chromedp.SendKeys(input, "Billing sender", chromedp.ByQuery),
)) ))
click(ctx, t, saveEdit) clickAndLoad(ctx, t, saveEdit)
assert.True(t, shown(ctx, `//span[text()="Billing sender"]`), assert.True(t, shown(ctx, `//span[text()="Billing sender"]`),
"saving the edit form does not change the description") "saving the edit form does not change the description")
@@ -775,7 +814,7 @@ func checkRecentEvents(ctx context.Context, t *testing.T, url string) {
"clicking the newest event does not collapse it") "clicking the newest event does not collapse it")
require.NoError(t, chromedp.Run(ctx, loadPage(url))) require.NoError(t, chromedp.Run(ctx, loadPage(url)))
click(ctx, t, newest+`/ancestor::div[@x-data][1]//a[text()="Open"]`) clickAndLoad(ctx, t, newest+`/ancestor::div[@x-data][1]//a[text()="Open"]`)
assert.True(t, shown(ctx, `//h2[text()="Body"]`), assert.True(t, shown(ctx, `//h2[text()="Body"]`),
"Open does not lead to the event's own page") "Open does not lead to the event's own page")
@@ -1176,7 +1215,7 @@ func checkNewWebhookTargets(
`","rotation":"none"}` `","rotation":"none"}`
} }
click(ctx, t, createButton) clickAndLoad(ctx, t, createButton)
require.Truef(t, shown(ctx, `//h1[text()="`+name+`"]`), require.Truef(t, shown(ctx, `//h1[text()="`+name+`"]`),
"%s: the new webhook's page does not open", name) "%s: the new webhook's page does not open", name)
@@ -1237,7 +1276,7 @@ func checkRefusedNewWebhook(ctx context.Context, t *testing.T, url string) {
chromedp.SetValue(pruningChoice, "2160h", chromedp.BySearch), chromedp.SetValue(pruningChoice, "2160h", chromedp.BySearch),
chromedp.SetValue("#archive_rotation", "monthly", chromedp.ByQuery), chromedp.SetValue("#archive_rotation", "monthly", chromedp.ByQuery),
)) ))
click(ctx, t, createButton) clickAndLoad(ctx, t, createButton)
assert.True(t, shown(ctx, `//div[@class="alert-error"]`), assert.True(t, shown(ctx, `//div[@class="alert-error"]`),
"a refused webhook does not show the reason") "a refused webhook does not show the reason")
@@ -1292,3 +1331,60 @@ func checkMobileMenu(ctx context.Context, t *testing.T, url string) {
click(ctx, t, button) click(ctx, t, button)
assert.True(t, hidden(ctx, menu), "the menu button does not close the menu") assert.True(t, hidden(ctx, menu), "the menu button does not close the menu")
} }
// scrollsSideways reports whether the page is wider than the window. A
// page's clientWidth is the window's width less its scroll bar.
const scrollsSideways = `document.documentElement.scrollWidth >
document.documentElement.clientWidth`
// cutOffElements lists each element, without elements inside it, that
// is shown but runs past the page's edge or its card's, by more than a
// pixel of rounding. A card hides what runs past its edge.
const cutOffElements = `[...document.querySelectorAll("body *")]
.filter((el) => {
const box = el.getBoundingClientRect();
const card = el.closest(".card")?.getBoundingClientRect();
const left = card ? card.left : 0;
const right = card ? card.right : document.documentElement.clientWidth;
return el.children.length === 0 && box.width > 0 &&
(box.left < left - 1 || box.right > right + 1);
})
.map((el) => el.outerHTML.slice(0, 120))`
// checkPhoneWidth loads the webhook page, url, and its event log,
// eventLog, in a phone-sized window, the event log with the attempts of
// the newest event's delivery to targetName shown. It checks that
// neither page scrolls sideways and that nothing shown on either, no
// status, time or control, is cut off at the page's or its card's edge.
func checkPhoneWidth(
ctx context.Context, t *testing.T, url, eventLog, targetName string,
) {
t.Helper()
var (
sideways bool
cutOff []string
)
measure := chromedp.Tasks{
chromedp.Evaluate(scrollsSideways, &sideways),
chromedp.Evaluate(cutOffElements, &cutOff),
}
require.NoError(t, chromedp.Run(
ctx,
chromedp.EmulateViewport(phoneWidth, phoneHeight),
loadPage(url),
measure,
))
assert.False(t, sideways, "the webhook page scrolls sideways on a phone")
assert.Empty(t, cutOff, "the webhook page cuts these off on a phone")
require.NoError(t, chromedp.Run(ctx, loadPage(eventLog)))
click(ctx, t, `//span[text()="`+targetName+`"]`)
require.True(t, shown(ctx, `//span[text()="Attempt 1"]`),
"clicking the delivery does not show its attempts")
require.NoError(t, chromedp.Run(ctx, measure))
assert.False(t, sideways, "the event log scrolls sideways on a phone")
assert.Empty(t, cutOff, "the event log cuts these off on a phone")
}
package.json
+4 -2
View File
@@ -1,6 +1,8 @@
{ {
"private": true, "private": true,
"devDependencies": { "devDependencies": {
"eslint": "10.11.0" "eslint": "10.11.0",
} "prettier": "3.9.9"
},
"packageManager": "yarn@4.18.1+sha512.b2e1e7524f654f2749d32b4ebcb4622473cb5bcbc485df2007e12a154e50162a4d795526768bc5f5b8f81717bfd79deb2472813d86fb5ae2eb551fa9c872b08f"
} }
script/assets
+2 -2
View File
@@ -2,8 +2,8 @@
# script/assets: extract Alpine.js from its npm package tarball, committed # script/assets: extract Alpine.js from its npm package tarball, committed
# in 3p/, to static/js/alpine.min.js, where go:embed reads it. The package # in 3p/, to static/js/alpine.min.js, where go:embed reads it. The package
# is @alpinejs/csp, Alpine's build for pages whose Content-Security-Policy # is @alpinejs/csp, Alpine's build for pages whose Content-Security-Policy
# forbids eval. The extracted file is not committed. script/test, make # forbids eval. The extracted file is not committed. make build, make dev
# build and make dev run this first. # and the Dockerfile's lint, test and build stages run this first.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
script/bootstrap
+14 -5
View File
@@ -3,14 +3,15 @@
# this repo. Idempotent: every install is guarded by a check so already # this repo. Idempotent: every install is guarded by a check so already
# installed tools are skipped. Base tooling comes from nix, apt, brew, # installed tools are skipped. Base tooling comes from nix, apt, brew,
# 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, node and ESLint are deliberately not # make, or go). golangci-lint, node, ESLint and prettier are deliberately
# installed: linting runs only in docker, via script/lint. # not installed: they run only in docker, via script/lint and script/fmt.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
PKGMGR="" PKGMGR=""
SUDO="" SUDO=""
APT_UPDATED=""
detect_pkgmgr() { detect_pkgmgr() {
[ -n "$PKGMGR" ] && return 0 [ -n "$PKGMGR" ] && return 0
@@ -39,7 +40,14 @@ pkg_install() {
detect_pkgmgr detect_pkgmgr
case "$PKGMGR" in case "$PKGMGR" in
nix) nix-env -iA "nixpkgs.$1" ;; nix) nix-env -iA "nixpkgs.$1" ;;
apt) $SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2" ;; apt)
# Package lists may be empty (fresh images); refresh once per run.
if [ -z "$APT_UPDATED" ]; then
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get update
APT_UPDATED=1
fi
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2"
;;
brew) brew install "$3" ;; brew) brew install "$3" ;;
apk) apk add --no-cache "$4" ;; apk) apk add --no-cache "$4" ;;
esac esac
@@ -60,9 +68,10 @@ main() {
if missing go; then pkg_install go golang go go; fi if missing go; then pkg_install go golang go go; fi
# Not installed here: docker is platform-specific and out of scope for a # Not installed here: docker is platform-specific and out of scope for a
# package-manager bootstrap, but script/lint and script/css need it. # package-manager bootstrap, but script/test, script/lint, script/fmt and
# script/css need it.
if missing docker; then if missing docker; then
echo "bootstrap: docker not found; script/lint and script/css require it" >&2 echo "bootstrap: docker not found; script/test, script/lint, script/fmt and script/css require it" >&2
fi fi
go mod download go mod download
script/check
+2 -2
View File
@@ -1,7 +1,7 @@
#!/bin/sh #!/bin/sh
# script/check: run all checks (test, lint, fmt-check, css-check). Our own # script/check: run all checks (test, lint, fmt-check, css-check). Our own
# extension to scripts-to-rule-them-all. # extension to scripts-to-rule-them-all. test, lint and css-check are
# Writes only the ignored static/js/alpine.min.js, through script/test. # Docker builds; fmt-check runs gofmt on the host. Writes nothing.
# Generic, apart from css-check. # Generic, apart from css-check.
set -eu set -eu
script/ci-mark-superseded
-152
View File
@@ -1,152 +0,0 @@
#!/bin/sh
# script/ci-mark-superseded: record an honest status on commits whose CI
# run Gitea cancelled because a newer commit landed on the same branch.
# Gitea writes `failure` / "Has been cancelled" for such a run, which
# reads as a test result on a commit nothing ever tested. Cancellation is
# unconditional server-side for push events, so the superseding run
# rewrites those statuses to `failure` with a description that says the
# commit was never tested. `skipped` cannot be used: Gitea's combined
# status folds `skipped` into `success`, so a never-tested commit would
# report green. Genuine failures and successes are never touched.
#
# Called by the Gitea Actions workflow, which supplies GITHUB_API_URL,
# GITHUB_REPOSITORY, GITHUB_SHA, GITHUB_WORKFLOW, GITHUB_JOB,
# GITHUB_EVENT_NAME and GITEA_TOKEN. ANCESTOR_LIMIT (default 20) caps how
# far back the walk looks; a value that is set but not a positive integer
# aborts rather than silently disabling the walk.
set -eu
SUPERSEDED_DESC='Superseded by a newer commit; never tested'
# Gitea builds the commit-status context as
# "<workflow name> / <job name> (<event>)", so derive it rather than
# hardcoding the result.
#
# The derivation is deliberately not byte-exact with Gitea's own rule and
# must not be "fixed" into a silent fallback. Gitea uses the job's `name:`
# (falling back to the job id) and the workflow's `name:` (falling back to
# the workflow filename), while the runner exports GITHUB_JOB as the job
# *id* and GITHUB_WORKFLOW as the parsed workflow `name:`. So giving the
# job a display `name:`, or dropping the workflow's `name:`, makes the
# derived context stop matching --- and require_own_context below then
# turns every push red with a message. That loud failure is the point
# (https://git.eeqj.de/sneak/webhooker/issues/147 item 2); guessing at a
# fallback would restore the silent no-op it replaced.
context() {
printf '%s / %s (%s)' \
"$GITHUB_WORKFLOW" "$GITHUB_JOB" "$GITHUB_EVENT_NAME"
}
# ANCESTOR_LIMIT is a documented knob, so a value that is set but
# unusable must fail loudly instead of defaulting
# (https://git.eeqj.de/sneak/webhooker/issues/80). Passing it straight to
# git would print `fatal: not an integer` into a discarded exit status
# and mark nothing.
ancestor_limit() {
# `-` and not `:-`: an explicitly empty value is set-but-unusable
# config, so it aborts like any other bad value rather than silently
# running at the default.
_limit="${ANCESTOR_LIMIT-20}"
case "$_limit" in
'' | *[!0-9]* | 0*)
echo "ANCESTOR_LIMIT must be a positive integer," \
"got '${_limit}'" >&2
return 1
;;
esac
printf '%s' "$_limit"
}
# The status Gitea created for this very job proves which context string
# it uses. If the derived one is missing, the workflow or the job was
# renamed and the match below would silently stop firing, restoring the
# false-red bug with no signal. Fail loudly instead.
require_own_context() {
if ! _body="$(curl -sf --retry 3 --retry-delay 2 --max-time 30 \
"${1}/commits/${GITHUB_SHA}/status")"; then
echo "cannot read commit statuses for ${GITHUB_SHA}" >&2
return 1
fi
_found="$(printf '%s' "$_body" | jq -r '(.statuses // [])[].context')"
if printf '%s\n' "$_found" | grep -qxF "$2"; then
return 0
fi
echo "no commit status with context '${2}' on ${GITHUB_SHA}:" >&2
echo "workflow or job renamed? contexts present:" >&2
printf '%s\n' "$_found" >&2
return 1
}
# Latest status for our context on a commit, as "state|description".
# The read is retried and bounded, and a read that still fails aborts the
# step: a laundered commit that cannot be read is not the same as one
# with nothing to do, and piping curl into jq would discard the
# difference.
status_of() {
if ! _sbody="$(curl -sf --retry 3 --retry-delay 2 --max-time 30 \
"${1}/commits/${2}/status")"; then
echo "cannot read commit statuses for ${2}" >&2
return 1
fi
printf '%s' "$_sbody" | jq -r --arg c "$3" \
'[(.statuses // [])[] | select(.context == $c)][0] // empty
| "\(.status)|\(.description)"'
}
mark_superseded() {
curl -sf -X POST "${1}/statuses/${2}" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H 'Content-Type: application/json' \
-d "$(jq -nc --arg c "$3" --arg d "$SUPERSEDED_DESC" \
'{context: $c, state: "failure", description: $d}')" \
>/dev/null
}
main() {
_api="${GITHUB_API_URL}/repos/${GITHUB_REPOSITORY}"
_ctx="$(context)"
_limit="$(ancestor_limit)"
require_own_context "$_api" "$_ctx"
# A shallow clone cannot resolve the parent, so it looks exactly like
# a root commit to rev-parse below and would exit 0 having walked
# nothing (or, at depth > 1, only the ancestors that happen to be
# present). The workflow checks out with `fetch-depth: 0`; verify
# that here rather than depend on it silently.
if [ "$(git rev-parse --is-shallow-repository)" = 'true' ]; then
echo "shallow repository: the ancestor walk needs full history" >&2
return 1
fi
# A root commit legitimately has no ancestors and is not an error.
# A SHA this repository does not have lands here too, since its
# parent is equally unresolvable, but require_own_context above has
# already aborted on the 404 for it. The walk itself carries no
# `|| true`, so a rev-list failure aborts.
if ! git rev-parse -q --verify "${GITHUB_SHA}^" >/dev/null; then
echo "no ancestor of ${GITHUB_SHA} to check"
return 0
fi
_walk="$(git rev-list --max-count="$_limit" "${GITHUB_SHA}^")"
for _sha in $_walk; do
_latest="$(status_of "$_api" "$_sha" "$_ctx")"
# A run that was cancelled, or one an earlier revision of this
# script laundered into `skipped`. Anything else stands.
case "$_latest" in
'failure|Has been cancelled' | "skipped|${SUPERSEDED_DESC}") ;;
*) continue ;;
esac
mark_superseded "$_api" "$_sha" "$_ctx"
echo "marked superseded: ${_sha}"
done
}
main "$@"
script/cibuild
+19 -6
View File
@@ -1,15 +1,28 @@
#!/bin/sh #!/bin/sh
# script/cibuild: run the CI build. The Dockerfile runs the checks # script/cibuild: run the CI build. It bootstraps first: a CI runner
# (make fmt-check, lint, test), so a successful build implies a green # checks out and runs this and nothing else, and script/fmt-check runs
# repo. Generic: needs no adaptation. The Gitea workflow runs this on # the formatter on the host, which a pristine checkout cannot do.
# push. # --no-cache for the same reason as script/docker: the gate phases the
# final stage depends on are RUN steps, and a cached one is a check that
# did not run.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build . "$SCRIPT_DIR/bootstrap"
"$SCRIPT_DIR/check"
# Own line: a failing command substitution inside an argument does
# not trip `set -e`, so the inline form degrades silently to an
# empty constant. The VERSION build argument takes precedence over
# the version a build stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown"
docker build --no-cache \
--build-arg VERSION="$version" \
-t "$("$SCRIPT_DIR/projectname")" .
} }
main "$@" main "$@"
script/css
+4 -2
View File
@@ -2,14 +2,16 @@
# script/css: regenerate static/css/tailwind.css (writes). tailwindcss is # script/css: regenerate static/css/tailwind.css (writes). tailwindcss is
# never installed locally: it runs in docker, at the version and sha256 # never installed locally: it runs in docker, at the version and sha256
# pinned in the Dockerfile's stylesheet stages, which also say what the # pinned in the Dockerfile's stylesheet stages, which also say what the
# stylesheet is generated from. # stylesheet is generated from. --no-cache, as on every docker build in
# script/, so the stylesheet is generated rather than taken from the cache.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build --target css-output --output type=local,dest=static/css . docker build --no-cache \
--target css-output --output type=local,dest=static/css .
} }
main "$@" main "$@"
script/css-check
+3 -2
View File
@@ -1,14 +1,15 @@
#!/bin/sh #!/bin/sh
# script/css-check: fail when static/css/tailwind.css differs from what # script/css-check: fail when static/css/tailwind.css differs from what
# script/css would generate (read-only). The comparison is the Dockerfile's # script/css would generate (read-only). The comparison is the Dockerfile's
# css-check stage, which the image build runs too. # css-check stage, which the image build runs too. --no-cache because a
# cached check is a check that did not run.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build --target css-check --output type=cacheonly . docker build --no-cache --target css-check --output type=cacheonly .
} }
main "$@" main "$@"
script/docker
+11 -7
View File
@@ -1,10 +1,8 @@
#!/bin/sh #!/bin/sh
# script/docker: build the Docker image tagged with the project name. # script/docker: build the Docker image tagged with the project name.
# The tag comes from script/projectname. # Identical in all repos; the tag comes from script/projectname.
# # --no-cache because the gate phases the final stage depends on are RUN
# The version script/version resolves here goes in as the VERSION build # steps, and a cached one is a check that did not run.
# arg, which takes precedence over what the build would derive from the
# .git in its context.
set -eu set -eu
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
@@ -12,8 +10,14 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build \ # Own line: a failing command substitution inside an argument does
--build-arg VERSION="$("$SCRIPT_DIR/version")" \ # not trip `set -e`, so the inline form degrades silently to an
# empty constant. The VERSION build argument takes precedence over
# the version a build stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown"
docker build --no-cache \
--build-arg VERSION="$version" \
-t "$("$SCRIPT_DIR/projectname")" . -t "$("$SCRIPT_DIR/projectname")" .
} }
script/fmt
+6 -1
View File
@@ -1,5 +1,8 @@
#!/bin/sh #!/bin/sh
# script/fmt: format all files (writes). # script/fmt: format all files (writes): the Go code with gofmt and
# goimports, the Markdown with prettier. prettier is never installed
# locally: it runs in docker, in the Dockerfile's Markdown stages, built
# with --no-cache like every docker build in script/.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
@@ -10,6 +13,8 @@ main() {
if command -v goimports >/dev/null 2>&1; then if command -v goimports >/dev/null 2>&1; then
goimports -w . goimports -w .
fi fi
docker build --no-cache \
--target markdown-output --output type=local,dest=. .
} }
main "$@" main "$@"
script/fmt-check
+3 -1
View File
@@ -1,6 +1,7 @@
#!/bin/sh #!/bin/sh
# script/fmt-check: check formatting (read-only). Same scope as # script/fmt-check: check formatting (read-only). Same scope as
# script/fmt, but fails instead of writing. # script/fmt, but fails instead of writing. --no-cache because a cached
# check is a check that did not run.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
@@ -12,6 +13,7 @@ main() {
gofmt -s -l . gofmt -s -l .
exit 1 exit 1
fi fi
docker build --no-cache --target markdown-check --output type=cacheonly .
} }
main "$@" main "$@"
script/lint
+13 -61
View File
@@ -1,71 +1,23 @@
#!/bin/sh #!/bin/sh
# script/lint: run the linters, golangci-lint over the Go code and then # script/lint: run the linter. Linting is a phase of the Dockerfile and
# ESLint over static/js/. Neither is ever installed locally. # this builds that phase alone; the linter is never installed or run on
# a developer host, where a shared result cache and a host-global lock
# make its answer untrustworthy.
# #
# golangci-lint runs via docker only, one way, everywhere — script/lint builds # The phase is not the last stage in the file, so it is built only when
# Dockerfile.lint, which COPYs the repo into the pinned golangci-lint image # --target names it. --no-cache because a cached lint layer is a lint
# and lints as a build step. This works even when the docker daemon is remote # that did not run. The tag makes each build replace the previous image
# and bind mounts are impossible, and it removes the host linter's shared # instead of leaving a dangling one behind.
# cache, which has attributed other checkouts' findings to this one.
#
# --no-cache-filter=lint forces the lint stage to re-execute on every run; a
# cached lint stage exits 0 in under a second having linted nothing. The deps
# stage keeps its cache, so module downloads are not repeated.
# --progress=plain keeps the linter's own output visible on success, so a
# passing run shows the issue count rather than nothing.
# --output=type=cacheonly leaves no image behind to clean up.
#
# docker silently ignores --no-cache-filter for a stage name that does not
# match, so a rename or a typo would restore the cached false green with no
# warning and a fast exit 0. The flag is therefore not trusted: the build
# output is teed to a log and a run is only a pass if golangci-lint's own
# summary line ("N issues." / "N issues:") is in it. No summary, no lint,
# whatever the exit code says.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build --no-cache \
log="$(mktemp -t webhooker-lint.XXXXXXXX)" --target lint \
rcfile="$(mktemp -t webhooker-lint-rc.XXXXXXXX)" -t "$("$SCRIPT_DIR/projectname")-lint" .
trap 'rm -f "$log" "$rcfile"' EXIT INT TERM
# The pipeline's status is tee's, and POSIX sh has no pipefail, so the
# build's status travels via a file. Output still streams live.
{
docker build \
-f Dockerfile.lint \
--no-cache-filter=lint \
--progress=plain \
--output=type=cacheonly \
. 2>&1 && echo 0 >"$rcfile" || echo $? >"$rcfile"
} | tee "$log" >&2
rc="$(cat "$rcfile")"
[ "$rc" -eq 0 ] || exit "$rc"
if ! grep -qE '[0-9]+ issues[.:]' "$log"; then
echo "script/lint: golangci-lint printed no summary line; the linter" >&2
echo " did not run. Check that the stage named in --no-cache-filter" >&2
echo " still matches a stage in Dockerfile.lint." >&2
exit 1
fi
# ESLint runs in the Dockerfile's js-lint stage, which the image build
# runs too. It prints nothing on a pass, so there is no summary to look
# for. Instead the stage is named once, for both flags: --target fails
# on a name that matches no stage, so a rename cannot leave
# --no-cache-filter silently ignored. The js-deps stage, which installs
# ESLint, keeps its cache, so ESLint is not downloaded again.
js_stage=js-lint
docker build \
--target "$js_stage" \
--no-cache-filter="$js_stage" \
--progress=plain \
--output=type=cacheonly \
.
} }
main "$@" main "$@"
script/test
+10 -75
View File
@@ -1,84 +1,19 @@
#!/bin/sh #!/bin/sh
# script/test: run the test suite. # script/test: run the test suite. Testing is a phase of the Dockerfile
# # and this builds that phase alone, on the same terms as script/lint:
# -timeout is applied by `go test` per package, not to the run as a whole, so # --target because a phase that is not the last stage is built only when
# it only has to clear the slowest single package. When this budget was set # named, --no-cache because a cached test layer is a test that did not
# that was internal/handlers, measured in a cache-defeated builder stage on the # run, and a tag so each build replaces the previous image.
# 48-core shared build host (2026-08-18); load- and host-dependent, not
# invariants:
#
# 16.9s host load 5-20, GOMAXPROCS 48
# 45.9s / 47.3s / 49.0s three runs at deliberate host load 31-73
# 30.6s / 39.7s host load 5-20, GOMAXPROCS 6 / 4
# 67.3s / 97.5s host load 5-20, GOMAXPROCS 2 / 1
# 67.3s GOMAXPROCS 4 at deliberate host load 52-68
#
# The old 30s budget was breached by every loaded run and by every GOMAXPROCS
# at or below 6; at GOMAXPROCS 4 it failed outright ("panic: test timed out
# after 30s"), reproduced on 33e4fa4 with no other change.
#
# 90s matches the org-wide backstop in REPO_POLICIES.md and is sized here
# against the figures above: the worst case under native parallelism is 49.0s,
# and the compound GOMAXPROCS-4-under-load case at 67.3s sits at 75% of it.
# The one figure above 90s is GOMAXPROCS 1, a synthetic core floor rather than
# a condition CI runs under. If a CPU-limited runner ever puts a real run near
# 67s, that is the datum to revisit the org figure with.
#
# Those figures predate tests hashing the admin password at 1 MB instead of
# 64 MB (https://git.eeqj.de/sneak/webhooker/pulls/404). After that change, in
# a cache-defeated build at host load 44-109 (2026-10-02), internal/handlers
# took 8.5s and the slowest package was internal/database at 15.8s. Once its
# retention tests seeded 50 rows per insert instead of 500
# (https://git.eeqj.de/sneak/webhooker/issues/198), internal/database took
# 7.3s and the slowest package was internal/handlers at 8.1s to 10.0s, at host
# load 25-48 (2026-10-02).
#
# -p 4 -parallel 8 keep the run under 2 GB of memory: at most four test
# binaries build or run at once, each with at most eight parallel tests. Under
# -race every test binary and every link costs a few hundred MB, so the
# defaults (one per core) add up to several GB on a many-core host.
#
# The first run has no -v: go test then prints one result line per package,
# with its coverage, and for a package that fails, everything its tests wrote,
# application log lines included. Verbose output from the whole suite passes
# the 2 MiB at which the Docker build cuts off each step's log, so on a failure
# only the tests that failed run again, with -v. The script exits 1 after that
# rerun whatever its result: the first run already showed the suite is broken.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
"$ROOT/script/assets" docker build --no-cache \
--target test \
log="$(mktemp -t webhooker-test.XXXXXXXX)" -t "$("$SCRIPT_DIR/projectname")-test" .
rcfile="$(mktemp -t webhooker-test-rc.XXXXXXXX)"
trap 'rm -f "$log" "$rcfile"' EXIT INT TERM
# The pipeline's status is tee's, and POSIX sh has no pipefail, so go
# test's status travels via a file. Output still streams live.
{
go test -race -cover -p 4 -parallel 8 -timeout 90s ./... 2>&1 \
&& echo 0 >"$rcfile" || echo $? >"$rcfile"
} | tee "$log"
if [ "$(cat "$rcfile")" -eq 0 ]; then
return
fi
# go test reports a failed test as a line starting "--- FAIL: TestName"
# (a failed subtest's line is indented, and reruns with its parent), and
# a failed package as "FAIL<tab>package/path<tab>...". A failure that
# names no test, such as a build error or a timeout, is already shown in
# full above, so there is nothing to rerun.
tests="$(awk '/^--- FAIL: / { print $3 }' "$log" | paste -s -d '|' -)"
packages="$(awk '/^FAIL\t/ { print $2 }' "$log")"
if [ -n "$tests" ]; then
echo "--- Rerunning the failed tests with -v for details ---"
go test -race -v -p 4 -parallel 8 -timeout 90s \
-run "^($tests)\$" $packages || true
fi
exit 1
} }
main "$@" main "$@"
script/test-browser
+2 -3
View File
@@ -3,8 +3,7 @@
# Docker: Dockerfile.browser builds the test and runs it in a digest-pinned # Docker: Dockerfile.browser builds the test and runs it in a digest-pinned
# headless browser image, so the host needs no browser. # headless browser image, so the host needs no browser.
# #
# --no-cache-filter=browser runs the test again even when nothing changed; # --no-cache because a cached test layer is a test that did not run.
# it must name the stage in Dockerfile.browser that runs it.
# --output=type=cacheonly leaves no image behind to clean up. # --output=type=cacheonly leaves no image behind to clean up.
set -eu set -eu
@@ -14,7 +13,7 @@ main() {
cd "$ROOT" cd "$ROOT"
docker build \ docker build \
-f Dockerfile.browser \ -f Dockerfile.browser \
--no-cache-filter=browser \ --no-cache \
--progress=plain \ --progress=plain \
--output=type=cacheonly \ --output=type=cacheonly \
. .
script/version
+5 -3
View File
@@ -1,9 +1,11 @@
#!/bin/sh #!/bin/sh
# script/version: output the version string the binary is stamped with. # script/version: output the version string the binary is stamped with.
# Our own extension to scripts-to-rule-them-all. The Makefile's build # Our own extension to scripts-to-rule-them-all. The Makefile's build
# target and script/docker both take the value from here, so a `make # and version targets take the value from here, and the Dockerfile's
# build` binary and a `make docker` image built from the same checkout # build stage calls them. script/docker and script/cibuild run the same
# report the same thing. # `git describe` on the host and pass the result in as $VERSION, so a
# `make build` binary and a `make docker` image built from the same
# checkout report the same thing.
# #
# Order of precedence: # Order of precedence:
# #
static/css/tailwind.css
+1 -1
View File
File diff suppressed because one or more lines are too long
static/js/app.js
+4
View File
@@ -138,6 +138,7 @@ document.addEventListener("alpine:init", function () {
url: "", url: "",
headers: "", headers: "",
timeout: "", timeout: "",
forwardQuery: false,
maxRetries: "", maxRetries: "",
expiry: "", expiry: "",
rotation: "", rotation: "",
@@ -150,6 +151,8 @@ document.addEventListener("alpine:init", function () {
this.url = refused.destination; this.url = refused.destination;
this.headers = refused.headers; this.headers = refused.headers;
this.timeout = refused.timeout; this.timeout = refused.timeout;
this.forwardQuery =
this.$root.hasAttribute("data-forward-query");
this.maxRetries = refused.maxRetries; this.maxRetries = refused.maxRetries;
this.expiry = refused.expiry; this.expiry = refused.expiry;
this.rotation = refused.rotation; this.rotation = refused.rotation;
@@ -169,6 +172,7 @@ document.addEventListener("alpine:init", function () {
this.url = ""; this.url = "";
this.headers = ""; this.headers = "";
this.timeout = ""; this.timeout = "";
this.forwardQuery = false;
this.maxRetries = ""; this.maxRetries = "";
this.expiry = ""; this.expiry = "";
this.rotation = ""; this.rotation = "";
templates/delivery_row.html
+1 -1
View File
@@ -4,7 +4,7 @@
an event's own page. Spans only, since a button may hold no div. --> an event's own page. Spans only, since a button may hold no div. -->
<span class="flex flex-1 flex-wrap items-center justify-between gap-3"> <span class="flex flex-1 flex-wrap items-center justify-between gap-3">
<span class="flex flex-wrap items-center gap-3"> <span class="flex flex-wrap items-center gap-3">
<span class="text-sm text-gray-700">{{.Target.DisplayName}}</span> <span class="text-sm text-gray-700 wrap-anywhere">{{.Target.DisplayName}}</span>
{{if .Replay}}<span class="text-xs text-gray-500">replay</span>{{end}} {{if .Replay}}<span class="text-xs text-gray-500">replay</span>{{end}}
<span class="text-xs {{if eq .Status "delivered"}}text-green-600{{else if eq .Status "failed"}}text-red-600{{else if eq .Status "retrying"}}text-yellow-600{{else}}text-gray-400{{end}}">{{with .Paused}}waiting: target paused after repeated failures, next try no earlier than {{.Until}} ({{.Relative}}){{else}}{{.Status}}{{end}}</span> <span class="text-xs {{if eq .Status "delivered"}}text-green-600{{else if eq .Status "failed"}}text-red-600{{else if eq .Status "retrying"}}text-yellow-600{{else}}text-gray-400{{end}}">{{with .Paused}}waiting: target paused after repeated failures, next try no earlier than {{.Until}} ({{.Relative}}){{else}}{{.Status}}{{end}}</span>
</span> </span>
templates/event_request.html
+15 -7
View File
@@ -1,14 +1,22 @@
{{define "event_request"}} {{define "event_request"}}
<!-- The entrypoint an event arrived at and its request headers, as <!-- The entrypoint an event arrived at, its query string and its
handlers.EventLogView carries them: the same in the event log and request headers, as handlers.EventLogView carries them: the same in
the event's own page. The entrypoint's URL is never shown. A the event log and the event's own page. The entrypoint's URL is
resubmitted copy, even a copy of a copy, did not arrive at an never shown. A resubmitted copy, even a copy of a copy, did not
entrypoint; the request it copies did. --> arrive at an entrypoint; the request it copies did. -->
<div class="space-y-2 text-xs"> <div class="space-y-2 text-xs">
{{if .ResubmittedFrom}} {{if .ResubmittedFrom}}
<p class="text-gray-500">The request it copies arrived at <span class="text-gray-900">{{.Entrypoint}}</span></p> <p class="text-gray-500">The request it copies arrived at <span class="text-gray-900 wrap-anywhere">{{.Entrypoint}}</span></p>
{{else}} {{else}}
<p class="text-gray-500">Arrived at <span class="text-gray-900">{{.Entrypoint}}</span></p> <p class="text-gray-500">Arrived at <span class="text-gray-900 wrap-anywhere">{{.Entrypoint}}</span></p>
{{end}}
{{if .RawQueryCut}}
<p class="text-gray-500">The query string is larger than the event log shows. <a href="{{.Body.EventURL}}" class="btn-small">Show the query string</a></p>
{{else if .RawQuery}}
<p class="text-gray-500">Query string</p>
<pre class="rounded-md border border-gray-200 bg-white p-2 text-xs text-gray-700 overflow-x-auto whitespace-pre-wrap break-all">{{.RawQuery}}</pre>
{{else}}
<p class="text-gray-500">No query string.</p>
{{end}} {{end}}
{{if .HeadersCut}} {{if .HeadersCut}}
<p class="text-gray-500">The request headers are larger than the event log shows. <a href="{{.Body.EventURL}}" class="btn-small">Show the request headers</a></p> <p class="text-gray-500">The request headers are larger than the event log shows. <a href="{{.Body.EventURL}}" class="btn-small">Show the request headers</a></p>
templates/source_detail.html
+16 -5
View File
@@ -6,15 +6,18 @@
<!-- 108rem, half again the 72rem (max-w-6xl) of the webhook list, the <!-- 108rem, half again the 72rem (max-w-6xl) of the webhook list, the
event log, the navbar and the footer, so an entrypoint URL fits on event log, the navbar and the footer, so an entrypoint URL fits on
one line. An inline style, because the committed tailwind.css has one line. An inline style, because the committed tailwind.css has
no class this wide. --> no class this wide. wrap-anywhere goes only on names and
descriptions: a row too wide for a phone must still run past the
edge, where the browser test sees it, rather than break its
controls mid-word. -->
<div class="mx-auto px-6 py-8" style="max-width: 108rem"> <div class="mx-auto px-6 py-8" style="max-width: 108rem">
<div class="mb-6"> <div class="mb-6">
<a href="/hooks" class="btn-small">&larr; Back to webhooks</a> <a href="/hooks" class="btn-small">&larr; Back to webhooks</a>
<div class="flex flex-wrap justify-between items-center gap-2 mt-2"> <div class="flex flex-wrap justify-between items-center gap-2 mt-2">
<div> <div>
<h1 class="text-2xl font-medium text-gray-900">{{.Webhook.Name}}</h1> <h1 class="text-2xl font-medium text-gray-900 wrap-anywhere">{{.Webhook.Name}}</h1>
{{if .Webhook.Description}} {{if .Webhook.Description}}
<p class="text-sm text-gray-500 mt-1">{{.Webhook.Description}}</p> <p class="text-sm text-gray-500 mt-1 wrap-anywhere">{{.Webhook.Description}}</p>
{{end}} {{end}}
</div> </div>
<div class="flex gap-2"> <div class="flex gap-2">
@@ -60,7 +63,7 @@
{{range .Entrypoints}} {{range .Entrypoints}}
<div class="p-4" x-data="collapsible"> <div class="p-4" x-data="collapsible">
<div class="flex flex-wrap items-center justify-between gap-2 mb-1"> <div class="flex flex-wrap items-center justify-between gap-2 mb-1">
<span x-show="closed" class="text-sm font-medium text-gray-900">{{if .Description}}{{.Description}}{{else}}Entrypoint{{end}}</span> <span x-show="closed" class="text-sm font-medium text-gray-900 wrap-anywhere">{{if .Description}}{{.Description}}{{else}}Entrypoint{{end}}</span>
<!-- Edit shows this form in place of the <!-- Edit shows this form in place of the
description and hides until it closes, and description and hides until it closes, and
Cancel resets what was typed. With Cancel resets what was typed. With
@@ -132,6 +135,7 @@
data-destination="{{.TargetForm.URL}}" data-destination="{{.TargetForm.URL}}"
data-headers="{{.TargetForm.Headers}}" data-headers="{{.TargetForm.Headers}}"
data-timeout="{{.TargetForm.Timeout}}" data-timeout="{{.TargetForm.Timeout}}"
{{if .TargetForm.ForwardQuery}}data-forward-query{{end}}
data-max-retries="{{.TargetForm.MaxRetries}}" data-max-retries="{{.TargetForm.MaxRetries}}"
data-expiry="{{.TargetForm.Expiry}}" data-expiry="{{.TargetForm.Expiry}}"
data-rotation="{{.TargetForm.Rotation}}"> data-rotation="{{.TargetForm.Rotation}}">
@@ -180,6 +184,13 @@
<label class="text-sm text-gray-700">Timeout (seconds, blank = default):</label> <label class="text-sm text-gray-700">Timeout (seconds, blank = default):</label>
<input type="number" name="timeout" :value="timeout" min="0" max="300" class="input text-sm w-24"> <input type="number" name="timeout" :value="timeout" min="0" max="300" class="input text-sm w-24">
</div> </div>
<div>
<label class="flex items-center gap-2 text-sm text-gray-700">
<input type="checkbox" name="forward_query" value="on" :checked="forwardQuery" class="h-4 w-4">
Pass the query string on to this target
</label>
<p class="text-xs text-gray-500 mt-1">Appends the query string each event arrived with to the URL above, after any query string the URL already has.</p>
</div>
<div> <div>
<div class="flex gap-2 items-center"> <div class="flex gap-2 items-center">
<label class="text-sm text-gray-700">Delivery attempts:</label> <label class="text-sm text-gray-700">Delivery attempts:</label>
@@ -249,7 +260,7 @@
{{range .Targets}} {{range .Targets}}
<div class="p-4"> <div class="p-4">
<div class="flex flex-wrap items-center justify-between gap-2 mb-1"> <div class="flex flex-wrap items-center justify-between gap-2 mb-1">
<span class="text-sm font-medium text-gray-900">{{.Name}}</span> <span class="text-sm font-medium text-gray-900 wrap-anywhere">{{.Name}}</span>
<div class="flex flex-wrap items-center gap-2"> <div class="flex flex-wrap items-center gap-2">
<span class="badge-info">{{if eq .Type "database"}}archive{{else}}{{.Type}}{{end}}</span> <span class="badge-info">{{if eq .Type "database"}}archive{{else}}{{.Type}}{{end}}</span>
{{if .Active}} {{if .Active}}
templates/source_logs.html
+10 -5
View File
@@ -3,10 +3,15 @@
{{define "title"}}Full Event Log - {{.Webhook.Name}} - Webhooker{{end}} {{define "title"}}Full Event Log - {{.Webhook.Name}} - Webhooker{{end}}
{{define "content"}} {{define "content"}}
<!-- wrap-anywhere goes only on names, IDs and content types: a row too
wide for a phone must still run past the edge, where the browser
test sees it, rather than break its statuses, times or controls
mid-word. So a target's name in an event's row, which shares its
element with the delivery's status, goes without. -->
<div class="max-w-6xl mx-auto px-6 py-8"> <div class="max-w-6xl mx-auto px-6 py-8">
<div class="mb-6"> <div class="mb-6">
<a href="/hook/{{.Webhook.ID}}" class="btn-small">&larr; Back to {{.Webhook.Name}}</a> <a href="/hook/{{.Webhook.ID}}" class="btn-small wrap-anywhere">&larr; Back to {{.Webhook.Name}}</a>
<div class="flex justify-between items-center mt-2"> <div class="flex flex-wrap justify-between items-center gap-2 mt-2">
<h1 class="text-2xl font-medium text-gray-900">Full Event Log</h1> <h1 class="text-2xl font-medium text-gray-900">Full Event Log</h1>
<!-- Under a filter, this counts the events the filter lists. --> <!-- Under a filter, this counts the events the filter lists. -->
<span class="text-sm text-gray-500">{{if gt .TotalEvents (len .Events)}}{{len .Events}} most recent of {{.TotalEvents}} events{{else}}{{.TotalEvents}}{{if not .Show}} total{{end}} event{{if ne .TotalEvents 1}}s{{end}}{{end}}{{if eq .Show "failed"}} with a failed delivery{{else if eq .Show "pending"}} with a delivery pending or retrying{{end}}</span> <span class="text-sm text-gray-500">{{if gt .TotalEvents (len .Events)}}{{len .Events}} most recent of {{.TotalEvents}} events{{else}}{{.TotalEvents}}{{if not .Show}} total{{end}} event{{if ne .TotalEvents 1}}s{{end}}{{end}}{{if eq .Show "failed"}} with a failed delivery{{else if eq .Show "pending"}} with a delivery pending or retrying{{end}}</span>
@@ -28,8 +33,8 @@
<div role="button" tabindex="0" class="btn-small w-full flex flex-wrap justify-between gap-2" :aria-expanded="open" @mousedown="cancelPendingToggle" @click="toggleUnlessSelecting" @keydown.enter.prevent="toggle" @keydown.space.prevent="toggle"> <div role="button" tabindex="0" class="btn-small w-full flex flex-wrap justify-between gap-2" :aria-expanded="open" @mousedown="cancelPendingToggle" @click="toggleUnlessSelecting" @keydown.enter.prevent="toggle" @keydown.space.prevent="toggle">
<span class="flex flex-wrap items-center gap-3"> <span class="flex flex-wrap items-center gap-3">
<span class="badge-info">{{.Method}}</span> <span class="badge-info">{{.Method}}</span>
<span class="text-sm font-mono text-gray-700">{{.ID}}</span> <span class="text-sm font-mono text-gray-700 wrap-anywhere">{{.ID}}</span>
<span class="text-sm text-gray-500">{{.ContentType}}</span> <span class="text-sm text-gray-500 wrap-anywhere">{{.ContentType}}</span>
{{if .ResubmittedFrom}} {{if .ResubmittedFrom}}
<span class="text-xs text-gray-500" title="This event is a copy of {{.ResubmittedFromID}}">resubmitted copy</span> <span class="text-xs text-gray-500" title="This event is a copy of {{.ResubmittedFromID}}">resubmitted copy</span>
{{end}} {{end}}
@@ -54,7 +59,7 @@
<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">
<div class="mb-3 flex flex-wrap items-center justify-between gap-2"> <div class="mb-3 flex flex-wrap items-center justify-between gap-2">
<div class="text-xs text-gray-500"> <div class="text-xs text-gray-500">
{{if .ResubmittedFrom}}Resubmitted from event <a href="/hook/{{$.Webhook.ID}}/events/{{.ResubmittedFromID}}" class="btn-small font-mono">{{.ResubmittedFromID}}</a>.{{end}} {{if .ResubmittedFrom}}Resubmitted from event <a href="/hook/{{$.Webhook.ID}}/events/{{.ResubmittedFromID}}" class="btn-small font-mono wrap-anywhere">{{.ResubmittedFromID}}</a>.{{end}}
{{if .ResubmitCount}}Resubmitted as {{.ResubmitCount}} new event{{if ne .ResubmitCount 1}}s{{end}}.{{end}} {{if .ResubmitCount}}Resubmitted as {{.ResubmitCount}} new event{{if ne .ResubmitCount 1}}s{{end}}.{{end}}
</div> </div>
<form method="POST" action="/hook/{{$.Webhook.ID}}/events/{{.ID}}/resubmit" class="inline"> <form method="POST" action="/hook/{{$.Webhook.ID}}/events/{{.ID}}/resubmit" class="inline">
templates/target_edit.html
+8
View File
@@ -47,6 +47,14 @@
<input type="number" id="timeout" name="timeout" value="{{.TargetForm.Timeout}}" min="0" max="{{.MaxTimeout}}" class="input"> <input type="number" id="timeout" name="timeout" value="{{.TargetForm.Timeout}}" min="0" max="{{.MaxTimeout}}" class="input">
<p class="text-xs text-gray-500 mt-1">Per-request timeout, at most {{.MaxTimeout}} seconds. Leave blank to use the default.</p> <p class="text-xs text-gray-500 mt-1">Per-request timeout, at most {{.MaxTimeout}} seconds. Leave blank to use the default.</p>
</div> </div>
<div class="form-group">
<label class="flex items-center gap-2 text-sm font-medium text-gray-700">
<input type="checkbox" id="forward_query" name="forward_query" value="on"{{if .TargetForm.ForwardQuery}} checked{{end}} class="h-4 w-4">
Pass the query string on to this target
</label>
<p class="text-xs text-gray-500 mt-1">Appends the query string each event arrived with to the destination URL, after any query string the URL already has.</p>
</div>
{{end}} {{end}}
{{if eq .Target.Type "slack"}} {{if eq .Target.Type "slack"}}
yarn.lock
+606 -411
View File
File diff suppressed because it is too large Load Diff