-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathtest_token_manager.py
More file actions
707 lines (553 loc) ยท 23.5 KB
/
test_token_manager.py
File metadata and controls
707 lines (553 loc) ยท 23.5 KB
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
"""Unit tests for TokenManager implementations."""
import asyncio
import pickle
import time
from collections.abc import Callable, Generator
from contextlib import asynccontextmanager
from unittest.mock import AsyncMock, Mock, patch
import pytest
from reflex import config
from reflex.app import EventNamespace
from reflex.istate.data import RouterData
from reflex.state import StateUpdate
from reflex.utils.token_manager import (
LocalTokenManager,
RedisTokenManager,
SocketRecord,
TokenManager,
)
class TestTokenManager:
"""Tests for the TokenManager factory."""
@patch("reflex.utils.token_manager.prerequisites.check_redis_used")
@patch("reflex.utils.token_manager.prerequisites.get_redis")
def test_create_local_when_no_redis(self, mock_get_redis, mock_check_redis_used):
"""Test factory creates LocalTokenManager when Redis is not available.
Args:
mock_get_redis: Mock for prerequisites.get_redis.
mock_check_redis_used: Mock for prerequisites.check_redis_used.
"""
mock_check_redis_used.return_value = False
manager = TokenManager.create()
assert isinstance(manager, LocalTokenManager)
mock_get_redis.assert_not_called()
@patch("reflex.utils.token_manager.prerequisites.check_redis_used")
@patch("reflex.utils.token_manager.prerequisites.get_redis")
def test_create_local_when_redis_client_none(
self, mock_get_redis, mock_check_redis_used
):
"""Test factory creates LocalTokenManager when Redis client is None.
Args:
mock_get_redis: Mock for prerequisites.get_redis.
mock_check_redis_used: Mock for prerequisites.check_redis_used.
"""
mock_check_redis_used.return_value = True
mock_get_redis.return_value = None
manager = TokenManager.create()
assert isinstance(manager, LocalTokenManager)
@patch("reflex.utils.token_manager.prerequisites.check_redis_used")
@patch("reflex.utils.token_manager.prerequisites.get_redis")
def test_create_redis_when_redis_available(
self, mock_get_redis, mock_check_redis_used
):
"""Test factory creates RedisTokenManager when Redis is available.
Args:
mock_get_redis: Mock for prerequisites.get_redis.
mock_check_redis_used: Mock for prerequisites.check_redis_used.
"""
mock_check_redis_used.return_value = True
mock_redis_client = Mock()
mock_redis_client.get_connection_kwargs.return_value = {"db": 0}
mock_get_redis.return_value = mock_redis_client
manager = TokenManager.create()
assert isinstance(manager, RedisTokenManager)
assert manager.redis is mock_redis_client
class TestLocalTokenManager:
"""Tests for LocalTokenManager."""
@pytest.fixture
def manager(self):
"""Create a LocalTokenManager instance.
Returns:
A LocalTokenManager instance for testing.
"""
return LocalTokenManager()
@pytest.mark.parametrize(
("token", "sid"),
[
("token1", "sid1"),
("test-token", "test-sid"),
("12345", "67890"),
],
)
async def test_link_token_to_sid_normal_case(self, manager, token, sid):
"""Test normal token linking returns None.
Args:
manager: LocalTokenManager fixture instance.
token: Token string to test.
sid: Session ID string to test.
"""
result = await manager.link_token_to_sid(token, sid)
assert result is None
assert manager.token_to_sid[token] == sid
assert manager.sid_to_token[sid] == token
async def test_link_token_to_sid_same_token_same_sid(self, manager):
"""Test linking same token to same SID (reconnection).
Args:
manager: LocalTokenManager fixture instance.
"""
token, sid = "token1", "sid1"
await manager.link_token_to_sid(token, sid)
result = await manager.link_token_to_sid(token, sid)
assert result is None
assert manager.token_to_sid[token] == sid
assert manager.sid_to_token[sid] == token
async def test_link_token_to_sid_duplicate_token_different_sid(self, manager):
"""Test duplicate token detection generates new token.
Args:
manager: LocalTokenManager fixture instance.
"""
token = "duplicate_token"
sid1, sid2 = "sid1", "sid2"
# First connection
result1 = await manager.link_token_to_sid(token, sid1)
assert result1 is None
# Duplicate token with different SID
result2 = await manager.link_token_to_sid(token, sid2)
assert result2 is not None
assert result2 != token
# Check mappings
assert manager.token_to_sid[result2] == sid2
assert manager.sid_to_token[sid2] == result2
assert manager.token_to_sid[token] == sid1
@pytest.mark.parametrize(
("token", "sid"),
[
("token1", "sid1"),
("test-token", "test-sid"),
],
)
async def test_disconnect_token(self, manager, token, sid):
"""Test token disconnection cleans up mappings.
Args:
manager: LocalTokenManager fixture instance.
token: Token string to test.
sid: Session ID string to test.
"""
await manager.link_token_to_sid(token, sid)
await manager.disconnect_token(token, sid)
assert token not in manager.token_to_sid
assert sid not in manager.sid_to_token
async def test_disconnect_nonexistent_token(self, manager):
"""Test disconnecting nonexistent token doesn't raise error.
Args:
manager: LocalTokenManager fixture instance.
"""
await manager.disconnect_token("nonexistent", "nonexistent")
assert len(manager.token_to_sid) == 0
assert len(manager.sid_to_token) == 0
async def test_enumerate_tokens(self, manager):
"""Test enumerate_tokens yields all linked tokens.
Args:
manager: LocalTokenManager fixture instance.
"""
tokens_sids = [("token1", "sid1"), ("token2", "sid2"), ("token3", "sid3")]
for token, sid in tokens_sids:
await manager.link_token_to_sid(token, sid)
found_tokens = set()
async for token in manager.enumerate_tokens():
found_tokens.add(token)
expected_tokens = {token for token, _ in tokens_sids}
assert found_tokens == expected_tokens
# Disconnect a token and ensure it's removed.
await manager.disconnect_token("token2", "sid2")
expected_tokens.remove("token2")
found_tokens = set()
async for token in manager.enumerate_tokens():
found_tokens.add(token)
assert found_tokens == expected_tokens
# Disconnect all tokens, none should remain
await manager.disconnect_all()
found_tokens = set()
async for token in manager.enumerate_tokens():
found_tokens.add(token)
assert not found_tokens
class TestRedisTokenManager:
"""Tests for RedisTokenManager."""
@pytest.fixture
def mock_redis(self):
"""Create a mock Redis client.
Returns:
AsyncMock configured as Redis client for testing.
"""
redis = AsyncMock()
redis.exists = AsyncMock()
redis.set = AsyncMock()
redis.delete = AsyncMock()
# Non-async call
redis.get_connection_kwargs = Mock(return_value={"db": 0})
# Mock out pubsub
async def listen():
await asyncio.sleep(1)
if False:
yield
return
@asynccontextmanager
async def pubsub(): # noqa: RUF029
pubsub_mock = AsyncMock()
pubsub_mock.listen = listen
yield pubsub_mock
redis.pubsub = pubsub
return redis
@pytest.fixture
def manager(self, mock_redis):
"""Create a RedisTokenManager instance with mocked config.
Args:
mock_redis: Mock Redis client fixture.
Returns:
RedisTokenManager instance for testing.
"""
with patch("reflex.config.get_config") as mock_get_config:
mock_config = Mock()
mock_config.redis_token_expiration = 3600
mock_get_config.return_value = mock_config
return RedisTokenManager(mock_redis)
def test_get_redis_key(self, manager):
"""Test Redis key generation follows expected pattern.
Args:
manager: RedisTokenManager fixture instance.
"""
token = "test_token_123"
expected_key = f"token_manager_socket_record_{token}"
assert manager._get_redis_key(token) == expected_key
async def test_link_token_to_sid_normal_case(self, manager, mock_redis):
"""Test normal token linking stores in both Redis and local dicts.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
mock_redis.exists.return_value = False
result = await manager.link_token_to_sid(token, sid)
assert result is None
mock_redis.exists.assert_called_once_with(
f"token_manager_socket_record_{token}"
)
mock_redis.set.assert_called_once_with(
f"token_manager_socket_record_{token}",
pickle.dumps(SocketRecord(instance_id=manager.instance_id, sid=sid)),
ex=3600,
)
assert manager.token_to_socket[token].sid == sid
assert manager.sid_to_token[sid] == token
async def test_link_token_to_sid_reconnection_skips_redis(
self, manager, mock_redis
):
"""Test reconnection with same token/SID skips Redis check.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
manager.token_to_socket[token] = SocketRecord(
instance_id=manager.instance_id, sid=sid
)
result = await manager.link_token_to_sid(token, sid)
assert result is None
mock_redis.exists.assert_not_called()
mock_redis.set.assert_not_called()
async def test_link_token_to_sid_duplicate_detected(self, manager, mock_redis):
"""Test duplicate token detection generates new token.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
mock_redis.exists.return_value = True
result = await manager.link_token_to_sid(token, sid)
assert result is not None
assert result != token
assert len(result) == 36 # UUID4 length
mock_redis.exists.assert_called_once_with(
f"token_manager_socket_record_{token}"
)
mock_redis.set.assert_called_once_with(
f"token_manager_socket_record_{result}",
pickle.dumps(SocketRecord(instance_id=manager.instance_id, sid=sid)),
ex=3600,
)
assert manager.token_to_sid[result] == sid
assert manager.sid_to_token[sid] == result
async def test_link_token_to_sid_redis_error_fallback(self, manager, mock_redis):
"""Test Redis error falls back to local manager behavior.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
mock_redis.exists.side_effect = Exception("Redis connection error")
with patch.object(
LocalTokenManager, "link_token_to_sid", new_callable=AsyncMock
) as mock_super:
mock_super.return_value = None
result = await manager.link_token_to_sid(token, sid)
assert result is None
mock_super.assert_called_once_with(token, sid)
async def test_link_token_to_sid_redis_set_error_continues(
self, manager, mock_redis
):
"""Test Redis set error doesn't prevent local storage.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
mock_redis.exists.return_value = False
mock_redis.set.side_effect = Exception("Redis set error")
result = await manager.link_token_to_sid(token, sid)
assert result is None
assert manager.token_to_sid[token] == sid
assert manager.sid_to_token[sid] == token
async def test_disconnect_token_owned_locally(self, manager, mock_redis):
"""Test disconnect cleans up both Redis and local mappings when owned locally.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
manager.token_to_socket[token] = SocketRecord(
instance_id=manager.instance_id, sid=sid
)
manager.sid_to_token[sid] = token
await manager.disconnect_token(token, sid)
mock_redis.delete.assert_called_once_with(
f"token_manager_socket_record_{token}"
)
assert token not in manager.token_to_sid
assert sid not in manager.sid_to_token
async def test_disconnect_token_not_owned_locally(self, manager, mock_redis):
"""Test disconnect doesn't clean up when not owned locally.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
await manager.disconnect_token(token, sid)
mock_redis.delete.assert_not_called()
async def test_disconnect_token_redis_error(self, manager, mock_redis):
"""Test disconnect continues with local cleanup even if Redis fails.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
"""
token, sid = "token1", "sid1"
manager.token_to_socket[token] = SocketRecord(
instance_id=manager.instance_id, sid=sid
)
manager.sid_to_token[sid] = token
mock_redis.delete.side_effect = Exception("Redis delete error")
await manager.disconnect_token(token, sid)
assert token not in manager.token_to_sid
assert sid not in manager.sid_to_token
@pytest.mark.parametrize(
"redis_error",
[
Exception("Connection timeout"),
Exception("Redis server down"),
Exception("Network error"),
],
)
async def test_various_redis_errors_handled_gracefully(
self, manager, mock_redis, redis_error
):
"""Test various Redis errors are handled gracefully.
Args:
manager: RedisTokenManager fixture instance.
mock_redis: Mock Redis client fixture.
redis_error: Exception to test error handling.
"""
token, sid = "token1", "sid1"
mock_redis.exists.side_effect = redis_error
with patch.object(
LocalTokenManager, "link_token_to_sid", new_callable=AsyncMock
) as mock_super:
mock_super.return_value = None
result = await manager.link_token_to_sid(token, sid)
assert result is None
mock_super.assert_called_once()
def test_inheritance_from_local_manager(self, manager):
"""Test RedisTokenManager inherits from LocalTokenManager.
Args:
manager: RedisTokenManager fixture instance.
"""
assert isinstance(manager, LocalTokenManager)
assert hasattr(manager, "token_to_sid")
assert hasattr(manager, "sid_to_token")
@pytest.fixture
def redis_url():
"""Returns the Redis URL from the environment."""
redis_url = config.get_config().redis_url
if redis_url is None:
pytest.skip("Redis URL not configured")
return redis_url
def query_string_for(token: str) -> dict[str, str]:
"""Generate query string for given token.
Args:
token: The token to generate query string for.
Returns:
The generated query string.
"""
return {"QUERY_STRING": f"token={token}"}
@pytest.fixture
def event_namespace_factory() -> Generator[Callable[[], EventNamespace], None, None]:
"""Yields the EventNamespace factory function."""
namespace = config.get_config().get_event_namespace()
created_objs = []
def new_event_namespace() -> EventNamespace:
state = Mock()
state.router_data = {}
mock_app = Mock()
mock_app.state_manager.modify_state = Mock(
return_value=AsyncMock(__aenter__=AsyncMock(return_value=state))
)
event_namespace = EventNamespace(namespace=namespace, app=mock_app)
event_namespace.emit = AsyncMock()
created_objs.append(event_namespace)
return event_namespace
yield new_event_namespace
for obj in created_objs:
asyncio.run(obj._token_manager.disconnect_all())
@pytest.mark.usefixtures("redis_url")
@pytest.mark.asyncio
async def test_redis_token_manager_enumerate_tokens(
event_namespace_factory: Callable[[], EventNamespace],
):
"""Integration test for RedisTokenManager enumerate_tokens interface.
Should support enumerating tokens across separate instances of the
RedisTokenManager.
Args:
event_namespace_factory: Factory fixture for EventNamespace instances.
"""
event_namespace1 = event_namespace_factory()
event_namespace2 = event_namespace_factory()
await event_namespace1.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.on_connect(sid="sid2", environ=query_string_for("token2"))
found_tokens = set()
async for token in event_namespace1._token_manager.enumerate_tokens():
found_tokens.add(token)
assert "token1" in found_tokens
assert "token2" in found_tokens
assert len(found_tokens) == 2
await event_namespace1._token_manager.disconnect_all()
found_tokens = set()
async for token in event_namespace1._token_manager.enumerate_tokens():
found_tokens.add(token)
assert "token2" in found_tokens
assert len(found_tokens) == 1
await event_namespace2._token_manager.disconnect_all()
found_tokens = set()
async for token in event_namespace1._token_manager.enumerate_tokens():
found_tokens.add(token)
assert not found_tokens
@pytest.mark.usefixtures("redis_url")
@pytest.mark.asyncio
async def test_redis_token_manager_get_token_owner(
event_namespace_factory: Callable[[], EventNamespace],
):
"""Integration test for RedisTokenManager get_token_owner interface.
Should support retrieving the owner of a token across separate instances of the
RedisTokenManager.
Args:
event_namespace_factory: Factory fixture for EventNamespace instances.
"""
event_namespace1 = event_namespace_factory()
event_namespace2 = event_namespace_factory()
await event_namespace1.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.on_connect(sid="sid2", environ=query_string_for("token2"))
assert isinstance((manager1 := event_namespace1._token_manager), RedisTokenManager)
assert isinstance((manager2 := event_namespace2._token_manager), RedisTokenManager)
assert await manager1._get_token_owner("token1") == manager1.instance_id
assert await manager1._get_token_owner("token2") == manager2.instance_id
assert await manager2._get_token_owner("token1") == manager1.instance_id
assert await manager2._get_token_owner("token2") == manager2.instance_id
async def _wait_for_call_count_positive(mock: Mock, timeout: float = 5.0):
"""Wait until the mock's call count is positive.
Args:
mock: The mock to wait on.
timeout: The maximum time to wait in seconds.
"""
deadline = time.monotonic() + timeout
while mock.call_count == 0 and time.monotonic() < deadline: # noqa: ASYNC110
await asyncio.sleep(0.1)
@pytest.mark.usefixtures("redis_url")
@pytest.mark.asyncio
async def test_redis_token_manager_lost_and_found(
event_namespace_factory: Callable[[], EventNamespace],
):
"""Updates emitted for lost and found tokens should be routed correctly via redis.
Args:
event_namespace_factory: Factory fixture for EventNamespace instances.
"""
event_namespace1 = event_namespace_factory()
emit1_mock: Mock = event_namespace1.emit # pyright: ignore[reportAssignmentType]
event_namespace2 = event_namespace_factory()
emit2_mock: Mock = event_namespace2.emit # pyright: ignore[reportAssignmentType]
await event_namespace1.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.on_connect(sid="sid2", environ=query_string_for("token2"))
await event_namespace2.emit_update(StateUpdate(), token="token1")
await _wait_for_call_count_positive(emit1_mock)
emit2_mock.assert_not_called()
emit1_mock.assert_called_once()
emit1_mock.reset_mock()
await event_namespace2.emit_update(StateUpdate(), token="token2")
await _wait_for_call_count_positive(emit2_mock)
emit1_mock.assert_not_called()
emit2_mock.assert_called_once()
emit2_mock.reset_mock()
if task := event_namespace1.on_disconnect(sid="sid1"):
await task
await event_namespace2.emit_update(StateUpdate(), token="token1")
# Update should be dropped on the floor.
await asyncio.sleep(2)
emit1_mock.assert_not_called()
emit2_mock.assert_not_called()
await event_namespace2.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.emit_update(StateUpdate(), token="token1")
await _wait_for_call_count_positive(emit2_mock)
emit1_mock.assert_not_called()
emit2_mock.assert_called_once()
emit2_mock.reset_mock()
if task := event_namespace2.on_disconnect(sid="sid1"):
await task
await event_namespace1.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.emit_update(StateUpdate(), token="token1")
await _wait_for_call_count_positive(emit1_mock)
emit2_mock.assert_not_called()
emit1_mock.assert_called_once()
emit1_mock.reset_mock()
@pytest.mark.usefixtures("redis_url")
@pytest.mark.asyncio
async def test_redis_token_manager_lost_and_found_router_data(
event_namespace_factory: Callable[[], EventNamespace],
):
"""Updates emitted for lost and found tokens should serialize properly.
Args:
event_namespace_factory: Factory fixture for EventNamespace instances.
"""
event_namespace1 = event_namespace_factory()
emit1_mock: Mock = event_namespace1.emit # pyright: ignore[reportAssignmentType]
event_namespace2 = event_namespace_factory()
emit2_mock: Mock = event_namespace2.emit # pyright: ignore[reportAssignmentType]
await event_namespace1.on_connect(sid="sid1", environ=query_string_for("token1"))
await event_namespace2.on_connect(sid="sid2", environ=query_string_for("token2"))
router = RouterData.from_router_data(
{"headers": {"x-test": "value"}},
)
await event_namespace2.emit_update(
StateUpdate(delta={"state": {"router": router}}), token="token1"
)
await _wait_for_call_count_positive(emit1_mock)
emit2_mock.assert_not_called()
emit1_mock.assert_called_once()
assert isinstance(emit1_mock.call_args[0][1], StateUpdate)
assert isinstance(emit1_mock.call_args[0][1].delta["state"]["router"], RouterData)
assert emit1_mock.call_args[0][1].delta["state"]["router"] == router
emit1_mock.reset_mock()