command plugins: Optionally print build logs during packageManager.build #7255
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
euanh
commented
Jan 15, 2024
| } | ||
|
|
||
| var position: Int { | ||
| return 0 // should be related to the downstreams somehow |
There was a problem hiding this comment.
What should 'position' return here? The downstreams might all be at different positions. Should this be the number of bytes which have been passed to write, or should it be related to positions of the downstreams?
There was a problem hiding this comment.
IDK, the doc comment for that protocol says it's "The current offset within the output stream", if that helps in any way.
MaxDesiatov
reviewed
Jan 15, 2024
euanh
force-pushed
the
plugin-diagnostics-echo-build-logs
branch
3 times, most recently
from
4cd3d67 to
ff7a6a0
Compare
MaxDesiatov
reviewed
Jan 15, 2024
|
@swift-ci test |
|
@swift-ci test windows |
|
The Windows test failure doesn't immediately look like it's related to this change: |
|
Yeah, that failure looks like something caused by Windows builds not running in complete isolation from each other 😕 |
|
@swift-ci test windows |
MaxDesiatov
approved these changes
Jan 18, 2024
When a plugin asks for a target to be built by calling packageManager.build, SwiftPM accumulates the build log in a buffer and returns the whole log when the build completes. No feedback is printed on the console while the build is running, so if the target is large the user can't tell whether the build is making progress or is stuck. This commit adds the option to echo logs to the console as they are produced, in addition to accumulating them in a buffer. Console echoing is turned off by default.
euanh
force-pushed
the
plugin-diagnostics-echo-build-logs
branch
from
56a5b02 to
35e5c1b
Compare
|
@swift-ci test |
|
@swift-ci test windows |
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.
This commit adds the option for a build run on behalf of a command plugin to echo logs to the console as they are produced, in addition to the current behaviour of accumulating them in a buffer. Console echoing is turned off by default.
Motivation:
When a plugin asks for a target to be built by calling
packageManager.build, SwiftPM accumulates the build log in a buffer and returns the whole log when the build completes. No feedback is printed on the console while the build is running, so if the target is large the user can't tell whether the build is making progress or is stuck.Modifications:
TeeOutputByteStream, anOutputByteStreamwhich copies its inputs to a set of output streamsechoLogsparameter topackageManager.build, defaulting tofalseto match the current behaviour.Result:
A command plugin can ask for build outputs to be echoed as they are produced. The user will have some feedback that a build is happening, rather than the long pause which can happen now.
This change depends on #7254.