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

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
+2
View File
@@ -4,6 +4,7 @@ package inbound
import (
"context"
"git.wisehodl.dev/jay/go-honeybee/transport"
"log/slog"
"time"
)
@@ -96,6 +97,7 @@ type WorkerFactory func(
id string,
conn *transport.Connection,
config *WorkerConfig,
logger *slog.Logger,
) (Worker, error)
type PoolConfig struct {
+5 -4
View File
@@ -4,10 +4,11 @@ import "errors"
var (
// Pool errors
PoolError = errors.New("pool error")
ErrPoolClosed = errors.New("pool is closed")
ErrPeerNotFound = errors.New("peer not found")
ErrPeerExists = errors.New("peer already exists")
PoolError = errors.New("pool error")
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")
// Config errors
InvalidMaxQueueSize = errors.New("maximum queue size cannot be negative")
+50 -29
View File
@@ -3,6 +3,7 @@ package inbound
import (
"context"
"fmt"
"git.wisehodl.dev/jay/go-honeybee/logging"
"git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
"log/slog"
@@ -40,11 +41,11 @@ type InboxMessage struct {
}
type PoolPlugin struct {
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Errors chan<- error
Logger *slog.Logger
OnExit OnExitFunction
Inbox chan<- InboxMessage
Events chan<- PoolEvent
Errors chan<- error
OnExit OnExitFunction
Handler slog.Handler
}
// Pool
@@ -60,20 +61,27 @@ type Pool struct {
ctx context.Context
cancel context.CancelFunc
id string
peers map[string]*Peer
inbox chan InboxMessage
events chan PoolEvent
errors chan error
config *PoolConfig
logger *slog.Logger
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) (*Pool, error) {
func NewPool(ctx context.Context, id string, config *PoolConfig, handler slog.Handler) (*Pool, error) {
if id == "" {
return nil, ErrInvalidPoolID
}
if config == nil {
config = GetDefaultPoolConfig()
}
@@ -82,13 +90,15 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger) (*Poo
// The factory function should be non-blocking or else Connect() may cause
// deadlocks.
if config.WorkerFactory == nil {
// TODO: Construct worker logger
config.WorkerFactory = func(
ctx context.Context,
id string,
conn *transport.Connection,
config *WorkerConfig,
logger *slog.Logger,
) (Worker, error) {
return NewWorker(ctx, id, conn, config)
return NewWorker(ctx, id, conn, config, logger)
}
}
@@ -98,15 +108,22 @@ func NewPool(ctx context.Context, config *PoolConfig, logger *slog.Logger) (*Poo
pctx, cancel := context.WithCancel(ctx)
var logger *slog.Logger
if handler != nil {
logger = logging.NewInboundPoolLogger(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),
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),
config: config,
handler: handler,
logger: logger,
}, nil
}
@@ -231,15 +248,24 @@ func (p *Pool) Send(id string, data []byte) error {
// addLocked constructs and registers a peer. Caller must hold p.mu write lock.
func (p *Pool) addLocked(id string, socket types.Socket) error {
var logger *slog.Logger
if p.handler != nil {
logger = logging.NewConnectionLogger(p.handler, p.id, id)
}
conn, err := transport.NewConnectionFromSocket(
socket, p.config.ConnectionConfig, p.logger)
socket, p.config.ConnectionConfig, 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 p.handler != nil {
logger = logging.NewInboundWorkerLogger(p.handler, p.id, id)
}
worker, err := p.config.WorkerFactory(wctx, id, conn, p.config.WorkerConfig, logger)
if err != nil {
cancel()
conn.Close()
@@ -263,17 +289,12 @@ func (p *Pool) addLocked(id string, socket types.Socket) error {
})
}
var logger *slog.Logger
if p.logger != nil {
logger = p.logger.With("id", id)
}
pool := PoolPlugin{
Inbox: p.inbox,
Events: p.events,
Errors: p.errors,
Logger: logger,
OnExit: onExit,
Inbox: p.inbox,
Events: p.events,
Errors: p.errors,
OnExit: onExit,
Handler: p.handler,
}
peer := &Peer{
+7 -2
View File
@@ -15,7 +15,7 @@ import (
func setupPool(t *testing.T) *Pool {
t.Helper()
pool, err := NewPool(context.Background(), nil, nil)
pool, err := NewPool(context.Background(), "pool-1", nil, nil)
assert.NoError(t, err)
return pool
}
@@ -39,6 +39,11 @@ func expectEvent(
// Tests
func TestPoolID(t *testing.T) {
_, err := NewPool(context.Background(), "", nil, nil)
assert.ErrorIs(t, err, ErrInvalidPoolID)
}
func TestPoolAdd(t *testing.T) {
t.Run("successfully adds peer", func(t *testing.T) {
pool := setupPool(t)
@@ -341,7 +346,7 @@ func TestPoolEvents(t *testing.T) {
)
assert.NoError(t, err)
pool, err := NewPool(context.Background(), config, nil)
pool, err := NewPool(context.Background(), "pool-1", config, nil)
assert.NoError(t, err)
defer pool.Close()
+4
View File
@@ -6,6 +6,7 @@ import (
"git.wisehodl.dev/jay/go-honeybee/queue"
"git.wisehodl.dev/jay/go-honeybee/transport"
"git.wisehodl.dev/jay/go-honeybee/types"
"log/slog"
"sync"
"time"
)
@@ -31,6 +32,7 @@ type DefaultWorker struct {
config *WorkerConfig
ctx context.Context
cancel context.CancelFunc
logger *slog.Logger
}
func NewWorker(
@@ -38,6 +40,7 @@ func NewWorker(
id string,
conn *transport.Connection,
config *WorkerConfig,
logger *slog.Logger,
) (*DefaultWorker, error) {
if config == nil {
config = GetDefaultWorkerConfig()
@@ -54,6 +57,7 @@ func NewWorker(
config: config,
ctx: wctx,
cancel: cancel,
logger: logger,
}, nil
}
+2 -2
View File
@@ -32,7 +32,7 @@ func setupWorkerTest(t *testing.T) workerTestVars {
ctx, cancel := context.WithCancel(context.Background())
var err error
worker, err := NewWorker(ctx, "peer-1", conn, nil)
worker, err := NewWorker(ctx, "peer-1", conn, nil, nil)
assert.NoError(t, err)
worker.cancel = cancel
@@ -125,7 +125,7 @@ func TestWorkerStart(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
worker, err := NewWorker(ctx, "peer-1", conn, &WorkerConfig{
InactivityTimeout: 20 * time.Millisecond,
})
}, nil)
assert.NoError(t, err)
worker.cancel = cancel
defer worker.Stop()