Skip to content

fix(firestore): serialize session state as JSON to avoid reserved field name errors #5549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nileshpatil6 wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −7
Open

fix(firestore): serialize session state as JSON to avoid reserved field name errors #5549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a06f94
fix(firestore): serialize session state as JSON to avoid Firestore re…
nileshpatil6 Apr 29, 2026
72ebdc5
Merge branch 'main' into fix/firestore-reserved-state-keys
rohityan Apr 30, 2026
fe190ce
fix(tests): update firestore state assertions to expect JSON-serializ…
nileshpatil6 May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/google/adk/integrations/firestore/firestore_session_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from __future__ import annotations

import asyncio
import json
from contextlib import asynccontextmanager
from datetime import datetime
from datetime import timezone
Expand Down Expand Up @@ -203,7 +204,7 @@ async def create_session(
"id": session_id,
"appName": app_name,
"userId": user_id,
"state": session_state,
"state": json.dumps(session_state),
"createTime": now,
"updateTime": now,
"revision": 1,
Expand Down Expand Up @@ -314,7 +315,10 @@ async def get_session(
events.append(Event.model_validate(ed))

# Let's continue getting session.
session_state = data.get("state", {})
raw_state = data.get("state", {})
session_state = (
json.loads(raw_state) if isinstance(raw_state, str) else raw_state
)

# Fetch shared state
app_ref = self.client.collection(self.app_state_collection).document(
Expand Down Expand Up @@ -407,7 +411,12 @@ async def list_sessions(
data = doc.to_dict()
if data:
u_id = data["userId"]
s_state = data.get("state", {})
raw_s_state = data.get("state", {})
s_state = (
json.loads(raw_s_state)
if isinstance(raw_s_state, str)
else raw_s_state
)
u_state = user_states_map.get(u_id, {})
merged = self._merge_state(app_state, u_state, s_state)

Expand Down Expand Up @@ -555,7 +564,7 @@ async def _append_txn(transaction: firestore.AsyncTransaction) -> int:
transaction.update(
session_ref,
{
"state": session_only_state,
"state": json.dumps(session_only_state),
"updateTime": firestore.SERVER_TIMESTAMP,
"revision": new_revision,
},
Expand Down
6 changes: 3 additions & 3 deletions tests/unittests/integrations/firestore/test_firestore_session_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

from __future__ import annotations

import json
from unittest import mock

from google.adk.events.event import Event
Expand Down Expand Up @@ -117,7 +118,7 @@ async def test_create_session(mock_firestore_client):
assert args[1]["id"] == session.id
assert args[1]["appName"] == app_name
assert args[1]["userId"] == user_id
assert args[1]["state"] == {}
assert json.loads(args[1]["state"]) == {}
assert args[1]["createTime"] == firestore.SERVER_TIMESTAMP
assert args[1]["updateTime"] == firestore.SERVER_TIMESTAMP

Expand Down Expand Up @@ -324,8 +325,7 @@ async def test_append_event_with_state_delta(mock_firestore_client):

transaction.update.assert_called_once()
args, kwargs = transaction.update.call_args
# In modular Firestore configurations alignments, updating variables mock assertions core setups
assert args[1]["state"] == session.state
assert json.loads(args[1]["state"]) == session.state
assert args[1]["updateTime"] == firestore.SERVER_TIMESTAMP


Expand Down