KTOR-8455: Introduces the ability to preserve context with HttpClient.

[siddartha-ravichandran-og]

Subsystem HTTP client and config

Motivation Today, when using ktor's HTTP client, there is no provision to preserve CoroutineContext. Following the completion of the actual HTTP call made in an async block, any context that we might want to preserve is lost. For instance, MDC context, which is vital to logging in applications, cannot be preserved after the HTTPClient completes.

Solution The solution provides the ability to supply a coroutine context provider lambda when configuring the HTTPClient, via its configuration. This will be executed per request executed by the HTTP client, which would then inject the supplied CoroutineContext during the async call.

[coderabbitai[bot]]

Walkthrough

This change introduces an optional extension point for customizing the coroutine context used during HTTP request execution in the Ktor client engine. A new nullable property, contextProvider, is added to the HttpClientEngineConfig class, allowing users to supply a function that returns an additional coroutine context. The request execution logic in HttpClientEngine is updated to incorporate this context if provided, otherwise defaulting to the original context composition. No changes are made to public API signatures except for the addition of the new property.

Changes

Files	Change Summary
ktor-client/ktor-client-core/common/src/io/ktor/client/engine/HttpClientEngineConfig.kt	Added a nullable contextProvider property to HttpClientEngineConfig for supplying additional coroutine context.
ktor-client/ktor-client-core/common/src/io/ktor/client/engine/HttpClientEngine.kt	Updated coroutine context construction in request execution to use contextProvider if set in the config.

✨ 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

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

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.

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.

[jetbrains-junie[bot]]

❌ Junie can be launched only by a repository collaborator

[adrianliz]

I am experiencing the same issue, it has been resolved? @bjhham