feat: implement Redis-based message bus and awareness management
- Added RedisMessageBus for message distribution using Redis Pub/Sub. - Introduced LocalMessageBus as a no-op implementation for single-server mode. - Created messagebus interface for abstraction of message distribution. - Implemented awareness management methods: SetAwareness, GetAllAwareness, DeleteAwareness, and ClearAllAwareness. - Added logger utility for structured logging with zap. - Refactored SniffYjsClientIDs and MakeYjsDeleteMessage functions for improved readability.
This commit is contained in:
M1ngdaXie
80
backend/internal/messagebus/interface.go
Normal file
80
backend/internal/messagebus/interface.go
Normal file
@@ -0,0 +1,80 @@
|
||||
package messagebus
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
// MessageBus abstracts message distribution across server instances
|
||||
type MessageBus interface {
|
||||
// Publish sends a message to a specific room channel
|
||||
// data must be preserved as-is (binary safe)
|
||||
Publish(ctx context.Context, roomID string, data []byte) error
|
||||
|
||||
// Subscribe listens to messages for a specific room
|
||||
// Returns a channel that receives binary messages
|
||||
Subscribe(ctx context.Context, roomID string) (<-chan []byte, error)
|
||||
|
||||
// Unsubscribe stops listening to a room
|
||||
Unsubscribe(ctx context.Context, roomID string) error
|
||||
|
||||
// SetAwareness caches awareness data for a client in a room
|
||||
SetAwareness(ctx context.Context, roomID string, clientID uint64, data []byte) error
|
||||
|
||||
// GetAllAwareness retrieves all cached awareness for a room
|
||||
GetAllAwareness(ctx context.Context, roomID string) (map[uint64][]byte, error)
|
||||
|
||||
// DeleteAwareness removes awareness cache for a client
|
||||
DeleteAwareness(ctx context.Context, roomID string, clientID uint64) error
|
||||
|
||||
ClearAllAwareness(ctx context.Context, roomID string) error
|
||||
|
||||
// IsHealthy returns true if message bus is operational
|
||||
IsHealthy() bool
|
||||
|
||||
// Close gracefully shuts down the message bus
|
||||
Close() error
|
||||
}
|
||||
|
||||
// LocalMessageBus is a no-op implementation for single-server mode
|
||||
type LocalMessageBus struct{}
|
||||
|
||||
func NewLocalMessageBus() *LocalMessageBus {
|
||||
return &LocalMessageBus{}
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) Publish(ctx context.Context, roomID string, data []byte) error {
|
||||
return nil // No-op for local mode
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) Subscribe(ctx context.Context, roomID string) (<-chan []byte, error) {
|
||||
ch := make(chan []byte)
|
||||
close(ch) // Immediately closed channel
|
||||
return ch, nil
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) Unsubscribe(ctx context.Context, roomID string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) SetAwareness(ctx context.Context, roomID string, clientID uint64, data []byte) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) GetAllAwareness(ctx context.Context, roomID string) (map[uint64][]byte, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) DeleteAwareness(ctx context.Context, roomID string, clientID uint64) error {
|
||||
return nil
|
||||
}
|
||||
func (l *LocalMessageBus) ClearAllAwareness(ctx context.Context, roomID string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) IsHealthy() bool {
|
||||
return true
|
||||
}
|
||||
|
||||
func (l *LocalMessageBus) Close() error {
|
||||
return nil
|
||||
}
|
||||
392
backend/internal/messagebus/redis.go
Normal file
392
backend/internal/messagebus/redis.go
Normal file
@@ -0,0 +1,392 @@
|
||||
package messagebus
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
goredis "github.com/redis/go-redis/v9"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
// envelopeSeparator separates the serverID prefix from the payload in Redis messages.
|
||||
// This allows receivers to identify and skip messages they published themselves.
|
||||
var envelopeSeparator = []byte{0xFF, 0x00}
|
||||
|
||||
// RedisMessageBus implements MessageBus using Redis Pub/Sub
|
||||
type RedisMessageBus struct {
|
||||
client *goredis.Client
|
||||
logger *zap.Logger
|
||||
subscriptions map[string]*subscription // roomID -> subscription
|
||||
subMu sync.RWMutex
|
||||
serverID string
|
||||
}
|
||||
|
||||
type subscription struct {
|
||||
pubsub *goredis.PubSub
|
||||
channel chan []byte
|
||||
cancel context.CancelFunc
|
||||
}
|
||||
|
||||
// NewRedisMessageBus creates a new Redis-backed message bus
|
||||
func NewRedisMessageBus(redisURL string, serverID string, logger *zap.Logger) (*RedisMessageBus, error) {
|
||||
opts, err := goredis.ParseURL(redisURL)
|
||||
if err != nil {
|
||||
logger.Error("Redis URL failed",
|
||||
zap.String("url", redisURL),
|
||||
zap.Error(err),
|
||||
)
|
||||
return nil, err
|
||||
}
|
||||
client := goredis.NewClient(opts)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
||||
defer cancel()
|
||||
|
||||
logger.Info("Trying to reach Redis...", zap.String("addr", opts.Addr))
|
||||
|
||||
if err := client.Ping(ctx).Err(); err != nil {
|
||||
logger.Error("Redis connection Ping Failed",
|
||||
zap.String("addr", opts.Addr),
|
||||
zap.Error(err),
|
||||
)
|
||||
_ = client.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
logger.Info("Redis connected successfully", zap.String("addr", opts.Addr))
|
||||
return &RedisMessageBus{
|
||||
client: client,
|
||||
logger: logger,
|
||||
subscriptions: make(map[string]*subscription),
|
||||
serverID: serverID,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Publish sends a binary message to a room channel, prepending the serverID envelope
|
||||
func (r *RedisMessageBus) Publish(ctx context.Context, roomID string, data []byte) error {
|
||||
channel := fmt.Sprintf("room:%s:messages", roomID)
|
||||
|
||||
// Prepend serverID + separator so receivers can filter self-echoes
|
||||
envelope := make([]byte, 0, len(r.serverID)+len(envelopeSeparator)+len(data))
|
||||
envelope = append(envelope, []byte(r.serverID)...)
|
||||
envelope = append(envelope, envelopeSeparator...)
|
||||
envelope = append(envelope, data...)
|
||||
|
||||
err := r.client.Publish(ctx, channel, envelope).Err()
|
||||
|
||||
if err != nil {
|
||||
r.logger.Error("failed to publish message",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Int("data_len", len(data)),
|
||||
zap.String("channel", channel),
|
||||
zap.Error(err),
|
||||
)
|
||||
return fmt.Errorf("redis publish failed: %w", err)
|
||||
}
|
||||
r.logger.Debug("published message successfully",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Int("data_len", len(data)),
|
||||
)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Subscribe creates a subscription to a room channel
|
||||
func (r *RedisMessageBus) Subscribe(ctx context.Context, roomID string) (<-chan []byte, error) {
|
||||
r.subMu.Lock()
|
||||
defer r.subMu.Unlock()
|
||||
|
||||
if sub, exists := r.subscriptions[roomID]; exists {
|
||||
r.logger.Debug("returning existing subscription", zap.String("roomID", roomID))
|
||||
return sub.channel, nil
|
||||
}
|
||||
|
||||
// Subscribe to Redis channel
|
||||
channel := fmt.Sprintf("room:%s:messages", roomID)
|
||||
pubsub := r.client.Subscribe(ctx, channel)
|
||||
|
||||
if _, err := pubsub.Receive(ctx); err != nil {
|
||||
pubsub.Close()
|
||||
return nil, fmt.Errorf("failed to verify subscription: %w", err)
|
||||
}
|
||||
|
||||
subCtx, cancel := context.WithCancel(context.Background())
|
||||
msgChan := make(chan []byte, 256)
|
||||
sub := &subscription{
|
||||
pubsub: pubsub,
|
||||
channel: msgChan,
|
||||
cancel: cancel,
|
||||
}
|
||||
r.subscriptions[roomID] = sub
|
||||
|
||||
go r.forwardMessages(subCtx, roomID, sub.pubsub, msgChan)
|
||||
|
||||
r.logger.Info("successfully subscribed to room",
|
||||
zap.String("roomID", roomID),
|
||||
zap.String("channel", channel),
|
||||
)
|
||||
return msgChan, nil
|
||||
}
|
||||
|
||||
// forwardMessages receives from Redis PubSub and forwards to local channel
|
||||
func (r *RedisMessageBus) forwardMessages(ctx context.Context, roomID string, pubsub *goredis.PubSub, msgChan chan []byte) {
|
||||
defer func() {
|
||||
close(msgChan)
|
||||
r.logger.Info("forwarder stopped", zap.String("roomID", roomID))
|
||||
}()
|
||||
|
||||
//Get the Redis channel from pubsub
|
||||
ch := pubsub.Channel()
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
r.logger.Info("stopping the channel due to context cancellation", zap.String("roomID", roomID))
|
||||
return
|
||||
|
||||
case msg, ok := <-ch:
|
||||
// Check if channel is closed (!ok)
|
||||
if !ok {
|
||||
r.logger.Warn("redis pubsub channel closed unexpectedly", zap.String("roomID", roomID))
|
||||
return
|
||||
}
|
||||
|
||||
// Parse envelope: serverID + separator + payload
|
||||
raw := []byte(msg.Payload)
|
||||
sepIdx := bytes.Index(raw, envelopeSeparator)
|
||||
if sepIdx == -1 {
|
||||
r.logger.Warn("received message without server envelope, skipping",
|
||||
zap.String("roomID", roomID))
|
||||
continue
|
||||
}
|
||||
|
||||
senderID := string(raw[:sepIdx])
|
||||
payload := raw[sepIdx+len(envelopeSeparator):]
|
||||
|
||||
// Skip messages published by this same server (prevent echo)
|
||||
if senderID == r.serverID {
|
||||
continue
|
||||
}
|
||||
|
||||
select {
|
||||
case msgChan <- payload:
|
||||
r.logger.Debug("message forwarded",
|
||||
zap.String("roomID", roomID),
|
||||
zap.String("from_server", senderID),
|
||||
zap.Int("size", len(payload)))
|
||||
default:
|
||||
r.logger.Warn("message dropped: consumer too slow",
|
||||
zap.String("roomID", roomID))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Unsubscribe stops listening to a room
|
||||
func (r *RedisMessageBus) Unsubscribe(ctx context.Context, roomID string) error {
|
||||
r.subMu.Lock()
|
||||
defer r.subMu.Unlock()
|
||||
|
||||
// Check if subscription exists
|
||||
sub, ok := r.subscriptions[roomID]
|
||||
if !ok {
|
||||
r.logger.Debug("unsubscribe ignored: room not found", zap.String("roomID", roomID))
|
||||
return nil
|
||||
}
|
||||
// Cancel the context (stops forwardMessages goroutine)
|
||||
sub.cancel()
|
||||
|
||||
// Close the Redis pubsub connection
|
||||
if err := sub.pubsub.Close(); err != nil {
|
||||
r.logger.Error("failed to close redis pubsub",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Error(err),
|
||||
)
|
||||
}
|
||||
// Remove from subscriptions map
|
||||
delete(r.subscriptions, roomID)
|
||||
r.logger.Info("successfully unsubscribed", zap.String("roomID", roomID))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// SetAwareness caches awareness data in Redis Hash
|
||||
func (r *RedisMessageBus) SetAwareness(ctx context.Context, roomID string, clientID uint64, data []byte) error {
|
||||
key := fmt.Sprintf("room:%s:awareness", roomID)
|
||||
field := fmt.Sprintf("%d", clientID)
|
||||
|
||||
if err := r.client.HSet(ctx, key, field, data).Err(); err != nil {
|
||||
r.logger.Error("failed to set awareness data",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Uint64("clientID", clientID),
|
||||
zap.Error(err),
|
||||
)
|
||||
return fmt.Errorf("hset awareness failed: %w", err)
|
||||
}
|
||||
|
||||
// Set expiration on the Hash (30s)
|
||||
if err := r.client.Expire(ctx, key, 30*time.Second).Err(); err != nil {
|
||||
r.logger.Warn("failed to set expiration on awareness key",
|
||||
zap.String("key", key),
|
||||
zap.Error(err),
|
||||
)
|
||||
}
|
||||
r.logger.Debug("awareness updated",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Uint64("clientID", clientID),
|
||||
zap.Int("data_len", len(data)),
|
||||
)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetAllAwareness retrieves all cached awareness for a room
|
||||
func (r *RedisMessageBus) GetAllAwareness(ctx context.Context, roomID string) (map[uint64][]byte, error) {
|
||||
// 1. 构建 Redis Hash key
|
||||
key := fmt.Sprintf("room:%s:awareness", roomID)
|
||||
|
||||
// 2. 从 Redis 获取所有字段
|
||||
// HGetAll 会返回该 Hash 下所有的 field 和 value
|
||||
result, err := r.client.HGetAll(ctx, key).Result()
|
||||
if err != nil {
|
||||
r.logger.Error("failed to HGetAll awareness",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Error(err),
|
||||
)
|
||||
return nil, fmt.Errorf("redis hgetall failed: %w", err)
|
||||
}
|
||||
|
||||
// 3. 转换数据类型：map[string]string -> map[uint64][]byte
|
||||
awarenessMap := make(map[uint64][]byte, len(result))
|
||||
|
||||
for field, value := range result {
|
||||
// 解析 field (clientID) 为 uint64
|
||||
// 虽然提示可以用 Sscanf，但在 Go 中 strconv.ParseUint 通常更高效且稳健
|
||||
clientID, err := strconv.ParseUint(field, 10, 64)
|
||||
if err != nil {
|
||||
r.logger.Warn("invalid clientID format in awareness hash",
|
||||
zap.String("roomID", roomID),
|
||||
zap.String("field", field),
|
||||
)
|
||||
continue // 跳过异常字段，保证其他数据正常显示
|
||||
}
|
||||
|
||||
// 将 string 转换为 []byte
|
||||
awarenessMap[clientID] = []byte(value)
|
||||
}
|
||||
|
||||
// 4. 记录日志
|
||||
r.logger.Debug("retrieved all awareness data",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Int("client_count", len(awarenessMap)),
|
||||
)
|
||||
|
||||
return awarenessMap, nil
|
||||
}
|
||||
|
||||
// DeleteAwareness removes awareness cache for a client
|
||||
func (r *RedisMessageBus) DeleteAwareness(ctx context.Context, roomID string, clientID uint64) error {
|
||||
key := fmt.Sprintf("room:%s:awareness", roomID)
|
||||
field := fmt.Sprintf("%d", clientID)
|
||||
|
||||
if err := r.client.HDel(ctx, key, field).Err(); err != nil {
|
||||
r.logger.Error("failed to delete awareness data",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Uint64("clientID", clientID),
|
||||
zap.Error(err),
|
||||
)
|
||||
return fmt.Errorf("delete awareness failed: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// IsHealthy checks Redis connectivity
|
||||
func (r *RedisMessageBus) IsHealthy() bool {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
|
||||
defer cancel()
|
||||
|
||||
// 只有 Ping 成功且没有报错，才认为服务是健康的
|
||||
if err := r.client.Ping(ctx).Err(); err != nil {
|
||||
r.logger.Warn("Redis health check failed", zap.Error(err))
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// StartHealthMonitoring runs periodic health checks
|
||||
func (r *RedisMessageBus) StartHealthMonitoring(ctx context.Context, interval time.Duration, onStatusChange func(bool)) {
|
||||
ticker := time.NewTicker(interval)
|
||||
defer ticker.Stop()
|
||||
|
||||
previouslyHealthy := true
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
r.logger.Info("stopping health monitoring")
|
||||
return
|
||||
case <-ticker.C:
|
||||
// 检查当前健康状态
|
||||
currentlyHealthy := r.IsHealthy()
|
||||
|
||||
// 如果状态发生变化（健康 -> 亚健康，或 亚健康 -> 恢复）
|
||||
if currentlyHealthy != previouslyHealthy {
|
||||
r.logger.Warn("Redis health status changed",
|
||||
zap.Bool("old_status", previouslyHealthy),
|
||||
zap.Bool("new_status", currentlyHealthy),
|
||||
)
|
||||
|
||||
// 触发外部回调逻辑
|
||||
if onStatusChange != nil {
|
||||
onStatusChange(currentlyHealthy)
|
||||
}
|
||||
|
||||
// 更新历史状态
|
||||
previouslyHealthy = currentlyHealthy
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (r *RedisMessageBus) Close() error {
|
||||
r.subMu.Lock()
|
||||
defer r.subMu.Unlock()
|
||||
|
||||
r.logger.Info("gracefully shutting down message bus", zap.Int("active_subs", len(r.subscriptions)))
|
||||
|
||||
// 1. 关闭所有正在运行的订阅
|
||||
for roomID, sub := range r.subscriptions {
|
||||
// 停止对应的 forwardMessages 协程
|
||||
sub.cancel()
|
||||
|
||||
// 关闭物理连接
|
||||
if err := sub.pubsub.Close(); err != nil {
|
||||
r.logger.Error("failed to close pubsub connection",
|
||||
zap.String("roomID", roomID),
|
||||
zap.Error(err),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// 2. 清空 Map，释放引用以便 GC 回收
|
||||
r.subscriptions = make(map[string]*subscription)
|
||||
|
||||
// 3. 关闭主 Redis 客户端连接池
|
||||
if err := r.client.Close(); err != nil {
|
||||
r.logger.Error("failed to close redis client", zap.Error(err))
|
||||
return err
|
||||
}
|
||||
|
||||
r.logger.Info("Redis message bus closed successfully")
|
||||
return nil
|
||||
}
|
||||
// ClearAllAwareness 彻底删除该房间的感知数据 Hash
|
||||
func (r *RedisMessageBus) ClearAllAwareness(ctx context.Context, roomID string) error {
|
||||
key := fmt.Sprintf("room:%s:awareness", roomID)
|
||||
// 直接使用 Del 命令删除整个 Key
|
||||
return r.client.Del(ctx, key).Err()
|
||||
}
|
||||
Reference in New Issue
Block a user