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

refactor(server/v2): late bound storeBuilder #22206

Merged
merged 2 commits into from
Oct 10, 2024
Merged

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Oct 9, 2024

Description

Any reason we can't just use StoreBuilder here? It simplifies the config story a bit.


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 (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • New Features

    • Enhanced configuration management for pruning options.
    • Simplified snapshot export functionality.
  • Bug Fixes

    • Streamlined function calls to reduce complexity and improve clarity.

Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve significant updates to the PrunesCmd and createRootStore functions in server/v2/store/commands.go, as well as modifications to the ExportSnapshotCmd function in server/v2/store/snapshot.go. The PrunesCmd now retrieves pruning options from a viper instance, while createRootStore has been restructured to accept only a viper.Viper instance and a logger. The ExportSnapshotCmd function has been simplified by removing an unnecessary parameter. These changes aim to enhance code clarity and maintainability.

Changes

File Path Change Summary
server/v2/store/commands.go - Updated PrunesCmd to retrieve options from viper.
- Overhauled createRootStore to accept only viper.Viper and logger, returning root.Options.
server/v2/store/snapshot.go - Modified ExportSnapshotCmd to simplify parameter list for createRootStore, removing the db parameter.

Possibly related PRs

  • test(server/v2): Add system-test for store's command #21357: This PR adds system tests for the store's command functionalities, which include testing the snapshots and prune commands that are directly related to the changes made in the main PR regarding the ExportSnapshotCmd and PrunesCmd functions.
  • fix(server/v2/store): fix store server flags #21745: This PR modifies the createRootStore function in commands.go, which is directly related to the changes made in the main PR where the createRootStore function was overhauled to simplify its parameters and improve its logic.

Suggested reviewers

  • julienrbrt
  • cool-develope
  • tac0turtle
  • hieuvubk

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.

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.

@github-actions github-actions bot added the C:server/v2 Issues related to server/v2 label Oct 9, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

much better indeed 👍🏾

Copy link
Contributor

@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: 2

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c39ec6f and bcab586.

📒 Files selected for processing (2)
  • server/v2/store/commands.go (3 hunks)
  • server/v2/store/snapshot.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
server/v2/store/commands.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

server/v2/store/snapshot.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (2)
server/v2/store/snapshot.go (1)

42-42: LGTM: Simplified createRootStore call

The change to createRootStore aligns with the PR objective of simplifying the configuration process. The removal of the db parameter suggests that the root store creation has been refactored to use the viper instance for configuration.

To ensure consistency across the codebase, let's verify other calls to createRootStore:

✅ Verification successful

Verified: createRootStore usage is consistent across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other occurrences of createRootStore to ensure consistent usage
rg --type go 'createRootStore\(' --glob '!server/v2/store/snapshot.go'

Length of output: 282

server/v2/store/commands.go (1)

78-87: Improved function implementation looks good

The refactored createRootStore function simplifies the code by removing unnecessary parameters and streamlining the configuration handling. The implementation follows best practices and enhances maintainability.

Comment on lines +44 to 46
rootStore, opts, err := createRootStore(vp, logger)
if err != nil {
return fmt.Errorf("can not create root store %w", err)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Correct spelling of 'cannot' in error message

The error message should use 'cannot' instead of 'can not' as per standard English usage.

Apply this diff to correct the spelling:

 return fmt.Errorf("can not create root store %w", err)
+return fmt.Errorf("cannot create root store %w", err)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
rootStore, opts, err := createRootStore(vp, logger)
if err != nil {
return fmt.Errorf("can not create root store %w", err)
rootStore, opts, err := createRootStore(vp, logger)
if err != nil {
return fmt.Errorf("cannot create root store %w", err)

Comment on lines +59 to 60
diff := latestHeight - opts.SCPruningOption.KeepRecent
cmd.Printf("pruning heights up to %v\n", diff)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Handle potential negative 'diff' value

If opts.SCPruningOption.KeepRecent is greater than latestHeight, the calculated diff will be negative, which may not make sense in the context of pruning. Consider adding a check to ensure that diff is not negative before proceeding.

Consider adding the following check:

+if diff <= 0 {
+    cmd.Println("No heights to prune")
+    return nil
+}
 diff := latestHeight - opts.SCPruningOption.KeepRecent
 cmd.Printf("pruning heights up to %v\n", diff)

Committable suggestion was skipped due to low confidence.

@tac0turtle tac0turtle added this pull request to the merge queue Oct 10, 2024
Merged via the queue into main with commit 742cb07 Oct 10, 2024
75 of 76 checks passed
@tac0turtle tac0turtle deleted the kocu/storebuilder-cmds branch October 10, 2024 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants