Streaming Docs discrepancies
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.4k
- Forks
- 365
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 169
Description
@TooTallNate uncovered a few bugs in the runtime when we wrote the streaming docs that need to be fixed in workflow handling
Sharing here:
If a lock is not released, the step process cannot terminate
Not true today (currently the stream needs to actually end), but we need to fix that.
Streams are automatically closed when the workflow run completes
Not true today, but we need to fix that
controller.error(new Error('Stream failed'));
I don't think we have implemented error storage in the World interface yet. Another TODO
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with the linked streaming documentation and the runtime's World interface, then trace the workflow handling for lock release, stream completion, and controller.error. Done means the documented lock, automatic stream closure, and error-storage behaviors all work as described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- distributed-systems
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100