Replace validator wait for activation stream with polling #14514

james-prysm · 2024-10-07T15:56:22Z

What type of PR is this?

Other

What does this PR do? Why is it needed?

deprecates the wait for activation event stream. This PR simplifies the checks for validator activation by polling against the status every epoch instead of receiving gRPC streams. By implementing this way we move one step closer to migrating to a full REST based validator client that can more easily connect with beacon nodes from other clients.

tested with web UI in holesky

Which issues(s) does this PR fix?

Fixes #

Other notes for review

Acknowledgements

I have read CONTRIBUTING.md.
I have made an appropriate entry to CHANGELOG.md.
I have added a description to this PR with sufficient context for reviewers to understand this PR.

james-prysm · 2024-10-07T16:04:43Z

validator/client/validator_test.go

@@ -341,46 +327,6 @@ func TestCanonicalHeadSlot_OK(t *testing.T) {
 	assert.Equal(t, primitives.Slot(0), headSlot, "Mismatch slots")
 }

-func TestWaitMultipleActivation_LogsActivationEpochOK(t *testing.T) {


duplicate test no longer needed, covered in activation_test

james-prysm · 2024-10-07T16:09:45Z

validator/client/wait_for_activation.go

+
+func (v *validator) handleReconnection(ctx context.Context, span octrace.Span, err error, message string, accountsChangedChan <-chan [][fieldparams.BLSPubkeyLength]byte) error {
+	tracing.AnnotateError(span, err)
+	attempts := streamAttempts(ctx)


should i rename this streamAttempts variable?

The code block is small enough that I don't think it matters too much. It should be very clear what it is

i guess it's not really a stream

CHANGELOG.md

saolyn · 2024-10-07T16:49:13Z

validator/client/wait_for_activation.go

+
+func (v *validator) handleReconnection(ctx context.Context, span octrace.Span, err error, message string, accountsChangedChan <-chan [][fieldparams.BLSPubkeyLength]byte) error {
+	tracing.AnnotateError(span, err)
+	attempts := streamAttempts(ctx)


The code block is small enough that I don't think it matters too much. It should be very clear what it is

validator/client/wait_for_activation.go

Co-authored-by: Sammy Rosso <[email protected]>

CHANGELOG.md

validator/client/wait_for_activation.go

rkapka · 2024-10-08T08:38:54Z

validator/client/wait_for_activation.go

+
+	// Step 3: update validator statuses in cache.
+	if err := v.updateValidatorStatusCache(ctx, validatingKeys); err != nil {
+		return v.handleReconnection(ctx, span, err, "Connection broken while waiting for activation. Reconnecting...", accountsChangedChan)


Why do we try to reconnect here? Failing to update the cache does not mean the connection is broken

rkapka · 2024-10-08T08:41:29Z

validator/client/wait_for_activation.go

+
+func (v *validator) getValidatorCount(ctx context.Context) (int64, error) {
+	// TODO: revisit https://github.com/prysmaticlabs/prysm/pull/12471#issuecomment-1568320970 to review if ValidatorCount api can be removed.
+	// "-1" indicates that validator count endpoint is not supported by the beacon node.


I would put this comment as the function documentation. Otherwise callers will get confused when they see -1 returned

validator/client/wait_for_activation.go

rkapka · 2024-10-08T08:50:36Z

validator/client/wait_for_activation.go

+		"slot":                   slot,
+		"seconds_sinceStart":     ss,
+		"next_epoch_start_slot":  firstSlotOfNextEpoch,
+		"slots_until_next_start": firstSlotOfNextEpoch - slot,


Is all of this information really useful? I personally would care only about the next_epoch_start_slot

it was useful for debugging, just having the slot wasn't always meaningful/exact

rkapka · 2024-10-08T08:54:43Z

validator/client/wait_for_activation.go

+		"seconds_sinceStart":     ss,
+		"next_epoch_start_slot":  firstSlotOfNextEpoch,
+		"slots_until_next_start": firstSlotOfNextEpoch - slot,
+	}).Debugf("Waiting %d seconds", waitTime)


We should provide a little more context because it's not obvious what this log refers to. Maybe Waiting until next epoch before re-checking validator statuses...?

rkapka · 2024-10-08T09:01:25Z

validator/client/wait_for_activation.go

+	if err != nil {
+		return err
+	}
+	nextEpochStartDuration, err := slots.ToTime(genesisTimeSec, firstSlotOfNextEpoch)


nitpick: the result of ToTime is not a duration, but a point in time

rkapka · 2024-10-08T09:07:51Z

validator/client/wait_for_activation.go

+	if err != nil {
+		return err
+	}
+	waitTime := uint64(nextEpochStartDuration.Unix()-time.Now().Unix()) + ss


I think this is incorrect, you should not be adding ss. You already know the exact point in time when the next epoch will start, so subtracting the current time from that time gives you the correct answer.

I tested it, the time isn't always 100% exact, sometimes it's like 1-2 seconds off when the new epoch starts
the +ss is just from the current time in the slot so it guarantees it is within the bounds of the start of the first epoch. sometimes adding a 1 second buffer doesn't work

Co-authored-by: Radosław Kapka <[email protected]>

validator/client/wait_for_activation.go

rkapka · 2024-10-10T10:37:41Z

time/slots/slottime.go

+	log.WithFields(logrus.Fields{
+		"current_slot":           currentSlot,
+		"next_epoch_start_slot":  firstSlotOfNextEpoch,
+		"slots_until_next_start": firstSlotOfNextEpoch - currentSlot,
+		"total_wait_time":        waitTime,
+		"is_epoch_start":         IsEpochStart(currentSlot),
+	}).Warn("Waiting until next epoch before re-checking validator statuses...")


This log does not belong here

rkapka · 2024-10-10T10:38:35Z

time/slots/slottime.go

+		"current_slot":           currentSlot,
+		"next_epoch_start_slot":  firstSlotOfNextEpoch,
+		"slots_until_next_start": firstSlotOfNextEpoch - currentSlot,
+		"total_wait_time":        waitTime,
+		"is_epoch_start":         IsEpochStart(currentSlot),


Our convention is to use camelCase for log fields

validator/client/wait_for_activation.go

Co-authored-by: Radosław Kapka <[email protected]>

james-prysm added 5 commits October 4, 2024 08:59

wip, waitForNextEpoch Broken

f0850bc

fixing wait for activation and timings

0e031d4

updating tests wip

e2396be

fixing tests

d877fe5

deprecating wait for activation stream

4f51abd

james-prysm added the Cleanup Code health! label Oct 7, 2024

james-prysm requested a review from a team as a code owner October 7, 2024 15:56

james-prysm requested review from terencechain, rkapka and nisdas October 7, 2024 15:56

james-prysm added the API Api related tasks label Oct 7, 2024

james-prysm changed the title ~~Remove validator wait activation~~ Replace validator wait for activation stream with polling Oct 7, 2024

Merge branch 'develop' into remove-validator-wait-activation

1dbc751

james-prysm marked this pull request as draft October 7, 2024 15:58

removing duplicate test

1312a8e

james-prysm commented Oct 7, 2024

View reviewed changes

james-prysm marked this pull request as ready for review October 7, 2024 16:11

james-prysm added the Ready For Review A pull request ready for code review label Oct 7, 2024

saolyn reviewed Oct 7, 2024

View reviewed changes

james-prysm and others added 2 commits October 7, 2024 14:01

Update validator/client/wait_for_activation.go

85bac27

Co-authored-by: Sammy Rosso <[email protected]>

Update CHANGELOG.md

efb99f0

Co-authored-by: Sammy Rosso <[email protected]>

rkapka reviewed Oct 8, 2024

View reviewed changes

james-prysm and others added 5 commits October 8, 2024 07:58

Update CHANGELOG.md

2356639

Co-authored-by: Radosław Kapka <[email protected]>

Update validator/client/wait_for_activation.go

645e79f

Co-authored-by: Radosław Kapka <[email protected]>

Merge branch 'develop' into remove-validator-wait-activation

2a2df19

moving seconds until next epoch start to slottime and adding unit test

5f6e9f5

removing seconds into slot buffer, will need to test

e513b87

james-prysm added Blocked Blocked by research or external factors and removed Ready For Review A pull request ready for code review labels Oct 8, 2024

james-prysm and others added 2 commits October 9, 2024 13:14

Merge branch 'develop' into remove-validator-wait-activation

6819a82

fixing waittime bug

bca707e

james-prysm added Ready For Review A pull request ready for code review and removed Blocked Blocked by research or external factors labels Oct 9, 2024

adding pr to changelog

6732cc4

rkapka reviewed Oct 10, 2024

View reviewed changes

validator/client/wait_for_activation.go Outdated Show resolved Hide resolved

validator/client/wait_for_activation.go Outdated Show resolved Hide resolved

rkapka requested changes Oct 10, 2024

View reviewed changes

rkapka reviewed Oct 10, 2024

View reviewed changes

validator/client/wait_for_activation.go Show resolved Hide resolved

james-prysm and others added 5 commits October 10, 2024 10:42

Update validator/client/wait_for_activation.go

9aa2121

Co-authored-by: Radosław Kapka <[email protected]>

Update validator/client/wait_for_activation.go

cbb4713

Co-authored-by: Radosław Kapka <[email protected]>

fixing incorect log

a678545

refactoring based on feedback

17e89c3

Merge branch 'develop' into remove-validator-wait-activation

d23faec

rkapka approved these changes Oct 10, 2024

View reviewed changes

james-prysm added this pull request to the merge queue Oct 10, 2024

Merged via the queue into develop with commit 6c22ede Oct 10, 2024
17 of 18 checks passed

james-prysm deleted the remove-validator-wait-activation branch October 10, 2024 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace validator wait for activation stream with polling #14514

Replace validator wait for activation stream with polling #14514

james-prysm commented Oct 7, 2024 •

edited

Loading

james-prysm Oct 7, 2024

james-prysm Oct 7, 2024

saolyn Oct 7, 2024

james-prysm Oct 7, 2024

saolyn Oct 7, 2024

rkapka Oct 8, 2024

rkapka Oct 8, 2024

rkapka Oct 8, 2024

james-prysm Oct 8, 2024

rkapka Oct 8, 2024

rkapka Oct 8, 2024

rkapka Oct 8, 2024

james-prysm Oct 8, 2024

rkapka Oct 10, 2024

rkapka Oct 10, 2024

Replace validator wait for activation stream with polling #14514

Replace validator wait for activation stream with polling #14514

Conversation

james-prysm commented Oct 7, 2024 • edited Loading

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

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

james-prysm commented Oct 7, 2024 •

edited

Loading