627724f702
the main motivation for this change is to be able to run tests.
before this commit, Start, Router and Log operated on global variables,
making automated testing unreasonably hard.
this commit puts all that a server needs in a new Server type,
which also made it possible for a Server.Shutdown - see ShutdownAware
doc comments.
BREAKING CHANGES:
- Relay.OnInitialized takes one argument now, *relayer.Server.
- relayer.Router is now replaced by relayer.Server.Router().
package users can still hook into the router from OnInitialized
for custom HTTP routing.
- relayer.Log is gone. apart from another global var, imho this was
a too opinionated choice for a framework to build a custom relay upon.
this commit introduces a Logger interface which package users can implement
for zerolog to make it log like before. see Server.Log for details.
other notable changes: finally added a couple basic tests, for start up
and shutdown. doc comments now explain most of the essentials,
hopefully making it more approachable for newcomers and easier to understand
the relayer package.
the changes in handlers.go are minimal, although git diff goes crazy.
this is because most of the lines are simply shifted indentation back by one
due to go fmt.
before this commit:
func handleWebsocket(relay Relay) func(http.ResponseWriter, *http.Request)
func handleNIP11(relay Relay) func(http.ResponseWriter, *http.Request)
after:
func (s *Server) handleWebsocket(w http.ResponseWriter, r *http.Request)
func (s *Server) handleNIP11(w http.ResponseWriter, r *http.Request)
105 lines
2.0 KiB
Go
105 lines
2.0 KiB
Go
package relayer
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/nbd-wtf/go-nostr"
|
|
)
|
|
|
|
func startTestRelay(t *testing.T, tr *testRelay) *Server {
|
|
t.Helper()
|
|
ready := make(chan struct{})
|
|
|
|
onInitializedFn := tr.onInitialized
|
|
tr.onInitialized = func(s *Server) {
|
|
close(ready)
|
|
if onInitializedFn != nil {
|
|
onInitializedFn(s)
|
|
}
|
|
}
|
|
srv := NewServer("127.0.0.1:0", tr)
|
|
go srv.Start()
|
|
|
|
select {
|
|
case <-ready:
|
|
case <-time.After(time.Second):
|
|
t.Fatal("server took too long to start up")
|
|
}
|
|
return srv
|
|
}
|
|
|
|
type testRelay struct {
|
|
name string
|
|
storage Storage
|
|
init func() error
|
|
onInitialized func(*Server)
|
|
onShutdown func(context.Context)
|
|
acceptEvent func(*nostr.Event) bool
|
|
}
|
|
|
|
func (tr *testRelay) Name() string { return tr.name }
|
|
func (tr *testRelay) Storage() Storage { return tr.storage }
|
|
|
|
func (tr *testRelay) Init() error {
|
|
if fn := tr.init; fn != nil {
|
|
return fn()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (tr *testRelay) OnInitialized(s *Server) {
|
|
if fn := tr.onInitialized; fn != nil {
|
|
fn(s)
|
|
}
|
|
}
|
|
|
|
func (tr *testRelay) OnShutdown(ctx context.Context) {
|
|
if fn := tr.onShutdown; fn != nil {
|
|
fn(ctx)
|
|
}
|
|
}
|
|
|
|
func (tr *testRelay) AcceptEvent(e *nostr.Event) bool {
|
|
if fn := tr.acceptEvent; fn != nil {
|
|
return fn(e)
|
|
}
|
|
return true
|
|
}
|
|
|
|
type testStorage struct {
|
|
init func() error
|
|
queryEvents func(*nostr.Filter) ([]nostr.Event, error)
|
|
deleteEvent func(id string, pubkey string) error
|
|
saveEvent func(*nostr.Event) error
|
|
}
|
|
|
|
func (st *testStorage) Init() error {
|
|
if fn := st.init; fn != nil {
|
|
return fn()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (st *testStorage) QueryEvents(f *nostr.Filter) ([]nostr.Event, error) {
|
|
if fn := st.queryEvents; fn != nil {
|
|
return fn(f)
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func (st *testStorage) DeleteEvent(id string, pubkey string) error {
|
|
if fn := st.deleteEvent; fn != nil {
|
|
return fn(id, pubkey)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (st *testStorage) SaveEvent(e *nostr.Event) error {
|
|
if fn := st.saveEvent; fn != nil {
|
|
return fn(e)
|
|
}
|
|
return nil
|
|
}
|