[Serializer] Fixed BackedEnumNormalizer priority for translatable enum #54315
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
fc827ce to
b7fccc1
Compare
b7fccc1 to
56118df
Compare
chalasr
reviewed
Mar 17, 2024
welcoMattic
approved these changes
Mar 21, 2024
stof
approved these changes
Mar 21, 2024
derrabus
reviewed
Mar 21, 2024
src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SerializerTest.php
Outdated
Show resolved
Hide resolved
derrabus
approved these changes
Mar 23, 2024
chalasr
approved these changes
Mar 23, 2024
b2ae966 to
42fde94
Compare
|
Good catch, thanks @IndraGunawan. |
|
What if someone relies on the current order? Do we consider this an unsupported use case? |
|
Good question. I would say yes as there are similar precedents changing e.g. compiler passes order or event listeners priority as part of a bugfix. It's probably worth being decided on a case-by-case basis and mentioned in the BC promise. |
|
This change breaks the way ApiPlatform exposes BackEnum as ApiResource |
|
As a BC break workaround, the easiest and maintainable way I found is to create a custom normalizer. For example, the project I'm working on needed the translated enumerations on serialization: use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Contracts\Translation\TranslatableInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
final readonly class AcmeNormalizer implements NormalizerInterface
{
public function __construct(private TranslatorInterface $translator)
{
}
/**
* @param TranslatableInterface $object
*/
public function normalize($object, ?string $format = null, array $context = []): string
{
return $object->trans($this->translator);
}
public function supportsNormalization($data, ?string $format = null, array $context = []): bool
{
return $data instanceof TranslatableInterface;
}
public function getSupportedTypes(?string $format): array
{
return [
TranslatableInterface::class => true,
];
}
}I don't know if this is the best way to do it or not but it seems to me to be quite maintainable. |
|
Implementation changed in #54484 |
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.
serialize a BackedEnum that implements
TranslatableInterfacewill return the translation value instead of the enum item value. this is becauseTranslatableNormalizer(ref) has higher priority thanBackedEnumNormalizerthis PR changes the
BackedEnumNormalizerpriority higher thanTranslatableNormalizerpriority