Quality: Potential false negative when color support object lacks stdout#2690
Open
tuanaiseo wants to merge 1 commit intosinonjs:mainfrom
Open
Conversation
`Colorizer.colorize` only disables ANSI codes when `this.supportsColor.stdout === false`. If `supportsColor` is missing, malformed, or has `stdout` undefined, the function still emits ANSI escapes, which can pollute logs in non-TTY environments. Affected files: colorizer.js Signed-off-by: tuanaiseo <221258316+tuanaiseo@users.noreply.github.com>
Contributor
|
Seems fine, but this requires a tiny test for that conditional. |
Contributor
|
I removed |
Contributor
|
A bit quick there, I will keep this open to see if the issue is still there |
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
2 participants
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.
Problem
Colorizer.colorizeonly disables ANSI codes whenthis.supportsColor.stdout === false. IfsupportsColoris missing, malformed, or hasstdoutundefined, the function still emits ANSI escapes, which can pollute logs in non-TTY environments.Severity:
mediumFile:
lib/sinon/colorizer.jsSolution
Use a stricter capability check, e.g.
if (!this.supportsColor || !this.supportsColor.stdout) return str;and consider guarding constructor input shape.Changes
lib/sinon/colorizer.js(modified)Testing