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
|
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"
)
const (
// PluginName linked to the memory, boltdb, memcached, redis plugins. DO NOT change w/o sync.
PluginName string = "kv"
// driver is the mandatory field which should present in every storage
driver string = "driver"
// config key used to detect local configuration for the driver
cfg string = "config"
)
// 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 {
errCh := make(chan error, 1)
const op = errors.Op("kv_plugin_serve")
// key - storage name in the config
// value - storage
// 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.config
configKey := fmt.Sprintf("%s.%s.%s", PluginName, k, cfg)
// at this point we know, that driver field present in the configuration
drName := v.(map[string]interface{})[driver]
// driver name should be a string
if drStr, ok := drName.(string); ok {
switch {
// local configuration section key
case p.cfgPlugin.Has(configKey):
if _, ok := p.constructors[drStr]; !ok {
p.log.Warn("no constructors registered", "requested constructor", drStr, "registered", p.constructors)
continue
}
storage, err := p.constructors[drStr].KVConstruct(configKey)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
// try global then
case p.cfgPlugin.Has(k):
if _, ok := p.constructors[drStr]; !ok {
p.log.Warn("no constructors registered", "requested constructor", drStr, "registered", p.constructors)
continue
}
// use only key for the driver registration, for example rr-boltdb should be globally available
storage, err := p.constructors[drStr].KVConstruct(k)
if err != nil {
errCh <- errors.E(op, err)
return errCh
}
// save the storage
p.storages[k] = storage
default:
p.log.Error("can't find local or global configuration, this section will be skipped", "local: ", configKey, "global: ", k)
continue
}
}
continue
}
return errCh
}
func (p *Plugin) Stop() error {
// stop all attached storages
for k := range p.storages {
p.storages[k].Stop()
}
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() {}
|
