Skip to content

chore: log peer count in WaitForSync to diagnose sync flakes #7149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rootulp merged 3 commits into from
Apr 22, 2026
+16 −5
Merged

chore: log peer count in WaitForSync to diagnose sync flakes #7149

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1d7c30
chore: log peer count in WaitForSync to diagnose sync flakes
rootulp Apr 20, 2026
0d4070a
chore: split logSyncStatus into success/error paths
rootulp Apr 21, 2026
b59785f
Merge branch 'main' into rootulp/log-peer-count-wait-for-sync
rootulp Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions test/docker-e2e/e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ func (s *CelestiaTestSuite) GetLatestBlockHeight(ctx context.Context, statusClie
// WaitForSync waits for a Celestia node to synchronize based on a provided sync condition within a specified timeout.
// The method periodically checks the node's sync status. Returns an error if the timeout is exceeded.
// Returns nil when the provided condition function returns true.
func (s *CelestiaTestSuite) WaitForSync(ctx context.Context, statusClient rpcclient.StatusClient, syncTimeout time.Duration, syncCondition func(coretypes.SyncInfo) bool) error {
func (s *CelestiaTestSuite) WaitForSync(ctx context.Context, client rpcclient.Client, syncTimeout time.Duration, syncCondition func(coretypes.SyncInfo) bool) error {
ticker := time.NewTicker(10 * time.Second)
defer ticker.Stop()

Expand All @@ -148,8 +148,8 @@ func (s *CelestiaTestSuite) WaitForSync(ctx context.Context, statusClient rpccli
s.T().Log("Waiting for sync to complete...")

// check immediately first
if status, err := statusClient.Status(timeoutCtx); err == nil {
s.T().Logf("Sync node status: Height=%d, CatchingUp=%t", status.SyncInfo.LatestBlockHeight, status.SyncInfo.CatchingUp)
if status, err := client.Status(timeoutCtx); err == nil {
s.logSyncStatus(timeoutCtx, client, status.SyncInfo)
if syncCondition(status.SyncInfo) {
s.T().Logf("Sync completed successfully")
return nil
Expand All @@ -160,13 +160,13 @@ func (s *CelestiaTestSuite) WaitForSync(ctx context.Context, statusClient rpccli
for {
select {
case <-ticker.C:
status, err := statusClient.Status(timeoutCtx)
status, err := client.Status(timeoutCtx)
if err != nil {
s.T().Logf("Failed to get status from state sync node, retrying...: %v", err)
continue
}

s.T().Logf("Sync node status: Height=%d, CatchingUp=%t", status.SyncInfo.LatestBlockHeight, status.SyncInfo.CatchingUp)
s.logSyncStatus(timeoutCtx, client, status.SyncInfo)

if syncCondition(status.SyncInfo) {
s.T().Logf("Sync completed successfully")
Expand All @@ -179,6 +179,16 @@ func (s *CelestiaTestSuite) WaitForSync(ctx context.Context, statusClient rpccli
}
}

// logSyncStatus logs the node's sync status along with peer count. A NetInfo
// error is logged but not fatal — sync-wait polling continues either way.
func (s *CelestiaTestSuite) logSyncStatus(ctx context.Context, client rpcclient.Client, info coretypes.SyncInfo) {
peers := -1
if netInfo, err := client.NetInfo(ctx); err == nil {
peers = netInfo.NPeers
}
s.T().Logf("Sync node status: Height=%d, CatchingUp=%t, Peers=%d", info.LatestBlockHeight, info.CatchingUp, peers)
}
Comment thread
rootulp marked this conversation as resolved.

// CheckLiveness validates that all validators proposed blocks and no nodes halted.
// Automatically waits for sufficient blocks (3 per validator minimum) if needed.
//
Expand Down
Loading