knotclient: introduce CursorStore #235

merged

opened by

oppi.li 6 months ago targeting master from push-qoplqnlvlqqo

consumers can configure a cursor-store, where cursors of individual event sources are stored. the module provides an in-memory store and a redis-backed store.

Signed-off-by: oppiliappan me@oppi.li

options

unified split

Changed files

+77 -9

cmd

eventconsumer

main.go

knotclient

events.go

+11 -7

cmd/eventconsumer/main.go

···

       11
       11
        
       )

     

       12
       12
        
       

     

       13
       13
        
       func main() {

     

       14
       14
       -
       	sourcesFlag := flag.String("sources", "", "list of wss sources")

     

       14
       14
       +
       	knots := flag.String("knots", "", "list of knots to connect to")

     

       15
       15
        
       	retryFlag := flag.Duration("retry", 1*time.Minute, "retry interval")

     

       16
       16
        
       	maxRetryFlag := flag.Duration("max-retry", 30*time.Minute, "max retry interval")

     

       17
       17
        
       	workerCount := flag.Int("workers", 10, "goroutine pool size")

     

       18
       18
        
       

     

       19
       19
        
       	flag.Parse()

     

       20
       20
        
       

     

       21
       21
       -
       	if *sourcesFlag == "" {

     

       22
       22
       -
       		fmt.Println("error: -sources is required")

     

       21
       21
       +
       	if *knots == "" {

     

       22
       22
       +
       		fmt.Println("error: -knots is required")

     

       23
       23
        
       		flag.Usage()

     

       24
       24
        
       		return

     

       25
       25
        
       	}

     

       26
       26
        
       

     

       27
       27
       -
       	sources := strings.Split(*sourcesFlag, ",")

     

       27
       27
       +
       	var srcs []knotclient.EventSource

     

       28
       28
       +
       	for k := range strings.SplitSeq(*knots, ",") {

     

       29
       29
       +
       		srcs = append(srcs, knotclient.EventSource{k})

     

       30
       30
       +
       	}

     

       28
       31
        
       

     

       29
       32
        
       	consumer := knotclient.NewEventConsumer(knotclient.ConsumerConfig{

     

       30
       30
       -
       		Sources:          sources,

     

       33
       33
       +
       		Sources:          srcs,

     

       31
       34
        
       		ProcessFunc:      processEvent,

     

       32
       35
        
       		RetryInterval:    *retryFlag,

     

       33
       36
        
       		MaxRetryInterval: *maxRetryFlag,

     

       34
       37
        
       		WorkerCount:      *workerCount,

     

       38
       38
       +
       		Dev:              true,

     

       35
       39
        
       	})

     

       36
       40
        
       

     

       37
       41
        
       	ctx, cancel := context.WithCancel(context.Background())

     
···

       41
       45
        
       	consumer.Stop()

     

       42
       46
        
       }

     

       43
       47
        
       

     

       44
       44
       -
       func processEvent(source string, msg []byte) error {

     

       45
       45
       -
       	fmt.Printf("From %s: %s\n", source, string(msg))

     

       48
       48
       +
       func processEvent(source knotclient.EventSource, msg knotclient.Message) error {

     

       49
       49
       +
       	fmt.Printf("From %s (%s, %s): %s\n", source.Knot, msg.Rkey, msg.Nsid, string(msg.EventJson))

     

       46
       50
        
       	return nil

     

       47
       51
        
       }

+66 -2

knotclient/events.go

···

       3
       3
        
       import (

     

       4
       4
        
       	"context"

     

       5
       5
        
       	"encoding/json"

     

       6
       6
       +
       	"fmt"

     

       6
       7
        
       	"log/slog"

     

       7
       8
        
       	"math/rand"

     

       8
       9
        
       	"net/url"

     

       9
       10
        
       	"sync"

     

       10
       11
        
       	"time"

     

       11
       12
        
       

     

       13
       13
       +
       	"tangled.sh/tangled.sh/core/appview/cache"

     

       12
       14
        
       	"tangled.sh/tangled.sh/core/log"

     

       13
       15
        
       

     

       14
       16
        
       	"github.com/gorilla/websocket"

     
···

       20
       22
        
       	Rkey string

     

       21
       23
        
       	Nsid string

     

       22
       24
        
       	// do not full deserialize this portion of the message, processFunc can do that

     

       23
       23
       -
       	EventJson json.RawMessage

     

       25
       25
       +
       	EventJson json.RawMessage `json:"event"`

     

       24
       26
        
       }

     

       25
       27
        
       

     

       26
       28
        
       type ConsumerConfig struct {

     
···

       33
       35
        
       	QueueSize         int

     

       34
       36
        
       	Logger            *slog.Logger

     

       35
       37
        
       	Dev               bool

     

       38
       38
       +
       	CursorStore       CursorStore

     

       36
       39
        
       }

     

       37
       40
        
       

     

       38
       41
        
       type EventSource struct {

     
···

       55
       58
        
       	randSource *rand.Rand

     

       56
       59
        
       }

     

       57
       60
        
       

     

       61
       61
       +
       type CursorStore interface {

     

       62
       62
       +
       	Set(knot, cursor string)

     

       63
       63
       +
       	Get(knot string) (cursor string)

     

       64
       64
       +
       }

     

       65
       65
       +
       

     

       66
       66
       +
       type RedisCursorStore struct {

     

       67
       67
       +
       	rdb *cache.Cache

     

       68
       68
       +
       }

     

       69
       69
       +
       

     

       70
       70
       +
       func NewRedisCursorStore(cache *cache.Cache) RedisCursorStore {

     

       71
       71
       +
       	return RedisCursorStore{

     

       72
       72
       +
       		rdb: cache,

     

       73
       73
       +
       	}

     

       74
       74
       +
       }

     

       75
       75
       +
       

     

       76
       76
       +
       const (

     

       77
       77
       +
       	cursorKey = "cursor:%s"

     

       78
       78
       +
       )

     

       79
       79
       +
       

     

       80
       80
       +
       func (r *RedisCursorStore) Set(knot, cursor string) {

     

       81
       81
       +
       	key := fmt.Sprintf(cursorKey, knot)

     

       82
       82
       +
       	r.rdb.Set(context.Background(), key, cursor, 0)

     

       83
       83
       +
       }

     

       84
       84
       +
       

     

       85
       85
       +
       func (r *RedisCursorStore) Get(knot string) (cursor string) {

     

       86
       86
       +
       	key := fmt.Sprintf(cursorKey, knot)

     

       87
       87
       +
       	val, err := r.rdb.Get(context.Background(), key).Result()

     

       88
       88
       +
       	if err != nil {

     

       89
       89
       +
       		return ""

     

       90
       90
       +
       	}

     

       91
       91
       +
       

     

       92
       92
       +
       	return val

     

       93
       93
       +
       }

     

       94
       94
       +
       

     

       95
       95
       +
       type MemoryCursorStore struct {

     

       96
       96
       +
       	store sync.Map

     

       97
       97
       +
       }

     

       98
       98
       +
       

     

       99
       99
       +
       func (m *MemoryCursorStore) Set(knot, cursor string) {

     

       100
       100
       +
       	m.store.Store(knot, cursor)

     

       101
       101
       +
       }

     

       102
       102
       +
       

     

       103
       103
       +
       func (m *MemoryCursorStore) Get(knot string) (cursor string) {

     

       104
       104
       +
       	if result, ok := m.store.Load(knot); ok {

     

       105
       105
       +
       		if val, ok := result.(string); ok {

     

       106
       106
       +
       			return val

     

       107
       107
       +
       		}

     

       108
       108
       +
       	}

     

       109
       109
       +
       

     

       110
       110
       +
       	return ""

     

       111
       111
       +
       }

     

       112
       112
       +
       

     

       58
       113
        
       func (e *EventConsumer) buildUrl(s EventSource, cursor string) (*url.URL, error) {

     

       59
       114
        
       	scheme := "wss"

     

       60
       115
        
       	if e.cfg.Dev {

     
···

       98
       153
        
       	if cfg.QueueSize == 0 {

     

       99
       154
        
       		cfg.QueueSize = 100

     

       100
       155
        
       	}

     

       156
       156
       +
       	if cfg.CursorStore == nil {

     

       157
       157
       +
       		cfg.CursorStore = &MemoryCursorStore{}

     

       158
       158
       +
       	}

     

       101
       159
        
       	return &EventConsumer{

     

       102
       160
        
       		cfg:        cfg,

     

       103
       161
        
       		dialer:     websocket.DefaultDialer,

     
···

       108
       166
        
       }

     

       109
       167
        
       

     

       110
       168
        
       func (c *EventConsumer) Start(ctx context.Context) {

     

       169
       169
       +
       	c.cfg.Logger.Info("starting consumer", "config", c.cfg)

     

       170
       170
       +
       

     

       111
       171
        
       	// start workers

     

       112
       172
        
       	for range c.cfg.WorkerCount {

     

       113
       173
        
       		c.wg.Add(1)

     
···

       149
       209
        
       				c.logger.Error("error deserializing message", "source", j.source.Knot, "err", err)

     

       150
       210
        
       				return

     

       151
       211
        
       			}

     

       212
       212
       +
       

     

       213
       213
       +
       			// update cursor

     

       214
       214
       +
       			c.cfg.CursorStore.Set(j.source.Knot, msg.Rkey)

     

       215
       215
       +
       

     

       152
       216
        
       			if err := c.cfg.ProcessFunc(j.source, msg); err != nil {

     

       153
       217
        
       				c.logger.Error("error processing message", "source", j.source, "err", err)

     

       154
       218
        
       			}

     
···

       193
       257
        
       	connCtx, cancel := context.WithTimeout(ctx, c.cfg.ConnectionTimeout)

     

       194
       258
        
       	defer cancel()

     

       195
       259
        
       

     

       196
       196
       -
       	u, err := url.Parse(source)

     

       260
       260
       +
       	cursor := c.cfg.CursorStore.Get(source.Knot)

     

       197
       261
        
       

     

       198
       262
        
       	u, err := c.buildUrl(source, cursor)

     

       199
       263
        
       	if err != nil {