FAB-16158 Pass chaincode name instead of ID

Jason Yellick · Jason Yellick · commit d681fad21e7e · 2019-08-10T23:08:24.000-04:00
The endorser.go code labors under the false assumption that a user
passes in anything in the chaincode ID other than name.  It then goes
and overrides these values anyway.  There's no point to passing the ID
around when the only piece of info it contains is the string name.
Fixing.

Change-Id: If54546736b7927182420304706734420e2181e14
Signed-off-by: Jason Yellick &lt;jyellick@us.ibm.com&gt;
diff --git a/core/endorser/endorser.go b/core/endorser/endorser.go
@@ -117,15 +117,15 @@ func NewEndorserServer(privDist privateDataDistributor, s Support, pr *packaging
 }
 
 // call specified chaincode (system or user)
-func (e *Endorser) callChaincode(txParams *ccprovider.TransactionParams, idBytes []byte, requiresInit bool, input *pb.ChaincodeInput, cid *pb.ChaincodeID) (*pb.Response, *pb.ChaincodeEvent, error) {
-	endorserLogger.Infof("[%s][%s] Entry chaincode: %s", txParams.ChannelID, shorttxid(txParams.TxID), cid)
+func (e *Endorser) callChaincode(txParams *ccprovider.TransactionParams, idBytes []byte, requiresInit bool, input *pb.ChaincodeInput, chaincodeName string) (*pb.Response, *pb.ChaincodeEvent, error) {
+	endorserLogger.Infof("[%s][%s] Entry chaincode: %s", txParams.ChannelID, shorttxid(txParams.TxID), chaincodeName)
 	defer func(start time.Time) {
 		logger := endorserLogger.WithOptions(zap.AddCallerSkip(1))
 		elapsedMilliseconds := time.Since(start).Round(time.Millisecond) / time.Millisecond
-		logger.Infof("[%s][%s] Exit chaincode: %s (%dms)", txParams.ChannelID, shorttxid(txParams.TxID), cid, elapsedMilliseconds)
+		logger.Infof("[%s][%s] Exit chaincode: %s (%dms)", txParams.ChannelID, shorttxid(txParams.TxID), chaincodeName, elapsedMilliseconds)
 	}(time.Now())
 
-	res, ccevent, err := e.s.Execute(txParams, txParams.ChannelID, cid.Name, txParams.TxID, idBytes, requiresInit, txParams.SignedProp, txParams.Proposal, input)
+	res, ccevent, err := e.s.Execute(txParams, txParams.ChannelID, chaincodeName, txParams.TxID, idBytes, requiresInit, txParams.SignedProp, txParams.Proposal, input)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -145,7 +145,7 @@ func (e *Endorser) callChaincode(txParams *ccprovider.TransactionParams, idBytes
 	//
 	// NOTE that if there's an error all simulation, including the chaincode
 	// table changes in lscc will be thrown away
-	if cid.Name == "lscc" && len(input.Args) >= 3 && (string(input.Args[0]) == "deploy" || string(input.Args[0]) == "upgrade") {
+	if chaincodeName == "lscc" && len(input.Args) >= 3 && (string(input.Args[0]) == "deploy" || string(input.Args[0]) == "upgrade") {
 		userCDS, err := protoutil.GetChaincodeDeploymentSpec(input.Args[2])
 		if err != nil {
 			return nil, nil, err
@@ -197,8 +197,8 @@ func (e *Endorser) SanitizeUserCDS(userCDS *pb.ChaincodeDeploymentSpec) (*pb.Cha
 }
 
 // SimulateProposal simulates the proposal by calling the chaincode
-func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, cid *pb.ChaincodeID) (ccprovider.ChaincodeDefinition, *pb.Response, []byte, *pb.ChaincodeEvent, error) {
-	endorserLogger.Debugf("[%s][%s] Entry chaincode: %s", txParams.ChannelID, shorttxid(txParams.TxID), cid)
+func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, chaincodeName string) (ccprovider.ChaincodeDefinition, *pb.Response, []byte, *pb.ChaincodeEvent, error) {
+	endorserLogger.Debugf("[%s][%s] Entry chaincode: %s", txParams.ChannelID, shorttxid(txParams.TxID), chaincodeName)
 	defer endorserLogger.Debugf("[%s][%s] Exit", txParams.ChannelID, shorttxid(txParams.TxID))
 	// we do expect the payload to be a ChaincodeInvocationSpec
 	// if we are supporting other payloads in future, this be glaringly point
@@ -208,9 +208,9 @@ func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, cid
 		return nil, nil, nil, nil, err
 	}
 
-	cdLedger, err := e.s.GetChaincodeDefinition(txParams.ChannelID, cid.Name, txParams.TXSimulator)
+	cdLedger, err := e.s.GetChaincodeDefinition(txParams.ChannelID, chaincodeName, txParams.TXSimulator)
 	if err != nil {
-		return nil, nil, nil, nil, errors.WithMessagef(err, "make sure the chaincode %s has been successfully defined on channel %s and try again", cid.Name, txParams.ChannelID)
+		return nil, nil, nil, nil, errors.WithMessagef(err, "make sure the chaincode %s has been successfully defined on channel %s and try again", chaincodeName, txParams.ChannelID)
 	}
 
 	err = e.s.CheckInstantiationPolicy(cdLedger.CCID(), cdLedger)
@@ -219,9 +219,9 @@ func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, cid
 	}
 
 	// ---3. execute the proposal and get simulation results
-	res, ccevent, err := e.callChaincode(txParams, cdLedger.Hash(), cdLedger.RequiresInit(), cis.ChaincodeSpec.Input, cid)
+	res, ccevent, err := e.callChaincode(txParams, cdLedger.Hash(), cdLedger.RequiresInit(), cis.ChaincodeSpec.Input, chaincodeName)
 	if err != nil {
-		endorserLogger.Errorf("[%s][%s] failed to invoke chaincode %s, error: %+v", txParams.ChannelID, shorttxid(txParams.TxID), cid, err)
+		endorserLogger.Errorf("[%s][%s] failed to invoke chaincode %s, error: %+v", txParams.ChannelID, shorttxid(txParams.TxID), chaincodeName, err)
 		return nil, nil, nil, nil, err
 	}
 
@@ -240,7 +240,7 @@ func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, cid
 	}
 
 	if simResult.PvtSimulationResults != nil {
-		if cid.Name == "lscc" {
+		if chaincodeName == "lscc" {
 			// TODO: remove once we can store collection configuration outside of LSCC
 			return nil, nil, nil, nil, errors.New("Private data is forbidden to be used in instantiate")
 		}
@@ -276,13 +276,13 @@ func (e *Endorser) SimulateProposal(txParams *ccprovider.TransactionParams, cid
 }
 
 // endorse the proposal by calling the ESCC
-func (e *Endorser) endorseProposal(chainID string, txid string, signedProp *pb.SignedProposal, proposal *pb.Proposal, response *pb.Response, simRes []byte, event *pb.ChaincodeEvent, visibility []byte, ccid *pb.ChaincodeID, txsim ledger.TxSimulator, cd ccprovider.ChaincodeDefinition) (*pb.ProposalResponse, error) {
-	endorserLogger.Debugf("[%s][%s] Entry chaincode: %s", chainID, shorttxid(txid), ccid)
+func (e *Endorser) endorseProposal(chainID string, txid string, signedProp *pb.SignedProposal, proposal *pb.Proposal, response *pb.Response, simRes []byte, event *pb.ChaincodeEvent, visibility []byte, chaincodeName string, txsim ledger.TxSimulator, cd ccprovider.ChaincodeDefinition) (*pb.ProposalResponse, error) {
+	endorserLogger.Debugf("[%s][%s] Entry chaincode: %s", chainID, shorttxid(txid), chaincodeName)
 	defer endorserLogger.Debugf("[%s][%s] Exit", chainID, shorttxid(txid))
 
 	escc := cd.Endorsement()
 
-	endorserLogger.Debugf("[%s][%s] escc for chaincode %s is %s", chainID, shorttxid(txid), ccid, escc)
+	endorserLogger.Debugf("[%s][%s] escc for chaincode %s is %s", chainID, shorttxid(txid), chaincodeName, escc)
 
 	// marshalling event bytes
 	var err error
@@ -294,19 +294,20 @@ func (e *Endorser) endorseProposal(chainID string, txid string, signedProp *pb.S
 		}
 	}
 
-	ccid.Version = cd.CCVersion()
-
 	ctx := Context{
 		PluginName:     escc,
 		Channel:        chainID,
 		SignedProposal: signedProp,
-		ChaincodeID:    ccid,
-		Event:          eventBytes,
-		SimRes:         simRes,
-		Response:       response,
-		Visibility:     visibility,
-		Proposal:       proposal,
-		TxID:           txid,
+		ChaincodeID: &pb.ChaincodeID{
+			Name:    chaincodeName,
+			Version: cd.CCVersion(),
+		},
+		Event:      eventBytes,
+		SimRes:     simRes,
+		Response:   response,
+		Visibility: visibility,
+		Proposal:   proposal,
+		TxID:       txid,
 	}
 	return e.s.EndorseWithPlugin(ctx)
 }
@@ -421,7 +422,7 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 	// Also obtain a history query executor for history queries, since tx simulator does not cover history
 	var txsim ledger.TxSimulator
 	var historyQueryExecutor ledger.HistoryQueryExecutor
-	if acquireTxSimulator(chainID, vr.hdrExt.ChaincodeId) {
+	if acquireTxSimulator(chainID, vr.hdrExt.ChaincodeId.Name) {
 		if txsim, err = e.s.GetTxSimulator(chainID, txid); err != nil {
 			return &pb.ProposalResponse{Response: &pb.Response{Status: 500, Message: err.Error()}}, nil
 		}
@@ -456,7 +457,7 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 	//       to validate the supplied action before endorsing it
 
 	// 1 -- simulate
-	cd, res, simulationResult, ccevent, err := e.SimulateProposal(txParams, hdrExt.ChaincodeId)
+	cd, res, simulationResult, ccevent, err := e.SimulateProposal(txParams, hdrExt.ChaincodeId.Name)
 	if err != nil {
 		return &pb.ProposalResponse{Response: &pb.Response{Status: 500, Message: err.Error()}}, nil
 	}
@@ -488,7 +489,7 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 		pResp = &pb.ProposalResponse{Response: res}
 	} else {
 		// Note: To endorseProposal(), we pass the released txsim. Hence, an error would occur if we try to use this txsim
-		pResp, err = e.endorseProposal(chainID, txid, signedProp, prop, res, simulationResult, ccevent, hdrExt.PayloadVisibility, hdrExt.ChaincodeId, txsim, cd)
+		pResp, err = e.endorseProposal(chainID, txid, signedProp, prop, res, simulationResult, ccevent, hdrExt.PayloadVisibility, hdrExt.ChaincodeId.Name, txsim, cd)
 
 		// if error, capture endorsement failure metric
 		meterLabels := []string{
@@ -525,15 +526,15 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 
 // determine whether or not a transaction simulator should be
 // obtained for a proposal.
-func acquireTxSimulator(chainID string, ccid *pb.ChaincodeID) bool {
+func acquireTxSimulator(chainID string, chaincodeName string) bool {
 	if chainID == "" {
 		return false
 	}
 
 	// ¯\_(ツ)_/¯ locking.
 	// Don't get a simulator for the query and config system chaincode.
 	// These don't need the simulator and its read lock results in deadlocks.
-	switch ccid.Name {
+	switch chaincodeName {
 	case "qscc", "cscc":
 		return false
 	default:
diff --git a/core/endorser/endorser_test.go b/core/endorser/endorser_test.go
@@ -564,8 +564,8 @@ func TestEndorserChaincodeCallLogging(t *testing.T) {
 	es.ProcessProposal(context.Background(), getSignedProp("chaincode-name", "chaincode-version", t))
 
 	t.Logf("contents:\n%s", buf.Contents())
-	gt.Eventually(buf).Should(gbytes.Say(`INFO.*\[testchainid\]\[[[:xdigit:]]{8}\] Entry chaincode: name:"chaincode-name" version:"chaincode-version"`))
-	gt.Eventually(buf).Should(gbytes.Say(`INFO.*\[testchainid\]\[[[:xdigit:]]{8}\] Exit chaincode: name:"chaincode-name" version:"chaincode-version"  (.*ms)`))
+	gt.Eventually(buf).Should(gbytes.Say(`INFO.*\[testchainid\]\[[[:xdigit:]]{8}\] Entry chaincode: chaincode-name`))
+	gt.Eventually(buf).Should(gbytes.Say(`INFO.*\[testchainid\]\[[[:xdigit:]]{8}\] Exit chaincode: chaincode-name (.*ms)`))
 }
 
 func TestEndorserLSCC(t *testing.T) {
@@ -728,7 +728,7 @@ func TestSimulateProposal(t *testing.T) {
 		},
 	}, packaging.NewRegistry(&golang.Platform{}), &disabled.Provider{})
 
-	_, _, _, _, err := es.SimulateProposal(&ccprovider.TransactionParams{}, nil)
+	_, _, _, _, err := es.SimulateProposal(&ccprovider.TransactionParams{}, "")
 	assert.Error(t, err)
 }
 
