Enforce maxTotalReorgs in the consensus reorg check#213
Open
damilolaedwards wants to merge 1 commit into
Open
Conversation
The maxTotalReorgs option was declared and documented but never read, so a playbook that set it to bound the total number of reorgs had no effect and the check passed no matter how many reorgs accumulated. Evaluate it alongside the other reorg thresholds, and extract the threshold logic into a helper so it can be tested without the wall clock service.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
check_consensus_reorgsdocuments amaxTotalReorgsoption to bound the total number of reorgs observed during monitoring, but the field was never read.runCheckonly enforcedminCheckEpochCountandmaxReorgsPerEpoch(andmaxReorgDistanceis handled separately). A playbook that setmaxTotalReorgsto gate on total reorgs therefore had no effect: the check reported success no matter how many reorgs accumulated.Fix
Evaluate
maxTotalReorgsalongside the other reorg thresholds, and extract the threshold evaluation into a helper so it can be unit tested without the wall clock service.Tests
Table test over the new bound (under, at, over, and unset), plus a guard for the neighbouring thresholds so the added check does not shadow them.
go build ./...,go vet, and the package tests pass.