fix(hydra): error hydra prefix (#6599)

Author: soyuka

features/hydra/error.feature

@@ -120,3 +120,21 @@ Feature: Error handling
  And the JSON node "title" should be equal to "An error occurred"
  And the JSON node "detail" should exist
  And the JSON node "violations" should exist
+
+ Scenario: Get an rfc 7807 error
+ When I add "Content-Type" header equal to "application/ld+json"
+ And I send a "POST" request to "/exception_problems_without_prefix" with body:
+ """
+ {}
+ """
+ Then the response status code should be 400
+ And the response should be in JSON
+ And the header "Content-Type" should be equal to "application/problem+json; charset=utf-8"
+ 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 "detail" should exist
+ And the JSON node "description" should exist
+ And the JSON node "trace" should exist
+ And the JSON node "status" should exist
+ And the JSON node "@context" should not exist

src/Hydra/Serializer/ErrorNormalizer.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Hydra\Serializer;
 
 use ApiPlatform\Api\UrlGeneratorInterface as LegacyUrlGeneratorInterface;
+use ApiPlatform\JsonLd\Serializer\HydraPrefixTrait;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use ApiPlatform\State\ApiResource\Error;
@@ -32,6 +33,7 @@
 final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
  use ErrorNormalizerTrait;
+ use HydraPrefixTrait;
 
  public const FORMAT = 'jsonld';
  public const TITLE = 'title';
@@ -47,11 +49,12 @@ public function __construct(private readonly LegacyUrlGeneratorInterface|UrlGene
  */
  public function normalize(mixed $object, ?string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
  {
+ $hydraPrefix = $this->getHydraPrefix($context);
  $data = [
  '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Error']),
- '@type' => 'hydra:Error',
- 'hydra:title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
- 'hydra:description' => $this->getErrorMessage($object, $context, $this->debug),
+ '@type' => $hydraPrefix.'Error',
+ $hydraPrefix.'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
+ $hydraPrefix.'description' => $this->getErrorMessage($object, $context, $this->debug),
  ];
 
  if ($this->debug && null !== $trace = $object->getTrace()) {

src/Hydra/Serializer/HydraPrefixNameConverter.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\Hydra\Serializer;
+
+use ApiPlatform\JsonLd\ContextBuilder;
+use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+final class HydraPrefixNameConverter implements NameConverterInterface, AdvancedNameConverterInterface
+{
+ public function __construct(private readonly NameConverterInterface $nameConverter)
+ {
+ }
+
+ public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string
+ {
+ $name = $this->nameConverter->normalize($propertyName, $class, $format, $context);
+
+ if (true === ($context[ContextBuilder::HYDRA_CONTEXT_HAS_PREFIX] ?? true)) {
+ return $name;
+ }
+
+ return str_starts_with($name, ContextBuilder::HYDRA_PREFIX) ? str_replace(ContextBuilder::HYDRA_PREFIX, '', $name) : $name;
+ }
+
+ public function denormalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string
+ {
+ return $this->nameConverter->denormalize($propertyName, $class, $format, $context);
+ }
+}

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

@@ -76,6 +76,9 @@
  <argument on-invalid="ignore">%api_platform.serializer.default_context%</argument>
  </service>
 
+ <service id="api_platform.hydra.name_converter.hydra_prefix" class="ApiPlatform\Hydra\Serializer\HydraPrefixNameConverter" decorates="api_platform.name_converter">
+ <argument type="service" id="api_platform.hydra.name_converter.hydra_prefix.inner" />
+ </service>
  </services>
 
 </container>

src/Symfony/EventListener/ErrorListener.php

@@ -110,7 +110,7 @@ protected function duplicateRequest(\Throwable $exception, Request $request): Re
  $operation = $operation->withProvider('api_platform.state.error_provider');
  }
 
- $normalizationContext = $operation->getNormalizationContext() ?? [];
+ $normalizationContext = ($operation->getNormalizationContext() ?? []) + ($apiOperation?->getNormalizationContext() ?? []);
  if (!($normalizationContext['api_error_resource'] ?? false)) {
  $normalizationContext += ['api_error_resource' => true];
  }

tests/Fixtures/TestBundle/ApiResource/ValidationExceptionProblem.php

@@ -21,6 +21,7 @@
 #[Post(processor: [ValidationExceptionProblem::class, 'provide'])]
 #[Post(uriTemplate: '/exception_problems', processor: [ValidationExceptionProblem::class, 'provideException'])]
 #[Post(uriTemplate: '/exception_problems_with_compatibility', processor: [ValidationExceptionProblem::class, 'provideException'], extraProperties: ['rfc_7807_compliant_errors' => false])]
+#[Post(uriTemplate: '/exception_problems_without_prefix', normalizationContext: ['hydra_prefix' => false], processor: [ValidationExceptionProblem::class, 'provideException'], extraProperties: ['rfc_7807_compliant_errors' => true])]
 class ValidationExceptionProblem
 {
  public static function provide(): void