Skip to content

Commit

Permalink
fix(snapshots): raise the per snapshot item limit
Browse files Browse the repository at this point in the history
  • Loading branch information
mhofman committed Sep 12, 2023
1 parent 67760b3 commit 40a6c46
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 1 deletion.
4 changes: 3 additions & 1 deletion snapshots/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ const (

chunkBufferSize = 4

snapshotMaxItemSize = int(64e6) // SDK has no key/value size limit, so we set an arbitrary limit
// snapshotMaxItemSize limits the size of both KVStore entries and snapshot
// extension payloads during a state-sync restore.
snapshotMaxItemSize = int(512e6)
)

// operation represents a Manager operation. Only one operation can be in progress at a time.
Expand Down
78 changes: 78 additions & 0 deletions snapshots/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package snapshots_test

import (
"errors"
"io"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -218,3 +219,80 @@ func TestManager_Restore(t *testing.T) {
})
require.NoError(t, err)
}

const snapshotMaxItemSize = int(512e6) // Copied from github.com/cosmos/cosmos-sdk/snapshots

func TestManager_RestoreLargeItem(t *testing.T) {
store := setupStore(t)
target := &mockSnapshotter{}
extSnapshotter := newExtSnapshotter(0)
manager := snapshots.NewManager(store, target)
err := manager.RegisterExtensions(extSnapshotter)
require.NoError(t, err)

// The protobuf wrapper introduces an extra byte
largeItem := make([]byte, snapshotMaxItemSize-1)
expectItems := [][]byte{largeItem}

chunks := snapshotItems(expectItems, newExtSnapshotter(1))

// Starting a restore works
err = manager.Restore(types.Snapshot{
Height: 3,
Format: 2,
Hash: []byte{1, 2, 3},
Chunks: 1,
Metadata: types.Metadata{ChunkHashes: checksums(chunks)},
})
require.NoError(t, err)

// Feeding the chunks should work
for i, chunk := range chunks {
done, err := manager.RestoreChunk(chunk)
require.NoError(t, err)
if i == len(chunks)-1 {
assert.True(t, done)
} else {
assert.False(t, done)
}
}

assert.Equal(t, expectItems, target.items)
assert.Equal(t, 1, len(extSnapshotter.state))
}

func TestManager_CannotRestoreTooLargeItem(t *testing.T) {
store := setupStore(t)
target := &mockSnapshotter{}
extSnapshotter := newExtSnapshotter(0)
manager := snapshots.NewManager(store, target)
err := manager.RegisterExtensions(extSnapshotter)
require.NoError(t, err)

// The protobuf wrapper introduces an extra byte
largeItem := make([]byte, snapshotMaxItemSize)
expectItems := [][]byte{largeItem}

chunks := snapshotItems(expectItems, newExtSnapshotter(1))

// Starting a restore works
err = manager.Restore(types.Snapshot{
Height: 3,
Format: 2,
Hash: []byte{1, 2, 3},
Chunks: 1,
Metadata: types.Metadata{ChunkHashes: checksums(chunks)},
})
require.NoError(t, err)

// Feeding the chunks fails
for _, chunk := range chunks {
_, err = manager.RestoreChunk(chunk)

if err != nil {
break
}
}
require.Error(t, err)
require.True(t, errors.Is(err, io.ErrShortBuffer))
}

0 comments on commit 40a6c46

Please sign in to comment.