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: prevent nil memory access #130

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Conversation

beer-1
Copy link
Collaborator

@beer-1 beer-1 commented Dec 9, 2024

Description

Closes: #XXXX

There may be a timing issue when fetching the receipt, specifically between the getTransaction and getReceipt calls. The getTransaction call can return a transaction in a pending state, while the getReceipt call might complete when the transaction has already transitioned to the committed state.

As a result, when attempting to marshalReceipt with transaction data from the pending state, it can lead to a crash during the query.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling for transaction retrieval, allowing for better identification of pending or queued transactions.
  • Documentation

    • Updated comments to clarify the conditions under which a transaction receipt may not be retrievable.

@beer-1 beer-1 requested a review from djm07073 December 9, 2024 04:59
@beer-1 beer-1 self-assigned this Dec 9, 2024
@beer-1 beer-1 requested a review from a team as a code owner December 9, 2024 04:59
Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request focus on the GetTransactionReceipt method within the JSONRPCBackend struct. The primary modification enhances the error handling logic, expanding the conditions under which a transaction receipt may be considered non-retrievable. This includes checks for nil values in the transaction object and its block number, allowing for broader scenarios where a transaction might be pending or queued. Comments in the code have been updated to clarify these new conditions.

Changes

File Path Change Summary
jsonrpc/backend/tx.go Modified GetTransactionReceipt method to improve error handling logic for transaction retrieval. Updated comments for clarity.

Possibly related PRs

🐇 In the code where transactions flow,
A check for nil now helps us know,
If pending or queued, they might still be,
Robust retrieval, as clear as can be!
With comments updated, the path is bright,
In the world of JSON, everything's right! 🌟


🪧 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

@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

🧹 Outside diff range and nitpick comments (1)
jsonrpc/backend/tx.go (1)

187-188: Consider adding debug logging for better observability.

Adding debug logs when a transaction is skipped due to being nil or pending would help with troubleshooting and monitoring.

 } else if rpcTx == nil || rpcTx.BlockNumber == nil || rpcTx.BlockNumber.ToInt() == nil {
+    b.logger.Debug("transaction not ready for receipt", "hash", hash, "status", func() string {
+        switch {
+        case rpcTx == nil:
+            return "not_found"
+        case rpcTx.BlockNumber == nil:
+            return "no_block_number"
+        default:
+            return "invalid_block_number"
+        }
+    }())
     return nil, nil // tx is not found or in pending/queued state
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 55ab7cf and 58b076d.

📒 Files selected for processing (1)
  • jsonrpc/backend/tx.go (1 hunks)
🔇 Additional comments (1)
jsonrpc/backend/tx.go (1)

187-188: LGTM! Comprehensive nil checks prevent memory access issues.

The additional nil checks properly handle the race condition between getTransaction and getReceipt calls, preventing potential crashes in marshalReceipt when a transaction is in pending/queued state.

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 56.93%. Comparing base (55ab7cf) to head (58b076d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
jsonrpc/backend/tx.go 0.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   56.93%   56.93%           
=======================================
  Files         110      110           
  Lines       10063    10063           
=======================================
  Hits         5729     5729           
  Misses       3508     3508           
  Partials      826      826           
Files with missing lines Coverage Δ
jsonrpc/backend/tx.go 53.98% <0.00%> (ø)

Copy link
Contributor

@djm07073 djm07073 left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1 beer-1 merged commit 05f54b7 into main Dec 9, 2024
9 of 10 checks passed
@beer-1 beer-1 deleted the fix/prevent-nil-memory-access branch December 9, 2024 06:33
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