16530614392

Committed 25 Jul 2025 08:04PM UTC coverage: 22.07%. Remained the same

Build # 16530614392

Build Type

push

github

Committed by

web-flow

Commit Message

fix(symfony): explicitly set the target class when mapping entities to resources (#7311)

Run Details

3 of 3 new or added lines in 2 files covered. (100.0%)

125 existing lines in 11 files now uncovered.

11573 of 52437 relevant lines covered (22.07%)

23.54 hits per line

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

100.0

/src/Symfony/EventListener/DeserializeListener.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\Symfony\EventListener;

use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\SerializerContextBuilderInterface;
use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
use ApiPlatform\State\Util\RequestAttributesExtractor;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;

/**
 * Updates the entity retrieved by the data provider with data contained in the request body.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class DeserializeListener
{
    use OperationRequestInitiatorTrait;

    public const OPERATION_ATTRIBUTE_KEY = 'deserialize';

    /**
     * @param ProviderInterface<object> $provider
     */
    public function __construct(
        private ProviderInterface $provider,
        ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null,
    ) {
        $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
    }

    /**
     * Deserializes the data sent in the requested format.
     *
     * @throws UnsupportedMediaTypeHttpException
     */
    public function onKernelRequest(RequestEvent $event): void
    {
        $request = $event->getRequest();
        $method = $request->getMethod();
        $operation = $this->initializeOperation($request);

        if (
            !($attributes = RequestAttributesExtractor::extractAttributes($request))
            || !$attributes['receive']
            || !$operation
        ) {
            return;
        }

        if (null === $operation->canDeserialize()) {
            $operation = $operation->withDeserialize(\in_array($method, ['POST', 'PUT', 'PATCH'], true));
        }

        $denormalizationContext = $operation->getDenormalizationContext() ?? [];
        if ($operation->canDeserialize() && !isset($denormalizationContext[SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE])) {
            $method = $operation->getMethod();
            $assignObjectToPopulate = 'POST' === $method
                || 'PATCH' === $method
                || ('PUT' === $method && !($operation->getExtraProperties()['standard_put'] ?? true));

            $operation = $operation->withDenormalizationContext($denormalizationContext + [SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE => $assignObjectToPopulate]);
        }

        if (!$operation->canDeserialize()) {
            return;
        }

        $data = $this->provider->provide($operation, $request->attributes->get('_api_uri_variables') ?? [], [
            'request' => $request,
            'uri_variables' => $request->attributes->get('_api_uri_variables') ?? [],
            'resource_class' => $operation->getClass(),
        ]);

        $request->attributes->set('data', $data);
    }
}

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\Symfony\EventListener;
15
16	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
17	use ApiPlatform\State\ProviderInterface;
18	use ApiPlatform\State\SerializerContextBuilderInterface;
19	use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
20	use ApiPlatform\State\Util\RequestAttributesExtractor;
21	use Symfony\Component\HttpKernel\Event\RequestEvent;
22	use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
23
24	/**
25	* Updates the entity retrieved by the data provider with data contained in the request body.
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class DeserializeListener
30	{
31	use OperationRequestInitiatorTrait;
32
33	public const OPERATION_ATTRIBUTE_KEY = 'deserialize';
34
35	/**
36	* @param ProviderInterface<object> $provider
37	*/
38	public function __construct(
39	private ProviderInterface $provider,
40	?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null,
41	) {
UNCOV 42	$this->resourceMetadataCollectionFactory = $resourceMetadataFactory;	294✔
43	}
44
45	/**
46	* Deserializes the data sent in the requested format.
47	*
48	* @throws UnsupportedMediaTypeHttpException
49	*/
50	public function onKernelRequest(RequestEvent $event): void
51	{
UNCOV 52	$request = $event->getRequest();	294✔
UNCOV 53	$method = $request->getMethod();	294✔
UNCOV 54	$operation = $this->initializeOperation($request);	294✔
55
56	if (
UNCOV 57	!($attributes = RequestAttributesExtractor::extractAttributes($request))	294✔
UNCOV 58	\|\| !$attributes['receive']	294✔
UNCOV 59	\|\| !$operation	294✔
60	) {
UNCOV 61	return;	31✔
62	}
63
UNCOV 64	if (null === $operation->canDeserialize()) {	265✔
UNCOV 65	$operation = $operation->withDeserialize(\in_array($method, ['POST', 'PUT', 'PATCH'], true));	265✔
66	}
67
UNCOV 68	$denormalizationContext = $operation->getDenormalizationContext() ?? [];	265✔
UNCOV 69	if ($operation->canDeserialize() && !isset($denormalizationContext[SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE])) {	265✔
UNCOV 70	$method = $operation->getMethod();	10✔
UNCOV 71	$assignObjectToPopulate = 'POST' === $method	10✔
UNCOV 72	\|\| 'PATCH' === $method	10✔
UNCOV 73	\|\| ('PUT' === $method && !($operation->getExtraProperties()['standard_put'] ?? true));	10✔
74
UNCOV 75	$operation = $operation->withDenormalizationContext($denormalizationContext + [SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE => $assignObjectToPopulate]);	10✔
76	}
77
UNCOV 78	if (!$operation->canDeserialize()) {	265✔
UNCOV 79	return;	259✔
80	}
81
UNCOV 82	$data = $this->provider->provide($operation, $request->attributes->get('_api_uri_variables') ?? [], [	10✔
UNCOV 83	'request' => $request,	10✔
UNCOV 84	'uri_variables' => $request->attributes->get('_api_uri_variables') ?? [],	10✔
UNCOV 85	'resource_class' => $operation->getClass(),	10✔
UNCOV 86	]);	10✔
87
UNCOV 88	$request->attributes->set('data', $data);	8✔
89	}
90	}

api-platform / core / 16530614392

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