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

93.1

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

use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;

/**
 * @see http://jsonapi.org/format/#fetching-sparse-fieldsets
 * @see https://api-platform.com/docs/core/filters#property-filter
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class TransformFieldsetsParametersListener
{
    public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
    {
    }

    public function onKernelRequest(RequestEvent $event): void
    {
        $request = $event->getRequest();
        if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {
            return;
        }

        $queryParameters = $request->query->all();
        $includeParameter = $queryParameters['include'] ?? null;
        $fieldsParameter = $queryParameters['fields'] ?? null;

        if (
            (!$fieldsParameter && !$includeParameter)
            || ($fieldsParameter && !\is_array($fieldsParameter))
            || (!\is_string($includeParameter))
            || 'jsonapi' !== $request->getRequestFormat()
            || !($resourceClass = $request->attributes->get('_api_resource_class'))
        ) {
            return;
        }

        $includeParameter = explode(',', $includeParameter);
        if (!$fieldsParameter) {
            $request->attributes->set('_api_included', $includeParameter);

            return;
        }

        $resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);
        $resourceShortName = $resourceMetadata->getOperation()->getShortName();

        $properties = [];
        foreach ($fieldsParameter as $resourceType => $fields) {
            $fields = explode(',', (string) $fields);

            if ($resourceShortName === $resourceType) {
                $properties = array_merge($properties, $fields);
            } elseif (\in_array($resourceType, $includeParameter, true)) {
                $properties[$resourceType] = $fields;

                $request->attributes->set('_api_included', array_merge($request->attributes->get('_api_included', []), [$resourceType]));
            } else {
                $properties[$resourceType] = $fields;
            }
        }

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

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\JsonApi;
15
16	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
17	use Symfony\Component\HttpKernel\Event\RequestEvent;
18
19	/**
20	* @see http://jsonapi.org/format/#fetching-sparse-fieldsets
21	* @see https://api-platform.com/docs/core/filters#property-filter
22	*
23	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
24	*/
25	final class TransformFieldsetsParametersListener
26	{
27	public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
28	{
UNCOV 29	}	5✔
30
31	public function onKernelRequest(RequestEvent $event): void
32	{
UNCOV 33	$request = $event->getRequest();	5✔
UNCOV 34	if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {	5✔
35	return;	×
36	}
37
UNCOV 38	$queryParameters = $request->query->all();	5✔
UNCOV 39	$includeParameter = $queryParameters['include'] ?? null;	5✔
UNCOV 40	$fieldsParameter = $queryParameters['fields'] ?? null;	5✔
41
42	if (
UNCOV 43	(!$fieldsParameter && !$includeParameter)	5✔
UNCOV 44	\|\| ($fieldsParameter && !\is_array($fieldsParameter))	5✔
UNCOV 45	\|\| (!\is_string($includeParameter))	5✔
UNCOV 46	\|\| 'jsonapi' !== $request->getRequestFormat()	5✔
UNCOV 47	\|\| !($resourceClass = $request->attributes->get('_api_resource_class'))	5✔
48	) {
UNCOV 49	return;	3✔
50	}
51
UNCOV 52	$includeParameter = explode(',', $includeParameter);	2✔
UNCOV 53	if (!$fieldsParameter) {	2✔
UNCOV 54	$request->attributes->set('_api_included', $includeParameter);	1✔
55
UNCOV 56	return;	1✔
57	}
58
UNCOV 59	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	1✔
UNCOV 60	$resourceShortName = $resourceMetadata->getOperation()->getShortName();	1✔
61
UNCOV 62	$properties = [];	1✔
UNCOV 63	foreach ($fieldsParameter as $resourceType => $fields) {	1✔
UNCOV 64	$fields = explode(',', (string) $fields);	1✔
65
UNCOV 66	if ($resourceShortName === $resourceType) {	1✔
UNCOV 67	$properties = array_merge($properties, $fields);	1✔
UNCOV 68	} elseif (\in_array($resourceType, $includeParameter, true)) {	1✔
UNCOV 69	$properties[$resourceType] = $fields;	1✔
70
UNCOV 71	$request->attributes->set('_api_included', array_merge($request->attributes->get('_api_included', []), [$resourceType]));	1✔
72	} else {
73	$properties[$resourceType] = $fields;	×
74	}
75	}
76
UNCOV 77	$request->attributes->set('_api_filter_property', $properties);	1✔
78	}
79	}

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