lotus/storage/pipeline/precommit_batch_test.go

// stm: #unit
package sealing_test

import (
	"bytes"
	"context"
	"sort"
	"sync"
	"testing"
	"time"

	"github.com/golang/mock/gomock"
	"github.com/stretchr/testify/require"

	"github.com/filecoin-project/go-address"
	"github.com/filecoin-project/go-state-types/abi"
	"github.com/filecoin-project/go-state-types/big"
	minertypes "github.com/filecoin-project/go-state-types/builtin/v9/miner"
	"github.com/filecoin-project/go-state-types/network"
	miner6 "github.com/filecoin-project/specs-actors/v6/actors/builtin/miner"

	"github.com/filecoin-project/lotus/api"
	"github.com/filecoin-project/lotus/chain/types"
	"github.com/filecoin-project/lotus/node/config"
	pipeline "github.com/filecoin-project/lotus/storage/pipeline"
	"github.com/filecoin-project/lotus/storage/pipeline/mocks"
	"github.com/filecoin-project/lotus/storage/pipeline/sealiface"
)

var fc = config.MinerFeeConfig{
	MaxPreCommitGasFee:      types.FIL(types.FromFil(1)),
	MaxCommitGasFee:         types.FIL(types.FromFil(1)),
	MaxTerminateGasFee:      types.FIL(types.FromFil(1)),
	MaxPreCommitBatchGasFee: config.BatchFeeConfig{Base: types.FIL(types.FromFil(3)), PerSector: types.FIL(types.FromFil(1))},
	MaxCommitBatchGasFee:    config.BatchFeeConfig{Base: types.FIL(types.FromFil(3)), PerSector: types.FIL(types.FromFil(1))},
}

func TestPrecommitBatcher(t *testing.T) {
	//stm: @CHAIN_STATE_MINER_CALCULATE_DEADLINE_001
	t0123, err := address.NewFromString("t0123")
	require.NoError(t, err)

	ctx := context.Background()

	as := asel(func(ctx context.Context, mi api.MinerInfo, use api.AddrUse, goodFunds, minFunds abi.TokenAmount) (address.Address, abi.TokenAmount, error) {
		return t0123, big.Zero(), nil
	})

	maxBatch := miner6.PreCommitSectorBatchMaxSize

	cfg := func() (sealiface.Config, error) {
		return sealiface.Config{
			MaxWaitDealsSectors:       2,
			MaxSealingSectors:         0,
			MaxSealingSectorsForDeals: 0,
			WaitDealsDelay:            time.Hour * 6,
			AlwaysKeepUnsealedCopy:    true,

			MaxPreCommitBatch:          maxBatch,
			PreCommitBatchWait:         24 * time.Hour,
			PreCommitBatchSlack:        3 * time.Hour,
			BatchPreCommitAboveBaseFee: big.NewInt(10000),

			AggregateCommits: true,
			MinCommitBatch:   miner6.MinAggregatedSectors,
			MaxCommitBatch:   miner6.MaxAggregatedSectors,
			CommitBatchWait:  24 * time.Hour,
			CommitBatchSlack: 1 * time.Hour,

			TerminateBatchMin:  1,
			TerminateBatchMax:  100,
			TerminateBatchWait: 5 * time.Minute,
		}, nil
	}

	type promise func(t *testing.T)
	type action func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise

	actions := func(as ...action) action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			var ps []promise
			for _, a := range as {
				p := a(t, s, pcb)
				if p != nil {
					ps = append(ps, p)
				}
			}

			if len(ps) > 0 {
				return func(t *testing.T) {
					for _, p := range ps {
						p(t)
					}
				}
			}
			return nil
		}
	}

	addSector := func(sn abi.SectorNumber, aboveBalancer bool) action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			var pcres sealiface.PreCommitBatchRes
			var pcerr error
			done := sync.Mutex{}
			done.Lock()

			si := pipeline.SectorInfo{
				SectorNumber: sn,
			}

			basefee := big.NewInt(9999)
			if aboveBalancer {
				basefee = big.NewInt(10001)
			}

			s.EXPECT().ChainHead(gomock.Any()).Return(makeBFTs(t, basefee, 1), nil).MaxTimes(2) // once in AddPreCommit

			go func() {
				defer done.Unlock()
				pcres, pcerr = pcb.AddPreCommit(ctx, si, big.Zero(), &minertypes.SectorPreCommitInfo{
					SectorNumber: si.SectorNumber,
					SealedCID:    fakePieceCid(t),
					DealIDs:      nil,
					Expiration:   0,
				})
			}()

			return func(t *testing.T) {
				done.Lock()
				require.NoError(t, pcerr)
				require.Empty(t, pcres.Error)
				require.Contains(t, pcres.Sectors, si.SectorNumber)
			}
		}
	}

	addSectors := func(sectors []abi.SectorNumber, aboveBalancer bool) action {
		as := make([]action, len(sectors))
		for i, sector := range sectors {
			as[i] = addSector(sector, aboveBalancer)
		}
		return actions(as...)
	}

	waitPending := func(n int) action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			require.Eventually(t, func() bool {
				p, err := pcb.Pending(ctx)
				require.NoError(t, err)
				return len(p) == n
			}, time.Second*5, 10*time.Millisecond)

			return nil
		}
	}

	//stm: @CHAIN_STATE_MINER_INFO_001, @CHAIN_STATE_NETWORK_VERSION_001
	expectSend := func(expect []abi.SectorNumber, gasOverLimit bool) action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			s.EXPECT().StateMinerInfo(gomock.Any(), gomock.Any(), gomock.Any()).Return(api.MinerInfo{Owner: t0123, Worker: t0123}, nil)
			if gasOverLimit {
				s.EXPECT().GasEstimateMessageGas(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, &api.ErrOutOfGas{})
			} else {
				s.EXPECT().GasEstimateMessageGas(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(&types.Message{GasLimit: 100000}, nil)
			}

			if !gasOverLimit {
				s.EXPECT().MpoolPushMessage(gomock.Any(), funMatcher(func(i interface{}) bool {
					b := i.(*types.Message)
					var params miner6.PreCommitSectorBatchParams
					require.NoError(t, params.UnmarshalCBOR(bytes.NewReader(b.Params)))
					for s, number := range expect {
						require.Equal(t, number, params.Sectors[s].SectorNumber)
					}
					return true
				}), gomock.Any()).Return(dummySmsg, nil)
			}
			return nil
		}
	}

	expectInitialCalls := func() action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			s.EXPECT().ChainHead(gomock.Any()).Return(makeBFTs(t, big.NewInt(10001), 1), nil)
			return nil
		}
	}

	flush := func(expect []abi.SectorNumber) action {
		return func(t *testing.T, s *mocks.MockPreCommitBatcherApi, pcb *pipeline.PreCommitBatcher) promise {
			_ = expectInitialCalls()(t, s, pcb)
			_ = expectSend(expect, false)(t, s, pcb)

			r, err := pcb.Flush(ctx)
			require.NoError(t, err)
			require.Len(t, r, 1)
			require.Empty(t, r[0].Error)
			sort.Slice(r[0].Sectors, func(i, j int) bool {
				return r[0].Sectors[i] < r[0].Sectors[j]
			})
			require.Equal(t, expect, r[0].Sectors)

			return nil
		}
	}

	getSectors := func(n int) []abi.SectorNumber {
		out := make([]abi.SectorNumber, n)
		for i := range out {
			out[i] = abi.SectorNumber(i)
		}
		return out
	}

	tcs := map[string]struct {
		actions []action
	}{
		"addSingle": {
			actions: []action{
				addSector(0, true),
				waitPending(1),
				flush([]abi.SectorNumber{0}),
			},
		},
		"addMax": {
			actions: []action{
				expectInitialCalls(),
				expectSend(getSectors(maxBatch), false),
				addSectors(getSectors(maxBatch), true),
			},
		},
		"addMax-gasAboveLimit": {
			actions: []action{
				expectInitialCalls(),
				expectSend(getSectors(maxBatch), true),
				expectSend(getSectors(maxBatch)[:maxBatch/2], false),
				expectSend(getSectors(maxBatch)[maxBatch/2:], false),
				addSectors(getSectors(maxBatch), true),
			},
		},
		"addOne-belowBaseFee": {
			actions: []action{
				expectSend(getSectors(1), false),
				addSectors(getSectors(1), false),
			},
		},
	}

	for name, tc := range tcs {
		tc := tc

		t.Run(name, func(t *testing.T) {
			// create go mock controller here
			mockCtrl := gomock.NewController(t)
			// when test is done, assert expectations on all mock objects.
			defer mockCtrl.Finish()

			// create them mocks
			pcapi := mocks.NewMockPreCommitBatcherApi(mockCtrl)
			pcapi.EXPECT().StateNetworkVersion(gomock.Any(), gomock.Any()).Return(network.Version20, nil).AnyTimes()

			pcb := pipeline.NewPreCommitBatcher(ctx, t0123, pcapi, as, fc, cfg)

			var promises []promise

			for _, a := range tc.actions {
				p := a(t, pcapi, pcb)
				if p != nil {
					promises = append(promises, p)
				}
			}

			for _, p := range promises {
				p(t)
			}

			err := pcb.Stop(ctx)
			require.NoError(t, err)
		})
	}
}

type funMatcher func(interface{}) bool

func (funMatcher) Matches(interface{}) bool {
	return true
}

func (funMatcher) String() string {
	return "fun"
}