feat: add ContentType attribute for default message content type#679
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why is this change proposed?
Resolves #658. When a consumed message carries no
contentTypeheader — common when messages are produced by non-Ecotone systems (e.g. Kafka records published by other teams' services) — Ecotone assumesapplication/x-phpand skips deserialization, failing withLack of Media Type Converter for application/x-php:string to <TargetClass>. There was no declarative way to state "messages arriving at this endpoint are JSON unless stated otherwise"; the only workaround was#[AddHeader('contentType', ...)], which unconditionally overrides and is easy to forget.Description of Changes
#[ContentType]endpoint attribute (extendsAddHeader, same family as#[Delayed],#[TimeToLive]) that sets thecontentTypemessage header before the endpoint processes the message.replaceIfExists: truemakes it override the incoming one.EndpointHeadersInterceptor; works transport-agnostically for any endpoint (Kafka consumers, asynchronous command/event handlers, etc.).Usage
Use cases
contentTypeheader. Declaring#[ContentType('application/json')]on the consumer makes deserialization work without touching producers.replaceIfExists: trueenforces the known-correct format.Flow
flowchart LR A[Message arrives at endpoint] --> B{contentType header present?} B -- no --> C[Set header from ContentType attribute] B -- yes --> D{replaceIfExists?} D -- true --> C D -- false --> E[Keep incoming header] C --> F[PayloadConverter deserializes to handler parameter type] E --> FPull Request Contribution Terms