Log error dropped by BlockBuilderWaiter.BuildBlock - #495
Closed
samliok wants to merge 1 commit into
Closed
Conversation
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.
What was wrong
BlockBuilderWaiter.BuildBlock (adapters.go:219) discarded the error returned by msm.BuildBlock and returned (nil, false). The common.BlockBuilder interface (common/api.go:44) only exposes a bool, so the epoch caller (simplex/epoch.go:2591) could only emit a generic "Failed building block" warning with no cause.
Consequence
Any block building failure, for example "failed to retrieve sealing block for previous epoch" (msm/msm.go:454) or a parent block lookup failure (msm/msm.go:288), was undiagnosable from logs. This sent the investigation of TestValidator_ValidatorSetDecreased down a wrong path.
Fix
Added a logger to BlockBuilderWaiter, wired from Config.Logger at construction (instance.go:479), and log the error at Warn. Context cancellation is the documented normal false path, so it is not logged.
Verification
TestBlockBuilderWaiterLogsBuildError, failed before the log call was added, passes after.
Found while debugging TestValidator_ValidatorSetDecreased.