Skip to content

[Serializer] Unexpected value should throw UnexpectedValueException #49537

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.

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

Merged
merged 1 commit into from
Apr 17, 2023

Conversation

ThomasTr
Copy link
Contributor

Q A
Branch? 5.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets See my recently started discussion here: #49535
License MIT
Doc PR NA

If a DateTime field to be serialised has a data type other than string (e.g. a serialised DateTime as array), a TypeException is thrown. This exception cannot be caught by a try/catch around the serializer.

This fix throws a NotNormalizableValueException that appears cleanly at the corresponding field.

This is my first pull request, please be kind to me :)

@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.3 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

@ThomasTr ThomasTr force-pushed the discussion_49535 branch 3 times, most recently from 57d73d0 to 3f2b947 Compare February 26, 2023 16:29
@carsonbot
Copy link

Hey!

I think @Seldaek has recently worked with this code. Maybe they can help review this?

Cheers!

Carsonbot

@ThomasTr ThomasTr force-pushed the discussion_49535 branch 2 times, most recently from a37127f to 20c1a08 Compare March 31, 2023 10:06
@ThomasTr ThomasTr requested a review from nicolas-grekas March 31, 2023 10:12
@@ -91,8 +91,8 @@ public function denormalize($data, string $type, string $format = null, array $c
$dateTimeFormat = $context[self::FORMAT_KEY] ?? null;
$timezone = $this->getTimezone($context);

if (null === $data || (\is_string($data) && '' === trim($data))) {
throw NotNormalizableValueException::createForUnexpectedDataType('The data is either an empty string or null, you should pass a string that can be parsed with the passed format or a valid DateTime string.', $data, [Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
if (null === $data || !\is_string($data) || '' === trim($data)) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have additionally adapted this if construct, since $data must always be a string.

@nicolas-grekas
Copy link
Member

Thank you @ThomasTr.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants