#27624

pending completion

Build # #27624

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/100d80841454fd647620de8fdca3ab947157ef39">100d80841<a href="https://github.com/api-platform/core/commit/100d80841454fd647620de8fdca3ab947157ef39">">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/0a317c83421b89ed7b53b05083cb5c74cde653df">0a317c834</a>">0a317c834</a><a href="https://github.com/api-platform/core/commit/100d80841454fd647620de8fdca3ab947157ef39"> into 9b1dc7188">9b1dc7188</a>

Run Details

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

13051 of 15668 relevant lines covered (83.3%)

15.07 hits per line

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

90.48

/src/Core/Bridge/Elasticsearch/DataProvider/CollectionDataProvider.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\Elasticsearch\DataProvider;

use ApiPlatform\Core\Bridge\Elasticsearch\Api\IdentifierExtractorInterface;
use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\RequestBodySearchCollectionExtensionInterface;
use ApiPlatform\Core\Bridge\Elasticsearch\Exception\IndexNotFoundException;
use ApiPlatform\Core\Bridge\Elasticsearch\Exception\NonUniqueIdentifierException;
use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\Factory\DocumentMetadataFactoryInterface;
use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
use ApiPlatform\Core\DataProvider\Pagination;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Exception\ResourceClassNotFoundException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use Elasticsearch\Client;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;

/**
 * Collection data provider for Elasticsearch.
 *
 * @experimental
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class CollectionDataProvider implements ContextAwareCollectionDataProviderInterface, RestrictedDataProviderInterface
{
    private $client;
    private $documentMetadataFactory;
    private $identifierExtractor;
    private $denormalizer;
    private $pagination;
    private $resourceMetadataFactory;

    /**
     * @param RequestBodySearchCollectionExtensionInterface[]                             $collectionExtensions
     * @param ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory
     */
    public function __construct(Client $client, DocumentMetadataFactoryInterface $documentMetadataFactory, IdentifierExtractorInterface $identifierExtractor = null, DenormalizerInterface $denormalizer, Pagination $pagination, $resourceMetadataFactory, iterable $collectionExtensions = [])
    {
        $this->client = $client;
        $this->documentMetadataFactory = $documentMetadataFactory;

        if ($this->identifierExtractor) {
            trigger_deprecation('api-platform', '2.7', sprintf('Passing an instance of "%s" is deprecated and will not be supported in 3.0.', IdentifierExtractorInterface::class));
        }

        $this->identifierExtractor = $identifierExtractor;
        $this->denormalizer = $denormalizer;
        $this->pagination = $pagination;

        if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
        }

        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->collectionExtensions = $collectionExtensions;
    }

    /**
     * {@inheritdoc}
     */
    public function supports(string $resourceClass, ?string $operationName = null, array $context = []): bool
    {
        try {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
            if (false === $resourceMetadata->getCollectionOperationAttribute($operationName, 'elasticsearch', true, true)) {
                return false;
            }
        } catch (ResourceClassNotFoundException $e) {
            return false;
        }

        try {
            $this->documentMetadataFactory->create($resourceClass);
        } catch (IndexNotFoundException $e) {
            return false;
        }

        if ($this->identifierExtractor) {
            try {
                $this->identifierExtractor->getIdentifierFromResourceClass($resourceClass);
            } catch (NonUniqueIdentifierException $e) {
                return false;
            }
        } else {
            $operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($operationName);

            if (\count($operation->getIdentifiers()) > 1) {
                return false;
            }
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getCollection(string $resourceClass, ?string $operationName = null, array $context = [])
    {
        $documentMetadata = $this->documentMetadataFactory->create($resourceClass);
        $body = [];

        foreach ($this->collectionExtensions as $collectionExtension) {
            $body = $collectionExtension->applyToCollection($body, $resourceClass, $operationName, $context);
        }

        if (!isset($body['query']) && !isset($body['aggs'])) {
            $body['query'] = ['match_all' => new \stdClass()];
        }

        $limit = $body['size'] = $body['size'] ?? $this->pagination->getLimit($resourceClass, $operationName, $context);
        $offset = $body['from'] = $body['from'] ?? $this->pagination->getOffset($resourceClass, $operationName, $context);

        $documents = $this->client->search([
            'index' => $documentMetadata->getIndex(),
            'type' => $documentMetadata->getType(),
            'body' => $body,
        ]);

        return new Paginator(
            $this->denormalizer,
            $documents,
            $resourceClass,
            $limit,
            $offset,
            $context
        );
    }

    private $collectionExtensions;
}

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\Elasticsearch\DataProvider;
15
16	use ApiPlatform\Core\Bridge\Elasticsearch\Api\IdentifierExtractorInterface;
17	use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\RequestBodySearchCollectionExtensionInterface;
18	use ApiPlatform\Core\Bridge\Elasticsearch\Exception\IndexNotFoundException;
19	use ApiPlatform\Core\Bridge\Elasticsearch\Exception\NonUniqueIdentifierException;
20	use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\Factory\DocumentMetadataFactoryInterface;
21	use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
22	use ApiPlatform\Core\DataProvider\Pagination;
23	use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
24	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
25	use ApiPlatform\Exception\ResourceClassNotFoundException;
26	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
27	use Elasticsearch\Client;
28	use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
29
30	/**
31	* Collection data provider for Elasticsearch.
32	*
33	* @experimental
34	*
35	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
36	*/
37	final class CollectionDataProvider implements ContextAwareCollectionDataProviderInterface, RestrictedDataProviderInterface
38	{
39	private $client;
40	private $documentMetadataFactory;
41	private $identifierExtractor;
42	private $denormalizer;
43	private $pagination;
44	private $resourceMetadataFactory;
45
46	/**
47	* @param RequestBodySearchCollectionExtensionInterface[] $collectionExtensions
48	* @param ResourceMetadataFactoryInterface\|ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory
49	*/
50	public function __construct(Client $client, DocumentMetadataFactoryInterface $documentMetadataFactory, IdentifierExtractorInterface $identifierExtractor = null, DenormalizerInterface $denormalizer, Pagination $pagination, $resourceMetadataFactory, iterable $collectionExtensions = [])
51	{
52	$this->client = $client;	3✔
53	$this->documentMetadataFactory = $documentMetadataFactory;	3✔
54
55	if ($this->identifierExtractor) {	3✔
56	trigger_deprecation('api-platform', '2.7', sprintf('Passing an instance of "%s" is deprecated and will not be supported in 3.0.', IdentifierExtractorInterface::class));	×
57	}
58
59	$this->identifierExtractor = $identifierExtractor;	3✔
60	$this->denormalizer = $denormalizer;	3✔
61	$this->pagination = $pagination;	3✔
62
63	if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	3✔
64	trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));	3✔
65	}
66
67	$this->resourceMetadataFactory = $resourceMetadataFactory;	3✔
68	$this->collectionExtensions = $collectionExtensions;	3✔
69	}	3✔
70
71	/**
72	* {@inheritdoc}
73	*/
74	public function supports(string $resourceClass, ?string $operationName = null, array $context = []): bool
75	{
76	try {
77	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	1✔
78	if (false === $resourceMetadata->getCollectionOperationAttribute($operationName, 'elasticsearch', true, true)) {	1✔
79	return false;	1✔
80	}
81	} catch (ResourceClassNotFoundException $e) {	1✔
82	return false;	1✔
83	}
84
85	try {
86	$this->documentMetadataFactory->create($resourceClass);	1✔
87	} catch (IndexNotFoundException $e) {	1✔
88	return false;	1✔
89	}
90
91	if ($this->identifierExtractor) {	1✔
92	try {
93	$this->identifierExtractor->getIdentifierFromResourceClass($resourceClass);	1✔
94	} catch (NonUniqueIdentifierException $e) {	1✔
95	return false;	1✔
96	}
97	} else {
98	$operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($operationName);	×
99
100	if (\count($operation->getIdentifiers()) > 1) {	×
101	return false;	×
102	}
103	}
104
105	return true;	1✔
106	}
107
108	/**
109	* {@inheritdoc}
110	*/
111	public function getCollection(string $resourceClass, ?string $operationName = null, array $context = [])
112	{
113	$documentMetadata = $this->documentMetadataFactory->create($resourceClass);	1✔
114	$body = [];	1✔
115
116	foreach ($this->collectionExtensions as $collectionExtension) {	1✔
117	$body = $collectionExtension->applyToCollection($body, $resourceClass, $operationName, $context);	1✔
118	}
119
120	if (!isset($body['query']) && !isset($body['aggs'])) {	1✔
121	$body['query'] = ['match_all' => new \stdClass()];	1✔
122	}
123
124	$limit = $body['size'] = $body['size'] ?? $this->pagination->getLimit($resourceClass, $operationName, $context);	1✔
125	$offset = $body['from'] = $body['from'] ?? $this->pagination->getOffset($resourceClass, $operationName, $context);	1✔
126
127	$documents = $this->client->search([	1✔
128	'index' => $documentMetadata->getIndex(),	1✔
129	'type' => $documentMetadata->getType(),	1✔
130	'body' => $body,	1✔
131	]);
132
133	return new Paginator(	1✔
134	$this->denormalizer,	1✔
135	$documents,
136	$resourceClass,
137	$limit,
138	$offset,
139	$context
140	);
141	}
142
143	private $collectionExtensions;
144	}

api-platform / core / #27624

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