github.com/koko1123/flow-go-1@v0.29.6/engine/verification/requester/requester_test.go

package requester_test

import (
	"sync"
	"testing"
	"time"

	"github.com/rs/zerolog"
	testifymock "github.com/stretchr/testify/mock"
	"github.com/stretchr/testify/require"

	mockfetcher "github.com/koko1123/flow-go-1/engine/verification/fetcher/mock"
	"github.com/koko1123/flow-go-1/engine/verification/requester"
	vertestutils "github.com/koko1123/flow-go-1/engine/verification/utils/unittest"
	"github.com/koko1123/flow-go-1/model/chunks"
	"github.com/koko1123/flow-go-1/model/flow"
	"github.com/koko1123/flow-go-1/model/messages"
	"github.com/koko1123/flow-go-1/model/verification"
	"github.com/koko1123/flow-go-1/module"
	flowmempool "github.com/koko1123/flow-go-1/module/mempool"
	mempool "github.com/koko1123/flow-go-1/module/mempool/mock"
	"github.com/koko1123/flow-go-1/module/mock"
	"github.com/koko1123/flow-go-1/module/trace"
	"github.com/koko1123/flow-go-1/network/channels"
	"github.com/koko1123/flow-go-1/network/mocknetwork"
	protocol "github.com/koko1123/flow-go-1/state/protocol/mock"
	"github.com/koko1123/flow-go-1/utils/unittest"
)

// RequesterEngineTestSuite encapsulates data structures for running unittests on requester engine.
type RequesterEngineTestSuite struct {
	// modules
	log             zerolog.Logger
	handler         *mockfetcher.ChunkDataPackHandler // contains callbacks for handling received chunk data packs.
	pendingRequests *mempool.ChunkRequests            // used to store all the pending chunks that assigned to this node
	state           *protocol.State                   // used to check the last sealed height
	con             *mocknetwork.Conduit              // used to send chunk data request, and receive the response
	tracer          module.Tracer
	metrics         *mock.VerificationMetrics

	// identities
	verIdentity *flow.Identity // verification node

	// parameters
	requestTargets uint64
	retryInterval  time.Duration // determines time in milliseconds for retrying chunk data requests.
}

// setupTest initiates a test suite prior to each test.
func setupTest() *RequesterEngineTestSuite {
	r := &RequesterEngineTestSuite{
		log:             unittest.Logger(),
		tracer:          trace.NewNoopTracer(),
		metrics:         &mock.VerificationMetrics{},
		handler:         &mockfetcher.ChunkDataPackHandler{},
		retryInterval:   100 * time.Millisecond,
		requestTargets:  2,
		pendingRequests: &mempool.ChunkRequests{},
		state:           &protocol.State{},
		verIdentity:     unittest.IdentityFixture(unittest.WithRole(flow.RoleVerification)),
		con:             &mocknetwork.Conduit{},
	}

	return r
}

// newRequesterEngine returns a requester engine for testing.
func newRequesterEngine(t *testing.T, s *RequesterEngineTestSuite) *requester.Engine {
	net := &mocknetwork.Network{}
	// mocking the network registration of the engine
	net.On("Register", channels.RequestChunks, testifymock.Anything).
		Return(s.con, nil).
		Once()

	e, err := requester.New(s.log,
		s.state,
		net,
		s.tracer,
		s.metrics,
		s.pendingRequests,
		s.retryInterval,
		// requests are only qualified if their retryAfter is elapsed.
		requester.RetryAfterQualifier,
		// exponential backoff with multiplier of 2, minimum interval of a second, and
		// maximum interval of an hour.
		flowmempool.ExponentialUpdater(2, time.Hour, time.Second),
		s.requestTargets)
	require.NoError(t, err)
	testifymock.AssertExpectationsForObjects(t, net)

	e.WithChunkDataPackHandler(s.handler)

	return e
}

// TestHandleChunkDataPack_Request evaluates happy path of submitting a request to requester engine.
// The request is added to pending request mempools, and metrics updated.
func TestHandleChunkDataPack_Request(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	request := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(unittest.IdentifierFixture()))
	s.pendingRequests.On("Add", request).Return(true).Once()
	s.metrics.On("OnChunkDataPackRequestReceivedByRequester").Return().Once()

	e.Request(request)

	testifymock.AssertExpectationsForObjects(t, s.pendingRequests, s.metrics)
}

// TestHandleChunkDataPack_HappyPath evaluates the happy path of receiving a requested chunk data pack.
// The chunk data pack should be passed to the registered handler, and the resources should be cleaned up.
func TestHandleChunkDataPack_HappyPath(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	response := unittest.ChunkDataResponseMsgFixture(unittest.IdentifierFixture())
	request := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(response.ChunkDataPack.ChunkID))
	originID := unittest.IdentifierFixture()

	// we remove pending request on receiving this response
	locators := chunks.LocatorMap{}
	locators[chunks.ChunkLocatorID(request.ResultID, request.Index)] = &chunks.Locator{
		ResultID: request.ResultID,
		Index:    request.Index,
	}
	s.pendingRequests.On("PopAll", response.ChunkDataPack.ChunkID).Return(locators, true).Once()

	s.handler.On("HandleChunkDataPack", originID, &verification.ChunkDataPackResponse{
		Locator: chunks.Locator{
			ResultID: request.ResultID,
			Index:    request.Index,
		},
		Cdp: &response.ChunkDataPack,
	}).Return().Once()
	s.metrics.On("OnChunkDataPackResponseReceivedFromNetworkByRequester").Return().Once()
	s.metrics.On("OnChunkDataPackSentToFetcher").Return().Once()

	err := e.Process(channels.RequestChunks, originID, response)
	require.Nil(t, err)

	testifymock.AssertExpectationsForObjects(t, s.con, s.handler, s.pendingRequests, s.metrics)
}

// TestHandleChunkDataPack_HappyPath_Multiple evaluates the happy path of receiving several requested chunk data packs.
// Each chunk data pack should be handled once by being passed to the registered handler,
// the chunk ID and collection ID should match the response, and the resources should be cleaned up.
func TestHandleChunkDataPack_HappyPath_Multiple(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	// creates list of chunk data pack responses
	count := 10
	requests := unittest.ChunkDataPackRequestListFixture(count)
	originID := unittest.IdentifierFixture()
	chunkIDs := toChunkIDs(t, requests)
	responses := unittest.ChunkDataResponseMessageListFixture(chunkIDs)

	// we remove pending request on receiving this response
	mockPendingRequestsPopAll(t, s.pendingRequests, requests)
	// we pass each chunk data pack and its collection to chunk data pack handler
	handlerWG := mockChunkDataPackHandler(t, s.handler, requests)

	s.metrics.On("OnChunkDataPackResponseReceivedFromNetworkByRequester").Return().Times(len(responses))
	s.metrics.On("OnChunkDataPackSentToFetcher").Return().Times(len(responses))

	for _, response := range responses {
		err := e.Process(channels.RequestChunks, originID, response)
		require.Nil(t, err)
	}

	unittest.RequireReturnsBefore(t, handlerWG.Wait, 100*time.Millisecond, "could not handle chunk data responses on time")
	testifymock.AssertExpectationsForObjects(t, s.con, s.metrics)
}

// TestHandleChunkDataPack_NonExistingRequest evaluates that failing to remove a received chunk data pack's request
// from the memory terminates the procedure of handling a chunk data pack without passing it to the handler.
// The request for a chunk data pack may be removed from the memory if duplicate copies of a requested chunk data pack arrive
// concurrently. Then the mutex lock on pending requests mempool allows only one of those requested chunk data packs to remove the
// request and pass to handler. While handling the other ones gracefully terminated.
func TestHandleChunkDataPack_FailedRequestRemoval(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	response := unittest.ChunkDataResponseMsgFixture(unittest.IdentifierFixture())
	originID := unittest.IdentifierFixture()

	// however by the time we try remove it, the request has gone.
	// this can happen when duplicate chunk data packs are coming concurrently.
	// the concurrency is safe with pending requests mempool's mutex lock.
	s.pendingRequests.On("PopAll", response.ChunkDataPack.ChunkID).Return(nil, false).Once()
	s.metrics.On("OnChunkDataPackResponseReceivedFromNetworkByRequester").Return().Once()

	err := e.Process(channels.RequestChunks, originID, response)
	require.Nil(t, err)

	testifymock.AssertExpectationsForObjects(t, s.pendingRequests, s.con, s.metrics)
	s.handler.AssertNotCalled(t, "HandleChunkDataPack")
}

// TestRequestPendingChunkSealedBlock evaluates that requester engine drops pending requests for chunks belonging to
// sealed blocks, and also notifies the handler that this requested chunk has been sealed, so it no longer requests
// from the network it.
func TestRequestPendingChunkSealedBlock(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	// creates a single chunk request that belongs to a sealed height.
	agrees := unittest.IdentifierListFixture(2)
	disagrees := unittest.IdentifierListFixture(3)
	requests := unittest.ChunkDataPackRequestListFixture(1,
		unittest.WithHeight(5),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	vertestutils.MockLastSealedHeight(s.state, 10)
	s.pendingRequests.On("All").Return(requests.UniqueRequestInfo())
	// check data pack request is never tried since its block has been sealed.
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", uint64(0)).Return().Once()

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	mockPendingRequestsPopAll(t, s.pendingRequests, requests)
	notifierWG := mockNotifyBlockSealedHandler(t, s.handler, requests)

	unittest.RequireReturnsBefore(t, notifierWG.Wait, time.Duration(2)*s.retryInterval, "could not notify the handler on time")

	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")
	// requester does not call publish to disseminate the request for this chunk.
	s.con.AssertNotCalled(t, "Publish")
}

// TestCompleteRequestingUnsealedChunkCycle evaluates a complete life cycle of receiving a chunk request by the requester.
// The requester should submit the request to the network (on its timer overflow), and receive the response back and send it to
// the registered handler.
//
// It should also clean the request from memory.
func TestCompleteRequestingUnsealedChunkLifeCycle(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	sealedHeight := uint64(10)
	// Creates a single chunk request with its corresponding response.
	// The chunk belongs to an unsealed block.
	agrees := unittest.IdentifierListFixture(2)
	disagrees := unittest.IdentifierListFixture(3)
	requests := unittest.ChunkDataPackRequestListFixture(1,
		unittest.WithHeightGreaterThan(sealedHeight),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	response := unittest.ChunkDataResponseMsgFixture(requests[0].ChunkID)

	// mocks the requester pipeline
	vertestutils.MockLastSealedHeight(s.state, sealedHeight)
	s.pendingRequests.On("All").Return(requests.UniqueRequestInfo())
	handlerWG := mockChunkDataPackHandler(t, s.handler, requests)
	mockPendingRequestsPopAll(t, s.pendingRequests, requests)

	// makes all chunk requests being qualified for dispatch instantly
	requestHistoryWG, updateHistoryWG := mockPendingRequestInfoAndUpdate(t,
		s.pendingRequests,
		requests,
		verification.ChunkDataPackRequestList{},
		verification.ChunkDataPackRequestList{},
		1)
	s.metrics.On("OnChunkDataPackResponseReceivedFromNetworkByRequester").Return().Times(len(requests))
	s.metrics.On("OnChunkDataPackRequestDispatchedInNetworkByRequester").Return().Times(len(requests))
	s.metrics.On("OnChunkDataPackSentToFetcher").Return().Times(len(requests))
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", uint64(1)).Return().Once()

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	// we wait till the engine submits the chunk request to the network, and receive the response
	conduitWG := mockConduitForChunkDataPackRequest(t, s.con, requests, 1, func(request *messages.ChunkDataRequest) {
		err := e.Process(channels.RequestChunks, requests[0].Agrees[0], response)
		require.NoError(t, err)
	})
	unittest.RequireReturnsBefore(t, requestHistoryWG.Wait, time.Duration(2)*s.retryInterval, "could not check chunk requests qualification on time")
	unittest.RequireReturnsBefore(t, updateHistoryWG.Wait, s.retryInterval, "could not update chunk request history on time")
	unittest.RequireReturnsBefore(t, conduitWG.Wait, time.Duration(2)*s.retryInterval, "could not request chunks from network")
	unittest.RequireReturnsBefore(t, handlerWG.Wait, 100*time.Second, "could not handle chunk data responses on time")

	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")
	testifymock.AssertExpectationsForObjects(t, s.metrics)
}

// TestRequestPendingChunkSealedBlock_Hybrid evaluates the situation that requester has some pending chunk requests belonging to sealed blocks
// (i.e., sealed chunks), and some pending chunk requests belonging to unsealed blocks (i.e., unsealed chunks).
//
// On timer, the requester should submit pending requests for unsealed chunks to the network, while dropping the requests for the
// sealed chunks, and notify the handler.
func TestRequestPendingChunkSealedBlock_Hybrid(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	sealedHeight := uint64(10)
	// creates 2 chunk data packs that belong to a sealed height, and
	// 3 that belong to an unsealed height.
	agrees := unittest.IdentifierListFixture(2)
	disagrees := unittest.IdentifierListFixture(3)
	sealedRequests := unittest.ChunkDataPackRequestListFixture(2,
		unittest.WithHeight(sealedHeight-1),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	unsealedRequests := unittest.ChunkDataPackRequestListFixture(3,
		unittest.WithHeightGreaterThan(sealedHeight),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	requests := append(sealedRequests, unsealedRequests...)

	vertestutils.MockLastSealedHeight(s.state, sealedHeight)
	s.pendingRequests.On("All").Return(requests.UniqueRequestInfo())

	// makes all (unsealed) chunk requests being qualified for dispatch instantly
	requestHistoryWG, updateHistoryWG := mockPendingRequestInfoAndUpdate(t,
		s.pendingRequests,
		unsealedRequests,
		verification.ChunkDataPackRequestList{},
		verification.ChunkDataPackRequestList{},
		1)
	s.metrics.On("OnChunkDataPackRequestDispatchedInNetworkByRequester").Return().Times(len(unsealedRequests))
	// each unsealed height is requested only once, hence the maximum is updated only once from 0 -> 1
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", testifymock.Anything).Return().Once()

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	// sealed requests should be removed and the handler should be notified.
	mockPendingRequestsPopAll(t, s.pendingRequests, sealedRequests)
	notifierWG := mockNotifyBlockSealedHandler(t, s.handler, sealedRequests)
	// unsealed requests should be submitted to the network once
	conduitWG := mockConduitForChunkDataPackRequest(t, s.con, unsealedRequests, 1, func(*messages.ChunkDataRequest) {})

	unittest.RequireReturnsBefore(t, requestHistoryWG.Wait, time.Duration(2)*s.retryInterval, "could not check chunk requests qualification on time")
	unittest.RequireReturnsBefore(t, updateHistoryWG.Wait, s.retryInterval, "could not update chunk request history on time")
	unittest.RequireReturnsBefore(t, notifierWG.Wait, time.Duration(2)*s.retryInterval, "could not notify the handler on time")
	unittest.RequireReturnsBefore(t, conduitWG.Wait, time.Duration(2)*s.retryInterval, "could not request chunks from network")
	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")

	testifymock.AssertExpectationsForObjects(t, s.metrics)
}

// TestReceivingChunkDataResponseForDuplicateChunkRequests evaluates happy path of receiving a chunk data pack response
// for duplicate chunk data pack requests.
// On receiving the chunk data pack, requester engine should send a chunk data response to the chunk handler for each
// of those pending duplicate chunk data requests.
// Note that by duplicate chunk data requests we mean chunks requests for same chunk ID that belong to
// distinct execution results.
func TestReceivingChunkDataResponseForDuplicateChunkRequests(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	resultA, _, _, _ := vertestutils.ExecutionResultForkFixture(t)

	duplicateChunkID := resultA.Chunks[0].ID()
	responseA := unittest.ChunkDataResponseMsgFixture(duplicateChunkID)

	requestA := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(duplicateChunkID))
	requestB := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(duplicateChunkID))

	requests := verification.ChunkDataPackRequestList{requestA, requestB}
	originID := unittest.IdentifierFixture()

	mockPendingRequestsPopAll(t, s.pendingRequests, requests)
	handlerWG := mockChunkDataPackHandler(t, s.handler, requests)

	s.metrics.On("OnChunkDataPackResponseReceivedFromNetworkByRequester").Return().Once()
	s.metrics.On("OnChunkDataPackSentToFetcher").Return().Twice()

	err := e.Process(channels.RequestChunks, originID, responseA)
	require.Nil(t, err)

	unittest.RequireReturnsBefore(t, handlerWG.Wait, time.Second, "could not handle chunk data responses on time")
	testifymock.AssertExpectationsForObjects(t, s.con, s.metrics)
}

// TestHandleChunkDataPack_DuplicateChunkIDs_Sealed evaluates that on receiving duplicate chunk data requests belonging to a sealed
// block, the requester engine is called chunk handler once for each of those requests notifying it of sealed block.
//
// Note that by duplicate chunk data requests we mean chunks requests for same chunk ID that belong to
// distinct execution results.
func TestHandleChunkDataPack_DuplicateChunkIDs_Sealed(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	// mocks the requester pipeline
	sealedHeight := uint64(10)
	vertestutils.MockLastSealedHeight(s.state, sealedHeight)

	resultA, _, _, _ := vertestutils.ExecutionResultForkFixture(t)
	duplicateChunkID := resultA.Chunks[0].ID()
	requestA := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(duplicateChunkID), unittest.WithHeight(uint64(sealedHeight-1)))
	requestB := unittest.ChunkDataPackRequestFixture(unittest.WithChunkID(duplicateChunkID), unittest.WithHeight(uint64(sealedHeight-1)))
	requests := verification.ChunkDataPackRequestList{requestA, requestB}

	// we remove pending request on receiving this response
	s.pendingRequests.On("All").Return(requests.UniqueRequestInfo())
	mockPendingRequestsPopAll(t, s.pendingRequests, requests)
	notifierWG := mockNotifyBlockSealedHandler(t, s.handler, requests)

	// check data pack request is never tried since its block has been sealed.
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", uint64(0)).Return().Once()

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	unittest.RequireReturnsBefore(t, notifierWG.Wait, time.Duration(2)*s.retryInterval, "could not notify the handler on time")

	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")

	testifymock.AssertExpectationsForObjects(t, s.metrics)
	// requester does not call publish to disseminate the request for this chunk.
	s.con.AssertNotCalled(t, "Publish")
}

// TestRequestPendingChunkDataPack evaluates happy path of having a single pending chunk requests.
// The chunk belongs to a non-sealed block.
// On timer interval, the chunk requests should be dispatched to the set of execution nodes agree with the execution
// result the chunk belongs to.
func TestRequestPendingChunkDataPack(t *testing.T) {
	testRequestPendingChunkDataPack(t, 1, 1)   // one request each one attempt
	testRequestPendingChunkDataPack(t, 10, 1)  // 10 requests each one attempt
	testRequestPendingChunkDataPack(t, 10, 10) // 10 requests each 10 attempts
}

// testRequestPendingChunkDataPack is a test helper that evaluates happy path of having a number of chunk requests pending.
// The test waits enough so that the required number of attempts is made on the chunks.
// The chunks belongs to a non-sealed block.
func testRequestPendingChunkDataPack(t *testing.T, count int, attempts int) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	// creates 10 chunk request each with 2 agree targets and 3 disagree targets.
	// chunk belongs to a block at heights greater than 5, but the last sealed block is at height 5, so
	// the chunk request should be dispatched.
	agrees := unittest.IdentifierListFixture(2)
	disagrees := unittest.IdentifierListFixture(3)
	requests := unittest.ChunkDataPackRequestListFixture(count,
		unittest.WithHeightGreaterThan(5),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	vertestutils.MockLastSealedHeight(s.state, 5)
	s.pendingRequests.On("All").Return(requests.UniqueRequestInfo())

	// makes all chunk requests being qualified for dispatch instantly
	requestHistory, updateHistoryWG := mockPendingRequestInfoAndUpdate(t,
		s.pendingRequests,
		requests,
		verification.ChunkDataPackRequestList{},
		verification.ChunkDataPackRequestList{},
		attempts)

	s.metrics.On("OnChunkDataPackRequestDispatchedInNetworkByRequester").Return().Times(count * attempts)
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", testifymock.Anything).Run(func(args testifymock.Arguments) {
		actualAttempts, ok := args[0].(uint64)
		require.True(t, ok)

		require.LessOrEqual(t, actualAttempts, uint64(attempts))
	}).Return().Times(attempts)

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	conduitWG := mockConduitForChunkDataPackRequest(t, s.con, requests, attempts, func(*messages.ChunkDataRequest) {})
	unittest.RequireReturnsBefore(t, requestHistory.Wait, time.Duration(2*attempts)*s.retryInterval, "could not check chunk requests qualification on time")
	unittest.RequireReturnsBefore(t, updateHistoryWG.Wait, s.retryInterval, "could not update chunk request history on time")
	unittest.RequireReturnsBefore(t, conduitWG.Wait, time.Duration(2*attempts)*s.retryInterval, "could not request and handle chunks on time")

	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")
	testifymock.AssertExpectationsForObjects(t, s.pendingRequests, s.metrics)
}

// TestDispatchingRequests_Hybrid evaluates the behavior of requester when it has different request dispatch timelines, i.e.,
// some requests should be dispatched instantly to the network. Some others are old and planned for late dispatch (out of this test timeline),
// and some other should not be dispatched since they no longer are needed (and will be cleaned on next iteration).
//
// The test evaluates that only requests that are instantly planned are getting dispatched to the network.
func TestDispatchingRequests_Hybrid(t *testing.T) {
	s := setupTest()
	e := newRequesterEngine(t, s)

	// Generates 30 requests, 10 of each type.
	//
	// requests belong to the chunks of
	// a block at heights greater than 5, but the last sealed block is at height 5, so
	// the chunk request should be dispatched.
	agrees := unittest.IdentifierListFixture(2)
	disagrees := unittest.IdentifierListFixture(3)
	vertestutils.MockLastSealedHeight(s.state, 5)
	// models new requests that are just added to the mempool and are ready to dispatch.
	instantQualifiedRequests := unittest.ChunkDataPackRequestListFixture(10,
		unittest.WithHeightGreaterThan(5),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	// models old requests that stayed long in the mempool and are not dispatched anytime soon.
	lateQualifiedRequests := unittest.ChunkDataPackRequestListFixture(10,
		unittest.WithHeightGreaterThan(5),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))
	// models requests that their chunk data pack arrives during the dispatch processing and hence
	// are no longer needed to dispatch.
	disQualifiedRequests := unittest.ChunkDataPackRequestListFixture(10,
		unittest.WithHeightGreaterThan(5),
		unittest.WithAgrees(agrees),
		unittest.WithDisagrees(disagrees))

	allRequests := append(instantQualifiedRequests, lateQualifiedRequests...)
	allRequests = append(allRequests, disQualifiedRequests...)
	s.pendingRequests.On("All").Return(allRequests.UniqueRequestInfo())

	attempts := 10 // waits for 10 iterations of onTimer cycle in requester.
	requestHistoryWG, updateHistoryWG := mockPendingRequestInfoAndUpdate(t,
		s.pendingRequests,
		instantQualifiedRequests,
		lateQualifiedRequests,
		disQualifiedRequests,
		attempts)

	unittest.RequireCloseBefore(t, e.Ready(), time.Second, "could not start engine on time")

	// mocks only instantly qualified requests are dispatched in the network.
	conduitWG := mockConduitForChunkDataPackRequest(t, s.con, instantQualifiedRequests, attempts, func(*messages.ChunkDataRequest) {})
	s.metrics.On("OnChunkDataPackRequestDispatchedInNetworkByRequester").Return().Times(len(instantQualifiedRequests) * attempts)
	// each instantly qualified one is requested only once, hence the maximum is updated only once from 0 -> 1, and
	// is kept at 1 during all cycles of this test.
	s.metrics.On("SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester", uint64(1)).Return()

	unittest.RequireReturnsBefore(t, requestHistoryWG.Wait, time.Duration(2*attempts)*s.retryInterval,
		"could not check chunk requests qualification on time")
	unittest.RequireReturnsBefore(t, updateHistoryWG.Wait, time.Duration(2*attempts)*s.retryInterval,
		"could not update chunk request history on time")
	unittest.RequireReturnsBefore(t, conduitWG.Wait, time.Duration(2*attempts)*s.retryInterval,
		"could not request and handle chunks on time")
	unittest.RequireCloseBefore(t, e.Done(), time.Second, "could not stop engine on time")

	testifymock.AssertExpectationsForObjects(t, s.pendingRequests, s.metrics)
}

// toChunkIDs is a test helper that extracts chunk ids from chunk data pack requests.
func toChunkIDs(t *testing.T, requests verification.ChunkDataPackRequestList) flow.IdentifierList {
	var chunkIDs flow.IdentifierList
	for _, request := range requests {
		require.NotContains(t, chunkIDs, request.ChunkID, "duplicate chunk ID found in fixture")
		chunkIDs = append(chunkIDs, request.ChunkID)
	}
	return chunkIDs
}

// mockConduitForChunkDataPackRequest mocks given conduit for requesting chunk data packs for given chunk IDs.
// Each chunk should be requested exactly `count` many time.
// Upon request, the given request handler is invoked.
// Also, the entire process should not exceed longer than the specified timeout.
func mockConduitForChunkDataPackRequest(t *testing.T,
	con *mocknetwork.Conduit,
	reqList verification.ChunkDataPackRequestList,
	count int,
	requestHandler func(*messages.ChunkDataRequest)) *sync.WaitGroup {

	// counts number of requests for each chunk data pack
	reqCount := make(map[flow.Identifier]int)
	reqMap := make(map[flow.Identifier]*verification.ChunkDataPackRequest)
	for _, request := range reqList {
		reqCount[request.ChunkID] = 0
		reqMap[request.ChunkID] = request
	}
	wg := &sync.WaitGroup{}

	// to counter race condition in concurrent invocations of Run
	mutex := &sync.Mutex{}
	wg.Add(count * len(reqList))

	con.On("Publish", testifymock.Anything, testifymock.Anything, testifymock.Anything).
		Run(func(args testifymock.Arguments) {
			mutex.Lock()
			defer mutex.Unlock()

			// requested chunk id from network should belong to list of chunk id requests the engine received.
			// also, it should not be repeated below a maximum threshold
			req, ok := args[0].(*messages.ChunkDataRequest)
			require.True(t, ok)
			require.True(t, reqList.ContainsChunkID(req.ChunkID))
			require.LessOrEqual(t, reqCount[req.ChunkID], count)
			reqCount[req.ChunkID]++

			// requested chunk ids should only be passed to agreed execution nodes
			target1, ok := args[1].(flow.Identifier)
			require.True(t, ok)
			require.Contains(t, reqMap[req.ChunkID].Agrees, target1)

			target2, ok := args[2].(flow.Identifier)
			require.True(t, ok)
			require.Contains(t, reqMap[req.ChunkID].Agrees, target2)

			go func() {
				requestHandler(req)
				wg.Done()
			}()

		}).Return(nil)

	return wg
}

// mockChunkDataPackHandler mocks chunk data pack handler for receiving a set of chunk responses.
// It evaluates that, each pair of (chunkIndex, resultID) should be passed exactly once.
func mockChunkDataPackHandler(t *testing.T, handler *mockfetcher.ChunkDataPackHandler, requests verification.ChunkDataPackRequestList) *sync.WaitGroup {
	handledLocators := make(map[flow.Identifier]struct{})

	wg := sync.WaitGroup{}
	wg.Add(len(requests))
	handler.On("HandleChunkDataPack", testifymock.Anything, testifymock.Anything).
		Run(func(args testifymock.Arguments) {
			_, ok := args[0].(flow.Identifier)
			require.True(t, ok)
			response, ok := args[1].(*verification.ChunkDataPackResponse)
			require.True(t, ok)

			// we should have already requested this chunk data pack.
			require.True(t, requests.ContainsLocator(response.ResultID, response.Index))
			require.True(t, requests.ContainsChunkID(response.Cdp.ChunkID))

			// invocation should be distinct per chunk ID
			locatorID := chunks.ChunkLocatorID(response.ResultID, response.Index)
			_, ok = handledLocators[locatorID]
			require.False(t, ok)

			handledLocators[locatorID] = struct{}{}

			wg.Done()
		}).Return()

	return &wg
}

// mockChunkDataPackHandler mocks chunk data pack handler for being notified that a set of chunk IDs are sealed.
// It evaluates that, each chunk ID should be notified only once.
func mockNotifyBlockSealedHandler(t *testing.T, handler *mockfetcher.ChunkDataPackHandler, requests verification.ChunkDataPackRequestList) *sync.WaitGroup {

	wg := &sync.WaitGroup{}
	wg.Add(len(requests))
	// maps keep track of distinct invocations per chunk ID
	seen := make(map[flow.Identifier]struct{})
	handler.On("NotifyChunkDataPackSealed", testifymock.Anything, testifymock.Anything).
		Run(func(args testifymock.Arguments) {
			chunkIndex, ok := args[0].(uint64)
			require.True(t, ok)
			resultID, ok := args[1].(flow.Identifier)
			require.True(t, ok)

			// we should have already requested this chunk data pack, and collection ID should be the same.
			require.True(t, requests.ContainsLocator(resultID, chunkIndex))

			// invocation should be distinct per chunk ID
			locatorID := chunks.ChunkLocatorID(resultID, chunkIndex)
			_, ok = seen[locatorID]
			require.False(t, ok)
			seen[locatorID] = struct{}{}

			wg.Done()
		}).Return()

	return wg
}

// mockPendingRequestsPopAll mocks chunk requests mempool for being queried for returning all requests associated with a
// chunk ID only once.
func mockPendingRequestsPopAll(t *testing.T, pendingRequests *mempool.ChunkRequests, requests verification.ChunkDataPackRequestList) {
	// maps keep track of distinct invocations per chunk ID
	seen := make(map[flow.Identifier]struct{})

	pendingRequests.On("PopAll", testifymock.Anything).
		Return(
			func(chunkID flow.Identifier) chunks.LocatorMap {
				locators := make(chunks.LocatorMap)

				// chunk ID must not be seen
				_, ok := seen[chunkID]
				require.False(t, ok)

				for _, request := range requests {
					if request.ChunkID == chunkID {
						locator := request.Locator
						locators[locator.ID()] = &locator
					}
				}

				seen[chunkID] = struct{}{}
				return locators
			},
			func(chunkID flow.Identifier) bool {
				for _, request := range requests {
					if request.ChunkID == chunkID {
						return true
					}
				}

				return false
			},
		)
}

// mockPendingRequestInfoAndUpdate mocks pending requests mempool regarding three sets of chunk IDs: the instant, late, and disqualified ones.
// The chunk IDs in the instantly qualified requests will be instantly qualified for dispatching in the networking layer.
// The chunk IDs in the late qualified requests will be postponed to a very later time for dispatching. The postponed time is set so long
// that they literally never get the chance to dispatch within the test time, e.g., 1 hour.
// The chunk IDs in the disqualified requests do not dispatch at all.
//
// The disqualified ones represent the set of chunk requests that are cleaned from memory during the on timer iteration of the requester
// engine, and are no longer needed.
func mockPendingRequestInfoAndUpdate(t *testing.T,
	pendingRequests *mempool.ChunkRequests,
	instantQualifiedReqs verification.ChunkDataPackRequestList,
	lateQualifiedReqs verification.ChunkDataPackRequestList,
	disQualifiedReqs verification.ChunkDataPackRequestList,
	attempts int) (*sync.WaitGroup, *sync.WaitGroup) {

	historyWG := &sync.WaitGroup{}

	// for purpose of test and due to having a mocked mempool, we assume disqualified requests reside on the
	// mempool, so their qualification is getting checked on each attempt iteration (and rejected).
	totalRequestHistory := attempts * (len(instantQualifiedReqs) + len(lateQualifiedReqs) + len(disQualifiedReqs))
	historyWG.Add(totalRequestHistory)

	pendingRequests.On("RequestHistory", testifymock.Anything).
		Run(func(args testifymock.Arguments) {
			// type assertion of input.
			chunkID, ok := args[0].(flow.Identifier)
			require.True(t, ok)

			// chunk ID should be one of the expected ones.
			require.True(t,
				instantQualifiedReqs.ContainsChunkID(chunkID) ||
					lateQualifiedReqs.ContainsChunkID(chunkID) ||
					disQualifiedReqs.ContainsChunkID(chunkID))

			historyWG.Done()

		}).Return(
		// number of attempts
		func(chunkID flow.Identifier) uint64 {
			if instantQualifiedReqs.ContainsChunkID(chunkID) || lateQualifiedReqs.ContainsChunkID(chunkID) {
				return uint64(1)
			}

			return uint64(0)

		}, // last tried timestamp
		func(chunkID flow.Identifier) time.Time {
			if instantQualifiedReqs.ContainsChunkID(chunkID) {
				// mocks last tried long enough so they instantly get qualified.
				return time.Now().Add(-1 * time.Hour)
			}

			if lateQualifiedReqs.ContainsChunkID(chunkID) {
				return time.Now()
			}

			return time.Time{}
		}, // retry after duration
		func(chunkID flow.Identifier) time.Duration {
			if instantQualifiedReqs.ContainsChunkID(chunkID) {
				// mocks retry after very short so they instantly get qualified.
				return 1 * time.Millisecond
			}

			if lateQualifiedReqs.ContainsChunkID(chunkID) {
				// mocks retry after long so they never qualify soon.
				return time.Hour
			}

			return 0

		}, // request info existence
		func(chunkID flow.Identifier) bool {
			if instantQualifiedReqs.ContainsChunkID(chunkID) || lateQualifiedReqs.ContainsChunkID(chunkID) {
				return true
			}

			return false
		},
	)

	updateWG := &sync.WaitGroup{}
	updateWG.Add(len(instantQualifiedReqs) * attempts)
	pendingRequests.On("UpdateRequestHistory", testifymock.Anything, testifymock.Anything).
		Run(func(args testifymock.Arguments) {
			// type assertion of inputs.
			chunkID, ok := args[0].(flow.Identifier)
			require.True(t, ok)

			_, ok = args[1].(flowmempool.ChunkRequestHistoryUpdaterFunc)
			require.True(t, ok)

			// checks only instantly qualified chunk requests should reach to this step,
			// i.e., invocation of UpdateRequestHistory
			require.True(t, instantQualifiedReqs.ContainsChunkID(chunkID))
			require.False(t, lateQualifiedReqs.ContainsChunkID(chunkID))
			require.False(t, disQualifiedReqs.ContainsChunkID(chunkID))

			updateWG.Done()

		}).
		Return(uint64(1), time.Now(), 1*time.Millisecond, true)

	return historyWG, updateWG
}