#27289

pending completion

Build # #27289

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/dd4b162f29fa415e2514477c5f74d3362a770a1e">dd4b162f2<a href="https://github.com/api-platform/core/commit/dd4b162f29fa415e2514477c5f74d3362a770a1e">">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/2712502e93ed41e2132942536b689a1001b83352">2712502e9</a>">2712502e9</a><a href="https://github.com/api-platform/core/commit/dd4b162f29fa415e2514477c5f74d3362a770a1e"> into cd198d20b">cd198d20b</a>

Run Details

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

10258 of 12308 relevant lines covered (83.34%)

14.74 hits per line

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

91.3

/src/Api/CachedIdentifiersExtractor.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\Api;

use ApiPlatform\Core\Util\ResourceClassInfoTrait;
use Psr\Cache\CacheException;
use Psr\Cache\CacheItemPoolInterface;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;

/**
 * {@inheritdoc}
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
final class CachedIdentifiersExtractor implements ContextAwareIdentifiersExtractorInterface
{
    use ResourceClassInfoTrait;

    public const CACHE_KEY_PREFIX = 'iri_identifiers';

    private $cacheItemPool;
    private $propertyAccessor;
    private $decorated;
    private $localCache = [];
    private $localResourceCache = [];

    public function __construct(CacheItemPoolInterface $cacheItemPool, IdentifiersExtractorInterface $decorated, PropertyAccessorInterface $propertyAccessor = null, ResourceClassResolverInterface $resourceClassResolver = null)
    {
        $this->cacheItemPool = $cacheItemPool;
        $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
        $this->decorated = $decorated;
        $this->resourceClassResolver = $resourceClassResolver;

        if (null === $this->resourceClassResolver) {
            @trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getIdentifiersFromResourceClass(string $resourceClass): array
    {
        if (isset($this->localResourceCache[$resourceClass])) {
            return $this->localResourceCache[$resourceClass];
        }

        return $this->localResourceCache[$resourceClass] = $this->decorated->getIdentifiersFromResourceClass($resourceClass);
    }

    /**
     * {@inheritdoc}
     */
    public function getIdentifiersFromItem($item, array $context = []): array
    {
        // TODO: Remove this class in 3.0 as the cache is not needed anymore
        if (isset($context['identifiers']) && $this->decorated instanceof ContextAwareIdentifiersExtractorInterface) {
            return $this->decorated->getIdentifiersFromItem($item, $context);
        }

        $keys = $this->getKeys($item, function ($item) use (&$identifiers) {
            return $identifiers = $this->decorated->getIdentifiersFromItem($item);
        });

        if (null !== $identifiers) {
            return $identifiers;
        }

        $identifiers = [];
        foreach ($keys as $propertyName) {
            $identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);

            if (!\is_object($identifiers[$propertyName])) {
                continue;
            }

            if (null === $relatedResourceClass = $this->getResourceClass($identifiers[$propertyName])) {
                continue;
            }

            if (!$relatedIdentifiers = $this->localCache[$relatedResourceClass] ?? false) {
                $relatedCacheKey = self::CACHE_KEY_PREFIX.md5($relatedResourceClass);
                try {
                    $relatedCacheItem = $this->cacheItemPool->getItem($relatedCacheKey);
                    if (!$relatedCacheItem->isHit()) {
                        return $this->decorated->getIdentifiersFromItem($item);
                    }
                } catch (CacheException $e) {
                    return $this->decorated->getIdentifiersFromItem($item);
                }

                $relatedIdentifiers = $relatedCacheItem->get();
            }

            $identifiers[$propertyName] = $this->propertyAccessor->getValue($identifiers[$propertyName], $relatedIdentifiers[0]);
        }

        return $identifiers;
    }

    private function getKeys($item, callable $retriever): array
    {
        $resourceClass = $this->getObjectClass($item);
        if (isset($this->localCache[$resourceClass])) {
            return $this->localCache[$resourceClass];
        }

        try {
            $cacheItem = $this->cacheItemPool->getItem(self::CACHE_KEY_PREFIX.md5($resourceClass));
        } catch (CacheException $e) {
            return $this->localCache[$resourceClass] = array_keys($retriever($item));
        }

        if ($cacheItem->isHit()) {
            return $this->localCache[$resourceClass] = $cacheItem->get();
        }

        $keys = array_keys($retriever($item));

        $cacheItem->set($keys);
        $this->cacheItemPool->save($cacheItem);

        return $this->localCache[$resourceClass] = $keys;
    }
}

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\Api;
15
16	use ApiPlatform\Core\Util\ResourceClassInfoTrait;
17	use Psr\Cache\CacheException;
18	use Psr\Cache\CacheItemPoolInterface;
19	use Symfony\Component\PropertyAccess\PropertyAccess;
20	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
21
22	/**
23	* {@inheritdoc}
24	*
25	* @author Antoine Bluchet <soyuka@gmail.com>
26	*/
27	final class CachedIdentifiersExtractor implements ContextAwareIdentifiersExtractorInterface
28	{
29	use ResourceClassInfoTrait;
30
31	public const CACHE_KEY_PREFIX = 'iri_identifiers';
32
33	private $cacheItemPool;
34	private $propertyAccessor;
35	private $decorated;
36	private $localCache = [];
37	private $localResourceCache = [];
38
39	public function __construct(CacheItemPoolInterface $cacheItemPool, IdentifiersExtractorInterface $decorated, PropertyAccessorInterface $propertyAccessor = null, ResourceClassResolverInterface $resourceClassResolver = null)
40	{
41	$this->cacheItemPool = $cacheItemPool;	44✔
42	$this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();	44✔
43	$this->decorated = $decorated;	44✔
44	$this->resourceClassResolver = $resourceClassResolver;	44✔
45
46	if (null === $this->resourceClassResolver) {	44✔
47	@trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);	1✔
48	}
49	}	44✔
50
51	/**
52	* {@inheritdoc}
53	*/
54	public function getIdentifiersFromResourceClass(string $resourceClass): array
55	{
56	if (isset($this->localResourceCache[$resourceClass])) {	20✔
57	return $this->localResourceCache[$resourceClass];	20✔
58	}
59
60	return $this->localResourceCache[$resourceClass] = $this->decorated->getIdentifiersFromResourceClass($resourceClass);	20✔
61	}
62
63	/**
64	* {@inheritdoc}
65	*/
66	public function getIdentifiersFromItem($item, array $context = []): array
67	{
68	// TODO: Remove this class in 3.0 as the cache is not needed anymore
69	if (isset($context['identifiers']) && $this->decorated instanceof ContextAwareIdentifiersExtractorInterface) {	20✔
70	return $this->decorated->getIdentifiersFromItem($item, $context);	2✔
71	}
72
73	$keys = $this->getKeys($item, function ($item) use (&$identifiers) {	18✔
74	return $identifiers = $this->decorated->getIdentifiersFromItem($item);	5✔
75	});	18✔
76
77	if (null !== $identifiers) {	18✔
78	return $identifiers;	5✔
79	}
80
81	$identifiers = [];	17✔
82	foreach ($keys as $propertyName) {	17✔
83	$identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);	17✔
84
85	if (!\is_object($identifiers[$propertyName])) {	17✔
86	continue;	11✔
87	}
88
89	if (null === $relatedResourceClass = $this->getResourceClass($identifiers[$propertyName])) {	8✔
90	continue;	6✔
91	}
92
93	if (!$relatedIdentifiers = $this->localCache[$relatedResourceClass] ?? false) {	6✔
94	$relatedCacheKey = self::CACHE_KEY_PREFIX.md5($relatedResourceClass);	6✔
95	try {
96	$relatedCacheItem = $this->cacheItemPool->getItem($relatedCacheKey);	6✔
97	if (!$relatedCacheItem->isHit()) {	6✔
98	return $this->decorated->getIdentifiersFromItem($item);	6✔
99	}
100	} catch (CacheException $e) {	×
101	return $this->decorated->getIdentifiersFromItem($item);	×
102	}
103
104	$relatedIdentifiers = $relatedCacheItem->get();	3✔
105	}
106
107	$identifiers[$propertyName] = $this->propertyAccessor->getValue($identifiers[$propertyName], $relatedIdentifiers[0]);	3✔
108	}
109
110	return $identifiers;	14✔
111	}
112
113	private function getKeys($item, callable $retriever): array
114	{
115	$resourceClass = $this->getObjectClass($item);	18✔
116	if (isset($this->localCache[$resourceClass])) {	18✔
117	return $this->localCache[$resourceClass];	15✔
118	}
119
120	try {
121	$cacheItem = $this->cacheItemPool->getItem(self::CACHE_KEY_PREFIX.md5($resourceClass));	18✔
122	} catch (CacheException $e) {	×
123	return $this->localCache[$resourceClass] = array_keys($retriever($item));	×
124	}
125
126	if ($cacheItem->isHit()) {	18✔
127	return $this->localCache[$resourceClass] = $cacheItem->get();	13✔
128	}
129
130	$keys = array_keys($retriever($item));	5✔
131
132	$cacheItem->set($keys);	5✔
133	$this->cacheItemPool->save($cacheItem);	5✔
134
135	return $this->localCache[$resourceClass] = $keys;	5✔
136	}
137	}

api-platform / core / #27289

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