Compare commits
1 Commits
issue-79-r
...
issue-66-s
| Author | SHA1 | Date | |
|---|---|---|---|
| b04bc2cc7b |
41
README.md
41
README.md
@@ -92,6 +92,27 @@ TTY detection, and security headers are always applied.
|
|||||||
| `METRICS_USERNAME` | Basic auth username for `/metrics` | `""` |
|
| `METRICS_USERNAME` | Basic auth username for `/metrics` | `""` |
|
||||||
| `METRICS_PASSWORD` | Basic auth password for `/metrics` | `""` |
|
| `METRICS_PASSWORD` | Basic auth password for `/metrics` | `""` |
|
||||||
| `SENTRY_DSN` | Sentry error reporting DSN | `""` |
|
| `SENTRY_DSN` | Sentry error reporting DSN | `""` |
|
||||||
|
| `SESSION_IDLE_TIMEOUT` | Idle session timeout (Go duration) | `24h` |
|
||||||
|
|
||||||
|
Sessions are bounded by two independent clocks, and end at whichever
|
||||||
|
one runs out first:
|
||||||
|
|
||||||
|
- **Idle expiry** (`SESSION_IDLE_TIMEOUT`, default `24h`) is a sliding
|
||||||
|
window. Every authenticated request pushes it forward, so a session
|
||||||
|
in continuous use never hits it, while an abandoned one expires a day
|
||||||
|
after its last use. Set it to `0` to disable idle expiry entirely;
|
||||||
|
the absolute cap below still applies. A set-but-unparseable value
|
||||||
|
aborts startup rather than silently falling back to the default.
|
||||||
|
- **Absolute expiry** is a fixed 7 days from login. Activity does
|
||||||
|
**not** extend it: after a week, every session ends and the user
|
||||||
|
authenticates again.
|
||||||
|
|
||||||
|
Only requests that authenticate with the session count as activity, so
|
||||||
|
an unauthenticated request carrying the cookie cannot keep a session
|
||||||
|
alive. The idle timestamp is rewritten at most once per tenth of the
|
||||||
|
idle window rather than on every request, which means a session may
|
||||||
|
expire up to 10% early relative to the user's true last request, but
|
||||||
|
never late.
|
||||||
|
|
||||||
On first startup, webhooker automatically generates a cryptographically
|
On first startup, webhooker automatically generates a cryptographically
|
||||||
secure session encryption key and stores it in the database. This key
|
secure session encryption key and stores it in the database. This key
|
||||||
@@ -307,29 +328,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 +530,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.
|
||||||
|
|||||||
17
TODO.md
17
TODO.md
@@ -28,17 +28,10 @@ databases currently grow without bound.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-09 Make retain-forever reachable from the normal create and
|
- 2026-08-09 Inactivity-based session timeout: sliding idle expiry
|
||||||
edit flows (#79): a `RetentionForeverDays = 365 * 1000` sentinel, a
|
(`SESSION_IDLE_TIMEOUT`, default `24h`) refreshed on authenticated
|
||||||
`Webhook.BeforeSave` hook rewriting any non-positive `retention_days`
|
requests, with the 7-day absolute cap kept as an independent
|
||||||
to it ahead of GORM's own column defaulting, a reaper that skips such
|
backstop that activity never extends (#66)
|
||||||
webhooks outright, form validation that honours `0` and rejects
|
|
||||||
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
|
||||||
@@ -82,7 +75,7 @@ databases currently grow without bound.
|
|||||||
- event redelivery endpoint
|
- event redelivery endpoint
|
||||||
- OpenAPI specification
|
- OpenAPI specification
|
||||||
- Analytics dashboard: success rates, response times, volume
|
- Analytics dashboard: success rates, response times, volume
|
||||||
- Session expiration tuning and a remember-me option
|
- A remember-me option at login
|
||||||
- Password change and reset flow
|
- Password change and reset flow
|
||||||
- Later, nice to have
|
- Later, nice to have
|
||||||
- email delivery target type
|
- email delivery target type
|
||||||
|
|||||||
@@ -31,6 +31,10 @@ const (
|
|||||||
// defaultRetentionSweepInterval is how often the retention
|
// defaultRetentionSweepInterval is how often the retention
|
||||||
// reaper deletes events older than each webhook's RetentionDays.
|
// reaper deletes events older than each webhook's RetentionDays.
|
||||||
defaultRetentionSweepInterval = time.Hour
|
defaultRetentionSweepInterval = time.Hour
|
||||||
|
|
||||||
|
// defaultSessionIdleTimeout is how long a session may go without
|
||||||
|
// authenticated activity before it expires.
|
||||||
|
defaultSessionIdleTimeout = 24 * time.Hour
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrInvalidEnvironment is returned when WEBHOOKER_ENVIRONMENT
|
// ErrInvalidEnvironment is returned when WEBHOOKER_ENVIRONMENT
|
||||||
@@ -60,6 +64,10 @@ type Config struct {
|
|||||||
// RetentionSweepInterval is how often the retention reaper runs.
|
// RetentionSweepInterval is how often the retention reaper runs.
|
||||||
RetentionSweepInterval time.Duration
|
RetentionSweepInterval time.Duration
|
||||||
|
|
||||||
|
// SessionIdleTimeout is the sliding inactivity window after
|
||||||
|
// which a session expires. Non-positive disables idle expiry.
|
||||||
|
SessionIdleTimeout time.Duration
|
||||||
|
|
||||||
params *ConfigParams
|
params *ConfigParams
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
}
|
}
|
||||||
@@ -162,6 +170,15 @@ func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Same fail-loud treatment for the session idle timeout.
|
||||||
|
sessionIdleTimeout, err := envDuration(
|
||||||
|
"SESSION_IDLE_TIMEOUT",
|
||||||
|
defaultSessionIdleTimeout,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
// Load configuration values from environment variables
|
// Load configuration values from environment variables
|
||||||
s := &Config{
|
s := &Config{
|
||||||
DataDir: envString("DATA_DIR"),
|
DataDir: envString("DATA_DIR"),
|
||||||
@@ -173,6 +190,7 @@ func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
|||||||
Port: envInt("PORT", defaultPort),
|
Port: envInt("PORT", defaultPort),
|
||||||
SentryDSN: envString("SENTRY_DSN"),
|
SentryDSN: envString("SENTRY_DSN"),
|
||||||
RetentionSweepInterval: retentionSweepInterval,
|
RetentionSweepInterval: retentionSweepInterval,
|
||||||
|
SessionIdleTimeout: sessionIdleTimeout,
|
||||||
log: log,
|
log: log,
|
||||||
params: ¶ms,
|
params: ¶ms,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -163,7 +163,7 @@ func TestRetentionSweepInterval(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if tt.expectError {
|
if tt.expectError {
|
||||||
testRetentionSweepIntervalError(t)
|
expectStartupError(t)
|
||||||
} else {
|
} else {
|
||||||
testRetentionSweepIntervalSuccess(t, tt.expected)
|
testRetentionSweepIntervalSuccess(t, tt.expected)
|
||||||
}
|
}
|
||||||
@@ -171,7 +171,9 @@ func TestRetentionSweepInterval(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func testRetentionSweepIntervalError(t *testing.T) {
|
// expectStartupError asserts that fx refuses to build the app,
|
||||||
|
// which is what a set-but-unparseable duration must cause.
|
||||||
|
func expectStartupError(t *testing.T) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
var cfg *config.Config
|
var cfg *config.Config
|
||||||
@@ -215,6 +217,82 @@ func testRetentionSweepIntervalSuccess(
|
|||||||
assert.Equal(t, expected, cfg.RetentionSweepInterval)
|
assert.Equal(t, expected, cfg.RetentionSweepInterval)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSessionIdleTimeout(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
set bool
|
||||||
|
value string
|
||||||
|
expectError bool
|
||||||
|
expected time.Duration
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "unset uses default",
|
||||||
|
set: false,
|
||||||
|
expected: 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid value is parsed",
|
||||||
|
set: true,
|
||||||
|
value: "30m",
|
||||||
|
expected: 30 * time.Minute,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unparseable value fails startup",
|
||||||
|
set: true,
|
||||||
|
value: "not-a-duration",
|
||||||
|
expectError: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Cannot use t.Parallel() here because t.Setenv
|
||||||
|
// is incompatible with parallel subtests.
|
||||||
|
t.Setenv("WEBHOOKER_ENVIRONMENT", "dev")
|
||||||
|
|
||||||
|
if tt.set {
|
||||||
|
t.Setenv("SESSION_IDLE_TIMEOUT", tt.value)
|
||||||
|
} else {
|
||||||
|
require.NoError(t, os.Unsetenv(
|
||||||
|
"SESSION_IDLE_TIMEOUT",
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
if tt.expectError {
|
||||||
|
expectStartupError(t)
|
||||||
|
} else {
|
||||||
|
testSessionIdleTimeoutSuccess(t, tt.expected)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testSessionIdleTimeoutSuccess(
|
||||||
|
t *testing.T,
|
||||||
|
expected time.Duration,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var cfg *config.Config
|
||||||
|
|
||||||
|
app := fxtest.New(
|
||||||
|
t,
|
||||||
|
fx.Provide(
|
||||||
|
globals.New,
|
||||||
|
logger.New,
|
||||||
|
config.New,
|
||||||
|
),
|
||||||
|
fx.Populate(&cfg),
|
||||||
|
)
|
||||||
|
require.NoError(t, app.Err())
|
||||||
|
|
||||||
|
app.RequireStart()
|
||||||
|
|
||||||
|
defer app.RequireStop()
|
||||||
|
|
||||||
|
assert.Equal(t, expected, cfg.SessionIdleTimeout)
|
||||||
|
}
|
||||||
|
|
||||||
func TestDefaultDataDir(t *testing.T) {
|
func TestDefaultDataDir(t *testing.T) {
|
||||||
for _, env := range []string{"", "dev", "prod"} {
|
for _, env := range []string{"", "dev", "prod"} {
|
||||||
name := env
|
name := env
|
||||||
|
|||||||
@@ -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)
|
||||||
|
|||||||
@@ -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
|
||||||
|
|
||||||
|
|||||||
@@ -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) {
|
||||||
@@ -687,7 +590,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,
|
||||||
|
|||||||
@@ -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)
|
|
||||||
}
|
|
||||||
@@ -186,6 +186,10 @@ func (s *Middleware) RequireAuth() func(http.Handler) http.Handler {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IsAuthenticated also enforces both session expiry
|
||||||
|
// deadlines, so an idle-expired or absolutely-expired
|
||||||
|
// session lands here and is sent back to the login
|
||||||
|
// page.
|
||||||
if !s.session.IsAuthenticated(sess) {
|
if !s.session.IsAuthenticated(sess) {
|
||||||
s.log.Debug(
|
s.log.Debug(
|
||||||
"auth middleware: unauthenticated request",
|
"auth middleware: unauthenticated request",
|
||||||
@@ -199,6 +203,26 @@ func (s *Middleware) RequireAuth() func(http.Handler) http.Handler {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This request authenticated with the session, so it
|
||||||
|
// counts as activity: push the idle deadline forward.
|
||||||
|
// This is the only place sessions are refreshed, which
|
||||||
|
// is what keeps an unauthenticated request from
|
||||||
|
// extending someone else's session. Touch advances the
|
||||||
|
// idle clock only -- the absolute cap is untouched --
|
||||||
|
// and reports false when nothing changed, so most
|
||||||
|
// requests do not re-issue the cookie. Save before the
|
||||||
|
// handler runs, while the headers are still ours to
|
||||||
|
// write.
|
||||||
|
if s.session.Touch(sess) {
|
||||||
|
err = s.session.Save(r, w, sess)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Error(
|
||||||
|
"auth middleware: failed to refresh session",
|
||||||
|
"error", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
next.ServeHTTP(w, r)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -28,13 +29,30 @@ func testMiddleware(
|
|||||||
) (*middleware.Middleware, *session.Session) {
|
) (*middleware.Middleware, *session.Session) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
m, s, _ := testMiddlewareWithSessionClock(t, env, 0, nil)
|
||||||
|
|
||||||
|
return m, s
|
||||||
|
}
|
||||||
|
|
||||||
|
// testMiddlewareWithSessionClock is testMiddleware with a
|
||||||
|
// configurable session idle timeout and a manually advanced clock,
|
||||||
|
// for the session-expiry tests. A nil clock uses the real one.
|
||||||
|
func testMiddlewareWithSessionClock(
|
||||||
|
t *testing.T,
|
||||||
|
env string,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
clock *fakeClock,
|
||||||
|
) (*middleware.Middleware, *session.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
os.Stderr,
|
os.Stderr,
|
||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
))
|
))
|
||||||
|
|
||||||
cfg := &config.Config{
|
cfg := &config.Config{
|
||||||
Environment: env,
|
Environment: env,
|
||||||
|
SessionIdleTimeout: idleTimeout,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a real session manager with a known key
|
// Create a real session manager with a known key
|
||||||
@@ -53,11 +71,40 @@ func testMiddleware(
|
|||||||
SameSite: http.SameSiteLaxMode,
|
SameSite: http.SameSiteLaxMode,
|
||||||
}
|
}
|
||||||
|
|
||||||
sessManager := session.NewForTest(store, cfg, log, key)
|
var now func() time.Time
|
||||||
|
|
||||||
|
if clock != nil {
|
||||||
|
now = clock.Now
|
||||||
|
}
|
||||||
|
|
||||||
|
sessManager := session.NewForTest(store, cfg, log, key, now)
|
||||||
|
|
||||||
m := middleware.NewForTest(log, cfg, sessManager)
|
m := middleware.NewForTest(log, cfg, sessManager)
|
||||||
|
|
||||||
return m, sessManager
|
return m, sessManager, clock
|
||||||
|
}
|
||||||
|
|
||||||
|
// fakeClock is a manually advanced clock, so session expiry can be
|
||||||
|
// tested without sleeping.
|
||||||
|
type fakeClock struct {
|
||||||
|
t time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Now() time.Time {
|
||||||
|
return c.t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Advance(d time.Duration) {
|
||||||
|
c.t = c.t.Add(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// newFakeClock returns a clock started at a fixed instant.
|
||||||
|
func newFakeClock() *fakeClock {
|
||||||
|
return &fakeClock{
|
||||||
|
t: time.Date(
|
||||||
|
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||||
|
),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Logging Middleware Tests ---
|
// --- Logging Middleware Tests ---
|
||||||
@@ -387,6 +434,181 @@ func TestRequireAuth_UnauthenticatedSession_RedirectsToLogin(
|
|||||||
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- RequireAuth Session Expiry Tests ---
|
||||||
|
|
||||||
|
// loginCookies authenticates a new session and returns the cookies
|
||||||
|
// a browser would then send back.
|
||||||
|
func loginCookies(
|
||||||
|
t *testing.T,
|
||||||
|
sessManager *session.Session,
|
||||||
|
) []*http.Cookie {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/login", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
sess, err := sessManager.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
sessManager.SetUser(sess, "user-123", "testuser")
|
||||||
|
require.NoError(t, sessManager.Save(req, w, sess))
|
||||||
|
|
||||||
|
cookies := w.Result().Cookies()
|
||||||
|
require.NotEmpty(t, cookies, "session cookie should be set")
|
||||||
|
|
||||||
|
return cookies
|
||||||
|
}
|
||||||
|
|
||||||
|
// runAuthed sends a request carrying cookies through RequireAuth
|
||||||
|
// and reports whether the protected handler ran, plus the response.
|
||||||
|
func runAuthed(
|
||||||
|
t *testing.T,
|
||||||
|
m *middleware.Middleware,
|
||||||
|
cookies []*http.Cookie,
|
||||||
|
) (bool, *httptest.ResponseRecorder) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var called bool
|
||||||
|
|
||||||
|
handler := m.RequireAuth()(http.HandlerFunc(
|
||||||
|
func(_ http.ResponseWriter, _ *http.Request) {
|
||||||
|
called = true
|
||||||
|
},
|
||||||
|
))
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(),
|
||||||
|
http.MethodGet, "/dashboard", nil,
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, c := range cookies {
|
||||||
|
req.AddCookie(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
handler.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
return called, w
|
||||||
|
}
|
||||||
|
|
||||||
|
// sessionCookies filters a response's cookies down to the session
|
||||||
|
// cookie, so tests can tell whether the session was re-issued.
|
||||||
|
func sessionCookies(
|
||||||
|
w *httptest.ResponseRecorder,
|
||||||
|
) []*http.Cookie {
|
||||||
|
var out []*http.Cookie
|
||||||
|
|
||||||
|
for _, c := range w.Result().Cookies() {
|
||||||
|
if c.Name == session.SessionName {
|
||||||
|
out = append(out, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_IdleExpiredSession_RedirectsToLogin(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
idle := time.Hour
|
||||||
|
|
||||||
|
m, sessManager, clock := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, idle, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := loginCookies(t, sessManager)
|
||||||
|
|
||||||
|
clock.Advance(idle)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, called,
|
||||||
|
"handler should not run for an idle-expired session",
|
||||||
|
)
|
||||||
|
assert.Equal(t, http.StatusSeeOther, w.Code)
|
||||||
|
assert.Equal(t, "/pages/login", w.Header().Get("Location"))
|
||||||
|
assert.Empty(
|
||||||
|
t, sessionCookies(w),
|
||||||
|
"an expired session must not be refreshed",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_RefreshesIdleDeadlineOnActivity(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
idle := time.Hour
|
||||||
|
|
||||||
|
m, sessManager, clock := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, idle, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
cookies := loginCookies(t, sessManager)
|
||||||
|
|
||||||
|
// Activity halfway through the idle window.
|
||||||
|
clock.Advance(idle / 2)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
require.True(t, called, "handler should run while valid")
|
||||||
|
|
||||||
|
refreshed := sessionCookies(w)
|
||||||
|
require.NotEmpty(
|
||||||
|
t, refreshed,
|
||||||
|
"activity should re-issue the session cookie",
|
||||||
|
)
|
||||||
|
|
||||||
|
// Past the original deadline. The refreshed cookie is still
|
||||||
|
// good; the original one is not.
|
||||||
|
clock.Advance(idle - time.Second)
|
||||||
|
|
||||||
|
calledRefreshed, _ := runAuthed(t, m, refreshed)
|
||||||
|
assert.True(
|
||||||
|
t, calledRefreshed,
|
||||||
|
"refreshed session should outlive the original deadline",
|
||||||
|
)
|
||||||
|
|
||||||
|
calledStale, staleW := runAuthed(t, m, cookies)
|
||||||
|
assert.False(
|
||||||
|
t, calledStale,
|
||||||
|
"the pre-refresh cookie carries the old idle deadline",
|
||||||
|
)
|
||||||
|
assert.Equal(t, http.StatusSeeOther, staleW.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireAuth_UnauthenticatedRequestDoesNotRefresh(
|
||||||
|
t *testing.T,
|
||||||
|
) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m, sessManager, _ := testMiddlewareWithSessionClock(
|
||||||
|
t, config.EnvironmentDev, time.Hour, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
// A session cookie that exists but was never authenticated.
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/setup", nil)
|
||||||
|
setupW := httptest.NewRecorder()
|
||||||
|
|
||||||
|
sess, err := sessManager.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, sessManager.Save(req, setupW, sess))
|
||||||
|
|
||||||
|
cookies := setupW.Result().Cookies()
|
||||||
|
require.NotEmpty(t, cookies)
|
||||||
|
|
||||||
|
called, w := runAuthed(t, m, cookies)
|
||||||
|
|
||||||
|
assert.False(t, called)
|
||||||
|
assert.Empty(
|
||||||
|
t, sessionCookies(w),
|
||||||
|
"an unauthenticated request must not stamp the session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// --- NoCache Middleware Tests ---
|
// --- NoCache Middleware Tests ---
|
||||||
|
|
||||||
func TestNoCache_SetsHeaders(t *testing.T) {
|
func TestNoCache_SetsHeaders(t *testing.T) {
|
||||||
@@ -479,7 +701,7 @@ func metricsAuthMiddleware(
|
|||||||
store := sessions.NewCookieStore(key)
|
store := sessions.NewCookieStore(key)
|
||||||
store.Options = &sessions.Options{Path: "/", MaxAge: 86400}
|
store.Options = &sessions.Options{Path: "/", MaxAge: 86400}
|
||||||
|
|
||||||
sessManager := session.NewForTest(store, cfg, log, key)
|
sessManager := session.NewForTest(store, cfg, log, key, nil)
|
||||||
|
|
||||||
return middleware.NewForTest(log, cfg, sessManager)
|
return middleware.NewForTest(log, cfg, sessManager)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"maps"
|
"maps"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -32,6 +33,18 @@ const (
|
|||||||
// status.
|
// status.
|
||||||
AuthenticatedKey = "authenticated"
|
AuthenticatedKey = "authenticated"
|
||||||
|
|
||||||
|
// CreatedAtKey is the session key holding the Unix timestamp at
|
||||||
|
// which the session was authenticated. It anchors the ABSOLUTE
|
||||||
|
// expiry clock and is written exactly once, by SetUser. Nothing
|
||||||
|
// refreshes it: an absolute deadline that moved with activity
|
||||||
|
// would not be a cap at all.
|
||||||
|
CreatedAtKey = "created_at"
|
||||||
|
|
||||||
|
// LastSeenKey is the session key holding the Unix timestamp of
|
||||||
|
// the most recent authenticated request. It anchors the IDLE
|
||||||
|
// expiry clock and is pushed forward by Touch.
|
||||||
|
LastSeenKey = "last_seen"
|
||||||
|
|
||||||
// sessionKeyLength is the required length in bytes for the
|
// sessionKeyLength is the required length in bytes for the
|
||||||
// session authentication key.
|
// session authentication key.
|
||||||
sessionKeyLength = 32
|
sessionKeyLength = 32
|
||||||
@@ -41,6 +54,19 @@ const (
|
|||||||
|
|
||||||
// secondsPerDay is the number of seconds in a day.
|
// secondsPerDay is the number of seconds in a day.
|
||||||
secondsPerDay = 86400
|
secondsPerDay = 86400
|
||||||
|
|
||||||
|
// sessionAbsoluteMaxAge is the hard upper bound on how long a
|
||||||
|
// session may live, measured from CreatedAtKey. Activity never
|
||||||
|
// extends it, so even a continuously used session ends here and
|
||||||
|
// the user has to authenticate again.
|
||||||
|
sessionAbsoluteMaxAge = sessionMaxAgeDays * secondsPerDay * time.Second
|
||||||
|
|
||||||
|
// idleRefreshDivisor rate-limits idle-deadline refreshes. Touch
|
||||||
|
// only rewrites LastSeenKey once the stored value is older than
|
||||||
|
// idleTimeout/idleRefreshDivisor, so an active session is
|
||||||
|
// re-saved at most this many times per idle window instead of
|
||||||
|
// once per request. See Touch for the tradeoff this buys.
|
||||||
|
idleRefreshDivisor = 10
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrSessionKeyLength is returned when the decoded session key
|
// ErrSessionKeyLength is returned when the decoded session key
|
||||||
@@ -62,6 +88,16 @@ type Session struct {
|
|||||||
key []byte // raw 32-byte auth key, also used for CSRF cookie signing
|
key []byte // raw 32-byte auth key, also used for CSRF cookie signing
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
config *config.Config
|
config *config.Config
|
||||||
|
|
||||||
|
// idleTimeout is the sliding inactivity window. A session that
|
||||||
|
// sees no authenticated request within this window expires,
|
||||||
|
// independently of the absolute cap. Non-positive disables idle
|
||||||
|
// expiry and leaves sessionAbsoluteMaxAge as the only bound.
|
||||||
|
idleTimeout time.Duration
|
||||||
|
|
||||||
|
// now reads the current time. Injected so expiry can be tested
|
||||||
|
// without sleeping.
|
||||||
|
now func() time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new session manager. The cookie store is
|
// New creates a new session manager. The cookie store is
|
||||||
@@ -73,8 +109,10 @@ func New(
|
|||||||
params Params,
|
params Params,
|
||||||
) (*Session, error) {
|
) (*Session, error) {
|
||||||
s := &Session{
|
s := &Session{
|
||||||
log: params.Logger.Get(),
|
log: params.Logger.Get(),
|
||||||
config: params.Config,
|
config: params.Config,
|
||||||
|
idleTimeout: params.Config.SessionIdleTimeout,
|
||||||
|
now: time.Now,
|
||||||
}
|
}
|
||||||
|
|
||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
@@ -149,29 +187,98 @@ func (s *Session) Save(
|
|||||||
return sess.Save(r, w)
|
return sess.Save(r, w)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetUser sets the user information in the session.
|
// SetUser sets the user information in the session. It starts both
|
||||||
|
// expiry clocks: CreatedAtKey (absolute, never refreshed again) and
|
||||||
|
// LastSeenKey (idle, refreshed by Touch).
|
||||||
func (s *Session) SetUser(
|
func (s *Session) SetUser(
|
||||||
sess *sessions.Session,
|
sess *sessions.Session,
|
||||||
userID, username string,
|
userID, username string,
|
||||||
) {
|
) {
|
||||||
|
now := s.now().Unix()
|
||||||
|
|
||||||
sess.Values[UserIDKey] = userID
|
sess.Values[UserIDKey] = userID
|
||||||
sess.Values[UsernameKey] = username
|
sess.Values[UsernameKey] = username
|
||||||
sess.Values[AuthenticatedKey] = true
|
sess.Values[AuthenticatedKey] = true
|
||||||
|
sess.Values[CreatedAtKey] = now
|
||||||
|
sess.Values[LastSeenKey] = now
|
||||||
}
|
}
|
||||||
|
|
||||||
// ClearUser removes user information from the session.
|
// ClearUser removes user information from the session, including
|
||||||
|
// both expiry timestamps.
|
||||||
func (s *Session) ClearUser(sess *sessions.Session) {
|
func (s *Session) ClearUser(sess *sessions.Session) {
|
||||||
delete(sess.Values, UserIDKey)
|
delete(sess.Values, UserIDKey)
|
||||||
delete(sess.Values, UsernameKey)
|
delete(sess.Values, UsernameKey)
|
||||||
delete(sess.Values, AuthenticatedKey)
|
delete(sess.Values, AuthenticatedKey)
|
||||||
|
delete(sess.Values, CreatedAtKey)
|
||||||
|
delete(sess.Values, LastSeenKey)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsAuthenticated checks if the session has an authenticated
|
// sessionTime reads a Unix-second timestamp stored under key.
|
||||||
// user.
|
func sessionTime(
|
||||||
|
sess *sessions.Session,
|
||||||
|
key string,
|
||||||
|
) (time.Time, bool) {
|
||||||
|
secs, ok := sess.Values[key].(int64)
|
||||||
|
if !ok {
|
||||||
|
return time.Time{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return time.Unix(secs, 0), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAuthenticated checks if the session has an authenticated user
|
||||||
|
// whose session has not passed either expiry deadline. Every
|
||||||
|
// authentication decision goes through here, so neither clock can
|
||||||
|
// be bypassed by a caller that forgets to check it.
|
||||||
func (s *Session) IsAuthenticated(sess *sessions.Session) bool {
|
func (s *Session) IsAuthenticated(sess *sessions.Session) bool {
|
||||||
auth, ok := sess.Values[AuthenticatedKey].(bool)
|
auth, ok := sess.Values[AuthenticatedKey].(bool)
|
||||||
|
if !ok || !auth {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
return ok && auth
|
return !s.expired(sess)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Touch records authenticated activity by pushing the IDLE deadline
|
||||||
|
// forward. It writes LastSeenKey only; CreatedAtKey is left alone so
|
||||||
|
// the absolute cap keeps counting down even for a user who never
|
||||||
|
// stops clicking.
|
||||||
|
//
|
||||||
|
// Callers must only invoke Touch for a request that authenticated
|
||||||
|
// with this session. Refreshing on an unauthenticated request would
|
||||||
|
// let anyone holding a stolen or abandoned cookie keep the session
|
||||||
|
// alive by polling a public endpoint. Touch enforces that itself by
|
||||||
|
// returning false for any session that is not currently
|
||||||
|
// authenticated and unexpired.
|
||||||
|
//
|
||||||
|
// To avoid re-encrypting and re-emitting the session cookie on every
|
||||||
|
// single request, the timestamp is advanced only once it is older
|
||||||
|
// than idleTimeout/idleRefreshDivisor. The tradeoff is that
|
||||||
|
// LastSeenKey lags real activity by up to that much, so a session
|
||||||
|
// can expire slightly early relative to the user's true last
|
||||||
|
// request -- never late.
|
||||||
|
//
|
||||||
|
// Touch reports whether it changed the session; only then does the
|
||||||
|
// caller need to save it.
|
||||||
|
func (s *Session) Touch(sess *sessions.Session) bool {
|
||||||
|
if s.idleTimeout <= 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if !s.IsAuthenticated(sess) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
now := s.now()
|
||||||
|
|
||||||
|
lastSeen, ok := sessionTime(sess, LastSeenKey)
|
||||||
|
if ok && now.Sub(lastSeen) < s.idleTimeout/idleRefreshDivisor {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
sess.Values[LastSeenKey] = now.Unix()
|
||||||
|
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetUserID retrieves the user ID from the session.
|
// GetUserID retrieves the user ID from the session.
|
||||||
@@ -253,3 +360,41 @@ func (s *Session) Regenerate(
|
|||||||
|
|
||||||
return newSess, nil
|
return newSess, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// expired reports whether the session has passed either of its two
|
||||||
|
// independent deadlines. They are deliberately kept apart:
|
||||||
|
//
|
||||||
|
// - the ABSOLUTE deadline is CreatedAtKey + sessionAbsoluteMaxAge.
|
||||||
|
// It is fixed at login and no amount of activity moves it.
|
||||||
|
// - the IDLE deadline is LastSeenKey + idleTimeout. Activity moves
|
||||||
|
// it forward via Touch.
|
||||||
|
//
|
||||||
|
// Whichever comes first ends the session.
|
||||||
|
//
|
||||||
|
// A session that claims to be authenticated but carries no
|
||||||
|
// timestamps predates this check; it is treated as expired so the
|
||||||
|
// user re-authenticates rather than being granted an unbounded
|
||||||
|
// session.
|
||||||
|
func (s *Session) expired(sess *sessions.Session) bool {
|
||||||
|
now := s.now()
|
||||||
|
|
||||||
|
createdAt, ok := sessionTime(sess, CreatedAtKey)
|
||||||
|
if !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if !now.Before(createdAt.Add(sessionAbsoluteMaxAge)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.idleTimeout <= 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
lastSeen, ok := sessionTime(sess, LastSeenKey)
|
||||||
|
if !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return !now.Before(lastSeen.Add(s.idleTimeout))
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import (
|
|||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"os"
|
"os"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -17,11 +18,47 @@ import (
|
|||||||
|
|
||||||
const testKeySize = 32
|
const testKeySize = 32
|
||||||
|
|
||||||
// testSession creates a Session with a real cookie store for
|
// testIdleTimeout is the idle window used by the expiry tests.
|
||||||
// testing.
|
const testIdleTimeout = time.Hour
|
||||||
|
|
||||||
|
// testAbsoluteMaxAge restates the documented absolute session cap
|
||||||
|
// independently of the implementation constant.
|
||||||
|
const testAbsoluteMaxAge = 7 * 24 * time.Hour
|
||||||
|
|
||||||
|
// fakeClock is a manually advanced clock, so expiry can be tested
|
||||||
|
// without sleeping.
|
||||||
|
type fakeClock struct {
|
||||||
|
t time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Now() time.Time {
|
||||||
|
return c.t
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *fakeClock) Advance(d time.Duration) {
|
||||||
|
c.t = c.t.Add(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// testSession creates a Session with a real cookie store and the
|
||||||
|
// real clock.
|
||||||
func testSession(t *testing.T) *session.Session {
|
func testSession(t *testing.T) *session.Session {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
s, _ := testSessionWithClock(t, testIdleTimeout, nil)
|
||||||
|
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// testSessionWithClock creates a Session with a real cookie store,
|
||||||
|
// the given idle timeout, and a manually advanced clock. Passing a
|
||||||
|
// nil clock uses the real one.
|
||||||
|
func testSessionWithClock(
|
||||||
|
t *testing.T,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
clock *fakeClock,
|
||||||
|
) (*session.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
key := make([]byte, testKeySize)
|
key := make([]byte, testKeySize)
|
||||||
|
|
||||||
for i := range key {
|
for i := range key {
|
||||||
@@ -38,7 +75,8 @@ func testSession(t *testing.T) *session.Session {
|
|||||||
}
|
}
|
||||||
|
|
||||||
cfg := &config.Config{
|
cfg := &config.Config{
|
||||||
Environment: config.EnvironmentDev,
|
Environment: config.EnvironmentDev,
|
||||||
|
SessionIdleTimeout: idleTimeout,
|
||||||
}
|
}
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
@@ -46,7 +84,46 @@ func testSession(t *testing.T) *session.Session {
|
|||||||
&slog.HandlerOptions{Level: slog.LevelDebug},
|
&slog.HandlerOptions{Level: slog.LevelDebug},
|
||||||
))
|
))
|
||||||
|
|
||||||
return session.NewForTest(store, cfg, log, key)
|
var now func() time.Time
|
||||||
|
|
||||||
|
if clock != nil {
|
||||||
|
now = clock.Now
|
||||||
|
}
|
||||||
|
|
||||||
|
return session.NewForTest(store, cfg, log, key, now), clock
|
||||||
|
}
|
||||||
|
|
||||||
|
// newFakeClock returns a clock started at a fixed instant.
|
||||||
|
func newFakeClock() *fakeClock {
|
||||||
|
return &fakeClock{
|
||||||
|
t: time.Date(
|
||||||
|
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// authenticatedSession returns a fresh session that has just been
|
||||||
|
// logged in, along with its manager and clock.
|
||||||
|
func authenticatedSession(
|
||||||
|
t *testing.T,
|
||||||
|
idleTimeout time.Duration,
|
||||||
|
) (*session.Session, *sessions.Session, *fakeClock) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
s, clock := testSessionWithClock(
|
||||||
|
t, idleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s.SetUser(sess, "user-123", "alice")
|
||||||
|
require.True(t, s.IsAuthenticated(sess))
|
||||||
|
|
||||||
|
return s, sess, clock
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Get and Save Tests ---
|
// --- Get and Save Tests ---
|
||||||
@@ -430,6 +507,263 @@ func TestSessionConstants(t *testing.T) {
|
|||||||
assert.Equal(t, "user_id", session.UserIDKey)
|
assert.Equal(t, "user_id", session.UserIDKey)
|
||||||
assert.Equal(t, "username", session.UsernameKey)
|
assert.Equal(t, "username", session.UsernameKey)
|
||||||
assert.Equal(t, "authenticated", session.AuthenticatedKey)
|
assert.Equal(t, "authenticated", session.AuthenticatedKey)
|
||||||
|
assert.Equal(t, "created_at", session.CreatedAtKey)
|
||||||
|
assert.Equal(t, "last_seen", session.LastSeenKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Expiry Tests ---
|
||||||
|
|
||||||
|
func TestSetUser_StartsBothClocks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
_, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
assert.Equal(
|
||||||
|
t, clock.Now().Unix(), sess.Values[session.CreatedAtKey],
|
||||||
|
"SetUser should anchor the absolute clock",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, clock.Now().Unix(), sess.Values[session.LastSeenKey],
|
||||||
|
"SetUser should anchor the idle clock",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_WithinIdleWindow(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout - time.Second)
|
||||||
|
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"session should still be valid just inside the idle window",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_IdleExpired(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"session should expire once the idle window lapses",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTouch_DoesNotExtendAbsoluteCap is the regression test for the
|
||||||
|
// refresh-the-wrong-clock bug: a session that is used continuously
|
||||||
|
// must survive well past the idle window and still die at the
|
||||||
|
// absolute cap.
|
||||||
|
func TestTouch_DoesNotExtendAbsoluteCap(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
createdAt := sess.Values[session.CreatedAtKey]
|
||||||
|
|
||||||
|
// Stay active: a request every half idle window, right up to
|
||||||
|
// the absolute cap.
|
||||||
|
step := testIdleTimeout / 2
|
||||||
|
steps := int(testAbsoluteMaxAge/step) - 1
|
||||||
|
|
||||||
|
for i := range steps {
|
||||||
|
clock.Advance(step)
|
||||||
|
s.Touch(sess)
|
||||||
|
|
||||||
|
require.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"active session should survive the idle window "+
|
||||||
|
"(step %d of %d)", i+1, steps,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// One more step of activity takes the session to exactly the
|
||||||
|
// absolute cap, measured from login. Nothing that happened in
|
||||||
|
// the loop may have moved that deadline.
|
||||||
|
clock.Advance(step)
|
||||||
|
s.Touch(sess)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"activity must not extend the absolute cap",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, createdAt, sess.Values[session.CreatedAtKey],
|
||||||
|
"Touch must never rewrite the absolute-clock anchor",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_RefreshesIdleDeadline(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
// Halfway through the window, activity happens.
|
||||||
|
clock.Advance(testIdleTimeout / 2)
|
||||||
|
assert.True(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should refresh once past the lazy-refresh threshold",
|
||||||
|
)
|
||||||
|
|
||||||
|
// Past the original deadline, but inside the refreshed one.
|
||||||
|
clock.Advance(testIdleTimeout - time.Second)
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"refreshed session should outlive the original deadline",
|
||||||
|
)
|
||||||
|
|
||||||
|
// And it still expires an idle window after that activity.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"refreshed session should expire one window after activity",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_LazyBelowRefreshThreshold(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
before := sess.Values[session.LastSeenKey]
|
||||||
|
|
||||||
|
// A request arriving almost immediately is not worth a cookie
|
||||||
|
// rewrite.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should not rewrite the session below the threshold",
|
||||||
|
)
|
||||||
|
assert.Equal(
|
||||||
|
t, before, sess.Values[session.LastSeenKey],
|
||||||
|
"last-seen should be unchanged below the threshold",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_UnauthenticatedSessionIsNotRefreshed(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, clock := testSessionWithClock(
|
||||||
|
t, testIdleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout / 2)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"an unauthenticated session must not be refreshed",
|
||||||
|
)
|
||||||
|
|
||||||
|
_, hasLastSeen := sess.Values[session.LastSeenKey]
|
||||||
|
assert.False(
|
||||||
|
t, hasLastSeen,
|
||||||
|
"Touch must not stamp an unauthenticated session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTouch_IdleExpiredSessionIsNotRevived(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
clock.Advance(testIdleTimeout)
|
||||||
|
require.False(t, s.IsAuthenticated(sess))
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"an already expired session must not be refreshed",
|
||||||
|
)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"Touch must not revive an expired session",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_MissingTimestamps(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, _ := testSessionWithClock(
|
||||||
|
t, testIdleTimeout, newFakeClock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
context.Background(), http.MethodGet, "/", nil)
|
||||||
|
|
||||||
|
sess, err := s.Get(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// A session from before idle expiry existed: authenticated,
|
||||||
|
// but with no timestamps. Fail closed.
|
||||||
|
sess.Values[session.AuthenticatedKey] = true
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"a session with no timestamps should be rejected",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAuthenticated_MissingLastSeen(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, _ := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
delete(sess.Values, session.LastSeenKey)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"a session with no idle anchor should be rejected",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdleTimeoutDisabled_AbsoluteCapStillApplies(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, clock := authenticatedSession(t, 0)
|
||||||
|
|
||||||
|
// Idle expiry is off, so an untouched session survives an
|
||||||
|
// arbitrary idle stretch.
|
||||||
|
clock.Advance(testAbsoluteMaxAge - time.Second)
|
||||||
|
assert.True(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"idle expiry should be disabled by a non-positive timeout",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert.False(
|
||||||
|
t, s.Touch(sess),
|
||||||
|
"Touch should be a no-op when idle expiry is disabled",
|
||||||
|
)
|
||||||
|
|
||||||
|
// The absolute cap still ends it.
|
||||||
|
clock.Advance(time.Second)
|
||||||
|
assert.False(
|
||||||
|
t, s.IsAuthenticated(sess),
|
||||||
|
"the absolute cap must still apply with idle expiry off",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClearUser_RemovesTimestamps(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
s, sess, _ := authenticatedSession(t, testIdleTimeout)
|
||||||
|
|
||||||
|
s.ClearUser(sess)
|
||||||
|
|
||||||
|
_, hasCreatedAt := sess.Values[session.CreatedAtKey]
|
||||||
|
assert.False(t, hasCreatedAt, "CreatedAtKey should be removed")
|
||||||
|
|
||||||
|
_, hasLastSeen := sess.Values[session.LastSeenKey]
|
||||||
|
assert.False(t, hasLastSeen, "LastSeenKey should be removed")
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Edge Cases ---
|
// --- Edge Cases ---
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package session
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/sessions"
|
"github.com/gorilla/sessions"
|
||||||
"sneak.berlin/go/webhooker/internal/config"
|
"sneak.berlin/go/webhooker/internal/config"
|
||||||
@@ -12,16 +13,28 @@ import (
|
|||||||
// middleware and handler tests to use real session functionality. The key
|
// middleware and handler tests to use real session functionality. The key
|
||||||
// parameter is the raw 32-byte authentication key used for session encryption
|
// parameter is the raw 32-byte authentication key used for session encryption
|
||||||
// and CSRF cookie signing.
|
// and CSRF cookie signing.
|
||||||
|
//
|
||||||
|
// The idle timeout is taken from cfg.SessionIdleTimeout, exactly as in
|
||||||
|
// production. The now parameter supplies the clock used for expiry
|
||||||
|
// checks so tests can advance time without sleeping; pass nil for the
|
||||||
|
// real clock.
|
||||||
func NewForTest(
|
func NewForTest(
|
||||||
store *sessions.CookieStore,
|
store *sessions.CookieStore,
|
||||||
cfg *config.Config,
|
cfg *config.Config,
|
||||||
log *slog.Logger,
|
log *slog.Logger,
|
||||||
key []byte,
|
key []byte,
|
||||||
|
now func() time.Time,
|
||||||
) *Session {
|
) *Session {
|
||||||
|
if now == nil {
|
||||||
|
now = time.Now
|
||||||
|
}
|
||||||
|
|
||||||
return &Session{
|
return &Session{
|
||||||
store: store,
|
store: store,
|
||||||
key: key,
|
key: key,
|
||||||
config: cfg,
|
config: cfg,
|
||||||
log: log,
|
log: log,
|
||||||
|
idleTimeout: cfg.SessionIdleTimeout,
|
||||||
|
now: now,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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