statesync/event: emit statesync start/end event (#6700)

internal/statesync/mock_sync_reactor.go

@@ -0,0 +1,50 @@
+package statesync
+
+import (
+	"context"
+	"time"
+
+	mock "github.com/stretchr/testify/mock"
+	state "github.com/tendermint/tendermint/state"
+)
+
+// MockSyncReactor is an autogenerated mock type for the SyncReactor type.
+// Because of the stateprovider uses in Sync(), we use package statesync instead of mocks.
+type MockSyncReactor struct {
+	mock.Mock
+}
+
+// Backfill provides a mock function with given fields: _a0
+func (_m *MockSyncReactor) Backfill(_a0 state.State) error {
+	ret := _m.Called(_a0)
+
+	var r0 error
+	if rf, ok := ret.Get(0).(func(state.State) error); ok {
+		r0 = rf(_a0)
+	} else {
+		r0 = ret.Error(0)
+	}
+
+	return r0
+}
+
+// Sync provides a mock function with given fields: _a0, _a1, _a2
+func (_m *MockSyncReactor) Sync(_a0 context.Context, _a1 StateProvider, _a2 time.Duration) (state.State, error) {
+	ret := _m.Called(_a0, _a1, _a2)
+
+	var r0 state.State
+	if rf, ok := ret.Get(0).(func(context.Context, StateProvider, time.Duration) state.State); ok {
+		r0 = rf(_a0, _a1, _a2)
+	} else {
+		r0 = ret.Get(0).(state.State)
+	}
+
+	var r1 error
+	if rf, ok := ret.Get(1).(func(context.Context, StateProvider, time.Duration) error); ok {
+		r1 = rf(_a0, _a1, _a2)
+	} else {
+		r1 = ret.Error(1)
+	}
+
+	return r0, r1
+}

internal/statesync/reactor.go

@@ -102,6 +102,12 @@ const (
 	maxLightBlockRequestRetries = 20
 )
 
+// SyncReactor defines an interface used for testing abilities of node.startStateSync.
+type SyncReactor interface {
+	Sync(context.Context, StateProvider, time.Duration) (sm.State, error)
+	Backfill(sm.State) error
+}
+
 // Reactor handles state sync, both restoring snapshots for the local node and
 // serving snapshots for other nodes.
 type Reactor struct {
@@ -222,6 +228,11 @@ func (r *Reactor) Sync(
 		return sm.State{}, errors.New("a state sync is already in progress")
 	}
 
+	if stateProvider == nil {
+		r.mtx.Unlock()
+		return sm.State{}, errors.New("the stateProvider should not be nil when doing the state sync")
+	}
+
 	r.syncer = newSyncer(
 		r.cfg,
 		r.Logger,