[Serializer] Generalize caching support a bit

nicolas-grekas · nicolas-grekas · commit e89c23660f36 · 2018-04-27T14:29:13.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -4,6 +4,8 @@ CHANGELOG
 4.1.0
 -----
 
+* added `CacheableSupportsMethodInterface` for normalizers and denormalizers that use
+  only the type and the format in their `supports*()` methods
 * added `MissingConstructorArgumentsException` new exception for deserialization failure
   of objects that needs data insertion in constructor
 * added an optional `default_constructor_arguments` option of context to specify a default data in
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -30,15 +30,14 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-abstract class AbstractObjectNormalizer extends AbstractNormalizer implements NormalizerWithCacheableSupportResultInterface
+abstract class AbstractObjectNormalizer extends AbstractNormalizer implements CacheableSupportsMethodInterface
 {
     const ENABLE_MAX_DEPTH = 'enable_max_depth';
     const DEPTH_KEY_PATTERN = 'depth_%s::%s';
     const DISABLE_TYPE_ENFORCEMENT = 'disable_type_enforcement';
 
     private $propertyTypeExtractor;
     private $attributesCache = array();
-    private $cache = array();
 
     /**
      * @var callable|null
@@ -225,11 +224,7 @@ public function setMaxDepthHandler(?callable $handler): void
      */
     public function supportsDenormalization($data, $type, $format = null)
     {
-        if (!isset($this->cache[$type])) {
-            $this->cache[$type] = class_exists($type) || (interface_exists($type) && null !== $this->classDiscriminatorResolver && null !== $this->classDiscriminatorResolver->getMappingForClass($type));
-        }
-
-        return $this->cache[$type];
+        return \class_exists($type) || (\interface_exists($type, false) && $this->classDiscriminatorResolver && null !== $this->classDiscriminatorResolver->getMappingForClass($type));
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/CacheableSupportsMethodInterface.php b/src/Symfony/Component/Serializer/Normalizer/CacheableSupportsMethodInterface.php
@@ -12,10 +12,14 @@
 namespace Symfony\Component\Serializer\Normalizer;
 
 /**
- * "supportsNormalization()" methods of normalizers implementing this interface have a cacheable return.
+ * Marker interface for normalizers and denormalizers that use
+ * only the type and the format in their supports*() methods.
+ *
+ * By implementing this interface, the return value of the
+ * supports*() methods will be cached by type and format.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-interface NormalizerWithCacheableSupportResultInterface
+interface CacheableSupportsMethodInterface
 {
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php
@@ -22,7 +22,7 @@
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class ConstraintViolationListNormalizer implements NormalizerInterface, NormalizerWithCacheableSupportResultInterface
+class ConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php
@@ -17,13 +17,11 @@
 /**
  * @author Jordi Boggiano <j.boggiano@seld.be>
  */
-class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, NormalizerWithCacheableSupportResultInterface
+class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface
 {
     use ObjectToPopulateTrait;
     use SerializerAwareTrait;
 
-    private $cache = array();
-
     /**
      * {@inheritdoc}
      */
@@ -67,14 +65,6 @@ public function supportsNormalization($data, $format = null)
      */
     public function supportsDenormalization($data, $type, $format = null)
     {
-        if (isset($this->cache[$type])) {
-            return $this->cache[$type];
-        }
-
-        if (!class_exists($type)) {
-            return $this->cache[$type] = false;
-        }
-
-        return $this->cache[$type] = is_subclass_of($type, 'Symfony\Component\Serializer\Normalizer\DenormalizableInterface');
+        return \is_subclass_of($type, DenormalizableInterface::class);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php
@@ -23,7 +23,7 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, NormalizerWithCacheableSupportResultInterface
+class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
 {
     private static $supportedTypes = array(
         \SplFileInfo::class => true,
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php
@@ -20,7 +20,7 @@
  *
  * @author Jérôme Parmentier <jerome@prmntr.me>
  */
-class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, NormalizerWithCacheableSupportResultInterface
+class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT_KEY = 'dateinterval_format';
 
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
@@ -20,7 +20,7 @@
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface, NormalizerWithCacheableSupportResultInterface
+class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT_KEY = 'datetime_format';
     const TIMEZONE_KEY = 'datetime_timezone';
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
@@ -35,22 +35,21 @@
 class GetSetMethodNormalizer extends AbstractObjectNormalizer
 {
     private static $setterAccessibleCache = array();
-    private $cache = array();
 
     /**
      * {@inheritdoc}
      */
     public function supportsNormalization($data, $format = null)
     {
-        return parent::supportsNormalization($data, $format) && (isset($this->cache[$type = \get_class($data)]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
+        return parent::supportsNormalization($data, $format) && $this->supports(\get_class($data));
     }
 
     /**
      * {@inheritdoc}
      */
     public function supportsDenormalization($data, $type, $format = null)
     {
-        return parent::supportsDenormalization($data, $type, $format) && (isset($this->cache[$type]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
+        return parent::supportsDenormalization($data, $type, $format) && $this->supports($type);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php
@@ -19,7 +19,7 @@
  *
  * @author Fred Cox <mcfedr@gmail.com>
  */
-class JsonSerializableNormalizer extends AbstractNormalizer implements NormalizerWithCacheableSupportResultInterface
+class JsonSerializableNormalizer extends AbstractNormalizer implements CacheableSupportsMethodInterface
 {
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Component/Serializer/Normalizer/PropertyNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/PropertyNormalizer.php
@@ -30,22 +30,20 @@
  */
 class PropertyNormalizer extends AbstractObjectNormalizer
 {
-    private $cache = array();
-
     /**
      * {@inheritdoc}
      */
     public function supportsNormalization($data, $format = null)
     {
-        return parent::supportsNormalization($data, $format) && (isset($this->cache[$type = \get_class($data)]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
+        return parent::supportsNormalization($data, $format) && $this->supports(\get_class($data));
     }
 
     /**
      * {@inheritdoc}
      */
     public function supportsDenormalization($data, $type, $format = null)
     {
-        return parent::supportsDenormalization($data, $type, $format) && (isset($this->cache[$type]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
+        return parent::supportsDenormalization($data, $type, $format) && $this->supports($type);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Serializer.php b/src/Symfony/Component/Serializer/Serializer.php
@@ -26,7 +26,7 @@
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Exception\LogicException;
-use Symfony\Component\Serializer\Normalizer\NormalizerWithCacheableSupportResultInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 
 /**
  * Serializer serializes and deserializes data.
@@ -46,22 +46,24 @@
 class Serializer implements SerializerInterface, ContextAwareNormalizerInterface, ContextAwareDenormalizerInterface, ContextAwareEncoderInterface, ContextAwareDecoderInterface
 {
     /**
-     * @var Encoder\ChainEncoder
+     * @internal since Symfony 4.1
      */
     protected $encoder;
 
     /**
-     * @var Encoder\ChainDecoder
+     * @internal since Symfony 4.1
      */
     protected $decoder;
 
-    private $normalizerCache = array();
-
     /**
-     * @var array
+     * @internal since Symfony 4.1
      */
     protected $normalizers = array();
 
+    private $cachedNormalizers;
+    private $denormalizerCache = array();
+    private $normalizerCache = array();
+
     public function __construct(array $normalizers = array(), array $encoders = array())
     {
         foreach ($normalizers as $normalizer) {
@@ -203,35 +205,36 @@ public function supportsDenormalization($data, $type, $format = null, array $con
      *
      * @return NormalizerInterface|null
      */
-    private function getNormalizer($data, $format, array $context)
+    private function getNormalizer($data, ?string $format, array $context)
     {
-        $type = \is_object($data) ? 'c-'.\get_class($data) : \gettype($data);
-        if (
-            isset($this->normalizerCache[$type][$format]) ||
-            (isset($this->normalizerCache[$type]) && \array_key_exists($format, $this->normalizerCache[$type]))
-        ) {
-            return $this->normalizerCache[$type][$format];
+        if ($this->cachedNormalizers !== $this->normalizers) {
+            $this->cachedNormalizers = $this->normalizers;
+            $this->denormalizerCache = $this->normalizerCache = array();
         }
+        $type = \is_object($data) ? \get_class($data) : 'native-'.\gettype($data);
 
-        $cacheable = true;
-        foreach ($this->normalizers as $normalizer) {
-            if (!$normalizer instanceof NormalizerInterface) {
-                continue;
-            }
+        if (!isset($this->normalizerCache[$format][$type])) {
+            $this->normalizerCache[$format][$type] = array();
 
-            $cacheable = $cacheable && $normalizer instanceof NormalizerWithCacheableSupportResultInterface;
-            if ($normalizer->supportsNormalization($data, $format, $context)) {
-                if ($cacheable) {
-                    $this->normalizerCache[$type][$format] = $normalizer;
+            foreach ($this->normalizers as $k => $normalizer) {
+                if (!$normalizer instanceof NormalizerInterface) {
+                    continue;
                 }
 
-                return $normalizer;
+                if (!$normalizer instanceof CacheableSupportsMethodInterface) {
+                    $this->normalizerCache[$format][$type][$k] = false;
+                } elseif ($normalizer->supportsNormalization($data, $format)) {
+                    $this->normalizerCache[$format][$type][$k] = true;
+                    break;
+                }
             }
         }
 
-        if ($cacheable) {
-            // allow to cache primitive types
-            $this->normalizerCache[$type][$format] = null;
+        foreach ($this->normalizerCache[$format][$type] as $k => $cacheable) {
+            $normalizer = $this->normalizers[$k];
+            if ($cacheable || $normalizer->supportsNormalization($data, $format, $context)) {
+                return $normalizer;
+            }
         }
     }
 
@@ -245,10 +248,32 @@ private function getNormalizer($data, $format, array $context)
      *
      * @return DenormalizerInterface|null
      */
-    private function getDenormalizer($data, $class, $format, array $context)
+    private function getDenormalizer($data, string $class, ?string $format, array $context)
     {
-        foreach ($this->normalizers as $normalizer) {
-            if ($normalizer instanceof DenormalizerInterface && $normalizer->supportsDenormalization($data, $class, $format, $context)) {
+        if ($this->cachedNormalizers !== $this->normalizers) {
+            $this->cachedNormalizers = $this->normalizers;
+            $this->denormalizerCache = $this->normalizerCache = array();
+        }
+        if (!isset($this->denormalizerCache[$format][$class])) {
+            $this->denormalizerCache[$format][$class] = array();
+
+            foreach ($this->normalizers as $k => $normalizer) {
+                if (!$normalizer instanceof DenormalizerInterface) {
+                    continue;
+                }
+
+                if (!$normalizer instanceof CacheableSupportsMethodInterface) {
+                    $this->denormalizerCache[$format][$class][$k] = false;
+                } elseif ($normalizer->supportsDenormalization(null, $class, $format)) {
+                    $this->denormalizerCache[$format][$class][$k] = true;
+                    break;
+                }
+            }
+        }
+
+        foreach ($this->denormalizerCache[$format][$class] as $k => $cacheable) {
+            $normalizer = $this->normalizers[$k];
+            if ($cacheable || $normalizer->supportsDenormalization($data, $class, $format, $context)) {
                 return $normalizer;
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,14 @@`
`12`	`12`	`namespace Symfony\Component\Serializer\Normalizer;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * "supportsNormalization()" methods of normalizers implementing this interface have a cacheable return.`
	`15`	`+ * Marker interface for normalizers and denormalizers that use`
	`16`	`+ * only the type and the format in their supports*() methods.`
	`17`	`+ *`
	`18`	`+ * By implementing this interface, the return value of the`
	`19`	`+ * supports*() methods will be cached by type and format.`
`16`	`20`	`*`
`17`	`21`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`18`	`22`	`*/`
`19`		`-interface NormalizerWithCacheableSupportResultInterface`
	`23`	`+interface CacheableSupportsMethodInterface`
`20`	`24`	`{`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
`23`	`23`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`24`	`24`	`*/`
`25`		`-class ConstraintViolationListNormalizer implements NormalizerInterface, NormalizerWithCacheableSupportResultInterface`
	`25`	`+class ConstraintViolationListNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`	`28`	`* {@inheritdoc}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @author Kévin Dunglas <dunglas@gmail.com>`
`25`	`25`	`*/`
`26`		`-class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, NormalizerWithCacheableSupportResultInterface`
	`26`	`+class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface`
`27`	`27`	`{`
`28`	`28`	`private static $supportedTypes = array(`
`29`	`29`	`\SplFileInfo::class => true,`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*`
`21`	`21`	`* @author Jérôme Parmentier <jerome@prmntr.me>`
`22`	`22`	`*/`
`23`		`-class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, NormalizerWithCacheableSupportResultInterface`
	`23`	`+class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface`
`24`	`24`	`{`
`25`	`25`	`const FORMAT_KEY = 'dateinterval_format';`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -35,22 +35,21 @@`
`35`	`35`	`class GetSetMethodNormalizer extends AbstractObjectNormalizer`
`36`	`36`	`{`
`37`	`37`	`private static $setterAccessibleCache = array();`
`38`		`- private $cache = array();`
`39`	`38`
`40`	`39`	`/**`
`41`	`40`	`* {@inheritdoc}`
`42`	`41`	`*/`
`43`	`42`	`public function supportsNormalization($data, $format = null)`
`44`	`43`	`{`
`45`		`- return parent::supportsNormalization($data, $format) && (isset($this->cache[$type = \get_class($data)]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));`
	`44`	`+ return parent::supportsNormalization($data, $format) && $this->supports(\get_class($data));`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`/**`
`49`	`48`	`* {@inheritdoc}`
`50`	`49`	`*/`
`51`	`50`	`public function supportsDenormalization($data, $type, $format = null)`
`52`	`51`	`{`
`53`		`- return parent::supportsDenormalization($data, $type, $format) && (isset($this->cache[$type]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));`
	`52`	`+ return parent::supportsDenormalization($data, $type, $format) && $this->supports($type);`
`54`	`53`	`}`
`55`	`54`
`56`	`55`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*`
`20`	`20`	`* @author Fred Cox <mcfedr@gmail.com>`
`21`	`21`	`*/`
`22`		`-class JsonSerializableNormalizer extends AbstractNormalizer implements NormalizerWithCacheableSupportResultInterface`
	`22`	`+class JsonSerializableNormalizer extends AbstractNormalizer implements CacheableSupportsMethodInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`	`25`	`* {@inheritdoc}`