Compare commits
1 Commits
issue-79-r
...
a6a306d810
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a6a306d810 |
50
README.md
50
README.md
@@ -307,29 +307,13 @@ event routing.
|
|||||||
| `user_id` | UUID | Foreign key → User |
|
| `user_id` | UUID | Foreign key → User |
|
||||||
| `name` | string | Human-readable name |
|
| `name` | string | Human-readable name |
|
||||||
| `description` | string | Optional description |
|
| `description` | string | Optional description |
|
||||||
| `retention_days` | integer | Days to retain events (default: 30; 0 means retain forever) |
|
| `retention_days` | integer | Days to retain events (default: 30) |
|
||||||
|
|
||||||
**Relations:** Belongs to User. Has many Entrypoints. Has many Targets.
|
**Relations:** Belongs to User. Has many Entrypoints. Has many Targets.
|
||||||
|
|
||||||
The `retention_days` field controls how long event data is kept in the
|
The `retention_days` field controls how long event data is kept in the
|
||||||
webhook's dedicated database before automatic cleanup.
|
webhook's dedicated database before automatic cleanup.
|
||||||
|
|
||||||
Setting `retention_days` to `0` means "retain events forever". Because
|
|
||||||
the column carries a default of 30, a literal zero cannot survive an
|
|
||||||
insert, so a zero is rewritten on save to a sentinel of `365 * 1000`
|
|
||||||
days (`database.RetentionForeverDays`). The retention reaper recognises
|
|
||||||
that sentinel and skips the webhook entirely, and the web UI displays
|
|
||||||
such a webhook's retention as "forever" rather than as a day count.
|
|
||||||
|
|
||||||
A *finite* retention is capped at `database.MaxFiniteRetentionDays`
|
|
||||||
(106751 days, about 292 years), and a larger one is rejected with a
|
|
||||||
400. The cap is not arbitrary: the reaper computes its cutoff as a
|
|
||||||
`time.Duration`, an int64 nanosecond count, and a longer period
|
|
||||||
overflows it. An overflowed cutoff lands in the future, where it
|
|
||||||
matches every row, so the sweep would delete every event the webhook
|
|
||||||
has instead of none. The reaper also clamps the value it is given, so a
|
|
||||||
row written by an older version cannot trigger that either.
|
|
||||||
|
|
||||||
#### Entrypoint
|
#### Entrypoint
|
||||||
|
|
||||||
A receiver URL where external services POST webhook events. Each
|
A receiver URL where external services POST webhook events. Each
|
||||||
@@ -525,7 +509,7 @@ This separation provides:
|
|||||||
DB; the event database file is hard-deleted (permanently removed).
|
DB; the event database file is hard-deleted (permanently removed).
|
||||||
- **Per-webhook retention** — the `retention_days` field on each webhook
|
- **Per-webhook retention** — the `retention_days` field on each webhook
|
||||||
controls automatic cleanup of old events in that webhook's database
|
controls automatic cleanup of old events in that webhook's database
|
||||||
only, or disables cleanup entirely when set to `0` (retain forever).
|
only.
|
||||||
- **Performance** — each webhook's database has its own WAL, its own
|
- **Performance** — each webhook's database has its own WAL, its own
|
||||||
page cache, and its own lock, so concurrent event ingestion across
|
page cache, and its own lock, so concurrent event ingestion across
|
||||||
webhooks won't contend.
|
webhooks won't contend.
|
||||||
@@ -547,6 +531,36 @@ older than the expiry are pruned each time the archive is (re)opened. An
|
|||||||
archive write failure is never silent success: the delivery records a
|
archive write failure is never silent success: the delivery records a
|
||||||
failed attempt with the error and is marked failed.
|
failed attempt with the error and is marked failed.
|
||||||
|
|
||||||
|
Because reopens only happen on writes, an archive belonging to a webhook
|
||||||
|
that has stopped receiving events would never be pruned. A background
|
||||||
|
**archive sweeper** closes that gap: on the same interval as the event
|
||||||
|
retention reaper (`RETENTION_SWEEP_INTERVAL`) it prunes every archive
|
||||||
|
whose database target declares a positive expiry, whether or not the
|
||||||
|
webhook is still receiving traffic. The sweep never creates an archive —
|
||||||
|
a webhook whose archive file does not yet exist is skipped, not
|
||||||
|
initialised — it takes the same per-webhook lock the write path uses, so
|
||||||
|
it can never interleave with a write, and it leaves the archive closed
|
||||||
|
afterwards so the move-the-file-away workflow keeps working. Archives
|
||||||
|
with no expiry, or the expiry `never`, are not touched by the sweep at
|
||||||
|
all.
|
||||||
|
|
||||||
|
Note that a webhook has one archive file but may carry more than one
|
||||||
|
`database` target, each with its own `expiry`. The shortest expiry
|
||||||
|
configured on any of them therefore governs the whole archive, and the
|
||||||
|
sweep applies it whether or not the webhook is still receiving events.
|
||||||
|
Configure a single `database` target per webhook unless you intend that.
|
||||||
|
|
||||||
|
Deleting a webhook releases its archive: the delivery engine's cached
|
||||||
|
archive writer is dropped and its file handle closed, so nothing lingers
|
||||||
|
after the webhook is gone. The archive **file itself is deliberately
|
||||||
|
left on disk**. Unlike the event database — per-webhook working storage
|
||||||
|
that is hard-deleted with the webhook — an archive is long-term storage
|
||||||
|
an operator may still want to keep or move away for offline retention,
|
||||||
|
and destroying it as a side effect of deleting a webhook would be
|
||||||
|
unrecoverable. Removing `archive-{webhookID}.db` is the operator's call.
|
||||||
|
Deleting a webhook's last `database` target releases the writer the same
|
||||||
|
way, and for the same reason leaves the file alone.
|
||||||
|
|
||||||
The **Slack target type** sends webhook events as formatted messages to
|
The **Slack target type** sends webhook events as formatted messages to
|
||||||
any Slack-compatible incoming webhook URL (works with Slack, Mattermost,
|
any Slack-compatible incoming webhook URL (works with Slack, Mattermost,
|
||||||
and other compatible services). Each message includes event metadata
|
and other compatible services). Each message includes event metadata
|
||||||
|
|||||||
27
TODO.md
27
TODO.md
@@ -10,12 +10,13 @@
|
|||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags exist. main (afe88c6) is a working webhook proxy
|
pre-1.0. No git tags exist. main (4f5ecb1) is a working webhook proxy
|
||||||
with auth, CSRF/SSRF protections, login rate limiting, Slack target,
|
with auth, CSRF/SSRF protections, login rate limiting, Slack target,
|
||||||
policy compliance (#6), and pinned lint tooling (#55). Note: TODO.md was
|
event retention (#63), the database archiving target (#43), the admin
|
||||||
deliberately deleted from this repo in f9a9569 (2026-03-01, #6); its
|
password change flow (#65), policy compliance (#6), and pinned lint
|
||||||
content was folded into the README TODO section, which this draft
|
tooling (#55). Note: TODO.md was deliberately deleted from this repo in
|
||||||
reconstructs as of 2026-07-06.
|
f9a9569 (2026-03-01, #6); its content was folded into the README TODO
|
||||||
|
section, which this draft reconstructs as of 2026-07-06.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -28,17 +29,11 @@ databases currently grow without bound.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-09 Make retain-forever reachable from the normal create and
|
- 2026-08-09 Archive writer lifecycle (#89): deleting a webhook (or its
|
||||||
edit flows (#79): a `RetentionForeverDays = 365 * 1000` sentinel, a
|
last `database` target) evicts the cached archive writer and closes
|
||||||
`Webhook.BeforeSave` hook rewriting any non-positive `retention_days`
|
its handle while deliberately leaving `archive-{webhookID}.db` on
|
||||||
to it ahead of GORM's own column defaulting, a reaper that skips such
|
disk, and a new `ArchiveSweeper` prunes idle archives on the existing
|
||||||
webhooks outright, form validation that honours `0` and rejects
|
`RETENTION_SWEEP_INTERVAL` without ever creating an archive file
|
||||||
garbage with a 400, and a retention UI that says "forever". Also
|
|
||||||
closes the overflow the same code path exposed: a finite
|
|
||||||
`retention_days` above `MaxFiniteRetentionDays` (106751, derived from
|
|
||||||
what an int64 `time.Duration` can hold) wrapped the reaper's cutoff
|
|
||||||
into the future and deleted every event, so it is now rejected at the
|
|
||||||
form and clamped in the reaper
|
|
||||||
- 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 canonical `.golangci.yml` (v2 `linters.settings` layout so
|
adopt the canonical `.golangci.yml` (v2 `linters.settings` layout so
|
||||||
|
|||||||
@@ -40,9 +40,15 @@ func main() {
|
|||||||
handlers.New,
|
handlers.New,
|
||||||
middleware.New,
|
middleware.New,
|
||||||
delivery.New,
|
delivery.New,
|
||||||
|
delivery.NewArchiveSweeper,
|
||||||
// Wire *delivery.Engine as delivery.Notifier so the
|
// Wire *delivery.Engine as delivery.Notifier so the
|
||||||
// webhook handler can notify the engine of new deliveries.
|
// webhook handler can notify the engine of new deliveries.
|
||||||
func(e *delivery.Engine) delivery.Notifier { return e },
|
func(e *delivery.Engine) delivery.Notifier { return e },
|
||||||
|
// Wire *delivery.Engine as delivery.WebhookEvictor so
|
||||||
|
// deleting a webhook releases its archive writer.
|
||||||
|
func(e *delivery.Engine) delivery.WebhookEvictor {
|
||||||
|
return e
|
||||||
|
},
|
||||||
server.New,
|
server.New,
|
||||||
),
|
),
|
||||||
fx.Invoke(
|
fx.Invoke(
|
||||||
@@ -50,6 +56,7 @@ func main() {
|
|||||||
*server.Server,
|
*server.Server,
|
||||||
*delivery.Engine,
|
*delivery.Engine,
|
||||||
*database.RetentionReaper,
|
*database.RetentionReaper,
|
||||||
|
*delivery.ArchiveSweeper,
|
||||||
) {
|
) {
|
||||||
},
|
},
|
||||||
),
|
),
|
||||||
|
|||||||
@@ -18,11 +18,6 @@ const (
|
|||||||
testVersion = "test"
|
testVersion = "test"
|
||||||
// testContentType is the event content type used in tests.
|
// testContentType is the event content type used in tests.
|
||||||
testContentType = "application/json"
|
testContentType = "application/json"
|
||||||
// testWebhookName is the Webhook.Name used in tests.
|
|
||||||
testWebhookName = "test-webhook"
|
|
||||||
// testForeverLabel is Webhook.RetentionLabel for a retain-forever
|
|
||||||
// webhook.
|
|
||||||
testForeverLabel = "forever"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func setupTestDB(
|
func setupTestDB(
|
||||||
|
|||||||
@@ -1,59 +1,6 @@
|
|||||||
package database
|
package database
|
||||||
|
|
||||||
import (
|
|
||||||
"math"
|
|
||||||
"strconv"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gorm.io/gorm"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// DefaultRetentionDays is the event retention period applied to a
|
|
||||||
// webhook created without an explicit retention value. It is the
|
|
||||||
// single source of truth for that policy and must stay in sync
|
|
||||||
// with the `gorm:"default:30"` column default on
|
|
||||||
// Webhook.RetentionDays below; a struct tag cannot reference a
|
|
||||||
// constant, so a test asserts the two agree.
|
|
||||||
DefaultRetentionDays = 30
|
|
||||||
|
|
||||||
// RetentionForeverDays is the sentinel RetentionDays value meaning
|
|
||||||
// "retain events forever". Users express that intent as 0, which
|
|
||||||
// Webhook.BeforeSave rewrites to this value: the column default
|
|
||||||
// substitutes DefaultRetentionDays for a zero value at insert
|
|
||||||
// time, so a zero can never survive a round trip to the database.
|
|
||||||
// Nothing outside this file may hardcode the number.
|
|
||||||
RetentionForeverDays = 365 * 1000
|
|
||||||
|
|
||||||
// MaxFiniteRetentionDays is the largest finite retention period the
|
|
||||||
// reaper's cutoff arithmetic can represent, and therefore the
|
|
||||||
// largest one a caller may request. It is derived from that
|
|
||||||
// arithmetic rather than picked: retentionCutoff computes
|
|
||||||
// retentionDays * hoursPerDay * time.Hour, and a time.Duration is
|
|
||||||
// an int64 nanosecond count, so math.MaxInt64 nanoseconds divided
|
|
||||||
// by an hour and then by a day is the exact ceiling — 106751 days,
|
|
||||||
// a little over 292 years.
|
|
||||||
//
|
|
||||||
// One day more overflows int64, wraps the product negative, and
|
|
||||||
// turns the cutoff into a timestamp in the far future that matches
|
|
||||||
// every row in the webhook's database. That is why this bound is
|
|
||||||
// enforced on input and why retentionCutoff saturates underneath
|
|
||||||
// it. Note that RetentionForeverDays deliberately sits above this
|
|
||||||
// ceiling: such webhooks are skipped before any cutoff is
|
|
||||||
// computed, and never reach the arithmetic at all.
|
|
||||||
MaxFiniteRetentionDays = int(
|
|
||||||
math.MaxInt64 / int64(time.Hour) / hoursPerDay,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
// Webhook represents a webhook processing unit that groups entrypoints and targets
|
// Webhook represents a webhook processing unit that groups entrypoints and targets
|
||||||
//
|
|
||||||
// Every method below takes a pointer receiver. BeforeSave has to,
|
|
||||||
// because it mutates the record and GORM only invokes hooks declared
|
|
||||||
// that way; the display helpers follow suit so the receiver kinds do
|
|
||||||
// not mix. Handlers therefore put a *Webhook into template data:
|
|
||||||
// html/template cannot call a pointer method on a value held in a map,
|
|
||||||
// because a map element is not addressable.
|
|
||||||
type Webhook struct {
|
type Webhook struct {
|
||||||
BaseModel
|
BaseModel
|
||||||
|
|
||||||
@@ -61,9 +8,7 @@ type Webhook struct {
|
|||||||
Name string `gorm:"not null" json:"name"`
|
Name string `gorm:"not null" json:"name"`
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
|
||||||
// RetentionDays is the number of days to retain events. A value of
|
// RetentionDays is the number of days to retain events.
|
||||||
// RetentionForeverDays means retain forever. The column default
|
|
||||||
// must equal DefaultRetentionDays.
|
|
||||||
RetentionDays int `gorm:"default:30" json:"retentionDays"`
|
RetentionDays int `gorm:"default:30" json:"retentionDays"`
|
||||||
|
|
||||||
// Relations
|
// Relations
|
||||||
@@ -71,55 +16,3 @@ type Webhook struct {
|
|||||||
Entrypoints []Entrypoint `json:"entrypoints,omitempty"`
|
Entrypoints []Entrypoint `json:"entrypoints,omitempty"`
|
||||||
Targets []Target `json:"targets,omitempty"`
|
Targets []Target `json:"targets,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BeforeSave normalises RetentionDays on every insert and update. A
|
|
||||||
// non-positive value is the user's way of asking for "retain forever",
|
|
||||||
// which is stored as the RetentionForeverDays sentinel.
|
|
||||||
//
|
|
||||||
// This has to happen in a hook rather than at the call sites. GORM
|
|
||||||
// substitutes the column default (DefaultRetentionDays) for a zero
|
|
||||||
// value while building the insert statement, which runs after
|
|
||||||
// BeforeSave; rewriting any later than this loses that race and the
|
|
||||||
// row lands at 30 days. Living on the model also means a future call
|
|
||||||
// site — a REST API, a fixture, a migration — cannot bypass it.
|
|
||||||
func (w *Webhook) BeforeSave(_ *gorm.DB) error {
|
|
||||||
if w.RetentionDays <= 0 {
|
|
||||||
w.RetentionDays = RetentionForeverDays
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// retainsForever reports whether a stored RetentionDays value means
|
|
||||||
// "keep events indefinitely". It is the single definition of that
|
|
||||||
// question, shared by Webhook.RetainsForever and by the reaper's
|
|
||||||
// cutoff computation so the two cannot disagree about which webhooks
|
|
||||||
// are exempt from reaping.
|
|
||||||
//
|
|
||||||
// It accepts the RetentionForeverDays sentinel written by BeforeSave
|
|
||||||
// and, defensively, the non-positive values that rows written before
|
|
||||||
// the sentinel existed may still carry.
|
|
||||||
func retainsForever(retentionDays int) bool {
|
|
||||||
return retentionDays <= 0 ||
|
|
||||||
retentionDays >= RetentionForeverDays
|
|
||||||
}
|
|
||||||
|
|
||||||
// RetainsForever reports whether this webhook's events are kept
|
|
||||||
// indefinitely.
|
|
||||||
func (w *Webhook) RetainsForever() bool {
|
|
||||||
return retainsForever(w.RetentionDays)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RetentionLabel returns the webhook's retention policy as display
|
|
||||||
// text, so that no template has to know about the sentinel value.
|
|
||||||
func (w *Webhook) RetentionLabel() string {
|
|
||||||
if w.RetainsForever() {
|
|
||||||
return "forever"
|
|
||||||
}
|
|
||||||
|
|
||||||
if w.RetentionDays == 1 {
|
|
||||||
return "1 day"
|
|
||||||
}
|
|
||||||
|
|
||||||
return strconv.Itoa(w.RetentionDays) + " days"
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,222 +0,0 @@
|
|||||||
package database_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"reflect"
|
|
||||||
"strconv"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/google/uuid"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"gorm.io/gorm"
|
|
||||||
"gorm.io/gorm/clause"
|
|
||||||
"sneak.berlin/go/webhooker/internal/database"
|
|
||||||
)
|
|
||||||
|
|
||||||
// startedTestDB returns a started main database for model-level tests.
|
|
||||||
func startedTestDB(t *testing.T) *gorm.DB {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
db, lc := setupTestDB(t)
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
require.NoError(t, lc.Start(ctx))
|
|
||||||
t.Cleanup(func() { require.NoError(t, lc.Stop(ctx)) })
|
|
||||||
|
|
||||||
return db.DB()
|
|
||||||
}
|
|
||||||
|
|
||||||
// storedRetention reads the retention_days column straight out of the
|
|
||||||
// row, so the assertion is about what was persisted rather than about
|
|
||||||
// whatever the in-memory struct happens to hold.
|
|
||||||
func storedRetention(t *testing.T, db *gorm.DB, id string) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var got int
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.Model(&database.Webhook{}).
|
|
||||||
Where("id = ?", id).
|
|
||||||
Pluck("retention_days", &got).Error,
|
|
||||||
)
|
|
||||||
|
|
||||||
return got
|
|
||||||
}
|
|
||||||
|
|
||||||
// newWebhookWithRetention creates a webhook through the ordinary Create
|
|
||||||
// path, so the BeforeSave hook and the GORM column default both apply
|
|
||||||
// exactly as they do in production.
|
|
||||||
func newWebhookWithRetention(
|
|
||||||
t *testing.T,
|
|
||||||
db *gorm.DB,
|
|
||||||
wh *database.Webhook,
|
|
||||||
) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
wh.UserID = uuid.New().String()
|
|
||||||
wh.Name = testWebhookName
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.Omit(clause.Associations).Create(wh).Error,
|
|
||||||
)
|
|
||||||
|
|
||||||
return wh.ID
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestWebhookBeforeSave_ZeroBecomesForeverSentinel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := startedTestDB(t)
|
|
||||||
|
|
||||||
wh := &database.Webhook{RetentionDays: 0}
|
|
||||||
id := newWebhookWithRetention(t, db, wh)
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetention(t, db, id),
|
|
||||||
"a zero retention must be stored as the sentinel, "+
|
|
||||||
"not replaced by the column default",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestWebhookBeforeSave_NegativeBecomesForeverSentinel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := startedTestDB(t)
|
|
||||||
|
|
||||||
wh := &database.Webhook{RetentionDays: -5}
|
|
||||||
id := newWebhookWithRetention(t, db, wh)
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetention(t, db, id),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestWebhookBeforeSave_PositiveIsPreserved(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := startedTestDB(t)
|
|
||||||
|
|
||||||
wh := &database.Webhook{RetentionDays: 7}
|
|
||||||
id := newWebhookWithRetention(t, db, wh)
|
|
||||||
|
|
||||||
assert.Equal(t, 7, storedRetention(t, db, id))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWebhookBeforeSave_UpdateToZeroBecomesSentinel proves the hook
|
|
||||||
// fires on update as well as insert, via the same Save call the edit
|
|
||||||
// handler makes.
|
|
||||||
func TestWebhookBeforeSave_UpdateToZeroBecomesSentinel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := startedTestDB(t)
|
|
||||||
|
|
||||||
wh := &database.Webhook{RetentionDays: 30}
|
|
||||||
id := newWebhookWithRetention(t, db, wh)
|
|
||||||
require.Equal(t, 30, storedRetention(t, db, id))
|
|
||||||
|
|
||||||
wh.RetentionDays = 0
|
|
||||||
require.NoError(t, db.Omit(clause.Associations).Save(wh).Error)
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetention(t, db, id),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWebhookRetentionColumnDefaultMatchesConstant guards the one place
|
|
||||||
// the default lives twice: a struct tag cannot reference a constant, so
|
|
||||||
// this asserts the tag and DefaultRetentionDays agree.
|
|
||||||
func TestWebhookRetentionColumnDefaultMatchesConstant(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
field, ok := reflect.TypeFor[database.Webhook]().
|
|
||||||
FieldByName("RetentionDays")
|
|
||||||
require.True(t, ok, "Webhook.RetentionDays must exist")
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
"default:"+strconv.Itoa(database.DefaultRetentionDays),
|
|
||||||
field.Tag.Get("gorm"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestMaxFiniteRetentionDaysIsTheOverflowCeiling asserts that the
|
|
||||||
// constant is exactly where the cutoff arithmetic stops working, which
|
|
||||||
// is what makes it a derived bound rather than a round number someone
|
|
||||||
// liked. One day more wraps the int64 nanosecond count negative, and a
|
|
||||||
// negative span is precisely what turned a cutoff into a future
|
|
||||||
// timestamp that matched — and deleted — every row.
|
|
||||||
//
|
|
||||||
// The multiplications are done through variables on purpose: as
|
|
||||||
// constant expressions the overflowing one would not compile.
|
|
||||||
func TestMaxFiniteRetentionDaysIsTheOverflowCeiling(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const hoursPerDay = 24
|
|
||||||
|
|
||||||
atCeiling := database.MaxFiniteRetentionDays
|
|
||||||
overCeiling := database.MaxFiniteRetentionDays + 1
|
|
||||||
|
|
||||||
assert.Positive(
|
|
||||||
t,
|
|
||||||
time.Duration(atCeiling*hoursPerDay)*time.Hour,
|
|
||||||
"the ceiling itself must still be representable",
|
|
||||||
)
|
|
||||||
assert.Negative(
|
|
||||||
t,
|
|
||||||
time.Duration(overCeiling*hoursPerDay)*time.Hour,
|
|
||||||
"one day past the ceiling must overflow",
|
|
||||||
)
|
|
||||||
|
|
||||||
assert.Less(
|
|
||||||
t,
|
|
||||||
database.MaxFiniteRetentionDays,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
"the sentinel sits above the ceiling and is only safe "+
|
|
||||||
"because retain-forever webhooks skip the arithmetic",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestWebhookRetainsForeverAndLabel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
days int
|
|
||||||
forever bool
|
|
||||||
label string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
"sentinel",
|
|
||||||
database.RetentionForeverDays, true, testForeverLabel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"above sentinel",
|
|
||||||
database.RetentionForeverDays + 1, true, testForeverLabel,
|
|
||||||
},
|
|
||||||
{"legacy zero", 0, true, testForeverLabel},
|
|
||||||
{"legacy negative", -1, true, testForeverLabel},
|
|
||||||
{"default", database.DefaultRetentionDays, false, "30 days"},
|
|
||||||
{"one day", 1, false, "1 day"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
wh := database.Webhook{RetentionDays: tc.days}
|
|
||||||
|
|
||||||
assert.Equal(t, tc.forever, wh.RetainsForever())
|
|
||||||
assert.Equal(t, tc.label, wh.RetentionLabel())
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -114,8 +114,7 @@ func (r *RetentionReaper) run(ctx context.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// sweep lists every webhook from the main database and reaps expired
|
// sweep lists every webhook from the main database and reaps expired
|
||||||
// rows from each per-webhook database that has a finite retention
|
// rows from each per-webhook database whose RetentionDays is positive.
|
||||||
// policy. Webhooks set to retain forever are skipped entirely.
|
|
||||||
func (r *RetentionReaper) sweep(ctx context.Context) {
|
func (r *RetentionReaper) sweep(ctx context.Context) {
|
||||||
var webhooks []Webhook
|
var webhooks []Webhook
|
||||||
|
|
||||||
@@ -140,13 +139,8 @@ func (r *RetentionReaper) sweep(ctx context.Context) {
|
|||||||
|
|
||||||
wh := webhooks[i]
|
wh := webhooks[i]
|
||||||
|
|
||||||
// Skip retain-forever webhooks before building any query.
|
// RetentionDays of zero or less means retain forever.
|
||||||
// RetainsForever covers both the RetentionForeverDays
|
if wh.RetentionDays <= 0 {
|
||||||
// sentinel and the non-positive values that predate it: the
|
|
||||||
// sentinel is a positive number, so without this the reaper
|
|
||||||
// would compute a cutoff a thousand years in the past and
|
|
||||||
// issue a DELETE matching nothing on every single sweep.
|
|
||||||
if wh.RetainsForever() {
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,10 +171,9 @@ func (r *RetentionReaper) reapWebhook(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
cutoff, ok := retentionCutoff(time.Now(), retentionDays)
|
cutoff := time.Now().Add(
|
||||||
if !ok {
|
-time.Duration(retentionDays*hoursPerDay) * time.Hour,
|
||||||
return
|
)
|
||||||
}
|
|
||||||
|
|
||||||
deleted, err := reapExpired(db, cutoff)
|
deleted, err := reapExpired(db, cutoff)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -203,37 +196,6 @@ func (r *RetentionReaper) reapWebhook(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// retentionCutoff returns the timestamp before which a webhook's
|
|
||||||
// events have expired, and whether any cutoff applies at all. It
|
|
||||||
// reports false for a retain-forever policy, so no DELETE is issued.
|
|
||||||
//
|
|
||||||
// The day count is clamped to MaxFiniteRetentionDays first. This is
|
|
||||||
// defense in depth rather than decoration: a time.Duration is an int64
|
|
||||||
// nanosecond count, so an unclamped multiplication overflows above
|
|
||||||
// that ceiling and wraps the span negative. Subtracting a negative
|
|
||||||
// span moves the cutoff into the far future, where it matches every
|
|
||||||
// row in the database: the sweep then deletes every event, delivery,
|
|
||||||
// and delivery result, including ones created seconds ago. Rejecting
|
|
||||||
// out-of-range input at the form is the primary guard; saturating here
|
|
||||||
// means an old row, a migration, or a future call site cannot turn a
|
|
||||||
// too-large retention into total data loss.
|
|
||||||
func retentionCutoff(
|
|
||||||
now time.Time,
|
|
||||||
retentionDays int,
|
|
||||||
) (time.Time, bool) {
|
|
||||||
if retainsForever(retentionDays) {
|
|
||||||
return time.Time{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
if retentionDays > MaxFiniteRetentionDays {
|
|
||||||
retentionDays = MaxFiniteRetentionDays
|
|
||||||
}
|
|
||||||
|
|
||||||
return now.Add(
|
|
||||||
-time.Duration(retentionDays*hoursPerDay) * time.Hour,
|
|
||||||
), true
|
|
||||||
}
|
|
||||||
|
|
||||||
// reapExpired hard-deletes, in foreign-key-safe order, the delivery
|
// reapExpired hard-deletes, in foreign-key-safe order, the delivery
|
||||||
// results, deliveries, and events associated with events older than
|
// results, deliveries, and events associated with events older than
|
||||||
// cutoff. Deletes are unscoped so rows are physically removed rather
|
// cutoff. Deletes are unscoped so rows are physically removed rather
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ func createWebhook(
|
|||||||
|
|
||||||
wh := &database.Webhook{
|
wh := &database.Webhook{
|
||||||
UserID: uuid.New().String(),
|
UserID: uuid.New().String(),
|
||||||
Name: testWebhookName,
|
Name: "test-webhook",
|
||||||
RetentionDays: retentionDays,
|
RetentionDays: retentionDays,
|
||||||
}
|
}
|
||||||
require.NoError(
|
require.NoError(
|
||||||
@@ -85,11 +85,10 @@ func createWebhook(
|
|||||||
db.Omit(clause.Associations).Create(wh).Error,
|
db.Omit(clause.Associations).Create(wh).Error,
|
||||||
)
|
)
|
||||||
|
|
||||||
// Webhook.BeforeSave rewrites a non-positive RetentionDays to the
|
// The RetentionDays column carries a GORM default of 30, so a
|
||||||
// retain-forever sentinel, and the column's GORM default would
|
// zero (or negative) value passed to Create is replaced by that
|
||||||
// otherwise substitute 30. Force the requested value with a
|
// default. Force the requested value explicitly so the
|
||||||
// column-level update so tests can plant legacy rows that predate
|
// retain-forever (<= 0) path can be exercised.
|
||||||
// the sentinel and still carry a literal 0 or negative value.
|
|
||||||
require.NoError(
|
require.NoError(
|
||||||
t,
|
t,
|
||||||
db.Model(wh).
|
db.Model(wh).
|
||||||
@@ -99,30 +98,6 @@ func createWebhook(
|
|||||||
return wh.ID
|
return wh.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
// createWebhookNormally inserts a webhook through the ordinary Create
|
|
||||||
// path, with no column-level forcing, so Webhook.BeforeSave applies
|
|
||||||
// exactly as it does in production. Passing 0 therefore yields a row
|
|
||||||
// holding the RetentionForeverDays sentinel.
|
|
||||||
func createWebhookNormally(
|
|
||||||
t *testing.T,
|
|
||||||
db *gorm.DB,
|
|
||||||
retentionDays int,
|
|
||||||
) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
wh := &database.Webhook{
|
|
||||||
UserID: uuid.New().String(),
|
|
||||||
Name: testWebhookName,
|
|
||||||
RetentionDays: retentionDays,
|
|
||||||
}
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.Omit(clause.Associations).Create(wh).Error,
|
|
||||||
)
|
|
||||||
|
|
||||||
return wh.ID
|
|
||||||
}
|
|
||||||
|
|
||||||
// eventChain is the set of row IDs seeded for a single event.
|
// eventChain is the set of row IDs seeded for a single event.
|
||||||
type eventChain struct {
|
type eventChain struct {
|
||||||
eventID string
|
eventID string
|
||||||
@@ -281,111 +256,12 @@ func TestRetentionReaper_ReapsExpiredKeepsRecent(t *testing.T) {
|
|||||||
assertChainPresent(t, db, recent)
|
assertChainPresent(t, db, recent)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRetentionReaper_SkipsSentinelReapsFiniteInSameSweep covers the
|
|
||||||
// end-to-end retain-forever path: a webhook created the normal way with
|
|
||||||
// a requested retention of 0 lands on the RetentionForeverDays
|
|
||||||
// sentinel, and the reaper leaves its ancient events alone while still
|
|
||||||
// reaping a finite-retention webhook in the very same sweep.
|
|
||||||
func TestRetentionReaper_SkipsSentinelReapsFiniteInSameSweep(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupRetentionTest(t)
|
|
||||||
|
|
||||||
foreverID := createWebhookNormally(t, env.mainDB.DB(), 0)
|
|
||||||
|
|
||||||
var stored database.Webhook
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
env.mainDB.DB().Where("id = ?", foreverID).
|
|
||||||
First(&stored).Error,
|
|
||||||
)
|
|
||||||
require.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
stored.RetentionDays,
|
|
||||||
"a requested retention of 0 must persist as the sentinel",
|
|
||||||
)
|
|
||||||
|
|
||||||
finiteID := createWebhookNormally(t, env.mainDB.DB(), 30)
|
|
||||||
|
|
||||||
foreverDB, err := env.mgr.GetDB(foreverID)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
finiteDB, err := env.mgr.GetDB(finiteID)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
ancient := time.Now().Add(-365 * 24 * time.Hour)
|
|
||||||
kept := seedEventChain(t, foreverDB, foreverID, ancient)
|
|
||||||
doomed := seedEventChain(t, finiteDB, finiteID, ancient)
|
|
||||||
|
|
||||||
env.reaper.ExportSweep(context.Background())
|
|
||||||
|
|
||||||
assertChainPresent(t, foreverDB, kept)
|
|
||||||
assertChainGone(t, finiteDB, doomed)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRetentionReaper_HugeFiniteRetentionRetainsRecentEvents pins the
|
|
||||||
// overflow that made a large finite retention destroy everything.
|
|
||||||
//
|
|
||||||
// The cutoff is a time.Duration, an int64 nanosecond count. A day
|
|
||||||
// count above MaxFiniteRetentionDays multiplied out unclamped wraps
|
|
||||||
// negative, so subtracting it moves the cutoff into the far future,
|
|
||||||
// where "created_at < cutoff" matches every row: an event created a
|
|
||||||
// moment ago, and its delivery and delivery result, were all deleted
|
|
||||||
// on the first sweep. 200000 is inside that band and below the
|
|
||||||
// retain-forever sentinel, so it is treated as a finite policy and
|
|
||||||
// really does reach the arithmetic.
|
|
||||||
//
|
|
||||||
// The row is planted at the column level because such a value can no
|
|
||||||
// longer be submitted through the form; the point of the test is that
|
|
||||||
// a row from an older version, or a future call site, still cannot
|
|
||||||
// trigger the wipe.
|
|
||||||
func TestRetentionReaper_HugeFiniteRetentionRetainsRecentEvents(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupRetentionTest(t)
|
|
||||||
|
|
||||||
const overflowingRetentionDays = 200000
|
|
||||||
|
|
||||||
require.Greater(
|
|
||||||
t,
|
|
||||||
overflowingRetentionDays,
|
|
||||||
database.MaxFiniteRetentionDays,
|
|
||||||
"the test value must exceed what the cutoff can represent",
|
|
||||||
)
|
|
||||||
require.Less(
|
|
||||||
t,
|
|
||||||
overflowingRetentionDays,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
"the test value must not be rescued by the forever skip",
|
|
||||||
)
|
|
||||||
|
|
||||||
webhookID := createWebhook(
|
|
||||||
t, env.mainDB.DB(), overflowingRetentionDays,
|
|
||||||
)
|
|
||||||
|
|
||||||
db, err := env.mgr.GetDB(webhookID)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
fresh := seedEventChain(t, db, webhookID, time.Now())
|
|
||||||
|
|
||||||
env.reaper.ExportSweep(context.Background())
|
|
||||||
|
|
||||||
assertChainPresent(t, db, fresh)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRetentionReaper_RetainsForeverWhenNonPositive(t *testing.T) {
|
func TestRetentionReaper_RetainsForeverWhenNonPositive(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
env := setupRetentionTest(t)
|
env := setupRetentionTest(t)
|
||||||
|
|
||||||
// A legacy row written before the sentinel existed still carries a
|
// RetentionDays of zero means retain forever.
|
||||||
// literal 0; the <= 0 guard must keep honouring it.
|
|
||||||
webhookID := createWebhook(t, env.mainDB.DB(), 0)
|
webhookID := createWebhook(t, env.mainDB.DB(), 0)
|
||||||
|
|
||||||
db, err := env.mgr.GetDB(webhookID)
|
db, err := env.mgr.GetDB(webhookID)
|
||||||
|
|||||||
229
internal/delivery/archive_sweeper.go
Normal file
229
internal/delivery/archive_sweeper.go
Normal file
@@ -0,0 +1,229 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ArchiveSweeperParams holds the fx dependencies for the
|
||||||
|
// ArchiveSweeper.
|
||||||
|
type ArchiveSweeperParams struct {
|
||||||
|
fx.In
|
||||||
|
|
||||||
|
Config *config.Config
|
||||||
|
Database *database.Database
|
||||||
|
Engine *Engine
|
||||||
|
Logger *logger.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// ArchiveSweeper periodically prunes expired rows from
|
||||||
|
// per-webhook archive databases whose database target carries a
|
||||||
|
// positive expiry.
|
||||||
|
//
|
||||||
|
// Without it, pruning happens only when an archive is
|
||||||
|
// (re)opened, and archives are only ever reopened by writes: an
|
||||||
|
// archive belonging to a webhook that has stopped receiving
|
||||||
|
// events would keep its expired rows forever. The sweep closes
|
||||||
|
// that gap without changing anything for archives whose expiry
|
||||||
|
// is unset or "never".
|
||||||
|
//
|
||||||
|
// It reuses Config.RetentionSweepInterval rather than
|
||||||
|
// introducing a second interval: this is a retention sweep with
|
||||||
|
// the same semantics as the event retention reaper.
|
||||||
|
type ArchiveSweeper struct {
|
||||||
|
db *database.Database
|
||||||
|
eng *Engine
|
||||||
|
log *slog.Logger
|
||||||
|
interval time.Duration
|
||||||
|
cancel context.CancelFunc
|
||||||
|
wg sync.WaitGroup
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewArchiveSweeper creates the archive sweeper and registers
|
||||||
|
// its fx lifecycle hooks. The background sweep loop starts on
|
||||||
|
// OnStart and stops cleanly on OnStop via context cancellation.
|
||||||
|
func NewArchiveSweeper(
|
||||||
|
lc fx.Lifecycle,
|
||||||
|
params ArchiveSweeperParams,
|
||||||
|
) *ArchiveSweeper {
|
||||||
|
s := &ArchiveSweeper{
|
||||||
|
db: params.Database,
|
||||||
|
eng: params.Engine,
|
||||||
|
log: params.Logger.Get(),
|
||||||
|
interval: params.Config.RetentionSweepInterval,
|
||||||
|
}
|
||||||
|
|
||||||
|
s.registerHooks(lc)
|
||||||
|
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// registerHooks wires the sweeper's start and stop into the fx
|
||||||
|
// lifecycle. Both hook contexts are deliberately ignored: see
|
||||||
|
// start for why the background loop must not inherit the start
|
||||||
|
// hook's context, and stop for why shutdown blocks on the loop
|
||||||
|
// rather than on the stop hook's deadline.
|
||||||
|
func (s *ArchiveSweeper) registerHooks(lc fx.Lifecycle) {
|
||||||
|
lc.Append(fx.Hook{
|
||||||
|
//nolint:contextcheck // Not passing the hook context is
|
||||||
|
// the point: see start.
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
s.start()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
s.stop()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// start launches the background sweep loop.
|
||||||
|
//
|
||||||
|
// The loop's context is derived from context.Background(), NOT
|
||||||
|
// from the fx OnStart hook context. The hook context carries
|
||||||
|
// fx's start timeout (15s by default), so a loop derived from it
|
||||||
|
// is cancelled 15 seconds after the application starts — long
|
||||||
|
// before the first tick under the default one-hour sweep
|
||||||
|
// interval, leaving a sweeper that never sweeps. A long-lived
|
||||||
|
// goroutine must outlive the startup phase, so its lifetime is
|
||||||
|
// bounded by OnStop instead: stop cancels this context and waits
|
||||||
|
// on the WaitGroup.
|
||||||
|
func (s *ArchiveSweeper) start() {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
s.cancel = cancel
|
||||||
|
|
||||||
|
s.wg.Add(1)
|
||||||
|
|
||||||
|
go s.run(ctx)
|
||||||
|
|
||||||
|
s.log.Info(
|
||||||
|
"archive sweeper started",
|
||||||
|
"interval", s.interval.String(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *ArchiveSweeper) stop() {
|
||||||
|
s.log.Info("archive sweeper stopping")
|
||||||
|
|
||||||
|
if s.cancel != nil {
|
||||||
|
s.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
s.wg.Wait()
|
||||||
|
s.log.Info("archive sweeper stopped")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *ArchiveSweeper) run(ctx context.Context) {
|
||||||
|
defer s.wg.Done()
|
||||||
|
|
||||||
|
ticker := time.NewTicker(s.interval)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
s.sweep(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweep prunes every archive whose database target declares a
|
||||||
|
// positive expiry. Targets belonging to a deleted webhook are
|
||||||
|
// soft-deleted along with it, so GORM's default scope already
|
||||||
|
// excludes them.
|
||||||
|
//
|
||||||
|
// A failure for one webhook is logged and the sweep continues,
|
||||||
|
// matching how the write path already treats a prune error as
|
||||||
|
// non-fatal.
|
||||||
|
func (s *ArchiveSweeper) sweep(ctx context.Context) {
|
||||||
|
var targets []database.Target
|
||||||
|
|
||||||
|
err := s.db.DB().
|
||||||
|
Model(&database.Target{}).
|
||||||
|
Where("type = ?", database.TargetTypeDatabase).
|
||||||
|
Find(&targets).Error
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: failed to list database targets",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range targets {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
s.sweepTarget(&targets[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepTarget prunes the archive of a single database target.
|
||||||
|
// A missing, empty, or "never" expiry parses as a zero duration
|
||||||
|
// and is skipped entirely, so those archives keep exactly the
|
||||||
|
// behaviour they had before the sweep existed.
|
||||||
|
func (s *ArchiveSweeper) sweepTarget(target *database.Target) {
|
||||||
|
expiry, err := parseArchiveExpiry(target.Config)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: invalid database target config",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if expiry <= 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.eng == nil || s.eng.dbTarget == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
err = s.eng.dbTarget.sweepWebhook(target.WebhookID, expiry)
|
||||||
|
if err == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// A writer evicted underneath the sweep means the operator
|
||||||
|
// deleted the webhook (or its last database target) while the
|
||||||
|
// sweep was walking the target list. That is an ordinary
|
||||||
|
// interleaving, not a failure, so it must not produce an
|
||||||
|
// error line.
|
||||||
|
if errors.Is(err, errArchiveWriterEvicted) {
|
||||||
|
s.log.Debug(
|
||||||
|
"archive sweep: writer evicted mid-sweep",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
s.log.Error(
|
||||||
|
"archive sweep: failed to prune archive",
|
||||||
|
"webhook_id", target.WebhookID,
|
||||||
|
"target_id", target.ID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
930
internal/delivery/archive_sweeper_test.go
Normal file
930
internal/delivery/archive_sweeper_test.go
Normal file
@@ -0,0 +1,930 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"gorm.io/driver/sqlite"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
_ "modernc.org/sqlite" // Pure Go SQLite driver.
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// sweepRowOld and sweepRowNew are the event ids
|
||||||
|
// seedArchiveRows assigns to the first and second seeded
|
||||||
|
// rows.
|
||||||
|
sweepRowOld = "ev-0"
|
||||||
|
sweepRowNew = "ev-1"
|
||||||
|
|
||||||
|
// sweepConcurrentWrites is how many deliveries the
|
||||||
|
// concurrent write-plus-sweep test races against the sweep.
|
||||||
|
sweepConcurrentWrites = 20
|
||||||
|
)
|
||||||
|
|
||||||
|
// sweeperEnv bundles the pieces an archive sweep test drives:
|
||||||
|
// a main configuration database holding webhooks and targets, a
|
||||||
|
// delivery engine owning the archive writer registry, and the
|
||||||
|
// data directory the archive files live in.
|
||||||
|
type sweeperEnv struct {
|
||||||
|
sweeper *delivery.ArchiveSweeper
|
||||||
|
eng *delivery.Engine
|
||||||
|
mainDB *database.Database
|
||||||
|
dataDir string
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupSweeperTest(t *testing.T) *sweeperEnv {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
log := archiveTestLogger()
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite",
|
||||||
|
fmt.Sprintf(
|
||||||
|
"file:%s?mode=rwc",
|
||||||
|
filepath.Join(dataDir, "main.db"),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = sqlDB.Close() })
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
mainDB := database.NewTestDatabase(gdb)
|
||||||
|
require.NoError(t, mainDB.Migrate())
|
||||||
|
|
||||||
|
eng := delivery.NewTestEngineWithDB(
|
||||||
|
mainDB,
|
||||||
|
database.NewTestWebhookDBManager(dataDir),
|
||||||
|
log,
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
return &sweeperEnv{
|
||||||
|
sweeper: delivery.NewTestArchiveSweeper(
|
||||||
|
mainDB, eng, log,
|
||||||
|
),
|
||||||
|
eng: eng,
|
||||||
|
mainDB: mainDB,
|
||||||
|
dataDir: dataDir,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePath returns where the engine keeps a webhook's
|
||||||
|
// archive file.
|
||||||
|
func (env *sweeperEnv) archivePath(webhookID string) string {
|
||||||
|
return filepath.Join(
|
||||||
|
env.dataDir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedDatabaseTarget creates a webhook with one database target
|
||||||
|
// carrying the given target config JSON, and returns the
|
||||||
|
// webhook id.
|
||||||
|
func (env *sweeperEnv) seedDatabaseTarget(
|
||||||
|
t *testing.T, configJSON string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: uuid.New().String(),
|
||||||
|
Name: "sweep-test",
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Omit(clause.Associations).
|
||||||
|
Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
tgt := &database.Target{
|
||||||
|
WebhookID: wh.ID,
|
||||||
|
Name: "archive",
|
||||||
|
Type: database.TargetTypeDatabase,
|
||||||
|
Active: true,
|
||||||
|
Config: configJSON,
|
||||||
|
}
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Omit(clause.Associations).
|
||||||
|
Create(tgt).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedArchiveRows creates the archive file for a webhook and
|
||||||
|
// inserts one row per supplied archived-at timestamp, returning
|
||||||
|
// the archive path. The handle is closed before returning, so
|
||||||
|
// the archive is idle exactly as it would be with no traffic.
|
||||||
|
func (env *sweeperEnv) seedArchiveRows(
|
||||||
|
t *testing.T, webhookID string, archivedAt ...time.Time,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=rwc", path),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t, gdb.AutoMigrate(&delivery.ExportArchivedEvent{}),
|
||||||
|
)
|
||||||
|
|
||||||
|
for i, at := range archivedAt {
|
||||||
|
row := delivery.ExportArchivedEvent{
|
||||||
|
EventID: fmt.Sprintf("ev-%d", i),
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"seeded":true}`,
|
||||||
|
ArchivedAt: at,
|
||||||
|
}
|
||||||
|
require.NoError(t, gdb.Create(&row).Error)
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, sqlDB.Close())
|
||||||
|
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivedEventIDs returns the event ids currently stored in an
|
||||||
|
// archive file, read through a separate read-only handle.
|
||||||
|
func archivedEventIDs(
|
||||||
|
t *testing.T, path string,
|
||||||
|
) []string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var rows []delivery.ExportArchivedEvent
|
||||||
|
|
||||||
|
rdb := openArchiveDBForRead(t, path)
|
||||||
|
require.NoError(t, rdb.Order("event_id").Find(&rows).Error)
|
||||||
|
|
||||||
|
ids := make([]string, 0, len(rows))
|
||||||
|
for i := range rows {
|
||||||
|
ids = append(ids, rows[i].EventID)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ids
|
||||||
|
}
|
||||||
|
|
||||||
|
// countArchivedRows counts the rows in an archive file without
|
||||||
|
// asserting anything, so it is safe to poll from an
|
||||||
|
// assert.Eventually condition (which runs off the test
|
||||||
|
// goroutine, where testify assertions must not be used).
|
||||||
|
func countArchivedRows(path string) (int64, error) {
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=ro", path),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = sqlDB.Close() }()
|
||||||
|
|
||||||
|
gdb, err := gorm.Open(
|
||||||
|
sqlite.Dialector{Conn: sqlDB}, &gorm.Config{},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var count int64
|
||||||
|
|
||||||
|
err = gdb.Model(&delivery.ExportArchivedEvent{}).
|
||||||
|
Count(&count).Error
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return count, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// captureLifecycle is a minimal fx.Lifecycle that records the
|
||||||
|
// hooks a component registers, so a test can invoke the real
|
||||||
|
// OnStart/OnStop functions with a context of its choosing.
|
||||||
|
type captureLifecycle struct {
|
||||||
|
hooks []fx.Hook
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *captureLifecycle) Append(h fx.Hook) {
|
||||||
|
l.hooks = append(l.hooks, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweeper_LoopOutlivesStartHookContext is the
|
||||||
|
// regression test for a sweeper that never swept. fx calls
|
||||||
|
// OnStart with a context carrying the application's start
|
||||||
|
// timeout (15 seconds by default), so a background loop whose
|
||||||
|
// context is derived from it is cancelled 15 seconds into the
|
||||||
|
// process — three quarters of an hour before the first tick
|
||||||
|
// under the default one-hour sweep interval.
|
||||||
|
//
|
||||||
|
// The hook context here is already cancelled, which is the same
|
||||||
|
// defect taken to its limit: a loop that inherits it never runs
|
||||||
|
// a single tick, while a correctly rooted loop keeps sweeping
|
||||||
|
// for as long as the process lives. Handing the hook a plain
|
||||||
|
// context.Background() would assert nothing at all.
|
||||||
|
func TestArchiveSweeper_LoopOutlivesStartHookContext(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
now.Add(-48*time.Hour),
|
||||||
|
now.Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSetInterval(10 * time.Millisecond)
|
||||||
|
|
||||||
|
// Drive the genuine fx hooks the application registers,
|
||||||
|
// rather than a test-only entry point.
|
||||||
|
lc := &captureLifecycle{}
|
||||||
|
env.sweeper.ExportRegisterHooks(lc)
|
||||||
|
require.Len(t, lc.hooks, 1)
|
||||||
|
|
||||||
|
hookCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
require.NoError(t, lc.hooks[0].OnStart(hookCtx))
|
||||||
|
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = lc.hooks[0].OnStop(context.Background())
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Eventually(
|
||||||
|
t,
|
||||||
|
func() bool {
|
||||||
|
count, err := countArchivedRows(path)
|
||||||
|
|
||||||
|
return err == nil && count == 1
|
||||||
|
},
|
||||||
|
5*time.Second,
|
||||||
|
10*time.Millisecond,
|
||||||
|
"the sweep loop must keep running after the start "+
|
||||||
|
"hook's context is done; it pruned nothing, so it "+
|
||||||
|
"inherited the hook context and died",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotResurrectEvictedWriter covers the
|
||||||
|
// interleaving where a sweep tick has already listed a webhook's
|
||||||
|
// target when the webhook is deleted and its writer evicted. The
|
||||||
|
// sweep must not put a writer back into the registry: nothing
|
||||||
|
// would ever evict it again, which is precisely the leak this
|
||||||
|
// change exists to close.
|
||||||
|
func TestArchiveSweep_DoesNotResurrectEvictedWriter(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Prime the registry the way a delivery would, then evict as
|
||||||
|
// the deletion path does. The target row is deliberately left
|
||||||
|
// in place: this is the tick that listed the webhook before
|
||||||
|
// the deletion committed.
|
||||||
|
_, err := env.eng.ExportEnsureArchiveWriter(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
env.eng.EvictWebhook(webhookID)
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a sweep must never re-register a writer for a webhook "+
|
||||||
|
"whose registry entry has already been released",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_LeavesNoRegistryEntry states the same
|
||||||
|
// invariant in its general form: sweeping an archive whose
|
||||||
|
// webhook has no cached writer must not leave one behind, so the
|
||||||
|
// registry keeps holding only writers a delivery created and an
|
||||||
|
// eviction can reach.
|
||||||
|
func TestArchiveSweep_LeavesNoRegistryEntry(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
time.Now().Add(-48*time.Hour),
|
||||||
|
time.Now().Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew}, archivedEventIDs(t, path),
|
||||||
|
"the sweep must still prune an idle archive",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the sweep must release the registry entry it created",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedByDelivery is the other
|
||||||
|
// half of that invariant: an entry the sweep created but a
|
||||||
|
// delivery then claimed belongs to the registry and must survive
|
||||||
|
// the sweep, or the delivery would be left holding a detached
|
||||||
|
// writer with an open handle that no eviction can reach.
|
||||||
|
func TestArchiveSweep_KeepsWriterAdoptedByDelivery(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
require.False(t, env.eng.ExportHasArchiveWriter(webhookID))
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a delivery's writer must stay registered",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a sweep must not drop a writer a delivery owns",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedDuringSweep covers the one
|
||||||
|
// interleaving the sweepOwned flag exists for, which
|
||||||
|
// TestArchiveSweep_KeepsWriterAdoptedByDelivery cannot reach: a
|
||||||
|
// delivery adopting the sweep's own entry WHILE that sweep is
|
||||||
|
// still running.
|
||||||
|
//
|
||||||
|
// The registry operations are driven directly, in the order the
|
||||||
|
// sweep and a concurrent delivery perform them, so the window is
|
||||||
|
// exercised deterministically rather than hoped for:
|
||||||
|
//
|
||||||
|
// 1. the sweep finds no cached writer and registers one of its
|
||||||
|
// own, marked sweep-owned;
|
||||||
|
// 2. a delivery arrives, is handed that very writer, clears the
|
||||||
|
// flag and opens the archive handle;
|
||||||
|
// 3. the sweep finishes and releases what it created.
|
||||||
|
//
|
||||||
|
// Step 3 must leave the entry alone. Dropping it would detach a
|
||||||
|
// writer that is holding an open archive handle inside its
|
||||||
|
// debounce window, and no eviction could ever reach it again —
|
||||||
|
// exactly the process-lifetime handle leak this change exists to
|
||||||
|
// close. The eviction at the end proves the entry is still
|
||||||
|
// reachable.
|
||||||
|
func TestArchiveSweep_KeepsWriterAdoptedDuringSweep(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
sweepWriter, created, err := env.eng.ExportSweepWriterFor(
|
||||||
|
webhookID,
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(
|
||||||
|
t, created,
|
||||||
|
"the sweep must have created the registry entry itself",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The delivery lands mid-sweep and adopts the entry.
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
adopted := env.eng.ExportArchiveWriterFor(webhookID)
|
||||||
|
require.NotNil(t, adopted)
|
||||||
|
require.True(
|
||||||
|
t, sweepWriter.Same(adopted),
|
||||||
|
"the delivery must have adopted the sweep's writer",
|
||||||
|
)
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the delivery leaves the archive handle open",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The sweep finishes.
|
||||||
|
env.eng.ExportReleaseSweepWriter(webhookID, sweepWriter)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a writer adopted by a delivery during a sweep must "+
|
||||||
|
"stay registered, or its open handle is unreachable",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.EvictWebhook(webhookID)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the adopted writer must still be evictable",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, sweepWriter.HandleOpen(),
|
||||||
|
"eviction must have closed the adopted writer's handle",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ContinuesAfterPerWebhookFailure proves a
|
||||||
|
// failure for one webhook does not abort the sweep for the
|
||||||
|
// others: an unparseable expiry and an unreadable archive both
|
||||||
|
// have to be logged and stepped over.
|
||||||
|
func TestArchiveSweep_ContinuesAfterPerWebhookFailure(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
// Seeded first so the sweep reaches them before the healthy
|
||||||
|
// webhook: targets come back in insertion order.
|
||||||
|
badConfigID := env.seedDatabaseTarget(t, `{"expiry":"!!!"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, badConfigID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
corruptID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
require.NoError(t, os.WriteFile(
|
||||||
|
env.archivePath(corruptID),
|
||||||
|
[]byte("this is not a sqlite database"),
|
||||||
|
0o600,
|
||||||
|
))
|
||||||
|
|
||||||
|
healthyID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
healthyPath := env.seedArchiveRows(
|
||||||
|
t, healthyID,
|
||||||
|
time.Now().Add(-48*time.Hour),
|
||||||
|
time.Now().Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew},
|
||||||
|
archivedEventIDs(t, healthyPath),
|
||||||
|
"a failure for an earlier webhook must not stop the "+
|
||||||
|
"sweep from pruning the ones after it",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_OpenExistingDoesNotCreateFile pins the second
|
||||||
|
// of the two no-create guards. The first is the stat in
|
||||||
|
// sweepWebhook; this one is the SQLite open mode, which is what
|
||||||
|
// protects the window between that stat and the open. Flipping
|
||||||
|
// the sweep's mode to create-if-missing makes this fail.
|
||||||
|
func TestArchiveSweep_OpenExistingDoesNotCreateFile(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "archive-absent.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
err := w.OpenExisting(time.Hour)
|
||||||
|
|
||||||
|
require.Error(
|
||||||
|
t, err,
|
||||||
|
"opening a missing archive without create permission "+
|
||||||
|
"must fail rather than conjure the file",
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, suffix := range archiveFileSuffixes() {
|
||||||
|
assert.NoFileExists(t, path+suffix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_PrunesIdleArchive is the core regression
|
||||||
|
// test for this issue: an archive that receives no further
|
||||||
|
// writes must still lose its expired rows. Before the sweeper
|
||||||
|
// existed, pruning only ever ran on a write-triggered reopen,
|
||||||
|
// so an idle archive kept expired rows forever.
|
||||||
|
func TestArchiveSweep_PrunesIdleArchive(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
now.Add(-48*time.Hour),
|
||||||
|
now.Add(-time.Minute),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.Equal(
|
||||||
|
t, []string{sweepRowOld, sweepRowNew},
|
||||||
|
archivedEventIDs(t, path),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowNew}, archivedEventIDs(t, path),
|
||||||
|
"the sweep should prune rows older than the expiry "+
|
||||||
|
"from an idle archive and keep the rest",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_LeavesArchiveClosed proves the sweep does
|
||||||
|
// not hold the archive open afterwards, so an operator can
|
||||||
|
// still move the file away for offline retention.
|
||||||
|
//
|
||||||
|
// The assertion is made on a writer the test holds a reference
|
||||||
|
// to, and the handle is proven OPEN before the sweep runs, so the
|
||||||
|
// test observes the sweep closing it rather than a writer that
|
||||||
|
// merely never opened anything. Asking the registry instead would
|
||||||
|
// be vacuous here: the sweep releases an entry it created, and a
|
||||||
|
// missing entry reports "not open" whether or not anything was
|
||||||
|
// closed.
|
||||||
|
func TestArchiveSweep_LeavesArchiveClosed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.OpenExisting(time.Hour))
|
||||||
|
require.True(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"the writer must hold an open handle before the sweep",
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.SweepExpired(time.Hour))
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"an idle archive must end the sweep closed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ClosesHandleOfRegisteredWriter states the same
|
||||||
|
// guarantee end to end, through the real sweeper and a writer the
|
||||||
|
// registry keeps.
|
||||||
|
//
|
||||||
|
// The delivery leaves the archive handle open inside its debounce
|
||||||
|
// window and makes the entry delivery-owned, so the sweep finds a
|
||||||
|
// cached writer (created is false, nothing is released) and the
|
||||||
|
// registry query afterwards is answered by a writer that really
|
||||||
|
// exists. A handle left open here would be doubly wrong: it also
|
||||||
|
// blocks the operator's move-the-file-away workflow.
|
||||||
|
func TestArchiveSweep_ClosesHandleOfRegisteredWriter(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
d := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the delivery must leave the archive handle open",
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"the delivery's registry entry must survive the sweep",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the sweep must leave the archive closed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_NeverExpiryUntouched proves the sweep is a
|
||||||
|
// no-op for the default retention policy, so archives with no
|
||||||
|
// expiry (or the literal "never") behave exactly as before.
|
||||||
|
func TestArchiveSweep_NeverExpiryUntouched(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, configJSON := range []string{
|
||||||
|
`{"expiry":"never"}`,
|
||||||
|
`{"expiry":""}`,
|
||||||
|
"",
|
||||||
|
} {
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, configJSON)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID,
|
||||||
|
time.Now().Add(-10000*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowOld}, archivedEventIDs(t, path),
|
||||||
|
"config %q must keep rows forever", configJSON,
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, env.eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"config %q must leave no registry entry behind",
|
||||||
|
configJSON,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_NeverExpirySkipsBeforeOpening pins the
|
||||||
|
// expiry <= 0 boundary in sweepTarget, which the row assertions
|
||||||
|
// above cannot reach: pruning is separately gated on a positive
|
||||||
|
// expiry, so a "never" archive keeps its rows even if the sweep
|
||||||
|
// does open it.
|
||||||
|
//
|
||||||
|
// The spec is stronger than that — a "never" archive is skipped
|
||||||
|
// before any file is touched — so the archive here exists but has
|
||||||
|
// never been migrated. Opening it at all would run AutoMigrate
|
||||||
|
// and create the archive table, which is exactly what must not
|
||||||
|
// happen.
|
||||||
|
func TestArchiveSweep_NeverExpirySkipsBeforeOpening(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"never"}`)
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
seedUnmigratedArchive(t, path)
|
||||||
|
require.False(t, archiveTableExists(t, path))
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, archiveTableExists(t, path),
|
||||||
|
"a never-expiry archive must not be opened at all",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedUnmigratedArchive creates an archive file that exists but
|
||||||
|
// carries no archive schema, so any open of it is observable: the
|
||||||
|
// archive table appears only if something ran AutoMigrate.
|
||||||
|
func seedUnmigratedArchive(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
sqlDB, err := sql.Open(
|
||||||
|
"sqlite", fmt.Sprintf("file:%s?mode=rwc", path),
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, err = sqlDB.ExecContext(
|
||||||
|
t.Context(), "CREATE TABLE placeholder (id INTEGER)",
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, sqlDB.Close())
|
||||||
|
}
|
||||||
|
|
||||||
|
// archiveTableExists reports whether an archive file has had the
|
||||||
|
// archive schema migrated into it.
|
||||||
|
func archiveTableExists(t *testing.T, path string) bool {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
return openArchiveDBForRead(t, path).
|
||||||
|
Migrator().
|
||||||
|
HasTable(&delivery.ExportArchivedEvent{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotCreateArchiveFile proves the sweep
|
||||||
|
// never conjures an archive: a webhook with a database target
|
||||||
|
// that has never received an event must still have no archive
|
||||||
|
// file (nor SQLite sidecar) after a sweep.
|
||||||
|
func TestArchiveSweep_DoesNotCreateArchiveFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.archivePath(webhookID)
|
||||||
|
|
||||||
|
require.NoFileExists(t, path)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
for _, suffix := range archiveFileSuffixes() {
|
||||||
|
assert.NoFileExists(
|
||||||
|
t, path+suffix,
|
||||||
|
"the sweep must not create an archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_DoesNotCreateAfterWriterExists covers the
|
||||||
|
// same guarantee once a writer is cached in the registry but
|
||||||
|
// the file itself is still absent (for instance because the
|
||||||
|
// operator moved the archive away).
|
||||||
|
func TestArchiveSweep_DoesNotCreateAfterWriterExists(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
path, err := env.eng.ExportEnsureArchiveWriter(webhookID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoFileExists(t, path)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.NoFileExists(t, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_SkipsDeletedWebhookTargets proves that the
|
||||||
|
// sweep ignores targets soft-deleted along with their webhook,
|
||||||
|
// so a deleted webhook's archive is never reopened.
|
||||||
|
func TestArchiveSweep_SkipsDeletedWebhookTargets(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
path := env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
env.mainDB.DB().
|
||||||
|
Where("webhook_id = ?", webhookID).
|
||||||
|
Delete(&database.Target{}).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{sweepRowOld}, archivedEventIDs(t, path),
|
||||||
|
"a deleted target's archive must be left alone",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweep_ConcurrentWrites proves the sweep serialises
|
||||||
|
// against writes through the per-webhook writer mutex. Run
|
||||||
|
// under -race, an unsynchronised sweep would be caught here.
|
||||||
|
func TestArchiveSweep_ConcurrentWrites(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
|
||||||
|
// The deliveries are seeded up front, on the test's own
|
||||||
|
// goroutine: the seed helpers assert, and testify assertions
|
||||||
|
// must not run off the test goroutine.
|
||||||
|
deliveries := make(
|
||||||
|
[]*database.Delivery, 0, sweepConcurrentWrites,
|
||||||
|
)
|
||||||
|
|
||||||
|
for range sweepConcurrentWrites {
|
||||||
|
event := seedEvent(t, webhookDB, `{"n":1}`)
|
||||||
|
event.WebhookID = webhookID
|
||||||
|
|
||||||
|
deliveries = append(
|
||||||
|
deliveries,
|
||||||
|
seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, `{"expiry":"1h"}`,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
|
wg.Add(2)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
|
||||||
|
for _, d := range deliveries {
|
||||||
|
env.eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
|
||||||
|
for range sweepConcurrentWrites {
|
||||||
|
env.sweeper.ExportSweep(context.Background())
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
assert.FileExists(t, env.archivePath(webhookID))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestArchiveSweeper_StopsCleanly proves the background loop
|
||||||
|
// exits on OnStop rather than leaking a goroutine.
|
||||||
|
func TestArchiveSweeper_StopsCleanly(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
env := setupSweeperTest(t)
|
||||||
|
|
||||||
|
webhookID := env.seedDatabaseTarget(t, `{"expiry":"1h"}`)
|
||||||
|
env.seedArchiveRows(
|
||||||
|
t, webhookID, time.Now().Add(-48*time.Hour),
|
||||||
|
)
|
||||||
|
|
||||||
|
env.sweeper.ExportSetInterval(time.Millisecond)
|
||||||
|
env.sweeper.ExportStart()
|
||||||
|
|
||||||
|
// stop blocks on the loop's WaitGroup, so returning at all
|
||||||
|
// proves the loop observed the cancellation and exited.
|
||||||
|
env.sweeper.ExportStop()
|
||||||
|
}
|
||||||
@@ -94,6 +94,23 @@ type Notifier interface {
|
|||||||
Notify(tasks []Task)
|
Notify(tasks []Task)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WebhookEvictor releases the delivery engine's per-webhook
|
||||||
|
// state for a webhook that no longer needs it — currently the
|
||||||
|
// cached archive writer of the database target, whose open
|
||||||
|
// file handle would otherwise outlive the webhook.
|
||||||
|
//
|
||||||
|
// It is deliberately separate from Notifier and deliberately
|
||||||
|
// one method wide: archiving lifecycle is not notification, and
|
||||||
|
// a single-method interface keeps the handlers package free of
|
||||||
|
// any dependency on the engine's internals while staying
|
||||||
|
// trivially fakeable in tests.
|
||||||
|
//
|
||||||
|
// EvictWebhook never deletes an archive file. It is idempotent
|
||||||
|
// and is a no-op for a webhook with no engine state.
|
||||||
|
type WebhookEvictor interface {
|
||||||
|
EvictWebhook(webhookID string)
|
||||||
|
}
|
||||||
|
|
||||||
// EngineParams are the fx dependencies for the delivery
|
// EngineParams are the fx dependencies for the delivery
|
||||||
// engine.
|
// engine.
|
||||||
type EngineParams struct {
|
type EngineParams struct {
|
||||||
@@ -127,6 +144,10 @@ type Engine struct {
|
|||||||
// httpTarget is retained so tests can reach the HTTP
|
// httpTarget is retained so tests can reach the HTTP
|
||||||
// target's shared client and circuit breakers.
|
// target's shared client and circuit breakers.
|
||||||
httpTarget *httpTarget
|
httpTarget *httpTarget
|
||||||
|
|
||||||
|
// dbTarget is retained so the engine can reach the archive
|
||||||
|
// writer registry for webhook eviction and the idle sweep.
|
||||||
|
dbTarget *databaseTarget
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates and registers the delivery engine with the
|
// New creates and registers the delivery engine with the
|
||||||
@@ -182,6 +203,19 @@ func (e *Engine) Notify(tasks []Task) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// EvictWebhook implements WebhookEvictor. It releases the
|
||||||
|
// engine's per-webhook archiving state: the database target's
|
||||||
|
// cached archive writer is dropped from the registry and its
|
||||||
|
// file handle closed. The archive file itself is left on disk
|
||||||
|
// — it is long-term storage the operator owns.
|
||||||
|
func (e *Engine) EvictWebhook(webhookID string) {
|
||||||
|
if e.dbTarget == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
e.dbTarget.evict(webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
// ScheduleRetry schedules a task to be re-enqueued onto the
|
// ScheduleRetry schedules a task to be re-enqueued onto the
|
||||||
// retry channel after delay. It implements the Scheduler
|
// retry channel after delay. It implements the Scheduler
|
||||||
// interface the targets use to own their durable retries.
|
// interface the targets use to own their durable retries.
|
||||||
|
|||||||
@@ -7,10 +7,17 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/fx"
|
||||||
"gorm.io/gorm"
|
"gorm.io/gorm"
|
||||||
"sneak.berlin/go/webhooker/internal/database"
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ErrExportArchiveWriterEvicted exposes the sentinel returned by
|
||||||
|
// an evicted archive writer. It carries the Err prefix rather
|
||||||
|
// than this file's usual Export one because it is a sentinel
|
||||||
|
// error.
|
||||||
|
var ErrExportArchiveWriterEvicted = errArchiveWriterEvicted
|
||||||
|
|
||||||
// Exported constants for test access.
|
// Exported constants for test access.
|
||||||
const (
|
const (
|
||||||
ExportDeliveryChannelSize = deliveryChannelSize
|
ExportDeliveryChannelSize = deliveryChannelSize
|
||||||
@@ -328,6 +335,183 @@ func (e *ExportArchiveWriter) DB() *gorm.DB {
|
|||||||
return e.w.db
|
return e.w.db
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Path returns the archive file the writer owns.
|
||||||
|
func (e *ExportArchiveWriter) Path() string {
|
||||||
|
return e.w.path
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenExisting opens the archive without permitting creation,
|
||||||
|
// the way the idle sweep does.
|
||||||
|
func (e *ExportArchiveWriter) OpenExisting(
|
||||||
|
expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.openMode(archiveModeExisting, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SweepExpired runs an idle sweep of the archive.
|
||||||
|
func (e *ExportArchiveWriter) SweepExpired(
|
||||||
|
expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
return e.w.sweepExpired(expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Evict marks the writer evicted and closes its handle, exactly
|
||||||
|
// as leaving the registry does.
|
||||||
|
func (e *ExportArchiveWriter) Evict() {
|
||||||
|
e.w.evict()
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandleOpen reports whether the writer currently holds an open
|
||||||
|
// archive handle.
|
||||||
|
func (e *ExportArchiveWriter) HandleOpen() bool {
|
||||||
|
e.w.mu.Lock()
|
||||||
|
defer e.w.mu.Unlock()
|
||||||
|
|
||||||
|
return e.w.db != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Same reports whether both wrappers refer to the very same
|
||||||
|
// underlying archive writer, so a test can prove a registry entry
|
||||||
|
// is the writer it was handed rather than a replacement.
|
||||||
|
func (e *ExportArchiveWriter) Same(
|
||||||
|
other *ExportArchiveWriter,
|
||||||
|
) bool {
|
||||||
|
return other != nil && e.w == other.w
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportArchiveWriterFor returns the archive writer the registry
|
||||||
|
// currently caches for a webhook, or nil when none is cached. It
|
||||||
|
// never creates one, so a test can hold a reference to the very
|
||||||
|
// writer an eviction is about to detach.
|
||||||
|
func (e *Engine) ExportArchiveWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) *ExportArchiveWriter {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
defer e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
w, ok := e.dbTarget.writers[webhookID]
|
||||||
|
if !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExportArchiveWriter{w: w}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportHasArchiveWriter reports whether the database target
|
||||||
|
// currently caches an archive writer for a webhook.
|
||||||
|
func (e *Engine) ExportHasArchiveWriter(
|
||||||
|
webhookID string,
|
||||||
|
) bool {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
defer e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
_, ok := e.dbTarget.writers[webhookID]
|
||||||
|
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportArchiveHandleOpen reports whether the cached archive
|
||||||
|
// writer for a webhook holds an open database handle. It
|
||||||
|
// returns false when no writer is cached.
|
||||||
|
func (e *Engine) ExportArchiveHandleOpen(
|
||||||
|
webhookID string,
|
||||||
|
) bool {
|
||||||
|
e.dbTarget.mu.Lock()
|
||||||
|
w, ok := e.dbTarget.writers[webhookID]
|
||||||
|
e.dbTarget.mu.Unlock()
|
||||||
|
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
return w.db != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportEnsureArchiveWriter creates (if needed) and returns the
|
||||||
|
// archive file path of the cached writer for a webhook, so a
|
||||||
|
// test can prime the registry the way a delivery would.
|
||||||
|
func (e *Engine) ExportEnsureArchiveWriter(
|
||||||
|
webhookID string,
|
||||||
|
) (string, error) {
|
||||||
|
w, err := e.dbTarget.writerFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.path, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSweepWriterFor takes a webhook's registry writer exactly
|
||||||
|
// as the idle sweep does, reporting whether the sweep had to
|
||||||
|
// create the entry. It lets a test drive the registry through the
|
||||||
|
// sweep's own entry point instead of choreographing goroutines.
|
||||||
|
func (e *Engine) ExportSweepWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) (*ExportArchiveWriter, bool, error) {
|
||||||
|
w, created, err := e.dbTarget.sweepWriterFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExportArchiveWriter{w: w}, created, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportReleaseSweepWriter releases a sweep-created registry entry
|
||||||
|
// exactly as a finished sweep does.
|
||||||
|
func (e *Engine) ExportReleaseSweepWriter(
|
||||||
|
webhookID string, w *ExportArchiveWriter,
|
||||||
|
) {
|
||||||
|
e.dbTarget.releaseSweepWriter(webhookID, w.w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewTestArchiveSweeper builds an ArchiveSweeper backed by the
|
||||||
|
// given main database and engine, without the fx lifecycle.
|
||||||
|
// Intended for tests.
|
||||||
|
func NewTestArchiveSweeper(
|
||||||
|
db *database.Database,
|
||||||
|
eng *Engine,
|
||||||
|
log *slog.Logger,
|
||||||
|
) *ArchiveSweeper {
|
||||||
|
return &ArchiveSweeper{
|
||||||
|
db: db,
|
||||||
|
eng: eng,
|
||||||
|
log: log,
|
||||||
|
interval: time.Hour,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSweep runs a single archive sweep synchronously for
|
||||||
|
// tests.
|
||||||
|
func (s *ArchiveSweeper) ExportSweep(ctx context.Context) {
|
||||||
|
s.sweep(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStart starts the sweeper's background loop for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportStart() {
|
||||||
|
s.start()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportRegisterHooks registers the sweeper's real fx lifecycle
|
||||||
|
// hooks on a lifecycle supplied by a test, so a test can drive
|
||||||
|
// the exact OnStart/OnStop functions the application runs and
|
||||||
|
// hand OnStart the kind of context fx actually supplies.
|
||||||
|
func (s *ArchiveSweeper) ExportRegisterHooks(lc fx.Lifecycle) {
|
||||||
|
s.registerHooks(lc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportStop stops the sweeper's background loop for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportStop() {
|
||||||
|
s.stop()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportSetInterval overrides the sweep interval for tests.
|
||||||
|
func (s *ArchiveSweeper) ExportSetInterval(d time.Duration) {
|
||||||
|
s.interval = d
|
||||||
|
}
|
||||||
|
|
||||||
// ExportParseArchiveExpiry exposes parseArchiveExpiry.
|
// ExportParseArchiveExpiry exposes parseArchiveExpiry.
|
||||||
func ExportParseArchiveExpiry(
|
func ExportParseArchiveExpiry(
|
||||||
configJSON string,
|
configJSON string,
|
||||||
|
|||||||
@@ -90,12 +90,15 @@ func (e *Engine) initTargets(client *http.Client) {
|
|||||||
client: client,
|
client: client,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
dbT := &databaseTarget{eng: e}
|
||||||
|
|
||||||
e.httpTarget = httpT
|
e.httpTarget = httpT
|
||||||
|
e.dbTarget = dbT
|
||||||
|
|
||||||
e.targets = map[database.TargetType]Target{
|
e.targets = map[database.TargetType]Target{
|
||||||
database.TargetTypeHTTP: httpT,
|
database.TargetTypeHTTP: httpT,
|
||||||
database.TargetTypeSlack: slackT,
|
database.TargetTypeSlack: slackT,
|
||||||
database.TargetTypeDatabase: &databaseTarget{eng: e},
|
database.TargetTypeDatabase: dbT,
|
||||||
database.TargetTypeLog: &logTarget{eng: e},
|
database.TargetTypeLog: &logTarget{eng: e},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sync"
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
"gorm.io/gorm"
|
"gorm.io/gorm"
|
||||||
"sneak.berlin/go/webhooker/internal/database"
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
@@ -111,15 +112,11 @@ func (t *databaseTarget) archive(d *database.Delivery) error {
|
|||||||
func (t *databaseTarget) writerFor(
|
func (t *databaseTarget) writerFor(
|
||||||
webhookID string,
|
webhookID string,
|
||||||
) (*archiveWriter, error) {
|
) (*archiveWriter, error) {
|
||||||
if t.eng.dbManager == nil {
|
path, err := t.archivePath(webhookID)
|
||||||
return nil, errArchiveNoDataDir
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
dir := filepath.Dir(t.eng.dbManager.DBPath(webhookID))
|
|
||||||
path := filepath.Join(
|
|
||||||
dir, fmt.Sprintf("archive-%s.db", webhookID),
|
|
||||||
)
|
|
||||||
|
|
||||||
t.mu.Lock()
|
t.mu.Lock()
|
||||||
defer t.mu.Unlock()
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
@@ -133,5 +130,166 @@ func (t *databaseTarget) writerFor(
|
|||||||
t.writers[webhookID] = w
|
t.writers[webhookID] = w
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A delivery claims the entry: even if the idle sweep created
|
||||||
|
// it moments ago, it now belongs to the registry proper and
|
||||||
|
// the sweep must leave it in place when it finishes.
|
||||||
|
w.sweepOwned = false
|
||||||
|
|
||||||
return w, nil
|
return w, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// sweepWriterFor returns the archive writer the idle sweep should
|
||||||
|
// prune a webhook through, together with whether the sweep itself
|
||||||
|
// created the registry entry.
|
||||||
|
//
|
||||||
|
// The sweep must route its prune through the registered writer so
|
||||||
|
// the writer's mutex orders it against concurrent writes, but it
|
||||||
|
// must never leave a registry entry behind: a sweep that ran
|
||||||
|
// concurrently with the webhook's deletion would otherwise
|
||||||
|
// re-create an entry that nothing will ever evict again, which is
|
||||||
|
// exactly the leak eviction exists to prevent. An entry the sweep
|
||||||
|
// creates is therefore marked sweep-owned and handed back to
|
||||||
|
// releaseSweepWriter when the sweep is done.
|
||||||
|
func (t *databaseTarget) sweepWriterFor(
|
||||||
|
webhookID string,
|
||||||
|
) (*archiveWriter, bool, error) {
|
||||||
|
path, err := t.archivePath(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
if t.writers == nil {
|
||||||
|
t.writers = make(map[string]*archiveWriter)
|
||||||
|
}
|
||||||
|
|
||||||
|
w, ok := t.writers[webhookID]
|
||||||
|
if ok {
|
||||||
|
return w, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
w = newArchiveWriter(path, t.eng.log)
|
||||||
|
w.sweepOwned = true
|
||||||
|
t.writers[webhookID] = w
|
||||||
|
|
||||||
|
return w, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// releaseSweepWriter drops a registry entry that the idle sweep
|
||||||
|
// created, so a sweep leaves the registry exactly as it found it.
|
||||||
|
//
|
||||||
|
// The entry is removed only if it is still the very writer the
|
||||||
|
// sweep installed and no delivery has claimed it in the meantime
|
||||||
|
// (writerFor clears sweepOwned when it hands a writer to the
|
||||||
|
// write path). Both conditions are evaluated under the registry
|
||||||
|
// lock, so an eviction that raced the sweep — which removes the
|
||||||
|
// entry outright — simply finds nothing left to do here, and a
|
||||||
|
// delivery that adopted the writer keeps a registered, evictable
|
||||||
|
// one.
|
||||||
|
func (t *databaseTarget) releaseSweepWriter(
|
||||||
|
webhookID string, w *archiveWriter,
|
||||||
|
) {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
cur, ok := t.writers[webhookID]
|
||||||
|
if !ok || cur != w || !cur.sweepOwned {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
delete(t.writers, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePath returns the archive file path for a webhook: it
|
||||||
|
// lives beside the per-webhook event database in the data
|
||||||
|
// directory. It does not touch the filesystem.
|
||||||
|
func (t *databaseTarget) archivePath(
|
||||||
|
webhookID string,
|
||||||
|
) (string, error) {
|
||||||
|
if t.eng.dbManager == nil {
|
||||||
|
return "", errArchiveNoDataDir
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := filepath.Dir(t.eng.dbManager.DBPath(webhookID))
|
||||||
|
|
||||||
|
return filepath.Join(
|
||||||
|
dir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// evict drops a webhook's archive writer from the registry and
|
||||||
|
// closes its handle, so a deleted webhook does not leave a
|
||||||
|
// writer (and an open archive handle within its debounce
|
||||||
|
// window) alive for the process lifetime.
|
||||||
|
//
|
||||||
|
// The map entry is removed under the registry lock, which is
|
||||||
|
// then released before the handle is closed under the writer's
|
||||||
|
// own lock: that ordering keeps the registry available to other
|
||||||
|
// webhooks while an in-flight write on this one drains, and
|
||||||
|
// closing under the writer's lock means eviction can never race
|
||||||
|
// a write.
|
||||||
|
//
|
||||||
|
// Eviction is idempotent and silent for a webhook with no
|
||||||
|
// writer, which is the common case: a webhook with no database
|
||||||
|
// target never creates one. It never deletes the archive file.
|
||||||
|
func (t *databaseTarget) evict(webhookID string) {
|
||||||
|
t.mu.Lock()
|
||||||
|
|
||||||
|
w, ok := t.writers[webhookID]
|
||||||
|
if ok {
|
||||||
|
delete(t.writers, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.mu.Unlock()
|
||||||
|
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.evict()
|
||||||
|
|
||||||
|
t.eng.log.Info(
|
||||||
|
"evicted archive writer",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"path", w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweepWebhook prunes one webhook's archive of rows older than
|
||||||
|
// expiry, without requiring a write. It returns nil (nothing to
|
||||||
|
// do) when the archive file does not exist, so a sweep never
|
||||||
|
// creates an archive for a webhook that has a database target
|
||||||
|
// but has never received an event.
|
||||||
|
//
|
||||||
|
// It also never leaves a registry entry behind: an entry it had
|
||||||
|
// to create to reach the writer's mutex is released again once
|
||||||
|
// the prune is done, so a sweep racing a webhook deletion cannot
|
||||||
|
// resurrect the writer the eviction just dropped.
|
||||||
|
func (t *databaseTarget) sweepWebhook(
|
||||||
|
webhookID string, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
path, err := t.archivePath(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check before taking a writer at all: a webhook whose
|
||||||
|
// archive has never been created gets no writer, no handle,
|
||||||
|
// and no file.
|
||||||
|
if !fileExists(path) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
w, created, err := t.sweepWriterFor(webhookID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if created {
|
||||||
|
defer t.releaseSweepWriter(webhookID, w)
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.sweepExpired(expiry)
|
||||||
|
}
|
||||||
|
|||||||
@@ -24,6 +24,20 @@ const archiveExpiryNever = "never"
|
|||||||
// offline archiving, but never more than once per this window.
|
// offline archiving, but never more than once per this window.
|
||||||
const archiveReopenDebounce = time.Second
|
const archiveReopenDebounce = time.Second
|
||||||
|
|
||||||
|
const (
|
||||||
|
// archiveModeCreate is the SQLite URI mode used by the write
|
||||||
|
// path: open the archive file, creating it if missing, so a
|
||||||
|
// first write (or a write after the operator moved the file
|
||||||
|
// away) recreates it.
|
||||||
|
archiveModeCreate = "rwc"
|
||||||
|
|
||||||
|
// archiveModeExisting is the SQLite URI mode used by the idle
|
||||||
|
// sweep: open read-write but never create. A sweep must never
|
||||||
|
// conjure an empty archive file for a webhook that has a
|
||||||
|
// database target but has never received an event.
|
||||||
|
archiveModeExisting = "rw"
|
||||||
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// errArchiveMissingWebhookID is returned when an event to
|
// errArchiveMissingWebhookID is returned when an event to
|
||||||
// archive has no webhook id to key its archive file on.
|
// archive has no webhook id to key its archive file on.
|
||||||
@@ -44,6 +58,15 @@ var (
|
|||||||
errArchiveExpiryNotPositive = errors.New(
|
errArchiveExpiryNotPositive = errors.New(
|
||||||
"expiry must be a positive duration or \"never\"",
|
"expiry must be a positive duration or \"never\"",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// errArchiveWriterEvicted is returned when a writer that has
|
||||||
|
// been evicted (its webhook was deleted, or its last database
|
||||||
|
// target was removed) is used again. An evicted writer is no
|
||||||
|
// longer in the registry, so reopening its file would leak a
|
||||||
|
// handle nothing owns.
|
||||||
|
errArchiveWriterEvicted = errors.New(
|
||||||
|
"archive writer has been evicted",
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
// databaseTargetConfig is the optional per-target JSON config
|
// databaseTargetConfig is the optional per-target JSON config
|
||||||
@@ -161,6 +184,25 @@ type archiveWriter struct {
|
|||||||
db *gorm.DB
|
db *gorm.DB
|
||||||
lastReopen time.Time
|
lastReopen time.Time
|
||||||
reopens int
|
reopens int
|
||||||
|
|
||||||
|
// evicted marks a writer that has been removed from the
|
||||||
|
// per-webhook registry. Its handle is closed and it must
|
||||||
|
// never open the file again: nothing holds it any more, so a
|
||||||
|
// reopen would leak the handle for the process lifetime.
|
||||||
|
evicted bool
|
||||||
|
|
||||||
|
// sweepOwned marks a registry entry that the idle sweep
|
||||||
|
// created because no writer was cached for the webhook. The
|
||||||
|
// sweep removes such an entry again when it is done, so a
|
||||||
|
// sweep can never leave — or resurrect — a registry entry
|
||||||
|
// for a webhook that has been deleted. A delivery that adopts
|
||||||
|
// the writer clears the flag, handing the entry to the
|
||||||
|
// registry proper.
|
||||||
|
//
|
||||||
|
// Unlike every other field here it is guarded by
|
||||||
|
// databaseTarget.mu, not by this writer's mu: it describes the
|
||||||
|
// registry entry rather than the file.
|
||||||
|
sweepOwned bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// newArchiveWriter builds an archiveWriter for a file path with
|
// newArchiveWriter builds an archiveWriter for a file path with
|
||||||
@@ -185,6 +227,12 @@ func (w *archiveWriter) write(
|
|||||||
w.mu.Lock()
|
w.mu.Lock()
|
||||||
defer w.mu.Unlock()
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
if w.evicted {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %s", errArchiveWriterEvicted, w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
if w.db == nil || !fileExists(w.path) {
|
if w.db == nil || !fileExists(w.path) {
|
||||||
err := w.reopen(expiry)
|
err := w.reopen(expiry)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -212,7 +260,19 @@ func (w *archiveWriter) write(
|
|||||||
// its schema, records the reopen time, and prunes expired rows
|
// its schema, records the reopen time, and prunes expired rows
|
||||||
// when expiry is positive.
|
// when expiry is positive.
|
||||||
func (w *archiveWriter) open(expiry time.Duration) error {
|
func (w *archiveWriter) open(expiry time.Duration) error {
|
||||||
dbURL := fmt.Sprintf("file:%s?mode=rwc", w.path)
|
return w.openMode(archiveModeCreate, expiry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// openMode opens the archive file with the given SQLite URI
|
||||||
|
// mode, migrates its schema, records the reopen time, and
|
||||||
|
// prunes expired rows when expiry is positive. The write path
|
||||||
|
// passes archiveModeCreate so a missing file is recreated; the
|
||||||
|
// idle sweep passes archiveModeExisting so a missing file is an
|
||||||
|
// error rather than a newly conjured empty archive.
|
||||||
|
func (w *archiveWriter) openMode(
|
||||||
|
mode string, expiry time.Duration,
|
||||||
|
) error {
|
||||||
|
dbURL := fmt.Sprintf("file:%s?mode=%s", w.path, mode)
|
||||||
|
|
||||||
sqlDB, err := sql.Open("sqlite", dbURL)
|
sqlDB, err := sql.Open("sqlite", dbURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -275,11 +335,70 @@ func (w *archiveWriter) close() {
|
|||||||
w.db = nil
|
w.db = nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// sweepExpired prunes an archive that may have gone idle, with
|
||||||
|
// no write to trigger the usual on-reopen prune. It takes the
|
||||||
|
// writer's own mutex for the whole operation, so a sweep is
|
||||||
|
// ordered against concurrent writes rather than reaching around
|
||||||
|
// them to the file.
|
||||||
|
//
|
||||||
|
// It never creates the archive file: a missing file is skipped,
|
||||||
|
// and the reopen uses archiveModeExisting so SQLite itself
|
||||||
|
// refuses to create one if the file disappears between the
|
||||||
|
// check and the open.
|
||||||
|
//
|
||||||
|
// The archive is left CLOSED afterwards. An idle archive holding
|
||||||
|
// no handle is what keeps the operator's move-the-file-away
|
||||||
|
// workflow working; the next write reopens (and recreates) the
|
||||||
|
// file as it always has.
|
||||||
|
func (w *archiveWriter) sweepExpired(expiry time.Duration) error {
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
if w.evicted {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"%w: %s", errArchiveWriterEvicted, w.path,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !fileExists(w.path) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drop any live handle first so the prune runs against a
|
||||||
|
// freshly opened file, matching the write path's semantics.
|
||||||
|
w.close()
|
||||||
|
|
||||||
|
err := w.openMode(archiveModeExisting, expiry)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
w.close()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// evict closes the writer's handle and marks it unusable. It is
|
||||||
|
// called when the writer leaves the registry, either because the
|
||||||
|
// webhook was deleted or because its last database target was
|
||||||
|
// removed. The archive FILE is deliberately left on disk: it is
|
||||||
|
// long-term storage an operator may still want.
|
||||||
|
func (w *archiveWriter) evict() {
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
|
||||||
|
w.evicted = true
|
||||||
|
|
||||||
|
w.close()
|
||||||
|
}
|
||||||
|
|
||||||
// prune deletes archived rows older than expiry, measured from
|
// prune deletes archived rows older than expiry, measured from
|
||||||
// each row's archived time. It runs on every (re)open, and
|
// each row's archived time. It runs on every (re)open, so a
|
||||||
// because the file is reopened after writes this keeps the
|
// steadily written archive is swept by its own write traffic. An
|
||||||
// archive swept without a separate background sweeper. Failures
|
// archive that goes idle receives no further reopens, which is
|
||||||
// are logged, not fatal: a prune error must not stop archiving.
|
// why ArchiveSweeper exists to drive sweepExpired on a timer.
|
||||||
|
// Failures are logged, not fatal: a prune error must not stop
|
||||||
|
// archiving.
|
||||||
func (w *archiveWriter) prune(expiry time.Duration) {
|
func (w *archiveWriter) prune(expiry time.Duration) {
|
||||||
cutoff := time.Now().Add(-expiry)
|
cutoff := time.Now().Add(-expiry)
|
||||||
|
|
||||||
|
|||||||
363
internal/delivery/target_database_evict_test.go
Normal file
363
internal/delivery/target_database_evict_test.go
Normal file
@@ -0,0 +1,363 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// evictTestEngine builds an engine backed by a temporary data
|
||||||
|
// directory and returns it along with that directory.
|
||||||
|
func evictTestEngine(t *testing.T) (*delivery.Engine, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
|
||||||
|
eng := delivery.NewTestEngineWithDB(
|
||||||
|
nil,
|
||||||
|
database.NewTestWebhookDBManager(dataDir),
|
||||||
|
archiveTestLogger(),
|
||||||
|
&http.Client{Timeout: 5 * time.Second},
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
return eng, dataDir
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_ClosesAndRemovesWriter proves that evicting
|
||||||
|
// a webhook drops its archive writer from the registry and
|
||||||
|
// closes the open archive handle, rather than leaving both
|
||||||
|
// alive for the process lifetime.
|
||||||
|
func TestEvictWebhook_ClosesAndRemovesWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, dataDir := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
webhookID := event.WebhookID
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"a delivery should have cached an archive writer",
|
||||||
|
)
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"the writer should hold an open handle after a write",
|
||||||
|
)
|
||||||
|
|
||||||
|
eng.EvictWebhook(webhookID)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter(webhookID),
|
||||||
|
"eviction should remove the registry entry",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportArchiveHandleOpen(webhookID),
|
||||||
|
"eviction should close the archive handle",
|
||||||
|
)
|
||||||
|
|
||||||
|
archivePath := filepath.Join(
|
||||||
|
dataDir, fmt.Sprintf("archive-%s.db", webhookID),
|
||||||
|
)
|
||||||
|
assert.FileExists(
|
||||||
|
t, archivePath,
|
||||||
|
"eviction must not delete the archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_UnknownWebhookIsNoOp proves eviction is safe
|
||||||
|
// for the common case of a webhook that never had a database
|
||||||
|
// target, and that repeating it does not panic.
|
||||||
|
func TestEvictWebhook_UnknownWebhookIsNoOp(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
assert.NotPanics(t, func() {
|
||||||
|
eng.EvictWebhook("no-such-webhook")
|
||||||
|
eng.EvictWebhook("no-such-webhook")
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter("no-such-webhook"),
|
||||||
|
"eviction must not create a writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// evictTestRow builds an archive row for the eviction tests.
|
||||||
|
func evictTestRow(eventID string) delivery.ExportArchivedEvent {
|
||||||
|
return delivery.ExportArchivedEvent{
|
||||||
|
EventID: eventID,
|
||||||
|
WebhookID: "wh-evict",
|
||||||
|
Method: http.MethodPost,
|
||||||
|
Body: `{"seeded":true}`,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictedWriter_WriteDoesNotReopenFile is the direct test of
|
||||||
|
// the evicted guard on the write path. A writer that has left
|
||||||
|
// the registry is held by nobody, so a handle it opened could
|
||||||
|
// never be closed again: it must refuse the write outright
|
||||||
|
// rather than recreate the archive behind the registry's back.
|
||||||
|
//
|
||||||
|
// The archive file is removed before the eviction, so an
|
||||||
|
// unguarded write is unmistakable — it recreates the file.
|
||||||
|
func TestEvictedWriter_WriteDoesNotReopenFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-evicted.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(evictTestRow("ev-1"), 0))
|
||||||
|
require.FileExists(t, path)
|
||||||
|
|
||||||
|
// The operator moves the archive away for offline retention,
|
||||||
|
// which the write path would ordinarily undo on the next
|
||||||
|
// write by recreating the file.
|
||||||
|
require.NoError(t, os.Remove(path))
|
||||||
|
|
||||||
|
w.Evict()
|
||||||
|
|
||||||
|
err := w.Write(evictTestRow("ev-2"), 0)
|
||||||
|
|
||||||
|
require.ErrorIs(
|
||||||
|
t, err, delivery.ErrExportArchiveWriterEvicted,
|
||||||
|
"an evicted writer must refuse writes",
|
||||||
|
)
|
||||||
|
assert.NoFileExists(
|
||||||
|
t, path,
|
||||||
|
"an evicted writer must not reopen (or recreate) the "+
|
||||||
|
"archive file",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"an evicted writer must hold no handle",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictedWriter_SweepDoesNotReopenFile is the same test for
|
||||||
|
// the sweep path: an idle sweep that reaches a writer already
|
||||||
|
// evicted underneath it must return the sentinel rather than
|
||||||
|
// reopen a file nothing owns.
|
||||||
|
func TestEvictedWriter_SweepDoesNotReopenFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "archive-evicted.db")
|
||||||
|
|
||||||
|
w := delivery.NewExportArchiveWriter(
|
||||||
|
path, archiveTestLogger(), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NoError(t, w.Write(evictTestRow("ev-1"), 0))
|
||||||
|
require.FileExists(t, path)
|
||||||
|
|
||||||
|
w.Evict()
|
||||||
|
|
||||||
|
err := w.SweepExpired(time.Hour)
|
||||||
|
|
||||||
|
require.ErrorIs(
|
||||||
|
t, err, delivery.ErrExportArchiveWriterEvicted,
|
||||||
|
"an evicted writer must refuse an idle sweep",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"a refused sweep must not leave a handle open",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// racingWrites drives a pack of goroutines writing to one
|
||||||
|
// archive writer until each is refused, so an eviction on the
|
||||||
|
// test goroutine has to take the writer's mutex away from writes
|
||||||
|
// that are already contending for it.
|
||||||
|
type racingWrites struct {
|
||||||
|
wg sync.WaitGroup
|
||||||
|
mu sync.Mutex
|
||||||
|
sawEvicted bool
|
||||||
|
otherErr error
|
||||||
|
started chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// racingWriteGoroutines is how many goroutines contend for the
|
||||||
|
// writer's mutex while the eviction lands.
|
||||||
|
const racingWriteGoroutines = 4
|
||||||
|
|
||||||
|
// startRacingWrites launches the writing goroutines. Each writes
|
||||||
|
// in a loop and stops at its first error, recording whether that
|
||||||
|
// error was the eviction sentinel. The deadline is a backstop
|
||||||
|
// against a hang, not a timing assumption: the first write after
|
||||||
|
// the eviction is refused.
|
||||||
|
func startRacingWrites(
|
||||||
|
w *delivery.ExportArchiveWriter,
|
||||||
|
) *racingWrites {
|
||||||
|
r := &racingWrites{
|
||||||
|
started: make(chan struct{}, racingWriteGoroutines),
|
||||||
|
}
|
||||||
|
|
||||||
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
|
|
||||||
|
r.wg.Add(racingWriteGoroutines)
|
||||||
|
|
||||||
|
for i := range racingWriteGoroutines {
|
||||||
|
go func() {
|
||||||
|
defer r.wg.Done()
|
||||||
|
|
||||||
|
first := true
|
||||||
|
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
err := w.Write(
|
||||||
|
evictTestRow(fmt.Sprintf("ev-%d", i)), 0,
|
||||||
|
)
|
||||||
|
|
||||||
|
if first {
|
||||||
|
r.started <- struct{}{}
|
||||||
|
|
||||||
|
first = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if err == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
r.record(err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// record classifies the error that stopped one goroutine.
|
||||||
|
func (r *racingWrites) record(err error) {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
if errors.Is(err, delivery.ErrExportArchiveWriterEvicted) {
|
||||||
|
r.sawEvicted = true
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
r.otherErr = err
|
||||||
|
}
|
||||||
|
|
||||||
|
// awaitFirstWrite blocks until at least one write has run, so
|
||||||
|
// the eviction that follows is a genuine race.
|
||||||
|
func (r *racingWrites) awaitFirstWrite() {
|
||||||
|
<-r.started
|
||||||
|
}
|
||||||
|
|
||||||
|
// wait joins the goroutines and reports whether any write was
|
||||||
|
// refused with the eviction sentinel, plus any unexpected error.
|
||||||
|
func (r *racingWrites) wait() (bool, error) {
|
||||||
|
r.wg.Wait()
|
||||||
|
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
return r.sawEvicted, r.otherErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_RacingWriteDoesNotReopenHandle exercises the
|
||||||
|
// interleaving the evicted flag exists for: writes already
|
||||||
|
// contending for the writer's mutex when the eviction takes it.
|
||||||
|
// The write that wins the mutex after the eviction must abandon
|
||||||
|
// its work rather than reopen the archive, leaving the writer
|
||||||
|
// permanently handle-free. Run under -race.
|
||||||
|
func TestEvictWebhook_RacingWriteDoesNotReopenHandle(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
// Prime the registry so the test can hold the very writer the
|
||||||
|
// eviction is about to detach.
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
|
||||||
|
w := eng.ExportArchiveWriterFor(event.WebhookID)
|
||||||
|
require.NotNil(t, w)
|
||||||
|
require.True(t, w.HandleOpen())
|
||||||
|
|
||||||
|
race := startRacingWrites(w)
|
||||||
|
|
||||||
|
// Evict only once writes are genuinely in flight, so the
|
||||||
|
// eviction has to contend for the writer's mutex.
|
||||||
|
race.awaitFirstWrite()
|
||||||
|
|
||||||
|
eng.EvictWebhook(event.WebhookID)
|
||||||
|
|
||||||
|
sawEvicted, otherErr := race.wait()
|
||||||
|
|
||||||
|
require.NoError(t, otherErr)
|
||||||
|
assert.True(
|
||||||
|
t, sawEvicted,
|
||||||
|
"a write after eviction must be refused",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, w.HandleOpen(),
|
||||||
|
"no write may reopen the archive once the writer has "+
|
||||||
|
"been evicted",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
"the registry entry must stay gone",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestEvictWebhook_LaterDeliveryRecreatesWriter proves eviction
|
||||||
|
// does not break archiving for a webhook that is still alive: a
|
||||||
|
// subsequent delivery gets a brand new writer from the registry.
|
||||||
|
// It says nothing about the evicted writer itself — that is what
|
||||||
|
// TestEvictedWriter_WriteDoesNotReopenFile covers.
|
||||||
|
func TestEvictWebhook_LaterDeliveryRecreatesWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
eng, _ := evictTestEngine(t)
|
||||||
|
|
||||||
|
webhookDB := testWebhookDB(t)
|
||||||
|
event := seedEvent(t, webhookDB, `{"archived":true}`)
|
||||||
|
d := seedDatabaseTargetDelivery(t, webhookDB, event, "")
|
||||||
|
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, d)
|
||||||
|
require.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
)
|
||||||
|
|
||||||
|
eng.EvictWebhook(event.WebhookID)
|
||||||
|
|
||||||
|
// A fresh delivery for the same webhook gets a brand new
|
||||||
|
// writer from the registry, so archiving keeps working.
|
||||||
|
second := seedDatabaseTargetDelivery(
|
||||||
|
t, webhookDB, event, "",
|
||||||
|
)
|
||||||
|
eng.ExportDeliverDatabase(webhookDB, second)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, eng.ExportHasArchiveWriter(event.WebhookID),
|
||||||
|
"a later delivery should recreate the writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -50,6 +50,13 @@ func openArchiveDBForRead(
|
|||||||
return gdb
|
return gdb
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// archiveFileSuffixes returns the archive file itself and the
|
||||||
|
// SQLite sidecars that accompany an open database. A test that
|
||||||
|
// asserts no archive was created has to check all of them.
|
||||||
|
func archiveFileSuffixes() []string {
|
||||||
|
return []string{"", "-wal", "-shm"}
|
||||||
|
}
|
||||||
|
|
||||||
// removeArchiveFiles simulates an operator moving the archive
|
// removeArchiveFiles simulates an operator moving the archive
|
||||||
// away by deleting the SQLite file and its sidecar files.
|
// away by deleting the SQLite file and its sidecar files.
|
||||||
func removeArchiveFiles(t *testing.T, path string) {
|
func removeArchiveFiles(t *testing.T, path string) {
|
||||||
|
|||||||
@@ -26,6 +26,8 @@ const (
|
|||||||
maxBodyShift = 20
|
maxBodyShift = 20
|
||||||
// recentEventLimit is the number of recent events to show.
|
// recentEventLimit is the number of recent events to show.
|
||||||
recentEventLimit = 20
|
recentEventLimit = 20
|
||||||
|
// defaultRetentionDays is the default event retention period.
|
||||||
|
defaultRetentionDays = 30
|
||||||
// paginationPerPage is the number of items per page.
|
// paginationPerPage is the number of items per page.
|
||||||
paginationPerPage = 25
|
paginationPerPage = 25
|
||||||
|
|
||||||
@@ -49,6 +51,7 @@ type HandlersParams struct {
|
|||||||
Healthcheck *healthcheck.Healthcheck
|
Healthcheck *healthcheck.Healthcheck
|
||||||
Session *session.Session
|
Session *session.Session
|
||||||
Notifier delivery.Notifier
|
Notifier delivery.Notifier
|
||||||
|
Evictor delivery.WebhookEvictor
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handlers provides HTTP handler methods for all application
|
// Handlers provides HTTP handler methods for all application
|
||||||
@@ -61,6 +64,7 @@ type Handlers struct {
|
|||||||
dbMgr *database.WebhookDBManager
|
dbMgr *database.WebhookDBManager
|
||||||
session *session.Session
|
session *session.Session
|
||||||
notifier delivery.Notifier
|
notifier delivery.Notifier
|
||||||
|
evictor delivery.WebhookEvictor
|
||||||
templates map[string]*template.Template
|
templates map[string]*template.Template
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,6 +99,7 @@ func New(
|
|||||||
s.dbMgr = params.WebhookDBMgr
|
s.dbMgr = params.WebhookDBMgr
|
||||||
s.session = params.Session
|
s.session = params.Session
|
||||||
s.notifier = params.Notifier
|
s.notifier = params.Notifier
|
||||||
|
s.evictor = params.Evictor
|
||||||
|
|
||||||
// Parse all page templates once at startup
|
// Parse all page templates once at startup
|
||||||
s.templates = map[string]*template.Template{
|
s.templates = map[string]*template.Template{
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -24,6 +25,32 @@ type noopNotifier struct{}
|
|||||||
|
|
||||||
func (n *noopNotifier) Notify([]delivery.Task) {}
|
func (n *noopNotifier) Notify([]delivery.Task) {}
|
||||||
|
|
||||||
|
// recordingEvictor is a delivery.WebhookEvictor that records
|
||||||
|
// the webhook ids it was asked to evict, so a test can prove
|
||||||
|
// that a deletion path reached the delivery engine.
|
||||||
|
type recordingEvictor struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
evicted []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recordingEvictor) EvictWebhook(webhookID string) {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
r.evicted = append(r.evicted, webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Evicted returns a copy of the recorded webhook ids.
|
||||||
|
func (r *recordingEvictor) Evicted() []string {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
|
||||||
|
out := make([]string, len(r.evicted))
|
||||||
|
copy(out, r.evicted)
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func newTestApp(
|
func newTestApp(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
targets ...any,
|
targets ...any,
|
||||||
@@ -47,6 +74,12 @@ func newTestApp(
|
|||||||
func() delivery.Notifier {
|
func() delivery.Notifier {
|
||||||
return &noopNotifier{}
|
return &noopNotifier{}
|
||||||
},
|
},
|
||||||
|
func() *recordingEvictor {
|
||||||
|
return &recordingEvictor{}
|
||||||
|
},
|
||||||
|
func(r *recordingEvictor) delivery.WebhookEvictor {
|
||||||
|
return r
|
||||||
|
},
|
||||||
handlers.New,
|
handlers.New,
|
||||||
),
|
),
|
||||||
fx.Populate(targets...),
|
fx.Populate(targets...),
|
||||||
|
|||||||
356
internal/handlers/source_delete_test.go
Normal file
356
internal/handlers/source_delete_test.go
Normal file
@@ -0,0 +1,356 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/go-chi/chi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"gorm.io/gorm/clause"
|
||||||
|
"sneak.berlin/go/webhooker/internal/database"
|
||||||
|
"sneak.berlin/go/webhooker/internal/handlers"
|
||||||
|
"sneak.berlin/go/webhooker/internal/session"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
deleteTestUserID = "test-user-id"
|
||||||
|
deleteTestUsername = "testuser"
|
||||||
|
|
||||||
|
// paramSourceID and paramTargetID are the chi URL parameter
|
||||||
|
// names the deletion handlers read.
|
||||||
|
paramSourceID = "sourceID"
|
||||||
|
paramTargetID = "targetID"
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedWebhook inserts a webhook owned by the test user and
|
||||||
|
// returns it.
|
||||||
|
func seedWebhook(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
) *database.Webhook {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
wh := &database.Webhook{
|
||||||
|
UserID: deleteTestUserID,
|
||||||
|
Name: "delete-me",
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(wh).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return wh
|
||||||
|
}
|
||||||
|
|
||||||
|
// seedTarget inserts a target of the given type for a webhook
|
||||||
|
// and returns it.
|
||||||
|
func seedTarget(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.Database,
|
||||||
|
webhookID string,
|
||||||
|
targetType database.TargetType,
|
||||||
|
) *database.Target {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
tgt := &database.Target{
|
||||||
|
WebhookID: webhookID,
|
||||||
|
Name: "t-" + string(targetType),
|
||||||
|
Type: targetType,
|
||||||
|
Active: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
db.DB().Omit(clause.Associations).Create(tgt).Error,
|
||||||
|
)
|
||||||
|
|
||||||
|
return tgt
|
||||||
|
}
|
||||||
|
|
||||||
|
// archivePathFor returns the archive database path the
|
||||||
|
// delivery engine would use for a webhook: beside the webhook's
|
||||||
|
// event database in the data directory.
|
||||||
|
func archivePathFor(
|
||||||
|
t *testing.T,
|
||||||
|
mgr *database.WebhookDBManager,
|
||||||
|
webhookID string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
return filepath.Join(
|
||||||
|
filepath.Dir(mgr.DBPath(webhookID)),
|
||||||
|
"archive-"+webhookID+".db",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeArchivePlaceholder creates a stand-in archive file so a
|
||||||
|
// test can assert the file survives webhook deletion.
|
||||||
|
func writeArchivePlaceholder(path string) error {
|
||||||
|
return os.WriteFile(path, []byte("archive"), 0o600)
|
||||||
|
}
|
||||||
|
|
||||||
|
// postRequest builds an authenticated POST request carrying the
|
||||||
|
// given chi URL parameters.
|
||||||
|
func postRequest(
|
||||||
|
path string,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
params map[string]string,
|
||||||
|
) *http.Request {
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodPost, path, nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
rctx := chi.NewRouteContext()
|
||||||
|
for k, v := range params {
|
||||||
|
rctx.URLParams.Add(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
return req.WithContext(
|
||||||
|
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDelete_EvictsArchiveWriter proves that
|
||||||
|
// deleting a webhook reaches the delivery engine and releases
|
||||||
|
// the webhook's archive writer, exercised through the real
|
||||||
|
// deletion handler rather than by calling the evictor directly.
|
||||||
|
func TestHandleSourceDelete_EvictsArchiveWriter(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{paramSourceID: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleSourceDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{wh.ID}, ev.Evicted(),
|
||||||
|
"deleting a webhook should evict its archive writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleSourceDelete_KeepsArchiveFile proves that deleting
|
||||||
|
// a webhook does not remove its archive database file: the
|
||||||
|
// archive is long-term storage the operator owns.
|
||||||
|
func TestHandleSourceDelete_KeepsArchiveFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
mgr *database.WebhookDBManager
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &mgr)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
|
||||||
|
// Place an archive file where the delivery engine would.
|
||||||
|
archivePath := archivePathFor(t, mgr, wh.ID)
|
||||||
|
require.NoError(
|
||||||
|
t,
|
||||||
|
writeArchivePlaceholder(archivePath),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{paramSourceID: wh.ID},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleSourceDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.FileExists(
|
||||||
|
t, archivePath,
|
||||||
|
"webhook deletion must not destroy the archive file",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_EvictsWhenLastDatabaseTargetGone
|
||||||
|
// proves that removing the last database target releases the
|
||||||
|
// archive writer.
|
||||||
|
func TestHandleTargetDelete_EvictsWhenLastDatabaseTargetGone(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
tgt := seedTarget(
|
||||||
|
t, db, wh.ID, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+tgt.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: tgt.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(
|
||||||
|
t, []string{wh.ID}, ev.Evicted(),
|
||||||
|
"removing the last database target should evict",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_KeepsWriterWhenDatabaseTargetRemains
|
||||||
|
// proves that deleting one of several database targets leaves
|
||||||
|
// the still-needed archive writer alone: the surviving target
|
||||||
|
// keeps archiving to the same file, so the writer must stay.
|
||||||
|
func TestHandleTargetDelete_KeepsWriterWhenDatabaseTargetRemains(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
doomed := seedTarget(
|
||||||
|
t, db, wh.ID, database.TargetTypeDatabase,
|
||||||
|
)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+doomed.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: doomed.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Empty(
|
||||||
|
t, ev.Evicted(),
|
||||||
|
"a second database target still needs the writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleTargetDelete_KeepsWriterWhenOtherTypeDeleted proves
|
||||||
|
// that deleting a target of an unrelated type leaves a
|
||||||
|
// still-needed archive writer alone: the webhook's database
|
||||||
|
// target is untouched, so its writer must stay.
|
||||||
|
func TestHandleTargetDelete_KeepsWriterWhenOtherTypeDeleted(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var (
|
||||||
|
h *handlers.Handlers
|
||||||
|
sess *session.Session
|
||||||
|
db *database.Database
|
||||||
|
ev *recordingEvictor
|
||||||
|
)
|
||||||
|
|
||||||
|
app := newTestApp(t, &h, &sess, &db, &ev)
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
t.Cleanup(app.RequireStop)
|
||||||
|
|
||||||
|
wh := seedWebhook(t, db)
|
||||||
|
seedTarget(t, db, wh.ID, database.TargetTypeDatabase)
|
||||||
|
other := seedTarget(t, db, wh.ID, database.TargetTypeLog)
|
||||||
|
|
||||||
|
cookies := authenticatedCookies(
|
||||||
|
t, sess, deleteTestUserID, deleteTestUsername,
|
||||||
|
)
|
||||||
|
|
||||||
|
req := postRequest(
|
||||||
|
"/source/"+wh.ID+"/targets/"+other.ID+"/delete",
|
||||||
|
cookies,
|
||||||
|
map[string]string{
|
||||||
|
paramSourceID: wh.ID,
|
||||||
|
paramTargetID: other.ID,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
h.HandleTargetDelete().ServeHTTP(w, req)
|
||||||
|
|
||||||
|
require.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Empty(
|
||||||
|
t, ev.Evicted(),
|
||||||
|
"a surviving database target must keep its writer",
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -25,73 +25,6 @@ type WebhookListItem struct {
|
|||||||
// errMissingURL signals that a required URL was not provided.
|
// errMissingURL signals that a required URL was not provided.
|
||||||
var errMissingURL = errors.New("missing URL")
|
var errMissingURL = errors.New("missing URL")
|
||||||
|
|
||||||
// errInvalidRetention signals a retention_days form value that is not
|
|
||||||
// a non-negative whole number.
|
|
||||||
var errInvalidRetention = errors.New("invalid retention days")
|
|
||||||
|
|
||||||
// errRetentionTooLarge signals a retention_days form value that is a
|
|
||||||
// whole number but larger than the reaper's cutoff arithmetic can
|
|
||||||
// represent. It is distinguished from errInvalidRetention so the form
|
|
||||||
// can tell the user the actual ceiling instead of implying their input
|
|
||||||
// was not a number.
|
|
||||||
var errRetentionTooLarge = errors.New("retention days out of range")
|
|
||||||
|
|
||||||
// retentionErrorMessage returns the message the create and edit forms
|
|
||||||
// show the user for a rejected retention_days value. Any error other
|
|
||||||
// than errRetentionTooLarge falls back to the generic wording, so an
|
|
||||||
// unrecognised parse failure still produces a sensible 400 rather than
|
|
||||||
// an empty alert.
|
|
||||||
func retentionErrorMessage(err error) string {
|
|
||||||
if errors.Is(err, errRetentionTooLarge) {
|
|
||||||
return "Retention must be at most " +
|
|
||||||
strconv.Itoa(database.MaxFiniteRetentionDays) +
|
|
||||||
" days, or 0 to retain events forever."
|
|
||||||
}
|
|
||||||
|
|
||||||
return "Retention must be a whole number of days, or 0 to " +
|
|
||||||
"retain events forever."
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseRetentionDays interprets a retention_days form value.
|
|
||||||
//
|
|
||||||
// An empty value yields fallback, which lets the create path apply the
|
|
||||||
// default and the edit path leave the stored value unchanged. A value
|
|
||||||
// of 0 is returned as 0 and is rewritten to the retain-forever
|
|
||||||
// sentinel by database.Webhook's BeforeSave hook. Anything unparseable
|
|
||||||
// or negative is an error rather than a silently substituted default.
|
|
||||||
//
|
|
||||||
// The upper bound is not cosmetic. The reaper computes its cutoff as a
|
|
||||||
// time.Duration, an int64 nanosecond count, so a day count above
|
|
||||||
// database.MaxFiniteRetentionDays overflows, puts the cutoff in the
|
|
||||||
// future, and deletes every event the webhook has. A finite value
|
|
||||||
// above that ceiling is therefore a 400.
|
|
||||||
//
|
|
||||||
// A value at or above the retain-forever sentinel is not out of range:
|
|
||||||
// it is what the edit form pre-fills for a retain-forever webhook, so
|
|
||||||
// submitting the form back unchanged has to keep meaning "forever"
|
|
||||||
// rather than being rejected.
|
|
||||||
func parseRetentionDays(raw string, fallback int) (int, error) {
|
|
||||||
raw = strings.TrimSpace(raw)
|
|
||||||
if raw == "" {
|
|
||||||
return fallback, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
v, err := strconv.Atoi(raw)
|
|
||||||
if err != nil || v < 0 {
|
|
||||||
return 0, errInvalidRetention
|
|
||||||
}
|
|
||||||
|
|
||||||
if v >= database.RetentionForeverDays {
|
|
||||||
return database.RetentionForeverDays, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if v > database.MaxFiniteRetentionDays {
|
|
||||||
return 0, errRetentionTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// EventWithDeliveries holds an event and its deliveries.
|
// EventWithDeliveries holds an event and its deliveries.
|
||||||
type EventWithDeliveries struct {
|
type EventWithDeliveries struct {
|
||||||
database.Event
|
database.Event
|
||||||
@@ -173,30 +106,11 @@ func (h *Handlers) buildWebhookListItems(
|
|||||||
// HandleSourceCreate shows the form to create a new webhook.
|
// HandleSourceCreate shows the form to create a new webhook.
|
||||||
func (h *Handlers) HandleSourceCreate() http.HandlerFunc {
|
func (h *Handlers) HandleSourceCreate() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
h.renderTemplate(
|
data := map[string]any{
|
||||||
w, r, "sources_new.html",
|
tmplKeyError: "",
|
||||||
newSourceFormData("", "", ""),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// newSourceFormData builds the template data for the webhook creation
|
h.renderTemplate(w, r, "sources_new.html", data)
|
||||||
// form.
|
|
||||||
//
|
|
||||||
// It carries the retention default so the pre-filled value comes from
|
|
||||||
// database.DefaultRetentionDays rather than being a third hardcoded
|
|
||||||
// copy of the same policy, and it carries the submitted name and
|
|
||||||
// description so that re-rendering the form after a validation failure
|
|
||||||
// gives the user their input back instead of a blank form. The edit
|
|
||||||
// form already behaves that way; create now matches it.
|
|
||||||
func newSourceFormData(
|
|
||||||
errMsg, name, description string,
|
|
||||||
) map[string]any {
|
|
||||||
return map[string]any{
|
|
||||||
tmplKeyError: errMsg,
|
|
||||||
"Name": name,
|
|
||||||
"Description": description,
|
|
||||||
"DefaultRetentionDays": database.DefaultRetentionDays,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -231,31 +145,23 @@ func (h *Handlers) HandleSourceCreateSubmit() http.HandlerFunc {
|
|||||||
retentionStr := r.FormValue("retention_days")
|
retentionStr := r.FormValue("retention_days")
|
||||||
|
|
||||||
if name == "" {
|
if name == "" {
|
||||||
|
data := map[string]any{
|
||||||
|
tmplKeyError: "Name is required",
|
||||||
|
}
|
||||||
|
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
h.renderTemplate(
|
h.renderTemplate(w, r, "sources_new.html", data)
|
||||||
w, r, "sources_new.html",
|
|
||||||
newSourceFormData(
|
|
||||||
"Name is required", name, description,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
retentionDays, retErr := parseRetentionDays(
|
retentionDays := defaultRetentionDays
|
||||||
retentionStr, database.DefaultRetentionDays,
|
|
||||||
)
|
|
||||||
if retErr != nil {
|
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
|
||||||
h.renderTemplate(
|
|
||||||
w, r, "sources_new.html",
|
|
||||||
newSourceFormData(
|
|
||||||
retentionErrorMessage(retErr),
|
|
||||||
name, description,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
if retentionStr != "" {
|
||||||
|
v, convErr := strconv.Atoi(retentionStr)
|
||||||
|
if convErr == nil && v > 0 {
|
||||||
|
retentionDays = v
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
h.createWebhookWithEntrypoint(
|
h.createWebhookWithEntrypoint(
|
||||||
@@ -409,10 +315,8 @@ func (h *Handlers) renderSourceDetail(
|
|||||||
scheme = fwdProto
|
scheme = fwdProto
|
||||||
}
|
}
|
||||||
|
|
||||||
// The template calls Webhook methods, which take pointer
|
|
||||||
// receivers; html/template cannot address a value stored in a map.
|
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
tmplKeyWebhook: &webhook,
|
tmplKeyWebhook: webhook,
|
||||||
"Entrypoints": entrypoints,
|
"Entrypoints": entrypoints,
|
||||||
"Targets": targets,
|
"Targets": targets,
|
||||||
"Events": events,
|
"Events": events,
|
||||||
@@ -448,7 +352,7 @@ func (h *Handlers) HandleSourceEdit() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
tmplKeyWebhook: &webhook,
|
tmplKeyWebhook: webhook,
|
||||||
tmplKeyError: "",
|
tmplKeyError: "",
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -512,7 +416,7 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
name := r.FormValue("name")
|
name := r.FormValue("name")
|
||||||
if name == "" {
|
if name == "" {
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
tmplKeyWebhook: webhook,
|
tmplKeyWebhook: *webhook,
|
||||||
tmplKeyError: "Name is required",
|
tmplKeyError: "Name is required",
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -524,25 +428,7 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
|
|
||||||
webhook.Name = name
|
webhook.Name = name
|
||||||
webhook.Description = r.FormValue("description")
|
webhook.Description = r.FormValue("description")
|
||||||
|
h.parseRetention(r, webhook)
|
||||||
// An empty field falls back to the stored value, so submitting the
|
|
||||||
// form without touching retention leaves the policy alone.
|
|
||||||
retentionDays, retErr := parseRetentionDays(
|
|
||||||
r.FormValue("retention_days"), webhook.RetentionDays,
|
|
||||||
)
|
|
||||||
if retErr != nil {
|
|
||||||
data := map[string]any{
|
|
||||||
tmplKeyWebhook: webhook,
|
|
||||||
tmplKeyError: retentionErrorMessage(retErr),
|
|
||||||
}
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusBadRequest)
|
|
||||||
h.renderTemplate(w, r, "source_edit.html", data)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
webhook.RetentionDays = retentionDays
|
|
||||||
|
|
||||||
err := h.db.DB().Save(webhook).Error
|
err := h.db.DB().Save(webhook).Error
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -556,6 +442,23 @@ func (h *Handlers) applyWebhookEdit(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// parseRetention parses and applies retention_days from the
|
||||||
|
// form.
|
||||||
|
func (h *Handlers) parseRetention(
|
||||||
|
r *http.Request,
|
||||||
|
webhook *database.Webhook,
|
||||||
|
) {
|
||||||
|
retStr := r.FormValue("retention_days")
|
||||||
|
if retStr == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
v, err := strconv.Atoi(retStr)
|
||||||
|
if err == nil && v > 0 {
|
||||||
|
webhook.RetentionDays = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// HandleSourceDelete handles webhook deletion.
|
// HandleSourceDelete handles webhook deletion.
|
||||||
func (h *Handlers) HandleSourceDelete() http.HandlerFunc {
|
func (h *Handlers) HandleSourceDelete() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -630,6 +533,13 @@ func (h *Handlers) deleteWebhookResources(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Release the delivery engine's per-webhook archiving state
|
||||||
|
// so a deleted webhook's archive writer (and any handle open
|
||||||
|
// within its debounce window) does not linger for the
|
||||||
|
// process lifetime. The archive file itself is deliberately
|
||||||
|
// left on disk; see evictArchiveWriter.
|
||||||
|
h.evictArchiveWriter(webhook.ID)
|
||||||
|
|
||||||
err = h.dbMgr.DeleteDB(webhook.ID)
|
err = h.dbMgr.DeleteDB(webhook.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.log.Error(
|
h.log.Error(
|
||||||
@@ -648,6 +558,64 @@ func (h *Handlers) deleteWebhookResources(
|
|||||||
http.Redirect(w, r, "/sources", http.StatusSeeOther)
|
http.Redirect(w, r, "/sources", http.StatusSeeOther)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// evictArchiveWriter asks the delivery engine to drop its
|
||||||
|
// cached archive writer for a webhook, closing the archive file
|
||||||
|
// handle.
|
||||||
|
//
|
||||||
|
// The archive database file is NOT deleted. Unlike the event
|
||||||
|
// database — which is per-webhook working storage and is
|
||||||
|
// hard-deleted with the webhook — an archive is explicitly
|
||||||
|
// long-term storage that an operator may want to keep or move
|
||||||
|
// away for offline retention. Destroying it as a side effect of
|
||||||
|
// deleting a webhook would be a surprising and unrecoverable
|
||||||
|
// data loss, so the file is left for the operator to handle.
|
||||||
|
func (h *Handlers) evictArchiveWriter(webhookID string) {
|
||||||
|
if h.evictor == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.evictor.EvictWebhook(webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// evictArchiveWriterIfUnused releases a webhook's archive
|
||||||
|
// writer once the webhook has no database target left to feed
|
||||||
|
// it.
|
||||||
|
//
|
||||||
|
// It is called after any child resource of a webhook is
|
||||||
|
// deleted, and is correct without knowing which kind was: it
|
||||||
|
// evicts only when no database target remains, so deleting one
|
||||||
|
// of several database targets — or deleting an unrelated
|
||||||
|
// target type — leaves a still-needed writer alone. When no
|
||||||
|
// database target ever existed there is no writer and eviction
|
||||||
|
// is a no-op. Soft-deleted targets are excluded by GORM's
|
||||||
|
// default scope, so the row just deleted is not counted.
|
||||||
|
func (h *Handlers) evictArchiveWriterIfUnused(webhookID string) {
|
||||||
|
var remaining int64
|
||||||
|
|
||||||
|
err := h.db.DB().
|
||||||
|
Model(&database.Target{}).
|
||||||
|
Where(
|
||||||
|
"webhook_id = ? AND type = ?",
|
||||||
|
webhookID, database.TargetTypeDatabase,
|
||||||
|
).
|
||||||
|
Count(&remaining).Error
|
||||||
|
if err != nil {
|
||||||
|
h.log.Error(
|
||||||
|
"failed to count remaining database targets",
|
||||||
|
"webhook_id", webhookID,
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if remaining > 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
h.evictArchiveWriter(webhookID)
|
||||||
|
}
|
||||||
|
|
||||||
// HandleSourceLogs shows the request/response logs for a
|
// HandleSourceLogs shows the request/response logs for a
|
||||||
// webhook.
|
// webhook.
|
||||||
func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
||||||
@@ -687,7 +655,7 @@ func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
data := map[string]any{
|
data := map[string]any{
|
||||||
tmplKeyWebhook: &webhook,
|
tmplKeyWebhook: webhook,
|
||||||
"Events": evts,
|
"Events": evts,
|
||||||
"Page": page,
|
"Page": page,
|
||||||
"TotalPages": totalPages,
|
"TotalPages": totalPages,
|
||||||
@@ -1121,23 +1089,31 @@ func (h *Handlers) HandleEntrypointDelete() http.HandlerFunc {
|
|||||||
return h.deleteChildResource(
|
return h.deleteChildResource(
|
||||||
"entrypointID", &database.Entrypoint{},
|
"entrypointID", &database.Entrypoint{},
|
||||||
"failed to delete entrypoint",
|
"failed to delete entrypoint",
|
||||||
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleTargetDelete handles deleting a target.
|
// HandleTargetDelete handles deleting a target. Deleting the
|
||||||
|
// last database target of a webhook leaves its archive writer
|
||||||
|
// with nothing to write, so the writer is evicted and its
|
||||||
|
// handle closed; the archive file is left on disk.
|
||||||
func (h *Handlers) HandleTargetDelete() http.HandlerFunc {
|
func (h *Handlers) HandleTargetDelete() http.HandlerFunc {
|
||||||
return h.deleteChildResource(
|
return h.deleteChildResource(
|
||||||
"targetID", &database.Target{},
|
"targetID", &database.Target{},
|
||||||
"failed to delete target",
|
"failed to delete target",
|
||||||
|
h.evictArchiveWriterIfUnused,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// deleteChildResource returns a handler that deletes a child
|
// deleteChildResource returns a handler that deletes a child
|
||||||
// resource (entrypoint or target) belonging to a webhook.
|
// resource (entrypoint or target) belonging to a webhook. The
|
||||||
|
// optional afterDelete hook runs with the webhook's id once the
|
||||||
|
// delete has succeeded, before the redirect.
|
||||||
func (h *Handlers) deleteChildResource(
|
func (h *Handlers) deleteChildResource(
|
||||||
idParam string,
|
idParam string,
|
||||||
model any,
|
model any,
|
||||||
errMsg string,
|
errMsg string,
|
||||||
|
afterDelete func(webhookID string),
|
||||||
) http.HandlerFunc {
|
) http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
userID, ok := h.getUserID(r)
|
userID, ok := h.getUserID(r)
|
||||||
@@ -1177,6 +1153,10 @@ func (h *Handlers) deleteChildResource(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if afterDelete != nil {
|
||||||
|
afterDelete(webhook.ID)
|
||||||
|
}
|
||||||
|
|
||||||
http.Redirect(
|
http.Redirect(
|
||||||
w, r,
|
w, r,
|
||||||
"/source/"+webhook.ID,
|
"/source/"+webhook.ID,
|
||||||
|
|||||||
@@ -1,581 +0,0 @@
|
|||||||
package handlers_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/go-chi/chi"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"gorm.io/gorm/clause"
|
|
||||||
"sneak.berlin/go/webhooker/internal/database"
|
|
||||||
"sneak.berlin/go/webhooker/internal/handlers"
|
|
||||||
"sneak.berlin/go/webhooker/internal/session"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// sourceTestUserID is the session user id used by the webhook
|
|
||||||
// management tests.
|
|
||||||
sourceTestUserID = "source-test-user"
|
|
||||||
// sourceIDParam is the chi URL parameter naming a webhook.
|
|
||||||
sourceIDParam = "sourceID"
|
|
||||||
)
|
|
||||||
|
|
||||||
// formRequest builds an urlencoded POST to path carrying the given
|
|
||||||
// cookies, plus any chi URL parameters the handler reads.
|
|
||||||
func formRequest(
|
|
||||||
path string,
|
|
||||||
cookies []*http.Cookie,
|
|
||||||
form url.Values,
|
|
||||||
urlParams map[string]string,
|
|
||||||
) *http.Request {
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
context.Background(),
|
|
||||||
http.MethodPost,
|
|
||||||
path,
|
|
||||||
strings.NewReader(form.Encode()),
|
|
||||||
)
|
|
||||||
req.Header.Set(
|
|
||||||
"Content-Type", "application/x-www-form-urlencoded",
|
|
||||||
)
|
|
||||||
|
|
||||||
for _, c := range cookies {
|
|
||||||
req.AddCookie(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
rctx := chi.NewRouteContext()
|
|
||||||
for k, v := range urlParams {
|
|
||||||
rctx.URLParams.Add(k, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
return req.WithContext(
|
|
||||||
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// getRequest builds a GET to path carrying the given cookies, plus any
|
|
||||||
// chi URL parameters the handler reads.
|
|
||||||
func getRequest(
|
|
||||||
t *testing.T,
|
|
||||||
path string,
|
|
||||||
cookies []*http.Cookie,
|
|
||||||
urlParams map[string]string,
|
|
||||||
) *http.Request {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
context.Background(), http.MethodGet, path, nil,
|
|
||||||
)
|
|
||||||
|
|
||||||
for _, c := range cookies {
|
|
||||||
req.AddCookie(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
rctx := chi.NewRouteContext()
|
|
||||||
for k, v := range urlParams {
|
|
||||||
rctx.URLParams.Add(k, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
return req.WithContext(
|
|
||||||
context.WithValue(req.Context(), chi.RouteCtxKey, rctx),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// submitCreate posts the webhook creation form with the given
|
|
||||||
// retention_days value (omitted entirely when retention is nil) and
|
|
||||||
// returns the recorder.
|
|
||||||
func submitCreate(
|
|
||||||
t *testing.T,
|
|
||||||
h *handlers.Handlers,
|
|
||||||
cookies []*http.Cookie,
|
|
||||||
name string,
|
|
||||||
retention *string,
|
|
||||||
) *httptest.ResponseRecorder {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
form := url.Values{}
|
|
||||||
form.Set("name", name)
|
|
||||||
|
|
||||||
if retention != nil {
|
|
||||||
form.Set("retention_days", *retention)
|
|
||||||
}
|
|
||||||
|
|
||||||
req := formRequest("/sources/new", cookies, form, nil)
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
|
|
||||||
h.HandleSourceCreateSubmit().ServeHTTP(w, req)
|
|
||||||
|
|
||||||
return w
|
|
||||||
}
|
|
||||||
|
|
||||||
// onlyWebhook loads the single webhook belonging to the test user.
|
|
||||||
func onlyWebhook(
|
|
||||||
t *testing.T,
|
|
||||||
db *database.Database,
|
|
||||||
) database.Webhook {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var webhooks []database.Webhook
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.DB().Where("user_id = ?", sourceTestUserID).
|
|
||||||
Find(&webhooks).Error,
|
|
||||||
)
|
|
||||||
require.Len(t, webhooks, 1)
|
|
||||||
|
|
||||||
return webhooks[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
// seedWebhook inserts a webhook owned by the test user with an exact
|
|
||||||
// stored retention value, bypassing Webhook.BeforeSave via a
|
|
||||||
// column-level update so that legacy rows can be planted too.
|
|
||||||
func seedWebhook(
|
|
||||||
t *testing.T,
|
|
||||||
db *database.Database,
|
|
||||||
retentionDays int,
|
|
||||||
) database.Webhook {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
wh := &database.Webhook{
|
|
||||||
UserID: sourceTestUserID,
|
|
||||||
Name: "seeded",
|
|
||||||
RetentionDays: retentionDays,
|
|
||||||
}
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.DB().Omit(clause.Associations).Create(wh).Error,
|
|
||||||
)
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.DB().Model(wh).
|
|
||||||
Update("retention_days", retentionDays).Error,
|
|
||||||
)
|
|
||||||
|
|
||||||
wh.RetentionDays = retentionDays
|
|
||||||
|
|
||||||
return *wh
|
|
||||||
}
|
|
||||||
|
|
||||||
// storedRetentionDays reads the retention_days column for a webhook.
|
|
||||||
func storedRetentionDays(
|
|
||||||
t *testing.T,
|
|
||||||
db *database.Database,
|
|
||||||
id string,
|
|
||||||
) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var got int
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
db.DB().Model(&database.Webhook{}).
|
|
||||||
Where("id = ?", id).
|
|
||||||
Pluck("retention_days", &got).Error,
|
|
||||||
)
|
|
||||||
|
|
||||||
return got
|
|
||||||
}
|
|
||||||
|
|
||||||
// sourceTestEnv bundles the handler, session, and database a webhook
|
|
||||||
// management test drives.
|
|
||||||
type sourceTestEnv struct {
|
|
||||||
handlers *handlers.Handlers
|
|
||||||
db *database.Database
|
|
||||||
cookies []*http.Cookie
|
|
||||||
}
|
|
||||||
|
|
||||||
func setupSourceTest(t *testing.T) *sourceTestEnv {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var h *handlers.Handlers
|
|
||||||
|
|
||||||
var sess *session.Session
|
|
||||||
|
|
||||||
var db *database.Database
|
|
||||||
|
|
||||||
app := newTestApp(t, &h, &sess, &db)
|
|
||||||
app.RequireStart()
|
|
||||||
|
|
||||||
t.Cleanup(app.RequireStop)
|
|
||||||
|
|
||||||
return &sourceTestEnv{
|
|
||||||
handlers: h,
|
|
||||||
db: db,
|
|
||||||
cookies: authenticatedCookies(
|
|
||||||
t, sess, sourceTestUserID, "sourceuser",
|
|
||||||
),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleSourceCreateSubmit_ZeroRetentionPersistsForever is the core
|
|
||||||
// regression test for the bug: the create form's 0 must reach the
|
|
||||||
// database as the retain-forever sentinel rather than being replaced by
|
|
||||||
// the column's default of 30.
|
|
||||||
func TestHandleSourceCreateSubmit_ZeroRetentionPersistsForever(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
zero := "0"
|
|
||||||
|
|
||||||
w := submitCreate(t, env.handlers, env.cookies, "forever", &zero)
|
|
||||||
require.Equal(t, http.StatusSeeOther, w.Code)
|
|
||||||
|
|
||||||
wh := onlyWebhook(t, env.db)
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
)
|
|
||||||
assert.True(t, wh.RetainsForever())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleSourceCreateSubmit_OmittedRetentionUsesDefault(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
|
|
||||||
w := submitCreate(t, env.handlers, env.cookies, "defaulted", nil)
|
|
||||||
require.Equal(t, http.StatusSeeOther, w.Code)
|
|
||||||
|
|
||||||
wh := onlyWebhook(t, env.db)
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.DefaultRetentionDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleSourceCreate_PrefillsDefaultFromConstant keeps the create
|
|
||||||
// form's pre-filled retention from becoming a third hardcoded copy of
|
|
||||||
// the 30-day policy.
|
|
||||||
func TestHandleSourceCreate_PrefillsDefaultFromConstant(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
env.handlers.HandleSourceCreate().ServeHTTP(
|
|
||||||
w, getRequest(t, "/sources/new", env.cookies, nil),
|
|
||||||
)
|
|
||||||
|
|
||||||
require.Equal(t, http.StatusOK, w.Code)
|
|
||||||
|
|
||||||
body := w.Body.String()
|
|
||||||
|
|
||||||
assert.Contains(
|
|
||||||
t, body,
|
|
||||||
`value="`+strconv.Itoa(database.DefaultRetentionDays)+`"`,
|
|
||||||
)
|
|
||||||
assert.NotContains(
|
|
||||||
t, body, `max="365"`,
|
|
||||||
"a max below the sentinel would block retain-forever",
|
|
||||||
)
|
|
||||||
assert.Contains(t, body, `min="0"`)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleSourceCreateSubmit_InvalidRetentionIsRejected(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, raw := range []string{"abc", "-1", "3.5"} {
|
|
||||||
t.Run(raw, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
|
|
||||||
w := submitCreate(
|
|
||||||
t, env.handlers, env.cookies, "bad", &raw,
|
|
||||||
)
|
|
||||||
|
|
||||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
|
||||||
assert.Contains(
|
|
||||||
t, w.Body.String(), "Retention must be",
|
|
||||||
)
|
|
||||||
|
|
||||||
var count int64
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
env.db.DB().Model(&database.Webhook{}).
|
|
||||||
Where("user_id = ?", sourceTestUserID).
|
|
||||||
Count(&count).Error,
|
|
||||||
)
|
|
||||||
assert.Zero(
|
|
||||||
t, count,
|
|
||||||
"no webhook may be created from a rejected form",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleSourceCreateSubmit_OverflowingRetentionIsRejected covers
|
|
||||||
// the data-loss path directly: a finite retention above the largest one
|
|
||||||
// the reaper's cutoff arithmetic can represent must never reach the
|
|
||||||
// database, because the sweep would compute a future cutoff and delete
|
|
||||||
// every event the webhook has.
|
|
||||||
func TestHandleSourceCreateSubmit_OverflowingRetentionIsRejected(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tooBig := strconv.Itoa(database.MaxFiniteRetentionDays + 1)
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
|
|
||||||
w := submitCreate(t, env.handlers, env.cookies, "huge", &tooBig)
|
|
||||||
|
|
||||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
|
||||||
assert.Contains(
|
|
||||||
t, w.Body.String(),
|
|
||||||
strconv.Itoa(database.MaxFiniteRetentionDays),
|
|
||||||
"the form tells the user the actual ceiling",
|
|
||||||
)
|
|
||||||
|
|
||||||
var count int64
|
|
||||||
|
|
||||||
require.NoError(
|
|
||||||
t,
|
|
||||||
env.db.DB().Model(&database.Webhook{}).
|
|
||||||
Where("user_id = ?", sourceTestUserID).
|
|
||||||
Count(&count).Error,
|
|
||||||
)
|
|
||||||
assert.Zero(
|
|
||||||
t, count,
|
|
||||||
"no webhook may be created from a rejected form",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleSourceCreateSubmit_SentinelIsAcceptedAsForever guards the
|
|
||||||
// boundary between "too large to represent" and "retain forever": the
|
|
||||||
// sentinel is above MaxFiniteRetentionDays, but it is the value the
|
|
||||||
// edit form pre-fills, so it must be accepted rather than rejected as
|
|
||||||
// out of range.
|
|
||||||
func TestHandleSourceCreateSubmit_SentinelIsAcceptedAsForever(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
|
||||||
|
|
||||||
w := submitCreate(t, env.handlers, env.cookies, "forever", &sentinel)
|
|
||||||
require.Equal(t, http.StatusSeeOther, w.Code)
|
|
||||||
|
|
||||||
wh := onlyWebhook(t, env.db)
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleSourceCreateSubmit_RejectedFormKeepsUserInput checks that a
|
|
||||||
// validation failure hands the user's typing back, matching what the
|
|
||||||
// edit form already does. Losing a long description to a mistyped
|
|
||||||
// retention value is the kind of thing that makes people give up on a
|
|
||||||
// form.
|
|
||||||
func TestHandleSourceCreateSubmit_RejectedFormKeepsUserInput(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
|
|
||||||
const (
|
|
||||||
name = "kept-name"
|
|
||||||
description = "a description worth not losing"
|
|
||||||
)
|
|
||||||
|
|
||||||
form := url.Values{}
|
|
||||||
form.Set("name", name)
|
|
||||||
form.Set("description", description)
|
|
||||||
form.Set("retention_days", "nonsense")
|
|
||||||
|
|
||||||
req := formRequest("/sources/new", env.cookies, form, nil)
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
|
|
||||||
env.handlers.HandleSourceCreateSubmit().ServeHTTP(w, req)
|
|
||||||
|
|
||||||
require.Equal(t, http.StatusBadRequest, w.Code)
|
|
||||||
|
|
||||||
body := w.Body.String()
|
|
||||||
|
|
||||||
assert.Contains(t, body, `value="`+name+`"`)
|
|
||||||
assert.Contains(t, body, description)
|
|
||||||
}
|
|
||||||
|
|
||||||
// submitEdit posts the webhook edit form for the given webhook.
|
|
||||||
func submitEdit(
|
|
||||||
t *testing.T,
|
|
||||||
env *sourceTestEnv,
|
|
||||||
wh database.Webhook,
|
|
||||||
retention string,
|
|
||||||
) *httptest.ResponseRecorder {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
form := url.Values{}
|
|
||||||
form.Set("name", wh.Name)
|
|
||||||
form.Set("description", wh.Description)
|
|
||||||
form.Set("retention_days", retention)
|
|
||||||
|
|
||||||
req := formRequest(
|
|
||||||
"/source/"+wh.ID+"/edit",
|
|
||||||
env.cookies,
|
|
||||||
form,
|
|
||||||
map[string]string{sourceIDParam: wh.ID},
|
|
||||||
)
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
|
|
||||||
env.handlers.HandleSourceEditSubmit().ServeHTTP(w, req)
|
|
||||||
|
|
||||||
return w
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleSourceEditSubmit_ZeroRetentionPersistsForever(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
wh := seedWebhook(t, env.db, database.DefaultRetentionDays)
|
|
||||||
|
|
||||||
w := submitEdit(t, env, wh, "0")
|
|
||||||
require.Equal(t, http.StatusSeeOther, w.Code)
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleSourceEditSubmit_InvalidRetentionIsRejected(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
wh := seedWebhook(t, env.db, database.DefaultRetentionDays)
|
|
||||||
|
|
||||||
w := submitEdit(t, env, wh, "not-a-number")
|
|
||||||
|
|
||||||
assert.Equal(t, http.StatusBadRequest, w.Code)
|
|
||||||
assert.Contains(t, w.Body.String(), "Retention must be")
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.DefaultRetentionDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
"a rejected form must not change the stored retention",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHandleSourceEditSubmit_EmptyRetentionLeavesValueUnchanged(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
wh := seedWebhook(t, env.db, 7)
|
|
||||||
|
|
||||||
w := submitEdit(t, env, wh, "")
|
|
||||||
require.Equal(t, http.StatusSeeOther, w.Code)
|
|
||||||
|
|
||||||
assert.Equal(t, 7, storedRetentionDays(t, env.db, wh.ID))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSourceEditForm_ForeverWebhookRoundTrips walks the exact path that
|
|
||||||
// the removed max="365" cap used to break: render the edit form for a
|
|
||||||
// retain-forever webhook, confirm the pre-filled sentinel is not capped
|
|
||||||
// by browser validation, then submit that pre-filled value straight
|
|
||||||
// back and confirm the retention policy survives untouched.
|
|
||||||
func TestSourceEditForm_ForeverWebhookRoundTrips(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
wh := seedWebhook(t, env.db, database.RetentionForeverDays)
|
|
||||||
|
|
||||||
req := getRequest(
|
|
||||||
t, "/source/"+wh.ID+"/edit", env.cookies,
|
|
||||||
map[string]string{sourceIDParam: wh.ID},
|
|
||||||
)
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
env.handlers.HandleSourceEdit().ServeHTTP(w, req)
|
|
||||||
|
|
||||||
require.Equal(t, http.StatusOK, w.Code)
|
|
||||||
|
|
||||||
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
|
||||||
body := w.Body.String()
|
|
||||||
|
|
||||||
assert.Contains(
|
|
||||||
t, body, `value="`+sentinel+`"`,
|
|
||||||
"the edit form pre-fills the stored retention",
|
|
||||||
)
|
|
||||||
assert.NotContains(
|
|
||||||
t, body, `max="365"`,
|
|
||||||
"a max below the sentinel would block saving any edit",
|
|
||||||
)
|
|
||||||
// "Currently forever." is the rendered RetentionLabel, not the
|
|
||||||
// static hint below the input, which says "Enter 0 to retain events
|
|
||||||
// forever." A bare Contains of "forever" would pass for any
|
|
||||||
// webhook and would assert nothing about this one.
|
|
||||||
assert.Contains(
|
|
||||||
t, body, "Currently forever.",
|
|
||||||
"the form reports this webhook's policy as forever",
|
|
||||||
)
|
|
||||||
|
|
||||||
// Submit the pre-filled value back, exactly as a browser would.
|
|
||||||
post := submitEdit(t, env, wh, sentinel)
|
|
||||||
require.Equal(t, http.StatusSeeOther, post.Code)
|
|
||||||
|
|
||||||
assert.Equal(
|
|
||||||
t,
|
|
||||||
database.RetentionForeverDays,
|
|
||||||
storedRetentionDays(t, env.db, wh.ID),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSourceListAndDetail_ShowForeverNotTheSentinelNumber checks that
|
|
||||||
// the retain-forever value is never rendered to the user as a raw day
|
|
||||||
// count on either read-only view.
|
|
||||||
func TestSourceListAndDetail_ShowForeverNotTheSentinelNumber(
|
|
||||||
t *testing.T,
|
|
||||||
) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := setupSourceTest(t)
|
|
||||||
wh := seedWebhook(t, env.db, database.RetentionForeverDays)
|
|
||||||
sentinel := strconv.Itoa(database.RetentionForeverDays)
|
|
||||||
|
|
||||||
listW := httptest.NewRecorder()
|
|
||||||
env.handlers.HandleSourceList().ServeHTTP(
|
|
||||||
listW, getRequest(t, "/sources", env.cookies, nil),
|
|
||||||
)
|
|
||||||
|
|
||||||
require.Equal(t, http.StatusOK, listW.Code)
|
|
||||||
assert.Contains(t, listW.Body.String(), "Retention: forever")
|
|
||||||
assert.NotContains(t, listW.Body.String(), sentinel)
|
|
||||||
|
|
||||||
detailW := httptest.NewRecorder()
|
|
||||||
env.handlers.HandleSourceDetail().ServeHTTP(
|
|
||||||
detailW,
|
|
||||||
getRequest(
|
|
||||||
t, "/source/"+wh.ID, env.cookies,
|
|
||||||
map[string]string{sourceIDParam: wh.ID},
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
require.Equal(t, http.StatusOK, detailW.Code)
|
|
||||||
assert.Contains(t, detailW.Body.String(), "Retention: forever")
|
|
||||||
assert.NotContains(t, detailW.Body.String(), sentinel)
|
|
||||||
}
|
|
||||||
@@ -181,7 +181,7 @@
|
|||||||
|
|
||||||
<!-- Info -->
|
<!-- Info -->
|
||||||
<div class="mt-4 text-sm text-gray-400">
|
<div class="mt-4 text-sm text-gray-400">
|
||||||
<p>Retention: {{.Webhook.RetentionLabel}} · Created: {{.Webhook.CreatedAt.Format "2006-01-02 15:04:05 UTC"}}</p>
|
<p>Retention: {{.Webhook.RetentionDays}} days · Created: {{.Webhook.CreatedAt.Format "2006-01-02 15:04:05 UTC"}}</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{end}}
|
{{end}}
|
||||||
|
|||||||
@@ -28,8 +28,7 @@
|
|||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="retention_days" class="label">Retention (days)</label>
|
<label for="retention_days" class="label">Retention (days)</label>
|
||||||
<input type="number" id="retention_days" name="retention_days" value="{{.Webhook.RetentionDays}}" min="0" class="input">
|
<input type="number" id="retention_days" name="retention_days" value="{{.Webhook.RetentionDays}}" min="1" max="365" class="input">
|
||||||
<p class="text-xs text-gray-500 mt-1">Currently {{.Webhook.RetentionLabel}}. Enter 0 to retain events forever.</p>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="flex gap-3">
|
<div class="flex gap-3">
|
||||||
|
|||||||
@@ -25,7 +25,7 @@
|
|||||||
<p class="text-sm text-gray-500 mt-1">{{.Description}}</p>
|
<p class="text-sm text-gray-500 mt-1">{{.Description}}</p>
|
||||||
{{end}}
|
{{end}}
|
||||||
</div>
|
</div>
|
||||||
<span class="badge-info">Retention: {{.RetentionLabel}}</span>
|
<span class="badge-info">{{.RetentionDays}}d retention</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="flex gap-6 mt-4 text-sm text-gray-500">
|
<div class="flex gap-6 mt-4 text-sm text-gray-500">
|
||||||
<span>{{.EntrypointCount}} entrypoint{{if ne .EntrypointCount 1}}s{{end}}</span>
|
<span>{{.EntrypointCount}} entrypoint{{if ne .EntrypointCount 1}}s{{end}}</span>
|
||||||
|
|||||||
@@ -18,18 +18,18 @@
|
|||||||
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="name" class="label">Name</label>
|
<label for="name" class="label">Name</label>
|
||||||
<input type="text" id="name" name="name" value="{{.Name}}" required autofocus placeholder="My Webhook" class="input">
|
<input type="text" id="name" name="name" required autofocus placeholder="My Webhook" class="input">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="description" class="label">Description</label>
|
<label for="description" class="label">Description</label>
|
||||||
<textarea id="description" name="description" rows="3" placeholder="Optional description" class="input">{{.Description}}</textarea>
|
<textarea id="description" name="description" rows="3" placeholder="Optional description" class="input"></textarea>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="retention_days" class="label">Retention (days)</label>
|
<label for="retention_days" class="label">Retention (days)</label>
|
||||||
<input type="number" id="retention_days" name="retention_days" value="{{.DefaultRetentionDays}}" min="0" class="input">
|
<input type="number" id="retention_days" name="retention_days" value="30" min="1" max="365" class="input">
|
||||||
<p class="text-xs text-gray-500 mt-1">How long to keep event data. Enter 0 to retain events forever.</p>
|
<p class="text-xs text-gray-500 mt-1">How long to keep event data.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="flex gap-3">
|
<div class="flex gap-3">
|
||||||
|
|||||||
Reference in New Issue
Block a user