[Serializer] Add methods getSupportedTypes to allow better performance

symfony · fabpot · Mar 10, 2023 · Feb 2, 2023 · Mar 9, 2023 · Mar 10, 2023
commit 400685a68b00b0932f8ef41096578872b643099c
diff --git a/...ony/Component/Messenger/Transport/Serialization/Normalizer/FlattenExceptionNormalizer.php b/...ony/Component/Messenger/Transport/Serialization/Normalizer/FlattenExceptionNormalizer.php
@@ -45,6 +45,13 @@ public function normalize(mixed $object, string $format = null, array $context =
         return $normalized;
     }
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            FlattenException::class => false,
+        ];
+    }
+
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
         return $data instanceof FlattenException && ($context[Serializer::MESSENGER_SERIALIZATION_CONTEXT] ?? false);

@@ -6,7 +6,9 @@ CHANGELOG
 
  * Add `XmlEncoder::SAVE_OPTIONS` context option
  * Add `BackedEnumNormalizer::ALLOW_INVALID_VALUES` context option
+ * Add method `getSupportedTypes(?string $format)` to `NormalizerInterface` and `DenormalizerInterface`
  * Deprecate `MissingConstructorArgumentsException` in favor of `MissingConstructorArgumentException`
+ * Deprecate `CacheableSupportsMethodInterface` in favor of the new `getSupportedTypes(?string $format)` methods
 
 6.2
 ---

@@ -35,6 +35,16 @@ public function __construct(
     ) {
     }
 
+    public function getSupportedTypes(?string $format): ?array
+    {
+        // @deprecated remove condition in 7.0
+        if (!method_exists($this->normalizer, 'getSupportedTypes')) {
+            return null;
+        }
+
+        return $this->normalizer->getSupportedTypes($format);
+    }
+
     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
     {
         if (!$this->normalizer instanceof NormalizerInterface) {
@@ -114,8 +124,13 @@ public function setDenormalizer(DenormalizerInterface $denormalizer): void
         $this->normalizer->setDenormalizer($denormalizer);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->normalizer instanceof CacheableSupportsMethodInterface && $this->normalizer->hasCacheableSupportsMethod();
     }
 

@@ -128,6 +128,16 @@ public function decode(string $data, string $format, array $context = []): mixed
         return $result;
     }
 
+    public function getSupportedTypes(?string $format): ?array
+    {
+        // @deprecated remove condition in 7.0
+        if (!method_exists($this->serializer, 'getSupportedTypes')) {
+            return null;
+        }
+
+        return $this->serializer->getSupportedTypes($format);
+    }
+
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
         return $this->serializer->supportsNormalization($data, $format, $context);

@@ -150,8 +150,13 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory
         }
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return false;
     }
 

@@ -300,7 +300,7 @@ abstract protected function getAttributeValue(object $object, string $attribute,
      */
     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */)
     {
-        return class_exists($type) || (interface_exists($type, false) && $this->classDiscriminatorResolver && null !== $this->classDiscriminatorResolver->getMappingForClass($type));
+        return class_exists($type) || (interface_exists($type, false) && null !== $this->classDiscriminatorResolver?->getMappingForClass($type));
     }
 
     public function denormalize(mixed $data, string $type, string $format = null, array $context = [])

@@ -27,6 +27,16 @@ class ArrayDenormalizer implements ContextAwareDenormalizerInterface, Denormaliz
 {
     use DenormalizerAwareTrait;
 
+    public function getSupportedTypes(?string $format): ?array
+    {
+        // @deprecated remove condition in 7.0
+        if (!method_exists($this->denormalizer, 'getSupportedTypes')) {
+            return null;
+        }
+
+        return $this->denormalizer->getSupportedTypes($format);
+    }
+
     /**
      * @throws NotNormalizableValueException
      */
@@ -69,8 +79,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
             && $this->denormalizer->supportsDenormalization($data, substr($type, 0, -2), $format, $context);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return $this->denormalizer instanceof CacheableSupportsMethodInterface && $this->denormalizer->hasCacheableSupportsMethod();
     }
 }
@@ -27,6 +27,13 @@ final class BackedEnumNormalizer implements NormalizerInterface, DenormalizerInt
      */
     public const ALLOW_INVALID_VALUES = 'allow_invalid_values';
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+           \BackedEnum::class => true,
+        ];
+    }
+
     public function normalize(mixed $object, string $format = null, array $context = []): int|string
     {
         if (!$object instanceof \BackedEnum) {
@@ -78,8 +85,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
         return is_subclass_of($type, \BackedEnum::class);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return true;
     }
 }
@@ -19,6 +19,8 @@
  * supports*() methods will be cached by type and format.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated since Symfony 6.3, implement "getSupportedTypes(?string $format)" instead
  */
 interface CacheableSupportsMethodInterface
 {

@@ -39,6 +39,13 @@ public function __construct(array $defaultContext = [], NameConverterInterface $
         $this->nameConverter = $nameConverter;
     }
 
+    public function getSupportedTypes(?string $format): ?array
+    {
+        return [
+            ConstraintViolationListInterface::class => __CLASS__ === static::class,
+        ];
+    }
+
     public function normalize(mixed $object, string $format = null, array $context = []): array
     {
         if (\array_key_exists(self::PAYLOAD_FIELDS, $context)) {
@@ -109,8 +116,13 @@ public function supportsNormalization(mixed $data, string $format = null /* , ar
         return $data instanceof ConstraintViolationListInterface;
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 }
@@ -22,6 +22,13 @@ class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, Se
     use ObjectToPopulateTrait;
     use SerializerAwareTrait;
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            NormalizableInterface::class => __CLASS__ === static::class,
+        ];
+    }
+
     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
     {
         return $object->normalize($this->serializer, $format, $context);
@@ -60,8 +67,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
         return is_subclass_of($type, DenormalizableInterface::class);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 }
@@ -45,6 +45,15 @@ public function __construct(MimeTypeGuesserInterface $mimeTypeGuesser = null)
         $this->mimeTypeGuesser = $mimeTypeGuesser;
     }
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            \SplFileInfo::class => __CLASS__ === static::class,
+            \SplFileObject::class => __CLASS__ === static::class,
+            File::class => __CLASS__ === static::class,
+        ];
+    }
+
     public function normalize(mixed $object, string $format = null, array $context = []): string
     {
         if (!$object instanceof \SplFileInfo) {
@@ -118,8 +127,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
         return isset(self::SUPPORTED_TYPES[$type]);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 

@@ -33,6 +33,13 @@ public function __construct(array $defaultContext = [])
         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
     }
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            \DateInterval::class => __CLASS__ === static::class,
+        ];
+    }
+
     /**
      * @throws InvalidArgumentException
      */
@@ -53,8 +60,13 @@ public function supportsNormalization(mixed $data, string $format = null /* , ar
         return $data instanceof \DateInterval;
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 

@@ -47,6 +47,15 @@ public function setDefaultContext(array $defaultContext): void
         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
     }
 
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            \DateTimeInterface::class => __CLASS__ === static::class,
+            \DateTimeImmutable::class => __CLASS__ === static::class,
+            \DateTime::class => __CLASS__ === static::class,
+        ];
+    }
+
     /**
      * @throws InvalidArgumentException
      */
@@ -124,8 +133,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
         return isset(self::SUPPORTED_TYPES[$type]);
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 

@@ -22,6 +22,13 @@
  */
 class DateTimeZoneNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
 {
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            \DateTimeZone::class => __CLASS__ === static::class,
+        ];
+    }
+
     /**
      * @throws InvalidArgumentException
      */
@@ -66,8 +73,13 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
         return \DateTimeZone::class === $type;
     }
 
+    /**
+     * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead
+     */
     public function hasCacheableSupportsMethod(): bool
     {
+        trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
         return __CLASS__ === static::class;
     }
 }
@@ -21,6 +21,8 @@
 
 /**
  * @author Jordi Boggiano <[email protected]>
+ *
+ * @method getSupportedTypes(?string $format): ?array
  */
 interface DenormalizerInterface
 {
@@ -49,12 +51,32 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
     /**
      * Checks whether the given class is supported for denormalization by this normalizer.
      *
-     * @param mixed       $data   Data to denormalize from
-     * @param string      $type   The class to which the data should be denormalized
-     * @param string|null $format The format being deserialized from
+     * Since Symfony 6.3, this method will only be called if the type is
+     * included in the supported types returned by getSupportedTypes().
+     *
+     * @see getSupportedTypes()
+     *
+     * @param mixed       $data    Data to denormalize from
+     * @param string      $type    The class to which the data should be denormalized
+     * @param string|null $format  The format being deserialized from
      * @param array       $context Options available to the denormalizer
      *
      * @return bool
      */
     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */);
+
+    /*
+     * Return the types supported for normalization by this denormalizer for
+     * this format associated to a boolean value indicating if the result of
+     * supports*() methods can be cached or if the result can not be cached
+     * because it depends on the context.
+     * Returning null means this denormalizer will be considered for
+     * every format/class.
+     * Return an empty array if no type is supported for this format.
+     *
+     * @param string $format The format being (de-)serialized from or into
+     *
+     * @return array<class-string|string, bool>|null
+     */
+    /* public function getSupportedTypes(?string $format): ?array; */
 }