backporting relay client and pool from latest go-nostr

This commit is contained in:
2025-08-06 22:18:26 +01:00
parent a7dd958585
commit 9c8ff2976d
41 changed files with 1954 additions and 1623 deletions

View File

@@ -1,224 +1,98 @@
package ws
import (
"bytes"
"compress/flate"
"context"
"crypto/tls"
"errors"
"fmt"
"github.com/gobwas/httphead"
"github.com/gobwas/ws"
"github.com/gobwas/ws/wsflate"
"github.com/gobwas/ws/wsutil"
"io"
"net"
"net/http"
"orly.dev/pkg/utils/chk"
"orly.dev/pkg/utils/context"
"orly.dev/pkg/utils/errorf"
"orly.dev/pkg/utils/log"
"net/textproto"
"time"
ws "github.com/coder/websocket"
)
// Connection is an outbound client -> relay connection.
type Connection struct {
conn net.Conn
enableCompression bool
controlHandler wsutil.FrameHandlerFunc
flateReader *wsflate.Reader
reader *wsutil.Reader
flateWriter *wsflate.Writer
writer *wsutil.Writer
msgStateR *wsflate.MessageState
msgStateW *wsflate.MessageState
var defaultConnectionOptions = &ws.DialOptions{
CompressionMode: ws.CompressionContextTakeover,
HTTPHeader: http.Header{
textproto.CanonicalMIMEHeaderKey("User-Agent"): {"github.com/nbd-wtf/go-nostr"},
},
}
// NewConnection creates a new Connection.
func NewConnection(
c context.T, url string, requestHeader http.Header,
tlsConfig *tls.Config,
) (connection *Connection, errResult error) {
dialer := ws.Dialer{
Header: ws.HandshakeHeaderHTTP(requestHeader),
Extensions: []httphead.Option{
wsflate.DefaultParameters.Option(),
},
TLSConfig: tlsConfig,
func getConnectionOptions(
requestHeader http.Header, tlsConfig *tls.Config,
) *ws.DialOptions {
if requestHeader == nil && tlsConfig == nil {
return defaultConnectionOptions
}
conn, _, hs, err := dialer.Dial(c, url)
return &ws.DialOptions{
HTTPHeader: requestHeader,
CompressionMode: ws.CompressionContextTakeover,
HTTPClient: &http.Client{
Transport: &http.Transport{
TLSClientConfig: tlsConfig,
},
},
}
}
// Connection represents a websocket connection to a Nostr relay.
type Connection struct {
conn *ws.Conn
}
// NewConnection creates a new websocket connection to a Nostr relay.
func NewConnection(
ctx context.Context, url string, requestHeader http.Header,
tlsConfig *tls.Config,
) (*Connection, error) {
c, _, err := ws.Dial(
ctx, url, getConnectionOptions(requestHeader, tlsConfig),
)
if err != nil {
return nil, err
}
enableCompression := false
state := ws.StateClientSide
for _, extension := range hs.Extensions {
if string(extension.Name) == wsflate.ExtensionName {
enableCompression = true
state |= ws.StateExtended
break
}
}
// reader
var flateReader *wsflate.Reader
var msgStateR wsflate.MessageState
if enableCompression {
msgStateR.SetCompressed(true)
flateReader = wsflate.NewReader(
nil, func(r io.Reader) wsflate.Decompressor {
return flate.NewReader(r)
},
)
}
controlHandler := wsutil.ControlFrameHandler(conn, ws.StateClientSide)
reader := &wsutil.Reader{
Source: conn,
State: state,
OnIntermediate: controlHandler,
CheckUTF8: false,
Extensions: []wsutil.RecvExtension{
&msgStateR,
},
}
// writer
var flateWriter *wsflate.Writer
var msgStateW wsflate.MessageState
if enableCompression {
msgStateW.SetCompressed(true)
c.SetReadLimit(2 << 24) // 33MB
flateWriter = wsflate.NewWriter(
nil, func(w io.Writer) wsflate.Compressor {
fw, err := flate.NewWriter(w, 4)
if err != nil {
log.E.F("Failed to create flate writer: %v", err)
}
return fw
},
)
}
writer := wsutil.NewWriter(conn, state, ws.OpText)
writer.SetExtensions(&msgStateW)
return &Connection{
conn: conn,
enableCompression: enableCompression,
controlHandler: controlHandler,
flateReader: flateReader,
reader: reader,
msgStateR: &msgStateR,
flateWriter: flateWriter,
writer: writer,
msgStateW: &msgStateW,
conn: c,
}, nil
}
// WriteMessage dispatches a message through the Connection.
func (cn *Connection) WriteMessage(c context.T, data []byte) (err error) {
select {
case <-c.Done():
return errorf.E(
"%s context canceled",
cn.conn.RemoteAddr(),
)
default:
// WriteMessage writes arbitrary bytes to the websocket connection.
func (c *Connection) WriteMessage(ctx context.Context, data []byte) error {
if err := c.conn.Write(ctx, ws.MessageText, data); err != nil {
return fmt.Errorf("failed to write message: %w", err)
}
if cn.msgStateW.IsCompressed() && cn.enableCompression {
cn.flateWriter.Reset(cn.writer)
if _, err := io.Copy(
cn.flateWriter, bytes.NewReader(data),
); chk.T(err) {
return errorf.E(
"%s failed to write message: %w",
cn.conn.RemoteAddr(),
err,
)
}
if err := cn.flateWriter.Close(); chk.T(err) {
return errorf.E(
"%s failed to close flate writer: %w",
cn.conn.RemoteAddr(),
err,
)
}
} else {
if _, err := io.Copy(cn.writer, bytes.NewReader(data)); chk.T(err) {
return errorf.E(
"%s failed to write message: %w",
cn.conn.RemoteAddr(),
err,
)
}
return nil
}
// ReadMessage reads arbitrary bytes from the websocket connection into the provided buffer.
func (c *Connection) ReadMessage(ctx context.Context, buf io.Writer) error {
_, reader, err := c.conn.Reader(ctx)
if err != nil {
return fmt.Errorf("failed to get reader: %w", err)
}
if err := cn.writer.Flush(); chk.T(err) {
return errorf.E(
"%s failed to flush writer: %w",
cn.conn.RemoteAddr(),
err,
)
if _, err := io.Copy(buf, reader); err != nil {
return fmt.Errorf("failed to read message: %w", err)
}
return nil
}
// ReadMessage picks up the next incoming message on a Connection.
func (cn *Connection) ReadMessage(c context.T, buf io.Writer) (err error) {
for {
select {
case <-c.Done():
return errorf.D(
"%s context canceled",
cn.conn.RemoteAddr(),
)
default:
}
h, err := cn.reader.NextFrame()
if err != nil {
cn.conn.Close()
return fmt.Errorf(
"%s failed to advance frame: %s",
cn.conn.RemoteAddr(),
err.Error(),
)
}
if h.OpCode.IsControl() {
if err := cn.controlHandler(h, cn.reader); chk.T(err) {
return errorf.E(
"%s failed to handle control frame: %w",
cn.conn.RemoteAddr(),
err,
)
}
} else if h.OpCode == ws.OpBinary ||
h.OpCode == ws.OpText {
break
}
if err := cn.reader.Discard(); chk.T(err) {
return errorf.E(
"%s failed to discard: %w",
cn.conn.RemoteAddr(),
err,
)
}
}
if cn.msgStateR.IsCompressed() && cn.enableCompression {
cn.flateReader.Reset(cn.reader)
if _, err := io.Copy(buf, cn.flateReader); chk.T(err) {
return errorf.E(
"%s failed to read message: %w",
cn.conn.RemoteAddr(),
err,
)
}
} else {
if _, err := io.Copy(buf, cn.reader); chk.T(err) {
return errorf.E(
"%s failed to read message: %w",
cn.conn.RemoteAddr(),
err,
)
}
}
return nil
// Close closes the websocket connection.
func (c *Connection) Close() error {
return c.conn.Close(ws.StatusNormalClosure, "")
}
// Close the Connection.
func (cn *Connection) Close() (err error) {
return cn.conn.Close()
// Ping sends a ping message to the websocket connection.
func (c *Connection) Ping(ctx context.Context) error {
ctx, cancel := context.WithTimeoutCause(
ctx, time.Millisecond*800, errors.New("ping took too long"),
)
defer cancel()
return c.conn.Ping(ctx)
}