0.2-dev Rework retry

[mkysel]

Retry was working OK, but it some cases it would get too fast, ignoring the exponential backoff.

This PR explicitly controls the backoff strategy.

Summary by CodeRabbit

• Refactor
  • Enhanced the synchronization process with streamlined error management and reconnection logic.
• Bug Fixes
  • Improved handling for interruptions and compatibility issues to ensure smoother, more reliable recovery during connectivity disruptions.

[coderabbitai]

Walkthrough

The pull request refines the error handling and control flow within the synchronization worker. Specifically, it removes the ExitLoopError struct and its method and streamlines the retry logic in the node registration subscription by replacing a looping backoff strategy with a direct call to the stream listener function. The backoff mechanism is updated to disable a maximum elapsed time, and error responses are adjusted: context cancellations yield permanent errors, EOF errors reset the backoff interval, and compatibility issues trigger a longer retry delay.

Changes

File

Change Summary

pkg/sync/syncWorker.go

- Removed ExitLoopError struct and its Error() method. - Modified subscribeToNodeRegistration to replace looping backoff with a direct call to s.listenToStream. - Updated backoff retry (max elapsed time set to zero). - In listenToStream, adjusted error handling for context cancellation (returns permanent error) and for EOF (resets backoff to one second). - Added a new condition for compatibility errors, returning a retry error after one hour.

Sequence Diagram(s)

sequenceDiagram
    participant Worker as SyncWorker
    participant Stream as Stream Listener

    Worker->>Stream: Call listenToStream()
    alt Context canceled
        Stream-->>Worker: Return permanent error (stop processing)
    else EOF error encountered
        Stream-->>Worker: Return error & reset backoff (1s delay)
    else Compatibility error detected
        Stream-->>Worker: Return error (retry after 1h)
    else Other error occurred
        Stream-->>Worker: Return error (continue retrying)
    end

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85b9abc and eb8e5e1.

📒 Files selected for processing (1)

• pkg/sync/syncWorker.go (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test (Node)

🔇 Additional comments (7)

pkg/sync/syncWorker.go (7)

21-21: Good addition of the strings package.

This import is necessary for the new error handling logic that checks for compatibility errors in error messages.

---

222-223: Improved error handling in the retry mechanism.

The code now directly returns errors from listenToStream to the backoff mechanism instead of implementing custom retry logic. This simplifies the code and lets the backoff library handle retries properly.

---

226-231: Enhanced backoff configuration with explicit control.

Setting WithMaxElapsedTime(0) disables the time limit for retries, allowing the process to continue indefinitely until success or context cancellation. This aligns with the PR objective of improving the retry mechanism with proper exponential backoff.

---

376-376: Better context cancellation handling.

Returning a permanent error when the context is canceled is the correct approach. This clearly signals to the backoff mechanism that retries should stop completely, rather than returning nil which could lead to ambiguous behavior.

---

391-394: Improved EOF error handling.

Resetting the backoff to 1 second on EOF is a good strategy. This allows the system to quickly recover when connections reset naturally, rather than waiting for increasingly longer backoff periods.

---

400-408: Smart handling of compatibility errors.

Adding specific handling for compatibility errors with a longer retry delay (1 hour) is an excellent approach. This prevents excessive retries when nodes won't accept each other's versions while still allowing for eventual reconnection if configurations change.

---

153-232:

Details

✅ Verification successful

Verify the removal of ExitLoopError is handled properly.

The AI summary mentions that ExitLoopError struct and its method were removed, but I don't see explicit checks to ensure all usages were properly replaced. Let's verify this change doesn't create issues elsewhere.

---

🏁 Script executed:

#!/bin/bash
# Check if ExitLoopError was used anywhere else in the codebase
rg "ExitLoopError" --type go

Length of output: 28

---

ExitLoopError Removal Verified

I ran a repository-wide search for “ExitLoopError” in Go files, and no matches were found. This indicates that all references to ExitLoopError have been removed and its removal is properly handled in the changes. The code in pkg/sync/syncWorker.go does not include explicit checks for ExitLoopError, which is consistent with its complete removal from the codebase.

• No references to ExitLoopError exist across the repository.
• The updated error handling and retry logic remain unaffected.

The removal appears sound. Please proceed with a final manual review of any edge cases to ensure that no overlooked dependencies on the removed error exist.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[macroscopeapp]

Refactor Node Registration Retry Logic

Modified error handling and retry mechanism in sync worker. Replaced infinite loop retry with backoff.Retry, added error-specific retry intervals for EOF and compatibility errors, and updated permanent error handling for context cancellation.

📍Where to Start

The subscribeToNodeRegistration function in syncWorker.go which contains the main changes to the retry logic.

---

Macroscope summarized eb8e5e1.