Added RetrieveBlockByNumber into blockledger (#2635)

GetBlock is used for retrieving a block in ConfigBlockOrPanic
which has overhead of Iterator. It is now simplified by exposing
a BlockStore function RetrieveBlockByNumber.

Signed-off-by: Parameswaran Selvam <parselva@in.ibm.com>

common/ledger/blockledger/fileledger/impl.go

@@ -29,6 +29,7 @@ type FileLedgerBlockStore interface {
 	GetBlockchainInfo() (*cb.BlockchainInfo, error)
 	RetrieveBlocks(startBlockNumber uint64) (ledger.ResultsIterator, error)
 	Shutdown()
+	RetrieveBlockByNumber(blockNum uint64) (*cb.Block, error)
 }
 
 // NewFileLedger creates a new FileLedger for interaction with the ledger
@@ -93,6 +94,7 @@ func (fl *FileLedger) Iterator(startPosition *ab.SeekPosition) (blockledger.Iter
 
 	iterator, err := fl.blockStore.RetrieveBlocks(startingBlockNumber)
 	if err != nil {
+		logger.Warnw("Failed to initialize block iterator", "blockNum", startingBlockNumber, "error", err)
 		return &blockledger.NotFoundErrorIterator{}, 0
 	}
 
@@ -117,3 +119,7 @@ func (fl *FileLedger) Append(block *cb.Block) error {
 	}
 	return err
 }
+
+func (fl *FileLedger) RetrieveBlockByNumber(blockNumber uint64) (*cb.Block, error) {
+	return fl.blockStore.RetrieveBlockByNumber(blockNumber)
+}

common/ledger/blockledger/ledger.go

@@ -43,6 +43,8 @@ type Reader interface {
 	Iterator(startType *ab.SeekPosition) (Iterator, uint64)
 	// Height returns the number of blocks on the ledger
 	Height() uint64
+	// retrieve blockByNumber
+	RetrieveBlockByNumber(blockNumber uint64) (*cb.Block, error)
 }
 
 // Writer allows the caller to modify the ledger

common/ledger/blockledger/util.go

@@ -10,9 +10,12 @@ import (
 	"github.com/golang/protobuf/proto"
 	cb "github.com/hyperledger/fabric-protos-go/common"
 	ab "github.com/hyperledger/fabric-protos-go/orderer"
+	"github.com/hyperledger/fabric/common/flogging"
 	"github.com/hyperledger/fabric/protoutil"
 )
 
+var logger = flogging.MustGetLogger("common.ledger.blockledger.util")
+
 var closedChan chan struct{}
 
 func init() {
@@ -95,3 +98,8 @@ func GetBlock(rl Reader, index uint64) *cb.Block {
 	}
 	return block
 }
+
+func GetBlockByNumber(rl Reader, blockNum uint64) (*cb.Block, error) {
+	logger.Debugw("Retrieving block", "blockNum", blockNum)
+	return rl.RetrieveBlockByNumber(blockNum)
+}

core/peer/deliverevents_test.go

@@ -95,6 +95,11 @@ func (m *mockReader) Height() uint64 {
 	return args.Get(0).(uint64)
 }
 
+func (m *mockReader) RetrieveBlockByNumber(blockNum uint64) (*common.Block, error) {
+	args := m.Called()
+	return args.Get(0).(*common.Block), args.Error(1)
+}
+
 // mockChainSupport
 type mockChainSupport struct {
 	mock.Mock

core/peer/peer.go

@@ -513,3 +513,7 @@ func (p *Peer) Initialize(
 		p.initChannel(cid)
 	}
 }
+
+func (flbs fileLedgerBlockStore) RetrieveBlockByNumber(blockNum uint64) (*common.Block, error) {
+	return flbs.GetBlockByNumber(blockNum)
+}