[FABG-1021] Add properties to Peer (#155)

Properties from the discovery service are added to the fab.Peer. The properties are exposed as a map of string key to interface{} value so that extended properties may be added without requiring modifications to this interface.

Signed-off-by: Bob Stasyszyn <[email protected]>

Author: bstasyszyn

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

@@ -9,7 +9,7 @@ SPDX-License-Identifier: Apache-2.0
 package dynamicdiscovery
 
 import (
-	fabDiscovery "github.com/hyperledger/fabric-sdk-go/pkg/fab/discovery"
+	"github.com/hyperledger/fabric-protos-go/gossip"
 	"github.com/pkg/errors"
 	"testing"
 	"time"
@@ -18,6 +18,7 @@ import (
 	contextAPI "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/context"
 	"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
 	pfab "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
+	fabDiscovery "github.com/hyperledger/fabric-sdk-go/pkg/fab/discovery"
 	discmocks "github.com/hyperledger/fabric-sdk-go/pkg/fab/discovery/mocks"
 	"github.com/hyperledger/fabric-sdk-go/pkg/fab/mocks"
 	mspmocks "github.com/hyperledger/fabric-sdk-go/pkg/msp/test/mockmsp"
@@ -90,13 +91,22 @@ func TestDiscoveryService(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, 0, len(peers))
 
+	chaincodes := []*gossip.Chaincode{
+		{
+			Name:    "cc1",
+			Version: "v1",
+		},
+	}
+
 	discClient.SetResponses(
 		&fabDiscovery.MockDiscoverEndpointResponse{
 			PeerEndpoints: []*discmocks.MockDiscoveryPeerEndpoint{
 				{
 					MSPID:        mspID1,
 					Endpoint:     peer1MSP1,
 					LedgerHeight: 5,
+					Chaincodes:   chaincodes,
+					LeftChannel:  false,
 				},
 			},
 			Target: peer1MSP2,
@@ -109,6 +119,12 @@ func TestDiscoveryService(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equalf(t, 1, len(peers), "Expected 1 peer")
 
+	peer := peers[0]
+	require.NotEmpty(t, peer.Properties())
+	require.Equal(t, uint64(5), peer.Properties()[fab.PropertyLedgerHeight])
+	require.Equal(t, false, peer.Properties()[fab.PropertyLeftChannel])
+	require.Equal(t, chaincodes, peer.Properties()[fab.PropertyChaincodes])
+
 	discClient.SetResponses(
 		&fabDiscovery.MockDiscoverEndpointResponse{
 			PeerEndpoints: []*discmocks.MockDiscoveryPeerEndpoint{

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

@@ -145,7 +145,11 @@ func asPeer(ctx contextAPI.Client, endpoint *discclient.Peer) (fab.Peer, bool) {
 		return nil, false
 	}
 
-	peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{PeerConfig: *peerConfig, MSPID: endpoint.MSPID})
+	peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{
+		PeerConfig: *peerConfig,
+		MSPID:      endpoint.MSPID,
+		Properties: fabdiscovery.GetProperties(endpoint),
+	})
 	if err != nil {
 		logger.Warnf("Unable to create peer config for [%s]: %s", url, err)
 		return nil, false

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

@@ -337,14 +337,17 @@ func asPeer(ctx contextAPI.Client, endpoint *discclient.Peer) (fab.Peer, error)
 		return nil, errors.Errorf("peer config not found for [%s]", url)
 	}
 
-	peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{PeerConfig: *peerConfig, MSPID: endpoint.MSPID})
+	peer, err := ctx.InfraProvider().CreatePeerFromConfig(&fab.NetworkPeer{
+		PeerConfig: *peerConfig,
+		MSPID:      endpoint.MSPID,
+		Properties: fabdiscovery.GetProperties(endpoint),
+	})
 	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,
+		Peer: peer,
 	}, nil
 }
 
@@ -354,11 +357,15 @@ func getDefaultRetryOpts(ctx contextAPI.Client, channelID string) retry.Opts {
 
 type peerEndpoint struct {
 	fab.Peer
-	blockHeight uint64
 }
 
 func (p *peerEndpoint) BlockHeight() uint64 {
-	return p.blockHeight
+	ledgerHeight, ok := p.Properties()[fab.PropertyLedgerHeight]
+	if !ok {
+		return 0
+	}
+
+	return ledgerHeight.(uint64)
 }
 
 // DiscoveryError is an error originating at the Discovery service

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

@@ -14,6 +14,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hyperledger/fabric-protos-go/gossip"
+
 	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/balancer"
 	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/options"
 	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/sorter/blockheightsorter"
@@ -164,6 +166,13 @@ func TestSelection(t *testing.T) {
 	})
 
 	t.Run("Success on one target", func(t *testing.T) {
+		chaincodes := []*gossip.Chaincode{
+			{
+				Name:    cc1,
+				Version: "v1",
+			},
+		}
+
 		discClient.SetResponses(
 			&discovery.MockDiscoverEndpointResponse{
 				EndorsersErr: fmt.Errorf("no endorsement combination can be satisfied"),
@@ -177,13 +186,20 @@ func TestSelection(t *testing.T) {
 						MSPID:        mspID1,
 						Endpoint:     peer1Org1URL,
 						LedgerHeight: 10,
+						Chaincodes:   chaincodes,
 					},
 				},
 			},
 		)
 		endorsers, err := service.GetEndorsersForChaincode([]*fab.ChaincodeCall{{ID: cc1}})
 		require.NoError(t, err)
 		require.Len(t, endorsers, 1)
+
+		endorser := endorsers[0]
+		require.NotEmpty(t, endorser.Properties())
+		require.Equal(t, uint64(10), endorser.Properties()[fab.PropertyLedgerHeight])
+		require.Equal(t, false, endorser.Properties()[fab.PropertyLeftChannel])
+		require.Equal(t, chaincodes, endorser.Properties()[fab.PropertyChaincodes])
 	})
 
 	t.Run("CCtoCC", func(t *testing.T) {

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

@@ -10,14 +10,14 @@ import (
 	"context"
 	"sort"
 
-	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/sorter/balancedsorter"
-	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/sorter/blockheightsorter"
-
 	discclient "github.com/hyperledger/fabric-sdk-go/internal/github.com/hyperledger/fabric/discovery/client"
 	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/balancer"
 	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/options"
+	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/sorter/balancedsorter"
+	"github.com/hyperledger/fabric-sdk-go/pkg/client/common/selection/sorter/blockheightsorter"
 	contextAPI "github.com/hyperledger/fabric-sdk-go/pkg/common/providers/context"
 	"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
+	fabdiscovery "github.com/hyperledger/fabric-sdk-go/pkg/fab/discovery"
 )
 
 type selectionFilter struct {
@@ -149,9 +149,9 @@ func (s *selectionFilter) asPeerValue(endpoint *discclient.Peer) fab.Peer {
 	}
 
 	return &peerEndpointValue{
-		mspID:       endpoint.MSPID,
-		url:         url,
-		blockHeight: endpoint.StateInfoMessage.GetStateInfo().GetProperties().LedgerHeight,
+		mspID:      endpoint.MSPID,
+		url:        url,
+		properties: fabdiscovery.GetProperties(endpoint),
 	}
 }
 
@@ -207,9 +207,9 @@ func containsPeer(peers []fab.Peer, peer fab.Peer) bool {
 }
 
 type peerEndpointValue struct {
-	mspID       string
-	url         string
-	blockHeight uint64
+	mspID      string
+	url        string
+	properties fab.Properties
 }
 
 func (p *peerEndpointValue) MSPID() string {
@@ -220,8 +220,17 @@ func (p *peerEndpointValue) URL() string {
 	return p.url
 }
 
+func (p *peerEndpointValue) Properties() fab.Properties {
+	return p.properties
+}
+
 func (p *peerEndpointValue) BlockHeight() uint64 {
-	return p.blockHeight
+	ledgerHeight, ok := p.properties[fab.PropertyLedgerHeight]
+	if !ok {
+		return 0
+	}
+
+	return ledgerHeight.(uint64)
 }
 
 func (p *peerEndpointValue) ProcessTransactionProposal(context.Context, fab.ProcessProposalRequest) (*fab.TransactionProposalResponse, error) {

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

@@ -0,0 +1,52 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package fabricselection
+
+import (
+	"testing"
+
+	"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPeerEndpointValue(t *testing.T) {
+	const mspID = "org1"
+	const url = "peer1.org1.com"
+
+	t.Run("Success", func(t *testing.T) {
+		ep := &peerEndpointValue{
+			mspID: mspID,
+			url:   url,
+			properties: fab.Properties{
+				fab.PropertyLedgerHeight: uint64(1001),
+			},
+		}
+
+		require.Equal(t, mspID, ep.MSPID())
+		require.Equal(t, url, ep.URL())
+		require.NotEmpty(t, ep.Properties())
+		require.Equal(t, uint64(1001), ep.Properties()[fab.PropertyLedgerHeight])
+		require.Equal(t, uint64(1001), ep.BlockHeight())
+		require.Panics(t, func() {
+			_, err := ep.ProcessTransactionProposal(nil, fab.ProcessProposalRequest{})
+			require.NoError(t, err)
+		})
+	})
+
+	t.Run("No ledger height property", func(t *testing.T) {
+		ep := &peerEndpointValue{
+			mspID:      mspID,
+			url:        url,
+			properties: fab.Properties{},
+		}
+
+		require.Equal(t, mspID, ep.MSPID())
+		require.Equal(t, url, ep.URL())
+		require.Empty(t, ep.Properties())
+		require.Equal(t, uint64(0), ep.BlockHeight())
+	})
+}

pkg/common/providers/fab/network.go

@@ -111,7 +111,8 @@ type ChannelPeer struct {
 // NetworkPeer combines peer info with MSP info
 type NetworkPeer struct {
 	PeerConfig
-	MSPID string
+	MSPID      string
+	Properties map[Property]interface{}
 }
 
 // OrganizationConfig provides the definition of an organization in the network

pkg/common/providers/fab/peer.go

@@ -16,10 +16,29 @@ type Peer interface {
 	//URL gets the peer address
 	URL() string
 
-	// TODO: Roles, Name, EnrollmentCertificate (if needed)
+	// Properties returns properties of the peer.
+	Properties() Properties
+
+	// TODO: Name, EnrollmentCertificate (if needed)
 }
 
 // PeerState provides state information about the Peer
 type PeerState interface {
 	BlockHeight() uint64
 }
+
+// Properties defines the properties of a peer
+type Properties map[Property]interface{}
+
+// Property is the key into the Properties map
+type Property = string
+
+// Following is a well-known list of properties of a peer, although this list may be extended.
+const (
+	// PropertyChaincodes defines the chaincodes that are deployed on the peer. Value type:[]*github.com/hyperledger/fabric-protos-go/gossip.Chaincode
+	PropertyChaincodes Property = "Chaincodes"
+	// PropertyLedgerHeight defines the ledger height property. Value type: uint64
+	PropertyLedgerHeight Property = "LedgerHeight"
+	// PropertyLeftChannel defines the "left-channel" property which indicates whether the peer left the channel. Value type: bool
+	PropertyLeftChannel Property = "LeftChannel"
+)

pkg/fab/discovery/mockdiscoveryclient.go

@@ -196,6 +196,8 @@ func newStateInfoMessage(endpoint *mocks.MockDiscoveryPeerEndpoint) *gprotoext.S
 				StateInfo: &gossip.StateInfo{
 					Properties: &gossip.Properties{
 						LedgerHeight: endpoint.LedgerHeight,
+						Chaincodes:   endpoint.Chaincodes,
+						LeftChannel:  endpoint.LeftChannel,
 					},
 				},
 			},

pkg/fab/discovery/mocks/mockdiscoveryserver.go

@@ -178,8 +178,9 @@ func asDiscoveryPeer(p *MockDiscoveryPeerEndpoint) *discovery.Peer {
 		Content: &gossip.GossipMessage_StateInfo{
 			StateInfo: &gossip.StateInfo{
 				Properties: &gossip.Properties{
-					Chaincodes:   nil,
 					LedgerHeight: p.LedgerHeight,
+					Chaincodes:   p.Chaincodes,
+					LeftChannel:  p.LeftChannel,
 				},
 				Timestamp: &gossip.PeerTime{
 					SeqNum: uint64(1000),
@@ -208,6 +209,8 @@ type MockDiscoveryPeerEndpoint struct {
 	MSPID        string
 	Endpoint     string
 	LedgerHeight uint64
+	Chaincodes   []*gossip.Chaincode
+	LeftChannel  bool
 }
 
 func asPeersByOrg(peers []*MockDiscoveryPeerEndpoint) map[string]*discovery.Peers {

pkg/fab/discovery/util.go

@@ -0,0 +1,42 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package discovery
+
+import (
+	"reflect"
+	"strings"
+
+	discclient "github.com/hyperledger/fabric-sdk-go/internal/github.com/hyperledger/fabric/discovery/client"
+	"github.com/hyperledger/fabric-sdk-go/pkg/common/providers/fab"
+)
+
+// GetProperties extracts the properties from the discovered peer.
+func GetProperties(endpoint *discclient.Peer) fab.Properties {
+	if endpoint.StateInfoMessage == nil {
+		return nil
+	}
+
+	stateInfo := endpoint.StateInfoMessage.GetStateInfo()
+	if stateInfo == nil || stateInfo.Properties == nil {
+		return nil
+	}
+
+	properties := make(fab.Properties)
+
+	val := reflect.ValueOf(stateInfo.Properties).Elem()
+
+	for i := 0; i < val.NumField(); i++ {
+		fType := val.Type().Field(i)
+
+		// Exclude protobuf fields
+		if !strings.HasPrefix(fType.Name, "XXX_") {
+			properties[fType.Name] = val.Field(i).Interface()
+		}
+	}
+
+	return properties
+}