fix: snapshotter's failure is not propogated (#16588)

(cherry picked from commit aeccbc9)
cosmos · Jun 17, 2023 · b3addca · b3addca
1 parent c06d8d7
commit b3addca
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 3 deletions.
diff --git a/store/CHANGELOG.md b/store/CHANGELOG.md
@@ -41,6 +41,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * [#16321](https://github.com/cosmos/cosmos-sdk/pull/16321) QueryInterface defines its own request and response types instead of relying on comet/abci & returns an error
 
+### Bug Fixes
+
+* [#16588](https://github.com/cosmos/cosmos-sdk/pull/16588) Propogate the Snapshotter's failure to the caller, (it will create a empty snapshot silently before).
+
 ## [v0.1.0-alpha.1](https://github.com/cosmos/cosmos-sdk/releases/tag/store%2Fv0.1.0-alpha.1) - 2023-03-17
 
 ### Features

diff --git a/store/snapshots/chunk.go b/store/snapshots/chunk.go
@@ -59,11 +59,13 @@ func (w *ChunkWriter) Close() error {
 // CloseWithError closes the writer and sends an error to the reader.
 func (w *ChunkWriter) CloseWithError(err error) {
 	if !w.closed {
+		if w.pipe == nil {
+			// create a dummy pipe just to propagate the error to the reader, it always returns nil
+			_ = w.chunk()
+		}
 		w.closed = true
 		close(w.ch)
-		if w.pipe != nil {
-			_ = w.pipe.CloseWithError(err) // CloseWithError always returns nil
-		}
+		_ = w.pipe.CloseWithError(err) // CloseWithError always returns nil
 	}
 }
 

diff --git a/store/snapshots/helpers_test.go b/store/snapshots/helpers_test.go
@@ -171,6 +171,38 @@ func (m *mockSnapshotter) SetSnapshotInterval(snapshotInterval uint64) {
 	m.snapshotInterval = snapshotInterval
 }
 
+type mockErrorSnapshotter struct{}
+
+var _ snapshottypes.Snapshotter = (*mockErrorSnapshotter)(nil)
+
+func (m *mockErrorSnapshotter) Snapshot(height uint64, protoWriter protoio.Writer) error {
+	return errors.New("mock snapshot error")
+}
+
+func (m *mockErrorSnapshotter) Restore(
+	height uint64, format uint32, protoReader protoio.Reader,
+) (snapshottypes.SnapshotItem, error) {
+	return snapshottypes.SnapshotItem{}, errors.New("mock restore error")
+}
+
+func (m *mockErrorSnapshotter) SnapshotFormat() uint32 {
+	return snapshottypes.CurrentFormat
+}
+
+func (m *mockErrorSnapshotter) SupportedFormats() []uint32 {
+	return []uint32{snapshottypes.CurrentFormat}
+}
+
+func (m *mockErrorSnapshotter) PruneSnapshotHeight(height int64) {
+}
+
+func (m *mockErrorSnapshotter) GetSnapshotInterval() uint64 {
+	return 0
+}
+
+func (m *mockErrorSnapshotter) SetSnapshotInterval(snapshotInterval uint64) {
+}
+
 // setupBusyManager creates a manager with an empty store that is busy creating a snapshot at height 1.
 // The snapshot will complete when the returned closer is called.
 func setupBusyManager(t *testing.T) *snapshots.Manager {

diff --git a/store/snapshots/manager_test.go b/store/snapshots/manager_test.go
@@ -4,6 +4,7 @@ import (
 	"errors"
 	"testing"
 
+	db "github.com/cosmos/cosmos-db"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -243,3 +244,13 @@ func TestManager_Restore(t *testing.T) {
 	})
 	require.NoError(t, err)
 }
+
+func TestManager_TakeError(t *testing.T) {
+	snapshotter := &mockErrorSnapshotter{}
+	store, err := snapshots.NewStore(db.NewMemDB(), GetTempDir(t))
+	require.NoError(t, err)
+	manager := snapshots.NewManager(store, opts, snapshotter, nil, log.NewNopLogger())
+
+	_, err = manager.Create(1)
+	require.Error(t, err)
+}