chore(launcher): use MigratorTrait explicitly in test database initialization macros

[rimrakhimov]

Use struct implementing MigratorTrait as a parameter into test database initialization macros instead of getting the crate itself. Makes it more flexible to use

Summary by CodeRabbit

• Documentation
  • Updated comments to clarify the usage of macros related to database migration.
• Chores
  • Renamed parameters in macros for improved clarity and consistency.

[coderabbitai]

Walkthrough

The pull request introduces changes to the TestDbGuard struct and its related methods within the test_database.rs file located in the libs/blockscout-service-launcher directory. The primary modification involves renaming a parameter in the database! and database_name! macros from migration_crate to Migrator. This adjustment clarifies that the expected type is a struct that implements the MigratorTrait. The changes are reflected in the macro definitions and their corresponding usage examples, ensuring consistency with the new parameter name. Additionally, the documentation comments have been updated to provide clearer guidance regarding the usage of these macros. Importantly, the overall structure and logic of the TestDbGuard class remain unchanged, with no modifications made to its core functionality or error handling mechanisms.

Poem

🐰 In the land of code where rabbits play,
A change was made, hip-hip-hooray!
The migrator hops with grace anew,
Guiding our tests with a clearer view.
With macros bright, we leap and bound,
In the garden of code, joy is found! 🌼

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 76a11fc and f356905.

📒 Files selected for processing (1)

• libs/blockscout-service-launcher/src/test_database.rs (2 hunks)

🔇 Additional comments (2)

libs/blockscout-service-launcher/src/test_database.rs (2)

190-196: LGTM! Documentation updates are clear and accurate.

The documentation changes effectively communicate the expected type and usage of the Migrator parameter, with consistent examples.

Also applies to: 207-207

---

213-214: LGTM! Type parameter change improves type safety.

The change from $migration_crate:ident to $migrator:ty is a good improvement as it:

1. Makes the expected type more explicit
2. Provides better type checking at compile time
3. Aligns with the goal of explicit MigratorTrait usage

Let's verify the macro usage across the codebase to ensure all callers have been updated:

Also applies to: 219-222

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.