refactor: unify all command functions as async generators#413
Closed
refactor: unify all command functions as async generators#413
Conversation
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨Init
Issue List
Other
Bug Fixes 🐛Init
Other
Internal Changes 🔧Init
Other
Other
🤖 This preview updates automatically when you update the PR. |
Contributor
Codecov Results 📊✅ 104 passed | Total: 104 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 697 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 96.66% 96.67% +0.01%
==========================================
Files 159 160 +1
Lines 20855 20914 +59
Branches 0 0 —
==========================================
+ Hits 20158 20217 +59
- Misses 697 697 —
- Partials 0 0 —Generated by Codecov Action |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
BYK
force-pushed
the
feat/streaming-command
branch
from
e7ea4be to
f81ed82
Compare
BYK
force-pushed
the
feat/streaming-command
branch
from
f81ed82 to
1eb34eb
Compare
BYK
changed the title
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
| if (fields && fields.length > 0) { | ||
| return logs.map((log) => filterFields(log, fields)); | ||
| } | ||
| return logs; |
There was a problem hiding this comment.
JSONL follow-mode outputs array-wrapped log entries
High Severity
In follow mode with --json, each JSONL line is emitted as a one-element array [{...}] instead of a bare object {...}. yieldStreamChunks wraps each individual log in { kind: "data", logs: [log] }, and jsonTransformLogOutput returns logs (the single-element array) directly. writeTransformedJson then serializes that array as-is. The old writeLogs called writeJson(stdout, log, fields) per log, emitting bare objects. This breaks the JSONL output contract for existing consumers.
Additional Locations (1)
BYK
force-pushed
the
feat/streaming-command
branch
3 times, most recently
from
c648183 to
f53bc98
Compare
All command functions now use async generator signatures. The framework iterates each yielded value through the existing OutputConfig rendering pipeline. Non-streaming commands yield once and return; streaming commands (log list --follow) yield multiple times. Key changes: - buildCommand: func returns AsyncGenerator, wrapper uses for-await-of - All ~27 command files: async func → async *func, return → yield - log/list follow mode: drainStreamingOutput replaced by yield delegation - Delete streaming-command.ts (151 lines) — absorbed into buildCommand - output.ts: extracted applyJsonExclude/writeTransformedJson helpers, support undefined suppression for streaming text-only chunks No new dependencies. Net -131 lines.
BYK
force-pushed
the
feat/streaming-command
branch
from
ee063a5 to
ff35175
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
All command functions now use async generator signatures (
async *func). The framework iterates each yielded value through the existing OutputConfig rendering pipeline.Key insight
Every command function becomes an async generator. No detection, no branching, no special cases. The framework always does
for await (const value of generator):Changes
Framework (
command.ts)SentryCommandFunction→ returnsAsyncGenerator<unknown, void, undefined>for await...ofto iterate and render each yielded valueOutput rendering (
output.ts)applyJsonExclude()andwriteTransformedJson()helpers (reduced complexity)jsonTransformreturningundefinednow suppresses the chunk (streaming text-only chunks)human()returning empty string suppresses output (streaming data-only chunks in human mode)All ~27 command files
async func→async *funcreturn { data, hint }→yield { data, hint }useYieldlog/list follow mode
drainStreamingOutputreplaced byyield*delegation toyieldStreamChunks()generatorDeleted:
streaming-command.ts(151 lines)drainStreamingOutput()andStreamingOutputConfig— no longer neededStats