19030958938

Committed 03 Nov 2025 10:10AM UTC coverage: 24.017%. First build

Build # 19030958938

Build Type

Pull #7500

github

Committed by

web-flow

Commit Message

Merge 7da1eef28 into 07d0ef86e

Pull Request Pull Request #7500: feat(symfony): isGranted before provider

Run Details

35 of 41 new or added lines in 3 files covered. (85.37%)

13784 of 57393 relevant lines covered (24.02%)

13.25 hits per line

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

94.74

/src/Symfony/Security/State/AccessCheckerProvider.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\Security\State;

use ApiPlatform\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
use ApiPlatform\Metadata\GraphQl\QueryCollection;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\Symfony\Security\Exception\AccessDeniedException;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;

/**
 * Allows access based on the ApiPlatform\Metadata\ResourceAccessCheckerInterface.
 * This implementation covers GraphQl and HTTP.
 *
 * @see ResourceAccessCheckerInterface
 */
final class AccessCheckerProvider implements ProviderInterface
{
    public function __construct(private readonly ProviderInterface $decorated, private readonly ResourceAccessCheckerInterface $resourceAccessChecker, private readonly ?string $event = null)
    {
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        switch ($this->event) {
            case 'post_denormalize':
                $isGranted = $operation->getSecurityPostDenormalize();
                $message = $operation->getSecurityPostDenormalizeMessage();
                break;
            case 'post_validate':
                $isGranted = $operation->getSecurityPostValidation();
                $message = $operation->getSecurityPostValidationMessage();
                break;
            case 'after_resolver':
                if (!$operation instanceof GraphQlOperation) {
                    throw new RuntimeException('Not a graphql operation');
                }

                $isGranted = $operation->getSecurityAfterResolver();
                $message = $operation->getSecurityMessageAfterResolver();
                break;
            default:
                $isGranted = $operation->getSecurity();
                $message = $operation->getSecurityMessage();
        }

        if (
            null === $isGranted
            // On a GraphQl QueryCollection we want to perform security stage only on the top-level query
            || ($operation instanceof QueryCollection && null !== ($context['source'] ?? null))
        ) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $body = 'pre_read' === $this->event ? null : $this->decorated->provide($operation, $uriVariables, $context);

        if ($operation instanceof HttpOperation) {
            $request = $context['request'] ?? null;

            $resourceAccessCheckerContext = [
                'object' => $body,
                'previous_object' => $request?->attributes->get('previous_data'),
                'request' => $request,
            ];
        } else {
            $resourceAccessCheckerContext = [
                'object' => $body,
                'previous_object' => $context['graphql_context']['previous_object'] ?? null,
            ];
        }

        if ('pre_read' === $this->event && $this->resourceAccessChecker->usesObjectVariable($isGranted, $resourceAccessCheckerContext)) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        if (!$this->resourceAccessChecker->isGranted($operation->getClass(), $isGranted, $resourceAccessCheckerContext)) {
            $operation instanceof GraphQlOperation ? throw new AccessDeniedHttpException($message ?? 'Access Denied.') : throw new AccessDeniedException($message ?? 'Access Denied.');
        }

        return 'pre_read' === $this->event ? $this->decorated->provide($operation, $uriVariables, $context) : $body;
    }
}

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\Security\State;
15
16	use ApiPlatform\Metadata\Exception\RuntimeException;
17	use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
18	use ApiPlatform\Metadata\GraphQl\QueryCollection;
19	use ApiPlatform\Metadata\HttpOperation;
20	use ApiPlatform\Metadata\Operation;
21	use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
22	use ApiPlatform\State\ProviderInterface;
23	use ApiPlatform\Symfony\Security\Exception\AccessDeniedException;
24	use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
25
26	/**
27	* Allows access based on the ApiPlatform\Metadata\ResourceAccessCheckerInterface.
28	* This implementation covers GraphQl and HTTP.
29	*
30	* @see ResourceAccessCheckerInterface
31	*/
32	final class AccessCheckerProvider implements ProviderInterface
33	{
34	public function __construct(private readonly ProviderInterface $decorated, private readonly ResourceAccessCheckerInterface $resourceAccessChecker, private readonly ?string $event = null)
35	{
36	}	355✔
37
38	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
39	{
40	switch ($this->event) {	355✔
41	case 'post_denormalize':	355✔
42	$isGranted = $operation->getSecurityPostDenormalize();	351✔
43	$message = $operation->getSecurityPostDenormalizeMessage();	351✔
44	break;	351✔
45	case 'post_validate':	354✔
46	$isGranted = $operation->getSecurityPostValidation();	351✔
47	$message = $operation->getSecurityPostValidationMessage();	351✔
48	break;	351✔
49	case 'after_resolver':	353✔
50	if (!$operation instanceof GraphQlOperation) {	13✔
51	throw new RuntimeException('Not a graphql operation');	×
52	}
53
54	$isGranted = $operation->getSecurityAfterResolver();	13✔
55	$message = $operation->getSecurityMessageAfterResolver();	13✔
56	break;	13✔
57	default:
58	$isGranted = $operation->getSecurity();	353✔
59	$message = $operation->getSecurityMessage();	353✔
60	}
61
62	if (
63	null === $isGranted	355✔
64	// On a GraphQl QueryCollection we want to perform security stage only on the top-level query
65	\|\| ($operation instanceof QueryCollection && null !== ($context['source'] ?? null))	355✔
66	) {
67	return $this->decorated->provide($operation, $uriVariables, $context);	350✔
68	}
69
70	$body = 'pre_read' === $this->event ? null : $this->decorated->provide($operation, $uriVariables, $context);	17✔
71
72	if ($operation instanceof HttpOperation) {	17✔
73	$request = $context['request'] ?? null;	12✔
74
75	$resourceAccessCheckerContext = [	12✔
76	'object' => $body,	12✔
77	'previous_object' => $request?->attributes->get('previous_data'),	12✔
78	'request' => $request,	12✔
79	];	12✔
80	} else {
81	$resourceAccessCheckerContext = [	5✔
82	'object' => $body,	5✔
83	'previous_object' => $context['graphql_context']['previous_object'] ?? null,	5✔
84	];	5✔
85	}
86
87	if ('pre_read' === $this->event && $this->resourceAccessChecker->usesObjectVariable($isGranted, $resourceAccessCheckerContext)) {	17✔
NEW 88	return $this->decorated->provide($operation, $uriVariables, $context);	×
89	}
90
91	if (!$this->resourceAccessChecker->isGranted($operation->getClass(), $isGranted, $resourceAccessCheckerContext)) {	17✔
92	$operation instanceof GraphQlOperation ? throw new AccessDeniedHttpException($message ?? 'Access Denied.') : throw new AccessDeniedException($message ?? 'Access Denied.');	8✔
93	}
94
95	return 'pre_read' === $this->event ? $this->decorated->provide($operation, $uriVariables, $context) : $body;	9✔
96	}
97	}

api-platform / core / 19030958938

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