Skip to content

Fix panic from missing batch in force-start-height#744

Merged
peterargue merged 1 commit into
mainfrom
petera/fix-force-start-height
Jan 30, 2025
Merged

Fix panic from missing batch in force-start-height#744
peterargue merged 1 commit into
mainfrom
petera/fix-force-start-height

Conversation

@peterargue
Copy link
Copy Markdown
Contributor

@peterargue peterargue commented Jan 30, 2025

Closes: #???

Description

Fixes panic when running with --force-start-height that was caused by a missing batch in the call to SetLatestCadenceHeight.

Also combines the db setup updates into a single batch to ensure the changes are only made if the setup is successful


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Performance Improvements
    • Enhanced database operation efficiency by introducing a new batch handling mechanism
    • Optimized storage setup process with consolidated batch updates
    • Improved database commit strategy to reduce individual write operations

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 30, 2025

Walkthrough

The pull request modifies the bootstrap/bootstrap.go file to improve database operation efficiency by introducing a new batch handling mechanism. The changes centralize batch creation and commit logic in the setupStorage function, replacing previous scattered batch handling with a more streamlined approach. The update ensures that database updates are committed more consistently and efficiently, with proper error handling for batch closure.

Changes

File Change Summary
bootstrap/bootstrap.go - Introduced store.NewBatch() for managing database operations
- Added deferred batch closure with fatal error logging
- Updated blocks.SetLatestCadenceHeight to use batch argument
- Removed redundant batch creation logic
- Added conditional batch commit based on update count

Possibly related PRs

Suggested labels

Bugfix, Improvement, Chore

Suggested reviewers

  • sideninja
  • zhangchiqing

Poem

🐰 Batch by batch, we optimize the store,
Coding rabbits hop through database lore!
Efficiency springs with each clever line,
Commits now dance in a rhythm divine!
Database magic, no errors in sight! 🚀

✨ 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
Copy Markdown
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: 0

🔭 Outside diff range comments (1)
bootstrap/bootstrap.go (1)

Storage account owner verification needs implementation as per architectural pattern

The verification is indeed missing and should be implemented. This is confirmed by:

  • A comment in storage/pebble/register_storage.go indicating that owner checks are a caller responsibility
  • No existing implementation of storage account owner verification was found in the codebase
🔗 Analysis chain

Line range hint 619-621: Consider implementing the storage account owner verification.

The TODO comment indicates a missing security check for verifying the storage account owner. This verification is important for ensuring the integrity of the storage system.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any existing storage account owner verification logic
rg -A 5 "verify.*storage.*account.*owner"

# Search for storage account related security measures
ast-grep --pattern 'func $_(storage $_, account $_) {
  $$$
  verify$_($_, $_)
  $$$
}'

Length of output: 417


Script:

#!/bin/bash
# Search for storage account security patterns
rg -i "storage.+account.+(check|validate|verify|auth)" -A 5

# Search for ownership validation patterns
rg -i "(owner|ownership).+(check|validate|verify)" -A 5

# Look for storage account related functions
ast-grep --pattern 'func $_($_) {
  $$$
  storage$_account$_
  $$$
}'

Length of output: 1333

🧹 Nitpick comments (1)
bootstrap/bootstrap.go (1)

624-629: Improve error message specificity.

While the batch commit logic is correct, the error message could be more informative by including the number of updates that failed to commit.

-			return nil, nil, fmt.Errorf("could not commit setup updates: %w", err)
+			return nil, nil, fmt.Errorf("could not commit %d setup updates: %w", batch.Count(), err)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8326189 and eca1570.

📒 Files selected for processing (1)
  • bootstrap/bootstrap.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Lint
  • GitHub Check: Test
🔇 Additional comments (2)
bootstrap/bootstrap.go (2)

560-567: LGTM! Well-structured batch handling.

The batch creation and cleanup logic is well-implemented with proper resource management using defer. Fatal error logging on batch close failure is appropriate for the setup phase.


572-572: LGTM! Fixed panic by providing batch parameter.

This change directly addresses the PR objective by providing the required batch parameter to SetLatestCadenceHeight, preventing the panic condition.

Copy link
Copy Markdown
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

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

LGTM!

@peterargue peterargue merged commit b23dc80 into main Jan 30, 2025
@peterargue peterargue deleted the petera/fix-force-start-height branch January 30, 2025 17:57
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.

3 participants