[FAB-5360] Populate BroadcastResponse info field

This CR modifies the broadcast.go implementation of the Broadcast interface to populate the info field with the error text of the error which caused a broadcast to fail. Additional context for the error is now available for all status codes except for SUCCESS which requires no additional info. Change-Id: I3c39fbef0d42edbe4d9382d7811014b4dfa41689 Signed-off-by: Jason Yellick <[email protected]>
hyperledger · Jul 27, 2017 · 9c0a9e2 · 9c0a9e2
1 parent d18601e
commit 9c0a9e2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/orderer/common/broadcast/broadcast.go b/orderer/common/broadcast/broadcast.go
@@ -76,7 +76,7 @@ func (bh *handlerImpl) Handle(srv ab.AtomicBroadcast_BroadcastServer) error {
 		chdr, isConfig, processor, err := bh.sm.BroadcastChannelSupport(msg)
 		if err != nil {
 			logger.Warningf("[channel: %s] Could not get message processor: %s", chdr.ChannelId, err)
-			return srv.Send(&ab.BroadcastResponse{Status: cb.Status_INTERNAL_SERVER_ERROR})
+			return srv.Send(&ab.BroadcastResponse{Status: cb.Status_INTERNAL_SERVER_ERROR, Info: err.Error()})
 		}
 
 		if !isConfig {
@@ -85,27 +85,27 @@ func (bh *handlerImpl) Handle(srv ab.AtomicBroadcast_BroadcastServer) error {
 			configSeq, err := processor.ProcessNormalMsg(msg)
 			if err != nil {
 				logger.Warningf("[channel: %s] Rejecting broadcast of normal message because of error: %s", chdr.ChannelId, err)
-				return srv.Send(&ab.BroadcastResponse{Status: ClassifyError(err)})
+				return srv.Send(&ab.BroadcastResponse{Status: ClassifyError(err), Info: err.Error()})
 			}
 
 			err = processor.Order(msg, configSeq)
 			if err != nil {
-				logger.Warningf("[channel: %s] Rejecting broadcast of normal message with SERVICE_UNAVAILABLE: reject by Order: %s", chdr.ChannelId, err)
-				return srv.Send(&ab.BroadcastResponse{Status: cb.Status_SERVICE_UNAVAILABLE})
+				logger.Warningf("[channel: %s] Rejecting broadcast of normal message with SERVICE_UNAVAILABLE: rejected by Order: %s", chdr.ChannelId, err)
+				return srv.Send(&ab.BroadcastResponse{Status: cb.Status_SERVICE_UNAVAILABLE, Info: err.Error()})
 			}
 		} else { // isConfig
 			logger.Debugf("[channel: %s] Broadcast is processing config update message", chdr.ChannelId)
 
 			config, configSeq, err := processor.ProcessConfigUpdateMsg(msg)
 			if err != nil {
 				logger.Warningf("[channel: %s] Rejecting broadcast of config message because of error: %s", chdr.ChannelId, err)
-				return srv.Send(&ab.BroadcastResponse{Status: ClassifyError(err)})
+				return srv.Send(&ab.BroadcastResponse{Status: ClassifyError(err), Info: err.Error()})
 			}
 
 			err = processor.Configure(msg, config, configSeq)
 			if err != nil {
 				logger.Warningf("[channel: %s] Rejecting broadcast of config message with SERVICE_UNAVAILABLE: rejected by Configure: %s", chdr.ChannelId, err)
-				return srv.Send(&ab.BroadcastResponse{Status: cb.Status_SERVICE_UNAVAILABLE})
+				return srv.Send(&ab.BroadcastResponse{Status: cb.Status_SERVICE_UNAVAILABLE, Info: err.Error()})
 			}
 		}
 

diff --git a/orderer/common/broadcast/broadcast_test.go b/orderer/common/broadcast/broadcast_test.go
@@ -242,6 +242,7 @@ func TestRejected(t *testing.T) {
 	m.recvChan <- nil
 	reply := <-m.sendChan
 	assert.Equal(t, cb.Status_BAD_REQUEST, reply.Status, "Should have rejected CONFIG_UPDATE")
+	assert.Equal(t, mm.MsgProcessorVal.ProcessErr.Error(), reply.Info, "Should have rejected CONFIG_UPDATE")
 }
 
 func TestBadStreamRecv(t *testing.T) {