* docs(autoscan): add arr webhook intake spec and implementation plan Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): add webhook intake schema migration Adds delivery_mode to autoscan_sources, the autoscan_webhook_endpoints table, and delivery_mode/provider_event_type on autoscan_events. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): add built-in arr-webhook source identity Host-discovered scan-source entry so webhook-mode sources need no plugin installation; composite lister appends it to plugin discovery. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): persist delivery mode, webhook endpoints, event metadata Sources carry delivery_mode; autoscan_webhook_endpoints CRUD with SHA-256 token lookup and AAD-bound encrypted redisplay; events record delivery_mode/provider_event_type; CreateEvent gains SkipRunningCheck so webhook deliveries are never dropped by the poll exclusion. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): share the consume path and add webhook IngestChanges Extracts consumeSourceChanges from PollOnce (marker semantics preserved, existing poll tests unchanged); PollOnce skips webhook sources; IngestChanges feeds deliveries through the shared pipeline without markers and without the running-event exclusion. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): add Sonarr/Radarr webhook payload parser Host-side arrwebhook package: provider inference, import/rename/delete path extraction with vanished-path-friendly previous paths, subtree fallback, exact-path dedupe, and no-op unknown events. Fixture-backed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(autoscan): add public webhook delivery route and admin endpoint management Public POST /api/v1/autoscan/webhooks/{token} with per-IP rate limiting, 256KiB body cap, 202-for-noop semantics, and token/body kept out of logs; admin create/rotate/delete endpoint routes; source responses carry delivery mode + webhook status/URL; create/update validate delivery mode against source identity. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(web): add webhook delivery mode to Autoscan admin UI Webhook sources get a generate/copy/rotate webhook URL section, provider selector, delivery status, and a connection-free Add-source flow; activity rows badge webhook deliveries with the arr event type. Path rewrites stay editable in both modes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(api): redact secret path params from request and activity logs The request logger and activity-log middleware recorded raw URLs, so bearer credentials in secret path segments (autoscan webhook {token}, webhook-sync {secret}) were persisted to app logs and activity_log. Redact the secret segment via the chi route params in both sinks. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(autoscan): make webhook delivery reliable --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
425 lines
15 KiB
Go
425 lines
15 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/autoscan"
|
|
)
|
|
|
|
const testWebhookToken = "wh_test_token_abcdef123456"
|
|
|
|
func webhookSource(enabled bool) autoscan.Source {
|
|
return autoscan.Source{
|
|
ID: "src-1",
|
|
PluginID: autoscan.BuiltinArrWebhookPluginID,
|
|
CapabilityID: autoscan.BuiltinArrWebhookCapabilityID,
|
|
Enabled: enabled,
|
|
DeliveryMode: autoscan.DeliveryModeWebhook,
|
|
SourceConfig: map[string]string{"webhook_provider": "auto"},
|
|
}
|
|
}
|
|
|
|
// webhookStore returns a store whose resolveTokenFn accepts testWebhookToken.
|
|
func webhookStore(source autoscan.Source, settingsEnabled bool) *fakeAutoscanStore {
|
|
return &fakeAutoscanStore{
|
|
getSettingsFn: func() (autoscan.Settings, error) {
|
|
return autoscan.Settings{Enabled: settingsEnabled, DefaultPollIntervalSeconds: 600, DebounceSeconds: 60}, nil
|
|
},
|
|
resolveTokenFn: func(token string) (autoscan.Source, autoscan.WebhookEndpoint, error) {
|
|
if token == testWebhookToken {
|
|
return source, autoscan.WebhookEndpoint{SourceID: source.ID}, nil
|
|
}
|
|
return autoscan.Source{}, autoscan.WebhookEndpoint{}, autoscan.ErrNotFound
|
|
},
|
|
}
|
|
}
|
|
|
|
func newWebhookDeliveryRequest(token, body string) *http.Request {
|
|
r := httptest.NewRequest(http.MethodPost, "/api/v1/autoscan/webhooks/"+token, strings.NewReader(body))
|
|
routeCtx := chi.NewRouteContext()
|
|
routeCtx.URLParams.Add("token", token)
|
|
return r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx))
|
|
}
|
|
|
|
const sonarrDownloadBody = `{
|
|
"eventType": "Download",
|
|
"series": {"path": "/data/tv/Show"},
|
|
"episodeFile": {"path": "/data/tv/Show/Season 01/e01.mkv"}
|
|
}`
|
|
|
|
func TestWebhookDeliveryIngestsAndAccepts(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{ingestResult: autoscan.IngestResult{Enqueued: 1}}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, sonarrDownloadBody))
|
|
|
|
if rec.Code != http.StatusAccepted {
|
|
t.Fatalf("status = %d, want 202 (%s)", rec.Code, rec.Body.String())
|
|
}
|
|
if len(svc.ingested) != 1 {
|
|
t.Fatalf("ingested = %+v, want one call", svc.ingested)
|
|
}
|
|
in := svc.ingested[0]
|
|
if in.SourceID != "src-1" || in.ProviderEventType != "Download" || len(in.Changes) != 1 {
|
|
t.Fatalf("unexpected ingest input: %+v", in)
|
|
}
|
|
if in.Changes[0].SourcePath != "/data/tv/Show/Season 01/e01.mkv" {
|
|
t.Fatalf("change path = %q", in.Changes[0].SourcePath)
|
|
}
|
|
if len(store.touchedSources) != 1 || store.touchedSources[0] != "src-1" {
|
|
t.Fatalf("touched = %+v, want src-1", store.touchedSources)
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryUnknownTokenIs404(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest("bogus-token", sonarrDownloadBody))
|
|
|
|
if rec.Code != http.StatusNotFound {
|
|
t.Fatalf("status = %d, want 404", rec.Code)
|
|
}
|
|
if len(svc.ingested) != 0 {
|
|
t.Fatalf("unknown token must not ingest, got %+v", svc.ingested)
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryTestEventIsAcceptedNoOp(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken,
|
|
`{"eventType": "Test", "series": {"path": "C:\\testpath"}}`))
|
|
|
|
if rec.Code != http.StatusAccepted {
|
|
t.Fatalf("status = %d, want 202", rec.Code)
|
|
}
|
|
if len(svc.ingested) != 0 {
|
|
t.Fatalf("test event must not ingest, got %+v", svc.ingested)
|
|
}
|
|
if len(store.touchedSources) != 1 {
|
|
t.Fatalf("test event must stamp last_received_at, touched = %+v", store.touchedSources)
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryUnknownEventTypeIsAcceptedNoOp(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken,
|
|
`{"eventType": "Health", "series": {"path": "/data/tv/Show"}}`))
|
|
|
|
if rec.Code != http.StatusAccepted {
|
|
t.Fatalf("status = %d, want 202", rec.Code)
|
|
}
|
|
if len(svc.ingested) != 0 {
|
|
t.Fatalf("unknown event must not ingest, got %+v", svc.ingested)
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryDisabledSourceIsAcceptedNoOp(t *testing.T) {
|
|
for name, tc := range map[string]struct {
|
|
sourceEnabled bool
|
|
settingsEnabled bool
|
|
}{
|
|
"source disabled": {sourceEnabled: false, settingsEnabled: true},
|
|
"autoscan disabled": {sourceEnabled: true, settingsEnabled: false},
|
|
} {
|
|
t.Run(name, func(t *testing.T) {
|
|
store := webhookStore(webhookSource(tc.sourceEnabled), tc.settingsEnabled)
|
|
svc := &fakeAutoscanTriggerer{}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, sonarrDownloadBody))
|
|
|
|
if rec.Code != http.StatusAccepted {
|
|
t.Fatalf("status = %d, want 202", rec.Code)
|
|
}
|
|
if len(svc.ingested) != 0 {
|
|
t.Fatalf("disabled state must not ingest, got %+v", svc.ingested)
|
|
}
|
|
if len(store.touchedSources) != 1 {
|
|
t.Fatalf("valid delivery must stamp last_received_at even while disabled")
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryMalformedBodyIs400(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, "{not json"))
|
|
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400", rec.Code)
|
|
}
|
|
if store.webhookErrs["src-1"] == "" {
|
|
t.Fatal("parse failure must be recorded on the endpoint")
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryOversizedBodyIs413(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
h := NewAutoscanHandler(store, &fakeAutoscanTriggerer{})
|
|
|
|
big := `{"eventType": "Download", "pad": "` + strings.Repeat("x", maxWebhookBodyBytes+1) + `"}`
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, big))
|
|
|
|
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
t.Fatalf("status = %d, want 413", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryDurableAcceptanceFailureIs500(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{ingestErr: context.DeadlineExceeded}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, sonarrDownloadBody))
|
|
|
|
if rec.Code != http.StatusInternalServerError {
|
|
t.Fatalf("status = %d, want 500 when the delivery could not be persisted", rec.Code)
|
|
}
|
|
if store.webhookErrs["src-1"] == "" {
|
|
t.Fatal("ingest failure must be recorded on the endpoint")
|
|
}
|
|
}
|
|
|
|
func TestWebhookDeliveryPendingRetryIsAccepted(t *testing.T) {
|
|
store := webhookStore(webhookSource(true), true)
|
|
svc := &fakeAutoscanTriggerer{ingestResult: autoscan.IngestResult{Pending: true}}
|
|
h := NewAutoscanHandler(store, svc)
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, sonarrDownloadBody))
|
|
|
|
if rec.Code != http.StatusAccepted {
|
|
t.Fatalf("status = %d, want 202 for a durably queued retry", rec.Code)
|
|
}
|
|
}
|
|
|
|
// recordingLogHandler captures every log record produced during a test.
|
|
type recordingLogHandler struct {
|
|
mu sync.Mutex
|
|
entries []string
|
|
}
|
|
|
|
func (h *recordingLogHandler) Enabled(context.Context, slog.Level) bool { return true }
|
|
func (h *recordingLogHandler) Handle(_ context.Context, r slog.Record) error {
|
|
var b strings.Builder
|
|
b.WriteString(r.Message)
|
|
r.Attrs(func(a slog.Attr) bool {
|
|
b.WriteString(" ")
|
|
b.WriteString(a.String())
|
|
return true
|
|
})
|
|
h.mu.Lock()
|
|
h.entries = append(h.entries, b.String())
|
|
h.mu.Unlock()
|
|
return nil
|
|
}
|
|
func (h *recordingLogHandler) WithAttrs([]slog.Attr) slog.Handler { return h }
|
|
func (h *recordingLogHandler) WithGroup(string) slog.Handler { return h }
|
|
|
|
func TestWebhookDeliveryNeverLogsToken(t *testing.T) {
|
|
recorder := &recordingLogHandler{}
|
|
prev := slog.Default()
|
|
slog.SetDefault(slog.New(recorder))
|
|
defer slog.SetDefault(prev)
|
|
|
|
store := webhookStore(webhookSource(true), true)
|
|
// Force both the failure and success logging paths.
|
|
for _, svc := range []*fakeAutoscanTriggerer{
|
|
{ingestErr: context.DeadlineExceeded},
|
|
{ingestResult: autoscan.IngestResult{Enqueued: 1}},
|
|
} {
|
|
h := NewAutoscanHandler(store, svc)
|
|
rec := httptest.NewRecorder()
|
|
h.HandleWebhookDelivery(rec, newWebhookDeliveryRequest(testWebhookToken, sonarrDownloadBody))
|
|
}
|
|
|
|
recorder.mu.Lock()
|
|
defer recorder.mu.Unlock()
|
|
for _, entry := range recorder.entries {
|
|
if strings.Contains(entry, testWebhookToken) {
|
|
t.Fatalf("log entry leaks the webhook token: %s", entry)
|
|
}
|
|
if strings.Contains(entry, "/data/tv/Show/Season 01") {
|
|
t.Fatalf("log entry leaks payload content: %s", entry)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestResolveDeliveryMode(t *testing.T) {
|
|
builtin := autoscan.BuiltinArrWebhookPluginID
|
|
builtinCap := autoscan.BuiltinArrWebhookCapabilityID
|
|
cases := []struct {
|
|
name string
|
|
requested string
|
|
pluginID string
|
|
capID string
|
|
want string
|
|
wantErr bool
|
|
}{
|
|
{"plugin defaults to poll", "", "sonarr", "arr", autoscan.DeliveryModePoll, false},
|
|
{"builtin defaults to webhook", "", builtin, builtinCap, autoscan.DeliveryModeWebhook, false},
|
|
{"plugin poll ok", "poll", "sonarr", "arr", autoscan.DeliveryModePoll, false},
|
|
{"builtin webhook ok", "webhook", builtin, builtinCap, autoscan.DeliveryModeWebhook, false},
|
|
{"plugin webhook rejected", "webhook", "sonarr", "arr", "", true},
|
|
{"builtin poll rejected", "poll", builtin, builtinCap, "", true},
|
|
{"garbage rejected", "carrier-pigeon", "sonarr", "arr", "", true},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
got, err := resolveDeliveryMode(tc.requested, tc.pluginID, tc.capID)
|
|
if tc.wantErr != (err != nil) {
|
|
t.Fatalf("err = %v, wantErr = %v", err, tc.wantErr)
|
|
}
|
|
if got != tc.want {
|
|
t.Fatalf("mode = %q, want %q", got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestValidateWebhookProvider(t *testing.T) {
|
|
for _, ok := range []string{"auto", "sonarr", "radarr", "", "Sonarr"} {
|
|
if err := validateWebhookProvider(map[string]string{"webhook_provider": ok}); err != nil {
|
|
t.Fatalf("provider %q must validate: %v", ok, err)
|
|
}
|
|
}
|
|
if err := validateWebhookProvider(map[string]string{"webhook_provider": "lidarr"}); err == nil {
|
|
t.Fatal("unsupported provider must be rejected")
|
|
}
|
|
if err := validateWebhookProvider(map[string]string{}); err != nil {
|
|
t.Fatalf("absent provider must validate: %v", err)
|
|
}
|
|
}
|
|
|
|
func TestUpdatePollSourceAllowsPluginWebhookProviderKey(t *testing.T) {
|
|
existing := autoscan.Source{
|
|
ID: "src-1",
|
|
PluginID: "example.plugin",
|
|
CapabilityID: "source",
|
|
DeliveryMode: autoscan.DeliveryModePoll,
|
|
}
|
|
var saved autoscan.Source
|
|
store := &fakeAutoscanStore{
|
|
getSourceFn: func(string) (autoscan.Source, error) { return existing, nil },
|
|
updateSourceFn: func(source autoscan.Source) (autoscan.Source, error) {
|
|
saved = source
|
|
return source, nil
|
|
},
|
|
}
|
|
h := NewAutoscanHandler(store, &fakeAutoscanTriggerer{})
|
|
body := `{"enabled":true,"delivery_mode":"poll","path_rewrites":[],"source_config":{"webhook_provider":"plugin-specific"}}`
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleUpdateSource(rec, newAutoscanRequest(http.MethodPut, "/admin/autoscan/sources/src-1", body, "src-1"))
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 (%s)", rec.Code, rec.Body.String())
|
|
}
|
|
if got := saved.SourceConfig["webhook_provider"]; got != "plugin-specific" {
|
|
t.Fatalf("plugin source config = %q, want unchanged", got)
|
|
}
|
|
}
|
|
|
|
// --- Admin endpoint management ---
|
|
|
|
func TestCreateSourceWebhookRequiresWebhookMode(t *testing.T) {
|
|
store := &fakeAutoscanStore{
|
|
getSourceFn: func(id string) (autoscan.Source, error) {
|
|
return autoscan.Source{ID: id, DeliveryMode: autoscan.DeliveryModePoll}, nil
|
|
},
|
|
}
|
|
h := NewAutoscanHandler(store, &fakeAutoscanTriggerer{})
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleCreateSourceWebhook(rec, newAutoscanRequest(http.MethodPost, "/admin/autoscan/sources/s1/webhook", "", "s1"))
|
|
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Fatalf("status = %d, want 400 for poll-mode source", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestCreateSourceWebhookReturnsURL(t *testing.T) {
|
|
source := webhookSource(true)
|
|
store := &fakeAutoscanStore{
|
|
getSourceFn: func(string) (autoscan.Source, error) { return source, nil },
|
|
createWebhookFn: func(sourceID string) (autoscan.WebhookEndpoint, string, error) {
|
|
return autoscan.WebhookEndpoint{SourceID: sourceID, SecretSuffix: "def456"}, testWebhookToken, nil
|
|
},
|
|
getWebhookFn: func(sourceID string) (autoscan.WebhookEndpoint, error) {
|
|
return autoscan.WebhookEndpoint{SourceID: sourceID, SecretSuffix: "def456"}, nil
|
|
},
|
|
revealTokenFn: func(string) (string, error) { return testWebhookToken, nil },
|
|
}
|
|
h := NewAutoscanHandler(store, &fakeAutoscanTriggerer{})
|
|
h.SetPublicURL("https://silo.example/")
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleCreateSourceWebhook(rec, newAutoscanRequest(http.MethodPost, "/admin/autoscan/sources/src-1/webhook", "", "src-1"))
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 (%s)", rec.Code, rec.Body.String())
|
|
}
|
|
body := rec.Body.String()
|
|
wantURL := `"webhook_url":"https://silo.example/api/v1/autoscan/webhooks/` + testWebhookToken + `"`
|
|
if !strings.Contains(body, wantURL) {
|
|
t.Fatalf("response missing %s: %s", wantURL, body)
|
|
}
|
|
if !strings.Contains(body, `"webhook_configured":true`) || !strings.Contains(body, `"webhook_secret_suffix":"def456"`) {
|
|
t.Fatalf("response missing webhook status fields: %s", body)
|
|
}
|
|
}
|
|
|
|
func TestSourceResponsesOmitWebhookURLWhenRevealFails(t *testing.T) {
|
|
source := webhookSource(true)
|
|
store := &fakeAutoscanStore{
|
|
listSourcesFn: func() ([]autoscan.Source, error) { return []autoscan.Source{source}, nil },
|
|
listWebhooksFn: func() ([]autoscan.WebhookEndpoint, error) {
|
|
return []autoscan.WebhookEndpoint{{SourceID: source.ID, SecretSuffix: "def456"}}, nil
|
|
},
|
|
revealTokenFn: func(string) (string, error) { return "", context.DeadlineExceeded },
|
|
}
|
|
h := NewAutoscanHandler(store, &fakeAutoscanTriggerer{})
|
|
|
|
rec := httptest.NewRecorder()
|
|
h.HandleListSources(rec, newAutoscanRequest(http.MethodGet, "/admin/autoscan/sources", "", ""))
|
|
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200", rec.Code)
|
|
}
|
|
body := rec.Body.String()
|
|
if strings.Contains(body, "webhook_url") {
|
|
t.Fatalf("reveal failure must omit webhook_url, got %s", body)
|
|
}
|
|
if !strings.Contains(body, `"webhook_configured":true`) {
|
|
t.Fatalf("status fields must survive reveal failure: %s", body)
|
|
}
|
|
}
|