ktor icon indicating copy to clipboard operation
ktor copied to clipboard
verified publisher icon ktorio

KTOR-8450: add content negotiation suffix support

Open anton-erofeev opened this issue 6 months ago • 3 comments

Subsystem Client, ktor.client.plugins.contentnegotiation

Motivation https://youtrack.jetbrains.com/issue/KTOR-8450

Solution added content negotiation suffix support

anton-erofeev avatar Jun 29 '25 21:06 anton-erofeev

Walkthrough

The changes introduce enhanced handling for content types with suffixes in the content negotiation plugin, referencing RFC 6839. The matching logic was updated to support types like application/problem+json when a converter is registered for application/json. A new test verifies this behavior by ensuring correct deserialization for such suffixed content types.

Changes

Files/Paths Change Summary
.../ktor-client-content-negotiation/common/src/io/ktor/client/plugins/contentnegotiation/ContentNegotiation.kt Enhanced content type matching logic to support suffixes per RFC 6839; added a set of supported suffix types; simplified register.
.../ktor-client-content-negotiation-tests/jvm/src/io/ktor/client/plugins/contentnegotiation/tests/JsonContentNegotiationTest.kt Added a test verifying content negotiation with suffixed content types using a custom converter.

Suggested reviewers

  • bjhham
📜 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 f1dd7684e8490c501c35ea32f70a2d0204b93ef7 and 1daa4ead0c0aebca82ef9bba8e9efa3d863b0ce7.

📒 Files selected for processing (2)
  • ktor-client/ktor-client-plugins/ktor-client-content-negotiation/common/src/io/ktor/client/plugins/contentnegotiation/ContentNegotiation.kt (3 hunks)
  • ktor-client/ktor-client-plugins/ktor-client-content-negotiation/ktor-client-content-negotiation-tests/jvm/src/io/ktor/client/plugins/contentnegotiation/tests/JsonContentNegotiationTest.kt (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.kt`: Include copyright header in new files. Use star imports for io.ktor.* packages (configured in .editorconfig). Max line length: 120 characters. Indent with 4 spaces.

**/*.kt: Include copyright header in new files. Use star imports for io.ktor.* packages (configured in .editorconfig). Max line length: 120 characters. Indent with 4 spaces.

📄 Source: CodeRabbit Inference Engine (CLAUDE.md)

List of files the instruction was applied to:

  • ktor-client/ktor-client-plugins/ktor-client-content-negotiation/ktor-client-content-negotiation-tests/jvm/src/io/ktor/client/plugins/contentnegotiation/tests/JsonContentNegotiationTest.kt
  • ktor-client/ktor-client-plugins/ktor-client-content-negotiation/common/src/io/ktor/client/plugins/contentnegotiation/ContentNegotiation.kt
🧠 Learnings (3)
📓 Common learnings 
Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:56.883Z
Learning: Prefix commit messages with KTOR-{NUM} (YouTrack issue), and write them in present tense, imperative mood.

Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:58.430Z
Learning: Prefix commit messages with KTOR-{NUM} (YouTrack issue), and write them in present tense, imperative mood.
ktor-client/ktor-client-plugins/ktor-client-content-negotiation/ktor-client-content-negotiation-tests/jvm/src/io/ktor/client/plugins/contentnegotiation/tests/JsonContentNegotiationTest.kt (10) 
Learnt from: rururux
PR: ktorio/ktor#4896
File: ktor-client/ktor-client-core/jvm/test/FileStorageTest.kt:1-12
Timestamp: 2025-05-30T06:45:52.309Z
Learning: In Ktor test files, particularly in the ktor-client/ktor-client-core/jvm/test/ directory, test files follow the convention of not including explicit package declarations. This is consistent across test files like CachingCacheStorageTest.kt and should be maintained for consistency.

Learnt from: rururux
PR: ktorio/ktor#4896
File: ktor-client/ktor-client-core/jvm/test/FileStorageTest.kt:1-12
Timestamp: 2025-05-30T06:45:52.309Z
Learning: In Ktor test files, particularly in the ktor-client/ktor-client-core/jvm/test/ directory, test files follow the convention of not including explicit package declarations. This is consistent across test files like CachingCacheStorageTest.kt and should be maintained for consistency.

Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:56.883Z
Learning: Error handling should follow Kotlin conventions and use specific Ktor exceptions.

Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:58.430Z
Learning: Error handling should follow Kotlin conventions and use specific Ktor exceptions for consistency and clarity.

Learnt from: tre3p
PR: ktorio/ktor#4936
File: ktor-utils/jvm/src/io/ktor/util/ZstdEncoding.kt:28-35
Timestamp: 2025-06-16T17:03:45.729Z
Learning: In the Ktor codebase, encoder implementations consistently use GlobalScope.writer and GlobalScope.reader patterns for compression/decompression operations. This is the established architectural pattern used throughout the codebase for byte channel transformations.

Learnt from: rururux
PR: ktorio/ktor#4896
File: ktor-client/ktor-client-core/jvm/test/FileStorageTest.kt:1-12
Timestamp: 2025-05-30T06:45:52.309Z
Learning: The headersOf() function from io.ktor.http package is available through wildcard imports like `import io.ktor.http.*`, so no explicit import statement is needed when using wildcard imports from that package.

Learnt from: rururux
PR: ktorio/ktor#4896
File: ktor-client/ktor-client-core/jvm/test/FileStorageTest.kt:1-12
Timestamp: 2025-05-30T06:45:52.309Z
Learning: The headersOf() function from io.ktor.http package is available through wildcard imports like `import io.ktor.http.*`, so no explicit import statement is needed when using wildcard imports from that package.

Learnt from: osipxd
PR: ktorio/ktor#4767
File: build-settings-logic/src/main/kotlin/ktorsettings.kotlin-user-project.settings.gradle.kts:136-146
Timestamp: 2025-04-23T11:48:32.634Z
Learning: For Kotlin Train builds in the Ktor project, the properties `atomicfu_version`, `coroutines_version`, and `serialization_version` are expected to be defined in the TeamCity CI environment, so using `.get()` without custom error handling is sufficient.

Learnt from: osipxd
PR: ktorio/ktor#4836
File: ktor-utils/build.gradle.kts:35-35
Timestamp: 2025-05-07T09:12:14.293Z
Learning: The Ktor project maintains a flat Gradle project structure (where projects are referenced without nested paths like `:ktor-test-base`) while keeping a hierarchical directory organization on disk.

Learnt from: bjhham
PR: ktorio/ktor#4849
File: ktor-server/ktor-server-plugins/ktor-server-di/common/src/io/ktor/server/plugins/di/DependencyProvider.kt:208-208
Timestamp: 2025-05-13T05:42:18.679Z
Learning: In Ktor's DI system, empty RuntimeException objects are used to obtain stack trace information in multiplatform code since thread stack traces are only available in Kotlin JVM. The exceptions are never thrown, only used to capture registration locations via the externalTraceLine() utility.
ktor-client/ktor-client-plugins/ktor-client-content-negotiation/common/src/io/ktor/client/plugins/contentnegotiation/ContentNegotiation.kt (6) 
Learnt from: bjhham
PR: ktorio/ktor#4855
File: ktor-server/ktor-server-plugins/ktor-server-di/api/ktor-server-di.klib.api:334-336
Timestamp: 2025-05-14T18:05:02.321Z
Learning: Breaking changes in constructor parameter order are acceptable for the ktor-server-di module when the code hasn't been released yet, as confirmed by the development team.

Learnt from: osipxd
PR: ktorio/ktor#4860
File: ktor-server/ktor-server-plugins/ktor-server-di/api/ktor-server-di.api:24-26
Timestamp: 2025-05-16T13:11:28.416Z
Learning: Binary incompatible changes (such as constructor signature changes) are acceptable in the ktor-server-di module when the version is not yet released, as confirmed by the development team.

Learnt from: osipxd
PR: ktorio/ktor#4875
File: ktor-version-catalog/build.gradle.kts:52-79
Timestamp: 2025-05-21T11:36:39.111Z
Learning: In the Ktor project's version catalog, library alias naming has different patterns: some aliases should maintain hierarchical structure (e.g., "server-metrics-micrometer" should preserve the "server-metrics-" prefix since "server-metrics" exists as a separate module), while others should convert hyphens to camelCase (e.g., "server-caching-headers" → "server-cachingHeaders").

Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:58.430Z
Learning: Error handling should follow Kotlin conventions and use specific Ktor exceptions for consistency and clarity.

Learnt from: CR
PR: ktorio/ktor#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-23T12:49:56.883Z
Learning: Error handling should follow Kotlin conventions and use specific Ktor exceptions.

Learnt from: tre3p
PR: ktorio/ktor#4936
File: ktor-utils/jvm/src/io/ktor/util/ZstdEncoding.kt:28-35
Timestamp: 2025-06-16T17:03:45.729Z
Learning: In the Ktor codebase, encoder implementations consistently use GlobalScope.writer and GlobalScope.reader patterns for compression/decompression operations. This is the established architectural pattern used throughout the codebase for byte channel transformations.
🔇 Additional comments (5)
ktor-client/ktor-client-plugins/ktor-client-content-negotiation/common/src/io/ktor/client/plugins/contentnegotiation/ContentNegotiation.kt (3)

21-22: LGTM: RFC 6839 suffix types correctly implemented.

The supported suffix types align with RFC 6839 standards and include the commonly used suffixes for structured data formats.

78-78: Good simplification: Consistent use of defaultMatcher.

Removing the special case handling and always using defaultMatcher makes the code more consistent and leverages the enhanced matching logic.

151-162: Excellent implementation of suffix-based content type matching.

The enhanced defaultMatcher correctly implements RFC 6839 suffix matching:

  • Maintains backward compatibility with exact matching
  • Properly handles suffixed content types like application/problem+json
  • Uses case-insensitive comparison for the suffix part
  • Validates that the suffix subtype is in the supported types set

This allows converters registered for base types (e.g., application/json) to handle their suffixed variants automatically.

ktor-client/ktor-client-plugins/ktor-client-content-negotiation/ktor-client-content-negotiation-tests/jvm/src/io/ktor/client/plugins/contentnegotiation/tests/JsonContentNegotiationTest.kt (2)

18-22: Appropriate imports for the new test functionality.

The additional imports are necessary for the new test implementation and follow the existing import patterns in the file.

329-364: Comprehensive test for suffix-based content negotiation.

The test effectively validates the RFC 6839 suffix matching implementation:

  • Tests application/problem+json content type with converter registered for application/json
  • Uses a custom ContentConverter to verify both serialization and deserialization paths
  • Properly asserts that the converter handles the suffixed content type correctly
  • Follows established test patterns in the file

This test provides good coverage for the new suffix matching functionality.

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

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[bot] avatar Jun 29 '25 21:06 coderabbitai[bot]

Hi @anton-erofeev, Are you planning to continue working on this PR or would you be okay if I picked it up? Thanks for your contribution to the project!

osipxd avatar Oct 23 '25 09:10 osipxd

Hey @osipxd, sure, please feel free to pick it up

anton-erofeev avatar Oct 23 '25 09:10 anton-erofeev