Skip to content

fix: prevent fallback to legacy store when migrating #955

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

Merged
merged 1 commit into from
Jun 2, 2025

Conversation

gfyrag
Copy link
Contributor

@gfyrag gfyrag commented Jun 2, 2025

No description provided.

@gfyrag gfyrag requested a review from a team as a code owner June 2, 2025 16:06
Copy link

coderabbitai bot commented Jun 2, 2025

Walkthrough

The OpenLedger method in DefaultStorageDriverAdapter was updated to use the GetLastVersion method instead of IsUpToDate when checking the state of the bucket. The logic now determines if the last version is at least 26 before proceeding, modifying how the boolean flag is set for further processing.

Changes

File(s) Change Summary
internal/storage/driver/adapters.go Replaced IsUpToDate check with GetLastVersion in OpenLedger; updated logic for boolean flag.

Poem

In the warren of code, a new path we tread,
Swapping out checks for a version instead.
No more "up to date?"—now we ask "what's the score?"
If version's high enough, we open the door.
A hop, a leap, a change so neat—
This rabbit finds the update sweet! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

if err != nil {
return nil, nil, fmt.Errorf("checking if bucket is up to date: %w", err)
}

return ledgerstore.NewDefaultStoreAdapter(isUpToDate, store), l, nil
return ledgerstore.NewDefaultStoreAdapter(lastVersion >= 26, store), l, nil
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Magical number, corresponding to the migration 25.
The migration 25 was introduced in v2.2.0 of the ledger.
So checking for this version is enough to declare the database is up to date to use the new store.

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

🧹 Nitpick comments (2)
internal/storage/driver/adapters.go (2)

23-26: Update error message to reflect the actual operation.

The logic change from IsUpToDate to GetLastVersion is correct and aligns with the PR objective. However, the error message on line 25 still refers to "checking if bucket is up to date" when we're now getting the last version.

Apply this diff to update the error message:

-		return nil, nil, fmt.Errorf("checking if bucket is up to date: %w", err)
+		return nil, nil, fmt.Errorf("getting bucket last version: %w", err)

28-28: Consider extracting the version threshold as a named constant.

The logic lastVersion >= 26 correctly determines when the store is up-to-date enough to avoid legacy fallback, which aligns with the PR objective. However, the magic number 26 should be extracted as a named constant for better maintainability.

Consider adding a constant at the package level:

+const MinStoreVersionForNewAdapter = 26
+
 func (d *DefaultStorageDriverAdapter) OpenLedger(ctx context.Context, name string) (ledgercontroller.Store, *ledger.Ledger, error) {

Then update the comparison:

-	return ledgerstore.NewDefaultStoreAdapter(lastVersion >= 26, store), l, nil
+	return ledgerstore.NewDefaultStoreAdapter(lastVersion >= MinStoreVersionForNewAdapter, store), l, nil
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 285f189 and 20e5e6b.

📒 Files selected for processing (1)
  • internal/storage/driver/adapters.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
internal/storage/driver/adapters.go (1)
internal/storage/ledger/legacy/adapters.go (1)
  • NewDefaultStoreAdapter (345-351)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Tests
  • GitHub Check: Dirty

@gfyrag gfyrag merged commit 6fc3941 into release/v2.2 Jun 2, 2025
8 checks passed
@gfyrag gfyrag deleted the hotfix/v2.2/prevent-fallback-to-legacy-store branch June 2, 2025 16:11
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