fix(metadata): various parameter improvements

Author: soyuka

src/JsonApi/Serializer/ErrorNormalizerTrait.php

@@ -39,15 +39,15 @@ private function getErrorMessage($object, array $context, bool $debug = false):
  private function getErrorCode(object $object): ?string
  {
  if ($object instanceof FlattenException) {
- return (string)$object->getStatusCode();
+ return (string) $object->getStatusCode();
  }
 
  if ($object instanceof \Exception) {
  $code = $object->getCode();
- return $code !== 0 ? (string)$code : null;
+
+ return 0 !== $code ? (string) $code : null;
  }
 
  return null;
  }
 }
-

src/Metadata/Parameter.php

@@ -124,9 +124,9 @@ public function getSecurityMessage(): ?string
  *
  * @readonly
  */
- public function getValue(): mixed
+ public function getValue(mixed $default = new ParameterNotFound()): mixed
  {
- return $this->extraProperties['_api_values'] ?? new ParameterNotFound();
+ return $this->extraProperties['_api_values'] ?? $default;
  }
 
  /**

src/Metadata/Parameters.php

@@ -70,7 +70,7 @@ public function add(string $key, Parameter $value): self
  /**
  * @param class-string $parameterClass
  */
- public function remove(string $key, string $parameterClass): self
+ public function remove(string $key, string $parameterClass = QueryParameter::class): self
  {
  foreach ($this->parameters as $i => [$parameterName, $parameter]) {
  if ($parameterName === $key && $parameterClass === $parameter::class) {
@@ -86,7 +86,7 @@ public function remove(string $key, string $parameterClass): self
  /**
  * @param class-string $parameterClass
  */
- public function get(string $key, string $parameterClass): ?Parameter
+ public function get(string $key, string $parameterClass = QueryParameter::class): ?Parameter
  {
  foreach ($this->parameters as [$parameterName, $parameter]) {
  if ($parameterName === $key && $parameterClass === $parameter::class) {
@@ -100,7 +100,7 @@ public function get(string $key, string $parameterClass): ?Parameter
  /**
  * @param class-string $parameterClass
  */
- public function has(string $key, string $parameterClass): bool
+ public function has(string $key, string $parameterClass = QueryParameter::class): bool
  {
  foreach ($this->parameters as [$parameterName, $parameter]) {
  if ($parameterName === $key && $parameterClass === $parameter::class) {

src/Metadata/Tests/ParameterTest.php

@@ -0,0 +1,28 @@
+<?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\Metadata\Tests;
+
+use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\State\ParameterNotFound;
+use PHPUnit\Framework\TestCase;
+
+class ParameterTest extends TestCase
+{
+ public function testDefaultValue(): void
+ {
+ $parameter = new QueryParameter();
+ $this->assertSame('test', $parameter->getValue('test'));
+ $this->assertSame(new ParameterNotFound(), $parameter->getValue('test'));
+ }
+}

src/Metadata/Tests/ParametersTest.php

@@ -0,0 +1,28 @@
+<?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\Metadata\Tests;
+
+use ApiPlatform\Metadata\Parameters;
+use ApiPlatform\Metadata\QueryParameter;
+use PHPUnit\Framework\TestCase;
+
+class ParametersTest extends TestCase
+{
+ public function testDefaultValue(): void
+ {
+ $r = new QueryParameter();
+ $parameters = new Parameters(['a' => $r]);
+ $this->assertSame($r, $parameters->get('a'));
+ }
+}

src/Symfony/Validator/State/ParameterValidatorProvider.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Symfony\Validator\State;
 
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
 use ApiPlatform\State\ParameterNotFound;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\Util\ParameterParserTrait;
@@ -68,9 +69,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
  $violation->getMessageTemplate(),
  $violation->getParameters(),
  $violation->getRoot(),
- $parameter->getProperty() ?? (
- str_contains($key, ':property') ? str_replace('[:property]', $violation->getPropertyPath(), $key) : $key.$violation->getPropertyPath()
- ),
+ $this->getProperty($parameter, $violation),
  $violation->getInvalidValue(),
  $violation->getPlural(),
  $violation->getCode(),
@@ -86,4 +85,24 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
  return $this->decorated->provide($operation, $uriVariables, $context);
  }
+
+ // There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
+ private function getProperty(Parameter $parameter, ConstraintViolation $violation)
+ {
+ $key = $parameter->getKey();
+
+ if (str_contains($key, '[:property]')) {
+ return str_replace('[:property]', $violation->getPropertyPath(), $key);
+ }
+
+ if (str_contains($key, ':property')) {
+ return str_replace(':property', $violation->getPropertyPath(), $key);
+ }
+
+ if ($p = $violation->getPropertyPath()) {
+ return $p;
+ }
+
+ return $key;
+ }
 }

tests/Fixtures/TestBundle/ApiResource/WithParameter.php

@@ -27,6 +27,7 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Validator\Constraints as Assert;
 
 #[Get(
  uriTemplate: 'with_parameters/{id}{._format}',
@@ -63,6 +64,7 @@
  'array' => new QueryParameter(schema: ['minItems' => 2, 'maxItems' => 3]),
  'multipleOf' => new QueryParameter(schema: ['multipleOf' => 2]),
  'pattern' => new QueryParameter(schema: ['pattern' => '/\d/']),
+ 'int' => new QueryParameter(property: 'a', constraints: [new Assert\Type('integer')], provider: [self::class, 'toInt']),
  ],
  provider: [self::class, 'collectionProvider']
 )]
@@ -132,4 +134,24 @@ public static function headerAndQueryProvider(Operation $operation, array $uriVa
 
  return new JsonResponse($values);
  }
+
+ public static function toInt(Parameter $parameter, array $parameters = [], array $context = []): ?Operation
+ {
+ if (null === ($operation = $context['operation'] ?? null)) {
+ return null;
+ }
+
+ $value = $parameter->getValue();
+
+ if (is_numeric($value)) {
+ $value = (int) $value;
+ }
+
+ $parameters = $operation->getParameters();
+ $parameters->add($parameter->getKey(), $parameter = $parameter->withExtraProperties(
+ $parameter->getExtraProperties() + ['_api_values' => $value]
+ ));
+
+ return $operation->withParameters($parameters);
+ }
 }

tests/Functional/Parameters/ValidationTest.php

@@ -20,7 +20,7 @@ final class ValidationTest extends ApiTestCase
  public function testWithGroupFilter(): void
  {
  $response = self::createClient()->request('GET', 'with_parameters_collection');
- $this->assertArraySubset(['violations' => [['propertyPath' => 'a', 'message' => 'The parameter "hydra" is required.']]], $response->toArray(false));
+ $this->assertArraySubset(['violations' => [['message' => 'The parameter "hydra" is required.']]], $response->toArray(false));
  $response = self::createClient()->request('GET', 'with_parameters_collection?hydra');
  $this->assertResponseIsSuccessful();
  }
@@ -134,4 +134,12 @@ public function testValidatePropertyPlaceholder(): void
  ],
  ], $response->toArray(false));
  }
+
+ public function testValidateMessage(): void
+ {
+ $response = self::createClient()->request('GET', 'validate_parameters?int=test');
+ $this->assertArraySubset([
+ 'detail' => 'int: This value should be of type integer.',
+ ], $response->toArray(false));
+ }
 }