Make bootstrapping handle its own timeouts #3410

yacovm · 2024-09-24T00:40:41Z

Why this should be merged

Currently, an engine registers timeouts into the handler, which schedules the timeouts on behalf of the the engine.

The handler then notifies the engine when the timeout expired.

However, the only engine that uses this mechanism is the bootstrapping engine, and not the other engine types such as the snowman and state sync engines.

It therefore makes sense to consolidate the timeout handling instead of delegating them to the handler.

By moving the timeout handling closer to the bootstrapper, we can make the API of the common.Engine be slimmer by removing the Timeout() method from it.

How this works

I refactored the timeout logic and decoupled it from the handler.
I also re-implemented the timeout mechanism in order to be more robust and testable.

How this was tested

CI tests
Added unit tests with 100% code coverage.
I ran a node which I built with the data race detector flag until after it was bootstrapped in order to ensure there were no data races introduced in this PR.

diff --git a/scripts/build_avalanche.sh b/scripts/build_avalanche.sh
index 74ec675e2..26320a562 100755
--- a/scripts/build_avalanche.sh
+++ b/scripts/build_avalanche.sh
@@ -29,4 +29,4 @@ source "$AVALANCHE_PATH"/scripts/constants.sh
 
 build_args="$race"
 echo "Building AvalancheGo..."
-go build $build_args -ldflags "-X github.com/ava-labs/avalanchego/version.GitCommit=$git_commit $static_ld_flags" -o "$avalanchego_path" "$AVALANCHE_PATH/main/"*.go
+go build -race $build_args -ldflags "-X github.com/ava-labs/avalanchego/version.GitCommit=$git_commit $static_ld_flags" -o "$avalanchego_path" "$AVALANCHE_PATH/main/"*.go

The node successfully finished bootstrapping and there were no data races observed in its log.

yacovm · 2024-09-25T01:18:18Z

snow/engine/common/timer.go

+}
+
+// RegisterTimeout fires the function the timeout handler is initialized with no later than the given timeout.
+func (th *timeoutHandler) RegisterTimeout(d time.Duration) {


I just moved this code section from handler.go

snow/engine/common/bootstrap_tracker.go

snow/engine/snowman/bootstrap/bootstrapper.go

snow/engine/common/timer.go

aaronbuchwald · 2024-10-01T11:43:27Z

snow/engine/common/timer.go

+		newTimer: func(d time.Duration) (<-chan time.Time, func() bool) {
+			timer := time.NewTimer(d)
+			return timer.C, timer.Stop
+		},


What's the reason for specifying this function here rather than just using time.NewTimer directly?

It looks like we replace this with an identical implementation in one of our test cases

Because I needed it for the tests :-)

aaronbuchwald · 2024-10-01T11:46:01Z

snow/engine/common/timer_test.go

+			},
+		},
+	} {
+		t.Run(testCase.desc, func(t *testing.T) {


Is it possible to remove clock from these tests?

What do you think of adding test cases for multiple timeouts w/ and w/o preemption?

I added two tests as requested, but I need the clock for these tests.

snow/engine/common/bootstrap_tracker.go

snow/engine/common/timer.go

snow/engine/snowman/bootstrap/bootstrapper.go

snow/engine/common/timer.go

StephenButtolph · 2024-10-11T18:34:56Z

snow/engine/common/timer.go

+	timer := th.newTimer(d)
+	defer timer.Stop()
+
+	defer th.onTimeout()


nit: I feel like this makes a bit more sense to just be called inline at the end of the function.

I think this inlining may need to be pushed from your local branch, it still seems to use the defer.

oh I thought you meant to inline relinquishing the pending token.

snow/engine/common/timer.go

snow/engine/common/timer_test.go

yacovm · 2024-10-11T20:27:28Z

@StephenButtolph thanks for the review, addressed your comments.

StephenButtolph

final nits then lgtm

message/internal_msg_builder.go

StephenButtolph · 2024-10-21T14:00:19Z

snow/engine/common/timer.go

+	timer := th.newTimer(d)
+	defer timer.Stop()
+
+	defer th.onTimeout()


I think this inlining may need to be pushed from your local branch, it still seems to use the defer.

snow/engine/common/timer_test.go

Currently, an engine registers timeouts into the handler, which schedules the timeouts on behalf of the the engine. The handler then notifies the engine when the timeout expired. However, the only engine that uses this mechanism is the bootstrapping engine, and not the other engine types such as the snowman and state sync engines. It therefore makes sense to consolidate the timeout handling instead of delegating them to the handler. By moving the timeout handling closer to the bootstrapper, we can make the API of the common.Engine be slimmer by removing the Timeout() method from it. Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

snow/engine/common/timer_test.go

Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

stale

yacovm requested a review from StephenButtolph as a code owner September 24, 2024 00:40

yacovm force-pushed the simplifyTimeouts branch 2 times, most recently from e2641d7 to 09ad764 Compare September 24, 2024 00:56

yacovm marked this pull request as draft September 24, 2024 01:07

yacovm force-pushed the simplifyTimeouts branch 3 times, most recently from 25122c6 to b54e285 Compare September 24, 2024 01:59

yacovm self-assigned this Sep 24, 2024

yacovm force-pushed the simplifyTimeouts branch 7 times, most recently from 31d051e to c25a68d Compare September 25, 2024 01:02

yacovm marked this pull request as ready for review September 25, 2024 01:15

yacovm commented Sep 25, 2024

View reviewed changes

marun reviewed Sep 25, 2024

View reviewed changes

snow/engine/common/bootstrap_tracker.go Outdated Show resolved Hide resolved

snow/engine/snowman/bootstrap/bootstrapper.go Show resolved Hide resolved

snow/engine/common/timer.go Outdated Show resolved Hide resolved

snow/engine/common/timer.go Outdated Show resolved Hide resolved

marun approved these changes Sep 26, 2024

View reviewed changes

aaronbuchwald previously requested changes Oct 1, 2024

View reviewed changes

yacovm force-pushed the simplifyTimeouts branch from 9be93a5 to fe44d95 Compare October 1, 2024 18:18

yacovm requested a review from aaronbuchwald October 1, 2024 19:23

StephenButtolph reviewed Oct 2, 2024

View reviewed changes

yacovm force-pushed the simplifyTimeouts branch 6 times, most recently from 4f949b8 to bdf0063 Compare October 3, 2024 20:14

yacovm added the cleanup Code quality improvement label Oct 3, 2024

StephenButtolph reviewed Oct 11, 2024

View reviewed changes

yacovm force-pushed the simplifyTimeouts branch from 214ed68 to a7b3ab4 Compare October 11, 2024 20:24

StephenButtolph reviewed Oct 21, 2024

View reviewed changes

yacovm added 3 commits October 21, 2024 16:27

Address code review comments

b3b78e7

Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

Address code review comments II

6148a8b

Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

yacovm force-pushed the simplifyTimeouts branch from 5071701 to 6148a8b Compare October 21, 2024 14:28

StephenButtolph reviewed Oct 21, 2024

View reviewed changes

snow/engine/common/timer_test.go Outdated Show resolved Hide resolved

Address code review comments III

2f5466f

Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>

yacovm force-pushed the simplifyTimeouts branch from d4a443a to 2f5466f Compare October 21, 2024 14:42

StephenButtolph approved these changes Oct 21, 2024

View reviewed changes

StephenButtolph added this to the v1.11.13 milestone Oct 21, 2024

StephenButtolph enabled auto-merge October 21, 2024 14:57

StephenButtolph added this pull request to the merge queue Oct 21, 2024

Merged via the queue into ava-labs:master with commit 071f780 Oct 21, 2024
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make bootstrapping handle its own timeouts #3410

Make bootstrapping handle its own timeouts #3410

yacovm commented Sep 24, 2024 •

edited

Loading

yacovm Sep 25, 2024

aaronbuchwald Oct 1, 2024

yacovm Oct 1, 2024

aaronbuchwald Oct 1, 2024

yacovm Oct 1, 2024

StephenButtolph Oct 11, 2024

yacovm Oct 11, 2024

StephenButtolph Oct 21, 2024

yacovm Oct 21, 2024

yacovm commented Oct 11, 2024

StephenButtolph left a comment

StephenButtolph Oct 21, 2024

Make bootstrapping handle its own timeouts #3410

Make bootstrapping handle its own timeouts #3410

Conversation

yacovm commented Sep 24, 2024 • edited Loading

Why this should be merged

How this works

How this was tested

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yacovm commented Oct 11, 2024

StephenButtolph left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yacovm commented Sep 24, 2024 •

edited

Loading