CouchbaseBucketCache::doGetStats() - Code Metrics - doctrine/cache - Measure and Improve Code Quality continuously with Scrutinizer

CouchbaseBucketCache::doGetStats() A
last analyzed 2020-05-27 16:46 UTC

↳ Parent: CouchbaseBucketCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	11
c	1
b	0
f	1
nc	1
nop	0
dl	0
loc	14
ccs	0
cts	13
cp	0
crap	2
rs	9.9

<?php

declare(strict_types=1);

namespace Doctrine\Common\Cache;

use Couchbase\Bucket;
use Couchbase\Document;
use Couchbase\Exception;
use RuntimeException;
use function phpversion;
use function serialize;
use function sprintf;
use function substr;
use function time;
use function unserialize;
use function version_compare;

/**
 * Couchbase ^2.3.0 cache provider.
 */
final class CouchbaseBucketCache extends CacheProvider
{
    private const MINIMUM_VERSION = '2.3.0';

    private const KEY_NOT_FOUND = 13;

    private const MAX_KEY_LENGTH = 250;

    private const THIRTY_DAYS_IN_SECONDS = 2592000;

    /** @var Bucket */
    private $bucket;

    public function __construct(Bucket $bucket)
    {
        if (version_compare(phpversion('couchbase'), self::MINIMUM_VERSION) < 0) {
            // Manager is required to flush cache and pull stats.
            throw new RuntimeException(sprintf('ext-couchbase:^%s is required.', self::MINIMUM_VERSION));
        }

        $this->bucket = $bucket;
    }

    /**
     * {@inheritdoc}
     */
    protected function doFetch($id)
    {
        $id = $this->normalizeKey($id);

        try {
            $document = $this->bucket->get($id);
        } catch (Exception $e) {
            return false;
        }

        if ($document instanceof Document && $document->value !== false) {
            return unserialize($document->value);
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    protected function doContains($id)
    {
        $id = $this->normalizeKey($id);

        try {
            $document = $this->bucket->get($id);
        } catch (Exception $e) {
            return false;
        }

        if ($document instanceof Document) {
            return ! $document->error;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    protected function doSave($id, $data, $lifeTime = 0)
    {
        $id = $this->normalizeKey($id);

        $lifeTime = $this->normalizeExpiry($lifeTime);

        try {
            $encoded = serialize($data);

            $document = $this->bucket->upsert($id, $encoded, [
                'expiry' => (int) $lifeTime,
            ]);
        } catch (Exception $e) {
            return false;
        }

        if ($document instanceof Document) {
            return ! $document->error;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    protected function doDelete($id)
    {
        $id = $this->normalizeKey($id);

        try {
            $document = $this->bucket->remove($id);
        } catch (Exception $e) {
            return $e->getCode() === self::KEY_NOT_FOUND;
        }

        if ($document instanceof Document) {
            return ! $document->error;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    protected function doFlush()
    {
        $manager = $this->bucket->manager();

        // Flush does not return with success or failure, and must be enabled per bucket on the server.
        // Store a marker item so that we will know if it was successful.
        $this->doSave(__METHOD__, true, 60);

        $manager->flush();

        if ($this->doContains(__METHOD__)) {
            $this->doDelete(__METHOD__);

            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    protected function doGetStats()
    {
        $manager          = $this->bucket->manager();
        $stats            = $manager->info();
        $nodes            = $stats['nodes'];
        $node             = $nodes[0];
        $interestingStats = $node['interestingStats'];

        return [
            Cache::STATS_HITS   => $interestingStats['get_hits'],
            Cache::STATS_MISSES => $interestingStats['cmd_get'] - $interestingStats['get_hits'],
            Cache::STATS_UPTIME => $node['uptime'],
            Cache::STATS_MEMORY_USAGE     => $interestingStats['mem_used'],
            Cache::STATS_MEMORY_AVAILABLE => $node['memoryFree'],
        ];
    }

    private function normalizeKey(string $id) : string
    {
        $normalized = substr($id, 0, self::MAX_KEY_LENGTH);

        if ($normalized === false) {
            return $id;
        }

        return $normalized;
    }

    /**
     * Expiry treated as a unix timestamp instead of an offset if expiry is greater than 30 days.
     *
     * @src https://developer.couchbase.com/documentation/server/4.1/developer-guide/expiry.html
     */
    private function normalizeExpiry(int $expiry) : int
    {
        if ($expiry > self::THIRTY_DAYS_IN_SECONDS) {
            return time() + $expiry;
        }

        return $expiry;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Doctrine\Common\Cache;
6
7			use Couchbase\Bucket;
8			use Couchbase\Document;
9			use Couchbase\Exception;
10			use RuntimeException;
11			use function phpversion;
12			use function serialize;
13			use function sprintf;
14			use function substr;
15			use function time;
16			use function unserialize;
17			use function version_compare;
18
19			/**
20			* Couchbase ^2.3.0 cache provider.
21			*/
22			final class CouchbaseBucketCache extends CacheProvider
23			{
24			private const MINIMUM_VERSION = '2.3.0';
25
26			private const KEY_NOT_FOUND = 13;
27
28			private const MAX_KEY_LENGTH = 250;
29
30			private const THIRTY_DAYS_IN_SECONDS = 2592000;
31
32			/** @var Bucket */
33			private $bucket;
34
35			public function __construct(Bucket $bucket)
36			{
37			if (version_compare(phpversion('couchbase'), self::MINIMUM_VERSION) < 0) {
38			// Manager is required to flush cache and pull stats.
39			throw new RuntimeException(sprintf('ext-couchbase:^%s is required.', self::MINIMUM_VERSION));
40			}
41
42			$this->bucket = $bucket;
43			}
44
45			/**
46			* {@inheritdoc}
47			*/
48			protected function doFetch($id)
49			{
50			$id = $this->normalizeKey($id);
51
52			try {
53			$document = $this->bucket->get($id);
54			} catch (Exception $e) {
55			return false;
56			}
57
58			if ($document instanceof Document && $document->value !== false) {
59			return unserialize($document->value);
60			}
61
62			return false;
63			}
64
65			/**
66			* {@inheritdoc}
67			*/
68			protected function doContains($id)
69			{
70			$id = $this->normalizeKey($id);
71
72			try {
73			$document = $this->bucket->get($id);
74			} catch (Exception $e) {
75			return false;
76			}
77
78			if ($document instanceof Document) {
79			return ! $document->error;
80			}
81
82			return false;
83			}
84
85			/**
86			* {@inheritdoc}
87			*/
88			protected function doSave($id, $data, $lifeTime = 0)
89			{
90			$id = $this->normalizeKey($id);
91
92			$lifeTime = $this->normalizeExpiry($lifeTime);
93
94			try {
95			$encoded = serialize($data);
96
97			$document = $this->bucket->upsert($id, $encoded, [
98			'expiry' => (int) $lifeTime,
99			]);
100			} catch (Exception $e) {
101			return false;
102			}
103
104			if ($document instanceof Document) {
105			return ! $document->error;
106			}
107
108			return false;
109			}
110
111			/**
112			* {@inheritdoc}
113			*/
114			protected function doDelete($id)
115			{
116			$id = $this->normalizeKey($id);
117
118			try {
119			$document = $this->bucket->remove($id);
120			} catch (Exception $e) {
121			return $e->getCode() === self::KEY_NOT_FOUND;
122			}
123
124			if ($document instanceof Document) {
125			return ! $document->error;
126			}
127
128			return false;
129			}
130
131			/**
132			* {@inheritdoc}
133			*/
134			protected function doFlush()
135			{
136			$manager = $this->bucket->manager();
137
138			// Flush does not return with success or failure, and must be enabled per bucket on the server.
139			// Store a marker item so that we will know if it was successful.
140			$this->doSave(__METHOD__, true, 60);
141
142			$manager->flush();
143
144			if ($this->doContains(__METHOD__)) {
145			$this->doDelete(__METHOD__);
146
147			return false;
148			}
149
150			return true;
151			}
152
153			/**
154			* {@inheritdoc}
155			*/
156			protected function doGetStats()
157			{
158			$manager = $this->bucket->manager();
159			$stats = $manager->info();
160			$nodes = $stats['nodes'];
161			$node = $nodes[0];
162			$interestingStats = $node['interestingStats'];
163
164			return [
165			Cache::STATS_HITS => $interestingStats['get_hits'],
166			Cache::STATS_MISSES => $interestingStats['cmd_get'] - $interestingStats['get_hits'],
167			Cache::STATS_UPTIME => $node['uptime'],
168			Cache::STATS_MEMORY_USAGE => $interestingStats['mem_used'],
169			Cache::STATS_MEMORY_AVAILABLE => $node['memoryFree'],
170			];
171			}
172
173			private function normalizeKey(string $id) : string
174			{
175			$normalized = substr($id, 0, self::MAX_KEY_LENGTH);
176
177			if ($normalized === false) {
178			return $id;
179			}
180
181			return $normalized;
182			}
183
184			/**
185			* Expiry treated as a unix timestamp instead of an offset if expiry is greater than 30 days.
186			*
187			* @src https://developer.couchbase.com/documentation/server/4.1/developer-guide/expiry.html
188			*/
189			private function normalizeExpiry(int $expiry) : int
190			{
191			if ($expiry > self::THIRTY_DAYS_IN_SECONDS) {
192			return time() + $expiry;
193			}
194
195			return $expiry;
196			}
197			}
198

doctrine / cache

CouchbaseBucketCache::doGetStats() A last analyzed 2020-05-27 16:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CouchbaseBucketCache::doGetStats() A
last analyzed 2020-05-27 16:46 UTC