578 lines
14 KiB
Go
578 lines
14 KiB
Go
package nostr
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log"
|
|
"math"
|
|
"net/http"
|
|
"slices"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/nbd-wtf/go-nostr/nip45/hyperloglog"
|
|
"github.com/puzpuzpuz/xsync/v3"
|
|
)
|
|
|
|
const (
|
|
seenAlreadyDropTick = time.Minute
|
|
)
|
|
|
|
type SimplePool struct {
|
|
Relays *xsync.MapOf[string, *Relay]
|
|
Context context.Context
|
|
|
|
authHandler func(context.Context, RelayEvent) error
|
|
cancel context.CancelCauseFunc
|
|
|
|
eventMiddleware func(RelayEvent)
|
|
duplicateMiddleware func(relay string, id string)
|
|
queryMiddleware func(relay string, pubkey string, kind int)
|
|
|
|
// custom things not often used
|
|
penaltyBoxMu sync.Mutex
|
|
penaltyBox map[string][2]float64
|
|
relayOptions []RelayOption
|
|
}
|
|
|
|
type DirectedFilter struct {
|
|
Filter
|
|
Relay string
|
|
}
|
|
|
|
type RelayEvent struct {
|
|
*Event
|
|
Relay *Relay
|
|
}
|
|
|
|
func (ie RelayEvent) String() string {
|
|
return fmt.Sprintf("[%s] >> %s", ie.Relay.URL, ie.Event)
|
|
}
|
|
|
|
type PoolOption interface {
|
|
ApplyPoolOption(*SimplePool)
|
|
}
|
|
|
|
func NewSimplePool(ctx context.Context, opts ...PoolOption) *SimplePool {
|
|
ctx, cancel := context.WithCancelCause(ctx)
|
|
|
|
pool := &SimplePool{
|
|
Relays: xsync.NewMapOf[string, *Relay](),
|
|
|
|
Context: ctx,
|
|
cancel: cancel,
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
opt.ApplyPoolOption(pool)
|
|
}
|
|
|
|
return pool
|
|
}
|
|
|
|
// WithRelayOptions sets options that will be used on every relay instance created by this pool.
|
|
func WithRelayOptions(ropts ...RelayOption) withRelayOptionsOpt {
|
|
return ropts
|
|
}
|
|
|
|
type withRelayOptionsOpt []RelayOption
|
|
|
|
func (h withRelayOptionsOpt) ApplyPoolOption(pool *SimplePool) {
|
|
pool.relayOptions = h
|
|
}
|
|
|
|
// WithAuthHandler must be a function that signs the auth event when called.
|
|
// it will be called whenever any relay in the pool returns a `CLOSED` message
|
|
// with the "auth-required:" prefix, only once for each relay
|
|
type WithAuthHandler func(ctx context.Context, authEvent RelayEvent) error
|
|
|
|
func (h WithAuthHandler) ApplyPoolOption(pool *SimplePool) {
|
|
pool.authHandler = h
|
|
}
|
|
|
|
// WithPenaltyBox just sets the penalty box mechanism so relays that fail to connect
|
|
// or that disconnect will be ignored for a while and we won't attempt to connect again.
|
|
func WithPenaltyBox() withPenaltyBoxOpt { return withPenaltyBoxOpt{} }
|
|
|
|
type withPenaltyBoxOpt struct{}
|
|
|
|
func (h withPenaltyBoxOpt) ApplyPoolOption(pool *SimplePool) {
|
|
pool.penaltyBox = make(map[string][2]float64)
|
|
go func() {
|
|
sleep := 30.0
|
|
for {
|
|
time.Sleep(time.Duration(sleep) * time.Second)
|
|
|
|
pool.penaltyBoxMu.Lock()
|
|
nextSleep := 300.0
|
|
for url, v := range pool.penaltyBox {
|
|
remainingSeconds := v[1]
|
|
remainingSeconds -= sleep
|
|
if remainingSeconds <= 0 {
|
|
pool.penaltyBox[url] = [2]float64{v[0], 0}
|
|
continue
|
|
} else {
|
|
pool.penaltyBox[url] = [2]float64{v[0], remainingSeconds}
|
|
}
|
|
|
|
if remainingSeconds < nextSleep {
|
|
nextSleep = remainingSeconds
|
|
}
|
|
}
|
|
|
|
sleep = nextSleep
|
|
pool.penaltyBoxMu.Unlock()
|
|
}
|
|
}()
|
|
}
|
|
|
|
// WithEventMiddleware is a function that will be called with all events received.
|
|
type WithEventMiddleware func(RelayEvent)
|
|
|
|
func (h WithEventMiddleware) ApplyPoolOption(pool *SimplePool) {
|
|
pool.eventMiddleware = h
|
|
}
|
|
|
|
// WithDuplicateMiddleware is a function that will be called with all duplicate ids received.
|
|
type WithDuplicateMiddleware func(relay string, id string)
|
|
|
|
func (h WithDuplicateMiddleware) ApplyPoolOption(pool *SimplePool) {
|
|
pool.duplicateMiddleware = h
|
|
}
|
|
|
|
// WithQueryMiddleware is a function that will be called with every combination of relay+pubkey+kind queried
|
|
// in a .SubMany*() call -- when applicable (i.e. when the query contains a pubkey and a kind).
|
|
type WithAuthorKindQueryMiddleware func(relay string, pubkey string, kind int)
|
|
|
|
func (h WithAuthorKindQueryMiddleware) ApplyPoolOption(pool *SimplePool) {
|
|
pool.queryMiddleware = h
|
|
}
|
|
|
|
var (
|
|
_ PoolOption = (WithAuthHandler)(nil)
|
|
_ PoolOption = (WithEventMiddleware)(nil)
|
|
_ PoolOption = WithPenaltyBox()
|
|
_ PoolOption = WithRelayOptions(WithRequestHeader(http.Header{}))
|
|
)
|
|
|
|
func (pool *SimplePool) EnsureRelay(url string) (*Relay, error) {
|
|
nm := NormalizeURL(url)
|
|
defer namedLock(nm)()
|
|
|
|
relay, ok := pool.Relays.Load(nm)
|
|
if ok && relay == nil {
|
|
if pool.penaltyBox != nil {
|
|
pool.penaltyBoxMu.Lock()
|
|
defer pool.penaltyBoxMu.Unlock()
|
|
v, _ := pool.penaltyBox[nm]
|
|
if v[1] > 0 {
|
|
return nil, fmt.Errorf("in penalty box, %fs remaining", v[1])
|
|
}
|
|
}
|
|
} else if ok && relay.IsConnected() {
|
|
// already connected, unlock and return
|
|
return relay, nil
|
|
}
|
|
|
|
// try to connect
|
|
// we use this ctx here so when the pool dies everything dies
|
|
ctx, cancel := context.WithTimeoutCause(
|
|
pool.Context,
|
|
time.Second*15,
|
|
errors.New("connecting to the relay took too long"),
|
|
)
|
|
defer cancel()
|
|
|
|
relay = NewRelay(context.Background(), url, pool.relayOptions...)
|
|
if err := relay.Connect(ctx); err != nil {
|
|
if pool.penaltyBox != nil {
|
|
// putting relay in penalty box
|
|
pool.penaltyBoxMu.Lock()
|
|
defer pool.penaltyBoxMu.Unlock()
|
|
v, _ := pool.penaltyBox[nm]
|
|
pool.penaltyBox[nm] = [2]float64{v[0] + 1, 30.0 + math.Pow(2, v[0]+1)}
|
|
}
|
|
return nil, fmt.Errorf("failed to connect: %w", err)
|
|
}
|
|
|
|
pool.Relays.Store(nm, relay)
|
|
return relay, nil
|
|
}
|
|
|
|
type PublishResult struct {
|
|
Error error
|
|
RelayURL string
|
|
Relay *Relay
|
|
}
|
|
|
|
func (pool *SimplePool) PublishMany(ctx context.Context, urls []string, evt Event) chan PublishResult {
|
|
ch := make(chan PublishResult, len(urls))
|
|
|
|
go func() {
|
|
for _, url := range urls {
|
|
relay, err := pool.EnsureRelay(url)
|
|
if err != nil {
|
|
ch <- PublishResult{err, url, nil}
|
|
} else {
|
|
err = relay.Publish(ctx, evt)
|
|
ch <- PublishResult{err, url, relay}
|
|
}
|
|
}
|
|
|
|
close(ch)
|
|
}()
|
|
|
|
return ch
|
|
}
|
|
|
|
// SubMany opens a subscription with the given filters to multiple relays
|
|
// the subscriptions only end when the context is canceled
|
|
func (pool *SimplePool) SubMany(
|
|
ctx context.Context,
|
|
urls []string,
|
|
filters Filters,
|
|
opts ...SubscriptionOption,
|
|
) chan RelayEvent {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
_ = cancel // do this so `go vet` will stop complaining
|
|
events := make(chan RelayEvent)
|
|
seenAlready := xsync.NewMapOf[string, Timestamp]()
|
|
ticker := time.NewTicker(seenAlreadyDropTick)
|
|
|
|
eose := false
|
|
|
|
pending := xsync.NewCounter()
|
|
pending.Add(int64(len(urls)))
|
|
for i, url := range urls {
|
|
url = NormalizeURL(url)
|
|
urls[i] = url
|
|
if idx := slices.Index(urls, url); idx != i {
|
|
// skip duplicate relays in the list
|
|
continue
|
|
}
|
|
|
|
go func(nm string) {
|
|
defer func() {
|
|
pending.Dec()
|
|
if pending.Value() == 0 {
|
|
close(events)
|
|
}
|
|
cancel()
|
|
}()
|
|
|
|
hasAuthed := false
|
|
interval := 3 * time.Second
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
default:
|
|
}
|
|
|
|
var sub *Subscription
|
|
|
|
if mh := pool.queryMiddleware; mh != nil {
|
|
for _, filter := range filters {
|
|
if filter.Kinds != nil && filter.Authors != nil {
|
|
for _, kind := range filter.Kinds {
|
|
for _, author := range filter.Authors {
|
|
mh(nm, author, kind)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
relay, err := pool.EnsureRelay(nm)
|
|
if err != nil {
|
|
goto reconnect
|
|
}
|
|
hasAuthed = false
|
|
|
|
subscribe:
|
|
sub, err = relay.Subscribe(ctx, filters, append(opts, WithCheckDuplicate(func(id, relay string) bool {
|
|
_, exists := seenAlready.Load(id)
|
|
if exists && pool.duplicateMiddleware != nil {
|
|
pool.duplicateMiddleware(relay, id)
|
|
}
|
|
return exists
|
|
}))...)
|
|
if err != nil {
|
|
goto reconnect
|
|
}
|
|
|
|
go func() {
|
|
<-sub.EndOfStoredEvents
|
|
eose = true
|
|
}()
|
|
|
|
// reset interval when we get a good subscription
|
|
interval = 3 * time.Second
|
|
|
|
for {
|
|
select {
|
|
case evt, more := <-sub.Events:
|
|
if !more {
|
|
// this means the connection was closed for weird reasons, like the server shut down
|
|
// so we will update the filters here to include only events seem from now on
|
|
// and try to reconnect until we succeed
|
|
now := Now()
|
|
for i := range filters {
|
|
filters[i].Since = &now
|
|
}
|
|
goto reconnect
|
|
}
|
|
|
|
ie := RelayEvent{Event: evt, Relay: relay}
|
|
if mh := pool.eventMiddleware; mh != nil {
|
|
mh(ie)
|
|
}
|
|
|
|
seenAlready.Store(evt.ID, evt.CreatedAt)
|
|
|
|
select {
|
|
case events <- ie:
|
|
case <-ctx.Done():
|
|
return
|
|
}
|
|
case <-ticker.C:
|
|
if eose {
|
|
old := Timestamp(time.Now().Add(-seenAlreadyDropTick).Unix())
|
|
for id, value := range seenAlready.Range {
|
|
if value < old {
|
|
seenAlready.Delete(id)
|
|
}
|
|
}
|
|
}
|
|
case reason := <-sub.ClosedReason:
|
|
if strings.HasPrefix(reason, "auth-required:") && pool.authHandler != nil && !hasAuthed {
|
|
// relay is requesting auth. if we can we will perform auth and try again
|
|
err := relay.Auth(ctx, func(event *Event) error {
|
|
return pool.authHandler(ctx, RelayEvent{Event: event, Relay: relay})
|
|
})
|
|
if err == nil {
|
|
hasAuthed = true // so we don't keep doing AUTH again and again
|
|
goto subscribe
|
|
}
|
|
} else {
|
|
log.Printf("CLOSED from %s: '%s'\n", nm, reason)
|
|
}
|
|
return
|
|
case <-ctx.Done():
|
|
return
|
|
}
|
|
}
|
|
|
|
reconnect:
|
|
// we will go back to the beginning of the loop and try to connect again and again
|
|
// until the context is canceled
|
|
time.Sleep(interval)
|
|
interval = interval * 17 / 10 // the next time we try we will wait longer
|
|
}
|
|
}(url)
|
|
}
|
|
|
|
return events
|
|
}
|
|
|
|
// SubManyEose is like SubMany, but it stops subscriptions and closes the channel when gets a EOSE
|
|
func (pool *SimplePool) SubManyEose(
|
|
ctx context.Context,
|
|
urls []string,
|
|
filters Filters,
|
|
opts ...SubscriptionOption,
|
|
) chan RelayEvent {
|
|
seenAlready := xsync.NewMapOf[string, bool]()
|
|
return pool.subManyEoseNonOverwriteCheckDuplicate(ctx, urls, filters, WithCheckDuplicate(func(id, relay string) bool {
|
|
_, exists := seenAlready.Load(id)
|
|
if exists && pool.duplicateMiddleware != nil {
|
|
pool.duplicateMiddleware(relay, id)
|
|
}
|
|
return exists
|
|
}), seenAlready, opts...)
|
|
}
|
|
|
|
func (pool *SimplePool) subManyEoseNonOverwriteCheckDuplicate(
|
|
ctx context.Context,
|
|
urls []string,
|
|
filters Filters,
|
|
wcd WithCheckDuplicate,
|
|
seenAlready *xsync.MapOf[string, bool],
|
|
opts ...SubscriptionOption,
|
|
) chan RelayEvent {
|
|
ctx, cancel := context.WithCancelCause(ctx)
|
|
|
|
events := make(chan RelayEvent)
|
|
wg := sync.WaitGroup{}
|
|
wg.Add(len(urls))
|
|
|
|
opts = append(opts, wcd)
|
|
|
|
go func() {
|
|
// this will happen when all subscriptions get an eose (or when they die)
|
|
wg.Wait()
|
|
cancel(errors.New("all subscriptions ended"))
|
|
close(events)
|
|
}()
|
|
|
|
for _, url := range urls {
|
|
go func(nm string) {
|
|
defer wg.Done()
|
|
|
|
if mh := pool.queryMiddleware; mh != nil {
|
|
for _, filter := range filters {
|
|
if filter.Kinds != nil && filter.Authors != nil {
|
|
for _, kind := range filter.Kinds {
|
|
for _, author := range filter.Authors {
|
|
mh(nm, author, kind)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
relay, err := pool.EnsureRelay(nm)
|
|
if err != nil {
|
|
debugLogf("error connecting to %s with %v: %s", nm, filters, err)
|
|
return
|
|
}
|
|
|
|
hasAuthed := false
|
|
|
|
subscribe:
|
|
sub, err := relay.Subscribe(ctx, filters, opts...)
|
|
if err != nil {
|
|
debugLogf("error subscribing to %s with %v: %s", relay, filters, err)
|
|
return
|
|
}
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-sub.EndOfStoredEvents:
|
|
return
|
|
case reason := <-sub.ClosedReason:
|
|
if strings.HasPrefix(reason, "auth-required:") && pool.authHandler != nil && !hasAuthed {
|
|
// relay is requesting auth. if we can we will perform auth and try again
|
|
err := relay.Auth(ctx, func(event *Event) error {
|
|
return pool.authHandler(ctx, RelayEvent{Event: event, Relay: relay})
|
|
})
|
|
if err == nil {
|
|
hasAuthed = true // so we don't keep doing AUTH again and again
|
|
goto subscribe
|
|
}
|
|
}
|
|
log.Printf("CLOSED from %s: '%s'\n", nm, reason)
|
|
return
|
|
case evt, more := <-sub.Events:
|
|
if !more {
|
|
return
|
|
}
|
|
|
|
ie := RelayEvent{Event: evt, Relay: relay}
|
|
if mh := pool.eventMiddleware; mh != nil {
|
|
mh(ie)
|
|
}
|
|
|
|
seenAlready.Store(evt.ID, true)
|
|
|
|
select {
|
|
case events <- ie:
|
|
case <-ctx.Done():
|
|
return
|
|
}
|
|
}
|
|
}
|
|
}(NormalizeURL(url))
|
|
}
|
|
|
|
return events
|
|
}
|
|
|
|
// CountMany aggregates count results from multiple relays using HyperLogLog
|
|
func (pool *SimplePool) CountMany(
|
|
ctx context.Context,
|
|
urls []string,
|
|
filter Filter,
|
|
opts []SubscriptionOption,
|
|
) int {
|
|
hll := hyperloglog.New(0) // offset is irrelevant here
|
|
|
|
wg := sync.WaitGroup{}
|
|
wg.Add(len(urls))
|
|
for _, url := range urls {
|
|
go func(nm string) {
|
|
defer wg.Done()
|
|
relay, err := pool.EnsureRelay(url)
|
|
if err != nil {
|
|
return
|
|
}
|
|
ce, err := relay.countInternal(ctx, Filters{filter}, opts...)
|
|
if err != nil {
|
|
return
|
|
}
|
|
if len(ce.HyperLogLog) != 256 {
|
|
return
|
|
}
|
|
hll.MergeRegisters(ce.HyperLogLog)
|
|
}(NormalizeURL(url))
|
|
}
|
|
|
|
wg.Wait()
|
|
return int(hll.Count())
|
|
}
|
|
|
|
// QuerySingle returns the first event returned by the first relay, cancels everything else.
|
|
func (pool *SimplePool) QuerySingle(ctx context.Context, urls []string, filter Filter) *RelayEvent {
|
|
ctx, cancel := context.WithCancelCause(ctx)
|
|
for ievt := range pool.SubManyEose(ctx, urls, Filters{filter}) {
|
|
cancel(errors.New("got the first event and ended successfully"))
|
|
return &ievt
|
|
}
|
|
cancel(errors.New("SubManyEose() didn't get yield events"))
|
|
return nil
|
|
}
|
|
|
|
func (pool *SimplePool) BatchedSubManyEose(
|
|
ctx context.Context,
|
|
dfs []DirectedFilter,
|
|
opts ...SubscriptionOption,
|
|
) chan RelayEvent {
|
|
res := make(chan RelayEvent)
|
|
wg := sync.WaitGroup{}
|
|
wg.Add(len(dfs))
|
|
seenAlready := xsync.NewMapOf[string, bool]()
|
|
|
|
for _, df := range dfs {
|
|
go func(df DirectedFilter) {
|
|
for ie := range pool.subManyEoseNonOverwriteCheckDuplicate(ctx,
|
|
[]string{df.Relay},
|
|
Filters{df.Filter},
|
|
WithCheckDuplicate(func(id, relay string) bool {
|
|
_, exists := seenAlready.Load(id)
|
|
if exists && pool.duplicateMiddleware != nil {
|
|
pool.duplicateMiddleware(relay, id)
|
|
}
|
|
return exists
|
|
}), seenAlready, opts...) {
|
|
res <- ie
|
|
}
|
|
|
|
wg.Done()
|
|
}(df)
|
|
}
|
|
|
|
go func() {
|
|
wg.Wait()
|
|
close(res)
|
|
}()
|
|
|
|
return res
|
|
}
|
|
|
|
func (pool *SimplePool) Close(reason string) {
|
|
pool.cancel(fmt.Errorf("pool closed with reason: '%s'", reason))
|
|
}
|