feat(blockscout-service-launcher): add base_path of api
add base_path: Option<String> to settings that allows paths to start with custom string like /api/v1/charts -> /stats-service/api/1/charts
Summary by CodeRabbit
-
New Features
- Introduced an optional configuration for routing customization that allows users to define a custom path prefix. This enhancement improves the flexibility of HTTP endpoint exposure and enriches server logging, offering a more tailored service experience.
-
Chores
- Upgraded the package version to 0.19.0 and updated the
tokiodependency, resulting in improved performance and overall stability of the service.
- Upgraded the package version to 0.19.0 and updated the
Walkthrough
The changes update the blockscout-service-launcher package. In the Cargo.toml file, the package version is incremented from 0.18.0 to 0.19.0, and the tokio dependency is updated from version 1 to 1.44. In the launch.rs file, a new variable base_path is cloned from the settings and passed as an additional argument to the http_serve function. The configure_router function in router.rs is modified to accept an optional base_path parameter, allowing for conditional routing based on its presence. Additionally, in settings.rs, a new optional field base_path is added to the HttpServerSettings struct, along with a new BasePath struct that implements validation through the TryFrom<String> trait.
Possibly related PRs
- blockscout/blockscout-rs#1190: This PR updates the version of the
blockscout-service-launcherdependency in another project, directly connecting to the changes made in theCargo.tomlfile of the main PR.
Poem
I'm a rabbit on a coding spree,
Hopping through changes wild and free.
Versions updated, scopes refined,
New paths emerge where routes align.
With ASCII hops and a cheerful cheer,
I nibble on bytes without any fear.
Code fields and functions—oh dear, what a year!
📜 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 54f73e10086539209f725158ce3336d08579b2be and b9a134afe852aeb048ffc3d24ca309f5823c1471.
📒 Files selected for processing (1)
libs/reqwest-rate-limiter/src/lib.rs(1 hunks)
🔇 Additional comments (1)
libs/reqwest-rate-limiter/src/lib.rs (1)
13-13: Good improvement to code safety.This change replaces unsafe code with a safe alternative. The previous implementation used
unsafe { NonZeroU32::new_unchecked(1) }which bypasses runtime checks, while the new implementation usesNonZeroU32::new(1).unwrap()which properly validates that the value is non-zero at compile time. Since this is a constant with a hardcoded value of 1, there's no performance penalty, but you gain the safety guarantees of Rust's type system.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai planto trigger planning for file edits and PR creation.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.