bug #51992 [Serializer] Fix using DateIntervalNormalizer with union types (Jeroeny)

fabpot · fabpot · commit 3f9249292707 · 2023-10-25T11:53:19.000-07:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Serializer] Fix using `DateIntervalNormalizer` with union types | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT The union logic of `AbstractObjectNormalizer` tries to denormalize each union type and catches `NotNormalizableValueException` (among some other exceptions). If a non-catching exception is thrown, denormalization fails on that first type, while a later type might have succeeded. If I try to denormalize a `DateTimeInterface` value into a `DateInterval|DateTimeInterface` type, it will fail because the `DateIntervalNormalizer` throws `UnexpectedValueException` instead of `NotNormalizableValueException`. Denormalizing a `DateInterval` into `DateTimeInterface|DateInterval` does work, because `DateTimeNormalizer` throws `NotNormalizableValueException`. I also checked some other Object-specific normalizers like `Uid`, `Problem`, `DateTimeZone`, `DataUri`, `BackedEnum`, they are using `NotNormalizableValueException`. See reproducer: https://github.com/Jeroeny/reproduce/tree/union/src Commits ------- c727a2f [Serializer] Fix using `DateIntervalNormalizer` with union types
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Normalizer;
 
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
-use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
 
 /**
  * Normalizes an instance of {@see \DateInterval} to an interval string.
@@ -70,17 +70,16 @@ public function hasCacheableSupportsMethod(): bool
      *
      * @return \DateInterval
      *
-     * @throws InvalidArgumentException
-     * @throws UnexpectedValueException
+     * @throws NotNormalizableValueException
      */
     public function denormalize($data, string $type, string $format = null, array $context = [])
     {
         if (!\is_string($data)) {
-            throw new InvalidArgumentException(sprintf('Data expected to be a string, "%s" given.', get_debug_type($data)));
+            throw NotNormalizableValueException::createForUnexpectedDataType('Data expected to be a string.', $data, ['string'], $context['deserialization_path'] ?? null, true);
         }
 
         if (!$this->isISO8601($data)) {
-            throw new UnexpectedValueException('Expected a valid ISO 8601 interval string.');
+            throw NotNormalizableValueException::createForUnexpectedDataType('Expected a valid ISO 8601 interval string.', $data, ['string'], $context['deserialization_path'] ?? null, true);
         }
 
         $dateIntervalFormat = $context[self::FORMAT_KEY] ?? $this->defaultContext[self::FORMAT_KEY];
@@ -98,7 +97,7 @@ public function denormalize($data, string $type, string $format = null, array $c
         }
         $valuePattern = '/^'.$signPattern.preg_replace('/%([yYmMdDhHiIsSwW])(\w)/', '(?:(?P<$1>\d+)$2)?', preg_replace('/(T.*)$/', '($1)?', $dateIntervalFormat)).'$/';
         if (!preg_match($valuePattern, $data)) {
-            throw new UnexpectedValueException(sprintf('Value "%s" contains intervals not accepted by format "%s".', $data, $dateIntervalFormat));
+            throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Value "%s" contains intervals not accepted by format "%s".', $data, $dateIntervalFormat), $data, ['string'], $context['deserialization_path'] ?? null, false);
         }
 
         try {
@@ -115,7 +114,7 @@ public function denormalize($data, string $type, string $format = null, array $c
 
             return new \DateInterval($data);
         } catch (\Exception $e) {
-            throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
+            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, ['string'], $context['deserialization_path'] ?? null, false, $e->getCode(), $e);
         }
     }
 
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/DateIntervalNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/DateIntervalNormalizerTest.php
@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
-use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
 use Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer;
 
 /**
@@ -123,26 +123,26 @@ public function testDenormalizeIntervalsWithOmittedPartsBeingZero()
 
     public function testDenormalizeExpectsString()
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(NotNormalizableValueException::class);
         $this->normalizer->denormalize(1234, \DateInterval::class);
     }
 
     public function testDenormalizeNonISO8601IntervalStringThrowsException()
     {
-        $this->expectException(UnexpectedValueException::class);
+        $this->expectException(NotNormalizableValueException::class);
         $this->expectExceptionMessage('Expected a valid ISO 8601 interval string.');
         $this->normalizer->denormalize('10 years 2 months 3 days', \DateInterval::class, null);
     }
 
     public function testDenormalizeInvalidDataThrowsException()
     {
-        $this->expectException(UnexpectedValueException::class);
+        $this->expectException(NotNormalizableValueException::class);
         $this->normalizer->denormalize('invalid interval', \DateInterval::class);
     }
 
     public function testDenormalizeFormatMismatchThrowsException()
     {
-        $this->expectException(UnexpectedValueException::class);
+        $this->expectException(NotNormalizableValueException::class);
         $this->normalizer->denormalize('P00Y00M00DT00H00M00S', \DateInterval::class, null, [DateIntervalNormalizer::FORMAT_KEY => 'P%yY%mM%dD']);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Serializer\Normalizer;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Serializer\Exception\InvalidArgumentException;`
`15`		`-use Symfony\Component\Serializer\Exception\UnexpectedValueException;`
	`15`	`+use Symfony\Component\Serializer\Exception\NotNormalizableValueException;`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* Normalizes an instance of {@see \DateInterval} to an interval string.`
`@@ -70,17 +70,16 @@ public function hasCacheableSupportsMethod(): bool`
`70`	`70`	`*`
`71`	`71`	`* @return \DateInterval`
`72`	`72`	`*`
`73`		`- * @throws InvalidArgumentException`
`74`		`- * @throws UnexpectedValueException`
	`73`	`+ * @throws NotNormalizableValueException`
`75`	`74`	`*/`
`76`	`75`	`public function denormalize($data, string $type, string $format = null, array $context = [])`
`77`	`76`	`{`
`78`	`77`	`if (!\is_string($data)) {`
`79`		`- throw new InvalidArgumentException(sprintf('Data expected to be a string, "%s" given.', get_debug_type($data)));`
	`78`	`+ throw NotNormalizableValueException::createForUnexpectedDataType('Data expected to be a string.', $data, ['string'], $context['deserialization_path'] ?? null, true);`
`80`	`79`	`}`
`81`	`80`
`82`	`81`	`if (!$this->isISO8601($data)) {`
`83`		`- throw new UnexpectedValueException('Expected a valid ISO 8601 interval string.');`
	`82`	`+ throw NotNormalizableValueException::createForUnexpectedDataType('Expected a valid ISO 8601 interval string.', $data, ['string'], $context['deserialization_path'] ?? null, true);`
`84`	`83`	`}`
`85`	`84`
`86`	`85`	`$dateIntervalFormat = $context[self::FORMAT_KEY] ?? $this->defaultContext[self::FORMAT_KEY];`
`@@ -98,7 +97,7 @@ public function denormalize($data, string $type, string $format = null, array $c`
`98`	`97`	`}`
`99`	`98`	`$valuePattern = '/^'.$signPattern.preg_replace('/%([yYmMdDhHiIsSwW])(\w)/', '(?:(?P<$1>\d+)$2)?', preg_replace('/(T.*)$/', '($1)?', $dateIntervalFormat)).'$/';`
`100`	`99`	`if (!preg_match($valuePattern, $data)) {`
`101`		`- throw new UnexpectedValueException(sprintf('Value "%s" contains intervals not accepted by format "%s".', $data, $dateIntervalFormat));`
	`100`	`+ throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Value "%s" contains intervals not accepted by format "%s".', $data, $dateIntervalFormat), $data, ['string'], $context['deserialization_path'] ?? null, false);`
`102`	`101`	`}`
`103`	`102`
`104`	`103`	`try {`
`@@ -115,7 +114,7 @@ public function denormalize($data, string $type, string $format = null, array $c`
`115`	`114`
`116`	`115`	`return new \DateInterval($data);`
`117`	`116`	`} catch (\Exception $e) {`
`118`		`- throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);`
	`117`	`+ throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, ['string'], $context['deserialization_path'] ?? null, false, $e->getCode(), $e);`
`119`	`118`	`}`
`120`	`119`	`}`
`121`	`120`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`use PHPUnit\Framework\TestCase;`
`15`	`15`	`use Symfony\Component\Serializer\Exception\InvalidArgumentException;`
`16`		`-use Symfony\Component\Serializer\Exception\UnexpectedValueException;`
	`16`	`+use Symfony\Component\Serializer\Exception\NotNormalizableValueException;`
`17`	`17`	`use Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer;`
`18`	`18`
`19`	`19`	`/**`
`@@ -123,26 +123,26 @@ public function testDenormalizeIntervalsWithOmittedPartsBeingZero()`
`123`	`123`
`124`	`124`	`public function testDenormalizeExpectsString()`
`125`	`125`	`{`
`126`		`- $this->expectException(InvalidArgumentException::class);`
	`126`	`+ $this->expectException(NotNormalizableValueException::class);`
`127`	`127`	`$this->normalizer->denormalize(1234, \DateInterval::class);`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`public function testDenormalizeNonISO8601IntervalStringThrowsException()`
`131`	`131`	`{`
`132`		`- $this->expectException(UnexpectedValueException::class);`
	`132`	`+ $this->expectException(NotNormalizableValueException::class);`
`133`	`133`	`$this->expectExceptionMessage('Expected a valid ISO 8601 interval string.');`
`134`	`134`	`$this->normalizer->denormalize('10 years 2 months 3 days', \DateInterval::class, null);`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`public function testDenormalizeInvalidDataThrowsException()`
`138`	`138`	`{`
`139`		`- $this->expectException(UnexpectedValueException::class);`
	`139`	`+ $this->expectException(NotNormalizableValueException::class);`
`140`	`140`	`$this->normalizer->denormalize('invalid interval', \DateInterval::class);`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`public function testDenormalizeFormatMismatchThrowsException()`
`144`	`144`	`{`
`145`		`- $this->expectException(UnexpectedValueException::class);`
	`145`	`+ $this->expectException(NotNormalizableValueException::class);`
`146`	`146`	`$this->normalizer->denormalize('P00Y00M00DT00H00M00S', \DateInterval::class, null, [DateIntervalNormalizer::FORMAT_KEY => 'P%yY%mM%dD']);`
`147`	`147`	`}`
`148`	`148`