Skip to content

[FrameworkBundle] Lower JsonSerializableNormalizer priority #46668

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
Merged
merged 1 commit into from
Jun 19, 2022
Merged

[FrameworkBundle] Lower JsonSerializableNormalizer priority #46668

merged 1 commit into from
Jun 19, 2022

Conversation

aprat84
Copy link
Contributor

@aprat84 aprat84 commented Jun 14, 2022 •
edited
Loading

Q A
Branch? 4.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets
License MIT
Doc PR

IMHO, more generic normalizers, like ObjectNormalizer or JsonSerializableNormalizer should have lower priority than other more specific normalizers, like DateTimeNormalizer, ConstraintViolationListNormalizer, etc.

My issue was with Carbon library, which extends php's DateTime.
Carbon classes implement JsonSerializable interface, so they are serialized with JsonSerializableNormalizer, using its internal toJSON() method, so I can't control which format I want them to be serialized.
I should be able to do it, as I can with DateTime, cause both implement DateTimeInterface.

That's because JsonSerializableNormalizer has higher priority than DateTimeNormalizer.

For now, my "fix" was to change priority in config like so:

serializer.normalizer.json_serializable:
        class: Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer
        tags:
            - {name: 'serializer.normalizer', priority: -950 }

@carsonbot carsonbot added this to the 4.4 milestone Jun 14, 2022
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.2 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@aprat84 aprat84 force-pushed the json-normalizer-priority branch from a4659b6 to 3fcfc20 Compare June 14, 2022 12:26
@nicolas-grekas nicolas-grekas requested a review from dunglas June 19, 2022 11:50
@nicolas-grekas
Copy link
Member

Thank you @aprat84.

@nicolas-grekas nicolas-grekas merged commit aac6436 into symfony:4.4 Jun 19, 2022
This was referenced Jun 26, 2022
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dunglas dunglas dunglas approved these changes

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

Assignees
No one assigned
Labels
Bug FrameworkBundle Status: Reviewed
Projects
None yet
Milestone
4.4
Development

Successfully merging this pull request may close these issues.
4 participants
@aprat84 @carsonbot @nicolas-grekas @dunglas