/
goredisstore.go
140 lines (116 loc) · 3.94 KB
/
goredisstore.go
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
// Package goredisstore offers Redis-based store implementation for throttled using go-redis.
package goredisstore // import "github.com/throttled/throttled/store/goredisstore"
import (
"context"
"strings"
"time"
"github.com/go-redis/redis"
)
const (
redisCASMissingKey = "key does not exist"
redisCASScript = `
local v = redis.call('get', KEYS[1])
if v == false then
return redis.error_reply("key does not exist")
end
if v ~= ARGV[1] then
return 0
end
redis.call('setex', KEYS[1], ARGV[3], ARGV[2])
return 1
`
)
// GoRedisStore implements a Redis-based store using go-redis.
type GoRedisStore struct {
client *redis.Client
prefix string
}
// New creates a new Redis-based store, using the provided pool to get
// its connections. The keys will have the specified keyPrefix, which
// may be an empty string, and the database index specified by db will
// be selected to store the keys. Any updating operations will reset
// the key TTL to the provided value rounded down to the nearest
// second. Depends on Redis 2.6+ for EVAL support.
func New(client *redis.Client, keyPrefix string) (*GoRedisStore, error) {
return &GoRedisStore{
client: client,
prefix: keyPrefix,
}, nil
}
// GetWithTime returns the value of the key if it is in the store
// or -1 if it does not exist. It also returns the current time at
// the redis server to microsecond precision.
func (r *GoRedisStore) GetWithTime(key string) (int64, time.Time, error) {
// TODO: Throttled should probably provide a Context-based version of its
// API.
context := context.Background()
key = r.prefix + key
pipe := r.client.Pipeline()
timeCmd := pipe.Time(context)
getKeyCmd := pipe.Get(context, key)
_, err := pipe.Exec(context)
now, err := timeCmd.Result()
if err != nil {
return 0, now, err
}
v, err := getKeyCmd.Int64()
if err == redis.Nil {
return -1, now, nil
} else if err != nil {
return 0, now, err
}
return v, now, nil
}
// SetIfNotExistsWithTTL sets the value of key only if it is not
// already set in the store it returns whether a new value was set.
// If a new value was set, the ttl in the key is also set, though this
// operation is not performed atomically.
func (r *GoRedisStore) SetIfNotExistsWithTTL(key string, value int64, ttl time.Duration) (bool, error) {
// TODO: Throttled should probably provide a Context-based version of its
// API.
context := context.Background()
key = r.prefix + key
updated, err := r.client.SetNX(context, key, value, 0).Result()
if err != nil {
return false, err
}
// An `EXPIRE 0` will delete the key immediately, so make sure that we set
// expiry for a minimum of one second out so that our results stay in the
// store.
if ttl < 1*time.Second {
ttl = 1 * time.Second
}
err = r.client.Expire(context, key, ttl).Err()
return updated, err
}
// CompareAndSwapWithTTL atomically compares the value at key to the
// old value. If it matches, it sets it to the new value and returns
// true. Otherwise, it returns false. If the key does not exist in the
// store, it returns false with no error. If the swap succeeds, the
// ttl for the key is updated atomically.
func (r *GoRedisStore) CompareAndSwapWithTTL(key string, old, new int64, ttl time.Duration) (bool, error) {
// TODO: Throttled should probably provide a Context-based version of its
// API.
context := context.Background()
key = r.prefix + key
ttlSeconds := int(ttl.Seconds())
// An `EXPIRE 0` will delete the key immediately, so make sure that we set
// expiry for a minimum of one second out so that our results stay in the
// store.
if ttlSeconds < 1 {
ttlSeconds = 1
}
// result will be 0 or 1
result, err := r.client.Eval(context, redisCASScript, []string{key}, old, new, ttlSeconds).Result()
var swapped bool
if s, ok := result.(int64); ok {
swapped = s == 1
} // if not ok, zero value of swapped is false.
if err != nil {
if strings.Contains(err.Error(), redisCASMissingKey) {
return false, nil
}
return false, err
}
return swapped, nil
}