jay/go-roots
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add constructor functions with options. update tests.

Browse Source
This commit is contained in:
Jay
2026-05-04 13:41:56 -04:00
parent 29ba275293
commit 48dde86abd
10 changed files with 641 additions and 597 deletions
Download Patch File Download Diff File Expand all files Collapse all files
events/event.go
+63 -1
View File
@@ -3,6 +3,10 @@
// serialization, cryptographic signatures, and subscription filters. // serialization, cryptographic signatures, and subscription filters.
package events package events
import (
"time"
)
// Tag represents a single tag within an event as an array of strings. // Tag represents a single tag within an event as an array of strings.
// The first element identifies the tag name, the second contains the value, // The first element identifies the tag name, the second contains the value,
// and subsequent elements are optional. // and subsequent elements are optional.
@@ -13,9 +17,67 @@ type Tag []string
type Event struct { type Event struct {
ID string `json:"id"` ID string `json:"id"`
PubKey string `json:"pubkey"` PubKey string `json:"pubkey"`
CreatedAt int `json:"created_at"` CreatedAt int64 `json:"created_at"`
Kind int `json:"kind"` Kind int `json:"kind"`
Tags []Tag `json:"tags"` Tags []Tag `json:"tags"`
Content string `json:"content"` Content string `json:"content"`
Sig string `json:"sig"` Sig string `json:"sig"`
} }
func NewEvent(opts ...EventOption) Event {
e := Event{Tags: make([]Tag, 0)}
for _, opt := range opts {
opt(&e)
}
return e
}
type EventOption func(*Event)
func WithID(id string) EventOption {
return func(e *Event) {
e.ID = id
}
}
func WithPubKey(pk string) EventOption {
return func(e *Event) {
e.PubKey = pk
}
}
func WithCreatedAt(t int64) EventOption {
return func(e *Event) {
e.CreatedAt = t
}
}
func WithCreatedAtTime(t time.Time) EventOption {
return func(e *Event) {
e.CreatedAt = t.Unix()
}
}
func WithKind(k int) EventOption {
return func(e *Event) {
e.Kind = k
}
}
func WithTag(t Tag) EventOption {
return func(e *Event) {
e.Tags = append(e.Tags, t)
}
}
func WithContent(c string) EventOption {
return func(e *Event) {
e.Content = c
}
}
func WithSig(s string) EventOption {
return func(e *Event) {
e.Sig = s
}
}
events/event_json_test.go
+12 -14
View File
@@ -7,7 +7,7 @@ import (
) )
func TestUnmarshalEventJSON(t *testing.T) { func TestUnmarshalEventJSON(t *testing.T) {
event := Event{} event := NewEvent()
json.Unmarshal(testEventJSONBytes, &event) json.Unmarshal(testEventJSONBytes, &event)
if err := Validate(event); err != nil { if err := Validate(event); err != nil {
t.Error("unmarshalled event is invalid") t.Error("unmarshalled event is invalid")
@@ -22,19 +22,17 @@ func TestMarshalEventJSON(t *testing.T) {
} }
func TestEventJSONRoundTrip(t *testing.T) { func TestEventJSONRoundTrip(t *testing.T) {
event := Event{ event := NewEvent(
ID: "86e856d0527dd08527498cd8afd8a7d296bde37e4757a8921f034f0b344df3ad", WithID("86e856d0527dd08527498cd8afd8a7d296bde37e4757a8921f034f0b344df3ad"),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: []Tag{ WithTag(Tag{"a", "value"}),
{"a", "value"}, WithTag(Tag{"b", "value", "optional"}),
{"b", "value", "optional"}, WithTag(Tag{"name", "value", "optional", "optional"}),
{"name", "value", "optional", "optional"}, WithContent(testEvent.Content),
}, WithSig("c05fe02a9c082ff56aad2b16b5347498a21665f02f050ba086dbe6bd593c8cd448505d2831d1c0340acc1793eaf89b7c0cb21bb696c71da6b8d6b857702bb557"),
Content: testEvent.Content, )
Sig: "c05fe02a9c082ff56aad2b16b5347498a21665f02f050ba086dbe6bd593c8cd448505d2831d1c0340acc1793eaf89b7c0cb21bb696c71da6b8d6b857702bb557",
}
expectedJSON := `{"id":"86e856d0527dd08527498cd8afd8a7d296bde37e4757a8921f034f0b344df3ad","pubkey":"cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef","created_at":1760740551,"kind":1,"tags":[["a","value"],["b","value","optional"],["name","value","optional","optional"]],"content":"hello world","sig":"c05fe02a9c082ff56aad2b16b5347498a21665f02f050ba086dbe6bd593c8cd448505d2831d1c0340acc1793eaf89b7c0cb21bb696c71da6b8d6b857702bb557"}` expectedJSON := `{"id":"86e856d0527dd08527498cd8afd8a7d296bde37e4757a8921f034f0b344df3ad","pubkey":"cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef","created_at":1760740551,"kind":1,"tags":[["a","value"],["b","value","optional"],["name","value","optional","optional"]],"content":"hello world","sig":"c05fe02a9c082ff56aad2b16b5347498a21665f02f050ba086dbe6bd593c8cd448505d2831d1c0340acc1793eaf89b7c0cb21bb696c71da6b8d6b857702bb557"}`
if err := Validate(event); err != nil { if err := Validate(event); err != nil {
events/event_test.go
+8 -9
View File
@@ -8,15 +8,14 @@ import (
const testSK = "f43a0435f69529f310bbd1d6263d2fbf0977f54bfe2310cc37ae5904b83bb167" const testSK = "f43a0435f69529f310bbd1d6263d2fbf0977f54bfe2310cc37ae5904b83bb167"
const testPK = "cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef" const testPK = "cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef"
var testEvent = Event{ var testEvent = NewEvent(
ID: "c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad", WithID("c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad"),
PubKey: testPK, WithPubKey(testPK),
CreatedAt: 1760740551, WithCreatedAt(1760740551),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent("hello world"),
Content: "hello world", WithSig("83b71e15649c9e9da362c175f988c36404cabf357a976d869102a74451cfb8af486f6088b5631033b4927bd46cad7a0d90d7f624aefc0ac260364aa65c36071a"),
Sig: "83b71e15649c9e9da362c175f988c36404cabf357a976d869102a74451cfb8af486f6088b5631033b4927bd46cad7a0d90d7f624aefc0ac260364aa65c36071a", )
}
var testEventJSON = `{"id":"c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad","pubkey":"cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef","created_at":1760740551,"kind":1,"tags":[],"content":"hello world","sig":"83b71e15649c9e9da362c175f988c36404cabf357a976d869102a74451cfb8af486f6088b5631033b4927bd46cad7a0d90d7f624aefc0ac260364aa65c36071a"}` var testEventJSON = `{"id":"c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad","pubkey":"cfa87f35acbde29ba1ab3ee42de527b2cad33ac487e80cf2d6405ea0042c8fef","created_at":1760740551,"kind":1,"tags":[],"content":"hello world","sig":"83b71e15649c9e9da362c175f988c36404cabf357a976d869102a74451cfb8af486f6088b5631033b4927bd46cad7a0d90d7f624aefc0ac260364aa65c36071a"}`
var testEventJSONBytes = []byte(testEventJSON) var testEventJSONBytes = []byte(testEventJSON)
events/id_test.go
+90 -110
View File
@@ -14,181 +14,161 @@ type IDTestCase struct {
var idTestCases = []IDTestCase{ var idTestCases = []IDTestCase{
{ {
name: "minimal event", name: "minimal event",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{}, ),
Content: "",
},
expected: "13a55672a600398894592f4cb338652d4936caffe5d3718d11597582bb030c39", expected: "13a55672a600398894592f4cb338652d4936caffe5d3718d11597582bb030c39",
}, },
{ {
name: "alphanumeric content", name: "alphanumeric content",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent("hello world"),
Content: "hello world", ),
},
expected: "c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad", expected: "c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad",
}, },
{ {
name: "unicode content", name: "unicode content",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent("hello world 😀"),
Content: "hello world 😀", ),
},
expected: "e42083fafbf9a39f97914fd9a27cedb38c429ac3ca8814288414eaad1f472fe8", expected: "e42083fafbf9a39f97914fd9a27cedb38c429ac3ca8814288414eaad1f472fe8",
}, },
{ {
name: "escaped content", name: "escaped content",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent("\"You say yes.\"\\n\\t\"I say no.\""),
Content: "\"You say yes.\"\\n\\t\"I say no.\"", ),
},
expected: "343de133996a766bf00561945b6f2b2717d4905275976ca75c1d7096b7d1900c", expected: "343de133996a766bf00561945b6f2b2717d4905275976ca75c1d7096b7d1900c",
}, },
{ {
name: "json content", name: "json content",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent("{\"field\": [\"value\",\"value\"],\"numeral\": 123}"),
Content: "{\"field\": [\"value\",\"value\"],\"numeral\": 123}", ),
},
expected: "c6140190453ee947efb790e70541a9d37c41604d1f29e4185da4325621ed5270", expected: "c6140190453ee947efb790e70541a9d37c41604d1f29e4185da4325621ed5270",
}, },
{ {
name: "empty tag", name: "empty tag",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{ WithTag(Tag{"a", ""}),
{"a", ""}, WithContent(""),
}, ),
Content: "",
},
expected: "7d3e394c75916362436f11c603b1a89b40b50817550cfe522a90d769655007a4", expected: "7d3e394c75916362436f11c603b1a89b40b50817550cfe522a90d769655007a4",
}, },
{ {
name: "single tag", name: "single tag",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{ WithTag(Tag{"a", "value"}),
{"a", "value"}, WithContent(""),
}, ),
Content: "",
},
expected: "7db394e274fb893edbd9f4aa9ff189d4f3264bf1a29cef8f614e83ebf6fa19fe", expected: "7db394e274fb893edbd9f4aa9ff189d4f3264bf1a29cef8f614e83ebf6fa19fe",
}, },
{ {
name: "optional tag values", name: "optional tag values",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{ WithTag(Tag{"a", "value", "optional"}),
{"a", "value", "optional"}, WithContent(""),
}, ),
Content: "",
},
expected: "656b47884200959e0c03054292c453cfc4beea00b592d92c0f557bff765e9d34", expected: "656b47884200959e0c03054292c453cfc4beea00b592d92c0f557bff765e9d34",
}, },
{ {
name: "multiple tags", name: "multiple tags",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{ WithTag(Tag{"a", "value", "optional"}),
{"a", "value", "optional"}, WithTag(Tag{"b", "another"}),
{"b", "another"}, WithTag(Tag{"c", "data"}),
{"c", "data"}, WithContent(""),
}, ),
Content: "",
},
expected: "f7c27f2eacda7ece5123a4f82db56145ba59f7c9e6c5eeb88552763664506b06", expected: "f7c27f2eacda7ece5123a4f82db56145ba59f7c9e6c5eeb88552763664506b06",
}, },
{ {
name: "unicode tag", name: "unicode tag",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 1, WithKind(1),
Tags: []Tag{ WithTag(Tag{"a", "😀"}),
{"a", "😀"}, WithContent(""),
}, ),
Content: "",
},
expected: "fd2798d165d9bf46acbe817735dc8cedacd4c42dfd9380792487d4902539e986", expected: "fd2798d165d9bf46acbe817735dc8cedacd4c42dfd9380792487d4902539e986",
}, },
{ {
name: "zero timestamp", name: "zero timestamp",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: 0, WithCreatedAt(0),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent(""),
Content: "", ),
},
expected: "9ca742f2e2eea72ad6e0277a6287e2bb16a3e47d64b8468bc98474e266cf0ec2", expected: "9ca742f2e2eea72ad6e0277a6287e2bb16a3e47d64b8468bc98474e266cf0ec2",
}, },
{ {
name: "negative timestamp", name: "negative timestamp",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: -1760740551, WithCreatedAt(-1760740551),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent(""),
Content: "", ),
},
expected: "4740b027040bb4d0ee8e885f567a80277097da70cddd143d8a6dadf97f6faaa3", expected: "4740b027040bb4d0ee8e885f567a80277097da70cddd143d8a6dadf97f6faaa3",
}, },
{ {
name: "max int64 timestamp", name: "max int64 timestamp",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: 9223372036854775807, WithCreatedAt(9223372036854775807),
Kind: 1, WithKind(1),
Tags: []Tag{}, WithContent(""),
Content: "", ),
},
expected: "b28cdd44496acb49e36c25859f0f819122829a12dc57c07612d5f44cb121d2a7", expected: "b28cdd44496acb49e36c25859f0f819122829a12dc57c07612d5f44cb121d2a7",
}, },
{ {
name: "different kind", name: "different kind",
event: Event{ event: NewEvent(
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: 20021, WithKind(20021),
Tags: []Tag{}, WithContent(""),
Content: "", ),
},
expected: "995c4894c264e6b9558cb94b7b34008768d53801b99960b47298d4e3e23fadd3", expected: "995c4894c264e6b9558cb94b7b34008768d53801b99960b47298d4e3e23fadd3",
}, },
} }
events/util_test.go
-5
View File
@@ -1,5 +0,0 @@
package events
func intPtr(i int) *int {
return &i
}
events/validate_test.go
+133 -140
View File
@@ -14,169 +14,161 @@ type ValidateEventTestCase struct {
var structureTestCases = []ValidateEventTestCase{ var structureTestCases = []ValidateEventTestCase{
{ {
name: "empty pubkey", name: "empty pubkey",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: "", WithPubKey(""),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "public key must be 64 lowercase hex characters", expectedError: "public key must be 64 lowercase hex characters",
}, },
{ {
name: "short pubkey", name: "short pubkey",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: "abc123", WithPubKey("abc123"),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "public key must be 64 lowercase hex characters", expectedError: "public key must be 64 lowercase hex characters",
}, },
{ {
name: "long pubkey", name: "long pubkey",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: "c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48adabc", WithPubKey("c7a702e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48adabc"),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "public key must be 64 lowercase hex characters", expectedError: "public key must be 64 lowercase hex characters",
}, },
{ {
name: "non-hex pubkey", name: "non-hex pubkey",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: "zyx-!2e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad", WithPubKey("zyx-!2e6158744ca03508bbb4c90f9dbb0d6e88fefbfaa511d5ab24b4e3c48ad"),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "public key must be 64 lowercase hex characters", expectedError: "public key must be 64 lowercase hex characters",
}, },
{ {
name: "uppercase pubkey", name: "uppercase pubkey",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: "C7A702E6158744CA03508BBB4C90F9DBB0D6E88FEFBFAA511D5AB24B4E3C48AD", WithPubKey("C7A702E6158744CA03508BBB4C90F9DBB0D6E88FEFBFAA511D5AB24B4E3C48AD"),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "public key must be 64 lowercase hex characters", expectedError: "public key must be 64 lowercase hex characters",
}, },
{ {
name: "empty id", name: "empty id",
event: Event{ event: NewEvent(
ID: "", WithID(""),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "id must be 64 hex characters", expectedError: "id must be 64 hex characters",
}, },
{ {
name: "short id", name: "short id",
event: Event{ event: NewEvent(
ID: "abc123", WithID("abc123"),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, ),
},
expectedError: "id must be 64 hex characters", expectedError: "id must be 64 hex characters",
}, },
{ {
name: "empty signature", name: "empty signature",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(""),
Sig: "", ),
},
expectedError: "signature must be 128 hex characters", expectedError: "signature must be 128 hex characters",
}, },
{ {
name: "short signature", name: "short signature",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig("abc123"),
Sig: "abc123", ),
},
expectedError: "signature must be 128 hex characters", expectedError: "signature must be 128 hex characters",
}, },
{ {
name: "empty tag", name: "empty tag",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: []Tag{{}}, WithTag(Tag{}),
Content: testEvent.Content, WithContent(testEvent.Content),
Sig: testEvent.Sig, WithSig(testEvent.Sig),
}, ),
expectedError: "tags must contain at least two elements", expectedError: "tags must contain at least two elements",
}, },
{ {
name: "single element tag", name: "single element tag",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: []Tag{{"a"}}, WithTag(Tag{"a"}),
Content: testEvent.Content, WithContent(testEvent.Content),
Sig: testEvent.Sig, WithSig(testEvent.Sig),
}, ),
expectedError: "tags must contain at least two elements", expectedError: "tags must contain at least two elements",
}, },
{ {
name: "one good tag, one single element tag", name: "one good tag, one single element tag",
event: Event{ event: NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: []Tag{{"a", "value"}, {"b"}}, WithTag(Tag{"a", "value"}),
Content: testEvent.Content, WithTag(Tag{"b"}),
Sig: testEvent.Sig, WithContent(testEvent.Content),
}, WithSig(testEvent.Sig),
),
expectedError: "tags must contain at least two elements", expectedError: "tags must contain at least two elements",
}, },
} }
@@ -191,37 +183,36 @@ func TestValidateEventStructure(t *testing.T) {
} }
func TestValidateEventIDFailure(t *testing.T) { func TestValidateEventIDFailure(t *testing.T) {
event := Event{ event := NewEvent(
ID: "7f661c2a3c1ed67dc959d6cd968d743d5e6e334313df44724bca939e2aa42c9e", WithID("7f661c2a3c1ed67dc959d6cd968d743d5e6e334313df44724bca939e2aa42c9e"),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: testEvent.Tags, WithContent(testEvent.Content),
Content: testEvent.Content, WithSig(testEvent.Sig),
Sig: testEvent.Sig, )
}
err := ValidateID(event) err := ValidateID(event)
assert.ErrorContains(t, err, "does not match computed id") assert.ErrorContains(t, err, "does not match computed id")
} }
func TestValidateSignature(t *testing.T) { func TestValidateSignature(t *testing.T) {
event := Event{ event := NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
Sig: testEvent.Sig, WithSig(testEvent.Sig),
} )
err := ValidateSignature(event) err := ValidateSignature(event)
assert.NoError(t, err) assert.NoError(t, err)
} }
func TestValidateInvalidSignature(t *testing.T) { func TestValidateInvalidSignature(t *testing.T) {
event := Event{ event := NewEvent(
ID: testEvent.ID, WithID(testEvent.ID),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
Sig: "9e43cbcf7e828a21c53fa35371ee79bffbfd7a3063ae46fc05ec623dd3186667c57e3d006488015e19247df35eb41c61013e051aa87860e23fa5ffbd44120482", WithSig("9e43cbcf7e828a21c53fa35371ee79bffbfd7a3063ae46fc05ec623dd3186667c57e3d006488015e19247df35eb41c61013e051aa87860e23fa5ffbd44120482"),
} )
err := ValidateSignature(event) err := ValidateSignature(event)
assert.ErrorContains(t, err, "event signature is invalid") assert.ErrorContains(t, err, "event signature is invalid")
@@ -280,7 +271,11 @@ var validateSignatureTestCases = []ValidateSignatureTestCase{
func TestValidateSignatureInvalidEventSignature(t *testing.T) { func TestValidateSignatureInvalidEventSignature(t *testing.T) {
for _, tc := range validateSignatureTestCases { for _, tc := range validateSignatureTestCases {
t.Run(tc.name, func(t *testing.T) { t.Run(tc.name, func(t *testing.T) {
event := Event{ID: tc.id, PubKey: tc.pubkey, Sig: tc.sig} event := NewEvent(
WithID(tc.id),
WithPubKey(tc.pubkey),
WithSig(tc.sig),
)
err := ValidateSignature(event) err := ValidateSignature(event)
assert.ErrorContains(t, err, tc.expectedError) assert.ErrorContains(t, err, tc.expectedError)
}) })
@@ -288,18 +283,16 @@ func TestValidateSignatureInvalidEventSignature(t *testing.T) {
} }
func TestValidateEvent(t *testing.T) { func TestValidateEvent(t *testing.T) {
event := Event{ event := NewEvent(
ID: "c9a0f84fcaa889654da8992105eb122eb210c8cbd58210609a5ef7e170b51400", WithID("c9a0f84fcaa889654da8992105eb122eb210c8cbd58210609a5ef7e170b51400"),
PubKey: testEvent.PubKey, WithPubKey(testEvent.PubKey),
CreatedAt: testEvent.CreatedAt, WithCreatedAt(testEvent.CreatedAt),
Kind: testEvent.Kind, WithKind(testEvent.Kind),
Tags: []Tag{ WithTag(Tag{"a", "value"}),
{"a", "value"}, WithTag(Tag{"b", "value", "optional"}),
{"b", "value", "optional"}, WithContent("valid event"),
}, WithSig("668a715f1eb983172acf230d17bd283daedb2598adf8de4290bcc7eb0b802fdb60669d1e7d1104ac70393f4dbccd07e8abf897152af6ce6c0a75499874e27f14"),
Content: "valid event", )
Sig: "668a715f1eb983172acf230d17bd283daedb2598adf8de4290bcc7eb0b802fdb60669d1e7d1104ac70393f4dbccd07e8abf897152af6ce6c0a75499874e27f14",
}
err := Validate(event) err := Validate(event)
assert.NoError(t, err) assert.NoError(t, err)
filters/filter.go
+87 -5
View File
@@ -4,6 +4,7 @@ import (
"encoding/json" "encoding/json"
"git.wisehodl.dev/jay/go-roots/events" "git.wisehodl.dev/jay/go-roots/events"
"strings" "strings"
"time"
) )
// TagFilters maps tag names to arrays of values for tag-based filtering // TagFilters maps tag names to arrays of values for tag-based filtering
@@ -20,13 +21,94 @@ type Filter struct {
IDs []string IDs []string
Authors []string Authors []string
Kinds []int Kinds []int
Since *int Since *int64
Until *int Until *int64
Limit *int Limit *int
Tags TagFilters Tags TagFilters
Extensions FilterExtensions Extensions FilterExtensions
} }
func NewFilter(opts ...FilterOption) Filter {
f := Filter{}
for _, opt := range opts {
opt(&f)
}
return f
}
type FilterOption func(*Filter)
func WithIDs(ids []string) FilterOption {
return func(f *Filter) {
f.IDs = ids
}
}
func WithAuthors(authors []string) FilterOption {
return func(f *Filter) {
f.Authors = authors
}
}
func WithKinds(kinds []int) FilterOption {
return func(f *Filter) {
f.Kinds = kinds
}
}
func WithSince(since int64) FilterOption {
return func(f *Filter) {
ptr := since
f.Since = &ptr
}
}
func WithUntil(until int64) FilterOption {
return func(f *Filter) {
ptr := until
f.Until = &ptr
}
}
func WithUntilTime(until time.Time) FilterOption {
return func(f *Filter) {
untilInt := until.Unix()
f.Until = &untilInt
}
}
func WithSinceTime(since time.Time) FilterOption {
return func(f *Filter) {
sinceInt := since.Unix()
f.Since = &sinceInt
}
}
func WithLimit(limit int) FilterOption {
return func(f *Filter) {
ptr := limit
f.Limit = &ptr
}
}
func WithTag(l string, v []string) FilterOption {
return func(f *Filter) {
if f.Tags == nil {
f.Tags = make(TagFilters)
}
f.Tags[l] = v
}
}
func WithExtension(l string, e json.RawMessage) FilterOption {
return func(f *Filter) {
if f.Extensions == nil {
f.Extensions = make(FilterExtensions)
}
f.Extensions[l] = e
}
}
// MarshalJSON converts the filter to JSON with standard fields, tag filters // MarshalJSON converts the filter to JSON with standard fields, tag filters
// (prefixed with "#"), and extensions merged into a single object. // (prefixed with "#"), and extensions merged into a single object.
func MarshalJSON(f Filter) ([]byte, error) { func MarshalJSON(f Filter) ([]byte, error) {
@@ -119,7 +201,7 @@ func UnmarshalJSON(data []byte, f *Filter) error {
if len(v) == 4 && string(v) == "null" { if len(v) == 4 && string(v) == "null" {
f.Since = nil f.Since = nil
} else { } else {
var val int var val int64
if err := json.Unmarshal(v, &val); err != nil { if err := json.Unmarshal(v, &val); err != nil {
return err return err
} }
@@ -132,7 +214,7 @@ func UnmarshalJSON(data []byte, f *Filter) error {
if len(v) == 4 && string(v) == "null" { if len(v) == 4 && string(v) == "null" {
f.Until = nil f.Until = nil
} else { } else {
var val int var val int64
if err := json.Unmarshal(v, &val); err != nil { if err := json.Unmarshal(v, &val); err != nil {
return err return err
} }
@@ -237,7 +319,7 @@ func matchesKinds(candidate int, kinds []int) bool {
return false return false
} }
func matchesTimeRange(timestamp int, since *int, until *int) bool { func matchesTimeRange(timestamp int64, since *int64, until *int64) bool {
if since != nil && timestamp < *since { if since != nil && timestamp < *since {
return false return false
} }
filters/filter_json_test.go
+154 -191
View File
@@ -37,57 +37,57 @@ var marshalTestCases = []FilterMarshalTestCase{
// ID cases // ID cases
{ {
name: "nil IDs", name: "nil IDs",
filter: Filter{IDs: nil}, filter: NewFilter(WithIDs(nil)),
expected: `{}`, expected: `{}`,
}, },
{ {
name: "empty IDs", name: "empty IDs",
filter: Filter{IDs: []string{}}, filter: NewFilter(WithIDs([]string{})),
expected: `{"ids":[]}`, expected: `{"ids":[]}`,
}, },
{ {
name: "populated IDs", name: "populated IDs",
filter: Filter{IDs: []string{"abc", "123"}}, filter: NewFilter(WithIDs([]string{"abc", "123"})),
expected: `{"ids":["abc","123"]}`, expected: `{"ids":["abc","123"]}`,
}, },
// Author cases // Author cases
{ {
name: "nil Authors", name: "nil Authors",
filter: Filter{Authors: nil}, filter: NewFilter(WithAuthors(nil)),
expected: `{}`, expected: `{}`,
}, },
{ {
name: "empty Authors", name: "empty Authors",
filter: Filter{Authors: []string{}}, filter: NewFilter(WithAuthors([]string{})),
expected: `{"authors":[]}`, expected: `{"authors":[]}`,
}, },
{ {
name: "populated Authors", name: "populated Authors",
filter: Filter{Authors: []string{"abc", "123"}}, filter: NewFilter(WithAuthors([]string{"abc", "123"})),
expected: `{"authors":["abc","123"]}`, expected: `{"authors":["abc","123"]}`,
}, },
// Kind cases // Kind cases
{ {
name: "nil Kinds", name: "nil Kinds",
filter: Filter{Kinds: nil}, filter: NewFilter(WithKinds(nil)),
expected: `{}`, expected: `{}`,
}, },
{ {
name: "empty Kinds", name: "empty Kinds",
filter: Filter{Kinds: []int{}}, filter: NewFilter(WithKinds([]int{})),
expected: `{"kinds":[]}`, expected: `{"kinds":[]}`,
}, },
{ {
name: "populated Kinds", name: "populated Kinds",
filter: Filter{Kinds: []int{1, 20001}}, filter: NewFilter(WithKinds([]int{1, 20001})),
expected: `{"kinds":[1,20001]}`, expected: `{"kinds":[1,20001]}`,
}, },
@@ -100,7 +100,7 @@ var marshalTestCases = []FilterMarshalTestCase{
{ {
name: "populated Since", name: "populated Since",
filter: Filter{Since: intPtr(1000)}, filter: NewFilter(WithSince(1000)),
expected: `{"since":1000}`, expected: `{"since":1000}`,
}, },
@@ -113,7 +113,7 @@ var marshalTestCases = []FilterMarshalTestCase{
{ {
name: "populated Until", name: "populated Until",
filter: Filter{Until: intPtr(1000)}, filter: NewFilter(WithUntil(1000)),
expected: `{"until":1000}`, expected: `{"until":1000}`,
}, },
@@ -126,27 +126,31 @@ var marshalTestCases = []FilterMarshalTestCase{
{ {
name: "populated Limit", name: "populated Limit",
filter: Filter{Limit: intPtr(100)}, filter: NewFilter(WithLimit(100)),
expected: `{"limit":100}`, expected: `{"limit":100}`,
}, },
// All standard fields // All standard fields
{ {
name: "all standard fields", name: "all standard fields",
filter: Filter{ filter: NewFilter(
IDs: []string{"abc", "123"}, WithIDs([]string{"abc", "123"}),
Authors: []string{"def", "456"}, WithAuthors([]string{"def", "456"}),
Kinds: []int{1, 200, 3000}, WithKinds([]int{1, 200, 3000}),
Since: intPtr(1000), WithSince(1000),
Until: intPtr(2000), WithUntil(2000),
Limit: intPtr(100), WithLimit(100),
}, ),
expected: `{"ids":["abc","123"],"authors":["def","456"],"kinds":[1,200,3000],"since":1000,"until":2000,"limit":100}`, expected: `{"ids":["abc","123"],"authors":["def","456"],"kinds":[1,200,3000],"since":1000,"until":2000,"limit":100}`,
}, },
{ {
name: "mixed fields", name: "mixed fields",
filter: Filter{IDs: nil, Authors: []string{}, Kinds: []int{1}}, filter: NewFilter(
WithIDs(nil),
WithAuthors([]string{}),
WithKinds([]int{1}),
),
expected: `{"authors":[],"kinds":[1]}`, expected: `{"authors":[],"kinds":[1]}`,
}, },
@@ -159,164 +163,138 @@ var marshalTestCases = []FilterMarshalTestCase{
{ {
name: "single-letter tag", name: "single-letter tag",
filter: Filter{Tags: map[string][]string{ filter: NewFilter(
"e": {"event1"}, WithTag("e", []string{"event1"}),
}}, ),
expected: `{"#e":["event1"]}`, expected: `{"#e":["event1"]}`,
}, },
{ {
name: "multi-letter tag", name: "multi-letter tag",
filter: Filter{Tags: map[string][]string{ filter: NewFilter(
"emoji": {"🔥", "💧"}, WithTag("emoji", []string{"🔥", "💧"}),
}}, ),
expected: `{"#emoji":["🔥","💧"]}`, expected: `{"#emoji":["🔥","💧"]}`,
}, },
{ {
name: "empty tag array", name: "empty tag array",
filter: Filter{Tags: map[string][]string{ filter: NewFilter(
"p": {}, WithTag("p", []string{}),
}}, ),
expected: `{"#p":[]}`, expected: `{"#p":[]}`,
}, },
{ {
name: "multiple tags", name: "multiple tags",
filter: Filter{Tags: map[string][]string{ filter: NewFilter(
"e": {"event1", "event2"}, WithTag("e", []string{"event1", "event2"}),
"p": {"pubkey1", "pubkey2"}, WithTag("p", []string{"pubkey1", "pubkey2"}),
}}, ),
expected: `{"#e":["event1","event2"],"#p":["pubkey1","pubkey2"]}`, expected: `{"#e":["event1","event2"],"#p":["pubkey1","pubkey2"]}`,
}, },
// Extensions // Extensions
{ {
name: "simple extension", name: "simple extension",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("search", json.RawMessage(`"query"`)),
"search": json.RawMessage(`"query"`), ),
},
},
expected: `{"search":"query"}`, expected: `{"search":"query"}`,
}, },
{ {
name: "extension with nested object", name: "extension with nested object",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("meta", json.RawMessage(`{"author":"alice","score":99}`)),
"meta": json.RawMessage(`{"author":"alice","score":99}`), ),
},
},
expected: `{"meta":{"author":"alice","score":99}}`, expected: `{"meta":{"author":"alice","score":99}}`,
}, },
{ {
name: "extension with nested array", name: "extension with nested array",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("items", json.RawMessage(`[1,2,3]`)),
"items": json.RawMessage(`[1,2,3]`), ),
},
},
expected: `{"items":[1,2,3]}`, expected: `{"items":[1,2,3]}`,
}, },
{ {
name: "extension with complex nested structure", name: "extension with complex nested structure",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("data", json.RawMessage(`{"users":[{"id":1}],"count":5}`)),
"data": json.RawMessage(`{"users":[{"id":1}],"count":5}`), ),
},
},
expected: `{"data":{"users":[{"id":1}],"count":5}}`, expected: `{"data":{"users":[{"id":1}],"count":5}}`,
}, },
{ {
name: "multiple extensions", name: "multiple extensions",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("search", json.RawMessage(`"x"`)),
"search": json.RawMessage(`"x"`), WithExtension("depth", json.RawMessage(`3`)),
"depth": json.RawMessage(`3`), ),
},
},
expected: `{"search":"x","depth":3}`, expected: `{"search":"x","depth":3}`,
}, },
// Extension Collisions // Extension Collisions
{ {
name: "extension collides with standard field - IDs", name: "extension collides with standard field - IDs",
filter: Filter{ filter: NewFilter(
IDs: []string{"real"}, WithIDs([]string{"real"}),
Extensions: map[string]json.RawMessage{ WithExtension("ids", json.RawMessage(`["fake"]`)),
"ids": json.RawMessage(`["fake"]`), ),
},
},
expected: `{"ids":["real"]}`, expected: `{"ids":["real"]}`,
}, },
{ {
name: "extension collides with standard field - Since", name: "extension collides with standard field - Since",
filter: Filter{ filter: NewFilter(
Since: intPtr(100), WithSince(100),
Extensions: map[string]json.RawMessage{ WithExtension("since", json.RawMessage(`999`)),
"since": json.RawMessage(`999`), ),
},
},
expected: `{"since":100}`, expected: `{"since":100}`,
}, },
{ {
name: "extension collides with multiple standard fields", name: "extension collides with multiple standard fields",
filter: Filter{ filter: NewFilter(
Authors: []string{"a"}, WithAuthors([]string{"a"}),
Kinds: []int{1}, WithKinds([]int{1}),
Extensions: map[string]json.RawMessage{ WithExtension("authors", json.RawMessage(`["b"]`)),
"authors": json.RawMessage(`["b"]`), WithExtension("kinds", json.RawMessage(`[2]`)),
"kinds": json.RawMessage(`[2]`), ),
},
},
expected: `{"authors":["a"],"kinds":[1]}`, expected: `{"authors":["a"],"kinds":[1]}`,
}, },
{ {
name: "extension collides with tag field - #e", name: "extension collides with tag field - #e",
filter: Filter{ filter: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("#e", json.RawMessage(`["fakeevent"]`)),
"#e": json.RawMessage(`["fakeevent"]`), ),
},
},
expected: `{}`, expected: `{}`,
}, },
{ {
name: "extension collides with standard and tag fields", name: "extension collides with standard and tag fields",
filter: Filter{ filter: NewFilter(
Authors: []string{"realauthor"}, WithAuthors([]string{"realauthor"}),
Tags: map[string][]string{ WithTag("e", []string{"realevent"}),
"e": {"realevent"}, WithExtension("authors", json.RawMessage(`["fakeauthor"]`)),
}, WithExtension("#e", json.RawMessage(`["fakeevent"]`)),
Extensions: map[string]json.RawMessage{ ),
"authors": json.RawMessage(`["fakeauthor"]`),
"#e": json.RawMessage(`["fakeevent"]`),
},
},
expected: `{"authors":["realauthor"],"#e":["realevent"]}`, expected: `{"authors":["realauthor"],"#e":["realevent"]}`,
}, },
// Kitchen Sink // Kitchen Sink
{ {
name: "filter with all field types", name: "filter with all field types",
filter: Filter{ filter: NewFilter(
IDs: []string{"x"}, WithIDs([]string{"x"}),
Since: intPtr(100), WithSince(100),
Tags: map[string][]string{ WithTag("e", []string{"y"}),
"e": {"y"}, WithExtension("search", json.RawMessage(`"z"`)),
}, WithExtension("ids", json.RawMessage(`["fakeid"]`)),
Extensions: map[string]json.RawMessage{ ),
"search": json.RawMessage(`"z"`),
"ids": json.RawMessage(`["fakeid"]`),
},
},
expected: `{"ids":["x"],"since":100,"#e":["y"],"search":"z"}`, expected: `{"ids":["x"],"since":100,"#e":["y"],"search":"z"}`,
}, },
} }
@@ -325,64 +303,64 @@ var unmarshalTestCases = []FilterUnmarshalTestCase{
{ {
name: "empty object", name: "empty object",
input: `{}`, input: `{}`,
expected: Filter{}, expected: NewFilter(),
}, },
// ID cases // ID cases
{ {
name: "null IDs", name: "null IDs",
input: `{"ids": null}`, input: `{"ids": null}`,
expected: Filter{IDs: nil}, expected: NewFilter(WithIDs(nil)),
}, },
{ {
name: "empty IDs", name: "empty IDs",
input: `{"ids": []}`, input: `{"ids": []}`,
expected: Filter{IDs: []string{}}, expected: NewFilter(WithIDs([]string{})),
}, },
{ {
name: "populated IDs", name: "populated IDs",
input: `{"ids": ["abc","123"]}`, input: `{"ids": ["abc","123"]}`,
expected: Filter{IDs: []string{"abc", "123"}}, expected: NewFilter(WithIDs([]string{"abc", "123"})),
}, },
// Author cases // Author cases
{ {
name: "null Authors", name: "null Authors",
input: `{"authors": null}`, input: `{"authors": null}`,
expected: Filter{Authors: nil}, expected: NewFilter(WithAuthors(nil)),
}, },
{ {
name: "empty Authors", name: "empty Authors",
input: `{"authors": []}`, input: `{"authors": []}`,
expected: Filter{Authors: []string{}}, expected: NewFilter(WithAuthors([]string{})),
}, },
{ {
name: "populated Authors", name: "populated Authors",
input: `{"authors": ["abc","123"]}`, input: `{"authors": ["abc","123"]}`,
expected: Filter{Authors: []string{"abc", "123"}}, expected: NewFilter(WithAuthors([]string{"abc", "123"})),
}, },
// Kind cases // Kind cases
{ {
name: "null Kinds", name: "null Kinds",
input: `{"kinds": null}`, input: `{"kinds": null}`,
expected: Filter{Kinds: nil}, expected: NewFilter(WithKinds(nil)),
}, },
{ {
name: "empty Kinds", name: "empty Kinds",
input: `{"kinds": []}`, input: `{"kinds": []}`,
expected: Filter{Kinds: []int{}}, expected: NewFilter(WithKinds([]int{})),
}, },
{ {
name: "populated Kinds", name: "populated Kinds",
input: `{"kinds": [1,2,3]}`, input: `{"kinds": [1,2,3]}`,
expected: Filter{Kinds: []int{1, 2, 3}}, expected: NewFilter(WithKinds([]int{1, 2, 3})),
}, },
// Since cases // Since cases
@@ -395,7 +373,7 @@ var unmarshalTestCases = []FilterUnmarshalTestCase{
{ {
name: "populated Since", name: "populated Since",
input: `{"since": 1000}`, input: `{"since": 1000}`,
expected: Filter{Since: intPtr(1000)}, expected: NewFilter(WithSince(1000)),
}, },
// Until cases // Until cases
@@ -408,7 +386,7 @@ var unmarshalTestCases = []FilterUnmarshalTestCase{
{ {
name: "populated Until", name: "populated Until",
input: `{"until": 1000}`, input: `{"until": 1000}`,
expected: Filter{Until: intPtr(1000)}, expected: NewFilter(WithUntil(1000)),
}, },
// Limit cases // Limit cases
@@ -421,161 +399,146 @@ var unmarshalTestCases = []FilterUnmarshalTestCase{
{ {
name: "populated Limit", name: "populated Limit",
input: `{"limit": 1000}`, input: `{"limit": 1000}`,
expected: Filter{Limit: intPtr(1000)}, expected: NewFilter(WithLimit(1000)),
}, },
// All standard fields // All standard fields
{ {
name: "all standard fields", name: "all standard fields",
input: `{"ids":["abc","123"],"authors":["def","456"],"kinds":[1,200,3000],"since":1000,"until":2000,"limit":100}`, input: `{"ids":["abc","123"],"authors":["def","456"],"kinds":[1,200,3000],"since":1000,"until":2000,"limit":100}`,
expected: Filter{ expected: NewFilter(
IDs: []string{"abc", "123"}, WithIDs([]string{"abc", "123"}),
Authors: []string{"def", "456"}, WithAuthors([]string{"def", "456"}),
Kinds: []int{1, 200, 3000}, WithKinds([]int{1, 200, 3000}),
Since: intPtr(1000), WithSince(1000),
Until: intPtr(2000), WithUntil(2000),
Limit: intPtr(100), WithLimit(100),
}, ),
}, },
{ {
name: "mixed fields", name: "mixed fields",
input: `{"ids": null, "authors": [], "kinds": [1]}`, input: `{"ids": null, "authors": [], "kinds": [1]}`,
expected: Filter{IDs: nil, Authors: []string{}, Kinds: []int{1}}, expected: NewFilter(
WithIDs(nil),
WithAuthors([]string{}),
WithKinds([]int{1}),
),
}, },
{ {
name: "zero int pointers", name: "zero int pointers",
input: `{"since": 0, "until": 0, "limit": 0}`, input: `{"since": 0, "until": 0, "limit": 0}`,
expected: Filter{Since: intPtr(0), Until: intPtr(0), Limit: intPtr(0)}, expected: NewFilter(WithSince(0), WithUntil(0), WithLimit(0)),
}, },
// Tags // Tags
{ {
name: "single-letter tag", name: "single-letter tag",
input: `{"#e":["event1"]}`, input: `{"#e":["event1"]}`,
expected: Filter{Tags: map[string][]string{"e": {"event1"}}}, expected: NewFilter(WithTag("e", []string{"event1"})),
}, },
{ {
name: "multi-letter tag", name: "multi-letter tag",
input: `{"#emoji":["🔥","💧"]}`, input: `{"#emoji":["🔥","💧"]}`,
expected: Filter{Tags: map[string][]string{"emoji": {"🔥", "💧"}}}, expected: NewFilter(WithTag("emoji", []string{"🔥", "💧"})),
}, },
{ {
name: "empty tag array", name: "empty tag array",
input: `{"#p":[]}`, input: `{"#p":[]}`,
expected: Filter{Tags: map[string][]string{"p": {}}}, expected: NewFilter(WithTag("p", []string{})),
}, },
{ {
name: "multiple tags", name: "multiple tags",
input: `{"#p":["pubkey1","pubkey2"],"#e":["event1","event2"]}`, input: `{"#p":["pubkey1","pubkey2"],"#e":["event1","event2"]}`,
expected: Filter{Tags: map[string][]string{ expected: NewFilter(
"p": {"pubkey1", "pubkey2"}, WithTag("p", []string{"pubkey1", "pubkey2"}),
"e": {"event1", "event2"}, WithTag("e", []string{"event1", "event2"}),
}}, ),
}, },
{ {
name: "null tag", name: "null tag",
input: `{"#p":null}`, input: `{"#p":null}`,
expected: Filter{Tags: map[string][]string{"p": nil}}, expected: NewFilter(WithTag("p", nil)),
}, },
// Extensions // Extensions
{ {
name: "simple extension", name: "simple extension",
input: `{"search":"query"}`, input: `{"search":"query"}`,
expected: Filter{Extensions: map[string]json.RawMessage{ expected: NewFilter(
"search": json.RawMessage(`"query"`), WithExtension("search", json.RawMessage(`"query"`)),
}, ),
},
}, },
{ {
name: "extension with nested object", name: "extension with nested object",
input: `{"meta":{"author":"alice","score":99}}`, input: `{"meta":{"author":"alice","score":99}}`,
expected: Filter{ expected: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("meta", json.RawMessage(`{"author":"alice","score":99}`)),
"meta": json.RawMessage(`{"author":"alice","score":99}`), ),
},
},
}, },
{ {
name: "extension with nested array", name: "extension with nested array",
input: `{"items":[1,2,3]}`, input: `{"items":[1,2,3]}`,
expected: Filter{ expected: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("items", json.RawMessage(`[1,2,3]`)),
"items": json.RawMessage(`[1,2,3]`), ),
},
},
}, },
{ {
name: "extension with complex nested structure", name: "extension with complex nested structure",
input: `{"data":{"level1":{"level2":[{"id":1}]}}}`, input: `{"data":{"level1":{"level2":[{"id":1}]}}}`,
expected: Filter{ expected: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("data", json.RawMessage(`{"level1":{"level2":[{"id":1}]}}`)),
"data": json.RawMessage(`{"level1":{"level2":[{"id":1}]}}`), ),
},
},
}, },
{ {
name: "multiple extensions", name: "multiple extensions",
input: `{"search":"x","custom":true,"depth":3}`, input: `{"search":"x","custom":true,"depth":3}`,
expected: Filter{ expected: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("search", json.RawMessage(`"x"`)),
"search": json.RawMessage(`"x"`), WithExtension("custom", json.RawMessage(`true`)),
"custom": json.RawMessage(`true`), WithExtension("depth", json.RawMessage(`3`)),
"depth": json.RawMessage(`3`), ),
},
},
}, },
{ {
name: "extension with null value", name: "extension with null value",
input: `{"optional":null}`, input: `{"optional":null}`,
expected: Filter{ expected: NewFilter(
Extensions: map[string]json.RawMessage{ WithExtension("optional", json.RawMessage(`null`)),
"optional": json.RawMessage(`null`), ),
},
},
}, },
// Kitchen Sink // Kitchen Sink
{ {
name: "extension with null value", name: "extension with null value",
input: `{"ids":["x"],"since":100,"#e":["y"],"search":"z"}`, input: `{"ids":["x"],"since":100,"#e":["y"],"search":"z"}`,
expected: Filter{ expected: NewFilter(
IDs: []string{"x"}, WithIDs([]string{"x"}),
Since: intPtr(100), WithSince(100),
Tags: map[string][]string{ WithTag("e", []string{"y"}),
"e": {"y"}, WithExtension("search", json.RawMessage(`"z"`)),
}, ),
Extensions: map[string]json.RawMessage{
"search": json.RawMessage(`"z"`),
},
},
}, },
} }
var roundTripTestCases = []FilterRoundTripTestCase{ var roundTripTestCases = []FilterRoundTripTestCase{
{ {
name: "fully populated filter", name: "fully populated filter",
filter: Filter{ filter: NewFilter(
IDs: []string{"x"}, WithIDs([]string{"x"}),
Since: intPtr(100), WithSince(100),
Tags: map[string][]string{ WithTag("e", []string{"y"}),
"e": {"y"}, WithExtension("search", json.RawMessage(`"z"`)),
}, ),
Extensions: map[string]json.RawMessage{
"search": json.RawMessage(`"z"`),
},
},
}, },
} }
filters/filter_match_test.go
+94 -117
View File
@@ -21,7 +21,7 @@ func init() {
} }
// Test keypairs corresponding to test events, for reference. // Test keypairs corresponding to test events, for reference.
var ( const (
nayru_sk = "1784be782585dfa97712afe12585d13ee608b624cf564116fa143c31a124d31e" nayru_sk = "1784be782585dfa97712afe12585d13ee608b624cf564116fa143c31a124d31e"
nayru_pk = "d877e187934bd942a71221b50ff2b426bd0777991b41b6c749119805dc40bcbe" nayru_pk = "d877e187934bd942a71221b50ff2b426bd0777991b41b6c749119805dc40bcbe"
farore_sk = "03d0611c41048a9108a75bf5d023180b5cf2d2d24e2e6b83def29de977315bb3" farore_sk = "03d0611c41048a9108a75bf5d023180b5cf2d2d24e2e6b83def29de977315bb3"
@@ -39,7 +39,7 @@ type FilterTestCase struct {
var filterTestCases = []FilterTestCase{ var filterTestCases = []FilterTestCase{
{ {
name: "empty filter", name: "empty filter",
filter: Filter{}, filter: NewFilter(),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -55,7 +55,7 @@ var filterTestCases = []FilterTestCase{
{ {
name: "empty id", name: "empty id",
filter: Filter{IDs: []string{}}, filter: NewFilter(WithIDs([]string{})),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -71,31 +71,34 @@ var filterTestCases = []FilterTestCase{
{ {
name: "single id prefix", name: "single id prefix",
filter: Filter{IDs: []string{"e751d41f"}}, filter: NewFilter(WithIDs([]string{"e751d41f"})),
expectedIDs: []string{"e751d41f"}, expectedIDs: []string{"e751d41f"},
}, },
{ {
name: "single full id", name: "single full id",
filter: Filter{IDs: []string{"e67fa7b84df6b0bb4c57f8719149de77f58955d7849da1be10b2267c72daad8b"}}, filter: NewFilter(
WithIDs([]string{
"e67fa7b84df6b0bb4c57f8719149de77f58955d7849da1be10b2267c72daad8b"}),
),
expectedIDs: []string{"e67fa7b8"}, expectedIDs: []string{"e67fa7b8"},
}, },
{ {
name: "multiple id prefixes", name: "multiple id prefixes",
filter: Filter{IDs: []string{"562bc378", "5e4c64f1"}}, filter: NewFilter(WithIDs([]string{"562bc378", "5e4c64f1"})),
expectedIDs: []string{"562bc378", "5e4c64f1"}, expectedIDs: []string{"562bc378", "5e4c64f1"},
}, },
{ {
name: "no id match", name: "no id match",
filter: Filter{IDs: []string{"ffff"}}, filter: NewFilter(WithIDs([]string{"ffff"})),
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "empty author", name: "empty author",
filter: Filter{Authors: []string{}}, filter: NewFilter(WithAuthors([]string{})),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -111,13 +114,13 @@ var filterTestCases = []FilterTestCase{
{ {
name: "single author prefix", name: "single author prefix",
filter: Filter{Authors: []string{"d877e187"}}, filter: NewFilter(WithAuthors([]string{"d877e187"})),
expectedIDs: []string{"e751d41f", "562bc378", "e67fa7b8"}, expectedIDs: []string{"e751d41f", "562bc378", "e67fa7b8"},
}, },
{ {
name: "multiple author prefixex", name: "multiple author prefixex",
filter: Filter{Authors: []string{"d877e187", "9e4b726a"}}, filter: NewFilter(WithAuthors([]string{"d877e187", "9e4b726a"})),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -129,20 +132,23 @@ var filterTestCases = []FilterTestCase{
}, },
{ {
name: "single author full", name: "single author full",
filter: Filter{Authors: []string{"d877e187934bd942a71221b50ff2b426bd0777991b41b6c749119805dc40bcbe"}}, filter: NewFilter(
WithAuthors([]string{
"d877e187934bd942a71221b50ff2b426bd0777991b41b6c749119805dc40bcbe"}),
),
expectedIDs: []string{"e751d41f", "562bc378", "e67fa7b8"}, expectedIDs: []string{"e751d41f", "562bc378", "e67fa7b8"},
}, },
{ {
name: "no author match", name: "no author match",
filter: Filter{Authors: []string{"ffff"}}, filter: NewFilter(WithAuthors([]string{"ffff"})),
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "empty kind", name: "empty kind",
filter: Filter{Kinds: []int{}}, filter: NewFilter(WithKinds([]int{})),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -158,13 +164,13 @@ var filterTestCases = []FilterTestCase{
{ {
name: "single kind", name: "single kind",
filter: Filter{Kinds: []int{1}}, filter: NewFilter(WithKinds([]int{1})),
expectedIDs: []string{"562bc378", "7a5d83d4", "4b03b69a"}, expectedIDs: []string{"562bc378", "7a5d83d4", "4b03b69a"},
}, },
{ {
name: "multiple kinds", name: "multiple kinds",
filter: Filter{Kinds: []int{0, 2}}, filter: NewFilter(WithKinds([]int{0, 2})),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"e67fa7b8", "e67fa7b8",
@@ -177,13 +183,13 @@ var filterTestCases = []FilterTestCase{
{ {
name: "no kind match", name: "no kind match",
filter: Filter{Kinds: []int{99}}, filter: NewFilter(WithKinds([]int{99})),
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "since only", name: "since only",
filter: Filter{Since: intPtr(5000)}, filter: NewFilter(WithSince(5000)),
expectedIDs: []string{ expectedIDs: []string{
"7a5d83d4", "7a5d83d4",
"3a122100", "3a122100",
@@ -195,7 +201,7 @@ var filterTestCases = []FilterTestCase{
{ {
name: "until only", name: "until only",
filter: Filter{Until: intPtr(3000)}, filter: NewFilter(WithUntil(3000)),
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -204,11 +210,8 @@ var filterTestCases = []FilterTestCase{
}, },
{ {
name: "time range", name: "time range",
filter: Filter{ filter: NewFilter(WithSince(4000), WithUntil(6000)),
Since: intPtr(4000),
Until: intPtr(6000),
},
expectedIDs: []string{ expectedIDs: []string{
"5e4c64f1", "5e4c64f1",
"7a5d83d4", "7a5d83d4",
@@ -217,20 +220,14 @@ var filterTestCases = []FilterTestCase{
}, },
{ {
name: "outside time range", name: "outside time range",
filter: Filter{ filter: NewFilter(WithSince(10000)),
Since: intPtr(10000),
},
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "empty tag filter", name: "empty tag filter",
filter: Filter{ filter: NewFilter(WithTag("e", []string{})),
Tags: TagFilters{
"e": {},
},
},
expectedIDs: []string{ expectedIDs: []string{
"e751d41f", "e751d41f",
"562bc378", "562bc378",
@@ -246,97 +243,85 @@ var filterTestCases = []FilterTestCase{
{ {
name: "single letter tag filter: e", name: "single letter tag filter: e",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("e", []string{
"e": {"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}, "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}),
}, ),
},
expectedIDs: []string{"562bc378"}, expectedIDs: []string{"562bc378"},
}, },
{ {
name: "multiple tag matches", name: "multiple tag matches",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("e", []string{
"e": { "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36",
"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "ae3f2a91b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7",
"ae3f2a91b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7", }),
}, ),
},
},
expectedIDs: []string{"562bc378", "3a122100"}, expectedIDs: []string{"562bc378", "3a122100"},
}, },
{ {
name: "multiple tag matches - single event match", name: "multiple tag matches - single event match",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("e", []string{
"e": { "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36",
"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "cb7787c460a79187d6a13e75a0f19240e05fafca8ea42288f5765773ea69cf2f",
"cb7787c460a79187d6a13e75a0f19240e05fafca8ea42288f5765773ea69cf2f", }),
}, ),
},
},
expectedIDs: []string{"562bc378"}, expectedIDs: []string{"562bc378"},
}, },
{ {
name: "single letter tag filter: p", name: "single letter tag filter: p",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("p", []string{
"p": {"91cf9b32f3735070f46c0a86a820a47efa08a5be6c9f4f8cf68e5b5b75c92d60"}, "91cf9b32f3735070f46c0a86a820a47efa08a5be6c9f4f8cf68e5b5b75c92d60"}),
}, ),
},
expectedIDs: []string{"e67fa7b8"}, expectedIDs: []string{"e67fa7b8"},
}, },
{ {
name: "multi letter tag filter", name: "multi letter tag filter",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("emoji", []string{"🌊"}),
"emoji": {"🌊"}, ),
},
},
expectedIDs: []string{"e67fa7b8"}, expectedIDs: []string{"e67fa7b8"},
}, },
{ {
name: "multiple tag filters", name: "multiple tag filters",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("e", []string{
"e": {"ae3f2a91b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7"}, "ae3f2a91b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7e9a1c5b4d8f2e7a9b6c3d8f7"}),
"p": {"3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"}, WithTag("p", []string{
}, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"}),
}, ),
expectedIDs: []string{"3a122100"}, expectedIDs: []string{"3a122100"},
}, },
{ {
name: "prefix tag filter", name: "prefix tag filter",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("p", []string{"ae3f2a91"}),
"p": {"ae3f2a91"}, ),
},
},
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "unknown tag filter", name: "unknown tag filter",
filter: Filter{ filter: NewFilter(
Tags: TagFilters{ WithTag("z", []string{"anything"}),
"z": {"anything"}, ),
},
},
expectedIDs: []string{}, expectedIDs: []string{},
}, },
{ {
name: "combined author+kind tag filter", name: "combined author+kind tag filter",
filter: Filter{ filter: NewFilter(
Authors: []string{"d877e187"}, WithAuthors([]string{"d877e187"}),
Kinds: []int{1, 2}, WithKinds([]int{1, 2}),
}, ),
expectedIDs: []string{ expectedIDs: []string{
"562bc378", "562bc378",
"e67fa7b8", "e67fa7b8",
@@ -345,11 +330,11 @@ var filterTestCases = []FilterTestCase{
{ {
name: "combined kind+time range tag filter", name: "combined kind+time range tag filter",
filter: Filter{ filter: NewFilter(
Kinds: []int{0}, WithKinds([]int{0}),
Since: intPtr(2000), WithSince(2000),
Until: intPtr(7000), WithUntil(7000),
}, ),
expectedIDs: []string{ expectedIDs: []string{
"5e4c64f1", "5e4c64f1",
"4a15d963", "4a15d963",
@@ -358,12 +343,10 @@ var filterTestCases = []FilterTestCase{
{ {
name: "combined author+tag tag filter", name: "combined author+tag tag filter",
filter: Filter{ filter: NewFilter(
Authors: []string{"e719e8f8"}, WithAuthors([]string{"e719e8f8"}),
Tags: TagFilters{ WithTag("power", []string{"fire"}),
"power": {"fire"}, ),
},
},
expectedIDs: []string{ expectedIDs: []string{
"4a15d963", "4a15d963",
}, },
@@ -371,15 +354,13 @@ var filterTestCases = []FilterTestCase{
{ {
name: "combined tag filter", name: "combined tag filter",
filter: Filter{ filter: NewFilter(
Authors: []string{"e719e8f8"}, WithAuthors([]string{"e719e8f8"}),
Kinds: []int{0}, WithKinds([]int{0}),
Since: intPtr(5000), WithSince(5000),
Until: intPtr(10000), WithUntil(10000),
Tags: TagFilters{ WithTag("power", []string{"fire"}),
"power": {"fire"}, ),
},
},
expectedIDs: []string{ expectedIDs: []string{
"4a15d963", "4a15d963",
}, },
@@ -404,17 +385,13 @@ func TestEventFilterMatching(t *testing.T) {
// TestEventFilterMatchingSkipMalformedTags documents that filter.Matches() // TestEventFilterMatchingSkipMalformedTags documents that filter.Matches()
// skips malformed tags during tag matching // skips malformed tags during tag matching
func TestEventFilterMatchingSkipMalformedTags(t *testing.T) { func TestEventFilterMatchingSkipMalformedTags(t *testing.T) {
event := events.Event{ event := events.NewEvent(
Tags: []events.Tag{ events.WithTag(events.Tag{"malformed"}),
{"malformed"}, events.WithTag(events.Tag{"valid", "value"}),
{"valid", "value"}, )
}, filter := NewFilter(
} WithTag("valid", []string{"value"}),
filter := Filter{ )
Tags: TagFilters{
"valid": {"value"},
},
}
assert.True(t, Matches(filter, event)) assert.True(t, Matches(filter, event))
} }
filters/util_test.go
-5
View File
@@ -1,5 +0,0 @@
package filters
func intPtr(i int) *int {
return &i
}