Compare commits
2 Commits
72868c0f02
...
next
| Author | SHA1 | Date | |
|---|---|---|---|
| aab448b076 | |||
| 7c43e095a6 |
4
TODO.md
4
TODO.md
@@ -26,6 +26,10 @@ capability in the README rationale).
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-08-11 Web UI cleanup: nav terminology unified on Webhooks, the
|
||||
Profile settings placeholder removed, a progressive-enhancement copy
|
||||
button for the entrypoint URL, and retention form copy that states the
|
||||
actual policy (deletion by the reaper, 0 retains forever) (#57)
|
||||
- 2026-08-09 Inactivity-based session timeout: sliding idle expiry
|
||||
(`SESSION_IDLE_TIMEOUT`, default `24h`) refreshed on authenticated
|
||||
requests, with the 7-day absolute cap kept as an independent
|
||||
|
||||
@@ -92,7 +92,12 @@ func ValidateTargetURL(
|
||||
) error {
|
||||
parsed, err := url.Parse(targetURL)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid URL: %w", err)
|
||||
// url.Parse embeds the whole URL in its error, and
|
||||
// this one is logged and shown; mask it. Every other
|
||||
// branch below reports only the hostname.
|
||||
return fmt.Errorf(
|
||||
"invalid URL: %w", maskURLError(err),
|
||||
)
|
||||
}
|
||||
|
||||
err = validateScheme(parsed.Scheme)
|
||||
|
||||
@@ -3,7 +3,6 @@ package delivery
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strconv"
|
||||
|
||||
"sneak.berlin/go/webhooker/internal/database"
|
||||
@@ -17,9 +16,6 @@ import (
|
||||
// browser history, screenshots and screen shares.
|
||||
const configUnavailable = "(unavailable)"
|
||||
|
||||
// urlPathElision stands in for a URL's elided path.
|
||||
const urlPathElision = "/..."
|
||||
|
||||
// ConfigField is one labelled, display-safe value derived
|
||||
// from a target's stored configuration.
|
||||
type ConfigField struct {
|
||||
@@ -202,23 +198,5 @@ func databaseConfigFields(configJSON string) []ConfigField {
|
||||
// parse into a scheme and host yields the neutral
|
||||
// placeholder, never the raw string.
|
||||
func (c *SlackTargetConfig) MaskedWebhookURL() string {
|
||||
return maskURL(c.WebhookURL)
|
||||
}
|
||||
|
||||
// maskURL renders a URL as scheme plus host with everything
|
||||
// that can carry a secret removed.
|
||||
func maskURL(raw string) string {
|
||||
parsed, err := url.Parse(raw)
|
||||
if err != nil || parsed.Scheme == "" ||
|
||||
parsed.Host == "" {
|
||||
return configUnavailable
|
||||
}
|
||||
|
||||
masked := parsed.Scheme + "://" + parsed.Host
|
||||
|
||||
if parsed.Path != "" && parsed.Path != "/" {
|
||||
masked += urlPathElision
|
||||
}
|
||||
|
||||
return masked
|
||||
return MaskURL(c.WebhookURL)
|
||||
}
|
||||
|
||||
@@ -363,7 +363,8 @@ func (t *httpTarget) doHTTPRequest(
|
||||
)
|
||||
if reqErr != nil {
|
||||
return 0, "", 0, fmt.Errorf(
|
||||
"creating request: %w", reqErr,
|
||||
"creating request: %w",
|
||||
maskURLError(reqErr),
|
||||
)
|
||||
}
|
||||
|
||||
@@ -492,8 +493,19 @@ func applyRequestHeaders(
|
||||
// executeHTTPRequest sends an HTTP request using the provided
|
||||
// client. URLs are validated by the config parsers and the
|
||||
// SSRF-safe transport before reaching here.
|
||||
//
|
||||
// Transport failures are masked here, at the single point
|
||||
// where every target's request errors are born, because the
|
||||
// caller stores them in DeliveryResult.Error: an unmasked
|
||||
// *url.Error would write the target URL — the credential for
|
||||
// a Slack incoming webhook — into the per-webhook database.
|
||||
func executeHTTPRequest(
|
||||
client *http.Client, req *http.Request,
|
||||
) (*http.Response, error) {
|
||||
return client.Do(req) //#nosec G704 -- validated URL, SSRF-safe transport
|
||||
resp, err := client.Do(req) //#nosec G704 -- validated URL, SSRF-safe transport
|
||||
if err != nil {
|
||||
return nil, maskURLError(err)
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
@@ -125,7 +125,7 @@ func (t *slackTarget) attempt(
|
||||
if err != nil {
|
||||
return attemptResult{
|
||||
success: false,
|
||||
errMsg: err.Error(),
|
||||
errMsg: maskURLError(err).Error(),
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
61
internal/delivery/url_mask.go
Normal file
61
internal/delivery/url_mask.go
Normal file
@@ -0,0 +1,61 @@
|
||||
package delivery
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net/url"
|
||||
)
|
||||
|
||||
// urlPathElision stands in for a URL's elided path.
|
||||
const urlPathElision = "/..."
|
||||
|
||||
// MaskURL renders a URL as scheme plus host with everything
|
||||
// that can carry a secret removed. A delivery target URL is
|
||||
// itself a credential — a Slack incoming webhook URL is a
|
||||
// bearer token — so the path, query and userinfo are never
|
||||
// reproduced, in a page, a log line or a stored error. A URL
|
||||
// that does not parse into a scheme and host yields the
|
||||
// neutral placeholder, never the raw string.
|
||||
func MaskURL(raw string) string {
|
||||
parsed, err := url.Parse(raw)
|
||||
if err != nil || parsed.Scheme == "" ||
|
||||
parsed.Host == "" {
|
||||
return configUnavailable
|
||||
}
|
||||
|
||||
masked := parsed.Scheme + "://" + parsed.Host
|
||||
|
||||
if parsed.Path != "" && parsed.Path != "/" {
|
||||
masked += urlPathElision
|
||||
}
|
||||
|
||||
return masked
|
||||
}
|
||||
|
||||
// maskURLError strips the credential from an error raised
|
||||
// against a request URL. The net/http and net/url packages
|
||||
// embed the full request URL in every *url.Error they return,
|
||||
// so an unmodified transport error persisted into
|
||||
// DeliveryResult.Error writes the credential to disk.
|
||||
//
|
||||
// The masked error keeps the operation and the wrapped cause,
|
||||
// so a DNS failure still reads differently from a refused
|
||||
// connection, a TLS handshake failure or a timeout, and Is,
|
||||
// As, Timeout and Temporary keep working on it. Only the
|
||||
// path, query and userinfo of the URL are dropped. Errors
|
||||
// that carry no URL are returned unchanged.
|
||||
//
|
||||
// Call it where the error is raised, before any wrapping: it
|
||||
// replaces the *url.Error itself, so any context wrapped
|
||||
// around it first would be discarded.
|
||||
func maskURLError(err error) error {
|
||||
var urlErr *url.Error
|
||||
if !errors.As(err, &urlErr) {
|
||||
return err
|
||||
}
|
||||
|
||||
return &url.Error{
|
||||
Op: urlErr.Op,
|
||||
URL: MaskURL(urlErr.URL),
|
||||
Err: urlErr.Err,
|
||||
}
|
||||
}
|
||||
196
internal/delivery/url_mask_test.go
Normal file
196
internal/delivery/url_mask_test.go
Normal file
@@ -0,0 +1,196 @@
|
||||
package delivery_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"gorm.io/gorm"
|
||||
"sneak.berlin/go/webhooker/internal/database"
|
||||
"sneak.berlin/go/webhooker/internal/delivery"
|
||||
)
|
||||
|
||||
// The path of a Slack incoming webhook URL is the credential:
|
||||
// whoever holds these segments can post to the channel
|
||||
// forever. None of them may reach a stored delivery error,
|
||||
// which lives on disk in the per-webhook database and is
|
||||
// serialized by the JSON tag on DeliveryResult.Error.
|
||||
const (
|
||||
maskSecretPath = "/services/T00000000/B00000000/" +
|
||||
"XXXXXXXXXXXXXXXXXXXXXXXX"
|
||||
)
|
||||
|
||||
// assertNoCredential fails if the whole path or any single
|
||||
// segment of it survived into the message, so a partial leak
|
||||
// fails the test too.
|
||||
func assertNoCredential(t *testing.T, msg string) {
|
||||
t.Helper()
|
||||
|
||||
segments := []string{
|
||||
maskSecretPath,
|
||||
"services",
|
||||
"T00000000",
|
||||
"B00000000",
|
||||
"XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||
}
|
||||
|
||||
for _, segment := range segments {
|
||||
assert.NotContains(t, msg, segment)
|
||||
}
|
||||
}
|
||||
|
||||
// storedDeliveryError returns the error string persisted for a
|
||||
// delivery, which is what an operator and any future API read.
|
||||
func storedDeliveryError(
|
||||
t *testing.T, db *gorm.DB, deliveryID string,
|
||||
) string {
|
||||
t.Helper()
|
||||
|
||||
var result database.DeliveryResult
|
||||
|
||||
require.NoError(t, db.Where(
|
||||
"delivery_id = ?", deliveryID,
|
||||
).First(&result).Error)
|
||||
|
||||
return result.Error
|
||||
}
|
||||
|
||||
// deliverSlackTo runs a Slack delivery against webhookURL and
|
||||
// returns the error string it persisted.
|
||||
func deliverSlackTo(
|
||||
t *testing.T, webhookURL string,
|
||||
) string {
|
||||
t.Helper()
|
||||
|
||||
db := testWebhookDB(t)
|
||||
e := testEngine(t, 1)
|
||||
targetID := uuid.New().String()
|
||||
|
||||
slackCfg, err := json.Marshal(
|
||||
delivery.SlackTargetConfig{
|
||||
WebhookURL: webhookURL,
|
||||
},
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
event := seedEvent(t, db, `{"test":true}`)
|
||||
|
||||
dlv := seedDelivery(
|
||||
t, db, event.ID, targetID,
|
||||
database.DeliveryStatusPending,
|
||||
)
|
||||
|
||||
d := buildSlackDelivery(
|
||||
dlv, event, targetID,
|
||||
"test-slack-mask", string(slackCfg),
|
||||
)
|
||||
|
||||
e.ExportDeliverSlack(context.TODO(), db, d)
|
||||
|
||||
assertDeliveryStatus(t, db, dlv.ID,
|
||||
database.DeliveryStatusFailed,
|
||||
)
|
||||
|
||||
return storedDeliveryError(t, db, dlv.ID)
|
||||
}
|
||||
|
||||
// TestDeliverSlack_TransportErrorMasksWebhookURL is the
|
||||
// load-bearing regression test: a transport failure must not
|
||||
// persist the webhook URL's credential into the database, and
|
||||
// must still say what went wrong and where.
|
||||
func TestDeliverSlack_TransportErrorMasksWebhookURL(
|
||||
t *testing.T,
|
||||
) {
|
||||
t.Parallel()
|
||||
|
||||
// A server closed before use gives a deterministic
|
||||
// transport failure against a known host.
|
||||
ts := httptest.NewServer(http.NewServeMux())
|
||||
host := ts.URL
|
||||
|
||||
ts.Close()
|
||||
|
||||
errMsg := deliverSlackTo(t, host+maskSecretPath)
|
||||
|
||||
require.NotEmpty(t, errMsg)
|
||||
assertNoCredential(t, errMsg)
|
||||
|
||||
// The diagnostic value survives: the operation, the host
|
||||
// and the transport failure are all still reported, and
|
||||
// only the path is elided.
|
||||
assert.Contains(t, errMsg, "sending request")
|
||||
assert.Contains(t, errMsg, "Post")
|
||||
assert.Contains(t, errMsg, host+"/...")
|
||||
assert.Contains(t, errMsg, "connection refused")
|
||||
}
|
||||
|
||||
// TestDeliverSlack_UnparsableURLMasksWebhookURL covers the
|
||||
// other error path out of a Slack attempt: url.Parse also
|
||||
// embeds the whole URL in the error it returns.
|
||||
func TestDeliverSlack_UnparsableURLMasksWebhookURL(
|
||||
t *testing.T,
|
||||
) {
|
||||
t.Parallel()
|
||||
|
||||
errMsg := deliverSlackTo(
|
||||
t,
|
||||
"https://hooks.slack.com"+maskSecretPath+"\n",
|
||||
)
|
||||
|
||||
require.NotEmpty(t, errMsg)
|
||||
assertNoCredential(t, errMsg)
|
||||
assert.Contains(t, errMsg, "invalid control character")
|
||||
}
|
||||
|
||||
// TestDoHTTPRequest_TransportErrorMasksURL proves the HTTP
|
||||
// target's transport errors are masked too; its destination
|
||||
// URL can carry a token in a query string.
|
||||
func TestDoHTTPRequest_TransportErrorMasksURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ts := httptest.NewServer(http.NewServeMux())
|
||||
host := ts.URL
|
||||
|
||||
ts.Close()
|
||||
|
||||
e := testEngine(t, 1)
|
||||
|
||||
cfg, err := e.ExportParseHTTPConfig(
|
||||
newHTTPTargetConfig(host + maskSecretPath),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
statusCode, _, _, reqErr := e.ExportDoHTTPRequest(
|
||||
context.TODO(), cfg,
|
||||
&database.Event{Body: `{"test":true}`},
|
||||
)
|
||||
require.Error(t, reqErr)
|
||||
assert.Zero(t, statusCode)
|
||||
|
||||
assertNoCredential(t, reqErr.Error())
|
||||
assert.Contains(t, reqErr.Error(), host+"/...")
|
||||
assert.Contains(
|
||||
t, reqErr.Error(), "connection refused",
|
||||
)
|
||||
}
|
||||
|
||||
// TestValidateTargetURL_UnparsableURLIsMasked proves the SSRF
|
||||
// validator's error does not carry the submitted URL, which
|
||||
// the handler both logs and shows.
|
||||
func TestValidateTargetURL_UnparsableURLIsMasked(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
err := delivery.ValidateTargetURL(
|
||||
context.TODO(),
|
||||
"https://hooks.slack.com"+maskSecretPath+"\n",
|
||||
)
|
||||
require.Error(t, err)
|
||||
|
||||
assertNoCredential(t, err.Error())
|
||||
assert.Contains(t, err.Error(), "invalid URL")
|
||||
}
|
||||
@@ -26,14 +26,14 @@ const (
|
||||
)
|
||||
|
||||
// seedConfiguredTarget inserts a target with a stored config
|
||||
// blob.
|
||||
// blob and returns it.
|
||||
func seedConfiguredTarget(
|
||||
t *testing.T,
|
||||
db *database.Database,
|
||||
webhookID string,
|
||||
targetType database.TargetType,
|
||||
config string,
|
||||
) {
|
||||
) *database.Target {
|
||||
t.Helper()
|
||||
|
||||
tgt := &database.Target{
|
||||
@@ -48,6 +48,8 @@ func seedConfiguredTarget(
|
||||
t,
|
||||
db.DB().Omit(clause.Associations).Create(tgt).Error,
|
||||
)
|
||||
|
||||
return tgt
|
||||
}
|
||||
|
||||
// renderSourceDetailPage runs the real source detail handler
|
||||
|
||||
134
internal/handlers/source_logs_test.go
Normal file
134
internal/handlers/source_logs_test.go
Normal file
@@ -0,0 +1,134 @@
|
||||
package handlers_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"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"
|
||||
)
|
||||
|
||||
// seedDeliveredEvent records an event and a delivery for it in
|
||||
// the webhook's own database, so the log page has a delivery
|
||||
// to render against the target.
|
||||
func seedDeliveredEvent(
|
||||
t *testing.T,
|
||||
dbMgr *database.WebhookDBManager,
|
||||
webhookID, targetID string,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
webhookDB, err := dbMgr.GetDB(webhookID)
|
||||
require.NoError(t, err)
|
||||
|
||||
event := &database.Event{
|
||||
WebhookID: webhookID,
|
||||
Method: http.MethodPost,
|
||||
Body: `{"test":true}`,
|
||||
ContentType: "application/json",
|
||||
}
|
||||
|
||||
require.NoError(t, webhookDB.Omit(
|
||||
clause.Associations,
|
||||
).Create(event).Error)
|
||||
|
||||
dlv := &database.Delivery{
|
||||
EventID: event.ID,
|
||||
TargetID: targetID,
|
||||
Status: database.DeliveryStatusDelivered,
|
||||
}
|
||||
|
||||
require.NoError(t, webhookDB.Omit(
|
||||
clause.Associations,
|
||||
).Create(dlv).Error)
|
||||
}
|
||||
|
||||
// renderSourceLogsPage runs the real event log handler for a
|
||||
// webhook and returns the rendered HTML.
|
||||
func renderSourceLogsPage(
|
||||
t *testing.T,
|
||||
h *handlers.Handlers,
|
||||
sess *session.Session,
|
||||
webhookID string,
|
||||
) string {
|
||||
t.Helper()
|
||||
|
||||
req := httptest.NewRequestWithContext(
|
||||
context.Background(),
|
||||
http.MethodGet,
|
||||
"/source/"+webhookID+"/logs",
|
||||
nil,
|
||||
)
|
||||
|
||||
for _, c := range authenticatedCookies(
|
||||
t, sess, deleteTestUserID, deleteTestUsername,
|
||||
) {
|
||||
req.AddCookie(c)
|
||||
}
|
||||
|
||||
rctx := chi.NewRouteContext()
|
||||
rctx.URLParams.Add(paramSourceID, webhookID)
|
||||
|
||||
req = req.WithContext(
|
||||
context.WithValue(
|
||||
req.Context(), chi.RouteCtxKey, rctx,
|
||||
),
|
||||
)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
h.HandleSourceLogs().ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
|
||||
return w.Body.String()
|
||||
}
|
||||
|
||||
// TestHandleSourceLogs_MasksSlackWebhookURL proves the event
|
||||
// log page is handed a display-safe projection of each target
|
||||
// rather than the stored row, so the credential cannot be
|
||||
// rendered from its template data.
|
||||
func TestHandleSourceLogs_MasksSlackWebhookURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var (
|
||||
h *handlers.Handlers
|
||||
sess *session.Session
|
||||
db *database.Database
|
||||
dbMgr *database.WebhookDBManager
|
||||
)
|
||||
|
||||
app := newTestApp(t, &h, &sess, &db, &dbMgr)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
wh := seedWebhook(t, db)
|
||||
tgt := seedConfiguredTarget(
|
||||
t, db, wh.ID,
|
||||
database.TargetTypeSlack,
|
||||
`{"webhookUrl":"`+slackWebhookURL+`"}`,
|
||||
)
|
||||
|
||||
seedDeliveredEvent(t, dbMgr, wh.ID, tgt.ID)
|
||||
|
||||
body := renderSourceLogsPage(t, h, sess, wh.ID)
|
||||
|
||||
assert.NotContains(t, body, slackSecretPath)
|
||||
assert.NotContains(t, body, "T00000000")
|
||||
assert.NotContains(t, body, "B00000000")
|
||||
assert.NotContains(
|
||||
t, body, "XXXXXXXXXXXXXXXXXXXXXXXX",
|
||||
)
|
||||
assert.NotContains(t, body, "webhookUrl")
|
||||
|
||||
// The page still identifies the delivery's target.
|
||||
assert.Contains(t, body, tgt.Name)
|
||||
assert.Contains(t, body, "delivered")
|
||||
}
|
||||
@@ -96,7 +96,17 @@ func parseRetentionDays(raw string, fallback int) (int, error) {
|
||||
type EventWithDeliveries struct {
|
||||
database.Event
|
||||
|
||||
Deliveries []database.Delivery
|
||||
Deliveries []DeliveryView
|
||||
}
|
||||
|
||||
// DeliveryView is the display-safe projection of a delivery
|
||||
// for the event log page. Its target is a TargetView, so the
|
||||
// stored configuration blob — which holds the target's
|
||||
// credential — has no path to the template.
|
||||
type DeliveryView struct {
|
||||
ID string
|
||||
Status database.DeliveryStatus
|
||||
Target delivery.TargetView
|
||||
}
|
||||
|
||||
// HandleSourceList shows a list of user's webhooks.
|
||||
@@ -764,22 +774,27 @@ func (h *Handlers) HandleSourceLogs() http.HandlerFunc {
|
||||
}
|
||||
}
|
||||
|
||||
// loadTargetMap loads targets into a map keyed by target ID.
|
||||
// loadTargetMap loads targets into a map of display-safe
|
||||
// views keyed by target ID. The projection happens here so
|
||||
// that no caller can hand a raw target, configuration blob
|
||||
// and all, to a template.
|
||||
func (h *Handlers) loadTargetMap(
|
||||
webhookID string,
|
||||
) map[string]database.Target {
|
||||
) map[string]delivery.TargetView {
|
||||
var targets []database.Target
|
||||
|
||||
h.db.DB().Where(
|
||||
"webhook_id = ?", webhookID,
|
||||
).Find(&targets)
|
||||
|
||||
views := delivery.NewTargetViews(targets)
|
||||
|
||||
targetMap := make(
|
||||
map[string]database.Target, len(targets),
|
||||
map[string]delivery.TargetView, len(views),
|
||||
)
|
||||
|
||||
for _, t := range targets {
|
||||
targetMap[t.ID] = t
|
||||
for _, v := range views {
|
||||
targetMap[v.ID] = v
|
||||
}
|
||||
|
||||
return targetMap
|
||||
@@ -804,7 +819,7 @@ func (h *Handlers) parsePage(r *http.Request) int {
|
||||
func (h *Handlers) loadEventsWithDeliveries(
|
||||
w http.ResponseWriter,
|
||||
webhook database.Webhook,
|
||||
targetMap map[string]database.Target,
|
||||
targetMap map[string]delivery.TargetView,
|
||||
page int,
|
||||
) ([]EventWithDeliveries, int64) {
|
||||
var totalEvents int64
|
||||
@@ -843,22 +858,39 @@ func (h *Handlers) loadEventsWithDeliveries(
|
||||
for i := range events {
|
||||
result[i].Event = events[i]
|
||||
|
||||
var deliveries []database.Delivery
|
||||
|
||||
webhookDB.Where(
|
||||
"event_id = ?", events[i].ID,
|
||||
).Find(&result[i].Deliveries)
|
||||
).Find(&deliveries)
|
||||
|
||||
for j := range result[i].Deliveries {
|
||||
tid := result[i].Deliveries[j].TargetID
|
||||
|
||||
if target, ok := targetMap[tid]; ok {
|
||||
result[i].Deliveries[j].Target = target
|
||||
}
|
||||
}
|
||||
result[i].Deliveries = newDeliveryViews(
|
||||
deliveries, targetMap,
|
||||
)
|
||||
}
|
||||
|
||||
return result, totalEvents
|
||||
}
|
||||
|
||||
// newDeliveryViews projects deliveries for rendering,
|
||||
// resolving each one's target to its display-safe view.
|
||||
func newDeliveryViews(
|
||||
deliveries []database.Delivery,
|
||||
targetMap map[string]delivery.TargetView,
|
||||
) []DeliveryView {
|
||||
views := make([]DeliveryView, len(deliveries))
|
||||
|
||||
for i := range deliveries {
|
||||
views[i] = DeliveryView{
|
||||
ID: deliveries[i].ID,
|
||||
Status: deliveries[i].Status,
|
||||
Target: targetMap[deliveries[i].TargetID],
|
||||
}
|
||||
}
|
||||
|
||||
return views
|
||||
}
|
||||
|
||||
// HandleEntrypointCreate handles adding a new entrypoint.
|
||||
func (h *Handlers) HandleEntrypointCreate() http.HandlerFunc {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -1102,9 +1134,12 @@ func (h *Handlers) buildURLTargetConfig(
|
||||
r.Context(), targetURL,
|
||||
)
|
||||
if err != nil {
|
||||
// The submitted URL can be a credential (a Slack
|
||||
// incoming webhook URL is a bearer token), so the log
|
||||
// records only its scheme and host.
|
||||
h.log.Warn(
|
||||
"target URL blocked by SSRF protection",
|
||||
"url", targetURL,
|
||||
"url", delivery.MaskURL(targetURL),
|
||||
"error", err,
|
||||
)
|
||||
http.Error(
|
||||
|
||||
299
internal/handlers/ui_copy_test.go
Normal file
299
internal/handlers/ui_copy_test.go
Normal file
@@ -0,0 +1,299 @@
|
||||
package handlers_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"sneak.berlin/go/webhooker/internal/database"
|
||||
"sneak.berlin/go/webhooker/internal/delivery"
|
||||
"sneak.berlin/go/webhooker/internal/handlers"
|
||||
"sneak.berlin/go/webhooker/internal/session"
|
||||
)
|
||||
|
||||
// Template data keys the page templates read. The handlers package has
|
||||
// its own unexported constants for these; this is the external test
|
||||
// package, so it needs its own.
|
||||
const (
|
||||
dataKeyWebhook = "Webhook"
|
||||
dataKeyError = "Error"
|
||||
)
|
||||
|
||||
// testWebhookID is the identifier given to the webhook under test on
|
||||
// pages that render one.
|
||||
const testWebhookID = "wh-1"
|
||||
|
||||
// renderPage renders a page template through the real template set as
|
||||
// an authenticated user and returns the resulting HTML.
|
||||
func renderPage(
|
||||
t *testing.T,
|
||||
h *handlers.Handlers,
|
||||
sess *session.Session,
|
||||
page string,
|
||||
data map[string]any,
|
||||
) string {
|
||||
t.Helper()
|
||||
|
||||
cookies := authenticatedCookies(t, sess, "test-user-id", "testuser")
|
||||
|
||||
req := httptest.NewRequestWithContext(
|
||||
context.Background(), http.MethodGet, "/", nil,
|
||||
)
|
||||
for _, c := range cookies {
|
||||
req.AddCookie(c)
|
||||
}
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
h.RenderTemplateForTest(w, req, page, data)
|
||||
|
||||
return w.Body.String()
|
||||
}
|
||||
|
||||
// TestNavbarUsesWebhookTerminology pins the user-visible navigation
|
||||
// label to "Webhooks". The /sources route is deliberately unchanged, so
|
||||
// the assertion targets the link text rather than the href.
|
||||
func TestNavbarUsesWebhookTerminology(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var h *handlers.Handlers
|
||||
|
||||
var sess *session.Session
|
||||
|
||||
app := newTestApp(t, &h, &sess)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
// One item, so the list body renders too: it calls
|
||||
// WebhookListItem.RetentionLabel, promoted from the embedded
|
||||
// Webhook and therefore a pointer method. An empty list would
|
||||
// skip that call and hide a template error behind the
|
||||
// navigation assertions below.
|
||||
item := handlers.WebhookListItem{}
|
||||
item.Name = "wh"
|
||||
item.ID = testWebhookID
|
||||
item.RetentionDays = 14
|
||||
|
||||
body := renderPage(t, h, sess, "sources_list.html", map[string]any{
|
||||
"Webhooks": []handlers.WebhookListItem{item},
|
||||
})
|
||||
|
||||
assert.Contains(t, body, "Retention: 14 days")
|
||||
assert.Contains(t, body, `class="btn-text">Webhooks</a>`)
|
||||
assert.Contains(
|
||||
t, body, `class="btn-text w-full text-left">Webhooks</a>`,
|
||||
)
|
||||
assert.Contains(
|
||||
t, body,
|
||||
`<h1 class="text-2xl font-medium text-gray-900">Webhooks</h1>`,
|
||||
)
|
||||
assert.NotContains(
|
||||
t, body, ">Sources<",
|
||||
"no user-visible element may still be labelled Sources",
|
||||
)
|
||||
assert.Contains(
|
||||
t, body, `href="/sources"`,
|
||||
"the /sources route itself must not change",
|
||||
)
|
||||
}
|
||||
|
||||
// TestEditPageUsesWebhookTerminology pins the edit page's heading and
|
||||
// its back link. The link's href still points at /source/{id}, which is
|
||||
// intentional: only user-visible copy changes.
|
||||
func TestEditPageUsesWebhookTerminology(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var h *handlers.Handlers
|
||||
|
||||
var sess *session.Session
|
||||
|
||||
app := newTestApp(t, &h, &sess)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
// The webhook goes in as a pointer because source_edit.html calls
|
||||
// Webhook.RetentionLabel, a pointer method: a map element is not
|
||||
// addressable, so a value here renders an error instead of the
|
||||
// page.
|
||||
webhook := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||
webhook.ID = testWebhookID
|
||||
|
||||
body := renderPage(t, h, sess, "source_edit.html", map[string]any{
|
||||
dataKeyWebhook: webhook,
|
||||
dataKeyError: "",
|
||||
})
|
||||
|
||||
assert.Contains(t, body, "Edit Webhook")
|
||||
assert.NotContains(t, body, ">Sources<")
|
||||
assert.Contains(t, body, `href="/source/wh-1"`)
|
||||
}
|
||||
|
||||
// TestCreateFormRetentionCopyMatchesBehaviour pins the create form's
|
||||
// retention copy to what the code does: the reaper permanently deletes
|
||||
// events past the cutoff, an empty field falls back to
|
||||
// DefaultRetentionDays, and 0 is rewritten to the retain-forever
|
||||
// sentinel by Webhook.BeforeSave.
|
||||
func TestCreateFormRetentionCopyMatchesBehaviour(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var h *handlers.Handlers
|
||||
|
||||
var sess *session.Session
|
||||
|
||||
app := newTestApp(t, &h, &sess)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
body := renderPage(t, h, sess, "sources_new.html", map[string]any{
|
||||
"Name": "",
|
||||
"Description": "",
|
||||
"DefaultRetentionDays": database.DefaultRetentionDays,
|
||||
dataKeyError: "",
|
||||
})
|
||||
|
||||
assert.Contains(
|
||||
t, body,
|
||||
"permanently deletes events older than this",
|
||||
"the form must say retention is enforced by deletion",
|
||||
)
|
||||
assert.Contains(t, body, "Enter 0 to retain events forever")
|
||||
assert.Contains(
|
||||
t, body,
|
||||
"leave blank to use the default of "+
|
||||
strconv.Itoa(database.DefaultRetentionDays)+" days",
|
||||
"blank means the default, not forever",
|
||||
)
|
||||
}
|
||||
|
||||
// TestEditFormRetentionCopyMatchesBehaviour pins the edit form's
|
||||
// retention copy, including that it states the stored policy via
|
||||
// RetentionLabel and that an empty field leaves that policy unchanged
|
||||
// rather than meaning forever.
|
||||
func TestEditFormRetentionCopyMatchesBehaviour(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var h *handlers.Handlers
|
||||
|
||||
var sess *session.Session
|
||||
|
||||
app := newTestApp(t, &h, &sess)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
finite := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||
finite.ID = testWebhookID
|
||||
|
||||
body := renderPage(t, h, sess, "source_edit.html", map[string]any{
|
||||
dataKeyWebhook: finite,
|
||||
dataKeyError: "",
|
||||
})
|
||||
|
||||
assert.Contains(t, body, "Currently 14 days.")
|
||||
assert.Contains(
|
||||
t, body,
|
||||
"permanently deletes events older than this",
|
||||
)
|
||||
assert.Contains(t, body, "Enter 0 to retain events forever")
|
||||
assert.Contains(
|
||||
t, body,
|
||||
"leave blank to keep the current setting",
|
||||
"blank means unchanged, not forever",
|
||||
)
|
||||
|
||||
forever := &database.Webhook{
|
||||
Name: "wh",
|
||||
RetentionDays: database.RetentionForeverDays,
|
||||
}
|
||||
forever.ID = "wh-2"
|
||||
|
||||
foreverBody := renderPage(
|
||||
t, h, sess, "source_edit.html", map[string]any{
|
||||
dataKeyWebhook: forever,
|
||||
dataKeyError: "",
|
||||
},
|
||||
)
|
||||
|
||||
assert.Contains(
|
||||
t, foreverBody, "Currently forever.",
|
||||
"a retain-forever webhook must not read as a day count",
|
||||
)
|
||||
assert.Contains(
|
||||
t, foreverBody,
|
||||
"No events are deleted while retention is set to forever",
|
||||
)
|
||||
assert.NotContains(
|
||||
t, foreverBody,
|
||||
"permanently deletes events older than this",
|
||||
"the reaper skips retain-forever webhooks, so the form "+
|
||||
"must not claim it deletes their events",
|
||||
)
|
||||
}
|
||||
|
||||
// TestEntrypointCopyButtonIsProgressiveEnhancement proves the copy
|
||||
// affordance degrades: the button ships with the hidden attribute, so a
|
||||
// browser that never runs app.js shows no dead control, and the URL is
|
||||
// rendered as ordinary selectable text either way.
|
||||
func TestEntrypointCopyButtonIsProgressiveEnhancement(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var h *handlers.Handlers
|
||||
|
||||
var sess *session.Session
|
||||
|
||||
app := newTestApp(t, &h, &sess)
|
||||
app.RequireStart()
|
||||
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
entrypoint := database.Entrypoint{Path: "abc123"}
|
||||
entrypoint.ID = "ep-1"
|
||||
|
||||
// The webhook goes in as a pointer because source_detail.html
|
||||
// calls Webhook.RetentionLabel, a pointer method: a map element
|
||||
// is not addressable, so a value here aborts execution partway
|
||||
// down the page, after the copy button has already been flushed
|
||||
// to the response.
|
||||
webhook := &database.Webhook{Name: "wh", RetentionDays: 14}
|
||||
webhook.ID = testWebhookID
|
||||
webhook.CreatedAt = time.Date(
|
||||
2026, time.January, 2, 3, 4, 5, 0, time.UTC,
|
||||
)
|
||||
|
||||
body := renderPage(t, h, sess, "source_detail.html", map[string]any{
|
||||
dataKeyWebhook: webhook,
|
||||
"Entrypoints": []database.Entrypoint{entrypoint},
|
||||
// The handler passes delivery.NewTargetViews(targets), never
|
||||
// raw targets, so the test data has to have that same shape.
|
||||
"Targets": delivery.NewTargetViews(nil),
|
||||
"Events": []database.Event{},
|
||||
"BaseURL": "https://hooks.example.com",
|
||||
})
|
||||
|
||||
assert.Contains(
|
||||
t, body,
|
||||
`<code id="entrypoint-url-ep-1"`,
|
||||
)
|
||||
assert.Contains(t, body, "https://hooks.example.com/webhook/abc123")
|
||||
assert.Contains(
|
||||
t, body,
|
||||
`hidden data-copy-target="entrypoint-url-ep-1"`,
|
||||
"the button must start hidden and be revealed by script",
|
||||
)
|
||||
|
||||
// renderTemplate streams to the ResponseWriter, so an abort
|
||||
// midway still leaves everything above it in the body. This pins
|
||||
// content from the last line of the template, which is below the
|
||||
// assertions above: without it, a page that renders the copy
|
||||
// button and then 500s passes.
|
||||
assert.Contains(
|
||||
t, body, "Retention: 14 days",
|
||||
"the page must render to completion, not abort partway",
|
||||
)
|
||||
}
|
||||
@@ -1,2 +1,60 @@
|
||||
// Webhooker client-side JavaScript
|
||||
console.log("Webhooker loaded");
|
||||
|
||||
// Copy-to-clipboard, as progressive enhancement.
|
||||
//
|
||||
// Markup renders each copy button with the `hidden` attribute and a
|
||||
// `data-copy-target` pointing at the id of the element holding the
|
||||
// text. This script reveals a button only once it has both a resolvable
|
||||
// target and a usable Clipboard API, so a browser without either shows
|
||||
// no button at all and the text stays selectable.
|
||||
(function () {
|
||||
"use strict";
|
||||
|
||||
const revertDelayMs = 2000;
|
||||
|
||||
function flash(button, message) {
|
||||
const original = button.getAttribute("data-copy-label");
|
||||
button.textContent = message;
|
||||
window.setTimeout(function () {
|
||||
button.textContent = original;
|
||||
}, revertDelayMs);
|
||||
}
|
||||
|
||||
function wire(button) {
|
||||
const target = document.getElementById(
|
||||
button.getAttribute("data-copy-target")
|
||||
);
|
||||
if (!target) {
|
||||
return;
|
||||
}
|
||||
|
||||
button.setAttribute("data-copy-label", button.textContent);
|
||||
button.addEventListener("click", function () {
|
||||
navigator.clipboard.writeText(target.textContent.trim()).then(
|
||||
function () {
|
||||
flash(button, "Copied");
|
||||
},
|
||||
function () {
|
||||
flash(button, "Copy failed");
|
||||
}
|
||||
);
|
||||
});
|
||||
button.removeAttribute("hidden");
|
||||
}
|
||||
|
||||
function init() {
|
||||
if (!navigator.clipboard || !navigator.clipboard.writeText) {
|
||||
return;
|
||||
}
|
||||
|
||||
const buttons = document.querySelectorAll("[data-copy-target]");
|
||||
buttons.forEach(wire);
|
||||
}
|
||||
|
||||
if (document.readyState === "loading") {
|
||||
document.addEventListener("DOMContentLoaded", init);
|
||||
} else {
|
||||
init();
|
||||
}
|
||||
})();
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
<!-- Desktop navigation -->
|
||||
<div class="hidden md:flex items-center gap-4">
|
||||
{{if .User}}
|
||||
<a href="/sources" class="btn-text">Sources</a>
|
||||
<a href="/sources" class="btn-text">Webhooks</a>
|
||||
<a href="/user/{{.User.Username}}" class="btn-text">
|
||||
<svg class="w-5 h-5 mr-1" fill="currentColor" viewBox="0 0 16 16">
|
||||
<path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/>
|
||||
@@ -38,7 +38,7 @@
|
||||
<div x-show="open" x-cloak x-transition class="md:hidden mt-4 pt-4 border-t border-gray-200">
|
||||
<div class="flex flex-col gap-2">
|
||||
{{if .User}}
|
||||
<a href="/sources" class="btn-text w-full text-left">Sources</a>
|
||||
<a href="/sources" class="btn-text w-full text-left">Webhooks</a>
|
||||
<a href="/user/{{.User.Username}}" class="btn-text w-full text-left">Profile</a>
|
||||
<form method="POST" action="/pages/logout">
|
||||
<input type="hidden" name="csrf_token" value="{{.CSRFToken}}">
|
||||
|
||||
@@ -34,7 +34,6 @@
|
||||
|
||||
<hr class="border-gray-200 mb-6">
|
||||
|
||||
<div class="grid grid-cols-1 md:grid-cols-2 gap-8">
|
||||
<div>
|
||||
<h3 class="text-lg font-medium text-gray-900 mb-3">Account Information</h3>
|
||||
<dl class="space-y-3">
|
||||
@@ -48,11 +47,6 @@
|
||||
</div>
|
||||
</dl>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="text-lg font-medium text-gray-900 mb-3">Settings</h3>
|
||||
<p class="text-sm text-gray-500">Profile settings and preferences will be available here.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card p-6 mt-6">
|
||||
|
||||
@@ -69,7 +69,12 @@
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<code class="text-xs text-gray-500 break-all block mt-1">{{$.BaseURL}}/webhook/{{.Path}}</code>
|
||||
<div class="flex items-start gap-2 mt-1">
|
||||
<code id="entrypoint-url-{{.ID}}" class="text-xs text-gray-500 break-all block flex-1">{{$.BaseURL}}/webhook/{{.Path}}</code>
|
||||
<!-- Hidden until app.js reveals it; without the
|
||||
script the URL above stays selectable. -->
|
||||
<button type="button" hidden data-copy-target="entrypoint-url-{{.ID}}" class="text-xs text-gray-500 hover:text-primary-600">Copy</button>
|
||||
</div>
|
||||
</div>
|
||||
{{else}}
|
||||
<div class="p-4 text-sm text-gray-500">No entrypoints configured.</div>
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
<div class="form-group">
|
||||
<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">
|
||||
<p class="text-xs text-gray-500 mt-1">Currently {{.Webhook.RetentionLabel}}. Enter 0 to retain events forever.</p>
|
||||
<p class="text-xs text-gray-500 mt-1">Currently {{.Webhook.RetentionLabel}}.{{if .Webhook.RetainsForever}} No events are deleted while retention is set to forever.{{else}} A periodic cleanup permanently deletes events older than this, along with their delivery records.{{end}} Enter 0 to retain events forever; leave blank to keep the current setting.</p>
|
||||
</div>
|
||||
|
||||
<div class="flex gap-3">
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{{template "base" .}}
|
||||
|
||||
{{define "title"}}Sources - Webhooker{{end}}
|
||||
{{define "title"}}Webhooks - Webhooker{{end}}
|
||||
|
||||
{{define "content"}}
|
||||
<div class="max-w-6xl mx-auto px-6 py-8">
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
<div class="form-group">
|
||||
<label for="retention_days" class="label">Retention (days)</label>
|
||||
<input type="number" id="retention_days" name="retention_days" value="{{.DefaultRetentionDays}}" min="0" 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">A periodic cleanup permanently deletes events older than this, along with their delivery records. Enter 0 to retain events forever; leave blank to use the default of {{.DefaultRetentionDays}} days.</p>
|
||||
</div>
|
||||
|
||||
<div class="flex gap-3">
|
||||
|
||||
Reference in New Issue
Block a user