prysm-pulse/beacon-chain/sync/rate_limiter_test.go
terence 5a66807989
Update to V5 (#13622)
* First take at updating everything to v5

* Patch gRPC gateway to use prysm v5

Fix patch

* Update go ssz

---------

Co-authored-by: Preston Van Loon <pvanloon@offchainlabs.com>
2024-02-15 05:46:47 +00:00

113 lines
3.9 KiB
Go

package sync
import (
"context"
"sync"
"testing"
"time"
"github.com/libp2p/go-libp2p/core/network"
"github.com/libp2p/go-libp2p/core/protocol"
"github.com/prysmaticlabs/prysm/v5/beacon-chain/p2p"
mockp2p "github.com/prysmaticlabs/prysm/v5/beacon-chain/p2p/testing"
p2ptypes "github.com/prysmaticlabs/prysm/v5/beacon-chain/p2p/types"
"github.com/prysmaticlabs/prysm/v5/testing/assert"
"github.com/prysmaticlabs/prysm/v5/testing/require"
"github.com/prysmaticlabs/prysm/v5/testing/util"
)
func TestNewRateLimiter(t *testing.T) {
rlimiter := newRateLimiter(mockp2p.NewTestP2P(t))
assert.Equal(t, len(rlimiter.limiterMap), 12, "correct number of topics not registered")
}
func TestNewRateLimiter_FreeCorrectly(t *testing.T) {
rlimiter := newRateLimiter(mockp2p.NewTestP2P(t))
rlimiter.free()
assert.Equal(t, len(rlimiter.limiterMap), 0, "rate limiter not freed correctly")
}
func TestRateLimiter_ExceedCapacity(t *testing.T) {
p1 := mockp2p.NewTestP2P(t)
p2 := mockp2p.NewTestP2P(t)
p1.Connect(p2)
rlimiter := newRateLimiter(p1)
// BlockByRange
topic := p2p.RPCBlocksByRangeTopicV1 + p1.Encoding().ProtocolSuffix()
wg := sync.WaitGroup{}
p2.BHost.SetStreamHandler(protocol.ID(topic), func(stream network.Stream) {
defer wg.Done()
code, errMsg, err := readStatusCodeNoDeadline(stream, p2.Encoding())
require.NoError(t, err, "could not read incoming stream")
assert.Equal(t, responseCodeInvalidRequest, code, "not equal response codes")
assert.Equal(t, p2ptypes.ErrRateLimited.Error(), errMsg, "not equal errors")
})
wg.Add(1)
stream, err := p1.BHost.NewStream(context.Background(), p2.PeerID(), protocol.ID(topic))
require.NoError(t, err, "could not create stream")
err = rlimiter.validateRequest(stream, 64)
require.NoError(t, err, "could not validate incoming request")
// Attempt to create an error, rate limit and lead to disconnect
err = rlimiter.validateRequest(stream, 1000)
require.NotNil(t, err, "could not get error from leaky bucket")
require.NoError(t, stream.Close(), "could not close stream")
if util.WaitTimeout(&wg, 1*time.Second) {
t.Fatal("Did not receive stream within 1 sec")
}
}
func TestRateLimiter_ExceedRawCapacity(t *testing.T) {
p1 := mockp2p.NewTestP2P(t)
p2 := mockp2p.NewTestP2P(t)
p1.Connect(p2)
p1.Peers().Add(nil, p2.PeerID(), p2.BHost.Addrs()[0], network.DirOutbound)
rlimiter := newRateLimiter(p1)
// BlockByRange
topic := p2p.RPCBlocksByRangeTopicV1 + p1.Encoding().ProtocolSuffix()
wg := sync.WaitGroup{}
p2.BHost.SetStreamHandler(protocol.ID(topic), func(stream network.Stream) {
defer wg.Done()
code, errMsg, err := readStatusCodeNoDeadline(stream, p2.Encoding())
require.NoError(t, err, "could not read incoming stream")
assert.Equal(t, responseCodeInvalidRequest, code, "not equal response codes")
assert.Equal(t, p2ptypes.ErrRateLimited.Error(), errMsg, "not equal errors")
})
wg.Add(1)
stream, err := p1.BHost.NewStream(context.Background(), p2.PeerID(), protocol.ID(topic))
require.NoError(t, err, "could not create stream")
for i := 0; i < 2*defaultBurstLimit; i++ {
err = rlimiter.validateRawRpcRequest(stream)
rlimiter.addRawStream(stream)
require.NoError(t, err, "could not validate incoming request")
}
// Triggers rate limit error on burst.
assert.ErrorContains(t, p2ptypes.ErrRateLimited.Error(), rlimiter.validateRawRpcRequest(stream))
// Make Peer bad.
for i := 0; i < defaultBurstLimit; i++ {
assert.ErrorContains(t, p2ptypes.ErrRateLimited.Error(), rlimiter.validateRawRpcRequest(stream))
}
assert.Equal(t, true, p1.Peers().IsBad(p2.PeerID()), "peer is not marked as a bad peer")
require.NoError(t, stream.Close(), "could not close stream")
if util.WaitTimeout(&wg, 1*time.Second) {
t.Fatal("Did not receive stream within 1 sec")
}
}
func Test_limiter_retrieveCollector_requiresLock(t *testing.T) {
l := limiter{}
_, err := l.retrieveCollector("")
require.ErrorContains(t, "caller must hold read/write lock", err)
}