-
Notifications
You must be signed in to change notification settings - Fork 228
/
redis.go
476 lines (409 loc) · 9.89 KB
/
redis.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
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
package storage
import (
"bufio"
"bytes"
"context"
"errors"
"fmt"
"net"
"os"
"os/exec"
"strings"
"sync"
"syscall"
"time"
"regexp"
"github.com/contribsys/faktory/client"
"github.com/contribsys/faktory/util"
"github.com/redis/go-redis/v9"
)
type redisStore struct {
Name string
mu sync.Mutex
queueSet map[string]*redisQueue
scheduled *redisSorted
retries *redisSorted
dead *redisSorted
working *redisSorted
rclient *redis.Client
}
func NewRedisStore(name string, rclient *redis.Client) (Store, error) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
rs := &redisStore{
Name: name,
mu: sync.Mutex{},
queueSet: map[string]*redisQueue{},
rclient: rclient,
}
rs.initSorted()
vals, err := rs.rclient.SMembers(ctx, "queues").Result()
if err != nil {
return nil, err
}
for idx := range vals {
q := rs.NewQueue(vals[idx])
err := q.init(ctx)
if err != nil {
util.Warnf("Unable to initialize queue: %v", err)
continue
}
rs.queueSet[vals[idx]] = q
}
return rs, nil
}
var (
instances = map[string]*exec.Cmd{}
redisMutex = sync.Mutex{}
)
func bootRedis(path string, sock string) (func(), error) {
redisMutex.Lock()
defer redisMutex.Unlock()
if _, ok := instances[sock]; ok {
return func() {
err := stopRedis(sock)
if err != nil {
util.Error("Unable to stop Redis", err)
}
}, nil
}
util.Infof("Initializing redis storage at %s, socket %s", path, sock)
err := os.MkdirAll(path, os.ModeDir|0o755)
if err != nil {
return nil, err
}
rclient := redis.NewClient(&redis.Options{
Network: "unix",
Addr: sock,
})
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
_, err = rclient.Ping(ctx).Result()
if err != nil {
// util.Debugf("Redis not alive, booting... -- %s", err)
conffilename := "/tmp/redis.conf"
if _, err := os.Stat(conffilename); err != nil {
if err != nil && os.IsNotExist(err) {
// nolint:gosec
err := os.WriteFile("/tmp/redis.conf", []byte(fmt.Sprintf(redisconf, client.Version)), 0o444)
if err != nil {
return nil, err
}
} else {
return nil, err
}
}
binary, err := exec.LookPath("redis-server")
if err != nil {
return nil, err
}
logfile := fmt.Sprintf("%s/redis.log", path)
loglevel := "warning"
if util.LogDebug {
loglevel = "notice"
}
arguments := []string{
binary,
conffilename,
"--unixsocket",
sock,
"--loglevel",
loglevel,
"--dir",
path,
"--logfile",
logfile,
}
util.Debugf("Booting Redis: %s", strings.Join(arguments, " "))
// nolint:gosec
cmd := exec.Command(arguments[0], arguments[1:]...)
util.EnsureChildShutdown(cmd, util.SIGTERM) // platform-specific tuning
// cmd.Stdout = os.Stdout
// cmd.Stderr = os.Stderr
instances[sock] = cmd
err = cmd.Start()
if err != nil {
return nil, err
}
// wait a few seconds for Redis to start
start := time.Now()
for i := 0; i < 1000; i++ {
conn, err := net.Dial("unix", sock)
if err == nil {
conn.Close()
break
}
time.Sleep(10 * time.Millisecond)
}
done := time.Now()
util.Debugf("Redis booted in %s", done.Sub(start))
// This will panic and crash Faktory if Redis dies for some reason.
go func() {
err := cmd.Wait()
if err != nil {
util.Warnf("Redis at %s crashed: %s", path, err)
panic(err)
}
}()
}
secs := 600
for {
ctx, cancel = context.WithTimeout(context.Background(), time.Second)
_, err = rclient.Ping(ctx).Result()
cancel()
if err == nil {
break
} else if secs == 0 {
return nil, err
} else if strings.HasPrefix(err.Error(), "LOADING") {
secs -= 1
util.Info("Faktory is waiting for Redis to load...")
time.Sleep(1 * time.Second)
} else {
return nil, err
}
}
ctx, cancel = context.WithTimeout(context.Background(), time.Second)
defer cancel()
infos, err := rclient.Info(ctx).Result()
if err != nil {
return nil, err
}
version := "Unknown"
scanner := bufio.NewScanner(bytes.NewBufferString(infos))
for scanner.Scan() {
txt := scanner.Text()
if strings.Contains(txt, "redis_version") {
version = strings.Split(txt, ":")[1]
}
}
if err := scanner.Err(); err != nil {
return nil, err
}
util.Debugf("Running Redis v%s", version)
err = rclient.Close()
if err != nil {
return nil, err
}
return func() {
err := stopRedis(sock)
if err != nil {
util.Error("Unable to stop Redis", err)
}
}, nil
}
func openRedis(sock string, poolSize int) (Store, error) {
redisMutex.Lock()
defer redisMutex.Unlock()
if _, ok := instances[sock]; !ok {
return nil, errors.New("redis not booted, cannot start")
}
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
rclient := redis.NewClient(&redis.Options{
Network: "unix",
Addr: sock,
DB: 0,
PoolSize: poolSize,
})
_, err := rclient.Ping(ctx).Result()
if err != nil {
return nil, err
}
return NewRedisStore(sock, rclient)
}
func (store *redisStore) Stats(ctx context.Context) map[string]string {
return map[string]string{
"stats": store.rclient.Info(ctx).String(),
"name": store.Name,
}
}
func (store *redisStore) PausedQueues(ctx context.Context) ([]string, error) {
return store.rclient.SMembers(ctx, "paused").Result()
}
// queues are iterated in sorted, lexigraphical order
func (store *redisStore) EachQueue(ctx context.Context, x func(Queue)) {
for _, k := range store.queueSet {
x(k)
}
}
func (store *redisStore) Flush(ctx context.Context) error {
return store.rclient.FlushDB(ctx).Err()
}
var (
ValidQueueName = regexp.MustCompile(`\A[a-zA-Z0-9._-]+\z`)
)
// returns an existing, known queue or nil
func (store *redisStore) ExistingQueue(_ context.Context, name string) (Queue, bool) {
q, ok := store.queueSet[name]
return q, ok
}
// creates the queue if it doesn't already exist
func (store *redisStore) GetQueue(ctx context.Context, name string) (Queue, error) {
if name == "" {
return nil, fmt.Errorf("queue name cannot be blank")
}
store.mu.Lock()
defer store.mu.Unlock()
q, ok := store.queueSet[name]
if ok {
return q, nil
}
if !ValidQueueName.MatchString(name) {
return nil, fmt.Errorf("queue names must match %v", ValidQueueName)
}
q = store.NewQueue(name)
err := q.init(ctx)
if err != nil {
return nil, err
}
err = store.rclient.SAdd(ctx, "queues", name).Err()
if err != nil {
return nil, fmt.Errorf("Unable to store queue name: %v", err)
}
store.queueSet[name] = q
return q, nil
}
func (store *redisStore) Close() error {
util.Debug("Stopping storage")
store.mu.Lock()
defer store.mu.Unlock()
return store.rclient.Close()
}
func (store *redisStore) Redis() *redis.Client {
return store.rclient
}
func stopRedis(sock string) error {
redisMutex.Lock()
defer redisMutex.Unlock()
cmd, ok := instances[sock]
if !ok {
return errors.New("No such redis instance " + sock)
}
util.Debugf("Shutting down Redis PID %d", cmd.Process.Pid)
before := time.Now()
p := cmd.Process
pid := p.Pid
// this call frequently errs and the returned error is a string,
// not easy to build logic around and too noisy to log
// "os: process already finished"
// TODO revisit error handling in versions after Go 1.14.
_ = p.Signal(syscall.SIGTERM)
delete(instances, sock)
// Test suite hack: Redis will not exit if we
// don't give it enough time to reopen the RDB
// file before deleting the entire storage directory.
// time.Sleep(100 * time.Millisecond)
i := 500
for ; i > 0; i-- {
time.Sleep(2 * time.Millisecond)
err := syscall.Kill(pid, syscall.Signal(0))
if errors.Is(err, syscall.ESRCH) {
util.Debugf("Redis dead in %v", time.Since(before))
return nil
} else {
return err
}
}
return nil
}
func (store *redisStore) Retries() SortedSet {
return store.retries
}
func (store *redisStore) Scheduled() SortedSet {
return store.scheduled
}
func (store *redisStore) Working() SortedSet {
return store.working
}
func (store *redisStore) Dead() SortedSet {
return store.dead
}
func (store *redisStore) EnqueueAll(ctx context.Context, sset SortedSet) error {
return sset.Each(ctx, func(_ int, entry SortedEntry) error {
j, err := entry.Job()
if err != nil {
return err
}
k, err := entry.Key()
if err != nil {
return err
}
q, err := store.GetQueue(ctx, j.Queue)
if err != nil {
return err
}
ok, err := sset.Remove(ctx, k)
if err != nil {
return err
}
if !ok {
return nil
}
return q.Add(ctx, j)
})
}
func (store *redisStore) EnqueueFrom(ctx context.Context, sset SortedSet, key []byte) error {
entry, err := sset.Get(ctx, key)
if err != nil {
return err
}
if entry == nil {
// race condition, element was removed already
return nil
}
job, err := entry.Job()
if err != nil {
return err
}
q, err := store.GetQueue(ctx, job.Queue)
if err != nil {
return err
}
ok, err := sset.Remove(ctx, key)
if err != nil {
return err
}
if !ok {
return nil
}
return q.Add(ctx, job)
}
var (
Open = openRedis
Boot = bootRedis
Stop = stopRedis
)
const (
redisconf = `
# DO NOT EDIT
# Created by Faktory %s
bind 127.0.0.1 ::1
port 0
# Faktory's redis is only available via local Unix socket.
# This maximizes performance and minimizes opsec risk.
unixsocket /tmp/faktory-redis.sock
unixsocketperm 700
timeout 0
daemonize no
maxmemory-policy noeviction
# Specify the server verbosity level.
# This can be one of:
# debug (a lot of information, useful for development/testing)
# verbose (many rarely useful info, but not a mess like the debug level)
# notice (moderately verbose, what you want in production probably)
# warning (only very important / critical messages are logged)
loglevel notice
logfile /tmp/faktory-redis.log
# we're pretty aggressive on persistence to minimize data loss.
# remember you can take backups of the RDB file with a simple 'cp'.
save 120 1
save 30 5
stop-writes-on-bgsave-error yes
rdbcompression yes
rdbchecksum yes
dbfilename faktory.rdb
slowlog-log-slower-than 10000
slowlog-max-len 128
`
)