Fix synchronizer timer #105
Merged
Conversation
This file contains 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
johningve
force-pushed
the
fix-synchronizer-timer
branch
from
7cac496 to
b9af063
Compare
The timer used by the synchronizer used to be resettable, but after 7776a29, the closure passed to the timer should only be used once because it stores the current view. This was done so that we can avoid the need for any synchronization of access to the current view in the synchronizer. However, I failed to realize that this would make the timer only usable once. Thus, resetting it is not possible as the view that is stored in the timer's closure would not change upon reset. This commit wraps the timer in a `oneShotTimer` struct that is intended to prevent the timer from being reused. Instead, the methods `startTimeoutTimer` and `stopTimeoutTimer` should be used instead of using the timer directly. These functions ensure that each timer is unique and thus a unique closure is used each time, ensuring that we get the correct view and avoid the need for synchronization code.
johningve
force-pushed
the
fix-synchronizer-timer
branch
from
b9af063 to
36a1b7e
Compare
With the timer changes, the network timer is twins needs to be updated.
Due to local timeout the sychronizer is called stopVoting which the gmock is not expecting, so the test cast is failing. Increased the timeout delay to prevent this.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #105 +/- ##
==========================================
+ Coverage 72.44% 73.03% +0.58%
==========================================
Files 63 63
Lines 6301 6308 +7
==========================================
+ Hits 4565 4607 +42
+ Misses 1428 1399 -29
+ Partials 308 302 -6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
meling
approved these changes
Mar 9, 2024
| @@ -143,7 +143,7 @@ func (n *Network) createTwinsNodes(nodes []NodeID, _ Scenario, consensusName str | |||
| consensus.New(consensusModule), | |||
| consensus.NewVotingMachine(), | |||
| crypto.NewCache(ecdsa.New(), 100), | |||
| synchronizer.New(FixedTimeout(0)), | |||
| synchronizer.New(FixedTimeout(1*time.Millisecond)), | |||
There was a problem hiding this comment.
We should consider if it would be enough to use e.g., 100 * time.Microsecond to avoid that twins tests take longer time. This should be tested and maybe "measured" since I'm not sure this will have an impact, one way or the other.
There was a problem hiding this comment.
I tried with different values, it looks like 1 millisecond is more stable compared to lower durations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The timer used by the synchronizer used to be resettable, but after
7776a29, the closure passed to the timer should only be used once
because it stores the current view. This was done so that we can avoid
the need for any synchronization of access to the current view in the
synchronizer. However, I failed to realize that this would make the
timer only usable once. Thus, resetting it is not possible as the view
that is stored in the timer's closure would not change upon reset.
This PR wraps the timer in a
oneShotTimerstruct that is intended toprevent the timer from being reused. Instead, the methods
startTimeoutTimerandstopTimeoutTimershould be used instead ofusing the timer directly. These functions ensure that each timer is
unique and thus a unique closure is used each time, ensuring that we get
the correct view and avoid the need for synchronization code.