[Core] Flush pretty output manually #2573
Merged
Conversation
This file contains 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
mpkorstanje
force-pushed
the
2563-flush-manually
branch
2 times, most recently
from
78a6fd1
to
27e7a0f
Compare
Codecov Report
@@ Coverage Diff @@
## main #2573 +/- ##
============================================
+ Coverage 84.58% 84.72% +0.13%
+ Complexity 2664 2655 -9
============================================
Files 310 310
Lines 9357 9317 -40
Branches 901 899 -2
============================================
- Hits 7915 7894 -21
+ Misses 1111 1094 -17
+ Partials 331 329 -2
Continue to review full report at Codecov.
|
mpkorstanje
force-pushed
the
2563-flush-manually
branch
from
27e7a0f
to
f9e6e75
Compare
For the sake of efficiency and performance we write to buffered writers. However, the pretty plugin is expected to print scenarios as they're started and steps as they're finished. This was initially resolved by flushing the `NiceAppendable` on every write. This turned out to have performance impact (#2481) and interact poorly with tools that expected (#2536) us to be better behaved. By having `NiceAppendable` flush only when the underlying buffer was full these problems were resolved (#2541) . However, because the underlying buffer is 8KiB the pretty formatters output would effectively sit in a buffer until the writer was closed. So now we flush the pretty and progress output manually after each event. This strikes a balance somewhere between the flush-everything-all-the-time and flush-when-full approaches. Fixes: #2563
mpkorstanje
force-pushed
the
2563-flush-manually
branch
from
f9e6e75
to
2eef85d
Compare
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.
🤔 What's changed?
For the sake of efficiency and performance we write to buffered writers.
However, the pretty plugin is expected to print scenarios as they're started
and steps as they're finished.
This was initially resolved by flushing the
NiceAppendableon every write.This turned out to have performance impact (#2481) and interact poorly with
tools that expected (#2536) us to be better behaved.
By having
NiceAppendableflush only when the underlying buffer was full theseproblems were resolved (#2541) . However, because the underlying buffer is 8KiB
the pretty formatters output would effectively sit in a buffer until the writer
was closed.
So now we flush the pretty and progress output manually after each event. This
strikes a balance somewhere between the flush-everything-all-the-time and
flush-when-full approaches.
Fixes: #2563
🏷️ What kind of change is this?
📋 Checklist: