Some good logging

[mkysel]

Needed these to determine what is going on in the network.

Summary by CodeRabbit

• Refactor
  • Enhanced logging for improved contextual error reporting during node operations and stream handling.
  • Updated processing routines to provide more detailed diagnostic information, aiding in troubleshooting.

[coderabbitai]

Walkthrough

This pull request updates the error logging and method signatures in the sync worker. The changes introduce structured logging using zap in several methods to include detailed node information (such as nodeid and HttpAddress). In particular, the subscribeToNodeRegistration, listenToStream, and setupStream methods now log enhanced context when errors occur. Additionally, the listenToStream signature is updated to accept a context and a node parameter, allowing for more comprehensive logging and easier tracing of issues.

Changes

File	Change Summary
pkg/sync/syncWorker.go	- subscribeToNodeRegistration: Enhanced error logging by including structured fields (nodeid, error) and logging context cancellation with HttpAddress. - listenToStream: Updated signature to include a context and a node parameter; enhanced logging now includes the peer's HttpAddress. - setupStream: Added an error log for batch subscribe failures incorporating the node's HttpAddress.

Suggested reviewers

• richardhuaaa

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)

---

📜 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 7567927 and 5396013.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

• pkg/sync/syncWorker.go

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

• GitHub Check: Test (Node)
• GitHub Check: Build pre-baked anvil-xmtpd
• GitHub Check: Lint-Go

---

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

• 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

pkg/sync/syncWorker.go (2)

333-336: Consider utilizing or removing the unused context parameter.

The context parameter is marked as unused (_). If it's not needed, consider removing it from the signature. If it might be needed in the future, add a TODO comment explaining the intended use.

-func (s *syncWorker) listenToStream(
-	_ context.Context,
-	node registry.Node,
-	originatorStream *originatorStream,
-) error {
+func (s *syncWorker) listenToStream(
+	node registry.Node,
+	originatorStream *originatorStream,
+) error {

---

276-276: Use structured logging consistently.

Replace fmt.Sprintf with zap's structured logging for consistency with the rest of the codebase.

-	s.log.Debug(fmt.Sprintf("Successfully opened a connection to peer at %s", node.HttpAddress))
+	s.log.Debug("Successfully opened a connection to peer", zap.String("peer", node.HttpAddress))

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 92fc298 and 7567927.

📒 Files selected for processing (1)

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

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

• GitHub Check: Test (Node)
• GitHub Check: Build pre-baked anvil-xmtpd
• GitHub Check: Lint-Go

🔇 Additional comments (3)

pkg/sync/syncWorker.go (3)

166-166: Great enhancement to error logging!

The structured logging with zap and inclusion of nodeid improves error traceability.

---

184-189: Excellent addition of node address in connection logs!

The inclusion of HttpAddress in both success and error scenarios provides valuable context for network debugging.

---

309-318: Well-structured error logging for subscription failures!

The enhanced error logging with peer address provides better context for debugging subscription issues.

[fbac]

Good logging is immediately approved always.