[Bug]: Enums with Translatable interface are broken

[p-golovin]

Version

5.3.0

Description

Broken in #2472

In 5.2.1:

...
          "currentTab": {
            "$ref": "#/components/schemas/EventTab"
          }
...
      "EventTab": {
        "type": "string",
        "enum": [
          "preview",
          "lineups",
          "summary"
        ]
      },

In 5.3.0:

          "currentTab": {
            "type": "string"
          }

Enum looks like this:

enum EventTab: string implements TranslatableInterface
{
    case preview = 'preview';
    case lineups = 'lineups';
    case summary = 'summary';

    public function trans(TranslatorInterface $translator, ?string $locale = null): string
    {
        return match ($this) {
            self::preview => $translator->trans(self::preview->value, domain: 'App.Statistics', locale: $locale),
            self::lineups => $translator->trans(self::lineups->value, domain: 'App.Statistics', locale: $locale),
            self::summary => $translator->trans(self::summary->value, domain: 'App.Statistics', locale: $locale),
        };
    }
}

[p-golovin]

Kindly ping @jsor

[jsor]

Interesting case. I made my MR under the naive assumption that payloads are serialized with Symonfy's Serializer component (e.g. with API Platform) which would result in having the translated string in the payload. This assumption is of course not true in the context of this bundle.

I put some thoughts in it but really can't think of a good solution other than removing automatic support for the TranslatableInterface. 🤷

[p-golovin]

Is there a way to enable/disable describers via config?

[RobertMe]

Interesting case. I made my MR under the naive assumption that payloads are serialized with Symonfy's Serializer component (e.g. with API Platform) which would result in having the translated string in the payload. This assumption is of course not true in the context of this bundle.

The assumption is true? But Symfony has a normalizer for BackedEnum and a normalizer for Translatable. And the normalizer for BackedEnum has a higher priority (-915) than the normalizer for Translatable (-920). So Symfony prefers to normalize based on BackedEnum, instead of Translatable.

I put some thoughts in it but really can't think of a good solution other than removing automatic support for the TranslatableInterface. 🤷

I think the solution would be to change the priority of the model describers, so that the EnumModelDescriber takes precedence over the (those?) for Translatable, just as Symfony prefers BackedEnumNormalizer over TranslatableNormalizer.

[RobertMe]

Is there a way to enable/disable describers via config?

Not to my knowledge. What you can do however is remove it using a compiler pass:

$container->removeDefinition('nelmio_api_doc.object_model.property_describers.translatable');

This seems to work, but you'll most likely want it only as a temporary work-a-round. But there also is some added code in ClassDescriber which might or might not still have some impact.

[github-actions]

This issue has been marked as stale because it has not had any activity for 60 days. Remove stale label or comment to prevent this from being closed in 60 days.