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
|
package kv
import (
"fmt"
endure "github.com/spiral/endure/pkg/container"
"github.com/spiral/errors"
"github.com/spiral/roadrunner/v2/common/kv"
"github.com/spiral/roadrunner/v2/plugins/config"
"github.com/spiral/roadrunner/v2/plugins/logger"
)
// PluginName linked to the memory, boltdb, memcached, redis plugins. DO NOT change w/o sync.
const PluginName string = "kv"
const (
// driver is the mandatory field which should present in every storage
driver string = "driver"
memcached string = "memcached"
boltdb string = "boltdb"
redis string = "redis"
memory string = "memory"
)
// Plugin for the unified storage
type Plugin struct {
log logger.Logger
// constructors contains general storage constructors, such as boltdb, memory, memcached, redis.
constructors map[string]kv.Constructor
// storages contains user-defined storages, such as boltdb-north, memcached-us and so on.
storages map[string]kv.Storage
// KV configuration
cfg Config
cfgPlugin config.Configurer
}
func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error {
const op = errors.Op("kv_plugin_init")
if !cfg.Has(PluginName) {
return errors.E(errors.Disabled)
}
err := cfg.UnmarshalKey(PluginName, &p.cfg.Data)
if err != nil {
return errors.E(op, err)
}
p.constructors = make(map[string]kv.Constructor, 5)
p.storages = make(map[string]kv.Storage, 5)
p.log = log
p.cfgPlugin = cfg
return nil
}
func (p *Plugin) Serve() chan error { //nolint:gocognit
errCh := make(chan error, 1)
const op = errors.Op("kv_plugin_serve")
// key - storage name in the config
// value - storage
/*
For example we can have here 2 storages (but they are not pre-configured)
for the boltdb and memcached
We should provide here the actual configs for the all requested storages
kv:
boltdb-south:
driver: boltdb
dir: "tests/rr-bolt"
file: "rr.db"
bucket: "rr"
permissions: 777
ttl: 40s
boltdb-north:
driver: boltdb
dir: "tests/rr-bolt"
file: "rr.db"
bucket: "rr"
permissions: 777
ttl: 40s
memcached:
driver: memcached
addr: [ "127.0.0.1:11211" ]
For this config we should have 3 constructors: memory, boltdb and memcached but 4 KVs: default, boltdb-south, boltdb-north and memcached
when user requests for example boltdb-south, we should provide that particular preconfigured storage
*/
for k, v := range p.cfg.Data {
// for example if the key not properly formatted (yaml)
if v == nil {
continue
}
// check type of the v
// should be a map[string]interface{}
switch t := v.(type) {
// correct type
case map[string]interface{}:
if _, ok := t[driver]; !ok {
errCh <- errors.E(op, errors.Errorf("could not find mandatory driver field in the %s storage", k))
return errCh
}
default:
p.log.Warn("wrong type detected in the configuration, please, check yaml indentation")
continue
}
// config key for the particular sub-driver kv.memcached
configKey := fmt.Sprintf("%s.%s", PluginName, k)
// at this point we know, that driver field present in the configuration
// TODO(rustatian): refactor, made generic, with checks like in the broadcast, websockets or jobs
switch v.(map[string]interface{})[driver] {
case memcached:
if _, ok := p.constructors[memcached]; !ok {
p.log.Warn("no memcached constructors registered", "registered", p.constructors)
continue
}
storage, err := p.constructors[memcached].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
case boltdb:
if _, ok := p.constructors[boltdb]; !ok {
p.log.Warn("no boltdb constructors registered", "registered", p.constructors)
continue
}
storage, err := p.constructors[boltdb].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
case memory:
if _, ok := p.constructors[memory]; !ok {
p.log.Warn("no in-memory constructors registered", "registered", p.constructors)
continue
}
storage, err := p.constructors[memory].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
case redis:
if _, ok := p.constructors[redis]; !ok {
p.log.Warn("no redis constructors registered", "registered", p.constructors)
continue
}
// first - try local configuration
switch {
case p.cfgPlugin.Has(configKey):
storage, err := p.constructors[redis].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
case p.cfgPlugin.Has(redis):
storage, err := p.constructors[redis].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
continue
default:
// otherwise - error, no local or global config
p.log.Warn("no global or local redis configuration provided", "key", configKey)
continue
}
default:
p.log.Error("unknown storage", errors.E(op, errors.Errorf("unknown storage %s", v.(map[string]interface{})[driver])))
}
}
return errCh
}
func (p *Plugin) Stop() error {
return nil
}
// Collects will get all plugins which implement Storage interface
func (p *Plugin) Collects() []interface{} {
return []interface{}{
p.GetAllStorageDrivers,
}
}
func (p *Plugin) GetAllStorageDrivers(name endure.Named, constructor kv.Constructor) {
// save the storage constructor
p.constructors[name.Name()] = constructor
}
// RPC returns associated rpc service.
func (p *Plugin) RPC() interface{} {
return &rpc{srv: p, log: p.log, storages: p.storages}
}
func (p *Plugin) Name() string {
return PluginName
}
// Available interface implementation
func (p *Plugin) Available() {}
|
