[Serializer] Revert deprecation of ContextAwareEncoderInterface and ContextAwareDecoderInterface

nicolas-grekas · nicolas-grekas · commit afca3384e522 · 2022-08-02T11:40:46.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -9,8 +9,6 @@ CHANGELOG
  * Set `Context` annotation as not final
  * Deprecate `ContextAwareNormalizerInterface`, use `NormalizerInterface` instead
  * Deprecate `ContextAwareDenormalizerInterface`, use `DenormalizerInterface` instead
- * Deprecate `ContextAwareEncoderInterface`, use `EncoderInterface` instead
- * Deprecate `ContextAwareDecoderInterface`, use `DecoderInterface` instead
  * Deprecate supporting denormalization for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
  * Deprecate denormalizing to an abstract class in `UidNormalizer`
  * Add support for `can*()` methods to `ObjectNormalizer`
diff --git a/src/Symfony/Component/Serializer/Encoder/ChainDecoder.php b/src/Symfony/Component/Serializer/Encoder/ChainDecoder.php
@@ -67,9 +67,13 @@ private function getDecoder(string $format, array $context): DecoderInterface
             return $this->decoders[$this->decoderByFormat[$format]];
         }
 
+        $cache = true;
         foreach ($this->decoders as $i => $decoder) {
+            $cache = $cache && !$decoder instanceof ContextAwareDecoderInterface;
             if ($decoder->supportsDecoding($format, $context)) {
-                $this->decoderByFormat[$format] = $i;
+                if ($cache) {
+                    $this->decoderByFormat[$format] = $i;
+                }
 
                 return $decoder;
             }
diff --git a/src/Symfony/Component/Serializer/Encoder/ChainEncoder.php b/src/Symfony/Component/Serializer/Encoder/ChainEncoder.php
@@ -90,9 +90,13 @@ private function getEncoder(string $format, array $context): EncoderInterface
             return $this->encoders[$this->encoderByFormat[$format]];
         }
 
+        $cache = true;
         foreach ($this->encoders as $i => $encoder) {
+            $cache = $cache && !$encoder instanceof ContextAwareEncoderInterface;
             if ($encoder->supportsEncoding($format, $context)) {
-                $this->encoderByFormat[$format] = $i;
+                if ($cache) {
+                    $this->encoderByFormat[$format] = $i;
+                }
 
                 return $encoder;
             }
diff --git a/src/Symfony/Component/Serializer/Encoder/ContextAwareDecoderInterface.php b/src/Symfony/Component/Serializer/Encoder/ContextAwareDecoderInterface.php
@@ -15,8 +15,6 @@
  * Adds the support of an extra $context parameter for the supportsDecoding method.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
- *
- * @deprecated since symfony/serializer 6.1, use DecoderInterface instead
  */
 interface ContextAwareDecoderInterface extends DecoderInterface
 {
diff --git a/src/Symfony/Component/Serializer/Encoder/ContextAwareEncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/ContextAwareEncoderInterface.php
@@ -15,8 +15,6 @@
  * Adds the support of an extra $context parameter for the supportsEncoding method.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
- *
- * @deprecated since symfony/serializer 6.1, use EncoderInterface instead
  */
 interface ContextAwareEncoderInterface extends EncoderInterface
 {
diff --git a/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php b/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php
@@ -124,10 +124,8 @@ public function encode(mixed $data, string $format, array $context = []): string
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool
+    public function supportsEncoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
@@ -212,10 +210,8 @@ public function decode(string $data, string $format, array $context = []): mixed
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsDecoding(string $format /* , array $context = [] */): bool
+    public function supportsDecoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php
@@ -39,10 +39,9 @@ public function decode(string $data, string $format, array $context = []);
     /**
      * Checks whether the deserializer can decode from given format.
      *
-     * @param string $format  Format name
-     * @param array  $context Options that decoders have access to
+     * @param string $format Format name
      *
      * @return bool
      */
-    public function supportsDecoding(string $format /* , array $context = [] */);
+    public function supportsDecoding(string $format);
 }
diff --git a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php
@@ -32,8 +32,7 @@ public function encode(mixed $data, string $format, array $context = []): string
     /**
      * Checks whether the serializer can encode to given format.
      *
-     * @param string $format  Format name
-     * @param array  $context Options that normalizers/encoders have access to
+     * @param string $format Format name
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool;
+    public function supportsEncoding(string $format): bool;
 }
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonDecode.php b/src/Symfony/Component/Serializer/Encoder/JsonDecode.php
@@ -95,10 +95,8 @@ public function decode(string $data, string $format, array $context = []): mixed
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsDecoding(string $format /* , array $context = [] */): bool
+    public function supportsDecoding(string $format): bool
     {
         return JsonEncoder::FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncode.php b/src/Symfony/Component/Serializer/Encoder/JsonEncode.php
@@ -57,10 +57,8 @@ public function encode(mixed $data, string $format, array $context = []): string
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool
+    public function supportsEncoding(string $format): bool
     {
         return JsonEncoder::FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php b/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php
@@ -47,20 +47,16 @@ public function decode(string $data, string $format, array $context = []): mixed
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool
+    public function supportsEncoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsDecoding(string $format /* , array $context = [] */): bool
+    public function supportsDecoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -166,20 +166,16 @@ public function decode(string $data, string $format, array $context = []): mixed
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool
+    public function supportsEncoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsDecoding(string $format /* , array $context = [] */): bool
+    public function supportsDecoding(string $format): bool
     {
         return self::FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Encoder/YamlEncoder.php b/src/Symfony/Component/Serializer/Encoder/YamlEncoder.php
@@ -67,10 +67,8 @@ public function encode(mixed $data, string $format, array $context = []): string
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsEncoding(string $format /* , array $context = [] */): bool
+    public function supportsEncoding(string $format): bool
     {
         return self::FORMAT === $format || self::ALTERNATIVE_FORMAT === $format;
     }
@@ -87,10 +85,8 @@ public function decode(string $data, string $format, array $context = []): mixed
 
     /**
      * {@inheritdoc}
-     *
-     * @param array $context
      */
-    public function supportsDecoding(string $format /* , array $context = [] */): bool
+    public function supportsDecoding(string $format): bool
     {
         return self::FORMAT === $format || self::ALTERNATIVE_FORMAT === $format;
     }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/ChainDecoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/ChainDecoderTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Encoder\ChainDecoder;
+use Symfony\Component\Serializer\Encoder\ContextAwareDecoderInterface;
 use Symfony\Component\Serializer\Encoder\DecoderInterface;
 use Symfony\Component\Serializer\Exception\RuntimeException;
 
@@ -28,7 +29,7 @@ class ChainDecoderTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->decoder1 = $this->createMock(DecoderInterface::class);
+        $this->decoder1 = $this->createMock(ContextAwareDecoderInterface::class);
         $this->decoder1
             ->method('supportsDecoding')
             ->willReturnMap([
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/ChainEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/ChainEncoderTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Debug\TraceableEncoder;
 use Symfony\Component\Serializer\Encoder\ChainEncoder;
+use Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface;
 use Symfony\Component\Serializer\Encoder\EncoderInterface;
 use Symfony\Component\Serializer\Encoder\NormalizationAwareInterface;
 use Symfony\Component\Serializer\Exception\RuntimeException;
@@ -30,7 +31,7 @@ class ChainEncoderTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->encoder1 = $this->createMock(EncoderInterface::class);
+        $this->encoder1 = $this->createMock(ContextAwareEncoderInterface::class);
         $this->encoder1
             ->method('supportsEncoding')
             ->willReturnMap([
@@ -106,7 +107,7 @@ public function testNeedsNormalizationTraceableEncoder()
 
 class NormalizationAwareEncoder implements EncoderInterface, NormalizationAwareInterface
 {
-    public function supportsEncoding(string $format, array $context = []): bool
+    public function supportsEncoding(string $format): bool
     {
         return true;
     }

Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,13 @@ private function getDecoder(string $format, array $context): DecoderInterface`
`67`	`67`	`return $this->decoders[$this->decoderByFormat[$format]];`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ $cache = true;`
`70`	`71`	`foreach ($this->decoders as $i => $decoder) {`
	`72`	`+ $cache = $cache && !$decoder instanceof ContextAwareDecoderInterface;`
`71`	`73`	`if ($decoder->supportsDecoding($format, $context)) {`
`72`		`- $this->decoderByFormat[$format] = $i;`
	`74`	`+ if ($cache) {`
	`75`	`+ $this->decoderByFormat[$format] = $i;`
	`76`	`+ }`
`73`	`77`
`74`	`78`	`return $decoder;`
`75`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,9 +90,13 @@ private function getEncoder(string $format, array $context): EncoderInterface`
`90`	`90`	`return $this->encoders[$this->encoderByFormat[$format]];`
`91`	`91`	`}`
`92`	`92`
	`93`	`+ $cache = true;`
`93`	`94`	`foreach ($this->encoders as $i => $encoder) {`
	`95`	`+ $cache = $cache && !$encoder instanceof ContextAwareEncoderInterface;`
`94`	`96`	`if ($encoder->supportsEncoding($format, $context)) {`
`95`		`- $this->encoderByFormat[$format] = $i;`
	`97`	`+ if ($cache) {`
	`98`	`+ $this->encoderByFormat[$format] = $i;`
	`99`	`+ }`
`96`	`100`
`97`	`101`	`return $encoder;`
`98`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,6 @@`
`15`	`15`	`* Adds the support of an extra $context parameter for the supportsDecoding method.`
`16`	`16`	`*`
`17`	`17`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`18`		`- *`
`19`		`- * @deprecated since symfony/serializer 6.1, use DecoderInterface instead`
`20`	`18`	`*/`
`21`	`19`	`interface ContextAwareDecoderInterface extends DecoderInterface`
`22`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -124,10 +124,8 @@ public function encode(mixed $data, string $format, array $context = []): string`
`124`	`124`
`125`	`125`	`/**`
`126`	`126`	`* {@inheritdoc}`
`127`		`- *`
`128`		`- * @param array $context`
`129`	`127`	`*/`
`130`		`- public function supportsEncoding(string $format /* , array $context = [] */): bool`
	`128`	`+ public function supportsEncoding(string $format): bool`
`131`	`129`	`{`
`132`	`130`	`return self::FORMAT === $format;`
`133`	`131`	`}`
`@@ -212,10 +210,8 @@ public function decode(string $data, string $format, array $context = []): mixed`
`212`	`210`
`213`	`211`	`/**`
`214`	`212`	`* {@inheritdoc}`
`215`		`- *`
`216`		`- * @param array $context`
`217`	`213`	`*/`
`218`		`- public function supportsDecoding(string $format /* , array $context = [] */): bool`
	`214`	`+ public function supportsDecoding(string $format): bool`
`219`	`215`	`{`
`220`	`216`	`return self::FORMAT === $format;`
`221`	`217`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,10 +39,9 @@ public function decode(string $data, string $format, array $context = []);`
`39`	`39`	`/**`
`40`	`40`	`* Checks whether the deserializer can decode from given format.`
`41`	`41`	`*`
`42`		`- * @param string $format Format name`
`43`		`- * @param array $context Options that decoders have access to`
	`42`	`+ * @param string $format Format name`
`44`	`43`	`*`
`45`	`44`	`* @return bool`
`46`	`45`	`*/`
`47`		`- public function supportsDecoding(string $format /* , array $context = [] */);`
	`46`	`+ public function supportsDecoding(string $format);`
`48`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,7 @@ public function encode(mixed $data, string $format, array $context = []): string`
`32`	`32`	`/**`
`33`	`33`	`* Checks whether the serializer can encode to given format.`
`34`	`34`	`*`
`35`		`- * @param string $format Format name`
`36`		`- * @param array $context Options that normalizers/encoders have access to`
	`35`	`+ * @param string $format Format name`
`37`	`36`	`*/`
`38`		`- public function supportsEncoding(string $format /* , array $context = [] */): bool;`
	`37`	`+ public function supportsEncoding(string $format): bool;`
`39`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,10 +95,8 @@ public function decode(string $data, string $format, array $context = []): mixed`
`95`	`95`
`96`	`96`	`/**`
`97`	`97`	`* {@inheritdoc}`
`98`		`- *`
`99`		`- * @param array $context`
`100`	`98`	`*/`
`101`		`- public function supportsDecoding(string $format /* , array $context = [] */): bool`
	`99`	`+ public function supportsDecoding(string $format): bool`
`102`	`100`	`{`
`103`	`101`	`return JsonEncoder::FORMAT === $format;`
`104`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,10 +57,8 @@ public function encode(mixed $data, string $format, array $context = []): string`
`57`	`57`
`58`	`58`	`/**`
`59`	`59`	`* {@inheritdoc}`
`60`		`- *`
`61`		`- * @param array $context`
`62`	`60`	`*/`
`63`		`- public function supportsEncoding(string $format /* , array $context = [] */): bool`
	`61`	`+ public function supportsEncoding(string $format): bool`
`64`	`62`	`{`
`65`	`63`	`return JsonEncoder::FORMAT === $format;`
`66`	`64`	`}`