15133993414

Committed 20 May 2025 09:30AM UTC coverage: 26.313% (-1.2%) from 27.493%

Build # 15133993414

Build Type

Pull #7161

github

Committed by

web-flow

Commit Message

Merge e2c03d45f into 5459ba375

Pull Request Pull Request #7161: fix(metadata): infer parameter string type from schema

Run Details

0 of 2 new or added lines in 1 file covered. (0.0%)

11019 existing lines in 363 files now uncovered.

12898 of 49018 relevant lines covered (26.31%)

34.33 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

7.41

/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php

<?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\JsonApi\Serializer;

use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/**
 * Converts {@see ConstraintViolationListInterface} to a JSON API error representation.
 *
 * @author Héctor Hurtarte <hectorh30@gmail.com>
 */
final class ConstraintViolationListNormalizer implements NormalizerInterface
{
    public const FORMAT = 'jsonapi';

    public function __construct(private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null)
    {
    }

    /**
     * {@inheritdoc}
     */
    public function normalize(mixed $object, ?string $format = null, array $context = []): array
    {
        $violations = [];
        foreach ($object as $violation) {
            $violations[] = [
                'detail' => $violation->getMessage(),
                'source' => [
                    'pointer' => $this->getSourcePointerFromViolation($violation),
                ],
            ];
        }

        return ['errors' => $violations];
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
    {
        return self::FORMAT === $format && $data instanceof ConstraintViolationListInterface;
    }

    public function getSupportedTypes($format): array
    {
        return self::FORMAT === $format ? [ConstraintViolationListInterface::class => true] : [];
    }

    private function getSourcePointerFromViolation(ConstraintViolationInterface $violation): string
    {
        $fieldName = $violation->getPropertyPath();

        if (!$fieldName) {
            return 'data';
        }

        $class = $violation->getRoot()::class;
        $propertyMetadata = $this->propertyMetadataFactory
            ->create(
                // Im quite sure this requires some thought in case of validations over relationships
                $class,
                $fieldName
            );

        if (null !== $this->nameConverter) {
            $fieldName = $this->nameConverter->normalize($fieldName, $class, self::FORMAT);
        }

        $type = $propertyMetadata->getBuiltinTypes()[0] ?? null;
        if ($type && null !== $type->getClassName()) {
            return "data/relationships/$fieldName";
        }

        return "data/attributes/$fieldName";
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\JsonApi\Serializer;
15
16	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
17	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
18	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
19	use Symfony\Component\Validator\ConstraintViolationInterface;
20	use Symfony\Component\Validator\ConstraintViolationListInterface;
21
22	/**
23	* Converts {@see ConstraintViolationListInterface} to a JSON API error representation.
24	*
25	* @author Héctor Hurtarte <hectorh30@gmail.com>
26	*/
27	final class ConstraintViolationListNormalizer implements NormalizerInterface
28	{
29	public const FORMAT = 'jsonapi';
30
31	public function __construct(private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null)
32	{
UNCOV 33	}	950✔
34
35	/**
36	* {@inheritdoc}
37	*/
38	public function normalize(mixed $object, ?string $format = null, array $context = []): array
39	{
40	$violations = [];	×
41	foreach ($object as $violation) {	×
42	$violations[] = [	×
43	'detail' => $violation->getMessage(),	×
44	'source' => [	×
45	'pointer' => $this->getSourcePointerFromViolation($violation),	×
46	],	×
47	];	×
48	}
49
50	return ['errors' => $violations];	×
51	}
52
53	/**
54	* {@inheritdoc}
55	*/
56	public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
57	{
58	return self::FORMAT === $format && $data instanceof ConstraintViolationListInterface;	×
59	}
60
61	public function getSupportedTypes($format): array
62	{
UNCOV 63	return self::FORMAT === $format ? [ConstraintViolationListInterface::class => true] : [];	890✔
64	}
65
66	private function getSourcePointerFromViolation(ConstraintViolationInterface $violation): string
67	{
68	$fieldName = $violation->getPropertyPath();	×
69
70	if (!$fieldName) {	×
71	return 'data';	×
72	}
73
74	$class = $violation->getRoot()::class;	×
75	$propertyMetadata = $this->propertyMetadataFactory	×
76	->create(	×
77	// Im quite sure this requires some thought in case of validations over relationships
78	$class,	×
79	$fieldName	×
80	);	×
81
82	if (null !== $this->nameConverter) {	×
83	$fieldName = $this->nameConverter->normalize($fieldName, $class, self::FORMAT);	×
84	}
85
86	$type = $propertyMetadata->getBuiltinTypes()[0] ?? null;	×
87	if ($type && null !== $type->getClassName()) {	×
88	return "data/relationships/$fieldName";	×
89	}
90
91	return "data/attributes/$fieldName";	×
92	}
93	}

api-platform / core / 15133993414

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous