Don't swallow Error message/stack when using formatter #1188
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
Fixes winstonjs#1178 When we use a formatter and pass an `Error` object in as `meta`, we end up removing the Error's message and stack information when `decycle`ing it. `clone` checks if the passed-in object is an `Error` and does not `decycle` it in that case, but when we use a formatter, this check does not happen because we `clone` the whole `options` object instead of just cloning `options.meta`. By `clone`ing `meta` alone when it is an Error, the `instanceof Error` check will catch it and copy `message` and `stack` into a new, non-Error object. So when that's buried in `options.meta`, re-`clone`ing it won't hurt.
kewitz
added a commit
to invisible-tech/logger
that referenced
this pull request
Jan 29, 2018
|
Works for me. Tested it with a custom formatter and also tested if Actually i'm confused why this is still open. |
julianhille
approved these changes
Feb 21, 2018
|
I'd like to see a test for it so that this won't happen again, |
Add test for "Don't swallow Error message/stack when using formatter", which Fixes winstonjs#1178
|
I added a test and confirmed that it works on my branch but fails for the |
|
shipit! |
|
Thanks for your contribution. Will get a maintenance release out tomorrow. |
cjbarth
pushed a commit
to cjbarth/winston
that referenced
this pull request
Aug 22, 2018
* commit 'dc74db60b8d46475fce04bab1e0c31abe5201e09': (34 commits) [dist] Maintenance release. 2.4.3 [Winston 2.x] Decycle circular `Error` instances (winstonjs#1307) [dist] Maintenance release. 2.4.2 [dist] Add .gitattributes file. [fix] Backport winstonjs#1281 onto 2.x for maintenance. [dist] Add ignores from 3.x for easier maintenance switching. fix: clone() cloning prototype's custom methods (winstonjs#1086) Don't swallow Error message/stack when using formatter (winstonjs#1188) [dist] Add package-lock.json Update http.js - Add support for headers fix 2.x readme (fixes winstonjs#1179) [dist] Maintenance release. 2.4.1 Always pass a function to fs.close (winstonjs#1227) Update documentation for the `stringify` option [dist] Version bump. 2.4.0 [fix] Correct documentation mistake in 2.x Add how to colorize output in the custom formatter example (winstonjs#989) [fix] Container.add() 'filters' and 'rewriters' option passing to logger (winstonjs#1036) Fixed working of "humanReadableUnhandledException" parameter when additional data is added in meta (winstonjs#1066) Added filtering by log level (winstonjs#1040) ...
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.
Fixes #1178
When we use a formatter and pass an
Errorobject in asmeta,we end up removing the Error's message and stack information when
decycleing it.clonechecks if the passed-in object is anErrorand does not
decycleit in that case, but when we use a formatter,this check does not happen because we
clonethe wholeoptionsobjectinstead of just cloning
options.meta.By
cloneingmetaalone when it is an Error,the
instanceof Errorcheck will catch it and copymessageandstackinto a new, non-Error object. So when that's buried in
options.meta,re-
cloneing it won't hurt.