chore: import upstream snapshot with attribution
Continuous Integration / Pre-commit Linter (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.10) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.11) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.12) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.12) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Has been cancelled
Copybara PR Handler / close-imported-pr (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Has been cancelled

This commit is contained in:
wehub-resource-sync
2026-07-13 13:25:13 +08:00
commit ec2b666284
2231 changed files with 491535 additions and 0 deletions
@@ -0,0 +1,388 @@
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from unittest import mock
from google.adk.events.event import Event
from google.adk.integrations.firestore.firestore_memory_service import FirestoreMemoryService
from google.cloud.firestore_v1.base_query import FieldFilter
from google.genai import types
import pytest
@pytest.fixture
def mock_firestore_client():
client = mock.MagicMock()
collection_ref = mock.MagicMock()
client.collection.return_value = collection_ref
collection_ref.where.return_value = collection_ref
doc_snapshot = mock.MagicMock()
doc_snapshot.to_dict.return_value = {}
collection_ref.get = mock.AsyncMock(return_value=[doc_snapshot])
return client
def test_extract_keywords(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
text = "The quick brown fox jumps over the lazy dog."
keywords = service._extract_keywords(text)
assert "the" not in keywords
assert "over" not in keywords
assert "quick" in keywords
assert "brown" in keywords
assert "fox" in keywords
assert "jumps" in keywords
assert "lazy" in keywords
assert "dog" in keywords
@pytest.mark.asyncio
async def test_search_memory_empty_query(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
response = await service.search_memory(
app_name="test_app", user_id="test_user", query=""
)
assert not response.memories
mock_firestore_client.collection.assert_not_called()
@pytest.mark.asyncio
async def test_search_memory_with_results(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
query = "quick fox"
doc_snapshot = mock_firestore_client.collection.return_value.where.return_value.where.return_value.where.return_value.get.return_value[
0
]
content = types.Content(parts=[types.Part.from_text(text="quick fox jumps")])
doc_snapshot.to_dict.return_value = {
"appName": app_name,
"userId": user_id,
"author": "user",
"content": content.model_dump(exclude_none=True, mode="json"),
"timestamp": 1234567890.0,
}
response = await service.search_memory(
app_name=app_name, user_id=user_id, query=query
)
assert response.memories
assert len(response.memories) == 1
assert response.memories[0].author == "user"
mock_firestore_client.collection.assert_called_with("memories")
collection_ref = mock_firestore_client.collection.return_value
assert collection_ref.where.call_count == 6
calls = collection_ref.where.call_args_list
app_name_calls = 0
user_id_calls = 0
keyword_calls = 0
for call in calls:
kwargs = call.kwargs
filt = kwargs.get("filter")
if filt:
if (
filt.field_path == "appName"
and filt.op_string == "=="
and filt.value == app_name
):
app_name_calls += 1
elif (
filt.field_path == "userId"
and filt.op_string == "=="
and filt.value == user_id
):
user_id_calls += 1
elif filt.field_path == "keywords" and filt.op_string == "array_contains":
if filt.value in ["quick", "fox"]:
keyword_calls += 1
assert app_name_calls == 2
assert user_id_calls == 2
assert keyword_calls == 2
@pytest.mark.asyncio
async def test_search_memory_deduplication(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
query = "quick fox"
content = types.Content(parts=[types.Part.from_text(text="quick fox jumps")])
doc_snapshot1 = mock.MagicMock()
doc_snapshot1.to_dict.return_value = {
"appName": app_name,
"userId": user_id,
"author": "user",
"content": content.model_dump(exclude_none=True, mode="json"),
"timestamp": 1234567890.0,
}
doc_snapshot2 = mock.MagicMock()
doc_snapshot2.to_dict.return_value = {
"appName": app_name,
"userId": user_id,
"author": "user",
"content": content.model_dump(exclude_none=True, mode="json"),
"timestamp": 1234567890.0,
}
get_mock = mock.AsyncMock(side_effect=[[doc_snapshot1], [doc_snapshot2]])
mock_firestore_client.collection.return_value.where.return_value.where.return_value.where.return_value.get = (
get_mock
)
response = await service.search_memory(
app_name=app_name, user_id=user_id, query=query
)
assert response.memories
assert len(response.memories) == 1
assert response.memories[0].author == "user"
@pytest.mark.asyncio
async def test_search_memory_parsing_error(mock_firestore_client, caplog):
service = FirestoreMemoryService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
query = "quick"
doc_snapshot = mock_firestore_client.collection.return_value.where.return_value.where.return_value.where.return_value.get.return_value[
0
]
doc_snapshot.to_dict.return_value = {"content": "invalid_data"}
response = await service.search_memory(
app_name=app_name, user_id=user_id, query=query
)
assert not response.memories
assert "Failed to parse memory entry" in caplog.text
@pytest.mark.asyncio
async def test_search_memory_only_stop_words(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
response = await service.search_memory(
app_name="test_app", user_id="test_user", query="the and or"
)
assert not response.memories
mock_firestore_client.collection.assert_not_called()
@pytest.mark.asyncio
async def test_search_memory_partial_failures(mock_firestore_client, caplog):
service = FirestoreMemoryService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
query = "fox quick"
coll_ref = (
mock_firestore_client.collection.return_value.where.return_value.where.return_value.where.return_value
)
doc_snapshot = mock.MagicMock()
doc_snapshot.to_dict.return_value = {
"content": {"parts": [{"text": "quick response"}]},
"author": "user",
"timestamp": 1234567890.0,
}
call_count = 0
async def mock_get():
nonlocal call_count
call_count += 1
if call_count == 1:
raise ValueError("Mock generic network failure standalone")
return [doc_snapshot]
coll_ref.get = mock.AsyncMock(side_effect=mock_get)
response = await service.search_memory(
app_name=app_name, user_id=user_id, query=query
)
assert len(response.memories) == 1
assert response.memories[0].author == "user"
assert "Memory keyword search partial failure" in caplog.text
def test_init_default_client():
with mock.patch("google.cloud.firestore.AsyncClient") as mock_client_class:
mock_instance = mock.MagicMock()
mock_client_class.return_value = mock_instance
service = FirestoreMemoryService()
mock_client_class.assert_called_once()
assert service.client == mock_instance
@pytest.mark.asyncio
async def test_add_session_to_memory(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
from google.adk.sessions.session import Session
session = Session(id="test_session", app_name="test_app", user_id="test_user")
content = types.Content(parts=[types.Part.from_text(text="quick brown fox")])
event = Event(
invocation_id="test_inv",
author="user",
content=content,
timestamp=1234567890.0,
)
session.events.append(event)
batch = mock.MagicMock()
mock_firestore_client.batch.return_value = batch
batch.commit = mock.AsyncMock()
doc_ref = mock.MagicMock()
mock_firestore_client.collection.return_value.document.return_value = doc_ref
await service.add_session_to_memory(session)
mock_firestore_client.batch.assert_called_once()
mock_firestore_client.collection.assert_called_with("memories")
batch.set.assert_called_once()
batch.commit.assert_called_once()
args, kwargs = batch.set.call_args
assert args[0] == doc_ref
data = args[1]
assert data["appName"] == "test_app"
assert data["userId"] == "test_user"
assert "quick" in data["keywords"]
assert data["author"] == "user"
assert data["timestamp"] == 1234567890.0
@pytest.mark.asyncio
async def test_add_session_to_memory_no_events(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
from google.adk.sessions.session import Session
session = Session(id="test_session", app_name="test_app", user_id="test_user")
batch = mock.MagicMock()
mock_firestore_client.batch.return_value = batch
await service.add_session_to_memory(session)
mock_firestore_client.batch.assert_called_once()
batch.set.assert_not_called()
batch.commit.assert_not_called()
@pytest.mark.asyncio
async def test_add_session_to_memory_no_keywords(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
from google.adk.sessions.session import Session
session = Session(id="test_session", app_name="test_app", user_id="test_user")
content = types.Content(parts=[types.Part.from_text(text="the and or")])
event = Event(invocation_id="test_inv", author="user", content=content)
session.events.append(event)
batch = mock.MagicMock()
mock_firestore_client.batch.return_value = batch
await service.add_session_to_memory(session)
mock_firestore_client.batch.assert_called_once()
batch.set.assert_not_called()
batch.commit.assert_not_called()
@pytest.mark.asyncio
async def test_add_session_to_memory_commit_error(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
from google.adk.sessions.session import Session
session = Session(id="test_session", app_name="test_app", user_id="test_user")
content = types.Content(parts=[types.Part.from_text(text="quick brown fox")])
event = Event(invocation_id="test_inv", author="user", content=content)
session.events.append(event)
batch = mock.MagicMock()
mock_firestore_client.batch.return_value = batch
batch.commit = mock.AsyncMock(
side_effect=Exception("Firestore commit failed")
)
with pytest.raises(Exception, match="Firestore commit failed"):
await service.add_session_to_memory(session)
@pytest.mark.asyncio
async def test_add_session_to_memory_exceeds_batch_limit(mock_firestore_client):
service = FirestoreMemoryService(client=mock_firestore_client)
from google.adk.sessions.session import Session
session = Session(id="test_session", app_name="test_app", user_id="test_user")
for i in range(501):
content = types.Content(
parts=[types.Part.from_text(text=f"event keyword {i}")]
)
event = Event(
invocation_id=f"test_inv_{i}",
author="user",
content=content,
timestamp=1234567890.0 + i,
)
session.events.append(event)
batch1 = mock.MagicMock()
batch2 = mock.MagicMock()
batch1.commit = mock.AsyncMock()
batch2.commit = mock.AsyncMock()
mock_firestore_client.batch.side_effect = [batch1, batch2]
await service.add_session_to_memory(session)
assert mock_firestore_client.batch.call_count == 2
assert batch1.set.call_count == 500
batch1.commit.assert_called_once()
assert batch2.set.call_count == 1
batch2.commit.assert_called_once()
@@ -0,0 +1,830 @@
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from datetime import datetime
from datetime import timezone
import json
from unittest import mock
from google.adk.errors.already_exists_error import AlreadyExistsError
from google.adk.events.event import Event
from google.adk.events.event import EventActions
from google.adk.integrations.firestore.firestore_session_service import FirestoreSessionService
from google.adk.sessions.base_session_service import GetSessionConfig
from google.adk.sessions.session import Session
from google.cloud import firestore
import pytest
@pytest.fixture
def mock_firestore_client():
client = mock.MagicMock()
collection_ref = mock.MagicMock()
doc_ref = mock.MagicMock()
subcollection_ref = mock.MagicMock()
subdoc_ref = mock.MagicMock()
sessions_coll_ref = mock.MagicMock()
sessions_doc_ref = mock.MagicMock()
client.collection.return_value = collection_ref
collection_ref.document.return_value = doc_ref
doc_ref.collection.return_value = subcollection_ref
subcollection_ref.document.return_value = subdoc_ref
subdoc_ref.collection.return_value = sessions_coll_ref
sessions_coll_ref.document.return_value = sessions_doc_ref
doc_snapshot = mock.MagicMock()
doc_snapshot.exists = False
doc_snapshot.to_dict.return_value = {}
subdoc_ref.get = mock.AsyncMock(return_value=doc_snapshot)
sessions_doc_ref.get = mock.AsyncMock(return_value=doc_snapshot)
doc_ref.get = mock.AsyncMock(return_value=doc_snapshot)
sessions_doc_ref.set = mock.AsyncMock()
sessions_doc_ref.delete = mock.AsyncMock()
events_collection_ref = mock.MagicMock()
sessions_doc_ref.collection.return_value = events_collection_ref
events_collection_ref.order_by.return_value = events_collection_ref
events_collection_ref.where.return_value = events_collection_ref
events_collection_ref.limit_to_last.return_value = events_collection_ref
events_collection_ref.get = mock.AsyncMock(return_value=[])
sessions_coll_ref.get = mock.AsyncMock(return_value=[])
sessions_coll_ref.where.return_value = sessions_coll_ref
client.collection_group.return_value = collection_ref
batch = mock.MagicMock()
client.batch.return_value = batch
batch.commit = mock.AsyncMock()
return client
@pytest.mark.asyncio
async def test_create_session(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
with mock.patch("google.cloud.firestore.async_transactional", lambda x: x):
session = await service.create_session(app_name=app_name, user_id=user_id)
assert session.app_name == app_name
assert session.user_id == user_id
assert session.id
assert session._storage_update_marker == "0"
mock_firestore_client.collection.assert_any_call("adk-session")
mock_firestore_client.collection.assert_any_call("app_states")
mock_firestore_client.collection.assert_any_call("user_states")
root_coll = mock_firestore_client.collection.return_value
app_ref = root_coll.document.return_value
users_coll = app_ref.collection.return_value
user_ref = users_coll.document.return_value
sessions_ref = user_ref.collection.return_value
session_doc_ref = sessions_ref.document.return_value
transaction = mock_firestore_client.transaction.return_value
transaction.set.assert_called_once()
args, kwargs = transaction.set.call_args
assert args[0] == session_doc_ref
assert args[1]["id"] == session.id
assert args[1]["appName"] == app_name
assert args[1]["userId"] == user_id
assert json.loads(args[1]["state"]) == {}
assert args[1]["createTime"] == firestore.SERVER_TIMESTAMP
assert args[1]["updateTime"] == firestore.SERVER_TIMESTAMP
@pytest.mark.asyncio
async def test_get_session_not_found(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
session = await service.get_session(
app_name=app_name, user_id=user_id, session_id=session_id
)
assert session is None
mock_firestore_client.collection.assert_called_with("adk-session")
root_coll = mock_firestore_client.collection.return_value
root_coll.document.assert_called_with(app_name)
app_ref = root_coll.document.return_value
app_ref.collection.assert_called_with("users")
users_coll = app_ref.collection.return_value
users_coll.document.assert_called_with(user_id)
user_ref = users_coll.document.return_value
user_ref.collection.assert_called_with("sessions")
sessions_ref = user_ref.collection.return_value
sessions_ref.document.assert_called_with(session_id)
@pytest.mark.asyncio
async def test_get_session_found(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
root_coll = mock_firestore_client.collection.return_value
app_ref = root_coll.document.return_value
users_coll = app_ref.collection.return_value
user_ref = users_coll.document.return_value
sessions_ref = user_ref.collection.return_value
sessions_doc_ref = sessions_ref.document.return_value
session_snap = mock.MagicMock()
session_snap.exists = True
session_snap.to_dict.return_value = {
"id": session_id,
"appName": app_name,
"userId": user_id,
"state": {"key": "value"},
"updateTime": 1234567890.0,
}
sessions_doc_ref.get.return_value = session_snap
# Decouple app and user documents so they do not duplicate values
app_state_coll = mock_firestore_client.collection.return_value
app_doc_ref = app_state_coll.document.return_value
app_snap = mock.MagicMock()
app_snap.exists = False
app_snap.to_dict.return_value = {}
app_doc_ref.get.return_value = app_snap
user_state_coll = mock_firestore_client.collection.return_value
user_doc_ref = user_state_coll.document.return_value
user_snap = mock.MagicMock()
user_snap.exists = False
user_snap.to_dict.return_value = {}
user_doc_ref.get.return_value = user_snap
events_collection_ref = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value
)
event_doc = mock.MagicMock()
event_doc.to_dict.return_value = {
"event_data": {"invocation_id": "test_inv", "author": "user"}
}
events_collection_ref.get = mock.AsyncMock(return_value=[event_doc])
session = await service.get_session(
app_name=app_name, user_id=user_id, session_id=session_id
)
assert session is not None
assert session.id == session_id
assert session.state == {"key": "value"}
assert len(session.events) == 1
assert session.events[0].invocation_id == "test_inv"
assert session._storage_update_marker == "0"
@pytest.mark.asyncio
async def test_delete_session(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
events_ref = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value
)
event_doc = mock.AsyncMock()
async def to_async_iter(iterable):
for item in iterable:
yield item
events_ref.stream.return_value = to_async_iter([event_doc])
await service.delete_session(
app_name=app_name, user_id=user_id, session_id=session_id
)
events_ref.stream.assert_called_once()
mock_firestore_client.batch.assert_called_once()
batch = mock_firestore_client.batch.return_value
batch.delete.assert_called_once_with(event_doc.reference)
batch.commit.assert_called_once()
session_doc_ref = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value.document.return_value
)
session_doc_ref.delete.assert_called_once()
@pytest.mark.asyncio
async def test_append_event(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session = Session(id="test_session", app_name=app_name, user_id=user_id)
event = Event(invocation_id="test_inv", author="user")
session_doc_snapshot = mock.MagicMock()
session_doc_snapshot.exists = True
session_doc_snapshot.to_dict.return_value = {"revision": 0}
root_coll = mock_firestore_client.collection.return_value
app_ref = root_coll.document.return_value
users_coll = app_ref.collection.return_value
user_ref = users_coll.document.return_value
sessions_ref = user_ref.collection.return_value
session_doc_ref = sessions_ref.document.return_value
session_doc_ref.get = mock.AsyncMock(return_value=session_doc_snapshot)
with mock.patch("google.cloud.firestore.async_transactional", lambda x: x):
await service.append_event(session, event)
transaction = mock_firestore_client.transaction.return_value
transaction.set.assert_called() # Invoked for events appends
transaction.update.assert_called_once() # Invoked for session revisions
args, kwargs = transaction.update.call_args
assert args[1]["revision"] == 1
assert args[1]["updateTime"] == firestore.SERVER_TIMESTAMP
assert session.last_update_time == event.timestamp
@pytest.mark.asyncio
async def test_append_event_with_state_delta(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session = Session(id="test_session", app_name=app_name, user_id=user_id)
event = mock.MagicMock()
event.partial = False
event.id = "test_event_id"
event.actions.state_delta = {
"_app_my_key": "app_val",
"_user_my_key": "user_val",
"session_key": "session_val",
}
event.model_dump.return_value = {"id": "test_event_id", "author": "user"}
service._update_app_state_transactional = mock.AsyncMock()
service._update_user_state_transactional = mock.AsyncMock()
session_doc_snapshot = mock.MagicMock()
session_doc_snapshot.exists = True
session_doc_snapshot.to_dict.return_value = {"revision": 0}
root_coll = mock_firestore_client.collection.return_value
app_ref = root_coll.document.return_value
users_coll = app_ref.collection.return_value
user_ref = users_coll.document.return_value
sessions_ref = user_ref.collection.return_value
session_doc_ref = sessions_ref.document.return_value
session_doc_ref.get = mock.AsyncMock(return_value=session_doc_snapshot)
with mock.patch("google.cloud.firestore.async_transactional", lambda x: x):
await service.append_event(session, event)
transaction = mock_firestore_client.transaction.return_value
transaction.set.assert_called()
assert session.state["session_key"] == "session_val"
transaction.update.assert_called_once()
args, kwargs = transaction.update.call_args
assert json.loads(args[1]["state"]) == session.state
assert args[1]["updateTime"] == firestore.SERVER_TIMESTAMP
@pytest.mark.asyncio
async def test_append_event_with_temp_state(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session = Session(id="test_session", app_name=app_name, user_id=user_id)
event = Event(
invocation_id="test_inv",
author="user",
actions=EventActions(
state_delta={"temp:k1": "v1", "session_key": "session_val"}
),
)
session_doc_snapshot = mock.MagicMock()
session_doc_snapshot.exists = True
session_doc_snapshot.to_dict.return_value = {"revision": 0}
root_coll = mock_firestore_client.collection.return_value
app_ref = root_coll.document.return_value
users_coll = app_ref.collection.return_value
user_ref = users_coll.document.return_value
sessions_ref = user_ref.collection.return_value
session_doc_ref = sessions_ref.document.return_value
session_doc_ref.get = mock.AsyncMock(return_value=session_doc_snapshot)
with mock.patch("google.cloud.firestore.async_transactional", lambda x: x):
await service.append_event(session, event)
# 1. Verify it was applied in-memory
assert session.state["temp:k1"] == "v1"
assert session.state["session_key"] == "session_val"
# 2. Verify it was trimmed before Firestore save
transaction = mock_firestore_client.transaction.return_value
transaction.set.assert_called()
# Filter calls for the one that actually sets the event data
event_set_calls = [
call
for call in transaction.set.call_args_list
if len(call[0]) > 1
and isinstance(call[0][1], dict)
and "event_data" in call[0][1]
]
assert len(event_set_calls) == 1
event_data = event_set_calls[0][0][1]["event_data"]
# Temporary keys should be deleted from delta before snapshot
assert "temp:k1" not in event_data["actions"]["state_delta"]
assert event_data["actions"]["state_delta"]["session_key"] == "session_val"
# 3. Verify temp keys are NOT written to session state in Firestore
transaction.update.assert_called_once()
update_args, _ = transaction.update.call_args
persisted_state = update_args[1]["state"]
assert (
"temp:k1" not in persisted_state
), "temp: keys must not be persisted to Firestore session state"
assert "session_key" in persisted_state
@pytest.mark.asyncio
async def test_list_sessions_with_user_id(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_doc = mock.MagicMock()
session_doc.to_dict.return_value = {
"id": "session1",
"appName": app_name,
"userId": user_id,
"state": {"session_key": "session_val"},
"updateTime": 1234567890.0,
}
app_state_coll = mock.MagicMock()
user_state_coll = mock.MagicMock()
sessions_coll = mock.MagicMock()
def collection_side_effect(name):
if name == service.app_state_collection:
return app_state_coll
elif name == service.user_state_collection:
return user_state_coll
elif name == service.root_collection:
return sessions_coll
return mock.MagicMock()
mock_firestore_client.collection.side_effect = collection_side_effect
app_doc = mock.MagicMock()
app_doc.exists = True
app_doc.to_dict.return_value = {"app_key": "app_val"}
app_doc_ref = mock.MagicMock()
app_state_coll.document.return_value = app_doc_ref
app_doc_ref.get = mock.AsyncMock(return_value=app_doc)
user_doc = mock.MagicMock()
user_doc.exists = True
user_doc.to_dict.return_value = {"user_key": "user_val"}
user_app_doc = mock.MagicMock()
user_state_coll.document.return_value = user_app_doc
users_coll = mock.MagicMock()
user_app_doc.collection.return_value = users_coll
user_doc_ref = mock.MagicMock()
users_coll.document.return_value = user_doc_ref
user_doc_ref.get = mock.AsyncMock(return_value=user_doc)
app_doc_in_root = mock.MagicMock()
sessions_coll.document.return_value = app_doc_in_root
users_coll = mock.MagicMock()
app_doc_in_root.collection.return_value = users_coll
user_doc_in_users = mock.MagicMock()
users_coll.document.return_value = user_doc_in_users
sessions_subcoll = mock.MagicMock()
user_doc_in_users.collection.return_value = sessions_subcoll
sessions_query = mock.MagicMock()
sessions_subcoll.where.return_value = sessions_query
sessions_query.get = mock.AsyncMock(return_value=[session_doc])
response = await service.list_sessions(app_name=app_name, user_id=user_id)
assert len(response.sessions) == 1
session = response.sessions[0]
assert session.id == "session1"
assert session.state["session_key"] == "session_val"
assert session.state["app:app_key"] == "app_val"
assert session.state["user:user_key"] == "user_val"
assert session.last_update_time == 1234567890.0
@pytest.mark.asyncio
async def test_list_sessions_preserves_datetime_update_time(
mock_firestore_client,
):
"""list_sessions converts datetime updateTime to last_update_time."""
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
update_time = datetime(2024, 6, 15, 10, 30, 0, tzinfo=timezone.utc)
session_doc = mock.MagicMock()
session_doc.to_dict.return_value = {
"id": "session1",
"appName": app_name,
"userId": user_id,
"state": {},
"updateTime": update_time,
}
app_state_coll = mock.MagicMock()
user_state_coll = mock.MagicMock()
sessions_coll = mock.MagicMock()
def collection_side_effect(name):
if name == service.app_state_collection:
return app_state_coll
elif name == service.user_state_collection:
return user_state_coll
elif name == service.root_collection:
return sessions_coll
return mock.MagicMock()
mock_firestore_client.collection.side_effect = collection_side_effect
app_doc = mock.MagicMock()
app_doc.exists = False
app_doc.to_dict.return_value = {}
app_doc_ref = mock.MagicMock()
app_state_coll.document.return_value = app_doc_ref
app_doc_ref.get = mock.AsyncMock(return_value=app_doc)
user_doc = mock.MagicMock()
user_doc.exists = False
user_doc.to_dict.return_value = {}
user_app_doc = mock.MagicMock()
user_state_coll.document.return_value = user_app_doc
users_coll = mock.MagicMock()
user_app_doc.collection.return_value = users_coll
user_doc_ref = mock.MagicMock()
users_coll.document.return_value = user_doc_ref
user_doc_ref.get = mock.AsyncMock(return_value=user_doc)
app_doc_in_root = mock.MagicMock()
sessions_coll.document.return_value = app_doc_in_root
users_coll = mock.MagicMock()
app_doc_in_root.collection.return_value = users_coll
user_doc_in_users = mock.MagicMock()
users_coll.document.return_value = user_doc_in_users
sessions_subcoll = mock.MagicMock()
user_doc_in_users.collection.return_value = sessions_subcoll
sessions_query = mock.MagicMock()
sessions_subcoll.where.return_value = sessions_query
sessions_query.get = mock.AsyncMock(return_value=[session_doc])
response = await service.list_sessions(app_name=app_name, user_id=user_id)
assert len(response.sessions) == 1
assert response.sessions[0].last_update_time == update_time.timestamp()
@pytest.mark.asyncio
async def test_list_sessions_without_user_id(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
session_doc = mock.MagicMock()
session_doc.to_dict.return_value = {
"id": "session1",
"appName": app_name,
"userId": "user1",
"state": {"session_key": "session_val"},
"updateTime": 1234567890.0,
}
mock_firestore_client.collection_group.return_value.where.return_value.get = (
mock.AsyncMock(return_value=[session_doc])
)
app_state_coll = mock.MagicMock()
user_state_coll = mock.MagicMock()
def collection_side_effect(name):
if name == service.app_state_collection:
return app_state_coll
elif name == service.user_state_collection:
return user_state_coll
return mock.MagicMock()
mock_firestore_client.collection.side_effect = collection_side_effect
app_doc = mock.MagicMock()
app_doc.exists = True
app_doc.to_dict.return_value = {"app_key": "app_val"}
app_doc_ref = mock.MagicMock()
app_state_coll.document.return_value = app_doc_ref
app_doc_ref.get = mock.AsyncMock(return_value=app_doc)
user_doc = mock.MagicMock()
user_doc.id = "user1"
user_doc.exists = True
user_doc.to_dict.return_value = {"user_key": "user_val"}
user_app_doc = mock.MagicMock()
user_state_coll.document.return_value = user_app_doc
users_coll = mock.MagicMock()
user_app_doc.collection.return_value = users_coll
user_doc_ref = mock.MagicMock()
users_coll.document.return_value = user_doc_ref
async def mock_get_all(refs):
yield user_doc
mock_firestore_client.get_all = mock_get_all
response = await service.list_sessions(app_name=app_name)
assert len(response.sessions) == 1
session = response.sessions[0]
assert session.id == "session1"
assert session.state["app:app_key"] == "app_val"
assert session.state["user:user_key"] == "user_val"
assert session.last_update_time == 1234567890.0
mock_firestore_client.collection_group.assert_called_once_with("sessions")
mock_firestore_client.collection_group.return_value.where.assert_called_once_with(
"appName", "==", app_name
)
@pytest.mark.asyncio
async def test_list_sessions_filters_other_apps(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
session_doc = mock.MagicMock()
session_doc.to_dict.return_value = {
"id": "session1",
"appName": app_name,
"userId": "user1",
"state": {"session_key": "session_val"},
}
mock_firestore_client.collection_group.return_value.where.return_value.get = (
mock.AsyncMock(return_value=[session_doc])
)
app_state_coll = mock.MagicMock()
user_state_coll = mock.MagicMock()
def collection_side_effect(name):
if name == service.app_state_collection:
return app_state_coll
elif name == service.user_state_collection:
return user_state_coll
return mock.MagicMock()
mock_firestore_client.collection.side_effect = collection_side_effect
app_doc = mock.MagicMock()
app_doc.exists = True
app_doc.to_dict.return_value = {"app_key": "app_val"}
app_doc_ref = mock.MagicMock()
app_state_coll.document.return_value = app_doc_ref
app_doc_ref.get = mock.AsyncMock(return_value=app_doc)
user_doc = mock.MagicMock()
user_doc.id = "user1"
user_doc.exists = True
user_doc.to_dict.return_value = {"user_key": "user_val"}
user_app_doc = mock.MagicMock()
user_state_coll.document.return_value = user_app_doc
users_coll = mock.MagicMock()
user_app_doc.collection.return_value = users_coll
user_doc_ref = mock.MagicMock()
users_coll.document.return_value = user_doc_ref
async def mock_get_all(refs):
yield user_doc
mock_firestore_client.get_all = mock_get_all
response = await service.list_sessions(app_name=app_name)
assert len(response.sessions) == 1
assert response.sessions[0].id == "session1"
assert response.sessions[0].app_name == app_name
mock_firestore_client.collection_group.assert_called_once_with("sessions")
mock_firestore_client.collection_group.return_value.where.assert_called_once_with(
"appName", "==", app_name
)
@pytest.mark.asyncio
async def test_create_session_already_exists(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
doc_snapshot = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.get.return_value
)
doc_snapshot.exists = True
with mock.patch("google.cloud.firestore.async_transactional", lambda x: x):
with pytest.raises(AlreadyExistsError):
await service.create_session(
app_name=app_name, user_id=user_id, session_id="existing_id"
)
@pytest.mark.asyncio
async def test_get_session_with_config(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
doc_snapshot = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.get.return_value
)
doc_snapshot.exists = True
doc_snapshot.to_dict.return_value = {
"id": session_id,
"appName": app_name,
"userId": user_id,
}
events_collection_ref = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value
)
config = GetSessionConfig(after_timestamp=1234567890.0, num_recent_events=5)
await service.get_session(
app_name=app_name, user_id=user_id, session_id=session_id, config=config
)
events_collection_ref.where.assert_called_once()
events_collection_ref.limit_to_last.assert_called_once_with(5)
@pytest.mark.asyncio
async def test_delete_session_batching(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
events_ref = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value.document.return_value.collection.return_value
)
dummy_docs = [mock.MagicMock() for _ in range(501)]
async def to_async_iter(iterable):
for item in iterable:
yield item
events_ref.stream.return_value = to_async_iter(dummy_docs)
batch = mock_firestore_client.batch.return_value
await service.delete_session(
app_name=app_name, user_id=user_id, session_id=session_id
)
assert batch.commit.call_count == 2
assert batch.delete.call_count == 501
@pytest.mark.asyncio
async def test_append_event_partial(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
session = Session(id="test_session", app_name="test_app", user_id="test_user")
event = Event(invocation_id="test_inv", author="user", partial=True)
result = await service.append_event(session, event)
assert result == event
mock_firestore_client.batch.assert_not_called()
@pytest.mark.asyncio
@pytest.mark.asyncio
async def test_get_session_empty_data(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_id = "test_session"
doc_snapshot = (
mock_firestore_client.collection.return_value.document.return_value.collection.return_value.document.return_value.get.return_value
)
doc_snapshot.exists = True
doc_snapshot.to_dict.return_value = {}
session = await service.get_session(
app_name=app_name, user_id=user_id, session_id=session_id
)
assert session is None
@pytest.mark.asyncio
async def test_list_sessions_missing_states(mock_firestore_client):
service = FirestoreSessionService(client=mock_firestore_client)
app_name = "test_app"
user_id = "test_user"
session_doc = mock.MagicMock()
session_doc.to_dict.return_value = {
"id": "session1",
"appName": app_name,
"userId": user_id,
"state": {"session_key": "session_val"},
}
app_state_coll = mock.MagicMock()
user_state_coll = mock.MagicMock()
sessions_coll = mock.MagicMock()
def collection_side_effect(name):
if name == service.app_state_collection:
return app_state_coll
elif name == service.user_state_collection:
return user_state_coll
elif name == service.root_collection:
return sessions_coll
return mock.MagicMock()
mock_firestore_client.collection.side_effect = collection_side_effect
app_doc = mock.MagicMock()
app_doc.exists = False
app_doc_ref = mock.MagicMock()
app_state_coll.document.return_value = app_doc_ref
app_doc_ref.get = mock.AsyncMock(return_value=app_doc)
user_doc = mock.MagicMock()
user_doc.exists = False
user_app_doc = mock.MagicMock()
user_state_coll.document.return_value = user_app_doc
users_coll = mock.MagicMock()
user_app_doc.collection.return_value = users_coll
user_doc_ref = mock.MagicMock()
users_coll.document.return_value = user_doc_ref
user_doc_ref.get = mock.AsyncMock(return_value=user_doc)
app_doc_in_root = mock.MagicMock()
sessions_coll.document.return_value = app_doc_in_root
users_coll = mock.MagicMock()
app_doc_in_root.collection.return_value = users_coll
user_doc_in_users = mock.MagicMock()
users_coll.document.return_value = user_doc_in_users
sessions_subcoll = mock.MagicMock()
user_doc_in_users.collection.return_value = sessions_subcoll
sessions_query = mock.MagicMock()
sessions_subcoll.where.return_value = sessions_query
sessions_query.get = mock.AsyncMock(return_value=[session_doc])
response = await service.list_sessions(app_name=app_name, user_id=user_id)
assert len(response.sessions) == 1
session = response.sessions[0]
assert session.id == "session1"
assert session.state["session_key"] == "session_val"
assert "_app_app_key" not in session.state
assert "_user_user_key" not in session.state