1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
package centrifuge
import (
"errors"
"fmt"
"time"
"github.com/centrifugal/protocol"
"github.com/gomodule/redigo/redis"
)
var _ PresenceManager = (*RedisPresenceManager)(nil)
// RedisPresenceManager keeps presence in Redis thus allows scaling nodes.
type RedisPresenceManager struct {
node *Node
sharding bool
config RedisPresenceManagerConfig
shards []*RedisShard
addPresenceScript *redis.Script
remPresenceScript *redis.Script
presenceScript *redis.Script
}
const (
// DefaultRedisPresenceTTL is a default value for presence TTL in Redis.
DefaultRedisPresenceTTL = 60 * time.Second
// DefaultRedisPresenceManagerPrefix is a default value for RedisPresenceManagerConfig.Prefix.
DefaultRedisPresenceManagerPrefix = "centrifuge"
)
// RedisPresenceManagerConfig is a config for RedisPresenceManager.
type RedisPresenceManagerConfig struct {
// Prefix to use before every channel name and key in Redis. By default
// DefaultRedisPresenceManagerPrefix will be used.
Prefix string
// PresenceTTL is an interval how long to consider presence info
// valid after receiving presence update. This allows to automatically
// clean up unnecessary presence entries after TTL passed. Zero value
// means that DefaultRedisPresenceTTL will be used.
PresenceTTL time.Duration
// Shards is a list of Redis shards to use. At least one shard must be provided.
Shards []*RedisShard
}
const (
// Add/update client presence information.
// KEYS[1] - presence set key
// KEYS[2] - presence hash key
// ARGV[1] - key expire seconds
// ARGV[2] - expire at for set member
// ARGV[3] - client ID
// ARGV[4] - info payload
addPresenceSource = `
redis.call("zadd", KEYS[1], ARGV[2], ARGV[3])
redis.call("hset", KEYS[2], ARGV[3], ARGV[4])
redis.call("expire", KEYS[1], ARGV[1])
redis.call("expire", KEYS[2], ARGV[1])
`
// Remove client presence.
// KEYS[1] - presence set key
// KEYS[2] - presence hash key
// ARGV[1] - client ID
remPresenceSource = `
redis.call("hdel", KEYS[2], ARGV[1])
redis.call("zrem", KEYS[1], ARGV[1])
`
// Get presence information.
// KEYS[1] - presence set key
// KEYS[2] - presence hash key
// ARGV[1] - current timestamp in seconds
presenceSource = `
local expired = redis.call("zrangebyscore", KEYS[1], "0", ARGV[1])
if #expired > 0 then
for num = 1, #expired do
redis.call("hdel", KEYS[2], expired[num])
end
redis.call("zremrangebyscore", KEYS[1], "0", ARGV[1])
end
return redis.call("hgetall", KEYS[2])
`
)
// NewRedisPresenceManager creates new RedisPresenceManager.
func NewRedisPresenceManager(n *Node, config RedisPresenceManagerConfig) (*RedisPresenceManager, error) {
if len(config.Shards) == 0 {
return nil, errors.New("presence: no Redis shards provided in configuration")
}
if len(config.Shards) > 1 {
n.Log(NewLogEntry(LogLevelInfo, fmt.Sprintf("presence: Redis sharding enabled: %d shards", len(config.Shards))))
}
if config.Prefix == "" {
config.Prefix = DefaultRedisPresenceManagerPrefix
}
if config.PresenceTTL == 0 {
config.PresenceTTL = DefaultRedisPresenceTTL
}
m := &RedisPresenceManager{
node: n,
shards: config.Shards,
config: config,
sharding: len(config.Shards) > 1,
addPresenceScript: redis.NewScript(2, addPresenceSource),
remPresenceScript: redis.NewScript(2, remPresenceSource),
presenceScript: redis.NewScript(2, presenceSource),
}
for i := range config.Shards {
config.Shards[i].registerScripts(
m.addPresenceScript,
m.remPresenceScript,
m.presenceScript,
)
}
return m, nil
}
func (m *RedisPresenceManager) getShard(channel string) *RedisShard {
if !m.sharding {
return m.shards[0]
}
return m.shards[consistentIndex(channel, len(m.shards))]
}
// AddPresence - see PresenceManager interface description.
func (m *RedisPresenceManager) AddPresence(ch string, uid string, info *ClientInfo) error {
return m.addPresence(m.getShard(ch), ch, uid, info)
}
func (m *RedisPresenceManager) addPresence(s *RedisShard, ch string, uid string, info *ClientInfo) error {
expire := int(m.config.PresenceTTL.Seconds())
infoJSON, err := infoToProto(info).Marshal()
if err != nil {
return err
}
expireAt := time.Now().Unix() + int64(expire)
hashKey := m.presenceHashKey(s, ch)
setKey := m.presenceSetKey(s, ch)
dr := s.newDataRequest("", m.addPresenceScript, setKey, []interface{}{setKey, hashKey, expire, expireAt, uid, infoJSON})
resp := s.getDataResponse(dr)
return resp.err
}
// RemovePresence - see PresenceManager interface description.
func (m *RedisPresenceManager) RemovePresence(ch string, uid string) error {
return m.removePresence(m.getShard(ch), ch, uid)
}
func (m *RedisPresenceManager) removePresence(s *RedisShard, ch string, uid string) error {
hashKey := m.presenceHashKey(s, ch)
setKey := m.presenceSetKey(s, ch)
dr := s.newDataRequest("", m.remPresenceScript, setKey, []interface{}{setKey, hashKey, uid})
resp := s.getDataResponse(dr)
return resp.err
}
// Presence - see PresenceManager interface description.
func (m *RedisPresenceManager) Presence(ch string) (map[string]*ClientInfo, error) {
return m.presence(m.getShard(ch), ch)
}
// Presence - see PresenceManager interface description.
func (m *RedisPresenceManager) presence(s *RedisShard, ch string) (map[string]*ClientInfo, error) {
hashKey := m.presenceHashKey(s, ch)
setKey := m.presenceSetKey(s, ch)
now := int(time.Now().Unix())
dr := s.newDataRequest("", m.presenceScript, setKey, []interface{}{setKey, hashKey, now})
resp := s.getDataResponse(dr)
if resp.err != nil {
return nil, resp.err
}
return mapStringClientInfo(resp.reply, nil)
}
func mapStringClientInfo(result interface{}, err error) (map[string]*ClientInfo, error) {
values, err := redis.Values(result, err)
if err != nil {
return nil, err
}
if len(values)%2 != 0 {
return nil, errors.New("mapStringClientInfo expects even number of values result")
}
m := make(map[string]*ClientInfo, len(values)/2)
for i := 0; i < len(values); i += 2 {
key, okKey := values[i].([]byte)
value, okValue := values[i+1].([]byte)
if !okKey || !okValue {
return nil, errors.New("scanMap key not a bulk string value")
}
var f protocol.ClientInfo
err = f.Unmarshal(value)
if err != nil {
return nil, errors.New("can not unmarshal value to ClientInfo")
}
m[string(key)] = infoFromProto(&f)
}
return m, nil
}
// PresenceStats - see PresenceManager interface description.
func (m *RedisPresenceManager) PresenceStats(ch string) (PresenceStats, error) {
presence, err := m.Presence(ch)
if err != nil {
return PresenceStats{}, err
}
numClients := len(presence)
numUsers := 0
uniqueUsers := map[string]struct{}{}
for _, info := range presence {
userID := info.UserID
if _, ok := uniqueUsers[userID]; !ok {
uniqueUsers[userID] = struct{}{}
numUsers++
}
}
return PresenceStats{
NumClients: numClients,
NumUsers: numUsers,
}, nil
}
func (m *RedisPresenceManager) presenceHashKey(s *RedisShard, ch string) channelID {
if s.useCluster {
ch = "{" + ch + "}"
}
return channelID(m.config.Prefix + ".presence.data." + ch)
}
func (m *RedisPresenceManager) presenceSetKey(s *RedisShard, ch string) channelID {
if s.useCluster {
ch = "{" + ch + "}"
}
return channelID(m.config.Prefix + ".presence.expire." + ch)
}
|