-
Notifications
You must be signed in to change notification settings - Fork 5
/
kvclient.go
403 lines (335 loc) · 12.5 KB
/
kvclient.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
package gocbcorex
import (
"context"
"crypto/tls"
"errors"
"net"
"strconv"
"sync"
"sync/atomic"
"github.com/google/uuid"
"go.opentelemetry.io/otel/metric"
"go.uber.org/zap"
"golang.org/x/exp/slices"
"github.com/couchbase/gocbcorex/contrib/ptr"
"github.com/couchbase/gocbcorex/memdx"
)
type GetMemdxClientFunc func(opts *memdx.ClientOptions) MemdxDispatcherCloser
type KvClientConfig struct {
Address string
TlsConfig *tls.Config
ClientName string
Authenticator Authenticator
SelectedBucket string
DisableDefaultFeatures bool
DisableErrorMap bool
// DisableBootstrap provides a simple way to validate that all bootstrapping
// is disabled on the client, mainly used for testing.
DisableBootstrap bool
}
func (o KvClientConfig) Equals(b *KvClientConfig) bool {
return o.Address == b.Address &&
o.TlsConfig == b.TlsConfig &&
o.ClientName == b.ClientName &&
o.Authenticator == b.Authenticator &&
o.SelectedBucket == b.SelectedBucket &&
o.DisableDefaultFeatures == b.DisableDefaultFeatures &&
o.DisableErrorMap == b.DisableErrorMap &&
o.DisableBootstrap == b.DisableBootstrap
}
type KvClientOptions struct {
Logger *zap.Logger
NewMemdxClient GetMemdxClientFunc
CloseHandler func(KvClient, error)
}
type KvClientOps interface {
GetCollectionID(ctx context.Context, req *memdx.GetCollectionIDRequest) (*memdx.GetCollectionIDResponse, error)
GetClusterConfig(ctx context.Context, req *memdx.GetClusterConfigRequest) (*memdx.GetClusterConfigResponse, error)
Get(ctx context.Context, req *memdx.GetRequest) (*memdx.GetResponse, error)
Set(ctx context.Context, req *memdx.SetRequest) (*memdx.SetResponse, error)
Delete(ctx context.Context, req *memdx.DeleteRequest) (*memdx.DeleteResponse, error)
GetAndLock(ctx context.Context, req *memdx.GetAndLockRequest) (*memdx.GetAndLockResponse, error)
GetAndTouch(ctx context.Context, req *memdx.GetAndTouchRequest) (*memdx.GetAndTouchResponse, error)
GetReplica(ctx context.Context, req *memdx.GetReplicaRequest) (*memdx.GetReplicaResponse, error)
GetRandom(ctx context.Context, req *memdx.GetRandomRequest) (*memdx.GetRandomResponse, error)
Unlock(ctx context.Context, req *memdx.UnlockRequest) (*memdx.UnlockResponse, error)
Touch(ctx context.Context, req *memdx.TouchRequest) (*memdx.TouchResponse, error)
Add(ctx context.Context, req *memdx.AddRequest) (*memdx.AddResponse, error)
Replace(ctx context.Context, req *memdx.ReplaceRequest) (*memdx.ReplaceResponse, error)
Append(ctx context.Context, req *memdx.AppendRequest) (*memdx.AppendResponse, error)
Prepend(ctx context.Context, req *memdx.PrependRequest) (*memdx.PrependResponse, error)
Increment(ctx context.Context, req *memdx.IncrementRequest) (*memdx.IncrementResponse, error)
Decrement(ctx context.Context, req *memdx.DecrementRequest) (*memdx.DecrementResponse, error)
GetMeta(ctx context.Context, req *memdx.GetMetaRequest) (*memdx.GetMetaResponse, error)
SetMeta(ctx context.Context, req *memdx.SetMetaRequest) (*memdx.SetMetaResponse, error)
DeleteMeta(ctx context.Context, req *memdx.DeleteMetaRequest) (*memdx.DeleteMetaResponse, error)
LookupIn(ctx context.Context, req *memdx.LookupInRequest) (*memdx.LookupInResponse, error)
MutateIn(ctx context.Context, req *memdx.MutateInRequest) (*memdx.MutateInResponse, error)
RangeScanCreate(ctx context.Context, req *memdx.RangeScanCreateRequest) (*memdx.RangeScanCreateResponse, error)
RangeScanContinue(ctx context.Context, req *memdx.RangeScanContinueRequest,
dataCb func(*memdx.RangeScanDataResponse) error) (*memdx.RangeScanActionResponse, error)
RangeScanCancel(ctx context.Context, req *memdx.RangeScanCancelRequest) (*memdx.RangeScanCancelResponse, error)
}
// KvClient implements a synchronous wrapper around a memdx.Client.
type KvClient interface {
// Reconfigure reconfigures this KvClient to a new state.
Reconfigure(config *KvClientConfig, cb func(error)) error
HasFeature(feat memdx.HelloFeature) bool
Close() error
LoadFactor() float64
RemoteHostPort() (string, string, int)
LocalHostPort() (string, int)
KvClientOps
}
type MemdxDispatcherCloser interface {
memdx.Dispatcher
Close() error
}
type kvClient struct {
logger *zap.Logger
remoteHostName string
remoteHost string
remotePort int
localHost string
localPort int
pendingOperations uint64
cli MemdxDispatcherCloser
durationMetric metric.Float64Histogram
lock sync.Mutex
currentConfig KvClientConfig
supportedFeatures []memdx.HelloFeature
// selectedBucket atomically stores the currently selected bucket,
// so that we can use it in our errors. Note that it is set before
// we send the operation to select the bucket, since things happen
// asynchronously and we do not support changing selected buckets.
selectedBucket atomic.Pointer[string]
closed uint32
closeHandler func(KvClient, error)
}
var _ KvClient = (*kvClient)(nil)
func NewKvClient(ctx context.Context, config *KvClientConfig, opts *KvClientOptions) (*kvClient, error) {
parseHostPort := func(addr string) (string, int) {
host, portStr, _ := net.SplitHostPort(addr)
parsedPort, _ := strconv.ParseInt(portStr, 10, 64)
return host, int(parsedPort)
}
logger := loggerOrNop(opts.Logger)
// We namespace the pool to improve debugging,
logger = logger.With(
zap.String("clientId", uuid.NewString()[:8]),
)
remoteHostName, remotePort := parseHostPort(config.Address)
durationMetric, err := meter.Float64Histogram("db.client.operation.duration",
metric.WithExplicitBucketBoundaries(0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10))
if err != nil {
logger.Warn("failed to create operation duration metric")
}
kvCli := &kvClient{
currentConfig: *config,
remoteHostName: remoteHostName,
remotePort: remotePort,
logger: logger,
closeHandler: opts.CloseHandler,
durationMetric: durationMetric,
}
logger.Debug("id assigned for " + config.Address)
var requestedFeatures []memdx.HelloFeature
if !config.DisableDefaultFeatures {
requestedFeatures = []memdx.HelloFeature{
memdx.HelloFeatureDatatype,
memdx.HelloFeatureSeqNo,
memdx.HelloFeatureXattr,
memdx.HelloFeatureXerror,
memdx.HelloFeatureSnappy,
memdx.HelloFeatureJSON,
memdx.HelloFeatureUnorderedExec,
memdx.HelloFeatureDurations,
memdx.HelloFeaturePreserveExpiry,
memdx.HelloFeatureSyncReplication,
memdx.HelloFeatureReplaceBodyWithXattr,
memdx.HelloFeatureSelectBucket,
memdx.HelloFeatureCreateAsDeleted,
memdx.HelloFeatureAltRequests,
memdx.HelloFeatureCollections,
}
}
var bootstrapHello *memdx.HelloRequest
if config.ClientName != "" || len(requestedFeatures) > 0 {
bootstrapHello = &memdx.HelloRequest{
ClientName: []byte(config.ClientName),
RequestedFeatures: requestedFeatures,
}
}
var bootstrapGetErrorMap *memdx.GetErrorMapRequest
if !config.DisableErrorMap {
bootstrapGetErrorMap = &memdx.GetErrorMapRequest{
Version: 2,
}
}
var bootstrapAuth *memdx.SaslAuthAutoOptions
if config.Authenticator != nil {
username, password, err := config.Authenticator.GetCredentials(ServiceTypeMemd, config.Address)
if err != nil {
return nil, err
}
bootstrapAuth = &memdx.SaslAuthAutoOptions{
Username: username,
Password: password,
EnabledMechs: []memdx.AuthMechanism{
memdx.ScramSha512AuthMechanism,
memdx.ScramSha256AuthMechanism},
}
}
var bootstrapSelectBucket *memdx.SelectBucketRequest
if config.SelectedBucket != "" {
bootstrapSelectBucket = &memdx.SelectBucketRequest{
BucketName: config.SelectedBucket,
}
}
shouldBootstrap := bootstrapHello != nil || bootstrapAuth != nil || bootstrapGetErrorMap != nil
if shouldBootstrap && config.DisableBootstrap {
return nil, errors.New("bootstrap was disabled but options requiring bootstrap were specified")
}
memdxClientOpts := &memdx.ClientOptions{
OrphanHandler: kvCli.handleOrphanResponse,
CloseHandler: kvCli.handleConnectionClose,
Logger: logger,
}
if opts.NewMemdxClient == nil {
conn, err := memdx.DialConn(ctx, config.Address, &memdx.DialConnOptions{TLSConfig: config.TlsConfig})
if err != nil {
return nil, err
}
kvCli.cli = memdx.NewClient(conn, memdxClientOpts)
} else {
kvCli.cli = opts.NewMemdxClient(memdxClientOpts)
}
remoteHost, _ := parseHostPort(kvCli.cli.RemoteAddr())
localHost, localPort := parseHostPort(kvCli.cli.LocalAddr())
kvCli.remoteHost = remoteHost
kvCli.localHost = localHost
kvCli.localPort = localPort
if shouldBootstrap {
if bootstrapSelectBucket != nil {
kvCli.selectedBucket.Store(ptr.To(bootstrapSelectBucket.BucketName))
}
kvCli.logger.Debug("bootstrapping")
res, err := kvCli.bootstrap(ctx, &memdx.BootstrapOptions{
Hello: bootstrapHello,
GetErrorMap: bootstrapGetErrorMap,
Auth: bootstrapAuth,
SelectBucket: bootstrapSelectBucket,
GetClusterConfig: nil,
})
if err != nil {
kvCli.logger.Debug("bootstrap failed", zap.Error(err))
if closeErr := kvCli.Close(); closeErr != nil {
kvCli.logger.Debug("failed to close connection for KvClient", zap.Error(closeErr))
}
return nil, contextualError{
Message: "failed to bootstrap",
Cause: err,
}
}
if res.Hello != nil {
kvCli.supportedFeatures = res.Hello.EnabledFeatures
}
kvCli.logger.Debug("successfully bootstrapped new KvClient",
zap.Stringers("features", kvCli.supportedFeatures))
} else {
kvCli.logger.Debug("skipped bootstrapping new KvClient")
}
return kvCli, nil
}
func (c *kvClient) Reconfigure(config *KvClientConfig, cb func(error)) error {
if config == nil {
return errors.New("must specify a configuration to reconfigure to")
}
c.lock.Lock()
defer c.lock.Unlock()
c.logger.Debug("reconfiguring")
if c.currentConfig.Address != config.Address ||
c.currentConfig.TlsConfig != config.TlsConfig ||
c.currentConfig.ClientName != config.ClientName ||
c.currentConfig.Authenticator != config.Authenticator ||
c.currentConfig.DisableDefaultFeatures != config.DisableDefaultFeatures ||
c.currentConfig.DisableErrorMap != config.DisableErrorMap ||
c.currentConfig.DisableBootstrap != config.DisableBootstrap {
// pretty much everything triggers a reconfigure
return errors.New("cannot reconfigure due to conflicting options")
}
var selectBucketName string
if config.SelectedBucket != c.currentConfig.SelectedBucket {
if c.currentConfig.SelectedBucket != "" {
return errors.New("cannot reconfigure from one selected bucket to another")
}
// because we only support going from no selected bucket to a selected
// bucket, we simply update the state here and nobody will be permitted to
// reconfigure unless it fails and set its back to no selected bucket.
c.currentConfig.SelectedBucket = config.SelectedBucket
selectBucketName = config.SelectedBucket
}
if !c.currentConfig.Equals(config) {
return errors.New("client config after reconfigure did not match new configuration")
}
go func() {
if selectBucketName != "" {
c.selectedBucket.Store(ptr.To(selectBucketName))
_, err := c.SelectBucket(context.Background(), &memdx.SelectBucketRequest{
BucketName: selectBucketName,
})
if err != nil {
c.lock.Lock()
c.currentConfig.SelectedBucket = ""
c.selectedBucket.Store(ptr.To(""))
c.lock.Unlock()
cb(err)
return
}
}
cb(nil)
}()
return nil
}
func (c *kvClient) HasFeature(feat memdx.HelloFeature) bool {
return slices.Contains(c.supportedFeatures, feat)
}
func (c *kvClient) Close() error {
c.logger.Info("closing")
if !atomic.CompareAndSwapUint32(&c.closed, 0, 1) {
c.logger.Debug("already closed")
return nil
}
return c.cli.Close()
}
func (c *kvClient) LoadFactor() float64 {
return (float64)(atomic.LoadUint64(&c.pendingOperations))
}
func (c *kvClient) RemoteHostPort() (string, string, int) {
return c.remoteHostName, c.remoteHost, c.remotePort
}
func (c *kvClient) LocalHostPort() (string, int) {
return c.localHost, c.localPort
}
func (c *kvClient) SelectedBucket() string {
bucketNamePtr := c.selectedBucket.Load()
if bucketNamePtr != nil {
return *bucketNamePtr
}
return ""
}
func (c *kvClient) handleOrphanResponse(packet *memdx.Packet) {
c.logger.Info(
"orphaned response encountered",
zap.String("opaque", strconv.Itoa(int(packet.Opaque))),
zap.String("opcode", packet.OpCode.String()),
)
}
func (c *kvClient) handleConnectionClose(err error) {
// Just mark ourselves as closed. The connection is already
// closed so there's no actual work to do, and we might already actually be closed.
atomic.StoreUint32(&c.closed, 1)
if c.closeHandler != nil {
c.closeHandler(c, err)
}
}