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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
|
// Copyright (c) 2014-2019 Ludovic Fauvet
// Licensed under the MIT license
package database
import (
"errors"
"fmt"
"strconv"
"strings"
"sync"
"time"
. "github.com/etix/mirrorbits/config"
"github.com/etix/mirrorbits/core"
"github.com/gomodule/redigo/redis"
"github.com/rafaeljusto/redigomock"
)
const (
redisConnectionTimeout = 200 * time.Millisecond
redisReadWriteTimeout = 300 * time.Second
)
var (
// ErrUnreachable is returned when the endpoint is not reachable
ErrUnreachable = errors.New("redis endpoint unreachable")
)
type redisPool interface {
Get() redis.Conn
Close() error
}
// Redis is the instance object of the redis database
type Redis struct {
pool redisPool
Pubsub *Pubsub
failure bool
failureState sync.RWMutex
knownMaster string
knownMasterLock sync.Mutex
stop chan bool
ready chan struct{}
version string
}
// NewRedis returns a new instance of the redis database
func NewRedis() *Redis {
r := NewRedisCustomPool(nil)
// Asynchronous db update handler
go r.dbUpdateHandler()
return r
}
// NewRedisCustomPool returns a new instance of the redis database
// using a custom pool
func NewRedisCustomPool(pool redisPool) *Redis {
r := &Redis{
stop: make(chan bool),
ready: make(chan struct{}),
}
if pool != nil {
// Check if we are running inside `go test`
if _, ok := pool.Get().(*redigomock.Conn); ok {
// Close ready since we are running a mock
close(r.ready)
}
r.pool = pool
} else {
r.pool = &redis.Pool{
MaxIdle: 10,
IdleTimeout: 240 * time.Second,
Dial: func() (redis.Conn, error) {
conn, err := r.Connect()
switch err {
case nil:
r.setFailureState(false)
default:
r.setFailureState(true)
}
if r.version != "" && ! r.IsAtLeastVersion(core.RedisMinimumVersion) {
log.Fatalf("Unsupported Redis version, please upgrade to Redis >= %s", core.RedisMinimumVersion)
}
return conn, err
},
TestOnBorrow: func(c redis.Conn, t time.Time) error {
_, err := c.Do("PING")
if RedisIsLoading(err) {
return nil
}
return err
},
}
}
go r.connRecover()
return r
}
// Get returns a redis connection from the pool
func (r *Redis) Get() redis.Conn {
select {
case <-r.ready:
default:
return &NotReadyError{}
}
return r.pool.Get()
}
// UnblockedGet returns a redis connection from the pool even
// if the database checks and/or upgrade are not finished.
func (r *Redis) UnblockedGet() redis.Conn {
return r.pool.Get()
}
// Close closes all connections to the redis database
func (r *Redis) Close() {
select {
case _, _ = <-r.stop:
return
default:
log.Debug("Closing databases connections")
r.Pubsub.Close()
r.pool.Close()
close(r.stop)
}
}
// ConnectPubsub initiates the connection to the pubsub
func (r *Redis) ConnectPubsub() {
if r.Pubsub == nil {
r.Pubsub = NewPubsub(r)
}
}
func (r *Redis) IsAtLeastVersion(version string) bool {
return parseVersion(r.version) >= parseVersion(version)
}
func (r *Redis) askVersion (conn redis.Conn) (string, error) {
if conn == nil {
return "", ErrUnreachable
}
info, err := parseInfo(conn.Do("INFO", "server"))
if err != nil {
return "", err
}
return info["redis_version"], nil
}
// Connect initiates a new connection to the redis server
func (r *Redis) Connect() (redis.Conn, error) {
sentinels := GetConfig().RedisSentinels
if len(sentinels) > 0 {
if len(GetConfig().RedisSentinelMasterName) == 0 {
r.logError("Config: RedisSentinelMasterName cannot be empty!")
goto single
}
for _, s := range sentinels {
log.Debugf("Connecting to redis sentinel %s", s.Host)
var master []string
var masterhost string
var cm redis.Conn
c, err := r.connectTo(s.Host)
if err != nil {
r.logError("Sentinel: %s", err.Error())
continue
}
//AUTH?
role, err := r.askRole(c)
if err != nil {
r.logError("Sentinel: %s", err.Error())
goto closeSentinel
}
if role != "sentinel" {
r.logError("Sentinel: %s is not a sentinel but a %s", s.Host, role)
goto closeSentinel
}
master, err = redis.Strings(c.Do("SENTINEL", "get-master-addr-by-name", GetConfig().RedisSentinelMasterName))
if err == redis.ErrNil {
r.logError("Sentinel: %s doesn't know the master-name %s", s.Host, GetConfig().RedisSentinelMasterName)
goto closeSentinel
} else if err != nil {
r.logError("Sentinel: %s", err.Error())
goto closeSentinel
}
masterhost = fmt.Sprintf("%s:%s", master[0], master[1])
cm, err = r.connectTo(masterhost)
if err != nil {
r.logError("Redis master: %s", err.Error())
goto closeSentinel
}
if r.auth(cm) != nil {
r.logError("Redis master: auth failed")
goto closeMaster
}
if err = r.selectDB(cm); err != nil {
c.Close()
return nil, err
}
role, err = r.askRole(cm)
if err != nil {
r.logError("Redis master: %s", err.Error())
goto closeMaster
}
if role != "master" {
r.logError("Redis master: %s is not a master but a %s", masterhost, role)
goto closeMaster
}
// Close the connection to the sentinel
c.Close()
r.printConnectedMaster(masterhost)
return cm, nil
closeMaster:
cm.Close()
closeSentinel:
c.Close()
}
}
single:
if len(GetConfig().RedisAddress) == 0 {
if len(sentinels) == 0 {
log.Error("No redis master available")
}
return nil, ErrUnreachable
}
if len(sentinels) > 0 && r.Failure() == false {
log.Warning("No redis master available, trying using the configured RedisAddress as fallback")
}
c, err := r.connectTo(GetConfig().RedisAddress)
if err != nil {
return nil, err
}
if err = r.auth(c); err != nil {
c.Close()
return nil, err
}
if err = r.selectDB(c); err != nil {
c.Close()
return nil, err
}
role, err := r.askRole(c)
if err != nil {
r.logError("Redis master: %s", err.Error())
return nil, ErrUnreachable
}
if role != "master" {
r.logError("Redis master: %s is not a master but a %s", GetConfig().RedisAddress, role)
return nil, ErrUnreachable
}
r.version, err = r.askVersion(c)
r.printConnectedMaster(GetConfig().RedisAddress)
return c, err
}
func (r *Redis) connectTo(address string) (redis.Conn, error) {
return redis.Dial("tcp", address,
redis.DialConnectTimeout(redisConnectionTimeout),
redis.DialReadTimeout(redisReadWriteTimeout),
redis.DialWriteTimeout(redisReadWriteTimeout))
}
func (r *Redis) askRole(c redis.Conn) (string, error) {
roleReply, err := redis.Values(c.Do("ROLE"))
if err != nil {
return "", err
}
role, err := redis.String(roleReply[0], err)
return role, err
}
func (r *Redis) auth(c redis.Conn) (err error) {
if GetConfig().RedisPassword != "" {
_, err = c.Do("AUTH", GetConfig().RedisPassword)
}
return
}
func (r *Redis) selectDB(c redis.Conn) (err error) {
_, err = c.Do("SELECT", GetConfig().RedisDB)
return
}
func (r *Redis) logError(format string, args ...interface{}) {
if r.Failure() {
log.Debugf(format, args...)
} else {
log.Errorf(format, args...)
}
}
func (r *Redis) printConnectedMaster(address string) {
r.knownMasterLock.Lock()
defer r.knownMasterLock.Unlock()
if address != r.knownMaster && core.Daemon {
r.knownMaster = address
log.Infof("Connected to redis master %s (version %s)", address, r.version)
} else {
log.Debugf("Connected to redis master %s (version %s)", address, r.version)
}
}
func (r *Redis) setFailureState(failure bool) {
r.failureState.Lock()
r.failure = failure
r.failureState.Unlock()
}
// Failure returns true if the connection is in a failure state
func (r *Redis) Failure() bool {
r.failureState.RLock()
defer r.failureState.RUnlock()
return r.failure
}
func (r *Redis) connRecover() {
ticker := time.NewTicker(1 * time.Second)
for {
select {
case <-r.stop:
return
case <-ticker.C:
if r.Failure() {
if conn := r.Get(); conn != nil {
// A successful Get() request will automatically unlock
// other services waiting for a working connection.
// This is only a way to ensure they wont wait forever.
if conn.Err() != nil {
log.Warningf("Database is down: %s", conn.Err().Error())
}
conn.Close()
}
}
}
}
}
func (r *Redis) dbUpdateHandler() {
var logOnce sync.Once
again:
upneeded, err := r.UpgradeNeeded()
if err != nil {
time.Sleep(100 * time.Millisecond)
goto again
}
if upneeded {
t := time.Now()
err = r.Upgrade()
if err == ErrAlreadyLocked {
logOnce.Do(func() {
log.Warning("Database upgrade running. Waiting for completion...")
})
time.Sleep(100 * time.Millisecond)
goto again
} else if err != nil {
log.Fatalf("Upgrade failed: %+v", err)
}
log.Infof("Database upgrade successful (took %s), starting normally", time.Since(t).Round(time.Millisecond))
}
close(r.ready)
}
// RedisIsLoading returns true if the error is of type LOADING
func RedisIsLoading(err error) bool {
// PARSING: "LOADING Redis is loading the dataset in memory"
if err != nil && strings.HasPrefix(err.Error(), "LOADING") {
return true
}
return false
}
func parseVersion(version string) int64 {
// We suppport up to 3 components (major, minor, patch) in the version
s := strings.Split(version, ".")
for len(s) < 3 {
s = append(s, "0")
}
format := fmt.Sprintf("%%s%%0%ds", 2)
var v string
for _, value := range s {
v = fmt.Sprintf(format, v, value)
}
var result int64
var err error
if result, err = strconv.ParseInt(v, 10, 64); err != nil {
return -1
}
return result
}
func parseInfo(i interface{}, err error) (map[string]string, error) {
v, err := redis.String(i, err)
if err != nil {
return nil, err
}
m := make(map[string]string)
lines := strings.Split(v, "\r\n")
for _, l := range lines {
if strings.HasPrefix(l, "#") {
continue
}
kv := strings.SplitN(l, ":", 2)
if len(kv) < 2 {
continue
}
m[kv[0]] = kv[1]
}
return m, nil
}
|