VertexAiSessionService: Event.id differs between the streamed event and getSession (id is not sent to Vertex and the appendEvent response is empty)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
Research direction
Start with VertexAiSessionService.appendEvent and SessionJsonConverter in com.google.adk.sessions, then compare event serialization with the Python fix linked in the issue. Check how the REST rawEvent field can preserve the ADK id and how session loading chooses an id. Done means the streamed event and the event returned by getSession retain the same id, with tests covering the round trip.
Written by the indexing model from the issue text.
Description
Describe the bug
With VertexAiSessionService, the same logical event has two different ids depending on how it is observed:
| Observed via | Event.id |
|---|---|
Runner.runAsync(...) stream |
ADK-generated UUID (Event.generateEventId()) |
getSession(...) afterwards |
Vertex resource id (last segment of the event name) |
InMemorySessionService keeps the ADK UUID, so the two services behave differently and the problem does not show up in local development.
Where (checked on 1.8.0 and 1.10.1)
BaseLlmFlowcreates the id withEvent.generateEventId()(a random UUID) and resets it for each resulting event.Runner.runAsynccallssessionService.appendEvent(session, event)for every non-partial event, then emits the event to the caller.VertexAiSessionService.appendEventsendsSessionJsonConverter.convertEventToJson(e)to:appendEvent. That JSON containsauthor,invocationId,timestamp,actions,eventMetadataandcontent, but no event id, and norawEvent(there is no reference torawEventanywhere incom.google.adk.sessionsin these versions).VertexAiClient.appendEventonly checks the response body forClientExceptionand returnsCompletable.complete().VertexAiSessionService.appendEventthen returns the local event (.toSingleDefault(e)), so the caller keeps the ADK UUID.- On
getSession,SessionJsonConverterrebuilds the id from the API resource name:
.id(Iterables.getLast(Splitter.on('/').split(apiEvent.get("name").toString())))
What the API allows
From the SessionEvent REST reference:
nameis documented as "Identifier. The resource name of the event" (…/sessions/{session}/events/{event}). There is no other field meant to carry a client-assigned event id.rawEventis "Optional. Weakly typed raw event data in proto struct format."sessions.appendEventreturns an empty body on success, so the id created by the service is not available at append time.
Documentation
The Events documentation says that the session service "records the event as it received it" (in the Python description) and recommends using event.id to reference specific occurrences. This does not hold for VertexAiSessionService: the id seen during the run is never stored and is replaced on reload.
Impact
Anything that correlates a streamed event with its persisted form by Event.id breaks. In our case (a chat UI built on top of an AG-UI endpoint), message ids sent to the client while streaming do not match the ids returned when the conversation is reloaded, so per-message state (for example feedback) can be attached to an id that no longer exists. The only workaround we found is to reload the session after the run and pair events by invocationId and order while checking the text, which is fragile.
Expected behavior
One of:
- Persist the ADK id (for example in
rawEvent, as ADK Python now does) and prefer it over the resource name when reading; or - Make the id assigned by Vertex available to the caller at append time (not possible today since the response is empty); or
- If neither is possible, document that
Event.idis not stable across streaming and reload on this service.
Related
- google/adk-python#6530: same behavior in Python, closed as a bug and fixed by keeping the id stored in
raw_event(commit 864914b). The Java converter does not writerawEvent, so that fix does not port directly. - google/adk-go#1329: same behavior in Go (open), noting that
SessionEventhas no field for a client event id.
Environment
google-adk1.8.0 (the same code is present in 1.10.1)VertexAiSessionServiceon Vertex AI Agent Engine sessions
- Dominant language
- Java
- Stars
- 1.7k
- Forks
- 433
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 43
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from google/adk-java
-
GeminiUtil placeholder user turn ("Continue output. DO NOT look at this line ...") is flagged by prompt injection filtersPossibly taken @hemasekhar-p claimed this 4 days ago. Openneeds review
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
google/adk-java#1628 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
[spring-ai] Streaming responses ending with CJK punctuation (。!?) are misclassified as partial and never persisted to the sessionPossibly taken @hirematha claimed this 7 days ago. Openneeds review
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
google/adk-java#1608 · 3 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
runLive passes partial events to appendEvent and never aggregates text chunks, unlike ADK PythonPossibly taken @hemasekhar-p claimed this today. Openwaiting on reporter
Difficulty 4/5 3-5 days Newbie friendliness 45/100
google/adk-java#1648 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
FirestoreSessionService compares event timestamps as text, reordering or skipping same-second eventsPossibly taken @hemasekhar-p claimed this today. Openwaiting on reporter
Difficulty 3/5 1-2 days Newbie friendliness 50/100
google/adk-java#1646 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
FirestoreSessionService ignores `app:` / `user:` state prefixes, so app and user state are never shared across sessionsPossibly taken @hemasekhar-p claimed this today. Openwaiting on reporter
Difficulty 4/5 3-5 days Newbie friendliness 45/100
google/adk-java#1645 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
quelea-projection/Quelea#711 ·
-
bug pdd
Difficulty 2/5 Under an hour Newbie friendliness 67/100
objectionary/eo#9450 ·
Maintainers usually reply within 1 day
-
[EC2] DescribeAvailabilityZones should return real AWS error for unknown zone namePossibly taken @omatheusmesmo claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area: core good first issue type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ShaftHQ/SHAFT_ENGINE#6909 ·
Maintainers usually reply within 1 day