github.com/MetalBlockchain/metalgo@v1.11.9/network/p2p/gossip/gossip_test.go

// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package gossip

import (
	"context"
	"sync"
	"testing"
	"time"

	"github.com/prometheus/client_golang/prometheus"
	"github.com/stretchr/testify/require"
	"golang.org/x/exp/maps"
	"google.golang.org/protobuf/proto"

	"github.com/MetalBlockchain/metalgo/ids"
	"github.com/MetalBlockchain/metalgo/network/p2p"
	"github.com/MetalBlockchain/metalgo/proto/pb/sdk"
	"github.com/MetalBlockchain/metalgo/snow/engine/common"
	"github.com/MetalBlockchain/metalgo/snow/validators"
	"github.com/MetalBlockchain/metalgo/utils/constants"
	"github.com/MetalBlockchain/metalgo/utils/logging"
	"github.com/MetalBlockchain/metalgo/utils/set"
	"github.com/MetalBlockchain/metalgo/utils/units"
)

func TestGossiperShutdown(*testing.T) {
	gossiper := NewPullGossiper[*testTx](
		logging.NoLog{},
		nil,
		nil,
		nil,
		Metrics{},
		0,
	)
	ctx, cancel := context.WithCancel(context.Background())

	wg := &sync.WaitGroup{}
	wg.Add(1)

	go func() {
		Every(ctx, logging.NoLog{}, gossiper, time.Second)
		wg.Done()
	}()

	cancel()
	wg.Wait()
}

func TestGossiperGossip(t *testing.T) {
	tests := []struct {
		name                   string
		targetResponseSize     int
		requester              []*testTx // what we have
		responder              []*testTx // what the peer we're requesting gossip from has
		expectedPossibleValues []*testTx // possible values we can have
		expectedLen            int
	}{
		{
			name: "no gossip - no one knows anything",
		},
		{
			name:                   "no gossip - requester knows more than responder",
			targetResponseSize:     1024,
			requester:              []*testTx{{id: ids.ID{0}}},
			expectedPossibleValues: []*testTx{{id: ids.ID{0}}},
			expectedLen:            1,
		},
		{
			name:                   "no gossip - requester knows everything responder knows",
			targetResponseSize:     1024,
			requester:              []*testTx{{id: ids.ID{0}}},
			responder:              []*testTx{{id: ids.ID{0}}},
			expectedPossibleValues: []*testTx{{id: ids.ID{0}}},
			expectedLen:            1,
		},
		{
			name:                   "gossip - requester knows nothing",
			targetResponseSize:     1024,
			responder:              []*testTx{{id: ids.ID{0}}},
			expectedPossibleValues: []*testTx{{id: ids.ID{0}}},
			expectedLen:            1,
		},
		{
			name:                   "gossip - requester knows less than responder",
			targetResponseSize:     1024,
			requester:              []*testTx{{id: ids.ID{0}}},
			responder:              []*testTx{{id: ids.ID{0}}, {id: ids.ID{1}}},
			expectedPossibleValues: []*testTx{{id: ids.ID{0}}, {id: ids.ID{1}}},
			expectedLen:            2,
		},
		{
			name:                   "gossip - target response size exceeded",
			targetResponseSize:     32,
			responder:              []*testTx{{id: ids.ID{0}}, {id: ids.ID{1}}, {id: ids.ID{2}}},
			expectedPossibleValues: []*testTx{{id: ids.ID{0}}, {id: ids.ID{1}}, {id: ids.ID{2}}},
			expectedLen:            2,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			require := require.New(t)
			ctx := context.Background()

			responseSender := &common.FakeSender{
				SentAppResponse: make(chan []byte, 1),
			}
			responseNetwork, err := p2p.NewNetwork(logging.NoLog{}, responseSender, prometheus.NewRegistry(), "")
			require.NoError(err)

			responseBloom, err := NewBloomFilter(prometheus.NewRegistry(), "", 1000, 0.01, 0.05)
			require.NoError(err)
			responseSet := &testSet{
				txs:   make(map[ids.ID]*testTx),
				bloom: responseBloom,
			}
			for _, item := range tt.responder {
				require.NoError(responseSet.Add(item))
			}

			metrics, err := NewMetrics(prometheus.NewRegistry(), "")
			require.NoError(err)
			marshaller := testMarshaller{}
			handler := NewHandler[*testTx](
				logging.NoLog{},
				marshaller,
				responseSet,
				metrics,
				tt.targetResponseSize,
			)
			require.NoError(err)
			require.NoError(responseNetwork.AddHandler(0x0, handler))

			requestSender := &common.FakeSender{
				SentAppRequest: make(chan []byte, 1),
			}

			requestNetwork, err := p2p.NewNetwork(logging.NoLog{}, requestSender, prometheus.NewRegistry(), "")
			require.NoError(err)
			require.NoError(requestNetwork.Connected(context.Background(), ids.EmptyNodeID, nil))

			bloom, err := NewBloomFilter(prometheus.NewRegistry(), "", 1000, 0.01, 0.05)
			require.NoError(err)
			requestSet := &testSet{
				txs:   make(map[ids.ID]*testTx),
				bloom: bloom,
			}
			for _, item := range tt.requester {
				require.NoError(requestSet.Add(item))
			}

			requestClient := requestNetwork.NewClient(0x0)

			require.NoError(err)
			gossiper := NewPullGossiper[*testTx](
				logging.NoLog{},
				marshaller,
				requestSet,
				requestClient,
				metrics,
				1,
			)
			require.NoError(err)
			received := set.Set[*testTx]{}
			requestSet.onAdd = func(tx *testTx) {
				received.Add(tx)
			}

			require.NoError(gossiper.Gossip(ctx))
			require.NoError(responseNetwork.AppRequest(ctx, ids.EmptyNodeID, 1, time.Time{}, <-requestSender.SentAppRequest))
			require.NoError(requestNetwork.AppResponse(ctx, ids.EmptyNodeID, 1, <-responseSender.SentAppResponse))

			require.Len(requestSet.txs, tt.expectedLen)
			require.Subset(tt.expectedPossibleValues, maps.Values(requestSet.txs))

			// we should not receive anything that we already had before we
			// requested the gossip
			for _, tx := range tt.requester {
				require.NotContains(received, tx)
			}
		})
	}
}

func TestEvery(*testing.T) {
	ctx, cancel := context.WithCancel(context.Background())
	calls := 0
	gossiper := &TestGossiper{
		GossipF: func(context.Context) error {
			if calls >= 10 {
				cancel()
				return nil
			}

			calls++
			return nil
		},
	}

	go Every(ctx, logging.NoLog{}, gossiper, time.Millisecond)
	<-ctx.Done()
}

func TestValidatorGossiper(t *testing.T) {
	require := require.New(t)

	nodeID := ids.GenerateTestNodeID()

	validators := testValidatorSet{
		validators: set.Of(nodeID),
	}

	calls := 0
	gossiper := ValidatorGossiper{
		Gossiper: &TestGossiper{
			GossipF: func(context.Context) error {
				calls++
				return nil
			},
		},
		NodeID:     nodeID,
		Validators: validators,
	}

	// we are a validator, so we should request gossip
	require.NoError(gossiper.Gossip(context.Background()))
	require.Equal(1, calls)

	// we are not a validator, so we should not request gossip
	validators.validators = set.Set[ids.NodeID]{}
	require.NoError(gossiper.Gossip(context.Background()))
	require.Equal(2, calls)
}

func TestPushGossiperNew(t *testing.T) {
	tests := []struct {
		name                 string
		gossipParams         BranchingFactor
		regossipParams       BranchingFactor
		discardedSize        int
		targetGossipSize     int
		maxRegossipFrequency time.Duration
		expected             error
	}{
		{
			name: "invalid gossip num validators",
			gossipParams: BranchingFactor{
				Validators: -1,
			},
			regossipParams: BranchingFactor{
				Peers: 1,
			},
			expected: ErrInvalidNumValidators,
		},
		{
			name: "invalid gossip num non-validators",
			gossipParams: BranchingFactor{
				NonValidators: -1,
			},
			regossipParams: BranchingFactor{
				Peers: 1,
			},
			expected: ErrInvalidNumNonValidators,
		},
		{
			name: "invalid gossip num peers",
			gossipParams: BranchingFactor{
				Peers: -1,
			},
			regossipParams: BranchingFactor{
				Peers: 1,
			},
			expected: ErrInvalidNumPeers,
		},
		{
			name:         "invalid gossip num to gossip",
			gossipParams: BranchingFactor{},
			regossipParams: BranchingFactor{
				Peers: 1,
			},
			expected: ErrInvalidNumToGossip,
		},
		{
			name: "invalid regossip num validators",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				Validators: -1,
			},
			expected: ErrInvalidNumValidators,
		},
		{
			name: "invalid regossip num non-validators",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				NonValidators: -1,
			},
			expected: ErrInvalidNumNonValidators,
		},
		{
			name: "invalid regossip num peers",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				Peers: -1,
			},
			expected: ErrInvalidNumPeers,
		},
		{
			name: "invalid regossip num to gossip",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{},
			expected:       ErrInvalidNumToGossip,
		},
		{
			name: "invalid discarded size",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				Validators: 1,
			},
			discardedSize: -1,
			expected:      ErrInvalidDiscardedSize,
		},
		{
			name: "invalid target gossip size",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				Validators: 1,
			},
			targetGossipSize: -1,
			expected:         ErrInvalidTargetGossipSize,
		},
		{
			name: "invalid max re-gossip frequency",
			gossipParams: BranchingFactor{
				Validators: 1,
			},
			regossipParams: BranchingFactor{
				Validators: 1,
			},
			maxRegossipFrequency: -1,
			expected:             ErrInvalidRegossipFrequency,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			_, err := NewPushGossiper[*testTx](
				nil,
				nil,
				nil,
				nil,
				Metrics{},
				tt.gossipParams,
				tt.regossipParams,
				tt.discardedSize,
				tt.targetGossipSize,
				tt.maxRegossipFrequency,
			)
			require.ErrorIs(t, err, tt.expected)
		})
	}
}

// Tests that the outgoing gossip is equivalent to what was accumulated
func TestPushGossiper(t *testing.T) {
	type cycle struct {
		toAdd    []*testTx
		expected [][]*testTx
	}
	tests := []struct {
		name           string
		cycles         []cycle
		shouldRegossip bool
	}{
		{
			name: "single cycle with regossip",
			cycles: []cycle{
				{
					toAdd: []*testTx{
						{
							id: ids.ID{0},
						},
						{
							id: ids.ID{1},
						},
						{
							id: ids.ID{2},
						},
					},
					expected: [][]*testTx{
						{
							{
								id: ids.ID{0},
							},
							{
								id: ids.ID{1},
							},
							{
								id: ids.ID{2},
							},
						},
					},
				},
			},
			shouldRegossip: true,
		},
		{
			name: "multiple cycles with regossip",
			cycles: []cycle{
				{
					toAdd: []*testTx{
						{
							id: ids.ID{0},
						},
					},
					expected: [][]*testTx{
						{
							{
								id: ids.ID{0},
							},
						},
					},
				},
				{
					toAdd: []*testTx{
						{
							id: ids.ID{1},
						},
					},
					expected: [][]*testTx{
						{
							{
								id: ids.ID{1},
							},
						},
						{
							{
								id: ids.ID{0},
							},
						},
					},
				},
				{
					toAdd: []*testTx{
						{
							id: ids.ID{2},
						},
					},
					expected: [][]*testTx{
						{
							{
								id: ids.ID{2},
							},
						},
						{
							{
								id: ids.ID{1},
							},
							{
								id: ids.ID{0},
							},
						},
					},
				},
			},
			shouldRegossip: true,
		},
		{
			name: "verify that we don't gossip empty messages",
			cycles: []cycle{
				{
					toAdd: []*testTx{
						{
							id: ids.ID{0},
						},
					},
					expected: [][]*testTx{
						{
							{
								id: ids.ID{0},
							},
						},
					},
				},
				{
					toAdd:    []*testTx{},
					expected: [][]*testTx{},
				},
			},
			shouldRegossip: false,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			require := require.New(t)
			ctx := context.Background()

			sender := &common.FakeSender{
				SentAppGossip: make(chan []byte, 2),
			}
			network, err := p2p.NewNetwork(
				logging.NoLog{},
				sender,
				prometheus.NewRegistry(),
				"",
			)
			require.NoError(err)
			client := network.NewClient(0)
			validators := p2p.NewValidators(
				&p2p.Peers{},
				logging.NoLog{},
				constants.PrimaryNetworkID,
				&validators.TestState{
					GetCurrentHeightF: func(context.Context) (uint64, error) {
						return 1, nil
					},
					GetValidatorSetF: func(context.Context, uint64, ids.ID) (map[ids.NodeID]*validators.GetValidatorOutput, error) {
						return nil, nil
					},
				},
				time.Hour,
			)
			metrics, err := NewMetrics(prometheus.NewRegistry(), "")
			require.NoError(err)
			marshaller := testMarshaller{}

			regossipTime := time.Hour
			if tt.shouldRegossip {
				regossipTime = time.Nanosecond
			}

			gossiper, err := NewPushGossiper[*testTx](
				marshaller,
				FullSet[*testTx]{},
				validators,
				client,
				metrics,
				BranchingFactor{
					Validators: 1,
				},
				BranchingFactor{
					Validators: 1,
				},
				0, // the discarded cache size doesn't matter for this test
				units.MiB,
				regossipTime,
			)
			require.NoError(err)

			for _, cycle := range tt.cycles {
				gossiper.Add(cycle.toAdd...)
				require.NoError(gossiper.Gossip(ctx))

				for _, expected := range cycle.expected {
					want := &sdk.PushGossip{
						Gossip: make([][]byte, 0, len(expected)),
					}

					for _, gossipable := range expected {
						bytes, err := marshaller.MarshalGossip(gossipable)
						require.NoError(err)

						want.Gossip = append(want.Gossip, bytes)
					}

					if len(want.Gossip) > 0 {
						// remove the handler prefix
						sentMsg := <-sender.SentAppGossip
						got := &sdk.PushGossip{}
						require.NoError(proto.Unmarshal(sentMsg[1:], got))

						require.Equal(want.Gossip, got.Gossip)
					} else {
						select {
						case <-sender.SentAppGossip:
							require.FailNow("unexpectedly sent gossip message")
						default:
						}
					}
				}

				if tt.shouldRegossip {
					// Ensure that subsequent calls to `time.Now()` are
					// sufficient for regossip.
					time.Sleep(regossipTime + time.Nanosecond)
				}
			}
		})
	}
}

type testValidatorSet struct {
	validators set.Set[ids.NodeID]
}

func (t testValidatorSet) Has(_ context.Context, nodeID ids.NodeID) bool {
	return t.validators.Contains(nodeID)
}