[FABG-693] Add Block Height to Dynamic Discovery Peers

Add PeerState to the set of interfaces implemented by the
peer endpoint returned from the Dynamic Discovery service.

Change-Id: Ifdcde9e2a2d4e18b614731b0d9568257a7fa0ea9
Signed-off-by: Bob Stasyszyn <Bob.Stasyszyn@securekey.com>

Author: bstasyszyn

pkg/client/common/discovery/dynamicdiscovery/chservice.go

@@ -103,7 +103,31 @@ func (s *ChannelService) evaluate(ctx contextAPI.Client, responses []fabdiscover
 			logger.Warn(lastErr.Error())
 			continue
 		}
-		return asPeers(ctx, endpoints), nil
+		return s.asPeers(ctx, endpoints), nil
 	}
 	return nil, lastErr
 }
+
+func (s *ChannelService) asPeers(ctx contextAPI.Client, endpoints []*discclient.Peer) []fab.Peer {
+	var peers []fab.Peer
+	for _, endpoint := range endpoints {
+		peer, ok := asPeer(ctx, endpoint)
+		if !ok {
+			continue
+		}
+		peers = append(peers, &peerEndpoint{
+			Peer:        peer,
+			blockHeight: endpoint.StateInfoMessage.GetStateInfo().GetProperties().LedgerHeight,
+		})
+	}
+	return peers
+}
+
+type peerEndpoint struct {
+	fab.Peer
+	blockHeight uint64
+}
+
+func (p *peerEndpoint) BlockHeight() uint64 {
+	return p.blockHeight
+}

pkg/client/common/discovery/dynamicdiscovery/chservice_test.go

@@ -10,6 +10,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/discovery"
 	clientmocks "github.com/hyperledger/fabric-sdk-go/pkg/client/common/mocks"
 	contextAPI "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/context"
 	pfab "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
@@ -101,7 +102,7 @@ func TestDiscoveryService(t *testing.T) {
 				{
 					MSPID:        mspID2,
 					Endpoint:     peer1MSP2,
-					LedgerHeight: 5,
+					LedgerHeight: 15,
 				},
 			},
 		},
@@ -112,4 +113,20 @@ func TestDiscoveryService(t *testing.T) {
 	peers, err = service.GetPeers()
 	assert.NoError(t, err)
 	assert.Equalf(t, 2, len(peers), "Expected 2 peers")
+
+	filteredService := discovery.NewDiscoveryFilterService(service, &blockHeightFilter{minBlockHeight: 10})
+	peers, err = filteredService.GetPeers()
+	require.NoError(t, err)
+	require.Equalf(t, 1, len(peers), "expecting discovery filter to return only one peer")
+}
+
+type blockHeightFilter struct {
+	minBlockHeight uint64
+}
+
+func (f *blockHeightFilter) Accept(peer pfab.Peer) bool {
+	if p, ok := peer.(pfab.PeerState); ok {
+		return p.BlockHeight() >= f.minBlockHeight
+	}
+	panic("expecting peer to have state")
 }

pkg/client/common/discovery/dynamicdiscovery/service.go

@@ -124,23 +124,31 @@ func (s *service) discoveryClient() discoveryClient {
 func asPeers(ctx contextAPI.Client, endpoints []*discclient.Peer) []fab.Peer {
 	var peers []fab.Peer
 	for _, endpoint := range endpoints {
-		url := endpoint.AliveMessage.GetAliveMsg().Membership.Endpoint
-
-		logger.Debugf("Adding endpoint [%s]", url)
-
-		peerConfig, found := ctx.EndpointConfig().PeerConfig(url)
-		if !found {
-			logger.Debugf("Peer config not found for url [%s]", url)
-			continue
-		}
-
-		peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{PeerConfig: *peerConfig, MSPID: endpoint.MSPID})
-		if err != nil {
-			logger.Warnf("Unable to create peer config for [%s]: %s", url, err)
+		peer, ok := asPeer(ctx, endpoint)
+		if !ok {
 			continue
 		}
 		peers = append(peers, peer)
 	}
-
 	return peers
 }
+
+func asPeer(ctx contextAPI.Client, endpoint *discclient.Peer) (fab.Peer, bool) {
+	url := endpoint.AliveMessage.GetAliveMsg().Membership.Endpoint
+
+	logger.Debugf("Adding endpoint [%s]", url)
+
+	peerConfig, found := ctx.EndpointConfig().PeerConfig(url)
+	if !found {
+		logger.Debugf("Peer config not found for url [%s]", url)
+		return nil, false
+	}
+
+	peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{PeerConfig: *peerConfig, MSPID: endpoint.MSPID})
+	if err != nil {
+		logger.Warnf("Unable to create peer config for [%s]: %s", url, err)
+		return nil, false
+	}
+
+	return peer, true
+}

pkg/client/common/selection/fabricselection/fabricselection.go

@@ -52,11 +52,6 @@ var defaultRetryOpts = retry.Opts{
 	RetryableCodes: retryableCodes,
 }
 
-// PeerState provides state information about the Peer
-type PeerState interface {
-	BlockHeight() uint64
-}
-
 type discoveryClient interface {
 	Send(ctx context.Context, req *discclient.Request, targets ...fab.PeerConfig) ([]fabdiscovery.Response, error)
 }

pkg/client/common/selection/fabricselection/selection_test.go

@@ -160,7 +160,7 @@ func TestSelection(t *testing.T) {
 	t.Run("Peer Filter", func(t *testing.T) {
 		endorsers, err := service.GetEndorsersForChaincode([]*fab.ChaincodeCall{{ID: cc1}},
 			options.WithPeerFilter(func(peer fab.Peer) bool {
-				return peer.(PeerState).BlockHeight() > 1001
+				return peer.(fab.PeerState).BlockHeight() > 1001
 			}),
 		)
 
@@ -170,7 +170,7 @@ func TestSelection(t *testing.T) {
 		// Ensure the endorsers all have a block height > 1001 and they are returned in descending order of block height
 		lastBlockHeight := uint64(9999999)
 		for _, endorser := range endorsers {
-			blockHeight := endorser.(PeerState).BlockHeight()
+			blockHeight := endorser.(fab.PeerState).BlockHeight()
 			assert.Truef(t, blockHeight > 1001, "Expecting block height to be > 1001")
 			assert.Truef(t, blockHeight <= lastBlockHeight, "Expecting endorsers to be returned in order of descending block height. Block Height: %d, Last Block Height: %d", blockHeight, lastBlockHeight)
 			lastBlockHeight = blockHeight
@@ -268,7 +268,7 @@ func TestWithDiscoveryFilter(t *testing.T) {
 
 		endorsers, err := service.GetEndorsersForChaincode([]*fab.ChaincodeCall{cc1ChaincodeCall},
 			options.WithPeerFilter(func(peer fab.Peer) bool {
-				return peer.(PeerState).BlockHeight() > 1001
+				return peer.(fab.PeerState).BlockHeight() > 1001
 			}))
 		assert.NoError(t, err)
 		assert.Equalf(t, 3, len(endorsers), "Expecting 3 endorser")

pkg/common/providers/fab/peer.go

@@ -18,3 +18,8 @@ type Peer interface {
 
 	// TODO: Roles, Name, EnrollmentCertificate (if needed)
 }
+
+// PeerState provides state information about the Peer
+type PeerState interface {
+	BlockHeight() uint64
+}