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

Add slog attributes at pool, worker, and connection levels.

Browse Source
This commit is contained in:
Jay
2026-04-23 17:58:40 -04:00
parent 91717457dd
commit 727dc18b57
17 changed files with 488 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files
outbound/config.go
+6 -1
View File
@@ -3,12 +3,17 @@ package outbound
import (
"context"
"git.wisehodl.dev/jay/go-honeybee/transport"
"log/slog"
"time"
)
// Types
type WorkerFactory func(ctx context.Context, id string) (Worker, error)
type WorkerFactory func(
ctx context.Context,
id string,
logger *slog.Logger,
) (Worker, error)
// Pool Config
outbound/errors.go
+4 -3
View File
@@ -10,9 +10,10 @@ var (
InvalidBufferSize = errors.New("buffer size must be greater than zero")
// Pool errors
ErrPoolClosed = errors.New("pool is closed")
ErrPeerNotFound = errors.New("peer not found")
ErrPeerExists = errors.New("peer already exists")
ErrInvalidPoolID = errors.New("pool id cannot be empty")
ErrPoolClosed = errors.New("pool is closed")
ErrPeerNotFound = errors.New("peer not found")
ErrPeerExists = errors.New("peer already exists")
// Worker errors
ErrConnectionUnavailable = errors.New("connection unavailable")
outbound/pool.go
+40 -23
View File
@@ -2,6 +2,7 @@ package outbound
import (
"context"
"git.wisehodl.dev/jay/go-honeybee/logging"
"git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
"log/slog"
@@ -30,12 +31,13 @@ type InboxMessage struct {
}
type PoolPlugin struct {
ID string
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Errors chan<- error
Logger *slog.Logger
Dialer types.Dialer
ConnectionConfig *transport.ConnectionConfig
Handler slog.Handler
}
// Pool
@@ -49,22 +51,29 @@ type Pool struct {
ctx context.Context
cancel context.CancelFunc
id string
peers map[string]*Peer
inbox chan InboxMessage
events chan PoolEvent
errors chan error
dialer types.Dialer
config *PoolConfig
logger *slog.Logger
dialer types.Dialer
config *PoolConfig
handler slog.Handler
logger *slog.Logger
mu sync.RWMutex
wg sync.WaitGroup
closed bool
}
func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger,
func NewPool(ctx context.Context, id string, config *PoolConfig, handler slog.Handler,
) (*Pool, error) {
if id == "" {
return nil, ErrInvalidPoolID
}
if config == nil {
config = GetDefaultPoolConfig()
}
@@ -74,8 +83,8 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger,
// deadlocks.
if config.WorkerFactory == nil {
config.WorkerFactory = func(
ctx context.Context, id string) (Worker, error) {
return NewWorker(ctx, id, config.WorkerConfig)
ctx context.Context, id string, logger *slog.Logger) (Worker, error) {
return NewWorker(ctx, id, config.WorkerConfig, logger)
}
}
@@ -85,16 +94,23 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger,
pctx, cancel := context.WithCancel(ctx)
var logger *slog.Logger
if handler != nil {
logger = logging.NewOutboundPoolLogger(handler, id)
}
return &Pool{
ctx: pctx,
cancel: cancel,
peers: make(map[string]*Peer),
inbox: make(chan InboxMessage, config.InboxBufferSize),
events: make(chan PoolEvent, config.EventsBufferSize),
errors: make(chan error, config.ErrorsBufferSize),
dialer: transport.NewDialer(),
config: config,
logger: logger,
ctx: pctx,
cancel: cancel,
id: id,
peers: make(map[string]*Peer),
inbox: make(chan InboxMessage, config.InboxBufferSize),
events: make(chan PoolEvent, config.EventsBufferSize),
errors: make(chan error, config.ErrorsBufferSize),
dialer: transport.NewDialer(),
config: config,
handler: handler,
logger: logger,
}, nil
}
@@ -168,24 +184,25 @@ func (p *Pool) Connect(id string) error {
return NewPoolError(ErrPeerExists)
}
var logger *slog.Logger
if p.handler != nil {
logger = logging.NewOutboundWorkerLogger(p.handler, p.id, id)
}
// The worker factory must be non-blocking to avoid deadlocks
worker, err := p.config.WorkerFactory(p.ctx, id)
worker, err := p.config.WorkerFactory(p.ctx, id, logger)
if err != nil {
return err
}
var logger *slog.Logger
if p.logger != nil {
logger = p.logger.With("id", id)
}
pool := PoolPlugin{
ID: p.id,
Inbox: p.inbox,
Events: p.events,
Errors: p.errors,
Logger: logger,
Dialer: p.dialer,
ConnectionConfig: p.config.ConnectionConfig,
Handler: p.handler,
}
p.wg.Add(1)
outbound/pool_test.go
+9 -4
View File
@@ -15,7 +15,7 @@ import (
func setupPool(t *testing.T) (*Pool, *honeybeetest.MockDialer) {
t.Helper()
pool, err := NewPool(context.Background(), nil, nil)
pool, err := NewPool(context.Background(), "pool-1", nil, nil)
assert.NoError(t, err)
dialer := &honeybeetest.MockDialer{
DialContextFunc: func(context.Context, string, http.Header) (types.Socket, *http.Response, error) {
@@ -45,6 +45,11 @@ func expectEvent(
// Tests
func TestPoolID(t *testing.T) {
_, err := NewPool(context.Background(), "", nil, nil)
assert.ErrorIs(t, err, ErrInvalidPoolID)
}
func TestPoolConnect(t *testing.T) {
t.Run("successfully adds connection", func(t *testing.T) {
pool, _ := setupPool(t)
@@ -85,7 +90,7 @@ func TestPoolConnect(t *testing.T) {
func TestPoolClose(t *testing.T) {
t.Run("channels close after pool close", func(t *testing.T) {
pool, _ := NewPool(context.Background(), nil, nil)
pool, _ := NewPool(context.Background(), "pool-1", nil, nil)
pool.Close()
_, ok := <-pool.Inbox()
assert.False(t, ok)
@@ -96,7 +101,7 @@ func TestPoolClose(t *testing.T) {
})
t.Run("connect after close returns error", func(t *testing.T) {
pool, _ := NewPool(context.Background(), nil, nil)
pool, _ := NewPool(context.Background(), "pool-1", nil, nil)
pool.Close()
err := pool.Connect("wss://test")
assert.ErrorIs(t, err, ErrPoolClosed)
@@ -154,7 +159,7 @@ func TestPoolSend(t *testing.T) {
},
}
pool, err := NewPool(context.Background(), nil, nil)
pool, err := NewPool(context.Background(), "pool-1", nil, nil)
assert.NoError(t, err)
pool.dialer = mockDialer
outbound/worker.go
+11 -2
View File
@@ -2,9 +2,11 @@ package outbound
import (
"context"
"git.wisehodl.dev/jay/go-honeybee/logging"
"git.wisehodl.dev/jay/go-honeybee/queue"
"git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
"log/slog"
"sync"
"sync/atomic"
"time"
@@ -25,13 +27,14 @@ type DefaultWorker struct {
config *WorkerConfig
ctx context.Context
cancel context.CancelFunc
logger *slog.Logger
}
func NewWorker(
ctx context.Context,
id string,
config *WorkerConfig,
logger *slog.Logger,
) (*DefaultWorker, error) {
if config == nil {
config = GetDefaultWorkerConfig()
@@ -47,6 +50,7 @@ func NewWorker(
heartbeat: make(chan struct{}),
ctx: wctx,
cancel: wcancel,
logger: logger,
}
return w, nil
@@ -333,7 +337,12 @@ func connect(
ctx context.Context,
pool PoolPlugin,
) (*transport.Connection, error) {
conn, err := transport.NewConnection(id, pool.ConnectionConfig, pool.Logger)
var logger *slog.Logger
if pool.Handler != nil {
logger = logging.NewConnectionLogger(pool.Handler, pool.ID, id)
}
conn, err := transport.NewConnection(id, pool.ConnectionConfig, logger)
if err != nil {
return nil, err
}