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

delete all pending txs & processed msgs before stopping batch submitter #75

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

sh-cha
Copy link
Collaborator

@sh-cha sh-cha commented Feb 6, 2025

Summary by CodeRabbit

  • Chores
    • Enhanced the batch finalization process with improved error handling and cleanup procedures, ensuring greater data consistency and overall system reliability.

@sh-cha sh-cha self-assigned this Feb 6, 2025
@sh-cha sh-cha requested a review from a team as a code owner February 6, 2025 06:31
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Walkthrough

The changes enhance the error handling in the prepareBatch method of the BatchSubmitter class by ensuring that after finalizing the current batch, the system will attempt to delete both processed messages and pending transactions from the database. This addition wraps potential errors with descriptive messages, ensuring that any issues during deletion are clearly reported. No modifications were made to the exported or public entities.

Changes

File Changes Summary
executor/batchsubmitter/batch.go Added two error-handling lines in prepareBatch: one calling node.DeleteProcessedMsgs(bs.da.DB()) and another calling node.DeletePendingTxs(bs.da.DB()), each wrapping errors with descriptive messages.

Sequence Diagram(s)

sequenceDiagram
    participant BS as BatchSubmitter
    participant DB as Database
    participant Node as Node Functions

    BS->>Node: DeleteProcessedMsgs(DB)
    Note right of BS: Error captured and wrapped if deletion fails
    BS->>Node: DeletePendingTxs(DB)
    Note right of BS: Error captured and wrapped if deletion fails
Loading

Poem

I'm a bouncy coder with a twitch in my ear,
Hoping through cleanups with a cheerful cheer.
I scanned the code with hurried hops,
Deleting leftovers till no error stops.
Fresh and tidy, the database sings—
Hip-hip-hooray for bug-free spring!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

Copy link
Member

@beer-1 beer-1 left a comment

Choose a reason for hiding this comment

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

LGTM

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: 0

🧹 Nitpick comments (1)
executor/batchsubmitter/batch.go (1)

59-67: LGTM! Consider adding a log message for better observability.

The implementation correctly cleans up processed messages and pending transactions before resetting the block process, with proper error handling.

Consider adding a log message to track the cleanup operation:

 		err = node.DeleteProcessedMsgs(bs.da.DB())
 		if err != nil {
 			return errors.Wrap(err, "failed to delete processed msgs")
 		}
 		err = node.DeletePendingTxs(bs.da.DB())
 		if err != nil {
 			return errors.Wrap(err, "failed to delete pending txs")
 		}
+		ctx.Logger().Info("cleaned up processed messages and pending transactions")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cb1812c and 45b9223.

📒 Files selected for processing (1)
  • executor/batchsubmitter/batch.go (1 hunks)

@sh-cha sh-cha merged commit 4e3e5e4 into main Feb 6, 2025
6 checks passed
@sh-cha sh-cha deleted the fix/delete-pendingtxs-resetbatchinfo branch February 6, 2025 09:07
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