[ai] Fix collectUiMessages option by accumulating chunks in a separate step call #784
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Peter Wielander <[email protected]>
🦋 Changeset detectedLatest commit: 6d2df7d The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Nitro | Next.js (Turbopack) workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Stream Benchmarks (includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests🪟 Windows (1 failed)nextjs-turbopack (1 failed):
🌍 Community Worlds (21 failed)mongodb (1 failed):
redis (1 failed):
starter (18 failed):
turso (1 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
❌ 🪟 Windows
❌ 🌍 Community Worlds
❌ Some E2E test jobs failed:
Check the workflow run for details. |
VaguelySerious
changed the title
readUIMessageStream
VaguelySerious
changed the title
readUIMessageStream
VaguelySerious
changed the title
Signed-off-by: Peter Wielander <[email protected]>
Signed-off-by: Peter Wielander <[email protected]>
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
Signed-off-by: Peter Wielander <[email protected]>
Signed-off-by: Peter Wielander <[email protected]>
When a step function is invoked, only capture `this` if it has a `classId` property (indicating it's a class constructor registered for serialization by the SWC plugin). This prevents serialization errors when step functions are called as methods on arbitrary objects (e.g., `tool.execute()`) where the object has non-serializable properties like Zod schemas.
…ent-collectUiMessages
VaguelySerious
changed the base branch from
main
to
peter/fix-step-serialization
I, Peter Wielander <[email protected]>, hereby add my Signed-off-by to this commit: 0e8fe8c Signed-off-by: Peter Wielander <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a refactor of #768 which moves the accumulation logic to a step. The test harness I was using to test #768 didn't correctly account for the workflow transformation, so
collectUiMessagesdidn't actually work as intended before (also reported in issue #739).This PR moves the final accumulation call to a
"use step"at the end of theagent.streamcall. The actual logic still uses AI SDK'sreadUIMessageStreaminternally, just like before.I alternatively considered pre-creating a stream in a setup step, then double piping to that stream, before passing it to the final step that can call
readUIMessageStreamon it. In a non-workflow world, this would result in a performance improvement (native stream use), but since we are awaiting step boundaries anyway, it would not help in this case, and it would make the content less observable.I tested this in
flight-booking-app. See the final step it makes here that gets the chunks and returns theuiMessages: