Merge pull request #2665 from teohhanhui/fix/cacheable-noop-scalar-normalizer

Add a cacheable no-op scalar normalizer

Author: soyuka

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -126,6 +126,11 @@
             <tag name="serializer.normalizer" priority="-925" />
         </service>
 
+        <service id="api_platform.serializer.normalizer.no_op_scalar" class="ApiPlatform\Core\Serializer\NoOpScalarNormalizer" public="false">
+            <!-- Run before our non-cacheable normalizers -->
+            <tag name="serializer.normalizer" priority="-900" />
+        </service>
+
         <!-- Resources Operations path resolver -->
 
         <service id="api_platform.operation_path_resolver" alias="api_platform.operation_path_resolver.router" public="false" />

src/Serializer/NoOpScalarNormalizer.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Serializer;
+
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * A no-op normalizer that passes through scalar values.
+ *
+ * When there are non-cacheable normalizers in use, and you don't need to normalize
+ * scalar values, register this normalizer with a higher priority than the non-cacheable
+ * normalizers. This allows caching supportsNormalization calls for scalar values.
+ */
+final class NoOpScalarNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function supportsNormalization($data, $format = null): bool
+    {
+        return is_scalar($data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize($object, $format = null, array $context = [])
+    {
+        return $object;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasCacheableSupportsMethod(): bool
+    {
+        return true;
+    }
+}

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -836,6 +836,7 @@ private function getPartialContainerBuilderProphecy()
             'api_platform.serializer.group_filter',
             'api_platform.serializer.normalizer.item',
             'api_platform.serializer.normalizer.item.non_resource',
+            'api_platform.serializer.normalizer.no_op_scalar',
             'api_platform.serializer.property_filter',
             'api_platform.serializer_locator',
             'api_platform.subresource_data_provider',