Print error on failed blockchain publish

[mkysel]

I would argue that we should not leak internal errors to the client, but it is actually easier to debug for now.

Summary by CodeRabbit

• Bug Fixes
  • Improved error logging for blockchain publishing, enhancing visibility of encountered issues.

[coderabbitai]

Walkthrough

The pull request introduces an enhancement to error logging in the PublishClientEnvelopes method within the pkg/api/payer/service.go file. The modification adds a detailed error logging statement using the zap logging framework when publishing envelopes to the blockchain fails. This change aims to improve error visibility and debugging capabilities by capturing and logging specific error details before returning an error status.

Changes

File	Change Summary
pkg/api/payer/service.go	Added error logging with zap.Error(err) in PublishClientEnvelopes method before returning an error

The changes are minimal and focused on improving error logging without altering the core logic or functionality of the method.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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 (1)

pkg/api/payer/service.go (1)

85-87: LGTM! Consider adding more context to the error log.

The error logging addition is good and matches the project's error handling pattern. However, consider enriching the log with additional context for better debugging:

-s.log.Error("error publishing payer envelopes", zap.Error(err))
+s.log.Error("error publishing payer envelopes to blockchain", 
+    zap.Error(err),
+    zap.String("topic", payload.payload.TargetTopic().String()),
+)

This would help distinguish blockchain publishing errors from node publishing errors and provide more context for debugging.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8433622 and dd38d77.

📒 Files selected for processing (1)

• pkg/api/payer/service.go (1 hunks)

[richardhuaaa]

I think we should add some middleware that automatically logs failed status codes