MongoDBCache::doFetch() - Code Metrics - Inspection of "Create expiration index when getting expired entry" - doctrine/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#221)

by Andreas

created 2017-05-26 15:25 UTC

MongoDBCache::doFetch() A

↳ Parent: MongoDBCache

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.3332

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	6
cts	9
cp	0.6667
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	1
crap	3.3332

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\Common\Cache;

use MongoBinData;
use MongoCollection;
use MongoCursorException;
use MongoDate;

/**
 * MongoDB cache provider.
 *
 * @since  1.1
 * @author Jeremy Mikola <[email protected]>
 */
class MongoDBCache extends CacheProvider
{
    /**
     * The data field will store the serialized PHP value.
     */
    const DATA_FIELD = 'd';

    /**
     * The expiration field will store a MongoDate value indicating when the
     * cache entry should expire.
     *
     * With MongoDB 2.2+, entries can be automatically deleted by MongoDB by
     * indexing this field with the "expireAfterSeconds" option equal to zero.
     * This will direct MongoDB to regularly query for and delete any entries
     * whose date is older than the current time. Entries without a date value
     * in this field will be ignored.
     *
     * The cache provider will also check dates on its own, in case expired
     * entries are fetched before MongoDB's TTLMonitor pass can expire them.
     *
     * @see http://docs.mongodb.org/manual/tutorial/expire-data/
     */
    const EXPIRATION_FIELD = 'e';

    /**
     * @var MongoCollection
     */
    private $collection;

    /**
     * @var bool
     */
    private $expirationIndexCreated = false;

    /**
     * Constructor.
     *
     * This provider will default to the write concern and read preference
     * options set on the MongoCollection instance (or inherited from MongoDB or
     * MongoClient). Using an unacknowledged write concern (< 1) may make the
     * return values of delete() and save() unreliable. Reading from secondaries
     * may make contain() and fetch() unreliable.
     *
     * @see http://www.php.net/manual/en/mongo.readpreferences.php
     * @see http://www.php.net/manual/en/mongo.writeconcerns.php
     * @param MongoCollection $collection
     */
    public function __construct(MongoCollection $collection)
    {
        $this->collection = $collection;
    }

    /**
     * {@inheritdoc}
     */
    protected function doFetch($id)
    {
        $document = $this->collection->findOne(['_id' => $id], [self::DATA_FIELD, self::EXPIRATION_FIELD]);

        if ($document === null) {
            return false;
        }

        if ($this->isExpired($document)) {
            $this->createExpirationIndex();
            $this->doDelete($id);
            return false;
        }

        return unserialize($document[self::DATA_FIELD]->bin);
    }

    /**
     * {@inheritdoc}
     */
    protected function doContains($id)
    {
        $document = $this->collection->findOne(['_id' => $id], [self::EXPIRATION_FIELD]);

        if ($document === null) {
            return false;
        }

        if ($this->isExpired($document)) {
            $this->createExpirationIndex();
            $this->doDelete($id);
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doSave($id, $data, $lifeTime = 0)
    {
        try {
            $result = $this->collection->update(
                ['_id' => $id],
                ['$set' => [
                    self::EXPIRATION_FIELD => ($lifeTime > 0 ? new MongoDate(time() + $lifeTime) : null),
                    self::DATA_FIELD => new MongoBinData(serialize($data), MongoBinData::BYTE_ARRAY),
                ]],
                ['upsert' => true, 'multiple' => false]
            );
        } catch (MongoCursorException $e) {
            return false;
        }

        return isset($result['ok']) ? $result['ok'] == 1 : true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doDelete($id)
    {
        $result = $this->collection->remove(['_id' => $id]);

        return isset($result['ok']) ? $result['ok'] == 1 : true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doFlush()
    {
        // Use remove() in lieu of drop() to maintain any collection indexes
        $result = $this->collection->remove();

        return isset($result['ok']) ? $result['ok'] == 1 : true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doGetStats()
    {
        $serverStatus = $this->collection->db->command([
            'serverStatus' => 1,
            'locks' => 0,
            'metrics' => 0,
            'recordStats' => 0,
            'repl' => 0,
        ]);

        $collStats = $this->collection->db->command(['collStats' => 1]);

        return [
            Cache::STATS_HITS => null,
            Cache::STATS_MISSES => null,
            Cache::STATS_UPTIME => (isset($serverStatus['uptime']) ? (int) $serverStatus['uptime'] : null),
            Cache::STATS_MEMORY_USAGE => (isset($collStats['size']) ? (int) $collStats['size'] : null),
            Cache::STATS_MEMORY_AVAILABLE  => null,
        ];
    }

    /**
     * Check if the document is expired.
     *
     * @param array $document
     *
     * @return bool
     */
    private function isExpired(array $document) : bool
    {
        return isset($document[self::EXPIRATION_FIELD]) &&
            $document[self::EXPIRATION_FIELD] instanceof MongoDate &&
            $document[self::EXPIRATION_FIELD]->sec < time();
    }

    private function createExpirationIndex(): void
    {
        if ($this->expirationIndexCreated) {
            return;
        }

        $this->expirationIndexCreated = true;
        $this->collection->createIndex([self::EXPIRATION_FIELD => 1], ['background' => true, 'expireAfterSeconds' => 0]);
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\Common\Cache;
21
22		use MongoBinData;
23		use MongoCollection;
24		use MongoCursorException;
25		use MongoDate;
26
27		/**
28		* MongoDB cache provider.
29		*
30		* @since 1.1
31		* @author Jeremy Mikola <[email protected]>
32		*/
33		class MongoDBCache extends CacheProvider
34		{
35		/**
36		* The data field will store the serialized PHP value.
37		*/
38		const DATA_FIELD = 'd';
39
40		/**
41		* The expiration field will store a MongoDate value indicating when the
42		* cache entry should expire.
43		*
44		* With MongoDB 2.2+, entries can be automatically deleted by MongoDB by
45		* indexing this field with the "expireAfterSeconds" option equal to zero.
46		* This will direct MongoDB to regularly query for and delete any entries
47		* whose date is older than the current time. Entries without a date value
48		* in this field will be ignored.
49		*
50		* The cache provider will also check dates on its own, in case expired
51		* entries are fetched before MongoDB's TTLMonitor pass can expire them.
52		*
53		* @see http://docs.mongodb.org/manual/tutorial/expire-data/
54		*/
55		const EXPIRATION_FIELD = 'e';
56
57		/**
58		* @var MongoCollection
59		*/
60		private $collection;
61
62		/**
63		* @var bool
64		*/
65		private $expirationIndexCreated = false;
66
67		/**
68		* Constructor.
69		*
70		* This provider will default to the write concern and read preference
71		* options set on the MongoCollection instance (or inherited from MongoDB or
72		* MongoClient). Using an unacknowledged write concern (< 1) may make the
73		* return values of delete() and save() unreliable. Reading from secondaries
74		* may make contain() and fetch() unreliable.
75		*
76		* @see http://www.php.net/manual/en/mongo.readpreferences.php
77		* @see http://www.php.net/manual/en/mongo.writeconcerns.php
78		* @param MongoCollection $collection
79		*/
80	78	public function __construct(MongoCollection $collection)
81		{
82	78	$this->collection = $collection;
83	78	}
84
85		/**
86		* {@inheritdoc}
87		*/
88	76	protected function doFetch($id)
89		{
90	76	$document = $this->collection->findOne(['_id' => $id], [self::DATA_FIELD, self::EXPIRATION_FIELD]);
91
92	76	if ($document === null) {
93	76	return false;
94		}
95
96	64	if ($this->isExpired($document)) {
97		$this->createExpirationIndex();
98		$this->doDelete($id);
99		return false;
100		}
101
102	64	return unserialize($document[self::DATA_FIELD]->bin);
103		}
104
105		/**
106		* {@inheritdoc}
107		*/
108	72	protected function doContains($id)
109		{
110	72	$document = $this->collection->findOne(['_id' => $id], [self::EXPIRATION_FIELD]);
111
112	72	if ($document === null) {
113	52	return false;
114		}
115
116	68	if ($this->isExpired($document)) {
117	1	$this->createExpirationIndex();
118	1	$this->doDelete($id);
119	1	return false;
120		}
121
122	68	return true;
123		}
124
125		/**
126		* {@inheritdoc}
127		*/
128	74	protected function doSave($id, $data, $lifeTime = 0)
129		{
130		try {
131	74	$result = $this->collection->update(
132	74	['_id' => $id],
133	74	['$set' => [
134	74	self::EXPIRATION_FIELD => ($lifeTime > 0 ? new MongoDate(time() + $lifeTime) : null),
135	74	self::DATA_FIELD => new MongoBinData(serialize($data), MongoBinData::BYTE_ARRAY),
136		]],
137	74	['upsert' => true, 'multiple' => false]
138		);
139	1	} catch (MongoCursorException $e) {
140	1	return false;
141		}
142
143	73	return isset($result['ok']) ? $result['ok'] == 1 : true;
144		}
145
146		/**
147		* {@inheritdoc}
148		*/
149	46	protected function doDelete($id)
150		{
151	46	$result = $this->collection->remove(['_id' => $id]);
152
153	46	return isset($result['ok']) ? $result['ok'] == 1 : true;
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159	2	protected function doFlush()
160		{
161		// Use remove() in lieu of drop() to maintain any collection indexes
162	2	$result = $this->collection->remove();
163
164	2	return isset($result['ok']) ? $result['ok'] == 1 : true;
165		}
166
167		/**
168		* {@inheritdoc}
169		*/
170	1	protected function doGetStats()
171		{
172	1	$serverStatus = $this->collection->db->command([
173	1	'serverStatus' => 1,
174		'locks' => 0,
175		'metrics' => 0,
176		'recordStats' => 0,
177		'repl' => 0,
178		]);
179
180	1	$collStats = $this->collection->db->command(['collStats' => 1]);
181
182		return [
183	1	Cache::STATS_HITS => null,
184	1	Cache::STATS_MISSES => null,
185	1	Cache::STATS_UPTIME => (isset($serverStatus['uptime']) ? (int) $serverStatus['uptime'] : null),
186	1	Cache::STATS_MEMORY_USAGE => (isset($collStats['size']) ? (int) $collStats['size'] : null),
187	1	Cache::STATS_MEMORY_AVAILABLE => null,
188		];
189		}
190
191		/**
192		* Check if the document is expired.
193		*
194		* @param array $document
195		*
196		* @return bool
197		*/
198	69	private function isExpired(array $document) : bool
199		{
200	69	return isset($document[self::EXPIRATION_FIELD]) &&
201	2	$document[self::EXPIRATION_FIELD] instanceof MongoDate &&
202	69	$document[self::EXPIRATION_FIELD]->sec < time();
203		}
204
205	1	private function createExpirationIndex(): void
206		{
207	1	if ($this->expirationIndexCreated) {
208		return;
209		}
210
211	1	$this->expirationIndexCreated = true;
212	1	$this->collection->createIndex([self::EXPIRATION_FIELD => 1], ['background' => true, 'expireAfterSeconds' => 0]);
213	1	}
214		}
215

doctrine / cache

Pull Request — master (#221)

MongoDBCache::doFetch() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like