Skip to content

Commit 4b26bba

Browse files
GWealecopybara-github
authored andcommitted
fix(redis): match app_name and user_id literally when listing sessions
Co-authored-by: George Weale <[email protected]> PiperOrigin-RevId: 978092596
1 parent 6762652 commit 4b26bba

3 files changed

Lines changed: 119 additions & 6 deletions

File tree

‎src/google/adk/integrations/redis/_redis_session_service.py‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import copy
2121
import json
2222
import logging
23+
import re
2324
import time
2425
from typing import Any
2526
from typing import cast
@@ -44,6 +45,11 @@
4445
logger = logging.getLogger("google_adk." + __name__)
4546

4647

48+
def _escape_glob(value: str) -> str:
49+
"""Escapes Redis glob metacharacters so that `value` matches only itself."""
50+
return re.sub(r"([\\*?\[\]])", r"\\\1", value)
51+
52+
4753
class RedisSessionService(BaseSessionService):
4854
"""Redis-backed session service for ADK.
4955
@@ -268,16 +274,17 @@ async def list_sessions(
268274
) -> ListSessionsResponse:
269275
"""Lists sessions matching the given app_name and optional user_id."""
270276
client = self._get_redis()
277+
escaped_app_name = _escape_glob(app_name)
271278
pattern = (
272-
f"{self.config.key_prefix}{app_name}:{user_id}:*"
273-
if user_id
274-
else f"{self.config.key_prefix}{app_name}:*"
279+
f"{self.config.key_prefix}{escaped_app_name}:{_escape_glob(user_id)}:*"
280+
if user_id is not None
281+
else f"{self.config.key_prefix}{escaped_app_name}:*"
275282
)
276283
app_raw = await client.get(self._app_state_key(app_name))
277284
app_state = json.loads(app_raw) if app_raw else {}
278285

279286
user_states_map: dict[str, dict[str, Any]] = {}
280-
if user_id:
287+
if user_id is not None:
281288
user_raw = await client.get(self._user_state_key(app_name, user_id))
282289
if user_raw:
283290
user_states_map[user_id] = json.loads(user_raw)
@@ -288,6 +295,13 @@ async def list_sessions(
288295
if raw:
289296
try:
290297
s = Session.model_validate_json(raw)
298+
# Key segments are ':'-joined and the trailing wildcard spans ':', so
299+
# a matched key can belong to another app or user whose id embeds a
300+
# ':'. Confirm ownership from the stored session itself.
301+
if s.app_name != app_name or (
302+
user_id is not None and s.user_id != user_id
303+
):
304+
continue
291305
u_id = s.user_id
292306
if u_id not in user_states_map:
293307
u_raw = await client.get(self._user_state_key(app_name, u_id))

‎tests/unittests/integrations/redis/_fake_redis.py‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
from __future__ import annotations
1818

1919
from collections.abc import AsyncIterator
20+
import re
2021

2122

2223
class FakeRedisAsync:
@@ -27,6 +28,7 @@ def __init__(self) -> None:
2728
self._ex_store: dict[str, int | None] = {}
2829
self._created_at: dict[str, float] = {}
2930
self._current_time: float = 0.0
31+
self.scan_patterns: list[str] = []
3032

3133
def advance_time(self, seconds: float) -> None:
3234
self._current_time += seconds
@@ -71,8 +73,33 @@ async def delete(self, key: str) -> int:
7173
return 1
7274
return 0
7375

76+
@staticmethod
77+
def _glob_match(pattern: str, key: str) -> bool:
78+
"""Matches a key the way Redis glob-style patterns do."""
79+
regex: list[str] = []
80+
i = 0
81+
while i < len(pattern):
82+
char = pattern[i]
83+
if char == "\\" and i + 1 < len(pattern):
84+
regex.append(re.escape(pattern[i + 1]))
85+
i += 2
86+
continue
87+
if char == "*":
88+
regex.append(".*")
89+
elif char == "?":
90+
regex.append(".")
91+
elif char == "[" and pattern.find("]", i + 1) != -1:
92+
end = pattern.find("]", i + 1)
93+
regex.append(f"[{pattern[i + 1 : end]}]")
94+
i = end + 1
95+
continue
96+
else:
97+
regex.append(re.escape(char))
98+
i += 1
99+
return re.fullmatch("".join(regex), key) is not None
100+
74101
async def scan_iter(self, match: str) -> AsyncIterator[str]:
75-
prefix = match.rstrip("*")
102+
self.scan_patterns.append(match)
76103
for k in list(self._store):
77-
if not self._is_expired(k) and k.startswith(prefix):
104+
if not self._is_expired(k) and self._glob_match(match, k):
78105
yield k

‎tests/unittests/integrations/redis/test_redis_session_service.py‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,78 @@ async def test_list_sessions(session_service):
203203
assert session_ids_all == {"s1", "s2", "s3"}
204204

205205

206+
@pytest.mark.asyncio
207+
async def test_list_sessions_glob_metacharacters_match_literally(
208+
session_service, fake_redis
209+
):
210+
await session_service.create_session(
211+
app_name="app1",
212+
user_id="u1",
213+
session_id="s1",
214+
)
215+
await session_service.create_session(
216+
app_name="app1",
217+
user_id="u2",
218+
session_id="s2",
219+
)
220+
221+
for app_name, user_id, expected_pattern in (
222+
("app1", "*", r"test:session:app1:\*:*"),
223+
("app1", "u?", r"test:session:app1:u\?:*"),
224+
("app1", "[u]1", r"test:session:app1:\[u\]1:*"),
225+
("*", "u1", r"test:session:\*:u1:*"),
226+
):
227+
fake_redis.scan_patterns.clear()
228+
resp = await session_service.list_sessions(
229+
app_name=app_name, user_id=user_id
230+
)
231+
assert fake_redis.scan_patterns == [expected_pattern], (app_name, user_id)
232+
assert resp.sessions == [], (app_name, user_id)
233+
234+
fake_redis.scan_patterns.clear()
235+
resp = await session_service.list_sessions(app_name="*")
236+
assert fake_redis.scan_patterns == [r"test:session:\*:*"]
237+
assert resp.sessions == []
238+
239+
240+
@pytest.mark.asyncio
241+
async def test_list_sessions_empty_user_id_is_a_filter_not_a_wildcard(
242+
session_service,
243+
):
244+
await session_service.create_session(
245+
app_name="app1",
246+
user_id="",
247+
session_id="s1",
248+
)
249+
await session_service.create_session(
250+
app_name="app1",
251+
user_id="u1",
252+
session_id="s2",
253+
)
254+
255+
resp = await session_service.list_sessions(app_name="app1", user_id="")
256+
assert [s.id for s in resp.sessions] == ["s1"]
257+
258+
259+
@pytest.mark.asyncio
260+
async def test_list_sessions_excludes_user_ids_sharing_a_prefix(
261+
session_service,
262+
):
263+
await session_service.create_session(
264+
app_name="app1",
265+
user_id="u1",
266+
session_id="s1",
267+
)
268+
await session_service.create_session(
269+
app_name="app1",
270+
user_id="u1:sub",
271+
session_id="s2",
272+
)
273+
274+
resp = await session_service.list_sessions(app_name="app1", user_id="u1")
275+
assert [s.id for s in resp.sessions] == ["s1"]
276+
277+
206278
@pytest.mark.asyncio
207279
async def test_delete_session(session_service):
208280
await session_service.create_session(

0 commit comments

Comments
 (0)