This PR fixes a type incompatibility in Hyperf\Nats\EncodedConnection when an encoder decodes a message body into a non-string value.
Currently, EncodedConnection::subscribe() and queueSubscribe() pass the decoded value directly into Message::setBody(). This works only when the decoded payload is a string. For JSON objects, arrays, YAML structures, serialized arrays, or other non-string decoded values, this causes a TypeError, because Message::setBody() expects a string.
This PR keeps the existing Message::getBody(): string and Message::setBody(string $body) API unchanged for backward compatibility, and introduces a separate decoded payload API:
$message->getBody(); // raw/backward-compatible string body$message->getPayload(); // decoded payload$message->hasPayload(); // whether decoded payload was set
For backward compatibility, when the decoded payload is a string, the message body is still updated with that string. When the decoded payload is not a string, the original body remains unchanged and the decoded value is available through getPayload().
This avoids changing the public body type to mixed, while fixing decoded array/object payloads.
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
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.
What does this PR do?
This PR fixes a type incompatibility in Hyperf\Nats\EncodedConnection when an encoder decodes a message body into a non-string value.
Currently, EncodedConnection::subscribe() and queueSubscribe() pass the decoded value directly into Message::setBody(). This works only when the decoded payload is a string. For JSON objects, arrays, YAML structures, serialized arrays, or other non-string decoded values, this causes a TypeError, because Message::setBody() expects a string.
This PR keeps the existing Message::getBody(): string and Message::setBody(string $body) API unchanged for backward compatibility, and introduces a separate decoded payload API:
For backward compatibility, when the decoded payload is a string, the message body is still updated with that string. When the decoded payload is not a string, the original body remains unchanged and the decoded value is available through getPayload().
This avoids changing the public body type to mixed, while fixing decoded array/object payloads.
Fixes #5222.