#28196

pending completion

Build # #28196

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/0b3c4324b2f0492125cd30daa48f8570570f0631">0b3c4324b<a href="https://github.com/api-platform/core/commit/0b3c4324b2f0492125cd30daa48f8570570f0631">">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/edd1e603a59e55532d591029be875adcb62be0da">edd1e603a</a>">edd1e603a</a><a href="https://github.com/api-platform/core/commit/0b3c4324b2f0492125cd30daa48f8570570f0631"> into 8cc452c1f">8cc452c1f</a>

Run Details

38 of 38 new or added lines in 16 files covered. (100.0%)

13179 of 16540 relevant lines covered (79.68%)

14.71 hits per line

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

0.0

/src/Core/Bridge/Doctrine/MongoDbOdm/SubresourceDataProvider.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\Doctrine\MongoDbOdm;

use ApiPlatform\Core\Bridge\Doctrine\Common\Util\IdentifierManagerTrait;
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface;
use ApiPlatform\Doctrine\Odm\Extension\AggregationItemExtensionInterface;
use ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface;
use ApiPlatform\Doctrine\Odm\Extension\AggregationResultItemExtensionInterface;
use ApiPlatform\Exception\OperationNotFoundException;
use ApiPlatform\Exception\ResourceClassNotSupportedException;
use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
use Doctrine\Persistence\ManagerRegistry;
use Doctrine\Persistence\ObjectRepository;

/**
 * Subresource data provider for the Doctrine MongoDB ODM.
 *
 * @experimental
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class SubresourceDataProvider implements SubresourceDataProviderInterface
{
    use IdentifierManagerTrait;

    private $managerRegistry;
    private $resourceMetadataFactory;
    private $collectionExtensions;
    private $itemExtensions;

    /**
     * @param AggregationCollectionExtensionInterface[] $collectionExtensions
     * @param AggregationItemExtensionInterface[]       $itemExtensions
     * @param mixed                                     $resourceMetadataFactory
     */
    public function __construct(ManagerRegistry $managerRegistry, $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $collectionExtensions = [], iterable $itemExtensions = [])
    {
        $this->managerRegistry = $managerRegistry;

        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->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->collectionExtensions = $collectionExtensions;
        $this->itemExtensions = $itemExtensions;
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
    {
        $manager = $this->managerRegistry->getManagerForClass($resourceClass);
        if (!$manager instanceof DocumentManager) {
            throw new ResourceClassNotSupportedException(sprintf('The manager for "%s" must be an instance of "%s".', $resourceClass, DocumentManager::class));
        }

        $repository = $manager->getRepository($resourceClass);
        /** @var ObjectRepository $repository */
        if (!$repository instanceof DocumentRepository) {
            throw new RuntimeException(sprintf('The repository for "%s" must be an instance of "%s".', $resourceClass, DocumentRepository::class));
        }

        if (isset($context['identifiers'], $context['operation']) && !isset($context['property'])) {
            $context['property'] = $context['operation']->getExtraProperties()['legacy_subresource_property'] ?? null;
            $context['collection'] = $context['operation']->isCollection();
        }

        if (!isset($context['identifiers'], $context['property'])) {
            throw new ResourceClassNotSupportedException('The given resource class is not a subresource.');
        }

        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        try {
            $operation = $context['operation'] ?? $resourceMetadata->getOperation($operationName);
            $attribute = $operation->getExtraProperties()['doctrine_mongodb'] ?? [];
        } catch (OperationNotFoundException $e) {
            $attribute = $resourceMetadata->getOperation()->getExtraProperties()['doctrine_mongodb'] ?? [];
        }

        $executeOptions = $attribute['execute_options'] ?? [];

        $aggregationBuilder = $this->buildAggregation($identifiers, $context, $executeOptions, $repository->createAggregationBuilder(), \count($context['identifiers']));

        if (true === $context['collection']) {
            foreach ($this->collectionExtensions as $extension) {
                $extension->applyToCollection($aggregationBuilder, $resourceClass, $operationName, $context);
                if ($extension instanceof AggregationResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {
                    return $extension->getResult($aggregationBuilder, $resourceClass, $operationName, $context);
                }
            }
        } else {
            foreach ($this->itemExtensions as $extension) {
                $extension->applyToItem($aggregationBuilder, $resourceClass, $identifiers, $operationName, $context);
                if ($extension instanceof AggregationResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {
                    return $extension->getResult($aggregationBuilder, $resourceClass, $operationName, $context);
                }
            }
        }

        $iterator = $aggregationBuilder->hydrate($resourceClass)->execute($executeOptions);

        return $context['collection'] ? $iterator->toArray() : ($iterator->current() ?: null);
    }

    /**
     * @throws RuntimeException
     */
    private function buildAggregation(array $identifiers, array $context, array $executeOptions, Builder $previousAggregationBuilder, int $remainingIdentifiers, Builder $topAggregationBuilder = null): Builder
    {
        if ($remainingIdentifiers <= 0) {
            return $previousAggregationBuilder;
        }

        $topAggregationBuilder = $topAggregationBuilder ?? $previousAggregationBuilder;

        if (\is_string(key($context['identifiers']))) {
            $contextIdentifiers = array_keys($context['identifiers']);
            $identifier = $contextIdentifiers[$remainingIdentifiers - 1];
            $identifierResourceClass = $context['identifiers'][$identifier][0];
            $previousAssociationProperty = $contextIdentifiers[$remainingIdentifiers] ?? $context['property'];
        } else {
            @trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', \E_USER_DEPRECATED);
            [$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1];
            $previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property'];
        }

        $manager = $this->managerRegistry->getManagerForClass($identifierResourceClass);
        if (!$manager instanceof DocumentManager) {
            throw new RuntimeException(sprintf('The manager for "%s" must be an instance of "%s".', $identifierResourceClass, DocumentManager::class));
        }

        $classMetadata = $manager->getClassMetadata($identifierResourceClass);

        if (!$classMetadata instanceof ClassMetadata) {
            throw new RuntimeException(sprintf('The class metadata for "%s" must be an instance of "%s".', $identifierResourceClass, ClassMetadata::class));
        }

        $aggregation = $manager->createAggregationBuilder($identifierResourceClass);
        $normalizedIdentifiers = [];

        if (isset($identifiers[$identifier])) {
            // if it's an array it's already normalized, the IdentifierManagerTrait is deprecated
            if ($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false) {
                $normalizedIdentifiers = $identifiers[$identifier];
            } else {
                $normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass);
            }
        }

        if ($classMetadata->hasAssociation($previousAssociationProperty)) {
            $aggregation->lookup($previousAssociationProperty)->alias($previousAssociationProperty);
            foreach ($normalizedIdentifiers as $key => $value) {
                $aggregation->match()->field($key)->equals($value);
            }
        } elseif ($classMetadata->isIdentifier($previousAssociationProperty)) {
            foreach ($normalizedIdentifiers as $key => $value) {
                $aggregation->match()->field($key)->equals($value);
            }

            return $aggregation;
        }

        // Recurse aggregations
        $aggregation = $this->buildAggregation($identifiers, $context, $executeOptions, $aggregation, --$remainingIdentifiers, $topAggregationBuilder);

        $results = $aggregation->execute($executeOptions)->toArray();
        $in = array_reduce($results, static function ($in, $result) use ($previousAssociationProperty) {
            return $in + array_map(static function ($result) {
                return $result['_id'];
            }, $result[$previousAssociationProperty] ?? []);
        }, []);
        $previousAggregationBuilder->match()->field('_id')->in($in);

        return $previousAggregationBuilder;
    }
}

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\Doctrine\MongoDbOdm;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Common\Util\IdentifierManagerTrait;
17	use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
18	use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
19	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
20	use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
21	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
22	use ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface;
23	use ApiPlatform\Doctrine\Odm\Extension\AggregationItemExtensionInterface;
24	use ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface;
25	use ApiPlatform\Doctrine\Odm\Extension\AggregationResultItemExtensionInterface;
26	use ApiPlatform\Exception\OperationNotFoundException;
27	use ApiPlatform\Exception\ResourceClassNotSupportedException;
28	use ApiPlatform\Exception\RuntimeException;
29	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
30	use Doctrine\ODM\MongoDB\Aggregation\Builder;
31	use Doctrine\ODM\MongoDB\DocumentManager;
32	use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
33	use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
34	use Doctrine\Persistence\ManagerRegistry;
35	use Doctrine\Persistence\ObjectRepository;
36
37	/**
38	* Subresource data provider for the Doctrine MongoDB ODM.
39	*
40	* @experimental
41	*
42	* @author Antoine Bluchet <soyuka@gmail.com>
43	* @author Alan Poulain <contact@alanpoulain.eu>
44	*/
45	final class SubresourceDataProvider implements SubresourceDataProviderInterface
46	{
47	use IdentifierManagerTrait;
48
49	private $managerRegistry;
50	private $resourceMetadataFactory;
51	private $collectionExtensions;
52	private $itemExtensions;
53
54	/**
55	* @param AggregationCollectionExtensionInterface[] $collectionExtensions
56	* @param AggregationItemExtensionInterface[] $itemExtensions
57	* @param mixed $resourceMetadataFactory
58	*/
59	public function __construct(ManagerRegistry $managerRegistry, $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $collectionExtensions = [], iterable $itemExtensions = [])
60	{
61	$this->managerRegistry = $managerRegistry;	×
62
63	if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	×
64	trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));	×
65	}
66
67	$this->resourceMetadataFactory = $resourceMetadataFactory;	×
68	$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;	×
69	$this->propertyMetadataFactory = $propertyMetadataFactory;	×
70	$this->collectionExtensions = $collectionExtensions;	×
71	$this->itemExtensions = $itemExtensions;	×
72	}	×
73
74	/**
75	* {@inheritdoc}
76	*
77	* @throws RuntimeException
78	*/
79	public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
80	{
81	$manager = $this->managerRegistry->getManagerForClass($resourceClass);	×
82	if (!$manager instanceof DocumentManager) {	×
83	throw new ResourceClassNotSupportedException(sprintf('The manager for "%s" must be an instance of "%s".', $resourceClass, DocumentManager::class));	×
84	}
85
86	$repository = $manager->getRepository($resourceClass);	×
87	/** @var ObjectRepository $repository */
88	if (!$repository instanceof DocumentRepository) {	×
89	throw new RuntimeException(sprintf('The repository for "%s" must be an instance of "%s".', $resourceClass, DocumentRepository::class));	×
90	}
91
92	if (isset($context['identifiers'], $context['operation']) && !isset($context['property'])) {	×
93	$context['property'] = $context['operation']->getExtraProperties()['legacy_subresource_property'] ?? null;	×
94	$context['collection'] = $context['operation']->isCollection();	×
95	}
96
97	if (!isset($context['identifiers'], $context['property'])) {	×
98	throw new ResourceClassNotSupportedException('The given resource class is not a subresource.');	×
99	}
100
101	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	×
102	try {
103	$operation = $context['operation'] ?? $resourceMetadata->getOperation($operationName);	×
104	$attribute = $operation->getExtraProperties()['doctrine_mongodb'] ?? [];	×
105	} catch (OperationNotFoundException $e) {	×
106	$attribute = $resourceMetadata->getOperation()->getExtraProperties()['doctrine_mongodb'] ?? [];	×
107	}
108
109	$executeOptions = $attribute['execute_options'] ?? [];	×
110
111	$aggregationBuilder = $this->buildAggregation($identifiers, $context, $executeOptions, $repository->createAggregationBuilder(), \count($context['identifiers']));	×
112
113	if (true === $context['collection']) {	×
114	foreach ($this->collectionExtensions as $extension) {	×
115	$extension->applyToCollection($aggregationBuilder, $resourceClass, $operationName, $context);	×
116	if ($extension instanceof AggregationResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {	×
117	return $extension->getResult($aggregationBuilder, $resourceClass, $operationName, $context);	×
118	}
119	}
120	} else {
121	foreach ($this->itemExtensions as $extension) {	×
122	$extension->applyToItem($aggregationBuilder, $resourceClass, $identifiers, $operationName, $context);	×
123	if ($extension instanceof AggregationResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {	×
124	return $extension->getResult($aggregationBuilder, $resourceClass, $operationName, $context);	×
125	}
126	}
127	}
128
129	$iterator = $aggregationBuilder->hydrate($resourceClass)->execute($executeOptions);	×
130
131	return $context['collection'] ? $iterator->toArray() : ($iterator->current() ?: null);	×
132	}
133
134	/**
135	* @throws RuntimeException
136	*/
137	private function buildAggregation(array $identifiers, array $context, array $executeOptions, Builder $previousAggregationBuilder, int $remainingIdentifiers, Builder $topAggregationBuilder = null): Builder
138	{
139	if ($remainingIdentifiers <= 0) {	×
140	return $previousAggregationBuilder;	×
141	}
142
143	$topAggregationBuilder = $topAggregationBuilder ?? $previousAggregationBuilder;	×
144
145	if (\is_string(key($context['identifiers']))) {	×
146	$contextIdentifiers = array_keys($context['identifiers']);	×
147	$identifier = $contextIdentifiers[$remainingIdentifiers - 1];	×
148	$identifierResourceClass = $context['identifiers'][$identifier][0];	×
149	$previousAssociationProperty = $contextIdentifiers[$remainingIdentifiers] ?? $context['property'];	×
150	} else {
151	@trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', \E_USER_DEPRECATED);	×
152	[$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1];	×
153	$previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property'];	×
154	}
155
156	$manager = $this->managerRegistry->getManagerForClass($identifierResourceClass);	×
157	if (!$manager instanceof DocumentManager) {	×
158	throw new RuntimeException(sprintf('The manager for "%s" must be an instance of "%s".', $identifierResourceClass, DocumentManager::class));	×
159	}
160
161	$classMetadata = $manager->getClassMetadata($identifierResourceClass);	×
162
163	if (!$classMetadata instanceof ClassMetadata) {	×
164	throw new RuntimeException(sprintf('The class metadata for "%s" must be an instance of "%s".', $identifierResourceClass, ClassMetadata::class));	×
165	}
166
167	$aggregation = $manager->createAggregationBuilder($identifierResourceClass);	×
168	$normalizedIdentifiers = [];	×
169
170	if (isset($identifiers[$identifier])) {	×
171	// if it's an array it's already normalized, the IdentifierManagerTrait is deprecated
172	if ($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false) {	×
173	$normalizedIdentifiers = $identifiers[$identifier];	×
174	} else {
175	$normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass);	×
176	}
177	}
178
179	if ($classMetadata->hasAssociation($previousAssociationProperty)) {	×
180	$aggregation->lookup($previousAssociationProperty)->alias($previousAssociationProperty);	×
181	foreach ($normalizedIdentifiers as $key => $value) {	×
182	$aggregation->match()->field($key)->equals($value);	×
183	}
184	} elseif ($classMetadata->isIdentifier($previousAssociationProperty)) {	×
185	foreach ($normalizedIdentifiers as $key => $value) {	×
186	$aggregation->match()->field($key)->equals($value);	×
187	}
188
189	return $aggregation;	×
190	}
191
192	// Recurse aggregations
193	$aggregation = $this->buildAggregation($identifiers, $context, $executeOptions, $aggregation, --$remainingIdentifiers, $topAggregationBuilder);	×
194
195	$results = $aggregation->execute($executeOptions)->toArray();	×
196	$in = array_reduce($results, static function ($in, $result) use ($previousAssociationProperty) {	×
197	return $in + array_map(static function ($result) {	×
198	return $result['_id'];	×
199	}, $result[$previousAssociationProperty] ?? []);	×
200	}, []);	×
201	$previousAggregationBuilder->match()->field('_id')->in($in);	×
202
203	return $previousAggregationBuilder;	×
204	}
205	}

api-platform / core / #28196

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