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

Inherit req ctx when saving state #2241

Merged
merged 14 commits into from
Dec 11, 2024
Merged

Inherit req ctx when saving state #2241

merged 14 commits into from
Dec 11, 2024

Conversation

fridrik01
Copy link
Contributor

@fridrik01 fridrik01 commented Dec 11, 2024

This PR updates the cometbft.Service so now the context.Context that gets passed into the main abci handlers will be used instead of context.Background

Now instead of conensus sending async message to blockchain and
then polling the chan for it to finish, we use DI to directly
call the blockchain service through an interface.

This commit starts this work by removing the genesis events so
its now handled synchronously from consensus layer.
This commit injects the BlockBuilder (the validator package) into
the cometbft.Service and calls it directly, removing the need for
NewSlot, BuiltBeaconBlock and BuiltSidecars events.

It was tricky to get DI working but eventually I found out that
injecting services through an interface with generic params or
return types is most likely not supported by the DI library. I
don't think this is documented anywhere, but you get a runtime
panic from DI once it can't assemble a dependecy based on the
interface definition. The solution here was to rely on only
concrete types, but this meant some additional struct generics
needed to be added to the cometbft.Service.
Now we have separate go files for each abci call we want to handle
and this cleans up the code nicely and makes it easier to read and
traverse the code.
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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. (Experiment)
  • @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

codecov bot commented Dec 11, 2024

Codecov Report

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

Project coverage is 30.68%. Comparing base (711ce6f) to head (f1eb82d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
consensus/cometbft/service/service.go 0.00% 9 Missing ⚠️
consensus/cometbft/service/process_proposal.go 0.00% 2 Missing ⚠️
consensus/cometbft/service/finalize_block.go 0.00% 1 Missing ⚠️
consensus/cometbft/service/init_chain.go 0.00% 1 Missing ⚠️
consensus/cometbft/service/prepare_proposal.go 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2241      +/-   ##
==========================================
- Coverage   30.70%   30.68%   -0.02%     
==========================================
  Files         331      331              
  Lines       15387    15394       +7     
  Branches       20       20              
==========================================
  Hits         4724     4724              
- Misses      10346    10353       +7     
  Partials      317      317              
Files with missing lines Coverage Δ
consensus/cometbft/service/finalize_block.go 0.00% <0.00%> (ø)
consensus/cometbft/service/init_chain.go 0.00% <0.00%> (ø)
consensus/cometbft/service/prepare_proposal.go 0.00% <0.00%> (ø)
consensus/cometbft/service/process_proposal.go 0.00% <0.00%> (ø)
consensus/cometbft/service/service.go 0.00% <0.00%> (ø)

Base automatically changed from remove-async-handling to remove-blockstoreservice December 11, 2024 18:07
@fridrik01 fridrik01 force-pushed the remove-blockstoreservice branch from f24b4f9 to 93b38d2 Compare December 11, 2024 18:40
Base automatically changed from remove-blockstoreservice to main December 11, 2024 18:50
@fridrik01 fridrik01 self-assigned this Dec 11, 2024
@fridrik01 fridrik01 marked this pull request as ready for review December 11, 2024 19:41
@abi87 abi87 merged commit 44bcc69 into main Dec 11, 2024
16 checks passed
@abi87 abi87 deleted the use-request-context branch December 11, 2024 19:47
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