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

feat: log transactions that gets no receipt #2048

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

edisontim
Copy link
Collaborator

@edisontim edisontim commented Nov 7, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for transaction processing, providing clearer feedback on failures.
    • Introduced a "transactionFailed" event to communicate reasons for transaction reverts.
  • Bug Fixes

    • Improved robustness of transaction handling by ensuring errors are logged and re-thrown for further handling.

Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eternum ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 8:21pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Nov 7, 2024 8:21pm

Copy link
Contributor

mentatbot bot commented Nov 7, 2024

You are out of MentatBot reviews. Your usage will refresh November 11 at 08:00 AM.

Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The changes involve modifications to the EternumProvider class in the sdk/packages/eternum/src/provider/index.ts file. The waitForTransactionWithCheck method has been updated to include enhanced error handling. A try-catch block has been added to log errors during transaction waits, and if a transaction is reverted, a "transactionFailed" event is emitted along with an error throw. These updates improve the clarity and robustness of transaction execution and error reporting.

Changes

File Path Change Summary
sdk/packages/eternum/src/provider/index.ts Enhanced error handling in waitForTransactionWithCheck: added try-catch, logging, and event emission for reverted transactions.

Poem

In the garden of code, where transactions play,
A rabbit hops in, to brighten the day.
With catches and logs, errors now show,
"Transaction failed!"—the message will glow.
Hooray for the changes, so robust and bright,
In the world of Eternum, all feels just right! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1bf782f and 16e679d.

📒 Files selected for processing (1)
  • sdk/packages/eternum/src/provider/index.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • sdk/packages/eternum/src/provider/index.ts

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>, 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 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.

Copy link

github-actions bot commented Nov 7, 2024

Failed to generate code suggestions for PR

Copy link
Contributor

@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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 93c3146 and 1bf782f.

📒 Files selected for processing (1)
  • sdk/packages/eternum/src/provider/index.ts (1 hunks)

Comment on lines 58 to 66
let receipt;
try {
receipt = await this.provider.waitForTransaction(transactionHash, {
retryInterval: 500,
});
} catch (error) {
console.error(error);
throw error;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance error handling and logging.

The current implementation has several areas for improvement:

  1. Replace console.error with structured logging that includes the transaction hash for better traceability.
  2. Preserve error context when re-throwing.
  3. Emit an event for consistency with other error cases.

Consider applying this improvement:

 let receipt;
 try {
   receipt = await this.provider.waitForTransaction(transactionHash, {
     retryInterval: 500,
   });
 } catch (error) {
-  console.error(error);
-  throw error;
+  const enhancedError = new Error(`Failed to wait for transaction ${transactionHash}: ${error.message}`);
+  enhancedError.cause = error;
+  this.emit("transactionError", { transactionHash, error: enhancedError });
+  throw enhancedError;
 }
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
let receipt;
try {
receipt = await this.provider.waitForTransaction(transactionHash, {
retryInterval: 500,
});
} catch (error) {
console.error(error);
throw error;
}
let receipt;
try {
receipt = await this.provider.waitForTransaction(transactionHash, {
retryInterval: 500,
});
} catch (error) {
const enhancedError = new Error(`Failed to wait for transaction ${transactionHash}: ${error.message}`);
enhancedError.cause = error;
this.emit("transactionError", { transactionHash, error: enhancedError });
throw enhancedError;
}

@ponderingdemocritus ponderingdemocritus merged commit 72b8190 into next Nov 7, 2024
11 checks passed
@ponderingdemocritus ponderingdemocritus deleted the feat/log-transactionhash-for-no-receipt branch November 7, 2024 22:08
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.

2 participants