Compare commits
2
Commits
9575f3a616
...
ba6ce94860
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ba6ce94860 | ||
|
|
88b961c115 |
No files matched your search
@@ -15,6 +15,7 @@ type APIKey struct {
|
||||
Description string `json:"description"`
|
||||
LastUsedAt *time.Time `json:"lastUsedAt,omitempty"`
|
||||
|
||||
// Relations
|
||||
User User `json:"user,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// User.APIKeys leads back here, and the JSON could loop.
|
||||
User User `json:"-"`
|
||||
}
|
||||
@@ -56,8 +56,10 @@ type Delivery struct {
|
||||
// the index.
|
||||
FinishedAt *time.Time `gorm:"index:idx_deliveries_status,priority:3" json:"finishedAt,omitempty"`
|
||||
|
||||
// Relations
|
||||
Event Event `json:"event,omitzero"`
|
||||
Target Target `json:"target,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// Event.Deliveries and Target.Deliveries lead back here, and the
|
||||
// JSON could loop.
|
||||
Event Event `json:"-"`
|
||||
Target Target `json:"-"`
|
||||
DeliveryResults []DeliveryResult `json:"deliveryResults,omitempty"`
|
||||
}
|
||||
@@ -23,6 +23,7 @@ type DeliveryResult struct {
|
||||
Error string `json:"error,omitempty"`
|
||||
Duration int64 `json:"durationMs"` // Duration in milliseconds
|
||||
|
||||
// Relations
|
||||
Delivery Delivery `json:"delivery,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// Delivery.DeliveryResults leads back here, and the JSON could loop.
|
||||
Delivery Delivery `json:"-"`
|
||||
}
|
||||
@@ -15,6 +15,7 @@ type Entrypoint struct {
|
||||
Description string `json:"description"`
|
||||
Active bool `gorm:"default:true" json:"active"`
|
||||
|
||||
// Relations
|
||||
Webhook Webhook `json:"webhook,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// Webhook.Entrypoints leads back here, and the JSON could loop.
|
||||
Webhook Webhook `json:"-"`
|
||||
}
|
||||
@@ -44,8 +44,9 @@ type Event struct {
|
||||
// kept as the record of where the copy came from either way.
|
||||
ResubmittedFromID *string `gorm:"type:uuid;index" json:"resubmittedFromId,omitempty"`
|
||||
|
||||
// Relations
|
||||
Webhook Webhook `json:"webhook,omitzero"`
|
||||
Entrypoint Entrypoint `json:"entrypoint,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to, so
|
||||
// Webhook and Entrypoint are left out of the JSON.
|
||||
Webhook Webhook `json:"-"`
|
||||
Entrypoint Entrypoint `json:"-"`
|
||||
Deliveries []Delivery `json:"deliveries,omitempty"`
|
||||
}
|
||||
@@ -0,0 +1,126 @@
|
||||
package database_test
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"sneak.berlin/go/webhooker/internal/database"
|
||||
)
|
||||
|
||||
// TestPreloadedModelsMarshalWithoutTheirParent pins that a child's
|
||||
// reference to the record it belongs to is left out of the JSON, so a
|
||||
// webhook and its targets cannot marshal each other in a loop, and that
|
||||
// GORM still preloads that reference, since it ignores json tags.
|
||||
func TestPreloadedModelsMarshalWithoutTheirParent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
db := startedTestDB(t)
|
||||
|
||||
stored := database.Webhook{
|
||||
UserID: uuid.New().String(),
|
||||
Name: testWebhookName,
|
||||
Entrypoints: []database.Entrypoint{{Path: uuid.New().String()}},
|
||||
Targets: []database.Target{{
|
||||
Name: "log",
|
||||
Type: database.TargetTypeLog,
|
||||
}},
|
||||
}
|
||||
require.NoError(t, db.Create(&stored).Error)
|
||||
|
||||
entrypointID := stored.Entrypoints[0].ID
|
||||
targetID := stored.Targets[0].ID
|
||||
|
||||
var webhook database.Webhook
|
||||
|
||||
require.NoError(t, db.
|
||||
Preload("Entrypoints.Webhook").
|
||||
Preload("Targets.Webhook").
|
||||
First(&webhook, "id = ?", stored.ID).Error)
|
||||
|
||||
require.Len(t, webhook.Entrypoints, 1)
|
||||
require.Len(t, webhook.Targets, 1)
|
||||
assert.Equal(t, stored.ID, webhook.Entrypoints[0].Webhook.ID)
|
||||
assert.Equal(t, stored.ID, webhook.Targets[0].Webhook.ID)
|
||||
|
||||
encoded := marshalModel(t, webhook)
|
||||
|
||||
assert.Contains(t, encoded, entrypointID)
|
||||
assert.Contains(t, encoded, targetID)
|
||||
|
||||
// Each child holds the parent's id as its webhookId, so the parent
|
||||
// is looked for by its own id field.
|
||||
parentIDField := `"id":"` + stored.ID + `"`
|
||||
|
||||
assert.NotContains(t, marshalModel(t, webhook.Entrypoints[0]), parentIDField)
|
||||
assert.NotContains(t, marshalModel(t, webhook.Targets[0]), parentIDField)
|
||||
|
||||
var target database.Target
|
||||
|
||||
require.NoError(t, db.
|
||||
Preload("Webhook").
|
||||
First(&target, "id = ?", targetID).Error)
|
||||
|
||||
assert.Equal(t, stored.ID, target.Webhook.ID)
|
||||
|
||||
encoded = marshalModel(t, target)
|
||||
|
||||
assert.Contains(t, encoded, stored.ID)
|
||||
assert.NotContains(t, encoded, parentIDField)
|
||||
}
|
||||
|
||||
// TestModelsMarshalWithoutTheirParent covers the other references to a
|
||||
// parent: each model is built with its parent set, and the parent's id
|
||||
// must not appear in the JSON.
|
||||
func TestModelsMarshalWithoutTheirParent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
parent := database.BaseModel{ID: uuid.New().String()}
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
model any
|
||||
}{
|
||||
{
|
||||
name: "Webhook.User",
|
||||
model: database.Webhook{User: database.User{BaseModel: parent}},
|
||||
},
|
||||
{
|
||||
name: "APIKey.User",
|
||||
model: database.APIKey{User: database.User{BaseModel: parent}},
|
||||
},
|
||||
{
|
||||
name: "Delivery.Event",
|
||||
model: database.Delivery{Event: database.Event{BaseModel: parent}},
|
||||
},
|
||||
{
|
||||
name: "Delivery.Target",
|
||||
model: database.Delivery{Target: database.Target{BaseModel: parent}},
|
||||
},
|
||||
{
|
||||
name: "DeliveryResult.Delivery",
|
||||
model: database.DeliveryResult{
|
||||
Delivery: database.Delivery{BaseModel: parent},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Event.Webhook",
|
||||
model: database.Event{Webhook: database.Webhook{BaseModel: parent}},
|
||||
},
|
||||
{
|
||||
name: "Event.Entrypoint",
|
||||
model: database.Event{
|
||||
Entrypoint: database.Entrypoint{BaseModel: parent},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
assert.NotContains(t, marshalModel(t, tc.model), parent.ID)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -34,7 +34,8 @@ type Target struct {
|
||||
MaxRetries int `json:"maxRetries,omitempty"`
|
||||
MaxQueueSize int `json:"maxQueueSize,omitempty"`
|
||||
|
||||
// Relations
|
||||
Webhook Webhook `json:"webhook,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// Webhook.Targets leads back here, and the JSON could loop.
|
||||
Webhook Webhook `json:"-"`
|
||||
Deliveries []Delivery `json:"deliveries,omitempty"`
|
||||
}
|
||||
@@ -66,8 +66,9 @@ type Webhook struct {
|
||||
// must equal DefaultRetentionDays.
|
||||
RetentionDays int `gorm:"default:30" json:"retentionDays"`
|
||||
|
||||
// Relations
|
||||
User User `json:"user,omitzero"`
|
||||
// Relations. No model marshals the record it belongs to:
|
||||
// User.Webhooks leads back here, and the JSON could loop.
|
||||
User User `json:"-"`
|
||||
Entrypoints []Entrypoint `json:"entrypoints,omitempty"`
|
||||
Targets []Target `json:"targets,omitempty"`
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"io"
|
||||
"log/slog"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"unicode/utf8"
|
||||
|
||||
@@ -18,15 +19,11 @@ import (
|
||||
// width.
|
||||
const budget = 64
|
||||
|
||||
// sampleRunes is how many runes wide the values in the charge test
|
||||
// are. The handlers add a constant per field — a pair of quotes when
|
||||
// the value needs quoting — so the per-rune charge is only visible
|
||||
// once it is amortised over a run of them.
|
||||
const sampleRunes = 64
|
||||
|
||||
// quotingSlack is that constant: the pair of quotes a handler adds to
|
||||
// a value that needs them and omits from one that does not.
|
||||
const quotingSlack = 2
|
||||
// batchRunes is how many consecutive code points the charge test logs
|
||||
// in one value. Logging every code point on its own line is too slow
|
||||
// for the suite under the race detector; 4,096 at a time is 272 lines
|
||||
// per handler for all of Unicode.
|
||||
const batchRunes = 4096
|
||||
|
||||
// newHandlers are the two handlers internal/logger can install. Time
|
||||
// is dropped so a line's width is a function of its value alone —
|
||||
@@ -66,46 +63,42 @@ func renderedWidth(
|
||||
return buf.Len()
|
||||
}
|
||||
|
||||
// chargeTestRunes is the set of code points the charge test measures:
|
||||
// every rune in the first two planes' worth of the BMP that the
|
||||
// handlers are most likely to treat specially, the separators that
|
||||
// only slog's JSON handler escapes, and a stratified sample across
|
||||
// the rest of Unicode so the astral charge is exercised on more than
|
||||
// one hand-picked rune.
|
||||
func chargeTestRunes() []rune {
|
||||
const (
|
||||
denseCeiling = 0x800
|
||||
stride = 1021
|
||||
surrogateLo = 0xD800
|
||||
surrogateHi = 0xDFFF
|
||||
)
|
||||
// emittedBytes is what a handler writes for the runes of s alone: the
|
||||
// width of a line carrying s twice, less that of a line carrying it
|
||||
// once. Both values hold the same runes, so the text handler quotes
|
||||
// both or neither, and the quotes cancel along with everything else on
|
||||
// the line.
|
||||
func emittedBytes(
|
||||
newHandler func(io.Writer) slog.Handler,
|
||||
s string,
|
||||
) int {
|
||||
return renderedWidth(newHandler, s+s) - renderedWidth(newHandler, s)
|
||||
}
|
||||
|
||||
var runes []rune
|
||||
// firstUndercharged returns the first rune in s that the handler
|
||||
// writes in more bytes than EncodedBytes charges for it, and how many
|
||||
// runes in s are undercharged that way. It measures one rune per line,
|
||||
// so the charge test calls it only on a batch that has already failed,
|
||||
// to name the code points rather than just their range.
|
||||
func firstUndercharged(
|
||||
newHandler func(io.Writer) slog.Handler,
|
||||
s string,
|
||||
) (rune, int) {
|
||||
first, count := rune(-1), 0
|
||||
|
||||
keep := func(r rune) {
|
||||
if r >= surrogateLo && r <= surrogateHi {
|
||||
return
|
||||
for _, r := range s {
|
||||
if emittedBytes(newHandler, string(r)) <= logfield.EncodedBytes(r) {
|
||||
continue
|
||||
}
|
||||
|
||||
runes = append(runes, r)
|
||||
if count == 0 {
|
||||
first = r
|
||||
}
|
||||
|
||||
count++
|
||||
}
|
||||
|
||||
for r := range rune(denseCeiling) {
|
||||
keep(r)
|
||||
}
|
||||
|
||||
for _, r := range []rune{
|
||||
0x2028, 0x2029, 0x200B, 0x4E00, 0xE000, 0xFFFD,
|
||||
0x1000C, 0x1F600, 0xE0001, 0x10FFFF,
|
||||
} {
|
||||
keep(r)
|
||||
}
|
||||
|
||||
for r := rune(denseCeiling); r <= utf8.MaxRune; r += stride {
|
||||
keep(r)
|
||||
}
|
||||
|
||||
return runes
|
||||
return first, count
|
||||
}
|
||||
|
||||
// TestEncodedBytes_ChargesAtLeastWhatTheHandlersEmit is the property
|
||||
@@ -114,33 +107,70 @@ func chargeTestRunes() []rune {
|
||||
// how a stated ceiling becomes false without any test noticing, so
|
||||
// the charge is measured against what the handlers actually write
|
||||
// rather than against the escaping rules as read.
|
||||
//
|
||||
// Every code point is covered, batchRunes at a time: each batch's
|
||||
// summed charge must cover what the handler writes for the whole
|
||||
// batch. A sum can hide an undercharged rune behind overcharged ones
|
||||
// in the same batch, which is the price of fitting all of Unicode
|
||||
// into the suite.
|
||||
func TestEncodedBytes_ChargesAtLeastWhatTheHandlersEmit(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var batches []string
|
||||
|
||||
for lo := rune(0); lo <= utf8.MaxRune; lo += batchRunes {
|
||||
var batch strings.Builder
|
||||
|
||||
for r := lo; r < lo+batchRunes; r++ {
|
||||
// Surrogate halves are not runes a string can carry.
|
||||
if utf8.ValidRune(r) {
|
||||
batch.WriteRune(r)
|
||||
}
|
||||
}
|
||||
|
||||
batches = append(batches, batch.String())
|
||||
}
|
||||
|
||||
// What EncodedBytes charges for each batch. Under -race -cover this
|
||||
// takes longer than logging the batches, so it is worked out once,
|
||||
// by whichever handler finishes logging first, while the other is
|
||||
// still logging.
|
||||
charged := sync.OnceValue(func() []int {
|
||||
costs := make([]int, len(batches))
|
||||
|
||||
for i, batch := range batches {
|
||||
for _, r := range batch {
|
||||
costs[i] += logfield.EncodedBytes(r)
|
||||
}
|
||||
}
|
||||
|
||||
return costs
|
||||
})
|
||||
|
||||
for name, newHandler := range newHandlers() {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// 'a' is a printable ASCII rune, charged exactly one
|
||||
// byte, so it is the zero point the other runes are
|
||||
// measured against.
|
||||
base := renderedWidth(
|
||||
newHandler, strings.Repeat("a", sampleRunes),
|
||||
)
|
||||
emitted := make([]int, len(batches))
|
||||
for i, batch := range batches {
|
||||
emitted[i] = emittedBytes(newHandler, batch)
|
||||
}
|
||||
|
||||
for _, r := range chargeTestRunes() {
|
||||
got := renderedWidth(
|
||||
newHandler,
|
||||
strings.Repeat(string(r), sampleRunes),
|
||||
for i, cost := range charged() {
|
||||
if emitted[i] <= cost {
|
||||
continue
|
||||
}
|
||||
|
||||
lo := rune(i * batchRunes)
|
||||
first, count := firstUndercharged(
|
||||
newHandler, batches[i],
|
||||
)
|
||||
charged := sampleRunes *
|
||||
(logfield.EncodedBytes(r) - 1)
|
||||
|
||||
require.LessOrEqual(
|
||||
t, got-base, charged+quotingSlack,
|
||||
"U+%04X costs more on the line than "+
|
||||
"EncodedBytes charges for it",
|
||||
r,
|
||||
t.Errorf(
|
||||
"U+%04X to U+%04X emit %d bytes but are "+
|
||||
"charged %d; %d of them cost more than "+
|
||||
"EncodedBytes charges, the first U+%04X",
|
||||
lo, lo+batchRunes-1, emitted[i], cost,
|
||||
count, first,
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
Reference in new issue
Block a user