#26377

pending completion

Build # #26377

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/dcfd2c7058b453000fd362a024d2de09b8d0b678">dcfd2c705<a href="https://github.com/api-platform/core/commit/dcfd2c7058b453000fd362a024d2de09b8d0b678">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/f80dcaac115e53722ab2b32f1df05ca904e3093d">f80dcaac1</a>">f80dcaac1</a><a href="https://github.com/api-platform/core/commit/dcfd2c7058b453000fd362a024d2de09b8d0b678"> into 9cecfab38">9cecfab38</a>

Run Details

97 of 97 new or added lines in 64 files covered. (100.0%)

8059 of 9552 relevant lines covered (84.37%)

14.82 hits per line

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

97.0

/src/Bridge/Symfony/Routing/ApiLoader.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\Core\Bridge\Symfony\Routing;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Exception\InvalidResourceException;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
use ApiPlatform\Core\PathResolver\OperationPathResolverInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Config\Resource\DirectoryResource;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Routing\Loader\XmlFileLoader;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

/**
 * Loads Resources.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ApiLoader extends Loader
{
    /**
     * @deprecated since version 2.1, to be removed in 3.0. Use {@see RouteNameGenerator::ROUTE_NAME_PREFIX} instead.
     */
    public const ROUTE_NAME_PREFIX = 'api_';
    public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';

    private $fileLoader;
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $operationPathResolver;
    private $container;
    private $formats;
    private $resourceClassDirectories;
    private $subresourceOperationFactory;
    private $graphqlEnabled;
    private $graphiQlEnabled;
    private $graphQlPlaygroundEnabled;
    private $entrypointEnabled;
    private $docsEnabled;

    public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, OperationPathResolverInterface $operationPathResolver, ContainerInterface $container, array $formats, array $resourceClassDirectories = [], SubresourceOperationFactoryInterface $subresourceOperationFactory = null, bool $graphqlEnabled = false, bool $entrypointEnabled = true, bool $docsEnabled = true, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false)
    {
        /** @var string[]|string $paths */
        $paths = $kernel->locateResource('@ApiPlatformBundle/Resources/config/routing');
        $this->fileLoader = new XmlFileLoader(new FileLocator($paths));
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->operationPathResolver = $operationPathResolver;
        $this->container = $container;
        $this->formats = $formats;
        $this->resourceClassDirectories = $resourceClassDirectories;
        $this->subresourceOperationFactory = $subresourceOperationFactory;
        $this->graphqlEnabled = $graphqlEnabled;
        $this->graphiQlEnabled = $graphiQlEnabled;
        $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
        $this->entrypointEnabled = $entrypointEnabled;
        $this->docsEnabled = $docsEnabled;
    }

    /**
     * {@inheritdoc}
     */
    public function load($data, $type = null): RouteCollection
    {
        $routeCollection = new RouteCollection();
        foreach ($this->resourceClassDirectories as $directory) {
            $routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));
        }

        $this->loadExternalFiles($routeCollection);

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
            $resourceShortName = $resourceMetadata->getShortName();

            if (null === $resourceShortName) {
                throw new InvalidResourceException(sprintf('Resource %s has no short name defined.', $resourceClass));
            }

            if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {
                foreach ($collectionOperations as $operationName => $operation) {
                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);
                }
            }

            if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {
                foreach ($itemOperations as $operationName => $operation) {
                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::ITEM);
                }
            }

            if (null === $this->subresourceOperationFactory) {
                continue;
            }

            foreach ($this->subresourceOperationFactory->create($resourceClass) as $operationId => $operation) {
                if (null === $controller = $operation['controller'] ?? null) {
                    $controller = self::DEFAULT_ACTION_PATTERN.'get_subresource';

                    if (!$this->container->has($controller)) {
                        throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', OperationType::SUBRESOURCE, 'GET'));
                    }
                }

                $routeCollection->add($operation['route_name'], new Route(
                    $operation['path'],
                    [
                        '_controller' => $controller,
                        '_format' => null,
                        '_api_resource_class' => $operation['resource_class'],
                        '_api_subresource_operation_name' => $operation['route_name'],
                        '_api_subresource_context' => [
                            'property' => $operation['property'],
                            'identifiers' => $operation['identifiers'],
                            'collection' => $operation['collection'],
                            'operationId' => $operationId,
                        ],
                    ] + ($operation['defaults'] ?? []),
                    $operation['requirements'] ?? [],
                    $operation['options'] ?? [],
                    $operation['host'] ?? '',
                    $operation['schemes'] ?? [],
                    ['GET'],
                    $operation['condition'] ?? ''
                ));
            }
        }

        return $routeCollection;
    }

    /**
     * {@inheritdoc}
     */
    public function supports($resource, $type = null)
    {
        return 'api_platform' === $type;
    }

    /**
     * Load external files.
     */
    private function loadExternalFiles(RouteCollection $routeCollection): void
    {
        if ($this->entrypointEnabled) {
            $routeCollection->addCollection($this->fileLoader->load('api.xml'));
        }

        if ($this->docsEnabled) {
            $routeCollection->addCollection($this->fileLoader->load('docs.xml'));
        }

        if ($this->graphqlEnabled) {
            $graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');
            $graphqlCollection->addDefaults(['_graphql' => true]);
            $routeCollection->addCollection($graphqlCollection);
        }

        if ($this->graphiQlEnabled) {
            $graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');
            $graphiQlCollection->addDefaults(['_graphql' => true]);
            $routeCollection->addCollection($graphiQlCollection);
        }

        if ($this->graphQlPlaygroundEnabled) {
            $graphQlPlaygroundCollection = $this->fileLoader->load('graphql/graphql_playground.xml');
            $graphQlPlaygroundCollection->addDefaults(['_graphql' => true]);
            $routeCollection->addCollection($graphQlPlaygroundCollection);
        }

        if (isset($this->formats['jsonld'])) {
            $routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));
        }
    }

    /**
     * Creates and adds a route for the given operation to the route collection.
     *
     * @throws RuntimeException
     */
    private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, ResourceMetadata $resourceMetadata, string $operationType): void
    {
        $resourceShortName = $resourceMetadata->getShortName();

        if (isset($operation['route_name'])) {
            if (!isset($operation['method'])) {
                @trigger_error(sprintf('Not setting the "method" attribute is deprecated and will not be supported anymore in API Platform 3.0, set it for the %s operation "%s" of the class "%s".', OperationType::COLLECTION === $operationType ? 'collection' : 'item', $operationName, $resourceClass), \E_USER_DEPRECATED);
            }

            return;
        }

        if (!isset($operation['method'])) {
            throw new RuntimeException(sprintf('Either a "route_name" or a "method" operation attribute must exist for the operation "%s" of the resource "%s".', $operationName, $resourceClass));
        }

        if (null === $controller = $operation['controller'] ?? null) {
            $controller = sprintf('%s%s_%s', self::DEFAULT_ACTION_PATTERN, strtolower($operation['method']), $operationType);

            if (!$this->container->has($controller)) {
                throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', $operationType, $operation['method']));
            }
        }

        $path = trim(trim($resourceMetadata->getAttribute('route_prefix', '')), '/');
        $path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);

        $route = new Route(
            $path,
            [
                '_controller' => $controller,
                '_format' => null,
                '_api_resource_class' => $resourceClass,
                sprintf('_api_%s_operation_name', $operationType) => $operationName,
            ] + ($operation['defaults'] ?? []),
            $operation['requirements'] ?? [],
            $operation['options'] ?? [],
            $operation['host'] ?? '',
            $operation['schemes'] ?? [],
            [$operation['method']],
            $operation['condition'] ?? ''
        );

        $routeCollection->add(RouteNameGenerator::generate($operationName, $resourceShortName, $operationType), $route);
    }
}

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\Core\Bridge\Symfony\Routing;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Exception\InvalidResourceException;
18	use ApiPlatform\Core\Exception\RuntimeException;
19	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
20	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
21	use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
22	use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
23	use ApiPlatform\Core\PathResolver\OperationPathResolverInterface;
24	use Symfony\Component\Config\FileLocator;
25	use Symfony\Component\Config\Loader\Loader;
26	use Symfony\Component\Config\Resource\DirectoryResource;
27	use Symfony\Component\DependencyInjection\ContainerInterface;
28	use Symfony\Component\HttpKernel\KernelInterface;
29	use Symfony\Component\Routing\Loader\XmlFileLoader;
30	use Symfony\Component\Routing\Route;
31	use Symfony\Component\Routing\RouteCollection;
32
33	/**
34	* Loads Resources.
35	*
36	* @author Kévin Dunglas <dunglas@gmail.com>
37	*/
38	final class ApiLoader extends Loader
39	{
40	/**
41	* @deprecated since version 2.1, to be removed in 3.0. Use {@see RouteNameGenerator::ROUTE_NAME_PREFIX} instead.
42	*/
43	public const ROUTE_NAME_PREFIX = 'api_';
44	public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';
45
46	private $fileLoader;
47	private $resourceNameCollectionFactory;
48	private $resourceMetadataFactory;
49	private $operationPathResolver;
50	private $container;
51	private $formats;
52	private $resourceClassDirectories;
53	private $subresourceOperationFactory;
54	private $graphqlEnabled;
55	private $graphiQlEnabled;
56	private $graphQlPlaygroundEnabled;
57	private $entrypointEnabled;
58	private $docsEnabled;
59
60	public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, OperationPathResolverInterface $operationPathResolver, ContainerInterface $container, array $formats, array $resourceClassDirectories = [], SubresourceOperationFactoryInterface $subresourceOperationFactory = null, bool $graphqlEnabled = false, bool $entrypointEnabled = true, bool $docsEnabled = true, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false)
61	{
62	/** @var string[]\|string $paths */
63	$paths = $kernel->locateResource('@ApiPlatformBundle/Resources/config/routing');	20✔
64	$this->fileLoader = new XmlFileLoader(new FileLocator($paths));	20✔
65	$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;	20✔
66	$this->resourceMetadataFactory = $resourceMetadataFactory;	20✔
67	$this->operationPathResolver = $operationPathResolver;	20✔
68	$this->container = $container;	20✔
69	$this->formats = $formats;	20✔
70	$this->resourceClassDirectories = $resourceClassDirectories;	20✔
71	$this->subresourceOperationFactory = $subresourceOperationFactory;	20✔
72	$this->graphqlEnabled = $graphqlEnabled;	20✔
73	$this->graphiQlEnabled = $graphiQlEnabled;	20✔
74	$this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;	20✔
75	$this->entrypointEnabled = $entrypointEnabled;	20✔
76	$this->docsEnabled = $docsEnabled;	20✔
77	}	20✔
78
79	/**
80	* {@inheritdoc}
81	*/
82	public function load($data, $type = null): RouteCollection
83	{
84	$routeCollection = new RouteCollection();	20✔
85	foreach ($this->resourceClassDirectories as $directory) {	20✔
86	$routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));	14✔
87	}
88
89	$this->loadExternalFiles($routeCollection);	20✔
90
91	foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {	20✔
92	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	20✔
93	$resourceShortName = $resourceMetadata->getShortName();	20✔
94
95	if (null === $resourceShortName) {	20✔
96	throw new InvalidResourceException(sprintf('Resource %s has no short name defined.', $resourceClass));	1✔
97	}
98
99	if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {	19✔
100	foreach ($collectionOperations as $operationName => $operation) {	18✔
101	$this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);	18✔
102	}
103	}
104
105	if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {	19✔
106	foreach ($itemOperations as $operationName => $operation) {	19✔
107	$this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::ITEM);	19✔
108	}
109	}
110
111	if (null === $this->subresourceOperationFactory) {	17✔
112	continue;	×
113	}
114
115	foreach ($this->subresourceOperationFactory->create($resourceClass) as $operationId => $operation) {	17✔
116	if (null === $controller = $operation['controller'] ?? null) {	17✔
117	$controller = self::DEFAULT_ACTION_PATTERN.'get_subresource';	17✔
118
119	if (!$this->container->has($controller)) {	17✔
120	throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', OperationType::SUBRESOURCE, 'GET'));	×
121	}
122	}
123
124	$routeCollection->add($operation['route_name'], new Route(	17✔
125	$operation['path'],	17✔
126	[
127	'_controller' => $controller,	17✔
128	'_format' => null,
129	'_api_resource_class' => $operation['resource_class'],	17✔
130	'_api_subresource_operation_name' => $operation['route_name'],	17✔
131	'_api_subresource_context' => [
132	'property' => $operation['property'],	17✔
133	'identifiers' => $operation['identifiers'],	17✔
134	'collection' => $operation['collection'],	17✔
135	'operationId' => $operationId,	17✔
136	],
137	] + ($operation['defaults'] ?? []),	17✔
138	$operation['requirements'] ?? [],	17✔
139	$operation['options'] ?? [],	17✔
140	$operation['host'] ?? '',	17✔
141	$operation['schemes'] ?? [],	17✔
142	['GET'],	17✔
143	$operation['condition'] ?? ''	17✔
144	));
145	}
146	}
147
148	return $routeCollection;	17✔
149	}
150
151	/**
152	* {@inheritdoc}
153	*/
154	public function supports($resource, $type = null)
155	{
156	return 'api_platform' === $type;	14✔
157	}
158
159	/**
160	* Load external files.
161	*/
162	private function loadExternalFiles(RouteCollection $routeCollection): void
163	{
164	if ($this->entrypointEnabled) {	20✔
165	$routeCollection->addCollection($this->fileLoader->load('api.xml'));	20✔
166	}
167
168	if ($this->docsEnabled) {	20✔
169	$routeCollection->addCollection($this->fileLoader->load('docs.xml'));	20✔
170	}
171
172	if ($this->graphqlEnabled) {	20✔
173	$graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');	14✔
174	$graphqlCollection->addDefaults(['_graphql' => true]);	14✔
175	$routeCollection->addCollection($graphqlCollection);	14✔
176	}
177
178	if ($this->graphiQlEnabled) {	20✔
179	$graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');	14✔
180	$graphiQlCollection->addDefaults(['_graphql' => true]);	14✔
181	$routeCollection->addCollection($graphiQlCollection);	14✔
182	}
183
184	if ($this->graphQlPlaygroundEnabled) {	20✔
185	$graphQlPlaygroundCollection = $this->fileLoader->load('graphql/graphql_playground.xml');	14✔
186	$graphQlPlaygroundCollection->addDefaults(['_graphql' => true]);	14✔
187	$routeCollection->addCollection($graphQlPlaygroundCollection);	14✔
188	}
189
190	if (isset($this->formats['jsonld'])) {	20✔
191	$routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));	20✔
192	}
193	}	20✔
194
195	/**
196	* Creates and adds a route for the given operation to the route collection.
197	*
198	* @throws RuntimeException
199	*/
200	private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, ResourceMetadata $resourceMetadata, string $operationType): void
201	{
202	$resourceShortName = $resourceMetadata->getShortName();	19✔
203
204	if (isset($operation['route_name'])) {	19✔
205	if (!isset($operation['method'])) {	14✔
206	@trigger_error(sprintf('Not setting the "method" attribute is deprecated and will not be supported anymore in API Platform 3.0, set it for the %s operation "%s" of the class "%s".', OperationType::COLLECTION === $operationType ? 'collection' : 'item', $operationName, $resourceClass), \E_USER_DEPRECATED);	×
207	}
208
209	return;	14✔
210	}
211
212	if (!isset($operation['method'])) {	19✔
213	throw new RuntimeException(sprintf('Either a "route_name" or a "method" operation attribute must exist for the operation "%s" of the resource "%s".', $operationName, $resourceClass));	1✔
214	}
215
216	if (null === $controller = $operation['controller'] ?? null) {	19✔
217	$controller = sprintf('%s%s_%s', self::DEFAULT_ACTION_PATTERN, strtolower($operation['method']), $operationType);	19✔
218
219	if (!$this->container->has($controller)) {	19✔
220	throw new RuntimeException(sprintf('There is no builtin action for the %s %s operation. You need to define the controller yourself.', $operationType, $operation['method']));	1✔
221	}
222	}
223
224	$path = trim(trim($resourceMetadata->getAttribute('route_prefix', '')), '/');	19✔
225	$path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);	19✔
226
227	$route = new Route(	19✔
228	$path,
229	[
230	'_controller' => $controller,	19✔
231	'_format' => null,
232	'_api_resource_class' => $resourceClass,	19✔
233	sprintf('_api_%s_operation_name', $operationType) => $operationName,	19✔
234	] + ($operation['defaults'] ?? []),	19✔
235	$operation['requirements'] ?? [],	19✔
236	$operation['options'] ?? [],	19✔
237	$operation['host'] ?? '',	19✔
238	$operation['schemes'] ?? [],	19✔
239	[$operation['method']],	19✔
240	$operation['condition'] ?? ''	19✔
241	);
242
243	$routeCollection->add(RouteNameGenerator::generate($operationName, $resourceShortName, $operationType), $route);	19✔
244	}	19✔
245	}

api-platform / core / #26377

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