completed inbound pool. Refactored to inbound/outbound semantics.

This commit is contained in:
Jay
2026-04-20 14:19:50 -04:00
parent de3c997279
commit eea208738a
27 changed files with 1401 additions and 244 deletions
+91 -26
View File
@@ -4,8 +4,10 @@ import (
"context" "context"
"log/slog" "log/slog"
"git.wisehodl.dev/jay/go-honeybee/initiatorpool" "git.wisehodl.dev/jay/go-honeybee/inbound"
"git.wisehodl.dev/jay/go-honeybee/outbound"
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
) )
// Connection types // Connection types
@@ -15,22 +17,52 @@ type ConnectionConfig = transport.ConnectionConfig
type RetryConfig = transport.RetryConfig type RetryConfig = transport.RetryConfig
type ConnectionOption = transport.ConnectionOption type ConnectionOption = transport.ConnectionOption
// Initator Pool types // Outbound Pool types
type InitiatorPool = initiatorpool.Pool type OutboundPool = outbound.Pool
type InitiatorPoolConfig = initiatorpool.PoolConfig type OutboundPoolConfig = outbound.PoolConfig
type InitiatorPoolOption = initiatorpool.PoolOption type OutboundPoolOption = outbound.PoolOption
type InitiatorWorkerConfig = initiatorpool.WorkerConfig type OutboundWorkerConfig = outbound.WorkerConfig
type InitiatorWorkerOption = initiatorpool.WorkerOption type OutboundWorkerOption = outbound.WorkerOption
type InitiatorInboxMessage = initiatorpool.InboxMessage type OutboundInboxMessage = outbound.InboxMessage
type InitiatorPoolEvent = initiatorpool.PoolEvent type OutboundPoolEvent = outbound.PoolEvent
type InitiatorPoolEventKind = initiatorpool.PoolEventKind type OutboundPoolEventKind = outbound.PoolEventKind
// Pool event constants // Pool event constants
const ( const (
EventConnected = initiatorpool.EventConnected EventConnected = outbound.EventConnected
EventDisconnected = initiatorpool.EventDisconnected EventDisconnected = outbound.EventDisconnected
)
// Inbound Pool types
type InboundPool = inbound.Pool
type InboundPoolConfig = inbound.PoolConfig
type InboundPoolOption = inbound.PoolOption
type InboundWorkerConfig = inbound.WorkerConfig
type InboundWorkerOption = inbound.WorkerOption
type InboundWorkerFactory = inbound.WorkerFactory
type InboundWorker = inbound.Worker
type InboundWorkerExitKind = inbound.WorkerExitKind
type InboundInboxMessage = inbound.InboxMessage
type InboundPoolEvent = inbound.PoolEvent
type InboundPoolEventKind = inbound.PoolEventKind
// Inbound Pool event constants
const (
EventPeerDisconnected = inbound.EventPeerDisconnected
EventPeerDropped = inbound.EventPeerDropped
EventPeerEvicted = inbound.EventPeerEvicted
)
// Inbound Worker exit kinds
const (
ExitCleanDisconnect = inbound.ExitCleanDisconnect
ExitUnexpectedDrop = inbound.ExitUnexpectedDrop
ExitInactive = inbound.ExitInactive
) )
// Connection constructors // Connection constructors
@@ -55,31 +87,64 @@ var (
WithCloseHandler = transport.WithCloseHandler WithCloseHandler = transport.WithCloseHandler
) )
// Initiator Pool constructors // Outbound Pool constructors
func NewInitiatorPool(ctx context.Context, config *InitiatorPoolConfig, logger *slog.Logger) (*InitiatorPool, error) { func NewOutboundPool(ctx context.Context, config *OutboundPoolConfig, logger *slog.Logger) (*OutboundPool, error) {
return initiatorpool.NewPool(ctx, config, logger) return outbound.NewPool(ctx, config, logger)
} }
func NewInitiatorPoolConfig(opts ...InitiatorPoolOption) (*InitiatorPoolConfig, error) { func NewOutboundPoolConfig(opts ...OutboundPoolOption) (*OutboundPoolConfig, error) {
return initiatorpool.NewPoolConfig(opts...) return outbound.NewPoolConfig(opts...)
} }
func NewInitiatorWorkerConfig(opts ...InitiatorWorkerOption) (*InitiatorWorkerConfig, error) { func NewOutboundWorkerConfig(opts ...OutboundWorkerOption) (*OutboundWorkerConfig, error) {
return initiatorpool.NewWorkerConfig(opts...) return outbound.NewWorkerConfig(opts...)
} }
// Initiator Pool options // Outbound Pool options
var ( var (
WithConnectionConfig = initiatorpool.WithConnectionConfig WithOutboundConnectionConfig = outbound.WithConnectionConfig
WithWorkerConfig = initiatorpool.WithWorkerConfig WithOutboundWorkerConfig = outbound.WithWorkerConfig
WithWorkerFactory = initiatorpool.WithWorkerFactory WithOutboundWorkerFactory = outbound.WithWorkerFactory
) )
// Initiator Worker options // Outbound Worker options
var ( var (
WithKeepaliveTimeout = initiatorpool.WithKeepaliveTimeout WithOutboundKeepaliveTimeout = outbound.WithKeepaliveTimeout
WithMaxQueueSize = initiatorpool.WithMaxQueueSize WithOutboundMaxQueueSize = outbound.WithMaxQueueSize
) )
// Inbound Pool constructors
func NewInboundPool(ctx context.Context, config *InboundPoolConfig, logger *slog.Logger) (*InboundPool, error) {
return inbound.NewPool(ctx, config, logger)
}
func NewInboundPoolConfig(opts ...InboundPoolOption) (*InboundPoolConfig, error) {
return inbound.NewPoolConfig(opts...)
}
func NewInboundWorkerConfig(opts ...InboundWorkerOption) (*InboundWorkerConfig, error) {
return inbound.NewWorkerConfig(opts...)
}
// Inbound Pool options
var (
WithInboundConnectionConfig = inbound.WithConnectionConfig
WithInboundWorkerConfig = inbound.WithWorkerConfig
WithInboundWorkerFactory = inbound.WithWorkerFactory
)
// Inbound Worker options
var (
WithInboundDeadTimeout = inbound.WithDeadTimeout
WithInboundMaxQueueSize = inbound.WithMaxQueueSize
)
// Socket type — needed for inbound pool.Add and pool.Replace
type Socket = types.Socket
+18 -1
View File
@@ -1,7 +1,8 @@
// responderpool/config.go // responderpool/config.go
package responderpool package inbound
import ( import (
"context"
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
"time" "time"
) )
@@ -90,9 +91,17 @@ func WithDeadTimeout(value time.Duration) WorkerOption {
// Pool Config // Pool Config
type WorkerFactory func(
ctx context.Context,
id string,
conn *transport.Connection,
config *WorkerConfig,
) (Worker, error)
type PoolConfig struct { type PoolConfig struct {
ConnectionConfig *transport.ConnectionConfig ConnectionConfig *transport.ConnectionConfig
WorkerConfig *WorkerConfig WorkerConfig *WorkerConfig
WorkerFactory WorkerFactory
} }
type PoolOption func(*PoolConfig) error type PoolOption func(*PoolConfig) error
@@ -112,6 +121,7 @@ func GetDefaultPoolConfig() *PoolConfig {
return &PoolConfig{ return &PoolConfig{
ConnectionConfig: nil, ConnectionConfig: nil,
WorkerConfig: nil, WorkerConfig: nil,
WorkerFactory: nil,
} }
} }
@@ -157,3 +167,10 @@ func WithWorkerConfig(wc *WorkerConfig) PoolOption {
return nil return nil
} }
} }
func WithWorkerFactory(wf WorkerFactory) PoolOption {
return func(c *PoolConfig) error {
c.WorkerFactory = wf
return nil
}
}
@@ -1,5 +1,5 @@
// responderpool/config_test.go // responderpool/config_test.go
package responderpool package inbound
import ( import (
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
@@ -1,9 +1,10 @@
package responderpool package inbound
import "errors" import "errors"
var ( var (
// Pool errors // Pool errors
PoolError = errors.New("pool error")
ErrPoolClosed = errors.New("pool is closed") ErrPoolClosed = errors.New("pool is closed")
ErrPeerNotFound = errors.New("peer not found") ErrPeerNotFound = errors.New("peer not found")
ErrPeerExists = errors.New("peer already exists") ErrPeerExists = errors.New("peer already exists")
@@ -1,7 +1,6 @@
package responderpool package inbound
import ( import (
"fmt"
"git.wisehodl.dev/jay/go-honeybee/honeybeetest" "git.wisehodl.dev/jay/go-honeybee/honeybeetest"
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
@@ -9,9 +8,8 @@ import (
"testing" "testing"
) )
func setupReaderTestConnection(t *testing.T) ( func setupTestSocket(t *testing.T) (
conn *transport.Connection, socket *honeybeetest.MockSocket,
mock *honeybeetest.MockSocket,
incoming chan honeybeetest.MockIncomingData, incoming chan honeybeetest.MockIncomingData,
outgoing chan honeybeetest.MockOutgoingData, outgoing chan honeybeetest.MockOutgoingData,
) { ) {
@@ -19,38 +17,51 @@ func setupReaderTestConnection(t *testing.T) (
incoming = make(chan honeybeetest.MockIncomingData, 10) incoming = make(chan honeybeetest.MockIncomingData, 10)
outgoing = make(chan honeybeetest.MockOutgoingData, 10) outgoing = make(chan honeybeetest.MockOutgoingData, 10)
mock = honeybeetest.NewMockSocket() socket = honeybeetest.NewMockSocket()
mock.CloseFunc = func() error { socket.CloseFunc = func() error {
mock.Once.Do(func() { close(mock.Closed) }) socket.Once.Do(func() { close(socket.Closed) })
return nil return nil
} }
mock.ReadMessageFunc = func() (int, []byte, error) { socket.ReadMessageFunc = func() (int, []byte, error) {
select { select {
case data, ok := <-incoming: case data, ok := <-incoming:
if !ok { if !ok {
return 0, nil, io.EOF return 0, nil, io.EOF
} }
return data.MsgType, data.Data, data.Err return data.MsgType, data.Data, data.Err
case <-mock.Closed: case <-socket.Closed:
return 0, nil, io.EOF return 0, nil, io.EOF
} }
} }
mock.WriteMessageFunc = func(msgType int, data []byte) error { socket.WriteMessageFunc = func(msgType int, data []byte) error {
select { select {
case outgoing <- honeybeetest.MockOutgoingData{MsgType: msgType, Data: data}: case outgoing <- honeybeetest.MockOutgoingData{MsgType: msgType, Data: data}:
return nil return nil
case <-mock.Closed: case <-socket.Closed:
return io.EOF return io.EOF
default: default:
return fmt.Errorf("mock outgoing channel unavailable") return io.EOF
} }
} }
return
}
func setupTestConnection(t *testing.T) (
conn *transport.Connection,
socket *honeybeetest.MockSocket,
incoming chan honeybeetest.MockIncomingData,
outgoing chan honeybeetest.MockOutgoingData,
) {
t.Helper()
socket, incoming, outgoing = setupTestSocket(t)
var err error var err error
conn, err = transport.NewConnectionFromSocket(mock, nil, nil) conn, err = transport.NewConnectionFromSocket(socket, nil, nil)
assert.NoError(t, err) assert.NoError(t, err)
return return
} }
+297
View File
@@ -0,0 +1,297 @@
package inbound
import (
"context"
"fmt"
"git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
"log/slog"
"sync"
"time"
)
// Types
type PoolEventKind string
const (
EventPeerDisconnected PoolEventKind = "disconnected"
EventPeerDropped PoolEventKind = "dropped"
EventPeerEvicted PoolEventKind = "evicted"
)
var workerToPoolEvent = map[WorkerExitKind]PoolEventKind{
ExitCleanDisconnect: EventPeerDisconnected,
ExitUnexpectedDrop: EventPeerDropped,
ExitInactive: EventPeerEvicted,
}
type OnExitFunction func(kind WorkerExitKind)
type PoolEvent struct {
ID string
Kind PoolEventKind
}
type InboxMessage struct {
ID string
Data []byte
ReceivedAt time.Time
}
type PoolPlugin struct {
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Logger *slog.Logger
OnExit OnExitFunction
}
// Pool
type Peer struct {
id string
conn *transport.Connection
worker Worker
done chan struct{}
}
type Pool struct {
ctx context.Context
cancel context.CancelFunc
peers map[string]*Peer
inbox chan InboxMessage
events chan PoolEvent
config *PoolConfig
logger *slog.Logger
mu sync.RWMutex
wg sync.WaitGroup
closed bool
}
func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger) (*Pool, error) {
if config == nil {
config = GetDefaultPoolConfig()
}
// If a custom factory is supplied, config.WorkerConfig is not used.
// The factory function should be non-blocking or else Connect() may cause
// deadlocks.
if config.WorkerFactory == nil {
config.WorkerFactory = func(
ctx context.Context,
id string,
conn *transport.Connection,
config *WorkerConfig,
) (Worker, error) {
return NewWorker(ctx, id, conn, config)
}
}
if err := ValidatePoolConfig(config); err != nil {
return nil, err
}
pctx, cancel := context.WithCancel(ctx)
return &Pool{
ctx: pctx,
cancel: cancel,
peers: make(map[string]*Peer),
inbox: make(chan InboxMessage, 256),
events: make(chan PoolEvent, 10),
config: config,
logger: logger,
}, nil
}
func (p *Pool) Peers() []string {
p.mu.RLock()
defer p.mu.RUnlock()
ids := make([]string, 0, len(p.peers))
for id := range p.peers {
ids = append(ids, id)
}
return ids
}
func (p *Pool) Inbox() <-chan InboxMessage {
return p.inbox
}
func (p *Pool) Events() <-chan PoolEvent {
return p.events
}
func (p *Pool) Close() {
p.mu.Lock()
if p.closed {
p.mu.Unlock()
return
}
p.closed = true
p.cancel()
// remove all peers
p.peers = make(map[string]*Peer)
// close all connections
for _, peer := range p.peers {
peer.worker.Stop()
peer.conn.Close()
}
p.mu.Unlock()
go func() {
p.wg.Wait()
close(p.inbox)
close(p.events)
}()
}
func (p *Pool) Add(id string, socket types.Socket) error {
p.mu.Lock()
defer p.mu.Unlock()
if p.closed {
return ErrPoolClosed
}
if _, exists := p.peers[id]; exists {
return ErrPeerExists
}
return p.addLocked(id, socket)
}
func (p *Pool) Replace(id string, socket types.Socket) error {
p.mu.Lock()
defer p.mu.Unlock()
if p.closed {
return ErrPoolClosed
}
if peer, exists := p.peers[id]; exists {
p.removeLocked(peer)
} else {
return ErrPeerNotFound
}
return p.addLocked(id, socket)
}
func (p *Pool) Remove(id string) error {
p.mu.Lock()
defer p.mu.Unlock()
if p.closed {
return ErrPoolClosed
}
peer, exists := p.peers[id]
if !exists {
return ErrPeerNotFound
}
p.removeLocked(peer)
return nil
}
func (p *Pool) Send(id string, data []byte) error {
p.mu.RLock()
defer p.mu.RUnlock()
if p.closed {
return ErrPoolClosed
}
peer, exists := p.peers[id]
if !exists {
return ErrPeerNotFound
}
return peer.worker.Send(data)
}
// addLocked constructs and registers a peer. Caller must hold p.mu write lock.
func (p *Pool) addLocked(id string, socket types.Socket) error {
conn, err := transport.NewConnectionFromSocket(
socket, p.config.ConnectionConfig, p.logger)
if err != nil {
return err
}
// The worker factory must be non-blocking to avoid deadlocks
wctx, cancel := context.WithCancel(p.ctx)
worker, err := p.config.WorkerFactory(wctx, id, conn, p.config.WorkerConfig)
if err != nil {
cancel()
conn.Close()
return fmt.Errorf("%w: %w", PoolError, err)
}
var once sync.Once
onExit := func(kind WorkerExitKind) {
once.Do(func() {
p.mu.Lock()
delete(p.peers, id)
p.mu.Unlock()
conn.Close()
select {
case p.events <- PoolEvent{ID: id, Kind: workerToPoolEvent[kind]}:
case <-p.ctx.Done():
return
}
})
}
var logger *slog.Logger
if p.logger != nil {
logger = p.logger.With("id", id)
}
pool := PoolPlugin{
Inbox: p.inbox,
Events: p.events,
Logger: logger,
OnExit: onExit,
}
peer := &Peer{
id: id,
conn: conn,
worker: worker,
done: make(chan struct{}),
}
p.wg.Add(1)
go func() {
defer cancel()
defer close(peer.done)
worker.Start(pool, &p.wg)
}()
p.peers[id] = peer
return nil
}
// removeLocked closes and unregisters a peer. Caller must hold p.mu write lock.
func (p *Pool) removeLocked(peer *Peer) {
delete(p.peers, peer.id)
peer.worker.Stop()
go func() {
<-peer.done
peer.conn.Close()
}()
}
+395
View File
@@ -0,0 +1,395 @@
package inbound
import (
"context"
"fmt"
"git.wisehodl.dev/jay/go-honeybee/honeybeetest"
"github.com/gorilla/websocket"
"github.com/stretchr/testify/assert"
"slices"
"testing"
"time"
)
// Helpers
func setupPool(t *testing.T) *Pool {
t.Helper()
pool, err := NewPool(context.Background(), nil, nil)
assert.NoError(t, err)
return pool
}
func expectEvent(
t *testing.T,
events <-chan PoolEvent,
expectedURL string,
expectedKind PoolEventKind,
) {
t.Helper()
honeybeetest.Eventually(t, func() bool {
select {
case e := <-events:
return e.ID == expectedURL && e.Kind == expectedKind
default:
return false
}
}, fmt.Sprintf("expected event: URL=%q, Kind=%q", expectedURL, expectedKind))
}
// Tests
func TestPoolAdd(t *testing.T) {
t.Run("successfully adds peer", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.NoError(t, err)
})
t.Run("peer appears in Peers after add", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.NoError(t, err)
assert.Contains(t, pool.Peers(), "peer-1")
})
t.Run("duplicate id returns ErrPeerExists", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket1, _, _ := setupTestSocket(t)
socket2, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket1)
assert.NoError(t, err)
err = pool.Add("peer-1", socket2)
assert.ErrorIs(t, err, ErrPeerExists)
})
t.Run("closed pool returns ErrPoolClosed", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.ErrorIs(t, err, ErrPoolClosed)
})
}
func TestPoolReplace(t *testing.T) {
t.Run("replaces existing peer", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket1, _, _ := setupTestSocket(t)
socket2, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket1)
assert.NoError(t, err)
err = pool.Replace("peer-1", socket2)
assert.NoError(t, err)
assert.Contains(t, pool.Peers(), "peer-1")
})
t.Run("unknown id returns ErrPeerNotFound", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Replace("unknown", socket)
assert.ErrorIs(t, err, ErrPeerNotFound)
})
t.Run("closed pool returns ErrPoolClosed", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Replace("peer-1", socket)
assert.ErrorIs(t, err, ErrPoolClosed)
})
t.Run("no event emitted for replaced peer", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket1, _, _ := setupTestSocket(t)
socket2, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket1)
assert.NoError(t, err)
err = pool.Replace("peer-1", socket2)
assert.NoError(t, err)
honeybeetest.Never(t, func() bool {
select {
case <-pool.Events():
return true
default:
return false
}
}, "no event expected on replace")
})
}
func TestPoolRemove(t *testing.T) {
t.Run("removes known peer", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.NoError(t, err)
err = pool.Remove("peer-1")
assert.NoError(t, err)
assert.NotContains(t, pool.Peers(), "peer-1")
})
t.Run("unknown id returns ErrPeerNotFound", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
err := pool.Remove("unknown")
assert.ErrorIs(t, err, ErrPeerNotFound)
})
t.Run("closed pool returns ErrPoolClosed", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
err := pool.Remove("peer-1")
assert.ErrorIs(t, err, ErrPoolClosed)
})
t.Run("no event emitted on remove", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.NoError(t, err)
err = pool.Remove("peer-1")
assert.NoError(t, err)
honeybeetest.Never(t, func() bool {
select {
case e := <-pool.Events():
fmt.Printf("got event: %v", e)
return true
default:
return false
}
}, "no event expected on remove")
})
}
func TestPoolSend(t *testing.T) {
t.Run("data reaches socket", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, outgoing := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.NoError(t, err)
err = pool.Send("peer-1", []byte("hello"))
assert.NoError(t, err)
honeybeetest.ExpectWrite(t, outgoing, websocket.TextMessage, []byte("hello"))
})
t.Run("unknown id returns ErrPeerNotFound", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
err := pool.Send("unknown", []byte("hello"))
assert.ErrorIs(t, err, ErrPeerNotFound)
})
t.Run("closed pool returns ErrPoolClosed", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
err := pool.Send("peer-1", []byte("hello"))
assert.ErrorIs(t, err, ErrPoolClosed)
})
}
func TestPoolClose(t *testing.T) {
t.Run("inbox and events channels close after pool close", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
_, ok := <-pool.Inbox()
assert.False(t, ok)
_, ok = <-pool.Events()
assert.False(t, ok)
})
t.Run("add after close returns ErrPoolClosed", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
socket, _, _ := setupTestSocket(t)
err := pool.Add("peer-1", socket)
assert.ErrorIs(t, err, ErrPoolClosed)
})
t.Run("close is idempotent", func(t *testing.T) {
pool := setupPool(t)
pool.Close()
pool.Close()
})
}
func TestPoolPeers(t *testing.T) {
t.Run("reflects active peers after add", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket1, _, _ := setupTestSocket(t)
socket2, _, _ := setupTestSocket(t)
pool.Add("peer-1", socket1)
pool.Add("peer-2", socket2)
peers := pool.Peers()
assert.Contains(t, peers, "peer-1")
assert.Contains(t, peers, "peer-2")
})
t.Run("loses entry after remove", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
pool.Remove("peer-1")
assert.NotContains(t, pool.Peers(), "peer-1")
})
t.Run("loses entry after peer self-disconnects", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, incoming, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
close(incoming)
honeybeetest.Eventually(t, func() bool {
return !slices.Contains(pool.Peers(), "peer-1")
}, "expected peer to be removed after self-disconnect")
})
}
func TestPoolEvents(t *testing.T) {
t.Run("EventPeerDisconnected emitted on clean close", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, incoming, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
incoming <- honeybeetest.MockIncomingData{
Err: &websocket.CloseError{Code: websocket.CloseNormalClosure},
}
expectEvent(t, pool.Events(), "peer-1", EventPeerDisconnected)
honeybeetest.Eventually(t, func() bool {
return !slices.Contains(pool.Peers(), "peer-1")
}, "expected peer auto-removed")
})
t.Run("EventPeerDropped emitted on unexpected close", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, incoming, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
incoming <- honeybeetest.MockIncomingData{
Err: &websocket.CloseError{Code: websocket.CloseProtocolError},
}
expectEvent(t, pool.Events(), "peer-1", EventPeerDropped)
honeybeetest.Eventually(t, func() bool {
return !slices.Contains(pool.Peers(), "peer-1")
}, "expected peer auto-removed")
})
t.Run("EventPeerEvicted emitted on watchdog timeout", func(t *testing.T) {
config, err := NewPoolConfig(
WithWorkerConfig(&WorkerConfig{DeadTimeout: 20 * time.Millisecond}),
)
assert.NoError(t, err)
pool, err := NewPool(context.Background(), config, nil)
assert.NoError(t, err)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
expectEvent(t, pool.Events(), "peer-1", EventPeerEvicted)
honeybeetest.Eventually(t, func() bool {
return !slices.Contains(pool.Peers(), "peer-1")
}, "expected peer auto-removed")
})
t.Run("no event emitted on Remove", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket, _, _ := setupTestSocket(t)
pool.Add("peer-1", socket)
pool.Remove("peer-1")
honeybeetest.Never(t, func() bool {
select {
case <-pool.Events():
return true
default:
return false
}
}, "no event expected on Remove")
})
t.Run("no event emitted on Replace of old peer", func(t *testing.T) {
pool := setupPool(t)
defer pool.Close()
socket1, _, _ := setupTestSocket(t)
socket2, _, _ := setupTestSocket(t)
pool.Add("peer-1", socket1)
pool.Replace("peer-1", socket2)
honeybeetest.Never(t, func() bool {
select {
case <-pool.Events():
return true
default:
return false
}
}, "no event expected on Replace")
})
}
+100 -8
View File
@@ -1,23 +1,111 @@
package responderpool package inbound
import ( import (
"container/list" "container/list"
"context" "context"
"errors" "errors"
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
"sync"
"time" "time"
) )
type onEventFunc func(kind PoolEventKind) type Worker interface {
Start(pool PoolPlugin, wg *sync.WaitGroup)
Stop()
Send(data []byte) error
}
type WorkerExitKind string
const (
ExitCleanDisconnect WorkerExitKind = "disconnected"
ExitUnexpectedDrop WorkerExitKind = "dropped"
ExitInactive WorkerExitKind = "inactive"
)
type ReceivedMessage struct { type ReceivedMessage struct {
data []byte data []byte
receivedAt time.Time receivedAt time.Time
} }
type DefaultWorker struct {
id string
conn *transport.Connection
heartbeat chan struct{}
config *WorkerConfig
ctx context.Context
cancel context.CancelFunc
}
func NewWorker(
ctx context.Context,
id string,
conn *transport.Connection,
config *WorkerConfig,
) (*DefaultWorker, error) {
if config == nil {
config = GetDefaultWorkerConfig()
}
if err := ValidateWorkerConfig(config); err != nil {
return nil, err
}
wctx, cancel := context.WithCancel(ctx)
return &DefaultWorker{
id: id,
conn: conn,
heartbeat: make(chan struct{}),
config: config,
ctx: wctx,
cancel: cancel,
}, nil
}
func (w *DefaultWorker) Start(pool PoolPlugin, wg *sync.WaitGroup) {
messages := make(chan ReceivedMessage, 256)
var owg sync.WaitGroup
owg.Add(3)
go func() {
defer owg.Done()
RunReader(w.ctx, pool.OnExit, w.conn, messages, w.heartbeat)
}()
go func() {
defer owg.Done()
RunForwarder(w.id, w.ctx, messages, pool.Inbox, w.config.MaxQueueSize)
}()
go func() {
defer owg.Done()
RunWatchdog(w.ctx, pool.OnExit, w.heartbeat, w.config.DeadTimeout)
}()
owg.Wait()
wg.Done()
}
func (w *DefaultWorker) Stop() {
w.cancel()
}
func (w *DefaultWorker) Send(data []byte) error {
if err := w.conn.Send(data); err != nil {
return err
}
select {
case w.heartbeat <- struct{}{}:
case <-w.ctx.Done():
}
return nil
}
func RunReader( func RunReader(
ctx context.Context, ctx context.Context,
onPeerClose onEventFunc, onPeerClose OnExitFunction,
conn *transport.Connection, conn *transport.Connection,
messages chan<- ReceivedMessage, messages chan<- ReceivedMessage,
@@ -31,14 +119,14 @@ func RunReader(
if !ok { if !ok {
// determine exit kind // determine exit kind
// by default, the peer dropped unexpectedly // by default, the peer dropped unexpectedly
kind := EventPeerDropped kind := ExitUnexpectedDrop
select { select {
// the peer-side error is sent before the connection is closed, // the peer-side error is sent before the connection is closed,
// so a non-blocking call here is correct // so a non-blocking call here is correct
// if an error is not sent, then assume the default event kind // if an error is not sent, then assume the default event kind
case err := <-conn.Errors(): case err := <-conn.Errors():
if errors.Is(err, transport.ErrPeerClosedClean) { if errors.Is(err, transport.ErrPeerClosedClean) {
kind = EventPeerDisconnected kind = ExitCleanDisconnect
} }
default: default:
} }
@@ -104,18 +192,22 @@ func RunForwarder(
func RunWatchdog( func RunWatchdog(
ctx context.Context, ctx context.Context,
onInactive func(), onInactive OnExitFunction,
heartbeat <-chan struct{}, heartbeat <-chan struct{},
timeout time.Duration, timeout time.Duration,
) { ) {
// disable watchdog timeout if not configured // disable watchdog timeout if not configured
if timeout <= 0 { if timeout <= 0 {
// drain heartbeats
// wait for cancel and exit // wait for cancel and exit
for {
select { select {
case <-heartbeat:
case <-ctx.Done(): case <-ctx.Done():
}
return return
} }
}
}
timer := time.NewTimer(timeout) timer := time.NewTimer(timeout)
defer timer.Stop() defer timer.Stop()
@@ -136,7 +228,7 @@ func RunWatchdog(
// timer completed // timer completed
case <-timer.C: case <-timer.C:
// signal peer is inactive // signal peer is inactive
onInactive() onInactive(ExitInactive)
return return
} }
} }
@@ -1,4 +1,4 @@
package initiatorpool package inbound
import ( import (
"context" "context"
@@ -1,8 +1,9 @@
package responderpool package inbound
import ( import (
"context" "context"
"git.wisehodl.dev/jay/go-honeybee/honeybeetest" "git.wisehodl.dev/jay/go-honeybee/honeybeetest"
"git.wisehodl.dev/jay/go-honeybee/transport"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"io" "io"
@@ -13,7 +14,7 @@ import (
func TestRunReader(t *testing.T) { func TestRunReader(t *testing.T) {
t.Run("message forwarded with correct data and non-zero receivedAt", func(t *testing.T) { t.Run("message forwarded with correct data and non-zero receivedAt", func(t *testing.T) {
conn, _, incoming, _ := setupReaderTestConnection(t) conn, _, incoming, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
@@ -21,7 +22,7 @@ func TestRunReader(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
go RunReader(ctx, func(PoolEventKind) {}, conn, messages, heartbeat) go RunReader(ctx, func(WorkerExitKind) {}, conn, messages, heartbeat)
before := time.Now() before := time.Now()
incoming <- honeybeetest.MockIncomingData{MsgType: websocket.TextMessage, Data: []byte("hello")} incoming <- honeybeetest.MockIncomingData{MsgType: websocket.TextMessage, Data: []byte("hello")}
@@ -37,7 +38,7 @@ func TestRunReader(t *testing.T) {
}) })
t.Run("heartbeat sent per forwarded message", func(t *testing.T) { t.Run("heartbeat sent per forwarded message", func(t *testing.T) {
conn, _, incoming, _ := setupReaderTestConnection(t) conn, _, incoming, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
messages := make(chan ReceivedMessage, 10) messages := make(chan ReceivedMessage, 10)
@@ -55,7 +56,7 @@ func TestRunReader(t *testing.T) {
for range messages { for range messages {
} }
}() }()
go RunReader(ctx, func(PoolEventKind) {}, conn, messages, heartbeat) go RunReader(ctx, func(WorkerExitKind) {}, conn, messages, heartbeat)
const n = 3 const n = 3
for i := 0; i < n; i++ { for i := 0; i < n; i++ {
@@ -67,20 +68,27 @@ func TestRunReader(t *testing.T) {
}, "expected heartbeats") }, "expected heartbeats")
}) })
t.Run("clean close calls onPeerClose with EventPeerDisconnected", func(t *testing.T) { t.Run("clean close calls onPeerClose with ExitCleanDisconnect", func(t *testing.T) {
conn, mock, _, _ := setupReaderTestConnection(t) mock := honeybeetest.NewMockSocket()
mock.CloseFunc = func() error {
mock.Once.Do(func() { close(mock.Closed) })
return nil
}
mock.ReadMessageFunc = func() (int, []byte, error) { mock.ReadMessageFunc = func() (int, []byte, error) {
return 0, nil, &websocket.CloseError{Code: websocket.CloseNormalClosure} return 0, nil, &websocket.CloseError{Code: websocket.CloseNormalClosure}
} }
conn, err := transport.NewConnectionFromSocket(mock, nil, nil)
assert.NoError(t, err)
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
heartbeat := make(chan struct{}, 1) heartbeat := make(chan struct{}, 1)
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
var gotKind PoolEventKind var gotKind WorkerExitKind
done := make(chan struct{}) done := make(chan struct{})
go RunReader(ctx, func(kind PoolEventKind) { go RunReader(ctx, func(kind WorkerExitKind) {
gotKind = kind gotKind = kind
close(done) close(done)
}, conn, messages, heartbeat) }, conn, messages, heartbeat)
@@ -94,23 +102,30 @@ func TestRunReader(t *testing.T) {
} }
}, "expected onPeerClose") }, "expected onPeerClose")
assert.Equal(t, EventPeerDisconnected, gotKind) assert.Equal(t, ExitCleanDisconnect, gotKind)
}) })
t.Run("unexpected close calls onPeerClose with EventPeerDropped", func(t *testing.T) { t.Run("unexpected close calls onPeerClose with ExitUnexpectedDrop", func(t *testing.T) {
conn, mock, _, _ := setupReaderTestConnection(t) mock := honeybeetest.NewMockSocket()
mock.CloseFunc = func() error {
mock.Once.Do(func() { close(mock.Closed) })
return nil
}
mock.ReadMessageFunc = func() (int, []byte, error) { mock.ReadMessageFunc = func() (int, []byte, error) {
return 0, nil, &websocket.CloseError{Code: websocket.CloseProtocolError} return 0, nil, &websocket.CloseError{Code: websocket.CloseProtocolError}
} }
conn, err := transport.NewConnectionFromSocket(mock, nil, nil)
assert.NoError(t, err)
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
heartbeat := make(chan struct{}, 1) heartbeat := make(chan struct{}, 1)
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
var gotKind PoolEventKind var gotKind WorkerExitKind
done := make(chan struct{}) done := make(chan struct{})
go RunReader(ctx, func(kind PoolEventKind) { go RunReader(ctx, func(kind WorkerExitKind) {
gotKind = kind gotKind = kind
close(done) close(done)
}, conn, messages, heartbeat) }, conn, messages, heartbeat)
@@ -124,23 +139,30 @@ func TestRunReader(t *testing.T) {
} }
}, "expected onPeerClose") }, "expected onPeerClose")
assert.Equal(t, EventPeerDropped, gotKind) assert.Equal(t, ExitUnexpectedDrop, gotKind)
}) })
t.Run("read error calls onPeerClose with EventPeerDropped", func(t *testing.T) { t.Run("read error calls onPeerClose with ExitUnexpectedDrop", func(t *testing.T) {
conn, mock, _, _ := setupReaderTestConnection(t) mock := honeybeetest.NewMockSocket()
mock.CloseFunc = func() error {
mock.Once.Do(func() { close(mock.Closed) })
return nil
}
mock.ReadMessageFunc = func() (int, []byte, error) { mock.ReadMessageFunc = func() (int, []byte, error) {
return 0, nil, io.EOF return 0, nil, io.EOF
} }
conn, err := transport.NewConnectionFromSocket(mock, nil, nil)
assert.NoError(t, err)
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
heartbeat := make(chan struct{}, 1) heartbeat := make(chan struct{}, 1)
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
var gotKind PoolEventKind var gotKind WorkerExitKind
done := make(chan struct{}) done := make(chan struct{})
go RunReader(ctx, func(kind PoolEventKind) { go RunReader(ctx, func(kind WorkerExitKind) {
gotKind = kind gotKind = kind
close(done) close(done)
}, conn, messages, heartbeat) }, conn, messages, heartbeat)
@@ -154,11 +176,11 @@ func TestRunReader(t *testing.T) {
} }
}, "expected onPeerClose") }, "expected onPeerClose")
assert.Equal(t, EventPeerDropped, gotKind) assert.Equal(t, ExitUnexpectedDrop, gotKind)
}) })
t.Run("ctx.Done exits without calling onPeerClose", func(t *testing.T) { t.Run("ctx.Done exits without calling onPeerClose", func(t *testing.T) {
conn, _, _, _ := setupReaderTestConnection(t) conn, _, _, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
@@ -168,7 +190,7 @@ func TestRunReader(t *testing.T) {
called := atomic.Bool{} called := atomic.Bool{}
done := make(chan struct{}) done := make(chan struct{})
go func() { go func() {
RunReader(ctx, func(PoolEventKind) { RunReader(ctx, func(WorkerExitKind) {
called.Store(true) called.Store(true)
}, conn, messages, heartbeat) }, conn, messages, heartbeat)
close(done) close(done)
+228
View File
@@ -0,0 +1,228 @@
package inbound
import (
"context"
"fmt"
"git.wisehodl.dev/jay/go-honeybee/honeybeetest"
"git.wisehodl.dev/jay/go-honeybee/transport"
"github.com/gorilla/websocket"
"github.com/stretchr/testify/assert"
"sync"
"sync/atomic"
"testing"
"time"
)
type workerTestVars struct {
worker *DefaultWorker
conn *transport.Connection
incoming chan honeybeetest.MockIncomingData
outgoing chan honeybeetest.MockOutgoingData
pool PoolPlugin
inbox chan InboxMessage
events chan PoolEvent
exitKind *atomic.Value
wg *sync.WaitGroup
}
func setupWorkerTest(t *testing.T) workerTestVars {
t.Helper()
conn, _, incoming, outgoing := setupTestConnection(t)
ctx, cancel := context.WithCancel(context.Background())
var err error
worker, err := NewWorker(ctx, "peer-1", conn, nil)
assert.NoError(t, err)
worker.cancel = cancel
inbox := make(chan InboxMessage, 256)
events := make(chan PoolEvent, 10)
exitKind := &atomic.Value{}
var once sync.Once
pool := PoolPlugin{
Inbox: inbox,
Events: events,
OnExit: func(kind WorkerExitKind) {
once.Do(func() { exitKind.Store(kind) })
},
}
wg := &sync.WaitGroup{}
wg.Add(1)
return workerTestVars{
worker: worker,
conn: conn,
incoming: incoming,
outgoing: outgoing,
pool: pool,
inbox: inbox,
events: events,
exitKind: exitKind,
wg: wg,
}
}
func TestWorkerStart(t *testing.T) {
t.Run("socket data arrives on inbox", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
go v.worker.Start(v.pool, v.wg)
v.incoming <- honeybeetest.MockIncomingData{
MsgType: websocket.TextMessage,
Data: []byte("hello"),
}
honeybeetest.Eventually(t, func() bool {
select {
case msg := <-v.inbox:
return msg.ID == "peer-1" && string(msg.Data) == "hello"
default:
return false
}
}, "expected message on inbox")
})
t.Run("clean peer close calls OnExit with ExitCleanDisconnect", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
go v.worker.Start(v.pool, v.wg)
v.incoming <- honeybeetest.MockIncomingData{
Err: &websocket.CloseError{Code: websocket.CloseNormalClosure},
}
honeybeetest.Eventually(t, func() bool {
val := v.exitKind.Load()
return val != nil && val.(WorkerExitKind) == ExitCleanDisconnect
}, "expected ExitCleanDisconnect")
})
t.Run("unexpected peer close calls OnExit with ExitUnexpectedDrop", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
go v.worker.Start(v.pool, v.wg)
v.incoming <- honeybeetest.MockIncomingData{
Err: &websocket.CloseError{Code: websocket.CloseProtocolError},
}
honeybeetest.Eventually(t, func() bool {
val := v.exitKind.Load()
return val != nil && val.(WorkerExitKind) == ExitUnexpectedDrop
}, "expected ExitUnexpectedDrop")
})
t.Run("watchdog timeout calls OnExit with ExitInactive", func(t *testing.T) {
conn, _, _, _ := setupTestConnection(t)
ctx, cancel := context.WithCancel(context.Background())
worker, err := NewWorker(ctx, "peer-1", conn, &WorkerConfig{
DeadTimeout: 20 * time.Millisecond,
})
assert.NoError(t, err)
worker.cancel = cancel
defer worker.Stop()
exitKind := &atomic.Value{}
var once sync.Once
pool := PoolPlugin{
Inbox: make(chan InboxMessage, 256),
Events: make(chan PoolEvent, 10),
OnExit: func(kind WorkerExitKind) {
once.Do(func() { exitKind.Store(kind) })
},
}
var wg sync.WaitGroup
wg.Add(1)
go worker.Start(pool, &wg)
honeybeetest.Eventually(t, func() bool {
val := exitKind.Load()
return val != nil && val.(WorkerExitKind) == ExitInactive
}, "expected ExitInactive")
})
}
func TestWorkerStop(t *testing.T) {
v := setupWorkerTest(t)
go v.worker.Start(v.pool, v.wg)
v.worker.Stop()
done := make(chan struct{})
go func() { v.wg.Wait(); close(done) }()
honeybeetest.Eventually(t, func() bool {
select {
case <-done:
return true
default:
return false
}
}, "expected wg to drain")
// does not call onExit
assert.Nil(t, v.exitKind.Load())
}
func TestWorkerSend(t *testing.T) {
t.Run("Send delivers data to socket", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
go v.worker.Start(v.pool, v.wg)
err := v.worker.Send([]byte("hello"))
assert.NoError(t, err)
honeybeetest.ExpectWrite(t, v.outgoing, websocket.TextMessage, []byte("hello"))
})
t.Run("Send produces heartbeats", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
count := atomic.Int32{}
go func() {
for range v.worker.heartbeat {
count.Add(1)
}
}()
// do not start the worker, allow heartbeats to be drained manually
for i := 0; i < 3; i++ {
err := v.worker.Send([]byte(fmt.Sprintf("msg-%d", i)))
assert.NoError(t, err)
}
honeybeetest.Eventually(t, func() bool {
return count.Load() == 3
}, "expected heartbeats")
})
t.Run("Send returns error after connection closed", func(t *testing.T) {
v := setupWorkerTest(t)
defer v.worker.Stop()
go v.worker.Start(v.pool, v.wg)
v.conn.Close()
honeybeetest.Eventually(t, func() bool {
return v.conn.State() == transport.StateClosed
}, "expected connection closed")
err := v.worker.Send([]byte("hello"))
assert.Error(t, err)
})
}
@@ -1,4 +1,4 @@
package responderpool package inbound
import ( import (
"context" "context"
@@ -16,7 +16,7 @@ func TestRunWatchdog(t *testing.T) {
defer cancel() defer cancel()
called := atomic.Bool{} called := atomic.Bool{}
go RunWatchdog(ctx, func() { called.Store(true) }, heartbeat, 200*time.Millisecond) go RunWatchdog(ctx, func(WorkerExitKind) { called.Store(true) }, heartbeat, 200*time.Millisecond)
for i := 0; i < 5; i++ { for i := 0; i < 5; i++ {
time.Sleep(20 * time.Millisecond) time.Sleep(20 * time.Millisecond)
@@ -33,10 +33,12 @@ func TestRunWatchdog(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
var gotKind WorkerExitKind
count := atomic.Int32{} count := atomic.Int32{}
done := make(chan struct{}) done := make(chan struct{})
go RunWatchdog(ctx, func() { go RunWatchdog(ctx, func(kind WorkerExitKind) {
count.Add(1) count.Add(1)
gotKind = kind
close(done) close(done)
}, heartbeat, 20*time.Millisecond) }, heartbeat, 20*time.Millisecond)
@@ -50,6 +52,7 @@ func TestRunWatchdog(t *testing.T) {
}, "expected onInactive") }, "expected onInactive")
assert.Equal(t, int32(1), count.Load()) assert.Equal(t, int32(1), count.Load())
assert.Equal(t, ExitInactive, gotKind)
}) })
t.Run("ctx.Done exits without calling onInactive", func(t *testing.T) { t.Run("ctx.Done exits without calling onInactive", func(t *testing.T) {
@@ -59,7 +62,7 @@ func TestRunWatchdog(t *testing.T) {
called := atomic.Bool{} called := atomic.Bool{}
done := make(chan struct{}) done := make(chan struct{})
go func() { go func() {
RunWatchdog(ctx, func() { called.Store(true) }, heartbeat, 20*time.Second) RunWatchdog(ctx, func(WorkerExitKind) { called.Store(true) }, heartbeat, 20*time.Second)
close(done) close(done)
}() }()
@@ -77,14 +80,14 @@ func TestRunWatchdog(t *testing.T) {
assert.False(t, called.Load()) assert.False(t, called.Load())
}) })
t.Run("zero timeout exits on ctx.Done without firing", func(t *testing.T) { t.Run("zero timeout exits on ctx.Done without firing onInactive", func(t *testing.T) {
heartbeat := make(chan struct{}) heartbeat := make(chan struct{})
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
called := atomic.Bool{} called := atomic.Bool{}
done := make(chan struct{}) done := make(chan struct{})
go func() { go func() {
RunWatchdog(ctx, func() { called.Store(true) }, heartbeat, 0) RunWatchdog(ctx, func(WorkerExitKind) { called.Store(true) }, heartbeat, 0)
close(done) close(done)
}() }()
@@ -101,4 +104,32 @@ func TestRunWatchdog(t *testing.T) {
assert.False(t, called.Load()) assert.False(t, called.Load())
}) })
t.Run("disabled keepalive drains heartbeats without blocking", func(t *testing.T) {
heartbeat := make(chan struct{})
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
done := make(chan struct{})
go func() {
RunWatchdog(ctx, func(WorkerExitKind) {}, heartbeat, 0)
close(done)
}()
// these must not block
for i := 0; i < 5; i++ {
heartbeat <- struct{}{}
}
cancel()
honeybeetest.Eventually(t, func() bool {
select {
case <-done:
return true
default:
return false
}
}, "expected RunWatchdog to exit")
})
} }
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"git.wisehodl.dev/jay/go-honeybee/transport" "git.wisehodl.dev/jay/go-honeybee/transport"
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import "errors" import "errors"
import "fmt" import "fmt"
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"fmt" "fmt"
@@ -9,7 +9,7 @@ import (
"testing" "testing"
) )
func setupWorkerTestConnection(t *testing.T) ( func setupTestConnection(t *testing.T) (
conn *transport.Connection, conn *transport.Connection,
mockSocket *honeybeetest.MockSocket, mockSocket *honeybeetest.MockSocket,
incomingData chan honeybeetest.MockIncomingData, incomingData chan honeybeetest.MockIncomingData,
+32 -35
View File
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -11,26 +11,6 @@ import (
// Types // Types
type Peer struct {
id string
worker Worker
}
type PoolPlugin struct {
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Errors chan<- error
Logger *slog.Logger
Dialer types.Dialer
ConnectionConfig *transport.ConnectionConfig
}
type InboxMessage struct {
ID string
Data []byte
ReceivedAt time.Time
}
type PoolEventKind string type PoolEventKind string
const ( const (
@@ -43,8 +23,28 @@ type PoolEvent struct {
Kind PoolEventKind Kind PoolEventKind
} }
type InboxMessage struct {
ID string
Data []byte
ReceivedAt time.Time
}
type PoolPlugin struct {
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Errors chan<- error
Logger *slog.Logger
Dialer types.Dialer
ConnectionConfig *transport.ConnectionConfig
}
// Pool // Pool
type Peer struct {
id string
worker Worker
}
type Pool struct { type Pool struct {
ctx context.Context ctx context.Context
cancel context.CancelFunc cancel context.CancelFunc
@@ -85,7 +85,7 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger,
pctx, cancel := context.WithCancel(ctx) pctx, cancel := context.WithCancel(ctx)
p := &Pool{ return &Pool{
ctx: pctx, ctx: pctx,
cancel: cancel, cancel: cancel,
peers: make(map[string]*Peer), peers: make(map[string]*Peer),
@@ -95,9 +95,7 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger,
dialer: transport.NewDialer(), dialer: transport.NewDialer(),
config: config, config: config,
logger: logger, logger: logger,
} }, nil
return p, nil
} }
func (p *Pool) Peers() []string { func (p *Pool) Peers() []string {
@@ -111,15 +109,15 @@ func (p *Pool) Peers() []string {
return ids return ids
} }
func (p *Pool) Inbox() chan InboxMessage { func (p *Pool) Inbox() <-chan InboxMessage {
return p.inbox return p.inbox
} }
func (p *Pool) Events() chan PoolEvent { func (p *Pool) Events() <-chan PoolEvent {
return p.events return p.events
} }
func (p *Pool) Errors() chan error { func (p *Pool) Errors() <-chan error {
return p.errors return p.errors
} }
@@ -165,9 +163,8 @@ func (p *Pool) Connect(id string) error {
if p.closed { if p.closed {
return NewPoolError(ErrPoolClosed) return NewPoolError(ErrPoolClosed)
} }
_, exists := p.peers[id]
if exists { if _, exists := p.peers[id]; exists {
return NewPoolError(ErrPeerExists) return NewPoolError(ErrPeerExists)
} }
@@ -181,7 +178,8 @@ func (p *Pool) Connect(id string) error {
if p.logger != nil { if p.logger != nil {
logger = p.logger.With("id", id) logger = p.logger.With("id", id)
} }
ctx := PoolPlugin{
pool := PoolPlugin{
Inbox: p.inbox, Inbox: p.inbox,
Events: p.events, Events: p.events,
Errors: p.errors, Errors: p.errors,
@@ -191,7 +189,7 @@ func (p *Pool) Connect(id string) error {
} }
p.wg.Add(1) p.wg.Add(1)
go worker.Start(ctx, &p.wg) go worker.Start(pool, &p.wg)
p.peers[id] = &Peer{id: id, worker: worker} p.peers[id] = &Peer{id: id, worker: worker}
@@ -205,18 +203,17 @@ func (p *Pool) Remove(id string) error {
} }
p.mu.Lock() p.mu.Lock()
defer p.mu.Unlock()
if p.closed { if p.closed {
p.mu.Unlock()
return NewPoolError(ErrPoolClosed) return NewPoolError(ErrPoolClosed)
} }
peer, exists := p.peers[id] peer, exists := p.peers[id]
if !exists { if !exists {
p.mu.Unlock()
return NewPoolError(ErrPeerNotFound) return NewPoolError(ErrPeerNotFound)
} }
delete(p.peers, id) delete(p.peers, id)
p.mu.Unlock()
peer.worker.Stop() peer.worker.Stop()
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -11,6 +11,8 @@ import (
"testing" "testing"
) )
// Helpers
func setupPool(t *testing.T) (*Pool, *honeybeetest.MockDialer) { func setupPool(t *testing.T) (*Pool, *honeybeetest.MockDialer) {
t.Helper() t.Helper()
pool, err := NewPool(context.Background(), nil, nil) pool, err := NewPool(context.Background(), nil, nil)
@@ -24,6 +26,25 @@ func setupPool(t *testing.T) (*Pool, *honeybeetest.MockDialer) {
return pool, dialer return pool, dialer
} }
func expectEvent(
t *testing.T,
events chan PoolEvent,
expectedURL string,
expectedKind PoolEventKind,
) {
t.Helper()
honeybeetest.Eventually(t, func() bool {
select {
case e := <-events:
return e.ID == expectedURL && e.Kind == expectedKind
default:
return false
}
}, fmt.Sprintf("expected event: URL=%q, Kind=%q", expectedURL, expectedKind))
}
// Tests
func TestPoolConnect(t *testing.T) { func TestPoolConnect(t *testing.T) {
t.Run("successfully adds connection", func(t *testing.T) { t.Run("successfully adds connection", func(t *testing.T) {
pool, _ := setupPool(t) pool, _ := setupPool(t)
@@ -148,20 +169,3 @@ func TestPoolSend(t *testing.T) {
pool.Close() pool.Close()
} }
func expectEvent(
t *testing.T,
events chan PoolEvent,
expectedURL string,
expectedKind PoolEventKind,
) {
t.Helper()
honeybeetest.Eventually(t, func() bool {
select {
case e := <-events:
return e.ID == expectedURL && e.Kind == expectedKind
default:
return false
}
}, fmt.Sprintf("expected event: URL=%q, Kind=%q", expectedURL, expectedKind))
}
+33 -35
View File
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"container/list" "container/list"
@@ -23,14 +23,12 @@ type ReceivedMessage struct {
} }
type DefaultWorker struct { type DefaultWorker struct {
Ctx context.Context id string
Cancel context.CancelFunc conn atomic.Pointer[transport.Connection]
heartbeat chan struct{}
Id string config *WorkerConfig
Config *WorkerConfig ctx context.Context
cancel context.CancelFunc
Conn atomic.Pointer[transport.Connection]
Heartbeat chan struct{}
} }
func NewWorker( func NewWorker(
@@ -42,19 +40,17 @@ func NewWorker(
if config == nil { if config == nil {
config = GetDefaultWorkerConfig() config = GetDefaultWorkerConfig()
} }
if err := ValidateWorkerConfig(config); err != nil {
err := ValidateWorkerConfig(config)
if err != nil {
return nil, err return nil, err
} }
pool, cancel := context.WithCancel(ctx) wctx, wcancel := context.WithCancel(ctx)
w := &DefaultWorker{ w := &DefaultWorker{
Ctx: pool, id: id,
Cancel: cancel, config: config,
Id: id, heartbeat: make(chan struct{}),
Config: config, ctx: wctx,
Heartbeat: make(chan struct{}), cancel: wcancel,
} }
return w, nil return w, nil
@@ -74,31 +70,31 @@ func (w *DefaultWorker) Start(
go func() { go func() {
defer owg.Done() defer owg.Done()
RunDialer(w.Id, w.Ctx, pool, dial, newConn) RunDialer(w.id, w.ctx, pool, dial, newConn)
}() }()
go func() { go func() {
defer owg.Done() defer owg.Done()
RunKeepalive(w.Ctx, w.Heartbeat, keepalive, w.Config.KeepaliveTimeout) RunKeepalive(w.ctx, w.heartbeat, keepalive, w.config.KeepaliveTimeout)
}() }()
go func() { go func() {
defer owg.Done() defer owg.Done()
RunForwarder(w.Id, w.Ctx, messages, pool.Inbox, w.Config.MaxQueueSize) RunForwarder(w.id, w.ctx, messages, pool.Inbox, w.config.MaxQueueSize)
}() }()
go func() { go func() {
defer owg.Done() defer owg.Done()
session := &Session{ session := &Session{
id: w.Id, id: w.id,
connPtr: &w.Conn, connPtr: &w.conn,
messages: messages, messages: messages,
heartbeat: w.Heartbeat, heartbeat: w.heartbeat,
dial: dial, dial: dial,
keepalive: keepalive, keepalive: keepalive,
newConn: newConn, newConn: newConn,
} }
session.Start(w.Ctx, pool) session.Start(w.ctx, pool)
}() }()
owg.Wait() owg.Wait()
@@ -106,25 +102,23 @@ func (w *DefaultWorker) Start(
} }
func (w *DefaultWorker) Stop() { func (w *DefaultWorker) Stop() {
w.Cancel() w.cancel()
} }
func (w *DefaultWorker) Send(data []byte) error { func (w *DefaultWorker) Send(data []byte) error {
conn := w.Conn.Load() conn := w.conn.Load()
if conn == nil { if conn == nil {
// connection not established by session // connection not established by session
return NewWorkerError(w.Id, ErrConnectionUnavailable) return NewWorkerError(w.id, ErrConnectionUnavailable)
} }
err := conn.Send(data) if err := conn.Send(data); err != nil {
return NewWorkerError(w.id, err)
if err != nil {
return NewWorkerError(w.Id, err)
} }
select { select {
case w.Heartbeat <- struct{}{}: case w.heartbeat <- struct{}{}:
case <-w.Ctx.Done(): case <-w.ctx.Done():
} }
return nil return nil
@@ -313,12 +307,16 @@ func RunKeepalive(
) { ) {
// disable keepalive timeout if not configured // disable keepalive timeout if not configured
if timeout <= 0 { if timeout <= 0 {
// drain heartbeats
// wait for cancel and exit // wait for cancel and exit
for {
select { select {
case <-heartbeat:
case <-ctx.Done(): case <-ctx.Done():
}
return return
} }
}
}
timer := time.NewTimer(timeout) timer := time.NewTimer(timeout)
defer timer.Stop() defer timer.Stop()
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -1,4 +1,4 @@
package responderpool package outbound
import ( import (
"context" "context"
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -76,4 +76,27 @@ func TestRunKeepalive(t *testing.T) {
} }
}, "expected done signal") }, "expected done signal")
}) })
t.Run("disabled keepalive drains heartbeats without blocking", func(t *testing.T) {
heartbeat := make(chan struct{})
keepalive := make(chan struct{}, 1)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
go RunKeepalive(ctx, heartbeat, keepalive, 0)
// these must not block
for i := 0; i < 5; i++ {
heartbeat <- struct{}{}
}
honeybeetest.Never(t, func() bool {
select {
case <-keepalive:
return true
default:
return false
}
}, "keepalive signal should not fire when disabled")
})
} }
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -11,7 +11,7 @@ import (
func TestWorkerSend(t *testing.T) { func TestWorkerSend(t *testing.T) {
t.Run("data sent to mock socket", func(t *testing.T) { t.Run("data sent to mock socket", func(t *testing.T) {
conn, _, _, outgoingData := setupWorkerTestConnection(t) conn, _, _, outgoingData := setupTestConnection(t)
defer conn.Close() defer conn.Close()
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
@@ -20,13 +20,13 @@ func TestWorkerSend(t *testing.T) {
heartbeatCount := atomic.Int32{} heartbeatCount := atomic.Int32{}
w := &DefaultWorker{ w := &DefaultWorker{
Ctx: ctx, ctx: ctx,
Cancel: cancel, cancel: cancel,
Id: "wss://test", id: "wss://test",
Heartbeat: heartbeat, heartbeat: heartbeat,
} }
w.Conn.Store(conn) w.conn.Store(conn)
defer w.Cancel() defer w.cancel()
go func() { go func() {
for range heartbeat { for range heartbeat {
@@ -53,7 +53,7 @@ func TestWorkerSend(t *testing.T) {
}) })
t.Run("sends one heartbeat per successful send", func(t *testing.T) { t.Run("sends one heartbeat per successful send", func(t *testing.T) {
conn, _, _, _ := setupWorkerTestConnection(t) conn, _, _, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
@@ -62,13 +62,13 @@ func TestWorkerSend(t *testing.T) {
heartbeatCount := atomic.Int32{} heartbeatCount := atomic.Int32{}
w := &DefaultWorker{ w := &DefaultWorker{
Ctx: ctx, ctx: ctx,
Cancel: cancel, cancel: cancel,
Id: "wss://test", id: "wss://test",
Heartbeat: heartbeat, heartbeat: heartbeat,
} }
w.Conn.Store(conn) w.conn.Store(conn)
defer w.Cancel() defer w.cancel()
go func() { go func() {
for range heartbeat { for range heartbeat {
@@ -93,12 +93,12 @@ func TestWorkerSend(t *testing.T) {
heartbeat := make(chan struct{}) heartbeat := make(chan struct{})
w := &DefaultWorker{ w := &DefaultWorker{
Ctx: ctx, ctx: ctx,
Cancel: cancel, cancel: cancel,
Id: "wss://test", id: "wss://test",
Heartbeat: heartbeat, heartbeat: heartbeat,
} }
defer w.Cancel() defer w.cancel()
go func() { go func() {
for range heartbeat { for range heartbeat {
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -15,7 +15,7 @@ import (
func TestRunReader(t *testing.T) { func TestRunReader(t *testing.T) {
t.Run("message arrives with correct data and non-zero receivedAt", func(t *testing.T) { t.Run("message arrives with correct data and non-zero receivedAt", func(t *testing.T) {
conn, _, incomingData, _ := setupWorkerTestConnection(t) conn, _, incomingData, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
@@ -46,7 +46,7 @@ func TestRunReader(t *testing.T) {
}) })
t.Run("heartbeat receives one signal per message", func(t *testing.T) { t.Run("heartbeat receives one signal per message", func(t *testing.T) {
conn, _, incomingData, _ := setupWorkerTestConnection(t) conn, _, incomingData, _ := setupTestConnection(t)
defer conn.Close() defer conn.Close()
messages := make(chan ReceivedMessage, 10) messages := make(chan ReceivedMessage, 10)
@@ -80,7 +80,7 @@ func TestRunReader(t *testing.T) {
}) })
t.Run("incoming channel close calls conn.Close and onStop", func(t *testing.T) { t.Run("incoming channel close calls conn.Close and onStop", func(t *testing.T) {
conn, _, incomingData, _ := setupWorkerTestConnection(t) conn, _, incomingData, _ := setupTestConnection(t)
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
heartbeat := make(chan struct{}) heartbeat := make(chan struct{})
@@ -118,7 +118,7 @@ func TestRunReader(t *testing.T) {
}) })
t.Run("sessionDone close calls conn.Close and onStop", func(t *testing.T) { t.Run("sessionDone close calls conn.Close and onStop", func(t *testing.T) {
conn, _, _, _ := setupWorkerTestConnection(t) conn, _, _, _ := setupTestConnection(t)
messages := make(chan ReceivedMessage, 1) messages := make(chan ReceivedMessage, 1)
heartbeat := make(chan struct{}) heartbeat := make(chan struct{})
@@ -145,7 +145,7 @@ func TestRunReader(t *testing.T) {
func TestRunStopMonitor(t *testing.T) { func TestRunStopMonitor(t *testing.T) {
t.Run("keepalive signal calls conn.Close and cancel", func(t *testing.T) { t.Run("keepalive signal calls conn.Close and cancel", func(t *testing.T) {
conn, _, _, _ := setupWorkerTestConnection(t) conn, _, _, _ := setupTestConnection(t)
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
@@ -170,7 +170,7 @@ func TestRunStopMonitor(t *testing.T) {
}) })
t.Run("ctx.Done calls conn.Close and cancel", func(t *testing.T) { t.Run("ctx.Done calls conn.Close and cancel", func(t *testing.T) {
conn, _, _, _ := setupWorkerTestConnection(t) conn, _, _, _ := setupTestConnection(t)
ctx, cancel := context.WithCancel(context.Background()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -45,7 +45,7 @@ func setup(t *testing.T) (
) { ) {
t.Helper() t.Helper()
ctx, cancel = context.WithCancel(context.Background()) ctx, cancel = context.WithCancel(context.Background())
conn, mockSocket, incomingData, outgoingData := setupWorkerTestConnection(t) conn, mockSocket, incomingData, outgoingData := setupTestConnection(t)
vars = testVars{ vars = testVars{
id: "wss://test", id: "wss://test",
dial: make(chan struct{}, 1), dial: make(chan struct{}, 1),
@@ -319,7 +319,7 @@ func TestRunSessionDisconnect(t *testing.T) {
close(v.incomingData) close(v.incomingData)
drainEvent(t, events, EventDisconnected) drainEvent(t, events, EventDisconnected)
conn2, _, _, _ := setupWorkerTestConnection(t) conn2, _, _, _ := setupTestConnection(t)
v.newConn <- conn2 v.newConn <- conn2
drainEvent(t, events, EventConnected) drainEvent(t, events, EventConnected)
}) })
@@ -1,4 +1,4 @@
package initiatorpool package outbound
import ( import (
"context" "context"
@@ -34,11 +34,11 @@ func makeWorkerContext(t *testing.T) (
func makeWorker(t *testing.T, ctx context.Context, cancel context.CancelFunc) *DefaultWorker { func makeWorker(t *testing.T, ctx context.Context, cancel context.CancelFunc) *DefaultWorker {
t.Helper() t.Helper()
return &DefaultWorker{ return &DefaultWorker{
Ctx: ctx, ctx: ctx,
Cancel: cancel, cancel: cancel,
Id: "wss://test", id: "wss://test",
Config: GetDefaultWorkerConfig(), config: GetDefaultWorkerConfig(),
Heartbeat: make(chan struct{}), heartbeat: make(chan struct{}),
} }
} }
@@ -67,7 +67,7 @@ func TestWorkerStart(t *testing.T) {
honeybeetest.Eventually(t, func() bool { honeybeetest.Eventually(t, func() bool {
select { select {
case e := <-events: case e := <-events:
return e.ID == w.Id && e.Kind == EventConnected return e.ID == w.id && e.Kind == EventConnected
default: default:
return false return false
} }
@@ -80,7 +80,7 @@ func TestWorkerStart(t *testing.T) {
w := makeWorker(t, ctx, cancel) w := makeWorker(t, ctx, cancel)
_, events, _, pool := makeWorkerContext(t) _, events, _, pool := makeWorkerContext(t)
_, mockSocket, _, outgoingData := setupWorkerTestConnection(t) _, mockSocket, _, outgoingData := setupTestConnection(t)
pool.Dialer = mockDialer(mockSocket) pool.Dialer = mockDialer(mockSocket)
var wg sync.WaitGroup var wg sync.WaitGroup
@@ -154,7 +154,7 @@ func TestWorkerStart(t *testing.T) {
honeybeetest.Eventually(t, func() bool { honeybeetest.Eventually(t, func() bool {
select { select {
case msg := <-inbox: case msg := <-inbox:
return msg.ID == w.Id && string(msg.Data) == "hello" return msg.ID == w.id && string(msg.Data) == "hello"
default: default:
return false return false
} }
@@ -167,7 +167,7 @@ func TestWorkerStart(t *testing.T) {
w := makeWorker(t, ctx, cancel) w := makeWorker(t, ctx, cancel)
_, events, _, pool := makeWorkerContext(t) _, events, _, pool := makeWorkerContext(t)
_, mockSocket, incomingData, _ := setupWorkerTestConnection(t) _, mockSocket, incomingData, _ := setupTestConnection(t)
pool.Dialer = mockDialer(mockSocket) pool.Dialer = mockDialer(mockSocket)
var wg sync.WaitGroup var wg sync.WaitGroup
-24
View File
@@ -1,24 +0,0 @@
package responderpool
import (
"time"
)
type PoolEventKind string
const (
EventPeerDisconnected PoolEventKind = "disconnected"
EventPeerDropped PoolEventKind = "dropped"
EventPeerEvicted PoolEventKind = "evicted"
)
type PoolEvent struct {
ID string
Kind PoolEventKind
}
type InboxMessage struct {
ID string
Data []byte
ReceivedAt time.Time
}