1 Commits
Author SHA1 Message Date
sneak 370fad06fc Rewrite TODO.md sentence by sentence
check / check (push) Waiting to run
Rewritten from scratch against the code on next; the sections and
their contents are kept.

Model: fable-5-1
2026-10-25 05:18:45 +00:00
+51 -46
View File
@@ -1,72 +1,77 @@
# Workflow # Workflow
One issue per unit of work, one branch and one PR per issue: One issue per unit of work, and one branch and one PR per issue:
- ensure a tracked issue exists with a definition of done - make sure 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 and push the branch
- pass an independent review, then the manager squash-merges into `next` - open a PR with base `next`, never `main`
- push; nothing stays local-only - pass an independent review
- the repository manager squash-merges it into `next`
`next` is the branch for the next milestone and must stay green and mergeable to The repository manager is the role that merges each issue's PR into `next`.
`main` without notice. One `next` -> `main` PR accumulates the milestone; Nothing stays local-only: every commit is pushed.
releases are cut from `main` separately.
The tracker (https://git.eeqj.de/sneak/webhooker/issues) is the record of what `next` is the branch for the next milestone. It must stay green and mergeable
is done and what is under way. This file keeps no list of either. into `main` at all times. A milestone's work reaches `main` through one PR from
`next`. The owner, @sneak, merges that PR. Cutting a release from `main` is a
separate step after that.
The tracker (https://git.eeqj.de/sneak/webhooker/issues) records what is done
and what is under way. This file keeps no list of either.
# Status # Status
What is still open for 1.0.0 is in its milestone What is still open for 1.0.0 is in its milestone
(https://git.eeqj.de/sneak/webhooker/milestone/9). `v1.0.0` is not tagged, and (https://git.eeqj.de/sneak/webhooker/milestone/9). `v1.0.0` is not tagged. Only
only @sneak tags it. @sneak tags it.
Delivery is at-least-once by design, not by accident: a send whose result row Delivery is at least once by design. When webhooker cannot record the outcome of
does not land is attempted again, so a receiver can see a duplicate. That is a delivery, it sends that delivery again. The target can then receive the same
deliberate — the alternative is a silent lost delivery — and the README says so event twice. The alternative is a lost delivery that nothing reports. The README
under Rationale. It is not a defect to re-file. says so. Such a duplicate is not a defect to re-file.
# Next Step # Next Step
@sneak runs webhooker in limited production, then tags `v1.0.0`. Merging `next` @sneak runs webhooker in limited production, then tags `v1.0.0`. Merging `next`
into `main` is a separate act from tagging and waits on neither of those: `next` into `main` is a separate act. It waits on neither the production run nor the
is kept mergeable at all times, which is the point of the branch. tag.
# Future Steps # Future Steps
- Per-webhook rate limits, set in the web UI and enforced in the receiver - Per-webhook rate limits, set in the web UI and enforced at the entrypoint.
handler, on top of the receiver's existing limits, which `RECEIVER_RATE_LIMIT` Today `RECEIVER_RATE_LIMIT` is the only rate-limit setting. It is how many
sets for the whole server (see Rate Limiting in the README) requests per minute one client address may send to one entrypoint. The same
- API key authentication for programmatic access (the `APIKey` model exists, but address is also capped at ten times that across all entrypoints together.
nothing creates a key and no middleware checks one) - API key authentication for programmatic access. The `APIKey` model and its
- REST API v1 `api_keys` table exist. Nothing creates a key and nothing checks one.
- CRUD for webhooks, entrypoints, targets - REST API v1. `/api/v1` is mounted with no routes today.
- CRUD for webhooks, entrypoints and targets
- event viewing and filtering endpoints - event viewing and filtering endpoints
- event redelivery endpoint - event redelivery endpoint
- OpenAPI specification - OpenAPI specification
- Analytics in the web UI: response times summarised per webhook or per target, - Analytics in the web UI: response times summarised per webhook or per target,
and figures for all webhooks together. The webhook page already shows event, and figures for all webhooks together. Today the webhook page shows event,
delivery and failure counts and failure percentages, the target list counts delivery and failure counts and failure percentages. The target list counts
each target's deliveries, the event log and each event's page show every each target's deliveries. The event log shows every attempt's duration.
attempt's duration, and `/metrics` carries server-wide counts and delivery `/metrics` carries server-wide counts and delivery durations.
durations - A remember-me option at login. Today every session survives a browser restart.
- A remember-me option at login. Every session already survives a browser It lasts up to 7 days. It ends sooner after `SESSION_IDLE_TIMEOUT` (default 24
restart: it lasts up to 7 days, and ends sooner after `SESSION_IDLE_TIMEOUT` hours) without use.
(default 24 hours) without activity - Password reset over the web for a forgotten password. Today a signed-in user
- Password reset flow for a forgotten password over the web. The authenticated can change their password. A lost password is reset from the command line with
password _change_ flow already landed, and a lost password is recoverable from `webhooker resetpw` (https://git.eeqj.de/sneak/webhooker/issues/208).
the console with `webhooker resetpw`
(https://git.eeqj.de/sneak/webhooker/issues/208)
- Later, nice to have - Later, nice to have
- email delivery target type - email delivery target type
- SNS and S3 delivery targets - SNS and S3 delivery targets
- data transformations (e.g. a configurable Slack message format; the Slack - data transformations, such as a configurable Slack message format. The
target sends one fixed format today) Slack target sends one fixed format today.
- JSONL file delivery with periodic S3 upload (the `database` target already - JSONL file delivery with periodic S3 upload. Today an archive target
archives events to SQLite files, rotated hourly, daily or monthly if set, writes events to SQLite files. An archive target can rotate those files
and the webhook page offers them as one gzipped JSON download) hourly, daily or monthly. The webhook page offers them as one gzipped JSON
download.
- webhook event search, and filtering beyond the event log's failed and - webhook event search, and filtering beyond the event log's failed and
pending views pending views
- multi-user with role-based access control (each webhook already belongs to - multi-user with role-based access control. Today each webhook belongs to
one account, but there is only the account made at first boot and no way one account. Only the account made at first boot exists. There is no way
to add another) to add another.