-
Notifications
You must be signed in to change notification settings - Fork 508
/
fabricselection.go
376 lines (312 loc) · 12.3 KB
/
fabricselection.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
/*
Copyright SecureKey Technologies Inc. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package fabricselection
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
discclient "github.com/hyperledger/fabric-sdk-go/internal/github.com/hyperledger/fabric/discovery/client"
"github.com/hyperledger/fabric-sdk-go/internal/github.com/hyperledger/fabric/protos/discovery"
"github.com/hyperledger/fabric-sdk-go/pkg/client/common/random"
soptions "github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/options"
"github.com/hyperledger/fabric-sdk-go/pkg/common/errors/multi"
"github.com/hyperledger/fabric-sdk-go/pkg/common/errors/retry"
"github.com/hyperledger/fabric-sdk-go/pkg/common/errors/status"
"github.com/hyperledger/fabric-sdk-go/pkg/common/logging"
coptions "github.com/hyperledger/fabric-sdk-go/pkg/common/options"
contextAPI "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/context"
"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
reqContext "github.com/hyperledger/fabric-sdk-go/pkg/context"
fabdiscovery "github.com/hyperledger/fabric-sdk-go/pkg/fab/discovery"
"github.com/hyperledger/fabric-sdk-go/pkg/util/concurrent/lazycache"
"github.com/hyperledger/fabric-sdk-go/pkg/util/concurrent/lazyref"
"github.com/pkg/errors"
grpcCodes "google.golang.org/grpc/codes"
)
const (
moduleName = "fabsdk/client"
// AccessDenied indicates that the user does not have permission to perform the operation
AccessDenied = "access denied"
)
var logger = logging.NewLogger(moduleName)
var retryableCodes = map[status.Group][]status.Code{
status.GRPCTransportStatus: {
status.Code(grpcCodes.Unavailable),
},
status.DiscoveryServerStatus: {
status.QueryEndorsers,
},
}
var defaultRetryOpts = retry.Opts{
Attempts: 6,
InitialBackoff: 500 * time.Millisecond,
MaxBackoff: 5 * time.Second,
BackoffFactor: 1.75,
RetryableCodes: retryableCodes,
}
// DiscoveryClient is the client to the discovery service
type DiscoveryClient interface {
Send(ctx context.Context, req *discclient.Request, targets ...fab.PeerConfig) ([]fabdiscovery.Response, error)
}
// clientProvider is overridden by unit tests
var clientProvider = func(ctx contextAPI.Client) (DiscoveryClient, error) {
return fabdiscovery.New(ctx)
}
// Service chooses endorsing peers for a given set of chaincodes using
// Fabric's Discovery Service
type Service struct {
channelID string
responseTimeout time.Duration
ctx contextAPI.Client
discovery fab.DiscoveryService
discClient DiscoveryClient
chResponseCache *lazycache.Cache
retryOpts retry.Opts
errHandler fab.ErrorHandler
}
// New creates a new dynamic selection service using Fabric's Discovery Service
func New(ctx contextAPI.Client, channelID string, discovery fab.DiscoveryService, opts ...coptions.Opt) (*Service, error) {
options := params{retryOpts: defaultRetryOpts}
coptions.Apply(&options, opts)
if options.refreshInterval == 0 {
options.refreshInterval = ctx.EndpointConfig().Timeout(fab.SelectionServiceRefresh)
}
if options.responseTimeout == 0 {
options.responseTimeout = ctx.EndpointConfig().Timeout(fab.DiscoveryResponse)
}
logger.Debugf("Cache refresh interval: %s", options.refreshInterval)
logger.Debugf("Deliver service response timeout: %s", options.responseTimeout)
logger.Debugf("Retry opts: %#v", options.retryOpts)
discoveryClient, err := clientProvider(ctx)
if err != nil {
return nil, errors.Wrap(err, "error creating discover client")
}
s := &Service{
channelID: channelID,
ctx: ctx,
responseTimeout: options.responseTimeout,
discovery: discovery,
discClient: discoveryClient,
retryOpts: options.retryOpts,
errHandler: options.errHandler,
}
s.chResponseCache = lazycache.NewWithData(
"Fabric_Selection_Cache",
func(key lazycache.Key, data interface{}) (interface{}, error) {
invocationChain := key.(*cacheKey).chaincodes
if logging.IsEnabledFor(moduleName, logging.DEBUG) {
key, err := json.Marshal(invocationChain)
if err != nil {
panic(fmt.Sprintf("marshal of chaincodes failed: %s", err))
}
logger.Debugf("Refreshing endorsers for chaincodes [%s] in channel [%s] from discovery service...", key, channelID)
}
ropts := s.retryOpts
if data != nil {
ropts = data.(retry.Opts)
logger.Debugf("Overriding retry opts: %#v", ropts)
}
endorsers, err := s.queryEndorsers(invocationChain, ropts)
if err != nil && s.errHandler != nil {
logger.Debugf("[%s] Got error from discovery query: %s. Invoking error handler", s.channelID, err)
s.errHandler(s.ctx, s.channelID, err)
}
return endorsers, err
},
lazyref.WithRefreshInterval(lazyref.InitImmediately, options.refreshInterval),
)
return s, nil
}
// GetEndorsersForChaincode returns the endorsing peers for the given chaincodes
func (s *Service) GetEndorsersForChaincode(chaincodes []*fab.ChaincodeCall, opts ...coptions.Opt) ([]fab.Peer, error) {
if s.chResponseCache.IsClosed() {
return nil, errors.Errorf("Selection service has been closed")
}
logger.Debugf("Getting endorsers for chaincodes [%#v]...", chaincodes)
if len(chaincodes) == 0 {
return nil, errors.New("no chaincode IDs provided")
}
params := soptions.Params{RetryOpts: s.retryOpts}
coptions.Apply(¶ms, opts)
chResponse, err := s.getChannelResponse(chaincodes, params.RetryOpts)
if err != nil {
return nil, errors.Wrapf(err, "error getting channel response for channel [%s]", s.channelID)
}
// Execute getEndorsers with retries since the discovered peers may be out of sync with
// the peers returned from the endorser query and it may take a while for them to sync.
endpoints, err := retry.NewInvoker(retry.New(s.retryOpts)).Invoke(
func() (interface{}, error) {
return s.getEndorsers(chaincodes, chResponse, params.PeerFilter, params.PeerSorter)
},
)
if err != nil || endpoints == nil {
return nil, err
}
return asPeers(s.ctx, endpoints.(discclient.Endorsers)), nil
}
// Close closes all resources associated with the service
func (s *Service) Close() {
logger.Debug("Closing channel response cache")
s.chResponseCache.Close()
}
func (s *Service) getEndorsers(chaincodes []*fab.ChaincodeCall, chResponse discclient.ChannelResponse, peerFilter soptions.PeerFilter, sorter soptions.PeerSorter) (discclient.Endorsers, error) {
peers, err := s.discovery.GetPeers()
if err != nil {
return nil, errors.Wrapf(err, "error getting peers from discovery service for channel [%s]", s.channelID)
}
endpoints, err := chResponse.Endorsers(asInvocationChain(chaincodes), newFilter(s.channelID, s.ctx, peers, peerFilter, sorter))
if err != nil && newDiscoveryError(err).isTransient() {
return nil, status.New(status.DiscoveryServerStatus, int32(status.QueryEndorsers), fmt.Sprintf("error getting endorsers: %s", err), []interface{}{})
}
return endpoints, err
}
func (s *Service) getChannelResponse(chaincodes []*fab.ChaincodeCall, retryOpts retry.Opts) (discclient.ChannelResponse, error) {
key := newCacheKey(chaincodes)
chResp, err := s.chResponseCache.Get(key, retryOpts)
if err != nil {
return nil, err
}
return chResp.(discclient.ChannelResponse), nil
}
func (s *Service) queryEndorsers(chaincodes []*fab.ChaincodeCall, retryOpts retry.Opts) (discclient.ChannelResponse, error) {
logger.Debugf("Querying discovery service for endorsers for chaincodes: %#v", chaincodes)
targets, err := s.getTargets(s.ctx)
if err != nil {
return nil, err
}
if len(targets) == 0 {
return nil, errors.Errorf("no peers configured for channel [%s]", s.channelID)
}
req, err := discclient.NewRequest().OfChannel(s.channelID).AddEndorsersQuery(asChaincodeInterests(chaincodes))
if err != nil {
return nil, errors.Wrapf(err, "error creating endorser query request")
}
logger.Debugf("Querying Discovery Service with retry opts: %#v", retryOpts)
chResponse, err := retry.NewInvoker(retry.New(retryOpts)).Invoke(
func() (interface{}, error) {
return s.query(req, chaincodes, targets)
},
)
if err != nil {
return nil, newDiscoveryError(err)
}
return chResponse.(discclient.ChannelResponse), nil
}
func (s *Service) query(req *discclient.Request, chaincodes []*fab.ChaincodeCall, targets []fab.PeerConfig) (discclient.ChannelResponse, error) {
logger.Debugf("Querying Discovery Service for endorsers for chaincodes: %#v on channel [%s]", chaincodes, s.channelID)
reqCtx, cancel := reqContext.NewRequest(s.ctx, reqContext.WithTimeout(s.responseTimeout))
defer cancel()
responses, err := s.discClient.Send(reqCtx, req, targets...)
if err != nil {
if len(responses) == 0 {
return nil, errors.Wrapf(err, "error calling discover service send for selection")
}
logger.Warnf("Received %d response(s) and one or more errors from discovery client: %s", len(responses), err)
}
if len(responses) == 0 {
return nil, errors.New("no successful response received from any peer")
}
// TODO: In a future patch:
// - validate the signatures in the responses
// For now just pick the first successful response
invocChain := asInvocationChain(chaincodes)
var discErrs []DiscoveryError
for _, response := range responses {
logger.Debugf("Checking response from [%s]...", response.Target())
chResp := response.ForChannel(s.channelID)
// Make sure the target didn't return an error
_, err := chResp.Endorsers(invocChain, discclient.NoFilter)
if err != nil {
logger.Debugf("... got error response from [%s]: %s", response.Target(), err)
discErrs = append(discErrs, newDiscoveryError(err))
continue
}
logger.Debugf("... got success response from [%s]", response.Target())
return chResp, nil
}
var errs []error
for _, err := range discErrs {
if err.isTransient() {
logger.Debugf("Got transient error: %s", err)
errMsg := fmt.Sprintf("error received from Discovery Server: %s", err)
return nil, status.New(status.DiscoveryServerStatus, int32(status.QueryEndorsers), errMsg, []interface{}{})
}
errs = append(errs, err)
}
return nil, multi.New(errs...)
}
func (s *Service) getTargets(ctx contextAPI.Client) ([]fab.PeerConfig, error) {
chpeers := ctx.EndpointConfig().ChannelPeers(s.channelID)
if len(chpeers) == 0 {
return nil, errors.Errorf("no channel peers configured for channel [%s]", s.channelID)
}
chConfig := ctx.EndpointConfig().ChannelConfig(s.channelID)
//pick number of peers based on channel policy
return random.PickRandomNPeerConfigs(chpeers, chConfig.Policies.Discovery.MaxTargets), nil
}
func asChaincodeInterests(chaincodes []*fab.ChaincodeCall) *discovery.ChaincodeInterest {
return &discovery.ChaincodeInterest{
Chaincodes: asInvocationChain(chaincodes),
}
}
func asInvocationChain(chaincodes []*fab.ChaincodeCall) discclient.InvocationChain {
var invocChain discclient.InvocationChain
for _, cc := range chaincodes {
invocChain = append(invocChain, &discovery.ChaincodeCall{
Name: cc.ID,
CollectionNames: cc.Collections,
})
}
return invocChain
}
func asPeers(ctx contextAPI.Client, endpoints []*discclient.Peer) []fab.Peer {
var peers []fab.Peer
for _, endpoint := range endpoints {
peer, err := asPeer(ctx, endpoint)
if err != nil {
logger.Debugf(err.Error())
continue
}
peers = append(peers, peer)
}
return peers
}
func asPeer(ctx contextAPI.Client, endpoint *discclient.Peer) (fab.Peer, error) {
url := endpoint.AliveMessage.GetAliveMsg().Membership.Endpoint
peerConfig, found := ctx.EndpointConfig().PeerConfig(url)
if !found {
return nil, errors.Errorf("peer config not found for [%s]", url)
}
peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{PeerConfig: *peerConfig, MSPID: endpoint.MSPID})
if err != nil {
return nil, errors.Wrapf(err, "unable to create peer config for [%s]", url)
}
return &peerEndpoint{
Peer: peer,
blockHeight: endpoint.StateInfoMessage.GetStateInfo().GetProperties().LedgerHeight,
}, nil
}
type peerEndpoint struct {
fab.Peer
blockHeight uint64
}
func (p *peerEndpoint) BlockHeight() uint64 {
return p.blockHeight
}
// DiscoveryError is an error originating at the Discovery service
type DiscoveryError string
func newDiscoveryError(err error) DiscoveryError {
return DiscoveryError(err.Error())
}
// Error returns the error message
func (e DiscoveryError) Error() string {
return string(e)
}
func (e DiscoveryError) isTransient() bool {
return strings.Contains(e.Error(), "failed constructing descriptor for chaincodes") ||
strings.Contains(e.Error(), "no endorsement combination can be satisfied")
}