fix(hydra): hydra_prefix on errors (#6704)

* fix(hydra): hydra_prefix on errors * doc: remove warning from changelog * review

Author: soyuka

CHANGELOG.md

@@ -12,9 +12,6 @@
 * [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 not exist
@@ -47,6 +49,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 <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\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/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" />