1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
|
"""Complete Limiter test suite
"""
import asyncio
import time
from inspect import isawaitable
import pytest
import sys
from .conftest import DEFAULT_RATES
from .conftest import logger
from .demo_bucket_factory import DemoAsyncGetBucketFactory
from .demo_bucket_factory import DemoBucketFactory
from .helpers import async_acquire
from .helpers import concurrent_acquire
from .helpers import flushing_bucket
from .helpers import inspect_bucket_items
from .helpers import prefilling_bucket
from pyrate_limiter import AbstractBucket
from pyrate_limiter import BucketAsyncWrapper
from pyrate_limiter import BucketFactory
from pyrate_limiter import Duration
from pyrate_limiter import InMemoryBucket
from pyrate_limiter import Limiter
from pyrate_limiter import RedisBucket
from pyrate_limiter import Rate
from pyrate_limiter import SingleBucketFactory
buffer_ms = 10
# Compute a windows specific jitter, due to clock timing
# on GHA's Windows runners
jitter_adjustment = 0
if sys.platform == "win32":
jitter_adjustment = 50
@pytest.mark.asyncio
async def test_limiter_constructor_01():
limiter = Limiter(DEFAULT_RATES[0])
assert isinstance(limiter.bucket_factory, BucketFactory)
assert isinstance(limiter.bucket_factory.bucket, InMemoryBucket)
assert limiter.bucket_factory.bucket.rates == [DEFAULT_RATES[0]]
limiter = Limiter(DEFAULT_RATES)
assert isinstance(limiter.bucket_factory, BucketFactory)
assert isinstance(limiter.bucket_factory.bucket, InMemoryBucket)
assert limiter.bucket_factory.bucket.rates == DEFAULT_RATES
assert len(limiter.buckets()) == 1
@pytest.mark.asyncio
async def test_limiter_constructor_02(
create_bucket,
):
bucket = await create_bucket(DEFAULT_RATES)
limiter = Limiter(bucket)
assert isinstance(limiter.bucket_factory, SingleBucketFactory)
limiter = Limiter(
bucket
)
assert isinstance(limiter.bucket_factory, BucketFactory)
acquire_ok = limiter.try_acquire("example")
if isawaitable(acquire_ok):
acquire_ok = await acquire_ok
assert acquire_ok
factory = DemoBucketFactory(demo=bucket)
limiter = Limiter(
factory,
)
assert limiter.bucket_factory is factory
@pytest.mark.asyncio
async def test_limiter_01(
request,
create_bucket,
):
if request.node.get_closest_marker("mpbucket"):
pytest.skip("Skipped mpbucket test due to erratic performance timing compared to more deterministic buckets")
bucket = await create_bucket(DEFAULT_RATES)
factory = DemoBucketFactory(demo=bucket)
limiter = Limiter(
factory,
buffer_ms=10
)
bucket = BucketAsyncWrapper(bucket)
await bucket.flush()
item = "demo"
logger.info("If weight = 0, it just passes thru")
acquire_ok, cost = await async_acquire(limiter, item, weight=0)
assert acquire_ok
assert cost <= (10+jitter_adjustment)
assert await bucket.count() == 0
logger.info("Limiter Test #1")
await prefilling_bucket(limiter, 0.3, item)
acquired, cost = await async_acquire(limiter, item, weight=0, blocking=False)
assert acquired
acquired, cost = await async_acquire(limiter, item, blocking=False)
assert not acquired
acquired, cost = await async_acquire(limiter, item, blocking=False)
assert not acquired
@pytest.mark.asyncredis
@pytest.mark.asyncio
async def test_limiter_async_factory_get_weight0(
):
factory = DemoAsyncGetBucketFactory()
limiter = Limiter(
factory,
buffer_ms=5
)
item = "demo"
logger.info("If weight = 0, it just passes thru")
acquire_ok, cost = await async_acquire(limiter, item, blocking=True, weight=0)
assert acquire_ok
assert cost <= 10
await prefilling_bucket(limiter, 0.3, item)
# Not blocking blocking, if weight is 0 then it's nearly instant
acquire_ok, cost = await async_acquire(limiter, item, blocking=True, weight=0)
assert acquire_ok
assert cost <= 10
# Even if blocking, if weight is 0 then it's nearly instant
acquire_ok, cost = await async_acquire(limiter, item, blocking=True, weight=0)
assert acquire_ok
assert cost <= 10
@pytest.mark.asyncredis
@pytest.mark.asyncio
async def test_limiter_async_factory_get(
):
factory = DemoAsyncGetBucketFactory()
limiter = Limiter(
factory,
buffer_ms=5
)
item = "demo"
await prefilling_bucket(limiter, 0.3, item)
# A non-blocking request should return immediately and fail
acquire_ok, cost = await async_acquire(limiter, item, blocking=False)
assert not acquire_ok
assert cost <= 50
# A blocking request should wait about 600+ ms
acquire_ok, cost = await async_acquire(limiter, item, blocking=True)
assert acquire_ok
assert 300 <= cost <= 900
# Same as above
acquire_ok, cost = await async_acquire(limiter, item)
assert acquire_ok
assert 300 <= cost <= 900
# # Flush before testing again
await factory.flush()
logger.info("Limiter Test #2")
await prefilling_bucket(limiter, 0, item)
# A non-blocking request should return immediately and fail
acquire_ok, cost = await async_acquire(limiter, item, blocking=False)
assert not acquire_ok
assert cost <= 50
# A blocking request should wait about 600+ ms
acquire_ok, cost = await async_acquire(limiter, item, blocking=True)
assert acquire_ok
assert 300 <= cost <= 1200
@pytest.mark.asyncio
async def test_limiter_concurrency(
create_bucket,
):
bucket = await create_bucket(DEFAULT_RATES)
factory = DemoBucketFactory(demo=bucket)
limiter = Limiter(
factory,
)
logger.info("Test Limiter Concurrency: inserting 4 items")
items = ["demo" for _ in range(4)]
result = await concurrent_acquire(limiter, items)
item_names = await inspect_bucket_items(bucket, 3)
result = await concurrent_acquire(limiter, items)
item_names = await inspect_bucket_items(bucket, 3)
logger.info(
"(No raise, delay is None or delay > max_delay) Result = %s, Item = %s",
result,
item_names,
)
@pytest.mark.asyncio
async def test_limiter_decorator(
create_bucket,
):
bucket = await create_bucket(DEFAULT_RATES)
factory = DemoBucketFactory(demo=bucket)
limiter = Limiter(
factory,
)
limiter_wrapper = limiter.as_decorator(name="demo", weight=1)
counter = 0
@limiter_wrapper
async def async_inc_counter(num: int):
nonlocal counter
counter += num
if isawaitable(bucket.count()):
with pytest.raises(RuntimeError):
@limiter_wrapper
def inc_counter(num: int):
nonlocal counter
counter += num
inc = inc_counter(1)
else:
@limiter_wrapper
def inc_counter(num: int):
nonlocal counter
counter += num
inc = inc_counter(1)
if isawaitable(inc):
await inc
assert counter == 1
await async_inc_counter(1)
assert counter == 2
async def test_wait_too_long():
requests_per_second = 10
rate = Rate(requests_per_second, Duration.SECOND)
bucket = InMemoryBucket([rate])
limiter = Limiter(bucket)
for i in range(500):
success = limiter.try_acquire("mytest", weight=1, blocking=False)
if not success:
break
assert not success # retried and then failed
time.sleep(1)
# raise_when_fail = True
limiter = Limiter(bucket)
tasks = [limiter.try_acquire_async("mytest", 1, timeout=0.0001) for i in range(500)]
r = await asyncio.gather(*tasks)
# Not all requests could be satisfied within the timeout
assert not all(r)
async def test_bucket_no_schedule_leak():
rates = [Rate(100, 1000)]
bucket = InMemoryBucket(rates)
bucket_factory = SingleBucketFactory(bucket, schedule_leak=False)
limiter = Limiter(bucket_factory)
acquired = limiter.try_acquire("test", 1)
acquired = limiter.try_acquire("test", 1)
assert acquired
await asyncio.sleep(1.2)
assert bucket.count() == 2
|