Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configurable base round timeout #92

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Configurable base round timeout #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b96e4b8
Configurable base round timeout
Stefan-Ethernal Apr 22, 2024
a24c91b
Try to resolve sonarcloud violation
Stefan-Ethernal Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions core/ibft.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ type Messages interface {
}

const (
round0Timeout = 10 * time.Second
roundFactorBase = float64(2)
// DefaultBaseRoundTimeout is the default base round (round 0) timeout
DefaultBaseRoundTimeout = 10 * time.Second
roundFactorBase = float64(2)
)

var (
Expand Down Expand Up @@ -129,7 +130,7 @@ func NewIBFT(
roundStarted: false,
name: newRound,
},
baseRoundTimeout: round0Timeout,
baseRoundTimeout: DefaultBaseRoundTimeout,
validatorManager: NewValidatorManager(backend, log),
}
}
Expand Down Expand Up @@ -1033,10 +1034,10 @@ func (i *IBFT) buildProposal(ctx context.Context, view *proto.View) *proto.Messa
}

proposal := messages.ExtractProposal(latestPC.ProposalMessage)
round := proposal.Round
preparedCertificateRound := proposal.Round

// skip if message's round is equals to/less than maxRound
if previousProposal != nil && round <= maxRound {
if previousProposal != nil && preparedCertificateRound <= maxRound {
continue
}

Expand All @@ -1046,7 +1047,7 @@ func (i *IBFT) buildProposal(ctx context.Context, view *proto.View) *proto.Messa
}

previousProposal = lastPB.RawProposal
maxRound = round
maxRound = preparedCertificateRound
}

if previousProposal == nil {
Expand Down Expand Up @@ -1140,6 +1141,11 @@ func (i *IBFT) ExtendRoundTimeout(amount time.Duration) {
i.additionalTimeout = amount
}

// SetBaseRoundTimeout sets the base (round 0) timeout
func (i *IBFT) SetBaseRoundTimeout(baseRoundTimeout time.Duration) {
i.baseRoundTimeout = baseRoundTimeout
}

// validPC verifies that the prepared certificate is valid
func (i *IBFT) validPC(
certificate *proto.PreparedCertificate,
Expand Down Expand Up @@ -1288,9 +1294,9 @@ func (i *IBFT) subscribe(details messages.SubscriptionDetails) *messages.Subscri
// - round 4: 8 sec
func getRoundTimeout(baseRoundTimeout, additionalTimeout time.Duration, round uint64) time.Duration {
var (
duration = int(baseRoundTimeout)
baseDuration = int(baseRoundTimeout)
roundFactor = int(math.Pow(roundFactorBase, float64(round)))
roundTimeout = time.Duration(duration * roundFactor)
roundTimeout = time.Duration(baseDuration * roundFactor)
)

return roundTimeout + additionalTimeout
Expand Down
55 changes: 40 additions & 15 deletions core/ibft_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,7 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
proposer := []byte("proposer")
round := uint64(1)

correctRoundMessage := newCorrectRoundMessage(round)
roundMessage := newCorrectRoundMessage(round)

generateProposalWithNoPrevious := func() *proto.Message {
roundChangeMessages := generateMessagesWithUniqueSender(quorum, proto.MessageType_ROUND_CHANGE)
Expand All @@ -720,8 +720,8 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
Type: proto.MessageType_PREPREPARE,
Payload: &proto.Message_PreprepareData{
PreprepareData: &proto.PrePrepareMessage{
Proposal: correctRoundMessage.proposal,
ProposalHash: correctRoundMessage.hash,
Proposal: roundMessage.proposal,
ProposalHash: roundMessage.hash,
Certificate: &proto.RoundChangeCertificate{
RoundChangeMessages: roundChangeMessages,
},
Expand All @@ -740,13 +740,13 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
Type: proto.MessageType_PREPREPARE,
Payload: &proto.Message_PreprepareData{
PreprepareData: &proto.PrePrepareMessage{
Proposal: correctRoundMessage.proposal,
ProposalHash: correctRoundMessage.hash,
Proposal: roundMessage.proposal,
ProposalHash: roundMessage.hash,
Certificate: &proto.RoundChangeCertificate{
RoundChangeMessages: generateFilledRCMessages(
quorum,
correctRoundMessage.proposal,
correctRoundMessage.hash,
roundMessage.proposal,
roundMessage.hash,
),
},
},
Expand Down Expand Up @@ -800,7 +800,7 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
Type: proto.MessageType_PREPARE,
Payload: &proto.Message_PrepareData{
PrepareData: &proto.PrepareMessage{
ProposalHash: correctRoundMessage.hash,
ProposalHash: roundMessage.hash,
},
},
}
Expand Down Expand Up @@ -857,10 +857,10 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
assert.Equal(t, prepare, i.state.name)

// Make sure the accepted proposal is the one that was sent out
assert.Equal(t, correctRoundMessage.proposal, i.state.getProposal())
assert.Equal(t, roundMessage.proposal, i.state.getProposal())

// Make sure the correct proposal hash was multicasted
assert.True(t, prepareHashMatches(correctRoundMessage.hash, multicastedPrepare))
assert.True(t, prepareHashMatches(roundMessage.hash, multicastedPrepare))
})
}
}
Expand Down Expand Up @@ -1201,6 +1201,7 @@ func TestIBFT_IsAcceptableMessage(t *testing.T) {
},
}
)

i := NewIBFT(log, backend, transport)
i.state.view = testCase.stateView

Expand Down Expand Up @@ -1235,6 +1236,7 @@ func TestIBFT_StartRoundTimer(t *testing.T) {

wg.Add(1)
i.wg.Add(1)

go func() {
i.startRoundTimer(ctx, 0)

Expand Down Expand Up @@ -1264,6 +1266,7 @@ func TestIBFT_StartRoundTimer(t *testing.T) {
ctx, cancelFn := context.WithCancel(context.Background())

wg.Add(1)

go func() {
defer func() {
wg.Done()
Expand Down Expand Up @@ -1351,16 +1354,16 @@ func TestIBFT_FutureProposal(t *testing.T) {
view *proto.View,
roundChangeMessages []*proto.Message,
) *proto.Message {
correctRoundMessage := newCorrectRoundMessage(view.Round)
roundMessage := newCorrectRoundMessage(view.Round)

return &proto.Message{
View: view,
From: proposer,
Type: proto.MessageType_PREPREPARE,
Payload: &proto.Message_PreprepareData{
PreprepareData: &proto.PrePrepareMessage{
Proposal: correctRoundMessage.proposal,
ProposalHash: correctRoundMessage.hash,
Proposal: roundMessage.proposal,
ProposalHash: roundMessage.hash,
Certificate: &proto.RoundChangeCertificate{
RoundChangeMessages: roundChangeMessages,
},
Expand Down Expand Up @@ -1464,6 +1467,7 @@ func TestIBFT_FutureProposal(t *testing.T) {
i.messages = mMessages

wg.Add(1)

go func() {
defer func() {
cancelFn()
Expand Down Expand Up @@ -1988,6 +1992,7 @@ func TestIBFT_ValidPC(t *testing.T) {

i := NewIBFT(log, backend, transport)
require.NoError(t, i.validatorManager.Init(0))

proposal := generateMessagesWithSender(1, proto.MessageType_PREPREPARE, sender)[0]

certificate := &proto.PreparedCertificate{
Expand Down Expand Up @@ -3045,6 +3050,18 @@ func TestIBFT_ExtendRoundTimer(t *testing.T) {
assert.Equal(t, additionalTimeout, i.additionalTimeout)
}

func TestIBFTOverrideBaseRoundTimeout(t *testing.T) {
t.Parallel()

baseRoundTimeout := 50 * time.Second

i := NewIBFT(mockLogger{}, mockBackend{}, mockTransport{})
i.SetBaseRoundTimeout(baseRoundTimeout)

// Make sure the base round timeout is properly set
assert.Equal(t, baseRoundTimeout, i.baseRoundTimeout)
}

func Test_getRoundTimeout(t *testing.T) {
t.Parallel()

Expand All @@ -3060,7 +3077,7 @@ func Test_getRoundTimeout(t *testing.T) {
want time.Duration
}{
{
name: "first round duration",
name: "zero round duration",
args: args{
baseRoundTimeout: time.Second,
additionalTimeout: time.Second,
Expand All @@ -3069,14 +3086,22 @@ func Test_getRoundTimeout(t *testing.T) {
want: time.Second * 2,
},
{
name: "zero round duration",
name: "first round duration",
args: args{
baseRoundTimeout: time.Second,
additionalTimeout: time.Second,
round: 1,
},
want: time.Second * 3,
},
{
name: "third round duration",
args: args{
baseRoundTimeout: time.Second,
round: 3,
},
want: time.Second * 8,
},
}

for _, tt := range tests {
Expand Down
Loading