[FAB-9948] Collection retrieval for service discovery

This change set adds collection retrieval for service discovery.

Change-Id: Ie8ba6c76f20465deee0471e5be858de0ecb77f89
Signed-off-by: yacovm <yacovm@il.ibm.com>

Author: yacovm

common/chaincode/metadata.go

@@ -21,10 +21,11 @@ type InstalledChaincode struct {
 
 // Metadata defines channel-scoped metadata of a chaincode
 type Metadata struct {
-	Name    string
-	Version string
-	Policy  []byte
-	Id      []byte
+	Name              string
+	Version           string
+	Policy            []byte
+	Id                []byte
+	CollectionsConfig []byte
 }
 
 // MetadataSet defines an aggregation of Metadata

core/cclifecycle/lifecycle.go

@@ -108,13 +108,15 @@ func NewLifeCycle(installedChaincodes Enumerator) (*Lifecycle, error) {
 
 // Metadata returns the metadata of the chaincode on the given channel,
 // or nil if not found or an error occurred at retrieving it
-func (lc *Lifecycle) Metadata(channel string, cc string) *chaincode.Metadata {
+func (lc *Lifecycle) Metadata(channel string, cc string, collections bool) *chaincode.Metadata {
 	queryCreator := lc.queryCreatorsByChannel[channel]
 	if queryCreator == nil {
 		Logger.Warning("Requested Metadata for non-existent channel", channel)
 		return nil
 	}
-	if md, found := lc.deployedCCsByChannel[channel].Lookup(cc); found {
+	// Search the metadata in our local cache, and if it exists - return it, but only if
+	// no collections were specified in the invocation.
+	if md, found := lc.deployedCCsByChannel[channel].Lookup(cc); found && !collections {
 		Logger.Debug("Returning metadata for channel", channel, ", chaincode", cc, ":", md)
 		return &md
 	}
@@ -123,7 +125,7 @@ func (lc *Lifecycle) Metadata(channel string, cc string) *chaincode.Metadata {
 		Logger.Error("Failed obtaining new query for channel", channel, ":", err)
 		return nil
 	}
-	md, err := DeployedChaincodes(query, AcceptAll, cc)
+	md, err := DeployedChaincodes(query, AcceptAll, collections, cc)
 	if err != nil {
 		Logger.Error("Failed querying LSCC for channel", channel, ":", err)
 		return nil

core/cclifecycle/lifecycle_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/hyperledger/fabric/core/cclifecycle"
 	"github.com/hyperledger/fabric/core/cclifecycle/mocks"
 	"github.com/hyperledger/fabric/core/common/ccprovider"
+	"github.com/hyperledger/fabric/core/common/privdata"
 	"github.com/hyperledger/fabric/core/ledger/cceventmgmt"
 	"github.com/hyperledger/fabric/protos/utils"
 	"github.com/op/go-logging"
@@ -304,7 +305,7 @@ func TestMetadata(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Scenario I: No subscription was invoked on the lifecycle
-	md := lc.Metadata("mychannel", "cc1")
+	md := lc.Metadata("mychannel", "cc1", false)
 	assert.Nil(t, md)
 	logger.AssertLogged("Requested Metadata for non-existent channel mychannel")
 
@@ -316,7 +317,7 @@ func TestMetadata(t *testing.T) {
 	defer sub.ChaincodeDeployDone(true)
 	assert.NoError(t, err)
 	assert.NotNil(t, sub)
-	md = lc.Metadata("mychannel", "cc1")
+	md = lc.Metadata("mychannel", "cc1", false)
 	assert.Equal(t, &chaincode.Metadata{
 		Name:    "cc1",
 		Version: "1.0",
@@ -328,36 +329,62 @@ func TestMetadata(t *testing.T) {
 	// Scenario III: A metadata retrieval is made and the chaincode is not in memory yet,
 	// and when the query is attempted to be made - it fails.
 	queryCreator.On("NewQuery").Return(nil, errors.New("failed obtaining query executor")).Once()
-	md = lc.Metadata("mychannel", "cc2")
+	md = lc.Metadata("mychannel", "cc2", false)
 	assert.Nil(t, md)
 	logger.AssertLogged("Failed obtaining new query for channel mychannel : failed obtaining query executor")
 
 	// Scenario IV:  A metadata retrieval is made and the chaincode is not in memory yet,
 	// and when the query is attempted to be made - it succeeds, but GetState fails.
 	queryCreator.On("NewQuery").Return(query, nil).Once()
 	query.On("GetState", "lscc", "cc2").Return(nil, errors.New("GetState failed")).Once()
-	md = lc.Metadata("mychannel", "cc2")
+	md = lc.Metadata("mychannel", "cc2", false)
 	assert.Nil(t, md)
 	logger.AssertLogged("Failed querying LSCC for channel mychannel : GetState failed")
 
 	// Scenario V: A metadata retrieval is made and the chaincode is not in memory yet,
 	// and both the query and the GetState succeed, however - GetState returns nil
 	queryCreator.On("NewQuery").Return(query, nil).Once()
 	query.On("GetState", "lscc", "cc2").Return(nil, nil).Once()
-	md = lc.Metadata("mychannel", "cc2")
+	md = lc.Metadata("mychannel", "cc2", false)
 	assert.Nil(t, md)
 	logger.AssertLogged("Chaincode cc2 isn't defined in channel mychannel")
 
 	// Scenario VI: A metadata retrieval is made and the chaincode is not in memory yet,
 	// and both the query and the GetState succeed, however - GetState returns a valid metadata
 	queryCreator.On("NewQuery").Return(query, nil).Once()
 	query.On("GetState", "lscc", "cc2").Return(cc2Bytes, nil).Once()
-	md = lc.Metadata("mychannel", "cc2")
+	md = lc.Metadata("mychannel", "cc2", false)
 	assert.Equal(t, &chaincode.Metadata{
 		Name:    "cc2",
 		Version: "1.0",
 		Id:      []byte{42},
 	}, md)
+
+	// Scenario VII: A metadata retrieval is made and the chaincode is in the memory,
+	// but a collection is also specified, thus - the retrieval should bypass the memory cache
+	// and go straight into the stateDB.
+	queryCreator.On("NewQuery").Return(query, nil).Once()
+	query.On("GetState", "lscc", "cc1").Return(cc1Bytes, nil).Once()
+	query.On("GetState", "lscc", privdata.BuildCollectionKVSKey("cc1")).Return([]byte{10, 10, 10}, nil).Once()
+	md = lc.Metadata("mychannel", "cc1", true)
+	assert.Equal(t, &chaincode.Metadata{
+		Name:              "cc1",
+		Version:           "1.0",
+		Id:                []byte{42},
+		Policy:            []byte{1, 2, 3, 4, 5},
+		CollectionsConfig: []byte{10, 10, 10},
+	}, md)
+	logger.AssertLogged("Retrieved collection config for cc1 from cc1~collection")
+
+	// Scenario VIII: A metadata retrieval is made and the chaincode is in the memory,
+	// but a collection is also specified, thus - the retrieval should bypass the memory cache
+	// and go straight into the stateDB. However - the retrieval fails
+	queryCreator.On("NewQuery").Return(query, nil).Once()
+	query.On("GetState", "lscc", "cc1").Return(cc1Bytes, nil).Once()
+	query.On("GetState", "lscc", privdata.BuildCollectionKVSKey("cc1")).Return(nil, errors.New("foo")).Once()
+	md = lc.Metadata("mychannel", "cc1", true)
+	assert.Nil(t, md)
+	logger.AssertLogged("Failed querying lscc namespace for cc1~collection: foo")
 }
 
 type logAsserter struct {

core/cclifecycle/subscription.go

@@ -24,7 +24,7 @@ type Subscription struct {
 	pendingUpdates chan *cceventmgmt.ChaincodeDefinition
 }
 
-type depCCsRetriever func(Query, ChaincodePredicate, ...string) (chaincode.MetadataSet, error)
+type depCCsRetriever func(Query, ChaincodePredicate, bool, ...string) (chaincode.MetadataSet, error)
 
 // HandleChaincodeDeploy is expected to be invoked when a chaincode is deployed via a deploy transaction and the chaicndoe was already
 // installed on the peer. This also gets invoked when an already deployed chaincode is installed on the peer
@@ -97,5 +97,5 @@ func queryChaincodeDefinitions(query Query, ccs []chaincode.InstalledChaincode,
 		return true
 	}
 
-	return deployedCCs(query, filter, names(ccs)...)
+	return deployedCCs(query, filter, false, names(ccs)...)
 }

core/cclifecycle/util.go

@@ -13,6 +13,7 @@ import (
 	"github.com/golang/protobuf/proto"
 	"github.com/hyperledger/fabric/common/chaincode"
 	"github.com/hyperledger/fabric/core/common/ccprovider"
+	"github.com/hyperledger/fabric/core/common/privdata"
 	"github.com/pkg/errors"
 )
 
@@ -76,7 +77,7 @@ func InstalledCCs(dir string, ls DirEnumerator, ccFromPath ChaincodeExtractor) (
 type ChaincodePredicate func(cc chaincode.Metadata) bool
 
 // DeployedChaincodes retrieves the metadata of the given deployed chaincodes
-func DeployedChaincodes(q Query, filter ChaincodePredicate, chaincodes ...string) (chaincode.MetadataSet, error) {
+func DeployedChaincodes(q Query, filter ChaincodePredicate, loadCollections bool, chaincodes ...string) (chaincode.MetadataSet, error) {
 	defer q.Done()
 
 	var res chaincode.MetadataSet
@@ -111,6 +112,18 @@ func DeployedChaincodes(q Query, filter ChaincodePredicate, chaincodes ...string
 			Logger.Debug("Filtered out", instCC)
 			continue
 		}
+
+		if loadCollections {
+			key := privdata.BuildCollectionKVSKey(cc)
+			collectionData, err := q.GetState("lscc", key)
+			if err != nil {
+				Logger.Errorf("Failed querying lscc namespace for %s: %v", key, err)
+				return nil, errors.WithStack(err)
+			}
+			instCC.CollectionsConfig = collectionData
+			Logger.Debug("Retrieved collection config for", cc, "from", key)
+		}
+
 		res = append(res, instCC)
 	}
 	Logger.Debug("Returning", res)

core/cclifecycle/util_test.go

@@ -253,7 +253,7 @@ func TestChaincodeInspection(t *testing.T) {
 			query.On("Done")
 			query.On("GetState", mock.Anything, mock.Anything).Return(test.returnedCCBytes, test.queryErr).Once()
 			query.On("GetState", mock.Anything, mock.Anything).Return(cc2Bytes, nil).Once()
-			ccInfo, err := cc.DeployedChaincodes(query, test.filter, test.queriedChaincodes...)
+			ccInfo, err := cc.DeployedChaincodes(query, test.filter, false, test.queriedChaincodes...)
 			if test.queryErr != nil {
 				assert.Error(t, err)
 			} else {

core/common/privdata/store.go

@@ -68,11 +68,19 @@ func RetrieveCollectionConfigPackageFromState(cc common.CollectionCriteria, stat
 	if cb == nil {
 		return nil, NoSuchCollectionError(cc)
 	}
+	conf, err := ParseCollectionConfig(cb)
+	if err != nil {
+		return nil, errors.Wrapf(err, "invalid configuration for collection criteria %#v", cc)
+	}
+	return conf, nil
+}
 
+// ParseCollectionConfig parses the collection configuration from the given serialized representation
+func ParseCollectionConfig(colBytes []byte) (*common.CollectionConfigPackage, error) {
 	collections := &common.CollectionConfigPackage{}
-	err = proto.Unmarshal(cb, collections)
+	err := proto.Unmarshal(colBytes, collections)
 	if err != nil {
-		return nil, errors.Wrapf(err, "invalid configuration for collection criteria %#v", cc)
+		return nil, errors.WithStack(err)
 	}
 
 	return collections, nil

discovery/client/client_test.go

@@ -570,7 +570,7 @@ type ccMetadataFetcher struct {
 	mock.Mock
 }
 
-func (mdf *ccMetadataFetcher) Metadata(channel string, cc string) *chaincode.Metadata {
+func (mdf *ccMetadataFetcher) Metadata(channel string, cc string, _ bool) *chaincode.Metadata {
 	return mdf.Called().Get(0).(*chaincode.Metadata)
 }
 

discovery/endorsement/endorsement.go

@@ -37,7 +37,7 @@ type principalEvaluator interface {
 type chaincodeMetadataFetcher interface {
 	// ChaincodeMetadata returns the metadata of the chaincode as appears in the ledger,
 	// or nil if the channel doesn't exist, or the chaincode isn't found in the ledger
-	Metadata(channel string, cc string) *chaincode.Metadata
+	Metadata(channel string, cc string, loadCollections bool) *chaincode.Metadata
 }
 
 type policyFetcher interface {
@@ -80,7 +80,8 @@ type peerPrincipalEvaluator func(member discovery2.NetworkMember, principal *msp
 // PeersForEndorsement returns an EndorsementDescriptor for a given set of peers, channel, and chaincode
 func (ea *endorsementAnalyzer) PeersForEndorsement(chainID common.ChainID, interest *discovery.ChaincodeInterest) (*discovery.EndorsementDescriptor, error) {
 	chaincode := interest.Chaincodes[0]
-	ccMD := ea.Metadata(string(chainID), chaincode.Name)
+	loadCollections := len(chaincode.CollectionNames) > 0
+	ccMD := ea.Metadata(string(chainID), chaincode.Name, loadCollections)
 	if ccMD == nil {
 		return nil, errors.Errorf("No metadata was found for chaincode %s in channel %s", chaincode.Name, string(chainID))
 	}

discovery/endorsement/endorsement_test.go

@@ -332,7 +332,7 @@ type metadataFetcher struct {
 	mock.Mock
 }
 
-func (mf *metadataFetcher) Metadata(channel string, cc string) *chaincode.Metadata {
+func (mf *metadataFetcher) Metadata(channel string, cc string, _ bool) *chaincode.Metadata {
 	arg := mf.Called().Get(0)
 	if arg == nil {
 		return nil