Skip to content

[Serializer] Improve NotNormalizableValueException exception messages in BackedEnumNormalizer #62574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
mdeboer wants to merge 2 commits into
base: 8.1
Choose a base branch
from
Open

[Serializer] Improve NotNormalizableValueException exception messages in BackedEnumNormalizer #62574

mdeboer wants to merge 2 commits into from
+81 −34

Conversation

@mdeboer
Copy link
Contributor

@mdeboer mdeboer commented Nov 29, 2025 •
edited
Loading

Q A
Branch? 8.1
Bug fix? no
New feature? yes
Deprecations? no
Issues
License MIT

This PR stems from a discussion I had with @xabbuh following the discussion at #54226 and specifically the comment from @nesl247.

With this PR I would like to propose some changes in the BackedEnumNormalizer that give the exception messages a bit more meaning in terms of what data is actually expected.

Example

Before

enum StringBackedEnumDummy: string
{
    case GET = 'GET';
    case OPTIONS = 'OPTIONS';
}

$this->normalizer->denormalize('POST', StringBackedEnumDummy::class);

// Throws NotNormalizableValueException with message:
//   The data must belong to a backed enumeration of type StringBackedEnumDummy

After

enum StringBackedEnumDummy: string
{
    case GET = 'GET';
    case OPTIONS = 'OPTIONS';
}

$this->normalizer->denormalize('POST', StringBackedEnumDummy::class);

// Throws NotNormalizableValueException with message:
//   The data must be one of the following values: 'GET', 'OPTIONS'

@mdeboer
[Serializer] Improve exception messages for backed enum values
9cc8b9f 
Improves the message when throwing the NotNormalizableValueException in the BackedEnumNormalizer. It gives better feedback what value type is expected (matching the backed type of the enum) and if the type is correct, what values are expected.
@mdeboer mdeboer marked this pull request as ready for review November 29, 2025 13:45
@mdeboer mdeboer requested a review from dunglas as a code owner November 29, 2025 13:45
@carsonbot carsonbot added this to the 8.1 milestone Nov 29, 2025
fabpot
fabpot approved these changes Nov 29, 2025
View reviewed changes
Copy link
Member

@fabpot fabpot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense to me.

@OskarStark OskarStark changed the title [Serializer] Improve NotNormalizableValueException exception messages in BackedEnumNormalizer [Serializer] Improve NotNormalizableValueException exception messages in BackedEnumNormalizer Nov 29, 2025
@symfony symfony deleted a comment from carsonbot Dec 1, 2025
alexandre-daubois
alexandre-daubois approved these changes Dec 5, 2025
View reviewed changes
@mdeboer @alexandre-daubois
Fix changelog format
d1f9a3d 
Co-authored-by: Alexandre Daubois <2144837+alexandre-daubois@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fabpot fabpot fabpot approved these changes

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@alexandre-daubois alexandre-daubois alexandre-daubois approved these changes

@dunglas dunglas Awaiting requested review from dunglas dunglas is a code owner

Assignees

No one assigned

Labels

Feature Serializer Status: Reviewed

Projects

None yet

Milestone

8.1

Development

Successfully merging this pull request may close these issues.

5 participants

@mdeboer @fabpot @nicolas-grekas @alexandre-daubois @carsonbot