Skip to content

fix(serializer): Use AdvancedNameConverterInterface instead of NameConverterInterface in the AbstractConstraintViolationListNormalizer #5398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2023
Merged

fix(serializer): Use AdvancedNameConverterInterface instead of NameConverterInterface in the AbstractConstraintViolationListNormalizer #5398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Serializer/AbstractConstraintViolationListNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace ApiPlatform\Serializer;

use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
Expand Down Expand Up @@ -56,8 +57,17 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co

foreach ($constraintViolationList as $violation) {
$class = \is_object($root = $violation->getRoot()) ? $root::class : null;

if ($this->nameConverter instanceof AdvancedNameConverterInterface) {
$propertyPath = $this->nameConverter->normalize($violation->getPropertyPath(), $class, static::FORMAT);
} elseif ($this->nameConverter instanceof NameConverterInterface) {
$propertyPath = $this->nameConverter->normalize($violation->getPropertyPath());
} else {
$propertyPath = $violation->getPropertyPath();
}

$violationData = [
'propertyPath' => $this->nameConverter ? $this->nameConverter->normalize($violation->getPropertyPath(), $class, static::FORMAT) : $violation->getPropertyPath(),
'propertyPath' => $propertyPath,
'message' => $violation->getMessage(),
'code' => $violation->getCode(),
];
Expand Down
74 changes: 57 additions & 17 deletions tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\ConstraintViolation;
Expand All @@ -44,17 +45,14 @@ public function testSupportNormalization(): void
}

/**
* @dataProvider payloadFieldsProvider
* @dataProvider nameConverterAndPayloadFieldsProvider
*/
public function testNormalize(?array $fields, array $result): void
public function testNormalize(?object $nameConverter, ?array $fields, array $expected): void
{
$urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
$nameConverterProphecy = $this->prophesize(NameConverterInterface::class);

$urlGeneratorProphecy->generate('api_jsonld_context', ['shortName' => 'ConstraintViolationList'])->willReturn('/context/foo')->shouldBeCalled();
$nameConverterProphecy->normalize(Argument::type('string'), null, Argument::type('string'))->will(fn ($args): string => '_'.$args[0]);

$normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), $fields, $nameConverterProphecy->reveal());
$normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), $fields, $nameConverter);

// Note : we use NotNull constraint and not Constraint class because Constraint is abstract
$constraint = new NotNull();
Expand All @@ -64,7 +62,31 @@ public function testNormalize(?array $fields, array $result): void
new ConstraintViolation('1', '2', [], '3', '4', '5'),
]);

$expected = [
$this->assertSame($expected, $normalizer->normalize($list));
}

public function nameConverterAndPayloadFieldsProvider(): iterable
{
$basicExpectation = [
'@context' => '/context/foo',
'@type' => 'ConstraintViolationList',
'hydra:title' => 'An error occurred',
'hydra:description' => "d: a\n4: 1",
'violations' => [
[
'propertyPath' => 'd',
'message' => 'a',
'code' => 'f24bdbad0becef97a6887238aa58221c',
],
[
'propertyPath' => '4',
'message' => '1',
'code' => null,
],
],
];

$nameConverterBasedExpectation = [
'@context' => '/context/foo',
'@type' => 'ConstraintViolationList',
'hydra:title' => 'An error occurred',
Expand All @@ -82,17 +104,35 @@ public function testNormalize(?array $fields, array $result): void
],
],
];
if ([] !== $result) {
$expected['violations'][0]['payload'] = $result;
}

$this->assertSame($expected, $normalizer->normalize($list));
}
$advancedNameConverterProphecy = $this->prophesize(AdvancedNameConverterInterface::class);
$advancedNameConverterProphecy->normalize(Argument::type('string'), null, Argument::type('string'))->will(fn ($args): string => '_'.$args[0]);
$advancedNameConverter = $advancedNameConverterProphecy->reveal();

public function payloadFieldsProvider(): iterable
{
yield [['severity', 'anotherField1'], ['severity' => 'warning']];
yield [null, ['severity' => 'warning', 'anotherField2' => 'aValue']];
yield [[], []];
$nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
$nameConverterProphecy->normalize(Argument::type('string'))->will(fn ($args): string => '_'.$args[0]);
$nameConverter = $nameConverterProphecy->reveal();

$nullNameConverter = null;

$expected = $nameConverterBasedExpectation;
$expected['violations'][0]['payload'] = ['severity' => 'warning'];
yield [$advancedNameConverter, ['severity', 'anotherField1'], $expected];
yield [$nameConverter, ['severity', 'anotherField1'], $expected];
$expected = $basicExpectation;
$expected['violations'][0]['payload'] = ['severity' => 'warning'];
yield [$nullNameConverter, ['severity', 'anotherField1'], $expected];

$expected = $nameConverterBasedExpectation;
$expected['violations'][0]['payload'] = ['severity' => 'warning', 'anotherField2' => 'aValue'];
yield [$advancedNameConverter, null, $expected];
yield [$nameConverter, null, $expected];
$expected = $basicExpectation;
$expected['violations'][0]['payload'] = ['severity' => 'warning', 'anotherField2' => 'aValue'];
yield [$nullNameConverter, null, $expected];

yield [$advancedNameConverter, [], $nameConverterBasedExpectation];
yield [$nameConverter, [], $nameConverterBasedExpectation];
yield [$nullNameConverter, [], $basicExpectation];
}
}
47 changes: 41 additions & 6 deletions tests/Problem/Serializer/ConstraintViolationNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\ConstraintViolation;
Expand All @@ -40,12 +41,12 @@ public function testSupportNormalization(): void
$this->assertTrue($normalizer->hasCacheableSupportsMethod());
}

public function testNormalize(): void
/**
* @dataProvider nameConverterProvider
*/
public function testNormalize(object|null $nameConverter, array $expected): void
{
$nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
$normalizer = new ConstraintViolationListNormalizer(['severity', 'anotherField1'], $nameConverterProphecy->reveal());

$nameConverterProphecy->normalize(Argument::type('string'), null, Argument::type('string'))->will(fn ($args) => '_'.$args[0]);
$normalizer = new ConstraintViolationListNormalizer(['severity', 'anotherField1'], $nameConverter);

// Note : we use NotNull constraint and not Constraint class because Constraint is abstract
$constraint = new NotNull();
Expand All @@ -55,6 +56,11 @@ public function testNormalize(): void
new ConstraintViolation('1', '2', [], '3', '4', '5'),
]);

$this->assertSame($expected, $normalizer->normalize($list));
}

public function nameConverterProvider(): iterable
{
$expected = [
'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
'title' => 'An error occurred',
Expand All @@ -75,6 +81,35 @@ public function testNormalize(): void
],
],
];
$this->assertSame($expected, $normalizer->normalize($list));

$nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
$nameConverterProphecy->normalize(Argument::type('string'))->will(fn ($args) => '_'.$args[0]);
yield [$nameConverterProphecy->reveal(), $expected];

$nameConverterProphecy = $this->prophesize(AdvancedNameConverterInterface::class);
$nameConverterProphecy->normalize(Argument::type('string'), null, Argument::type('string'))->will(fn ($args) => '_'.$args[0]);
yield [$nameConverterProphecy->reveal(), $expected];

$expected = [
'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
'title' => 'An error occurred',
'detail' => "d: a\n4: 1",
'violations' => [
[
'propertyPath' => 'd',
'message' => 'a',
'code' => 'f24bdbad0becef97a6887238aa58221c',
'payload' => [
'severity' => 'warning',
],
],
[
'propertyPath' => '4',
'message' => '1',
'code' => null,
],
],
];
yield [null, $expected];
}
}