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

fix: remove txs after execution in DummyExecutor #48

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Conversation

tzdybal
Copy link
Member

@tzdybal tzdybal commented Jan 15, 2025

Overview

Original implementation of DummyExecutor incorrectly removed transaction from "mempool" (in-memory slice in this case) during GetTxs.

Summary by CodeRabbit

  • New Features

    • Enhanced transaction management in the dummy executor.
    • Improved tracking of executed transactions.
  • Tests

    • Added a new test for verifying transaction removal functionality.

Original implementation of `DummyExecutor` incorrectly removed transaction from "mempool" (in-memory slice in this case) during `GetTxs`.
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces modifications to the DummyExecutor in test/dummy.go, focusing on transaction management. A new method removeExecutedTxs is added to efficiently remove executed transactions from the injectedTxs slice. The ExecuteTxs method is updated to utilize this new method, ensuring clean tracking of transactions. The GetTxs method is modified to preserve the list of injected transactions, and necessary imports are added to support the new functionality.

Changes

File Change Summary
test/dummy.go - Added removeExecutedTxs method to filter out executed transactions
- Updated ExecuteTxs to call removeExecutedTxs
- Modified GetTxs to preserve injectedTxs
- Added imports for bytes and slices
test/dummy_test.go - Added TestTxRemoval to test transaction handling in DummyExecutor
- Included assertions to verify transaction states after execution
- Added necessary imports for testing utilities

Suggested labels

testing

Suggested reviewers

  • gupadhyaya
  • yarikbratashchuk
  • MSevey
  • tuxcanfly

Possibly related PRs

Poem

🐰 A Rabbit's Ode to Transaction Tracking 🚀
In the world of dummy executors bright,
Transactions dance with newfound might.
Slices trimmed with surgical care,
No executed tx left to spare.
A clean slate for the next coding flight!

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

@RollkitBot RollkitBot requested review from a team, tuxcanfly, gupadhyaya and Manav-Aggarwal and removed request for a team January 15, 2025 13:44
@tzdybal tzdybal enabled auto-merge January 15, 2025 13:46
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)
test/dummy.go (1)

75-79: Consider optimizing transaction removal for better performance.

The current implementation has O(n*m) complexity where n is the size of injectedTxs and m is the size of txs. For better performance, especially with larger transaction volumes, consider using a map-based approach for O(n) complexity.

Here's a more efficient implementation:

 func (e *DummyExecutor) removeExecutedTxs(txs []types.Tx) {
+    // Create a map for O(1) lookup
+    txMap := make(map[string]struct{}, len(txs))
+    for _, tx := range txs {
+        txMap[string(tx)] = struct{}{}
+    }
+    
+    // Single pass through injectedTxs
+    e.injectedTxs = slices.DeleteFunc(e.injectedTxs, func(tx types.Tx) bool {
+        _, exists := txMap[string(tx)]
+        return exists
+    })
-    e.injectedTxs = slices.DeleteFunc(e.injectedTxs, func(tx types.Tx) bool {
-        return slices.ContainsFunc(txs, func(t types.Tx) bool { return bytes.Equal(tx, t) })
-    })
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7ae2c65 and d28d873.

📒 Files selected for processing (1)
  • test/dummy.go (3 hunks)
🔇 Additional comments (2)
test/dummy.go (2)

4-5: LGTM! Import changes are appropriate.

The added imports from the standard library (bytes and slices) are necessary for the new transaction removal functionality.

Also applies to: 9-9


61-61: LGTM! Transaction cleanup is now handled correctly.

The addition of removeExecutedTxs call ensures that transactions are removed from the mempool only after successful execution, which aligns with the PR's objective.

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

🧹 Nitpick comments (1)
test/dummy_test.go (1)

25-57: Consider adding more test cases.

The test could be enhanced by:

  1. Using a table-driven approach to test different scenarios
  2. Adding edge cases like:
    • Executing non-existent transactions
    • Executing the same transaction multiple times
    • Executing multiple transactions in one call

Would you like me to help implement these additional test cases?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d28d873 and 13f1c5a.

📒 Files selected for processing (1)
  • test/dummy_test.go (2 hunks)
🧰 Additional context used
🪛 GitHub Check: lint / golangci-lint
test/dummy_test.go

[failure] 5-5:
File is not properly formatted (goimports)

🪛 golangci-lint (1.62.2)
test/dummy_test.go

5-5: File is not goimports-ed with -local github.com/rollkit

(goimports)

🪛 GitHub Actions: CI and Release
test/dummy_test.go

[error] 5-5: File is not properly formatted (goimports)

🔇 Additional comments (1)
test/dummy_test.go (1)

25-57: Well-structured test implementation!

The test thoroughly verifies the transaction removal behavior with clear steps and comprehensive assertions.

@tzdybal tzdybal force-pushed the tzdybal/fix_mempool branch from 13f1c5a to 42c630f Compare January 15, 2025 14:32
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 (2)
test/dummy_test.go (2)

26-26: Add descriptive comment explaining the test's purpose.

While the test implementation is good, please add a comment explaining that this test validates the fix for transaction removal behavior in DummyExecutor, specifically that transactions are only removed after execution and not during GetTxs.

+// TestTxRemoval validates that transactions in DummyExecutor are only removed
+// after being executed, and not during GetTxs calls
 func TestTxRemoval(t *testing.T) {

26-58: Consider adding more test cases.

The current test effectively validates the basic transaction removal behavior. Consider adding these additional test cases to improve coverage:

  1. Executing an empty transaction list
  2. Executing multiple transactions at once
  3. Executing a non-existent transaction
  4. Executing the same transaction twice

Would you like me to provide an implementation for these additional test cases?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13f1c5a and 42c630f.

📒 Files selected for processing (1)
  • test/dummy_test.go (2 hunks)
🔇 Additional comments (1)
test/dummy_test.go (1)

4-11: Fix import ordering using goimports.

The imports need to be reordered according to the project's formatting rules.

@tzdybal tzdybal added this pull request to the merge queue Jan 15, 2025
Merged via the queue into main with commit a398e4d Jan 15, 2025
10 checks passed
@tzdybal tzdybal deleted the tzdybal/fix_mempool branch January 15, 2025 23:06
Copy link

🎉 This PR is included in version 0.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

3 participants