How should custom data- parts stream with WorkflowAgent?
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 46/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- ai-infra-agents, backend-api-design
Research direction
Start with the WorkflowAgent migration notes, the Streaming Updates from Tools documentation, and the createModelCallToUIChunkTransform implementation mentioned in the issue. Compare the transform behavior with workflow-examples PR #53 and investigate how stream parts relate to result.steps and WorkflowChatTransport reconnects. Done means documenting or implementing a supported way to stream, reconnect, and persist custom data parts, including those emitted outside tool calls.
Written by the indexing model from the issue text.
Description
We're moving a multi-turn agent from DurableAgent to WorkflowAgent (ai 7.0.163, @ai-sdk/workflow 2.0.95, workflow 5.4.0). We follow the chat-session-modeling and message-queueing docs: one long-lived run per chat, a hook feeding a queue, prepareStep draining it, and createModelCallToUIChunkTransform at the route.
Our workflow writes app-specific data-* parts to the run stream. Some come from inside tools, but many come from steps outside any tool call.
On DurableAgent they streamed live next to the model output. On WorkflowAgent, createModelCallToUIChunkTransform maps any part type it doesn't know to nothing, so they're dropped. We confirmed this in a test app and in the transform's source.
Questions:
- What's the recommended way to show custom data-* parts live with WorkflowAgent, including parts written from steps outside a tool call, so they also survive a reconnect with WorkflowChatTransport? Is passing data-* through the transform, as PR #53 does, supported?
- How do we save and persist these custom data parts? It’s not captured as part of the
result.stepsfrom WorkflowAgent.
What we've found:
- The Streaming Updates from Tools page still says to write data-* chunks with getWritable() into the agent's stream. With the stock transform, those never reach the client.
- The v7 migration notes say the stream moved to ModelCallStreamPart "to avoid baking a UI protocol into the workflow payload". They don't say where custom UI data should go instead.
- workflow-examples PR #53 (flight-booking-app, closed without merging) copies the transform into lib/chat-stream.ts and forwards data-* parts unchanged.
- eve and durable-harness sidestep the question. Neither uses WorkflowAgent: each runs ToolLoopAgent inside its own session runtime on Workflow 5 and writes its own event protocol to the run stream.
- Dominant language
- TypeScript
- Stars
- 2.5k
- Forks
- 401
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 201
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No 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 vercel/workflow
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
node-module-esbuild-plugin: getImportedIdentifier only checks the first named import when locating a violationPossibly taken @div-cowboy claimed this 5 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vercel/workflow#5057 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
code-transform.mdx §ID Generation omits the package-shipped `name@version` ID formPossibly taken @Mohith26 claimed this 113 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
Similar issues
-
db-d1-sqlite: upsert is aliased to updateOne, so payload.kv.set never inserts new keysPossibly taken @pcbeingused333 claimed this today. OpenBug db: d1-sqlite Payload OSS
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
payloadcms/payload#19766 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
device-management-toolkit/sample-web-ui#3711 ·
Maintainers usually reply within 1 day
-
bug impact:low Team: SecuritySolution Team:Defend Workflows v9.6.0
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
elastic/kibana#306401 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
agentes-chat/agentes-chat#927 ·
Maintainers usually reply within 1 day
-
Closing a pinned tab jumps to the Tabs section instead of the next open pinned tabPossibly taken @seenimohamed claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ardia-browser/ardia#2769 ·
Maintainers usually reply within 1 day