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

chore(DefaultServiceOptions): minor chainID loading refactoring #2022

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

abi87
Copy link
Collaborator

@abi87 abi87 commented Sep 25, 2024

chainID is either specified by flag or read by genesis file. In handling the genesis file, we currently have a couple of gosec warnings around fliepath sanitization and closing the file, which I believe are easily solvable. This PR does that.

Ignoring errors in closing a file may be dangerous. This is not the case for genesis ( we only read the file, not write it). Still I wanted to introduce the error handling to solicit conversation around how to generally handle it in the overall codebase

Summary by CodeRabbit

  • New Features
    • Introduced a new method for loading the chain ID from the genesis file, enhancing error handling and code organization.
  • Refactor
    • Streamlined the implementation of the DefaultServiceOptions function by removing inline logic and improving readability.

@abi87 abi87 self-assigned this Sep 25, 2024
Copy link
Contributor

coderabbitai bot commented Sep 25, 2024

Walkthrough

The changes introduce a new function, loadChainIDFromGenesis, in the baseapp_options.go file. This function is responsible for loading the chain ID from the genesis file, improving the organization of the code by separating this logic from the DefaultServiceOptions function. The new implementation enhances error handling and ensures the proper closure of file descriptors, streamlining the code and making it more readable.

Changes

Files Change Summary
mod/node-core/pkg/builder/baseapp_options.go Added method loadChainIDFromGenesis(appOpts config.AppOptions) (string, error), refactored logic for loading chain ID from the genesis file, improved error handling, and removed inline logic from DefaultServiceOptions.

Poem

In the code where rabbits hop,
A new function makes the old one stop.
With a chain ID from genesis bright,
Errors handled, everything's right!
Hopping through logic, so neat and clean,
A happy codebase, a joyful scene! 🐇✨


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 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 Sep 25, 2024

Codecov Report

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

Project coverage is 22.37%. Comparing base (af61ea8) to head (497bca7).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
mod/node-core/pkg/builder/baseapp_options.go 0.00% 23 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2022      +/-   ##
==========================================
- Coverage   22.38%   22.37%   -0.02%     
==========================================
  Files         358      358              
  Lines       16043    16051       +8     
  Branches       12       12              
==========================================
  Hits         3591     3591              
- Misses      12303    12311       +8     
  Partials      149      149              
Flag Coverage Δ
22.37% <0.00%> (-0.02%) ⬇️
Files with missing lines Coverage Δ
mod/node-core/pkg/builder/baseapp_options.go 0.00% <0.00%> (ø)

fp = filepath.Join(homeDir, "config", "genesis.json")
)

f, err := os.Open(filepath.Clean(fp))
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Found here the suggestion to fix it up

Comment on lines +100 to +110
if err != nil {
return "",
errors.Join(
f.Close(),
fmt.Errorf(
"failed to parse chain-id from genesis file: %w",
err,
),
)
}
return chainID, f.Close()
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

here we avoid defer f.Close() (which ignores the error causing the gosec warning) and we explicitly return the (unlikely) f.Close error to the caller.

@abi87 abi87 marked this pull request as ready for review September 25, 2024 21:06
@itsdevbear itsdevbear enabled auto-merge (squash) September 27, 2024 01:08
@itsdevbear itsdevbear merged commit 9cbd0b0 into main Sep 27, 2024
16 checks passed
@itsdevbear itsdevbear deleted the minor-chainID-cleanup branch September 27, 2024 01:16
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