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: resolve potential deadlock in coinjoin_tests #6593

Merged
merged 1 commit into from
Feb 23, 2025

Conversation

UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Feb 22, 2025

Issue being fixed or feature implemented

ScanForWalletTransactions should be called outside of cs_wallet lock scope which is not the case for CTransactionBuilderTestSetup ctor in coinjoin_tests.cpp atm.

Should fix tsan test failures like https://github.com/PastaPastaPasta/dash/actions/runs/13467587625/job/37636500963#step:8:1.

What was done?

How Has This Been Tested?

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

ScanForWalletTransactions should be called outside of cs_wallet lock scope
@UdjinM6 UdjinM6 added this to the 23 milestone Feb 22, 2025
Copy link

coderabbitai bot commented Feb 22, 2025

Walkthrough

The changes update the method used to determine the starting block hash in a wallet transaction scanning process, specifically within a test setup. The original code retrieved the genesis block hash from the active chain using one approach. The new implementation obtains the block hash by calling a method on the wallet's chain interface with an index of 0. Other than this adjustment in sourcing the block hash, the call to the ScanForWalletTransactions method maintains its parameters and overall logic. No modifications were made to public or exported declarations.


📜 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 843a00d and 2f5a466.

📒 Files selected for processing (1)
  • src/wallet/test/coinjoin_tests.cpp (1 hunks)
🔇 Additional comments (2)
src/wallet/test/coinjoin_tests.cpp (2)

143-148: LGTM! Good fix for the potential deadlock.

Moving ScanForWalletTransactions outside of the cs_wallet lock scope is the correct approach to prevent deadlocks, as the function may acquire locks internally. The use of WalletRescanReserver ensures proper synchronization.


145-145:

✅ Verification successful

Consider verifying the equivalence of block hash retrieval methods.

The change from m_node.chainman->ActiveChain().Genesis()->GetBlockHash() to wallet->chain().getBlockHash(0) appears logically equivalent but should be verified.

Run this script to confirm both methods return the same block hash:


🏁 Script executed:

#!/bin/bash
# Description: Search for other usages of these methods to verify they are used interchangeably
# and to ensure there are no special cases where one is preferred over the other.

# Search for Genesis block hash retrieval patterns
rg -A 2 "ActiveChain\(\)\.Genesis\(\)->GetBlockHash\(\)"
rg -A 2 "chain\(\)\.getBlockHash\(0\)"

# Search for any comments or documentation about these methods
rg -A 5 -i "genesis.*block.*hash"

Length of output: 14689


Block Hash Retrieval Equivalence Verified

After running the search queries, it's clear that both m_node.chainman->ActiveChain()->Genesis()->GetBlockHash() and wallet->chain().getBlockHash(0) are used in similar contexts across the codebase (e.g., in wallet and RPC tests). The evidence confirms that these methods are used interchangeably without any special cases, so the change in coinjoin_tests.cpp is valid.

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

Copy link
Member

@PastaPastaPasta PastaPastaPasta left a comment

Choose a reason for hiding this comment

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

utACK 2f5a466; thanks for looking into it!

Copy link
Collaborator

@kwvg kwvg left a comment

Choose a reason for hiding this comment

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

utACK 2f5a466

@PastaPastaPasta PastaPastaPasta merged commit 22ba436 into dashpay:develop Feb 23, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants