[Serializer] Deprecate support for abstract uid denormalization in UidNormalizer

fancyweb · fancyweb · commit 38431ca7d533 · 2021-12-28T15:05:39.000+01:00
diff --git a/UPGRADE-6.1.md b/UPGRADE-6.1.md
@@ -0,0 +1,8 @@
+UPGRADE FROM 6.0 to 6.1
+=======================
+
+Serializer
+----------
+
+ * Deprecate supporting denormalization for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
+ * Deprecate denormalizing to an abstract class in `UidNormalizer`
diff --git a/UPGRADE-7.0.md b/UPGRADE-7.0.md
@@ -0,0 +1,8 @@
+UPGRADE FROM 6.x to 7.0
+=======================
+
+Serializer
+----------
+
+ * Remove denormalization support for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
+ * Denormalizing to an abstract class in `UidNormalizer` now throws an `\Error`
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * Deprecate supporting denormalization for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
+ * Deprecate denormalizing to an abstract class in `UidNormalizer`
+
 6.0
 ---
 
diff --git a/src/Symfony/Component/Serializer/Normalizer/UidNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/UidNormalizer.php
@@ -70,7 +70,13 @@ public function supportsNormalization(mixed $data, string $format = null): bool
     public function denormalize(mixed $data, string $type, string $format = null, array $context = []): mixed
     {
         try {
-            return AbstractUid::class !== $type ? $type::fromString($data) : Uuid::fromString($data);
+            if (AbstractUid::class === $type) {
+                trigger_deprecation('symfony/serializer', '6.1', sprintf('Denormalizing to an abstract class in "%s" is deprecated, it will throw an \Error in 7.0.', __CLASS__));
+
+                return Uuid::fromString($data);
+            }
+
+            return $type::fromString($data);
         } catch (\InvalidArgumentException|\TypeError $exception) {
             throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The data is not a valid "%s" string representation.', $type), $data, [Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
         } catch (\Error $e) {
@@ -87,7 +93,13 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
      */
     public function supportsDenormalization(mixed $data, string $type, string $format = null): bool
     {
-        return is_a($type, AbstractUid::class, true);
+        if (AbstractUid::class === $type) {
+            trigger_deprecation('symfony/serializer', '6.1', sprintf('Supporting denormalization for the "%s" type in "%s" is deprecated, use one of "%s" child class instead.', AbstractUid::class, __CLASS__, AbstractUid::class));
+
+            return true;
+        }
+
+        return is_subclass_of($type, AbstractUid::class, true);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/UidNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/UidNormalizerTest.php
@@ -3,6 +3,7 @@
 namespace Symfony\Component\Serializer\Tests\Normalizer;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Normalizer\UidNormalizer;
 use Symfony\Component\Uid\AbstractUid;
@@ -16,6 +17,8 @@
 
 class UidNormalizerTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     /**
      * @var UidNormalizer
      */
@@ -134,8 +137,13 @@ public function testSupportsDenormalizationForNonUid()
         $this->assertFalse($this->normalizer->supportsDenormalization('foo', \stdClass::class));
     }
 
+    /**
+     * @group legacy
+     */
     public function testSupportOurAbstractUid()
     {
+        $this->expectDeprecation('Since symfony/serializer 6.1: Supporting denormalization for the "Symfony\Component\Uid\AbstractUid" type in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, use one of "Symfony\Component\Uid\AbstractUid" child class instead.');
+
         $this->assertTrue($this->normalizer->supportsDenormalization('1ea6ecef-eb9a-66fe-b62b-957b45f17e43', AbstractUid::class));
     }
 
@@ -152,13 +160,23 @@ public function testDenormalize($uuidString, $class)
         $this->assertEquals($class::fromString($uuidString), $this->normalizer->denormalize($uuidString, $class));
     }
 
+    /**
+     * @group legacy
+     */
     public function testDenormalizeOurAbstractUid()
     {
+        $this->expectDeprecation('Since symfony/serializer 6.1: Denormalizing to an abstract class in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, it will throw an \Error in 7.0.');
+
         $this->assertEquals(Uuid::fromString($uuidString = '1ea6ecef-eb9a-66fe-b62b-957b45f17e43'), $this->normalizer->denormalize($uuidString, AbstractUid::class));
     }
 
+    /**
+     * @group legacy
+     */
     public function testDenormalizeCustomAbstractUid()
     {
+        $this->expectDeprecation('Since symfony/serializer 6.1: Denormalizing to an abstract class in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, it will throw an \Error in 7.0.');
+
         $this->assertEquals(Uuid::fromString($uuidString = '1ea6ecef-eb9a-66fe-b62b-957b45f17e43'), $this->normalizer->denormalize($uuidString, TestAbstractCustomUid::class));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Symfony\Component\Serializer\Tests\Normalizer;`
`4`	`4`
`5`	`5`	`use PHPUnit\Framework\TestCase;`
	`6`	`+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;`
`6`	`7`	`use Symfony\Component\Serializer\Exception\LogicException;`
`7`	`8`	`use Symfony\Component\Serializer\Normalizer\UidNormalizer;`
`8`	`9`	`use Symfony\Component\Uid\AbstractUid;`
`@@ -16,6 +17,8 @@`
`16`	`17`
`17`	`18`	`class UidNormalizerTest extends TestCase`
`18`	`19`	`{`
	`20`	`+ use ExpectDeprecationTrait;`
	`21`	`+`
`19`	`22`	`/**`
`20`	`23`	`* @var UidNormalizer`
`21`	`24`	`*/`
`@@ -134,8 +137,13 @@ public function testSupportsDenormalizationForNonUid()`
`134`	`137`	`$this->assertFalse($this->normalizer->supportsDenormalization('foo', \stdClass::class));`
`135`	`138`	`}`
`136`	`139`
	`140`	`+ /**`
	`141`	`+ * @group legacy`
	`142`	`+ */`
`137`	`143`	`public function testSupportOurAbstractUid()`
`138`	`144`	`{`
	`145`	`+ $this->expectDeprecation('Since symfony/serializer 6.1: Supporting denormalization for the "Symfony\Component\Uid\AbstractUid" type in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, use one of "Symfony\Component\Uid\AbstractUid" child class instead.');`
	`146`	`+`
`139`	`147`	`$this->assertTrue($this->normalizer->supportsDenormalization('1ea6ecef-eb9a-66fe-b62b-957b45f17e43', AbstractUid::class));`
`140`	`148`	`}`
`141`	`149`
`@@ -152,13 +160,23 @@ public function testDenormalize($uuidString, $class)`
`152`	`160`	`$this->assertEquals($class::fromString($uuidString), $this->normalizer->denormalize($uuidString, $class));`
`153`	`161`	`}`
`154`	`162`
	`163`	`+ /**`
	`164`	`+ * @group legacy`
	`165`	`+ */`
`155`	`166`	`public function testDenormalizeOurAbstractUid()`
`156`	`167`	`{`
	`168`	`+ $this->expectDeprecation('Since symfony/serializer 6.1: Denormalizing to an abstract class in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, it will throw an \Error in 7.0.');`
	`169`	`+`
`157`	`170`	`$this->assertEquals(Uuid::fromString($uuidString = '1ea6ecef-eb9a-66fe-b62b-957b45f17e43'), $this->normalizer->denormalize($uuidString, AbstractUid::class));`
`158`	`171`	`}`
`159`	`172`
	`173`	`+ /**`
	`174`	`+ * @group legacy`
	`175`	`+ */`
`160`	`176`	`public function testDenormalizeCustomAbstractUid()`
`161`	`177`	`{`
	`178`	`+ $this->expectDeprecation('Since symfony/serializer 6.1: Denormalizing to an abstract class in "Symfony\Component\Serializer\Normalizer\UidNormalizer" is deprecated, it will throw an \Error in 7.0.');`
	`179`	`+`
`162`	`180`	`$this->assertEquals(Uuid::fromString($uuidString = '1ea6ecef-eb9a-66fe-b62b-957b45f17e43'), $this->normalizer->denormalize($uuidString, TestAbstractCustomUid::class));`
`163`	`181`	`}`
`164`	`182`