fix(test): handle NDJSON chunking in log_stream tests #4358
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
The log endpoint streams NDJSON (newline-delimited JSON) generated by `tracing-subscriber`. However, the log stream tests assume each HTTP body chunk contains a complete JSON object, which isn't necessarily the case. HTTP streaming doesn't guarantee chunk boundaries align with JSON boundaries because TCP can split data anywhere. This causes occasional test failures when chunks split mid-JSON-object in my local machine. Fix by buffering incoming chunks and extracting complete lines (by newline delimiter) before parsing as JSON. We could arguably set the content type header for this endpoint to `application/x-ndjson` to be fully compliant with the NDJSON specs, but that that may be risking a breaking change for little value. Signed-off-by: Alejandro Martinez Ruiz <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4358 +/- ##
==========================================
+ Coverage 67.68% 71.53% +3.84%
==========================================
Files 332 394 +62
Lines 15158 18546 +3388
==========================================
+ Hits 10259 13266 +3007
- Misses 4899 5280 +381 see 299 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
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.
The log endpoint streams NDJSON (newline-delimited JSON) generated by
tracing-subscriber. However, the log stream tests assume each HTTP body chunk contains a complete JSON object, which isn't necessarily the case.HTTP streaming doesn't guarantee chunk boundaries align with JSON boundaries because TCP can split data anywhere. This causes occasional test failures when chunks split mid-JSON-object in my local machine.
Fix by buffering incoming chunks and extracting complete lines (by newline delimiter) before parsing as JSON.
We could arguably set the content type header for this endpoint to
application/x-ndjsonto be fully compliant with the NDJSON specs, but that that may be risking a breaking change for little value.