Merge 3.4

Author: soyuka

CHANGELOG.md

@@ -142,9 +142,6 @@ Notes:
 * [afe7d47d7](https://github.com/api-platform/core/commit/afe7d47d7b7ba6c8591bfb60137a65d1fa1fe38f) fix(metadata): passing class as parameter in XML ApiResource's definition (#6659)
 * [b93ee467c](https://github.com/api-platform/core/commit/b93ee467c69253e0cfe60e75b48a5c7aa683474a) fix(metadata): overwriting XML ApiResource definition by YAML ApiResource definition (#6660)
 
-> [!WARNING]
-> Hydra prefix on errors is breaking, read `title` not `hydra:title`. The `hydra_prefix` flag doesn't apply to errors as it provided redundant information (both `hydra:title` and `title` were available)
-
 ## v3.4.1
 
 ### Bug fixes

features/hydra/error.feature

@@ -17,8 +17,10 @@ Feature: Error handling
     And the header "Link" should contain '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error"'
     And the JSON node "type" should exist
     And the JSON node "title" should be equal to "An error occurred"
+    And the JSON node "hydra:title" should be equal to "An error occurred"
     And the JSON node "detail" should exist
     And the JSON node "description" should exist
+    And the JSON node "hydra:description" should exist
     And the JSON node "trace" should exist
     And the JSON node "status" should exist
     And the JSON node "@context" should exist
@@ -48,6 +50,8 @@ Feature: Error handling
           ],
           "detail": "name: This value should not be blank.",
           "title": "An error occurred",
+          "hydra:title": "An error occurred",
+          "hydra:description": "name: This value should not be blank.",
           "description": "name: This value should not be blank.",
           "type": "/validation_errors/c1051bb4-d103-4f74-8988-acbcafc7fdc3"
       }

src/JsonLd/ContextBuilder.php

@@ -14,7 +14,6 @@
 namespace ApiPlatform\JsonLd;
 
 use ApiPlatform\JsonLd\Serializer\HydraPrefixTrait;
-use ApiPlatform\Metadata\Error;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\IriConverterInterface;
@@ -185,7 +184,7 @@ private function getResourceContextWithShortname(string $resourceClass, int $ref
             }
         }
 
-        if (false === ($this->defaultContext[self::HYDRA_CONTEXT_HAS_PREFIX] ?? true) || $operation instanceof Error) {
+        if (false === ($this->defaultContext[self::HYDRA_CONTEXT_HAS_PREFIX] ?? true)) {
             return ['http://www.w3.org/ns/hydra/context.jsonld', $context];
         }
 

src/JsonLd/Serializer/ErrorNormalizer.php

@@ -0,0 +1,58 @@
+<?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\JsonLd\Serializer;
+
+use ApiPlatform\State\ApiResource\Error;
+use ApiPlatform\Symfony\Validator\Exception\ValidationException as SymfonyValidationException;
+use ApiPlatform\Validator\Exception\ValidationException;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+final class ErrorNormalizer implements NormalizerInterface
+{
+    use HydraPrefixTrait;
+
+    public function __construct(private readonly NormalizerInterface $inner, private readonly array $defaultContext = [])
+    {
+    }
+
+    public function normalize(mixed $object, ?string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
+    {
+        $normalized = $this->inner->normalize($object, $format, $context);
+        $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);
+        if (!$hydraPrefix) {
+            return $normalized;
+        }
+
+        if (isset($normalized['description'])) {
+            $normalized['hydra:description'] = $normalized['description'];
+        }
+
+        if (isset($normalized['title'])) {
+            $normalized['hydra:title'] = $normalized['title'];
+        }
+
+        return $normalized;
+    }
+
+    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
+    {
+        return $this->inner->supportsNormalization($data, $format, $context)
+            && (is_a($data, Error::class) || is_a($data, ValidationException::class) || is_a($data, SymfonyValidationException::class));
+    }
+
+    public function getSupportedTypes(?string $format): array
+    {
+        return $this->inner->getSupportedTypes($format);
+    }
+}

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -34,6 +34,7 @@
 use ApiPlatform\Metadata\FilterInterface;
 use ApiPlatform\Metadata\UriVariableTransformerInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
+use ApiPlatform\RamseyUuid\Serializer\UuidDenormalizer;
 use ApiPlatform\State\ApiResource\Error;
 use ApiPlatform\State\ParameterProviderInterface;
 use ApiPlatform\State\ProcessorInterface;
@@ -180,7 +181,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
         $loader->load('api.xml');
         $loader->load('filter.xml');
 
-        if (class_exists(Uuid::class)) {
+        if (class_exists(UuidDenormalizer::class) && class_exists(Uuid::class)) {
             $loader->load('ramsey_uuid.xml');
         }
 

src/Symfony/Bundle/DependencyInjection/Compiler/MetadataAwareNameConverterPass.php

@@ -39,14 +39,20 @@ public function process(ContainerBuilder $container): void
         }
 
         $definition = $container->getDefinition('serializer.name_converter.metadata_aware');
-        $num = \count($definition->getArguments());
+        $key = '$fallbackNameConverter';
+        $arguments = $definition->getArguments();
+        if (false === \array_key_exists($key, $arguments)) {
+            $key = 1;
+        }
 
         if ($container->hasAlias('api_platform.name_converter')) {
             $nameConverter = new Reference((string) $container->getAlias('api_platform.name_converter'));
-            if (1 === $num) {
+
+            // old symfony versions
+            if (false === \array_key_exists($key, $arguments)) {
                 $definition->addArgument($nameConverter);
-            } elseif (1 < $num && null === $definition->getArgument(1)) {
-                $definition->setArgument(1, $nameConverter);
+            } elseif (null === $definition->getArgument($key)) {
+                $definition->setArgument($key, $nameConverter);
             }
         }
 

src/Symfony/Bundle/Resources/config/hydra.xml

@@ -25,6 +25,7 @@
         <service id="api_platform.hydra.normalizer.constraint_violation_list" class="ApiPlatform\Hydra\Serializer\ConstraintViolationListNormalizer" public="false">
             <argument>%api_platform.validator.serialize_payload_fields%</argument>
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
+            <argument>%api_platform.serializer.default_context%</argument>
 
             <tag name="serializer.normalizer" priority="-780" />
         </service>

src/Symfony/Bundle/Resources/config/jsonld.xml

@@ -36,6 +36,12 @@
             <tag name="serializer.normalizer" priority="-890" />
         </service>
 
+        <service id="api_platform.jsonld.normalizer.error" class="ApiPlatform\JsonLd\Serializer\ErrorNormalizer" public="false">
+            <argument type="service" id="api_platform.jsonld.normalizer.item" />
+            <argument>%api_platform.serializer.default_context%</argument>
+            <tag name="serializer.normalizer" priority="-880" />
+        </service>
+
         <service id="api_platform.jsonld.normalizer.object" class="ApiPlatform\JsonLd\Serializer\ObjectNormalizer" public="false">
             <argument type="service" id="serializer.normalizer.object" />
             <argument type="service" id="api_platform.iri_converter" />
@@ -46,7 +52,7 @@
         </service>
 
         <service id="api_platform.jsonld.normalizer.validation_exception" class="ApiPlatform\Symfony\Validator\Serializer\ValidationExceptionNormalizer" public="false">
-            <argument type="service" id="api_platform.jsonld.normalizer.item" />
+            <argument type="service" id="api_platform.jsonld.normalizer.error" />
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
 
             <tag name="serializer.normalizer" priority="-800" />

src/Symfony/composer.json

@@ -65,10 +65,10 @@
         "api-platform/doctrine-odm": "To support MongoDB. Only versions 4.0 and later are supported.",
         "api-platform/elasticsearch": "To support Elasticsearch.",
         "api-platform/graphql": "To support GraphQL.",
+        "api-platform/ramsey-uuid": "To support Ramsey's UUID identifiers.",
         "ocramius/package-versions": "To display the API Platform's version in the debug bar.",
         "phpstan/phpdoc-parser": "To support extracting metadata from PHPDoc.",
         "psr/cache-implementation": "To use metadata caching.",
-        "ramsey/uuid": "To support Ramsey's UUID identifiers.",
         "symfony/cache": "To have metadata caching when using Symfony integration.",
         "symfony/config": "To load XML configuration files.",
         "symfony/expression-language": "To use authorization and mercure advanced features.",

tests/Symfony/Bundle/DependencyInjection/Compiler/MetadataAwareNameConverterPassTest.php

@@ -101,4 +101,23 @@ public function testProcessOnlyOneArg(): void
 
         $pass->process($containerBuilderProphecy->reveal());
     }
+
+    public function testProcessWithAbstractMetadataAware(): void
+    {
+        $pass = new MetadataAwareNameConverterPass();
+
+        $definition = $this->prophesize(Definition::class);
+        $definition->getArguments()->willReturn(['$metadataFactory' => [], '$fallbackNameConverter' => null])->shouldBeCalled();
+        $definition->getArgument('$fallbackNameConverter')->willReturn(null)->shouldBeCalled();
+        $definition->setArgument('$fallbackNameConverter', new Reference('app.name_converter'))->willReturn($definition)->shouldBeCalled();
+
+        $containerBuilderProphecy = $this->prophesize(ContainerBuilder::class);
+        $containerBuilderProphecy->hasDefinition('serializer.name_converter.metadata_aware')->willReturn(true)->shouldBeCalled();
+        $containerBuilderProphecy->hasAlias('api_platform.name_converter')->shouldBeCalled()->willReturn(true);
+        $containerBuilderProphecy->getAlias('api_platform.name_converter')->shouldBeCalled()->willReturn(new Alias('app.name_converter'));
+        $containerBuilderProphecy->setAlias('api_platform.name_converter', 'serializer.name_converter.metadata_aware')->shouldBeCalled();
+        $containerBuilderProphecy->getDefinition('serializer.name_converter.metadata_aware')->shouldBeCalled()->willReturn($definition);
+
+        $pass->process($containerBuilderProphecy->reveal());
+    }
 }