Skip to content
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.

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

Rpc crawler #18

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Rpc crawler #18

wants to merge 7 commits into from

Conversation

faddat
Copy link
Contributor

@faddat faddat commented Apr 30, 2024

Check for problems by actually running the crawler

Summary by CodeRabbit

  • New Features
    • Introduced a GitHub Actions workflow for automated testing across multiple operating systems.
  • Enhancements
    • Improved synchronization in node checking functionalities to enhance thread safety.
    • Enhanced network information fetching with timeout-managed contexts for reliability.
  • Bug Fixes
    • Corrected the return behavior of the FetchNodeInfoGRPC function to return nil on success.

Copy link

coderabbitai bot commented May 6, 2024

Walkthrough

The recent updates introduce enhanced thread safety in Go codebases through synchronization mechanisms in checknode.go, and improved network operations handling in lib.go using context with timeouts. Additionally, a new GitHub Actions workflow in test.yml supports testing and running Go code across various operating systems.

Changes

File Path Change Summary
.github/workflows/.../test.yml Introduced a workflow for testing and running Go code on multiple OS.
lib/checknode.go Added synchronization with sync.RWMutex for thread safety in various maps.
lib/lib.go Updated gRPC and HTTP networking functions to use contexts with timeouts.

🐰✨
A hop, a skip, a code deploy,
Through fields of green, our bugs destroy.
With mutex locks and timed requests,
Our code now safely rests.
Celebrate the sync, the test, the joy! 🎉
🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5c81988 and f00271b.
Files ignored due to path filters (2)
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum
Files selected for processing (3)
  • .github/workflows/test.yml (1 hunks)
  • lib/checknode.go (3 hunks)
  • lib/lib.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/test.yml
Additional comments not posted (10)
lib/checknode.go (8)

15-15: Added mutex for earliestBlock to ensure thread safety.


17-17: Added mutex for rpcAddr to ensure thread safety.


19-19: Added mutex for grpcAddr to ensure thread safety.


21-21: Added mutex for apiAddr to ensure thread safety.


23-23: Added mutex for moniker to ensure thread safety.


29-29: Added mutex for archiveNodes to ensure thread safety.


33-38: Ensure proper locking and unlocking around rpcAddr map access to prevent data races.


49-72: Ensure thread safety by locking and unlocking around map reinitializations. This is crucial when resetting the state in a concurrent environment.

lib/lib.go (2)

91-106: Updated FetchNodeInfoGRPC to use a context with a timeout, improving the management of network resources and handling potential long-running operations more gracefully.


110-112: Updated FetchNetInfo to use a context with a timeout, enhancing the reliability of network operations by managing long-running requests effectively.

Comment on lines +79 to +92
if client == nil {
color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}

ctx := context.TODO()
status, err := client.Status(ctx)
if err != nil {
color.Red("[%s] cannot fetch status\n", time.Now().Format("2006-01-02 15:04:05"))
return
}
if status == nil {
color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proper error handling and user feedback when client operations fail. However, consider using a more structured logging approach instead of direct user feedback for better maintainability.

- color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
+ log.Errorf("Client is nil for %s at %s", nodeAddr, time.Now().Format("2006-01-02 15:04:05"))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
if client == nil {
color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
ctx := context.TODO()
status, err := client.Status(ctx)
if err != nil {
color.Red("[%s] cannot fetch status\n", time.Now().Format("2006-01-02 15:04:05"))
return
}
if status == nil {
color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
if client == nil {
log.Errorf("Client is nil for %s at %s", nodeAddr, time.Now().Format("2006-01-02 15:04:05"))
return
}
ctx := context.TODO()
status, err := client.Status(ctx)
if err != nil {
color.Red("[%s] cannot fetch status\n", time.Now().Format("2006-01-02 15:04:05"))
return
}
if status == nil {
color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return

Comment on lines +108 to +124
if client == nil {
color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
netinfo, err := FetchNetInfo(client)
if err == nil {
color.Green("[%s] Got net info from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
CheckNodeGRPC(nodeAddr)
// CheckNodeGRPC(nodeAddr)
ctx := context.TODO()
status, err := client.Status(ctx)
moniker[nodeAddr] = status.NodeInfo.Moniker
if err != nil {
color.Red("[%s] Failed to fetch client from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
if status == nil {
color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure proper error handling and user feedback when client operations fail. Similar to previous comment, consider using structured logging.

- color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
+ log.Errorf("Status is nil for %s at %s", nodeAddr, time.Now().Format("2006-01-02 15:04:05"))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
if client == nil {
color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
netinfo, err := FetchNetInfo(client)
if err == nil {
color.Green("[%s] Got net info from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
CheckNodeGRPC(nodeAddr)
// CheckNodeGRPC(nodeAddr)
ctx := context.TODO()
status, err := client.Status(ctx)
moniker[nodeAddr] = status.NodeInfo.Moniker
if err != nil {
color.Red("[%s] Failed to fetch client from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
if status == nil {
color.Red("[%s] Status is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
if client == nil {
color.Red("[%s] Client is nil for %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
netinfo, err := FetchNetInfo(client)
if err == nil {
color.Green("[%s] Got net info from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
// CheckNodeGRPC(nodeAddr)
ctx := context.TODO()
status, err := client.Status(ctx)
if err != nil {
color.Red("[%s] Failed to fetch client from %s\n", time.Now().Format("2006-01-02 15:04:05"), nodeAddr)
return
}
if status == nil {
log.Errorf("Status is nil for %s at %s", nodeAddr, time.Now().Format("2006-01-02 15:04:05"))
return

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant