platform icon indicating copy to clipboard operation
platform copied to clipboard

perf(dapi): fetch only specific unconfirmed transaction

Open shumkov opened this issue 8 months ago • 1 comments

Issue being fixed or feature implemented

If a state transition broadcast failed, we check the mempool to provide a detailed error. Currently, we fetch the entire mempool to ensure the transaction is in there.

What was done?

  • Fetch a specific unconfirmed transaction instead of the entire mempool

How Has This Been Tested?

Updated unit test

Breaking Changes

None

Checklist:

  • [x] I have performed a self-review of my own code
  • [x] I have commented my code, particularly in hard-to-understand areas
  • [x] I have added or updated relevant unit/integration/functional/e2e tests
  • [x] I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • [x] I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • [x] I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced detection of duplicate transactions in the mempool for more precise error handling during state transition broadcasts.
  • Tests

    • Updated unit tests to align with the improved mempool detection method and verify error handling.
  • Chores

    • Updated the Docker image version for the tenderdash service to improve environment consistency.
    • Added a configuration migration to update tenderdash Docker image versions across existing setups.

shumkov avatar Apr 17 '25 12:04 shumkov

Walkthrough

The code for detecting whether a state transition already exists in the mempool was refactored. Instead of retrieving a list of unconfirmed transactions and searching for the relevant state transition, the new approach queries directly for an unconfirmed transaction by its hash using a specific RPC method. Error handling was updated to ignore not-found errors and throw an error if the transaction is found. The corresponding unit test was updated to mock the new RPC method and adjust the expected response structure. Additionally, the default Docker image version for the tenderdash service was updated, and a new configuration migration was added to apply this image version across existing configs.

Changes

File(s) Change Summary
packages/dapi/lib/grpcServer/handlers/platform/broadcastStateTransitionHandlerFactory.js Refactored mempool existence check to use direct transaction hash query via unconfirmed_tx RPC; improved error handling.
packages/dapi/test/unit/grpcServer/handlers/platform/broadcastStateTransitionHandlerFactory.spec.js Updated unit test to mock the new RPC method and response format for checking mempool transactions.
packages/dashmate/configs/defaults/getBaseConfigFactory.js Updated tenderdash Docker image version from 'dashpay/tenderdash:1' to 'dashpay/tenderdash:1.5-dev'.
packages/dashmate/configs/getConfigFileMigrationsFactory.js Added new migration step '2.1.0-dev.1' to update tenderdash Docker image version in all configs to 'dashpay/tenderdash:1.5-dev'.

Possibly related PRs

  • dashpay/platform#2270: Refactors the mempool state transition existence check to use requestTenderRpc('unconfirmed_tx') with enhanced error handling and integration in the broadcast state transition handler.
  • dashpay/platform#2385: Updates the tenderdash Docker image version and adds a corresponding migration, related to configuration management for tenderdash versions.

Suggested reviewers

  • shumkov
  • QuantumExplorer

Poem

A hop, a skip, a mempool check anew,
Now with a hash, we search right through!
No more sifting lists, just one quick peek,
If it’s there, we squeak—AlreadyExists, so to speak!
Testing in tow, with mocks that align,
This rabbit’s code now checks just fine.
🐇✨

[!TIP]

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 2c8334d93fd9b825d1b3c22f73202551f90e7fba and 57092a4f10df7d07adaf7eb0d41c0f8e597ff811.

📒 Files selected for processing (1)
  • packages/dashmate/configs/getConfigFileMigrationsFactory.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/dashmate/configs/getConfigFileMigrationsFactory.js
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build JS packages / Build JS
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar Apr 17 '25 12:04 coderabbitai[bot]