forked from hyperledger/fabric
-
Notifications
You must be signed in to change notification settings - Fork 0
/
statecouchdb.go
492 lines (386 loc) · 14.7 KB
/
statecouchdb.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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/*
Copyright IBM Corp. 2016, 2017 All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package statecouchdb
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"strconv"
"strings"
"sync"
"unicode/utf8"
"github.com/hyperledger/fabric/common/flogging"
"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb"
"github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/version"
"github.com/hyperledger/fabric/core/ledger/ledgerconfig"
"github.com/hyperledger/fabric/core/ledger/util/couchdb"
)
var logger = flogging.MustGetLogger("statecouchdb")
var compositeKeySep = []byte{0x00}
var lastKeyIndicator = byte(0x01)
var binaryWrapper = "valueBytes"
//querySkip is implemented for future use by query paging
//currently defaulted to 0 and is not used
var querySkip = 0
// VersionedDBProvider implements interface VersionedDBProvider
type VersionedDBProvider struct {
couchInstance *couchdb.CouchInstance
databases map[string]*VersionedDB
mux sync.Mutex
openCounts uint64
}
// NewVersionedDBProvider instantiates VersionedDBProvider
func NewVersionedDBProvider() (*VersionedDBProvider, error) {
logger.Debugf("constructing CouchDB VersionedDBProvider")
couchDBDef := couchdb.GetCouchDBDefinition()
couchInstance, err := couchdb.CreateCouchInstance(couchDBDef.URL, couchDBDef.Username, couchDBDef.Password,
couchDBDef.MaxRetries, couchDBDef.MaxRetriesOnStartup, couchDBDef.RequestTimeout)
if err != nil {
return nil, err
}
return &VersionedDBProvider{couchInstance, make(map[string]*VersionedDB), sync.Mutex{}, 0}, nil
}
// GetDBHandle gets the handle to a named database
func (provider *VersionedDBProvider) GetDBHandle(dbName string) (statedb.VersionedDB, error) {
provider.mux.Lock()
defer provider.mux.Unlock()
vdb := provider.databases[dbName]
if vdb == nil {
var err error
vdb, err = newVersionedDB(provider.couchInstance, dbName)
if err != nil {
return nil, err
}
provider.databases[dbName] = vdb
}
return vdb, nil
}
// Close closes the underlying db instance
func (provider *VersionedDBProvider) Close() {
// No close needed on Couch
}
// VersionedDB implements VersionedDB interface
type VersionedDB struct {
db *couchdb.CouchDatabase
dbName string
}
// newVersionedDB constructs an instance of VersionedDB
func newVersionedDB(couchInstance *couchdb.CouchInstance, dbName string) (*VersionedDB, error) {
// CreateCouchDatabase creates a CouchDB database object, as well as the underlying database if it does not exist
db, err := couchdb.CreateCouchDatabase(*couchInstance, dbName)
if err != nil {
return nil, err
}
return &VersionedDB{db, dbName}, nil
}
// Open implements method in VersionedDB interface
func (vdb *VersionedDB) Open() error {
// no need to open db since a shared couch instance is used
return nil
}
// Close implements method in VersionedDB interface
func (vdb *VersionedDB) Close() {
// no need to close db since a shared couch instance is used
}
// ValidateKey implements method in VersionedDB interface
func (vdb *VersionedDB) ValidateKey(key string) error {
if !utf8.ValidString(key) {
return fmt.Errorf("Key should be a valid utf8 string: [%x]", key)
}
return nil
}
// GetState implements method in VersionedDB interface
func (vdb *VersionedDB) GetState(namespace string, key string) (*statedb.VersionedValue, error) {
logger.Debugf("GetState(). ns=%s, key=%s", namespace, key)
compositeKey := constructCompositeKey(namespace, key)
couchDoc, _, err := vdb.db.ReadDoc(string(compositeKey))
if err != nil {
return nil, err
}
if couchDoc == nil {
return nil, nil
}
//remove the data wrapper and return the value and version
returnValue, returnVersion := removeDataWrapper(couchDoc.JSONValue, couchDoc.Attachments)
return &statedb.VersionedValue{Value: returnValue, Version: &returnVersion}, nil
}
func removeDataWrapper(wrappedValue []byte, attachments []*couchdb.Attachment) ([]byte, version.Height) {
//initialize the return value
returnValue := []byte{}
//initialize a default return version
returnVersion := version.NewHeight(0, 0)
//create a generic map for the json
jsonResult := make(map[string]interface{})
//unmarshal the selected json into the generic map
decoder := json.NewDecoder(bytes.NewBuffer(wrappedValue))
decoder.UseNumber()
_ = decoder.Decode(&jsonResult)
// handle binary or json data
if jsonResult[dataWrapper] == nil && attachments != nil { // binary attachment
// get binary data from attachment
for _, attachment := range attachments {
if attachment.Name == binaryWrapper {
returnValue = attachment.AttachmentBytes
}
}
} else {
//place the result json in the data key
returnMap := jsonResult[dataWrapper]
//marshal the mapped data. this wrappers the result in a key named "data"
returnValue, _ = json.Marshal(returnMap)
}
//create an array containing the blockNum and txNum
versionArray := strings.Split(fmt.Sprintf("%s", jsonResult["version"]), ":")
//convert the blockNum from String to unsigned int
blockNum, _ := strconv.ParseUint(versionArray[0], 10, 64)
//convert the txNum from String to unsigned int
txNum, _ := strconv.ParseUint(versionArray[1], 10, 64)
//create the version based on the blockNum and txNum
returnVersion = version.NewHeight(blockNum, txNum)
return returnValue, *returnVersion
}
// GetStateMultipleKeys implements method in VersionedDB interface
func (vdb *VersionedDB) GetStateMultipleKeys(namespace string, keys []string) ([]*statedb.VersionedValue, error) {
vals := make([]*statedb.VersionedValue, len(keys))
for i, key := range keys {
val, err := vdb.GetState(namespace, key)
if err != nil {
return nil, err
}
vals[i] = val
}
return vals, nil
}
// GetStateRangeScanIterator implements method in VersionedDB interface
// startKey is inclusive
// endKey is exclusive
func (vdb *VersionedDB) GetStateRangeScanIterator(namespace string, startKey string, endKey string) (statedb.ResultsIterator, error) {
//Get the querylimit from core.yaml
queryLimit := ledgerconfig.GetQueryLimit()
compositeStartKey := constructCompositeKey(namespace, startKey)
compositeEndKey := constructCompositeKey(namespace, endKey)
if endKey == "" {
compositeEndKey[len(compositeEndKey)-1] = lastKeyIndicator
}
queryResult, err := vdb.db.ReadDocRange(string(compositeStartKey), string(compositeEndKey), queryLimit, querySkip)
if err != nil {
logger.Debugf("Error calling ReadDocRange(): %s\n", err.Error())
return nil, err
}
logger.Debugf("Exiting GetStateRangeScanIterator")
return newKVScanner(namespace, *queryResult), nil
}
// ExecuteQuery implements method in VersionedDB interface
func (vdb *VersionedDB) ExecuteQuery(namespace, query string) (statedb.ResultsIterator, error) {
//Get the querylimit from core.yaml
queryLimit := ledgerconfig.GetQueryLimit()
queryString, err := ApplyQueryWrapper(namespace, query, queryLimit, 0)
if err != nil {
logger.Debugf("Error calling ApplyQueryWrapper(): %s\n", err.Error())
return nil, err
}
queryResult, err := vdb.db.QueryDocuments(queryString)
if err != nil {
logger.Debugf("Error calling QueryDocuments(): %s\n", err.Error())
return nil, err
}
logger.Debugf("Exiting ExecuteQuery")
return newQueryScanner(*queryResult), nil
}
// ApplyUpdates implements method in VersionedDB interface
func (vdb *VersionedDB) ApplyUpdates(batch *statedb.UpdateBatch, height *version.Height) error {
namespaces := batch.GetUpdatedNamespaces()
for _, ns := range namespaces {
updates := batch.GetUpdates(ns)
for k, vv := range updates {
compositeKey := constructCompositeKey(ns, k)
logger.Debugf("Channel [%s]: Applying key=[%#v]", vdb.dbName, compositeKey)
//convert nils to deletes
if vv.Value == nil {
vdb.db.DeleteDoc(string(compositeKey), "")
} else {
couchDoc := &couchdb.CouchDoc{}
//Check to see if the value is a valid JSON
//If this is not a valid JSON, then store as an attachment
if couchdb.IsJSON(string(vv.Value)) {
// Handle it as json
couchDoc.JSONValue = addVersionAndChainCodeID(vv.Value, ns, vv.Version)
} else { // if the data is not JSON, save as binary attachment in Couch
attachment := &couchdb.Attachment{}
attachment.AttachmentBytes = vv.Value
attachment.ContentType = "application/octet-stream"
attachment.Name = binaryWrapper
attachments := append([]*couchdb.Attachment{}, attachment)
couchDoc.Attachments = attachments
couchDoc.JSONValue = addVersionAndChainCodeID(nil, ns, vv.Version)
}
// SaveDoc using couchdb client and use attachment to persist the binary data
rev, err := vdb.db.SaveDoc(string(compositeKey), "", couchDoc)
if err != nil {
logger.Errorf("Error during Commit(): %s\n", err.Error())
return err
}
if rev != "" {
logger.Debugf("Saved document revision number: %s\n", rev)
}
}
}
}
// Record a savepoint at a given height
err := vdb.recordSavepoint(height)
if err != nil {
logger.Errorf("Error during recordSavepoint: %s\n", err.Error())
return err
}
return nil
}
//addVersionAndChainCodeID adds keys for version and chaincodeID to the JSON value
func addVersionAndChainCodeID(value []byte, chaincodeID string, version *version.Height) []byte {
//create a version mapping
jsonMap := map[string]interface{}{"version": fmt.Sprintf("%v:%v", version.BlockNum, version.TxNum)}
//add the chaincodeID
jsonMap["chaincodeid"] = chaincodeID
//Add the wrapped data if the value is not null
if value != nil {
//create a new genericMap
rawJSON := (*json.RawMessage)(&value)
//add the rawJSON to the map
jsonMap[dataWrapper] = rawJSON
}
//marshal the data to a byte array
returnJSON, _ := json.Marshal(jsonMap)
return returnJSON
}
// Savepoint docid (key) for couchdb
const savepointDocID = "statedb_savepoint"
// Savepoint data for couchdb
type couchSavepointData struct {
BlockNum uint64 `json:"BlockNum"`
TxNum uint64 `json:"TxNum"`
UpdateSeq string `json:"UpdateSeq"`
}
// recordSavepoint Record a savepoint in statedb.
// Couch parallelizes writes in cluster or sharded setup and ordering is not guaranteed.
// Hence we need to fence the savepoint with sync. So ensure_full_commit is called before
// savepoint to ensure all block writes are flushed. Savepoint itself does not need to be flushed,
// it will get flushed with next block if not yet committed.
func (vdb *VersionedDB) recordSavepoint(height *version.Height) error {
var err error
var savepointDoc couchSavepointData
// ensure full commit to flush all changes until now to disk
dbResponse, err := vdb.db.EnsureFullCommit()
if err != nil || dbResponse.Ok != true {
logger.Errorf("Failed to perform full commit\n")
return errors.New("Failed to perform full commit")
}
// construct savepoint document
// UpdateSeq would be useful if we want to get all db changes since a logical savepoint
dbInfo, _, err := vdb.db.GetDatabaseInfo()
if err != nil {
logger.Errorf("Failed to get DB info %s\n", err.Error())
return err
}
savepointDoc.BlockNum = height.BlockNum
savepointDoc.TxNum = height.TxNum
savepointDoc.UpdateSeq = dbInfo.UpdateSeq
savepointDocJSON, err := json.Marshal(savepointDoc)
if err != nil {
logger.Errorf("Failed to create savepoint data %s\n", err.Error())
return err
}
// SaveDoc using couchdb client and use JSON format
_, err = vdb.db.SaveDoc(savepointDocID, "", &couchdb.CouchDoc{JSONValue: savepointDocJSON, Attachments: nil})
if err != nil {
logger.Errorf("Failed to save the savepoint to DB %s\n", err.Error())
return err
}
return nil
}
// GetLatestSavePoint implements method in VersionedDB interface
func (vdb *VersionedDB) GetLatestSavePoint() (*version.Height, error) {
var err error
couchDoc, _, err := vdb.db.ReadDoc(savepointDocID)
if err != nil {
logger.Errorf("Failed to read savepoint data %s\n", err.Error())
return nil, err
}
// ReadDoc() not found (404) will result in nil response, in these cases return height nil
if couchDoc == nil || couchDoc.JSONValue == nil {
return nil, nil
}
savepointDoc := &couchSavepointData{}
err = json.Unmarshal(couchDoc.JSONValue, &savepointDoc)
if err != nil {
logger.Errorf("Failed to unmarshal savepoint data %s\n", err.Error())
return nil, err
}
return &version.Height{BlockNum: savepointDoc.BlockNum, TxNum: savepointDoc.TxNum}, nil
}
func constructCompositeKey(ns string, key string) []byte {
compositeKey := []byte(ns)
compositeKey = append(compositeKey, compositeKeySep...)
compositeKey = append(compositeKey, []byte(key)...)
return compositeKey
}
func splitCompositeKey(compositeKey []byte) (string, string) {
split := bytes.SplitN(compositeKey, compositeKeySep, 2)
return string(split[0]), string(split[1])
}
type kvScanner struct {
cursor int
namespace string
results []couchdb.QueryResult
}
func newKVScanner(namespace string, queryResults []couchdb.QueryResult) *kvScanner {
return &kvScanner{-1, namespace, queryResults}
}
func (scanner *kvScanner) Next() (statedb.QueryResult, error) {
scanner.cursor++
if scanner.cursor >= len(scanner.results) {
return nil, nil
}
selectedKV := scanner.results[scanner.cursor]
_, key := splitCompositeKey([]byte(selectedKV.ID))
//remove the data wrapper and return the value and version
returnValue, returnVersion := removeDataWrapper(selectedKV.Value, selectedKV.Attachments)
return &statedb.VersionedKV{
CompositeKey: statedb.CompositeKey{Namespace: scanner.namespace, Key: key},
VersionedValue: statedb.VersionedValue{Value: returnValue, Version: &returnVersion}}, nil
}
func (scanner *kvScanner) Close() {
scanner = nil
}
type queryScanner struct {
cursor int
results []couchdb.QueryResult
}
func newQueryScanner(queryResults []couchdb.QueryResult) *queryScanner {
return &queryScanner{-1, queryResults}
}
func (scanner *queryScanner) Next() (statedb.QueryResult, error) {
scanner.cursor++
if scanner.cursor >= len(scanner.results) {
return nil, nil
}
selectedResultRecord := scanner.results[scanner.cursor]
namespace, key := splitCompositeKey([]byte(selectedResultRecord.ID))
//remove the data wrapper and return the value and version
returnValue, returnVersion := removeDataWrapper(selectedResultRecord.Value, selectedResultRecord.Attachments)
return &statedb.VersionedKV{
CompositeKey: statedb.CompositeKey{Namespace: namespace, Key: key},
VersionedValue: statedb.VersionedValue{Value: returnValue, Version: &returnVersion}}, nil
}
func (scanner *queryScanner) Close() {
scanner = nil
}