[rush] Logging enhancements #4929
Merged
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
dmichon-msft
requested review from
iclanton,
octogonz,
apostolisms and
D4N14L
as code owners
D4N14L
approved these changes
Sep 19, 2024
libraries/rush-lib/src/logic/operations/CacheableOperationPlugin.ts
Outdated
Show resolved
Hide resolved
D4N14L
reviewed
Sep 19, 2024
D4N14L
approved these changes
Sep 20, 2024
iclanton
approved these changes
Sep 20, 2024
iclanton
approved these changes
Sep 20, 2024
dmichon-msft
force-pushed
the
user/dmichon/logging-enhancement
branch
from
9460c8b to
0fc4acf
Compare
dmichon-msft
commented
Sep 20, 2024
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.
Summary
Leaves ANSI escape codes present in the JSONL log files, so that color information will be preserved when replaying from cache.
Adds a property
logFilePathstoIOperationExecutionResultso that they are available to plugins that may wish to interact with them.Adds a property
logServePathto the options forrush-serve-pluginthat specifies a base path under which all log files will be made available via the local server.Details
The
logFilePathsproperty will only be defined for operations that created log files.Served files are all in a single flat directory. This may cause collisions if two projects in the same repository have the same unscoped package name, since the naming convention for log files uses the unscoped package name, rather than the full package name.
Refactors logging-related code to have ProjectLogWritable construct the splitter and text rewriter internally, rather than it being the responsibility of the caller. This facilitates routing the raw log directly to the JSONL output and separately performing the newline rewriting and ANSI escape code trimming only for text logs.
How it was tested
Built with
FORCE_COLOR=1and verified that the jsonl logs contained the ANSI escape codes from Heft formatting.Wired up
rush-serve-pluginin the repository temporarily and validated that WebSocket messages contained information about log files. Also checked that the referenced log files could be fetched.Impacted documentation
Documentation for rush-serve-plugin, mainly regarding the schema. The examples for use of websocket will be extended in a future PR when we have a fully functional dashboard to submit.