#24784

pending completion

Build # #24784

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/bcbe31845f928e0a3284afe6b6d16d79d9efd312">bcbe31845<a href="https://github.com/api-platform/core/commit/bcbe31845f928e0a3284afe6b6d16d79d9efd312">">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/a9e94fb42b7f3347b8e2cff894f7e611ef5ddae9">a9e94fb42</a>">a9e94fb42</a><a href="https://github.com/api-platform/core/commit/bcbe31845f928e0a3284afe6b6d16d79d9efd312"> into 5a7c2e429">5a7c2e429</a>

Run Details

13 of 13 new or added lines in 1 file covered. (100.0%)

6376 of 11029 relevant lines covered (57.81%)

68.82 hits per line

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

88.37

/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 IdentifiersExtractorInterface
{
    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
    {
        $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 IdentifiersExtractorInterface
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;	526✔
42	$this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();	526✔
43	$this->decorated = $decorated;	526✔
44	$this->resourceClassResolver = $resourceClassResolver;	526✔
45
46	if (null === $this->resourceClassResolver) {	526✔
47	@trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), E_USER_DEPRECATED);	×
48	}
49	}	526✔
50
51	/**
52	* {@inheritdoc}
53	*/
54	public function getIdentifiersFromResourceClass(string $resourceClass): array
55	{
56	if (isset($this->localResourceCache[$resourceClass])) {	183✔
57	return $this->localResourceCache[$resourceClass];	12✔
58	}
59
60	return $this->localResourceCache[$resourceClass] = $this->decorated->getIdentifiersFromResourceClass($resourceClass);	183✔
61	}
62
63	/**
64	* {@inheritdoc}
65	*/
66	public function getIdentifiersFromItem($item): array
67	{
68	$keys = $this->getKeys($item, function ($item) use (&$identifiers) {
69	return $identifiers = $this->decorated->getIdentifiersFromItem($item);	79✔
70	});	400✔
71
72	if (null !== $identifiers) {	400✔
73	return $identifiers;	79✔
74	}
75
76	$identifiers = [];	396✔
77	foreach ($keys as $propertyName) {	396✔
78	$identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);	396✔
79
80	if (!\is_object($identifiers[$propertyName])) {	396✔
81	continue;	394✔
82	}
83
84	if (null === $relatedResourceClass = $this->getResourceClass($identifiers[$propertyName])) {	13✔
85	continue;	2✔
86	}
87
88	if (!$relatedIdentifiers = $this->localCache[$relatedResourceClass] ?? false) {	11✔
89	$relatedCacheKey = self::CACHE_KEY_PREFIX.md5($relatedResourceClass);	9✔
90	try {
91	$relatedCacheItem = $this->cacheItemPool->getItem($relatedCacheKey);	9✔
92	if (!$relatedCacheItem->isHit()) {	9✔
93	return $this->decorated->getIdentifiersFromItem($item);	9✔
94	}
95	} catch (CacheException $e) {	×
96	return $this->decorated->getIdentifiersFromItem($item);	×
97	}
98
99	$relatedIdentifiers = $relatedCacheItem->get();	9✔
100	}
101
102	$identifiers[$propertyName] = $this->propertyAccessor->getValue($identifiers[$propertyName], $relatedIdentifiers[0]);	11✔
103	}
104
105	return $identifiers;	396✔
106	}
107
108	private function getKeys($item, callable $retriever): array
109	{
110	$resourceClass = $this->getObjectClass($item);	400✔
111	if (isset($this->localCache[$resourceClass])) {	400✔
112	return $this->localCache[$resourceClass];	308✔
113	}
114
115	try {
116	$cacheItem = $this->cacheItemPool->getItem(self::CACHE_KEY_PREFIX.md5($resourceClass));	400✔
117	} catch (CacheException $e) {	×
118	return $this->localCache[$resourceClass] = array_keys($retriever($item));	×
119	}
120
121	if ($cacheItem->isHit()) {	400✔
122	return $this->localCache[$resourceClass] = $cacheItem->get();	359✔
123	}
124
125	$keys = array_keys($retriever($item));	79✔
126
127	$cacheItem->set($keys);	79✔
128	$this->cacheItemPool->save($cacheItem);	79✔
129
130	return $this->localCache[$resourceClass] = $keys;	79✔
131	}
132	}

api-platform / core / #24784

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