LeakyBucketThrottler::__construct() - Code Metrics - Inspection of "Additional throttler types (#5)" - sunspikes/php-ratelimiter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 553806...856339 )

by Krishnaprasad

created 2017-01-02 16:58 UTC

LeakyBucketThrottler::__construct() A

↳ Parent: LeakyBucketThrottler

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	17
c	0
b	0
f	0
ccs	9
cts	9
cp	1
rs	9.4285
cc	2
eloc	15
nc	2
nop	7
crap	2

<?php
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Krishnaprasad MG <[email protected]>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Sunspikes\Ratelimit\Throttle\Throttler;

use Sunspikes\Ratelimit\Cache\Exception\ItemNotFoundException;
use Sunspikes\Ratelimit\Cache\Adapter\CacheAdapterInterface;
use Sunspikes\Ratelimit\Time\TimeAdapterInterface;

final class LeakyBucketThrottler implements RetriableThrottlerInterface
{
    const TIME_CACHE_KEY = ':time';
    const TOKEN_CACHE_KEY = ':tokens';

    /**
     * @var CacheAdapterInterface
     */
    private $cache;

    /**
     * @var int|null
     */
    private $cacheTtl;

    /**
     * @var string
     */
    private $key;

    /**
     * @var int
     */
    private $threshold;

    /**
     * @var TimeAdapterInterface
     */
    private $timeProvider;

    /**
     * @var int
     */
    private $timeLimit;

    /**
     * @var int
     */
    private $tokenlimit;

    /**
     * @param CacheAdapterInterface $cache
     * @param TimeAdapterInterface  $timeAdapter
     * @param string                $key          Cache key prefix
     * @param int                   $tokenLimit   Bucket capacity
     * @param int                   $timeLimit    Refill time in milliseconds
     * @param int|null              $threshold    Capacity threshold on which to start throttling (default: 0)
     * @param int|null              $cacheTtl     Cache ttl time (default: null => CacheAdapter ttl)
     */
    public function __construct(
        CacheAdapterInterface $cache,
        TimeAdapterInterface $timeAdapter,
        $key,
        $tokenLimit,
        $timeLimit,
        $threshold = null,
        $cacheTtl = null
    ) {
        $this->cache = $cache;
        $this->timeProvider = $timeAdapter;
        $this->key = $key;
        $this->tokenlimit = $tokenLimit;
        $this->timeLimit = $timeLimit;
        $this->cacheTtl = $cacheTtl;
        $this->threshold = null !== $threshold ? $threshold : 0;
    }

    /**
     * @inheritdoc
     */
    public function access()
    {
        return 0 === $this->hit();
    }

    /**
     * @inheritdoc
     */
    public function hit()
    {
        $tokenCount = $this->count();

        $this->setUsedCapacity($tokenCount + 1);

        if (0 < $wait = $this->getWaitTime($tokenCount)) {
            $this->timeProvider->usleep(1e3 * $wait);
        }

        return $wait;
    }

    /**
     * @inheritdoc
     */
    public function clear()
    {
        $this->setUsedCapacity(0);
    }

    /**
     * @inheritdoc
     */
    public function count()
    {
        try {
            $timeSinceLastRequest = 1e3 * ($this->timeProvider->now() - $this->cache->get($this->key.self::TIME_CACHE_KEY));

            if ($timeSinceLastRequest > $this->timeLimit) {
                return 0;
            }

            $lastTokenCount = $this->cache->get($this->key.self::TOKEN_CACHE_KEY);
        } catch (ItemNotFoundException $exception) {
            $this->clear(); //Clear the bucket

            return 0;
        }

        // Return the `used` token count, minus the amount of tokens which have been `refilled` since the previous request
        return  (int) max(0, ceil($lastTokenCount - ($this->tokenlimit * $timeSinceLastRequest / ($this->timeLimit))));
    }

    /**
     * @inheritdoc
     */
    public function check()
    {
        return 0 === $this->getWaitTime($this->count());
    }

    /**
     * @inheritdoc
     */
    public function getTime()
    {
        return $this->timeLimit;
    }

    /**
     * @inheritdoc
     */
    public function getLimit()
    {
        return $this->tokenlimit;
    }

    /**
     * @inheritdoc
     */
    public function getRetryTimeout()

    {
        if ($this->threshold > $this->count() + 1) {
            return 0;
        }

        return (int) ceil($this->timeLimit / $this->tokenlimit);
    }

    /**
     * @param int $tokenCount
     *
     * @return int
     */
    private function getWaitTime($tokenCount)

    {
        if ($this->threshold > $tokenCount) {
            return 0;
        }

        return (int) ceil($this->timeLimit / max(1, ($this->tokenlimit - $this->threshold)));
    }

    /**
     * @param int $tokens
     */
    private function setUsedCapacity($tokens)
    {
        $this->cache->set($this->key.self::TOKEN_CACHE_KEY, $tokens, $this->cacheTtl);
        $this->cache->set($this->key.self::TIME_CACHE_KEY, $this->timeProvider->now(), $this->cacheTtl);
    }
}


1			<?php
2			/**
3			* The MIT License (MIT)
4			*
5			* Copyright (c) 2015 Krishnaprasad MG <[email protected]>
6			*
7			* Permission is hereby granted, free of charge, to any person obtaining a copy
8			* of this software and associated documentation files (the "Software"), to deal
9			* in the Software without restriction, including without limitation the rights
10			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11			* copies of the Software, and to permit persons to whom the Software is
12			* furnished to do so, subject to the following conditions:
13			*
14			* The above copyright notice and this permission notice shall be included in all
15			* copies or substantial portions of the Software.
16			*
17			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23			* SOFTWARE.
24			*/
25
26			namespace Sunspikes\Ratelimit\Throttle\Throttler;
27
28			use Sunspikes\Ratelimit\Cache\Exception\ItemNotFoundException;
29			use Sunspikes\Ratelimit\Cache\Adapter\CacheAdapterInterface;
30			use Sunspikes\Ratelimit\Time\TimeAdapterInterface;
31
32			final class LeakyBucketThrottler implements RetriableThrottlerInterface
33			{
34			const TIME_CACHE_KEY = ':time';
35			const TOKEN_CACHE_KEY = ':tokens';
36
37			/**
38			* @var CacheAdapterInterface
39			*/
40			private $cache;
41
42			/**
43			* @var int\|null
44			*/
45			private $cacheTtl;
46
47			/**
48			* @var string
49			*/
50			private $key;
51
52			/**
53			* @var int
54			*/
55			private $threshold;
56
57			/**
58			* @var TimeAdapterInterface
59			*/
60			private $timeProvider;
61
62			/**
63			* @var int
64			*/
65			private $timeLimit;
66
67			/**
68			* @var int
69			*/
70			private $tokenlimit;
71
72			/**
73			* @param CacheAdapterInterface $cache
74			* @param TimeAdapterInterface $timeAdapter
75			* @param string $key Cache key prefix
76			* @param int $tokenLimit Bucket capacity
77			* @param int $timeLimit Refill time in milliseconds
78			* @param int\|null $threshold Capacity threshold on which to start throttling (default: 0)
79			* @param int\|null $cacheTtl Cache ttl time (default: null => CacheAdapter ttl)
80			*/
81	16		public function __construct(
82			CacheAdapterInterface $cache,
83			TimeAdapterInterface $timeAdapter,
84			$key,
85			$tokenLimit,
86			$timeLimit,
87			$threshold = null,
88			$cacheTtl = null
89			) {
90	16		$this->cache = $cache;
91	16		$this->timeProvider = $timeAdapter;
92	16		$this->key = $key;
93	16		$this->tokenlimit = $tokenLimit;
94	16		$this->timeLimit = $timeLimit;
95	16		$this->cacheTtl = $cacheTtl;
96	16		$this->threshold = null !== $threshold ? $threshold : 0;
97	16		}
98
99			/**
100			* @inheritdoc
101			*/
102	3		public function access()
103			{
104	3		return 0 === $this->hit();
105			}
106
107			/**
108			* @inheritdoc
109			*/
110	8		public function hit()
111			{
112	8		$tokenCount = $this->count();
113
114	8		$this->setUsedCapacity($tokenCount + 1);
115
116	8		if (0 < $wait = $this->getWaitTime($tokenCount)) {
117	2		$this->timeProvider->usleep(1e3 * $wait);
118	2		}
119
120	8		return $wait;
121			}
122
123			/**
124			* @inheritdoc
125			*/
126	7		public function clear()
127			{
128	7		$this->setUsedCapacity(0);
129	7		}
130
131			/**
132			* @inheritdoc
133			*/
134	14		public function count()
135			{
136			try {
137	14		$timeSinceLastRequest = 1e3 * ($this->timeProvider->now() - $this->cache->get($this->key.self::TIME_CACHE_KEY));
138
139	13		if ($timeSinceLastRequest > $this->timeLimit) {
140	4		return 0;
141			}
142
143	9		$lastTokenCount = $this->cache->get($this->key.self::TOKEN_CACHE_KEY);
144	10		} catch (ItemNotFoundException $exception) {
145	6		$this->clear(); //Clear the bucket
146
147	6		return 0;
148			}
149
150			// Return the `used` token count, minus the amount of tokens which have been `refilled` since the previous request
151	9		return (int) max(0, ceil($lastTokenCount - ($this->tokenlimit * $timeSinceLastRequest / ($this->timeLimit))));
152			}
153
154			/**
155			* @inheritdoc
156			*/
157	3		public function check()
158			{
159	3		return 0 === $this->getWaitTime($this->count());
160			}
161
162			/**
163			* @inheritdoc
164			*/
165			public function getTime()
166			{
167			return $this->timeLimit;
168			}
169
170			/**
171			* @inheritdoc
172			*/
173			public function getLimit()
174			{
175			return $this->tokenlimit;
176			}
177
178			/**
179			* @inheritdoc
180			*/
181	2	View Code Duplication	public function getRetryTimeout()
			0 ignored issues – show Duplication introduced 2016-12-21 09:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
182			{
183	2		if ($this->threshold > $this->count() + 1) {
184	1		return 0;
185			}
186
187	1		return (int) ceil($this->timeLimit / $this->tokenlimit);
188			}
189
190			/**
191			* @param int $tokenCount
192			*
193			* @return int
194			*/
195	9	View Code Duplication	private function getWaitTime($tokenCount)
			0 ignored issues – show Duplication introduced 2016-12-21 09:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
196			{
197	9		if ($this->threshold > $tokenCount) {
198	8		return 0;
199			}
200
201	3		return (int) ceil($this->timeLimit / max(1, ($this->tokenlimit - $this->threshold)));
202			}
203
204			/**
205			* @param int $tokens
206			*/
207	10		private function setUsedCapacity($tokens)
208			{
209	10		$this->cache->set($this->key.self::TOKEN_CACHE_KEY, $tokens, $this->cacheTtl);
210	10		$this->cache->set($this->key.self::TIME_CACHE_KEY, $this->timeProvider->now(), $this->cacheTtl);
211	10		}
212			}
213

sunspikes / php-ratelimiter

Push — master ( 553806...856339 )

LeakyBucketThrottler::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like