feat(api-client-framework)!: configuration and endpoint updates

[rimrakhimov]

1. Remove CustomError from Error enum
2. Re-export reqwest related crates to be available to framework users
3. Update config to have middlewares being explicitly specified, instead of having just max_retries variable
4. Add method to setup headers to Endpoint trait

Summary by CodeRabbit

• New Features

  • Added optional header configuration for API endpoints
  • Introduced middleware support for HTTP client configuration

• Refactor

  • Removed retry middleware from HTTP client
  • Simplified error handling in API client framework
  • Updated public exports for easier library usage

• Chores

  • Removed reqwest-retry dependency from project configuration

[coderabbitai]

Walkthrough

The pull request introduces modifications to the API client framework in Rust. The changes primarily focus on refactoring the HTTP client configuration and endpoint handling. The Cargo.toml file sees the removal of the reqwest-retry dependency. In the async_client.rs, the HttpApiClientConfig structure is updated to replace max_retries with a middlewares vector, allowing more flexible middleware processing. The endpoint.rs adds a new headers method to the Endpoint trait, enabling optional header specification for API calls. The lib.rs file now publicly exports additional dependencies and simplifies the error handling structure by removing the CustomError variant.

Poem

🐰 Hop, hop, through the code we go,
Middlewares dance, no retries to show.
Headers optional, errors refined,
A framework leaner, cleverly designed.
CodeRabbit's magic, in Rust we trust! 🚀

---

📜 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 3e8098c and d0623d9.

📒 Files selected for processing (1)

• libs/api-client-framework/src/lib.rs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• libs/api-client-framework/src/lib.rs

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

libs/api-client-framework/src/lib.rs (1)

9-11: Heads up on re-exported crates
Re-exporting reqwest, reqwest_middleware, and url directly from this library may lead to version conflicts in downstream consumers if they already depend on different versions of these crates. Consider exposing only the necessary types or functions to mitigate potential collisions while preserving modularity.

libs/api-client-framework/src/endpoint.rs (1)

26-32: Consider providing additional guidance for setting custom headers.
The new headers() method provides a clean way to specify optional request headers. If certain headers must always be present (for example, authentication tokens or correlation IDs), consider documenting or enforcing this in your implementing types. Otherwise, this looks good and aligns well with the trait design.

libs/api-client-framework/src/async_client.rs (3)

15-16: Provide examples or references on how to implement custom middlewares.
Declaring middlewares: Vec<Arc<dyn Middleware>> is an excellent way to allow layered request processing. For clarity, adding an inline example or referencing a “How to implement custom middlewares” doc might help maintainers and contributors.

---

41-46: Order-based application of middlewares is correct.
Applying each middleware in the sequence they appear in config.middlewares is straightforward. If you rely on specific ordering, consider documenting it in the config struct docstring. Otherwise, this looks good.

---

71-74: Be mindful of overwriting any previously set headers.
Calling request.headers(...) replaces the entire header map. If you need to preserve headers added earlier (like Content-Type), consider merging them instead. Otherwise, this approach correctly applies endpoint-specific headers.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82dc056 and 3e8098c.

📒 Files selected for processing (4)

• libs/api-client-framework/Cargo.toml (0 hunks)
• libs/api-client-framework/src/async_client.rs (3 hunks)
• libs/api-client-framework/src/endpoint.rs (1 hunks)
• libs/api-client-framework/src/lib.rs (1 hunks)

💤 Files with no reviewable changes (1)

• libs/api-client-framework/Cargo.toml

🔇 Additional comments (2)

libs/api-client-framework/src/async_client.rs (2)

4-6: No issues found with the new imports.
This import of ClientBuilder and Middleware is consistent with the updated approach that removes explicit retry logic.

---

24-24: Empty default is reasonable.
Initializing middlewares as an empty vector aligns with the typical usage pattern.