QueryRepository::evaluateBody() - Code Metrics - Inspection of "Support http cache" - bearsunday/BEAR.QueryRepository - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.x (#53)

by Akihito

created 2018-10-10 08:31 UTC

QueryRepository::evaluateBody() A

↳ Parent: QueryRepository

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	5
cts	5
cp	1
rs	9.8333
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	4

<?php
/**
 * This file is part of the BEAR.QueryRepository package.
 *
 * @license http://opensource.org/licenses/MIT MIT
 */
namespace BEAR\QueryRepository;

use BEAR\QueryRepository\Exception\ExpireAtKeyNotExists;
use BEAR\RepositoryModule\Annotation\Cacheable;
use BEAR\RepositoryModule\Annotation\Storage;
use BEAR\Resource\AbstractUri;
use BEAR\Resource\RequestInterface;
use BEAR\Resource\ResourceObject;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\Cache\Cache;

class QueryRepository implements QueryRepositoryInterface
{
    const ETAG_BY_URI = 'etag-by-uri';

    /**
     * @var Cache
     */
    private $kvs;

    /**
     * @var Reader
     */
    private $reader;

    /**
     * @var Expiry
     */
    private $expiry;

    /**
     * @var EtagSetterInterface
     */
    private $setEtag;

    /**
     * @Storage("kvs")
     */
    public function __construct(
        EtagSetterInterface $setEtag,
        Cache $kvs,
        Reader $reader,
        Expiry $expiry
    ) {
        $this->setEtag = $setEtag;
        $this->reader = $reader;
        $this->kvs = $kvs;
        $this->expiry = $expiry;
    }

    /**
     * {@inheritdoc}
     */
    public function put(ResourceObject $ro)
    {
        $ro->toString();
        ($this->setEtag)($ro);
        if (isset($ro->headers['ETag'])) {
            $this->updateEtagDatabase($ro);
        }
        /* @var $cacheable Cacheable */
        $cacheable = $this->getCacheable($ro);
        $body = $this->evaluateBody($ro->body);
        $lifeTime = $this->getExpiryTime($ro, $cacheable);
        $this->setMaxAge($ro, $lifeTime);
        $id = $this->getVaryUri($ro->uri);
        if ($cacheable instanceof Cacheable && $cacheable->type === 'view') {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            if (! $ro->view) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                // render
                $ro->view = $ro->toString();
            }

            return $this->kvs->save($id, [$ro->uri, $ro->code, $ro->headers, $body, $ro->view], $lifeTime);
        }
        // "value" cache type
        return $this->kvs->save($id, [$ro->uri, $ro->code, $ro->headers, $body, null], $lifeTime);
    }

    /**
     * {@inheritdoc}
     */
    public function get(AbstractUri $uri)
    {
        $id = $this->getVaryUri($uri);
        $data = $this->kvs->fetch($id);
        if ($data === false) {
            return false;
        }
        $age = \time() - \strtotime($data[2]['Last-Modified']);
        $data[2]['Age'] = $age;

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function purge(AbstractUri $uri)
    {
        $id = $this->getVaryUri($uri);
        $this->deleteEtagDatabase($uri);

        return $this->kvs->delete($id);
    }

    /**
     * Delete etag in etag repository
     *
     * @param AbstractUri $uri
     */
    public function deleteEtagDatabase(AbstractUri $uri)
    {
        $etagId = self::ETAG_BY_URI . $this->getVaryUri($uri); // invalidate etag

        $oldEtagKey = $this->kvs->fetch($etagId);

        $this->kvs->delete($oldEtagKey);
    }

    private function evaluateBody($body)
    {
        if (! \is_array($body)) {
            return $body;
        }
        foreach ($body as &$item) {
            if ($item instanceof RequestInterface) {
                $item = ($item)();
            }
        }

        return $body;
    }

    /**
     * @return Cacheable|null
     */
    private function getCacheable(ResourceObject $ro)
    {
        /** @var Cacheable|null $cache */
        $cache = $this->reader->getClassAnnotation(new \ReflectionClass($ro), Cacheable::class);

        return $cache;
    }

    /**
     * Update etag in etag repository
     *
     * @param ResourceObject $ro
     */
    private function updateEtagDatabase(ResourceObject $ro)
    {
        $etag = $ro->headers['ETag'];
        $uri = (string) $ro->uri;
        $etagUri = self::ETAG_BY_URI . $uri;
        $oldEtag = $this->kvs->fetch($etagUri);
        if ($oldEtag) {
            $this->kvs->delete($oldEtag);
        }
        $etagId = HttpCache::ETAG_KEY . $etag;
        $this->kvs->save($etagId, $uri);     // save etag
        $this->kvs->save($etagUri, $etagId); // save uri  mapping etag
    }

    private function getExpiryTime(ResourceObject $ro, Cacheable $cacheable = null) : int
    {
        if ($cacheable === null) {
            return 0;
        }

        if ($cacheable->expiryAt) {
            return $this->getExpiryAtSec($ro, $cacheable);
        }

        return $cacheable->expirySecond ? $cacheable->expirySecond : $this->expiry[$cacheable->expiry];
    }

    private function getExpiryAtSec(ResourceObject $ro, Cacheable $cacheable) : int
    {
        if (! isset($ro->body[$cacheable->expiryAt])) {
            $msg = \sprintf('%s::%s', \get_class($ro), $cacheable->expiryAt);
            throw new ExpireAtKeyNotExists($msg);
        }
        $expiryAt = $ro->body[$cacheable->expiryAt];
        $sec = \strtotime($expiryAt) - \time();

        return $sec;
    }

    private function setMaxAge(ResourceObject $ro, int $age)
    {
        $setMaxAge = \sprintf('max-age=%d', $age);
        if (isset($ro->headers['Cache-Control'])) {
            $ro->headers['Cache-Control'] .= ', ' . $setMaxAge;

            return;
        }
        $ro->headers['Cache-Control'] = $setMaxAge;
    }

    private function getVaryUri(AbstractUri $uri) : string
    {
        if (! isset($_SERVER['X_VARY'])) {
            return (string) $uri;
        }
        $varys = \explode(',', $_SERVER['X_VARY']);
        $varyId = '';
        foreach ($varys as $vary) {
            $phpVaryKey = \sprintf('X_%s', \strtoupper($vary));
            if (isset($_SERVER[$phpVaryKey])) {
                $varyId .= $_SERVER[$phpVaryKey];
            }
        }

        return (string) $uri . $varyId;
    }
}


Pull Request — 1.x (#53)

QueryRepository::evaluateBody() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
2		/**
3		* This file is part of the BEAR.QueryRepository package.
4		*
5		* @license http://opensource.org/licenses/MIT MIT
6		*/
7		namespace BEAR\QueryRepository;
8
9		use BEAR\QueryRepository\Exception\ExpireAtKeyNotExists;
10		use BEAR\RepositoryModule\Annotation\Cacheable;
11		use BEAR\RepositoryModule\Annotation\Storage;
12		use BEAR\Resource\AbstractUri;
13		use BEAR\Resource\RequestInterface;
14		use BEAR\Resource\ResourceObject;
15		use Doctrine\Common\Annotations\Reader;
16		use Doctrine\Common\Cache\Cache;
17
18		class QueryRepository implements QueryRepositoryInterface
19		{
20		const ETAG_BY_URI = 'etag-by-uri';
21
22		/**
23		* @var Cache
24		*/
25		private $kvs;
26
27		/**
28		* @var Reader
29		*/
30		private $reader;
31
32		/**
33		* @var Expiry
34		*/
35		private $expiry;
36
37		/**
38		* @var EtagSetterInterface
39		*/
40		private $setEtag;
41
42		/**
43		* @Storage("kvs")
44		*/
45		public function __construct(
46		EtagSetterInterface $setEtag,
47		Cache $kvs,
48		Reader $reader,
49		Expiry $expiry
50		) {
51	16	$this->setEtag = $setEtag;
52		$this->reader = $reader;
53		$this->kvs = $kvs;
54		$this->expiry = $expiry;
55		}
56
57	16	/**
58	16	* {@inheritdoc}
59	16	*/
60	16	public function put(ResourceObject $ro)
61	16	{
62		$ro->toString();
63		($this->setEtag)($ro);
64		if (isset($ro->headers['ETag'])) {
65		$this->updateEtagDatabase($ro);
66	14	}
67		/* @var $cacheable Cacheable */
68	14	$cacheable = $this->getCacheable($ro);
69	14	$body = $this->evaluateBody($ro->body);
70	14	$lifeTime = $this->getExpiryTime($ro, $cacheable);
71		$this->setMaxAge($ro, $lifeTime);
72		$id = $this->getVaryUri($ro->uri);
73	14	if ($cacheable instanceof Cacheable && $cacheable->type === 'view') {
		0 ignored issues – show Bug introduced 2016-08-03 12:44 UTC by Report Bug Copy Issue Report The class `BEAR\RepositoryModule\Annotation\Cacheable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
74	14	if (! $ro->view) {
		0 ignored issues – show Bug Best Practice introduced 2018-09-30 17:01 UTC by Report Bug Copy Issue Report The expression `$ro->view` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
75	14	// render
76	1	$ro->view = $ro->toString();
77		}
78	1
79		return $this->kvs->save($id, [$ro->uri, $ro->code, $ro->headers, $body, $ro->view], $lifeTime);
80		}
81	1	// "value" cache type
82		return $this->kvs->save($id, [$ro->uri, $ro->code, $ro->headers, $body, null], $lifeTime);
83		}
84	13
85		/**
86		* {@inheritdoc}
87		*/
88		public function get(AbstractUri $uri)
89		{
90	14	$id = $this->getVaryUri($uri);
91		$data = $this->kvs->fetch($id);
92	14	if ($data === false) {
93	14	return false;
94	13	}
95		$age = \time() - \strtotime($data[2]['Last-Modified']);
96		$data[2]['Age'] = $age;
97	10
98		return $data;
99		}
100
101		/**
102		* {@inheritdoc}
103	9	*/
104		public function purge(AbstractUri $uri)
105	9	{
106		$id = $this->getVaryUri($uri);
107	9	$this->deleteEtagDatabase($uri);
108
109		return $this->kvs->delete($id);
110		}
111
112		/**
113		* Delete etag in etag repository
114		*
115	9	* @param AbstractUri $uri
116		*/
117	9	public function deleteEtagDatabase(AbstractUri $uri)
118	9	{
119		$etagId = self::ETAG_BY_URI . $this->getVaryUri($uri); // invalidate etag
120	9
121	9	$oldEtagKey = $this->kvs->fetch($etagId);
122
123		$this->kvs->delete($oldEtagKey);
124		}
125
126	14	private function evaluateBody($body)
127		{
128	14	if (! \is_array($body)) {
129	12	return $body;
130		}
131	12	foreach ($body as &$item) {
132		if ($item instanceof RequestInterface) {
133		$item = ($item)();
134	2	}
135		}
136
137		return $body;
138		}
139
140		/**
141		* @return Cacheable\|null
142	14	*/
143		private function getCacheable(ResourceObject $ro)
144	14	{
145	14	/** @var Cacheable\|null $cache */
146	14	$cache = $this->reader->getClassAnnotation(new \ReflectionClass($ro), Cacheable::class);
147	14
148	14	return $cache;
149	7	}
150
151	14	/**
152	14	* Update etag in etag repository
153	14	*
154	14	* @param ResourceObject $ro
155		*/
156		private function updateEtagDatabase(ResourceObject $ro)
157		{
158		$etag = $ro->headers['ETag'];
159		$uri = (string) $ro->uri;
160		$etagUri = self::ETAG_BY_URI . $uri;
161	15	$oldEtag = $this->kvs->fetch($etagUri);
162		if ($oldEtag) {
163	15	$this->kvs->delete($oldEtag);
164	1	}
165		$etagId = HttpCache::ETAG_KEY . $etag;
166		$this->kvs->save($etagId, $uri); // save etag
167	14	$this->kvs->save($etagUri, $etagId); // save uri mapping etag
168		}
169
170		private function getExpiryTime(ResourceObject $ro, Cacheable $cacheable = null) : int
171		{
172		if ($cacheable === null) {
173		return 0;
174		}
175
176		if ($cacheable->expiryAt) {
177		return $this->getExpiryAtSec($ro, $cacheable);
178		}
179
180		return $cacheable->expirySecond ? $cacheable->expirySecond : $this->expiry[$cacheable->expiry];
181		}
182
183		private function getExpiryAtSec(ResourceObject $ro, Cacheable $cacheable) : int
184		{
185		if (! isset($ro->body[$cacheable->expiryAt])) {
186		$msg = \sprintf('%s::%s', \get_class($ro), $cacheable->expiryAt);
187		throw new ExpireAtKeyNotExists($msg);
188		}
189		$expiryAt = $ro->body[$cacheable->expiryAt];
190		$sec = \strtotime($expiryAt) - \time();
191
192		return $sec;
193		}
194
195		private function setMaxAge(ResourceObject $ro, int $age)
196		{
197		$setMaxAge = \sprintf('max-age=%d', $age);
198		if (isset($ro->headers['Cache-Control'])) {
199		$ro->headers['Cache-Control'] .= ', ' . $setMaxAge;
200
201		return;
202		}
203		$ro->headers['Cache-Control'] = $setMaxAge;
204		}
205
206		private function getVaryUri(AbstractUri $uri) : string
207		{
208		if (! isset($_SERVER['X_VARY'])) {
209		return (string) $uri;
210		}
211		$varys = \explode(',', $_SERVER['X_VARY']);
212		$varyId = '';
213		foreach ($varys as $vary) {
214		$phpVaryKey = \sprintf('X_%s', \strtoupper($vary));
215		if (isset($_SERVER[$phpVaryKey])) {
216		$varyId .= $_SERVER[$phpVaryKey];
217		}
218		}
219
220		return (string) $uri . $varyId;
221		}
222		}
223

bearsunday / BEAR.QueryRepository

Pull Request — 1.x (#53)

QueryRepository::evaluateBody() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like