Skip to content

Commit 2dc11e4

Browse files
nicolas-grekasnicolas-grekas
committed
bug #62321 [Serializer] Fix BackedEnumNormalizer behavior with partial denormalization (yoeunes)
This PR was merged into the 6.4 branch. Discussion ---------- [Serializer] Fix BackedEnumNormalizer behavior with partial denormalization | Q | A |---|--- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Issues | Fixes #62313 | License | MIT This PR fixes a bug in `BackedEnumNormalizer` that occurs when using `collect_denormalization_errors` and `allow_invalid_values` at the same time. When `allow_invalid_values` was set, the normalizer would return `null` for invalid data (like `null`) *before* `NotNormalizableValueException` could be thrown. This caused the denormalization to fail with a fatal `TypeError` (e.g., `Typed property ... must not be null`) instead of populating a `PartialDenormalizationException` with the expected type errors. This fix ensures that `NotNormalizableValueException` is still thrown when `collect_denormalization_errors` is active (`not_normalizable_value_exceptions` context key is set), allowing the Serializer to catch it and report the error correctly. Commits ------- 752933f [Serializer] Fix BackedEnumNormalizer behavior with partial denormalization
2 parents 19f6580 + 752933f commit 2dc11e4

File tree

3 files changed

+83
-11
lines changed

3 files changed

+83
-11
lines changed

‎src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,30 +57,28 @@ public function denormalize(mixed $data, string $type, ?string $format = null, a
5757
throw new InvalidArgumentException('The data must belong to a backed enumeration.');
5858
}
5959

60-
if ($context[self::ALLOW_INVALID_VALUES] ?? false) {
61-
if (null === $data || (!\is_int($data) && !\is_string($data))) {
62-
return null;
63-
}
60+
$allowInvalidValues = $context[self::ALLOW_INVALID_VALUES] ?? false;
6461

65-
try {
66-
return $type::tryFrom($data);
67-
} catch (\TypeError) {
62+
if (null === $data || (!\is_int($data) && !\is_string($data))) {
63+
if ($allowInvalidValues && !isset($context['not_normalizable_value_exceptions'])) {
6864
return null;
6965
}
70-
}
7166

72-
if (!\is_int($data) && !\is_string($data)) {
7367
throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
7468
}
7569

7670
try {
7771
return $type::from($data);
78-
} catch (\ValueError $e) {
72+
} catch (\ValueError|\TypeError $e) {
7973
if (isset($context['has_constructor'])) {
8074
throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type, 0, $e);
8175
}
8276

83-
throw NotNormalizableValueException::createForUnexpectedDataType('The data must belong to a backed enumeration of type '.$type, $data, [$type], $context['deserialization_path'] ?? null, true, 0, $e);
77+
if ($allowInvalidValues && !isset($context['not_normalizable_value_exceptions'])) {
78+
return null;
79+
}
80+
81+
throw NotNormalizableValueException::createForUnexpectedDataType('The data must belong to a backed enumeration of type '.$type, $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true, 0, $e);
8482
}
8583
}
8684

‎src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,30 @@ public function testItUsesTryFromIfContextIsPassed()
126126

127127
$this->assertSame(StringBackedEnumDummy::GET, $this->normalizer->denormalize('GET', StringBackedEnumDummy::class, null, [BackedEnumNormalizer::ALLOW_INVALID_VALUES => true]));
128128
}
129+
130+
public function testDenormalizeNullWithAllowInvalidAndCollectErrorsThrows()
131+
{
132+
$this->expectException(NotNormalizableValueException::class);
133+
$this->expectExceptionMessage('The data is neither an integer nor a string');
134+
135+
$context = [
136+
BackedEnumNormalizer::ALLOW_INVALID_VALUES => true,
137+
'not_normalizable_value_exceptions' => [], // Indicate that we want to collect errors
138+
];
139+
140+
$this->normalizer->denormalize(null, StringBackedEnumDummy::class, null, $context);
141+
}
142+
143+
public function testDenormalizeInvalidValueWithAllowInvalidAndCollectErrorsThrows()
144+
{
145+
$this->expectException(NotNormalizableValueException::class);
146+
$this->expectExceptionMessage('The data must belong to a backed enumeration of type');
147+
148+
$context = [
149+
BackedEnumNormalizer::ALLOW_INVALID_VALUES => true,
150+
'not_normalizable_value_exceptions' => [],
151+
];
152+
153+
$this->normalizer->denormalize('invalid-value', StringBackedEnumDummy::class, null, $context);
154+
}
129155
}

‎src/Symfony/Component/Serializer/Tests/SerializerTest.php‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use Symfony\Component\PropertyAccess\PropertyAccessor;
1616
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
1717
use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
18+
use Symfony\Component\PropertyInfo\Extractor\SerializerExtractor;
1819
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
1920
use Symfony\Component\Serializer\Encoder\CsvEncoder;
2021
use Symfony\Component\Serializer\Encoder\JsonEncoder;
@@ -1794,6 +1795,38 @@ public function testDeserializeObjectWithAsymmetricPropertyVisibility()
17941795
$this->assertSame('one', $object->item);
17951796
$this->assertSame('final', $object->type); // Value set in the constructor; must not be changed during deserialization
17961797
}
1798+
1799+
public function testPartialDenormalizationWithInvalidEnumAndAllowInvalid()
1800+
{
1801+
$factory = new ClassMetadataFactory(new AttributeLoader());
1802+
$extractor = new PropertyInfoExtractor(
1803+
[new SerializerExtractor($factory)],
1804+
[new ReflectionExtractor()]
1805+
);
1806+
$serializer = new Serializer(
1807+
[
1808+
new ArrayDenormalizer(),
1809+
new BackedEnumNormalizer(),
1810+
new ObjectNormalizer($factory, null, null, $extractor),
1811+
],
1812+
);
1813+
1814+
$context = [
1815+
'collect_denormalization_errors' => true,
1816+
'allow_invalid_values' => true,
1817+
];
1818+
1819+
try {
1820+
$serializer->denormalize(['id' => 123, 'status' => null], SerializerTestRequestDto::class, null, $context);
1821+
$this->fail('PartialDenormalizationException was not thrown.');
1822+
} catch (PartialDenormalizationException $exception) {
1823+
$this->assertCount(1, $exception->getErrors());
1824+
$error = $exception->getErrors()[0];
1825+
1826+
$this->assertSame('status', $error->getPath());
1827+
$this->assertSame(['int', 'string'], $error->getExpectedTypes());
1828+
}
1829+
}
17971830
}
17981831

17991832
class Model
@@ -1969,3 +2002,18 @@ interface NormalizerAwareNormalizer extends NormalizerInterface, NormalizerAware
19692002
interface DenormalizerAwareDenormalizer extends DenormalizerInterface, DenormalizerAwareInterface
19702003
{
19712004
}
2005+
2006+
enum SerializerTestBackedEnum: string
2007+
{
2008+
case PENDING = 'pending';
2009+
case ACTIVE = 'active';
2010+
}
2011+
2012+
class SerializerTestRequestDto
2013+
{
2014+
public function __construct(
2015+
public int $id,
2016+
public SerializerTestBackedEnum $status,
2017+
) {
2018+
}
2019+
}

0 commit comments

Comments
 (0)